Failover Vm Replication

Failover Vm Replication

This request fails over the specified VM replication to the destination site.

The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

Request
URI
POST
https://{api_host}/vm-replications/{replicationId}/failover
COPY
Path Parameters
string
replicationId
Required

Cloud VM-level replication identifier

replicationId example 
C4-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

Request Body 
{
    "consolidate": false,
    "instanceId": "6959cd85-5bd9-47a2-886b-3d938e3c0856",
    "type": "vcloud",
    "vmNetworkSettings": {
        "de68576d-7505-490e-ab9e-1942c2c965c4": {
            "primaryNicIndex": 0,
            "nics": [
                {
                    "nicIndex": 0,
                    "isConnected": true,
                    "resetMacAddress": false,
                    "network": "ext_net_vdc_s1Org",
                    "ipAddress": "",
                    "ipAddressAllocationMode": "POOL",
                    "externalIpAddress": "10.71.232.255",
                    "networkAdapterType": "",
                    "needsCustomization": false,
                    "macAddress": "00:50:56:8a:b2:a8"
                }
            ],
            "copySourceNicSettings": true,
            "computerName": "testpc",
            "enableGuestCustomization": true
        }
    },
    "vAppNetworkSettings": {
        "networkMappings": [
            {
                "sourceNetworkName": "ext_net_vdc_s1Org",
                "sourceOrgVdcNetwork": {
                    "id": "e5a39b99-6c27-493c-acce-7eae3cd7414e",
                    "name": "ext_net_vdc_s1Org"
                },
                "destinationOrgVdcNetwork": {
                    "id": "f1c31b8d-c36b-4c2e-9236-cf97f5046072",
                    "name": "ext_net_vdc_s2Org"
                }
            }
        ],
        "copySourceNetworks": true,
        "bridgeOrgVdcNetworks": [],
        "bulkConnectVmNics": false
    },
    "powerOn": true
}
Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns C4ApiTask_of_SingleVmReplicationInfo of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "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": {
            "destinationCatalogItemId": "0221b98b-b91c-4524-a491-f744f67bffbe",
            "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": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

SingleVmReplicationInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

string
site
Optional

Site on which the task runs.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


400

The returned error codes include (but are not limited to): BadRequest

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+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.


401

The returned error codes include (but are not limited to): NotAuthenticated, RemoteAuthenticationFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+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.7+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.7+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
Vm Replications Operations
POST
Apply Storage Profile Vm Replication
PATCH
Chown Vm Replication
DELETE
Cleanup Failover Test Vm Replication
GET
Disk Samples Vm Replication
POST
Failover Test Vm Replication
POST
Failover Vm Replication
GET
Get Effective Guest Customization Vm Replication
GET
Get Network Settings Vm Replication
GET
Get Virtual Hardware
GET
Get Vm Replication
GET
Instance Vm Replication
GET
Instances Vm Replication
POST
Migrate Vm Replication
POST
Pause Vm Replication
PATCH
Reconfigure Disks Vm Replication
PATCH
Reconfigure Vm Replication
PUT
Replace Guest Customization Vm Replication
PUT
Replace Network Settings Vm Replication
POST
Resume Vm Replication
POST
Reverse Vm Replication
POST
Start Vm Replication
DELETE
Stop Vm Replication
POST
Sync Vm Replication
GET
Traffic Samples Vm Replication
GET
Vm Replications