wti.remote.cpm_power_info – Получение информации о потреблении электроэнергии устройства WTI

Примечание

Этот плагин входит в коллекцию wti.remote (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install wti.remote.

Для использования в книге задач укажите: wti.remote.cpm_power_info.

В версии 2.9: wti.remote

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации о потреблении электроэнергии устройства WTI

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cpm_enddate строка		Дата окончания диапазона для поиска данных о потреблении электроэнергии
cpm_password строка / обязательно		Пароль устройства WTI для отправки модуля.
cpm_startdate строка		Дата начала диапазона для поиска данных о потреблении электроэнергии
cpm_url строка / обязательно		URL-адрес устройства WTI для отправки модуля.
cpm_username строка / обязательно		Имя пользователя устройства WTI для отправки модуля.
use_https булево	Варианты: no да ←	Определяет использование HTTPS-соединения или HTTP-соединения.
use_proxy булево	Варианты: нет ← да	Флаг для управления тем, будет ли поиск учитывать переменные среды HTTP-прокси при их наличии.
validate_certs булево	Варианты: нет да ←	Если ложно, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.

Примечания

Примечание

Используйте groups/cpm в module_defaults для установки общих параметров, используемых между модулями CPM.

Примеры

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

- name: Get the Power Information of a WTI device
  cpm_power_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', 'current2': '0.00', 'current3': '0.00', 'current4': '0.00', 'current5': '0.00', 'current6': '0.00', 'current7': '0.00', 'current8': '0.00', 'voltage1': '118.00'}], 'timestamp': '2020-02-24T21:45:18+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_power_info_module.html