Citrix Application Delivery Management

Upgrade

Each Citrix ADM release offers new and updated features with increased functionality. Citrix recommends you upgrade Citrix ADM to the latest release to avail of the new features and bug fixes. A comprehensive list of enhancements, known issues, and bug fixes is included in the release notes accompanying every release announcement. It is also important to understand the licensing framework and types of licenses that can be used before you start to upgrade. For Citrix ADM licensing information, see Licensing.

The Upgrade path information is also available in the Citrix Upgrade Guide.

Before you upgrade

Download the upgrade package from the Citrix ADM Downloads page and follow the instructions in this article to upgrade your system to the latest 13.0 build. After the upgrade process begins, ADM restarts and the existing connections are terminated and reconnected when the upgrade completes. The existing configuration is preserved, but Citrix ADM does not process any data until the upgrade is successfully completed.

Points to note before upgrading to 13.0:

  • If you are upgrading to Citrix ADM 13.0 build 36.27 version from either version 11.1 or from version 12.0 build earlier than 56.x, perform the following steps:

    • Upgrade from existing version to 12.0 build 57.24.

    • Upgrade to the latest build of version 12.1.

    • Upgrade to version 13.0.

      Follow this two-step process because there are certain clean-up procedures required to upgrade successfully to 13.0 release. These procedures are available only from 12.0 build 56.x onwards.

Important points to note before upgrading to 13.0 67.xx

When you upgrade the ADM software to image version 13.0 67.xx, your ADM database is also migrated. This data migration happens because ADM now uses PostgreSQL version 10.11.

When upgrading to 13.0 67.xx, Citrix recommends you first upgrade to 13.0 61.xx and then to 13.0 67.xx, for better user experience.

Note

You cannot downgrade Citrix ADM from a 13.0 build to any build of an earlier release.

Recommended precautions:

  • Take a snapshot of Citrix ADM server if you are upgrading to 13.0 67.xx.

  • Back up the Citrix ADM server before you upgrade.

  • After the upgrade, you might have to reestablish connections between the Citrix ADM server and the managed instances. A confirmation prompt warns you that connections can fail if you proceed.

  • For Citrix ADM servers in high availability setup, when upgrading, do not make any configuration changes on either of the nodes.

    Warning

    Do not refresh the browser until the upgrade process is successfully completed. Check the GUI for the approximate time for the upgrade to complete.

  • After upgrade, the active node can change in a high availability pair.

Upgrade a single Citrix ADM server

To upgrade single Citrix ADM Server:

  1. Log on to Citrix ADM with administrator credentials.

  2. Navigate to System > System Administration. Under the System Administration subheading, click Upgrade Citrix ADM.

    Upgrade Citrix ADM

  3. On the Upgrade Citrix ADM page, select the Clean software image on successful upgrade check box to delete image files after upgrade. Selecting this option removes the Citrix ADM image files automatically upon upgrade.

    Note

    This option is selected by default. If you do not select this check box before starting the upgrade process, you must manually delete the images.

    Select upgrade file

  4. You can then upload a new image file by selecting either Local (your local machine) or Appliance. The build file must be present on the Citrix ADM virtual appliance.

    Upload image

  5. Click OK. The Confirm dialog box is displayed. Click Yes.

    The upgrade process starts. The following screen capture shows the upgrade process for 13.0 64.35 and previous versions.

    Upgrade process window

    The following screen capture shows the upgrade process for 13.0 67.xx.

    Upgrade process window for 67.xx

    Upgrade progress for 67.xx

After your configuration is migrated, you can log on to the ADM GUI. Upon logon, the historical data starts to migrate at the background while you can continue to work on ADM.

13-0-67-x first logon

During historical data migration, some of the old data might not be available. The time taken to migrate your database depends on the size of data and the number of tables.

You can monitor the database migration using the ADM GUI. Click View upgrade progress and the Database Migration Status appears.

13-0-67-x first logon

Troubleshooting database migration issues

During upgrade to 13.0 67.xx, sometimes migration of Web Insight historical data might appear to be stuck. In such cases, to check details of data migration, do the following.

