Stop-VBRCDPReplicaFailover

Short Description

Undoes a CDP replica failover.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VBRCDPReplicaFailover -Replica <VBRCDPReplica> [-ForceFailover] [-RunAsync] [-Force]

[-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet undoes a CDP replica failover.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will undo a failover for a CDP replica without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
ForceFailover	Defines that the cmdlet will force the undo failover operation. If you do not provide this parameter, the cmdlet will not be able to undo a failover in case the host on which the CDP replica resides is not available.	`SwitchParameter`	False	Named	False
Replica	Specifies a CDP replica for which you want to undo a failover. The cmdlet will switch back from this CDP replica to the original VM. Accepts the `VBRCDPReplica` object. To create this object, run the `Get-VBRCDPReplica` cmdlet.	`VBRCDPReplica`	True	Named	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command. Note: Microsoft PowerShell enables the `Confirm` parameter for this cmdlet by default. To disable this option, set the parameter value to `$false`. That is, `Confirm:$false`.	`SwitchParameter`	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Undoing Failover

$replica = Get-VBRCDPReplica -Name "Win05"

Stop-VBRCDPReplicaFailover -Replica $replica -ForceFailover

This example shows how to undo a failover of the CDP replica of the Win05 VM.

Perform the following steps:
1. Run the Get-VBRCDPReplica cmdlet. Specify the Name parameter value. Save the result to the $replica variable.
2. Run the Stop-VBRCDPReplicaFailover cmdlet. Set the $replica variable as the Replica parameter. Provide the ForceFailover parameter.

Get-VBRCDPReplica