PUT /managementServer/quiesce

Use this PUT 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.
Note: This API requires Lenovo XClarity Administrator v2.2.0 or later.

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.
  • resume. Stop quiescing the management server and resume XClarity Administrator.

    Attention: If a restore or backup process is not in progress when you call this method, the management server is forced to restart.

Request example

{
   "action": "resume"
}

Response codes

Code Description
200 OK
400 Bad request
500 Internal server error

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
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

Response example

{
   "result": "success",
   "message": []
}