PowerCLI Reference



This cmdlet prepares the specified replication groups to fail over.


Start-SpbmReplicationPrepareFailover [-ReplicationGroup] <SpbmReplicationGroup[]> [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet prepares the specified replication groups to fail over.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ReplicationGroupSpbmReplicationGroup[]Specifies the replication group you want to prepare for failover. The replication group should be a source replication group.trueTrue (ByValue)
ConfirmSwitchParameterIf 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.falseFalse
RunAsyncSwitchParameterIndicates 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.falseFalse
ServerVIServer[]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.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type




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

Start-SpbmReplicationPrepareFailover -ReplicationGroup $sourceRg

Performs the preparation of a planned failover on the $sourceRg source replication group.

Copyright © VMware, Inc. All rights reserved.