Skip to main content

PATCH – Update System PowerLimit properties

Use the PATCH method to update the PowerLimit resource properties.

Request URL​

Note
This setting is not supported on following systems: AMD-based and dense systems, Systems without XCC2_Platinum license installed.
PATCH https://<BMC_IPADDR>/redfish/v1/Chassis/1/Controls/PowerLimit

Request body​

FieldTypeDescription

ControlMode

String

“Disabled” or “Manual”.

SetPoint

Number

The desired set point of the control. If both SetPoint and ControlMode are given, if SetPoint is a number then ControlMode must be “Manual”, and if SetPoint is null then ControlMode must be “Disabled”, and vice versa, otherwise 400 Conflict is returned.

Response​

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

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example is PATCH body.

{
"SetPoint": 500,
"ControlMode": "Manual"
}

The following example JSON response is returned:

{
    "AllowableMax": 1800,
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "@odata.context": "/redfish/v1/$metadata#Control.Control",
    "Id": "PowerLimit",
    "Name": "System Power Limit",
    "@odata.type": "#Control.v1_1_0.Control",
    "@odata.id": "/redfish/v1/Chassis/1/Controls/PowerLimit",
    "SetPointType": "Single",
    "SetPointUnits": "Watt",
    "RelatedItem": [
        {
            "@odata.id": "/redfish/v1/Chassis/1"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PowerSubsystem"
        }
    ],
    "Increment": 1,
    "AllowableMin": 0,
    "PhysicalContext": "Chassis",
    "Sensor": {
        "Reading": 20,
        "DataSourceUri": "/redfish/v1/Chassis/1/Sensors/161L0"
    },
    "ControlType": "Power",
    "Implementation": "Programmable",
    "Description": "This resource shall represent system power limit of a chassis for a Redfish implementation.",
    "@odata.etag": "\"79fb6c6b41bd242e8a2\"",
    "ControlMode": "Manual",
    "SetPoint": 500
}