GET – Resource for BIOS
Use the GET method to retrieve properties in BIOS resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/Systems/1/Bios
Request body
None
Response body
Field | Type | Description | ||||
---|---|---|---|---|---|---|
Id | String | “Bios”. | ||||
Name | String | “Bios”. | ||||
Description | String | System Bios | ||||
AttributeRegistry | String | ”BiosAttributeRegistry.1.0.0”. | ||||
Attributes | Object | This is the manufacturer/provider specific list of BIOS attributes. | ||||
Actions | Object | Expanded | ||||
#Bios.ChangePassword | Object | Expanded | ||||
@Redfish.ActionInfo | Link | /redfish/v1/Systems/1/Bios/ChangePasswordActionInfo | ||||
PasswordName@Redfish.AllowableValues | Array | Items: string Item count: 2 | ||||
PasswordName@Redfish.AllowableValues[0] | String | "UefiAdminPassword". | ||||
PasswordName@Redfish.AllowableValues[1] | String | "UefiPowerOnPassword". | ||||
#Bios.ResetBios | Object | Expanded. | ||||
@Redfish.Settings | Object | Expanded. | ||||
Messages | Array | Items: object. | ||||
Messages[N] | Object | Expanded | ||||
MessageId | String | “RebootRequired”. | ||||
RelatedProperties | Array | Items:string. | ||||
RelatedProperties[N] | String | The setting name of BIOS attributes. The format will be “#/Attributes/” + the name of attribute. | ||||
Severity | String | “Warning”. | ||||
Message | String | “Changes completed successfully, but these changes will not take effect until next reboot.” | ||||
Resolution | String | “Reboot the computer system for the changes to take effect.” | ||||
SettingsObject | Link | /redfish/v1/Systems/1/Bios/Pending/ | ||||
Time | String | Indicate the time when the Attributes last applied. | ||||
SupportedApplyTimes | Array | Items: string Item count: 1 | ||||
SupportedApplyTimes[0] | String | “OnReset”. | ||||
Links | Object | Expanded | ||||
ActiveSoftwareImage | Link | /redfish/v1/UpdateService/FirmwareInventory/UEFI | ||||
SoftwareImages | Array | Items: string Item count: 1 | ||||
SoftwareImages[1] | Link | /redfish/v1/UpdateService/FirmwareInventory/UEFI | ||||
SoftwareImages@odata.count | Number | 1 |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response is returned:
{
"@odata.type": "#Bios.v1_0_6.Bios",
"Actions": {
"#Bios.ResetBios": {
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios",
"title": "ResetBios"
},
"#Bios.ChangePassword": {
"PasswordName@Redfish.AllowableValues": [
"UefiAdminPassword",
"UefiPowerOnPassword"
],
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/Bios/ChangePasswordActionInfo",
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword",
"title": "ChangePassword"
}
},
"Id": "Bios",
"AttributeRegistry": "BiosAttributeRegistry.1.0.0",
"Attributes": {
…
…
},
"Name": "Bios",
"@odata.id": "/redfish/v1/Systems/1/Bios",
"@odata.etag": "\"610e10e486e3486d2a50c5b9e6750559\"",
"Description": "System Bios",
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_2_1.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Pending"
},
"Messages": [],
"SupportedApplyTimes": [
"OnReset"
],
"Time": "2019-11-28T10:07:08+00:00"
},
"Links": {
"ActiveSoftwareImage": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/UEFI"
},
"SoftwareImages": [
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/UEFI"
}
],
"SoftwareImages@odata.count": 1
}
}