PUT /managementServer/quiesce
Use this method to stop quiescing the management server and resume Lenovo XClarity Administrator and to cancel a backup operation.
Typically, you do not need to use this request, as both the backup and restore operations automatically quiesce the management server, run the operation, and then resume the management server.
If you use this request when a backup is being created, the backup operation is canceled.
Attention
Do not use this request during a restore operation. If you use this request when a backup is being restored, the restore operation is stopped; however, any that data restored up until that moment is not rolled back. Therefore, data might be lost, and both the management server and the virtual appliance itself might not behave correctly. If network settings were restored, the management server might start using the restored IP address as well.
Authentication
Authentication is not required.
Request URL
PUT https://{management_server_IP}/managementServer/quiesce
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| action | Required | String | Action to take. This can be the following value.
| ||
The following example stops quiescing the management server and resumes XClarity Administrator.
{
"action": "resume"
}
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. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
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 | ||
The following example is returned if the request is successful.
{
"result": "success",
"message": []
}
Give documentation feedback