Skip to main content

PUT /storage/{uuid}/{controller}

Use this method to power on or off a specific storage controller.

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.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/storage/{uuid}/{controller}
where:

  • {uuid} is the UUID of the storage device to be retrieved. To obtain the node UUID, use the GET /storage method.

  • {controller} is A for the top controller or B for the bottom controller.

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
powerStateRequiredStringPerforms a power operation on the device. This can be one of the following values:
  • powerOn. Powers on the storage.
  • powerOff. Powers off the storage device immediately.
  • powerCycleSoft. Restarts the storage device immediately.
If you specify this attribute, 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.
Attention
A successful response indicates that the request was successfully created and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.
The following example restarts the target storage device:
{
   "powerState": "powerCycleSoft"
}

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.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
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