Add-VBRAmazonS3ExternalRepository

In this article

    Short Description

    Adds Amazon S3 object storage as an external repository.

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

    Syntax

    Add-VBRAmazonS3ExternalRepository -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3ExternalConnection>[-Name <string>] [-Description <string>] [-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-Force][<CommonParameters>]

    Detailed Description

    This cmdlet adds Amazon S3 object storage as an external repository to the backup infrastructure.

    Note

    Mind the following:

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    AmazonS3Folder

    Specifies the name of the folder in the external repository. Veeam Backup & Replication will import the backups from this folder into the backups infrastructure.

    Accepts the VBRAmazonS3Folder object. To create this object, run the New-VBRAmazonS3Folder cmdlet.

    True

    Named

    True (ByValue)

    Connection

    Specifies the active session with Amazon S3 object storage that you want to add as an external repository.

    Accepts the VBRAmazonS3ExternalConnection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet and set the ExternalRepository property as the ServiceType parameter value.

    True

    Named

    False

    Name

    Specifies the name of Amazon S3 object storage that you want to add as an external repository.

    String

    False

    Named

    False

    Description

    Specifies the description of Amazon S3 object storage that you want to add as an external repository.

    String

    False

    Named

    False

    DecryptBackups

    Indicates that Veeam Backup & Replication will decrypt encrypted backup files created by Cloud Protection Manager.

    SwitchParameter

    False

    Named

    False

    DecryptionKey

    Specifies the password that Veeam Backup & Replication will use to decrypt the backup files.

    Accepts the VBREncryptionKey object. To get this object, run the Add-VBREncryptionKey cmdlet.

    False

    Named

    False

    Force

    Indicates that the cmdlet will add an external repository without showing warnings in the PowerShell console.

    SwitchParameter

    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

    Examples

    Adding Amazon S3 External Repository

    This example shows how to add Amazon S3 object storage as an external repository into your Veeam Backup & Replication infrastructure.

    $account = Get-VBRAmazonAccount

    $connect = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType ExternalRepository

    $bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "veeam-tw"

    $folder = Get-VBRAmazonS3Folder -Name "frozenbucket" -Bucket $bucket -Connection $connect

    Add-VBRAmazonS3ExternalRepository -Name "New Repository" -AmazonS3Folder $folder -Connection $connect

    Perform the following actions:

    1. Run the Get-VBRAmazonAccount cmdlet. Save the result to the $account variable.
    2. Run the Connect-VBRAmazonS3Service cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
    3. Run the Get-VBRAmazonS3Bucket cmdlet. Specify the Connection and Name parameter values. Save the result to the $bucket variable.
    4. Run the Get-VBRAmazonS3Folder cmdlet. Specify the  Connection, Bucket and Name parameter values. Save the result to the $folder variable.
    5. Run the Add-VBRAmazonS3Repository cmdlet. Specify the following settings:
    • Set the $connect variable as the Connection parameter value.
    • Set the $folder variable as the AmazonS3Folder parameter value.
    • Specify the Name parameter value.

    Adding Amazon S3 External Repository and Decrypting the Imported Backup Files

    This example shows how to add Amazon S3 object storage as an external repository into your Veeam Backup & Replication infrastructure. Veeam Backup & Replication will decrypt the backup files that are imported from the external repository.

    $account = Get-VBRAmazonAccount

    $connect = Connect-VBRAmazonS3Service -Account $account[1] -RegionType Global -ServiceType ExternalRepository

    $bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "veeam-tw"

    $folder = Get-VBRAmazonS3Folder -Name "frozenbucket" -Bucket $bucket -Connection $connect

    $securepassword = Read-Host -Prompt "Enter password" -AsSecureString

    $key = Add-VBREncryptionKey -Password $securepassword

    Add-VBRAmazonS3ExternalRepository -Name "New Repository" -AmazonS3Folder $folder -Connection $connect -DecryptBackups -DecryptionKey $key

    Perform the following actions:

    1. Run the Get-VBRAmazonAccount cmdlet. Save the result to the $account variable.
    2. Run the Connect-VBRAmazonS3Service cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
    3. Run the Get-VBRAmazonS3Bucket cmdlet. Specify the Connection and Name parameter values. Save the result to the $bucket variable.
    4. Run the Get-VBRAmazonS3Folder cmdlet. Specify the  Connection, Bucket and Name parameter values. Save the result to the $folder variable.
    5. Run the Read-Host cmdlet. cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    6. Run the Add-VBREncryptionKey cmdlet. Specify the Password parameter. Save the result to the $key variable.
    7. Run the Add-VBRAmazonS3Repository cmdlet. Specify the following settings:
    • Set the $connect variable as the Connection parameter value.
    • Set the $folder variable as the AmazonS3Folder parameter value.
    • Provide the DecryptBackups parameter.
    • Set the $key variable as the DecryptionKey parameter value.
    • Specify the Name parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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