This is an archive version of the document. To get the most up-to-date information, see the current version.Start-VBRViReplicaFailover
Short Description
Fails over a corrupted VM to its replica.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -OR- Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-Definite] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -OR- Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-Planned] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet allows you fail over a corrupted VM to its successfully created replica.
This cmdlet provides 3 parameter sets for the following operations:
Performing failover. 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.
Performing permanent failover. You can perform the permanent failover to permanently move your workload to the target host if the source is nonrecoverable. Your target host should have adequate resources. The replica starts acting like source in this case.
Performing planned failover. In this case, the source VM is powered off properly, and the replica is fully synchronized before the failover. The planned failover is used for maintenance or in other cases of planned downtime.
In Veeam Backup & Replication, failover is a temporary stage that needs to be finalized. In case your primary VM is unrecoverable, you can perform the permanent failover with this cmdlet. In case you plan to switch to the replica temporarily, you need to take the following steps:
- You can perform failback to recover the original VM on the source host or in a new location. Failback is used in case you failed over to a DR site that is not intended for continuous operations, and would like to move the operations back to the production site when the consequences of a disaster are eliminated.
Run Start-VBRViReplicaFailback for VMware or Start-VBRHvReplicaFailback for Hyper-V to failback to the original VM.
- You can undo failover to switch back to the original VM, revert replication operations and discard changes made to the working VM replica. In this case you loose all the changes that were made to the replica while you failed over to it.
Run Stop-VBRReplicaFailover to undo failover.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Restore | Specifies the replica restore point to which you want to fail over. | True | 1 | True (ByValue, | 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 |
Definite | Performs permanent failover. | 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 |
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-VBRViReplicaFailover -Reason "Configuration recovery" -RunAsync |
Example 2
This command starts permanent failover 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. The -Definite parameter is set to perform the permanent failover.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | Start-VBRViReplicaFailover -Reason "Configuration recovery" -RunAsync -Definite |
Example 3
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-VBRViReplicaFailover -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync |
Example 4
This command performs the planned failover to the VM replica represented by the $"DC_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Tsunami forecast". The Planned parameter is used to leverage the planned failover mechanism.
PS C:\PS> Start-VBRViReplicaFailover -RestorePoint $"DC_replica restorepoint" -Reason "Tsunami forecast" -Planned |