ADC CLI Commands

snmp-alarm

May 28, 2024

Contributed by:

The following operations can be performed on “snmp-alarm”:

enable snmp alarm

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.

Synopsis

enable snmp alarm ...

Arguments

trapName Name of the SNMP alarm. This parameter is required for identifying the SNMP alarm.

Possible values: CPU-USAGE, AVERAGE-CPU, MEMORY, MGMT-CPU-USAGE, SYNFLOOD, TCP-SYNFLOOD, VSERVER-REQRATE, SERVICE-REQRATE, ENTITY-RXRATE, ENTITY-TXRATE, ENTITY-SYNFLOOD, SERVICE-MAXCLIENTS, HA-STATE-CHANGE, ENTITY-STATE, CONFIG-CHANGE, CONFIG-SAVE, SERVICEGROUP-MEMBER-REQRATE, SERVICEGROUP-MEMBER-MAXCLIENTS, MONITOR-RTO-THRESHOLD, LOGIN-FAILURE, SSL-CERT-EXPIRY, FAN-SPEED-LOW, VOLTAGE-LOW, VOLTAGE-HIGH, TEMPERATURE-HIGH, CPU-TEMPERATURE-HIGH, POWER-SUPPLY-FAILURE, DISK-USAGE-HIGH, INTERFACE-THROUGHPUT-LOW, MON_PROBE_FAILED, HA-VERSION-MISMATCH, HA-SYNC-FAILURE, HA-NO-HEARTBEATS, HA-BAD-SECONDARY-STATE, INTERFACE-BW-USAGE, RATE-LIMIT-THRESHOLD-EXCEEDED, ENTITY-NAME-CHANGE, HA-PROP-FAILURE, IP-CONFLICT, PF-RL-RATE-THRESHOLD, PF-RL-PPS-THRESHOLD, PF-RL-RATE-PKTS-DROPPED, PF-RL-PPS-PKTS-DROPPED, APPFW-START-URL, APPFW-DENY-URL, APPFW-VIOLATIONS-TYPE, APPFW-REFERER-HEADER, APPFW-CSRF-TAG, APPFW-COOKIE, APPFW-FIELD-CONSISTENCY, APPFW-BUFFER-OVERFLOW, APPFW-FIELD-FORMAT, APPFW-FILE-UPLOAD-TYPE, APPFW-GRPC, APPFW-GRPC-WEB-JSON, APPFW-GRPC-WEB-TEXT, APPFW-JSON-DOS, APPFW-JSON-SQL, APPFW-JSON-XSS, APPFW-SAFE-COMMERCE, APPFW-SAFE-OBJECT, APPFW-SESSION-LIMIT, APPFW-SIGNATURE-MATCH, APPFW-POLICY-HIT, APPFW-XSS, APPFW-XML-XSS, APPFW-SQL, APPFW-XML-SQL, APPFW-XML-ATTACHMENT, APPFW-XML-DOS, APPFW-XML-VALIDATION, APPFW-XML-WSI, APPFW-XML-SCHEMA-COMPILE, APPFW-XML-SOAP-FAULT, APPFW-NEW-SIGNATURE-ADDED, APPFW-DEPLOY-RELAXATION-DP, APPFW-LEARNED-RULE-APPLIED-DYN-PROF, APPFW-CMD, APPFW-SCHEMA-ENDPOINT-NOTFOUND, APPFW-SCHEMA-METHOD-UNSUPPORTED, APPFW-SCHEMA-PARAMETER-MISSING, APPFW-SCHEMA-VALUE-INCORRECT, APPFW-SCHEMA-CONTENTTYPE-UNSUPPORTED, APPFW-SCHEMA-PARAMETER-INVALID, APPFW-SCHEMA-OTHER, APPFW-SCHEMA-RELAXATION-RULE, APPFW-POSTBODYLIMIT, APPFW-JSON-CMD, APPFW-SQL-GRAM, APPFW-JSON-SQL-GRAM, APPFW-CMD-GRAM, APPFW-JSON-CMD-GRAM, APPFW-BLOCK-KEYWORD, APPFW-JSON-BLOCKKEYWORD, APPFW-BYPASS-LIST, APPFW-DENY-LIST, DNSKEY-EXPIRY, HA-LICENSE-MISMATCH, SSL-CARD-FAILED, SSL-CARD-NORMAL, WARM-RESTART-EVENT, HARD-DISK-DRIVE-ERRORS, COMPACT-FLASH-ERRORS, CALLHOME-UPLOAD-EVENT, 1024KEY-EXCHANGE-RATE, 2048KEY-EXCHANGE-RATE, 4096KEY-EXCHANGE-RATE, SSL-CUR-SESSION-INUSE, CLUSTER-NODE-HEALTH, CLUSTER-NODE-QUORUM, CLUSTER-VERSION-MISMATCH, CLUSTER-CCO-CHANGE, CLUSTER-OVS-CHANGE, CLUSTER-SYNC-FAILURE, CLUSTER-SYNC-PARTIAL-SUCCESS, CLUSTER-PROP-FAILURE, CLUSTER-PROP-EXEC-FAILURE, HA-STICKY-PRIMARY, INBAND-PROTOCOL-VERSION-MISMATCH, SSL-CHIP-REINIT, VRID-STATE-CHANGE, PORT-ALLOC-FAILED, LLDP-REMOTE-CHANGE, DUPLICATE-IPV6, PARTITION-CONFIG-EVENT, PARTITION-SWITCHED, LSN-PORTALLOC-FAILED, LSN-PORTQUOTA-EXCEED, LSN-SESSIONQUOTA-EXCEED, LSN-MEM-RECOVERY-KICKEDIN, VSERVER-SPILLOVER, INCONSISTENT-CONFIGURATION-IN-PPES, PARTITION-RATE-LIMIT, POOLED-LICENSE-ONGRACE, POOLED-LICENSE-PARTIAL, CLUSTER-BACKPLANE-HB-MISSING, GSLB-SITE-MEP-FLAP, DNS-MAXNEGCACHE-USAGE, DNS-MAXCACHE-USAGE, NS-LICENSE-EXPIRY, PKT-RATELIMITING-ATTACK, GSLB-SYNC-STATUS-FLIP, URLFILT-DB-UPDATE-STATUS, URLFILT-INIT-SDK, POOLED-LICENSE-CHECKOUT-FAILURE, MIGRATION-STARTED, MIGRATION-COMPLETE, ECDHE-EXCHANGE-RATE, BOT-SIGNATURE-UPDATE, APPFW-XMLPAYLOAD-CONTENT-TYPE-MISMATCH, PORT-ALLOC-EXCEED, KEK_UPDATE_SUCCESS, KEK_UPDATE_FAILURE, ADC-ANOMALY, SYSLOG-CONNECTION-DROPPED, NSROOT_PASSWORD_EXPIRY_WARNING, DNSSEC-KEY-AUTOMGMT-STATUS-FAILURE, DNSSEC-KEY-AUTOMGMT-STATUS-SUCCESS, CLOUD-REST-API-FAILURE, SSL-ASYM-CRYPTO-UTILIZATION, SSL-SYM-CRYPTO-UTILIZATION

