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

字符串

设置syslog数据包的优先级。值为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"

timestamp

字符串

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

选项

  • "UTC"

  • "localtime"

transport_mode

字符串

传输模式。该值属于枚举类型，且区分大小写。

选项

  • "tcp"

  • "udp"

vrf_name

字符串

日志服务器上的VPN名称。该值为长度为1到31个字符的字符串，区分大小写。默认值为 _public_。

注释

注意

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

  • 推荐连接方式为 netconf。

  • 对于旧版剧本，此模块也支持 local 连接。

示例

- 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版中移除。[已弃用]

  • 更多信息请参见 已弃用。

作者

  • 李彦峰 (@QijunPan)