Upgrading Your Traffic Manager

Pulse Secure Virtual Traffic Manager 21.4: Software Installation and Getting Started Guide

Upgrading Your Traffic Manager

This section contains details of how to upgrade and, if necessary, revert your Traffic Manager software version.

These instructions describe the upgrade and reversion functionality available in version 21.4. For upgrades from an earlier release, use the Upgrading instructions in the Pulse Secure Virtual Traffic Manager: Installation and Getting Started Guide applicable to the former version. Functionality described here might not be present in earlier releases.

Ivanti recommends you backup your configuration as a precaution before upgrading the Traffic Manager. Use the System > Backup page to create a snapshot of your current configuration that you can restore later if necessary.

For further information on upgrading and space requirements, see the Pulse Community Web site:https://community.pulsesecure.net

Upgrading a Cluster of Traffic Managers

This section is applicable to upgrades from version 17.4 and later only. Versions of the Traffic Manager earlier than 17.4 do not contain the cluster upgrade functionality described here. Instead, you must upgrade each cluster member individually. See the documentation applicable to the version you have for more details.

An upgrade initiated on one cluster member can optionally be rolled out to all other cluster members automatically.

To initiate an upgrade, you must first obtain the software package specific to your operating system. For clusters containing two or more Traffic Managers, one of the following scenarios must apply:

•Where a cluster contains Traffic Managers of only one variant (for example, the software edition), the uploaded software package is applicable to all Traffic Managers in the cluster. Hence, an upgrade initiated on one Traffic Manager can upgrade all other Traffic Managers in the cluster without further user intervention.

•Where a cluster contains Traffic Managers spanning multiple platforms (for example, a mixed cluster of software instances and appliances), a single uploaded software package applies only to a subset of your cluster. To upgrade all the Traffic Managers in your cluster, obtain software upgrade packages that cover all product variants used. Then, execute an upgrade for each product variant in turn from any cluster member (regardless of that cluster member’s host platform).

In the event an upgrade fails on any Traffic Manager in the cluster, the default behavior is to roll-back the upgrade in progress and leave your entire cluster on the previous working software version.

Command line upgrades contain an additional option to not automatically roll-back all Traffic Managers in the event of an upgrade failure. You can instead instruct the cluster members which upgraded successfully to remain using the new version, and to only roll-back the Traffic Managers that failed. However, you must not make any configuration changes while your cluster is in a mixed-version state.

Performing an Upgrade

Before you begin, obtain the relevant Traffic Manager installation package. Packages are named according to the following convention:

ZeusTM_<version>_<OS>.tgz

where <version> is the Traffic Manager version and <OS> is the Operating System platform identifier.

Perform the upgrade through the Admin UI or from the command line.

To upgrade using the Admin UI

1.Log in to the Admin UI, and click System > Traffic Managers > Upgrade....

2.Follow the instructions to upload and apply the upgrade package. Where you are upgrading a cluster of Traffic Managers, select which of your other cluster members should receive the upgrade package (subject to the platform rules in Upgrading a Cluster of Traffic Managers).

To upgrade using the command line

1.Copy the upgrade package to the Traffic Manager host using the Linux scp command, or Windows based pscp (http://www.chiark.greenend.org.uk/~sgtatham/putty/) or WinSCP (http://winscp.net/eng/index.php).

2.Using ssh (Linux) or putty (Windows), login to your Traffic Manager machine as the system superuser. For instructions on using the system superuser (also known as the “root” user), see your host operating system documentation.

3.Change directories to the directory where you copied the installation package file.

4.To upgrade a cluster of Traffic Managers, run the following command:

ZEUSHOME/zxtm/bin/upgrade-cluster --package <package_filename> --mode <mode>

In the above command syntax, <package_filename> refers to the upgrade package file in .tgz format, and <mode> is one of “info” (just report on the potential upgrade) or “install” (perform the upgrade). For full details of this command and all optional arguments, use the --help argument.

Alternatively, to upgrade the current Traffic Manager only, extract the contents of the tgz file by running the following command:

gzip -dc ZeusTM_<Version>_<OS>.tgz | tar –xvf –

Then, run the following command in the extracted directory:

./zinstall

5.Your Traffic Manager software is automatically stopped, upgraded, and restarted, while retaining its current configuration.

When upgrading the software through the Admin UI from a significantly older version of the software, for example 4.2, you might see warning messages such as:

SERIOUS:monitors/SIP UDP: Unknown monitor scope: sip
SERIOUS:monitors/RTSP: Unknown monitor scope: rtsp
WARN:monitors/SIP UDP: Line 1: Unknown config key

These messages come from the older version of the software and warn you about the incompatibility with RTSP/SIP monitors of the newer version. The messages can be safely ignored.

For further information relating to upgrades and warnings, see the release notes provided with your software.

Reverting to an Earlier Version

The upgrade process preserves the previous Traffic Manager version in a separate disk partition to facilitate a reversion capability. To revert to the previous version, use the Switch Versions feature in the Admin UI or the rollback program from the command line.

This procedure does not retain any configuration you have made since upgrading to the current version. It is strictly a roll-back procedure that reinstates the selected software version and reinstates the previous configuration settings. Therefore, Ivanti strongly recommends that you make a backup copy of your configuration before reverting your appliance.

To revert the Traffic Manager to a previous version using the Admin UI

Traffic Manager versions earlier than 10.4 do not contain a switch feature in the Admin UI. If you roll back to a version earlier than 10.4 and then want to switch again to a different revision, or even to return to the newest software version, you must use the command line “rollback” program until you reach version 10.4 or later.

1.Login to the Admin UI of the Traffic Manager you want to revert.

2.Click System > Traffic Managers and locate the “Switch Versions” section:

The Switch Versions section is hidden if there are no applicable versions to revert to.

3.Select a Traffic Manager version to use from the drop-down list.

4.Tick Confirm and then click Rollback to start the roll back process.

To revert the Traffic Manager to a previous version using the command line

1.Using ssh (Linux) or putty (Windows), log in to your Traffic Manager machine as the system superuser.

To become the system superuser (also known as the "root" user), see your host operating system documentation.

2.Run the command:

$ZEUSHOME/zxtm/bin/rollback

This starts the rollback program:

Rollback

This program allows you to roll back to a previously installed version of the software. Please note that the older version will not gain any of the configuration changes made since upgrading.

Do you want to continue? Y/N [N]:

3.Type Y and press Enter to continue. The program lists all versions of the Traffic Manager it can restore:

Which version of the Traffic Manager would you like to use?

1) 18.2

2) 18.3 (current version)

Select a version [2]

4.Select the version you want to restore, and press Enter.

5.The Traffic Manager stops the current version and restarts itself with the selected version.

If you need to cancel this process and return to the latest version, repeat the rollback procedure and select the newer version to restore. You do not need to reinstall the latest version of the Traffic Manager to achieve this.

For rollbacks to 18.1 or earlier, be aware that if you subsequently decide to roll forward again to version 18.2 or later, the Admin UI “Switch Versions” feature is not supported. Use only the command line rollback program for this purpose.