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

Start-VBRViReplicaFailback

Short Description

Fails back VMware 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-VBRViReplicaFailback -RestorePoint <COib> [-Complete] [-StoragePolicyAction <VBRStoragePolicyAction> {Current | Stored | Default}] [-PowerOn] [-ReIp] [-SkipTagsRestore] [-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>] [-Reason <string>] [-RunAsync] [-WhatIf] [-Confirm]  [<CommonParameters>]

  • For failback to another location:

Start-VBRViReplicaFailback -RestorePoint <COib> -Server <CHost> [-ResourcePool <CViResourcePoolItem>] [-Datastore <VBRViDatastoreBase>] [-Folder <CViFolderItem>] [-StoragePolicy <VBRViStoragePolicy>] [-Network <VBRViNetworkInfo[]>] [-PowerOn] [-ReIp] [-SkipTagsRestore] [-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>] [-Reason <string>] [-RunAsync] [-WhatIf] [-Confirm]  [<CommonParameters>]

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

Start-VBRViReplicaFailback -RestorePoint <COib> -Vm <CViVmItem> [-PowerOn] [-ReIp] [-SkipTagsRestore] [-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>] [-Reason <string>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet fails back VMware VMs to the production host. This cmdlet finalizes the replica failover started with Start-VBRViReplicaFailover.

Run Stop-VBRReplicaFailover to undo failover.

Run Stop-VBRViReplicaFailback 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

StoragePolicyAction

Specifies the strategy for selecting storage policy profile in case the storage profile of the backed up VM differs from the profile of the original VM.

  • Current: the restored VM will be subscribed to the same profile as in backup (if such profile still exists) or to the profile to which the original VM is subscribed (if profile as in backup was removed).
  • Default: the restored VM will be subscribed to the profile that is set as default for the target datastore.
  • Stored: the restored VM will be subscribed to the profile as in backup (if such profile still exists).

False

Named

False

False

Server

Used for failback to another location.

Specifies the ESX(i) host where you want to register the VM.

True

Named

False

False

ResourcePool

Used for failback to another location.

Specifies the resource pool where you want to register the VM.

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

False

Named

False

False

Datastore

Used for failback to another location.

Specifies the datastore 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

Folder

Used for failback to another location.

Specifies the folder where you want to register the VM.

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

False

Named

False

False

StoragePolicy

Used for failback to another location.

Specifies the storage policy with which you want to register the VM.

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

Accepts VBRViStoragePolicy type.

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 VBRViNetworkInfo type.

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

ReIp

If set, the production VM will use the re-IP rules set in the replication job.

Do not enable the re-IP if the re-IP rules are not configured in the replication job.

False

Named

False

False

SkipTagsRestore

If set, the VM will be restored without its VMware tag. Otherwise, the restored VM will keep its original tag.

False

Named

False

False

DRSiteProxy

Specifies the proxy configured on the disaster recovery site.

False

Named

False

False

ProdSiteProxy

Specifies the proxy configured on the production site.

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

This example shows how to fail back to the original location. The VM will fail back with the following parameters:

  • The storage policy is set to Current.
  • The cmdlet will power the VM on after failback.

To fail back to the original location:

  1. Run Get-VBRRestorePoint to get the restore point of the replica and save it to the $restore_point variable.
  2. Run Start-VBRViReplicaFailback with the saved variable.

PS C:\PS> $restore_point = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1

PS C:\PS> Start-VBRViReplicaFailback -RestorePoint $restore_point -StoragePolicyAction Current -PowerOn

Related Commands

Get-VBRRestorePoint

Get-VBRViProxy

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