This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRAmazonS3CompatibleRepository
Short Description
Adds S3 Compatible object storage repository to Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VBRAmazonS3CompatibleRepository -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3CompatibleConnection> [-Name <String>] [-Description <String>] [-EnableSizeLimit [<SwitchParameter>]][-SizeLimit <Int32>] [-EnableBackupImmutability [<SwitchParameter>]] [-ImmutabilityPeriod <Int32>][<CommonParameters>] |
Detailed Description
This cmdlet adds S3 Compatible object storage repository to Veeam Backup & Replication.
Parameters
Parameter | Description | Required | Position | Accept |
AmazonS3Folder | Specifies an S3 Compatible folder. Veeam Backup & Replication will move backup files into this folder. Accepts the VBRAmazonS3Folder type. | True | Named | True (ByValue) |
Connection | Specifies an active session with an S3 Compatible object storage that you want to add as a backup repository. | True | Named | False |
Name | Specifies a name of an S3 Compatible object storage. The cmdlet will add object storage with this name. | False | Named | False |
Description | Specifies a description of an S3 Compatible object storage. The cmdlet will add object storage with this description. | False | Named | False |
EnableSizeLimit | Indicates that the cmdlet will enable size limits for data blocks that you want to store in an S3 Compatible storage. Use the SizeLimit parameter to specify the size limits. | False | Named | False |
SizeLimit | For the EnableSizeLimit parameter Specifies size limits in GB for data blocks that you want to store in an S3 Compatible object storage added as a backup repository. Permitted value: 1024 - 1073741824. Default: 10240. | False | Named | False |
EnableBackupImmutability | Defines that the cmdlet will enable the immutability option. | False | Named | False |
ImmutabilityPeriod | For the EnableBackupImmutability parameter. Defines the immutability period in days. Default: 30 | 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
Example
This example shows how to add an S3 Compatible object storage as the backup repository to Veeam Backup & Replication.
- Run Get-VBRAmazonAccount to get an Amazon S3 credentials record. Save the result to the $account variable.
- Run Connect-VBRAmazonS3CompatibleService with the $account variable to connect to S3 Compatible object storage. Use the ServicePoint parameter to specify the endpoint. Save the result to the $connect variable.
- Run Get-VBRAmazonS3Bucket with the $connect variable to get an Amazon S3 bucket. Save the result to the $bucket variable.
- Run Get-VBRAmazonS3Folder with the $bucket and the $connect variables to get an Amazon S3 folder. Save the result to the $folder variable.
- Run Add-VBRAmazonS3CompatibleRepository with the $connect and the $folder variables.
$account = Get-VBRAmazonAccount $connect = Connect-VBRAmazonS3CompatibleService -Account $account -CustomRegionId "us-east-1" -ServicePoint "http://123.45.67.89:9000" $bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "New Bucket" $folder = Get-VBRAmazonS3Folder -Name "New Folder" -Bucket $bucket -Connection $connect Add-VBRAmazonS3CompatibleRepository -AmazonS3Folder $folder -Connection $connect -Name "New Repository" |
Related Commands
