GET /api/v1/data/devices/{id}/powerSupplies
Use this method to return power-supply information about a specific device.
Authentication
Authentication with user name and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}/powerSupplies
where {id} is the ID of the device. To obtain the device IDs, use GET /api/v1/data/devices.
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| powerSupplies | Array of objects | (Rack servers only) Information about power supplies | ||
| cmmDisplayName | String | Assigned component name | ||
| cmmHealthState | String | Health state (translated). This can be one of the following values.
| ||
| dataHandle | Long | Time stamp of the last status update | ||
| description | String | Assigned component description | ||
| excludedHealthState | String | |||
| firmware | Array of objects | Power-supply firmware details | ||
| build | String | Firmware build | ||
| classifications | String | Firmware type codes | ||
| date | String | Firmware date | ||
| name | String | Firmware name | ||
| revision | String | Firmware revision | ||
| role | String | Firmware role | ||
| softwareID | String | Firmware ID | ||
| status | String | Firmware status | ||
| type | String | Firmware type | ||
| version | String | Firmware version | ||
| FRU | String | FRU part number | ||
| fruSerialNumber | String | FRU serial number | ||
| hardwareRevision | String | Hardware revision | ||
| healthState | String | Health state (translated). This can be one of the following values.
| ||
| healthStateKey | String | Health state key. This can be one of the following values.
| ||
| inputVoltageIsAC | Boolean | Identifies whether the input voltage is AC or DC. This can be one of the following values. The value is valid only if inputVoltageMin and inputVoltageMax are valid.
| ||
| inputVoltageMax | Long | Maximum input voltage. A value of -1 mean it has not been set yet. | ||
| inputVoltageMin | Long | Minimum input voltage. A value of -1 means it has not been set yet. | ||
| leds | Array of objects | Information about power-supply LEDs | ||
| color | String | LED color. This can be one of the following values.
| ||
| location | String | LED location. This can be one of the following values.
| ||
| name | String | LED name | ||
| state | String | LED state This can be one of the following values.
| ||
| machineType | String | Machine type | ||
| manufacturer | String | Manufacture name | ||
| manufactureDate | String | Manufacture date | ||
| manufacturerId | String | Manufacturer ID | ||
| model | String | Power-supply model | ||
| name | String | Name that is displayed in the user interface for this device | ||
| overallHealthState | String | Highest severity of all power supplies(translated). This can be one of the following values.
| ||
| overallHealthStateKey | String | Highest severity key. This can be one of the following values.
| ||
| parent | Object | Information about the parent device | ||
| uri | String | Parent URI | ||
| uuid | String | Parent UUID | ||
| posID | String | Position ID | ||
| powerAllocation | Object | Information about power allocation | ||
| totalInputPower | Long | Total input power | ||
| totalOutputPower | Long | Total output power | ||
| powerStatus | String | Power status (translated). This can be one of the following values.
| ||
| powerStatusKey | String | Power status key. This can be one of the following values.
| ||
| productId | String | Product ID | ||
| productName | String | Product name | ||
| serialNumber | String | Serial number | ||
| slots | Integer | Power-supply primary slot | ||
| type | String | Resource type. This value is always PowerSupplies. | ||
| uri | String | Power supply URI | ||
| userDescription | String | User description | ||
| uuid | String | UUID | ||
| vpdID | String | VPD ID | ||
| _links | Object | Device URI (see Links) | ||
The following example is returned if the request is successful.
{
"powerSupplies": [{
"cmmDisplayName": "Power Supply 1",
"cmmHealthState": "Unknown",
"dataHandle": 0,
"description": "",
"excludedHealthState": "Normal",
"firmware": [{
"build": "0",
"classifications": [10],
"date": "",
"name": "DETA Firmware",
"revision": "0",
"role": "Primary",
"softwareID": "PSUDETA6500",
"status": "Active",
"type": "Firmware",
"version": "3.50"
}],
"FRU": "",
"fruSerialNumber": "",
"hardwareRevision": "",
"healthState": "Normal",
"healthStateKey": "Normal",
"inputVoltageIsAC": true,
"inputVoltageMax": -1,
"inputVoltageMin": -1,
"leds": [],
"machineType": "",
"manufacturer": "DETA",
"manufactureDate": "",
"manufacturerId": "",
"model": "",
"name": "Power Supply 1",
"overallHealthState": "Normal",
"overallHealthStateKey": "Normal",
"parent": {
"uri": "chassis/",
"uuid": ""
},
"partNumber": "SP50L09198",
"posID": "",
"powerAllocation": {
"totalInputPower": 0,
"totalOutputPower": 750
},
"powerState": "Unknown",
"powerStatus": "Unknown",
"powerStatusKey": "Unknown"
"productId": "",
"productName": "",
"serialNumber": "D1DG6CG009B",
"slots": [1],
"type": "PowerSupply",
"uri": "powerSupply/",
"userDescription": "",
"uuid": "",
"vpdID": "",
}],
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/C7199530FEDE4FE09540DFC3D75FC56C/powerSupplies"
}
}
Give feedback