Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

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

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 (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> 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.

PS C:\PS> Remove-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

Related Commands

Get-VBRFailoverPlan

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation