dellemc.openmanage.idrac_lifecycle_controller_jobs – Delete the Lifecycle Controller Jobs

Note

This plugin is part of the dellemc.openmanage collection (version 3.6.0).

To install it use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.idrac_lifecycle_controller_jobs.

New in version 2.1.0: of dellemc.openmanage

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

  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
idrac_ip
string / required
iDRAC IP Address.
idrac_password
string / required
iDRAC user password.

aliases: idrac_pwd
idrac_port
integer
Default:
443
iDRAC port.
idrac_user
string / required
iDRAC username.
job_id
string
Job ID of the specific job to be deleted.
All the jobs in the job queue are deleted if this option is not specified.

Notes

Note

  • Run this module from a system that has direct access to DellEMC iDRAC.

  • 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"
       idrac_port: 443

- 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"
       idrac_port: 443
       job_id: "JID_801841929470"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
error_info
dictionary
on HTTP error
Details of the HTTP Error.

Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to process the request because an error occurred.', 'MessageArgs': [], 'MessageId': 'GEN1234', 'RelatedProperties': [], 'Resolution': 'Retry the operation. If the issue persists, contact your system administrator.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg
string
always
Status of the delete operation.

Sample:
Successfully deleted the job.
status
dictionary
success
Details of the delete operation.

Sample:
{'Message': 'The specified job was deleted', 'MessageID': 'SUP020', 'ReturnValue': '0'}


Authors

  • Felix Stephen (@felixs88)

  • Anooja Vardhineni (@anooja-vardhineni)