Add-VBOProxy
Short Description
Adds a backup proxy server to the Veeam Backup for Microsoft 365 infrastructure.
Syntax
This cmdlet provides parameter sets that allow you to:
- Add Windows-based backup proxy server.
Add-VBOProxy -Hostname <String> [-Credential <PSCredential>] [-WindowsCredential <PSCredential>] [-Port <Int32>] [-Description <String>] [-Force] [-ThreadsNumber <Int32>] [-EnableNetworkThrottling] [-ThrottlingValue <UInt32>] [-ThrottlingUnit <VBOThrottlingUnit>] [-InternetProxyMode <VBOInternetProxyMode>] [-CustomInternetProxyHostName <String>] [-CustomInternetProxyPort <UInt16>] [-UseCustomInternetProxyAuthentication] [-CustomInternetProxyCredential <PSCredential>] [-UseDomainNetwork] [-ServiceCredential <PSCredential>] [-CreateServiceAccount] [<CommonParameters>] |
- Add Linux-based backup proxy server.
Add-VBOProxy -Hostname <String> [-Port <Int32>] [-Description <String>] [-Force] [-ThreadsNumber <Int32>] [-EnableNetworkThrottling] [-ThrottlingValue <UInt32>] [-ThrottlingUnit <VBOThrottlingUnit>] [-InternetProxyMode <VBOInternetProxyMode>] [-CustomInternetProxyHostName <String>] [-CustomInternetProxyPort <UInt16>] [-UseCustomInternetProxyAuthentication] [-CustomInternetProxyCredential <PSCredential>] [-LinuxCredential <VBOLinuxCredential>] [-ServiceCredential <PSCredential>] [-CreateServiceAccount] [<CommonParameters>] |
Detailed Description
This cmdlet adds a backup proxy server to the Veeam Backup for Microsoft 365 backup infrastructure.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Hostname | Specifies a DNS name or an IP address of a backup proxy server that you want to add. | String | True | Named | False |
Credential | Specifies Windows credentials. The cmdlet will use these credentials to connect to the Windows-based backup proxy server. If you omit this parameter, the cmdlet will use the Windows credentials under which you are currently logged in. Note: This parameter will be deprecated in future versions of Veeam Backup for Microsoft 365. Use the WindowsCredential parameter instead. | PSCredential | False | Named | False |
WindowsCredential | Specifies Windows credentials. The cmdlet will use these credentials to connect to the Windows-based backup proxy server. If you omit this parameter, the cmdlet will use the Windows credentials under which you are currently logged in. | PSCredential | False | Named | 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 |
Description | Specifies a description of the 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 |
Force | Defines that the cmdlet will add a backup proxy server without showing warnings in the PowerShell console. If you do not provide the parameter, the cmdlet will prompt you to confirm the operation. Default: False | SwitchParameter | False | Named | False |
ThreadsNumber | Note: This parameter will be deprecated in future versions of Veeam Backup for Microsoft 365. Specifies a number of threads that the backup proxy server will simultaneously run to process backup data. Default: 64 | Int32 | False | Named | 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 |
ThrottlingValue | For the EnableNetworkThrottling parameter. Specifies a threshold for the inbound traffic to the backup proxy server. Default: 0 | UInt32 | False | Named | 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 |
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.
| VBOInternetProxyMode | False | Named | 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 |
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 |
UseCustomInternetProxyAuthentication | For the InternetProxyMode parameter with the Custom option. Defines that a backup proxy will use authentication for connecting to the internet proxy server. Default: False | SwitchParameter | False | Named | 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 |
UseDomainNetwork | Defines that the cmdlet will add a domain backup proxy, that is, a backup proxy server that resides in the same domain as the Veeam Backup for Microsoft 365 server or in a trusted domain. If you omit this parameter, the cmdlet will add a workgroup backup proxy, that is, a backup proxy server that resides in a workgroup. Default: False For more information about backup proxy server types, see the Backup Proxy Servers section of the Veeam Backup for Microsoft 365 User Guide. | SwitchParameter | False | Named | False |
ServiceCredential | Specifies credentials of a service account. The cmdlet will use these credentials to run Veeam Backup for Microsoft 365 Proxy Service. | PSCredential | False | Named | False |
CreateServiceAccount | Defines that the cmdlet will create a service account and automatically grant the required permissions to this account. Default: False | SwitchParameter | False | Named | False |
LinuxCredential | Specifies Linux credentials. The cmdlet will use these credentials to connect to the Linux-based backup proxy server. | Accepts the VBOLinuxCredential object. To get this object, run the New-VBOLinuxCredential cmdlet. | False | Named | 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 settings of a backup proxy server added to the Veeam Backup for Microsoft 365 backup infrastructure.
Examples
Example 1. Adding Backup Proxy Server Using Current Windows Account Credentials
This command adds a Windows-based backup proxy server with 172.70.53.53 IP address to the Veeam Backup for Microsoft 365 server. Veeam Backup for Microsoft 365 will use the account under which you are currently logged in to Windows server to connect to the backup proxy server. The backup proxy server and Veeam Backup for Microsoft 365 server reside in the same domain or in trusted domains.
|
Example 2. Adding Backup Proxy Server Using Specific Credentials
This example shows how to add a Windows-based backup proxy server with 172.70.53.53 IP address to the Veeam Backup for Microsoft 365 server with the following settings:
Perform the following steps:
|
Example 3. Adding Backup Proxy Server with Internet Proxy Server Settings
This command adds a Windows-based backup proxy server with the 172.70.53.53 IP address to the Veeam Backup for Microsoft 365 server with the following settings:
|
Example 4. Adding Backup Proxy Server with Inbound Traffic Limitations
This command adds a Windows-based backup proxy server with the 172.70.53.53 IP address to the Veeam Backup for Microsoft 365 server. To connect to the backup proxy server, the cmdlet will use the account under which you are currently logged in. The threshold for the inbound traffic to the backup proxy will be set to 10 Mbps.
|
Example 5. Adding Linux-Based Backup Proxy Server
This example shows how to add a Linux-based backup proxy server to the Veeam Backup for Microsoft 365 server with the following settings:
Perform the following steps:
|
Related Commands