Boot Object
This object shall contain properties which describe boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration.
Behavior
Any changes in Boot properties require a host-reset to apply, so the patch to Boot Properties is supported in Future State URI only and not on the Systems/Self URI.
After User patches the new values for Boot in Systems/Self/SD, it will not be reflected in Systems/Self URI until the next reboot.
In the next boot, BIOS reads the values from this future settings URI and applies in in BIOS and patches the new data in Systems/Self URI.
Now the Future State URI namely Systems/Self/SD will have the same values as Systems/Self after the next reboot after the patch.
Name | Type | Read only | Description | ||
BootOptions | Object | True | A reference to the collection of the UEFI Boot Options associated with this Computer System. Note This property is populated by Host Interface as part of Inventory.(Extra Bios Support is needed. See | ||
| CertificateService | Object | True | A reference to the collection of the CertificateServices. | ||
BootNext | String | False | This property is the BootOptionReference of the Boot Option to perform a one time boot from when BootSourceOverride Target is UefiBootNext. Default it will be null value. User needs to patch this property and BIOS will read it in the next boot and apply provided AMI BIOS is used. Note This property is populated by Host Interface as part of Inventory.(Extra Bios Support is needed. See | ||
BootSourceOverrideTarget | String | False | The current boot source to be used at next boot instead of the norm boot device, if BootSourceOverrideEnabled is true. Default it will be null value.The allowable values for this property are specified in the following table:- | ||
Enum | Description | ||||
None | Boot from the normal boot device. | ||||
Pxe | Boot from the Pre-Boot Execution (PXE) environment. | ||||
Floppy | Boot from the floppy disk drive. | ||||
Cd | Boot from the CD/DVD disc. | ||||
Usb | Boot from a USB device as specified by the system BIOS | ||||
Hdd | Boot from a hard drive | ||||
BiosSetup | Boot to the BIOS Setup Utility. | ||||
Utilities | Boot the Manufacturer’s Utilities Programs(s). Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS boot. | ||||
Diags | Boot the Manufacturer’s Diagnostics program. | ||||
UefiShell | Boot to the UEFI Shell. Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. | ||||
UefiTarget | Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property. Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. | ||||
SDCard | Boot from an SD Card. Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. | ||||
UefiHttp | Boot from a UEFI HTTP network location. Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. | ||||
RemoteDrive | Boot from a remote drive (e.g. iSCSI). Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. | ||||
UefiBootNext | Boot to the UEFI Device specified in the BootNext property. Note This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOSBoot. | ||||
BootSourceOverrideEnabled | String | False | The value of this property shall be Once if this is a one time boot override and Continuous if this selection should remain active until cancelled. If the property value is set to Once, the value will be reset back to Disabled after the BootSourceOverrideTarget actions have been completed. Default it will be null value | ||
Enum | Description | ||||
Disabled | The system will boot normally. | ||||
Once | On its next boot cycle, the system will boot (one time) to the Boot Source OverrideTarget. The value of BootSourceOverrideEnabled is then reset back to Disabled. | ||||
Continuous | The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled | ||||
UefiTargetBootSourceOverride | String | False | The value of this property shall be the UEFI device path of the override boot target. The valid values for this property are specified through the Redfish.AllowableValues annotation. BootSourceOverrideEnabled = Continuous is not supported for UE Boot Source Override as this setting is defined in UEFI as a one time boot only. Default it will be null value. | ||
AliasBootOrder | Array | True | Ordered array of boot source aliases representing the persistent Boo Order associated with this computer system. Note Platform specific porting needed. | ||
BootOrder | Array | False | Ordered array of BootOptionReference strings representing the persistent Boot Order associated with this computer system. | ||
BootOrderPropertySelection | String | True | The value of this property shall indicate which boot order property the system uses when specifying the persistent boot order. | ||
BootSourceOverrideMode | String | False | The value of this property shall be Legacy for non-UEFI BIOS boot or UEFI for UEFI boot from boot source specified in BootSourceOverrideTarget property. | ||
Enum | Description | ||||
Legacy | The system will boot in non-UEFI boot mode to the Boot Source Override Target. | ||||
UEFI | The system will boot in UEFI boot mode to the Boot Source Override Target. | ||||
Additional Information
BootSourceOverrideTarget is set to a default value of "None" and can be changed only when the data is sent from BIOS (BIOS should support Redfish) or set by end-user using PATCH request (Enum values are selectively patchable with respect to Redfish support in BIOS).
This can also be populated by Host Interface, (Extra Bios Support is needed).
The Allowable values only shows the values that are supported by IPMI by default so that syncing with IPMI will work.
If it is detected that BIOS sent the AttributeRegistry file, then it is assumed that BIOS has support for using the Redfish boot options and the syncing with IPMI is disabled.
IPMI default support - None, Pxe, Floppy, Cd, Usb, Hdd, BiosSetup and Diags.
UefiTargetBootSourceOverride will not be displayed by default and can be changed only when the data is sent from BIOS (BIOS should support Redfish) or set by end-user using PATCH request. Until then it is acceptable to have it not displayed and the "SelectList" part of odata.context can be omitting it in order to be a valid response.
Patch request for Boot properties will be blocked when FixedBootOrder feature is enabled in BIOS, this is handled using an internal flag which will be populated from Bios.
This can also be populated by Host Interface (Extra Bios Support is needed).