Run Test
Run a test recovery for a given replication. A VM is created and registered at the recovery site. You can use the VM to run tests, security scans and ransomware-cleanup. Operation is available only on recovery site (for incoming replications). The operation requires a valid VMware Live Recovery subscription.
The ID of the pairing between this vSphere Replication server and the remote one.
The ID of a replication
Spec containing test recovery settings.
Show optional properties
{
"instance_id": "string",
"folder_id": "Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3",
"compute_resource_id": "string",
"power_on": false
}{
"instance_id": "string",
"folder_id": "Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3",
"compute_resource_id": "string",
"excluded_disk_backings": [
{
"disk_key": 0,
"destination_path": "my_vm_folder/my_vm_disk_1.vmdk",
"destination_datastore_id": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd"
}
],
"power_on": false
}The instance of the replicated VM to use for test recovery.
The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.
The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.
File backings for excluded disks. If 'destination_path' and 'destination_datastore_id' properties are not specified then the disk will be detached from the VM.
Whether to power on the VM after the recovery completes.
Task to monitor the operation progress. Once successfully completed, the task result contains the newly registered VM ID.
"TaskDrResponseEntity Object"Bad request - the server cannot understand the request due to invalid syntax or invalid request body content
"ResponseError Object"The code of the error.
The message of the error.
The ID of the operation.
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
"ResponseError Object"The code of the error.
The message of the error.
The ID of the operation.
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
"ResponseError Object"The code of the error.
The message of the error.
The ID of the operation.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"compute_resource_id:"string","folder_id:"string","instance_id:"string","power_on:"boolean"}' https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/test