Product Documentation

Adding an Instance to NetScaler MAS

Jan 17, 2017

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:

  • NetScaler MPX
  • NetScaler VPX
  • NetScaler SDX
  • NetScaler CPX
  • NetScaler Gateway
  • NetScaler SD-WAN WO
  • NetScaler SD-WAN EE

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

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 NetScaler instances and NetScaler MAS, see Ports.

For NetScaler SD-WAN WO and NetScaler SD-WAN EE instances, NetScaler MAS uses the mangament IP address of the instances for communication.

How NetScaler MAS Discovers and Adds Instances

When you add an instance to the NetScaler MAS server, the server implicitly adds itself as a trap destination for the instance and collects inventory of the instance.

The following diagram describes how NetScaler MAS implicitly discovers and adds instances.  

localized image

As shown in the diagram, the following steps are performed implicitly by NetScaler MAS.

1) The NetScaler MAS server sends an Internet Control Message Protocol (ICMP) ping to locate the instance. Then, it uses the instance profile details to log on to the instance. Using a NetScaler NITRO call, NetScaler MAS retrieves the license information of the instance. On the basis of the licensing information, it determines whether the instance is a NetScaler instance and the type of NetScaler platform (for example, NetScaler MPX, NetScaler VPX, NetScaler SDX, or NetScaler Gateway). On succesful detection of the NetScaler instance, it is added to the NetScaler MAS server’s database.

For NetScaler SD-WAN instances, NetScaler MAS does not detect the instance by using licensing information. Instead, after locating the instance by using ICMP ping, it sends a NITRO request to the instance to check for the instance type and version.

This step might fail if the instance profile does not include the correct credentials. For NetScaler MPX, NetScaler VPX, NetScaler SDX, and NetScaler Gateway instances, this step might also fail if the licenses are not applied to the instance.

2) NetScaler MAS adds its IP address to the list of trap destinations on the instance.This allows the NetScaler MAS server to receive traps generated on the NetScaler instance.

This step might fail if the number of trap destinations on the NetScaler instance exceeds the maximum limit of trap destinations. The maximum limit on NetScaler instances is 20.

For NetScaler SD-WAN instances, NetScaler MAS adds its IP address as the SNMP manager on the instance.

3) NetScaler MAS collects inventory from the instance by sending a NITRO request. It collects instance details such as host name, software version, running and saved configuration, certificate details, entities configured on the instance, and so on.

This step might fail because of network or firewall issues.

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 NetScaler 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 NetScaler SD-WAN WO and NetScaler SD-WAN EE editions.

You must then specify an instance profile that NetScaler MAS 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 NetScaler MAS. For each instance type, a default profile is available. For example, the ns-root-profile is the default profile for NetScaler instances. This profile is defined by the default NetScaler 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.

Note

  • To add NetScaler 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 NetScaler 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.

localized image

3) Navigate to Infrastructure > Dashboard and click All Instances. On the Instances page, click New at the top right corner of the page. On the Add Instances page, from Instance Type, select the type of instance you want to add, and then follow the instructions in step 4.

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

4) Select one of the following options:

  • Enter Device IP address - For NetScaler 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 NetScaler 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 NetScaler CPX IP address is reachable from the NetScaler MAS server, select the Routable checkbox. If your NetScaler CPX IP address is reachable through the host, uncheck the Routable checkbox and specify the host’s IP address.

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

Note

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