Add-VBRViProxy

In this article

    Short Description

    Adds VMware backup proxies to the backup infrastructure.

    Applies to

    Platform: VMware

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

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

    When you add a proxy, you assign the role of the backup proxy to a Windows-based or Linux-based server that you add to the backup infrastructure. To add a new proxy, you need to have the server added to the backup infrastructure.

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

    Run the Add-VBRLinux cmdlet to add a Linux server to the backup infrastructure.

    Run the Add-VBRHvProxy cmdlet to add Hyper-V backup proxies.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Server

    Specifies the server that will act as a VMware backup proxy.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Description

    Specifies the description of a 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

    <CommonParameters>

    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