Start-VBRHighAvailabilityClusterFailover

Short Description

Starts failover of an HA cluster.

Product Edition: Premium

Syntax

Start-VBRHighAvailabilityClusterFailover [-Server <String>] -Credential <PSCredential> [-Force] [<CommonParameters>]

Detailed Description

This cmdlet starts failover of an HA cluster. During failover, Veeam Backup & Replication set the secondary node as a primary node. The former primary node becomes unavailable and the cluster will consist of one node only.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credential	Specifies the credentials of the secondary node. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	True	Named	False
Force	Defines that the cmdlet will start switchover of a HA cluster without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Server	Specifies the secondary node IP address.	`String`	False	Named	False

<CommonParameters>

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

Examples

Starting Failover of HA cluster

This command starts failover of the HA cluster.

$creds = Get-Credential

Start-VBRHighAvailabilityClusterFailover -Server 203.0.113.25 -Credential $creds -Force

Perform the following steps:

Run the Get-Credential cmdlet. Save the result to the $creds variable.
Run the Start-VBRHighAvailabilityClusterFailover cmdlet. Set the $creds variable as the Credential parameter value. Specify the Server parameter value.

Get-Credential