VM Restore Operation
Select
To restore a virtual machine
Path Parameters
- vmGuid string required
GUID of VM to backup
Query Parameters
- mediaAgentName string
Media agent name
- mediaAgentId string
Media agent id
- fromTime string
Restore window UTC from time. Valid Formats: yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:sszzz or yyyy-MM-dd
- toTime date-time
Restore window UTC to time. Valid Formats: yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:sszzz or yyyy-MM-dd
- application/json
Request Body
- powerOnVmAfterRestore boolean
Default value:
false
Turn ON virtual machine after restore. Defaults to false.
- overwriteVM boolean
Default value:
false
Unconditionally overwrite VM during restore. Defaults to false.
- inPlaceRestore boolean required
Default value:
false
Flag to set if restore is in-place or out-of-place. Defaults to false.
- backupSource int32
Backup source information from where you want to restore. 0 (Automatic), 1 (Snap Copy), 2 (Primary), 3 to N (Aux Copy)
destination object
id int32name stringaccessNode object
id int32name stringaccessNodeGroup object
id int32name stringvmDestinationInfo object required
Destination informantion for the VM to restore
googleCloud object
Destination information for the GCP VMs to restore
googleCloudVMInfoList object[]
List of Google Cloud VMs that are to be restored
instanceId stringInstance ID of the google cloud virtual machine to be restored. Ex: 123456789123456789.
name stringDefault value:
Defaults to source VM name
The new name of the instance after restore. Defaults to source name after restore.
projectId stringGCP Project ID
zone stringDefault value:
Defaults to source instance zone after restore. For reference: cloud.google.com/compute/docs/regions-zones#available'
GCP zones. Ex: asia-east1-a. Defaults to source instance zone after restore. For reference: cloud.google.com/compute/docs/regions-zones#available
region stringDefault value:
Defaults to source instance region after restore. For reference: cloud.google.com/compute/docs/regions-zones#available
GCP Region. Ex: asia-east1. Defaults to source instance region after restore. For reference: cloud.google.com/compute/docs/regions-zones#available
machineType stringDefault value:
--Auto Select--
GCP Machine Family. Ex: c2d-highmem-8. Defaults to --Auto Select--. For Reference: cloud.google.com/compute/docs/machine-resource
createPublicIP booleanDefault value:
false
Flag to create external IP after restore. Defaults to false.
networkInterfaces object[]
Google Cloud VM network interfaces list
name stringName of the network interface card. Ex: nic0.
networkName stringDefault value:
Defaults to source network name.
Network Name. Ex: default. Defaults to source network name.
subnetId stringDefault value:
Defaults to source subnet
Subnet self-link. Format: googleapis.com/compute/v1/projects/
/regions/ /subnetworks/{Subnet Name}. Defaults to source subnet self-link. networkId stringDefault value:
Defaults to source network self-link.
Network self-link. Format: googleapis.com/compute/v1/projects/
/global/networks/{Network Name}. Defaults to source network self-link. internalIP ipv4Default value:
Defaults to the source internal IP after restore.
Internal IP address. Defaults to the source internal IP after restore.
externalIP ipv4Default value:
Defaults to null and is not set after restore.
External IP Address. Defaults to null and is not set after restore.
customMetadata object[]
GCP custom metadata key-value pairs
name stringvalue stringnodeAffinities object[]
Node affinity for the virtual machine to provision virtual machine as sole tenanat VM. Defaults to no node affinity. Format: '[{name: compute.googleapis.com/node-group-name, value: {Node Group Name} }, {name: compute.googleapis.com/node-name, value: {Node Name} }]'
name stringvalue stringserviceAccount object
Google cloud service account details
id stringname stringemail stringencryptionKey stringCustomer Managed Encryption Key
keyProtectionLevel stringProtection level of encryption key
namePrefix stringAdds prefix for VM display name
nameSuffix stringAdds suffix for VM display name
azure object
Destination information for the Azure VMs to restore
azureVMInfoList object[]
List of Azure VMs that are to be restored
sourceVMGuid stringAzure VM ID
name stringDefault value:
Defaults to source VM name
Azure VM name to be set after restore. Defaults to source VM name.
resourceGroup stringDefault value:
Defaults to source VM resource group name
Azure Resource Group Name. Defaults to source VM resource group name.
region stringDefault value:
Defaults to source VM region
Azure region name. Ex: For azure region (West US 3) the region value will be westus3. For reference: learn.microsoft.com/en-us/rest/api/resources/subscriptions/list-locations
availabilityZone stringDefault value:
Defaults to Auto
Azure availablity zones. Defaults to Auto. Values can be as follows: 'Auto' (Select from the source VM config), 'None' (Will not restore to any zone), '{Zone Number}' (Availablity zone number the restored VM should be in. Ex: 2).
storageAccount string requiredDefault value:
Defaults to source storage account
Azure staging storage account. Defaults to source storage account.
vmSize stringDefault value:
--Auto Select--
VM size to be after restore. Defaults to --Auto Select--. Ex: Standard_A1.
diskType stringDisk type to set after restore. Ex: Standard_LRS.
createPublicIP booleanDefault value:
false
Boolean to specify if VM should have publice IP. Defaults to false.
restoreAsManagedVM booleanDefault value:
true
Boolean to specify if VM need to be restored as managed VM. Defaults to true.
securityGroupId stringDefault value:
Defaults to source configuration
Azure security group to be set for the VM. Defaults to source configuration.
diskEncryptionSetTypeId stringAzure Disk Encryption Type. Values can be: 'EncryptionAtRestWithCustomerKey' or 'EncryptionAtRestWithPlatformAndCustomerKeys' or 'EncryptionAtRestWithPlatformAndCustomerKeys'. For reference: learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.compute.models.encryptiontype?view=azure-dotnet&viewFallbackFrom=azure-dotnet
diskEncryptionSetId stringAzure Disk Encryption Set ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Compute/diskEncryptionSets/{Disk Encryption Set}.
nics object[]
Azure VM network interface list
networkId stringAzure network ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}.
subnetId stringAzure subnet ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}/subnets/{Subnet Name}.
privateIpAddress ipv4Azure private IP address.
publicIpAddress ipv4Azure publice IP address.
publicIpAddressId stringAzure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.
vmTags object[]
Azure VM tag list
name stringvalue stringrestoreSourceVMTags booleanDefault value:
true
Restore source VM tags.
namePrefix stringAdds prefix for VM display name
nameSuffix stringAdds suffix for VM display name
aws object
Destination information for the AWS instances to restore
awsInstanceInfoList object[]
List of AWS instances that are to be restored
instanceId stringAWS instance ID
instanceName stringDefault value:
Defaults to source instance name
AWS instance name to be set after restore. Defaults to source instance name.
zone stringDefault value:
Defaults to source instance availability zone.
AWS Availability zone. Defaults to source instance availability zone.
region stringinstanceSize stringDefault value:
Defaults to source instance size
Instance size to be after restore. Defaults to source instance size
volumeType stringencryptionKey object
isEncrypted booleanencryptionKey stringdiskEncryptionSetId stringdiskEncryptionSetTypeId stringnics object[]
AWS instance network interface list
vpcId stringnetworkName stringsubnetId stringeniId stringsecurityGroups object[]
List of AWS security groups to be set for the instance.
groupId stringgroupName stringvmTags object[]
AWS VM tag list
name stringvalue stringrestoreSourceVMTags booleanDefault value:
true
Restore source VM tags.
keyPairs object[]
List of key pairs
keyId stringkeyName stringrestoreSourceNetworkConfig booleanDefault value:
true
If set to true, we will use the source network configuration during restore
namePrefix stringAdds prefix for instance display name
nameSuffix stringAdds suffix for instance display name
- transportMode string
Possible values: [
Auto
,SAN
,Hot_Add
,NAS
,NBD_SSL
,NBD
,EBS_DIRECT
,IMPORT
]Backup transport modes enum
- restoreFlavour
Possible values: [
NONE
,VIRTUAL_MACHINE
,PHYSICAL_VOLUME
,VMDK_FILES
,VIRTUAL_HARD_DISKS
,VDI_OBJECT
,DISK_ATTACH
,RESTORE_AS_FILE
,INSTANT_VM
]Type of restore for virtual machine
- notifyOnJobCompletion boolean
Default value:
false
Enable email notificaiton for job status. Defaults to false.
- reuseVMClient boolean
Reuse the existing VM client instance of creating new one after restore. Defaults to true for inplace restore and false for out of place restore.
- 200
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- taskId int32
- jobIds string[]
JobIds for the immediate run request
{
"taskId": 0,
"jobIds": [
"string"
]
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}