Product Documentation

Create SNMP traps, managers, and users

May 24, 2018

You can configure an SNMP agent on a Citrix NetScaler instance to generate asynchronous events called traps. Traps are generated whenever there are abnormal conditions on the NetScaler instance. The traps are then sent to a remote device called a trap listener, which then alerts you to the abnormal condition on the NetScaler instance. 

Alternatively, you can query the SNMP agent for system-specific information from a remote device called an SNMP manager. The agent then searches the management information base (MIB) for requested data and sends the data to the SNMP manager.

Support for SNMP Version 3 Traps on NetScaler MAS for NetScaler Instances

SNMP version 3 traps provides security capabilities such as authentication and encryption by using the credentials of SNMP users.

When you add an instance to the NetScaler MAS server, the server implicitly adds itself as a trap destination for the instance during discovery. This allows the NetScaler MAS server to receive traps generated on the instance. When you add an SNMP v3 as a trap destination on the NetScaler MAS server, it is bound to an SNMP user’s credentials, the SNMP group, and the SNMP view.

If the trap destination is already present on the managed instance, NetScaler MAS will only verify the trap destination against its user and security level. If the discovery process is successful, and the NetScaler MAS server starts to receive traps generated on the NetScaler instance, an new event is generated. This event will notify the administrator that a new SNMP user has been added to an instance and the traps being sent from that instance must be authenticated by the NetScaler MAS server.


  • During discovery, if there is an existing trap destination with a different version (v2), NetScaler MAS will delete the older version and replace it with SNMP v3, to avoid receiving similar traps.
  • If you want to discover an existing instance with SNMP v3, if it already has an trap destination set with v2, then you must delete that instance on your NetScaler MAS server and add it once again with the newer trap destination.

To create an SNMP trap destination on NetScaler MAS

  1. Navigate to System > SNMP > Trap Destinations.
  2. Under SNMP Traps, click Add to create a new SNMP trap, and then specify the following details:
    • Version – Select the SNMP version to use.
    • Destination Server - Name or IP address of the trap destination.
    • Port -  Enter the trap destination’s port. The port is set to 162 by default.
    • Community – Specify the community string to use when sending a trap to the trap listener.
  3. Click Create.


If you are creating an SNMP v3 trap destination, you must specify the SNMP user credentials you want to bind the trap to, by clicking Insert and then add the user from the list of SNMP users available. To add an SNMP user, see To create an SNMP user.

To create an SNMP manager community

  1. Navigate to System > SNMP > Managers.
  2. Under SNMP Manager, click Add to create a new SNMP manager community, and then specify the following details:
    • SNMP Manager -  Enter the name or IP address of the SNMP manager.
    • Community – Specify the community string to use when sending traps to the trap listener.
  3. Optionally, you can select the Enable Management Network checkbox to specify the Netmask which is the subnet mask of the SNMP manager network.
  4. Click Create.

To create an SNMP user

  1. Navigate to System > SNMP > Users.
  2. Under SNMP User, click Add.
  3. Enter the user name and assign a security level to the user from the drop-down list.
  4. Based on the Security Level you’ve assigned to the user, you might need to provide additional authentication protocols, such as authentication protocols, privacy passwords, and assign SNMP views.