---
title: "Add-VBRNASSMBServer"
description: "This cmdlet adds SMB network shared folders to the Veeam Backup & Replication infrastructure."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbrnassmbserver.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Unstructured Data Backup > Working with Unstructured Data Source > Adding File Shares > Add-VBRNASSMBServer"
dateModified: "2026-08-19"
---

# Add-VBRNASSMBServer

## Short Description
Adds SMB network shared folders to the Veeam Backup & Replication infrastructure.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>AllParameterSets (Default)</code></p>

```
Add-VBRNASSMBServer -Path <String> [-ProcessingMode <VBRNASProcessingMode>] [-ProxyMode <VBRNASProxyMode>]
 [-SelectedProxyServer <VBRNASProxyServer[]>] -CacheRepository <CBackupRepository>
 [-StorageSnapshotPath <String>] [-BackupIOControlLevel <VBRNASBackupIOControlLevel>]
 [-EnableDirectBackupFailover] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>AddCredentials</code></p>

```
Add-VBRNASSMBServer -Path <String> -User <String> -Password <String> [-ProcessingMode <VBRNASProcessingMode>]
 [-ProxyMode <VBRNASProxyMode>] [-SelectedProxyServer <VBRNASProxyServer[]>]
 -CacheRepository <CBackupRepository> [-StorageSnapshotPath <String>]
 [-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-EnableDirectBackupFailover] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Credentials</code></p>

```
Add-VBRNASSMBServer -Path <String> -AccessCredentials <CCredentials> [-ProcessingMode <VBRNASProcessingMode>]
 [-ProxyMode <VBRNASProxyMode>] [-SelectedProxyServer <VBRNASProxyServer[]>]
 -CacheRepository <CBackupRepository> [-StorageSnapshotPath <String>]
 [-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-EnableDirectBackupFailover] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet adds SMB network shared folders to the Veeam Backup & Replication infrastructure.

## 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">AccessCredentials</span></p>
        </td>
        <td>
          <p>Specifies credentials that the cmdlet will use to authenticate against the SMB network shared folder.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</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">BackupIOControlLevel</span></p>
        </td>
        <td>
          <p>Specifies a speed that Veeam Backup & Replication will use to read data from the file server. 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>VBRNASBackupIOControlLevel</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">EnableDirectBackupFailover</span></p>
        </td>
        <td>
          <p>For the <code>StorageSnapshot</code> processing option.</p><p>Defines that if the native storage snapshot fails while being processed, Veeam Backup & Replication will backup data directly from the file server.</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">Password</span></p>
        </td>
        <td>
          <p>Specifies the password. The cmdlet will use this password to authenticate against the SMB network shared folder.</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">Path</span></p>
        </td>
        <td>
          <p>Specifies a path to the SMB network shared folder. The cmdlet will add the SMB network shared folder located at the specified path to the Veeam Backup & Replication infrastructure.</p><p><strong>Note</strong>: Use the <em>\\\\server\\folder</em> format.</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">ProcessingMode</span></p>
        </td>
        <td>
          <p>Specifies processing options that define how Veeam Backup & Replication will back up data.</p><ul><li><code>Direct:</code> use this option to back up directly from the SMB network shared folder. <strong>Note</strong>: This option does not back up locked files.</li><li><code>VSSSnapshot:</code> use this option to back up from VSS snapshots that have been created by the backup proxy.</li><li><code>StorageSnapshot:</code> use this option to back up from the native storage snapshots. Use the <code>StorageSnapshotPath</code> parameter to specify the path to the folder where native storage snapshots are located.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRNASProcessingMode</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">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 the SMB network shared folder.</li><li><code>SelectedProxy</code>: use this option if you want to specify the backup proxy that will process the SMB network shared folder. 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">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 back up the SMB network shared folder.</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">StorageSnapshotPath</span></p>
        </td>
        <td>
          <p>For the <code>StorageSnapshot</code> processing option.</p><p>Specifies the path to the folder where native storage snapshots are located. Veeam Backup & Replication will get data from these snapshots located at the specified folder.</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">User</span></p>
        </td>
        <td>
          <p>Specifies the user name. The cmdlet will apply this user name to authenticate against the SMB network shared folder.</p><p><strong>Note</strong>: The user name must be in the <em>DOMAIN\Username</em> format.</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 `VBRNASSMBServer` object that contains settings of the SMB network shared folder that is added to the Veeam Backup & Replication infrastructure.

## Examples

::: example
### Example 1. Adding SMB Network Shared Folder Without Authentication

This example shows how to add the SMB network shared folder without authentication.

```
$repository = Get-VBRBackupRepository -Name 'Backup Repository 09'
Add-VBRNASSMBServer -Path '\\Server07\SharedDocuments' -CacheRepository $repository
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the `Add-VBRNASSMBServer` cmdlet. Specify the `Path` parameter value. Set the `$repository` variable as the `CacheRepository` parameter value.

:::

::: example
### Example 2. Adding SMB Network Shared Folder with User Name and Password

This example shows how to add the SMB network shared folder authenticated with user name and password.

```
$repository = Get-VBRBackupRepository -Name 'Backup Repository 05'
Add-VBRNASSMBServer -Path '\\Server08\SharedDocuments' -User Administrator -Password AdminCredentials -CacheRepository $repository
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the `Add-VBRNASSMBServer` cmdlet. Specify the following settings:

   - Specify the `Path` parameter value.
   - Specify the `User` parameter value.
   - Specify the `Password` parameter value.
   - Set the `$repository` variable as the `CacheRepository` parameter value.

:::

::: example
### Example 3. Adding SMB Network Shared Folder with Credentials

This example shows how to add SMB network shared folder authenticated with credentials.

```
$repository = Get-VBRBackupRepository -Name 'Backup Repository 05'
$credentials = Get-VBRCredentials -Name 'SMB File Share Credentials'
Add-VBRNASSMBServer -Path '\\Server04\SharedDocuments' -AccessCredentials $credentials -CacheRepository $repository
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$credentials` variable.
3. Run the `Add-VBRNASSMBServer` cmdlet. Specify the following settings:

   - Specify the `Path` parameter value.
   - Set the `$credentials` variable as the `AccessCredentials` parameter value.
   - Set the `$repository` variable as the `CacheRepository` parameter value.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`Get-VBRCredentials`](get-vbrcredentials.md)