Get-VBRArchiveObjectStorageRepository

Short Description

Returns archive repositories added to the backup infrastructure.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get an array of all archive repositories added to Veeam Backup & Replication by their names.

Get-VBRArchiveObjectStorageRepository [-Name <string[]>] [-Type {AzureArchive | AmazonS3Glacier}]  [<CommonParameters>]

  • Get an array of archive repositories added to Veeam Backup & Replication by their IDs.

Get-VBRArchiveObjectStorageRepository [-Id <guid[]>] [-Type {AzureArchive | AmazonS3Glacier}]  [<CommonParameters>]

Detailed Description

This cmdlet returns a list of archive repositories added to Veeam Backup & Replication. You can get the following types of these archive repositories:

  • Amazon S3 Glacier
  • Azure Archive
  • S3 compatible object storage with data archiving

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Id

Specifies an ID of an archive repository that you want to get.

Guid

False

Named

False

Name

Specifies a name of an archive repository that you want to get.

String

False

Named

False

Type

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

  • Amazon S3 Glacier
  • Azure Archive

Accepts the following types of objects:

  • AzureArchive
  • AmazonS3Glacier

To create these objects, run the following cmdlets:

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRArchiveObjectStorageRepository object that defines the archive repository settings.

Examples

Get-VBRArchiveObjectStorageRepositoryExample 1. Getting Azure Archive Repositories

This command gets all Azure Archive repository instances added to the backup infrastructure.

Get-VBRArchiveObjectStorageRepository -Type AzureArchive

Get-VBRArchiveObjectStorageRepositoryExample 2. Getting Amazon S3 Glacier Archive Repositories

This command gets all Amazon S3 Glacier archive repository instances added to the backup infrastructure.

Get-VBRArchiveObjectStorageRepository -Type AmazonS3Glacier