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] [-ConnectionType <VBRRepositoryConnectionType>] [-GatewayServer <CHost[]>] [-ProxyAppliance <CHost>] [-EnableSizeLimit] [-SizeLimit <Int32>] [-ImmutabilityPeriod <Int32>] [-MountServerOptions <VBRRepositoryMountServerOptions>] [-LimitConcurrentJobs] [-MaxConcurrentJobs <Int32>] [-Force]  [<CommonParameters>]

Detailed Description

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

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Repository

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

Accepts the VBRAmazonS3Repository object. To create this object, run the Get-VBRObjectStorageRepository cmdlet.

True

Named

True (ByValue)

Name

Specifies a name of an S3 compatible object storage. The cmdlet will add object storage with this name.

String

False

Named

False

Description

Specifies a description of an S3 compatible object storage. The cmdlet will add object storage with this description.

String

False

Named

False

EnableSizeLimit

Enables size limits for data blocks that you want to store in an S3 compatible object storage.

Use the SizeLimit parameter to specify the size limits.

SwitchParameter

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.

Permitted value: 1024 - 1073741824.

Default: 10240.

Int32

False

Named

False

EnableIAStorageClass

Defines that the cmdlet will enable the infrequent access storage class for data blocks that are stored in an S3 compatible object storage.

SwitchParameter

False

Named

False

EnableOZIAStorageClass

Defines that the cmdlet will enable the One Zone-IA storage class for data blocks that are stored in object storage.

SwitchParameter

False

Named

False

UseGatewayServer

Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories.

Default: True.

Note: If you do not specify the UseGatewayServer parameter, the cmdlet will use a proxy server to transfer data.

SwitchParameter

False

Named

False

GatewayServer

Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.

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

False

Named

False

ProxyAppliance

Specifies a helper appliance. Veeam Backup & Replication will use this appliance to perform a health check of backup files and apply retention to NAS backup files.

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

False

Named

False

ConnectionType

Specifies how Veeam Backup & Replication will access the object storage repository:

  • Direct: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories.
  • Gateway: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories.
    Note: Provide the GatewayServer parameter to specify the server.

Default: Direct.

VBRRepositoryConnectionType

False

Named

False

ImmutabilityPeriod

For the EnableBackupImmutability parameter.

Defines the immutability period in days.

Default: 30 days.

Maximum: 999 days.

Int32

False

Named

False

MountServerOptions

Specifies settings of a mount server for object storage repositories.

Note: This parameter is required for object storage repositories that you want to add as performance extents to a scale-out backup repository.

 

Accepts the VBRRepositoryMountServerOptions object. To create this object, run the New-VBRRepositoryMountServerOptions cmdlet.

 

False

Named

False

LimitConcurrentJobs

Defines that the number of concurrent jobs using this repository must be limited.

Use the MaxConcurrentJobs parameter to set the maximum value.

SwitchParameter

False

Named

False

MaxConcurrentJobs

To set maximum value for the LimitConcurrentJobs parameter.

Specifies the maximum allowed number of concurrent tasks for a repository.

Permitted values: 1 to 99.

Int32

False

Named

False

ForceOwnershipChange

Defines that the cmdlet will force ownership change of the object storage folder.

If you do not provide this parameter and the object storage folder is owned by another host, you will not be able to add object storage to the backup infrastructure.

SwitchParameter

False

Named

False

Force

Defines that the cmdlet will modify an object storage repository without showing warnings in the PowerShell console.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRAmazonS3CompatibleRepository

Examples

Modifying Gateway Server Settings of S3 Сompatible Object Storage

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

$amazon = Get-VBRObjectStorageRepository -Type AmazonS3Compatible

$gateserv = Get-VBRServer -Name "north.tech.local, north2.tech.local"

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

Perform the following steps:

  1. Run the Get-VBRObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $amazon variable.
  2. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gateserv variable.
  3. Run the Set-VBRAmazonS3CompatibleRepository cmdlet. Set the $amazon variable as the Repository parameter value. Provide the UseGatewayServer parameter. Set the $gateserv variable as the GatewayServer parameter value.

Related Commands