wti.remote.cpm_syslog_client_config 模块 – 在 WTI OOB 和 PDU 设备中设置网络 SYSLOG 客户端参数

注意

此模块是 wti.remote 集合 (版本 1.0.10) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install wti.remote。

要在 playbook 中使用它，请指定： wti.remote.cpm_syslog_client_config。

wti.remote 2.11.0 中的新增功能

概要

  • 在 WTI OOB 和 PDU 设备中设置网络 SYSLOG 客户端参数

参数

参数

注释

address

列表 / 元素=字符串

设置要联系的 SYSLOG 服务器的 IP 地址。

clear

整数

在设置新定义的条目之前，删除为正在定义的协议设置的所有 IP 块条目。

选项

  • 0

  • 1

cpm_password

字符串 / 必需

这是发送模块到 WTI 设备的密码。

cpm_url

字符串 / 必需

这是发送模块到 WTI 设备的 URL。

cpm_username

字符串 / 必需

这是发送模块到 WTI 设备的用户名。

index

列表 / 元素=整数

正在修改的 IP 块的索引。

port

列表 / 元素=整数

定义 SYSLOG 客户端使用的端口号 (1-65535)。

protocol

整数

应应用 SYSLOG 条目的协议。0 = ipv4，1 = ipv6。

选项

  • 0

  • 1

secure

列表 / 元素=整数

定义 SYSLOG 客户端是否使用安全连接（需要 TCP 传输）。

transport

列表 / 元素=整数

定义 SYSLOG 客户端使用的传输协议类型。0=UDP，1=TCP；

use_https

布尔值

指定使用 https 连接还是 http 连接。

选项

  • false

  • true ← (默认)

use_proxy

布尔值

标志，用于控制查找在存在时是否会观察 HTTP 代理环境变量。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。这仅应在使用自签名证书的个人控制站点上使用。

。

选项

  • false

  • true ← (默认)

备注

注意

  • 在 module_defaults 中使用 groups/cpm 设置 CPM 模块之间使用的常用选项。

示例

# Sets the device SYSLOG Client Parameters
- name: Set the an SYSLOG Client Parameter for a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
      - 1
    address:
      - "11.22.33.44"
    port:
      - 555
    transport:
      - 1
    secure:
      - 0

# Sets the device SYSLOG Client Parameters
- name: Set the SYSLOG Client Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
      - 1
      - 2
    address:
      - "11.22.33.44"
      - "55.66.77.88"
    port:
      - 555
      - 557
    transport:
      - 1
      - 0
    secure:
      - 0
      - 1

返回值

公共返回值已在此处记录，以下是此模块独有的字段

键

描述

data

复杂类型

发送的命令返回的输出 JSON

返回：始终

syslogclient

字典

模块执行后 WTI 设备的接口信息的当前键值对。

返回：始终

示例： {"syslogclient": {"ietf-ipv4": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}, "ietf-ipv6": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}}}

作者

  • Western Telematic Inc. (@wtinetworkgear)