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

Remove-VBRFailoverPlan

In this article

    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>]

    Related Commands

    Get-VBRFailoverPlan

    Return Type

    None

    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 failover plan you want to remove.

    Accepts VBRFailoverPlan or VBRCloudFailoverPlan object.

    You can remove multiple objects.

    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.

    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