Skip to main content

PATCH – Update next-one-time boot configurations and other properties

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

Request URL​

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

Request body​

Properties to be updated are shown as below.

FieldTypeDescription

Boot

Object

Describes boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration.

 

BootSourceOverrideEnabled

String

Describes the state of the Boot Source Override feature.

 

BootSourceOverrideMode

String

The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.

 

UefiTargetBootSourceOverride

String

The UEFI Device Path of the device to boot from when BootSourceOverrideSupported is UefiTarget.

 

BootSourceOverrideTarget

String

The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.

HostWatchdogTimer

Object

This object describes the Host Watchdog Timer functionality for this system.

 

FunctionEnabled

Boolean

This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.

AssetTag

String

The asset tag of the system.

IndicatorLED

Object

The indicator light state for the indicator light associated with this system.

KeyManagement

Object

Expanded

 

KMIPServers

Array

An array of the KMIP servers to which this computer system is subscribed.

  

KMIPServers[N]

Object

Expanded

  

Address

String

The KMIP server address.

  

Port

Int

The KMIP server port.

 

KMIPCertificates

Link

A URI reference to a collection of server certificates for the servers referenced by the KMIPServers property.

Response​

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

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example is PATCH body.

{
   "Boot" : {
      "BootSourceOverrideMode" : "Legacy", 
      "BootSourceOverrideTarget" : "Hdd", 
      "BootSourceOverrideEnabled" : "Once",
      "UefiTargetBootSourceOverride" : null 
   },
   "HostWatchdogTimer" : {
      "FunctionEnabled": true
   },
   "AssetTag": "asset tag",
   "IndicatorLED": "Lit"
}

After the PATCH operation runs successfully, querying the system resource returns below example JSON response:

{
    …
    "IndicatorLED": "Lit",
    "HostWatchdogTimer": {
        "WarningAction": "None",
        "WarningAction@Redfish.AllowableValues": [
            "None"
        ],
        "Status": {
            "State": "Disabled"
        },
        "FunctionEnabled": true,
        "TimeoutAction@Redfish.AllowableValues": [
            "PowerCycle"
        ],
        "TimeoutAction": "PowerCycle"
    },
    "AssetTag": "asset tag",
    "Boot": {
        "BootSourceOverrideEnabled@Redfish.AllowableValues": [
            "Once",
            "Disabled"
        ],
        "BootSourceOverrideMode": "Legacy",
        "UefiTargetBootSourceOverride": null,
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Cd",
            "Usb",
            "Hdd",
            "BiosSetup",
            "Diags",
            "UefiTarget"
        ],
        "BootSourceOverrideTarget": "Hdd"
    },
    …
}