## PowerCLI Reference

# Start-SpbmReplicationTestFailover

## Synopsis

This cmdlet performs a test failover of a target replication group.

Syntax

Start-SpbmReplicationTestFailover [-ReplicationGroup] <SpbmReplicationGroup[]> [-CheckOnly] [-Unplanned] [-SourceVvolIdMap <Hashtable>] [-PointInTimeReplica <SpbmPointInTimeReplica[]>] [-RunAsync] [-Server <VIServer>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Stop-SpbmReplicationTestFailover

Detailed Description

This cmdlet performs a test failover of a target replication group. If the operation succeeds, the replication state of the replication group becomes InTest.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
ReplicationGroup | SpbmReplicationGroup[] | Specifies the replication group on which you want to perform the test failover. | true | true (ByValue)
CheckOnly | SwitchParameter | Does not perform the test failover, but checks if the configuration is correct to perform the test failover. | false | false
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false
PointInTimeReplica | SpbmPointInTimeReplica[] | Specifies the point in time replica object you want to use for the corresponding replication group test failover. If no replica is specified for a replication group, the latest available replica is used by default by the VASA provider. If more than one replica is specified for a replication group, a non-terminating error is generated for that replication group. | false | false
RunAsync | SwitchParameter | Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console. | false | false
Server | VIServer | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false
SourceVvolIdMap | Hashtable | If this is a planned test failover, this parameter is mandatory. This will contain a map of sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified replication groups. | false | false
Unplanned | SwitchParameter | Specifies an unplanned test failover. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

VM file paths corresponding to recovered devices. One VM file path for a VM and all its disks together.

Notes

Examples

-------------- Example 1 --------------

    Start-SpbmReplicationTestFailover -ReplicationGroup $targetRg -CheckOnly

Checks if the target replication group has the correct configuration to perform a test failover.

-------------- Example 2 --------------

    Start-SpbmReplicationTestFailover -ReplicationGroup $targetRg ?Unplanned -PointInTimeReplica $replica

Performs a test failover of an unplanned type on the $targetRg target replication group by using the $replica point in time replica.

Copyright © VMware, Inc. All rights reserved.