Модуль dellemc.openmanage.ome_job_info — Получение подробностей о задании по заданному ID задания или всей очереди заданий в OpenManage Enterprise

Примечание

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

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

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

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

Новая в dellemc.openmanage 2.0.0

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

Описание

Этот модуль извлекает подробности о задании по заданному ID задания или всей очереди заданий в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл PEM (Privacy Enhanced Mail), содержащий сертификат CA, используемый для проверки.
fetch_execution_history логическое	Извлекает историю выполнения задания. fetch_execution_history применим только при указании корректного job_id. В случае `true`, извлекает все детали истории выполнения. В случае `false`, извлекает только информацию о задании и последние данные о выполнении. Варианты: `false` ← (по умолчанию) `true`
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
job_id целое число	Уникальный ID задания.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
system_query_options словарь	Параметры для постраничного вывода.
filter строка	Фильтр записей по поддерживаемым значениям.
skip целое число	Количество записей для пропуска. Значение по умолчанию 0.
top целое число	Количество записей для возврата. Значение по умолчанию 100.
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: Get all jobs details
  dellemc.openmanage.ome_job_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Get job details for id
  dellemc.openmanage.ome_job_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    job_id: 12345

- name: Get filtered job details
  dellemc.openmanage.ome_job_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    system_query_options:
      top: 2
      skip: 1
      filter: "JobType/Id eq 8"

- name: Get detail job execution history with last execution detail for a job.
  dellemc.openmanage.ome_job_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    job_id: 12345
    fetch_execution_history: true

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

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

