Product Documentation

Getting started

This document walks you through how to get started with onboarding and setting up Citrix Application Delivery Management (Citrix ADM) for the first time. This document is intended for network and application administrators who manage Citrix network devices (Citrix ADC, SD-WAN WO, Citrix Gateway, Citrix Secure Web Gateway, and so on). You must follow the steps in this document irrespective of the type of device you plan to manage using Citrix ADM.

The following image illustrates the steps you have to perform to get started.

localized image

Before you begin onboarding, make sure you review the browser requirements, the agent installation requirements, and the port requirements.

Step 1: Sign Up for Citrix Cloud

To start using Citrix ADM, you must first create a new Citrix Cloud company account or join an existing one that has been created by someone else in your company. For detailed processes and instructions on how to proceed, see Signing Up for Citrix Cloud.

localized image

Step 2: Request a Citrix ADM trial

After you log on to Citrix Cloud, a screen similar to the following appears. In the Available Services section, on the NetScaler Management and Analytics Service tile, click Request Trial.

localized image

The NetScaler Management and Analytics Service tile moves to the My Services section, and the button then changes to View Trial Status. You will receive an email to notify you when your trial becomes available. It might take a few minutes. After you are authorized to access the trial, the button on the tile changes to Manage. Click Manage to log on to the Citrix ADM GUI.

Note

Citrix assigns permissions to you to access the Citrix ADM for a 30-day trial period. For information about trial subscriptions and how to buy, see https://www.citrix.com/products/citrix-cloud/subscriptions.html.

The following image shows the Citrix ADM GUI screen. Click Get Started to begin setting up the service for the first time.

localized image

Step 3: Install the Citrix ADM Agent

You must install and configure the Citrix ADM agent in your network environment to enable communication between the Citrix ADM and the managed instances in your data center or cloud.

You can install an agent on the following:

  • Hypervisors in your enterprise data center:
    • Citrix XenServer
    • VMware ESXi
    • Microsoft Hyper-V
    • Linux KVM Server
  • Public clouds:
    • Microsoft Azure cloud
    • Amazon Web Service cloud

You can also use the built-in agent available on the Citrix ADC instances.

Note: To use the built-in agent, ensure that you upgrade your Citrix ADC instance to the version 12.0.56.20.

Install an agent on a hypervisor

To install an agent on a hypervisor, on the Select Agent Type page, select On a Hypervisor (On Premises) and click Next.

localized image

On the Set Up Agent page, select the hypervisor and click Download Image to download the agent image to your local system.

localized image

A service URL and an activation code are generated and displayed on the GUI. Copy both because you have to enter the service URL and the activation code while installing the agent on your hypervisor. The agent uses the service URL to locate the service and the activation code to register with the service.

localized image

For detailed instructions about installing an agent on your on-premises hypervisor, see Installing Citrix ADM Agent on Premises.

Once you have installed the agent on your on-premises hypervisor, on the Set Up Agent page, click Register Agent.

Note

If you do not want to add agents during the initial setup, click Skip to take a look at the features provided by Citrix ADM. You can add the agents and instances later. To add agents later, navigate to Settings > Set up Agents. For instructions about how to add instances later, see Adding Instances.

Install an agent on a public cloud

To install the agent on the cloud, on the Select Agent Type page, select On Public Cloud and click Next.

localized image

You do not have to download the agent image from the Set Up Agent page. The agent image is available on the respective cloud marketplace.

localized image

You must, however, generate the service URL and the activation code by clicking Generate Activation Code, and then copy and save them to use during agent installation.

Once you have installed the agent on your public cloud, on the Set Up Agent page, click Register Agent.

Use the built-in agent in the Citrix ADC instance

The Citrix ADC instances in your environment include a built-in agent. You can initiate the built-in agent and use it to establish communication between the instance and Citrix ADM.

To use the built-in agent on the Citrix ADC instance, on the Select Agent Type page, select Built-in Agent and click Next.

localized image

For detailed instructions about initiating the built-in agent on your Citrix ADC instance, see Initiate Built-in Agent on the Citrix ADC instance.

On the Set Up Agent page, copy the generated Service URL and the Activation Code. Save them to use while initiating the built-in agent on your Citrix ADC instance.

localized image

After the built-in agent is initiated, click Register Instance on the Set Up Agents page to register the built-in agent with Citrix ADM.

Step 4: Add instances to Citrix ADM

Instances are network appliances or virtual appliances that you want to discover, manage, and monitor from Citrix ADM. To manage and monitor these instances, you must add the instances to the service.

After you have successfully installed and registered the agent, it is displayed on the Set Up Agent page. When the agent status is in the UP state denoted by a green dot next to it, click Next to start adding instances to the service.

localized image

On the Add Instances page, specify values for Instance TypeIP Address, and Instance Authentication Profile Name, and then click Add Instances.

localized image

After the instances are added, you can view the number of instances that have been successfully discovered.

localized image

Click Done to complete your initial setup and start managing your deployment.

Note

If you do not want to add instances during the initial setup, you can click Done to complete the setup and add the instances later. For instructions about how to add instances later to Citrix ADM, see Adding Instances.