Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
PowerShell Reference

Set-VBOProxy

Short Description

Modifies backup proxy settings.

Syntax

Set-VBOProxy -Proxy <VBOProxy> [-Credential <PSCredential>] [-Description <String>] [-Port <Int32>] [-ThreadsNumber <Int32>] [-EnableNetworkThrottling [<SwitchParameter>]] [-ThrottlingValue <UInt32>] [-ThrottlingUnit <VBOThrottlingUnit>] [-InternetProxyMode <VBOInternetProxyMode>] [-CustomInternetProxyHostName <String>] [-CustomInternetProxyPort <UInt16>] [-UseCustomInternetProxyAuthentication [<SwitchParameter>]] [-CustomInternetProxyCredential <PSCredential>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a backup proxy added to Veeam Backup for Microsoft Office 365 infrastructure.

Set-VBOProxy Note:

This cmdlet requires a PSCredential object. To obtain a PSCredential object, run Get-Credential cmdlet as described in the Microsoft Powershell Reference.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Proxy

Specifies the backup proxy that you want to modify.

True

Named

True (ByValue)

False

Credential

Specifies credentials that will be used to connect to the backup proxy.

The parameter is optional. If you do not provide this parameter, to connect to the backup proxy, the cmdlet will use the account under which you are currently logged in.

False

Named

False

False

Description

Specifies a description for future reference. The default description contains information on the user who added the backup proxy, date and time when the backup proxy was added.

False

Named

False

False

Port

Specifies a port that will be used to connect to the backup proxy.

Default: 9193

False

Named

False

False

ThreadsNumber

Specifies a number of threads that will be simultaneously processed by the backup proxy.

Default: 64

False

Named

False

False

EnableNetworkThrottling

Specifies that Veeam Backup for Microsoft Office 365 will limit the inbound traffic to the backup proxy for performance optimization.

Default: False

False

Named

False

False

ThrottlingValue

[Applies only if you have provided the EnableNetworkThrottling parameter]

Specifies a threshold for the inbound traffic to the backup proxy.

Default: 0

False

Named

False

False

ThrottlingUnit

[Applies only if you have provided the EnableNetworkThrottling parameter]

Specifies a measuring unit for the inbound traffic threshold: Mbps, MBs or KBs.

Default: Mbps

False

Named

False

False

InternetProxyMode

Specifies whether a dedicated internet proxy server will be used as a gateway machine.

  • If you set the parameter value to None, an internet proxy will not be used.
  • If you set the parameter value to ManagementServerProxy, an internet proxy will be used with connection settings obtained from the Veeam Backup for Office 365 server.
    NOTE: If you select the Do not use internet proxy option in the Veeam Backup for Microsoft Office 365 console, you will not be able to use an internet proxy. For more information on how to enable internet proxy connection settings in the console, see the Configuring Internet Proxy section of the Veeam Backup for Microsoft Office 365 User Guide.
  • If you set the parameter value to Custom, an internet proxy will be used. To connect to the internet proxy, the added backup proxy will use custom settings defined through the CustomInternetProxyHostName, CustomInternetProxyPort, UseCustomInternetProxyAuthentication and CustomInternetProxyCredential parameters.

False

Named

False

False

CustomInternet
ProxyHostName

[Applies only if you have provided the Custom value for the InternetProxyMode parameter]

Specifies a DNS name or an IP address of the internet proxy server that you want to add.

False

Named

False

False

CustomInternetProxyPort

[Applies only if you have provided the Custom value for the InternetProxyMode parameter]

Specifies a port that will be used to connect to the internet proxy server.

False

Named

False

False

UseCustomInternet
ProxyAuthentication

[Applies only if you have provided the Custom value for the InternetProxyMode parameter]

Indicates that backup proxy will use authentication for connecting to the internet proxy server.

False

Named

False

False

CustomInternet
ProxyCredential

[Applies only if you have provided the Custom value for the InternetProxyMode parameter]

Specifies the credentials you want to use for authentication with the internet proxy server.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to modify a backup proxy with the d96f55a4-d15d-410b-b0f0-d51d17ccdab6 ID. To connect to the backup proxy, the cmdlet will use the account under which you are currently logged in. The inbound traffic to the backup proxy will be limited using the following requirements:

  • The number of threads that the backup proxy will simultaneously run to process backup data must be limited to 16.
  • The threshold for the inbound traffic to the backup proxy will be set to 10 Mbps.

You will need to perform the following steps:

  1. Run the Get-VBOProxy cmdlet. Set d96f55a4-d15d-410b-b0f0-d51d17ccdab6 as the ID parameter value. Save the result to the $proxy variable.
  2. Run the Set-VBOProxy cmdlet. Set the $proxy variable as the Proxy parameter value.

$proxy = Get-VBOProxy -Id "d96f55a4-d15d-410b-b0f0-d51d17ccdab6"

Set-VBOProxy -Proxy $proxy -ThreadsNumber 16 -EnableNetworkThrottling -ThrottlingValue 10 -ThrottlingUnit Mbps

Example 2

This example shows how to change credentials used to connect to the support.east.local backup proxy:

  1. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use to connect to the backup proxy. Save the result to the $credentials variable.
  2. Run the Get-VBOProxy cmdlet. Set support.east.local as the Hostname parameter value. Save the result to the $proxy variable.
  3. Run the Set-VBOProxy cmdlet. Set the $proxy variable as the Proxy parameter value. Set the $credentials variable as the Credential parameter value.

$credentials = Get-Credential

$proxy = Get-VBOProxy -Hostname "support.east.local"

Set-VBOProxy -Proxy $proxy -Credential $credentials

Example 3

This example shows how to add a connection to the internetProxy.local internet proxy for the support.east.local backup proxy. To connect to the internet proxy, the support.east.local backup proxy will use the default port (3128).

  1. Run the Get-VBOProxy cmdlet. Set the support.east.local as the Hostname parameter value. Save the result to the $proxy variable.
  2. Run the Set-VBOProxy cmdlet. Specify the following settings:
  • Set the $proxy variable as the Proxy parameter value.
  • Set Custom as the InternetProxyMode parameter value.
  • Set internetProxy.local as the CustomInternetProxyHostName parameter value.
  • Set 3128 as the CustomInternetProxyPort parameter value.

$proxy = Get-VBOProxy -Hostname "support.east.local"

Set-VBOProxy -Proxy $proxy -InternetProxyMode Custom -CustomInternetProxyHostName internetProxy.local -CustomInternetProxyPort 3128

Related Commands

Get-VBOProxy

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference