dellemc.openmanage.idrac_bios (2.1.5) — module

Configure the BIOS attributes.

| "added in version" 2.9.11 of dellemc.openmanage"

Authors: Felix Stephen (@felixs88), Anooja Vardhineni (@anooja-vardhineni)

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5


Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows to configure the BIOS attributes.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- 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"
    attributes:
      BootMode : "Bios"
      OneTimeBootMode: "Enabled"
      BootSeqRetry: "Enabled"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure PXE generic attributes
  dellemc.openmanage.idrac_bios:
    idrac_ip:   "192.168.0.1"
    idrac_user: "user_name"
    idrac_password:  "user_password"
    attributes:
      PxeDev1EnDis: "Enabled"
      PxeDev1Protocol: "IPV4"
      PxeDev1VlanEnDis: "Enabled"
      PxeDev1VlanId: 1
      PxeDev1Interface: "NIC.Embedded.1-1-1"
      PxeDev1VlanPriority: 2
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure boot sources
  dellemc.openmanage.idrac_bios:
    idrac_ip:   "192.168.0.1"
    idrac_user: "user_name"
    idrac_password:  "user_password"
    boot_sources:
      - Name : "NIC.Integrated.1-2-3"
        Enabled : true
        Index : 0
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure multiple boot sources
  dellemc.openmanage.idrac_bios:
    idrac_ip:   "192.168.0.1"
    idrac_user: "user_name"
    idrac_password:  "user_password"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure boot sources - Enabling
  dellemc.openmanage.idrac_bios:
    idrac_ip:   "192.168.0.1"
    idrac_user: "user_name"
    idrac_password:  "user_password"
    boot_sources:
      - Name : "NIC.Integrated.1-1-1"
        Enabled : true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure boot sources - Index
  dellemc.openmanage.idrac_bios:
    idrac_ip:   "192.168.0.1"
    idrac_user: "user_name"
    idrac_password:  "user_password"
    boot_sources:
      - Name : "NIC.Integrated.1-1-1"
        Index : 0

Inputs

    
idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

boot_mode:
    choices:
    - Bios
    - Uefi
    description:
    - (deprecated)Sets boot mode to BIOS or UEFI.
    - This option is deprecated, and will be removed in later version. Use I(attributes)
      for configuring the BIOS attributes.
    - I(boot_mode) is mutually exclusive with I(boot_sources).
    required: false
    type: str

nvme_mode:
    choices:
    - NonRaid
    - Raid
    description:
    - (deprecated)Configures the NVME mode in the iDRAC 9 based PowerEdge Servers.
    - This option is deprecated, and will be removed in later version. Use I(attributes)
      for configuring the BIOS attributes.
    - I(nvme_mode) is mutually exclusive with I(boot_sources).
    required: false
    type: str

share_mnt:
    description: Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for network shares.
    required: false
    type: str

attributes:
    description:
    - Dictionary of BIOS attributes and value pair. Attributes should be part of the Redfish
      Dell BIOS Attribute Registry. Use U(https://I(idrac_ip)/redfish/v1/Systems/System.Embedded.1/Bios)
      to view the Redfish URI.
    - If deprecated options are provided and the same is repeated in I(attributes) then
      values in I(attributes) will take precedence.
    - I(attributes) is mutually exclusive with I(boot_sources).
    required: false
    type: dict

idrac_port:
    default: 443
    description: iDRAC port.
    required: false
    type: int

idrac_user:
    description: iDRAC username.
    required: true
    type: str

share_name:
    description: Network share or a local path.
    required: false
    type: str

share_user:
    description: 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.
    required: false
    type: str

boot_sources:
    description:
    - List of boot devices to set the boot sources settings.
    - I(boot_sources) is mutually exclusive with I(attributes), I(boot_sequence), I(onetime_boot_mode),
      I(secure_boot_mode), I(nvme_mode), I(boot_mode).
    elements: str
    required: false
    type: list

boot_sequence:
    description:
    - (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 I(attributes)
      for configuring the BIOS attributes.
    - I(boot_sequence) is mutually exclusive with I(boot_sources).
    required: false
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description: iDRAC user password.
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description: Network share user password. This option is mandatory for CIFS share.
    required: false
    type: str

secure_boot_mode:
    choices:
    - AuditMode
    - DeployedMode
    - SetupMode
    - UserMode
    description:
    - (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 I(attributes)
      for configuring the BIOS attributes.
    - I(secure_boot_mode) is mutually exclusive with I(boot_sources).
    required: false
    type: str

onetime_boot_mode:
    choices:
    - Disabled
    - OneTimeBootSeq
    - OneTimeCustomBootSeqStr
    - OneTimeCustomHddSeqStr
    - OneTimeCustomUefiBootSeqStr
    - OneTimeHddSeq
    - OneTimeUefiBootSeq
    description:
    - (deprecated)Configures the one time boot mode setting.
    - This option is deprecated, and will be removed in later version. Use I(attributes)
      for configuring the BIOS attributes.
    - I(onetime_boot_mode) is mutually exclusive with I(boot_sources).
    required: false
    type: str