dellemc.openmanage.ome_devices модуль — Выполнение операций, специфичных для устройства, на целевых устройствах

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: dellemc.openmanage.ome_devices.

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

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

Обзор

Выполнение операций, специфичных для устройства, таких как обновление инвентаризации, очистка очереди задач iDRAC и сброс iDRAC из OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использован для проверки.
device_action строка	`refresh_inventory` обновляет инвентаризацию на целевых устройствах. `reset_idrac` Вызывает сброс на целевых iDRAC. `clear_idrac_job_queue` Очищает очередь заданий на целевых iDRAC. Для каждого действия запускается задание. Варианты: `"refresh_inventory"` ← (по умолчанию) `"reset_idrac"` `"clear_idrac_job_queue"`
device_ids список / элементы=целое число	Идентификаторы целевых устройств. Взаимоисключительно с device_service_tags.
device_service_tags список / элементы=строка	Теги сервиса целевых устройств. Взаимоисключительно с device_ids.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise.
job_description строка	Необязательное описание задания.
job_name строка	Необязательное имя задания.
job_schedule строка	Укажите строку cron для планирования задания. По умолчанию: `"startnow"`
job_wait логическое	Предоставляет возможность ожидания завершения задания. Этот параметр применим, когда state равно `present`. Это применимо, когда job_schedule равно `startnow`. Варианты: `false` `true` ← (по умолчанию)
job_wait_timeout целое число	Максимальное время ожидания job_wait в секундах. Задание отслеживается только в течение этого времени. Этот параметр применим, когда job_wait равно `true`. По умолчанию: `1200`
password строка	Пароль OpenManage Enterprise. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise. По умолчанию: `443`
state строка	`present` Позволяет выполнить device_action на целевых устройствах. `absent` Удаляет устройство из OpenManage Enterprise. Задание не запускается. job_wait, job_schedule, job_name и job_description не применимы к этой операции. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_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

Примечания

Примечание

Для idrac_reset, задание запускает только операцию сброса iDRAC и не отслеживает весь цикл сброса.
Запускайте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Refresh Inventory
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: refresh_inventory
    device_service_tags:
      - SVCTAG1

- name: Clear iDRAC job queue
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: clear_idrac_job_queue
    device_service_tags:
      - SVCTAG1

- name: Reset iDRAC using the service tag
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: reset_idrac
    device_service_tags:
      - SVCTAG1

- name: Remove devices using servicetags
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    device_service_tags:
      - SVCTAG1
      - SVCTAF2

- name: Remove devices using IDs
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    device_ids:
      - 10235

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

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

Ключ	Описание
error_info словарь	Подробности HTTP-ошибки. Возвращается: при HTTP-ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the requested URI is invalid.", "MessageArgs": [], "MessageId": "CGEN1002", "RelatedProperties": [], "Resolution": "Enter a valid URI and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
job словарь	Подробности задачи по работе с устройствами. Возвращается: при успехе Пример: {"Builtin": false, "CreatedBy": "admin", "Editable": true, "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(14874)/ExecutionHistories", "Id": 14874, "JobDescription": "The Refresh inventory task initiated from OpenManage Ansible Modules for devices with the ids '13216'.", "JobName": "Refresh inventory", "JobStatus": {"@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled"}, "JobType": {"@odata.type": "#JobService.JobType", "Id": 8, "Internal": false, "Name": "Inventory_Task"}, "LastExecutionDetail": {"@odata.id": "/api/JobService/Jobs(14874)/LastExecutionDetail"}, "LastRunStatus": {"@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed"}, "Params": [{"JobId": 14874, "Key": "action", "Value": "CONFIG_INVENTORY"}, {"JobId": 14874, "Key": "isCollectDriverInventory", "Value": "true"}], "Schedule": "startnow", "State": "Enabled", "Targets": [{"Data": "", "Id": 13216, "JobId": 14874, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "UserGenerated": true, "Visible": true}
msg строка	Общий статус выполнения операции с устройствами. Возвращается: всегда Пример: `"Successfully removed the device(s)."`

Авторы

Jagadeesh N V(@jagadeeshnv)
ShivamSh3(@ShivamSh3)

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

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