vCloud Availability API Reference Data Structures
{
"buildDate": "integer",
"buildVersion": "string",
"instanceId": "string",
"productName": "string",
"serviceType": "string"
}RPM build time.
Represents the product version along with the build id.
Unique identifier of the service, which never changes.
The name of the product.
Machine readable service type ID.
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
{
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}{
"endTime": 1499929558827,
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"generatedOn": "1464261608370L",
"id": "b05d1e00-6338-48ff-86fb-ee0e55b8cd93",
"owner": "owner1",
"sha": "SHA-256:45C9A6614FCCD4F9592D8283A4F25BFF84076FD43EE9F90EAA07746EBBED02CA"
},
"resultType": "string",
"startTime": 1499929548951,
"state": "SUCCEEDED",
"user": "root",
"warnings": [],
"workflowInfo": {
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}
}Timestamp (in msec) of the task's completion time. -1 means the task hasn't completed.
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. Populated only if the execution was successful.
Timestamp (in msec) of the task's creation time.
The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]
The user who started the task.
{
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}Id of the resource associated with the task. Some tasks don't have a resourceId.
Name of the resource associated with the task. Some resources don't have a name.
Type of the resource associated with the task.
The workflow type.
{
"site": "site2",
"type": "string"
}Identifies the vCD sites we're logging into.
type
{
"org": "Org1",
"site": "site1"
}Authenticated organization
Authenticated site
{
"type": "string"
}type
{
"endTime": 1499929558827,
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"descriptor": {
"description": "vapp description in vCD",
"metadata": {},
"name": "my vapp 1"
},
"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": "boolean",
"lastUpdated": "integer",
"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": "boolean",
"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": "integer",
"state": "opened",
"stateAge": "integer"
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": "boolean",
"isReversed": "boolean",
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "GREEN",
"settings": {
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"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": "integer"
},
"startupInfo": {
"order": "integer",
"startAction": "powerOn",
"startDelay": "integer",
"stopAction": "powerOff",
"stopDelay": "integer"
},
"storageProfile": "null",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "null",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}
]
},
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "SUCCEEDED",
"user": "root",
"warnings": [],
"workflowInfo": {
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}
}Timestamp (in msec) of the task's completion time. -1 means the task hasn't completed.
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. Populated only if the execution was successful.
Site on which the task runs.
Timestamp (in msec) of the task's creation time.
The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]
The user who started the task.
{
"endTime": 1499929558827,
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "SUCCEEDED",
"user": "root",
"warnings": [],
"workflowInfo": {
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}
}Timestamp (in msec) of the task's completion time. -1 means the task hasn't completed.
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. Populated only if the execution was successful.
Site on which the task runs.
Timestamp (in msec) of the task's creation time.
The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]
The user who started the task.
{
"endTime": 1499929558827,
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "SUCCEEDED",
"user": "root",
"warnings": [],
"workflowInfo": {
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}
}Timestamp (in msec) of the task's completion time. -1 means the task hasn't completed.
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.
The result of the task. Populated only if the execution was successful.
Indicates the type of the task result. Populated only if the execution was successful.
Site on which the task runs.
Timestamp (in msec) of the task's creation time.
The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]
The user who started the task.
{
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"distance": 15,
"numberOfInstances": 3
}
]
},
"rpo": 15
}What LWD traffic mode is supported. Can be PLAIN, ENCRYPTED or ENCRYPTED_COMPRESSED.
The descrioption of the replication.
Replicated image guest quiescing - if empty/omitted no change will be applied.
Recovery point objective in minutes - if empty/omitted no change will be applied.
{
"authenticatedSites": [
{
"org": "Org1",
"site": "site1"
}
],
"roles": [
"EVERYONE"
],
"user": "admin1@Org1"
}vCloud Director sites the current session has authenticated with. The site specified in the request should be present here
Roles granted to the session
The currently authenticated user
{
"owner": "org1@site1"
}Optional owner of the replication, if omitted the currently logged in user becomes the owner.
{
"currentRpoViolation": 25,
"isMovingReplica": "boolean",
"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": "integer",
"state": "opened",
"stateAge": "integer"
}Currently accumulated RPO violation.
Shows whether the replica files are being moved right now.
The space used on the destination site.
State of the replication on the destination site (reported by the HBR). Can be one of [idle, passive, opened, fullsync, lwd, prune, paused, unknown]
The number of milliseconds elapsed since this state was received from the remote site. Client UIs should display a warning if this is greater that the current RPO.
{
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"managerConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"managerHealth": {
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"localReplicatorsHealth": [
{
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"hbrConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"lwdProxyConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"onlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"productName": "string",
"runtimeId": "string"
}
],
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineReplicators": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": "boolean",
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"onlineReplicators": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": "boolean",
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"productName": "string",
"runtimeId": "string"
},
"productName": "string",
"runtimeId": "string",
"tunnelConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"vcdConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}The address of the appliance.
RPM build time.
Represents the product version along with the build id.
The current time of the appliance.
Unique identifier of the service, which never changes.
The name of the product.
A value that remains constant as long as the service is running. If it changes, this means the service was rebooted.
{
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"isMigration": "boolean",
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"distance": 15,
"numberOfInstances": 3
}
]
},
"rpo": 15,
"source": {
"site": "site1",
"type": "string"
},
"targetDiskType": "THIN",
"destination": {
"type": "string"
}
}What LWD traffic mode is supported. Can be PLAIN, ENCRYPTED or ENCRYPTED_COMPRESSED.
The descrioption of the replication.
Replication initial sync time. If in the past, 0 or negative, the sync will not be delayed. The time is specified as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC
Whether the replication is actually migration.
Replicated image guest quiescing - if empty/omitted no change will be applied.
Recovery point objective in minutes - if empty/omitted no change will be applied.
Optional type of virtual disks created on DR site. Possible values are: [THIN, PREALLOCATED, PREALLOCATED_ZEROS]. Default value is:THIN
{
"org": "org2",
"recoveredVappId": "null",
"site": "site2",
"vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
"vdcName": "Virtual DC 2"
}The shortname of the org to which the vApp is replicated.
The vCloud vApp on the destination site that holds the recovered VM (only populated if one or more VMs belonging to the same source vApp are recovered on the destination site).
The shortname of the destination site.
vCloud Virtual Datacenter ID on the destination site.
vCloud Virtual Datacenter Name on the destination site.
{
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true
}
}Network settings for each VM organized as map by VM ID
{
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"localReplicatorsHealth": [
{
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"hbrConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"lwdProxyConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"onlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"productName": "string",
"runtimeId": "string"
}
],
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineReplicators": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": "boolean",
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"onlineReplicators": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": "boolean",
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"productName": "string",
"runtimeId": "string"
}The address of the appliance.
RPM build time.
Represents the product version along with the build id.
The current time of the appliance.
Unique identifier of the service, which never changes.
Health info for each online local replicator. If the 'local site' property is not set for this manager, this list will always be empty.
List of replicators to which the manager can't talk to.
List of replicators to which the manager can talk to.
The name of the product.
A value that remains constant as long as the service is running. If it changes, this means the service was rebooted.
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}The manager's address.
The manager's thumbprint.
The pairing description.
UUID of the pairing.
vCenter password.
vCenter username.
The user who requested the pairing.
{
"access": "READONLY",
"key": "val1",
"type": "STRING",
"value": "Hello, world!"
}access
key
type
value
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}id
name
{
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}Current instance progress (if any).
{
"bytesToTransfer": 1000,
"bytesTransferred": 400,
"checksumComparedBytes": 1000,
"checksumTotalBytes": 1000,
"progress": 40
}bytesToTransfer
bytesTransferred
checksumComparedBytes
checksumTotalBytes
progress
{
"items": [
{
"endTime": 1499929558827,
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "SUCCEEDED",
"user": "root",
"warnings": [],
"workflowInfo": {
"resourceId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
"resourceName": "my vapp 1",
"resourceType": "vappReplication",
"type": "sync"
}
}
],
"limit": 100,
"offset": "integer",
"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.
{
"items": [
{
"descriptor": {
"description": "vapp description in vCD",
"metadata": {},
"name": "my vapp 1"
},
"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": "boolean",
"lastUpdated": "integer",
"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": "boolean",
"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": "integer",
"state": "opened",
"stateAge": "integer"
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": "boolean",
"isReversed": "boolean",
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "GREEN",
"settings": {
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"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": "integer"
},
"startupInfo": {
"order": "integer",
"startAction": "powerOn",
"startDelay": "integer",
"stopAction": "powerOff",
"stopDelay": "integer"
},
"storageProfile": "null",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "null",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}
]
}
],
"limit": 100,
"offset": "integer",
"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.
{
"type": "string"
}type
{
"key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
"quiescedType": "fileSystemQuiesced",
"sequenceNumber": 11,
"timestamp": 1469701818743,
"transferBytes": 512000,
"transferSeconds": 4
}PIT instance identifier. Should be used when failing over.
Type of quiescing.
Counter, which represents the sequential number of this instance
When was this instance created.
Total bytes in this instance (transferred during the delta and, for VMs running on MN.next+hosts, any preceding full sync). For VMs replicating from older (MN) hosts, this does not include the bytes for any full sync, just the delta.
Total time in seconds it took to transfer this instance(for VMs running on MN.next+ hosts, this includes any preceeding full sync).
{
"site": "site1",
"type": "string"
}vCloud site shortname
type
{
"address": "string",
"buildDate": "integer",
"buildVersion": "string",
"currentTime": "integer",
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"hbrConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"lwdProxyConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"onlineManagers": [
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"productName": "string",
"runtimeId": "string"
}The address of the appliance.
RPM build time.
Represents the product version along with the build id.
The current time of the appliance.
Unique identifier of the service, which never changes.
List of replication managers to which the replicator can't talk to.
List of replication managers to which the replicator can talk to.
The name of the product.
A value that remains constant as long as the service is running. If it changes, this means the service was rebooted.
Indicates communication errors related to the vCenters. Connections areverified using the credentials, provided during the pairing with the manager. The following data structure is used: managerId -> [ {vc1 : error}, {vc2: error} ]
{
"apiUrl": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": "boolean",
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}URL where the replicator's REST API can be reached. Guaranteed to be populated for 'fully' registered replicators. WARNING: This will change once L4 tunneling is in place!
The replicator's certificate, used to verify both outgoing and incoming connections. Guaranteed to be populated for 'fully' registered replicators.
API-User-supplied description of this replicator
The unique identifier (instance uuid) of the replicator. It might be null, before the replicator is fully paired.
Whether this replicator is temporarily out of service due to maintenance.
The owner of this replicator.
A cookie the replicator can use to register or re-register with this manager. Registration cookies can only be used once.
Site identifier. Not interpreted by replication manager, but can be used for filtering or automatic replicator selection.
{
"cause": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"error": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}{
"rules": [
{
"distance": 15,
"numberOfInstances": 3
}
]
}{
"distance": 15,
"numberOfInstances": 3
}Specifies how many minutes there should be between each two consequent retained instances.
Specifies how many instances to retain
{
"org": "org1",
"site": "site1",
"vappId": "d6977f40-4d90-46b2-a34e-5077e8648eda",
"vdcId": "f61d60d2-698a-46dc-a266-88df27644956",
"vdcName": "Virtual DC 1"
}The shortname of the org the source vApp belongs to.
The shortname of the site that holds the source vApp.
Source vApp vCloud ID.
The vCD Virtual Datacenter Id where the source vApp resides.
The vCD Virtual Datacenter Name where the source vApp resides.
{
"progress": {
"bytesToTransfer": 1000,
"bytesTransferred": 400,
"checksumComparedBytes": 1000,
"checksumTotalBytes": 1000,
"progress": 40
},
"state": "idle",
"stateAge": "integer"
}State of the replication on the source site. Can be one of [none, paused, syncing, idle, active, error]
The number of milliseconds elapsed since this state was received from the remote site. Client UIs should display a warning if this is greater that the current RPO.
{
"storageProfileId": "91932be0-b038-4667-a9ed-cefa4c08d7f4"
}The storage profile to be applied to the VM replication. If null is specified the current storage profile will be re-applied (this will cause changes in the existing storage profile made in VC to take effect, possibly migrating the replication and its related independent disk to a new datastore).
{
"cookie": "string"
}cookie
{
"generatedOn": "1464261608370L",
"id": "b05d1e00-6338-48ff-86fb-ee0e55b8cd93",
"owner": "owner1",
"sha": "SHA-256:45C9A6614FCCD4F9592D8283A4F25BFF84076FD43EE9F90EAA07746EBBED02CA"
}When the support bundle was created.
Id of the support bundle.
Owner of the support bundle.
SHA.
{
"propertyNames": [
"string"
],
"values": [
[
{}
]
]
}propertyNames
values
{
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true
}Specifies whether to connect all VM NICs to single orgVdcNetwork. It cannot be specified in combination with vmNetworkSettings.
{
"failoverSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true
}
},
"failoverTestSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true
}
}
}{
"description": "vapp description in vCD",
"metadata": {},
"name": "my vapp 1"
}Replicated vCloud vApp description.
Replicated vCloud vApp metadata.
Replicated vCloud vApp name.
{
"type": "string"
}type
{
"type": "string"
}type
{
"descriptor": {
"description": "vapp description in vCD",
"metadata": {},
"name": "my vapp 1"
},
"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": "boolean",
"lastUpdated": "integer",
"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": "boolean",
"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": "integer",
"state": "opened",
"stateAge": "integer"
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": "boolean",
"isReversed": "boolean",
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "GREEN",
"settings": {
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"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": "integer"
},
"startupInfo": {
"order": "integer",
"startAction": "powerOn",
"startDelay": "integer",
"stopAction": "powerOff",
"stopDelay": "integer"
},
"storageProfile": "null",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "null",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}
]
}The vApp-level replication ID.
True if the VM replication is a migration. Otherwise, it's a protection.
StartTime of the latest task associated with this vApp replication.
Representation of the replication health suitable for UI purposes.
The id of the user that owns the replication.
{
"type": "string"
}type
{
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
}vCenter Server datastore.
vCenter Server datastore moref.
vCenter Server.
vCenter Server instance UUID.
{
"nics": [
{
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "DHCP",
"isConnected": "boolean",
"network": "network1",
"nicIndex": "integer",
"resetMacAddress": true
}
],
"primaryNicIndex": "integer"
}primaryNicIndex
{
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "DHCP",
"isConnected": "boolean",
"network": "network1",
"nicIndex": "integer",
"resetMacAddress": true
}IP address of the NIC.
Ip Address allocation mode. Can be one of POOL, DHCP, MANUAL, NONE.
Indicates whether the NIC should be connected.
The name of the network to which the NIC is attached.
Index of the NIC starting from 0 in a VM.
Indicates whether the NIC MAC address should be reset (regenerated) or kept as it is.
{
"recoveryState": "NOT_STARTED",
"vAppId": "null",
"vcdVmId": "null"
}State of VM recovery. Test failover, failover and cleanup failover test change it. Possible values: [NOT_STARTED, IN_PROGRESS, TEST, COMPLETE]
The vCloud vApp on the destination site that holds the recovered VM (only populated if one or more VMs belonging to the same source vApp are recovered on the destination site.)
The recovered vCloud VM on the destination site.
{
"computerName": "null",
"dataConnectionState": "SYNCING",
"destinationState": {
"currentRpoViolation": 25,
"isMovingReplica": "boolean",
"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": "integer",
"state": "opened",
"stateAge": "integer"
},
"id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
"isMigration": true,
"isPaused": "boolean",
"isReversed": "boolean",
"lastUpdated": 618094800000,
"metadata": {},
"overallHealth": "GREEN",
"settings": {
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"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": "integer"
},
"startupInfo": {
"order": "integer",
"startAction": "powerOn",
"startDelay": "integer",
"stopAction": "powerOff",
"stopDelay": "integer"
},
"storageProfile": "null",
"vimLocation": {
"datastore": "datastore",
"datastoreMoref": "datastore-33",
"vimServer": "vim server",
"vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
},
"vmDescription": "null",
"vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
"vmName": "my vm 1"
}vCloud VM computer name.
Shows the replication traffic (data) connection health. Possible values: [SYNCING, INITIAL_SYNCING, OK, PAUSED, POWERED_OFF, PRUNING, FINISHED, UNKNOWN, ERROR]
The VM-level replication ID.
True if the VM replication is a migration. Otherwise, it's a protection.
Indicates whether the underlying VM replication is paused.
Whether the replication is reversed. Note this flag gets inverted on each reverse, so only the odd reversed replication will show 'true'.
The startTime of the latest task associated with this vm replication.
vCloud Director metadata for the VM.
Representation of the replication health suitable for UI purposes.
Destination storage profile.
vCloud VM description.
vCloud VM ID.
vCloud VM name.
{
"dataConnectionType": "ENCRYPTED_COMPRESSED",
"description": "new description",
"initialSyncTime": "integer",
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"distance": 15,
"numberOfInstances": 3
}
]
},
"rpo": 15
}What LWD traffic mode is supported. Can be PLAIN, ENCRYPTED or ENCRYPTED_COMPRESSED.
The descrioption of the replication.
Replication initial sync time. If in the past, 0 or negative, the sync will not be delayed. The time is specified as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC
Replicated image guest quiescing - if empty/omitted no change will be applied.
Recovery point objective in minutes - if empty/omitted no change will be applied.
{
"order": "integer",
"startAction": "powerOn",
"startDelay": "integer",
"stopAction": "powerOff",
"stopDelay": "integer"
}order
startAction
startDelay
stopAction
stopDelay