How NetScaler MAS discovers instances

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 ADC
    • NetScaler MPX

    • NetScaler VPX

    • NetScaler SDX

    • NetScaler CPX

  • NetScaler Gateway

  • NetScaler SD-WAN

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


NetScaler MAS uses the NetScaler IP (NSIP) address of the NetScaler instances for communication. NetScaler MAS can also discover NetScaler instances with subnet IP (SNIP) address that has management access enabled on it. For information about the ports that must be open between the NetScaler instances and NetScaler MAS, see Ports.

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

You cannot add NetScaler SD-WAN SE / EE instances in NetScaler MAS. You can configure NetScaler MAS as an AppFlow collector on the NetScaler SD-WAN SE/EE appliances.

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 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 WO instances, NetScaler MAS does not detect the instance by using licensing information. 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.


    In HTTP, you can add NetScaler instances to the NetScaler MAS even if licenses are not configured on the instances.

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

    To learn to add instances to NetScaler MAS, see Add instances.

How NetScaler MAS discovers instances

In this article