Stop-VBRReplicaFailover

In this article

    Short Description

    Undoes replica failover.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Stop-VBRReplicaFailover [-RestorePoint] <COib> [-RunAsync] [-Force] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet undoes the replica failover. This cmdlet finalizes the replica failover started with Start-VBRViReplicaFailover.

    Run Start-VBRViReplicaFailback to fail back to the VMware production VM.

    Run Start-VBRHvReplicaFailback to fail back to the Hyper-V production VM.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the restore point of the production VM to recover to.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    RunAsync

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

    False

    Named

    False

    False

    Force

    Indicates that the replica job starts running without waiting for the target host to power off. Otherwise the replica job will start only after the target host is powered off.

    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 command stops failover process by reverting to the production VM. The restore point of the replica VM is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. The -Force parameter is set to start the replica job running anyway.

    Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | Stop-VBRReplicaFailover -Reason "Configuration recovery" -RunAsync -Force

    Example 2

    This command stops failover process by reverting to the production VM. The restorepoint of the replica VM is represented by the $WebServer_replica_restorepoint variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background.

    Stop-VBRReplicaFailover -RestorePoint $WebServer_replica_restorepoint -Reason "Data recovery" -RunAsync

    Related Commands

    Get-VBRRestorePoint

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.