| addsnmptrap |
Use this method to adds an SNMP trap listener. You can configure the Citrix ADC to generate asynchronous events (trap messages) to report abnormal conditions. The trap messages are sent to a remote device (trap listener) to help administrators monitor the appliance and respond promptly to any issues. |
Syntax |
Parameters |
trapclass |
Type of trap messages that the Citrix ADC sends to the trap listener: Generic or the enterprise-specific messages defined in the MIB file. This is mandatory parameter. |
trapdestination |
IPv4 or the IPv6 address of the trap listener to which the Citrix ADC is to send SNMP trap messages. This is mandatory parameter. Minimum value = 1. |
version |
SNMP version, which determines the format of trap messages sent to the trap listener.
This setting must match the setting on the trap listener. Otherwise, the listener drops the trap messages. Default value = V2. |
destport |
UDP port at which the trap listener listens for trap messages. This setting must match the setting on the trap listener. Otherwise, the listener drops the trap messages. Default value = 162. Minimum value = 1. Maximum value = 65534. |
communityname |
Password (string) sent with the trap messages, so that the trap listener can authenticate them. Can include 1 to 31 uppercase or lowercase letters, numbers, and hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore (_) characters.
You must specify the same community string on the trap listener device. Otherwise, the trap listener drops the trap messages.
The following requirement applies only to the Citrix ADC CLI:
If the string includes one or more spaces, enclose the name in double or single quotation marks (for example, "my string" or 'my string'). |
srcip |
IPv4 or IPv6 address that the Citrix ADC inserts as the source IP address in all SNMP trap messages that it sends to this trap listener. By default this is the appliance's NSIP or NSIP6 address, but you can specify an IPv4 MIP or SNIP/SNIP6 address. In cluster setup, the default value is the individual node's NSIP, but it can be set to CLIP or Striped SNIP address. In non default partition, this parameter must be set to the SNIP/SNIP6 address. Minimum value = 1. |
severity |
Severity level at or above which the Citrix ADC sends trap messages to this trap listener. The severity levels, in increasing order of severity, are Informational, Warning, Minor, Major, Critical. This parameter can be set for trap listeners of type SPECIFIC only. The default is to send all levels of trap messages.
Important: Trap messages are not assigned severity levels unless you specify severity levels when configuring SNMP alarms. Default value = SNMP_SEV_UNKNOWN. |
allpartitions |
Send traps of all partitions to this destination. Default value = DISABLED. |
Return Value |
Returns simpleResult |
See Also |