Replication Reconfigure
This request configures the VM replication settings.
The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.
VM replication identifier
H4-ec991bd5-af9d-446a-8599-5b693842c4a3Optional site to run the operation on. When omitted, defaults to the local site.
site1Operation ID for correlating logs across multiple services
Settings to use for reconfiguring replication.
{
"description": "New description",
"rpo": 0,
"dataConnectionType": "PLAIN",
"quiesced": false,
"retentionPolicy": {
"rules": [
{
"numberOfInstances": 3,
"distance": 60
}
]
},
"archiveSettings": null,
"initialSyncTime": 0
}New description of the replication
The initial synchronization time of the replication. The time is specified as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC. When set in the past, as 0, or as a negative, then the synchronization starts immediately. Passing null means no change is to be made.
Whether quiescing of the replication instances is supported. Passing null means no change is to be made.
Optional value. When the provided value is less than 0, the RPO does not change.
Accepted
{
"endTime": 1499929558827,
"error": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"id": "H4-2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
"vmName": "My-protected-vm",
"settings": {
"vcId": "52ce9bc4-2563-448d-b8af-9047a03ce5c2",
"vmId": "vm-15",
"description": "replication description",
"externalKey": null,
"excludedDiskKeys": [],
"rpo": 15,
"dataConnectionType": "ENCRYPTED",
"quiesced": true,
"sourceLocation": {
"site": "site1",
"replicatorId": "9664de13-6150-4315-9f59-2d85eb4c302f"
},
"destinationLocation": {
"site": "site2",
"replicatorId": "107102e0-e03b-404e-8e17-0688c657a74b"
},
"replicationPlacement": {
"datastoreId": "ds:uu:id",
"datastoreFolder": "fol/der",
"vcId": "vc:uu:id",
"disks": [
{
"diskKey": 2000,
"datastoreId": "ds:uu:id",
"diskPath": "disk/path",
"isSeed": false,
"storageProfileId": "86dae29f-d727-4a1c-9571-a03bdf74b923",
"contentId": "95d35bba-ca6e-451b-ad52-5d83c75ef5a7"
}
],
"validateSeedUuids": true,
"storageProfileId": "86dae29f-d727-4a1c-9571-a03bdf74b923"
},
"retentionPolicy": {
"rules": [
{
"numberOfInstances": 3,
"distance": 60
}
]
},
"autopinInstances": false,
"targetDiskType": "THIN",
"archiveSettings": null,
"startPaused": false,
"initialSyncTime": 0,
"isMigration": false,
"isReversed": false
},
"owner": "owner-1",
"destinationState": {
"currentRpoViolation": 25,
"latestInstance": {
"key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
"sequenceNumber": 11,
"timestamp": 1469701818743,
"transferBytes": 512000,
"transferSeconds": 4,
"quiescedType": "fileSystemQuiesced",
"isPinned": false
},
"state": "opened",
"recoveryInfo": {
"recoveryState": "NOT_STARTED",
"vcId": "5352b37c-ebf2-4d20-8733-1ccc54ff58d3",
"vmId": "vm-1",
"vmName": "myvm",
"optimizeUntil": 1
},
"lastError": {
"code": "Forbidden",
"msg": "Permission denied.",
"args": [],
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"stateAge": 0,
"replicatedDisks": [],
"spaceRequirement": 0,
"isMovingReplica": false
},
"sourceState": {
"state": "syncing",
"progress": {
"progress": 40,
"bytesTransferred": 400,
"bytesToTransfer": 1000,
"checksumTotalBytes": 1000,
"checksumComparedBytes": 1000
},
"stateAge": 0
},
"isPaused": false,
"lastUpdated": 618094800000,
"dataConnectionState": "SYNCING",
"overallHealth": "GREEN",
"sourceVmEncrypted": false
},
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "string",
"user": "root",
"warnings": [],
"workflowInfo": {}
}Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.
The unique identifier of the long-running task. It is unique and can be used for monitoring.
Timestamp in msec of the last task status update.
Percentage-based progress of the task.
Indicates the type of the task result. Populates only when the execution succeeds.
Site on which the task runs.
Timestamp in msec of the creation time of the task.
The user who started the task.
The returned error codes include (but are not limited to): NotAuthenticated
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
The returned error codes include (but are not limited to): GeneralServerFailure
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.