Skip to main content

Get the details of a recovery entity​

Get the details of a recovery entity

Path Parameters
  • recoveryEntityId integer required

    Recovery entity Id

Responses

OK

Schema
  • id int32

    Id of the recovery entity

  • name string

    Name of the recovery entity

  • entity object
  • id int32
  • name string
  • recoveryGroup object
  • id int32
  • name string
  • workload string

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE, PHYSICAL_SERVER, GOOGLE_CLOUD_PLATFORM, ACTIVE_DIRECTORY_FOREST]

  • client object
  • id int32
  • name string
  • backupSet object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • virtualMachine object
  • GUID string
  • name string
  • subclient object
  • id int32
  • name string
  • recoveryConfiguration object
  • advancedOptions object
  • azure object

    Advanced options for Azure replication group

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • deployVmOnlyDuringfailover boolean

    Default value: true

    Select this option to deploy a VM only when a failover operation is requested

  • amazon object

    Advanced options for Amazon replication group

  • validateDestinationVM boolean

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • deployVmWhenFailover boolean

    If true, the destination VM will be created during failover operation

  • continueOnFailure boolean

    If true, the operation will continue for the remaining VMs even if the failover operation fails for the current VM

  • failoverDelay int32

    The delay (in minutes) between performing operations on entities of different priorities

  • transportMode string

    Possible values: [AUTO, SAN, HOT_ADD, NAS, NBD_SSL, NBD]

    Default value: AUTO

    transport mode based on environment. Values are case sensitive

  • gcp object

    Advanced options for GCP replication group

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • failoverDelay int32

    The delay (in minutes) between performing operations on entities of different priorities

  • continueOnFailure boolean

    If true, the operation will continue for the remaining VMs even if the failover operation fails for the current VM

  • vmw object

    Advanced options for VMWare replication group

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • diskProvisioning string

    Possible values: [Auto, Thick, Thin, ThickEagerZero]

    Default value: Auto

    Select the disk provisioning type for the destination VM. The values are case sensitive.

  • transportMode string

    Possible values: [Auto, SAN, Hot_Add, NAS, NBD_SSL, NBD]

    Default value: Auto

    Choose transport mode based on environment. Values are case sensitive

  • unconditionalOverwrite boolean

    Default value: false

    Replace an existing virtual machine with the same name in the target location

  • SnapshotsToRetain int32

    Number of snapshots to retain on destination VM

  • hyperV object

    Advanced options for HyperV replication group

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • nutanix object

    Advanced options for Nutanix as a destination vendor

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • oci object

    The advanced option for replication group

  • delayBetweenPriorityMachines int32

    Default value: 2

    The delay between machines in different priorities. Mention in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure.

  • script object

    Pre/post failover and failback scripts at group level

  • preFailover object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postFailover object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • preFailback object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postFailback object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • openStack object

    Advanced options for OpenStack as a destination vendor

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • configuration object
  • azure object

    Replication configuration for Azure

  • sourceVM string

    Source VM

  • destinationVM string

    Destination VM

  • resourceGroup string

    Resource group in which the converted virtual machine should be created.

  • storageAccount string

    Azure Standard or Premium general-purpose storage account.

  • extensionRestorePolicy string

    Possible values: [DEFAULT, DO_NOT_RESTORE, RESTORE, RESTORE_BUT_IGNORE_FAILURES]

  • vmSize string

    VM size

  • createPublicIP boolean

    Create a public IP.

  • restoreAsManagedVm boolean

    Restore the VM as a managed disk for the destination VMs.

  • overrideReplicationOptions object

    Replication options for Azure

  • availabilityZone string

    VM availability zone

  • securityGroup object

    The id and the name of the security group

  • id string

    Security group id

  • name string

    security group name

  • testFailoverVirtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • privateIPaddress string

    Private IP address of the network

  • publicIPAddress string

    Public IP address of the network

  • publicIPaddressID string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • virtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • privateIPaddress string

    Private IP address of the network

  • publicIPAddress string

    Public IP address of the network

  • publicIPaddressID string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • diskType string

    Type of the disk

  • sourceVMGuid string

    GUID of the source VM

  • region string

    region of the VM

  • testFailoverVmSize string

    Vm size to be used during the test failover operation

  • amazon object

    Replication configuration for Amazon

  • sourceVM string

    Source instance

  • sourceVMGuid string

    GUID of the source VM

  • destinationVM string

    Destination instance

  • datacenter string

    Destination data center

  • availabilityZone string

    Destination availability zone

  • instanceType string

    Provides the available CPU cores and memory for the instance.

  • testFailoverInstanceType string

    Provides the available CPU cores and memory for the test failover instances

  • overrideReplicationOptions object

    Replication options for Amazon

  • IAMRole object
  • guid string
  • name string
  • volumeType string

    Type of volume used for replication

  • keyPair string

    Name of the key pair that is used to login to the VM

  • encryptionKey string

    Encryption key if used

  • guestCreds object

    Guest Credentials

  • computerName string

    The name of the computer

  • userName string

    user name of the computer

  • password string

    password for the user

  • network object

    Network interface for the destination instances

  • displayName string

    Network display name

  • name string

    Name of network

  • subnetId string

    subnet id of network

  • sourceNetworkId string

    VPC Id of the network

  • privateIPaddress string

    Private IP address of the network

  • autoSelectSecurityGroup boolean

    Automatically select the security groups for the destination instances

  • securityGroups object[]

    Select the security groups for the destination instances

  • id string

    Security group id

  • name string

    security group name

  • testFailoverNetwork object

    Network interface for the destination instances

  • displayName string

    Network display name

  • name string

    Name of network

  • subnetId string

    subnet id of network

  • sourceNetworkId string

    VPC Id of the network

  • privateIPaddress string

    Private IP address of the network

  • autoSelectTestFailoverSecurityGroup boolean

    Automatically select the security groups for the test failover instances

  • testFailoverSecurityGroups object[]

    Select the security groups for the test failover instances

  • id string

    Security group id

  • name string

    security group name

  • logBucket object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • gcp object

    Model to store configuration per VM

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • primaryZone string

    Primary zone of the destination VM instance

  • datacenter string

    Datacenter of the destination VM instance

  • projectId string

    Gcp project id

  • createPublicIP boolean

    Public/External IP of the destination VM instance

  • machineType string

    Destination VM instance machine type

  • secondaryZone string

    Secondary zone of the destination VM instance

  • overrideReplicationOptions object

    Extended instance configuration options

  • tags object[]
  • name string
  • value string
  • vmNodeAffinity object[]
  • name string
  • value string
  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • publicIPaddress string

    Public IP address of the network

  • publicIPaddressID string

    Public IP address ID of the network

  • privateIPaddress string

    Private IP address of the network

  • privateIPType string

    Possible values: [AUTOMATIC, STATIC, RESERVED_STATIC]

    IP type of the network

  • vmw object

    Replication configuration for VMware

  • sourceVM string

    The source VM

  • sourceVMGuid string

    The guid of the source VM

  • destinationVM string

    The replicated VM

  • destinationHost string

    Destination hypervisor

  • cluster string

    Cluster name

  • datastore string

    Select a datastore to be used for virtual machine disks

  • dataStoreClusterName string

    The name of datastore cluster

  • vmStoragePolicy object
  • id int32
  • GUID string
  • name string
  • resourcePool string

    Select a resource pool for the destination VM

  • vmFolder string

    VM folder option

  • overrideReplicationOptions object

    Replication options for VMware

  • vmDisplayName string

    Enter the display name for the destination VM

  • hostname string

    Enter the hostname for the destination VM

  • destinationHost string

    Host for the destination VM

  • datastore string

    Select a datastore to be used for virtual machine disks

  • resourcePool string

    Select a resource pool for the destination VM

  • vmFolder string

    VM folder replication

  • networkSettings object[]

    Mapping between a source network and a destination network

  • source string

    Source network name

  • sourceId string

    Source network ID

  • destination string

    Destination network name

  • ipAddressSettings object[]

    Customize IP address settings

  • sourceIp string

    Source IP

  • subnetMask string

    Subnet mask

  • defaultGateway string

    Default gateway

  • useDhcp boolean

    Use DHCP

  • hostName string

    Hostname

  • destinationIp string

    Destination IP

  • SubnetMaskNoDhcp string

    Subnet mask when dhcp is not selected

  • defaultGatewayNoDhcp string

    Defaault gateway when dhcp is not selected

  • primaryDNSNoDhcp string

    Primary DNS when dhcp is not selected

  • alternateDNSNoDhcp string

    Alternate DNS when dhcp is not selected

  • hyperV object

    Replication configuration for HyperV

  • sourceVM string

    Source VM

  • destinationVM string

    Destination VM

  • hypervHost string

    Hypervisor

  • destinationVolume string

    Destination volume for hyperV

  • overrideReplicationOptions object

    Replication options for HyperV

  • vmDisplayName string

    Display name for the destination VM

  • registerVMWithFailoverCluster string

    Register replicated virtual machines to the failover cluster for the destination client.

  • networkAdapter object[]

    Select a network interface from the Network adapter list

  • networkName string

    Name of network

  • nutanix object

    Model to store configuration per VM for Nutanix vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • oci object

    Model to store configuration per VM for OCI vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • availabilityDomain string

    Destination VM instance availability domain

  • stagingBucket string

    Staged bucket name for restore operation

  • region string

    Instance region

  • createPublicIP boolean

    Public/External IP of the destination VM instance

  • shape string

    Destination VM instance shape

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • compartment object
  • name string
  • value string
  • openStack object

    Model to store configuration per VM for OpenStack vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • recoveryDestinationInfo object

    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.

  • targetInstanceId string

    Instance ID to which the disks are to be attached. Only used during attach disk restore.

  • name string

    Default value: Defaults to source VM name

    The new name of the instance after restore. Pass the target Instance name in case of attach disk 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

  • secondaryZone string

    Default value: Defaults to source instance zone after restore. For reference: cloud.google.com/compute/docs/regions-zones#available'

    GCP Secondary Zone. Applies only to the instances that are configured to use regional persistent disks. Ex: asia-east1-a.

  • 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

  • templateId string

    This is the GCP template image that is to be used for creating the new VM.

  • 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

  • attachAndSwapOSDisk boolean

    Default value: false

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

  • 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
  • vmNetworkTags object[]

    GCP VM Network tags

  • name string
  • value string
  • retainSourceVMNetworkTags boolean

    Default value: true

    Retains source VM Network tags.

  • 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
  • accessScopes string[]

    Type and level of API access to grant the VM.

  • 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

    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

  • isOSDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

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

  • extensionRestorePolicy string

    Possible values: [DEFAULT, DO_NOT_RESTORE, RESTORE, RESTORE_BUT_IGNORE_FAILURES]

  • 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

  • keyvaultId string

    Resource ID of the keyvault for keys and secrets

  • nics object[]

    Azure VM network interface list

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • subscriptionId string

    Azure Subscription ID for the restore destination.

  • 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. Pass the target Instance name in case of attach disk restore. Defaults to source instance name.

  • targetInstanceId string

    Instance ID to which the disks are to be attached. Only used during attach disk restore.

  • zone string

    Default value: Defaults to source instance availability zone.

    AWS Availability zone. Defaults to source instance availability zone.

  • region string
  • tenancy string

    Possible values: [default, dedicated, host]

    Tenancy of the instance.

  • hostId string

    The ID of the dedicated host on which the instance should reside. Should be specified if the tenancy is specified as 'host'. If specified, hostResourceGroup should not be specified.

  • hostResourceGroup object

    AWS host resource group info. Should be specified if the tenancy is specified as 'host'. If specified, hostId should not be specified.

  • resourceGroupName string

    The name of the resource group on which the instance should reside.

  • resourceGroupArn string

    The arn of the resource group on which the instance should reside.

  • affinity string

    Possible values: [default, host]

    Affinity setting for the instance on the dedicated host.

  • licenses object[]

    AWS host license list

  • licenseArn string
  • licenseName string
  • instanceSize string

    Default value: Defaults to source instance size

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

  • amiId string

    AMI to be used for creating the restored instance. By default, AMI will be picked based on the properties of source VM.

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

  • restoreSourceVolumeTags boolean

    Default value: true

    Restore source volume 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

  • osName string

    VM OS Name

  • guestCredential object

    VM guest credentials

  • computerName string
  • credentialId int32
  • 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

  • nutanixPrismCentral object

    Destination information for the Nutanix Prism Central VMs to restore

  • nutanixPrismCentralVMInfoList object[]

    List of nutanix prism central VMs that are to be restored

  • vmGuid string

    Nutanix Prism Central VM ID

  • name string

    Nutanix prism central VM name to be set after restore, defaults to source VM name.

  • cluster string

    Destination cluster for nutanix prism central VM, defaults to source VM cluster.

  • storageContainer string

    Destination storage container for nutanix prism central VM. defaults to source VM storage container.

  • nics object[]

    Nutanix prism central VM network interface list

  • uuid string

    UUID of the nutanix prism central Subnet

  • name string

    Name of the nutanix prism central Network

  • displayName string

    Used in GUI. Display name of the network

  • destinationNetwork string

    Name of the destination 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

  • disks object[]

    Openstack VM disk list

  • name string

    Openstack disk name. Ex: 9e9de935-18fd-4b7f-a8a7-b0c09ea79f39

  • Datastore string

    Openstack datastore. Ex: NFS-Host

  • isOsDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

  • 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

  • cloudstack object

    Destination information for the Cloudstack VMs to restore

  • cloudstackVMInfoList object[]

    List of Cloud stack VMs that are to be restored

  • vmGuid string

    Cloudstack VM ID

  • name string

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

  • zone object
  • guid string
  • name string
  • pod object
  • guid string
  • name string
  • cluster object
  • guid string
  • name string
  • host object
  • guid string
  • name string
  • domain object
  • guid string
  • name string
  • ownerType string

    Cloudstack VM owner type. Defaults to source VM owner type.

  • ownerTypeInfo object
  • guid string
  • name string
  • serviceOffering object
  • guid string
  • name string
  • diskOffering object
  • guid string
  • name string
  • template object
  • guid string
  • name string
  • keyPairs object[]

    List of keyPairs

  • keyId string
  • keyName string
  • securityGroups object[]

    Cloudstack VM security group list

  • groupId string
  • groupName string
  • nics object[]

    Cloudstack VM network setting list

  • id string

    Cloudstack nic id. Ex: ed5950fd-cfe7-4c5c-9cd7-cfebacee829d

  • name string

    Cloudstack nic name. Ex: 1

  • networkName string

    Cloudstack network name. Ex: defaultGuestNetwork

  • subnetId string

    Cloudstack subnet id.

  • networkDisplayName string

    Cloudstack network display name. Ex: defaultGuestNetwork

  • subnetMask string

    Cloudstack subnet mask. Ex: 255.255.240.0

  • networkAddress string

    Cloudstack network gateway. Ex: 172.24.31.245

  • disks object[]

    Cloudstack VM disk list

  • name string

    Cloudstack disk name. Ex: 9e9de935-18fd-4b7f-a8a7-b0c09ea79f39

  • Datastore string

    Cloudstack datastore. Ex: NFS-Host

  • isOsDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

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

  • osType object
  • guid string
  • name string
  • ipAddressSettingsList object[]
  • 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

  • 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

    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.

  • storagePolicy object
  • guid string
  • name string
  • datastore string

    VMware Datastore Name. Defaults to source VM datastore name

  • datastoreCluster object
  • guid string
  • name string
  • osType object
  • guid string
  • name string
  • disks object[]

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

  • name string

    VMware VM disk name

  • datastore string

    VMware Datastore name

  • filter boolean

    Default value: false

    Set true to exclude disk from restored VM

  • ipAddressSettingsList object[]
  • 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

  • nics object[]
  • 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
  • vmStoragePolicy string deprecated
  • 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

  • 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

  • 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

  • securityGroups object[]

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

  • groupId string
  • groupName string
  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • redHatVirtulization object

    Destination information for the Rhev VMs to restore

  • rhevVMInfoList object[]

    List of Rhev VMs that are to be restored

  • sourceVMGuid string

    Rhev VM ID

  • name string

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

  • cluster string

    Rhev destination cluster.

  • storageDomain string

    Storage Domain of the Rhev VM

  • nics object[]

    Rhev VM network interface list

  • sourceNetwork string

    Name of the source network

  • destinationNetwork string

    Name of the destination network

  • namePrefix string

    Adds prefix for vm display name

  • nameSuffix string

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

  • datastoreClusterName string

    Fusion Compute VM datastore cluster name.

  • 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

  • proxmox object

    Destination information for the Proxmox VMs to restore

  • proxmoxVMInfoList object[]

    List of Proxmox VMs that are to be restored

  • sourceVMGuid string

    Proxmox VM ID

  • newName string

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

  • node string

    Proxmox destination node.

  • storage string

    storage of Proxmox VM

  • disks object[]

    Proxmox VM disks list

  • name string

    Name of the Proxmox VM disk

  • storage string

    Storage for the Proxmox VM disk

  • nics object[]

    Proxmox VM NIC's list

  • sourceNetwork string

    Source network of the Proxmox VM.

  • destinationNetwork string

    Destination network of the Proxmox VM.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • morpheus object

    Destination information for the Morpheus VMs to restore

  • MorpheusVMInfoList object[]

    List of Morpheus VMs that are to be restored

  • sourceVMGuid string

    Morpheus VM GUID

  • vmName string

    Morpheus VM name.

  • newName string

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

  • cloud string

    Morpheus cloud where VM will be restored.

  • cluster string

    Morpheus cluster where VM will be restored.

  • host string

    Morpheus host where VM will be restored.

  • storage string

    storage of Morpheus VM

  • servicePlanCode string

    Morpheus service plan code to be used for restore. If not specified, default service plan will be used.

  • disks object[]

    Morpheus VM disks list

  • name string

    Name of the Morpheus VM disk

  • storage string

    Storage for the Morpheus VM disk

  • nics object[]

    Morpheus VM NIC's list

  • sourceNetwork string

    Source network of the Morpheus VM.

  • destinationNetwork string

    Destination network of the Morpheus VM.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • azureStackHub object

    Destination information for the AzureStackHub VMs to restore

  • azureStackHubVMInfoList object[]

    List of AzureStackHub VMs that are to be restored

  • sourceVMGuid string

    AzureStackHub VM guid

  • name string

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

  • resourceGroup string

    AzureStackHub resource group.

  • region string

    AzureStackHub region.

  • storageAccount string

    AzureStackHub storage account.

  • vmSize string

    AzureStackHub vm size.

  • restoreAsManagedVM boolean

    Default value: true

    AzureStackHub option for restore as managed VM.

  • securityGroupId string

    Default value: Defaults to source configuration

    AzureStackHub security group to be set for the VM. Defaults to source configuration. Set the full security group URL from the portal.

  • storageType string

    AzureStackHub storage type. Keep the field empty to use source VM's storage type.

  • createPublicIP boolean

    Default value: true

    Assign a public IP to the restored instance.

  • nics object[]

    AzureStackHub VM network interface list

  • networkName string

    Name of the selected network

  • subnetId string

    subnet Id

  • namePrefix string

    Adds prefix for vm display name

  • nameSuffix string

    Adds suffix for vm display name

  • dbConfig object
  • server object
  • id int32
  • name string
  • instance object
  • id int32
  • name string
  • databases object[]
  • id int64

    ID of the source database

  • sourceName string

    Name of the source database

  • destinationName string

    Name of the destination database

  • fileMappings object[]
  • source object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • destination object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • imageDetails object
  • vmCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • vmTemplate object
  • GUID string
  • name string
  • skipOSDisk boolean

    Default value: false

    Determine if OS disk should be attached to new VM during the disk attach restore

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • mediaAgent object
  • id int32
  • name string
  • copyPrecedence int32

    Copy precedence for the copy used for the restore

  • hardwareConfiguration object
  • dataDiskConfiguration object[]
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • volumeConfiguration object[]
  • name string

    Name of the volume

  • totalSize int64

    Size for volume in bytes

  • enabled boolean

    Determine if volume is enabled or not

  • disks object[]
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • systemDiskConfiguration object
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • credentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • instance object
  • id int32
  • name string
  • preRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • defaultWorkloadValidations object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • target object
  • id int32
  • name string
  • recoveryPointDetails object

    Contains the information regarding the recovery entity level recoveryPoint selection

  • recoveryPointForLastRecoveryJob int32

    Default value: -1

    Timestamp that was set for the last recovery job that was ran for this entity. If no job ran, this value will be -1

  • entityRecoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • entityRecoveryPointCategory string

    Possible values: [LATEST, POINT_IN_TIME, AUTOMATIC]

    Default value: LATEST

    Type of recovery point category

  • inheritedFrom string

    Possible values: [RECOVERY_GROUP, RECOVERY_ENTITY]

    Default value: RECOVERY_GROUP

    Describes from where the recovery point is inherited from. If not provided, recovery point will be used as if it is set at recovery group level

  • timeZoneId int32

    TimeZone Id of the CS

  • recoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • executionOrder object
  • priority int32

    Decides the priority of group execution

  • order int32

    Decides the priority of entites within a group

  • group int32

    Group ID to group similar entities together

  • connectionDetails object
  • guestCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • csCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • topologyDetails object
  • serverGroups object[]
  • id int32
  • name string
  • networkGateway object[]
  • hostname string

    Gateway machine hostname

  • port int32

    Possible values: >= 1 and <= 65535

  • vmHostName string

    VM host name

  • vmClientName string

    VM client name

  • domainCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • blockSysrepForRecovery boolean
  • restoreEligibility object
  • isEligible boolean
  • ineligibleReason string
  • restoreStatus object
  • jobStatus string

    Possible values: [SUCCESS = 0, FAILURE = 1, RUNNING = 2, COMPLETED_WITH_ERRORS = 4, SKIPPED = 8, KILLED = 16, SUSPENDED = 32, PENDING = 64, NOT_STARTED = 128, INVALID = 256, NOT_APPLICABLE = 512, MARKED_AS_FAILED = 1024]

  • failureReason string
  • lastJobId int32
  • copyAvailableTime int32
  • lastFullBackupTime int32
  • restoredVMState VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • cleanupEligibility object
  • isEligible boolean
  • ineligibleReason string
  • cleanupStatus object
  • jobStatus string

    Possible values: [SUCCESS = 0, FAILURE = 1, RUNNING = 2, COMPLETED_WITH_ERRORS = 4, SKIPPED = 8, KILLED = 16, SUSPENDED = 32, PENDING = 64, NOT_STARTED = 128, INVALID = 256, NOT_APPLICABLE = 512, MARKED_AS_FAILED = 1024]

  • failureReason string
  • lastJobId int32
  • recoveryStatus string

    Possible values: [NO_STATUS, NOT_READY, READY, RECOVERED, FAILED, RECOVERED_WITH_ERRORS, IN_PROGRESS, CLEANED_UP, MARK_AS_FAILED, CLEANUP_FAILED, RECOVERED_WITH_THREATS, WAITING]

    Status of recovery entity

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • validationResults object[]
  • type string

    Possible values: [THREAT_SCAN, WINDOWS_DEFENDER, DEFAULT_VALIDATION, CUSTOM_RUNBOOK_VALIDATION, CUSTOM_RESOURCE_VALIDATION]

    Validation status of recovery entity

  • customValidationGuid string
  • output string

    Output of the script executed

  • name string

    Name of the script executed

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • failureReason string

    Script validation failure reason

  • threatInfo object[]
  • count int32

    The number of threats found per threat type

  • threatType string

    The name of the threat

  • recoveryFailureReason string

    Reason for last recovery job failure

  • validationFailureReason string

    Reason for last validation failure

  • recoveryStatusNotReadyReason string

    Recovery status not ready reason

  • recoveryStatusNotReadyCategory string

    Possible values: [NONE = 0, INVALID_VM_NAME = 1, INVALID_COPY = 2, MARK_AS_FAILED = 4, INVALID_SMART_FOLDER = 8, LAST_BACKUP_OUTDATED = 32, LAST_BACKUP_NOT_READY = 64, MANAGED_IDENTITY_ENABLED = 128, AUTOSCALING_DISABLED = 256, ENABLE_AUTOSCALING_FOR_THREATSCAN = 512, PRIMARY_ASSET_COPIES_NOT_AVAILABLE = 1024, PARENT_ENTITY_NOT_REGISTERED = 262144]

    Recovery status not ready category

  • recoveryReadinessStatus string

    Possible values: [NONE = 0, READY = 1, PARTIAL_READY = 2, NOT_READY = 3, OUTDATED = 4]

    Recovery readiness status

  • recoveryStatusPartialReadyCategory string

    Possible values: [NONE = 0, SECONDARY_ASSET_COPIES_NOT_AVAILABLE = 1, GATEWAY_OR_NETWORK_TOPOLOGY_NOT_AVAILABLE = 2]

    Recovery status partial ready category

  • recoveryStatusPartialReadyReason string

    Recovery status partial ready reason

  • lastRecoveryJobId int32

    Last recovery job Id of the entity

  • lastRestoreJobId int32

    Last restore job Id of the entity

  • lastSuccessfulRestoreJobId int32

    Last successful restore job Id of the entity

  • lastSuccessfulRecoveryJobId int32

    Last successful recovery job Id of the entity

  • lastRunbookInstanceId int32

    Latest runbook insatnce Id of the entity

  • lastSuccessfulRunbookInstanceId int32

    Latest successful runbook insatnce Id of the entity

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • copyAvailableTime int32

    Timestamp of the latest backup job start time present in the copy that would be used for recovery. Value would be -1 if no valid copy is present for recovery.

  • lastFullBackupTime int32

    Last available full backup job start time present in the copy in UNIX timestamp format. Value would be -1 if no valid copy is present.

  • installedWorkloads string[]

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE, PHYSICAL_SERVER, GOOGLE_CLOUD_PLATFORM, ACTIVE_DIRECTORY_FOREST]

  • sourceVendor string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

  • fileShare object
  • name string

    Name of Azure File Share

  • protocol EnabledProtocol

    Possible values: [SMB, NFS]

    Protocol of file share

  • shareURL string

    URL of File Share

  • adForestRunbookInfo object
  • adForest object
  • id int32
  • name string
  • runbookInfo object
  • id int32
  • name string
  • recoveredVMState VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • destinationVirtualMachine object
  • GUID string
  • name string
  • destinationName string

    Name of the recovered entity

  • threatScan object
  • status CRRThreatScanStatus

    Possible values: [NONE, NOT_ENABLED, ENABLED, NOT_RUN, RUNNING, RUN_FAILED, COMPLETED, THREAT_FOUND]

  • vmConnectionInfo object
  • resourceGroupName string

    Name of resource group

  • subscriptionId string

    Subscription ID

  • url string

    URL for bastionHost/SSM

  • hasRecoverySubEntities boolean

    Default value: false

    Set to false if there are no subEntities associated with the parent recovery entity

  • skipRecovery boolean

    Default value: false

    Set to true if the recovery of the entity is skipped

  • resetRepaveOption boolean

    Whether repave entites have to be reset during target updation

  • resetStaticIPAddress boolean

    Whether we have to reset existing IP Address during target updation

  • guestCredential object
  • id int32
  • name string
  • appTypeId int32

    The application type id of the source

  • subEntities object[]
  • id int32

    Id of the recovery entity

  • name string

    Name of the recovery entity

  • entity object
  • id int32
  • name string
  • recoveryGroup object
  • id int32
  • name string
  • workload string

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE, PHYSICAL_SERVER, GOOGLE_CLOUD_PLATFORM, ACTIVE_DIRECTORY_FOREST]

  • client object
  • id int32
  • name string
  • backupSet object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • virtualMachine object
  • GUID string
  • name string
  • subclient object
  • id int32
  • name string
  • recoveryConfiguration object
  • advancedOptions object
  • azure object

    Advanced options for Azure replication group

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • deployVmOnlyDuringfailover boolean

    Default value: true

    Select this option to deploy a VM only when a failover operation is requested

  • amazon object

    Advanced options for Amazon replication group

  • validateDestinationVM boolean

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • deployVmWhenFailover boolean

    If true, the destination VM will be created during failover operation

  • continueOnFailure boolean

    If true, the operation will continue for the remaining VMs even if the failover operation fails for the current VM

  • failoverDelay int32

    The delay (in minutes) between performing operations on entities of different priorities

  • transportMode string

    Possible values: [AUTO, SAN, HOT_ADD, NAS, NBD_SSL, NBD]

    Default value: AUTO

    transport mode based on environment. Values are case sensitive

  • gcp object

    Advanced options for GCP replication group

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • failoverDelay int32

    The delay (in minutes) between performing operations on entities of different priorities

  • continueOnFailure boolean

    If true, the operation will continue for the remaining VMs even if the failover operation fails for the current VM

  • vmw object

    Advanced options for VMWare replication group

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • diskProvisioning string

    Possible values: [Auto, Thick, Thin, ThickEagerZero]

    Default value: Auto

    Select the disk provisioning type for the destination VM. The values are case sensitive.

  • transportMode string

    Possible values: [Auto, SAN, Hot_Add, NAS, NBD_SSL, NBD]

    Default value: Auto

    Choose transport mode based on environment. Values are case sensitive

  • unconditionalOverwrite boolean

    Default value: false

    Replace an existing virtual machine with the same name in the target location

  • SnapshotsToRetain int32

    Number of snapshots to retain on destination VM

  • hyperV object

    Advanced options for HyperV replication group

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • nutanix object

    Advanced options for Nutanix as a destination vendor

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • oci object

    The advanced option for replication group

  • delayBetweenPriorityMachines int32

    Default value: 2

    The delay between machines in different priorities. Mention in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure.

  • script object

    Pre/post failover and failback scripts at group level

  • preFailover object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postFailover object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • preFailback object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postFailback object

    DR operation scripting information

  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • unconditionalOverwrite boolean

    This will replace the instance at the destination if the instance with the same name already exists.

  • openStack object

    Advanced options for OpenStack as a destination vendor

  • validateDestinationVM boolean

    Default value: true

    Validates that the destination VM is bootable by powering it on and then powering off

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • configuration object
  • azure object

    Replication configuration for Azure

  • sourceVM string

    Source VM

  • destinationVM string

    Destination VM

  • resourceGroup string

    Resource group in which the converted virtual machine should be created.

  • storageAccount string

    Azure Standard or Premium general-purpose storage account.

  • extensionRestorePolicy string

    Possible values: [DEFAULT, DO_NOT_RESTORE, RESTORE, RESTORE_BUT_IGNORE_FAILURES]

  • vmSize string

    VM size

  • createPublicIP boolean

    Create a public IP.

  • restoreAsManagedVm boolean

    Restore the VM as a managed disk for the destination VMs.

  • overrideReplicationOptions object

    Replication options for Azure

  • availabilityZone string

    VM availability zone

  • securityGroup object

    The id and the name of the security group

  • id string

    Security group id

  • name string

    security group name

  • testFailoverVirtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • privateIPaddress string

    Private IP address of the network

  • publicIPAddress string

    Public IP address of the network

  • publicIPaddressID string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • virtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • privateIPaddress string

    Private IP address of the network

  • publicIPAddress string

    Public IP address of the network

  • publicIPaddressID string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • diskType string

    Type of the disk

  • sourceVMGuid string

    GUID of the source VM

  • region string

    region of the VM

  • testFailoverVmSize string

    Vm size to be used during the test failover operation

  • amazon object

    Replication configuration for Amazon

  • sourceVM string

    Source instance

  • sourceVMGuid string

    GUID of the source VM

  • destinationVM string

    Destination instance

  • datacenter string

    Destination data center

  • availabilityZone string

    Destination availability zone

  • instanceType string

    Provides the available CPU cores and memory for the instance.

  • testFailoverInstanceType string

    Provides the available CPU cores and memory for the test failover instances

  • overrideReplicationOptions object

    Replication options for Amazon

  • IAMRole object
  • guid string
  • name string
  • volumeType string

    Type of volume used for replication

  • keyPair string

    Name of the key pair that is used to login to the VM

  • encryptionKey string

    Encryption key if used

  • guestCreds object

    Guest Credentials

  • computerName string

    The name of the computer

  • userName string

    user name of the computer

  • password string

    password for the user

  • network object

    Network interface for the destination instances

  • displayName string

    Network display name

  • name string

    Name of network

  • subnetId string

    subnet id of network

  • sourceNetworkId string

    VPC Id of the network

  • privateIPaddress string

    Private IP address of the network

  • autoSelectSecurityGroup boolean

    Automatically select the security groups for the destination instances

  • securityGroups object[]

    Select the security groups for the destination instances

  • id string

    Security group id

  • name string

    security group name

  • testFailoverNetwork object

    Network interface for the destination instances

  • displayName string

    Network display name

  • name string

    Name of network

  • subnetId string

    subnet id of network

  • sourceNetworkId string

    VPC Id of the network

  • privateIPaddress string

    Private IP address of the network

  • autoSelectTestFailoverSecurityGroup boolean

    Automatically select the security groups for the test failover instances

  • testFailoverSecurityGroups object[]

    Select the security groups for the test failover instances

  • id string

    Security group id

  • name string

    security group name

  • logBucket object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • gcp object

    Model to store configuration per VM

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • primaryZone string

    Primary zone of the destination VM instance

  • datacenter string

    Datacenter of the destination VM instance

  • projectId string

    Gcp project id

  • createPublicIP boolean

    Public/External IP of the destination VM instance

  • machineType string

    Destination VM instance machine type

  • secondaryZone string

    Secondary zone of the destination VM instance

  • overrideReplicationOptions object

    Extended instance configuration options

  • tags object[]
  • name string
  • value string
  • vmNodeAffinity object[]
  • name string
  • value string
  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • publicIPaddress string

    Public IP address of the network

  • publicIPaddressID string

    Public IP address ID of the network

  • privateIPaddress string

    Private IP address of the network

  • privateIPType string

    Possible values: [AUTOMATIC, STATIC, RESERVED_STATIC]

    IP type of the network

  • vmw object

    Replication configuration for VMware

  • sourceVM string

    The source VM

  • sourceVMGuid string

    The guid of the source VM

  • destinationVM string

    The replicated VM

  • destinationHost string

    Destination hypervisor

  • cluster string

    Cluster name

  • datastore string

    Select a datastore to be used for virtual machine disks

  • dataStoreClusterName string

    The name of datastore cluster

  • vmStoragePolicy object
  • id int32
  • GUID string
  • name string
  • resourcePool string

    Select a resource pool for the destination VM

  • vmFolder string

    VM folder option

  • overrideReplicationOptions object

    Replication options for VMware

  • vmDisplayName string

    Enter the display name for the destination VM

  • hostname string

    Enter the hostname for the destination VM

  • destinationHost string

    Host for the destination VM

  • datastore string

    Select a datastore to be used for virtual machine disks

  • resourcePool string

    Select a resource pool for the destination VM

  • vmFolder string

    VM folder replication

  • networkSettings object[]

    Mapping between a source network and a destination network

  • source string

    Source network name

  • sourceId string

    Source network ID

  • destination string

    Destination network name

  • ipAddressSettings object[]

    Customize IP address settings

  • sourceIp string

    Source IP

  • subnetMask string

    Subnet mask

  • defaultGateway string

    Default gateway

  • useDhcp boolean

    Use DHCP

  • hostName string

    Hostname

  • destinationIp string

    Destination IP

  • SubnetMaskNoDhcp string

    Subnet mask when dhcp is not selected

  • defaultGatewayNoDhcp string

    Defaault gateway when dhcp is not selected

  • primaryDNSNoDhcp string

    Primary DNS when dhcp is not selected

  • alternateDNSNoDhcp string

    Alternate DNS when dhcp is not selected

  • hyperV object

    Replication configuration for HyperV

  • sourceVM string

    Source VM

  • destinationVM string

    Destination VM

  • hypervHost string

    Hypervisor

  • destinationVolume string

    Destination volume for hyperV

  • overrideReplicationOptions object

    Replication options for HyperV

  • vmDisplayName string

    Display name for the destination VM

  • registerVMWithFailoverCluster string

    Register replicated virtual machines to the failover cluster for the destination client.

  • networkAdapter object[]

    Select a network interface from the Network adapter list

  • networkName string

    Name of network

  • nutanix object

    Model to store configuration per VM for Nutanix vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • oci object

    Model to store configuration per VM for OCI vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • availabilityDomain string

    Destination VM instance availability domain

  • stagingBucket string

    Staged bucket name for restore operation

  • region string

    Instance region

  • createPublicIP boolean

    Public/External IP of the destination VM instance

  • shape string

    Destination VM instance shape

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • compartment object
  • name string
  • value string
  • openStack object

    Model to store configuration per VM for OpenStack vendor

  • sourceVM string

    Source VM instance name

  • sourceVMGuid string

    Source VM instance guid

  • destinationVM string

    Destination VM instance name

  • overrideReplicationOptions object

    Extended instance configuration options

  • network object

    Network interface for the destination instances

  • networkDisplayName string

    Network display name

  • networkName string

    Name of network

  • subnetId string

    subnet id of network

  • privateIPaddress string

    Private IP address of the network

  • recoveryDestinationInfo object

    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.

  • targetInstanceId string

    Instance ID to which the disks are to be attached. Only used during attach disk restore.

  • name string

    Default value: Defaults to source VM name

    The new name of the instance after restore. Pass the target Instance name in case of attach disk 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

  • secondaryZone string

    Default value: Defaults to source instance zone after restore. For reference: cloud.google.com/compute/docs/regions-zones#available'

    GCP Secondary Zone. Applies only to the instances that are configured to use regional persistent disks. Ex: asia-east1-a.

  • 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

  • templateId string

    This is the GCP template image that is to be used for creating the new VM.

  • 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

  • attachAndSwapOSDisk boolean

    Default value: false

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

  • 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
  • vmNetworkTags object[]

    GCP VM Network tags

  • name string
  • value string
  • retainSourceVMNetworkTags boolean

    Default value: true

    Retains source VM Network tags.

  • 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
  • accessScopes string[]

    Type and level of API access to grant the VM.

  • 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

    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

  • isOSDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

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

  • extensionRestorePolicy string

    Possible values: [DEFAULT, DO_NOT_RESTORE, RESTORE, RESTORE_BUT_IGNORE_FAILURES]

  • 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

  • keyvaultId string

    Resource ID of the keyvault for keys and secrets

  • nics object[]

    Azure VM network interface list

  • id string

    Azure NIC ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/networkInterfaces/{Network Interface Name}.

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

  • subscriptionId string

    Azure Subscription ID for the restore destination.

  • 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. Pass the target Instance name in case of attach disk restore. Defaults to source instance name.

  • targetInstanceId string

    Instance ID to which the disks are to be attached. Only used during attach disk restore.

  • zone string

    Default value: Defaults to source instance availability zone.

    AWS Availability zone. Defaults to source instance availability zone.

  • region string
  • tenancy string

    Possible values: [default, dedicated, host]

    Tenancy of the instance.

  • hostId string

    The ID of the dedicated host on which the instance should reside. Should be specified if the tenancy is specified as 'host'. If specified, hostResourceGroup should not be specified.

  • hostResourceGroup object

    AWS host resource group info. Should be specified if the tenancy is specified as 'host'. If specified, hostId should not be specified.

  • resourceGroupName string

    The name of the resource group on which the instance should reside.

  • resourceGroupArn string

    The arn of the resource group on which the instance should reside.

  • affinity string

    Possible values: [default, host]

    Affinity setting for the instance on the dedicated host.

  • licenses object[]

    AWS host license list

  • licenseArn string
  • licenseName string
  • instanceSize string

    Default value: Defaults to source instance size

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

  • amiId string

    AMI to be used for creating the restored instance. By default, AMI will be picked based on the properties of source VM.

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

  • restoreSourceVolumeTags boolean

    Default value: true

    Restore source volume 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

  • osName string

    VM OS Name

  • guestCredential object

    VM guest credentials

  • computerName string
  • credentialId int32
  • 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

  • nutanixPrismCentral object

    Destination information for the Nutanix Prism Central VMs to restore

  • nutanixPrismCentralVMInfoList object[]

    List of nutanix prism central VMs that are to be restored

  • vmGuid string

    Nutanix Prism Central VM ID

  • name string

    Nutanix prism central VM name to be set after restore, defaults to source VM name.

  • cluster string

    Destination cluster for nutanix prism central VM, defaults to source VM cluster.

  • storageContainer string

    Destination storage container for nutanix prism central VM. defaults to source VM storage container.

  • nics object[]

    Nutanix prism central VM network interface list

  • uuid string

    UUID of the nutanix prism central Subnet

  • name string

    Name of the nutanix prism central Network

  • displayName string

    Used in GUI. Display name of the network

  • destinationNetwork string

    Name of the destination 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

  • disks object[]

    Openstack VM disk list

  • name string

    Openstack disk name. Ex: 9e9de935-18fd-4b7f-a8a7-b0c09ea79f39

  • Datastore string

    Openstack datastore. Ex: NFS-Host

  • isOsDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

  • 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

  • cloudstack object

    Destination information for the Cloudstack VMs to restore

  • cloudstackVMInfoList object[]

    List of Cloud stack VMs that are to be restored

  • vmGuid string

    Cloudstack VM ID

  • name string

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

  • zone object
  • guid string
  • name string
  • pod object
  • guid string
  • name string
  • cluster object
  • guid string
  • name string
  • host object
  • guid string
  • name string
  • domain object
  • guid string
  • name string
  • ownerType string

    Cloudstack VM owner type. Defaults to source VM owner type.

  • ownerTypeInfo object
  • guid string
  • name string
  • serviceOffering object
  • guid string
  • name string
  • diskOffering object
  • guid string
  • name string
  • template object
  • guid string
  • name string
  • keyPairs object[]

    List of keyPairs

  • keyId string
  • keyName string
  • securityGroups object[]

    Cloudstack VM security group list

  • groupId string
  • groupName string
  • nics object[]

    Cloudstack VM network setting list

  • id string

    Cloudstack nic id. Ex: ed5950fd-cfe7-4c5c-9cd7-cfebacee829d

  • name string

    Cloudstack nic name. Ex: 1

  • networkName string

    Cloudstack network name. Ex: defaultGuestNetwork

  • subnetId string

    Cloudstack subnet id.

  • networkDisplayName string

    Cloudstack network display name. Ex: defaultGuestNetwork

  • subnetMask string

    Cloudstack subnet mask. Ex: 255.255.240.0

  • networkAddress string

    Cloudstack network gateway. Ex: 172.24.31.245

  • disks object[]

    Cloudstack VM disk list

  • name string

    Cloudstack disk name. Ex: 9e9de935-18fd-4b7f-a8a7-b0c09ea79f39

  • Datastore string

    Cloudstack datastore. Ex: NFS-Host

  • isOsDisk boolean

    Default value: false

    Boolean to specify if the disk is OS disk

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

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

  • osType object
  • guid string
  • name string
  • ipAddressSettingsList object[]
  • 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

  • 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

    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.

  • storagePolicy object
  • guid string
  • name string
  • datastore string

    VMware Datastore Name. Defaults to source VM datastore name

  • datastoreCluster object
  • guid string
  • name string
  • osType object
  • guid string
  • name string
  • disks object[]

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

  • name string

    VMware VM disk name

  • datastore string

    VMware Datastore name

  • filter boolean

    Default value: false

    Set true to exclude disk from restored VM

  • ipAddressSettingsList object[]
  • 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

  • nics object[]
  • 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
  • vmStoragePolicy string deprecated
  • 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

  • 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

  • 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

  • securityGroups object[]

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

  • groupId string
  • groupName string
  • namePrefix string

    Adds prefix for instance display name

  • nameSuffix string

    Adds suffix for instance display name

  • redHatVirtulization object

    Destination information for the Rhev VMs to restore

  • rhevVMInfoList object[]

    List of Rhev VMs that are to be restored

  • sourceVMGuid string

    Rhev VM ID

  • name string

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

  • cluster string

    Rhev destination cluster.

  • storageDomain string

    Storage Domain of the Rhev VM

  • nics object[]

    Rhev VM network interface list

  • sourceNetwork string

    Name of the source network

  • destinationNetwork string

    Name of the destination network

  • namePrefix string

    Adds prefix for vm display name

  • nameSuffix string

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

  • datastoreClusterName string

    Fusion Compute VM datastore cluster name.

  • 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

  • proxmox object

    Destination information for the Proxmox VMs to restore

  • proxmoxVMInfoList object[]

    List of Proxmox VMs that are to be restored

  • sourceVMGuid string

    Proxmox VM ID

  • newName string

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

  • node string

    Proxmox destination node.

  • storage string

    storage of Proxmox VM

  • disks object[]

    Proxmox VM disks list

  • name string

    Name of the Proxmox VM disk

  • storage string

    Storage for the Proxmox VM disk

  • nics object[]

    Proxmox VM NIC's list

  • sourceNetwork string

    Source network of the Proxmox VM.

  • destinationNetwork string

    Destination network of the Proxmox VM.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • morpheus object

    Destination information for the Morpheus VMs to restore

  • MorpheusVMInfoList object[]

    List of Morpheus VMs that are to be restored

  • sourceVMGuid string

    Morpheus VM GUID

  • vmName string

    Morpheus VM name.

  • newName string

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

  • cloud string

    Morpheus cloud where VM will be restored.

  • cluster string

    Morpheus cluster where VM will be restored.

  • host string

    Morpheus host where VM will be restored.

  • storage string

    storage of Morpheus VM

  • servicePlanCode string

    Morpheus service plan code to be used for restore. If not specified, default service plan will be used.

  • disks object[]

    Morpheus VM disks list

  • name string

    Name of the Morpheus VM disk

  • storage string

    Storage for the Morpheus VM disk

  • nics object[]

    Morpheus VM NIC's list

  • sourceNetwork string

    Source network of the Morpheus VM.

  • destinationNetwork string

    Destination network of the Morpheus VM.

  • namePrefix string

    Adds prefix for VM display name

  • nameSuffix string

    Adds suffix for VM display name

  • azureStackHub object

    Destination information for the AzureStackHub VMs to restore

  • azureStackHubVMInfoList object[]

    List of AzureStackHub VMs that are to be restored

  • sourceVMGuid string

    AzureStackHub VM guid

  • name string

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

  • resourceGroup string

    AzureStackHub resource group.

  • region string

    AzureStackHub region.

  • storageAccount string

    AzureStackHub storage account.

  • vmSize string

    AzureStackHub vm size.

  • restoreAsManagedVM boolean

    Default value: true

    AzureStackHub option for restore as managed VM.

  • securityGroupId string

    Default value: Defaults to source configuration

    AzureStackHub security group to be set for the VM. Defaults to source configuration. Set the full security group URL from the portal.

  • storageType string

    AzureStackHub storage type. Keep the field empty to use source VM's storage type.

  • createPublicIP boolean

    Default value: true

    Assign a public IP to the restored instance.

  • nics object[]

    AzureStackHub VM network interface list

  • networkName string

    Name of the selected network

  • subnetId string

    subnet Id

  • namePrefix string

    Adds prefix for vm display name

  • nameSuffix string

    Adds suffix for vm display name

  • dbConfig object
  • server object
  • id int32
  • name string
  • instance object
  • id int32
  • name string
  • databases object[]
  • id int64

    ID of the source database

  • sourceName string

    Name of the source database

  • destinationName string

    Name of the destination database

  • fileMappings object[]
  • source object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • destination object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • imageDetails object
  • vmCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • vmTemplate object
  • GUID string
  • name string
  • skipOSDisk boolean

    Default value: false

    Determine if OS disk should be attached to new VM during the disk attach restore

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • mediaAgent object
  • id int32
  • name string
  • copyPrecedence int32

    Copy precedence for the copy used for the restore

  • hardwareConfiguration object
  • dataDiskConfiguration object[]
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • volumeConfiguration object[]
  • name string

    Name of the volume

  • totalSize int64

    Size for volume in bytes

  • enabled boolean

    Determine if volume is enabled or not

  • disks object[]
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • systemDiskConfiguration object
  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • credentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • instance object
  • id int32
  • name string
  • preRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • postRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • defaultWorkloadValidations object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • target object
  • id int32
  • name string
  • recoveryPointDetails object

    Contains the information regarding the recovery entity level recoveryPoint selection

  • recoveryPointForLastRecoveryJob int32

    Default value: -1

    Timestamp that was set for the last recovery job that was ran for this entity. If no job ran, this value will be -1

  • entityRecoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • entityRecoveryPointCategory string

    Possible values: [LATEST, POINT_IN_TIME, AUTOMATIC]

    Default value: LATEST

    Type of recovery point category

  • inheritedFrom string

    Possible values: [RECOVERY_GROUP, RECOVERY_ENTITY]

    Default value: RECOVERY_GROUP

    Describes from where the recovery point is inherited from. If not provided, recovery point will be used as if it is set at recovery group level

  • timeZoneId int32

    TimeZone Id of the CS

  • recoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • executionOrder object
  • priority int32

    Decides the priority of group execution

  • order int32

    Decides the priority of entites within a group

  • group int32

    Group ID to group similar entities together

  • connectionDetails object
  • guestCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • csCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • topologyDetails object
  • serverGroups object[]
  • id int32
  • name string
  • networkGateway object[]
  • hostname string

    Gateway machine hostname

  • port int32

    Possible values: >= 1 and <= 65535

  • vmHostName string

    VM host name

  • vmClientName string

    VM client name

  • domainCreds object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • blockSysrepForRecovery boolean
  • restoreEligibility object
  • isEligible boolean
  • ineligibleReason string
  • restoreStatus object
  • jobStatus string

    Possible values: [SUCCESS = 0, FAILURE = 1, RUNNING = 2, COMPLETED_WITH_ERRORS = 4, SKIPPED = 8, KILLED = 16, SUSPENDED = 32, PENDING = 64, NOT_STARTED = 128, INVALID = 256, NOT_APPLICABLE = 512, MARKED_AS_FAILED = 1024]

  • failureReason string
  • lastJobId int32
  • copyAvailableTime int32
  • lastFullBackupTime int32
  • restoredVMState VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • cleanupEligibility object
  • isEligible boolean
  • ineligibleReason string
  • cleanupStatus object
  • jobStatus string

    Possible values: [SUCCESS = 0, FAILURE = 1, RUNNING = 2, COMPLETED_WITH_ERRORS = 4, SKIPPED = 8, KILLED = 16, SUSPENDED = 32, PENDING = 64, NOT_STARTED = 128, INVALID = 256, NOT_APPLICABLE = 512, MARKED_AS_FAILED = 1024]

  • failureReason string
  • lastJobId int32
  • recoveryStatus string

    Possible values: [NO_STATUS, NOT_READY, READY, RECOVERED, FAILED, RECOVERED_WITH_ERRORS, IN_PROGRESS, CLEANED_UP, MARK_AS_FAILED, CLEANUP_FAILED, RECOVERED_WITH_THREATS, WAITING]

    Status of recovery entity

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • validationResults object[]
  • type string

    Possible values: [THREAT_SCAN, WINDOWS_DEFENDER, DEFAULT_VALIDATION, CUSTOM_RUNBOOK_VALIDATION, CUSTOM_RESOURCE_VALIDATION]

    Validation status of recovery entity

  • customValidationGuid string
  • output string

    Output of the script executed

  • name string

    Name of the script executed

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • failureReason string

    Script validation failure reason

  • threatInfo object[]
  • count int32

    The number of threats found per threat type

  • threatType string

    The name of the threat

  • recoveryFailureReason string

    Reason for last recovery job failure

  • validationFailureReason string

    Reason for last validation failure

  • recoveryStatusNotReadyReason string

    Recovery status not ready reason

  • recoveryStatusNotReadyCategory string

    Possible values: [NONE = 0, INVALID_VM_NAME = 1, INVALID_COPY = 2, MARK_AS_FAILED = 4, INVALID_SMART_FOLDER = 8, LAST_BACKUP_OUTDATED = 32, LAST_BACKUP_NOT_READY = 64, MANAGED_IDENTITY_ENABLED = 128, AUTOSCALING_DISABLED = 256, ENABLE_AUTOSCALING_FOR_THREATSCAN = 512, PRIMARY_ASSET_COPIES_NOT_AVAILABLE = 1024, PARENT_ENTITY_NOT_REGISTERED = 262144]

    Recovery status not ready category

  • recoveryReadinessStatus string

    Possible values: [NONE = 0, READY = 1, PARTIAL_READY = 2, NOT_READY = 3, OUTDATED = 4]

    Recovery readiness status

  • recoveryStatusPartialReadyCategory string

    Possible values: [NONE = 0, SECONDARY_ASSET_COPIES_NOT_AVAILABLE = 1, GATEWAY_OR_NETWORK_TOPOLOGY_NOT_AVAILABLE = 2]

    Recovery status partial ready category

  • recoveryStatusPartialReadyReason string

    Recovery status partial ready reason

  • lastRecoveryJobId int32

    Last recovery job Id of the entity

  • lastRestoreJobId int32

    Last restore job Id of the entity

  • lastSuccessfulRestoreJobId int32

    Last successful restore job Id of the entity

  • lastSuccessfulRecoveryJobId int32

    Last successful recovery job Id of the entity

  • lastRunbookInstanceId int32

    Latest runbook insatnce Id of the entity

  • lastSuccessfulRunbookInstanceId int32

    Latest successful runbook insatnce Id of the entity

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • copyAvailableTime int32

    Timestamp of the latest backup job start time present in the copy that would be used for recovery. Value would be -1 if no valid copy is present for recovery.

  • lastFullBackupTime int32

    Last available full backup job start time present in the copy in UNIX timestamp format. Value would be -1 if no valid copy is present.

  • installedWorkloads string[]

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE, PHYSICAL_SERVER, GOOGLE_CLOUD_PLATFORM, ACTIVE_DIRECTORY_FOREST]

  • sourceVendor string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

  • fileShare object
  • name string

    Name of Azure File Share

  • protocol EnabledProtocol

    Possible values: [SMB, NFS]

    Protocol of file share

  • shareURL string

    URL of File Share

  • adForestRunbookInfo object
  • adForest object
  • id int32
  • name string
  • runbookInfo object
  • id int32
  • name string
  • recoveredVMState VMState

    Possible values: [STOPPED = 0, RUNNING = 1, SUSPENDED = 2, UNKNOWN = 3, ARCHIVED = 4, EXPIRED = 5, UNAVAILABLE = 6, CREATING = 101, CLONING = 102, CREATING_SNAPSHOT = 103, REVERTING_SNAPSHOT = 104, DELETING_SNAPSHOT = 105, STARTING = 106, STOPPING = 107, SUSPENDING = 108, RESTARTING = 109, DELETING = 110, RECOVERING = 111, RETRIEVING = 112]

    State of VirtualMachine

  • destinationVirtualMachine object
  • GUID string
  • name string
  • destinationName string

    Name of the recovered entity

  • threatScan object
  • status CRRThreatScanStatus

    Possible values: [NONE, NOT_ENABLED, ENABLED, NOT_RUN, RUNNING, RUN_FAILED, COMPLETED, THREAT_FOUND]

  • vmConnectionInfo object
  • resourceGroupName string

    Name of resource group

  • subscriptionId string

    Subscription ID

  • url string

    URL for bastionHost/SSM

  • hasRecoverySubEntities boolean

    Default value: false

    Set to false if there are no subEntities associated with the parent recovery entity

  • skipRecovery boolean

    Default value: false

    Set to true if the recovery of the entity is skipped

  • resetRepaveOption boolean

    Whether repave entites have to be reset during target updation

  • resetStaticIPAddress boolean

    Whether we have to reset existing IP Address during target updation

  • guestCredential object
  • id int32
  • name string
  • appTypeId int32

    The application type id of the source

Loading...