---
title: "Add-VBRS3GlacierCompatibleRepository"
description: "This cmdlet adds S3 compatible object storage with data archiving to the backup infrastructure. To be able to work with S3 compatible object storage with data archiving, you must enable the SOSAPI functionality."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbrs3glaciercompatiblerepository.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Object Storage Repositories > Adding Amazon S3 and S3 Compatible Object Storage > Add-VBRS3GlacierCompatibleRepository"
dateModified: "2026-08-19"
---

# Add-VBRS3GlacierCompatibleRepository

## Short Description
Adds S3 compatible object storage with data archiving to the backup infrastructure.

**Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License

## Syntax
```
Add-VBRS3GlacierCompatibleRepository [-Name <String>] [-Description <String>]
 -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3CompatibleConnection> [-EnableBackupImmutability]
 [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>] [-ArchiverAppliance <CHost>]
 [-ForceOwnershipChange] [-EnableReadOnlyMode] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet adds S3 compatible object storage with data archiving to the backup infrastructure.

::: important

To be able to work with S3 compatible object storage with data archiving, you must enable the SOSAPI functionality. For more information, see [Working with Veeam Smart Object Storage API (SOSAPI)](https://helpcenter.veeam.com/docs/vbr/userguide/sosapi.html?ver=13) section in Veeam Backup & Replication User Guide.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AmazonS3Folder</span></p>
        </td>
        <td>
          <p>Specifies a folder for S3 compatible object storage with data archiving. Veeam Backup & Replication will move backup files into this folder.</p><p>Accepts the <code>VBRAmazonS3Folder</code> object. To create this object, run the <a href="new-vbramazons3folder.md"><code>New-VBRAmazonS3Folder</code></a> cmdlet. To get this object, run the <a href="get-vbramazons3folder.md"><code>Get-VBRAmazonS3Folder</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbramazons3folder.md"><code>VBRAmazonS3Folder</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ArchiverAppliance</span></p>
        </td>
        <td>
          <p>Specifies the archiver appliance. The cmdlet will use it to transfer data from S3 compatible object storage to S3 compatible object storage with data archiving. You can use either Windows-based or Linux-based appliance.</p><p>Accepts the <code>CHost</code> object. To get this object, run the <a href="get-vbrserver.md"><code>Get-VBRServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Connection</span></p>
        </td>
        <td>
          <p>Specifies an active session with S3 compatible object storage that supports data archiving. The cmdlet use it to add S3 compatible object storage as a backup repository.</p><p>Accepts the <code>VBRAmazonS3Connection</code> object. To get this object, run the <a href="connect-vbramazons3compatibleservice.md"><code>Connect-VBRAmazonS3CompatibleService</code></a> cmdlet and set the <code>ArchiveTier</code> property as the <code>ServiceType</code> parameter value.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRAmazonS3CompatibleConnection</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies a description of S3 compatible object storage with data archiving. The cmdlet will add S3 compatible object storage with this description.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableBackupImmutability</span></p>
        </td>
        <td>
          <p>Enables immutability for S3 compatible object storage with data archiving.</p><p>Default: <code>False.</code></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableReadOnlyMode</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add the object storage repository in the read-only mode. If you enable this option, Veeam Backup & Replication will not write or modify data in the object storage repository. You can use the object storage repository for restore operations only.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add S3 compatible object storage with data archiving without showing warnings in the PowerShell console.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ForceOwnershipChange</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will force ownership change of the folder for S3 compatible that supports data archiving.</p><p>If you do not provide this parameter and the S3 compatible object storage folder is owned by another host, you will not be able to add S3 compatible object storage to the backup infrastructure.</p><p>Default: <code>False.</code></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityMode</span></p>
        </td>
        <td>
          <p>Specifies the immutability retention period:</p><ul><li><code>BackupRetention</code>: Use this option if you want the immutability period to depend on the backup job retention.</li><li><code>RepositoryRetention</code>: Use this option if you want to ignore the job retention and specify the immutability period explicitly.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRRepositoryImmutabilityMode</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityPeriod</span></p>
        </td>
        <td>
          <p>For the <code>EnableBackupImmutability</code> parameter.</p><p>Defines the immutability period in days.</p><p>Default: <code>30</code> days.</p><p>Maximum: <code>999</code> days.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies a name of S3 compatible object storage with data archiving. The cmdlet will add S3 compatible object storage with this name.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
[`VBRS3GlacierCompatibleRepository`](vbrs3glaciercompatiblerepository.md)

## Examples

::: example
### Adding S3 Compatible Object Storage with Data Archiving

This example shows how to add S3 compatible object storage with data archiving to the backup infrastructure.

```
$account = Get-VBRAmazonAccount
$connect = Connect-VBRAmazonS3CompatibleService -Account $account[0] -CustomRegionId "us-east-1" -ServicePoint "http://172.24.185.88:80" -ServiceType ArchiveTier 
$folder = New-VBRAmazonS3Folder -Bucket $bucket[1] -Connection $connect -Name "TW02"
$s3Archive = Add-VBRS3GlacierCompatibleRepository -AmazonS3Folder $folder -Name "Monthly_Reports" -Connection $connect
```

Perform the following steps:

1. Run the [`Get-VBRAmazonAccount`](get-vbramazonaccount.md) cmdlet. Save the result to the `$account` variable.
2. Run the [`Connect-VBRAmazonS3CompatibleService`](connect-vbramazons3compatibleservice.md) cmdlet. Specify the `Account`, `CustomRegionId`, `ServicePoint` and the `ServiceType` parameter values. Save the result to the `$connect` variable.
3. Run the [`New-VBRAmazonS3Folder`](new-vbramazons3folder.md) cmdlet. Specify the `Bucket`, `Connection` and `Name` parameter values. Save the result to the `$folder` variable.
4. Run the `Add-VBRS3GlacierCompatibleRepository` cmdlet. Specify the following settings:

   - Set the `$folder` variable as the `AmazonS3Folder` parameter value. 
   - Set the `$connect` variable as the `Connection` parameter value. 
   - Set the `Name` parameter value. 
   - Save the result to the `$s3Archive` variable.

:::

## Related Commands

- [`Get-VBRAmazonAccount`](get-vbramazonaccount.md)
- [`Connect-VBRAmazonS3CompatibleService`](connect-vbramazons3compatibleservice.md)
- [`New-VBRAmazonS3Folder`](new-vbramazons3folder.md)