Try SpotterConfigure the boot order settings.
| "added in version" 6.1.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to configure the boot order settings.
---
- name: Configure the system boot options settings.
dellemc.openmanage.idrac_boot:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_options:
- display_name: Hard drive C
enabled: true
- boot_option_reference: NIC.PxeDevice.2-1
enabled: true
- name: Configure the boot order settings.
dellemc.openmanage.idrac_boot:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_order:
- Boot0001
- Boot0002
- Boot0004
- Boot0003
- name: Configure the boot source override mode.
dellemc.openmanage.idrac_boot:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_source_override_mode: legacy
boot_source_override_target: cd
boot_source_override_enabled: once
- name: Configure the UEFI target settings.
dellemc.openmanage.idrac_boot:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_source_override_mode: uefi
boot_source_override_target: uefi_target
uefi_target_boot_source_override: "VenHw(3A191845-5F86-4E78-8FCE-C4CFF59F9DAA)"
- name: Configure the boot source override mode as pxe.
dellemc.openmanage.idrac_boot:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
boot_source_override_mode: legacy
boot_source_override_target: pxe
boot_source_override_enabled: continuous
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
idrac_ip:
description: iDRAC IP Address.
required: true
type: str
job_wait:
default: true
description:
- Provides the option to wait for job completion.
- This is applicable when I(reset_type) is C(force_reset) or C(graceful_reset).
type: bool
boot_order:
description:
- This option allows to set the boot devices in the required boot order sequences.
- This is mutually exclusive with I(boot_options).
elements: str
type: list
idrac_port:
default: 443
description: iDRAC port.
type: int
idrac_user:
description:
- iDRAC username.
- If the username is not provided, then the environment variable C(IDRAC_USERNAME)
is used.
- 'Example: export IDRAC_USERNAME=username'
required: true
type: str
reset_type:
choices:
- graceful_restart
- force_restart
- none
default: graceful_restart
description:
- C(none) Host system is not rebooted and I(job_wait) is not applicable.
- C(force_restart) Forcefully reboot the Host system.
- C(graceful_restart) Gracefully reboot the Host system.
type: str
resource_id:
description: Redfish ID of the resource.
type: str
boot_options:
description:
- Options to enable or disable the boot devices.
- This is mutually exclusive with I(boot_order), I(boot_source_override_mode), I(boot_source_override_enabled)
I(boot_source_override_target), and I(uefi_target_boot_source_override).
elements: dict
suboptions:
boot_option_reference:
description:
- FQDD of the boot device.
- This is mutually exclusive with I(display_name).
type: str
display_name:
description:
- Display name of the boot source device.
- This is mutually exclusive with I(boot_option_reference).
type: str
enabled:
description: Enable or disable the boot device.
required: true
type: bool
type: list
idrac_password:
aliases:
- idrac_pwd
description:
- iDRAC user password.
- If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
is used.
- 'Example: export IDRAC_PASSWORD=password'
required: true
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
job_wait_timeout:
default: 900
description:
- The maximum wait time of I(job_wait) in seconds. The job is tracked only for this
duration.
- This option is applicable when I(job_wait) is C(true).
type: int
boot_source_override_mode:
choices:
- legacy
- uefi
description:
- The BIOS boot mode (either Legacy or UEFI) to be used when I(boot_source_override_target)
boot source is booted from.
- C(legacy) The system boot in non-UEFI(Legacy) boot mode to the I(boot_source_override_target).
- C(uefi) The system boot in UEFI boot mode to the I(boot_source_override_target).
- This is mutually exclusive with I(boot_options).
type: str
boot_source_override_target:
choices:
- uefi_http
- sd_card
- uefi_target
- utilities
- bios_setup
- hdd
- cd
- floppy
- pxe
- none
description:
- The boot source override target device to use during the next boot instead of the
normal boot device.
- C(pxe) performs PXE boot from the primary NIC.
- C(floppy), C(cd), C(hdd), C(sd_card) performs boot from their devices respectively.
- C(bios_setup) performs boot into the native BIOS setup.
- C(utilities) performs boot from the local utilities.
- C(uefi_target) performs boot from the UEFI device path found in I(uefi_target_boot_source_override).
- If the I(boot_source_override_target) is set to a value other than C(none) then
the I(boot_source_override_enabled) is automatically set to C(once).
- Changes to this options do not alter the BIOS persistent boot order configuration.
- This is mutually exclusive with I(boot_options).
type: str
boot_source_override_enabled:
choices:
- continuous
- disabled
- once
description:
- The state of the Boot Source Override feature.
- C(disabled) The system boots normally.
- C(once) The system boots (one time) to the I(boot_source_override_target).
- C(continuous) The system boots to the target specified in the I(boot_source_override_target)
until this property is set to Disabled.
- "The state is set to C(once) for the one-time boot override and C(continuous) for\
\ the remain-active-until\u2014canceled override. If the state is set C(once) or\
\ C(continuous), the value is reset to C(disabled) after the I(boot_source_override_target)\
\ actions have completed successfully."
- Changes to this options do not alter the BIOS persistent boot order configuration.
- This is mutually exclusive with I(boot_options).
type: str
uefi_target_boot_source_override:
description:
- The UEFI device path of the device from which to boot when I(boot_source_override_target)
is C(uefi_target).
- I(boot_source_override_enabled) cannot be set to c(continuous) if I(boot_source_override_target)
set to C(uefi_target) because this settings is defined in UEFI as a one-time-boot
setting.
- Changes to this options do not alter the BIOS persistent boot order configuration.
- This is required if I(boot_source_override_target) is C(uefi_target).
- This is mutually exclusive with I(boot_options).
type: str
boot:
description: Configured boot settings details.
returned: success
sample:
BootOptions:
Description: Collection of BootOptions
Members:
- BootOptionEnabled: false
BootOptionReference: HardDisk.List.1-1
Description: Current settings of the Legacy Boot option
DisplayName: 'Hard drive C:'
Id: HardDisk.List.1-1
Name: Legacy Boot option
UefiDevicePath: VenHw(D6C0639F-C705-4EB9-AA4F-5802D8823DE6)
Name: Boot Options Collection
BootOrder:
- HardDisk.List.1-1
BootSourceOverrideEnabled: Disabled
BootSourceOverrideMode: Legacy
BootSourceOverrideTarget: None
UefiTargetBootSourceOverride: null
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
job:
description: Configured job details.
returned: success
sample:
ActualRunningStartTime: '2019-06-19T00:57:24'
ActualRunningStopTime: '2019-06-19T01:00:27'
CompletionTime: '2019-06-19T01:00:27'
Description: Job Instance
EndTime: TIME_NA
Id: JID_609237056489
JobState: Completed
JobType: BIOSConfiguration
Message: Job completed successfully.
MessageArgs: []
MessageId: PR19
Name: 'Configure: BIOS.Setup.1-1'
PercentComplete: 100
StartTime: '2019-06-19T00:55:05'
TargetSettingsURI: null
type: dict
msg:
description: Successfully updated the boot settings.
returned: success
sample: Successfully updated the boot settings.
type: str