Add-VBRAmazonS3Server

Short Description

Adds Amazon S3 storage 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

Add-VBRAmazonS3Server -FriendlyName <string> -Account <VBRAmazonAccount> -Region <VBRAmazonS3Region> -CacheRepository <CBackupRepository> [-ProxyMode {Automatic | SelectedProxy}] [-SelectedProxyServer <VBRNASProxyServer[]>] [-BackupIOControlLevel <VBRUnstructuredBackupIOControlLevel> {Lowest | Low | Medium | High | Highest}] [-BucketName <string>] [<CommonParameters>]

Detailed Description

This cmdlet adds Amazon S3 storage to the inventory. You can use this object storage as a source of data for object storage backup job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

FriendlyName

Specify a name that you want to assign to the object storage.

String

True

Named

True (ByValue)

Account

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

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

True

Named

False

Region

Specifies an array of Amazon S3 regions where Amazon S3 buckets are located. The cmdlet will return an array of Amazon S3 buckets from these Amazon S3 regions.

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

True

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

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 Amazon S3 object storage.

Accepts the VBRNASProxyServer[] object. To get this object, run the Get-VBRNASProxyServer 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:

  • Lowest
  • Low
  • Medium
  • High
  • Highest

VBRUnstructuredBackupIOControlLevel

False

Named

False

BucketName

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

String

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 VBRAmazonS3Server object that contains settings of Amazon S3 storage added to the inventory.

Examples

Adding Amazon S3 Storage as Unstructured Data Source

This example shows how to add Amazon S3 storage as unstructured data source to the inventory.

$account = Get-VBRAmazonAccount -AccessKey "XXXXXXXX" -Description "AWS account"

$region = Get-VBRAmazonS3Region -RegionId "eu-central-1"

$cacherepository = Get-VBRBackupRepository -Name "WinSrv"

Add-VBRAmazonS3Server -FriendlyName "Amazon S3 OS" -Account $account -Region $region -CacheRepository $cacherepository

Perform the following steps:

  1. Run the Get-VBRAmazonAccount cmdlet. Specify the AccessKey and the Description parameters values. Save the result to the $account variable.
  2. Run the Get-VBRAmazonS3Region cmdlet. Specify the RegionId parameter value. Save the result to the $region variable.
  3. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $cacherepository variable.
  4. Run the Add-VBRAmazonS3Server cmdlet. Specify the following settings:
  • Specify the FriendlyName parameter value.
  • Set the $account variable as the Account parameter value.
  • Set the $region variable as the Region parameter value.
  • Set the $cacherepository variable as the CacheRepository parameter value.

Related Commands