VM Recover
Select
This operation initiates a restore operation for a virtual machine and returns the details for the restore job. You can perform an in-place restore or an out-of-place restore of a virtual machine. Supported vendors: VMware, vCloud and HyperV
Note:
vmClientGUIDis the client GUID of the backed-up VM. You can use "Get all VMs" API to fetch the client GUID from the client properties of the VM.Path Parameters
- vmClientGUID string required
- application/json
Request Body
- inPlaceRestore boolean required
The option to restore backed-up data to the same client from which it was backed up. Set to false for out of place recover
- passUnconditionalOverride boolean
The option to overwrite an existing virtual machine of the same name.
- powerOnVmAfterRestore boolean
The option to start the virtual machine after it is restored.
destinationClient object
Required for out of place recover
clientName stringDestination client name of the hypervisor
destinationInfo object[]
Required for out of place recover
vmware object
esxHost stringEsxHost in the Vcenter to which this VM has to be restored
newName stringNew restore name for the VM
dataStore stringDatastore in the Vcenter to which this VM has to be restored
resourcePool stringResourcedPool in the Vcenter to which this VM has to be restored
vcloud object
newName stringNew name of the VM
esxHost stringDestination esx host of the VM
dataStore stringDestination Storage Policy GUID of the VM
vCloudOrgName stringName of the destination vCloud Organisation
vCDName stringName of the destination vCloud Org VDC
vAppName stringName of the destination vApp
vCloudOwner stringName of the owner of the VM
hyperv object
newName stringdestinationPath stringregisterwithFailover string
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 63814,
"jobIds": [
"131574"
]
}