Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Add-VBRAmazonS3ExternalRepository

Short Description

Adds Amazon S3 object storage as an external repository.

Applies to

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus

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.

Add-VBRAmazonS3ExternalRepository Note:

Mind the following:

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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.

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 VBRAmazonS3Connection type.

True

Named

False

 

Name

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

False

Named

False

 

Description

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

False

Named

False

 

DecryptBackups

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

False

Named

False

 

DecryptionKey

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

Accepts the VBREncryptionKey type.

False

Named

False

 

Force

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

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.

Return Type

Example 1

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

  1. Run Get-VBRAmazonAccount to get the necessary Amazon S3 account. Save the result to the $account variable.
  2. Run Connect-VBRAmazonS3Service with the $account variable to connect to the Amazon S3 object storage. Save the result to the $connect variable.
  3. Run Get-VBRAmazonS3Bucket with the $connect variable to get the necessary Amazon S3 bucket. Save the result to the $bucket variable.
  4. Run Get-VBRAmazonS3Folder with the $bucket and the $connect variables to get the necessary Amazon S3 folder. Save the result to the $folder variable.
  5. Run Add-VBRAmazonS3Repository with the $connect and the $folder variables.

$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

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

Example 2

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.

  1. Run Get-VBRAmazonAccount to get the necessary Amazon S3 account. Save the result to the $account variable.
  2. Run Connect-VBRAmazonS3Service with the $account variable to connect to the Amazon S3 object storage. Save the result to the $connect variable.
  3. Run Get-VBRAmazonS3Bucket with the $connect variable to get the Amazon S3 bucket. Save the result to the $bucket variable.
  4. Run Get-VBRAmazonS3Folder with the $bucket and the $connect variables to get the Amazon S3 folder. Save the result to the $folder variable.
  5. Run Read-Host to create a secure password. Save the result to the $securepassword variable.
  6. Run Add-VBREncryptionKey with the $securepassword variable. Save the result to the $key variable.
  7. Run Add-VBRAmazonS3Repository with the $folder, $connect and $key variables. Use the DecryptBackups parameter to decrypt the encrypted backup files.

$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

Get-VBRAmazonAccount

Connect-VBRAmazonS3Service

Get-VBRAmazonS3Bucket

Get-VBRAmazonS3Folder

Add-VBREncryptionKey

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation