Set-VBRNASProxyServer

Short Description

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

Applies to

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

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.

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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

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

Output Object

VBRNASProxyServer

Examples

Set-VBRNASProxyServer Example 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:

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

Set-VBRNASProxyServer Example 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:

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

Related Commands

Get-VBRNASProxyServer