Use this method to return the status of the management server and of an active backup or restore operation.
Authentication with user name and password is required.
GET https://{management_server_IP}/managementServer/quiesce
None
None
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
Attributes | Type | Description | ||
---|---|---|---|---|
backupRequest | Object | Operational status when a backup is being created. If a backup package is not being created, this attribute is not returned. |
||
backupRequestedBy | String | Name of the user who started the backup creation operation | ||
filename | String | Name of the XClarity Administrator backup | ||
includeFW | Boolean | Indicates whether to include firmware and OS device-driver
updates in the backup. This can be one of the following values.
|
||
includeOS | Boolean | Indicates whether to include operating system images in the
backup. This can be one of the following values.
|
||
jobId | String | ID of the job that was created for the backup operation | ||
label | String | User-defined label for the backup | ||
progress | String | Percentage value of the backup creation progress | ||
remoteShareDestination | String | Mount point of the remote share where the backup is located (for example, /mnt/backups) | ||
status | String | Status of the backup operation. This can be one of the following
values.
|
||
uuid | String | UUID of the backup file | ||
restoreRequest | Object | Operational status when a backup is being restored or imported If a backup is not being restored or imported, this attribute is not returned |
||
devices | Boolean | Indicates whether to restore device inventory. This can be
one of the following values.
|
||
filename | String | Name of the XClarity Administrator backup | ||
firmware | Boolean | Indicates whether to restore firmware and OS device-driver
updates. This can be one of the following values.
|
||
network | Boolean | Indicates whether to restore network settings. This can be
one of the following values.
|
||
osImages | Boolean | Indicates whether to restore operating-system images. This
can be one of the following values.
|
||
status | String | Status of the restore/import operation. This can be one of
the following values.
|
||
uuid | String | UUID of the backup file | ||
serviceRunning | String | Service that is currently running. This can be one of the following
values.
|
||
result | String | Result of the request. This can be one of the following values.
|
||
message | Object | Information about the error message | ||
explanation | String | Additional information to clarify the reason for the message | ||
id | String | Message identifier of a returned 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 | ||
text | String | Message text associated with the message identifier |
{
"backupRequest": {
"backupRequestedBy": "ADMIN",
"filename": "ecea83fd-c68a-41a3-a1b2-cf11e992c1fb_test.tar",
"includeFW": false,
"includeOS": false,
"jobId": "32",
"label": "test",
"progress": "65.1",
"remoteShareDestination": "",
"status": "COMPLETED: ecea83fd-c68a-41a3-a1b2-cf11e992c1fb_test",
"uuid": "ecea83fd-c68a-41a3-a1b2-cf11e992c1fb"
},
"serviceRunning": "QUIESCE",
"result": "success",
"message": []
}
{
"restoreRequest": {
"devices": true,
"filename": "ecea83fd-c68a-41a3-a1b2-cf11e992c1fb_test.tar",
"firmware": false,
"network": true,
"osImages": false,
"status": "COMPLETED: Restore done",
"uuid": "ecea83fd-c68a-41a3-a1b2-cf11e992c1fb"
},
"serviceRunning": "QUIESCE",
"result": "success",
"message": []
}
{
"serviceRunning": "LXCA",
"result": "success",
"message": []
}