Add-VBRComputerFileProxyServer

Short Description

Adds new file proxy servers to the backup infrastructure.

Applies to

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

Syntax

Add-VBRComputerFileProxyServer -Server <CHost> [-Description <string>] [-ConcurrentTaskNumber <int>] [<CommonParameters>]

Detailed Description

This cmdlet adds file proxy servers to the backup infrastructure. Veeam Backup & Replication will use these servers for Veeam Agent storage integration.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Server	Specifies the host where the file proxy server is located. The cmdlet will add this host as the file proxy server to the backup infrastructure. Note: The file proxy server must run the Microsoft Windows Server OS.	Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.	True	Named	True (ByValue, ByProperty Name)
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 a 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

Server

Specifies the host where the file proxy server is located. The cmdlet will add this host as the file proxy server to the backup infrastructure.

Note: The file proxy server must run the Microsoft Windows Server OS.

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

True

Named

True (ByValue,
ByProperty
Name)

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 a 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 backup infrastructure.

Examples

Add-VBRComputerFileProxyServer Example 1. Adding File Proxy Servers

This example shows how to add a file proxy server to the backup infrastructure. The file proxy server is assigned two concurrent tasks to process.

$server = Get-VBRServer -Name "File Proxy 01"

Add-VBRComputerFileProxyServer -Server $server

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Add-VBRComputerFileProxyServer cmdlet. Set the $server variable as the Server parameter value.

Add-VBRComputerFileProxyServer Example 2. Adding File Proxy Servers with Specific Number of Concurrent Tasks

This example shows how to add file proxy servers to the backup infrastructure. The file proxy server is assigned 100 concurrent tasks to process.

$server = Get-VBRServer -Name "File Proxy 01"

Add-VBRComputerFileProxyServer -Server $server -ConcurrentTaskNumber 100

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Add-VBRComputerFileProxyServer cmdlet. Set the $server variable as the Server parameter value. Specify the ConcurrentTaskNumber parameter value.

Related Commands

Get-VBRServer