dellemc.openmanage.idrac_bios module – Configure the BIOS attributes
Note
This module is part of the dellemc.openmanage collection (version 5.5.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 configure the BIOS attributes.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.8.6
Parameters
Parameter |
Comments |
|---|---|
Dictionary of BIOS attributes and value pair. Attributes should be part of the Redfish Dell BIOS Attribute Registry. Use https://I%28idrac_ip/redfish/v1/Systems/System.Embedded.1/Bios) to view the Redfish URI. If deprecated options are provided and the same is repeated in attributes then values in attributes will take precedence. attributes is mutually exclusive with boot_sources. |
|
(deprecated)Sets boot mode to BIOS or UEFI. This option is deprecated, and will be removed in later version. Use attributes for configuring the BIOS attributes. boot_mode is mutually exclusive with boot_sources. Choices:
|
|
(deprecated)Allows to set the boot sequence in BIOS boot mode or Secure UEFI boot mode by rearranging the boot entries in Fully Qualified Device Descriptor (FQDD). TThis option is deprecated, and will be removed in later version. Use attributes for configuring the BIOS attributes. boot_sequence is mutually exclusive with boot_sources. |
|
List of boot devices to set the boot sources settings. boot_sources is mutually exclusive with attributes, boot_sequence, onetime_boot_mode, secure_boot_mode, nvme_mode, boot_mode. |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
(deprecated)Configures the NVME mode in the iDRAC 9 based PowerEdge Servers. This option is deprecated, and will be removed in later version. Use attributes for configuring the BIOS attributes. nvme_mode is mutually exclusive with boot_sources. Choices:
|
|
(deprecated)Configures the one time boot mode setting. This option is deprecated, and will be removed in later version. Use attributes for configuring the BIOS attributes. onetime_boot_mode is mutually exclusive with boot_sources. Choices:
|
|
(deprecated)Configures how the BIOS uses the Secure Boot Policy Objects in iDRAC 9 based PowerEdge Servers. This option is deprecated, and will be removed in later version. Use attributes for configuring the BIOS attributes. secure_boot_mode is mutually exclusive with boot_sources. Choices:
|
|
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares. |
|
Network share or a local path. |
|
Network share user password. This option is mandatory for CIFS share. |
|
Network share user name. Use the format ‘user@domain’ or ‘domain\user’ if user is part of a domain. This option is mandatory for CIFS share. |
|
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 DellEMC iDRAC.
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 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-2-3"
Enabled : true
Index : 0
- name: Configure multiple 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 : 0
- Name : "NIC.Integrated.2-2-2"
Enabled : true
Index : 1
- Name : "NIC.Integrated.3-3-3"
Enabled : true
Index : 2
- name: Configure boot sources - Enabling
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
- name: Configure boot sources - Index
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"
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: |
|
Configures the BIOS configuration attributes. Returned: success Sample: |