2.5. Upgrading Software

Home Prev	cOS Stream 4.00.03 Administration Guide	Next

From time to time Clavister will release new cOS Stream software versions. All version releases are provided in the form of a single file with the filetype .upg and a filename indicating the target platform and version number. All releases are installed in the same way.

The following should be noted about new releases:

Notifications about new releases is sent by email to registered MyClavister users. Email preferences should be set accordingly in the relevant MyClavister account.
It is recommended to always upgrade to the latest cOS Stream release.
The .upg file for a specific upgrade should be downloaded from the relevant MyClavister account before beginning the upgrade process.
Upgrades should be performed during a maintenance window when there is no live traffic. The upgrade process will disrupt any traffic flowing through the NetShield firewall.
As a precaution, it is recommended to take a full system backup before beginning the upgrade process.
The progress of the upgrade process will be displayed on the cOS Stream console, as described later in this section.
If the upgrade process fails then cOS Stream will automatically roll back any changes so the system will be unchanged.
Success of an upgrade will be displayed in the console at the end of the process but it can be reconfirmed manually using the about command.

Applying a .upg Upgrade File

Applying an upgrade file requires the following steps:

Upload the relevant .upg file to firewall disk storage using SCP.
Use the CLI upgrade command to apply the upgrade.
cOS Stream verifies the checksum and signature of the upgrade file and then installs it.

For a high availability (HA) cluster, the above procedure is repeated on each cluster node but with some extra considerations. This is described further in Section 22.4, Upgrading an HA Cluster.

The Upgrade Command

The CLI upgrade command is used to install an already uploaded .upg file. For example, if the file uploaded with SCP is called cos_stream_4_00_02.upg, the upgrade command with example output would be:

System:/> upgrade cos_stream_4_00_02.upg

This will upgrade the system using cos_stream_4_00_02.upg
Are you sure you want to continue? [yes/no]: yes
|0%Validating                     |50%Extracting                   |100%
|||||||||||||||||||||||||

The CLI displays a progress bar consisting of lines which will gradually increase to 100% completion.

The following should be noted:

After successful installation, the system will automatically restart itself.
If the system fails to configure with the new software version, the old version is automatically restored and the system is restarted.
When running a CLI script, the -force option should be used to suppress the continuation question. The full CLI command would be:
```
System:/> upgrade <filename> -force
```

Managing Package Files

To check which .upg files have been uploaded and are available to be used with an upgrade, the following command is used:

System:/> upgrade -list

Wildcards cannot be used with the -list option.

To delete a package file, the following command can be used:

System:/> upgrade -delete <filename>

With the -delete option, the asterisk wildcard character ("*") can be used to represent filenames. For example, the delete all files:

System:/> upgrade -delete *.upg