dellemc.openmanage.idrac_lifecycle_controller_jobs module – Delete the Lifecycle Controller Jobs
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.idrac_lifecycle_controller_jobs
.
New in dellemc.openmanage 2.1.0
Synopsis
Delete a Lifecycle Controller job using its job ID or delete all jobs.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
Job ID of the specific job to be deleted. All the jobs in the job queue are deleted if this option is not specified. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell iDRAC.
This module supports both IPv4 and IPv6 address for idrac_ip.
This module does not support
check_mode
.
Examples
---
- name: Delete Lifecycle Controller job queue
dellemc.openmanage.idrac_lifecycle_controller_jobs:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
- name: Delete Lifecycle Controller job using a job ID
dellemc.openmanage.idrac_lifecycle_controller_jobs:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
job_id: "JID_801841929470"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Status of the delete operation. Returned: always Sample: |
|
Details of the delete operation. Returned: success Sample: |