dellemc.openmanage.idrac_lifecycle_controller_jobs (2.1.5) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

Delete a Lifecycle Controller job using its job ID or delete all jobs.

Requirements

• omsdk
• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
job_id:
    description:
    - Job ID of the specific job to be deleted.
    - All the jobs in the job queue are deleted if this option is not specified.
    required: false
    type: str

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    required: false
    type: int

idrac_user:
    description: iDRAC username.
    required: true
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description: iDRAC user password.
    required: true
    type: str

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on 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.
  type: dict
msg:
  description: Status of the delete operation.
  returned: always
  sample: Successfully deleted the job.
  type: str
status:
  description: details of the delete operation.
  returned: success
  sample:
    Message: The specified job was deleted
    MessageID: SUP020
    ReturnValue: '0'
  type: dict