GET /nodes/{uuid}/pfaConfigSettings

Use this method to return information about the predicted failure alerts (PFA) configuration settings from the baseboard management controller.

A 64-bit category map is used to identify hardware event categories and severities:

Note: This API requires Lenovo XClarity Administrator v2.1.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/nodes/{uuid}/pfaConfigSettings

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
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.
404 Not found A specified resource cannot be found. 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
categoryBitMap Array of Objects Bits definition
  vmMoveCategoryBit Integer Bit number of the category
  vmMoveCategoryName String Name of the category
  vmMoveCategoryType String Type of the category
desiredCategories Integer Hardware event categories that are monitored. This value can be a bitmask value as per the category map.
supportedCategories Integer Hardware event categories that are supported by the platform. This value can be a bitmask value as per the category map.
The following example is returned if the request is successful.
{
   "categoryBitMap": [{
      "vmoveCategoryBit": 0,
      "vmMoveCategoryName": "RASeventVMmovementsupport",
      "vmMoveCategoryType": "VMEFlag"
   },
   {
      "vmMoveCategoryBit": 1,
      "vmMoveCategoryName": "Processorsubsystem",
      "vmMoveCategoryType": "EventCategory"
   },
   ...,
   {
      "vmMoveCategoryBit": 31,
      "vmMoveCategoryName": "partialcapacityloss",
      "vmMoveCategoryType": "Severity"
   }],
   "desiredCategoriesv": 2147483684,
   "supportedCategories": 3087007935
}