Set-VBRAmazonS3CompatibleRepository

Short Description

Modifies settings for S3 Compatible object storage added as a backup repository.

Applies to

Platform: VMware, Hyper-V

Product Edition:  Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRAmazonS3CompatibleRepository -Repository <VBRAmazonS3CompatibleRepository> [-Name <String>] [-Description<String>] [-UseGatewayServer [<SwitchParameter>]] [-GatewayServer <CHost>] [-EnableSizeLimit [<SwitchParameter>]][-SizeLimit <Int32>] [-EnableBackupImmutability [<SwitchParameter>]] [-ImmutabilityPeriod <Int32>][<CommonParameters>]

Detailed Description

This cmdlet modifies settings for S3 Compatible object storage added as a backup repository Veeam Backup & Replication.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Repository

Specifies an S3 Compatible object storage that you want to modify.

Accepts the VBRAmazonS3CompatibleRepository type.

True

Named

True (ByValue)

Name

Specifies a name for the S3 Compatible object storage.

False

Named

False

Description

Specifies a description of S3 Compatible object storage.

False

Named

False

UseGatewayServer

Indicates that the cmdlet will use a gateway server to access an S3 Compatible object storage.

False

Named

False

GatewayServer

Specifies a gateway server that you want to use to access an S3 Compatible object storage repository.

False

Named

False

EnableSizeLimit

Indicates that the cmdlet will enable size limits for data blocks that you want to store in an Amazon S3 object storage.

Use the SizeLimit parameter to specify the size limits.

False

Named

False

SizeLimit

For the EnableSizeLimit parameter.

Specifies size limits in GB for data blocks that you want to store in an S3 Compatible object storage added as a backup repository.

Permitted value: 1024 - 1073741824.

Default: 10240.

False

Named

False

EnableBackupImmutability

Defines that the cmdlet will enable the immutability option.

False

Named

False

ImmutabilityPeriod

For the EnableBackupImmutability parameter.

Defines the immutability period in days.

Default: 30

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

This example shows how to modify settings for an S3 Compatible object storage added as a backup repository. The cmdlet will use a custom gateway server to connect to the S3 Compatible object storage.

  1. Run Get-VBRObjectStorageRepository to get an Amazon S3 object storage added as a backup repository. Save the result to the $amazon variable.
  2. Run Get-VBRServer with the name parameter to get a server that you want to use as a gateway. Save the result to the $gateserv variable.
  3. Run Set-VBRAmazonS3CompatibleRepository with the $amazon and $gateserv variables. Use the UseGatewayServer parameter to enable the custom gateway server option.

$amazon = Get-VBRObjectStorageRepository -Type AmazonS3Compatible

$gateserv = Get-VBRServer -Name "North.tech.local"

Set-VBRAmazonS3CompatibleRepository -Repository $amazon -UseGatewayServer -GatewayServer $gateserv

Related Commands

Get-VBRObjectStorageRepository

Get-VBRServer