---
title: "Add-VBRS3CompatibleServer"
description: "This cmdlet adds S3 compatible object storage as unstructured data source to the inventory."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbrs3compatibleserver.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Unstructured Data Backup > Working with Unstructured Data Source > Adding Object Storage Servers > Add-VBRS3CompatibleServer"
dateModified: "2026-08-19"
---

# Add-VBRS3CompatibleServer

## Short Description
Adds S3 compatible object storage as unstructured data source to the inventory.

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

## Syntax
```
Add-VBRS3CompatibleServer -Account <VBRAmazonAccount> -FriendlyName <String> [-RegionId <String>]
 -ServicePoint <String> [-ProxyMode <VBRNASProxyMode>] [-SelectedProxyServer <VBRNASProxyServer[]>]
 -CacheRepository <CBackupRepository> [-BackupIOControlLevel <VBRUnstructuredBackupIOControlLevel>]
 [-BucketName <String>] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet adds S3 compatible object storage as unstructured data source to the inventory.

## 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">Account</span></p>
        </td>
        <td>
          <p>Specifies an S3 credentials record. Veeam Backup & Replication will use this credentials record to connect to S3 compatible object storage.</p><p>Accepts the <a href="vbramazonaccount.md"><code>VBRAmazonAccount</code></a> object. To get this object, run the <a href="get-vbramazonaccount.md"><code>Get-VBRAmazonAccount</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbramazonaccount.md"><code>VBRAmazonAccount</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">BackupIOControlLevel</span></p>
        </td>
        <td>
          <p>Specifies a speed that Veeam Backup & Replication will use to read data from object storage. You can specify either of the following speed:</p><ul><li><code>Lowest</code></li><li><code>Low</code></li><li><code>Medium</code></li><li><code>High</code></li><li><code>Highest</code></li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupIOControlLevel</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">BucketName</span></p>
        </td>
        <td>
          <p>Specifies a name of the S3 compatible bucket. The cmdlet will connect to this bucket.</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">CacheRepository</span></p>
        </td>
        <td>
          <p>Specifies the cache repository. Veeam Backup & Replication will keep the .VCACHE files on this repository.</p><p>Accepts the <code>CBackupRepository</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</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">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add S3 compatible object storage 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">FriendlyName</span></p>
        </td>
        <td>
          <p>Specify a name that you want to assign to the object storage.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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">ProxyMode</span></p>
        </td>
        <td>
          <p>Specifies the backup proxy options.</p><ul><li><code>Automatic</code>: use this option if you want Veeam Backup & Replication to choose the backup proxy that will process object storage.</li><li><code>SelectedProxy</code>: use this option if you want to specify the backup proxy that will process object storage. Use the <code>SelectedProxyServer</code> parameter to specify the backup proxy.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRNASProxyMode</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">RegionId</span></p>
        </td>
        <td>
          <p>Specifies a region.</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">SelectedProxyServer</span></p>
        </td>
        <td>
          <p>For the <code>SelectedProxy</code> option of the <code>ProxyMode</code> parameter.</p><p>Specifies the backup proxy. Veeam Backup & Replication will use this backup proxy to to back up S3 compatible object storage.</p><p>Accepts the <code>VBRNASProxyServer[]</code> object. To get this object, run the <a href="get-vbrnasproxyserver.md"><code>Get-VBRNASProxyServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnasproxyserver.md"><code>VBRNASProxyServer[]</code></a></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">ServicePoint</span></p>
        </td>
        <td>
          <p>Specifies a service point address of object storage.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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>
    </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
The cmdlet returns the `VBRS3CompatibleServer` object that contains settings of S3 compatible storage added to the inventory.

## Examples

::: example
### Adding S3 Compatible Storage as Unstructured Data Source

This example shows how to add S3 compatible storage as unstructured data source to the inventory.

```
$account = Get-VBRAmazonAccount -AccessKey "XXXXXXXX" -Description "S3 account"
$cacherepository = Get-VBRBackupRepository -Name "WinSrv"
Add-VBRS3CompatibleServer -FriendlyName "S3 compatible" -Account $account -ServicePoint "S3.eu.compatible" -CacheRepository $cacherepository
```

Perform the following steps:

1. Run the [`Get-VBRAmazonAccount`](get-vbramazonaccount.md) cmdlet. Specify the `AccessKey` and `Description` parameters values. Save the result to the `$account` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$cacherepository` variable.
3. Run the `Add-VBRAmazonS3Server` cmdlet. Specify the following settings:

   - Specify the `FriendlyName` parameter value.
   - Set the `$account` variable as the `Account` parameter value.
   - Specify the `ServicePoint` parameter value.
   - Set the `$cacherepository` variable as the `CacheRepository` parameter value.

:::

## Related Commands

- [`Get-VBRAmazonAccount`](get-vbramazonaccount.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)