Start-VBRReplicaFailover (obsolete) - Veeam Backup PowerShell Reference

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
RestorePoint	Specifies the replica restore point to which you want to fail over.	Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet.	True	1	True (ByValue, ByProperty Name)
Reason	Specifies the reason for performing a failover.	String	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False
Planned	Performs planned failover.	SwitchParameter	False	Named	False

This example shows how to fail over to the WebServer_replica VM replica to its latest restore point.

Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | Start-VBRReplicaFailover -Reason "Configuration recovery" -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.
Pipe the cmdlet output to the Select cmdlet. Specify the First parameter value.
Pipe the cmdlet output to the Start-VBRReplicaFailover cmdlet. Specify the Reason parameter value. Provide the RunAsync parameter.

This example shows how to fail over to the WebServer_replica VM replica to a specific restore point.

$WebServer_replica_restorepoint = Get-VBRRestorePoint -Name "WebServer_replica"

Start-VBRReplicaFailover -RestorePoint $WebServer_replica_restorepoint[0] -Reason "Data recovery" -RunAsync

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Save the result to the $WebServer_replica_restorepoint variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the first restore point in the array).

Run the Start-VBRReplicaFailover cmdlet. Set the $WebServer_replica_restorepoint[0] variable as the RestorePoint parameter value. Specify the Reason parameter value. Provide the RunAsync parameter.