W3cubDocs

/Ansible

nxos_snmp_trap - Manages SNMP traps.

New in version 2.2.

Synopsis

Manages SNMP traps configurations.

Options

parameter required default choices comments
group
 yes
  • aaa
  • bridge
  • callhome
  • cfs
  • config
  • entity
  • feature-control
  • hsrp
  • license
  • link
  • lldp
  • ospf
  • pim
  • rf
  • rmon
  • snmp
  • storm-control
  • stpx
  • sysmgr
  • system
  • upgrade
  • vtp
  • all
Case sensitive group.
host
 yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
 no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
ssh_keyfile
 no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
 no enabled
  • enabled
  • disabled
Manage the state of the resource.
transport
 yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

# ensure lldp trap configured
- nxos_snmp_traps:
    group: lldp
    state: enabled
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

# ensure lldp trap is not configured
- nxos_snmp_traps:
    group: lldp
    state: disabled
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

Return Values

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

name description returned type sample
end_state k/v pairs of trap info after module execution always dict {'lldp': [{'enabled': 'Yes', 'trap': 'lldpRemTablesChange'}]}
changed check to see if a change was made on the device always boolean True
updates command sent to the device always list snmp-server enable traps lldp ;
proposed k/v pairs of parameters passed into module always dict {'group': 'lldp'}
existing k/v pairs of existing trap status dict {'lldp': [{'enabled': 'No', 'trap': 'lldpRemTablesChange'}]}

Notes

Note

This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the nxos_command module.

Note

Be aware that you can set a trap only for an enabled feature.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_snmp_traps_module.html