netscaler.adc.snmpalarm module – Configuration for alarm resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.snmpalarm.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for alarm resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

logging

any

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

Choices:

  • "ENABLED"

  • "DISABLED"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

normalvalue

any

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.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

severity

any

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.

Choices:

  • "Critical"

  • "Major"

  • "Minor"

  • "Warning"

  • "Informational"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When enabled, the resource will be enabled on the NetScaler ADC node.

When disabled, the resource will be disabled on the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "enabled"

  • "disabled"

  • "unset"

thresholdvalue

any

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.

time

any

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), Other Traps = 86400sec(1 day)

trapname

any

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

Choices:

  • "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-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"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)