Replication Query Replications
This request returns all the configured VM replications.
If present, returned replication's IDs will be in the given list. Comma-separated H4 replication IDs are expected.
H4-d50b197f-c0ab-4041-bf38-d59c8fda437c,H4-d75a6707-b9ee-4324-8848-0daf9c0a7bcbIf present, returned replications will be filtered by their data connection state.
OKIf present, returned replications will be filtered by their overall health.
GREENIf present, returned replications will be filtered by their source site.
site1If present, returned replications will be filtered by their destination site.
site2If present, returned replications will be filtered by whether they are migrations.
trueIf present, returned replications will be filtered by the name of the VM.
myvmIf present, returned replications will be filtered by whether the source VM is encrypted.
trueIf present. the returned replications are filtered by RPO values, greater than or equal to the configured value.
15If present. the returned replications are filtered by RPO values, less than or equal to the configured value.
15If present, returned replications will be filtered by their recovery state.
TESTIf present, returned replications will be filtered by source replicator.
79805fc7-27f3-4e73-9162-9c03fc910ef6If present, returned replications will be filtered by destination replicator.
a27adbef-546b-48d2-b3b0-cc976cefeb20An optional list of comma-separated fields, used to sort the result. The default sorting direction is ascending. When a field finishes with a hyphen, the direction for this field will be descending. This allows chaining e.g. col,col2-,col3 will result in sorting by col (asc), then by col2 (desc) and finally by col3 (asc). If this field is omitted, the result is sorted by start time in descending order.
vmName-Optional site to run the operation on. When omitted, defaults to the local site.
site1Query limit - maximum number of items this query should retrieve. If omitted or higher than the server's limits, defaults to 100.
Query offset - how many items to skip, before retrieving the actual items. If omitted, defaults to 0.
Operation ID for correlating logs across multiple services
OK
{
"items": [
{
"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
}
],
"limit": 100,
"offset": 0,
"total": 3
}Maximum number of items that this query could retrieve.
How much items were skipped, before retrieving the actual items.
The total number of items.
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.