Start-VBRFailoverPlan

Short Description

Starts failover by failover plan.

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force] [<CommonParameters>]
FromDate

Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-FromDate <DateTime>] [-Wait] [-Force] [<CommonParameters>]
Test

Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force] [-Test] [-KeepAliveDuration <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet starts failover by failover plan. With this cmdlet, you can start a number of failover processes.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
FailoverPlan	Specifies the array of failover plans you want to start. Accepts the `VBRFailoverPlan` or `VBRCloudFailoverPlan` objects. To get these objects, run the `Get-VBRFailoverPlan` cmdlet.	`VBRFailoverPlan[]`	True	Named	True (ByPropertyName, ByValue)
Force	Used for cloud failovers to start full failover after the user's site is already partially failed over to cloud replicas. If you provide this parameter, the cmdlet turns off the user appliance without notifying the user. Otherwise, the cmdlet will display a warning.	`SwitchParameter`	False	Named	False
FromDate	Use this parameter to fail over to a particular restore point. Specifies the date and time to which you want to fail over. Veeam Backup & Replication will find a restore point closest to this moment. If omitted, Veeam Backup & Replication will fail over to the latest restore point.	`DateTime`	False	Named	False
KeepAliveDuration	Specifies a timeout in minutes for a CDP replicas failover test. The CDP replica will be active during this period of time. Note: Consider the following: You must use the `Test` parameter. To stop the failover testing beforehand, run the `Undo-VBRFailoverPlan`.	`Int32`	False	Named	False
Test	Defines that the failover runs in test mode.	`SwitchParameter`	False	Named	False
Wait	Use this parameter to manage starting multiple failover processes. If you provide this parameter, the next failover process will wait for the previous to end.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRBackupSession[]

Examples

Start-VBRFailoverPlan Example 1. Starting Failover Plan [Using Pipeline]

This command starts failover process by the MS Exchange Group Failover failover plan. The VMs in the failover group are failed over to the latest restore point.

Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | Start-VBRFailoverPlan

Perform the following steps:

Run the Get-VBRFailoverPlan cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Start-VBRFailoverPlan cmdlet.

Start-VBRFailoverPlan Example 2. Starting Failover Plan [Using Variable]

This example shows how to start failover process by the MS Exchange Group Failover failover plan. The VMs in the failover group are failed over to the latest restore point.

$MSExchangeGroup = Get-VBRFailoverPlan -Name "MS Exchange Group Failover"

Start-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

Perform the following steps:

Run the Get-VBRFailoverPlan cmdlet. Specify the Name parameter value. Save the result to the $MSExchangeGroup variable.
Run the Start-VBRFailoverPlan cmdlet. Set the $MSExchangeGroup variable as the FailoverPlan parameter value.

Start-VBRFailoverPlan Example 3. Starting Failover Plans for Specific Restore Point

This example shows how to start failover processes by the MS Exchange Group Failover and SQLServers Group Failover failover plans. The VMs are failed over to a week ago state. The VM groups are failed over one by one.

$date = Get-Date

Get-VBRFailoverPlan -Name "MS Exchange Group Failover", "SQLServers Group Failover" | Start-VBRFailoverPlan -FromDate $date.AddDays(-7) -Wait

Perform the following steps:

The date is obtained with the Get-Date command. Save it to the $date variable.
Run the Get-VBRFailoverPlan cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Start-VBRFailoverPlan cmdlet. Set the $date variable as the FromDate parameter value. Provide the Wait parameter.