Set-VBRAmazonS3CompatibleRepository

Short Description

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

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>]

[-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]

[-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-EnableConcurrentTasksLimit]

[-MaxConcurrentTasks <Int32>] [-EnableBucketAutoProvision] [-MachinesPerBucketLimit <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 parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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
Description	Specifies a description of an S3 compatible object storage. The cmdlet will add object storage with this description.	`String`	False	Named	False
EnableBucketAutoProvision	For creating multiple child buckets. Defines that the cmdlet will create multiple child buckets automatically.	`SwitchParameter`	False	Named	False
EnableConcurrentTasksLimit	Enables limits for concurrent tasks that can be processed by the object storage repository. Use the `MaxConcurrentTasks` parameter to specify the number of tasks.	`SwitchParameter`	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. Default: `False`.	`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
GatewayServer	Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.	`CHost[]`	False	Named	False
ImmutabilityMode	Specifies the immutability retention period: `BackupRetention`: Use this option if you want the immutability period to depend on the backup job retention. `RepositoryRetention`: Use this option if you want to ignore the job retention and specify the immutability period explicitly.	`VBRRepositoryImmutabilityMode`	False	Named	False
ImmutabilityPeriod	For the `EnableBackupImmutability` parameter. Defines the immutability period in days. Default: 30 days. Maximum: 999 days.	`Int32`	False	Named	False
MachinesPerBucketLimit	For creating multiple child buckets. Specifies a number of per-machine backup chains in a sub bucket. The cmdlet will create child buckets according to the amount of per-machine backup chains. Default: `10`.	`Int32`	False	Named	False
MaxConcurrentTasks	Specifies a maximum number of concurrent tasks that can be processed at once by the object storage repository.	`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.	`VBRRepositoryMountServerOptions[]`	False	Named	True (ByPropertyName)
Name	Specifies a name of an S3 compatible object storage. The cmdlet will add object storage with this name.	`String`	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 file backup job files.	`CHost`	False	Named	False
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.	`VBRAmazonS3CompatibleRepository`	True	Named	True (ByValue)
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
UseGatewayServer	Note: This parameter is deprecated and will be ignored. Use the `GatewayServer` parameter instead. Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories. Default: `False`.	`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 Compatible 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 -ConnectionType Gateway -GatewayServer $gateserv

Perform the following steps:

Run the Get-VBRObjectStorageRepository cmdlet. Set the AmazonS3Compatible option for the Type parameter. Save the result to the $amazon variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gateserv variable.
Run the Set-VBRAmazonS3CompatibleRepository cmdlet. Set the $amazon variable as the Repository parameter value. Set the Gateway value for the ConnectionType parameter. Set the $gateserv variable as the GatewayServer parameter value.