Veeam Backup for Microsoft Office 365 5.0
PowerShell Reference
Related documents
User GuideREST API ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
Search

Add-VBOAmazonS3ObjectStorageRepository

In this article

    Short Description

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

    Syntax

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

    Detailed Description

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

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Folder

    Specifies an Amazon S3 folder. The cmdlet will move backup files into the selected folder.

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

    True

    Named

    False

     

    Name

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

    String

    True

    Named

    False

     

    Description

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

    String

    False

    Named

    False

     

    EnableIAStorageClass

    Indicates that the cmdlet will enable the infrequent access storage class for data blocks that are stored in an Amazon S3 object storage.

    SwitchParameter

    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 the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBOAmazonS3ObjectStorageRepository object that contains settings of the Amazon S3 object storage repository.

    Examples

    Add-VBOAmazonS3ObjectStorageRepositoryExample 1. Adding Amazon S3 Object Storage Repository

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

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

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

    $bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionID EUStockholm -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-VBOAmazonS3ServiceConnectionSettings 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 Repository with Description

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

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

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

    $bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionID EUStockholm -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-VBOAmazonS3ServiceConnectionSettings 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 Object Storage Repository with Specified Size Limits

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

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

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

    $bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionID EUStockholm -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-VBOAmazonS3ServiceConnectionSettings 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 EnableIAStorageClass parameter.
    • Specify the SizeLimit parameter value.

    Related Commands