cisco.nxos.nxos_snmp_traps module – (deprecated, removed after 2024-01-01) Manages SNMP traps.

Note

This module is part of the cisco.nxos collection (version 4.4.0).

You might already have this collection installed if you are using the ansible package. 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 cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_snmp_traps.

New in cisco.nxos 1.0.0

DEPRECATED

Removed in:

major release after 2024-01-01

Why:

Updated modules released with more functionality

Alternative:

nxos_snmp_server

Synopsis

  • Manages SNMP traps configurations.

Note

This module has a corresponding action plugin.

Aliases: snmp_traps

Parameters

Parameter

Comments

group

string / required

Case sensitive group.

Choices:

  • "aaa"

  • "bfd"

  • "bgp"

  • "bridge"

  • "callhome"

  • "cfs"

  • "config"

  • "eigrp"

  • "entity"

  • "feature-control"

  • "generic"

  • "hsrp"

  • "license"

  • "link"

  • "lldp"

  • "mmode"

  • "ospf"

  • "pim"

  • "rf"

  • "rmon"

  • "snmp"

  • "storm-control"

  • "stpx"

  • "switchfabric"

  • "syslog"

  • "sysmgr"

  • "system"

  • "upgrade"

  • "vtp"

  • "all"

state

string

Manage the state of the resource.

Choices:

  • "enabled" ← (default)

  • "disabled"

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Limited Support for Cisco MDS

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

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

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

# ensure lldp trap configured
- cisco.nxos.nxos_snmp_traps:
    group: lldp
    state: enabled

# ensure lldp trap is not configured
- cisco.nxos.nxos_snmp_traps:
    group: lldp
    state: disabled

Return Values

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

Key

Description

commands

list / elements=string

command sent to the device

Returned: always

Sample: ["snmp-server enable traps lldp ;"]

Status

  • This module will be removed in a major release after 2024-01-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Jason Edelman (@jedelman8)