dellemc.openmanage.redfish_firmware_rollback module – To perform a component firmware rollback using component name
Note
This module is part of the dellemc.openmanage collection (version 9.8.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.redfish_firmware_rollback.
New in dellemc.openmanage 8.2.0
Synopsis
This module allows to rollback the firmware of different server components.
Depending on the component, the firmware update is applied after an automatic or manual reboot.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
IP address of the target out-of-band controller. For example- <ipaddress>:<port>. |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The name or regular expression of the component to match and is case-sensitive. |
|
Password of the target out-of-band controller. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
Reboot the server to apply the previous version of the firmware.
When reboot is Choices:
|
|
Wait time in seconds. The module waits for this duration till the server reboots. Default: |
|
The socket level timeout in seconds. Default: |
|
Username of the target out-of-band controller. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Redfish APIs.
For components that do not require a reboot, firmware rollback proceeds irrespective of reboot is
trueorfalse.This module supports IPv4 and IPv6 addresses.
This module supports
check_mode.
Examples
---
- name: Rollback a BIOS component firmware
dellemc.openmanage.redfish_firmware_rollback:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
name: "BIOS"
- name: Rollback all NIC cards with a name starting from 'Broadcom Gigabit'.
dellemc.openmanage.redfish_firmware_rollback:
baseuri: "192.168.0.1:443"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
name: "Broadcom Gigabit Ethernet.*"
- name: Rollback all the component firmware except BIOS component.
dellemc.openmanage.redfish_firmware_rollback:
baseuri: "192.168.0.1:443"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
name: "(?!BIOS).*"
- name: Rollback all the available firmware component.
dellemc.openmanage.redfish_firmware_rollback:
baseuri: "192.168.0.1:443"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
name: ".*"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP error. Returned: on http error Sample: |
|
Overall firmware rollback status. Returned: always Sample: |
|
Firmware rollback job and progress details from the iDRAC. Returned: success Sample: |