FailbackReplicationGroupType

Element:
FailbackReplicationGroup
Type:
FailbackReplicationGroupType
Namespace:
http://www.vmware.com/vr/v6.0
Description:
Failback replication group.
Since:
3.0
Schema:
hcs.xsd
Media type(s):
application/vnd.vmware.hcs.failbackReplicationGroup+xml
Extends:
EntityType
XML Representation:
<FailbackReplicationGroup 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>
    <SourceVappId> xs:string </SourceVappId>
    <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>
    <Paused> xs:boolean </Paused>
</FailbackReplicationGroup>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 3.0 The URI of the entity.
type string No always 3.0 The MIME type of the entity.
id string No none 3.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 3.0 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 3.0 Optional description.
Link LinkType No none 3.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.
Paused boolean Yes 3.0 Indicates whether the ReplicationGroup is paused.
QuiesceGuestEnabled boolean Yes 3.0 Flag that indicates whether or not to quiesce the file system or applications in the guest OS before a consistent replica is created.
ReplicationError ErrorType No 3.0 ReplicationGroup errors.
ReplicationState string No 3.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 3.0 Recovery point objective in minutes.
SourceVappId string No 3.0 Identifier of the ReplicationGroup source vApp.
Tasks TasksInProgressType No none 3.0 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 3.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
read GET /vr/failbackreplications/{replicationGroupId} Retrieves information for the specified outgoing FailbackReplicationGroup. 3.0
delete DELETE /vr/failbackreplications/{replicationGroupId} Removes the specified FailbackReplicationGroup. 3.0