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

community.network.ce_info_center_trap – Manages information center trap 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_info_center_trap.

Synopsis

  • Manages information center trap configurations on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
channel_id
string
Number of a channel. The value is an integer ranging from 0 to 9. The default value is 0.
module_name
string
Module name of the rule. The value is a string of 1 to 31 case-insensitive characters. The default value is default. Please use lower-case letter, such as [aaa, acl, arp, bfd].
state
string
    Choices:
  • present ←
  • absent
Specify desired state of the resource.
trap_buff_enable
string
    Choices:
  • no_use ←
  • true
  • false
Whether a trap buffer is enabled to output information.
trap_buff_size
string
Size of a trap buffer. The value is an integer ranging from 0 to 1024. The default value is 256.
trap_enable
string
    Choices:
  • no_use ←
  • true
  • false
Whether a device is enabled to output alarms.
trap_level
string
    Choices:
  • emergencies
  • alert
  • critical
  • error
  • warning
  • notification
  • informational
  • debugging
Trap level permitted to output.
trap_time_stamp
string
    Choices:
  • date_boot
  • date_second
  • date_tenthsecond
  • date_millisecond
  • shortdate_second
  • shortdate_tenthsecond
  • shortdate_millisecond
  • formatdate_second
  • formatdate_tenthsecond
  • formatdate_millisecond
Timestamp format of alarm information.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Recommended connection is netconf.
  • This module also works with local connections for legacy playbooks.

Examples

- name: CloudEngine info center trap 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 trap buffer"
    community.network.ce_info_center_trap:
      state: present
      trap_buff_enable: true
      trap_buff_size: 768
      provider: "{{ cli }}"

  - name: "Undo trap buffer"
    community.network.ce_info_center_trap:
      state: absent
      trap_buff_enable: true
      trap_buff_size: 768
      provider: "{{ cli }}"

  - name: "Config trap module log level"
    community.network.ce_info_center_trap:
      state: present
      module_name: aaa
      channel_id: 1
      trap_enable: true
      trap_level: error
      provider: "{{ cli }}"

  - name: "Undo trap module log level"
    community.network.ce_info_center_trap:
      state: absent
      module_name: aaa
      channel_id: 1
      trap_enable: true
      trap_level: error
      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:
{'icTrapBuffEn': 'true', 'trapBuffSize': '768'}
existing
dictionary
always
k/v pairs of existing aaa server

Sample:
{'icTrapBuffEn': 'false', 'trapBuffSize': '256'}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'state': 'present', 'trap_buff_enable': 'true', 'trap_buff_size': '768'}
updates
list / elements=string
always
command sent to the device

Sample:
['info-center trapbuffer', 'info-center trapbuffer size 768']


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_info_center_trap_module.html