community.general.ce_info_center_global (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module offers the ability to be output to the log buffer, log file, console, terminal, or log host on HUAWEI CloudEngine switches.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: info center global module 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 info-center enable
    ce_info_center_global:
      info_center_enable: true
      state: present
      provider: "{{ cli }}"

  - name: Config statistic-suppress enable
    ce_info_center_global:
      suppress_enable: true
      state: present
      provider: "{{ cli }}"

  - name: Config info-center syslog packet-priority 1
    ce_info_center_global:
      packet_priority: 2
      state: present
      provider: "{{ cli }}"

  - name: Config info-center channel 1 name aaa
    ce_info_center_global:
      channel_id: 1
      channel_cfg_name: aaa
      state: present
      provider: "{{ cli }}"

  - name: Config info-center logfile size 10
    ce_info_center_global:
      logfile_max_num: 10
      state: present
      provider: "{{ cli }}"

  - name: Config info-center console channel 1
    ce_info_center_global:
      channel_out_direct: console
      channel_id: 1
      state: present
      provider: "{{ cli }}"

  - name: Config info-center filter-id bymodule-alias snmp snmp_ipunlock
    ce_info_center_global:
      filter_feature_name: SNMP
      filter_log_name: SNMP_IPLOCK
      state: present
      provider: "{{ cli }}"


  - name: Config info-center max-logfile-number 16
    ce_info_center_global:
      logfile_max_size: 16
      state: present
      provider: "{{ cli }}"

  - name: Config syslog loghost domain.
    ce_info_center_global:
      server_domain: aaa
      vrf_name: aaa
      channel_id: 1
      transport_mode: tcp
      facility: local4
      server_port: 100
      level: alert
      timestamp: UTC
      state: present
      provider: "{{ cli }}"

Inputs

    
level:
    choices:
    - emergencies
    - alert
    - critical
    - error
    - warning
    - notification
    - informational
    - debugging
    description:
    - Level of logs saved on a log server.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify desired state of the resource.

ip_type:
    choices:
    - ipv4
    - ipv6
    description:
    - Log server address type, IPv4 or IPv6.

facility:
    choices:
    - local0
    - local1
    - local2
    - local3
    - local4
    - local5
    - local6
    - local7
    description:
    - Log record tool.

vrf_name:
    description:
    - VPN name on a log server. The value is a string of 1 to 31 case-sensitive characters.
      The default value is _public_.

server_ip:
    description:
    - Log server address, IPv4 or IPv6 type. The value is a string of 0 to 255 characters.
      The value can be an valid IPv4 or IPv6 address.

source_ip:
    description:
    - Log source ip address, IPv4 or IPv6 type. The value is a string of 0 to 255. The
      value can be an valid IPv4 or IPv6 address.

timestamp:
    choices:
    - UTC
    - localtime
    description:
    - Log server timestamp. The value is of the enumerated type and case-sensitive.

channel_id:
    description:
    - Number for channel. The value is an integer ranging from 0 to 9. The default value
      is 0.

server_port:
    description:
    - Number of a port sending logs.The value is an integer ranging from 1 to 65535. For
      UDP, the default value is 514. For TCP, the default value is 601. For TSL, the default
      value is 6514.

channel_name:
    description:
    - Channel name. The value is a string of 1 to 30 case-sensitive characters.

server_domain:
    description:
    - Server name. The value is a string of 1 to 255 case-sensitive characters.

is_default_vpn:
    default: 'no'
    description:
    - Use the default VPN or not.
    type: bool

transport_mode:
    choices:
    - tcp
    - udp
    description:
    - Transport mode. The value is of the enumerated type and case-sensitive.

filter_log_name:
    description:
    - Name of the filtered log. The value is a string of 1 to 63 case-sensitive characters.

logfile_max_num:
    description:
    - Maximum number of log files of the same type. The default value is 200.
    - The value range for log files is[3, 500], for security files is [1, 3],and for operation
      files is [1, 7].

packet_priority:
    description:
    - Set the priority of the syslog packet.The value is an integer ranging from 0 to
      7. The default value is 0.

ssl_policy_name:
    description:
    - SSL policy name. The value is a string of 1 to 23 case-sensitive characters.

suppress_enable:
    choices:
    - 'false'
    - 'true'
    description:
    - Whether a device is enabled to suppress duplicate statistics. The value is of the
      Boolean type.

channel_cfg_name:
    default: console
    description:
    - Channel name.The value is a string of 1 to 30 case-sensitive characters. The default
      value is console.

logfile_max_size:
    choices:
    - '4'
    - '8'
    - '16'
    - '32'
    default: 32
    description:
    - Maximum size (in MB) of a log file. The default value is 32.
    - The value range for log files is [4, 8, 16, 32], for security files is [1, 4],
    - and for operation files is [1, 4].

channel_out_direct:
    choices:
    - console
    - monitor
    - trapbuffer
    - logbuffer
    - snmp
    - logfile
    description:
    - Direction of information output.

info_center_enable:
    choices:
    - 'true'
    - 'false'
    description:
    - Whether the info-center function is enabled. The value is of the Boolean type.

filter_feature_name:
    description:
    - Feature name of the filtered log. The value is a string of 1 to 31 case-insensitive
      characters.

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of aaa params after module execution
  returned: always
  sample:
    server_domain_info:
    - chnlId: '1'
      chnlName: monitor
      facility: local4
      isBriefFmt: 'false'
      isDefaultVpn: 'true'
      level: alert
      serverDomain: aaa
      serverPort: '100'
      sourceIP: 0.0.0.0
      sslPolicyName: null
      timestamp: localtime
      transportMode: tcp
      vrfName: _public_
    - chnlId: '1'
      chnlName: monitor
      facility: local4
      isBriefFmt: 'false'
      isDefaultVpn: 'false'
      level: alert
      serverDomain: aaa
      serverPort: '100'
      sourceIP: 0.0.0.0
      sslPolicyName: gmc
      timestamp: UTC
      transportMode: tcp
      vrfName: aaa
  type: dict
existing:
  description: k/v pairs of existing rollback
  returned: always
  sample:
    server_domain_info:
    - chnlId: '1'
      chnlName: monitor
      facility: local4
      isBriefFmt: 'false'
      isDefaultVpn: 'false'
      level: alert
      serverDomain: aaa
      serverPort: '100'
      sourceIP: 0.0.0.0
      sslPolicyName: gmc
      timestamp: UTC
      transportMode: tcp
      vrfName: aaa
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    channel_id: '1'
    facility: local4
    is_default_vpn: true
    level: alert
    server_domain: aaa
    server_port: '100'
    state: present
    timestamp: localtime
    transport_mode: tcp
  type: dict
updates:
  description: command sent to the device
  returned: always
  sample:
  - info-center loghost domain aaa level alert port 100 facility local4 channel 1
    localtime transport tcp
  type: list