Get-VBRExternalRepository

In this article

    Short Description

    Returns an array of external repositories from Veeam Backup & Replication.

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

    Syntax

    This cmdlet provides two parameter sets:

    • For getting an external repository by the external repository name

    Get-VBRExternalRepository -Id <guid[]>  [<CommonParameters>]

    • For getting get an external repository by the external repository ID

    Get-VBRExternalRepository [-Name <string[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns an array of external repositories added to your Veeam Backup & Replication infrastructure. You can get the following types of external repositories:

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

    Note

    This cmdlet is not available for the Veeam Backup Starter license.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Id

    Specifies the ID of an external repository that you want to get.

    String

    True

    Named

    False

    Name

    Specifies the name of an external repository that you want to get.

    String

    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.

    Examples

    Getting External Repository by Name

    This command gets an external repository by the external repository name.

    Get-VBRExternalRepository  -Name "External Repository"

    Getting External Repository by ID

    This command gets an external repository by the external repository ID.

    Get-VBRExternalRepository -Id "0x0x0xxx-000x-0x0x-000-000x00000x0x"

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.