Try SpotterConfiguration for snmp trap resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for snmp trap resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | snmptrap
delegate_to: localhost
netscaler.adc.snmptrap:
state: present
trapclass: generic
trapdestination: 10.10.10.10
version: V3
allpartitions: ENABLED
td:
description:
- Integer value that uniquely identifies the traffic domain in which you want to configure
the entity. If you do not specify an ID, the entity becomes part of the default
traffic domain, which has an ID of 0.
type: float
nsip:
description:
- 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.
required: true
type: str
srcip:
description:
- 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.
type: str
state:
choices:
- present
- absent
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
version:
choices:
- V1
- V2
- V3
description:
- '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.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
destport:
description:
- 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.
type: int
severity:
choices:
- Critical
- Major
- Minor
- Warning
- Informational
description:
- '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 C(Informational),
C(Warning), C(Minor), C(Major), C(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.'
type: str
trapclass:
choices:
- generic
- specific
description:
- 'Type of trap messages that the Citrix ADC sends to the trap listener: Generic or
the enterprise-C(specific) messages defined in the MIB file.'
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
save_config:
default: false
description:
- If C(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.
type: bool
allpartitions:
choices:
- ENABLED
- DISABLED
description:
- Send traps of all partitions to this destination.
type: str
communityname:
description:
- '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').
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
trapdestination:
description:
- IPv4 or the IPv6 address of the trap listener to which the Citrix ADC is to send
SNMP trap messages.
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
snmptrap_snmpuser_binding:
description: Bindings for snmptrap_snmpuser_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: 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'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list