dellemc.openmanage.redfish_powerstate – Управление состоянием питания устройства

Примечание

Этот плагин входит в состав коллекции dellemc.openmanage (версия 3.0.0).

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

Для использования в книге задач укажите: dellemc.openmanage.redfish_powerstate.

Введено в версии 2.1.0: модуля dellemc.openmanage

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

Обзор

Этот модуль позволяет управлять различными состояниями питания указанного устройства.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7.5

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
baseuri строка / обязательно		IP-адрес целевого контроллера вне полосы пропускания. Например, <ipaddress>:<port>.
password строка / обязательно		Пароль целевого контроллера вне полосы пропускания.
reset_type строка / обязательно	Варианты: ForceOff ForceOn ForceRestart GracefulRestart GracefulShutdown Nmi On PowerCycle PushPowerButton	Этот параметр перезапускает устройство. Если `ForceOff`, немедленно отключает устройство. Если `ForceOn`, немедленно включает устройство. Если `ForceRestart`, немедленно выключает устройство, а затем перезапускает его. Если `GracefulRestart`, выполняет плавное выключение устройства, а затем перезапускает его. Если `GracefulShutdown`, выполняет плавное выключение устройства и отключает его. Если `Nmi`, отправляет диагностический прерывание устройству. Как правило, это немаскируемое прерывание (NMI) на устройстве x86. Если `On`, включает устройство. Если `PowerCycle`, выполняет цикл питания устройства. Если `PushPowerButton`, имитирует нажатие физической кнопки питания на устройстве. При выполнении операции управления питанием, которая не поддерживается устройством, отображается сообщение об ошибке со списком поддерживаемых операций.
resource_id строка		Уникальный идентификатор управляемого устройства. Например, https://<baseuri>/redfish/v1/Systems/<resource_id>. Этот параметр обязателен для base_uri с несколькими устройствами. Для получения данных об устройстве используйте API https://<baseuri>/redfish/v1/Systems.
username строка / обязательно		Имя пользователя целевого контроллера вне полосы пропускания.

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к API Redfish.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Manage power state of the first device
  dellemc.openmanage.redfish_powerstate:
       baseuri: "192.168.0.1"
       username: "username"
       password: "password"
       reset_type: "On"

- name: Manage power state of a specified device
  dellemc.openmanage.redfish_powerstate:
       baseuri: "192.168.0.1"
       username: "username"
       password: "password"
       reset_type: "ForceOff"
       resource_id: "System.Embedded.1"

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
error_info словарь	при ошибке HTTP	Подробности об ошибке HTTP. Пример: {'error': {'@Message.ExtendedInfo': [{'Message': 'Не удалось завершить операцию, так как ресурс /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset не найден.', 'MessageArgs': ['/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset'], 'MessageArgs@odata.count': 1, 'MessageId': 'IDRAC.2.1.SYS403', 'RelatedProperties': [], 'RelatedProperties@odata.count': 0, 'Resolution': 'Укажите правильный ресурс и повторите операцию. Сведения о допустимых ресурсах см. в руководстве пользователя Redfish, доступном на сайте поддержки.', 'Severity': 'Critical'}], 'code': 'Base.1.5.GeneralError', 'message': 'Произошла общая ошибка. Дополнительные сведения см. в ExtendedInfo'}}
msg строка	всегда	Общий статус операции перезагрузки. Пример: Операция перезагрузки типа 'On' выполнена успешно.

Авторы

Sajna Shetty(@Sajna-Shetty)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/redfish_powerstate_module.html