Log on to ADM shell prompt and run the following command to see the granular details of the progress.


    cat /var/mps/log/db_upgrade/web_insight_mapping_migration_status

Here’s an example output

    bash-3.2# cat /var/mps/log/db_upgrade/web_insight_mapping_migration_status
    Tue Oct  6 07:41:55 GMT 2020
    157 out of 127346 done in 54 seconds
    File
     /var/mps/db_upgrade/hist_table_mig_data/Web_Insight/af_app_client_server_resp_second_l3p_d7_dump
    bash-3.2#

In this example, af_app_client_server_resp_second_l3p_d7 is the entry that is being upgraded. And 157 entries out of 127,346 is migrated in 54 seconds.

Upgrade a high availability pair from 12.1 release to 13.0 release

For Citrix ADM servers in a high availability mode, you can upgrade by either accessing the active node or the floating IP address. Both the Citrix ADM servers are automatically upgraded to the latest build once you initiate the upgrade process in either of the servers.

Note

If you are upgrading a high availability pair from 12.0 or earlier releases, see Citrix ADM 12.1 Upgrade

Upgrade Citrix ADM disaster recovery deployment

Upgrading Citrix ADM disaster recovery deployment is a two-step process:

  • Upgrade the Citrix ADM nodes configured in high availability mode in the primary site. Later you must upgrade the disaster recovery node.

  • Ensure that you have upgraded the Citrix ADM servers that are deployed in high availability before upgrading the disaster recovery node.

Upgrade the Citrix ADM disaster recovery node

  1. Download Citrix ADM upgrade image file from Citrix download site.

  2. Upload this file to the disaster recovery node using nsrecover credentials.

  3. Log on to the disaster recovery node using the nsrecover credentials.

  4. Navigate to the folder where you placed the image file and unzip the file.

    Upgrade dr agent1

  5. Run the following script:

    ./installmas

    Upgrade dr agent2

Upgrade on-prem agents for multisite deployment

Upgrading Citrix ADM agent deployment is a three-step process. Ensure that you have completed the following tasks before upgrading the on-prem agents:

  1. Upgrade the Citrix ADM servers that are deployed in high availability.

  2. Upgrade the Citrix ADM disaster recovery node.

    For more information, see Upgrade Citrix ADM disaster recovery deployment.

Upgrade the on-prem agent

  1. Download Citrix ADM agent upgrade image file from Citrix download site.

  2. Upload this file to Agent node using nsrecover credentials.

  3. Ensure that you download the correct agent upgrade image. The following is an example of an image file name format:

    build-masagent-13.0-48.18.tgz

  4. Log on to the on-prem agent using the nsrecover credentials.

  5. Navigate to the folder where you placed the image file and unzip the file.

    Upgrade dr agent3

  6. Run the following script:

    ./installmasagent

    Upgrade dr agent4

Add an extra disk to the Citrix ADM server

If your Citrix ADM storage requirement exceeds the default disk space (120 GB), you can attach an extra disk. You can attach more disk in both single-server and high availability deployments.

When you upgrade Citrix ADM from release version 12.1–13.0, the partitions that you had created on the additional disk in the earlier version remain the same. The partitions are not removed nor are they resized.

The procedure to attach more disk remains the same in the upgraded build. You can now use the new disk partitioning tool in Citrix ADM to create partitions in the newly added disk. You can also use tool to resize the partitions in the existing more disk. For more information on how to attach more disks and to use the new disk partitioning tool, see How to attach an extra disk to Citrix ADM.

Provision Citrix ADC instances in OpenStack using StyleBooks

From Citrix ADM 12.1 build 49.23 onwards, the architecture of OpenStack orchestration workflow has been updated. The workflow now uses Citrix ADM StyleBooks to configure Citrix ADC instances. If you upgrade to Citrix ADM 13.0 from version 12.0 or 12.1 build 48.18, you must run the following migration script:

/mps/scripts/migration_scripts/migrate_configurations.py

For more information about the os-cs-lb-mon StyleBook and the migration script, see Provisioning of Citrix ADC VPX instance on OpenStack using StyleBook