---
title: "Set-VBRNasFilerSMBServer"
description: "This cmdlet modifies settings of SMB shares located on an enterprise NAS system and added to the inventory. You can either specify the cache repository manually or make the file share to inherit cache repository settings from the enterprise NAS..."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrnasfilersmbserver.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Unstructured Data Backup > Working with Unstructured Data Source > Adding Enterprise Storage System as NAS Filer > Set-VBRNasFilerSMBServer"
dateModified: "2026-08-20"
---

# Set-VBRNasFilerSMBServer

## Short Description
Modifies settings of SMB shares located on an enterprise NAS system added to the inventory.

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

## Syntax

This cmdlet provides the following parameter sets:

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

```
Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-CacheRepository <CBackupRepository>]
 [-MetaMigrationType <VBRNASBackupMetaMigrationType>]
 [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]
 [-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>AddCredentials</code></p>

```
Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-User <String>] [-Password <String>]
 [-CacheRepository <CBackupRepository>] [-MetaMigrationType <VBRNASBackupMetaMigrationType>]
 [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]
 [-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Credentials</code></p>

```
Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-AccessCredentials <CCredentials>]
 [-CacheRepository <CBackupRepository>] [-MetaMigrationType <VBRNASBackupMetaMigrationType>]
 [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]
 [-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>InheritSettings</code></p>

```
Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-MetaMigrationType <VBRNASBackupMetaMigrationType>]
 [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-InheritSettingsFromFiler] [-Force] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet modifies settings of SMB shares located on an enterprise NAS system and added to the inventory. You can either specify the cache repository manually or make the file share to inherit cache repository settings from the enterprise NAS system.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## 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 enterprise NAS system.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</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">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 a cache repository. The cmdlet will set this repository as a cache repository for the SMB file share.</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>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 modify settings of SMB shares 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">InheritSettingsFromFiler</span></p>
        </td>
        <td>
          <p>Defines that the SMB file share will inherit settings of the enterprise SMB system. If you provide this parameter, the cmdlet will inherit cache settings, throttling settings and credentials.</p><p><strong>Note</strong>: You must provide the <code>MetaMigrationType</code> to inherit cache repository settings.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</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">MetaMigrationType</span></p>
        </td>
        <td>
          <p>Specifies how the cmdlet will migrate metadata. You can use one of the following options:</p><ul><li><code>CheckExistence</code> — use this option to check that metadata is available on the current cache repository.</li><li><code>CopyMetaFromCache</code> — use this option to migrate metadata from source cache repository to a new cache repository.</li></ul><p><strong>Note</strong>: If metadata in a source cache repository is corrupted, the cmdlet will copy data from the archive repository.</p><ul><li><code>DownloadMetaFromArchive</code> — use this option to migrate metadata from archive repository or from replica metadata in archive repository.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRNASBackupMetaMigrationType</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 enterprise NAS system.</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">RetrievalSettings</span></p>
        </td>
        <td>
          <p>Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive repositories.</p><p>Accepts the <code>VBRUnstructuredBackupColdStorageRetrievalSettings</code> object. To create this object, run the <a href="new-vbrunstructuredbackupretrievalsettings.md"><code>New-VBRUnstructuredBackupColdStorageRetrievalSettings</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupColdStorageRetrievalSettings</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">Server</span></p>
        </td>
        <td>
          <p>Specifies an SMB file share. The cmdlet will modify settings for this file share.</p><p>Accepts the <code>VBRSANNASSMBServer</code> <code>(VBRNASServer)</code> object. To get this object, run the <a href="get-vbrunstructuredserver.md"><code>Get-VBRUnstructuredServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRSANNASSMBServer</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</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 enterprise NAS system.</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
The cmdlet returns the `VBRNASServer` object that defines settings of the SMB file share located on the enterprise NAS system.

## Examples

::: example
### Example 1. Setting Cache Repository for SMB Share Manually

This example shows how to modify SMB share: a cache repository is specified manually.

```
$isilonhost = Get-VBRIsilonHost -Name "HostName"
$volume = Get-VBRIsilonVolume -Name "SMB Share" -Host $isilonhost
$isi = Get-VBRUnstructuredServer -SANEntity $volume
$cacherepo = Get-VBRBackupRepository -Name "Cache repository 1"
Set-VBRNasFilerSMBServer -Server $isi -CacheRepository $cacherepo
```

Perform the following steps:

1. Run the [`Get-VBRIsilonHost`](get-vbrisilonhost.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$isilonhost` variable.
2. Run the [`Get-VBRIsilonVolume`](get-vbrisilonvolume.md) cmdlet. Specify the `Name` parameter value. Set the `$isilonhost` variable as the `Host` parameter value. Save the result to the `$volume` variable.
3. Run the [`Get-VBRUnstructuredServer`](get-vbrunstructuredserver.md) cmdlet. Set the `$volume` variable as the `SANEntity` parameter value. Save the result to the `$volume` variable.
4. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$cacherepo` variable.
5. Run the `Set-VBRNasFilerSMBServer` cmdlet. Set the `$isi` variable as the `Server` parameter value. Set the `$cacherepo` variable as the `CacheRepository` parameter value.

:::

::: example
### Example 2. Setting Cache Repository Settings Inherited from NAS System for SMB Share

This example shows how to modify SMB share: a cache repository settings are inherited from the enterprise NAS system on which the share is located.

```
$isilonhost = Get-VBRIsilonHost -Name "HostName"
$volume = Get-VBRIsilonVolume -Name "SMB Share" -Host $isilonhost
$isi = Get-VBRUnstructuredServer -SANEntity $volume
Set-VBRNasFilerSMBServer -Server $isi -InheritSettingsFromFiler
```

Perform the following steps:

1. Run the [`Get-VBRIsilonHost`](get-vbrisilonhost.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$isilonhost` variable.
2. Run the [`Get-VBRIsilonVolume`](get-vbrisilonvolume.md) cmdlet. Specify the `Name` parameter value. Set the `$isilonhost` variable as the `Host` parameter value. Save the result to the `$volume` variable.
3. Run the [`Get-VBRUnstructuredServer`](get-vbrunstructuredserver.md) cmdlet. Set the `$volume` variable as the `SANEntity` parameter value. Save the result to the `$volume` variable.
4. Run the `Set-VBRNasFilerSMBServer` cmdlet. Set the `$isi` variable as the `Server` parameter value. Provide the `InheritSettingsFromFiler` parameter.

:::

## Related Commands

- [`Get-VBRIsilonHost`](get-vbrisilonhost.md)
- [`Get-VBRIsilonVolume`](get-vbrisilonvolume.md)
- [`Get-VBRUnstructuredServer`](get-vbrunstructuredserver.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)