Example

enable snmp alarm VSERVER-REQRATE enable snmp alarm CPU SYNFLOOD

disable snmp alarm

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.

Synopsis

disable snmp alarm ...

Arguments

trapName Name of the SNMP alarm. This parameter is required for identifying the SNMP alarm.

Example

disable snmp alarm VSERVER-REQRATE disable snmp alarm CPU SYNFLOOD

show snmp alarm

Displays the settings of all SNMP alarms or of the specified SNMP alarm. To display the settings of all the SNMP alarms, run the command without any parameters. To display the settings of a particular SNMP alarm, specify the trapName (Alarm name) of the SNMP alarm.

Synopsis

show snmp alarm []

Arguments

trapName Name of the SNMP alarm whose details you want the Citrix ADC to display.

Output

thresholdValue The high threshold value.

normalValue The normal threshold value.

time The time interval for the SYNFLOOD alarm.

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

severity The severity of this alarm.

logging The log status of the alarm.

flags timeout If DB is enabled and clear config is fired, then to reset timeinterval of alarm, corresponding default time value is needed. This hidden argument holds the default time value for the corresponding alarm.

devno count stateflag

set snmp alarm

Configures an SNMP alarm. You must enable and configure alarms to generate enterprise-specific trap messages. The Citrix ADC sends these trap messages only to trap listeners of type (class) SPECIFIC. The SNMP alarms are either event based or threshold based.

