Skip to main content

GET /managementServer/quiesce

Use this method to return the status of the management server and of an active backup or restore operation.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/managementServer/quiesce

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.

Response body​

AttributesTypeDescription
backupRequestObjectOperational status when a backup is being created.

If a backup package is not being created, this attribute is not returned.

 backupRequestedByStringName of the user who started the backup creation operation
 filenameStringName of the XClarity Administrator backup
 includeFWBooleanIndicates whether to include firmware and OS device-driver updates in the backup. This can be one of the following values.

  • true. Include updates.

  • false. Do not firmware updates.

 includeOSBooleanIndicates whether to include operating system images in the backup. This can be one of the following values.

  • true. Include OS images.

  • false. Do not include OS images.

 jobIdStringID of the job that was created for the backup operation
 labelStringUser-defined label for the backup
 progressStringPercentage value of the backup creation progress
 remoteShareDestinationStringMount point of the remote share where the backup is located (for example, /mnt/backups)
 statusStringStatus of the backup operation. This can be one of the following values.

  • EXEC: Ready to begin data export

  • EXEC: Export thread started

  • EXEC: Init export package procedures

  • EXEC: Checking if appliance has enough space to export package

  • EXEC: Starting the backup procedures

  • EXEC: Starting export of transformed content

  • EXEC: Saving xcat data

  • EXEC: Starting the packaging procedures

  • EXEC: Packaging LXCA data

  • EXEC: Validating LXCA data

  • EXEC: Creating metadata file

  • EXEC: Appending OS images to external tar

  • EXEC: Appending FW files to external tar

  • COMPLETED: {backup_file_name}

  • FAIL: {error_message}

 uuidStringUUID of the backup file
restoreRequestObjectOperational status when a backup is being restored or imported

If a backup is not being restored or imported, this attribute is not returned

 devicesBooleanIndicates whether to restore device inventory. This can be one of the following values.

  • true. Restore device inventory.

  • false. Do not restore device inventory.

 filenameStringName of the XClarity Administrator backup
 firmwareBooleanIndicates whether to restore firmware and OS device-driver updates. This can be one of the following values.

  • true. Restore updates.

  • false. Do not restore updates.

 networkBooleanIndicates whether to restore network settings. This can be one of the following values.

  • true. Restore device network settings.

  • false. Do not restore device network settings.

 osImagesBooleanIndicates whether to restore operating-system images. This can be one of the following values.

  • true. Restore operating-system images.

  • false. Do not restore operating-system images.

 statusStringStatus of the restore/import operation. This can be one of the following values.

  • uploaded

  • canceled

  • EXEC: validated

  • EXEC: Init restore

  • EXEC: Starting quiesce

  • EXEC: Preparing restore environment

  • EXEC: Restoring network and date settings

  • EXEC: Restoring date settings

  • EXEC: Restoring thread started

  • EXEC: Init restore package procedures

  • EXEC: Starting restore procedures

  • EXEC: Starting restore of transformed content

  • EXEC: Error restoring database

  • COMPLETED: Restore done

  • FAIL: {error _message}

 uuidStringUUID of the backup file
serviceRunningStringService that is currently running. This can be one of the following values.

  • LXCA. XClarity Administrator is either starting or already up and running.

  • QUIESCE. XClarity Administrator is not running while the requested backup, restore, or import operation completes.. XClarity Administrator is either starting or already up and running.

resultStringResult 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.
messageObjectInformation about the error message
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 textStringMessage text associated with the message identifier
The following example is returned while a backup is being created.
{
   "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": []
}
The following example is returned while a backup is being restored.
{
   "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": []
}
The following example is returned while XClarity Administrator is up and there is no backup, restore, or import operation in progress.
{
   "serviceRunning": "LXCA",
   "result": "success",
   "message": []
}