модуль dellemc.openmanage.ome_powerstate — выполняет операции управления питанием в OpenManage Enterprise

Примечание

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

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

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

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

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

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

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

Этот модуль выполняет поддерживаемые операции управления питанием в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
device_id целое число	Идентификатор целевого устройства. device_id и device_service_tag являются взаимоисключающими параметрами.
device_service_tag строка	Метка обслуживания целевого устройства. device_service_tag и device_id являются взаимоисключающими параметрами.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
power_state строка / обязательный	Требуемое конечное состояние питания. Варианты: `"on"` `"off"` `"coldboot"` `"warmboot"` `"shutdown"`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная окружения `OME_USERNAME`. Пример: export OME_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 не указан, используется переменная окружения `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

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

Примеры

---
- name: Power state operation based on device id
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 11111
    power_state: "off"

- name: Power state operation based on device service tag
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: "KLBR111"
    power_state: "on"

- name: Power state operation based on list of device ids
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: "{{ item.device_id }}"
    power_state: "{{ item.state }}"
  with_items:
    - { "device_id": 11111, "state": "on" }
    - { "device_id": 22222, "state": "off" }

- name: Power state operation based on list of device service tags
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: "{{ item.service_tag }}"
    power_state: "{{ item.state }}"
  with_items:
    - { "service_tag": "KLBR111", "state": "on" }
    - { "service_tag": "KLBR222", "state": "off" }

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

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

Ключ	Описание
job_status словарь	Сведения о задании операции изменения состояния питания и ходе его выполнения из OME. Возвращается: при успешном выполнении Пример: {"Builtin": false, "CreatedBy": "user", "Editable": true, "EndTime": null, "Id": 11111, "JobDescription": "DeviceAction_Task", "JobName": "DeviceAction_Task_PowerState", "JobStatus": {"Id": 1111, "Name": "New"}, "JobType": {"Id": 1, "Internal": false, "Name": "DeviceAction_Task"}, "LastRun": "2019-04-01 06:39:02.69", "LastRunStatus": {"Id": 1112, "Name": "Running"}, "NextRun": null, "Params": [{"JobId": 11111, "Key": "powerState", "Value": "2"}, {"JobId": 11111, "Key": "operationName", "Value": "POWER_CONTROL"}], "Schedule": "", "StartTime": null, "State": "Enabled", "Targets": [{"Data": "", "Id": 11112, "JobId": 11111, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "Visible": true}
msg строка	Общий статус задания операции изменения состояния питания. Возвращается: всегда Пример: `"Power State operation job submitted successfully."`

Ключ

Описание

job_status

словарь

Сведения о задании операции изменения состояния питания и ходе его выполнения из OME.

Возвращается: при успешном выполнении

Пример: {"Builtin": false, "CreatedBy": "user", "Editable": true, "EndTime": null, "Id": 11111, "JobDescription": "DeviceAction_Task", "JobName": "DeviceAction_Task_PowerState", "JobStatus": {"Id": 1111, "Name": "New"}, "JobType": {"Id": 1, "Internal": false, "Name": "DeviceAction_Task"}, "LastRun": "2019-04-01 06:39:02.69", "LastRunStatus": {"Id": 1112, "Name": "Running"}, "NextRun": null, "Params": [{"JobId": 11111, "Key": "powerState", "Value": "2"}, {"JobId": 11111, "Key": "operationName", "Value": "POWER_CONTROL"}], "Schedule": "", "StartTime": null, "State": "Enabled", "Targets": [{"Data": "", "Id": 11112, "JobId": 11111, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "Visible": true}

msg

строка

Общий статус задания операции изменения состояния питания.

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

Пример: "Power State operation job submitted successfully."

Авторы

Felix Stephen (@felixs88)

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

© 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/ome_powerstate_module.html