PUT /nodes/{uuid}/bmc
Use this method to restart the baseboard management controller for a specific managed server.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/nodes/{uuid}/bmc
where {uuid} is the UUID of the node to be retrieved. To obtain the node UUID, use the GET /nodes method.
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| powerState | Optional | String | Performs a power operation on the device. This can be one of the following values.
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 server:
{
"powerState": "restart"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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. |
| 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 body
No response is returned if the request is successful with a response code of 200. If the request is not successful, the following attributes are returned.
| Attributes | Type | Description | ||
|---|---|---|---|---|
| statusCode | Integer | Response code | ||
| statusDescription | String | Result of the request. This can be one of the following values.
| ||
| messages | Array | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | String | User actions that can be taken to recover from the event | ||
| recoveryUrl | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
The following example is returned if the request fails.
{
"statusCode": 409,
"statusDescription": "The current state of the requested resources conflicts with this
request.",
"messages": [{
"explanation": "The RESTART action on endpoint AndroMeda failed.",
"id": "FQXDM0409N",
"recovery": "Verify the state of the requested resource and send this request again.",
"recoveryUrl": "",
"text": "The current state of the requested resources conflicts with this request.",
}]
}
Give documentation feedback