Set-VBRS3CompatibleServer

Short Description

Modifies settings of Amazon S3 storage added as unstructured data source to the inventory.

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

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

Syntax

Set-VBRS3CompatibleServer -Server <VBRS3CompatibleServer> [-Account <VBRAmazonAccount>] [-ProxyMode {Automatic | SelectedProxy}] [-SelectedProxyServer <VBRNASProxyServer[]>] [-CacheRepository <CBackupRepository>][-BackupIOControlLevel <VBRUnstructuredBackupIOControlLevel> {Lowest | Low | Medium | High | Highest}] [-MetaMigrationType VBRUnstructuredBackupMetaMigrationType {CheckExistence | CopyMetaFromCache | DownloadMetaFromArchive}] [-BucketName <string>] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Amazon S3 storage added as unstructured data source to the inventory.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Server

Specifies the S3 compatible storage that you want to modify.

Accepts the VBRAmazonS3Server object. To create this object, run the Get-VBRUnstructuredServer cmdlet.

True

Named

True (ByValue, ByPropertyName)

Account

Specifies an S3 credentials record. Veeam Backup & Replication will use this credentials record to connect to S3 compatible object storage.

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

False

Named

True (ByValue)

ProxyMode

Specifies the backup proxy options.

  • Automatic: use this option if you want Veeam Backup & Replication to choose the backup proxy that will process object storage.
  • SelectedProxy: use this option if you want to specify the backup proxy that will process object storage.
    Use the SelectedProxyServer parameter to specify the backup proxy.

VBRNASProxyMode

False

Named

False

SelectedProxyServer

For the SelectedProxy option of the ProxyMode parameter.

Specifies the backup proxy. Veeam Backup & Replication will use this backup proxy to back up to back up S3 compatible object storage.

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

False

Named

False

CacheRepository

Specifies the cache repository. Veeam Backup & Replication will keep the .VCACHE files on this repository.

Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

BackupIOControlLevel

Specifies a speed that Veeam Backup & Replication will use to read data from object storage. You can specify either of the following speed:

  1. Lowest
  2. Low
  3. Medium
  4. High
  5. Highest

VBRUnstructuredBackupIOControlLevel

False

Named

False

MetaMigrationType

Specifies how the cmdlet will migrate metadata. You can use one of the following options:

  • CheckExistence — use this option to check that metadata is available on the current cache repository.
  • CopyMetaFromCache — use this option to migrate metadata from source cache repository to a new cache respository.
    Note: If metadata in a source cache repository is corruted, the cmdlet will copy data from the archive repository.
  • DownloadMetaFromArchive — use this option to migrate metadata from archive repository or from replica metadata in archive repository.

VBRUnstructuredBackupMetaMigrationType

False

Named

False

BucketName

Specifies a name of the S3 compatible bucket. The cmdlet will connect to this bucket.

String

False

Named

False

Force

Defines that the cmdlet will add S3 compatible object storage 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

The cmdlet returns the VBRS3CompatibleServer object that contains settings of S3 compatible storage added to the inventory.

Examples

Modifying Settings of S3 Compatible Storage Added as Unstructured Data Source

This example shows how to set the high speed for Veeam Backup & Replication to read data from S3 compatible storage added as unstructured data source to the inventory.

$server = Get-VBRUnstructuredServer -Name "S3 compatible OS"

Set-VBRS3CompatibleServer -Server $server -BackupIOControlLevel High

Perform the following steps:

  1. Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter values. Save the result to the $server variable.
  2. Run the Set-VBRS3CompatibleServer cmdlet. Set the $server variable as the Server parameter value. Specify the BackupIOControlLevel parameter value.

Related Commands

Get-VBRUnstructuredServer