Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

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 stop the session after you have added S3 Compatible object storage into your Veeam Backup & Replication infrastructure. Run Disconnect-VBRAmazonS3Service to stop the session.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example

This example shows how to connect to S3 Compatible object storage.

  1. Run Get-VBRAmazonAccount to get the Amazon S3 credentials record. Save the result to the $account variable.
  2. Run Get-VBRAmazonS3Region with the $connection 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

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation