W3cubDocs

/Ansible 2.11

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.0.0).

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 Choices/Defaults Comments
hostname
string / required
Target IP address or hostname.
job_id
integer
Unique ID of the job.
password
string / required
Target user password.
port
integer
Default:
443
Target HTTPS port.
system_query_options
dictionary
Options for pagination of the output.
filter
string
Filter records by the values supported.
skip
integer
Number of records to skip. Default value is 0.
top
integer
Number of records to return. Default value is 100.
username
string / required
Target 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 Returned Description
job_info
dictionary
success
Details of the OpenManage Enterprise jobs.

Sample:
{'value': [{'Builtin': False, 'CreatedBy': 'system', 'Editable': True, 'EndTime': None, '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': None, 'Params': [], 'Schedule': '', 'StartTime': None, 'State': 'Enabled', 'Targets': [{'Data': "''", 'Id': 123123, 'JobId': 12345, 'TargetType': {'Id': 1000, 'Name': 'DEVICE'}}], 'UpdatedBy': None, 'Visible': True}]}
msg
string
always
Overall status of the job facts operation.

Sample:
Successfully fetched the job info


Authors

  • Jagadeesh N V(@jagadeeshnv)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_job_info_module.html