Skip to main content

GET – Secure boot properties

Use the GET method to retrieve properties in SecureBoot resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/SecureBoot

Request body​

None

Response body​

FieldTypeDescription

Id

String

SecureBoot

Name

String

Secure Boot

Description

String

UEFI Secure Boot Configuration

SecureBootEnable

Boolean, Null

Enable or disable UEFI Secure Boot (takes effect on next boot).

SecureBootCurrentBoot

String, Null

Secure Boot state during the current boot cycle.

SecureBootMode

String, Null

Current Secure Boot Mode

Property value:

  • “UserMode”

  • “SetupMode”

  • “AuditMode”

  • “DeployedMode”

Actions

Object

Expanded.

 

#SecureBoot.ResetKeys

Object

Refer to the Post section.

  

@Redfish.ActionInfo

Link

/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

When the request is successful, a message body similar to the following is returned:

{
    "@odata.context": "/redfish/v1/$metadata#SecureBoot.SecureBoot",
    "@odata.etag": "\"848E3F3E\"",
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot",
    "@odata.type": "#SecureBoot.v1_1_0.SecureBoot",
    "Actions": {
        "#SecureBoot.ResetKeys": {
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo",
            "target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",
            "title": "ResetKeys"
        }
    },
    "Description": "UEFI Secure Boot Configuration",
    "Id": "SecureBoot",
    "Name": "Secure Boot",
    "SecureBootCurrentBoot": "Disabled",
    "SecureBootEnable": false,
    "SecureBootMode": "UserMode"
}