Set-VBRAmazonS3ExternalRepository

Short Description

Modifies Amazon S3 object storage added as an external repository.

Applies to

Platform: VMware, Hyper-V

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

Syntax

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

Detailed Description

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

Note

This cmdlet requires the PSCredential object. Use the Get-Credential cmdlet to get the PSCredentials object. For more information, see the Get-Credential user guide.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

ExternalRepository

Specifies Amazon S3 external repository that you want to modify.

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

True

Named

True (ByValue)

Name

Specifies the name of Amazon S3 object storage.

String

False

Named

False

Description

Specifies the description of Amazon S3 object storage.

String

False

Named

False

DecryptBackups

Defines 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

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.

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

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 VBRAmazonS3ExternalRepository object that contains settings of Amazon S3 repositories added to the backup infrastructure.

Examples

Modifying Decryption Password for Amazon S3 External Repository

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

$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

Perform the following steps:

  1. Run the Get-VBRExternalRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
  3. Run the Add-VBREncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value. Save the result to the $key variable.
  4. Run the Set-VBRAmazonS3ExternalRepository cmdlet. Specify the following settings:
  • Set the $repository variable as the ExternalRepository parameter value.
  • Provide the DecryptBackups parameter.
  • Set the $key variable as the DecryptionKey parameter value.

Related Commands