Skip to main content

GET /api/v1/data/devices/{id}/powerSupplies

Use this method to return power-supply information about a specific device.

Authentication​

Authentication with username 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​

CodeDescriptionComments
200OKThe request completed successfully.
404Not foundThe 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).

AttributesTypeDescription
powerSuppliesArray of objects(Rack servers only) Information about power supplies
 cmmDisplayNameStringAssigned component name
 cmmHealthStateStringHealth state (translated). This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
 dataHandleLongTime stamp of the last status update
 descriptionStringAssigned component description
 deviceTypeKeyStringDevice type key
 excludedHealthStateStringExcluded health state. This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
 firmwareArray of objectsPower-supply firmware details
  buildStringFirmware build
  classificationsArray of integersFirmware type codes
  dateStringFirmware date
  deviceTypeKeyStringDevice type key
  nameStringFirmware name
  roleStringFirmware role. This can be one of the following values.
  • Primary
  • Backup
  • Temporary
  • Permanent
  softwareIDStringFirmware ID
  statusStringFirmware status. This can be one of the following values.
  • Active
  • Inactive
  typeStringFirmware type, such as UEFI, MP, or DSA.
  versionStringFirmware version
 FRUStringFRU part number
 fruSerialNumberStringFRU serial number
 hardwareRevisionStringHardware revision
 healthStateStringHealth state (translated). This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
 healthStateKeyStringHealth state key. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
 inputVoltageIsACBooleanIdentifies 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.
  • true. AC
  • false. DC
 inputVoltageMaxLongMaximum input voltage. A value of -1 mean it has not been set yet.
 inputVoltageMinLongMinimum input voltage. A value of -1 means it has not been set yet.
 ledsArray of objectsInformation about power-supply LEDs
  colorStringLED color. This can be one of the following values.
  • Red
  • Amber
  • Yellow
  • Green
  • Blue
  • Unknown
  locationStringLED location. This can be one of the following values.
  • Front panel
  • Lightpath Card
  • Planar
  • FRU
  • Rear Panel
  • Unknown
  nameStringLED name
  stateStringLED state This can be one of the following values.
  • Off
  • On
  • Blinking
  • Unknown
 machineTypeStringMachine type
 manufactureDateStringManufacture date
 manufacturerStringManufacture name
 manufacturerIdStringManufacturer ID
 modelStringPower-supply model
 nameStringUser-defined name, if available. Otherwise, this is one of the following values.
  • component name
  • serial number
  • UUID
 overallHealthStateStringHighest severity of all power supplies(translated). This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
 overallHealthStateKeyStringHighest severity key. This can be one of the following values.
  • Normal
  • Warning
  • Critical
  • Unknown
 parentObjectInformation about the parent device
  uriStringParent URI
  uuidStringParent UUID
 posIDStringPosition ID
 powerAllocationObjectInformation about power allocation
  totalInputPowerLongTotal input power
  totalOutputPowerLongTotal output power
 powerStateStringCurrent power state of the power supply. This can be one of the following values.
  • Off
  • On
  • ShuttingDown
  • Standby
  • Hibernate
  • Unknown
 powerStatusStringPower status (translated). This can be one of the following values.
  • Off
  • On
  • Standby
  • Unknown
 powerStatusKeyStringPower status key. This can be one of the following values.
  • Off
  • On
  • Standby
  • Unknown
 productIdStringProduct ID
 productNameStringProduct name
 serialNumberStringSerial number
 slotsIntegerPower-supply primary slot
 typeStringResource type. This value is always PowerSupplies.
 uriStringPower supply URI
 userDescriptionStringUser description
 uuidStringUUID
 vpdIDStringVPD ID
_linksObjectDevice URI (see Links)
The following example is returned if the request is successful.
{
   "powerSupplies": [{
      "cmmDisplayName": "Power Supply 1",
      "cmmHealthState": "Unknown",
      "dataHandle": 0,
      "description": "Power Supply 1",
      "deviceTypeKey": "powersupply",
      "excludedHealthState": "Normal",
      "firmware": [{
         "build": null,
         "classifications": [ 10 ],
         "date": "",
         "deviceTypeKey": "firmware",
         "name": "PSU1",
         "role": "OK",
         "softwareID": "PSUDETA6d00",
         "status": "OK",
         "type": "Firmware",
         "version": "3.50"
      }],
      "FRU": "",
      "fruSerialNumber": "",
      "hardwareRevision": "",
      "healthState": "Normal",
      "healthStateKey": "Normal",
      "inputVoltageIsAC": true,
      "inputVoltageMax": -1,
      "inputVoltageMin": -1,
      "leds": [],
      "machineType": "",
      "manufactureDate": "",
      "manufacturer": "DETA",
      "manufacturerId": "",
      "model": "",
      "name": "Power Supply 1",
      "overallHealthState": "Normal",
      "overallHealthStateKey": "Normal",
      "parent": {
         "uri": "chassis/",
         "uuid": ""
      },
      "partNumber": "SP57A14695",
      "posID": "",
      "powerAllocation": {
         "totalInputPower": 0,
         "totalOutputPower": 750
      },
      "powerState": "Unknown",
      "powerStatus": "Unknown",
      "powerStatusKey": "Unknown"
      "productId": "",
      "productName": "",
      "serialNumber": "D1DG01B0043",
      "slots": [ 1 ],
      "type": "PowerSupply",
      "uri": "powerSupply/",
      "userDescription": "",
      "uuid": "",
      "vpdID": ""
   }],
   "_links": {
      "rel": "self",
      "uri": "/api/v1/data/devices/91C6C497643711ED9D3BA31E8F6751A9-B65EC401D9B741F49736CFC9380791F4/powerSupplies"
   }
}