This is an archive version of the document. To get the most up-to-date information, see the current version.

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:

This cmdlet requires a PSCredential object. Use Get-Credential to create the PSCredentials object.
For more information on Get-Credential, see https://msdn.microsoft.com/en-us/powershell/reference/5.1/microsoft.powershell.security/get-credential.
This cmdlet is not available for the Veeam Backup Starter license.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
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

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example

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

Run Get-VBRExternalRepository to get the Amazon S3 external repository that you want to modify. Save the result to the $repository variable.
Create a secure password. Save the result to the $securepassword variable.
Run Add-VBREncryptionKey with the $securepassword variable. Save the result to the $key variable.
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