Skip to main content

VM Restore Operation​

Select

SaaS
Customer Managed

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

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 int32
  • name string
  • accessNode object
  • id int32
  • name string
  • accessNodeGroup object
  • id int32
  • name string
  • vmDestinationInfo 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 string

    Instance ID of the google cloud virtual machine to be restored. Ex: 123456789123456789.

  • name string

    Default value: Defaults to source VM name

    The new name of the instance after restore. Defaults to source name after restore.

  • projectId string

    GCP Project ID

  • zone string

    Default 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 string

    Default 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 string

    Default value: --Auto Select--

    GCP Machine Family. Ex: c2d-highmem-8. Defaults to --Auto Select--. For Reference: cloud.google.com/compute/docs/machine-resource

  • createPublicIP boolean

    Default value: false

    Flag to create external IP after restore. Defaults to false.

  • disks object[]

    Google Cloud instance disks list

  • name string

    Google Cloud instance disk name to update.

  • newName string

    Google Cloud instance disks new name. Defaults to source disk name

  • type string

    Google Cloud instance disks type. Defaults to source disk type

  • IOPS int32

    Input Output Operations per second

  • throughput int32

    Throughput in MBPS

  • networkInterfaces object[]

    Google Cloud VM network interfaces list

  • name string

    Name of the network interface card. Ex: nic0.

  • networkName string

    Default value: Defaults to source network name.

    Network Name. Ex: default. Defaults to source network name.

  • subnetId string

    Default 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 string

    Default 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 ipv4

    Default value: Defaults to the source internal IP after restore.

    Internal IP address. Defaults to the source internal IP after restore.

  • externalIP ipv4

    Default 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 string
  • value string
  • nodeAffinities 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 string
  • value string
  • serviceAccount object

    Google cloud service account details

  • id string
  • name string
  • email string
  • encryptionKey string

    Customer Managed Encryption Key

  • keyProtectionLevel string

    Protection level of encryption key

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds 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 string

    Azure VM ID

  • name string

    Default value: Defaults to source VM name

    Azure VM name to be set after restore. Pass the target VM name in case of attach disk restore. Defaults to source VM name.

  • targetVMGuid string

    VM GUID to which the disks are to be attached. Only used during attach disk restore

  • resourceGroup string

    Default value: Defaults to source VM resource group name

    Azure Resource Group Name. Defaults to source VM resource group name.

  • region string

    Default 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 string

    Default 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 required

    Default value: Defaults to source storage account

    Azure staging storage account. Defaults to source storage account.

  • vmSize string

    Default value: --Auto Select--

    VM size to be after restore. Defaults to --Auto Select--. Ex: Standard_A1.

  • templateId string

    This is the Azure resource ID of the template image that is to be used for creating the new VM. This can take values of 3 different images: Market place image, Custom image, Azure compute gallery image.

  • diskType string

    Disk type to set after restore. Ex: Standard_LRS.

  • createPublicIP boolean

    Default value: false

    Boolean to specify if VM should have publice IP. Defaults to false.

  • restoreAsManagedVM boolean

    Default value: true

    Boolean to specify if VM need to be restored as managed VM. Defaults to true.

  • securityGroupId string

    Default value: Defaults to source configuration

    Azure security group to be set for the VM. Defaults to source configuration.

  • diskEncryptionSetTypeId string

    Azure 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 string

    Azure Disk Encryption Set ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Compute/diskEncryptionSets/{Disk Encryption Set}.

  • disks object[]

    Azure VM disks list

  • storageAccount string

    Azure storage account name. Defaults to source storage account

  • type string

    Azure disk type. Defaults to source disk type

  • name string

    Name of the azure disk to update

  • newName string

    Name of the new disk. Used only during attach disk restore

  • attachAndSwapOSDisk boolean

    Default value: false

    Used only in case of attach disk restore. If selected, the OS disk of the target VM will be swapped with the restored OS disk.

  • skipOSDisk boolean

    Default value: false

    When attaching disks to the new VM, when this is selected, the OS disk of the source VM is NOT attached to the target VM. Only the data disks of the source VM are attached to the target VM

  • guestCredentialID object

    To be set in order to use the saved credentials for the new VM during attach disk restore

  • id int32
  • name string
  • guestUsername string

    Username for the target VM during the attach disk restore to a new VM

  • guestPassword string

    Base64 encoded password for the target VM during the attach disk restore to a new VM

  • nics object[]

    Azure VM network interface list

  • networkId string

    Azure network ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}.

  • subnetId string

    Azure subnet ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}/subnets/{Subnet Name}.

  • privateIpAddress ipv4

    Azure private IP address.

  • publicIpAddress ipv4

    Azure publice IP address.

  • publicIpAddressId string

    Azure 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 string
  • value string
  • restoreSourceVMTags boolean

    Default value: true

    Restore source VM tags.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds 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 string

    AWS instance ID

  • instanceName string

    Default value: Defaults to source instance name

    AWS instance name to be set after restore. Defaults to source instance name.

  • zone string

    Default value: Defaults to source instance availability zone.

    AWS Availability zone. Defaults to source instance availability zone.

  • region string
  • instanceSize string

    Default value: Defaults to source instance size

    Instance size to be after restore. Defaults to source instance size

  • volumeType string
  • encryptionKey object
  • isEncrypted boolean
  • encryptionKey string
  • diskEncryptionSetId string
  • diskEncryptionSetTypeId string
  • volumes object[]

    AWS instance volumes list

  • id string

    AWS source volume ID for the volume that needs to be updated

  • name string

    AWS volume name. Defaults to source volume name

  • type string

    AWS volume type. Defaults to source volume type

  • IOPS int32

    Input Output Operations per second

  • Throughput int32

    Throughput in MBPS

  • encryptionKey object
  • isEncrypted boolean
  • encryptionKey string
  • diskEncryptionSetId string
  • diskEncryptionSetTypeId string
  • diskTags object[]

    AWS disk tag list

  • name string
  • value string
  • nics object[]

    AWS instance network interface list

  • vpcId string
  • networkName string
  • subnetId string
  • eniId string
  • securityGroups object[]

    List of AWS security groups to be set for the instance.

  • groupId string
  • groupName string
  • vmTags object[]

    AWS VM tag list

  • name string
  • value string
  • restoreSourceVMTags boolean

    Default value: true

    Restore source VM tags.

  • keyPairs object[]

    List of key pairs

  • keyId string
  • keyName string
  • restoreSourceNetworkConfig boolean

    Default value: true

    If set to true, we will use the source network configuration during restore

  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • nutanix object

    Destination information for the Nutanix VMs to restore

  • nutanixVMInfoList object[]

    List of Nutanix VMs that are to be restored

  • sourceVMGuid string

    Nutanix VM ID

  • name string

    Nutanix VM name to be set after restore. Defaults to source VM name.

  • storageContainer string

    Nutanix storage container. Defaults to source storage container.

  • nics object[]

    Nutanix VM network interface list

  • name string

    Name of the Nutanix network

  • networkName string

    UUID of the Nutanix subnet

  • destinationNetwork string

    Name of the destination network

  • networkDisplayName string

    Used in GUI. Display name of the network

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • openstack object

    Destination information for the Openstack instances to restore

  • openstackInstanceInfoList object[]

    List of Openstack instances that are to be restored

  • sourceInstanceGuid string

    Openstack instance ID

  • instanceName string

    Openstack instance name to be set after restore. Defaults to source instance name.

  • availabilityZone string

    Openstack Availability zone. Defaults to source instance availability zone.

  • volumeType string

    Openstack Volume type to be after restore. Defaults to source volume type

  • flavor string

    Openstack flavor to be after restore. Defaults to source flavor. Pass the flavor ID

  • securityGroups object[]

    List of Openstack security groups to be set for the instance.

  • groupId string
  • groupName string
  • keyPairs object[]

    List of key pairs

  • keyId string
  • keyName string
  • nics object[]

    Openstack instance network interface list

  • networkName string

    Openstack network name. Ex: external_network

  • networkId string

    Openstack network Id. Ex: 77948eb8-9a47-49cd-bd94-e999540f7da7

  • subnetId string

    Openstack subnetId. Ex: eba7e847-d438-4337-81b6-a3b73e218990

  • image string

    Selected image will be used as the base image for the restored instance. Pass the imageId

  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • oci object

    Destination information for the OCI instances to restore

  • ociInstanceInfoList object[]

    List of OCI instances that are to be restored

  • instanceOcid string

    ocid of the source OCI instance

  • instanceName string

    Default value: Defaults to source instance name

    OCI instance name to be set after restore. Required if prefix or suffix is passed otherwise defaults to source instance name.

  • compartmentId string

    Default value: Defaults to source instance compartment

    OCI instance will be restored to the specified OCI compartment.

  • availabilityDomain string

    Default value: Defaults to source instance availability domain.

    OCI availability domain.

  • region string

    Default value: Defaults to source instance region.

    OCI region.

  • instanceShape string

    Default value: Defaults to source instance size

    Instance size to be after restore.

  • createPublicIP boolean

    Default value: false

    Assign a public IP to the restored instance.

  • stagingBucket string

    (Optional parameter). To be set only in case, if the source instance image is either deleted or not exists in the selected region.

  • disks object[]

    OCI instance volumes list

  • volumeName string

    Name of the OCI volume

  • nics object[]

    OCI instance NIC's list

  • networkName string

    network name for the OCI instance

  • vcnId string

    vcn name for the OCI instance

  • subnetId string

    subnet id of the OCI instance

  • privateIpAddress string

    private Ip address of the OCI instance

  • instanceTags object[]

    OCI instance tag list

  • name string
  • value string
  • restoreSourceVMTags boolean

    Default value: true

    Restore source instance tags.

  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • hyperv object

    Destination information for the HyperV VM to restore

  • hyperVVmInfoList object[]

    List of HyperV VMs that are to be restored

  • vmGuid string

    vmGuid of the HyperV VM

  • vmName string

    Default value: Defaults to source VM name

    HyperV VM name to be set after restore. Required if prefix or suffix is passed otherwise defaults to source VM name.

  • datastore string

    (optional)HyperV source VM datastore.

  • destinationHyperVHost string

    Default value: Defaults to source VM host

    The destination HyperV host on which the HyperV VM is to be restored.

  • destinationFolder string

    Default value: Defaults to HyperV default folder for OOP restore and defaults to source VM folder for in-place restore

    The destination folder on which the HyperV VM is to be restored.

  • networkAdapter string

    Default value: Defaults to source VM network adapter if available else 'Not Connected'

    The Network adapter to be used for the restored HyperV VM.

  • disks object[]

    HyperV VM disks list

  • diskName string

    Name of the HyperV VM disk

  • diskDestinationPath string

    Destination path for the HyperV VM disk

  • nics object[]

    HyperV VM NIC's list

  • networkName string

    network name for the HyperV

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • vcloud object

    Destination information for the vCloud VMs to restore

  • vCloudVMInfoList object[]

    List of vCloud VMs that are to be restored

  • sourceVMGuid string

    Source VM GUID.

  • vCloudOrgName string

    Name of the destination vCloud Organisation. Defaults to source VM organistation.

  • orgVDCName string

    Name of the destination vCloud Org VDC. Defaults to source VM org VDC.

  • vAppName string

    Name of the destination vApp. Defaults to source VM vApp.

  • vCloudOwner string

    Name of the owner of the VM. Defaults to source VM owner.

  • esxHost string

    Destination esx host of the VM. Defaults to source VM esx host.

  • storagePolicy string

    Destination Storage Policy GUID of the VM. Defaults to source VM Storage Policy.

  • newName string

    New name of the VM. Defaults to source VM name. Required if namePrefix or nameSuffix is set.

  • isStandAloneRestore boolean

    Default value: false

    If set to true a standalone restore will be performed

  • restoreVappConfig boolean

    Default value: false

    If set to true and it is not a standalone restore, vapp configurations will also be restored

  • addToFailoverCluster boolean

    Default value: false

    If set to true the VM is added to the failover cluster

  • vCloudCatalogName string

    Name of vCloud catalog

  • nics object[]

    vCloud VM network interface list. Defaults to source VM networks.

  • destinationNetwork string

    Name of the destination network

  • sourceNetwork string

    Name of the source network

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • vmware object

    Destination information for the VMware VMs to restore. Not required for Full VM InPlace restore

  • vmwVMInfoList object[]

    List of VMware VMs that are to be restored

  • vmGuid string required

    VMware source VM instance UUID

  • name string

    VMware VM name to be set after restore. Required if prefix or suffix is passed otherwise defaults to source VM name.

  • hostname string

    VMware VM hostname to be set after restore. Defaults to source VM hostname

  • esxHost string

    VMware ESX host Name. Defaults to source VM ESX host name.

  • resourcePool string

    VMware Resource Pool path. Defaults to source VM resource pool path.

  • folder string

    VMware folder path. Defaults to source VM folder path.

  • vmStoragePolicy string

    VMware VM storage policy Name. Defaults to source VM storage policy name.

  • datastore string

    VMware Datastore Name. Defaults to source VM datastore name

  • disks object[]

    VMware VM disks list. Defaults to source VM disks info.

  • name string

    VMware VM disk name

  • datastore string

    VMware Datastore name

  • ipAddressSettings object

    A mapping of IP between the source and the destination VM with an option to configure either a dynamic or a static IP.

  • sourceIP string

    The full IP address or an IP address pattern of the source VM.

  • sourceSubnetMask string

    The subnet mask of the source VM.

  • sourceDefaultGateway string

    The default gateway of the source VM.

  • useDhcp boolean

    Default value: true

    Automatically assigns available IP addresses to be used with the specified destination network.

  • destinationIP string

    The full IP address or an IP address pattern for the destination VM. Provide only if DHCP is not enabled.

  • destinationSubnetMask string

    The subnet mask for the destination VM. Provide only if DHCP is not enabled.

  • destinationDefaultGateway string

    The default gateway for the destination VM. Provide only if DHCP is not enabled.

  • destinationPreferredDNS string

    The preferred DNS server for the destination VM. Provide only if DHCP is not enabled

  • destinationAlternateDNS string

    The alternate DNS server for the destination VM. Provide only if DHCP is not enabled

  • networkSettings object

    VMware VM network interface information

  • sourceNetworkId string

    Source network ID

  • sourceNetworkName string

    Source network name

  • destinationNetworkName string

    Destination network name

  • destinationNetworkDisplayName string

    Name of network to which the restore nic is connected

  • restoreSourceVMTags boolean

    Default value: true

    Restore source VM tags.

  • vmTags object[]

    VMware VM tag list. By default restoreSourceVMTags is true

  • name string
  • value string
  • vmCustomAttributes object[]

    VMware VM custom attribute list

  • name string
  • value string
  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • alibaba object

    Destination information for the Alibaba intances to restore

  • alibabaVMInfoList object[]

    List of Alibaba instances that are to be restored

  • sourceVMGuid string

    Alibaba instance ID

  • name string

    Alibaba instance name to be set after restore. Defaults to source instance name.

  • availabilityZone string

    Alibaba availability zones. Access node must be present in this region

  • instanceType string

    Type of the Alibaba instance

  • nics object[]

    Alibaba instance network interface list

  • name string

    Name of the Alibaba network

  • subnetId string

    Subnet ID of the destination network

  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • xen object

    Destination information for the Xen VMs to restore

  • xenVMInfoList object[]

    List of Xen VMs that are to be restored

  • sourceVMGuid string

    Xen VM ID

  • name string

    Xen VM name to be set after restore. Defaults to source VM name.

  • destinationHost string

    Xen destination host.

  • storageRepository string

    Storage Repository of the Xen VM

  • nics object[]

    Xen VM network interface list

  • sourceNetwork string

    Name of the source network

  • destinationNetwork string

    Name of the destination network

  • sourceNetworkId string

    ID of the source network

  • namePrefix string

    Adds prefix for vm display name

  • nameSuffix string

    Adds suffix for vm display name

  • fusionCompute object

    Destination information for the FusionCompute VMs to restore

  • fusionComputeVMInfoList object[]

    List of Fusion Compute VMs that are to be restored

  • sourceVMGuid string

    FusionCompute VM ID

  • name string

    FusionCompute VM name to be set after restore. Defaults to source VM name.

  • destinationHost string

    Fusion Compute destination hosts.

  • datastore string

    Fusion Compute VM datastore

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • oraclevm object

    Destination information for the Oracle VMs to restore

  • oraclevmInfoList object[]

    List of Oracle VMs that are to be restored

  • sourceVMGuid string

    Oracle VM ID

  • name string

    Oracle VM name to be set after restore. Defaults to source VM name.

  • destinationHypervisor string

    Oracle VM destination hypervisor.

  • repository string

    Repository for the Oracle VM

  • nics object[]

    Oracle VM network interface list

  • sourceNetwork string

    Source network of the Oracle VM. Use * for using any network.

  • destinationNetwork string

    Destination network of the Oracle VM

  • sourceNetworkId string

    ID of the source network.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • azureStackHCI object

    Destination information for the Azure Local VM to restore

  • azureStackHCIVmInfoList object[]

    List of Azure Local VMs that are to be restored

  • vmGuid string

    vmGuid of the Azure Local VM

  • vmName string

    Default value: Defaults to source VM name

    Azure Local VM name to be set after restore. Required if prefix or suffix is passed otherwise defaults to source VM name.

  • datastore string

    (optional)Azure Local source VM datastore.

  • destinationAzureStackHCIHost string

    Default value: Defaults to source VM host

    The destination Azure Local host on which the Azure Local VM is to be restored.

  • destinationFolder string

    Default value: Defaults to Azure Local default folder for OOP restore and defaults to source VM folder for in-place restore

    The destination folder on which the Azure Local VM is to be restored.

  • networkAdapter string

    Default value: Defaults to source VM network adapter if available else 'Not Connected'

    The Network adapter to be used for the restored Azure Local VM.

  • disks object[]

    Azure Local VM disks list

  • diskName string

    Name of the Azure Local VM disk

  • diskDestinationPath string

    Destination path for the Azure Local VM disk

  • nics object[]

    Azure Local VM NIC's list

  • networkName string

    network name for the Azure Local VM

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM 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

  • isAttachToNewVM boolean

    Default value: false

    Flag to set when performing attach disk restore to a new VM.

  • 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.

Responses

Success

Schema
  • taskId int32
  • jobIds string[]

    JobIds for the immediate run request

Loading...