Set-VBRNASNFSServer

Short Description

Modifies settings of NFS network shared folders added to the Veeam Backup & Replication infrastructure.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRNASNFSServer -Server <VBRNASNFSServer> [-ProcessingMode <VBRNASProcessingMode> {Direct | VSSSnapshot |StorageSnapshot}] [-ProxyMode <VBRNASProxyMode> {Automatic | SelectedProxy}] [-SelectedProxyServer <VBRNASProxyServer[]>] [-CacheRepository <CBackupRepository>][-StorageSnapshotPath <string> [-BackupIOControlLevel {Lowest | Low | Medium | High | Highest}] [-EnableDirectBackupFailover]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of NFS network shared folders added to the Veeam Backup & Replication infrastructure. This cmdlet modifies an existing VMware replication job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Server

Specify an NFS network shared folder. The cmdlet will modify settings of this network shared folder.

Accepts the VBRNASNFSServer object. To get this object, run the Get-VBRNASServer cmdlet.

True

Named

True (ByValue, ByPropertyName)

 

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 that have been created by the backup proxy.

VBRNASProcessingMode

False

Named

False

 

StorageSnapshotPath

For the StorageSnapshot processing options.

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

 

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 NFS network shared folder.
  • SelectedProxy: use this option if you want to specify the backup proxy that will process the NFS 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 process the NFS network shared folder.

VBRNASProxyServer[]

False

Named

False

 

CacheRepository

Specifies the cache repository. Veeam Backup & Replication will keep the cached data of the NFS network shared folder on this repository.

CBackupRepository

False

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

 

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

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRNASNFSServer object that contains settings of the NFS network shared folder that is added to the Veeam Backup & Replication infrastructure.

Examples

Set-VBRNASNFSServerExample 1. Modifying Processing Options

This example shows how to modify the processing options of the \\LinuxSRV2049\November NFS network shared folder. Veeam Backup & Replication will create backups of the \\LinuxSRV2049\November NFS network shared folder from VSS snapshots that have been created by the backup proxy.

$server = Get-VBRNASServer -Name "\\LinuxSRV2049\November"

Set-VBRNASNFSServer -Server $server -ProcessingMode VSSSnapshot

Perform the following steps:

  1. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Set-VBRNASNFSServer cmdlet. Set the $server variable as the Server parameter value. Specify the ProcessingMode parameter value.

Set-VBRNASNFSServerExample 2. Modifying Backup Proxy Options

This example shows how to modify the backup proxy options of the \\LinuxSRV2049\November NFS network shared folder. Veeam Backup & Replication will select the backup proxy to process the \\LinuxSRV2049\November NFS network shared folder automatically.

$server = Get-VBRNASServer -Name "\\LinuxSRV2049\November"

Set-VBRNASNFSServer -Server $server -ProxyMode Automatic

Perform the following steps:

  1. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Set-VBRNASSMBServer cmdlet. Set the $server variable as the Server parameter value. Specify the ProxyMode parameter value.

Set-VBRNASNFSServerExample 3. Modifying Cache Repository Settings

This example shows how to modify cache repository settings of the \\LinuxSRV2049\November NFS network shared folder. The \\LinuxSRV2049\November NFS network shared folder will be processed by the Repository07 backup repository.

$server = Get-VBRNASServer -Name "\\LinuxSRV2049\November"

$repository = Get-VBRBackupRepository -Name Repository07

Set-VBRNASSMBServer -Server $server -CacheRepository $repository

Perform the following steps:

  1. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  3. Run the Set-VBRNASSMBServer cmdlet. Set the $server variable as the Server parameter value. Set the $repository variable as the CacheRepository parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.