wti.remote.cpm_current_info 模块 – 获取 WTI 设备的当前信息

注意

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

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

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

要在剧本中使用它,请指定: wti.remote.cpm_current_info

wti.remote 2.9.0 中的新增功能

概要

  • 获取 WTI 设备的当前信息

参数

参数

注释

cpm_enddate

字符串

查找当前数据的范围的结束日期

cpm_password

字符串 / 必需

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

cpm_startdate

字符串

查找当前数据的范围的开始日期

cpm_url

字符串 / 必需

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

cpm_username

字符串 / 必需

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

use_https

布尔值

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

选项

  • false

  • true ← (默认)

use_proxy

布尔值

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

选项

  • false ← (默认)

  • true

validate_certs

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

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

示例

- name: Get the Current Information of a WTI device
  cpm_current_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

- name: Get the Current Information of a WTI device
  cpm_current_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false
    startdate: 01-12-2020"
    enddate: 02-16-2020"

返回值

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

描述

data

复杂类型

发送的命令返回的输出 JSON

返回: 始终

ats

字符串

标识 WTI 设备是否为 ATS 类型电源设备。

返回: 成功

示例: "1"

outletmetering

字符串

标识 WTI 设备是否具有电源插座计量功能。

返回: 成功

示例: "1"

plugcount

字符串

模块执行后 WTI 设备的当前插座插头数量。

返回: 成功

示例: "8"

powerdata

字典

模块执行后 WTI 设备的电源数据。

返回: 成功

示例: [{"branch1": [{"current1": "0.00", "voltage1": "118.00"}], "format": "F", "temperature": "90", "timestamp": "2020-02-24T23:29:31+00:00"}]

powerdatacount

字符串

模块执行后返回的总电源数据样本数。

返回: 成功

示例: "1"

powereff

字符串

模块执行后 WTI 设备的电源效率。

返回: 成功

示例: "100"

powerfactor

字符串

模块执行后 WTI 设备的功率因数。

返回: 成功

示例: "100"

powerunit

字符串

标识 WTI 设备是否为电源类型设备。

返回: 成功

示例: "1"

status

字典

模块完成后的返回状态

返回: 始终

示例: {"code": "0", "text": "OK"}

timestamp

字符串

模块执行后 WTI 设备的当前时间戳。

返回: 成功

示例: "2020-02-24T20:54:03+00:00"

作者

  • Western Telematic Inc. (@wtinetworkgear)