iLO 4 REST API Data Model (HpServerBootSettings Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"HpServerBootSettings" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios/Boot

/rest/v1/Systems/{item}/Bios/Boot/Settings

See Resource Map for more details.

The schema definition of the server UEFI Boot Order.

"HpServerBootSettings" defines the following properties:

"AttributeRegistry"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format <schema>.<majorversion>.<minorversion>.<errataversion>.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"BootSources[]/BootString"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
User-readable string that describes the UEFI boot option.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"BootSources[]/CorrelatableID"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Contains any CorrelatableIDs that represent this boot option. The correlatableID values can be JSON Pointers or UEFI identifiers.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"BootSources[]/StructuredBootString"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Uniquely identifies this boot option within the server.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"BootSources[]/UEFIDevicePath"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"DesiredBootDevices[]/CorrelatableID"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Standardized text representation of the UEFI device path of the desired boot device, in UTF-8 format. For example 'PciRoot(0x0)/Pci(0x2,0x2)/Pci(0x0,0x0)'
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"CorrelatableID": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/CorrelatableID" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/Lun"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
The Logical Unit Number (LUN) of the desired boot device. This value must be a hexadecimal string with an even number of 2 to 16 characters, excluding the first two characters, 0x (for example, '0x01').
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"Lun": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/Lun" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/Wwn"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
The Fibre Channel World Wide Name (WWN) of the desired boot device. This value must be a hexadecimal string with an even number of 2 to 16 characters, excluding the first two characters, 0x (for example, '0x0001020304050607').
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"Wwn": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/Wwn" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/iScsiTargetName"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
The iSCSI node target name of the desired boot device. The value must be a string based on IETF RFC 3270, and can be up to 223 characters in length (for example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target').
JSON type:
String from 0 to 223 characters in length.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"iScsiTargetName": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/iScsiTargetName" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SettingsResult/definitions/SettingsResult/ETag"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
ETag of this resource after the settings have been applied.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SettingsResult/definitions/SettingsResult/Messages[]/Message"

This property is a member of HpServerBootSettings

Human-readable message.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/MessageID"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Key for this message, which is used to look up the message in a message registry. The key is in the format <registry>.<majorver>.<minorver>:<messagekey>.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/Resolution"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Instructions for resolving the issue that caused the error.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/Severity"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
This is the severity of the errors.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Operation"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Details about the results of applying the settings.
JSON type:
String containing one of the following supported values: "SettingsApply"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Time"

This property is a member of [HpServerBootSettings](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpServerBootSettings-Resource-Type)#hpserverbootsettings-resource-type)
Time at which the settings were applied.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
⚠️ **GitHub.com Fallback** ⚠️