Skip to main content

GET – GPU PowerLimit properties

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

Request URL​

Note
Only Nvidia GPU supports this function in AMD-based systems.
GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/Controls/GPU{N}_PowerLimit

Request body​

None

Response body​

Field

Type

Description

Id

String

“GPU{N}_PowerLimit”

Name

String

“GPU Power Limit”

Description

String

This resource shall represent GPU power limit of a chassis for a Redfish implementation.

ControlMode

String

The current operating mode of the control. “Disabled” or “Manual”.

ControlType

String

“Power”

Implementation

String

“Programmable”

Increment

Number

1

PhysicalContext

String

“Controls”

RelatedItem

Array

Items: links to resources that this control services.

 

RelatedItem[N]

Link

/redfish/v1/Chassis/1 /redfish/v1/System/1/Processor/GPU{N}

Sensor

Object

Expanded

 

DataSourceUri

String

Redfish path of sensor “GPU{N}_Power”

 

Reading

Number

Reading of sensor “GPU{N}_Power”.

SetPoint

Number

The desired set point of the control.

SetPointType

String

“Single”

SetPointUnits

String

“Watt”

Status

Object

Expanded

 

State

String

“Enabled”

 

Health

String

“OK”

Note
When XCC2 Platinum license is not installed, “SetPoint” and “ControlMode” properties will be hidden.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "@odata.context": "/redfish/v1/$metadata#Control.Control",
    "Id": "GPU1_PowerLimit",
    "Name": "GPU Power Limit",
    "@odata.type": "#Control.v1_1_0.Control",
    "@odata.id": "/redfish/v1/Chassis/1/Controls/GPU1_PowerL{imit",
    "SetPointType": "Single",
    "SetPointUnits": "Watt",
    "RelatedItem": [
            {
"@odata.id": "/redfish/v1/Chassis/1",
          },
          {
             “@odata.id”: “/redfish/v1/System/1/Processor/GPU1”
          }
    ],
    "Increment": 1,
    "PhysicalContext": "Controls",
    "Sensor": {
        "Reading": 20,
        "DataSourceUri": "/redfish/v1/Chassis/1/Sensors/GPU1_Power"
    },
    "ControlType": "Power",
    "Implementation": "Programmable",
    "Description": "This resource shall represent gpu power limit of a chassis for a Redfish implementation.",
    "@odata.etag": "\"79fb6c6b41bd242e8a2\"",
    "ControlMode": "Manual",
    "SetPoint": 5
}