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

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

"HpBios" Resource Type

Resource Instances

[/rest/v1/Systems/{item}/Bios ](http://h22208.www2.hp.com/eginfolib/servers/docs/HPRestfultool/iLo4/data_model_reference.html#/rest/v1/Systems/{item}/Bios)

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

See Resource Map for more details.

BIOS configuration settings vary with the server model and firmware version. The per-server settings are described with HpBios Attributes. A GET of the BIOS settings will include a combination of properties from "HpBios" and "HpBios Attributes".

For the modifiyable settings resource, you may PATCH or PUT the property "BaseConfig" with the value "default" to cause the BIOS to revert to default settings on the next reboot. The BIOS will revert to default settings and override them with any other properties specified in the request payload. For example:

PUT {"BaseConfig": "default", "Slot3NicBoot7": "PxeBoot"}

To cause the BIOS to revert to defaults and also set Slot 3 NIC to boot to PXE.

"HpBios" defines the following properties:

"AutoPowerOn"

This property is a member of HpBios

This defines whether the system will automatically power on when power is applied.
JSON type:
String containing one of the following supported values: "AlwaysPowerOn" "AlwaysPowerOff" "RestoreLastState"

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:

{"AutoPowerOn": "AlwaysPowerOff"}

The property "AutoPowerOn" on resource type HpBios 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.

"PowerOnDelay"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
This defines how long the system waits to power on after AC power is applied. Will be null if AutoPowerOn is set to AlwaysPowerOff.
JSON type:
String containing one of the following supported values: "None" "Random" "15Sec" "30Sec" "45Sec" "60Sec"

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

{"PowerOnDelay": "30Sec"}

The property "PowerOnDelay" on resource type HpBios 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.

"PowerRegulator"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
HP Power Regulator mode.
JSON type:
String containing one of the following supported values: "DynamicPowerSavings" "StaticLowPower" "StaticHighPerf" "OsControl"

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:

{"PowerRegulator": "StaticHighPerf"}

The property "PowerRegulator" on resource type HpBios 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.

"SwapROM"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
If true, ROM Selection will change from Current to Backup on next boot.
JSON type:
Boolean ('true' or 'false')

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:

{"SwapROM": true}

The property "SwapROM" on resource type HpBios 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.

"TpmOpromMeasuring"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
This allows enabling/disabling of TPM Option ROM Measurement.
JSON type:
String containing one of the following supported values: "Disabled" "Enabled"

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:

{"TpmOpromMeasuring": "Enabled"}

The property "TpmOpromMeasuring" on resource type HpBios 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.

"TpmState"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
This indicates the current TPM state.
JSON type:
String containing one of the following supported values: "NotPresent" "PresentDisabled" "PresentEnabled"

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:

{"TpmState": "PresentDisabled"}

The property "TpmState" on resource type HpBios 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.

"HpBios" Resource Type

Resource Instances

[/rest/v1/Systems/{item}/Bios ](http://h22208.www2.hp.com/eginfolib/servers/docs/HPRestfultool/iLo4/data_model_reference.html#/rest/v1/Systems/{item}/Bios)

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

See Resource Map for more details.

"HpBios" defines the following properties:

"AttributeRegistry"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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.

"SettingsResult/definitions/SettingsResult/ETag"

This property is a member of [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-resource-type)
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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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 [HpBios](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Resource-Type)#hpbios-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** ⚠️