Attributes | Elements | Operations | ||
Home Frames |
|
|
|
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:
|
||
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:
|
||
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:
|
||
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 |
Top of page | Attributes | Elements | Operations | |
Home Frames |
|
|
|