POST /nodes/{uuid}/MPFAData
Use this method to collect memory-failure-prediction analytics data for a specific ThinkSystem or ThinkAgile server.
- This REST API is not supported for AMD-based ThinkSystem or ThinkAgile servers.
- This REST API requires Lenovo XClarity Administrator v4.1.0 or later.
A job is created to complete this request.
A successful response code indicates that the job was successfully transmitted and accepted by the management server. It does not indicate that the operation that is associated with the job was successful. If a job was not successfully started, refer to the response code and response body for details.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/nodes/{uuid}/MPFAData
where {uuid} is the UUID of the server. To obtain the server UUIDs, use GET /nodes.
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| action | Required | String | This value is always collectMPFAData. | ||
{
"action": "collectMPFAData"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 202 | Accepted | The request has been accepted for processing, but the processing has not yet completed. The request might or might not be acted upon, depending on the results of the processing. |
| 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. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 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 header
This method starts a job that runs in the background to perform the operation. The response header includes a URI in the form /tasks/{task_id} (for example, /tasks/12) that represents the job that is created to perform this request. You can use GET /tasks/{job_list} to monitor the status and progress of the job. If a job was not successfully started, refer to the response code and response body for details.
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| result | String | Results of the request. This can be one of the following values.
| ||
| messages | Array of objects | Information about one or more messages | ||
| id | String | Message identifier of a returned message | ||
| text | String | Message text associated with the message identifier | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||