Set-VBOProxy - Veeam Backup for Microsoft 365 PowerShell Reference

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>] [-EnableTeamsGraphAPIBackup <SwitchParameter>] [<CommonParameters>]

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Proxy	Specifies the backup proxy that you want to modify.	Accepts the VBOProxy object. To get this object, run the Get-VBOProxy cmdlet.	True	Named	True (ByValue)	False
Credential	Specifies Windows credentials. The cmdlet will use these credentials to connect to the backup proxy server. If omit this parameter, to connect to the backup proxy server, the cmdlet will use the Windows credentials under which you are currently logged in.	PSCredential	False	Named	False	False
Port	Specifies a port number. The cmdlet will use this port number to connect to the backup proxy server. Default: 9193	Int32	False	Named	False	False
Description	Specifies a description of the backup proxy server. The cmdlet will replace the current description with the specified description.	String	False	Named	False	False
ThreadsNumber	Specifies a number of threads that the backup proxy server will simultaneously run to process backup data. Default: 64	Int32	False	Named	False	False
EnableNetworkThrottling	Defines that Veeam Backup for Microsoft 365 will limit the inbound traffic to the backup proxy server for performance optimization. Default: False	SwitchParameter	False	Named	False	False
ThrottlingValue	For the EnableNetworkThrottling parameter. Specifies a threshold for the inbound traffic to the backup proxy. Default: 0	UInt32	False	Named	False	False
ThrottlingUnit	For the EnableNetworkThrottling parameter. Specifies a measuring unit for the inbound traffic threshold: Mbps, MBs or KBs. Default: Mbps	VBOThrottlingUnit	False	Named	False	False
InternetProxyMode	Specifies settings of an internet proxy server. Veeam Backup for Microsoft 365 will assign this internet proxy server to a backup proxy that does not have direct access to the internet. Custom: Use this option to specify connection settings for an internet proxy server explicitly. Use the following parameters to specify these settings: CustomInternetProxyHostName CustomInternetProxyPort UseCustomInternetProxyAuthentication CustomInternetProxyCredential ManagementServerProxy: Use this option if you want an internet proxy server to use the connection settings that are specified in the global internet proxy server settings. None: Use this option if you do not want to assign an internet proxy server to a backup proxy.	VBOInternetProxyMode	False	Named	False	False
CustomInternetProxyHostName	For the InternetProxyMode parameter with the Custom option. Specifies a DNS name or an IP address of the internet proxy server that you want to add.	String	False	Named	False	False
CustomInternetProxyPort	For the InternetProxyMode parameter with the Custom option. Specifies a port number. The backup proxy will use this port to connect to the internet proxy server. Default: 3128	UInt16	False	Named	False	False
UseCustomInternetProxyAuthentication	For the InternetProxyMode parameter with the Custom option. Defines that the backup proxy will use authentication for connecting to the internet proxy server.	SwitchParameter	False	Named	False	False
CustomInternetProxyCredential	For the InternetProxyMode parameter with the Custom option. Specifies credentials that you want to use for authentication to the internet proxy server.	PSCredential	False	Named	False	False
EnableTeamsGraphAPIBackup	Defines that Veeam Backup for Microsoft 365 will use Teams Export APIs for team chats backup. For more information, see this Veeam KB article. Default: False Once you have enabled usage of Teams Export APIs for team chats backup, you cannot change this setting back.	SwitchParameter	False	Named	False	False

This example shows how to modify a backup proxy with the ID d96f55a4-d15d-410b-b0f0-d51d17ccdab6. Veeam Backup for Microsoft 365 will use the credentials that you provide to connect to the backup proxy server. 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.

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

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

Perform the following steps:

Run the Get-VBOProxy cmdlet. Specify the Id parameter value. Save the result to the $proxy variable.
Run the Set-VBOProxy cmdlet. Specify the following settings:

Set the $proxy variable as the Proxy parameter value.
Specify the ThreadsNumber parameter value.
Provide the EnableNetworkThrottling parameter.
Specify the ThrottlingValue parameter value.
Specify the ThrottlingUnit parameter value.

This example shows how to change credentials that Veeam Backup for Microsoft 365 uses to connect to the support.east.local backup proxy.

$serverCredentials = Get-Credential

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

Set-VBOProxy -Proxy $proxy -Credential $serverCredentials

Perform the following steps:

Run the Get-Credential cmdlet. Enter the credentials you want to use to connect to the backup proxy. Save the result to the $serverCredentials variable.
Run the Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $proxy variable.
Run the Set-VBOProxy cmdlet. Set the $proxy variable as the Proxy parameter value. Set the $serverCredentials variable as the Credential parameter value.

This example shows how modify settings that the support.east.local proxy server uses to connect to the internetProxy.local internet proxy server. The support.east.local backup proxy will use the default port to connect to the internet proxy server.

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

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

Perform the following steps:

Run the Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $proxy variable.
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.
Specify the CustomInternetProxyHostName parameter value.
Specify the CustomInternetProxyPort parameter value.