Replication
This request returns the details for the specified vApp replication.
Request
URI
GET
https://{api_host}//vapp-replications/{replicationId}
COPY
Path Parameters
string
replicationId
Required
Cloud vApp-level replication identifier
replicationId example
C4VAPP-ec991bd5-af9d-446a-8599-5b693842c4a3
Query Parameters
string
site
Optional
Optional site to run the operation on. When omitted, defaults to the local site.
site example
site1
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Responses
200
OK
Returns VappReplicationInfo of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"descriptor": {
"description": "vapp description in VMware Cloud Director",
"enabledTemplateCustomization": false,
"isGolden": false,
"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": {
"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,
"position": 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
}
}
],
"isEnabled": false,
"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": "string",
"owner": "org1@site2",
"source": {
"isTemplate": false,
"org": "org1",
"site": "site1",
"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": false,
"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,
"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": [
{
"distance": 15,
"numberOfInstances": 3
}
]
},
"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": "string",
"dsClusterName": "string",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "description",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}
]
}string
id
Optional
The vApp-level replication ID.
boolean
isMigration
Optional
True if the VM replication is a migration. Otherwise, it's a protection.
integer As int64 As int64
lastUpdated
Optional
StartTime of the latest task associated with this vApp replication.
string
owner
Optional
The organisation that owns the replication.
401
The returned error codes include (but are not limited to): NotAuthenticated, RemoteAuthenticationFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
404
The returned error codes include (but are not limited to): SiteNotFound
Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to): GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
On This Page
Vapp Replications Operations
POST
Apply Storage Profile
PATCH
Chown
DELETE
Cleanup Failover Test
POST
Failover
POST
Failover Test
GET
Get Effective Guest Customization Settings
GET
Get Network Settings
POST
Migrate
POST
Pause
PATCH
Reconfigure
PATCH
Reconfigure Disks
PUT
Replace Guest Customization Settings
PUT
Replace Network Settings
GET
Replication
GET
Replications
POST
Resume
POST
Reverse
POST
Start
DELETE
Stop
POST
Sync