Citrix Application Delivery Management service

Onboard Citrix ADC instances using Citrix ADM service connect

Following is a step-by-step guide to help you get started with ADM service. Before you start, read how the Citrix ADM service launches a new onboarding workflow, which provides you a faster way to get complete visibility into your hybrid multi-cloud (HMC) deployment. See Low-touch onboarding of Citrix ADC instances using Citrix ADM service connect.

Step 1: Get started

  1. In the email, click Get Started to initiate the onboarding process.
  2. Sign in to Citrix Cloud using your My Citrix/Citrix Cloud credentials.
  3. In the Citrix ADM service landing page, take a moment to read why you are there and the benefits of using ADM.

    View asset insights

  4. Click View Asset Insights. The Asset Insights page opens.

Step 2: Asset Insights

The Asset Insights page uses the data collected through Call Home and ADM service connect to provide insights on your ADC instances. This page gives you insights into your overall ADC infrastructure, key metrics, trends, and highlights the issues affectingADC performance and health and recommends way to mitigate the issues. The insights are categorized into the following types:

  1. Recent Events: Get a summary of all critical errors that have happened on the ADC instances and the list of all ADC instances that have critical errors.

    Recent events

  2. ADC deployment: Have visibility into ADC instances that are deployed as standalone ADC and recommendation to configure these ADC instances as an HA pair using maintenance jobs on ADM.

    ADC deployment

  3. ADC Maintenance Program: Get details of all ADC instances that have maintenance programs expiring.

    ADC maintenance program

  4. Resource utilization: Find insights about high resource utilization for CPU, memory, HTTP throughput, and SSL throughput. For each insight, ADM suggests recommended action:

    • CPU: Predict CPU utilization for the next 24 hours on ADM.
    • Memory: Predict memory utilization for the next 24 hours on ADM.
    • SSL throughput: View SSL real time optimization with intelligent App Analytics on ADM.
    • HTTP Throughput: Troubleshoot ADC throughput capacity issues with Infrastructure Analytics.

    Resource utilization

  • Key Metrics: Get details of key metrics related to CPU, memory, HTTP throughput, SSL throughput, and uncover anomalous trends in metrics.

Key metrics

After you’ve checked your insights, click Onboard ADC instances.

Onboard ADC instances

Step 3: Asset Inventory

This page displays all the ADC instances in your environment.

  1. View and select the ADC instances you want to onboard to ADM service.

    Asset inventory

    If you need details about any instance such as device, configuration, feature, or license information, click the instance IP address under the ADC instance.

    Instance details


    If your instance is not listed, use the Find and Add ADC option on the upper-right corner. Enter the details in the mandatory fields (serial ID, ADC instance IP address, license serial number, and fulfillment ID) and search.

    Find and add ADC

  2. Click Onboard ADC instances.

Step 4: ADC onboarding to ADM service

You can onboard your instances using the built-agent (default option) or an external agent.

Onboard agents

Onboard ADC instances using a built-in agent

Auto- and script-based onboarding use the built-in agent, which is set by default.

Auto-onboarding: it is supported only on the following ADC versions:

  • Citrix ADC MPX and VPX image version 12.1 57.18 and later and 13.0 61.48 and later
  • SDX version image 13.0 61.48 and later and 12.1 58.14 and later

ADC Selection displays the total number of instances you’ve selected for onboarding. Select a profile under Device Profile.

Out of the total selected ADC instances, some instances might qualify for auto-onboarding (based on minimum version criteria). Under Registration, the instances that qualify for auto-onboarding are displayed. Click Start onboarding to onboard your ADC instances on ADM.

Onboard ADC using built-in agent

Auto-onboarding might take up to 15 minutes to complete. This is because Citrix ADM service connect sends a request probe to ADM service every 15 minutes.

Onboarding progress


If you don’t want the ADC instances to auto-onboard to ADM (for security reasons), you can disable auto-onboarding and you use the script-based option for on onboarding.

Script-based onboarding: after auto-onboarding completes, you can onboard the rest of the instances using the script-based onboarding. Use one of the following options:

  • Download the script, extract the tar file, and run it on any one of the ADC instances, using the command given on the UI. Ensure that the ADC instance on which you run this script has network connectivity to all the other selected ADC instances.

  • Log in to the CLI console of each ADC instance and run the commands given on the UI. For more details, refer to step 7 in the doc Configure the ADC built-in agent to manage instances. Ensure that you generate a new unique activation code for each of the ADC instances.

    Script-based onboarding

After you’ve onboarded all your instances, click View instance dashboard to go to the ADM instance management UI dashboard and explore the different features.


If you are a new customer on ADM Service, your Citrix service account by default is an Express account. For more information about the ADM account entitlement, see Manage Citrix ADM resources using Express account.

Onboard ADC instances using an external agent

You can use external agent-based onboarding if you want to use pooled licensing or the complete analytics suite in ADM service or both use pooled licensing and the complete analytics suite.

Onboard ADC using external agent

Complete the following steps:

  1. Select a device profile.


    For security reasons, you can’t use the default ADC credentials (nsroot/nsroot) for onboarding.

  2. Select an external agent and click Setup new agent.

  3. Select any of the following environments:

    • Amazon Web Services
    • Microsoft Azure
    • Google Cloud Platform
    • On-premises

Install an agent on your on-premises hypervisor

If you select On-premises, you can install the agent on the following hypervisors: Citrix Hypervisor, VMware ESXi, Microsoft Hyper-V, Linux KVM Server.

Select on-premises

  1. Select On a Hypervisor (On Premises) and click Next.

    Select hypervisor

  2. Select the hypervisor type and download the image, for example, VMware ESXi.

    Download image

  3. Use the service URL and activation code to configure the agent.

    Configure agent

    The agent uses the service URL to locate the service and the activation code to register with the service. For detailed instructions about installing an agent on your on-premises hypervisor, see Install Citrix ADM agent on-premises

  4. Click Register Agent. When completed, and click Done to return to the ADC onboarding ADM service page.

    Complete onboarding

  5. Click Start onboarding. After you’ve onboarded all your instances, click View instance dashboard to go to the ADM instance management UI dashboard and explore the different features.

    View instance dashboard

Install an agent on a public cloud

You can install the agent in one of the following cloud environments:

  • Amazon Web Services
  • Microsoft Azure
  • Google Cloud Platform

For more information, see the following documents:

Onboard Citrix ADC instances using Citrix ADM service connect