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

Set-VBRAmazonS3ExternalRepository

Short Description

Modifies Amazon S3 object storage added as an external repository.

Applies to

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRAmazonS3ExternalRepository -ExternalRepository <VBRAmazonS3ExternalRepository> [-Name <string>][-Description <string>] [-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-GatewayServer <CHost>][<CommonParameters>]

Detailed Description

This cmdlet modifies existing Amazon S3 object storage added as an external repository.

Set-VBRAmazonS3ExternalRepository Note:

Mind the following:

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

ExternalRepository

Specifies Amazon S3 external repository that you want to modify.

True

Named

True (ByValue)

 

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 will0 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

 

GatewayServer

Specifies the gateway server. Veeam Backup & Replication will use this server to access Amazon S3 object storage that is added as an external repository.

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example

This example shows how to modify the decryption password for Amazon S3 object storage added as an external repository.

  1. Run Get-VBRExternalRepository to get the Amazon S3 external repository that you want to modify. Save the result to the $repository variable.
  2. Create a secure password. Save the result to the $securepassword variable.
  3. Run Add-VBREncryptionKey with the $securepassword variable. Save the result to the $key variable.
  4. Run Set-VBRAmazonS3ExternalRepository with the $repository and $key variables.

$repository = Get-VBRExternalRepository -Name "External Repository"

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

$key = Add-VBREncryptionKey -Password $securepassword

Set-VBRAmazonS3ExternalRepository -ExternalRepository $repository -DecryptBackups -DecryptionKey $key

Related Commands

Get-VBRExternalRepository

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

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation