Product Documentation

Adding instances

You can add instances either while setting up the Citrix Application Delivery Management (Citrix ADM) for the first time or at a later time.

Instances are Citrix appliances or virtual appliances that you want to discover, manage, and monitor from Citrix ADM. 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 Gateway
  • Citrix Secure Web Gateway
  • Citrix SD-WAN WO

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.

You must then specify an instance profile that Citrix ADM can use to access the instance. This instance profile contains the user name and password of the instance(s) that you want to add to the service. For each instance type, a default profile is available. For example, the ns-root-profile is the default profile for Citrix ADC instances. This profile is defined by 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 new profile, and then rediscover the instance.

You can access the GUIs of Citrix ADC instances from the Citrix ADM after adding the instances in Citrix ADM. To access the Citrix ADC instances from the Citrix ADM, you must be connected to the Citrix network.

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.

To add a Citrix ADC instance to Citrix ADM

Note

Perform this task to add all other ADC instances except the ADC CPX instance.

  1. Navigate to Networks > Dashboard and click All Instances. On the Instances page, click New at the top right corner of the page. On the Add Instance page, from Instance Type, select the type of instance you want to add.

    Alternatively, navigate to Networks> Instances. Under Instances, select the type of instance you want to add (for example, Citrix ADC VPX) and click Add.

  2. 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. 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.
  3. From Profile Name, select the appropriate instance profile, or create a new profile by clicking the + icon.

  4. From Site, select the site where you want the instance to be added.

  5. From Agent, select the agent with which you want to associate the instances, and then click OK.

    While adding the instances, if there is only one agent configured on your Citrix ADM, by default, that agent is selected.

    localized image

To add Citrix ADC CPX instance in ADM

  1. Navigate to Networks > Instances. Under Instances, select Citrix ADC and select the CPX tab.

  2. Click Add.

  3. Select one of the following options:

    • Enter Device IP address. Specify either the host name or 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. In the Routable IP/Docker IP field, enter the IP address. The IP address can be either the Citrix ADC CPX instance (if it is reachable) or the Docker host.

  5. In the Profile Name field, select the appropriate instance profile, or create a new profile by clicking the + icon.

    Note

    When you are creating a new profile, ensure to specify the HTTP, HTTPS, SSH, and SNMP port details of the host. You can also specify the range of ports that were published by the host in the Start Port and Number of ports field.

  6. As an option, select the site where you want to deploy the CPX instance. You can create a new site also by clicking Add.

  7. If available, select the Citrix ADM service agent from the list of agents.

  8. 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 > CPX, select the instance you want to rediscover, and then from the Select Action list, click Rediscover.

To access an instance GUI from the Citrix ADM

Navigate to Networks > Instances > Citrix ADC. Select the type of instance you want to access (for example, VPX, MPX, CPX, or SDX), and then click the IP address of a specific instance.

localized image

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