POST /api/v1/maintenance/powerOption
Use this method to reboot or shut down the orchestrator server.
Note
This REST API requires Lenovo XClarity Orchestrator v2.1 or later.
Authentication
Authentication with username and password is required.
Resource URI
POST https://{orchestrator_server_IP}/api/v1/maintenance/powerOption
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| powerOption | Required | String | Power action to perform on the orchestrator server. This can be one of the following values.
| ||
The following example restarts the orchestrator server.
{
"powerOption": "Reboot"
}
The following example shuts down the orchestrator server.
{
"powerOption": "Shutdown"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| {message_attributes} | varies | Status messages (see Status messages) | ||
Give documentation feedback