The Citrix ADC supports the following user configurable alarms: HA-STATE-CHANGE: Change to primary/secondary CPU-USAGE: Individual CPU usage AVERAGE-CPU: Average CPU usage MGMT-CPU: Management CPU usage ENTITY-STATE: Entity state change SYNFLOOD: Global unacknowledged SYN count MEMORY: Memory usage VSERVER-REQRATE: Vserver specific request rate SERVICE-REQRATE: Service specific request rate ENTITY-RXRATE: Entity specific Rx bytes per sec ENTITY-TXRATE: Entity specific Tx bytes per sec ENTITY-SYNFLOOD: Entity specific unacknowledged SYN count CONFIG-CHANGE: System configuration changed SERVICE-MAXCLIENTS: Service hit max-client limit CONFIG-SAVE: System configuration was saved SERVICEGROUP-MEMBER-REQRATE: Request rate on a service group member SERVICEGROUP-MEMBER-MAXCLIENTS: Service group member hits max-client MONITOR-RTO-THRESHOLD: Monitor probe response timeout LOGIN-FAILURE: GUI/CLI/API login failure SSL-CERT-EXPIRY: Certificate expiry FAN-SPEED-LOW: Low fan speed VOLTAGE-LOW: Low voltage VOLTAGE-HIGH: High Voltage TEMPERATURE-HIGH: High temperature CPU-TEMPERATURE-HIGH: High CPU temperature POWER-SUPPLY-FAILURE: Power supply failure DISK-USAGE-HIGH: High disk usage INTERFACE-THROUGHPUT-LOW: Low Interface throughput MON_PROBE_FAILED: Monitor probe failure HA-VERSION-MISMATCH: HA Citrix ADC’s OS version mismatch HA-SYNC-FAILURE: HA config synchronization failure HA-NO-HEARTBEATS: No HA hearbeats HA-BAD-SECONDARY-STATE: Secondary state DOWN/UNKNOWN/STAY SECONDARY INTERFACE-BW-USAGE: System aggregate BW usage RATE-LIMIT-THRESHOLD-EXCEEDED: Client exceed rate-limit threshold ENTITY-NAME-CHANGE: Entity name change HA-PROP-FAILURE: HA config propagation failure IP-CONFLICT: IP conflict PF-RL-RATE-THRESHOLD: Platform rate limit in Mbps PF-RL-PPS-THRESHOLD: Platform packets per second limit PF-RL-RATE-PKTS-DROPPED: Packet Drops due to platform rate limit PF-RL-PPS-PKTS-DROPPED: Packet Drops due to platform packet per sec limit APPFW-START-URL: AppFirewall Start URL violation APPFW-DENY-URL: AppFirewall Deny URL violation APPFW-REFERER-HEADER: AppFirewall Referer Header violation APPFW-CSRF-TAG: AppFirewall CSRF Tag violation APPFW-COOKIE: AppFirewall Cookie violation APPFW-FIELD-CONSISTENCY: AppFirewall Field Consistency violation APPFW-BUFFER-OVERFLOW: AppFirewall Buffer Overflow violation APPFW-POSTBODYLIMIT: AppFirewall Post Body Limit violation APPFW-FIELD-FORMAT: AppFirewall Field Format violation APPFW-JSON-DOS: AppFirewall JSON DoS violation APPFW-JSON-SQL: AppFirewall JSON SQL violation APPFW-JSON-SQL-GRAM: AppFirewall JSON SQL violation (detected by SQL Grammar) APPFW-BLOCK-KEYWORD: AppFirewall Block Keyword violation APPFW-JSON-BLOCKKEYWORD: AppFirewall JSON Block Keyword violation APPFW-BYPASS-LIST: AppFirewall Bypass List Rule Hit APPFW-DENY-LIST: AppFirewall Deny List Rule Hit APPFW-JSON-XSS: AppFirewall JSON Cross Site Scripting violation APPFW-SAFE-COMMERCE: AppFirewall Safe Commerce violation APPFW-SAFE-OBJECT: AppFirewall Safe Object violation APPFW-POLICY-HIT: AppFirewall Policy Hit APPFW-VIOLATIONS-TYPE: AppFirewall Content Type violation APPFW-XSS: AppFirewall Cross Site Scripting violation APPFW-SIGNATURE-MATCH: AppFirewall Signature violation APPFW-XML-XSS: AppFirewall XML Cross Site Scripting violation APPFW-SQL: AppFirewall SQL violation APPFW-XML-SQL: AppFirewall XML SQL violation APPFW-SQL-GRAM: AppFirewall SQL violation reported by SQL Grammar APPFW-CMD: AppFirewall CMD Injection violation APPFW-CMD-GRAM: AppFirewall CMD violation reported by SQL Grammar APPFW-SCHEMA-ENDPOINT-NOTFOUND: AppFirewall Schema endpoint not found APPFW-SCHEMA-METHOD-UNSUPPORTED: AppFirewall Schema method unsupported APPFW-SCHEMA-PARAMETER-MISSING: AppFirewall Schema parameter missing APPFW-SCHEMA-VALUE-INCORRECT: AppFirewall Schema value incorrect APPFW-SCHEMA-CONTENTTYPE-UNSUPPORTED: AppFirewall Schema content type unsupported APPFW-SCHEMA-PARAMETER-INVALID: AppFirewall Schema parameter invalid APPFW-SCHEMA-OTHER: AppFirewall Schema other APPFW-SCHEMA-RELAXATION-RULE: AppFirewall Schema relaxation rule APPFW-JSON-CMD: AppFirewall JSON CMD Injection violation APPFW-JSON-CMD-GRAM: AppFirewall JSON CMD violation (detected by CMD Grammar) APPFW-XML-ATTACHMENT: AppFirewall XML Attachment violation APPFW-XML-DOS: AppFirewall XML DoS violation APPFW-XML-VALIDATION: AppFirewall XML Validation violation APPFW-XML-WSI: AppFirewall XML WSI violation APPFW-XML-SCHEMA-COMPILE: AppFirewall XML Schema Compile violation APPFW-XML-SOAP-FAULT: AppFirewall XML Soap Fault violation DNSKEY-EXPIRY: DNSKEY expiry HA-LICENSE-MISMATCH: HA Citrix ADC’s license mismatch APPFW-SESSION-LIMIT: AppFirewall Session Limit reached SSL-CARD-FAILED: SSL Card Failed SSL-CARD-NORMAL: SSL Card Normal WARM-RESTART-EVENT: Warm Restart Event Occurred HARD-DISK-DRIVE-ERRORS: Hard Disk Drive Errors COMPACT-FLASH-ERRORS: Compact Flash Errors CALLHOME-UPLOAD-EVENT: Attempt to upload Show Tech Support Archive 1024KEY-EXCHANGE-RATE: 1024 Key Exchange Rate 2048KEY-EXCHANGE-RATE: 2048 Key Exchange Rate 4096KEY-EXCHANGE-RATE: 4096 Key Exchange Rate SSL-CUR-SESSION-INUSE: SSL Current Sessions In Use SYSLOG-CONNECTION-DROPPED: Syslog server connection dropped CLUSTER-NODE-HEALTH: Cluster Node Health State Change CLUSTER-NODE-QUORUM: Cluster Node View has Quorum CLUSTER-VERSION-MISMATCH: Cluster Node Version Mismatch CLUSTER-CCO-CHANGE: Cluster Configuration Coordinator Change CLUSTER-OVS-CHANGE: Cluster Operational View Set Change CLUSTER-SYNC-FAILURE: Cluster Config Synchronization Failure CLUSTER-SYNC-PARTIAL-SUCCESS: Cluster Config Synchronization Partial Success CLUSTER-PROP-FAILURE: Cluster Config Propagation Failure CLUSTER-PROP-EXEC-FAILURE: Cluster propagated command Failure HA-STICKY-PRIMARY: Fixed primary state owing to max HA flips INBAND-PROTOCOL-VERSION-MISMATCH: Inband protocol mismatch between BR and QoSd SSL-CHIP-REINIT: SSL Chip Reinit VRID-STATE-CHANGE: VRID State Change PORT-ALLOC-FAILED: Port Alloc Failed LLDP-REMOTE-CHANGE: LLDP Remote Change DUPLICATE-IPV6: IPv6 Address got duplicated PARTITION-CONFIG-EVENT: Partition Added/removed PARTITION-SWITCHED: Partition Swicthed LSN-PORTALLOC-FAILED: LSN Port Allocation Failed LSN-PORTQUOTA-EXCEED: LSN Port Quota Exceeded LSN-SESSIONQUOTA-EXCEED: LSN Session Quota Exceeded LSN-MEM-RECOVERY-KICKEDIN: LSN Memory Recovery Kicked-in VSERVER-SPILLOVER: Vserver spillover occurred PARTITION-RATE-LIMIT: Partition bandwidth, connection and memory limit/threshold exceeded POOLED-LICENSE-ONGRACE: Pooled license running on grace POOLED-LICENSE-PARTIAL: Pooled license partial capacity CLUSTER-BACKPLANE-HB-MISSING: Heartbeats are missing on backplane GSLB-SITE-MEP-FLAP: GSLB site MEP flap DNS-MAXNEGCACHE-USAGE: Max negative cache usage limit for DNS DNS-MAXCACHE-USAGE: Max cache usage limit for DNS TCP-SYNFLOOD: SYN Flood for TCP NS-LICENSE-EXPIRY: Citrix ADC license expiry PKT-RATELIMITING-ATTACK: Detected packet ratelimiting attack GSLB-SYNC-STATUS-FLIP: GSLB sync status flip URLFILT-DB-UPDATE-STATUS: Urlfiltering Database Update Status URLFILT-INIT-SDK: Urlfiltering SDK Initialization APPFW-NEW-SIGNATURE-ADDED: New Appfw Signature Imported POOLED-LICENSE-CHECKOUT-FAILURE: Pooled license checkout failure APPFW-FILE-UPLOAD-TYPE: Appfw File Upload Type Violation MIGRATION-STARTED: Migration has been initiated MIGRATION-COMPLETE: Migration is complete on N1 APPFW-DEPLOY-RELAXATION-DP: Appfw Relaxation ready to be deployed APPFW-LEARNED-RULE-APPLIED-DYN-PROF: Appfw learned rule applied ECDHE-EXCHANGE-RATE: ecdhe based transactions per second BOT-SIGNATURE-UPDATE: Bot Signature Auto Update APPFW-XMLPAYLOAD-CONTENT-TYPE-MISMATCH: Appfw XML Payload Content-Type Mismatch Violation INCONSISTENT-CONFIGURATION-IN-PPES: Inconsistent configuration across multiple PPEs APPFW-GRPC: gRPC request blocked by appfw APPFW-GRPC-WEB-TEXT: gRPC-web text request blocked by appfw APPFW-GRPC-WEB-JSON: gRPC-web JSON request blocked by appfw PORT-ALLOC-EXCEED: Port allocation percentage exceeds the configured value KEK_UPDATE_SUCCESS: Update KEK successful KEK_UPDATE_FAILURE: Update KEK failure ADC-ANOMALY: ADC Anomaly detected NSROOT_PASSWORD_EXPIRY_WARNING: nsroot password expiration warning DNSSEC-KEY-AUTOMGMT-STATUS-FAILURE: DNSKEY command Failure DNSSEC-KEY-AUTOMGMT-STATUS-SUCCESS: DNSKEY command success CLOUD-REST-API-FAILURE: Cloud Api invoked by the PE is failed SSL-ASYM-CRYPTO-UTILIZATION: ASymmetric crypto utilization SSL-SYM-CRYPTO-UTILIZATION: Symmetric crypto utilization

