Stop-VBRHvReplicaFailback

Short Description

Undoes Hyper-V replica failback.

Platform: Hyper-V

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

Syntax

Stop-VBRHvReplicaFailback -RestorePoint <COib> [-RunAsync] [-WhatIf]

[-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet undoes the Hyper-V replica failback started with the Start-VBRHvReplicaFailback cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
RestorePoint	Specifies the restore point of the replica VM. The cmdlet will undo failback of this VM. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	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 whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. 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 whether the cmdlet writes 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

Stop-VBRHvReplicaFailback Example 1. Undoing Replica Failback [Using Pipeline]

This example shows how to stop failback using pipeline.

Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | Stop-VBRHvReplicaFailback -RunAsync

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter the restore points of the VM with the Sort-Object method by the creationtime property to get the most recent one.
Pipe the cmdlet output to the Stop-VBRHvReplicaFailback cmdlet. Provide the RunAsync parameter.

Stop-VBRHvReplicaFailback Example 2. Undoing Replica Failback [Using Variable]

This example shows how to stop failback using a variable.

$replica_restorepoint = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1

Stop-VBRHvReplicaFailback -RestorePoint $replica_restorepoint -RunAsync

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter the restore points of the VM with the Sort-Object method by the creationtime property to get the most recent one. Save it to the $replica_restorepoint variable.
Run the Stop-VBRHvReplicaFailback cmdlet. Set the $replica_restorepoint variable as the RestorePoint parameter value. Provide the RunAsync parameter.