Veeam Backup for Microsoft Office 365 4.0
PowerShell Reference
Related documents

Add-VBOAmazonS3CompatibleObjectStorageRepository

Short Description

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

Syntax

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder <VBOAmazonS3Folder> -Name <string> [-Description <string>] [-SizeLimit <uint64>]  [<CommonParameters>]

Detailed Description

This cmdlet adds the S3 Compatible object storage repository or IBM Cloud object storage to the Veeam Backup for Microsoft Office 365 infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Folder

Specifies an S3 Compatible folder. Veeam Backup for Microsoft Office 365 will move backup files into this folder.

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

True

Named

False

 

Name

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

String

True

Named

False

 

Description

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

String

False

Named

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 Office 365 will not run a new job.

Permitted value: 1024 - 1073741824.

Default: 10240.

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

Uint64

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

Examples

Add-VBOAmazonS3CompatibleObjectStorageRepositoryExample 1. Adding S3 Compatible Object Storage Repository

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

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

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

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -Region EUStockholm

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

Add-VBOAmazonS3CompatibleObjectStorageRepository -Folder $folder -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. Specify the Name parameter value.

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

This example shows how to add the S3 Compatible object storage repository 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 -AmazonS3ConnectionSettings $connection -Region EUStockholm

$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 Repository with Specified Size Limits

This example shows how to add the S3 Compatible object storage repository. 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 -AmazonS3ConnectionSettings $connection -Region EUStockholm

$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.

Related Commands

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

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