dellemc.openmanage.idrac_firmware (2.1.5) — module

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

| "added in version" 2.9.10 of dellemc.openmanage"

Authors: Rajeev Arakkal (@rajeevarakkal), Felix Stephen (@felixs88)

preview | supported by community

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

Update the Firmware by connecting to a network share (CIFS, NFS, HTTP, HTTPS, FTP) 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 NFS Share
  dellemc.openmanage.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "192.168.0.0:/share"
       reboot: True
       job_wait: True
       apply_update: True
       catalog_file_name: "Catalog.xml"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update firmware from repository on a CIFS Share
  dellemc.openmanage.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "full_cifs_path"
       share_user: "share_user"
       share_password: "share_password"
       reboot: True
       job_wait: True
       apply_update: True
       catalog_file_name: "Catalog.xml"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update firmware from repository on a HTTP
  dellemc.openmanage.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "http://downloads.dell.com"
       reboot: True
       job_wait: True
       apply_update: True
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update firmware from repository on a HTTPS
  dellemc.openmanage.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "https://downloads.dell.com"
       reboot: True
       job_wait: True
       apply_update: True
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update firmware from repository on a FTP
  dellemc.openmanage.idrac_firmware:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       share_name: "ftp://ftp.dell.com"
       reboot: True
       job_wait: True
       apply_update: True

Inputs

    
reboot:
    default: false
    description:
    - Provides the option to apply the update packages immediately or in the next reboot.
    - If I(reboot) is set to C(True),  then the packages  are applied immediately.
    - If I(reboot) is set to C(False), then the packages are staged and applied in the
      next reboot.
    - Packages that do not require a reboot are applied immediately irrespective of I
      (reboot).
    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 not applicable for HTTP, HTTPS, and FTP shares.
    required: false
    type: str

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

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

share_name:
    description: Network share path of update repository. CIFS, NFS, HTTP, HTTPS and FTP
      share types are supported.
    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

apply_update:
    default: true
    description:
    - If I(apply_update) is set to C(True), then the packages are applied.
    - If I(apply_update) is set to C(False), no updates are applied, and a catalog report
      of packages is generated and returned.
    required: false
    type: bool

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

ignore_cert_warning:
    default: true
    description: Specifies if certificate warnings are ignored when HTTPS share is used.
      If C(True) option is set, then the certificate warnings are ignored.
    required: false
    type: bool

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