Undo-VBRFailoverPlan

In this article

    Short Description

    Undoes the failover by failover plan.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Undo-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet undoes the failover process. Undoing failover switches the workload back to source VMs. All changes that were made to the replicas during failover are discarded.

    To switch back to the production VM and synchronize the changes made to the replica while failover, start a failback process. Run Start-VBRViReplicaFailback or Start-VBRHvReplicaFailback to fail back to the VMware or Hyper-V production VM. Note that failback is not a group process and must be performed for each VM individually.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    FailoverPlan

    Specifies the array of failover plans you want to undo.

    Accepts VBRFailoverPlan or VBRCloudFailoverPlan types.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Wait

    Use this parameter to manage undoing multiple failover processes.

    If indicated, the next undo failover process will wait for the previous to end.

    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.

    Return Type

    VBRBackupSession[]

    Example 1

    This command undoes the failover process by failover plan named "MS Exchange Group Failover". The failover plan is obtained with Get-VBRFailoverPlan and piped down.

    Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | Undo-VBRFailoverPlan

    Example 2

    This command undoes the failover process represented by the '$MSExchangeGroup' variable. The failover plan is obtained with Get-VBRFailoverPlan and assigned to the variable beforehand.

    Undo-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

    Example 3

    This command undoes failover processes by failover plans named "MS Exchange Group Failover" and "SQLServers Group Failover". The VM groups are processed one by one.

    • The failover plans are obtained with Get-VBRFailoverPlan and piped down.
    • The Wait parameter is used to undo the failover processes one after the other.

    Get-VBRFailoverPlan -Name "MS Exchange Group Failover", "SQLServers Group Failover" | Undo-VBRFailoverPlan -Wait

    Related Commands

    Get-VBRFailoverPlan