Skip to main content

POST /nodes/SMARTData

Use this method to collect Self-Monitoring, Analysis and Reporting Technology (SMART) data for all manage ThinkAgile and ThinkSystem servers.

Note

  • Servers must be powered on to collect SMART data.

  • A job is created to collect SMART data. The response header includes the job ID for this request, in the format jobIDs="{job_id}" (for example, jobIDs="12"). 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.

    Attention
    A successful response indicates that the request was successfully transmitted and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.

  • This API requires Lenovo XClarity Administrator v3.0.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

POST https://{management_server_IP}/nodes/SMARTData

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
actionRequiredStringThis value is always collectSMARTData.

SMART data is collected from hard drives and solid-state drives and is used to analyze drive reliability and detect imminent hardware failures.

If you specify this attribute, this method starts a job that runs in the background to perform the operation. The response body returns 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.

Attention
A successful response indicates that the request was successfully transmitted and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.
Note
SMART data collection must be enabled (see GET /nodes/globalConfigSettings).
The following example collects SMART data.
{
   "action": "collectSMARTData"
}

Response codes​

CodeDescriptionComments
202AcceptedThe 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.
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​

None