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

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 that you want to modify. Accepts the CViProxy type.	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 that 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. 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

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:

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

Set-VBRViProxy -Proxy $proxy -TransportMode HotAdd -EnableFailoverToNBD -EnableHostToProxyEncryption

Related Commands

Get-VBRServer