Syntax
Start-SpbmReplicationPromote [-ReplicationGroup] <SpbmReplicationGroup[]> [-Unplanned] [-RunAsync] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet promotes a target replication group from InTest to FailedOver state.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
ReplicationGroup | SpbmReplicationGroup[] | Specifies the replication groups to promote to FailedOver state. | 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 | |
Unplanned | SwitchParameter | Indicates if the promote operation is unplanned or planned. | 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
The failed over replication groupsNotes
Examples
-------------- Example 1 --------------
Start-SpbmReplicationPromote -ReplicationGroup $targetRg
Promotes the $targetRg target replication group from InTest state to FailedOver.