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

Start-VBRReplicaFailover (obsolete)

Short Description

Fails over a corrupted VM to its replica.

Start-VBRReplicaFailover (obsolete) Note:

In Backup & Replication v6 this cmdlet was replaced by Start-VBRViReplicaFailover. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.

Applies to

Platform: VMware, Hyper-V

Syntax

Start-VBRReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-Planned] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet allows you fail over a corrupted VM to its successfully created replica.

Performing failover is switching to a VM replica in case the original VM is damaged. You can fail over to the latest state of a replica or to any of its good known restore points.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Restore
Point

Specifies the replica restore point to which you want to fail over.

True

1

True (ByValue,
ByProperty
Name)

False

Reason

Specifies the reason for performing a failover.

False

Named

False

False

RunAsync

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

False

Named

False

False

Planned

Performs planned failover.

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 over to the VM replica named "WebServer_ replica" to its latest restore point. 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-VBRReplicaFailover -Reason "Configuration recovery" -RunAsync

Example 2

This command fails over to 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-VBRReplicaFailover -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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation