ReplicationGroupType

Element:
ReplicationGroup
Type:
ReplicationGroupType
Namespace:
http://www.vmware.com/vr/v6.0
Description:
ReplicationGroup.
Since:
1.0
Schema:
hcs.xsd
Media type(s):
application/vnd.vmware.hcs.replicationGroup+xml
Extends:
EntityType
XML Representation:
<ReplicationGroup xmlns="http://www.vmware.com/vr/v6.0" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
    </vcloud_v1.5:Link>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <vcloud_v1.5:Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Link>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Owner>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                    <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
                </vcloud_v1.5:TenantError>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:User>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Organization>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <Rpo> xs:long </Rpo>
    <QuiesceGuestEnabled> xs:boolean </QuiesceGuestEnabled>
    <NetworkCompressionEnabled> xs:boolean </NetworkCompressionEnabled>
    <PlaceholderVappId> xs:string </PlaceholderVappId>
    <EventPartitionId> xs:string </EventPartitionId>
    <ReplicationState> xs:string </ReplicationState>
    <vcloud_v1.5:ReplicationError stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
            vendorSpecificErrorCode="xs:string">
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
            <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        </vcloud_v1.5:TenantError>
    </vcloud_v1.5:ReplicationError>
    <VrServerInfo>
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <Uuid> xs:string </Uuid>
        <ReplicationTrafficAddress> xs:string </ReplicationTrafficAddress>
    </VrServerInfo>
    <NextInstanceSequenceNumber> xs:long </NextInstanceSequenceNumber>
    <Paused> xs:boolean </Paused>
    <CurrentRpoViolation> xs:int </CurrentRpoViolation>
    <TestRecoveryState> xs:string </TestRecoveryState>
    <vcloud_v1.5:TestRecoveryError stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
            vendorSpecificErrorCode="xs:string">
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
            <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        </vcloud_v1.5:TenantError>
    </vcloud_v1.5:TestRecoveryError>
    <TestRecoveryCompletionTime> xs:anySimpleType </TestRecoveryCompletionTime>
    <RecoveryState> xs:string </RecoveryState>
    <vcloud_v1.5:RecoveryError stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
            vendorSpecificErrorCode="xs:string">
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
            <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        </vcloud_v1.5:TenantError>
    </vcloud_v1.5:RecoveryError>
    <RecoveryCompletionTime> xs:anySimpleType </RecoveryCompletionTime>
    <ReplicationGroupInstance>
        <Id> xs:string </Id>
        <TransferStartTime> xs:anySimpleType </TransferStartTime>
        <TransferSeconds> xs:long </TransferSeconds>
        <TransferBytes> xs:long </TransferBytes>
    </ReplicationGroupInstance>
</ReplicationGroup>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 1.0 The URI of the entity.
type string No always 1.0 The MIME type of the entity.
id string No none 1.0 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 1.0 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
CurrentRpoViolation int No 1.0 The time in minutes that has elapsed since the last RPO violation. It has a value of 0 if there is no RPO violation and positive value otherwise.
Description string No always 1.0 Optional description.
EventPartitionId string No 1.0 Event partition identifier of the ReplicationGroup.
Link LinkType No none 1.0 A reference to an entity or operation associated with this object.
NetworkCompressionEnabled boolean Yes 3.0 Flag that indicates whether or not compression should be used when sending traffic over the network.
NextInstanceSequenceNumber long No 1.0 The sequence number of the next replica instance of the ReplicationGroup.
Paused boolean Yes 1.0 Indicates whether the ReplicationGroup is paused.
PlaceholderVappId string No 1.0 Identifier of the ReplicationGroup placeholder vApp.
QuiesceGuestEnabled boolean Yes 1.0 Flag that indicates whether or not to quiesce the file system or applications in the guest OS before a consistent replica is created.
RecoveryCompletionTime anySimpleType No 1.0 Timestamp of successful planned migration or failover. Not present if the ReplicationGroup is not recovered, or the operation has failed.
RecoveryError ErrorType No 1.0 Describes the error encountered during the last planned migration or failover. Not present if the operation was never executed or was completed successfully.
RecoveryState string No 1.0 Recovery state

One of:

  • unknown - Unknown (for forward compatibility).
  • notStarted - No recovery attempt has been performed so far.
  • inprogress - When a recovery is in progress.
  • error - Last recovery attempt failed.
  • ok - Last recovery attempt succeeded.
ReplicationError ErrorType No 1.0 ReplicationGroup errors.
ReplicationGroupInstance ReplicationGroupInstanceType No 1.0 Statistics for the latest completed consistent replica update.
ReplicationState string No 1.0 The ReplicationGroup state.

One of:

  • error - The ReplicationGroup has replication or configuration errors.
  • moving - The ReplicationGroup is in the process of being moved to a different VR server.
  • configuring - The ReplicationGroup is in the process of being configured or re-configured.
  • paused - The replication for this ReplicationGroup is being paused
  • fullSync - Full sync is performed on this ReplicationGroup.
  • initialFullSync - Initial full sync is performed, this state happens only once in a ReplicationGroup's lifetime.
  • sync - There is live replication traffic for this ReplicationGroup.
  • notActive - There is no replication traffic for this ReplicationGroup and there are no opened connections for it.
  • OK - The ReplicationGroup is configured properly, no configuration or replication errors are present. But no actual replication traffic is taking place at the moment.
  • unknown - The ReplicationGroup's status cannot be determined.
  • recovering - A recovery is being performed on this ReplicationGroup.
  • recovered - The ReplicationGroup has been successfully recovered.
Rpo long No 1.0 Recovery point objective in minutes.
Tasks TasksInProgressType No none 1.0 A list of queued, running, or recently completed tasks associated with this entity.
TestRecoveryCompletionTime anySimpleType No 1.0 Timestamp of the latest successful test failover. Not present if the ReplicationGroup is not in state of test failover, or if the test failover operation failed.
TestRecoveryError ErrorType No 1.0 Describes the error encountered during the last test failover or cleanup. Not present if the operation was never executed or was completed successfully.
TestRecoveryState string No 1.0 Test recovery state

One of:

  • unknown - Unknown (for forward compatibility).
  • none - There is/are no test VM(s) at recovery site.
  • testInProgress - There is test recovery in progress.
  • complete - Test VM(s) or vApp is ready to use.
  • cleanupInProgress - Cleanup in progress.
  • testError - There is a test error.
  • cleanupError - There is a cleanup error.
VCloudExtension VCloudExtensionType No always 1.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VrServerInfo VrServerInfoType No 1.0 Information about the VR Server replication traffic and UUID.

Operations

CRUD Operation Description Since Deprecated
read GET /vr/replications/{replicationGroupId} Retrieves information for the specified incoming ReplicationGroup. 1.0
delete DELETE /vr/replications/{replicationGroupId} Removes the specified incoming ReplicaitonGroup. 1.0
action POST /vr/replications/{replicationGroupId}/action/failover Performs failover for the incoming ReplicationGroup. 1.0
action POST /vr/replications/{replicationGroupId}/action/testCleanup Performs test clean-up for the incoming ReplicationGroup. 1.0
action POST /vr/replications/{replicationGroupId}/action/testFailover Performs test failover for the specified incoming ReplicationGroup. 1.0