Home > Configuration > Snmp

Use this method to creates an SNMP community, which is a password (string) used to authenticate SNMP queries from SNMP managers. You can associate it with any of the following SNMP query types: GET, GET NEXT, ALL, GET BULK.
You can associate one or more community strings with each query type. For example, if you associate two community strings, such as Example and Test, with the query type GET NEXT, the Citrix ADC considers only those GET NEXT SNMP query packets that contain Example or Test as the community string.

Use this method to adds an SNMPv3 user group on the Citrix ADC. SNMPv3 groups are logical aggregations of SNMPv3 users. SNMPv3 groups are used to implement access control and define the security levels for the users. You can add a maximum of 1000 SNMPv3 groups to the Citrix ADC appliance.

Use this method to specifies an SNMP manager to query the Citrix ADC. The added manager complies with SNMP V1, V2, and V3. If you specify one or more SNMP managers, the appliance does not accept SNMP queries from any hosts except the specified SNMP managers. You can specify up to a maximum of 100 IP based SNMP managers or networks and a maximum of 5 host-name based SNMP managers.

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.

Use this method to adds an SNMPv3 user who can send SNMP queries to the Citrix ADC. You can add a maximum of 1000 SNMPv3 users.

Use this method to adds an SNMPv3 view. Used to implement access control for the SNMPv3 user, SNMPv3 views restrict user access to specific portions of the MIB. The Citrix ADC can have multiple SNMPv3 views with the same name, differentiated by subtree parameter settings. You can add a maximum of 1000 SNMPv3 views.

Use this method to bind user to snmp trap.

Use this method to disables an SNMP alarm. The Citrix ADC does not generate trap messages for SNMP alarms that are disabled. Some alarms are enabled by default, but you can disable them.

Use this method to enables or disables an SNMP alarm. The Citrix ADC looks for conditions specified in the enabled SNMP alarms. When the condition in any enabled SNMP alarm is met, the appliance generates an SNMP trap message. It does not look for conditions specified in disabled SNMP alarms and therefore does not generate an SNMP trap message when the condition in any disabled SNMP alarm is met. Some alarms are enabled by default, but you can disable them.

Use this method to get the settings of all SNMP alarms or of the specified SNMP alarm. To display the settings of all the SNMP alarms, run the method without any parameters. To display the settings of a particular SNMP alarm, specify the trapName (Alarm name) of the SNMP alarm.

Use this method to get the SNMP v1 or v2 query-type privileges (such as GET, GET NEXT, ALL, or GET BULK) that have been set for all SNMP communities or for the specified SNMP community. To display the settings of all the SNMP communities, run the method without any parameters. To display the settings of a particular SNMP community, specify the name of the SNMP community.

Use this method to get the ID of the SNMPv3 engine of the Citrix ADC.

Use this method to get the settings of all SNMPv3 groups or of the specified SNMPv3 group. To display the settings of all SNMPv3 groups, run the method without any parameters. To display the settings of a particular SNMPv3 group, specify the name of the SNMPv3 group and securityLevel (Security level). The Citrix ADC can have multiple SNMPv3 groups with the same name, differentiated by the securityLevel (Security level) parameter setting.

Use this method to get configuration information about all SNMP managers on the Citrix ADC, or detailed information about the specified manager.

Use this method to get the information that has been configured on the SNMP agent for the purpose of identifying the Citrix ADC, such as the name of the appliance, administrator, and location.

Use this method to get the corresponding SNMP OIDs for the virtual servers, services, and service groups configured on the Citrix ADC. To display the SNMP OID of all entities of a particular type, such as virtual servers, run the method with only that entity type specified. To display the SNMP of a particular entity, specify the entity type and the entity name.

Use this method to get the settings for the following SNMP options: SNMP SET and SNMP trap Logging.

Use this method to get the settings of all trap listeners or of the specified trap listener. To display the settings of all the trap listeners, run the method without any parameters. To display the settings of a particular trap listener, specify the trapClass (Trap Type) and trapDestination (IP Address) of the trap listener.

Use this method to get the settings of all SNMPv3 users or of the specified SNMPv3 user. To display the settings of all the SNMPv3 users, run the method without any parameters. To display the settings of a particular SNMPv3 user, specify the name of the SNMPv3 user.

Use this method to get the settings of all SNMPv3 views or of the specified SNMPv3 view. To display the settings of all the SNMPv3 views, run the method without any parameters. To display the settings of a particular SNMPv3 view, specify the name of the SNMPv3 view and subtree (the associated subtree of the MIB). The Citrix ADC can have multiple SNMPv3 views with the same name, differentiated by the subtree parameter settings.

Use this method to removes an SNMP community from the Citrix ADC. After you remove the SNMP community, the appliance does not respond to any SNMP queries that contain that community string.

Use this method to removes an SNMPv3 group entry from the Citrix ADC. The appliance can have multiple SNMPv3 groups with the same name, differentiated by the securityLevel (Security level) parameter setting. Therefore, to identify an SNMPv3 group entry that you want to remove, you have to specify both the name and security level of the SNMPv3 group.

Use this method to removes an SNMP manager from the list of managers that are allowed to access the Citrix ADC.

Use this method to removes a trap listener entry from the Citrix ADC.

Use this method to removes an SNMPv3 user entry from the Citrix ADC.

Use this method to removes an SNMPv3 view entry from the Citrix ADC. The appliance can have multiple SNMPv3 views with the same name, differentiated by the subtree parameter setting. Therefore, to identify an SNMPv3 group subtree that you want to remove, you have to specify both the name and subtree of the SNMPv3 view.

Use this method to set logging status of the alarm. When logging is enabled, the Citrix ADC logs every trap message that is generated for this alarm.

Use this method to set severity level assigned to trap messages generated by this alarm. The severity levels are, in increasing order of severity, Informational, Warning, Minor, Major, and Critical.
This parameter is useful when you want the Citrix ADC to send trap messages to a trap listener on the basis of severity level. Trap messages with a severity level lower than the specified level (in the trap listener entry) are not sent.

Use this method to set current state of the SNMP alarm. The Citrix ADC generates trap messages only for SNMP alarms that are enabled. Some alarms are enabled by default, but you can disable them.

Use this method to set value for the high threshold. The Citrix ADC generates an SNMP trap message when the value of the attribute associated with the alarm is greater than or equal to the specified high threshold value.

Use this method to set interval, in seconds, at which the Citrix ADC generates SNMP trap messages when the conditions specified in the SNMP alarm are met.Can be specified for the following alarms: SYNFLOOD, HA-VERSION-MISMATCH, HA-DISK-ENCRYPTION-MISMATCH, HA-SYNC-FAILURE, HA-NO-HEARTBEATS,HA-BAD-SECONDARY-STATE, CLUSTER-NODE-HEALTH, CLUSTER-NODE-QUORUM, CLUSTER-VERSION-MISMATCH, CLUSTER-BKHB-FAILED, PORT-ALLOC-FAILED, COMPACT-FLASH-ERRORS, HARD-DISK-DRIVE-ERRORS and APPFW traps. Default trap time intervals: SYNFLOOD and APPFW traps = 1sec, PORT-ALLOC-FAILED = 3600sec(1 hour), PORT-ALLOC-EXCEED = 3600sec(1 hour), SYSLOG-CONNECTION-DROPPED = 3600sec(1 hour), Other Traps = 86400sec(1 day)

Use this method to set a hexadecimal value of at least 10 characters, uniquely identifying the engineid.
This is mandatory parameter.

Use this method to set name of the configured SNMPv3 view that you want to bind to this SNMPv3 group. An SNMPv3 user bound to this group can access the subtrees that are bound to this SNMPv3 view as type INCLUDED, but cannot access the ones that are type EXCLUDED. If the Citrix ADC has multiple SNMPv3 view entries with the same name, all such entries are associated with the SNMPv3 group.
This is mandatory parameter.

