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

Get-VBRExternalRepository

Short Description

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

Applies to

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus

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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

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

True

Named

False

 

Name

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

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 1

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

Get-VBRExternalRepository  -Name "External Repository"

Example 2

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

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