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

Operation:

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

Description:

Performs test failover for the specified incoming ReplicationGroup. Test images will be created for all related VMs. The ongoing replication will not be affected. All test VMs will be brought up to a bootable state. The caller can specify whether to synchronize the ReplicationGroup before the recovery and whether the vApp should be powered on after the recovery.

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

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

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

Since:

1.0

Input parameters

The test failover specification

Consume media type(s):

application/vnd.vmware.hcs.testFailoverParams+xml
application/*+xml

Input type:

TestFailoverParamsType

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