PUT /managementServer/data

Use this method to copy a Lenovo XClarity Administrator backup from the local repository to a remote share or from a remote share to the local repository, to move a backup from the local repository to a remote share, or to push a backup to a newly setup XClarity Administrator virtual appliance.

Important

After the backup is pushed to the new virtual appliance, you can validate and prepare the backup using POST /files/managementServer/data?action=operation.

Authentication

Authentication with username and password is required.

Request URL

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

Query parameters

None

Request body

Table 1. Copy or move a backup
Attributes	Required / Optional	Type	Description
action	Required	String	Action to take. This can be the following value. start. Starts a job to copy or move the backup.
destination	Required	String	Location to save the backup. This can be one of the following values. internal. XClarity Administrator local repository `{mount_point}`. Mount point for the remote share that is already configured in the XClarity Administrator instance.
operation	Required	String	Operation to perform on the backup. This can be one of the following values. copy. Copy the backup but do not delete the original copy. move. Copy the backup and delete the original copy.
uuid	Required	String	UUID of the backup. To obtain the UUID, use GET /managementServer/data

The following example copies the backup to the local repository. The remote share from where the backup will be copied is chosen automatically.

{
   "action": "start",
   "destination": "internal",
   "operation": "copy",
   "uuid": "4edf27ff-08d1-49b5-b7f3-7e8edc4fd278"
}

The following example moves the backup to a specific remote share.

{
   "operation": "move",
   "action": "start",
   "uuid": "4edf27ff-08d1-49b5-b7f3-7e8edc4fd278",
   "destination": "/mnt/my_remote_share"
}

Table 2. Push a backup to another XClarity Administrator instance
Attributes	Required / Optional	Description
action	Required	Action to take. This can be the following value. start. Start the push operation. This method creates a job to perform the operation. cancel. Cancel the push operation that is in progress.
destination	Required if action is “start”.	IP address of the target management server
operation	Required	Operation to perform. This can be the following value. push. Pushes the backup to another XClarity Administrator instance
uuid	Required if action is “start”.	UUID of the backup. To obtain the UUID, use GET /managementServer/data

The following example pushes the backup to another XClarity Administrator instance. If the backup is not on the local repository, the backup is pushed from the remote share where it is located.

{
   "action": "start",
   "destination": "10.243.16.45"б
   "operation": "push",
   "uuid": "4edf27ff-08d1-49b5-b7f3-7e8edc4fd278"
}

The following example cancels the push operation that is currently in progress.

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

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.
403	Forbidden	The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
500	Internal Server Error	An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes			Type	Description
jobId			String	ID of the job that was created to track the action progress. This attribute is returned only when an operation is started (action=start). If no job was created, this attribute is empty. The response body includes a job ID that represents the job that is monitored by the management server. You can use GET /tasks/{job_list} to determine the status of the job. If a job was not successfully started, refer to the response code and response body for details. Attention A successful response indicates that the request was successfully created and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.
result			String	Result 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.
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

The following example is returned when an operation is started.

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

The following example is returned when an operation is canceled.

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

Give documentation feedback

PUT /managementServer/data

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​