Product Documentation

Add instances to NetScaler MAS

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

  • Citrix ADC

    • Citrix ADC MPX

    • Citrix ADC VPX

    • Citrix ADC SDX

    • Citrix ADC CPX

  • Citrix Gateway

  • Citrix SD-WAN

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

Note

  • NetScaler MAS uses the NetScaler IP (NSIP) address of the NetScaler instances for communication. For information about the ports that must be open between the Citrix ADC instances and NetScaler MAS, see Ports.
  • For Citrix SD-WAN WO and Citrix SD-WAN EE instances, NetScaler MAS uses the mangament IP address of the instances for communication.
  • To learn how NetScaler MAS 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 NetScaler MAS. 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.

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 Instance page, select Profiles.

    localized image

  4. On the Admin Profiles page, select Add.

    localized image

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

    localized image

    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 NetScaler MAS and the Citrix ADC instance.

    5. HTTP Port: Specify the port for HTTP communication between NetScaler MAS 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 NetScaler MAS and Citrix ADC CPX.

    6. HTTPS Port: Specify the port for HTTPS communication between NetScaler MAS 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 NetScaler MAS 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 NetScaler MAS 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.

        localized image

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

    10. Select Create.

How to Add Instances to NetScaler MAS

You can add instances either while setting up the NetScaler MAS server for the first time or at a later time.

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 NetScaler MAS supports only Citrix SD-WAN WO and Citrix SD-WAN EE 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 NetScaler MAS, 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 NetScaler MAS servers are set up in high availability mode, when an instance is added, load balancing comes into effect and the instances are distributed across the two NetScaler MAS server nodes by using the round-robin method.

To add an instance to NetScaler MAS:

  1. In a web browser, type the IP address of the NetScaler Management and Analytics System (for example, http://192.168.100.1).

  2. In the User Name and Password fields, enter the administrator credentials. The default administrator credentials are nsroot/nsroot.

  3. Navigate to Networks > Dashboard and click All Instances. On the Instances page, click Add. On the Add Instance page, from Instance Type, select the type of instance you want to add, and then follow the instructions in step 4.

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

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

    Note

    For Citrix ADC CPX instances, you must 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. Also, if your Citrix ADC CPX IP address is reachable from the NetScaler MAS server, select the Routable checkbox. If your Citrix ADC CPX IP address is reachable through the host, uncheck the Routable checkbox and specify the host’s IP address.

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

  7. Click OK to initiate the process of adding instances to NetScaler MAS.

Note

If you want to rediscover an instance, navigate to Networks > Instances > NetScaler <Instance Type>, select the instance you want to rediscover, and then from the Action drop-down list, click Rediscover.

Add instances to NetScaler MAS