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
BootObject

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

 BootSourceOverrideEnabledString

Describes the state of the Boot Source Override feature.

 BootSourceOverrideModeString

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

 UefiTargetBootSourceOverrideString

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

 BootSourceOverrideTargetString

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

HostWatchdogTimerObject

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

 FunctionEnabledBoolean

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

AssetTagString

The asset tag of the system.

IndicatorLEDObject

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

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"
    },
    …
}