community.general.idrac_firmware (2.5.9) — module

Firmware update from a repository on a network share (CIFS, NFS).

Authors: Rajeev Arakkal (@rajeevarakkal)

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9


Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

Update the Firmware by connecting to a network share (either CIFS or NFS) that contains a catalog of available updates.

Network share should contain a valid repository of Update Packages (DUPs) and a catalog file describing the DUPs.

All applicable updates contained in the repository are applied to the system.

This feature is available only with iDRAC Enterprise License.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Update firmware from repository on a Network Share
  community.general.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "192.168.0.0:/share"
       share_user: "share_user_name"
       share_password: "share_user_pwd"
       share_mnt: "/mnt/share"
       reboot: True
       job_wait: True
       catalog_file_name: "Catalog.xml"

Inputs

    
reboot:
    default: false
    description: Whether to reboots after applying the updates or not.
    type: bool

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

job_wait:
    default: true
    description: Whether to wait for job completion or not.
    type: bool

share_mnt:
    description: Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for Network Share.
    required: true
    type: str

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

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

share_name:
    description: CIFS or NFS Network share.
    required: true
    type: str

share_user:
    description: Network share user in the format 'user@domain' or 'domain\\user' if user
      is part of a domain else 'user'. This option is mandatory for CIFS Network Share.
    type: str

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

share_password:
    aliases:
    - share_pwd
    description: Network share user password. This option is mandatory for CIFS Network
      Share.
    type: str

catalog_file_name:
    default: Catalog.xml
    description: Catalog file name relative to the I(share_name).
    required: false
    type: str

Outputs

msg:
  description: Over all firmware update status.
  returned: always
  sample: Successfully updated the firmware.
  type: str
update_status:
  description: Firmware Update job and progress details from the iDRAC.
  returned: success
  sample:
    InstanceID: JID_XXXXXXXXXXXX
    JobStartTime: NA
    JobState: Completed
    Message: Job completed successfully.
    MessageId: REDXXX
    Name: Repository Update
    Status: Success
  type: dict