Skip to main content

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​

FieldTypeDescription

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"

  

target

String

redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword

  

title

String

ChangePassword

 

#Bios.ResetBios

Object

Expanded.

  

target

String

/redfish/v1/Systems/system/Bios/Actions/Bios.ResetBios

  

title

String

ResetBios

@Redfish.Settings

Object

Expanded.

 

Messages

Array

Items: object.

  

Messages[N]

Object

Expanded.

   

MessageId

String

“Base.1.16.0.ResetRequired”

   

RelatedProperties

Array

Items: string.

    

RelatedProperties[N]

String

The setting name of BIOS attributes. The format will be “#/Attributes/” + the name of attribute.

 

SettingsObject

Link

/redfish/v1/Systems/1/Bios/Pending/

 

SupportedApplyTimes

Array

Items: string

Item count: 1

  

SupportedApplyTimes[0]

String

“OnReset”

 

Time

String

Indicate the time when the Attributes last applied.

Links

Object

Expanded.

 

ActiveSoftwareImage

Link

/redfish/v1/UpdateService/FirmwareInventory/UEFI

 

SoftwareImages

Array

Items: string

Item count: 1

  

SoftwareImages[N]

Link

/redfish/v1/UpdateService/FirmwareInventory/UEFI

 

SoftwareImages@odata.count

Number

1

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_3_5.Settings",
        "Messages": [],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/1/Bios/Pending"
        },
        "SupportedApplyTimes": [
            "OnReset"
        ],
        "Time": "2024-12-03T22:34:35+00:00"
    },
    "@odata.context": "/redfish/v1/$metadata#Bios.Bios",
    "@odata.etag": "\"7277A030\"",
    "@odata.id": "/redfish/v1/Systems/1/Bios",
    "@odata.type": "#Bios.v1_2_0.Bios",
    "Actions": {
        "#Bios.ChangePassword": {
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/Bios/ChangePasswordActionInfo",
            "PasswordName@Redfish.AllowableValues": [
                "UefiAdminPassword",
                "UefiPowerOnPassword"
            ],
            "target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword",
            "title": "ChangePassword"
        },
        "#Bios.ResetBios": {
            "target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios",
            "title": "ResetBios"
        },
        "Oem": {}
    },
    "AttributeRegistry": "BiosAttributeRegistry.1.0.0",
    "Attributes": {
        "AdvancedRAS_DIMMDisablePolicy": "DisableFaultyDIMMPersistently",
        ...
        "iSCSI_TargetPort_8": 3260
    },
    "Description": "System Bios",
    "Id": "Bios",
    "Links": {
        "ActiveSoftwareImage": {
            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/UEFI"
        },
        "SoftwareImages": [
            {
                "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/UEFI"
            }
        ],
        "SoftwareImages@odata.count": 1
    },
    "Name": "Bios",
    "Oem": {
        ...
        }
    }
}