GET /fans/`{uuid}`

Use this method to return properties for a specific Flex System fan.

Authentication

Authentication with username and password is required.

Request URL

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

where {uuid} is the UUID of the fan to be retrieved. To obtain the fan UUID, use the GET /fans 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	Fan name provided by the CMM
cmmHealthState		String	Health summary that corresponds to the highest event severity of all fans. This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
dataHandle		Long
description		String	Description provided by the CMM
errorFields		Array of objects that contain `{string, errorCode}`	Error codes. This can be one of the following values. FETCH_SUCCESS FETCH_FAILED NO_CONNECTOR FATAL_EXCEPTION NETWORK_FAIL
firmware		Array	Information about fan firmware
	build	String	The firmware build
	date	String	The firmware date
	name	String	The firmware name
	role	String	The firmware role
	status	String	The firmware status
	type	String	The firmware type
	version	String	The firmware version
FRU		String	FRU part number
fruSerialNumber		String	FRU serial number
hardwareRevision		String	Hardware revision
LEDs		Array	Information about fan 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
machine type		String	Machine type
manufactureDate		String	Manufacture date
manufacturer		String	Manufacturer
manufacturerID		String	Manufacturer ID
model		String	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	Information about power allocation
	maximumAllocatedPower	Long	Maximum power allocated to the fan
	minimumAllocatedPower	Long	Minimum power allocated to the fa.
powerState		String	Current power state of the fan. This can be one of the following values. Off On ShuttingDown Standby Hibernate Unknown
productID		String	Product ID
productName		String	Product name
serialNumber		String	Serial number
slots		Integer	Fan primary slot
type		String	Resource type. This value is always Power Supply.
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": "Fan 01",
   "cmmHealthState": "Normal",
   "dataHandle": 0,
   "description": "IBM Fan Pack",
   "errorFields": [],
   "firmware": [{
      "build": "",
      "date": "",
      "name": "Fan Controller",
      "role": "",
      "status": "",
      "type": "Fan Controller",
      "version": "226"
   }],
   "FRU": "88Y6685",
   "fruSerialNumber": "YK10JPB69H61",
   "hardwareRevision": "4.0",
   "leds": [{
      "color": "Amber",
      "location": "FrontPanel",
      "name": "FAULT",
      "state": "Off"
   }],
   "machineType": "",
   "manufactureDate": "2511",
   "manufacturer": "IBM",
   "manufacturerId": "20301",
   "model": "",
   "name": "Fan 01",
    "parent": {
      "uri": "chassis/FBEF740B178F4EFAA846E7225EE256DC",
      "uuid": "FBEF740B178F4EFAA846E7225EE256DC"
   },
   "partNumber": "88Y6691",
   "posID": "373",
    "powerAllocation": {
      "maximumAllocatedPower": 0,
      "minimumAllocatedPower": 0
   },
   "powerState": "Unknown",
   "productId": "342",
   "productName": "80mm Fan Pack for ITE Cooling",
    "serialNumber": "",
   "slots": [1],
   "type": "Fan",
   "uri": "fan/192C7661981E11E091C2C0AC11247C9B",
   "userDescription": "",
   "uuid": "192C7661981E11E091C2C0AC11247C9B",
   "vpdID": "11"
}

Give documentation feedback

GET /fans/{uuid}

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​