Product Documentation
NetScaler Application Delivery Management service
View PDF

Getting started

July 18, 2023
Contributed by: 
C R S

This document walks you through how to get started with onboarding and setting up NetScaler ADM for the first time. This document is intended for network and application administrators who manage Citrix network devices (NetScaler, NetScaler 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 NetScaler ADM.

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

    NetScaler ADM Express account

  3. Select a region that suits your business need.

    Important

    You cannot change the region later.

  4. Select roles and use cases that apply to you.

    Role and use cases

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 NetScaler ADM resources. If your NetScaler ADM Express account remains inactive for 90 days, the account gets deleted. For more information, see Manage NetScaler ADM using Express account.

When you log back on to your Citrix Cloud account, the NetScaler 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 deployment options that suits your business requirement:

Select deployment options

  • Smart deployment - This option is an automated environment setup to deploy new ADC instances. It automatically installs an agent to enable communication between the NetScaler ADM and the managed instances.

    This option supports AWS, Microsoft Azure, and Google Cloud environments. In three steps, you can deliver an application that is present in the cloud using ADC instances.

    Smart deployment workflow

  • Custom deployment - This option is a multi-stage deployment. You can select each environment option and deploy or discover ADC instances.

Select smart deployment for AWS

This deployment option creates the following infrastructure in AWS:

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

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

  • An ADC Autoscale group. You can customize this group later in the Infrastructure > Public Cloud > Autoscale Groups page.

Before deploying 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, perform the following steps:

  1. In Create Cloud Access profile, select AWS as a deployment environment. Specify Access Profile Name and Role ARN to create a Cloud Access Profile.

    Add access profile name

    Role ARN

    The NetScaler ADM uses the Cloud Access Profile to access an AWS account.

  2. Specify the following details to prepare the AWS environment:

    1. In 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

    2. In ADC AutoScale Group Details, specify the following to Autoscale ADC instances in the AWS cloud:

      • AutoScale Group Name - A name to identify an Autoscale group.

      • Availability Zones - Select the zones in which you want to create the Autoscale groups.

        You can select multiple zones from the list.

      • Deployment Type - Select either Evaluation or Production option.

        If you want to evaluate the NetScaler ADM Autoscale solution before purchasing the production license, select the Evaluation option.

        Important

        • The evaluation option supports only one availability zone.
        • With the evaluation option, you can select only NetScaler VPX Express. And, the NetScaler ADM Autoscale solution can scale up to three ADC instances.

      • NetScaler VPX product - Select licenses to provision ADC instances.

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

        Review and select the user consent message.

      • Instance type - Select the required instance type.

        Autoscale group details

    3. Click Next.

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

      ADC deployment in AWS

  3. After the successful ADC deployment, click Deploy Application.

    In Configure Application, specify the necessary details and click Submit.

    Configure ASG applications

    For more information, see Configure an application for the Autoscale group.

Select smart deployment for Microsoft Azure

This deployment option creates the following infrastructure in Azure:

  • An Azure Resource Manager (ARM) template to create the required infrastructure that includes subnets, security groups, NAT gateways, and so on.

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

  • An ADC Autoscale group. You can customize this group later in the Infrastructure > Public Cloud > Autoscale Groups page.

Before deploying ADC instances, ensure the following:

  • You possess a Microsoft Azure account that supports the Azure Resource Manager deployment model.

  • You have a resource group in Microsoft Azure.

For more information on how to create an account and other tasks, see Microsoft Azure Documentation.

To deploy ADC instances, perform the following steps:

  1. In Create Cloud Access profile, select Microsoft Azure as a deployment environment. Specify NetScaler ADM and ADC cloud access profile details.

    NetScaler ADM and ADC cloud access profiles for Azure

    The NetScaler ADM uses the NetScaler ADM Cloud Access Profile to access a Microsoft Azure account. And, an ADC Cloud Access Profile is used to provision NetScaler VPX instances.

  2. Specify the following details to prepare the Azure environment:

    1. In Application Environment Details, specify a name for your deployment. And, ensure that the correct Cloud Access Profile is selected.

      Azure application environment details

    2. In Data Center Details, specify the region, resource group, and virtual network details where you want to deploy ADC instances.

      Azure data center details

    3. In ADC AutoScale Group Details, specify the following:

      • Availability - Select the availability zone or set in which you want to create the Autoscale groups. Depending on the cloud access profile that you have selected, availability zones appear on the list.

      • Deployment Type - Select either Evaluation or Production option.

        If you want to evaluate the NetScaler ADM Autoscale solution before purchasing the production license, select the Evaluation option.

        Important

        • The evaluation option supports only one availability zone or set.
        • With the evaluation option, you can select only NetScaler VPX Express. And, the NetScaler ADM Autoscale solution can scale up to three ADC instances.

      • Select NetScaler VPX product - Select licenses to provision ADC instances.

        Subscribe to this Azure Marketplace license and return to the page.

        Review and select the user consent message.

      • Select VM size - Select the required virtual machine size.

      Azure ADC Autoscale group details

    4. Click Next.

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

  3. After the successful ADC deployment, click Deploy Application.

    In Configure Application, specify the necessary details and click Submit.

    Configure ASG applications

    For more information, see Configure an application for the Autoscale group.

Select smart deployment for Google Cloud

This deployment option creates the following infrastructure in Google Cloud:

  • A Google Cloud Deployment Manager to create the required infrastructure that includes VPC networks, subnets, Cloud NAT, Cloud Router gateways, and firewall rules.

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

  • An ADC Autoscale group. You can customize this group later in the Infrastructure > Public Cloud > Autoscale Groups page.

Before deploying ADC instances, ensure that you already possess a Google Cloud account. For more information on how to create an account, see Google Cloud Documentation.

To deploy ADC instances, perform the following steps:

  1. In Create Cloud Access profile, select Google Cloud as a deployment environment.

    Specify Cloud Access Profile Name and Service Account Key.

    Create a Cloud Access Profile for Google Cloud

    The NetScaler ADM uses the Cloud Access Profile to access a Google Cloud account.

  2. Specify the following details to prepare the Google Cloud environment:

    1. In Application Environment Details, specify a name for your deployment. And, ensure that the correct Cloud Access Profile is selected.

      Google Cloud environment details

    2. In Data Center Details, select Google Cloud Region where you want to deploy ADC instances.

      Google Cloud Region

    3. In ADC AutoScale Group Details, specify the following to Autoscale ADC instances in Google Cloud:

      • VPC Network’s Subnet CIDR - Specify a VPC network created for management, client, and server traffic. However, you can select the existing network for server.

      • Zones - Select the zones in which you want to create the Autoscale groups.

        You can select multiple zones from the list.

      • Deployment Type - Select either Evaluation or Production option.

        If you want to evaluate the NetScaler ADM Autoscale solution before purchasing the production license, select the Evaluation option.

        Important

        • The evaluation option supports only one availability zone.
        • With the evaluation option, you can select only NetScaler VPX Express. And, the NetScaler ADM Autoscale solution can scale up to three ADC instances.

      • NetScaler VPX product - Select licenses to provision ADC instances.

      • Machine type - Select the required instance type.

        Autoscale group details

    4. Click Next.

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

  3. After the successful ADC deployment, click Deploy Application.

    Google Cloud application delivery successful

    In Configure Application, specify the necessary details and click Submit.

    Configure ASG applications

    For more information, see Configure an application for the Autoscale group.

Select custom deployment

This option provides a multi-stage deployment. Select this option to discover ADC instances from various environments. With this option, you can also deploy new instances by specifying custom environment options.

Perform the following steps to deploy or discover ADC instances:

  1. Select any of the following environments:

    • AWS
    • Microsoft Azure
    • Google Cloud Platform
    • On-premises

    Select environment options

  2. Install the NetScaler ADM Agent to enable communication between the NetScaler ADM and the managed instances in your data center or cloud.

    The Select Agent Type step varies the agent installation options depending on the selected environment.

    • On-premises - If you select On-premises, you can install an agent on the following hypervisors:

      • Citrix Hypervisor

      • VMware ESXi

      • Microsoft Hyper-V

      • Linux KVM Server

      Select on-premises agent

    • Public clouds - If you select AWS, Microsoft Azure, or Google Cloud Platform, you can externally install an agent on the selected cloud.

      The following is an example image for the AWS environment.

      Select an AWS agent

    • As a microservice - To deploy an agent as a Kubernetes application.

      Agent as a microservice

    • Built-in agent - To discover built-in agents available with NetScaler version 12.0 or later.

      Configure a built-in agent

  3. Click Next

    Steps to install an agent vary for every option. The following links guide you to the specific steps to install an agent:

Install an agent on a hypervisor

Perform the following steps to set up an NetScaler ADM agent on a hypervisor:

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

  2. Copy the service URL and an activation code.

    Hypervisor3

  3. Specify the copied 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. For detailed instructions about installing an agent on your on-premises hypervisor, see Install NetScaler ADM agent on-premises.

  4. After successful agent installation, return to the Set Up Agent page and click Register Agent.

Next step: Add instances.

Note

If you do not want to add agents during the initial setup, click Skip to check the features provided by NetScaler 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

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.

  1. Copy and save the service URL and the activation code to use during agent installation.

    If you want a new activation code, click Create new Activation Code, and then copy and save the code to use during agent installation.

    Public cloud1

  2. After successful agent installation, return to the Set Up Agent page and click Register Agent.

Next step: Add instances.

Install an agent as a microservice

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

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

  1. 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 NetScaler ADM through the agent.

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

      Microservice download agent

    4. Click Submit.

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

  3. Click Close.

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

Use the built-in agent

The NetScaler 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 NetScaler ADM.

  1. Copy the generated Service URL and the Activation Code. Save them to use while initiating the built-in agent on your NetScaler instance.

    Built-in agent

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

  2. After the built-in agent is initiated, return to the Set Up Agent page and click Register Instance.

Next step: Add instances.

Add instances

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

After the successful agent installation and registration, the agents are 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

  1. In the Add Instances page, view the ADC instances that are connected to the registered agent. Ensure that the instance is in the Up status and click Next.

    View ADC instances

  2. 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 NetScaler ADM, see Adding Instances.

Onboard ADC instances by using the NetScaler ADM GUI dashboard

If you’ve skipped onboarding the ADC instances in the Getting Started workflow while setting up NetScaler ADM for the first time, you can onboard the instances from the NetScaler ADM GUI dashboard. If the ADC instances are not yet added, the GUI prompts you to add the instances.

When you click any module on the left-hand navigation bar, on the right-hand side a tabular preview of the features and benefits of that module appears. These features and benefits help you better manage ADC instances by using NetScaler ADM.

Features and benefits carousel

Click Add ADC instances to onboard the instances. The Get Started workflow restarts. Follow the steps from Step 3: Select an ADC deployment type onwards, given in this document, to onboard the instances. If the ADC instances are already onboarded, after you log on to NetScaler ADM, you see only the NetScaler ADM landing page with the navigation bar on the left.

Agent actions

After you’ve set up your NetScaler ADM, you can apply various actions to an agent. Navigate to Infrastructure > Instances > 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 agent 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 NetScaler ADM agent. You can download this file and send it to Citrix technical support for investigation and troubleshooting.

View agent diagnostics and receive alerts for endpoint verification

NetScaler ADM performs a periodic (every one hour) diagnostic check for the agent and provides the following information:

  • Endpoint reachability – Checks if all endpoints are reachable. The ADM agent uses various endpoints for the communication between ADM and ADC instances. For more information, see Software Requirements.

  • Health check probe – Provides the time stamp of the latest health check.

  • Agent proxy – Checks if the agent proxy exists.

If the agent endpoint reachability status changes (from OK to Needs Review), the super administrator receives an email notification comprising the issue details. Navigate to Infrastructure > Instances > Agents to view the newly added Diagnostics Status option that provides the status such as Needs Review or OK.

Agent diagnostic status

Click to view the diagnostic information of an agent.

Diagnostic information

  • Category. Provides the issue category.

  • Status. Provides the issue status such as Needs Review or OK.

  • Recommendation. Provides the required recommendation to troubleshoot the issue.

After you troubleshoot and the endpoint reachability status changes from Needs Review to OK, the super administrator receives an email notification mentioning that the issue is resolved.

Email notification

The following example is an email notification after the endpoint reachability status has changed from OK to Needs Review:

Diagnostic error notification

The following example is an email notification after the endpoint reachability status has changed from Needs Review to OK:

Issues resolve notification

Getting started
July 18, 2023
Contributed by: 
C R S
July 18, 2023
Contributed by: 
C R S

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.