Stop-VBRHvReplicaFailback

In this article

    Short Description

    Undoes Hyper-V replica failback.

    Applies to

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the restore point of the replica VM. The cmdlet will undo failback of this VM.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This example shows how to stop failback using pipeline.

    Run Get-VBRRestorePoint to get the restore point of the VM and save it to the $WebServer_replica_restorepoint variable. Filter the restore points of the VM with the Sort-Object method by the "creationtime" property to get the most recent one. Pipe the result to the Stop-VBRHvReplicaFailback. Use the RunAsync parameter to bring the process to the background.

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

    Example 2

    This example shows how to stop failback using a variable.

    1. Run Get-VBRRestorePoint to get the restore point of the VM. 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 $WebServer_replica_restorepoint variable.
    2. Run Stop-VBRHvReplicaFailback with the saved variable. Use the RunAsync parameter to bring the process to the background.

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

    Stop-VBRHvReplicaFailback -RestorePoint $WebServer_replica_restorepoint -RunAsync

    Related Commands

    Get-VBRRestorePoint