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

Remove-VBRFailoverPlan

Short Description

Removes a selected failover plan or a cloud failover plan.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Remove-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected failover plan from Veeam Backup & Replication console and database.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

FailoverPlan

Specifies the array of failover plans you want to remove.

Accepts VBRFailoverPlan or VBRCloudFailoverPlan types.

True

Named

True (ByValue,
ByProperty
Name)

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 on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

None

Example 1

This command removes failover plan named "MS Exchange Group Failover". The failover plan object is obtained with Get-VBRFailoverPlan and piped down.

Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | Remove-VBRFailoverPlan

Example 2

This command removes failover plan represented by the '$MSExchangeGroup' variable. The failover plan object is obtained with Get-VBRFailoverPlan and assigned to the variable beforehand.

Remove-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

Related Commands

Get-VBRFailoverPlan