dellemc.openmanage.ome_firmware module – Update firmware on PowerEdge devices and its components through OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.9.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.ome_firmware.
New in dellemc.openmanage 2.0.0
Synopsis
This module updates the firmware of PowerEdge devices and all its components through OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
Enter the baseline name to update the firmware of all devices or list of devices that are not complaint. This option is mutually exclusive with dup_file and device_group_names. |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
List of components to be updated. If not provided, all components applicable are considered. This option is case sensitive. This is applicable to device_service_tag, device_id, and baseline_name. Default: |
|
Enter the name of the device group that contains the devices on which firmware needs to be updated. This option is mutually exclusive with device_id and device_service_tag. |
|
List of ids of the targeted device. Either device_id or device_service_tag can be used individually or together. This option is mutually exclusive with device_group_names and devices. |
|
List of service tags of the targeted devices. Either device_id or device_service_tag can be used individually or together. This option is mutually exclusive with device_group_names and devices. |
|
This option allows to select components on each device for firmware update. This option is mutually exclusive with dup_file, device_group_names, device_id, and device_service_tag. |
|
The target components to be updated. If not specified, all applicable device components are considered. Default: |
|
The id of the target device to be updated. This option is mutually exclusive with service_tag. |
|
The service tag of the target device to be updated. This option is mutually exclusive with id. |
|
The path of the Dell Update Package (DUP) file that contains the firmware or drivers required to update the target system device or individual device components. This is mutually exclusive with baseline_name, components, and devices. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
This option provides the choices to reboot the server immediately after the firmware update. This is applicable when schedule is
Choices:
|
|
Select the schedule for the firmware update. if if Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_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 OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode.
Examples
---
- name: Update firmware from DUP file using device ids
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_id:
- 11111
- 22222
dup_file: "/path/Chassis-System-Management_Firmware_6N9WN_WN64_1.00.01_A00.EXE"
- name: Update firmware from a DUP file using a device service tags
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_service_tag:
- KLBR111
- KLBR222
dup_file: "/path/Network_Firmware_NTRW0_WN64_14.07.07_A00-00_01.EXE"
- name: Update firmware from a DUP file using a device group names
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_group_names:
- servers
dup_file: "/path/BIOS_87V69_WN64_2.4.7.EXE"
- name: Update firmware using baseline name
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
- name: Stage firmware for the next reboot using baseline name
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
schedule: StageForNextReboot
- name: "Update firmware using baseline name and components."
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
components:
- BIOS
- name: Update firmware of device components from a DUP file using a device ids in a baseline
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
device_id:
- 11111
- 22222
components:
- iDRAC with Lifecycle Controller
- name: Update firmware of device components from a baseline using a device service tags under a baseline
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
device_service_tag:
- KLBR111
- KLBR222
components:
- IOM-SAS
- name: Update firmware using baseline name with a device id and required components
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
devices:
- id: 12345
components:
- Lifecycle Controller
- id: 12346
components:
- Enterprise UEFI Diagnostics
- BIOS
- name: "Update firmware using baseline name with a device service tag and required components."
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
devices:
- service_tag: ABCDE12
components:
- PERC H740P Adapter
- BIOS
- service_tag: GHIJK34
components:
- OS Drivers Pack
- name: "Update firmware using baseline name with a device service tag or device id and required components."
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
devices:
- service_tag: ABCDE12
components:
- BOSS-S1 Adapter
- PowerEdge Server BIOS
- id: 12345
components:
- iDRAC with Lifecycle Controller
- name: "Update firmware using baseline name and components and perform Powercycle."
dellemc.openmanage.ome_firmware:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: baseline_devices
components:
- BIOS
reboot_type: PowerCycle
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 update status. Returned: always Sample: |
|
The firmware update job and progress details from the OME. Returned: success Sample: |