POST /managementServer/data

During the backup or restore operation, the management server is placed in a quiesced state. You can use the GET /managementServer/quiesce method to retrieve the current status of the management server and of the backup or restore operation that is in progress. Note that while the management server is being quiesced or resumed, status cannot be retrieved.

The restore operation is a multiple-step operation. The backup package must first be decrypted and prepared before the restore can start.

To restore a backup file in a newly setup management server, complete the following steps.

1. Send the backup to the new management server by completing one of the following steps.

   1. Importing the backup to the management server using POST /files/managementServer/data?action=import.

   2. Pushing the backup from an existing management server to the new management server using PUT /managementServer/data and specifying the operation=push and action=start request attributes.

2. Validate, decrypt, and prepare the backup using POST /files/managementServer/data?action=process.

3. Restore the backup using POST /managementServer/data and specifying the operation=restore and action=start request attributes.

To restore a backup file in an existing management server, complete the following steps

1. If the package is not in the local repository, either:

• If the file is on the local server, import the file using POST /files/managementServer/data?action=import and then validate and prepare the backup the file using POST /files/managementServer/data?action=process.

• If the file is in a remote share, copy the backup to the local repository using PUT /managementServer/data and specifying the operation=copyand action=start request attributes.

1. Decrypt and prepare the backup using POST /managementServer/data and specifying the operation=restore and action=prepare request attributes.

2. Restore the backup using POST /managementServer/data and specifying the operation=restore and action=start request attributes.

Authentication​

Authentication with username and password is required.

Request URL​

POST https://{management_server_IP}/managementServer/data

Query parameters​

None

Request body​

{
   "action": "start",
   "includeFW": true,
   "includeOS": true,
   "label": "mybackup",
   "operation": "backup",
   "passphrase": "123456789",
   "remoteShareDestination": "/mnt/my_remote_share"
}

{
   "action": "prepare",
   "operation": "restore",
   "passphrase": "123456789",
   "uuid": "56be1884-3187-4a4c-90b5-13f05ee824a2"
}

{
   "action": "start",
   "includeFW": false,
   "includeOS": true,
   "label": "mybackup2",
   "operation": "backup",
   "passphrase": "123456789"
}

{
   "action": "start",
   "devices": true,
   "network": true,
   "operation": "restore",
   "osImages": false,
   "firmware": false
}

{
   "action": "cancel",
   "operation": "restore"
}

Response codes​

Response body​

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