Skip to main content

VMGroup Restore Operation​

Select

SaaS
Customer Managed

To restore the virtual machines in vmgroup

Path Parameters
  • VmGroupId int32 required

    Id of the VMgroup 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.

  • 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. Defaults to source VM name.

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

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

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

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

Responses

Success

Schema
  • taskId int32
  • jobIds string[]

    JobIds for the immediate run request

POST /v4/vmgroup/:vmgroupid/restore

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
VmGroupId — path required
mediaAgentName — query
mediaAgentId — query
fromTime — query
toTime — query
Body
{

  "powerOnVmAfterRestore": false,

  "overwriteVM": false,

  "inPlaceRestore": false,

  "backupSource": 2,

  "destination": {

    "id": 0,

    "name": "string"

  },

  "accessNode": {

    "id": 0,

    "name": "string"

  },

  "accessNodeGroup": {

    "id": 0,

    "name": "string"

  },

  "vmDestinationInfo": {

    "googleCloud": {

      "googleCloudVMInfoList": [

        {

          "instanceId": "123456789123456",

          "name": "Defaults to source VM name",

          "projectId": "string",

          "zone": "asia-east1-a",

          "region": "asia-east1",

          "machineType": "c2d-highmem-8",

          "createPublicIP": false,

          "networkInterfaces": [

            {

              "name": "nic0",

              "networkName": "default",

              "subnetId": "Defaults to source subnet",

              "networkId": "Defaults to source network self-link.",

              "internalIP": "198.51.100.42",

              "externalIP": "198.51.100.42"

            }

          ],

          "customMetadata": [

            {

              "name": "string",

              "value": "string"

            }

          ],

          "nodeAffinities": [

            {

              "name": "string",

              "value": "string"

            }

          ],

          "serviceAccount": {

            "id": "string",

            "name": "string",

            "email": "string"

          },

          "encryptionKey": "kmsKeyName:projects/projectName/locations/global/keyRings/enc-key/cryptoKeys/enc-key-name",

          "keyProtectionLevel": "SOFTWARE"

        }

      ],

      "namePrefix": "string",

      "nameSuffix": "string"

    },

    "azure": {

      "azureVMInfoList": [

        {

          "sourceVMGuid": "c1231de123-4309-41be-123123-123abc123",

          "name": "Defaults to source VM name",

          "resourceGroup": "Defaults to source VM resource group name",

          "region": "For azure region (West US 3) the region value will be westus3",

          "availabilityZone": "Defaults to Auto",

          "storageAccount": "Defaults to source storage account",

          "vmSize": "Standard_A1",

          "diskType": "Standard_LRS",

          "createPublicIP": false,

          "restoreAsManagedVM": true,

          "securityGroupId": "Defaults to source configuration",

          "diskEncryptionSetTypeId": "string",

          "diskEncryptionSetId": "string",

          "nics": [

            {

              "networkId": "string",

              "subnetId": "string",

              "privateIpAddress": "198.51.100.42",

              "publicIpAddress": "198.51.100.42",

              "publicIpAddressId": "string"

            }

          ],

          "vmTags": [

            {

              "name": "string",

              "value": "string"

            }

          ],

          "restoreSourceVMTags": true

        }

      ],

      "namePrefix": "string",

      "nameSuffix": "string"

    },

    "aws": {

      "awsInstanceInfoList": [

        {

          "instanceId": "i-0f90bef70bd90c9e0",

          "instanceName": "Defaults to source instance name",

          "zone": "Defaults to source instance availability zone.",

          "region": "string",

          "instanceSize": "t2.micro",

          "volumeType": "string",

          "encryptionKey": {

            "isEncrypted": true,

            "encryptionKey": "string",

            "diskEncryptionSetId": "string",

            "diskEncryptionSetTypeId": "string"

          },

          "nics": [

            {

              "vpcId": "string",

              "networkName": "string",

              "subnetId": "string",

              "eniId": "string"

            }

          ],

          "securityGroups": [

            {

              "groupId": "string",

              "groupName": "string"

            }

          ],

          "vmTags": [

            {

              "name": "string",

              "value": "string"

            }

          ],

          "restoreSourceVMTags": true,

          "keyPairs": [

            {

              "keyId": "string",

              "keyName": "string"

            }

          ],

          "restoreSourceNetworkConfig": true

        }

      ],

      "namePrefix": "string",

      "nameSuffix": "string"

    }

  },

  "transportMode": "Auto",

  "restoreFlavour": "NONE",

  "notifyOnJobCompletion": false,

  "reuseVMClient": true

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId/restore' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "powerOnVmAfterRestore": false,
  "overwriteVM": false,
  "inPlaceRestore": false,
  "backupSource": 2,
  "destination": {
    "id": 0,
    "name": "string"
  },
  "accessNode": {
    "id": 0,
    "name": "string"
  },
  "accessNodeGroup": {
    "id": 0,
    "name": "string"
  },
  "vmDestinationInfo": {
    "googleCloud": {
      "googleCloudVMInfoList": [
        {
          "instanceId": "123456789123456",
          "name": "Defaults to source VM name",
          "projectId": "string",
          "zone": "asia-east1-a",
          "region": "asia-east1",
          "machineType": "c2d-highmem-8",
          "createPublicIP": false,
          "networkInterfaces": [
            {
              "name": "nic0",
              "networkName": "default",
              "subnetId": "Defaults to source subnet",
              "networkId": "Defaults to source network self-link.",
              "internalIP": "198.51.100.42",
              "externalIP": "198.51.100.42"
            }
          ],
          "customMetadata": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "nodeAffinities": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "serviceAccount": {
            "id": "string",
            "name": "string",
            "email": "string"
          },
          "encryptionKey": "kmsKeyName:projects/projectName/locations/global/keyRings/enc-key/cryptoKeys/enc-key-name",
          "keyProtectionLevel": "SOFTWARE"
        }
      ],
      "namePrefix": "string",
      "nameSuffix": "string"
    },
    "azure": {
      "azureVMInfoList": [
        {
          "sourceVMGuid": "c1231de123-4309-41be-123123-123abc123",
          "name": "Defaults to source VM name",
          "resourceGroup": "Defaults to source VM resource group name",
          "region": "For azure region (West US 3) the region value will be westus3",
          "availabilityZone": "Defaults to Auto",
          "storageAccount": "Defaults to source storage account",
          "vmSize": "Standard_A1",
          "diskType": "Standard_LRS",
          "createPublicIP": false,
          "restoreAsManagedVM": true,
          "securityGroupId": "Defaults to source configuration",
          "diskEncryptionSetTypeId": "string",
          "diskEncryptionSetId": "string",
          "nics": [
            {
              "networkId": "string",
              "subnetId": "string",
              "privateIpAddress": "198.51.100.42",
              "publicIpAddress": "198.51.100.42",
              "publicIpAddressId": "string"
            }
          ],
          "vmTags": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "restoreSourceVMTags": true
        }
      ],
      "namePrefix": "string",
      "nameSuffix": "string"
    },
    "aws": {
      "awsInstanceInfoList": [
        {
          "instanceId": "i-0f90bef70bd90c9e0",
          "instanceName": "Defaults to source instance name",
          "zone": "Defaults to source instance availability zone.",
          "region": "string",
          "instanceSize": "t2.micro",
          "volumeType": "string",
          "encryptionKey": {
            "isEncrypted": true,
            "encryptionKey": "string",
            "diskEncryptionSetId": "string",
            "diskEncryptionSetTypeId": "string"
          },
          "nics": [
            {
              "vpcId": "string",
              "networkName": "string",
              "subnetId": "string",
              "eniId": "string"
            }
          ],
          "securityGroups": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "vmTags": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "restoreSourceVMTags": true,
          "keyPairs": [
            {
              "keyId": "string",
              "keyName": "string"
            }
          ],
          "restoreSourceNetworkConfig": true
        }
      ],
      "namePrefix": "string",
      "nameSuffix": "string"
    }
  },
  "transportMode": "Auto",
  "restoreFlavour": "NONE",
  "notifyOnJobCompletion": false,
  "reuseVMClient": true
}'