Try SpotterGet job details for a given job ID or an entire job queue on OpenMange Enterprise
| "added in version" 2.0.0 of dellemc.openmanage"
Authors: Jagadeesh N V (@jagadeeshnv), Abhishek Sinha (@Abhishek-Dell)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module retrieves job details for a given job ID or an entire job queue on OpenMange Enterprise.
---
- 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
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
job_id:
description: Unique ID of the job.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
system_query_options:
description: Options for pagination of the output.
suboptions:
filter:
description: Filter records by the values supported.
type: str
skip:
description: Number of records to skip. Default value is 0.
type: int
top:
description: Number of records to return. Default value is 100.
type: int
type: dict
fetch_execution_history:
default: false
description:
- Fetches the execution history of the job.
- I(fetch_execution_history) is only applicable when valid I(job_id) is given.
- When C(true), fetches all the execution history details.
- When C(false), fetches only the job info and last execution details.
type: bool
job_info:
description: Details of the OpenManage Enterprise jobs.
returned: success
sample:
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 ==========\n\
Message: 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=======================================\n\
Task 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 ==========\n\
Message: 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=======================================\n\
Task 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 ==========\n\
Message: 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=======================================\n\
Task 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 ==========\n\
Message: 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=======================================\n\
Task 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 ==========\n\
Message: 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=======================================\n\
Task 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
type: dict
msg:
description: Overall status of the job facts operation.
returned: always
sample: Successfully fetched the job info
type: str