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

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

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

Новое в dellemc.openmanage 2.1.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
baseuri строка / обязательно	IP-адрес целевого внешнего контроллера. Например - <ipaddress>:<port>.
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
oem_reset_type словарь добавлено в dellemc.openmanage 9.5.0	Этот параметр инициирует полный цикл питания переменного тока (AC) сервера, что эквивалентно отключению кабелей питания с использованием OEM API. oem_reset_type взаимоисключает reset_type. Если значение ‘final_power_state’ не указано, значение по умолчанию – ‘Off’.
password строка	Пароль целевого внешнего контроллера. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=password
reset_type строка	Этот параметр перезагружает устройство. `ForceOff` немедленно выключает устройство. `ForceOn` немедленно включает устройство. `ForceRestart` немедленно выключает устройство, а затем перезапускает сервер. `GracefulRestart` выполняет плавное завершение работы устройства, а затем перезапускает его. `GracefulShutdown` выполняет плавное завершение работы устройства, а затем выключает его. `Nmi` отправляет диагностическое прерывание на устройство. Обычно это не маскируемое прерывание (NMI) в системах x86. `On` включает устройство. `PowerCycle` выполняет цикл питания устройства. `PushPowerButton` имитирует нажатие физической кнопки питания на устройстве. reset_type взаимоисключает oem_reset_type. При выполнении операции управления питанием, которая не поддерживается устройством, отображается сообщение об ошибке со списком операций, которые можно выполнить. Варианты: `"ForceOff"` `"ForceOn"` `"ForceRestart"` `"GracefulRestart"` `"GracefulShutdown"` `"Nmi"` `"On"` `"PowerCycle"` `"PushPowerButton"`
resource_id строка	Этот параметр является уникальным идентификатором управляемого устройства. Например, https://<I(baseuri>/redfish/v1/Systems/<resource_id>). Этот параметр обязателен для base_uri с несколькими устройствами. Для получения подробной информации об устройстве используйте API https://<I(baseuri>/redfish/v1/Systems) для операции reset_type и https://<I(baseuri>/redfish/v1/Chassis) для операции oem_reset_type.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Таймаут на уровне сокета в секундах. Значение по умолчанию: `30`
username строка	Имя пользователя целевого внешнего контроллера. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=username
validate_certs булево добавлено в dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты проверяться не будут. Настраивайте `false` только на лично контролируемых сайтах, где используются самоподписанные сертификаты. До версии коллекции `5.0.0`, validate_certs по умолчанию `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `IDRAC_X_AUTH_TOKEN`. Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль из системы, имеющей прямой доступ к 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"
    ca_path: "/path/to/ca_cert.pem"
    reset_type: "On"

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

- name: Perform AC Power Cycle with final power state On
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    oem_reset_type:
      dell:
        final_power_state: "On"
        reset_type: "PowerCycle"

- name: Perform AC Power Cycle  with final power state Off
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    oem_reset_type:
      dell:
        final_power_state: "Off"
        reset_type: "PowerCycle"

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

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

Ключ	Описание
error_info словарь	Подробности об ошибке HTTP. Возвращается: при ошибке HTTP Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the resource /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset entered in not found.", "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": "Enter the correct resource and retry the operation. For information about valid resource, see the Redfish Users Guide available on the support site.", "Severity": "Critical"}], "code": "Base.1.5.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}
msg строка	Общий статус операции сброса. Возвращается: всегда Пример: `"Successfully performed the reset type operation 'On'."`

Ключ

Описание

error_info

словарь

Подробности об ошибке HTTP.

Возвращается: при ошибке HTTP

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the resource /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset entered in not found.", "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": "Enter the correct resource and retry the operation. For information about valid resource, see the Redfish Users Guide available on the support site.", "Severity": "Critical"}], "code": "Base.1.5.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}

msg

строка

Общий статус операции сброса.

Возвращается: всегда

Пример: "Successfully performed the reset type operation 'On'."

Авторы

Sajna Shetty(@Sajna-Shetty)
Lovepreet Singh (@singh-lovepreet1)

Ссылки на коллекцию

© 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/dellemc/openmanage/redfish_powerstate_module.html