Start-VBRReplicaFailover (obsolete)

Short Description

Fails over a corrupted VM to its replica.

Note

This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Start-VBRViReplicaFailover cmdlet.

Platform: VMware, Hyper-V

Syntax

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

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

Detailed Description

This cmdlet allows you fail over a corrupted VM to its successfully created replica.

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.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Planned	Performs planned failover.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for performing a failover.	`String`	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	Defines that the cmdlet will write 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-VBRReplicaFailover (obsolete) Example 1. Failing Over to Latest Restore Point of Replica [Using Pipeline]

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.

Start-VBRReplicaFailover (obsolete) Example 2. Failing Over to Specific Restore Point of Replica [Using Variable]

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.

Get-VBRRestorePoint