Add-VBOProxy
Short Description
Adds backup proxies to Veeam Backup for Microsoft Office 365.
Syntax
Add-VBOProxy -Hostname <String> [-Credential <PSCredential>] [-Port <Int32>] [-Description <String>] [-Force [<SwitchParameter>]] [-ThreadsNumber <Int32>] [-EnableNetworkThrottling [<SwitchParameter>]] [-ThrottlingValue <UInt32>] [-ThrottlingUnit <VBOThrottlingUnit>] [-InternetProxyMode <VBOInternetProxyMode>] [-CustomInternetProxyHostName <String>] [-CustomInternetProxyPort <UInt16>] [-UseCustomInternetProxyAuthentication [<SwitchParameter>]] [-CustomInternetProxyCredential <PSCredential>] [<CommonParameters>] |
Detailed Description
This cmdlet adds a backup proxy to Veeam Backup for Microsoft Office 365 infrastructure.
|
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 | Accept |
Hostname | Specifies a DNS name or an IP address of a backup proxy that you want to add. | True | Named | False | 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 |
Port | Specifies a port that will be used to connect to the backup proxy. Default: 9193 | 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 |
Force | Specifies that the confirmation dialog will be suppressed. If you do not provide the parameter, the cmdlet will prompt you to confirm the operation. | False | Named | False | False |
ThreadsNumber | Specifies a number of threads that the backup proxy will simultaneously run to process backup data. Default: 64 | False | Named | False | False |
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 |
Specifies whether a dedicated internet proxy server will be used as a gateway machine.
| False | Named | False | False | |
[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 | |
[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. Default: 3128. | False | Named | False | False | |
[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 | |
[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 command adds a backup proxy with 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server. To connect to the backup proxy, the cmdlet will use the account under which you are currently logged in.
Add-VBOProxy -Hostname 172.70.53.53 -Port 9193 |
Example 2
This example shows how to add a backup proxy with 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server. To connect to the backup proxy, the cmdlet will use credentials that you provide.
- Run the Get-Credential cmdlet to create a credential object. Enter the credentials you want to use to connect to the backup proxy. Save the result to the $serverCredentials variable.
- Run the Add-VBOProxy cmdlet. Set the $serverCredentials variable as the Credential parameter value. Set 9193 as the Port parameter value.
$serverCredentials = Get-Credential Add-VBOProxy -Hostname 172.70.53.53 -Credential $serverCredentials -Port 9193 |
Example 3
This command adds a backup proxy with the 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server. To connect to the backup proxy, the cmdlet will use credentials of the account under which you are currently logged in.
A dedicated internet proxy will be used as a gateway machine. To connect to the internet proxy, the added backup proxy will use custom settings defined through the CustomInternetProxyHostName, CustomInternetProxyPort parameters.
Add-VBOProxy -Hostname 172.70.53.53 -InternetProxyMode Custom -CustomInternetProxyHostName internetProxy.local -CustomInternetProxyPort 3128 |
Example 4
This command adds a backup proxy with the 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server. 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 parameters:
- The number of threads that the backup proxy simultaneously run to process backup data will be limited to 16.
- The threshold for the inbound traffic to the backup proxy will be set to 10 Mbps.
Add-VBOProxy -Hostname 172.70.53.53 -ThreadsNumber 16 -EnableNetworkThrottling -ThrottlingValue 10 -ThrottlingUnit Mbps |