Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

Add instances to Citrix ADM

December 31, 2023
Contributed by: 
C

Instances are Citrix appliances or virtual appliances that you want to discover, manage, and monitor from Citrix ADM. You must add instances to the Citrix ADM server if you want to manage and monitor these instances. You can add the following Citrix appliances and virtual appliances to Citrix ADM:

  • Citrix ADC MPX

  • Citrix ADC VPX

  • Citrix ADC SDX

  • Citrix ADC CPX

  • Citrix ADC BLX

  • Citrix Gateway

  • Citrix SD-WAN

You can add instances either while setting up the Citrix ADM server for the first time or later. You must then specify an instance profile that Citrix ADM can use to access the instance.

Note

  • Citrix ADM uses the NetScaler IP (NSIP) address of the Citrix ADC instances for communication. For information about the ports that must be open between the Citrix ADC instances and Citrix ADM, see Ports.

  • For Citrix SD-WAN WO and Citrix SD-WAN EE instances, Citrix ADM uses the management IP address of the instances for communication.

  • To learn how Citrix ADM discovers instances, see Discover instances.

How to create a Citrix ADC profile

Citrix ADC profile contains the user name, password, communication ports, and authentication types of the instances that you want to add to Citrix ADM. For each instance type, a default profile is available. For example, the nsroot is the default profile for Citrix ADC instances. The default profile is defined by using the default Citrix ADC administrator credentials. If you have changed the default admin credentials of your instances, you can define custom instance profiles for those instances. If you change the credentials of an instance after the instance is discovered, you must edit the instance profile or create a profile, and then rediscover the instance.

You can create a Citrix ADC profile from the Instance page or while adding or changing an instance.

Note

Ensure to use the super administrator account to create an instance profile.

To create a Citrix ADC profile from the Instance page:

  1. Navigate to Networks > Instances.

  2. Select an Instance. For example, Citrix ADC.

  3. On the Citrix ADC page, under Select Action select Profiles.

    Dashboard

  4. On the Admin Profiles page, select Add.

    Admin-profile

  5. On the Create Citrix ADC Profile page, do the following:

    Create-profile

    1. Profile Name: Specify a profile name for the Citrix ADC instance.

    2. User Name: Specify a user name to log on to the Citrix ADC instance.

    3. Password: Specify a password to log on to the Citrix ADC instance.

    4. SSH Port: Specify the port for SSH communication between Citrix ADM and the Citrix ADC instance.

    5. HTTP Port: Specify the port for HTTP communication between Citrix ADM and the Citrix ADC instance.

      Note

      The default HTTP port is 80. You can also specify the non-default or customized HTTP port that you might have configured in your Citrix ADC CPX instance. The customized HTTP port can be used for communication only between Citrix ADM and Citrix ADC CPX.

    6. HTTPS Port: Specify the port for HTTPS communication between Citrix ADM and the Citrix ADC instance.

      Note

      The default HTTPS port is 443. You can also specify the non-default or customized HTTPS port that you might have configured in your Citrix ADC CPX instance. The customized HTTPS port can be used for communication only between Citrix ADM and Citrix ADC CPX.

    7. Use global settings for Citrix ADC communication: Select this option if you want to use the system settings for communication between Citrix ADM and Citrix ADC instance, otherwise select either HTTP or https.

    8. SNMP Version: Select either SNMPv2 or SNMPv3 and do the following:

      1. If you select SNMPv2, specify the Community name for authentication.

      2. If you select SNMPv3, specify the Security Name and Security Level. Based on the security level, select the Authentication Type and Privacy Type.

        SNMP-create

        Note

        For Citrix ADC SDX, only SNMPv2 is supported.

    9. Timeout Settings: Specify the time that Citrix ADM must wait before sending a connection request to the Citrix ADC instance after a restart.

    10. Select Create.

Add ADC instances to Citrix ADM

You can add instances either while setting up the Citrix ADM server for the first time or later.

To add instances, you must specify either the host name or IP address of each Citrix ADC instance, or a range of IP addresses.

For SD-WAN instances, specify the IP address of each instance, or a range of IP addresses. Note that Citrix ADM supports only Citrix SD-WAN WO and Citrix SD-WAN PE editions.

Note

  • To add Citrix ADC instances configured in a cluster, you must specify either the cluster IP address or any one of the individual nodes in the cluster setup. However, on Citrix ADM, the cluster is represented by the cluster IP address only.

  • For Citrix ADC instances set up as an HA pair, when you add one instance, the other instance in the pair is automatically added.

If two Citrix ADM servers are set up in high availability mode, when an instance is added, the traffic source is through the ADM floating IP address.

When you add an instance from a remote data that is configured with an on-prem agent, the traffic source is through the ADM agent.

