Create replication group
Select
Create a replication group
- application/json
Request Body
Provide the options for one of the vendors to create a replication group
- MOD1
- MOD2
- MOD3
- MOD4
- name string required
The name of the replication group being created
sourceHypervisor object required
id int32name stringvms object[] required
A list of name and GUID of all the virtual machines that have to be replicated
GUID stringname string- frequencyInMinutes int32
Default value:
240
The field denotes the frequency of replication.
recoveryTarget object required
id int32name stringstorage 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 int32name stringisDedupe boolean requiredDenotes if this is a deduplication copy
- destVendor string required
Possible values: [
Amazon
] advancedOptions object
Advanced options for Amazon replication group
validateDestinationVM booleanDefault value:
true
Validates that the destination VM is bootable by powering it on and then powering off
unconditionalOverwrite booleanDefault 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 stringname stringinstanceName string requiredDisplay name for the destination instance
regionName string requiredThe name of the AWS region where the destination instance will reside
availabilityZone string requiredThe name of AWS zone where the destination instance will reside
volumeType stringID of the volume type that will be used on the destination instance. Default value is Auto
encryptionKey stringThe 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 stringThe ID of the VPC
subnetId stringThe ID of the subnet
name stringThe name of the network
privateIPaddress stringThe private IP address 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 stringSecurity group id
name stringsecurity group name
instanceType stringThe 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 stringThe name of the computer
userName stringThe user to be used to access the computer
password stringThe password of the user in Base64 format
- name string required
The name of the replication group being created
sourceHypervisor object required
id int32name stringvms object[] required
A list of name and GUID of all the virtual machines that have to be replicated
GUID stringname string- frequencyInMinutes int32
Default value:
240
The field denotes the frequency of replication.
recoveryTarget object required
id int32name stringstorage 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 int32name stringisDedupe boolean requiredDenotes if this is a deduplication copy
- destVendor string required
Possible values: [
Azure
] advancedOptions object
Advanced options for Azure replication group
unconditionalOverwrite booleanDefault value:
false
This will replace the instance at the destination if the instance with the same name already exists.
deployVmOnlyDuringfailover booleanDefault 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 stringname stringvmDisplayName string requiredDisplay name of destination VM
resourceGroup string requiredThe resource group to be used for the destination VM
region string requiredThe name of the region where the destination VM will reside
storageAccount string requiredThe name of the storage account to be used on the destination VM
vmSizeId stringThe id of the vm size to be applied to the destination VM. Default value is Auto
diskTypeId stringThe 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 destination VM. Default value is Auto
subnetId stringThe ID of the subnet
network stringThe name of the network
securityGroup object
The id and the name of the security group
id stringSecurity group id
name stringsecurity group name
createPublicIP booleanCreates a public IP on the network
restoreAsManagedVM booleanCreates the destination as a managed VM
privateIPaddress stringPrivate IP address of the network
publicIPaddress stringPublic IP address of the network
publicIPaddressID stringPublic IP address id of the network
- name string required
The name of the replication group being created
sourceHypervisor object required
id int32name stringvms object[] required
A list of name and GUID of all the virtual machines that have to be replicated
GUID stringname string- frequencyInMinutes int32
Default value:
240
The field denotes the frequency of replication.
recoveryTarget object required
id int32name stringstorage 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 int32name stringisDedupe boolean requiredDenotes if this is a deduplication copy
- destVendor string required
Possible values: [
HyperV
] advancedOptions object
Advanced options for HyperV replication group
validateDestinationVM booleanDefault value:
true
Validates that the destination VM is bootable by powering it on and then powering off
unconditionalOverwrite booleanDefault 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 stringname stringvmDisplayName string requiredDisplay name for the destination VM
registerVMWithFailoverCluster booleanRegister replicated virtual machines to the failover cluster for the destination client.
networkName string requiredThe name of the network of destination VM
- name string required
The name of the replication group being created
sourceHypervisor object required
id int32name stringvms object[] required
A list of name and GUID of all the virtual machines that have to be replicated
GUID stringname string- frequencyInMinutes int32
Default value:
240
The field denotes the frequency of replication.
recoveryTarget object required
id int32name stringstorage 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 int32name stringisDedupe boolean requiredDenotes 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 booleanDefault value:
true
Validates that the destination VM is bootable by powering it on and then powering off
diskProvisioning stringPossible values: [
ORIGINAL
,THICK LAZY ZERO
,THIN
,THICK EAGER ZERO
]Default value:
ORIGINAL
The disk provisioning type for the destination VM.
transportMode stringPossible values: [
AUTO
,SAN
,HOT_ADD
,NAS
,NBD_SSL
,NBD
]Default value:
AUTO
The transport mode based on environment.
unconditionalOverwrite booleanDefault value:
false
This will replace the instance at the destination if the instance with the same name already exists.
SnapshotsToRetain int32Number of snapshots to retain on destination VM. This is only applicable if snap engine is provided
snapEngine object
id int32name stringrecoveryOptions 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 requiredPossible values: [
LATEST_RECOVERY
,POINT_IN_TIME_RECOVERY
]Default value:
POINT_IN_TIME_RECOVERY
Type of recovery.
recoveryPointStore object required
id int32name stringrecoveryPointInterval object
Recovery point interval inputs for continuous replication group. Provide atleast one of crash consistent and application consistent interval.
crashConsistentRpInterval int32Default value:
300
Minimum time interval(in seconds) between VM recovery points. Applicable only for Point in time recovery.
applicationConsistentRpInterval int32Time(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 requiredPossible 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 booleanDefault value:
true
Merge the recovery points beyond the time provided in mergeRecoveryPointsOlderThan
mergeRecoveryPointsOlderThan int32Possible 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 int32Possible 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 int32Time(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 booleanDefault 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 stringname stringvmDisplayName string requiredEnter the display name for the destination VM
destinationHost string requiredName of host where the destination VM will reside
datastore string requiredThe datastore to be used for virtual machine disks
resourcePool string requiredThe resource pool that will be used on the destination VM
vmFolder stringIf 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 stringSource network name
sourceId stringSource network ID
destination stringDestination 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 stringThe full IP address or an IP address pattern of the source VM.
sourceSubnetMask stringThe subnet mask of the source VM.
sourceDefaultGateway stringThe default gateway of the source VM.
useDhcp booleanDefault value:
false
Automatically assigns available IP addresses to be used with the specified destination network.
destinationIP stringThe full IP address or an IP address pattern for the destination VM. Provide only if DHCP is not enabled.
destinationSubnetMask stringThe subnet mask for the destination VM. Provide only if DHCP is not enabled.
destinationDefaultGateway stringThe default gateway for the destination VM. Provide only if DHCP is not enabled.
destinationPreferredDNS stringThe preferred DNS server for the destination VM. Provide only if DHCP is not enabled
destinationAlternateDNS stringThe alternate DNS server for the destination VM. Provide only if DHCP is not enabled
destinationPreferredWINS stringThe preferred WINS server for the destination VM. Provide only if DHCP is not enabled
destinationAlternateWINS stringThe alternate WINS server for the destination VM. Provide only if DHCP is not enabled
- 200
- 400
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- id int32
- name string
{
"id": 0,
"name": "string"
}
Bad Request
Internal server error