Replications
This request returns all the configured vApp replications.
Optional site to run the operation on. If omitted, defaults to the local site.
site2If present, returned replications will be filtered by replication owner. Filtering option available only to admins.
org2@site2If present, returned replications will be filtered by source vDC id.
38c4079d-131e-499f-aadb-60dfbaf85c08If present, returned replications will be filtered by source vDC name.
org1_vdc1If present, returned replications will be filtered by source site short name. Local site filtering is not supported.
site1If present, returned replications will be filtered by VMware Cloud Director source org.
org1If present, returned replications will be filtered by source site type.
vcenterIf present, returned replications will be filtered by source vApp Id.
7a659b40-52fd-41f0-b0e0-5ea31c33c277If present, returned replications will be filtered by VMware Cloud Director vApp name. The vApp name must contain the provided value.
vApp001If present, returned replications will be filtered by destination org.
org2If present, returned replications will be filtered by destination vDC id.
f3f9df5d-006b-429b-875b-028f0012759bIf present, returned replications will be filtered by destination site type.
vcloudIf present, returned replications will be filtered by destination vDC name.
org2_vdc2If present, returned replications will be filtered by destination recovered vAppId.
05bab7e6-adb9-4aa6-9e38-70f8b9e25613If present, returned replications will be filtered by replication type: migration or protection.
trueIf present, only replications for which management operations that were performed no later than the specified date are returned.
1499929599999If present, only replications for which management operations that were performed after the specified date are returned.
1499929500000If 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-4c674f437a22An 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.
sortQuery limit - maximum number of items this query should retrieve. If omitted or higher than the server's limits, defaults to 100.
10Query offset - how much items to skip, before retrieving the actual items. If omitted, defaults to 0.
10Operation ID for correlating logs across multiple services
OK
{
"items": [
{
"descriptor": {
"description": "vapp description in VMware Cloud Director",
"enabledTemplateCustomization": false,
"isGolden": false,
"metadata": {},
"name": "my vapp 1",
"networks": [
{
"dhcpService": {
"defaultLeaseTime": 86400,
"domainName": "acme.com",
"ipRange": {
"endAddress": "10.71.80.255",
"startAddress": "10.71.80.0"
},
"isEnabled": true,
"maxLeaseTime": 86400,
"primaryNameServer": "8.8.8.8",
"routerIp": "192.168.0.1",
"secondaryNameServer": "8.8.4.4",
"subMask": "255.255.255.0"
},
"fenceMode": "bridged",
"firewallService": {
"defaultAction": "allow",
"firewallRules": [],
"isEnabled": true,
"logDefaultAction": false
},
"ipScopes": [
{
"allocatedIpAddresses": [
"10.71.81.55"
],
"dnsSuffix": "acme.com",
"gateway": "192.168.4.1",
"ipRanges": [
{
"startAddress": "10.71.80.0",
"endAddress": "10.71.80.255"
}
],
"isEnabled": true,
"isInherited": true,
"netmask": "255.255.225.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.4.4"
}
],
"name": "myvappnetworkdescriptor",
"natService": {
"externalIp": "1.2.3.4",
"isEnabled": true,
"natRules": [
{
"description": "Some description.",
"gatewayNatRule": {
"icmpSubType": "any",
"originalIp": "10.20.30.40",
"originalPort": "\"80\"",
"protocol": "TCP",
"translatedIp": "11.22.33.44",
"translatedPort": "\"88\""
},
"id": 1,
"isEnabled": true,
"oneToOneBasicRule": {
"externalIpAddress": "any",
"internalIpAddress": "any",
"mappingMode": "automatic"
},
"oneToOneVmRule": {
"externalIpAddress": "10.71.80.255",
"mappingMode": "automatic",
"vmName": "myvm",
"vmNicId": 0
},
"portForwardingRule": {
"externalIpAddress": "10.71.80.255",
"externalPort": 80,
"internalIpAddress": "10.20.30.40",
"internalPort": 88,
"protocol": "TCP"
},
"type": "SNAT",
"vmRule": {
"externalIpAddress": "10.71.80.255",
"externalPort": 80,
"internalPort": 88,
"protocol": "TCP",
"vmName": "myvm",
"vmNicId": 0
}
}
],
"policy": "allowTraffic",
"type": "ipTranslation"
},
"parentId": "b879c7ba-461e-46fe-af51-8208c063002e",
"parentName": "myparent",
"routerExternalIp": "10.20.30.40"
}
],
"sourceCatalogItemId": "0221b98b-b91c-4524-a491-f744f67bffbe"
},
"destination": {
"destinationCatalogItemId": "0221b98b-b91c-4524-a491-f744f67bffbe",
"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": "string",
"owner": "org1@site2",
"source": {
"isTemplate": false,
"org": "org1",
"site": "site1",
"sourceCatalogId": "0221b98b-b91c-4524-a491-f744f67bffbe",
"sourceCatalogName": "Catalog1",
"vappId": "d6977f40-4d90-46b2-a34e-5077e8648eda",
"vdcId": "f61d60d2-698a-46dc-a266-88df27644956",
"vdcName": "Virtual DC 1"
},
"vmReplications": [
{
"computerName": "computerName",
"dataConnectionState": "string",
"destinationState": {
"currentRpoViolation": 25,
"isMovingReplica": false,
"lastError": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"latestInstance": {
"isPinned": true,
"key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
"quiescedType": "string",
"sequenceNumber": 11,
"timestamp": 1469701818743,
"transferBytes": 512000,
"transferSeconds": 4
},
"spaceRequirement": 0,
"state": "string",
"stateAge": 0
},
"guestCustomization": {
"adminAutoLogonCount": 3,
"adminPassword": "sEcUrEpAsS",
"adminPasswordAuto": true,
"adminPasswordEnabled": true,
"changeSid": true,
"computerName": "workload-69",
"customizationScript": "echo 'hello world'",
"domainName": "workgroup",
"domainOrgUnit": "computers",
"domainUserName": "user1",
"domainUserPassword": "sEcUrEpAsS",
"enabled": true,
"joinDomainEnabled": true,
"resetPasswordRequired": true,
"resolutionType": "string",
"useOrgSettings": true
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": false,
"isReversed": false,
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "string",
"owner": "org1@site1",
"placementPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
"placementPolicyName": "Gold",
"settings": {
"dataConnectionType": "string",
"description": "new description",
"excludedDiskKeys": [
0
],
"initialSyncTime": 0,
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"numberOfInstances": 3,
"distance": 60
}
]
},
"rpo": 15,
"targetDiskType": "string"
},
"sizingPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
"sizingPolicyName": "SizingPolicy1",
"slaProfile": {
"displayName": "Gold",
"id": "61c528c8-1a8c-4c4e-8886-f1b6eeba98a5"
},
"sourceState": {
"stateAge": 0
},
"sourceVmEncrypted": false,
"startupInfo": {
"order": 0,
"startAction": "powerOn",
"startDelay": 0,
"stopAction": "powerOff",
"stopDelay": 0
},
"storageProfile": "ecde053f-1aed-4547-b73a-52b9f7c48298",
"storageProfileName": "*",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"datastoreName": "test datastore",
"dsClusterMoref": "test datastore cluster",
"dsClusterName": "datastoreCluster-12",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "description",
"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.
The returned error codes include (but are not limited to): UnsupportedSortingField
{
"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): NotAuthenticated, RemoteAuthenticationFailure
{
"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): SiteNotFound
{
"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.