wti.remote.cpm_web_info 模块 – 从 WTI OOB 和 PDU 设备获取网络 Web 参数

注意

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

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

要安装它,请使用: ansible-galaxy collection install wti.remote

要在 playbook 中使用它,请指定: wti.remote.cpm_web_info

wti.remote 2.10.0 中的新增功能

概要

  • 从 WTI OOB 和 PDU 设备获取网络 Web 参数

参数

参数

注释

cpm_password

字符串 / 必需

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

cpm_username 为空,则此参数被认为是用户令牌。

cpm_url

字符串 / 必需

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

cpm_username

字符串

这是发送到 WTI 设备的模块的用户名。如果此值

为空,则 cpm_password 被认为是用户令牌。

include_certs

布尔值

如果为真,将返回 WTI 设备上的签名密钥、私钥和中间密钥。

选项

  • false ← (默认)

  • true

interface

列表 / 元素=字符串

这是正在检索的以太网端口名称。它可以包含单个以太网

端口名称、多个以逗号分隔的以太网端口名称,或者未定义所有端口。

选项

  • "eth0"

  • "eth1"

  • "ppp0"

  • "qmimux0"

use_https

布尔值

指定使用 https 连接或 http 连接。

选项

  • false

  • true ← (默认)

use_proxy

布尔值

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

选项

  • false ← (默认)

  • true

validate_certs

布尔值

如果为 false,则不会验证 SSL 证书。这应该只在

使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

备注

注意

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

示例

- name: Get the network Web Parameters for all interfaces of a WTI device.
  cpm_web_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

- name: Get the network Web Parameters for all interfaces of a WTI device using a User Token.
  cpm_web_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: ""
    cpm_password: "randomusertokenfromthewtidevice"
    use_https: true
    validate_certs: false

- name: Get the network Web Parameters for eth0 of a WTI device, include the certificates in the response.
  cpm_web_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    include_certs: true
    use_https: false
    validate_certs: false
    interface: "eth0"

返回值

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

描述

data

复杂类型

发送的命令返回的输出 JSON

返回:始终

ocsp

整数

Web 服务器的在线证书状态协议 (OCSP) 的当前状态。

返回:成功

示例: 1

totalports

整数

当前调用返回的总端口数。

返回:成功

示例: 1

trace

整数

Web 服务器的 TRACE 请求的当前状态。

返回:成功

示例: 0

web

字典

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

返回:始终

示例: [{"harden": "2", "hsts": "0", "httpenable": "1", "httpport": "80", "httpsenable": "1", "httpsport": "443", "name": "eth0", "tlsmode": "2"}]

webterm

整数

Web 服务器的 Web 上 CLI 的当前状态。

返回:成功

示例: 0

作者

  • Western Telematic Inc. (@wtinetworkgear)