Use this method to set amount of time, in seconds, for which the Citrix ADC waits before sending another DNS query to resolve the host name of the SNMP manager if the last query failed. This parameter is valid for host-name based SNMP managers only. After a query succeeds, the TTL determines the wait time. The minimum and default value is 5.

Use this method to set name of the administrator for this Citrix ADC. Along with the name, you can include information on how to contact this person, such as a phone number or an email address. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters.

The following requirement applies only to the Citrix ADC CLI:
If the information includes one or more spaces, enclose it in double or single quotation marks (for example, "my contact" or 'my contact').

Use this method to set custom identification number for the Citrix ADC. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a custom identification that helps identify the Citrix ADC appliance.

The following requirement applies only to the Citrix ADC CLI:
If the ID includes one or more spaces, enclose it in double or single quotation marks (for example, "my ID" or 'my ID').

Use this method to set physical location of the Citrix ADC. For example, you can specify building name, lab number, and rack number. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters.

The following requirement applies only to the Citrix ADC CLI:
If the location includes one or more spaces, enclose it in double or single quotation marks (for example, "my location" or 'my location').

Use this method to set name for this Citrix ADC. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the Citrix ADC appliance.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose it in double or single quotation marks (for example, "my name" or 'my name').

Use this method to set by default, Customtrap will be disabled, set to enabled when using the feature.

Use this method to set send partition name as a varbind in traps. By default the partition names are not sent as a varbind.

Use this method to set by default, the severity level info of the trap is not mentioned in the trap message. Enable this option to send severity level of trap as one of the varbind in the trap message.

Use this method to set accept SNMP SET requests sent to the Citrix ADC, and allow SNMP managers to write values to MIB objects that are configured for write access.

Use this method to set log any SNMP trap events (for SNMP alarms in which logging is enabled) even if no trap listeners are configured. With the default setting, SNMP trap events are logged if at least one trap listener is configured on the appliance.

Use this method to set audit log level of SNMP trap logs. The default value is INFORMATIONAL.

Use this method to set send traps of all partitions to this destination.

Use this method to set 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').

Use this method to set 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.

Use this method to set 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.

Use this method to set 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.

Use this method to set authentication algorithm used by the Citrix ADC and the SNMPv3 user for authenticating the communication between them. You must specify the same authentication algorithm when you configure the SNMPv3 user in the SNMP manager.

Use this method to set name of the configured SNMPv3 group to which to bind this SNMPv3 user. The access rights (bound SNMPv3 views) and security level set for this group are assigned to this user.

Use this method to set encryption algorithm used by the Citrix ADC and the SNMPv3 user for encrypting the communication between them. You must specify the same encryption algorithm when you configure the SNMPv3 user in the SNMP manager.

Use this method to set include or exclude the subtree, specified by the subtree parameter, in or from this view. This setting can be useful when you have included a subtree, such as A, in an SNMPv3 view and you want to exclude a specific subtree of A, such as B, from the SNMPv3 view.
This is mandatory parameter.

Use this method to unbind user from snmp trap.

Remove snmp alarm logging setting.

Remove snmp alarm normalvalue setting.

Remove snmp alarm severity setting.

Remove snmp alarm state setting.

Remove snmp alarm thresholdvalue setting.

Remove snmp alarm time setting.

Remove snmp manager domainresolveretry setting.

Remove snmp mib contact setting.

Remove snmp mib customid setting.

Remove snmp mib location setting.

Name for this Citrix ADC. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the Citrix ADC appliance.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose it in double or single quotation marks (for example, "my name" or 'my name').

Remove snmp option customtrap setting.

Remove snmp option partitionnameintrap setting.

Remove snmp option severityinfointrap setting.

Remove snmp option snmpset setting.

Remove snmp option snmptraplogging setting.

Remove snmp option snmptraplogginglevel setting.

Remove snmp trap allpartitions setting.

Remove snmp trap community setting.

Remove snmp trap destport setting.

Remove snmp trap severity setting.

Remove snmp trap srcip setting.

Remove snmp user authpasswd setting.

Remove snmp user authtype setting.

Remove snmp user privpasswd setting.

Remove snmp user privtype setting.