Set-VBRNASProxyServer

Short Description

Modifies file backup proxy servers added to the Veeam Backup & Replication infrastructure.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRNASProxyServer -ProxyServer <VBRNASProxyServer> [-Description <string>] [-ConcurrentTaskNumber <int>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of file backup proxy servers 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

ProxyServer

Specifies the file backup proxy server. The cmdlet will modify the settings of this server.

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

True

Named

True (ByValue, ByPropertyName)

 

Description

Specifies a description of the file backup proxy server. The cmdlet will add the proxy server with the specified description.

String

False

Named

False

 

ConcurrentTaskNumber

Specifies the number of concurrent tasks that can be assigned to the file backup proxy simultaneously.

Permitted values: 1-100.

Int32

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 VBRNASProxyServer object that contains settings of the file backup proxy server added to the Veeam Backup & Replication infrastructure.

Examples

Set-VBRNASProxyServerExample 1. Modifying Description

This example shows how to modify a description of the file backup proxy server.

$proxy = Get-VBRNASProxyServer -Name "Proxy05"

Set-VBRNASProxyServer -ProxyServer $proxy -Description "Proxy for SMB network shared folders"

Perform the following steps:

  1. Run the Get-VBRNASProxyServer cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
  2. Run the Set-VBRNASProxyServer cmdlet. Set the $proxy variable as the ProxyServer parameter value. Specify the Description parameter value.

Set-VBRNASProxyServerExample 2. Modifying Number of Concurrent Tasks

This example shows how to modify the number of concurrent tasks for the file backup proxy server. The file backup proxy server will process 50 concurrent tasks simultaneously.

$proxy = Get-VBRNASProxyServer -Name "Proxy05"

Set-VBRNASProxyServer -ProxyServer $proxy -ConcurrentTaskNumber 50

Perform the following steps:

  1. Run the Get-VBRNASProxyServer cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
  2. Run the Set-VBRNASProxyServer cmdlet. Set the $proxy variable as the ProxyServer parameter value. Specify the Description parameter value.

Related Commands

Get-VBRNASProxyServer

I want to report a typo

There is a misspelling right here:

 

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