Jump to content
Updated Privacy Statement

Deployment Guide: Migrating Citrix ADM to Citrix ADM service

  • Contributed By: Arnaud Pain


In this document, you'll discover how to migrate Citrix ADM (Application Delivery Management) on-premises to Citrix ADM service. Migrating to cloud resources modernizes your deployment, providing enhanced elasticity, scalability, and management.

The guidance documented here is based on a deployment in a Citrix approved lab environment running on VMware vSphere Hypervisor. The initial and final deployments represent typical customer environments.


We've written this document for users who are

  • Familiar with the administration of a Citrix ADM

It's also helpful if you know Citrix Cloud fundamentals and understand Citrix ADM service.

Set up a basic Citrix Cloud environment

For more information on onboarding process see the Getting Started section. During the initial configuration of the ADM service agent , you need to provide the Service URL and Activation Code that are provided during the initial configuration in Citrix Cloud.



As we migrate from on-premises ADM, we do not need to continue the Agent configuration and can click Skip.

Deploy ADM service agent

More details can be found here.

  1. Download the agent image as instructed in Getting Started.
  2. Import the agent image file to VMware vSphere.
  3. From the Console, configure the initial network configuration options as show in the below example:


  4. After completing the initial network configuration, save the configuration settings.


  5. When prompted, log on using the default (nsrecover/nsroot) credentials.


  6. Run the script /mps/register_agent_cloud.py.


  7. Enter the Service URL and the Activation Code that was provided in Citrix Cloud during initial configuration.


  8. You are prompted to change ADM (Application Delivery Management) Agent default password.


  9. After update of the Agent Password and successful registration, the agent will restart to complete the installation process.


Migrate to ADM service

After the ADM service agent basic configuration is done, the next step is to upgrade the ADM to a Firmware that includes the script that will be used to migrate. You can migrate on-premises Citrix ADM 13.0 76.29 or a later version to Citrix Cloud. If your ADM has 12.1 or an earlier version, you must first upgrade to 13.0 76.29 or a later version and then migrate to Citrix Cloud. For more information, see the Upgrade section.

Once your ADM is on the required version, you can start the process for the migration, the next step is to configure the on-premises ADM service agent.

Configure 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, it is advised to configure the same number of agents for ADM service.

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

  1. Connect to Citrix Cloud.


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


  3. Click API Access tab.


  4. Provide a name for Secure client and click Create Client.


  5. Click Download.



If you use your on-premises ADM deployment as a Pooled license server for ADC instances, you will need, before the migration, to reallocate your licenses to ADM service. In fact, during the migration process, the ADC license configuration is updated to point to ADM service agent instead of your ADM on-premises.

  1. Connect to Citrix Cloud ADM service.
  2. Navigate to Networks > Licenses.


  3. Take note of your Host ID and go to https://www.mycitrix.com to reallocate your licenses.
  4. Ensure your licenses are present in ADM service before starting the migration.



The secureclient.csv downloaded from previous steps needs to be uploaded to primary ADM. Copy the client ID and secret CSV file, for example, in the /var directory.


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


We recommend to updating to ADM 76.x or later builds as the migration scripts (servicemigrationtool.py and config_collect_onprem.py) are available as part of the build, available in /mps/scripts.


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

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

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


  2. Enter in Shell
  3. Validate if the CSV file is present.


  4. Run the following commands to complete the migration:

    a. cd /mps/scripts

    b. python servicemigrationtool.py

For example: python servicemigrationtool.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.


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:


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. If you have the supported ADC instance version for the pooled license server, the following message is displayed:



You will only see above the Primary Node IP Address.

If you select Y, the migration process continues by changing the license server. 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:


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


You can connect to Citrix ADM service and ensure you see your ADC instance.


User Feedback

There are no comments to display.

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Create New...