Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRViProxy

Short Description

Adds VMware backup proxies to Veeam Backup & Replication.

Applies to

Platform: VMware

For Hyper-V, run Add-VBRHvProxy.

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.

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.
  • Ndb: 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

Indicates if 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.

False

Named

False

False

EnableHostToProxyEncryption

Indicates if VM data must be transported over an encrypted SSL connection in the Network transport mode.

Default: encryption is disabled.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> 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.

PS C:\PS> Add-VBRViProxy -Server $server -Description "Local Backup Proxy"

Related Commands

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation