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	Type	Required	Position	Accept Pipeline Input
FailoverPlan	Specifies the array of failover plans you want to remove.	Accepts the VBRFailoverPlan or VBRCloudFailoverPlan objects. To get these objects, run the Get-VBRFailoverPlan cmdlet.	True	Named	True (ByValue, ByProperty Name)
WhatIf	Defines that the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines that the cmdlet displays a prompt that asks if the user is sure that they want to continue. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

FailoverPlan

Specifies the array of failover plans you want to remove.

Accepts the VBRFailoverPlan or VBRCloudFailoverPlan objects. To get these objects, run the Get-VBRFailoverPlan cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

WhatIf

Defines that the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet displays a prompt that asks if the user is sure that they want to continue.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

None.

Examples

Remove-VBRFailoverPlan Example 1. Removing Failover Plan [Using Pipeline]

This command removes the MS Exchange Group Failover failover plan.

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

Perform the following steps:

Run the Get-VBRFailoverPlan cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Remove-VBRFailoverPlan cmdlet.

Remove-VBRFailoverPlan Example 2. Removing Failover Plan [Using Variable]

This example shows how to remove the MS Exchange Group Failover failover plan.

$MSExchangeGroup = Get-VBRFailoverPlan -Name "MS Exchange Group Failover"

Remove-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

Perform the following steps:

Run the Get-VBRFailoverPlan cmdlet. Specify the Name parameter value. Save the result to the $MSExchangeGroup variable.
Run the Remove-VBRFailoverPlan cmdlet. Set the $MSExchangeGroup variable as the FailoverPlan parameter value.

Related Commands

Get-VBRFailoverPlan