This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRViProxy

Short Description

Adds VMware backup proxies to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRViProxy -Server <CHost> [-Description <string>] [-MaxTasks <int>] [-TransportMode <VBRProxyTransportMode> {Auto | DirectStorageAccess | HotAdd | Nbd}] [-ConnectedDatastoreMode <VBRProxyConnectedDatastoreMode> {Auto | Manual}] [-Datastore <VBRViDatastore[]>] [-EnableFailoverToNBD] [-EnableHostToProxyEncryption] [<CommonParameters>]

Detailed Description

This cmdlet adds a VMware backup proxy server to the Veeam Backup & Replication managing console.

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 Add-VBRWinServer to add a Microsoft Windows server.

For Hyper-V, run Add-VBRHvProxy.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Server	Specifies the server which will act as a VMware backup proxy.	True	Named	True (ByValue, ByProperty Name)	False
Description	Specifies the description of the VMware proxy.	False	Named	False	False
MaxTasks	Specifies the number of concurrent tasks that can be assigned to the proxy simultaneously. Permitted values: 1-100. Default: 2.	False	Named	False	False
TransportMode	Specifies the transport mode used by the backup proxy: Auto: automatic proxy selection mode. DirectStorageAccess: Direct storage access transport mode (Direct SAN access or Direct NFS access). HotAdd: Virtual appliance transport mode. Nbd: Network transport mode. Default: Auto.	False	Named	False	False
ConnectedDatastoreMode	Specifies the mode the proxy will use to connect to datastores: Auto: Veeam Backup & Replication automatically detects all datastores that allow direct SAN or NFS connection. Manual: backup proxy has a direct SAN or NFS connection to datastores in the Datastore list. Use the Datastore parameter to specify the allowed datastores. Default: Auto.	False	Named	False	False
Datastore	Specifies the list of datastores to which the backup proxy has a direct SAN or NFS connection.	False	Named	False	False
EnableFailoverToNBD	Defines that the backup proxy must fail over to the Network transport mode if it fails to transport data in the Direct storage access or Virtual appliance transport mode. Default: Failover to the Network transport mode is enabled. Note: To disable this option, specify the $false value for the EnableFailoverToNBD parameter.	False	Named	False	False
EnableHostToProxyEncryption	Defines that VM data must be transported over an encrypted SSL connection in the Network transport mode. Default: Encryption is disabled.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and piped down. The description is "Local Backup Proxy". The max concurrent tasks number is set to 6.

Get-VBRServer -Name "VMware Local Server" | Add-VBRViProxy -Description "Local Backup Proxy" -MaxTasks 6

Example 2

This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and assigned to the $server variable. The description is "Local Backup Proxy". The max concurrent tasks number is not set to enable the default value.

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

Example 3

This command adds a new proxy with the Virtual appliance transport mode. The failover to the Network transport mode option is disabled.

Add-VBRViProxy -Server $server -Description "Local Backup Proxy" -TransportMode HotAdd -EnableFailoverToNBD:$false

Related Commands

Get-VBRServer