This is an archive version of the document. To get the most up-to-date information, see the current version.

Connect-VBRAmazonS3CompatibleService

Short Description

Connects to S3 Compatible object storage.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

Connect-VBRAmazonS3CompatibleService -Account <VBRAmazonAccount> -CustomRegionId <string> -ServicePoint <string> [-GatewayServer <CHost>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet connects to S3 Compatible object storage. It creates the IVBRAmazonS3Connection object that contains the connection settings for S3 Compatible object storage. You can use these settings to add S3 Compatible object storage into your Veeam Backup & Replication infrastructure as an external repository or as an object storage repository.

Run Add-VBRAmazonS3Repository to add S3 Compatible object storage as an object storage repository. Veeam Backup & Replication will use this repository to implement the Capacity Tier option for the scale-out repository.

Run Add-VBRAmazonS3ExternalRepository to add S3 Compatible as an external repository.

Connect-VBRAmazonS3CompatibleService Note:

Mind the following:

It is recommended to disconnect the S3 Compatible session at the end. Otherwise, the information that you get within the session will not be refreshed when you connect again, and outdated data will be used then. Run Disconnect-VBRAmazonS3Service to stop the session.

To get an active session, save the result that you get after you run Connect-VBRAmazonS3CompatibleService to a variable.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
Account	Specifies an S3 Compatible service credentials record. Veeam Backup & Replication will use this credentials record to connect to S3 Compatible object storage. Accepts the VBRAmazonAccount type.	True	Named	True (ByValue)
CustomRegionId	Specifies an Amazon S3 region where your S3 Compatible object storage is located. Accepts the VBRAmazonS3Region[] type.	True	Named	False
ServicePoint	Specifies the endpoint. The cmdlet will use this endpoint to connect to S3 Compatible object storage.	True	Named	False
GatewayServer	Specifies a gateway server that you want to use to access S3 Compatible object storage.	False	Named	False
Force	Indicates that the cmdlet will set up a connection to S3 Compatible object storage even if Veeam Backup & Replication or Veeam Agent cannot validate that the certificate is issued from the trusted authorities.	False	Named	False

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 connect to S3 Compatible object storage.

Run Get-VBRAmazonAccount to get the Amazon S3 credentials record. Save the result to the $account variable.
Run Connect-VBRAmazonS3CompatibleService with the $account variable. Use the ServicePoint parameter to specify the endpoint.

$account = Get-VBRAmazonAccount

Connect-VBRAmazonS3CompatibleService -Account $account -CustomRegionId "us-east-1" -ServicePoint "http://123.45.67.89:9000"

Related Commands

Get-VBRAmazonAccount