Replications
Query the configured vApp-level replications.
If present, returned replications will be filtered by destination org.
org2
If present, returned replications will be filtered by destination site type.
vcloud
If present, returned replications will be filtered by destination vDC id.
f3f9df5d-006b-429b-875b-028f0012759b
If present, returned replications will be filtered by destination vDC name.
org2_vdc2
If present, returned replications' IDs will be in the given list. Comma-separated C4 vApp replication IDs are expected.
C4VAPP-dadaf8ce-2333-440a-96f8-eec92ccc9cdb,C4VAPP-68129bba-e584-450a-aa15-4c674f437a22
If present, returned replications will be filtered by replication type: migration or protection.
true
If present, only replications for which management operations that were performed after the specified date are returned.
1499929500000
If present, only replications for which management operations that were performed no later than the specified date are returned.
1499929599999
Query limit - maximum number of items this query should retrieve. If omitted or higher than the server's limits, defaults to 100.
10
Query offset - how much items to skip, before retrieving the actual items. If omitted, defaults to 0.
10
If present, returned replications will be filtered by replication owner. Filtering option available only to admins.
org2@site2
If present, returned replications will be filtered by destination recovered vAppId.
05bab7e6-adb9-4aa6-9e38-70f8b9e25613
Optional site to run the operation on. If omitted, defaults to the local site.
site2
An optional list of comma-separated fields, used to sort the result. The default sorting direction is ascending. If one of the fields ends 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). Supported fields: [name, sourceSite, sourceOrg, sourceVdcName, destinationOrg, destinationVdcName, site, owner, lastUpdated]. If this field is omitted, the result is sorted by last update time in descending order.
sort
If present, returned replications will be filtered by vCD source org.
org1
If present, returned replications will be source site short name. Local site filtering is not supported.
site1
If present, returned replications will be filtered by source site type.
vcenter
If present, returned replications will be filtered by source vDC id.
38c4079d-131e-499f-aadb-60dfbaf85c08
If present, returned replications will be filtered by source vDC name.
org1_vdc1
If present, returned replications will be filtered by source vApp Id.
7a659b40-52fd-41f0-b0e0-5ea31c33c277
If present, returned replications will be filtered by vCD vApp name. The vApp name must contain the provided value.
vApp001
Operation ID for correlating logs across multiple services
OK
{
"items": [
{
"descriptor": {
"description": "vapp description in vCD",
"metadata": {},
"name": "my vapp 1",
"networks": [
{
"dhcpService": {
"defaultLeaseTime": 0,
"domainName": "string",
"ipRange": {
"endAddress": "string",
"startAddress": "string"
},
"isEnabled": false,
"maxLeaseTime": 0,
"primaryNameServer": "string",
"routerIp": "string",
"secondaryNameServer": "string",
"subMask": "string"
},
"fenceMode": "string",
"firewallService": {
"IsEnabled": false,
"defaultAction": "string",
"firewallRules": [
{
"description": "string",
"destinationIp": "string",
"destinationPortRange": "string",
"destinationVm": {
"ipType": "string",
"vmName": "string",
"vmNicId": 0
},
"direction": "string",
"enableLogging": false,
"icmpSubType": "string",
"id": "string",
"isEnabled": false,
"matchOnTranslate": false,
"policy": "string",
"port": 0,
"protocol": {
"any": false,
"icmp": false,
"other": "string",
"tcp": false,
"udp": false
},
"sourceIp": "string",
"sourcePort": 0,
"sourcePortRange": "string",
"sourceVm": {
"ipType": "string",
"vmName": "string",
"vmNicId": 0
}
}
],
"logDefaultAction": false
},
"ipScopes": [
{
"allocatedIpAddresses": [
"string"
],
"dnsSuffix": "string",
"gateway": "string",
"ipRanges": [
{
"endAddress": "string",
"startAddress": "string"
}
],
"isEnabled": false,
"isInherited": false,
"netmask": "string",
"primaryDns": "string",
"secondaryDns": "string"
}
],
"name": "string",
"natService": {
"externalIp": "string",
"isEnabled": false,
"natRules": [
{
"description": "string",
"gatewayNatRule": {
"icmpSubType": "string",
"originalIp": "string",
"originalPort": "string",
"protocol": "string",
"translatedIp": "string",
"translatedPort": "string"
},
"id": 0,
"isEnabled": false,
"oneToOneBasicRule": {
"externalIpAddress": "string",
"internalIpAddress": "string",
"mappingMode": "string"
},
"oneToOneVmRule": {
"externalIpAddress": "string",
"mappingMode": "string",
"vmName": "string",
"vmNicId": 0
},
"portForwardingRule": {
"externalIpAddress": "string",
"externalPort": 0,
"internalIpAddress": "string",
"internalPort": 0,
"protocol": "string"
},
"type": "string",
"vmRule": {
"externalIpAddress": "string",
"externalPort": 0,
"internalPort": 0,
"protocol": "string",
"vmName": "string",
"vmNicId": 0
}
}
],
"policy": "string",
"type": "string"
},
"parentId": "string",
"parentName": "string"
}
]
},
"destination": {
"org": "org2",
"recoveredVappId": "null",
"site": "site2",
"vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
"vdcName": "Virtual DC 2"
},
"id": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"isMigration": false,
"lastUpdated": 0,
"overallHealth": "GREEN",
"owner": "org1@site2",
"source": {
"org": "org1",
"site": "site1",
"vappId": "d6977f40-4d90-46b2-a34e-5077e8648eda",
"vdcId": "f61d60d2-698a-46dc-a266-88df27644956",
"vdcName": "Virtual DC 1"
},
"vmReplications": [
{
"computerName": "null",
"dataConnectionState": "SYNCING",
"destinationState": {
"currentRpoViolation": 25,
"isMovingReplica": false,
"lastError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"latestInstance": {
"key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
"quiescedType": "fileSystemQuiesced",
"sequenceNumber": 11,
"timestamp": 1469701818743,
"transferBytes": 512000,
"transferSeconds": 4
},
"recoveryInfo": {
"recoveryState": "NOT_STARTED",
"vAppId": "null",
"vcdVmId": "null"
},
"spaceRequirement": 0,
"state": "opened",
"stateAge": 0
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": false,
"isReversed": false,
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "GREEN",
"settings": {
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"excludedDiskKeys": [
0
],
"initialSyncTime": 0,
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"distance": 15,
"numberOfInstances": 3
}
]
},
"rpo": 15
},
"sourceState": {
"progress": {
"bytesToTransfer": 1000,
"bytesTransferred": 400,
"checksumComparedBytes": 1000,
"checksumTotalBytes": 1000,
"progress": 40
},
"state": "idle",
"stateAge": 0
},
"startupInfo": {
"order": 0,
"startAction": "powerOn",
"startDelay": 0,
"stopAction": "powerOff",
"stopDelay": 0
},
"storageProfile": "null",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"datastoreName": "test datastore",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "null",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}
]
}
],
"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.
Returned error codes include (but are not limited to):
- UnsupportedSortingField
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
Returned error codes include (but are not limited to):
- NotAuthenticated
- RemoteAuthenticationFailure
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
Returned error codes include (but are not limited to):
- SiteNotFound
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
Returned error codes include (but are not limited to):
- GeneralServerFailure
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.