POST /vr/replications/{replicationGroupId}/action/failover

Operation:

POST /vr/replications/{replicationGroupId}/action/failover

Description:

Performs failover for the incoming ReplicationGroup. All related VMs will be recovered and brought up to a bootable state. The caller can specify whether the vApp should be powered on after successful recovery.

If the related VDC is not enabled for failover, the returned task will fail with VdcNotEnabledForRecoveryFault vendor-specific error code.

If the replication is already in the process of getting recovered the returned task will fail with OngoingFailover vendor-specific error code.

If the replication is already recovered the returned task will fail with AlreadyRecovered vendor-specific error code.

Since:

1.0

Input parameters

Parameters for failover

Consume media type(s):

application/vnd.vmware.hcs.failoverParams+xml

Input type:

FailoverParamsType

Output parameters

TaskType

This operation is asynchronous and returns a task that you can monitor to track the progress of the request.

Produce media type(s):

application/vnd.vmware.vcloud.task+xml

Output type:

com.vmware.vcloud.api.rest.schema_v1_5.TaskType

Examples