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). 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.

Get started

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 Citrix Cloud company account or join an existing one that someone else in your company has created. For detailed processes and instructions on how to proceed, see Signing Up for Citrix Cloud.

Step 2: Manage Citrix ADM with an Express account

After you log on to Citrix Cloud, do the following:

  1. Go to the Available Services section.

  2. On the Application Delivery Management tile, click Manage.

    The Application Delivery Management tile moves to the My Services section.

    Citrix ADM Express account

  3. Select one of the following regions that suits your business need:

    • United States (US)
    • Europe (EU)
    • Australia (ANZ)

    Select region to set up ADM

    Important

    You cannot change the region later.

You can log off from the browser while the initialization completes in the background, which might take some time.

Welcome

Note

Citrix assigns an Express account to manage ADM resources. If your Citrix ADM Express account remains inactive for 90 days, the account gets deleted. For more information, see Manage Citrix ADM Service using Express account.

When you log back on to your Citrix Cloud account, the Citrix ADM GUI screen appears. Click Get Started to begin setting up the service for the first time.

Get started

Step 3: Select an ADC deployment type

Select one of the following options to deploy or discover ADC instances:

  • Amazon Web Services (AWS)
  • Microsoft Azure
  • On-Premises

Select Deployment type

AWS deployment type - you can deliver an application that is present in AWS using ADC instances.

With this option, the ADM creates the following:

  • A CloudFormation stack in AWS to create the required infrastructure that includes subnets, security groups, NAT gateways, and so on.

  • An ADM Agent in the VPC to manage ADC instances.

  • An ADC Autoscale group. You can customize this group later in the Networks > Autoscale Group page.

Before deploying new ADC instances, ensure the following:

  1. You already possess an AWS account.

  2. You have created an IAM user with all administrative permissions.

To deploy ADC instances, provide the following information:

  • Cloud Access Profile - With this profile, the ADM service can access an AWS account to provision ADC instances.

    1. Specify Access Profile Name.

      Add access profile name

    2. Specify Role ARN.

      Role ARN

  • Data Center Details - Select AWS Region and AWS VPC where you want to deploy ADC instances.

    AWS VPC lists the VPCs present in the selected AWS Region.

    Data center details

  • ADC AutoScale Group Details - Specify the following to Autoscale ADC instances in the AWS cloud:

    1. Specify AutoScale Group Name.

    2. Select Availability Zones. You can select multiple zones.

    3. In ADC License, select licenses to provision ADC instances.

      Note

      Currently, ADM supports Production licenses only.

    4. Subscribe to the selected license in the AWS marketplace and return to this page.

    5. Read and select the user consent message.

    6. Select the instance type.

    7. Click Next.

    Autoscale group details

After successful validation, click Create to deploy ADC instances in AWS and create an Autoscale group.

ADC deployment in AWS

Note

If you choose this option, you do not have to install an agent and add instances separately.

After the successful ADC deployment, you can configure applications using StyleBooks.

Step 4: Install the Citrix ADM Agent

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.

Depending on the selected deployment type, you can select an agent to discover ADC instances.

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

  • As a microservice in your Kubernetes master

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.

Hypervisor

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

Hypervisor2

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.

Hypervisor3

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 check 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.

Public cloud

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.

Public cloud1

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.

Install an agent as a microservice

You can deploy a Citrix ADM agent as a microservice in Kubernetes cluster to view service graph in Citrix ADM.

For more information to get started with service graph, see Setting up service graph.

  1. Select the As a Microservice option, and click Next.

    Microservice agent

  2. Specify the following parameters:

    1. Application ID – A string id to define the service for the agent in the Kubernetes cluster and distinguish this agent from other agents in the same cluster.

    2. Agent Password – Specify a password for CPX to use this password to onboard CPX to ADM service through the agent.

    3. Confirm Password – Specify the same password for confirmation.

    4. Click Submit.

  3. After you click Submit, you can download the YAML or Helm Chart.

    Microservice download agent

  4. Click Close.

    For more information, see Install Citrix ADM agent in Kubernetes cluster.

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.

Built-in agent

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.

Built-in agent

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 5: 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.

Add instances

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

Add instances

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

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.

Agent actions

After you’ve set up your ADM service, you can apply various actions to an agent. Navigate to Networks > Agents.

Agent action

Under Select Action, you can use the following features:

Install a new certificate: if you need a different agent certificate to meet your security requirement, you can add one.

Change the default password: to ensure security of your infrastructure, change the default password of an agent.

Generate a technical support file: generate a technical support file for a selected Citrix ADM agent. You can download this file and send it to Citrix technical support for investigation and troubleshooting.