To add an instance to Citrix ADM:

  1. Log on to Citrix ADM with administrator credentials.

  2. Navigate to Networks > Instances > Citrix ADC. Select the type of instance you want to add (for example, Citrix ADC VPX) and click Add.

    Add-instance

  3. Select one of the following options:

    • Enter Device IP address - For Citrix ADC instances, specify either the host name or IP address of each instance, or a range of IP addresses.

      If you want to discover an ADC HA pair using SNIP, ensure the Independent Network Configuration (INC) mode is enabled. And, specify the SNIP addresses in the following format:

       <SNIP of primary instance>#<SNIP of secondary instance>
 <!--NeedCopy-->

      For example, 10.10.10.11#10.10.10.12

      For SD-WAN instances, specify the IP address of each instance, or a range of IP addresses.

    • Import from file - From your local system, upload a text file that contains the IP addresses of all the instances you want to add.

  4. From Profile Name, select the appropriate instance profile, or create a new profile by clicking the + icon.

  5. From Site, select the location where you want to add the instance, or create a new location by clicking the + icon.

  6. Click OK to initiate the process of adding instances to Citrix ADM.

Note

If you want to rediscover an instance, navigate to Networks > Instances > Citrix ADC. Select the instance type (for example, VPX) and select the instance you want to rediscover, and then from the Select Action list, click Rediscover.

Add ADC CPX instances to Citrix ADM

Citrix ADM has been enhanced to provide support to the improvements that has been accomplished in CPX functionalities. Citrix ADC CPX instance is now added in Citrix ADM by providing an IP address for the CPX along with a device profile. The process of addition of a CPX instance is now similar to how other ADC types such as VPX or MPX is added in ADM. Also, the registration of CPX in ADM has been enhanced. When a CPX starts, Citrix ADM automatically discovers and registers the CPX instance. A CPX instance is no longer discovered through Docker host.

  1. Navigate to Networks > Instances > Citrix ADC and click CPX tab.

  2. Click Add to add new CPX instances in Citrix ADM.

  3. The Add Citrix ADC CPX page opens. Enter the values for the following parameters:

    1. You can add CPX instances by providing either the reachable IP address of the CPX instance or the IP address of the Docker container where the CPX instance is hosted.

    2. Select the profile of the CPX instance.

    3. Select the site where the instances are to be deployed.

    4. Select the agent.

    5. As an option, you can enter the key-value pair to the instance. Adding key-value pair makes it easy for you to search for the instance later.

      Add Citrix ADC CPX

    Note

    For Citrix ADC CPX instances, you must specify the HTTP, HTTPS, SSH, and SNMP port details of the host while creating the CPX instance profile. You can also specify the range of ports that were published by the host in the Start Port and Number of ports field.

  4. Click OK.

Add a standalone Citrix ADC BLX instance in Citrix ADM

A standalone Citrix ADC BLX instance is a single instance that is running on the dedicated host Linux server.

  1. Navigate to Networks > Instances > Citrix ADC.

  2. In the BLX tab, click Add.

  3. Select the Standalone option from the Instance Type list.

  4. In the IP address field, specify the IP address of the BLX instance.

  5. In the Host IP address field, specify the IP address of the Linux server where the BLX instance is hosted.

  6. In the Profile Name list, select the appropriate profile for a BLX instance, or create a profile.

    To create a profile, click Add.

    Important

    Ensure you have specified the correct host user name and password of the Linux server in the profile.

  7. In the Site list, select the site where you want to add an instance.

    If you want to add a site, click Add.

  8. In the Agent list, select the Citrix ADM agent to which you want to associate the instance.

    If there is only one agent configured on your Citrix ADM, that agent is selected by default.

  9. Click OK.

Add Citrix ADC BLX standalone instance to Citrix ADM

Add high-availability Citrix ADC BLX instances in Citrix ADM

The high-availability Citrix ADC BLX instances that run on different host Linux servers. A Linux server cannot host more than one BLX instances.

  1. In the BLX tab, click Add.

  2. Select the High Availability option from the Instance Type list.

  3. In the IP address field, specify the IP address of the BLX instance.

  4. In the Host IP address field, specify the IP address of the Linux server where the BLX instance is hosted.

  5. In the Peer IP address field, specify the IP address of the peer BLX instance.

  6. In the Peer Host IP address field, specify the IP address of the Linux server where the peer BLX instance is hosted.

  7. In the Profile Name list, select the appropriate profile for a BLX instance, or create a profile.

    To create a profile, click Add.

    Important

    Ensure you have specified the correct host user name and password of the Linux server in the profile.

  8. In the Site list, select the site where you want to add an instance.

    If you want to add a site, click Add.

  9. In the Agent list, select the Citrix ADM agent to which you want to associate the instance.

    If there is only one agent configured on your Citrix ADM, that agent is selected by default.

  10. Click OK.

Add Citrix ADC BLX high-availability instances to Citrix ADM

Access an instance GUI from the Citrix ADM

  1. Navigate to Networks > Instances > Citrix ADC.

  2. Select the type of instance you want to access (for example, VPX, MPX, CPX, SDX, or BLX).

  3. Click the required Citrix ADC IP address or host name.

View-instance

The GUI of the selected instance appears in a pop-up window.

Add instances to Citrix ADM
December 31, 2023
Contributed by: 
C
December 31, 2023
Contributed by: 
C

In this article

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