Модуль 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 строка / обязательно	URL устройства WTI для отправки модуля.
cpm_username строка / обязательно	Имя пользователя устройства WTI для отправки модуля.
use_https логическое	Определяет использование подключения https или http. Варианты: `false` `true` ← (по умолчанию)
use_proxy логическое	Флаг для управления наблюдением за переменными среды HTTP-прокси при их наличии. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое	Если ложно, сертификаты SSL не будут валидироваться. Это следует использовать только на контролируемых сайтах с использованием самозаверенных сертификатов. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используйте 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"

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
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 строка	Общее количество образцов powerdata, возвращенных после выполнения модуля. Возвращается: успешно Пример: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/wti/remote/cpm_current_info_module.html