Product Documentation

Single Bundle Upgrade

Jan 16, 2018

For 10.5 and previous releases, NetScaler SDX appliance setup includes setting up XenServer hypervisor, its supplemental packs and hotfixes, the Management Service, NetScaler virtual machines, and LOM firmware. Each of these components has a different release cycle. Therefore, updating each component independently, as allowed by NetScaler SDX 10.5 and earlier releases, makes maintenance difficult. Updating each component separately also leads to unsupported combinations of components.

The Single bundle upgrade, available from 11.0 and later releases, combines all the components except the NetScaler image and LOM firmware in a single image file, called the NetScaler SDX image. Using this image, you can upgrade all the components in a single step, eliminating the chances of incompatibility between various components. Single bundle upgrade also ensures that your appliance is always running a version that is tested and supported by Citrix. Because all the SDX components are combined in a single file, the NetScaler SDX image file is significantly larger than the Management Service image file.

The file name of the image is of the format build-sdx-12.0-<build_number>.tgz. After the Management Service is upgraded to NetScaler SDX 12.0, the new GUI does not display the options to upload the XenServer image file, supplemental packs, or hotfixes. This is because NetScaler SDX 12.0 does not support upgrading individual components.

Upgrading the Entire Appliance from 12.0

If you are currently running version 10.5.66.x or later of the NetScaler SDX Management Service, you can use the NetScaler SDX 11.1 image file to upgrade the appliance. If your Management Service is running an older version, you must first upgrade it to version 10.5.66.x or later.

To upgrade the appliance:

  1. Upload the single bundle image file, navigate to Configuration> Management Service > Software Images and then click Upload
  2. Navigate to Configuration > System > System Administration. Go to step 3 f you're upgrading from release 10.55 66.x and later. Go to step 4, if you're upgrading from release 11.0
  3. In the System Administration group, click Upgrade Management Service.
  4. In the System Administration group, click Upgrade Appliance.
    The upgrade process takes a few minutes.
Before the upgrade, Management Service displays the following information:
  • Single bundle image file name
  • The current version of NetScaler SDX running on your appliance
  • The selected version to which the appliance will be upgraded
  • Approximate time to upgrade the appliance
  • Miscellaneous information

Before clicking Upgrade Appliance, make sure that you have reviewed all the information displayed on the screen. You cannot abort the upgrade process once it starts.


If the upgrade is not successful, reset the appliance to factory default settings and upgrade again. For more information see the "Resetting the Appliance to Factory Version" section in Performing Appliance Reset.