You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_info_center_trap - Manages information center trap configuration on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages information center trap configurations on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
channel_id	no			Number of a channel. The value is an integer ranging from 0 to 9. The default value is 0.
module_name	no			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	no	present	present absent	Specify desired state of the resource.
trap_buff_enable	no	no_use	no_use true false	Whether a trap buffer is enabled to output information.
trap_buff_size	no			Size of a trap buffer. The value is an integer ranging from 0 to 1024. The default value is 256.
trap_enable	no	no_use	no_use true false	Whether a device is enabled to output alarms.
trap_level	no		emergencies alert critical error warning notification informational debugging	Trap level permitted to output.
trap_time_stamp	no		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.

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"
    ce_info_center_trap:
      state: present
      trap_buff_enable: true
      trap_buff_size: 768
      provider: "{{ cli }}"

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

  - name: "Config trap module log level"
    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"
    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 Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
changed	check to see if a change was made on the device	always	boolean	True
end_state	k/v pairs of aaa params after module execution	always	dict	{'trapBuffSize': '768', 'icTrapBuffEn': 'true'}
existing	k/v pairs of existing aaa server	always	dict	{'trapBuffSize': '256', 'icTrapBuffEn': 'false'}
proposed	k/v pairs of parameters passed into module	always	dict	{'state': 'present', 'trap_buff_size': '768', 'trap_buff_enable': 'true'}
updates	command sent to the device	always	list	['info-center trapbuffer', 'info-center trapbuffer size 768']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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