dellemc.openmanage.ome_job_info – Get job details for a given job ID or an entire job queue on OpenMange Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.ome_job_info
.
New in version 2.0.0: of dellemc.openmanage
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 >= 2.7.5
Parameters
Parameter |
Comments |
---|---|
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: 443 |
|
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. |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
Notes
Note
Run this module from a system that has direct access to DellEMC 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"
- name: Get job details for id
dellemc.openmanage.ome_job_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
job_id: 12345
- name: Get filtered job details
dellemc.openmanage.ome_job_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
system_query_options:
top: 2
skip: 1
filter: "JobType/Id eq 8"
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: {“value”: [{“Builtin”: false, “CreatedBy”: “system”, “Editable”: true, “EndTime”: null, “Id”: 12345, “JobDescription”: “Refresh Inventory for Device”, “JobName”: “Refresh Inventory for Device”, “JobStatus”: {“Id”: 2080, “Name”: “New”}, “JobType”: {“Id”: 8, “Internal”: false, “Name”: “Inventory_Task”}, “LastRun”: “2000-01-29 10:51:34.776”, “LastRunStatus”: {“Id”: 2060, “Name”: “Completed”}, “NextRun”: null, “Params”: [], “Schedule”: “”, “StartTime”: null, “State”: “Enabled”, “Targets”: [{“Data”: “\u0027\u0027”, “Id”: 123123, “JobId”: 12345, “TargetType”: {“Id”: 1000, “Name”: “DEVICE”}}], “UpdatedBy”: null, “Visible”: true}]} |
|
Overall status of the job facts operation. Returned: always Sample: “Successfully fetched the job info” |
Authors
Jagadeesh N V(@jagadeeshnv)