Get-VBRBackupRepository

In this article

    Short Description

    Returns a list of backup repositories.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRBackupRepository [-Name <string[]>] [-ScaleOut]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns a list of backup repositories added to the backup infrastructure.

    You can get a list of all backup repositories, get scale-out backup repositories or look for repositories directly by name.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies an array of backup repositories names. The cmdlet will return repositories with these names.

    String

    False

    Named

    False

    True

    ScaleOut

    Defines that the cmdlet will return only scale-out backup repositories.

    Note: You must provide this parameter to get scale-out backup repositories.

    SwitchParameter

    False

    Named

    False

    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

    The cmdlet returns the CBackupRepository object that contains settings of backup repositories added to the backup infrastructure.

    Examples

    Get-VBRBackupRepositoryExample 1. Getting Standalone Backup Repositories

    This command gets all standalone backup repositories added to the backup infrastructure.

    Get-VBRBackupRepository

    Get-VBRBackupRepositoryExample 2. Getting Scale-Out Backup Repositories

    This command gets scale-out backup repositories added to the backup infrastructure.

    Get-VBRBackupRepository -ScaleOut

    Get-VBRBackupRepositoryExample 3. Getting Standalone Backup Repositories by Name

    This command gets the Backups Vol12 and Local standalone backup repositories.

    Get-VBRBackupRepository -Name "Backups Vol2", "Local*"

    Get-VBRBackupRepositoryExample 4. Getting Scale-Out Backup Repository by Name

    This command gets scale-out backup repository named  Veeam Performance Scale-Out Repository.

    Get-VBRBackupRepository -ScaleOut -Name "Veeam Performance Scale-Out Repository"