Short Description
Fails over corrupted VMware VMs to their replicas.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 3 parameter sets.
- For failover:
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync] [-PowerOn] [-ReIp] [-WhatIf] [-Confirm] [<CommonParameters>] |
- For permanent failover:
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync] [-Definite] [-WhatIf] [-Confirm] [<CommonParameters>] |
- For planned failover:
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync] [-Planned] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet fails over a corrupted VMware VM to its successfully created replica.
This cmdlet provides 3 parameter sets for the following operations:
- Failover
- Permanent failover
- Planned failover
Run Start-VBRViReplicaFailback to fail back to the original VM.
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 |
PowerOn | If set, the replica VM will be powered on after the failover. Otherwise, you will need to power on the replica VM manually. | False | Named | False | False |
ReIp | If set, the replica will use the re-IP rules set in the replication job. Do not enable the re-IP if the re-IP rules are not configured in the replication job. | False | Named | False | False |
Definite | Indicates that the failover is permanent. | False | Named | False | False |
Planned | Indicates that the failover is planned. | 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 |
<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 |
Related Commands
