Remove-VBRBackupRepository

In this article

    Short Description

    Removes a backup repository from the backup infrastructure.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Remove-VBRBackupRepository -Repository <CBackupRepository[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet allows you to remove a backup repository from the backup infrastructure.

    When you remove a backup repository, Veeam Backup & Replication unassigns the repository role from the server, so it is no longer used as a backup destination. The actual server remains added to the backup infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Repository

    Specifies an array of backup repositories you want to remove.

    Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    WhatIf

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

    SwitchParameter

    False

    Named

    False

    Confirm

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

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    None.

    Examples

    Remove-VBRBackupRepositoryExample 1. Removing Backup Repository [Using Variable]

    This example shows how to remove the backup repository named Local Repository 01.

    $repository = Get-VBRBackupRepository -Name "Local Repository 01"

    Remove-VBRBackupRepository -Repository $repository

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
    2. Run the Remove-VBRBackupRepository cmdlet. Set the $repository variable as the Repository parameter value.

    Remove-VBRBackupRepositoryExample 2. Removing Backup Repository [Using Pipeline]

    This example shows how to remove the backup repository named Local Repository 01.

    Get-VBRBackupRepository -Name "Local Repository 01" | Remove-VBRBackupRepository

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value.
    2. Pipe the cmdlet output to the Remove-VBRBackupRepository cmdlet.

    Related Commands

    Get-VBRBackupRepository