RunRecoverySpec

RunRecoverySpec
RunRecoverySpec

Spec containing run recovery settings.

JSON Example
{
    "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,
    "sync_data": false
}
string
instance_id
Optional

The instance of the replicated VM to use for recovery. If no instance is set and there is a promoted instance, the promoted instance will be used. If no promoted instance exists, the latest instance will be used. If set, the 'sync_data' parameter must be 'false'.

string
folder_id
Required

The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.

string
compute_resource_id
Required

The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.

array of DiskBacking
excluded_disk_backings
Optional

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.

boolean
power_on
Required

Whether to power on the VM after the recovery completes.

boolean
sync_data
Required

Whether to perform offline sync to replicate the latest changes. If 'true', the protected site must still be available and the VMs powered off, else the recovery will fail. If the protected site is not available, and the user confirms the recovery should run, sync_data must be set to 'false'.