W3cubDocs

/Ansible

community.network.ce_snmp_traps – Manages SNMP traps configuration on HUAWEI CloudEngine switches.

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.ce_snmp_traps.

Synopsis

  • Manages SNMP traps configurations on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
feature_name
string
    Choices:
  • aaa
  • arp
  • bfd
  • bgp
  • cfg
  • configuration
  • dad
  • devm
  • dhcpsnp
  • dldp
  • driver
  • efm
  • erps
  • error-down
  • fcoe
  • fei
  • fei_comm
  • fm
  • ifnet
  • info
  • ipsg
  • ipv6
  • isis
  • l3vpn
  • lacp
  • lcs
  • ldm
  • ldp
  • ldt
  • lldp
  • mpls_lspm
  • msdp
  • mstp
  • nd
  • netconf
  • nqa
  • nvo3
  • openflow
  • ospf
  • ospfv3
  • pim
  • pim-std
  • qos
  • radius
  • rm
  • rmon
  • securitytrap
  • smlktrap
  • snmp
  • ssh
  • stackmng
  • sysclock
  • sysom
  • system
  • tcp
  • telnet
  • trill
  • trunk
  • tty
  • vbst
  • vfs
  • virtual-perception
  • vrrp
  • vstm
  • all
Alarm feature name.
interface_number
string
Interface number.
interface_type
string
    Choices:
  • Ethernet
  • Eth-Trunk
  • Tunnel
  • NULL
  • LoopBack
  • Vlanif
  • 100GE
  • 40GE
  • MTunnel
  • 10GE
  • GE
  • MEth
  • Vbdif
  • Nve
Interface type.
port_number
string
Source port number.
trap_name
string
Alarm trap name.

Notes

Note

  • Recommended connection is network_cli.
  • This module also works with local connections for legacy playbooks.

Examples

- name: CloudEngine snmp traps test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config SNMP trap all enable"
    community.network.ce_snmp_traps:
      state: present
      feature_name: all
      provider: "{{ cli }}"

  - name: "Config SNMP trap interface"
    community.network.ce_snmp_traps:
      state: present
      interface_type: 40GE
      interface_number: 2/0/1
      provider: "{{ cli }}"

  - name: "Config SNMP trap port"
    community.network.ce_snmp_traps:
      state: present
      port_number: 2222
      provider: "{{ cli }}"

Return Values

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

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
always
k/v pairs of aaa params after module execution

Sample:
{'snmp-agent trap': ['enable'], 'undo snmp-agent trap': []}
existing
dictionary
always
k/v pairs of existing aaa server

Sample:
{'snmp-agent trap': [], 'undo snmp-agent trap': []}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'feature_name': 'all', 'state': 'present'}
updates
list / elements=string
always
command sent to the device

Sample:
['snmp-agent trap enable']


Authors

  • wangdezhuang (@QijunPan)

© 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/ce_snmp_traps_module.html