Start-VBRViReplicaFailover

Short Description

Fails over corrupted VMware VMs to their replicas.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Failover (Default)

Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-PowerOn] [-ReIp]

[-WhatIf] [-Confirm] [<CommonParameters>]
Planned

Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-PowerOn] [-Planned]

[-WhatIf] [-Confirm] [<CommonParameters>]
Definite

Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-Definite]

[-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet fails over a corrupted VMware VM to its successfully created replica.

Run the Start-VBRViReplicaFailback cmdlet to fail back to the original VM.

Run the Stop-VBRReplicaFailover cmdlet to undo failover.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Definite	Defines that the failover is permanent.	`SwitchParameter`	False	Named	False
Planned	Defines that the failover is planned. Default: The planned failover option is enabled.	`SwitchParameter`	False	Named	False
PowerOn	Defines that the cmdlet will power on replica VM after the failover. Otherwise, you will need to power on the replica VM manually.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for performing a failover.	`String`	False	Named	False
ReIp	Defines that the replica will use the re-IP rules that are set in the replication job. Note: Do not enable the re-IP if the re-IP rules are not configured in the replication job.	`SwitchParameter`	False	Named	False
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.	`COib`	True	0	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command.	`SwitchParameter`	False	Named	False
WhatIf	Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Examples

Start-VBRViReplicaFailover Example 1. Performing Failover to VM Replica

This example shows how to perform failover to the WebServer VM replica.

$restorepoint = Get-VBRRestorePoint -Name "WebServer"

Start-VBRViReplicaFailover -RestorePoint $restorepoint[3] -Reason "Data recovery" -RunAsync

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Save the result to the $restorepoint variable.
Run the Start-VBRViReplicaFailover cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
  The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the fourth restore point is used.
- Specify the Reason parameter value.
- Provide the RunAsync parameter.

Start-VBRViReplicaFailover Example 2. Performing Failover to Latest Restore Point [Using Pipeline]

This command fails over to the latest restore point of the WebServer VM replica.

Get-VBRRestorePoint -Name "WebServer" | Sort-Object $_.creationtime -Descending | Select-Object -First 1 | Start-VBRViReplicaFailover -Reason "Configuration recovery" -RunAsync

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the .creationtime property for the $_ variable. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Set the 1 number as the First parameter value.
Pipe the cmdlet output to the Start-VBRViReplicaFailover cmdlet. Specify the Reason parameter value. Provide the RunAsync parameter.

Start-VBRViReplicaFailover Example 3. Performing Planned Failover to VM Replica

This example shows how to perform planned failover of the WebServer VM.

$restorepoint = Get-VBRRestorePoint -Name "WebServer"

Start-VBRViReplicaFailover -RestorePoint $restorepoint[3] -Reason "Tsunami forecast" -Planned

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Save the result to the $restorepoint variable.
Run the Start-VBRViReplicaFailover cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
  The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the fourth restore point is used.
- Specify the Reason parameter value.
- Provide the Planned parameter.

Start-VBRViReplicaFailover Example 4. Performing Permanent Failover

This example shows how to perform permanent failover of the WebServer VM.

$restorepoint = Get-VBRRestorePoint -Name "WebServer"

Start-VBRViReplicaFailover -RestorePoint $restorepoint[3] -Reason "Configuration recovery" -RunAsync -Definite

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Save the result to the $restorepoint variable.
Run the Start-VBRViReplicaFailover cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
  The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the fourth restore point is used.
- Specify the Reason parameter value.
- Provide the RunAsync parameter.
- Provide the Definite parameter.