dellemc.openmanage.idrac_boot role – Configure the boot order settings

Note

This role 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.

To use it in a playbook, specify: dellemc.openmanage.idrac_boot.

Entry point main – Configure the boot order settings

New in dellemc.openmanage 8.0.0

Synopsis

  • This role allows to configure the boot order settings.

Parameters

Parameter

Comments

boot_options

list / elements=dictionary

Options to enable or disable the boot devices.

This is mutually exclusive with boot_order, boot_source_override_mode, boot_source_override_enabled, boot_source_override_target, and uefi_target_boot_source_override.

boot_option_reference

string

FQDD of the boot device.

This is mutually exclusive with display_name.

display_name

string

Display name of the boot source device.

This is mutually exclusive with boot_option_reference.

enabled

boolean / required

Enable or disable the boot device.

Choices:

  • false

  • true

boot_order

list / elements=string

This option allows to set the boot devices in the required boot order sequence.

This is mutually exclusive with boot_options.

boot_source_override_enabled

string

The state of the Boot Source Override feature.

disabled, the system boots normally.

once, the system boots 1 time to the boot_source_override_target.

continuous, the system boots to the target specified in the boot_source_override_target until this property is set to Disabled.

The state is set to once for the 1 time boot override and continuous for the remain-active-until—cancelled override. If the state is set once or continuous, the value is reset to disabled after the boot_source_override_target actions have completed successfully.

Changes to these options do not alter the BIOS persistent boot order configuration.

This is mutually exclusive with boot_options.

Choices:

  • "continuous"

  • "disabled"

  • "once"

boot_source_override_mode

string

The BIOS boot mode (either Legacy or UEFI) to be used when boot_source_override_target boot source is booted.

legacy The system boot in non-UEFI(Legacy) boot mode to the boot_source_override_target.

uefi The system boot in UEFI boot mode to the boot_source_override_target.

This is mutually exclusive with boot_options.

Choices:

  • "legacy"

  • "uefi"

boot_source_override_target

string

The boot source override targets the device to use during the next boot instead of the normal boot device.

pxe performs PXE boot from the primary NIC.

floppy, cd, hdd, and sd_card performs boot from their devices respectively.

bios_setup performs boot into the native BIOS setup.

uefi_http performs boot from a URI over HTTP.

utilities performs boot from the local utilities.

uefi_target performs boot from the UEFI device path found in uefi_target_boot_source_override.

none if the boot_source_override_target is set to a value other than none then the boot_source_override_enabled is automatically set to once.

Changes to these options do not alter the BIOS persistent boot order configuration.

This is mutually exclusive with boot_options.

Choices:

  • "uefi_http"

  • "sd_card"

  • "uefi_target"

  • "utilities"

  • "bios_setup"

  • "hdd"

  • "cd"

  • "floppy"

  • "pxe"

  • "none"

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

iDRAC IP Address.

https_port

integer

iDRAC port.

Default: 443

https_timeout

integer

The socket level timeout in seconds.

Default: 30

job_wait

boolean

Provides the option to wait for job completion.

This is applicable when reset_type is force_reset or graceful_reset.

Choices:

  • false

  • true ← (default)

job_wait_timeout

integer

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 True.

Default: 900

password

string

iDRAC user password.

reset_type

string

none Host system is not rebooted and job_wait is not applicable.

force_restart Forcefully reboot the Host system.

graceful_restart Gracefully reboot the Host system.

Choices:

  • "graceful_restart" ← (default)

  • "force_restart"

  • "none"

resource_id

string

Redfish ID of the resource.

uefi_target_boot_source_override

string

The UEFI device path of the device from which to boot when boot_source_override_target is uefi_target.

If boot_source_override_target is set to uefi_target, then boot_source_override_enabled cannot be set to c(continuous) because this setting is defined in UEFI as a one-time-boot setting.

Changes to these options do not alter the BIOS persistent boot order configuration.

This is required if boot_source_override_target is uefi_target.

This is mutually exclusive with boot_options.

username

string

iDRAC username.

validate_certs

boolean

If False, the SSL certificates will not be validated.

Configure False only on personally controlled sites where self-signed certificates are used.

Choices:

  • false

  • true ← (default)