GET /powerSupplies/{uuid}

Use this method to return properties for a specific power supply in a Flex System chassis.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/powerSupplies/{uuid}

where {uuid} is the UUID of the power supply to be retrieved. To obtain the power supply UUID, use the GET /powerSupplies method.

Query parameters

Parameters Required / Optional Description
excludeAttributes={attributes} Optional Returns a response that excludes the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • When the includeAttributes query parameter is specified, the excludeAttributes query parameter is ignored.
  • The response is filtered based on attribute name, not the attribute value.
  • Base attributes cannot be excluded.
includeAttributes=<attributes} Optional Returns a response that includes the base attributes and the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • The response is filtered based on attribute name, not the attribute value.
  • If this attribute is not specified, all attributes are returned by default.

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
cmmDisplayName String Display name provided by the CMM
cmmHealthState String Health summary that corresponds to the highest event severity of all the devices in the chassis. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
dataHandle Long Time stamp of the last status update
description String Description that was provided by the CMM.
firmware Array of objects Power-supply firmware details
  build String Firmware build
  date String Firmware date
  name String Firmware name
  role String Firmware role
  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
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.
  • true. AC
  • false. DC
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.
  • Red
  • Amber
  • Yellow
  • Green
  • Blue
  • Unknown
  location String LED location. This can be one of the following values.
  • Front panel
  • Lightpath Card
  • Planar
  • FRU
  • Rear Panel
  • Unknown
  name String LED name
  state String LED state This can be one of the following values.
  • Off
  • On
  • Blinking
  • Unknown
machineType String Machine type
manufacturer String Manufacturer
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
parent Object  
  uri String Parent URI
  uuid String Parent UUID
partNumber String Part number
posID String Position ID
powerAllocation Object  
  totalInputPower Long Total input power
  totalOutputPower Long Total output power
powerState String Current power state of the power supply. This can be one of the following values.
  • Off
  • On
  • ShuttingDown
  • Standby
  • Hibernate
  • Unknown
productID String Product ID
productName   Product name
serialNumber String Serial number
slots Integer Power-supply primary slot
type String Resource type. This value is always PowerSupply.
uri String URI
userDescription String User description
uuid String UUID
vpdID String VPD ID
The following example is returned if the request is successful.
{
   "cmmDisplayName": "Power Supply 01",
   "cmmHealthState": "Non-Critical",
   "dataHandle": 0,
   "description": "Power Supply",
   "firmware": [{
      "build": "",
      "date": "",
      "name": "Power Supply Firmware",
      "role": "",
      "status": "",
      "type": "Power Supply Firmware",
      "version": "0"
   }],
   "FRU": "69Y5817",
   "fruSerialNumber": "ZK125116E0KK",
   "hardwareRevision": "5.0",
   "inputVoltageIsAC": true,
   "inputVoltageMax": 208,
   "inputVoltageMin": 200,
   "leds": [{
      "color": "Green",
      "location": "Planar",
      "name": "IN",
      "state": "On"
   },
   ...,
   {
      "color": "Amber",
      "location": "Planar",
      "name": "FAULT",
      "state": "Off"
   }],
   "machineType": "",
   "manufacturer": "IBM",
   "manufactureDate": "2411",
   "manufacturerId": "20301",
   "model": "",
   "name": "Power Supply 01",
   "parent": {
      "uri": "chassis/FBEF740B178F4EFAA846E7225EE256DC",
      "uuid": "FBEF740B178F4EFAA846E7225EE256DC"
   },
   "partNumber": "69Y5801",
   "posID": "128",
   "powerAllocation": {
      "totalInputPower": 0,
      "totalOutputPower": 0
   },
   "powerState": "Unknown",
   "productId": "303",
   "productName": "IBM 2500 W Power Supply",
   "serialNumber": "",
   "slots": [1],
   "type": "PowerSupply",
   "uri": "powerSupply/B1B549049DE811E00005000500050005",
   "userDescription": "",
   "uuid": "B1B549049DE811E00005000500050005",
   "vpdID": "60"
}