Skip to main content

GET – BootOption Instance

Request

GET https://{{ip}}/ redfish/v1/Systems/Self/BootOptions/{{BootOptions_instance}}
Content-Type: application/json
  1. Displays the information about the BootOptions.

  2. In BMC, BootOptions Inventory will be populated via HostInterface communication with AMI BIOS.

Response

The response of the request will be in JSON format. The properties are mentioned in the following table.

Table 1. Boot Option Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

Actions

Object

True

The available actions for this Resource.

BootOptionEnabled

Boolean

False

An indication of whether the boot option is enabled. Default it will be null value

BootOptionReference

String

True

The unique boot option.

DisplayName

String

True

The user-readable display name of the boot option that appears in the boot order list in the user interface.

RelatedItem

Array

True

An array of one or more IDs for the Resources associated with this boot option.

RelatedItem@odata.count

Number

True

Number of RelatedItems

UefiDevicePath

String

True

The UEFI device path to access this UEFI Boot Option.

Alias

String

True

The alias of this boot source.

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 BIOS Boot.