Create replication group

Create a replication group

application/json

Request Body

Provide the options for one of the vendors to create a replication group

oneOf

MOD1
MOD2
MOD3
MOD4

name string required

The name of the replication group being created

sourceHypervisor object required

id int32

name string

vms object[] required

A list of name and GUID of all the virtual machines that have to be replicated

GUID string

name string

frequencyInMinutes int32

Default value: 240

The field denotes the frequency of replication.

recoveryTarget object required

id int32

name string

storage object[] required

The primary and an optional secondary storage that will be used for storing the source VM data for replication. The secondary storage if provided, will be the default source for replication.

storagePool object required

id int32

name string

isDedupe boolean required

Denotes if this is a deduplication copy

destVendor string required

Possible values: [Amazon]

advancedOptions object

Advanced options for Amazon 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.

overrideReplicationOptions object[]

The replication options per instance, if provided, will override the replication options from the target. For the instances not in this list, the options are applied from the target.

sourceVM object required

GUID string

name string

instanceName string required

Display name for the destination instance

regionName string required

The name of the AWS region where the destination instance will reside

availabilityZone string required

The name of AWS zone where the destination instance will reside

volumeType string

ID of the volume type that will be used on the destination instance. Default value is Auto

encryptionKey string

The ID of the encryption key that will be used to encrypt the data of the desination instance. Default value is Auto

network object

Network info

vpc string

The ID of the VPC

subnetId string

The ID of the subnet

name string

The name of the network

securityGroups object[]

The security group to be applied to the destination instance that acts as a virtual firewall. Default value is Auto

id string

Security group id

name string

security group name

instanceType string

The available CPU cores and memory to be used on the destination instance. Default value is Auto

guestCredentials object

Faster performance can be achieved during replication by using the VSA access node running on the Amazon instance. Applicable only if the source VM is Windows and the source hypervisor is not Amazon vendor.

computerName string

The name of the computer

userName string

The user to be used to access the computer

password string

The password of the user in Base64 format

name string required

The name of the replication group being created

sourceHypervisor object required

id int32

name string

vms object[] required

A list of name and GUID of all the virtual machines that have to be replicated

GUID string

name string

frequencyInMinutes int32

Default value: 240

The field denotes the frequency of replication.

recoveryTarget object required

id int32

name string

storage object[] required

The primary and an optional secondary storage that will be used for storing the source VM data for replication. The secondary storage if provided, will be the default source for replication.

storagePool object required

id int32

name string

isDedupe boolean required

Denotes if this is a deduplication copy

destVendor string required

Possible values: [Azure]

advancedOptions 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

overrideReplicationOptions object[]

The replication options per instance, if provided, will override the replication options from the target. For the instances not in this list, the options are applied from the target.

sourceVM object required

GUID string

name string

vmDisplayName string required

Display name of destination VM

resourceGroup string required

The resource group to be used for the destination VM

region string required

The name of the region where the destination VM will reside

storageAccount string required

The name of the storage account to be used on the destination VM

vmSizeId string

The id of the vm size to be applied to the destination VM. Default value is Auto

diskTypeId string

The id of the disk type to be used for the destination VM. Default value is Auto

virtualNetwork object[]

The network to be used on the desination VM. Default value is Auto

subnetId string

The ID of the subnet

network string

The name of the network

securityGroup object

The id and the name of the security group

id string

Security group id

name string

security group name

createPublicIP boolean

Creates a public IP on the destination VM

restoreAsManagedVM boolean

Creates the destination as a managed VM

name string required

The name of the replication group being created

sourceHypervisor object required

id int32

name string

vms object[] required

A list of name and GUID of all the virtual machines that have to be replicated

GUID string

name string

frequencyInMinutes int32

Default value: 240

The field denotes the frequency of replication.

recoveryTarget object required

id int32

name string

storage object[] required

The primary and an optional secondary storage that will be used for storing the source VM data for replication. The secondary storage if provided, will be the default source for replication.

storagePool object required

id int32

name string

isDedupe boolean required

Denotes if this is a deduplication copy

destVendor string required

Possible values: [HyperV]

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

overrideReplicationOptions object[]

The replication options per instance, if provided, will override the replication options from the target. For the instances not in this list, the options are applied from the target.

sourceVM object required

GUID string

name string

vmDisplayName string required

Display name for the destination VM

registerVMWithFailoverCluster boolean

networkName string required

