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

Set-VBRViProxy

Short Description

Modifies VMware backup proxies.

Applies to

Platform: VMware

For Hyper-V, run Add-VBRHvProxy.

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet modifies settings of a selected VMware backup proxy server. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Proxy

Specifies the proxy you want to modify.

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.

Allowed 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

This example shows how to configure the following settings for the backup proxy:

  • Set transport mode to Virtual Appliance
  • Enable failover to the Network transport mode
  • Encrypt traffic transported over the network

To do this, you must use the following commands:

  1. Run Get-VBRViProxy to get the backup proxy and save it to the $proxy variable.
  2. Run Set-VBRViProxy with the $proxy variable and the following parameters: -TransportMode HotAdd -EnableFailoverToNBD -EnableHostToProxyEncryption.

PS C:\PS> Set-VBRViProxy -Proxy $proxy -TransportMode HotAdd -EnableFailoverToNBD -EnableHostToProxyEncryption

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation