Set-VBRAmazonS3ExternalRepository

Short Description

Modifies external Amazon S3 storage 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 external Amazon S3 storage repository added to the backup infrastructure.

Note

This cmdlet requires the PSCredential object. Use the Get-Credential cmdlet to get the PSCredentials object.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

ExternalRepository

Specifies external Amazon S3 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 a name of external Amazon S3 storage repository.

String

False

Named

False

Description

Specifies a description of external Amazon S3 storage repository.

String

False

Named

False

DecryptBackups

Defines that Veeam Backup & Replication will decrypt encrypted backups.

Default: False.

SwitchParameter

False

Named

False

DecryptionKey

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

Default: False.

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

False

Named

False

GatewayServer

Specifies a gateway server. Veeam Backup & Replication will use this server to access an Amazon S3 bucket.

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 Microsoft Docs.

Output Object

The cmdlet returns the VBRAmazonS3ExternalRepository object that contains settings of the modified external Amazon S3 storage repository added to the backup infrastructure..

Examples

Modifying Decryption Password of External Amazon S3 Storage Repository

This example shows how to modify the decryption password for external Amazon S3 storage 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