Docs4dev
Docs
ansible / latest / collections / community / network / pn_snmp_trap_sink_module.html

community.network.pn_snmp_trap_sink – CLI command to create/delete snmp-trap-sink

Note

This plugin is part of the community.network collection (version 3.0.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 community.network.

To use it in a playbook, specify: community.network.pn_snmp_trap_sink.

Synopsis

  • This module can be used to create a SNMP trap sink and delete a SNMP trap sink.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_community
string
community type.
pn_dest_host
string
destination host.
pn_dest_port
string
Default:
"162"
destination port.
pn_type
string
    Choices:
  • TRAP_TYPE_V1_TRAP
  • TRAP_TYPE_V2C_TRAP ←
  • TRAP_TYPE_V2_INFORM
trap type.
state
string / required
    Choices:
  • present
  • absent
State the action to perform. Use present to create snmp-trap-sink and absent to delete snmp-trap-sink.

Examples

- name: Snmp trap sink functionality
  community.network.pn_snmp_trap_sink:
    pn_cliswitch: "sw01"
    state: "present"
    pn_community: "foo"
    pn_type: "TRAP_TYPE_V2_INFORM"
    pn_dest_host: "192.168.67.8"

- name: Snmp trap sink functionality
  community.network.pn_snmp_trap_sink:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_community: "foo"
    pn_type: "TRAP_TYPE_V2_INFORM"
    pn_dest_host: "192.168.67.8"

Return Values

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

Key Returned Description
changed
boolean
always
indicates whether the CLI caused changes on the target.

command
string
always
the CLI command run on the target node.

stderr
list / elements=string
on error
set of error responses from the snmp-trap-sink command.

stdout
list / elements=string
always
set of responses from the snmp-trap-sink command.



Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_snmp_trap_sink_module.html