# Data Object - ReplicationConfigSpec(vim.vm.ReplicationConfigSpec)

Property of
  VirtualMachineConfigInfo, VirtualMachineConfigSpec
Extends
  DynamicData
See also
  ReplicationInfoDiskSettings
Since
  vSphere API 6.0

## Data Object Description

The ReplicationConfigSpec object type encapsulates the replication configuration parameters for a virtual machine. It consists of two parts: 1) a set of virtual machine-wide replication properties; 2) a set of properties per replicated virtual disk. ReplicationSetting is passed as an argument for initial replication configuration (@see vim.VirtualMachine.EnableReplication) as well as for re-configuration of a replicated VM's properties (@see vim.VirtualMachine.ReconfigureReplication). It is also returned to callers through a "get" interface (@see vim.VirtualMachine.ReplicationConfig).

Properties

Name | Type | Description
--- | --- | ---
destination | xsd:string | The IP address of the HBR Server in the secondary site where this VM is replicated to. Note: If net encryption is enabled, this is the address of the encryption tunnelling agent.
disk* | ReplicationInfoDiskSettings[] | The set of the disks of this VM that are configured for replication.
encryptionDestination* | xsd:string | The IP address of the remote HBR server, target for encrypted LWD. This field is required when net encryption is enabled, ignored otherwise. Since vSphere API 6.7
encryptionPort* | xsd:int | The port on the remote HBR server, target for encrypted LWD. This field is only relevant when net encryption is enabled. Since vSphere API 6.7
generation | xsd:long | A generation number (>=0) that reflects the "freshness" of the ReplicationConfigSpec on which a re-configuration is based. The generation number is used to detect and disallow concurrent updates to a VM's replication settings. For initial replication enablement, generation = 0. The replication settings of every replication re-configuration operation must reflect the latest generation number known to the caller. It takes an explicit call to get the latest replication settings to find out what the latest generation number is. The update algorithm of the generation number is opaque to the caller; e.g., the caller cannot assume that the generation numbers are incremented by one every time replication is (re)configured, not even that they are changing monotonically.
netCompressionEnabled* | xsd:boolean | Flag that indicates whether or not compression should be used when sending traffic over the network. The primary will negotiate the best compression with the server on the secondary if this is enabled. Since vSphere API 6.0
netEncryptionEnabled* | xsd:boolean | Flag that indicates whether or not encription should be used when sending traffic over the network. The primary will use the remoteCertificateThumbprint to verify the identity of the remote server. Since vSphere API 6.7
oppUpdatesEnabled | xsd:boolean | Flag that indicates whether or not to perform opportunistic updates in-between consistent replicas. TODO: This may be removed from the final product.
paused | xsd:boolean | Flag that indicates whether or not the vm or group has been paused for replication.
port | xsd:int | The port on the HBR Server in the secondary site where this VM is replicated to. Note: If net encryption is enabled, this is the port of the encryption tunneling agent.
quiesceGuestEnabled | xsd:boolean | Flag that indicates whether or not to quiesce the file system or applications in the guest OS before a consistent replica is created.
remoteCertificateThumbprint* | xsd:string | The SHA256 thumbprint of the remote server certificate. This field is only relevant when net encription is enabled. Since vSphere API 6.7
rpo | xsd:long | The Recovery Point Objective specified for this VM, in minutes. Currently, valid values are in the range of 1 minute to 1440 minutes (24 hours).
vmReplicationId | xsd:string | An opaque identifier that uniquely identifies a replicated VM between primary and secondary sites.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ReplicationConfigSpec"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="generation" type="xsd:long"/> <element name="vmReplicationId" type="xsd:string"/> <element name="destination" type="xsd:string"/> <element name="port" type="xsd:int"/> <element name="rpo" type="xsd:long"/> <element name="quiesceGuestEnabled" type="xsd:boolean"/> <element name="paused" type="xsd:boolean"/> <element name="oppUpdatesEnabled" type="xsd:boolean"/> <element name="netCompressionEnabled" type="xsd:boolean" minOccurs="0"/> <element name="netEncryptionEnabled" type="xsd:boolean" minOccurs="0"/> <element name="encryptionDestination" type="xsd:string" minOccurs="0"/> <element name="encryptionPort" type="xsd:int" minOccurs="0"/> <element name="remoteCertificateThumbprint" type="xsd:string" minOccurs="0"/> <element name="disk" type="vsan:ReplicationInfoDiskSettings" minOccurs="0" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType>