Start-VBRHvReplicaFailback

In this article

    Short Description

    Fails back Hyper-V VMs to production host.

    Applies to

    Platform: Hyper-V

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

    Syntax

    This cmdlet provides 3 parameter sets.

    • For failback to the original VM:

    Start-VBRHvReplicaFailback -RestorePoint <COib> [-Complete] [-PowerOn] [-Reason <string>] [-RunAsync] [-QuickRollback] [-WhatIf] [-Confirm]  [<CommonParameters>]

    • For failback to the original VM restored in a different location:

    Start-VBRHvReplicaFailback -RestorePoint <COib> -Vm <CHvVmItem> [-PowerOn] [-Reason <string>] [-RunAsync] [-QuickRollback] [-Force] [-WhatIf] [-Confirm]  [<CommonParameters>]

    • For failback to another location:

    Start-VBRHvReplicaFailback -RestorePoint <COib> -Server <CHost> [-Datastore <string>] [-Network <VBRHvServerNetworkInfo[]>] [-VmName <string>] [-PreserveVmID] [-RegisterAsClusterResource] [-PowerOn] [-Reason <string>] [-RunAsync] [-QuickRollback] [-Force] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet fails back Hyper-V VMs to the production host. This cmdlet finalizes the replica failover started with Start-VBRHvReplicaFailover.

    Run Stop-VBRReplicaFailover to undo failover.

    Run Stop-VBRHvReplicaFailback to undo failback.

    Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs you want to fail back changes its geographical location.

    Start-VBRHvReplicaFailback Note:

    The cmdlet will not run if the geographical location of the VMs you want to fail back and the target production host location do not match. If you still want to run the cmdlet, use the Force parameter.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the replica restore point. The cmdlet uses this restore point to identify the replica you want to fail back.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Complete

    If set, the failback will be committed.

    False

    Named

    False

    False

    Server

    Used for failback to another location.

    Specifies the Hyper-V host where you want to register the VM.

    True

    Named

    False

    False

    Datastore

    Used for failback to another location.

    Specifies the path to the folder where you want to register the VM.

    If not specified, the cmdlet will use the datastore that is set as default for the target host.

    False

    Named

    False

    False

    Network

    Used for failback to another location.

    Specifies the array of production site networks. The cmdlet will map the replica to these networks.

    Accepts VBRHvServerNetworkInfo type.

    False

    Named

    False

    False

    VmName

    Used for failback to another location.

    Specifies the name you want to assign to the new VM.

    False

    Named

    False

    False

    PreserveVmID

    If set, the restored VM will get the ID of the original VM. Otherwise, the restored VM will get a new ID.

    False

    Named

    False

    False

    RegisterAsClusterResource

    If set, the VM will be registered as a part of Microsoft Failover Cluster.

    False

    Named

    False

    False

    Vm

    Used for failback to the original VM restored in a different location.

    Specifies the VM restored from backup. The cmdlet will map the replica to this VM.

    True

    Named

    False

    False

    PowerOn

    If set, the production VM will be powered on after the failback. Otherwise, you will need to power the VM on manually.

    False

    Named

    False

    False

    Reason

    Specifies the reason for performing a failback.

    False

    Named

    False

    False

    RunAsync

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

    False

    Named

    False

    False

    QuickRollback

    Indicates that the cmdlet will perform incremental failback.

    NOTE:  Incremental failback uses VM changed block tracking data. If the cmdlet fails to retrieve the changed block tracking data for some reason, it will perform full VM failback.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will perform failback even if the geographical location of the VMs you want to fail back and the target production host location do not match.

    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 failback to the original VM.

    You will need to perform the following steps:

    1. Run Get-VBRRestorePoint to get the restore point of the replica. Filter restore points with Sort-Object method by the "creationtime" property to get the most recent one. Save the result to the $restore_point variable.
    2. Run Start-VBRHvReplicaFailback with the $respoint variable. Add RunAsync parameter to bring the process to the background.

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

    Start-VBRHvReplicaFailback -RestorePoint $respoint -RunAsync

    Example 2

    This example shows how to failback to the original VM restored in a different location.

    You will need to perform the following steps:

    1. Run Get-VBRRestorePoint to get the restore point of the replica. Filter restore points with Sort-Object method by the "creationtime" property to get the most recent one. Save the result to the $restore_point variable.
    2. Run Find-VBRHvEntity to get the VM where the original VM was restored to. Save the result to the $vm variable.
    3. Run Start-VBRHvReplicaFailback with the $respoint and $vm variables.

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

    $vm =  Find-VBRHvEntity -Name "Fileserver02"

    Start-VBRHvReplicaFailback -RestorePoint $respoint -VM $vm

    Example 3

    This example shows how to failback to another location.

    You will need to perform the following steps:

    1. Run Get-VBRRestorePoint to get the restore point of the replica. Filter restore points with Sort-Object method by the "creationtime" property to get the most recent one. Save the result to the $restore_point variable.
    2. Run Get-VBRServer to get the server where you want to register the VM for failback. Save the result to the $srv variable.
    3. Run Start-VBRHvReplicaFailback with the $respoint and $srv variables. Add QuickRollback parameter to perform failback using changed block tracking data.

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

    $srv =  Get-VBRServer -Name "tech.support.local"

    Start-VBRHvReplicaFailback -RestorePoint $respoint -Server $srv -VmName "Webserver_N" -QuickRollback

    Related Commands

    Get-VBRRestorePoint

    Find-VBRHvEntity

    Get-VBRServer

    Get-VBRLocation

    I want to report a typo

    There is a misspelling right here:

     

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