Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBRHvReplicaFailback

Short Description

Fails back Hyper-V VMs to production host.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 3 parameter sets.

  • For failback to the original VM:

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

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

Start-VBRHvReplicaFailback -RestorePoint <COib> -Vm <CHvVmItem> [-PowerOn] [-Reason <string>] [-RunAsync] [-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] [-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.

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 (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command fails back from the VM replica named "WebServer_ replica". The restore point 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.

PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | Start-VBRHvReplicaFailback -Reason "Configuration recovery" -RunAsync

Example 2

This command fails back from the VM replica 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.

PS C:\PS> Start-VBRHvReplicaFailback -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync

Related Commands

Get-VBRRestorePoint

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation