Start Vm Replication
This request configures a new replication for the specified VM.
Optional site to run the operation on. When omitted, defaults to the local site.
site1
Operation ID for correlating logs across multiple services
On-Prem-Auth
{
"source": {
"type": "vm",
"site": "site1",
"vmId": "441a891a-5294-4dff-b02d-c605d335be1b",
"excludedDiskKeys": null
},
"destination": {
"type": "vcloud",
"site": "site2",
"vdc": "d6977f40-4d90-46b2-a34e-5077e8648eda",
"storageProfile": "*"
},
"description": "A Protected Workload",
"rpo": 5,
"slaProfileId": null,
"dataConnectionType": "ENCRYPTED",
"quiesced": true,
"retentionPolicy": {
"rules": [
{
"numberOfInstances": 3,
"distance": 60
}
]
},
"targetDiskType": "THIN",
"initialSyncTime": 0,
"isMigration": false
}
The description of the replication.
The destination location 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 a 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.
The SLA Profile to use instead of the custom rpo/dataConnectionType/retentionPolicy settings
The source location of the replication.
Accepted
{
"endTime": 1499929558827,
"error": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"destination": {
"org": "org2",
"recoveredVappId": "null",
"site": "site2",
"vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
"vdcName": "Virtual DC 2"
},
"source": {
"vappName": "vApp1"
},
"vappReplicationId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963"
},
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "string",
"user": "root",
"warnings": [],
"workflowInfo": {}
}
Timestamp in msec of the completion time of the task. -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 creation time of the task.
The user who started the task.
The returned error codes include (but are not limited to): BadRequest, ServiceNotLicensed
{
"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.