wti.remote.cpm_syslog_server_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_server_config

wti.remote 2.11.0 中的新增功能

概要

  • 在 WTI OOB 和 PDU 设备中设置网络 SYSLOG 服务器参数

参数

参数

注释

address

列表 / 元素=字符串

设置阻止消息日志记录的 IP 地址。

clear

整数

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

选项

  • 0

  • 1

cpm_password

字符串 / 必需

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

cpm_url

字符串 / 必需

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

cpm_username

字符串 / 必需

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

enable

整数

激活为指定的接口和协议监听 SYSLOG。

选项

  • 0

  • 1

index

列表 / 元素=整数

正在修改的 IP 块的索引。

interface

字符串 / 必需

我们正在定义的 SYSLOG 的以太网端口。

选项

  • "eth0"

  • "eth1"

  • "ppp0"

  • "qmimux0"

port

整数

定义 SYSLOG 服务器使用的端口号 (1 - 65535)。

protocol

整数

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

选项

  • 0

  • 1

secure

整数

定义 SYSLOG 服务器是否使用安全连接(需要 TCP 传输)。

选项

  • 0

  • 1

transport

整数

定义 SYSLOG 服务器使用的传输协议类型。0=UDP,1=TCP;

选项

  • 0

  • 1

use_https

布尔值

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

选项

  • false

  • true ← (默认)

use_proxy

布尔值

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

选项

  • false ← (默认)

  • true

validate_certs

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用 groups/cpmmodule_defaults 中设置 CPM 模块之间使用的公共选项。

示例

# Sets the device SYSLOG Server Parameters
- name: Set the an SYSLOG Server 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
    interface: "eth0"
    protocol: 0
    port: 514
    transport: 0
    secure: 0
    clear: 1

# Sets the device SYSLOG Server Parameters
- name: Set the SYSLOG Server Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    interface: "eth0"
    protocol: 0
    port: 514
    transport: 0
    secure: 0
    clear: 1
    index:
      - 1
      - 2
    block:
      - "192.168.50.4"
      - "72.76.4.56"

返回值

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

描述

data

复杂类型

发送的命令返回的输出 JSON

返回:始终

syslogserver

字典

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

返回:始终

示例: {"syslogserver": {"eth0": [{"ietf-ipv4": {"block": [{"address": "", "index": "1"}, {"address": "", "index": "2"}, {"address": "", "index": "3"}, {"address": "", "index": "4"}], "enable": 0, "port": "514", "secure": "0", "transport": "0"}, "ietf-ipv6": {"block": [{"address": "", "index": "1"}, {"address": "", "index": "2"}, {"address": "", "index": "3"}, {"address": "", "index": "4"}], "enable": 0, "port": "514", "secure": "0", "transport": "0"}}]}}

作者

  • Western Telematic Inc. (@wtinetworkgear)