Connect-VBRAmazonS3CompatibleService
Short Description
Connects to S3 compatible object storage.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Connect-VBRAmazonS3CompatibleService -Account <VBRAmazonAccount> -CustomRegionId <string> -ServicePoint <string> [-GatewayServer <CHost[]>] [-ConnectionType {Direct | Gateway}] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet connects to S3 compatible object storage. It creates the IVBRAmazonS3Connection object that contains the connection settings for the following types of storage:
- S3 compatible object storage
- AWS Snowball Edge device
- Wasabi Cloud Object Storage
You can use these settings to add S3 compatible devices to the backup infrastructure as the following types of repositories:
- An object storage repository. Run the Add-VBRAmazonS3CompatibleRepository cmdlet to add S3 compatible object storage as an object storage repository.
- An external repository. Run the Add-VBRAmazonS3ExternalRepository cmdlet to add S3 compatible as an external repository.
- A capacity extent of a scale-out backup repository.
- An archive extent of a scale-out backup repository.
Note |
Mind the following:
|
Parameters
Parameter | Description | Type | 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 object. To create this object, run the Get-VBRAmazonAccount cmdlet. | True | Named | True (ByValue) |
CustomRegionId | Specifies an Amazon S3 region where your S3 compatible object storage is located. Note: To connect to the AWS Snowball Edge device, you must provide the snow value for the CustomRegionId parameter. | String | True | Named | False |
ServicePoint | Specifies the endpoint. The cmdlet will use this endpoint to connect to S3 compatible object storage. | String | True | Named | False |
GatewayServer | Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories. | Accepts the CHost[] object. To get this object, run the Get-VBRServer cmdlet. | False | Named | False |
ConnectionType | Specifies how Veeam Backup & Replication will access the object storage repository:
Default: Direct. | VBRRepositoryConnectionType | 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. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
VBRAmazonS3CompatibleRepository
Examples
Example 1. Connecting to S3 Compatible Object Storage
This example shows how to connect to S3 compatible object storage.
Perform the following steps:
|
Example 2. Connecting to AWS Snowball Edge
This example shows how to connect to AWS Snowball Edge.
Perform the following steps:
|
Related Commands