Start-VBRHvReplicaFailback

Short Description

Fails back Hyper-V VMs to production host.

Platform: Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

ToOriginal (Default)

Start-VBRHvReplicaFailback -RestorePoint <COib> [-Complete] [-PowerOn] [-Reason <String>] [-RunAsync]

[-QuickRollback] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
FromBackup

Start-VBRHvReplicaFailback -RestorePoint <COib> -Vm <CHvVmItem> [-PowerOn] [-Reason <String>] [-RunAsync]

[-QuickRollback] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DifferentLocation

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 the Start-VBRHvReplicaFailover cmdlet.

Run the Stop-VBRReplicaFailover cmdlet to undo failover.

Run the Stop-VBRHvReplicaFailback cmdlet to undo failback.

Note

The cmdlet will not run if the geographic 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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Complete	Defines that the failback will be committed.	`SwitchParameter`	False	Named	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.	`String`	False	Named	False
Force	Defines that the cmdlet will perform failback even if the geographic location of the VMs you want to fail back and the target production host location do not match.	`SwitchParameter`	False	Named	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 the `VBRHvServerNetworkInfo` object. To get this object, run the `Get-VBRHvServerNetworkInfo` cmdlet.	`VBRHvServerNetworkInfo[]`	False	Named	False
PowerOn	Defines that the production VM will be powered on after the failback. Otherwise, you will need to power the VM on manually.	`SwitchParameter`	False	Named	False
PreserveVmID	Defines that the restored VM will get the ID of the original VM. Otherwise, the restored VM will get a new ID.	`SwitchParameter`	False	Named	False
QuickRollback	Defines 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.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for performing failback.	`String`	False	Named	False
RegisterAsClusterResource	Defines that the VM will be registered as a part of Microsoft Failover Cluster.	`SwitchParameter`	False	Named	False
RestorePoint	Specifies the replica restore point. The cmdlet uses this restore point to identify the replica you want to fail back. 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
Server	Used for failback to another location. Specifies the Hyper-V host where you want to register the VM.	`CHost`	True	Named	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. Accepts the `CHvVmItem` object. To get this object, run the `Find-VBRHvEntity` cmdlet.	`CHvVmItem`	True	Named	False
VmName	Used for failback to another location. Specifies the name you want to assign to the new VM.	`String`	False	Named	False
Confirm	Defines that the cmdlet displays a prompt that asks if the user is sure that they want to continue.	`SwitchParameter`	False	Named	False
WhatIf	Defines that 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

Start-VBRHvReplicaFailback Example 1. Performing Failback to Original VM

This example shows how to failback to the original VM.

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

Start-VBRHvReplicaFailback -RestorePoint $restorepoint -RunAsync

Perform the following steps:

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

Start-VBRHvReplicaFailback Example 2. Performing Failback to Original VM in Different Location

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

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

$vm = Find-VBRHvEntity -Name "Fileserver02"

Start-VBRHvReplicaFailback -RestorePoint $restorepoint -VM $vm

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter restore points with the Sort-Object method by the creationtime property to get the most recent one. Save the result to the $restorepoint variable.
Run the Find-VBRHvEntity cmdlet. Specify the Name parameter value. Save the result to the $vm variable.
Run the Start-VBRHvReplicaFailback cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Set the $vm variable as the VM parameter value.

Start-VBRHvReplicaFailback Example 3. Performing Failback to Another Location

This example shows how to failback to another location.

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

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

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

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter restore points with the Sort-Object method by the creationtime property to get the most recent one. Save the result to the $restorepoint variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $srv variable.
Run the Start-VBRHvReplicaFailback cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
- Set the $srv variable as the Server parameter value.
- Specify the VmName parameter value.
- Provide the QuickRollback parameter.