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:

AllParameterSets (Default)

Add-VBRNASSMBServer -Path <String> [-ProcessingMode <VBRNASProcessingMode>] [-ProxyMode <VBRNASProxyMode>]

[-SelectedProxyServer <VBRNASProxyServer[]>] -CacheRepository <CBackupRepository>

[-StorageSnapshotPath <String>] [-BackupIOControlLevel <VBRNASBackupIOControlLevel>]

[-EnableDirectBackupFailover] [<CommonParameters>]

AddCredentials

Add-VBRNASSMBServer -Path <String> -User <String> -Password <String> [-ProcessingMode <VBRNASProcessingMode>]

[-ProxyMode <VBRNASProxyMode>] [-SelectedProxyServer <VBRNASProxyServer[]>]

-CacheRepository <CBackupRepository> [-StorageSnapshotPath <String>]

[-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-EnableDirectBackupFailover] [<CommonParameters>]

Credentials

Add-VBRNASSMBServer -Path <String> -AccessCredentials <CCredentials> [-ProcessingMode <VBRNASProcessingMode>]

[-ProxyMode <VBRNASProxyMode>] [-SelectedProxyServer <VBRNASProxyServer[]>]

-CacheRepository <CBackupRepository> [-StorageSnapshotPath <String>]

[-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-EnableDirectBackupFailover] [<CommonParameters>]

Detailed Description

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AccessCredentials	Specifies credentials that the cmdlet will use to authenticate against the SMB network shared folder.	`CCredentials`	True	Named	False
BackupIOControlLevel	Specifies a speed that Veeam Backup & Replication will use to read data from the file server. You can specify either of the following speed: `Lowest` `Low` `Medium` `High` `Highest`	`VBRNASBackupIOControlLevel`	False	Named	False
CacheRepository	Specifies the cache repository. Veeam Backup & Replication will keep the .VCACHE files on this repository. Accepts the `CBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	True	Named	False
EnableDirectBackupFailover	For the `StorageSnapshot` processing option. Defines that if the native storage snapshot fails while being processed, Veeam Backup & Replication will backup data directly from the file server.	`SwitchParameter`	False	Named	False
Password	Specifies the password. The cmdlet will use this password to authenticate against the SMB network shared folder.	`String`	True	Named	False
Path	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. Note: Use the \\\\server\\folder format.	`String`	True	Named	False
ProcessingMode	Specifies processing options that define how Veeam Backup & Replication will back up data. `Direct:` use this option to back up directly from the SMB network shared folder. Note: This option does not back up locked files. `VSSSnapshot:` use this option to back up from VSS snapshots that have been created by the backup proxy. `StorageSnapshot:` use this option to back up from the native storage snapshots. Use the `StorageSnapshotPath` parameter to specify the path to the folder where native storage snapshots are located.	`VBRNASProcessingMode`	False	Named	False
ProxyMode	Specifies the backup proxy options. `Automatic`: use this option if you want Veeam Backup & Replication to choose the backup proxy that will process the SMB network shared folder. `SelectedProxy`: use this option if you want to specify the backup proxy that will process the SMB network shared folder. Use the `SelectedProxyServer` parameter to specify the backup proxy.	`VBRNASProxyMode`	False	Named	False
SelectedProxyServer	For the `SelectedProxy` option of the `ProxyMode` parameter. Specifies the backup proxy. Veeam Backup & Replication will use this backup proxy to back up the SMB network shared folder. Accepts the `VBRNASProxyServer[]` object. To get this object, run the `Get-VBRNASProxyServer` cmdlet.	`VBRNASProxyServer[]`	False	Named	False
StorageSnapshotPath	For the `StorageSnapshot` processing option. 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.	`String`	False	Named	False
User	Specifies the user name. The cmdlet will apply this user name to authenticate against the SMB network shared folder. Note: The user name must be in the DOMAIN\Username format.	`String`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

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

Add-VBRNASSMBServer 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:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Add-VBRNASSMBServer cmdlet. Specify the Path parameter value. Set the $repository variable as the CacheRepository parameter value.

Add-VBRNASSMBServer 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:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
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.

Add-VBRNASSMBServer 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:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
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.