Remove-VBRExternalRepository

In this article

    Short Description

    Removes external repositories from backup infrastructure.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Remove-VBRExternalRepository -ExternalRepository <VBRExternalRepository> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes external repositories from your backup infrastructure. You can remove the following types of external repositories:

    • Amazon S3 object storage added as an external repository.
    • Microsoft Azure object storage added as an external repository.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    ExternalRepository

    Specifies the external repository that you want to remove.

    Accepts the VBRExternalRepository type.

    True

    Named

    True (ByValue)

     

    WhatIf

    Indicates that the cmdlet will write a message that describes the effects of running the cmdlet. The cmdlet won`t perform any action.

    False

    Named

    False

     

    Confirm

    Indicates that the cmdlet will require a confirmation that you want to run the cmdlet.

    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.

    Return Type

    Example

    This example shows how to remove an external repository from your backup infrastructure.

    1. Run Get-VBRExternalRepository to get the external repository that you want to remove. Save the result to the $repository variable.
    2. Run Remove-VBRExternalRepository with the $repository variable.

    $repository = Get-VBRExternalRepository -Name "External repository"

    Remove-VBRExternalRepository -ExternalRepository $repository

    Related Commands

    Get-VBRExternalRepository