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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: dellemc.openmanage.redfish_powerstate.

Добавлено в dellemc.openmanage 2.1.0

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

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

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

Требования

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

python >= 3.9.6

Параметры

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

Ключ

Описание

error_info

dictionary

Сведения об ошибке 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

string

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

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

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

Авторы

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

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

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