Citrix Application Delivery Management

Migrate on-premises Citrix ADM to Citrix Cloud

You can migrate on-premises Citrix ADM 13.0 64.35 or a later version to Citrix Cloud. If your ADM has 12.1 or an earlier version, you must first upgrade to 13.0 64.35 or a later version and then migrate to Citrix Cloud. For more information, see the Upgrade section.

ADM service through Citrix Cloud enables you to get:

  • Faster releases, approximately every two weeks with latest feature updates.

  • Machine-learning based analytics for application security and bot, performance, and usage.

  • Various other features that are currently supported only in ADM service, such as peak and lean period analytics, machine-learning based analytics for application security and bot, application CPU analytics, and many more.

For a successful migration, you must:

  • Ensure to have internet connection in on-premises ADM for Citrix Cloud accessibility

  • Configure the ADM service agent

  • Get the client and secret CSV file from Citrix Cloud

  • Validate the ADM service licensing

  • Migrate using a script

Configure the ADM service agent

To enable communications between Citrix ADC instances and Citrix ADM, you must configure an agent. Citrix ADM agents are, by default, automatically upgraded to latest build. You can also select a specific time for the agent upgrade. For more information, see Configuring agent upgrade settings.

  • If your existing on-premises ADM (standalone or HA pair) has no on-premises agents configured, you must configure at least one agent for ADM service.

  • If your existing on-premises ADM (standalone or HA pair) has configured with on-premises agents for multisite deployments, you must configure the same number of agents for ADM service.

For more information on configuring an agent, see the Getting Started section.

Get the client and secret CSV file from Citrix Cloud

After you configure the agent, get the client and secret CSV file from the Citrix Cloud page:

  1. Log on to citrix.cloud.com

  2. Click the Home icon and select Identity and Access Management

    Identity and Access Management

  3. From the API Access tab, enter a secure client name and click Create Client.

    API access

  4. ID and Secret is generated. Click Download and save the CSV file in the on-premises ADM.

    For example, save the CSV file to the /var directory.

    ID and secret file

Validate the ADM service licenses

You must obtain licenses for ADM service.

  • The VIP licenses in ADM service must be more than or equal to the on-premises VIP licenses.

    Note

    If VIP licenses are lesser, then virtual servers are selected randomly and the VIP-level configuration for ADM service fails.

  • If you use ADM on-premises deployment as a license server, reallocate your licenses to ADM Service before migration. For more information, see Configure an ADM server only as the pooled license server and How to reallocate a license file.

  • If you are using the pooled licenses in on-premises ADM, you must obtain the pooled licenses for ADM service and then allocate licenses to the ADC instances. For more information, see Configure Pooled Licensing. The following supported ADC versions enable you to modify the license allocation from ADM:

    • Citrix ADC SDX: 13.0 74.11 or later versions.

    • Citrix ADC VPX and MPX: 13.0 47.24 or later versions, 12.1 58.14 or later versions, and 11.1 65.10 or later versions.

Migrate using a script

  • For ADM 76.x or later builds, the migration scripts (servicemigrationtool.py and config_collect_onprem.py) are available as part of the build, available at cd /mps/scripts.

  • For ADM earlier than 76.x builds, you must download the migration scripts and copy the scripts in on-premises ADM.

    Note

    Ensure that the on-premises ADM has internet connectivity during migration.

  1. Using an SSH client, log on to the on-premises ADM.

    Note

    For an ADM HA pair, log on to the primary node.

  2. Type shell and press Enter to switch to bash mode.

  3. Copy the client ID and secret CSV file. For example, copy the file to the /var directory.

    After you copy the CSV file, you can validate if the CSV file is present.

    Add CSV

    Note

    For an ADM HA pair, copy the CSV file in the primary node.

  4. For ADM 13.0 76.xx version, run the following commands to complete the migration:

    1. cd /mps/scripts

    2. python servicemigrationtool.py <path of ClientID/Secret File in on-premises Citrix ADM VM>

    For example, python servicemigrationtool.py /var/secureclient.csv

  5. For ADM earlier than 13.0 76.xx version:

    1. Download the migration script from the following location: https://download.citrixnetworkapi.net/root/download/v1/public/software?product=admonprem&build=migrationtool&model=servicemigrationtool_27.tgz

      The downloaded file comprises two bundle scripts, servicemigrationtool_27.py and config_collect_onprem_27.py.

    2. Save the two scripts in on-premises ADM. For example, save in the /var directory

    3. Run the following commands to migrate:

      1. cd /var

      2. servicemigrationtool_27.py <path of ClientID/Secret File in on-premises ADM VM>

        For example, python servicemigrationtool_27.py /var/secureclient.csv

After you run the script, it checks the prerequisites and then proceeds with the migration. The script first checks for the license availability. The following message is displayed only if you have lesser ADM service license than the on-premises license.

Lesser on-premises licenses

If you select Y, the migration continues by licensing the VIP randomly. If you select N, the script stops the migration.

If you have the unsupported ADC instance version for the pooled license server, the following message is displayed:

Unsupported ADC version

If you select Y, the migration process continues by changing the license server. If you select N, the script prompts if you want to proceed with rest of the migration. The script stops the migration if you select N.

Depending upon the on-premises configuration, the approximate time for the migration to complete is between a few minutes and a few hours. After the migration is complete, you see the following message:

Migration complete status

The migration is successful once all the ADC and SD-WAN WANOP instances and their respective configurations are successfully moved to ADM service. After successful migration, the on-premises Citrix ADM stops processing the following instance events:

  • SSL certificates

  • Syslog messages

  • Backup

  • Agent cluster

  • Performance reporting

  • Configuration audit

  • Emon scheduler

Migrate on-premises Citrix ADM to Citrix Cloud