For the purposes of this command, entity includes vservers and services.

Synopsis

set snmp alarm \[-thresholdValue <positive\_integer> \[-normalValue <positive\_integer>]] \[-time ] \[-state \( ENABLED | DISABLED )] \[-severity ] \[-logging \( ENABLED | DISABLED )]

Arguments

trapName Name of the SNMP alarm. This parameter is required for identifying the SNMP alarm and cannot be modified.

thresholdValue 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. Minimum value: 1

normalValue Value for the normal threshold. A trap message is generated if the value of the respective attribute falls to or below this value after exceeding the high threshold. Minimum value: 1

time 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-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) Default value: 1

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

Possible values: ENABLED, DISABLED Default value: ENABLED

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

Possible values: Critical, Major, Minor, Warning, Informational Default value: Unknown

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

Possible values: ENABLED, DISABLED Default value: ENABLED

Example

set snmp alarm VSERVER-REQRATE -thresholdValue 10000 -normalValue 100

add snmp trap

unset snmp alarm

Resets the specified parameters of an SNMP alarm to their default settings..Refer to the set snmp alarm command for meanings of the arguments.

Synopsis

unset snmp alarm [-thresholdValue] [-normalValue] [-time] [-state] [-severity] [-logging]

Example

unset snmp alarm VSERVER-REQRATE

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

snmp-alarm

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

snmp-alarm

enable snmp alarm

Synopsis

Arguments

Example

disable snmp alarm

Synopsis

Arguments

Example

show snmp alarm

Synopsis

Arguments

Output

set snmp alarm

Synopsis

Arguments

Example

Related Commands

unset snmp alarm

Synopsis

Example

In this article