dellemc.openmanage.ome_job_info module – Get job details for a given job ID or an entire job queue on OpenMange Enterprise
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_job_info
.
New in dellemc.openmanage 2.0.0
Synopsis
This module retrieves job details for a given job ID or an entire job queue on OpenMange Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Fetches the execution history of the job. fetch_execution_history is only applicable when valid job_id is given. When When Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Unique ID of the job. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Options for pagination of the output. |
|
Filter records by the values supported. |
|
Number of records to skip. Default value is 0. |
|
Number of records to return. Default value is 100. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the OpenManage Enterprise jobs. Returned: success Sample: |
|
Overall status of the job facts operation. Returned: always Sample: |