## PowerCLI Reference

# Start-SpbmReplicationPrepareFailover

## Synopsis

This cmdlet prepares the specified replication groups to fail over.

Syntax

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

Related Commands

Online version

Detailed Description

This cmdlet prepares the specified replication groups to fail over.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
ReplicationGroup | SpbmReplicationGroup[] | Specifies the replication group you want to prepare for failover. The replication group should be a source replication group. | true | true (ByValue)
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
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
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

None

Notes

Examples

-------------- 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.