Failover Vm Replication

Failover Vm Replication

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

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

The VM Replication unique identifier

replicationId example 
C4-09b2917c-bbe9-4693-ae3f-95b43a94b244
Query Parameters
string
site
Optional

site

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

failoverSettings

VmReplicationFailoverSettings of type(s) application/json
Required 
{
    "type": "string"
}
string
type
Required

type

Possible values are : vcenter, vcloud,
Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns C4ApiTaskOfSingleVmReplicationInfo of type(s) application/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": {
        "computerName": "computerName",
        "dataConnectionState": "SYNCING",
        "destination": {
            "org": "org2",
            "recoveredVappId": "null",
            "site": "site2",
            "vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
            "vdcName": "Virtual DC 2"
        },
        "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": "fileSystemQuiesced",
                "sequenceNumber": 11,
                "timestamp": 1469701818743,
                "transferBytes": 512000,
                "transferSeconds": 4
            },
            "recoveryInfo": {
                "recoveryState": "NOT_STARTED"
            },
            "spaceRequirement": 0,
            "state": "opened",
            "stateAge": 0
        },
        "id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
        "isMigration": true,
        "isPaused": false,
        "isReversed": false,
        "lastUpdated": 618094800000,
        "metadata": {},
        "overallHealth": "GREEN",
        "owner": "org1@site1",
        "settings": {
            "dataConnectionType": "ENCRYPTED_COMPRESSED",
            "description": "new description",
            "excludedDiskKeys": [
                0
            ],
            "initialSyncTime": 0,
            "quiesced": true,
            "retentionPolicy": {
                "rules": [
                    {
                        "distance": 15,
                        "numberOfInstances": 3
                    }
                ]
            },
            "rpo": 15
        },
        "slaProfile": {
            "displayName": "Gold",
            "id": "61c528c8-1a8c-4c4e-8886-f1b6eeba98a5"
        },
        "source": {
            "org": "org1",
            "site": "site1",
            "vappId": "d6977f40-4d90-46b2-a34e-5077e8648eda",
            "vappName": "vApp1",
            "vdcId": "f61d60d2-698a-46dc-a266-88df27644956",
            "vdcName": "Virtual DC 1"
        },
        "sourceState": {
            "progress": {
                "bytesToTransfer": 1000,
                "bytesTransferred": 400,
                "checksumComparedBytes": 1000,
                "checksumTotalBytes": 1000,
                "progress": 40
            },
            "state": "idle",
            "stateAge": 0
        },
        "startupInfo": {
            "order": 0,
            "startAction": "powerOn",
            "startDelay": 0,
            "stopAction": "powerOff",
            "stopDelay": 0
        },
        "storageProfile": "ecde053f-1aed-4547-b73a-52b9f7c48298",
        "storageProfileName": "Default",
        "vappReplicationId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
        "vimLocation": {
            "datastore": "datastore",
            "datastoreMoref": "datastore-33",
            "datastoreName": "test datastore",
            "vimServer": "vim server",
            "vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
        },
        "vmDescription": "description",
        "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"
    }
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 means the task hasn't completed.

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. Populated only if the execution was successful.

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.

string
state
Optional

The current state of the task. States: [RUNNING, SUCCEEDED, FAILED]

Possible values are : RUNNING, SUCCEEDED, FAILED,
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/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/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):

  • VmReplicationNotFound
  • SiteNotFound
Returns ApiError of type(s) application/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/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 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 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
PATCH
Update Network Settings Vm Replication
GET
Vm Replications