.. _idrac_firmware_module:


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

.. contents::
   :local:
   :depth: 1


Synopsis
--------

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
------------
The below requirements are needed on the host that executes this module.

- omsdk
- python >= 2.7.5



Parameters
----------

  share_name (True, str, None)
    Network share path of update repository. CIFS, NFS, HTTP, HTTPS and FTP share types are supported.


  share_user (optional, str, None)
    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.


  share_password (optional, str, None)
    Network share user password. This option is mandatory for CIFS Network Share.


  share_mnt (optional, str, None)
    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.


  job_wait (optional, bool, True)
    Whether to wait for job completion or not.


  catalog_file_name (optional, str, Catalog.xml)
    Catalog file name relative to the *share_name*.


  ignore_cert_warning (optional, bool, True)
    Specifies if certificate warnings are ignored when HTTPS share is used. If ``True`` option is set, then the certificate warnings are ignored.


  apply_update (optional, bool, True)
    If *apply_update* is set to ``True``, then the packages are applied.

    If *apply_update* is set to ``False``, no updates are applied, and a catalog report of packages is generated and returned.


  reboot (optional, bool, False)
    Provides the option to apply the update packages immediately or in the next reboot.

    If *reboot* is set to ``True``,  then the packages  are applied immediately.

    If *reboot* is set to ``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).


  idrac_ip (True, str, None)
    iDRAC IP Address.


  idrac_user (True, str, None)
    iDRAC username.


  idrac_password (True, str, None)
    iDRAC user password.


  idrac_port (optional, int, 443)
    iDRAC port.





Notes
-----

.. note::
   - Run this module from a system that has direct access to DellEMC iDRAC.
   - Module will report success based on the iDRAC firmware update parent job status if there are no individual component jobs present.
   - For server with iDRAC firmware 5.00.00.00 and later, if the repository contains unsupported packages, then the module will return success with a proper message.
   - This module supports ``check_mode``.




Examples
--------

.. code-block:: yaml+jinja

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

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

    - 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

    - 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

    - 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



Return Values
-------------

msg (always, str, Successfully updated the firmware.)
  Overall firmware update status.


update_status (success, dict, {'InstanceID': 'JID_XXXXXXXXXXXX', 'JobState': 'Completed', 'Message': 'Job completed successfully.', 'MessageId': 'REDXXX', 'Name': 'Repository Update', 'JobStartTime': 'NA', 'Status': 'Success'})
  Firmware Update job and progress details from the iDRAC.





Status
------





Authors
~~~~~~~

- Rajeev Arakkal (@rajeevarakkal)
- Felix Stephen (@felixs88)