Skip to main content

PATCH – Update secure boot properties

Use the PATCH method to update properties in SecureBoot resource for Redfish service.

Request URL​

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

Request body​

Property to be updated is shown as bellow.

FieldTypeDescription

SecureBootEnable

String

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

XCC will do the RPP assert internally when receiving this cmd.

If assert RPP successfully, return code 200 + @Message.ExtendedInfo

“RebootRequired”:

"RebootRequired": {

"Description": "Indicates that one or more properties were changed, and/or actions completed successfully. However, these changes will not take effect until the next system reboot.",

"Message": "Changes completed successfully, but these changes will not take effect until next reboot.",

"Severity": "Warning",

"NumberOfArgs": 0,

"ParamTypes": [],

"Resolution": "Reboot the computer system for the changes to take effect."

}

else return

code 200 + @Message.ExtendedInfo “PhysicalPresenceError”: "PhysicalPresenceError": {

"Description": "The operation failed because Physical Presence or Remote Physical Presence was not asserted.",

"Message": " The operation failed because of Remote Physical Presence security requirements.",

"Severity": "Warning",

"NumberOfArgs": 0,

"ParamTypes": [],

"Resolution": "Attempt asserting Physical Presence or Remote Physical Presence, and retry the operation."

}

Response body​

The response returns same content as GET operation with updated properties.

Status code​

HTTP Status CodeError Message ID
200RebootRequired
403InsufficientPrivilege
500InternalError

Response example​

The following example is PATCH body.

{
"SecureBootEnable": true
}

Get the following response:

{
    "SecureBootCurrentBoot": "Disabled",
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot",
    "Name": "Secure Boot",
    "@odata.context": "/redfish/v1/$metadata#SecureBoot.SecureBoot",
    "Id": "SecureBoot",
    "@odata.type": "#SecureBoot.v1_0_4.SecureBoot",
    "SecureBootEnable": true,
    "SecureBootMode": "SetupMode",
    "@odata.etag": "\"95230d5e00821715e4de6085f28c564e\"",
    "Actions": {
        "#SecureBoot.ResetKeys": {
            "target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",
            "title": "ResetKeys",
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo"
        }
    },
    "Description": "UEFI Secure Boot Configuration",
    "@Message.ExtendedInfo": [
        {
            "MessageArgs": [],
            "Resolution": "Reboot the computer system for the changes to take effect.",
            "MessageId": "ExtendedError.1.1.RebootRequired",
            "Severity": "Warning",
            "Message": "Changes completed successfully, but these changes will not take effect until next reboot.",
            "@odata.type": "#Message.v1_0_6.Message"
        }
    ]
}