Product Documentation

Licensing, Upgrading, and Downgrading

May 15, 2015


Release 7.4 supports both remote license servers and locally installed licenses.

For licensing information for all Citrix CloudBridge platforms, see

Upgrading Existing Installations

Note: If you are using a standard evaluation license, you cannot upgrade to software versions that are later than your license.
Citrix CloudBridge VPX

If you are upgrading from release 5.6, install a new virtual machine rather than upgrading the existing virtual machine, because resource requirements changed with release 6.2.0. Release 6.0 and 6.2 virtual machines can be updated with the CloudBridge release 7.4 binary.

Repeater 8500, Repeater 8800, Citrix CloudBridge 600, and Citrix CloudBridge 700

Acquire the software from My Account.

Installing the Update
Note: If you are upgrading from a pre-6.0 release (such as release 5.3), you must update to release 6.x first, then to release 7.4. Also, if you are upgrading from a pre-6.0 release, acceleration will not take place until you install the new license from Citrix.

From the browser based user interface (http://appliance_ip_address), go to the System Maintenance > Update Software link on the Configuration tab. In the Upgrade System Software table, click Choose File to select the patch file (the file you downloaded with FTP), and then click Upload Patch, as shown in the following screen shot.

Figure 1. Update Software Page

The patch file is then copied to your appliance and tested for integrity. If you have downloaded a valid file, a Restart Unit? prompt appears. Click Yes.

The settings from your current release are copied to the new one, so your configuration is retained in the new release. The process of installing the patch file continues during the restart, which might take several minutes longer than usual. The new release is now running on your appliance.
Note: If your appliance still uses the old default password, it is changed to "password" when you install this upgrade.
Citrix CloudBridge 400, CloudBridge 800, CloudBridge 2000, CloudBridge 3000, CloudBridge 4000, and CloudBridge 5000

CloudBridge 400, 800, 2000, 3000, 4000, and 5000 appliances can be updated to release 7.4 with the following procedure.

This procedure is recommended for all CloudBridge 400 and 800, CloudBridge 2000 and 3000 appliances, and for CloudBridge 4000 and 5000 appliances that have already been configured. Your existing configuration is retained without modification.

The update process involves two basic steps:
  1. If you are not already running release 7.1.0 or higher, download the release 7.4.0 management service, then update the management service to release 7.4.0.
  2. Download and install the release 7.4.0 upgrade bundle.

The versions of the management service and upgrade bundle corresponding to release 7.4 are listed in the Compatibility section. These files can be downloaded from My Account.

Note: If the #SESS_CORRUPTED error message appears at any time during these procedures, click Logout, clear your browser cache, close your browser, and open it again.

To update the Management Service:

Follow this procedure only if your appliance has a management service from a release earlier than release 7.1.
Note: In this procedure, System > Configuration refers to the Configuration menu of a CloudBridge 4000 or CloudBridge 5000 appliance and the System > Configuration menu of a CloudBridge 2000 or CloudBridge 3000 appliance.
  1. Update the management service. On the System > Configuration > Management Service > Software Images tab, click Upload and select and upload the new management service from the dialog box.
  2. On the Configuration > Management Service page, click Upgrade Management Service. Select the management service image you just uploaded, and then click OK. The management service is upgraded. The UI becomes unresponsive during this process.
  3. Clear your browser cache.
  4. Once the new management service is installed, the UI starts responding again and takes you to the logon page. Log on. Go to the System > Configuration page and verify that the current version of the management service matches the version you intended to install.

    If the pages display a Version Incompatibility Detected warning message, it just means that you need to install the upgrade bundle. Ignore the Recommendations in the warning and install the upgrade bundle, as described below.

To update the appliance
  1. If your appliance is not yet running Release 7.1.0 or later, upload and install the management service for the target release before continuing.
  2. Acquire the update file. If you log on to with your My Account credentials, the CloudBridge software is available in the Downloads section. The upgrade file has a .upg extension and is several hundred megabytes long. Download the file to a convenient system. To minimize transfer time, this system should be in the same facility as the appliance and have a fast link to it (Gigabit Ethernet rather than 54 Mbps wireless).
  3. Log on to the appliance and navigate to the System > Configuration page .
  4. Click the Update Software link.
  5. In the text box that appears, specify the upgrade file, and then click Upload.
  6. When a message announces that the upload was successful, click Install.
  7. The appliance performs the upgrade, which takes about half an hour. It displays a series of status messages, starting with “Preparing to upgrade” and ending with “Upgrade completed Successfully.”
  8. Click OK to display the updated user interface. Clear your browser cache to ensure successful operation.
  1. If there is no Update Software link, you are using an earlier version of the management service. Update the management service to release 7.4, and then run the update process.
  2. If the graphical user interface seems dysfunctional after the update, clear your browser cache. You might also need to wait for all features to initialize.
  3. The update process is a post-provisioning process. It does not function properly on a new system or after a factory reset if you run it before running the Configuration Wizard.
  4. The update process can fail for a variety of reasons, including a corrupted or truncated update file, an appliance using versions that are not in its supported range, and other issues. If the update process fails, it displays an error message.
  5. If you need to run the update process again, you must upload the update file again.
Citrix CloudBridge 700 series

To upgrade a Citrix CloudBridge 700 appliance, see the Citrix Branch Repeater with Windows Server User's Guide, release 3.0, chapter 3.

Troubleshooting Installation Related Issues

The clockface showing the estimated update time is not always 100% accurate. If the installation ends with an error page displaying some kind of HTTP timeout error, wait a few minutes, and then attempt to connect normally to the browser based management interface of the appliance. Doing so usually shows that the newly installed version is up and running.

Sometimes an update fails if it spans a large number of releases, such as a jump from release 4.x to 6.0. If this happens, installing an intermediate release first (for example, release 5.5) and upgrading in two steps usually works.

Contact Citrix Support with any installation issues.

Troubleshooting Installation Related Issues for Citrix CloudBridge VPX for Amazon

For information about troubleshooting installation related issues for Citrix CloudBridge VPX for Amazon, see WAN Optimization for CloudBridge.

Downgrading to an Earlier Release

CloudBridge 4000 and CloudBridge 5000 Appliances
You cannot downgrade a CloudBridge 4000 or CloudBridge 5000 appliance to an earlier release.
Other Appliances
Upgrading creates a new software installation. It does not remove the previous release of the software or the previous configuration settings. Therefore, an appliance can be returned to any release that it has previously used.

You can revert to a previous release of the software by using the Downgrade Release feature, which is available on the System Maintenance: Update Software page. The downgrade returns the configuration to what it was for the earlier release at the time the upgrade was applied. Any configuration changes you made with the newer release are lost.

The software can be downgraded to previously installed releases only. Neither the Upgrade Software nor the Downgrade Release feature supports the installation of patch files with a earlier release number than the current one, except for releases already resident on the appliance.