Veeam Backup for Microsoft 365 7 [Archived]
PowerShell Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBOAmazonS3ObjectStorageRepository

Short Description

Adds the Amazon S3 object storage to Veeam Backup for Microsoft 365.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add object storage of the Amazon S3 Standard storage class.

Add-VBOAmazonS3ObjectStorageRepository -Folder <VBOAmazonS3Folder> -Name <String> [-Description <String>] [-SizeLimit <UInt64>] [-EnableImmutability <SwitchParameter>] [<CommonParameters>]

  • Add object storage of the Amazon S3 Standard-Infrequent Access storage class.

Add-VBOAmazonS3ObjectStorageRepository -Folder <VBOAmazonS3Folder> -Name <String> [-EnableIAStorageClass <SwitchParameter>] [-Description <String>] [-SizeLimit <UInt64>] [-EnableImmutability <SwitchParameter>] [<CommonParameters>]

  • Add object storage of the Amazon S3 Standard or Amazon S3 Standard-Infrequent Access storage class along with the Amazon archiver appliance.

Add-VBOAmazonS3ObjectStorageRepository -Folder <VBOAmazonS3Folder> -Name <String> [-EnableIAStorageClass <SwitchParameter>] [-ArchiverAppliance <VBOAmazonArchiverAppliance>] [-Description <String>] [-SizeLimit <UInt64>] [-EnableImmutability <SwitchParameter>] [<CommonParameters>]

  • Add object storage of the Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval or Amazon S3 Glacier Deep Archive storage class along with the Amazon archiver appliance.

Add-VBOAmazonS3ObjectStorageRepository -Folder <VBOAmazonS3Folder> -EnableLongTerm <SwitchParameter> -Name <String> [-EnableGlacierDeepArchive <SwitchParameter>] [-EnableGlacierInstantRetrieval <SwitchParameter>] [-ArchiverAppliance <VBOAmazonArchiverAppliance>] [-Description <String>] [-SizeLimit <UInt64>] [-EnableImmutability <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet adds the Amazon S3 object storage to Veeam Backup for Microsoft 365.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Folder

Specifies an Amazon S3 folder. Veeam Backup for Microsoft 365 will move backups or backup copies into the specified folder.

Accepts the VBOAmazonS3Folder object.

To get this object, run the Get-VBOAmazonS3Folder cmdlet.

True

Named

False

False

Name

Specifies a name of Amazon S3 object storage. The cmdlet will add object storage with this name.

String

True

Named

False

False

Description

Specifies a description of Amazon S3 object storage. The cmdlet will add object storage with this description.

String

False

Named

False

False

EnableIAStorageClass

Defines that the cmdlet will enable the Amazon S3 Standard-Infrequent Access storage class for data blocks that are stored in an Amazon S3 object storage.

SwitchParameter

False

Named

False

False

SizeLimit

Specifies a soft limit in GB for your object storage consumption that can be exceeded temporarily. If the specified limit is exceeded, Veeam Backup for Microsoft 365 will not run a new job.

Permitted value: 1024 - 1073741824.

Default: 1024

Note: In PowerShell you can specify a soft limit in GB only.

UInt64

False

Named

False

False

EnableImmutability

Defines that the cmdlet will add object storage to the Veeam Backup for Microsoft 365 infrastructure with the immutability feature enabled. Immutability protects data in backup copies from loss as a result of attacks, malware activity or any other injurious actions that may be performed by 3rd party applications.

For more information about the immutability feature, see the Immutability section of the Veeam Backup for Microsoft 365 User Guide.

SwitchParameter

False

Named

False

False

EnableLongTerm

Defines that the cmdlet will enable adding object storage of one of the following storage classes:

  • Amazon S3 Glacier Instant Retrieval
  • Amazon S3 Glacier Flexible Retrieval
  • Amazon S3 Glacier Deep Archive

SwitchParameter

True

Named

False

False

EnableGlacierDeepArchive

Defines that the cmdlet will enable the Amazon S3 Glacier Deep Archive storage class.

SwitchParameter

False

Named

False

False

EnableGlacierInstantRetrieval

Defines that the cmdlet will enable the Amazon S3 Glacier Instant Retrieval storage class.

SwitchParameter

False

Named

False

False

ArchiverAppliance

Specifies the Amazon archiver appliance.

The cmdlet will use this archiver appliance when transferring backed-up data between different instances of Amazon S3 Standard or Amazon S3 Standard-IA storage classes, or to any of Amazon S3 Glacier storage classes during backup copy jobs.

Accepts the VBOAmazonArchiverAppliance object.

To create this object, run the New-VBOAmazonArchiverAppliance cmdlet.

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 VBOAmazonS3ObjectStorageRepository object that contains settings of the Amazon S3 object storage.

Examples

Add-VBOAmazonS3ObjectStorageRepositoryExample 1. Adding Amazon S3 Object Storage

This example shows how to add the Amazon S3 object storage.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

Add-VBOAmazonS3ObjectStorageRepository -Folder $folder -Name "Documents"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  1. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  2. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  3. Run the Add-VBOAmazonS3ObjectStorageRepository cmdlet. Set the $folder variable as the Folder parameter value. Specify the Name parameter value.

Add-VBOAmazonS3ObjectStorageRepositoryExample 2. Adding Amazon S3 Object Storage with Description

This example shows how to add the Amazon S3 object storage with description.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

Add-VBOAmazonS3ObjectStorageRepository -Folder $folder -Name "Documents" -Description "Created by Administrator"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3ObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Specify the Name parameter value.
  • Specify the Description parameter value.

Add-VBOAmazonS3ObjectStorageRepositoryExample 3. Adding Amazon S3 Standard-Infrequent Access Object Storage with Specified Size Limits

This example shows how to add object storage of the Amazon S3 Standard-Infrequent Access storage class. The repository will be added with size limits set to 5120 GB.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

Add-VBOAmazonS3ObjectStorageRepository -Folder $folder -Name "Documents" -EnableIAStorageClass -SizeLimit 5120

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3ObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Specify the Name parameter value.
  • Provide the EnableIAStorageClass parameter.
  • Specify the SizeLimit parameter value.

Add-VBOAmazonS3ObjectStorageRepositoryExample 4. Adding Amazon S3 Glacier Flexible Retrieval Object Storage

This example shows how to add object storage of the Amazon S3 Glacier Flexible Retrieval storage class.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

Add-VBOAmazonS3ObjectStorageRepository -Folder $folder -EnableLongTerm -Name "Archived Documents"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3ObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Provide the EnableLongTerm parameter.
  • Specify the Name parameter value.

Add-VBOAmazonS3ObjectStorageRepositoryExample 5. Adding Amazon S3 Glacier Instant Retrieval Object Storage with Immutability Enabled

This example shows how to add object storage of the Amazon S3 Glacier Instant Retrieval storage class with the enabled immutability to store backup copies.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName2"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

Add-VBOAmazonS3ObjectStorageRepository -Folder $folder -EnableLongTerm -EnableGlacierInstantRetrieval -EnableImmutability -Name "BackupCopies"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3ObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Provide the EnableLongTerm parameter.
  • Provide the EnableGlacierInstantRetrieval parameter.
  • Provide the EnableImmutability parameter.
  • Specify the Name parameter value.

Related Commands

View all results across Veeam
Back to document search