Veeam Backup for Microsoft 365 7
PowerShell Reference
Related documents
Search

Add-VBOAmazonS3CompatibleObjectStorageRepository

Short Description

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

Syntax

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder <VBOAmazonS3Folder> [-Type <AddAmazonS3CompatibleObjectStorageType>] -Name <String> [-Description <String>] [-SizeLimit <UInt64>] [-EnableImmutability] [<CommonParameters>]

Detailed Description

This cmdlet adds the Amazon S3 Compatible object storage, IBM Cloud Object Storage or Wasabi Cloud Object Storage to the Veeam Backup for Microsoft 365 infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Folder

Specifies an S3 Compatible 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

Type

Specifies a type of the S3 Compatible object storage. The cmdlet will add object storage of one of the following types:

  • AmazonS3Compatible
  • IBMCloud
  • WasabiCloud

AddAmazonS3CompatibleObjectStorageType

False

Named

False

False

Name

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

String

True

Named

False

False

Description

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

String

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

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

Examples

Add-VBOAmazonS3CompatibleObjectStorageRepositoryExample 1. Adding Amazon S3 Compatible Object Storage

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

$account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

$connection = New-VBOAmazonS3CompatibleConnectionSettings -Account $account -ServicePoint "172.17.186.13:9000"

$bucket = Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings $connection -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 09"

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder $folder -Type AmazonS3Compatible -Name "Documents"

Perform the following steps:

  1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.
  1. Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
  2. Run the Get-VBOAmazonS3Folder cmdlet. Specify the necessary parameters. Save the result to the $folder variable.
  3. Run the Add-VBOAmazonS3CompatibleObjectStorageRepository cmdlet. Set the $folder variable as the Folder parameter value. Set AmazonS3Compatible as the Type parameter value. Specify the Name parameter value.

Add-VBOAmazonS3CompatibleObjectStorageRepositoryExample 2. Adding S3 Compatible Object Storage with Description

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

$account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

$connection = New-VBOAmazonS3CompatibleConnectionSettings -Account $account -ServicePoint "172.17.186.13:9000"

$bucket = Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings $connection -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 08"

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

Perform the following steps:

  1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Specify the necessary parameters. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3CompatibleObjectStorageRepository 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-VBOAmazonS3CompatibleObjectStorageRepositoryExample 3. Adding S3 Compatible Object Storage with Specified Size Limits

This example shows how to add the S3 Compatible object storage. The repository will be added with size limits set to 5120 GB.

$account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

$connection = New-VBOAmazonS3CompatibleConnectionSettings -Account $account -ServicePoint "172.17.186.13:9000"

$bucket = Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings $connection -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 07"

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder $folder -Name "Documents" -SizeLimit 5120

Perform the following steps:

  1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3Folder cmdlet. Specify the necessary parameters. Save the result to the $folder variable.
  5. Run the Add-VBOAmazonS3CompatibleObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Specify the Name parameter value.
  • Specify the SizeLimit parameter value.

Add-VBOAmazonS3CompatibleObjectStorageRepositoryExample 4. Adding S3 Compatible Object Storage of IBMCloud Type with Immutability Enabled

This example shows how to add the S3 Compatible object storage of the IBMCloud type with the enabled immutability to store backup copies.

$account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

$connection = New-VBOAmazonS3CompatibleConnectionSettings -Account $account -ServicePoint "172.17.186.13:9000"

$bucket = Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings $connection -Name "BucketName2"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 10"

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder $folder -Type IBMCloud -Name "BackupCopies"  -EnableImmutability

Perform the following steps:

  1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.
  1. Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
  2. Run the Get-VBOAmazonS3Folder cmdlet. Specify the necessary parameters. Save the result to the $folder variable.
  3. Run the Add-VBOAmazonS3CompatibleObjectStorageRepository cmdlet. Set the $folder variable as the Folder parameter value. Set IBMCloud as the Type parameter value. Specify the Name parameter value. Provide the EnableImmutability parameter.

Related Commands

View all results across Veeam
Back to document search