The name of the network of destination VM

name string required

The name of the replication group being created

sourceHypervisor object required

id int32

name string

vms object[] required

A list of name and GUID of all the virtual machines that have to be replicated

GUID string

name string

frequencyInMinutes int32

Default value: 240

The field denotes the frequency of replication.

recoveryTarget object required

id int32

name string

storage object[] required

The primary and an optional secondary storage that will be used for storing the source VM data for replication. The secondary storage if provided, will be the default source for replication.

storagePool object required

id int32

name string

isDedupe boolean required

Denotes if this is a deduplication copy

destVendor string required

Possible values: [VMware]

replicationType string

Possible values: [Periodic, Continuous]

Default value: Periodic

The field specifies the type of replication that is to be performed

advancedOptions 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: [ORIGINAL, THICK LAZY ZERO, THIN, THICK EAGER ZERO]

Default value: ORIGINAL

The disk provisioning type for the destination VM.

transportMode string

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

Default value: AUTO

The transport mode based on environment.

unconditionalOverwrite boolean

Default value: false

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

SnapshotsToRetain int32

Number of snapshots to retain on destination VM. This is only applicable if snap engine is provided

snapEngine object

id int32

name string

recoveryOptions object

Recovery options for a continuous replication group. recoveryPointStore is an intermediate storage for recovery points. Provide both the id and the name of the recoveryPointStore. Either crash consistent or application consistent RP interval is mandatory.

recoveryType string required

Possible values: [LATEST_RECOVERY, POINT_IN_TIME_RECOVERY]

Default value: POINT_IN_TIME_RECOVERY

Type of recovery.

recoveryPointStore object required

id int32

name string

recoveryPointInterval object

Recovery point interval inputs for continuous replication group. Provide atleast one of crash consistent and application consistent interval.

crashConsistentRpInterval int32

Default value: 300

Minimum time interval(in seconds) between VM recovery points. Applicable only for Point in time recovery.

applicationConsistentRpInterval int32

Time(in seconds) after which the source VMs are quiesced to create application-consistent recovery points for destination VMs. Applicable only for Point in time recovery.

recoveryPointRetention object

Recovery point retention inputs for continuous replication group.

retainRecoveryPointsFor int32 required

Possible values: >= 1

Default value: 604800

The lengh of time(in seconds) to a retain the recovery point entries. Applicable only for Point in time recovery.

mergeRecoveryPoints boolean

Default value: true

Merge the recovery points beyond the time provided in mergeRecoveryPointsOlderThan

mergeRecoveryPointsOlderThan int32

Possible values: >= 1

Default value: 172800

Applicable only if mergeRecoveryPoints is set to true. Beyond this period(in seconds), older recovery points will be merged into progressively coarser intervals going back in time. Applicable only for Point in time recovery. The value cannot exceed the value of retainRecoveryPointsFor.

recoveryPointIntervalAtEndofRetention int32

Possible values: >= 1 and <= 86400

Default value: 21600

Applicable only if mergeRecoveryPoints is set to true. Time interval(in seconds) between the older recovery points. Applicable only if mergeRecoveryPointsOlderThan and Point in time recovery is selected. The value cannot exceed the value of retainRecoveryPointsFor or 86400 seconds(1 day).

rpStoreOfflineFor int32

Time(in seconds) after which the recovery type is switched to 'Latest recovery' if RP store is offline. Applicable only for Point in time recovery.

pruneAndMergeDuringOffPeak boolean

Default value: false

Transfers the updates of the oldest recovery points to destination VM only during off-peak hours. The peak interval time should be configured in the RP store. Applicable only for Point in time recovery.

overrideReplicationOptions object[]

The replication options per instance, if provided, will override the replication options from the target. For the instances not in this list, the options are applied from the target.

sourceVM object required

GUID string

name string

vmDisplayName string required

Enter the display name for the destination VM

destinationHost string required

Name of host where the destination VM will reside

datastore string required

The datastore to be used for virtual machine disks

resourcePool string required

The resource pool that will be used on the destination VM

vmFolder string

If the destination VM has to reside inside a folder, specify the name here

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[]

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: false

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

destinationPreferredWINS string

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

destinationAlternateWINS string

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

hostname string

The host name to be applied for the destination VM.

Responses

Success

application/json

Schema
Example (from schema)

Schema

id int32
name string

{
  "id": 0,
  "name": "string"
}

Create replication group​

Create replication group