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

Get-VBRObjectStorageRepository

Short Description

Returns object storage added as backup repositories to Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

Product Edition:  Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets:

  • To get an array of all object storage added as backup repositories from Veeam Backup & Replication

Get-VBRObjectStorageRepository [-Name <string[]>] [-Type <VBRObjectStorageRepositoryType> {AmazonS3 |AmazonS3Compatible | AzureBlob}]  [<CommonParameters>]

  • To get an array of object storage added as backup repositories by the backup repositories ID

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

Detailed Description

This cmdlet returns an array of object storage added as backup repositories to Veeam Backup & Replication. You can get the following types of these backup repositories:

  • Amazon S3
  • S3 Compatible
  • Azure Blob

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies an ID of a backup repository that you want to get.

True

Named

False

 

Name

Specifies the name of a backup repository that you want to get.

False

Named

False

 

Type

Specifies the type of a backup repository that you want to get. You can select the following type of backup repositories:

  • Amazon S3
  • Azure Blob
  • AmazonS3CompatibleService

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 all Azure Blob storage added as backup repositories.

Get-VBRObjectStorageRepository -Type AzureBlob

Example 2

This command gets all Amazon S3 object storage added as backup repositories.

Get-VBRObjectStorageRepository -Type Amazon S3

Example 3

This command gets all S3 Compatible object storage added as backup repositories.

Get-VBRObjectStorageRepository -Type AmazonS3CompatibleService

I want to report a typo

There is a misspelling right here:

 

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