Ключ	Описание
job_info словарь	Подробности задач OpenManage Enterprise. Возвращается: успех Пример: {"value": [{"Builtin": false, "CreatedBy": "admin", "Editable": true, "EndTime": null, "ExecutionHistories": [{"EndTime": "2023-06-07 09:33:08.403", "ExecutedBy": "admin", "ExecutionHistoryDetails": [{"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:33:08.189", "ExecutionHistoryId": 1243224, "Id": 1288519, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:33:07.525", "Value": "Running\nDiscovery of target 198.168.0.1 started .\nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}, {"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:33:08.313", "ExecutionHistoryId": 1243224, "Id": 1288518, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.2", "Progress": "100", "StartTime": "2023-06-07 09:33:07.521", "Value": "Running\nDiscovery of target 198.168.0.2 started. \nDiscovery target resolved to IP 198.168.0.2 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}], "Id": 1243224, "JobId": 10429, "JobName": "Discovery-201", "JobStatus": {"Id": 2070, "Name": "Failed"}, "LastUpdateTime": "2023-06-07 09:33:08.447185", "Progress": "100", "StartTime": "2023-06-07 09:33:07.148"}, {"EndTime": "2023-06-07 09:30:56.338", "ExecutedBy": "admin", "ExecutionHistoryDetails": [{"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:30:56.085", "ExecutionHistoryId": 1243218, "Id": 1288512, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:30:55.441", "Value": "Running\nDiscovery of target 198.168.0.1 started. \nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}, {"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:30:56.21", "ExecutionHistoryId": 1243218, "Id": 1288511, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.2", "Progress": "100", "StartTime": "2023-06-07 09:30:55.439", "Value": "Running\nDiscovery of target 198.168.0.2 started. \nDiscovery target resolved to IP 198.168.0.2 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}], "Id": 1243218, "JobId": 10429, "JobName": "Discovery-201", "JobStatus": {"Id": 2070, "Name": "Failed"}, "LastUpdateTime": "2023-06-07 09:30:56.365294", "Progress": "100", "StartTime": "2023-06-07 09:30:55.064"}], "Id": 10429, "JobDescription": "Discovery-201", "JobName": "Discovery-201", "JobStatus": {"Id": 2080, "Name": "New"}, "JobType": {"Id": 101, "Internal": false, "Name": "Discovery_Task"}, "LastExecutionDetail": {"ElapsedTime": null, "EndTime": "2023-06-07 09:33:08.189", "ExecutionHistoryId": 1243224, "Id": 1288519, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:33:07.525", "Value": "Running\nDiscovery of target 198.168.0.1 started. \nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation. \n=======================================\nTask Failed. Completed With Errors."}, "LastRun": "2023-06-07 09:33:07.161", "LastRunStatus": {"Id": 2070, "Name": "Failed"}, "NextRun": null, "Params": [], "Schedule": "startnow", "StartTime": null, "State": "Enabled", "Targets": [], "UpdatedBy": "admin", "UserGenerated": true, "Visible": true}]}
msg строка	Общий статус операции с фактами задач. Возвращается: всегда Пример: `"Successfully fetched the job info"`

Ключ

Описание

job_info

словарь

Подробности задач OpenManage Enterprise.

Возвращается: успех

Пример: {"value": [{"Builtin": false, "CreatedBy": "admin", "Editable": true, "EndTime": null, "ExecutionHistories": [{"EndTime": "2023-06-07 09:33:08.403", "ExecutedBy": "admin", "ExecutionHistoryDetails": [{"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:33:08.189", "ExecutionHistoryId": 1243224, "Id": 1288519, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:33:07.525", "Value": "Running\nDiscovery of target 198.168.0.1 started .\nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}, {"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:33:08.313", "ExecutionHistoryId": 1243224, "Id": 1288518, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.2", "Progress": "100", "StartTime": "2023-06-07 09:33:07.521", "Value": "Running\nDiscovery of target 198.168.0.2 started. \nDiscovery target resolved to IP 198.168.0.2 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}], "Id": 1243224, "JobId": 10429, "JobName": "Discovery-201", "JobStatus": {"Id": 2070, "Name": "Failed"}, "LastUpdateTime": "2023-06-07 09:33:08.447185", "Progress": "100", "StartTime": "2023-06-07 09:33:07.148"}, {"EndTime": "2023-06-07 09:30:56.338", "ExecutedBy": "admin", "ExecutionHistoryDetails": [{"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:30:56.085", "ExecutionHistoryId": 1243218, "Id": 1288512, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:30:55.441", "Value": "Running\nDiscovery of target 198.168.0.1 started. \nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}, {"ElapsedTime": "00:00:00", "EndTime": "2023-06-07 09:30:56.21", "ExecutionHistoryId": 1243218, "Id": 1288511, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.2", "Progress": "100", "StartTime": "2023-06-07 09:30:55.439", "Value": "Running\nDiscovery of target 198.168.0.2 started. \nDiscovery target resolved to IP 198.168.0.2 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation.\n=======================================\nTask Failed. Completed With Errors."}], "Id": 1243218, "JobId": 10429, "JobName": "Discovery-201", "JobStatus": {"Id": 2070, "Name": "Failed"}, "LastUpdateTime": "2023-06-07 09:30:56.365294", "Progress": "100", "StartTime": "2023-06-07 09:30:55.064"}], "Id": 10429, "JobDescription": "Discovery-201", "JobName": "Discovery-201", "JobStatus": {"Id": 2080, "Name": "New"}, "JobType": {"Id": 101, "Internal": false, "Name": "Discovery_Task"}, "LastExecutionDetail": {"ElapsedTime": null, "EndTime": "2023-06-07 09:33:08.189", "ExecutionHistoryId": 1243224, "Id": 1288519, "IdBaseEntity": 0, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "198.168.0.1", "Progress": "100", "StartTime": "2023-06-07 09:33:07.525", "Value": "Running\nDiscovery of target 198.168.0.1 started. \nDiscovery target resolved to IP 198.168.0.1 .\n: ========== EEMI Code: CGEN1009 ==========\nMessage: Unable to perform the requested action because the device management endpoint authentication over WSMAN, REDFISH failed. \nRecommended actions: Make sure the credentials associated with the device management endpoint are valid and retry the operation. \n=======================================\nTask Failed. Completed With Errors."}, "LastRun": "2023-06-07 09:33:07.161", "LastRunStatus": {"Id": 2070, "Name": "Failed"}, "NextRun": null, "Params": [], "Schedule": "startnow", "StartTime": null, "State": "Enabled", "Targets": [], "UpdatedBy": "admin", "UserGenerated": true, "Visible": true}]}

msg

строка

Общий статус операции с фактами задач.

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

Пример: "Successfully fetched the job info"

Авторы

Jagadeesh N V (@jagadeeshnv)
Abhishek Sinha (@Abhishek-Dell)

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

© 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_job_info_module.html