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>] [-EnableTeamsGraphAPIBackup <switchparameter>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of a backup proxy that is added to Veeam Backup for Microsoft 365 infrastructure. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
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 a backup proxy server. The default description contains information on the user who added the backup proxy server, date and time when the backup proxy server was added. | 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 do not have direct access to the internet.
| 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. A 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 a 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 the credentials you want to use for authentication with 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 Note: This parameter is available starting from Veeam Backup for Microsoft 365 version 6a (build 6.1.0.222). Once you have enabled usage of Teams Export APIs for team chats backup, you can not change this setting back. | SwitchParameter | 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.
Output Object
The cmdlet returns the VBOProxy object that contains a list of backup proxy servers added to the Veeam Backup for Microsoft 365 backup infrastructure.
Examples
Example 1. Modifying Inbound Traffic Limitations of Backup Proxy
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:
Perform the following steps:
|
Example 2. Modifying Credentials of Backup Proxy
This example shows how to change credentials that Veeam Backup for Microsoft 365 uses to connect to the support.east.local backup proxy.
Perform the following steps:
|
Example 3. Modifying Internet Proxy Server Settings for Backup Proxy
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.
Perform the following steps:
|
Related Commands