community.network.ce_info_center_global 模块 – 管理华为 CloudEngine 交换机上的日志输出。

注意

此模块是 community.network 集合(版本 5.1.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.network

要在 Playbook 中使用它,请指定:community.network.ce_info_center_global

注意

community.network 集合已被弃用,将从 Ansible 12 中删除。有关更多信息,请参阅讨论线程

已弃用

在以下版本中删除:

6.0.0 版

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 此模块允许在华为 CloudEngine 交换机上输出到日志缓冲区、日志文件、控制台、终端或日志主机。

别名:network.cloudengine.ce_info_center_global

参数

参数

注释

channel_cfg_name

字符串

通道名称。该值是 1 到 30 个区分大小写的字符的字符串。默认值为 console。

默认值: "console"

channel_id

字符串

通道的数字。该值是 0 到 9 的整数。默认值为 0。

channel_name

字符串

通道名称。该值是 1 到 30 个区分大小写的字符的字符串。

channel_out_direct

字符串

信息输出的方向。

选项

  • "console"

  • "monitor"

  • "trapbuffer"

  • "logbuffer"

  • "snmp"

  • "logfile"

facility

字符串

日志记录工具。

选项

  • "local0"

  • "local1"

  • "local2"

  • "local3"

  • "local4"

  • "local5"

  • "local6"

  • "local7"

filter_feature_name

字符串

已过滤日志的功能名称。该值是 1 到 31 个不区分大小写的字符的字符串。

filter_log_name

字符串

已过滤日志的名称。该值是 1 到 63 个区分大小写的字符的字符串。

info_center_enable

字符串

是否启用信息中心功能。该值是布尔类型。

选项

  • "true"

  • "false"

ip_type

字符串

日志服务器地址类型,IPv4 或 IPv6。

选项

  • "ipv4"

  • "ipv6"

is_default_vpn

布尔值

是否使用默认 VPN。

选项

  • false ← (默认)

  • true

level

字符串

保存在日志服务器上的日志级别。

选项

  • "emergencies"

  • "alert"

  • "critical"

  • "error"

  • "warning"

  • "notification"

  • "informational"

  • "debugging"

logfile_max_num

字符串

相同类型的日志文件的最大数量。默认值为 200。

日志文件的值范围是 [3, 500],安全文件的值范围是 [1, 3],操作文件的值范围是 [1, 7]。

logfile_max_size

字符串

日志文件的最大大小(以 MB 为单位)。默认值为 32。

日志文件的值范围是 [4, 8, 16, 32],安全文件的值范围是 [1, 4],

操作文件的值范围是 [1, 4]。

选项

  • "4"

  • "8"

  • "16"

  • "32"

默认值: 32

packet_priority

字符串

设置系统日志数据包的优先级。该值是 0 到 7 的整数。默认值为 0。

server_domain

字符串

服务器名称。该值是 1 到 255 个区分大小写的字符的字符串。

server_ip

字符串

日志服务器地址,IPv4 或 IPv6 类型。该值是 0 到 255 个字符的字符串。该值可以是有效的 IPv4 或 IPv6 地址。

server_port

字符串

发送日志的端口号。该值是 1 到 65535 的整数。对于 UDP,默认值为 514。对于 TCP,默认值为 601。对于 TSL,默认值为 6514。

source_ip

字符串

日志源 IP 地址,IPv4 或 IPv6 类型。该值是 0 到 255 的字符串。该值可以是有效的 IPv4 或 IPv6 地址。

ssl_policy_name

字符串

SSL 策略名称。该值是 1 到 23 个区分大小写的字符的字符串。

state

字符串

指定资源的所需状态。

选项

  • "present" ← (默认)

  • "absent"

suppress_enable

字符串

是否启用设备以抑制重复统计信息。该值是布尔类型。

选项

  • "false"

  • "true"

时间戳

字符串

日志服务器时间戳。该值是枚举类型,且区分大小写。

选项

  • “UTC”

  • “localtime”

transport_mode

字符串

传输模式。该值是枚举类型,且区分大小写。

选项

  • “tcp”

  • “udp”

vrf_name

字符串

日志服务器上的 VPN 名称。该值是一个由 1 到 31 个区分大小写的字符组成的字符串。默认值为 _public_。

注意

注意

  • 此模块需要在被管理的远程设备上启用 netconf 系统服务。

  • 推荐的连接方式是 netconf

  • 此模块也适用于 local 连接,用于旧版 playbook。

示例

- name: Info center global module test
  hosts: cloudengine
  connection: local
  gather_facts: false
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: Config info-center enable
    community.network.ce_info_center_global:
      info_center_enable: true
      state: present
      provider: "{{ cli }}"

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

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

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

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

  - name: Config info-center console channel 1
    community.network.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
    community.network.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
    community.network.ce_info_center_global:
      logfile_max_size: 16
      state: present
      provider: "{{ cli }}"

  - name: Config syslog loghost domain.
    community.network.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 }}"

返回值

常见的返回值已在此处记录 此处,以下是此模块独有的字段

描述

changed

布尔值

检查设备上是否进行了更改

返回: 始终

示例: true

end_state

字典

模块执行后 aaa 参数的键/值对

返回: 始终

示例: {"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"}]}

existing

字典

现有回滚的键/值对

返回: 始终

示例: {"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"}]}

proposed

字典

传递到模块的参数的键/值对

返回: 始终

示例: {"channel_id": "1", "facility": "local4", "is_default_vpn": true, "level": "alert", "server_domain": "aaa", "server_port": "100", "state": "present", "timestamp": "localtime", "transport_mode": "tcp"}

updates

列表 / 元素=字符串

发送到设备的命令

返回: 始终

示例: ["info-center loghost domain aaa level alert port 100 facility local4 channel 1 localtime transport tcp"]

状态

  • 此模块将在 6.0.0 版本中移除。[已弃用]

  • 有关更多信息,请参阅已弃用

作者

  • Li Yanfeng (@QijunPan)