Set-VBRComputerFileProxyServer

Short Description

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

Applies to

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

Syntax

Set-VBRComputerFileProxyServer -FileProxy <VBRComputerFileProxyServer> [-Description <string>] [-ConcurrentTaskNumber <int>] [<CommonParameters>]

Detailed Description

This cmdlet modifies an existing file proxy server.

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
FileProxy	Specifies the file proxy server. The cmdlet will modify the settings of this server.	Accepts the VBRComputerFileProxyServer object. To get this object, run the Get-VBRComputerFileProxyServer cmdlet.	True	Named	True (ByValue, ByPropertyName)
Description	Specifies a description of the file proxy server. The cmdlet will add the proxy server with the specified description.	String	False	Named	False
ConcurrentTaskNumber	Specifies the integer defining the number of concurrent tasks that can be assigned to the file proxy simultaneously. Permitted values: 1-128. Default: 2.	Int32	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

FileProxy

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

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

True

Named

True (ByValue, ByPropertyName)

Description

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

String

False

Named

False

ConcurrentTaskNumber

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

Permitted values: 1-128.

Default: 2.

Int32

False

Named

False

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

Output Object

The cmdlet returns the VBRComputerFileProxyServer object that contains settings of the file proxy server added to the Veeam Backup & Replication infrastructure.

Examples

Set-VBRComputerFileProxyServer Example 1. Modifying Description

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

$proxy = Get-VBRComputerFileProxyServer -Name "File Proxy 01"

Set-VBRComputerFileProxyServer -FileProxy $proxy -Description "Proxy for Veeam Agents"

Perform the following steps:

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

Set-VBRComputerFileProxyServer Example 2. Modifying Number of Concurrent Tasks

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

$proxy = Get-VBRComputerFileProxyServer -Name "File Proxy 01"

Set-VBRComputerFileProxyServer -FileProxy $proxy -ConcurrentTaskNumber 50

Perform the following steps:

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

Related Commands

Get-VBRComputerFileProxyServer