Add-VBRHvProxy

Short Description

Adds a Hyper-V backup proxy to the backup infrastructure.

Platform: Hyper-V

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

Syntax

Add-VBRHvProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet adds a Hyper-V backup proxy server to the backup infrastructure.

When you add a proxy, you set a role to a Microsoft Windows server. To add a new proxy, you need to have the server added to your Veeam Backup & Replication managing console.

Run the Add-VBRWinServer cmdlet to add a Microsoft Windows server.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Description	Specifies a description of a Hyper-V backup proxy.	`String`	False	Named	False
MaxTasks	Specifies the number of concurrent tasks that can be assigned to the proxy simultaneously. Allowed values: `1`-`100`. Default: `2`.	`Int32`	False	Named	False
Server	Specifies a server which will act as a Hyper-V backup proxy. Accepts the `CHost[]` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the CHvProxy[] that contains an array of Hyper-V backup proxy servers added to the backup infrastructure.

Examples

Add-VBRHvProxy Example 1. Adding New Hyper-V Backup Proxy [Using Variable]

This example shows how to add a new Hyper-V backup proxy. The description is Local Backup Proxy. The max concurrent tasks number is set to 2 by default.

$server = Get-VBRServer -Name "Server"

Add-VBRHvProxy -Server $server -Description "Local Backup Proxy"

Perform the following steps:

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

Add-VBRHvProxy Example 2. Adding New Hyper-V Backup Proxy [Using Pipeline]

This example shows how to add a new Hyper-V backup proxy. The description is Local Backup Proxy. The max concurrent tasks number is set to 6.

Get-VBRServer -Name "HyperV Local Server" | Add-VBRHvProxy -Description "Local Backup Proxy" -MaxTasks 6

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Add-VBRHvProxy cmdlet. Specify the Description parameter value. Specify the MaxTasks parameter value.

Get-VBRServer