wti.remote.cpm_current_info – Получить текущую информацию о устройстве WTI
Примечание
Этот плагин входит в состав коллекции wti.remote (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install wti.remote.
Для использования в плейбуке укажите: wti.remote.cpm_current_info.
В версии 2.9: модуля wti.remote
Описание
- Получить текущую информацию о устройстве WTI
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
cpm_enddate
строка
|
Конечная дата диапазона для поиска текущих данных
|
|
|
cpm_password
строка / обязательно
|
Пароль устройства WTI для отправки модуля.
|
|
|
cpm_startdate
строка
|
Начальная дата диапазона для поиска текущих данных
|
|
|
cpm_url
строка / обязательно
|
URL устройства WTI для отправки модуля.
|
|
|
cpm_username
строка / обязательно
|
Имя пользователя устройства WTI для отправки модуля.
|
|
|
use_https
логическое значение
|
|
Указывает на использование HTTPS-соединения или HTTP-соединения.
|
|
use_proxy
логическое значение
|
|
Флаг для управления наблюдением за переменными окружения HTTP-прокси при их наличии.
|
|
validate_certs
логическое значение
|
|
Если false, сертификаты SSL не будут проверены. Это следует использовать
только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.
|
Примечания
Примечание
- Используйте
groups/cpmвmodule_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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/wti/remote/cpm_current_info_module.html
