Skip to main content

GET /fanMuxes/{uuid}

Use this method to return properties and metrics for a specific Flex System fan logic module (fan mux).

Authentication​

Authentication with username and password is required.

Request URL​

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

where {uuid} is the UUID of the fan to be retrieved. To obtain the fan UUID, use the GET /fanMuxes method.

Query parameters​

ParametersRequired / OptionalDescription
excludeAttributes={attributes}OptionalReturns 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}OptionalReturns 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.

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe 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.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
cmmDisplayNameStringFan mux name that is provided by the CMM
cmmHealthStateStringHealth summary that corresponds to the highest event severity of all the devices. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
dataHandleLongTime stamp of the last status update
descriptionStringDescription provided by the CMM
FRUStringFRU part number
fruSerialNumberStringFRU serial number
hardwareRevisionStringHardware revision
ledsArrayInformation about fan mux 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
manufacturerStringManufacturer
manufactureDateStringManufacture date
manufacturerIDStringManufacturer ID
modelStringFan mux model
nameStringName that is displayed in the user interface for this device
parentObjectParent device
 uriStringParent URI
 uuidStringParent UUID
partNumberStringPart number
productIDStringProduct ID
productNameStringProduct name
serialNumberStringSerial number
slotsIntegerPrimary slot
statusStringStatus. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
typeStringResource type. This value is always FanMux.
uriStringURI
uuidStringUUID
The following example is returned if the request is successful.
{
   "cmmDisplayName": "Fan Logic 01",
   "cmmHealthState": "Major-Failure",
   "dataHandle": 0,
   "description": "Fan Logic Module",
   "FRU": "81Y2912",
   "fruSerialNumber": "31gfbdRUKGmS",
   "hardwareRevision": "3.1",
   "leds": [{
      "color": "Amber",
      "location": "FrontPanel",
      "name": "FAULT",
      "state": "On"
   }],
   "machineType": "",
   "manufactureDate": "1011",
   "manufacturer": "IBM",
   "manufacturerId": "20301",
   "model": "",
   "name": "Fan Logic 01",
   "parent": {
      "uri": "chassis/48331A223BF34FBA90732B379B837B9C",
      "uuid": "48331A223BF34FBA90732B379B837B9C"
   },
   "partNumber": "49Y3309",
   "productId": "338",
   "productName": "IBM Accipiter Fan Logic Mux Card",
   "serialNumber": "",
   "slots": [1],
   "status": "Major-Failure",
   "type": "FanMux",
   "uri": "fanMux/5D3EC1A4F2064A2981457AC9A06B56F9",
   "uuid": "5D3EC1A4F2064A2981457AC9A06B56F9"
}