This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRHvReplicaFailover

Short Description

Fails over corrupted Hyper-V VMs to their replicas.

Applies to

Platform: Hyper-V

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

Syntax

This cmdlet provides 3 parameter sets.

  • For failover:

Start-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync]  [<CommonParameters>]

  • For permanent failover:

Start-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync] [-Definite]  [<CommonParameters>]

  • For planned failover:

Start-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [-RunAsync] [-Planned]  [<CommonParameters>]

Detailed Description

This cmdlet fails over a corrupted Hyper-V VM to its successfully created replica.

This cmdlet provides 3 parameter sets for the following operations:

  • Failover
  • Permanent failover
  • Planned failover

Run Start-VBRHvReplicaFailback to fail back to the original VM.

Run Stop-VBRReplicaFailover to undo failover. You can also undo planned failover.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

Specifies the replica restore point to which you want to fail over.

True

1

True (ByValue,
ByProperty
Name)

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

Indicates that the failover is permanent.

False

Named

False

False

Planned

Indicates that the failover is planned.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Related Commands

Get-VBRRestorePoint