dellemc.openmanage.idrac_bios module – Modify and clear BIOS attributes, reset BIOS settings, and configure boot sources
Note
This module is part of the dellemc.openmanage collection (version 11.0.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.idrac_bios.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to modify the BIOS attributes. Also clears pending BIOS attributes and resets BIOS to default settings.
Boot sources can be enabled or disabled. Boot sequence can be configured.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
Apply time of the attributes. This is applicable only to attributes.
Choices:
|
|
Dictionary of BIOS attributes and value pair. Attributes should be part of the Redfish Dell BIOS Attribute Registry. Use https://I(idrac_ip/redfish/v1/Systems/System.Embedded.1/Bios) to view the Redfish URI. This is mutually exclusive with clear_pending and reset_bios. |
|
Options to enable or disable the boot sources. This is mutually exclusive with attributes, clear_pending, and reset_bios. |
|
Enable or disable the boot device. Choices:
|
|
Boot index of the device. |
|
FQDD of the boot device. |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
SHA-256 fingerprint of the expected TLS certificate (hex digest, with or without colons). When supplied together with |
|
Allows the user to clear all pending BIOS attributes changes.
This operation will not create any job.
This is mutually exclusive with attributes and reset_bios. Choices:
|
|
If Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
Provides the option to wait for job completion. This is applicable for attributes when apply_time is Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
Option to schedule the maintenance window. This is required when apply_time is |
|
The duration in seconds for the maintenance window. |
|
The start time for the maintenance window to be scheduled. The format is YYYY-MM-DDThh:mm:ss<offset> <offset> is the time offset from UTC that the current timezone set in iDRAC in the format: +05:30 for IST. |
|
Resets the BIOS to default settings and triggers a reboot of host system. This is applied to the host after the restart. This operation will not create any job.
This is mutually exclusive with attributes, clear_pending, and boot_sources. When Choices:
|
|
This is applicable for reset_bios, and attributes when apply_time is Choices:
|
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
Notes
Note
This module requires ‘Administrator’ privilege for idrac_user.
Run this module from a system that has direct access to Dell iDRAC.
This module supports both IPv4 and IPv6 address for idrac_ip.
This module supports
check_mode.
Examples
---
- name: Configure generic attributes of the BIOS
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
attributes:
BootMode: "Bios"
OneTimeBootMode: "Enabled"
BootSeqRetry: "Enabled"
- name: Configure PXE generic attributes
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
attributes:
PxeDev1EnDis: "Enabled"
PxeDev1Protocol: "IPV4"
PxeDev1VlanEnDis: "Enabled"
PxeDev1VlanId: 1
PxeDev1Interface: "NIC.Embedded.1-1-1"
PxeDev1VlanPriority: 2
- name: Configure BIOS attributes at Maintenance window
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
apply_time: AtMaintenanceWindowStart
maintenance_window:
start_time: "2022-09-30T05:15:40-05:00"
duration: 600
attributes:
BootMode: "Bios"
OneTimeBootMode: "Enabled"
BootSeqRetry: "Enabled"
- name: Clear pending BIOS attributes
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
clear_pending: true
- name: Reset BIOS attributes to default settings.
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
validate_certs: false
reset_bios: true
- name: Configure Boot Sources
dellemc.openmanage.idrac_bios:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_sources:
- Name: "NIC.Integrated.1-1-1"
Enabled: true
Index: 1
- Name: "NIC.Integrated.1-1-2"
Enabled: true
Index: 0
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: |
|
Dict of invalid attributes provided. Returned: on invalid attributes or values. Sample: |
|
Status of the action performed on bios. Returned: success Sample: |
|
Overall status of the bios operation. Returned: success Sample: |