Add-VBOProxy

In this article

    Short Description

    Adds backup proxy servers to the Veeam Backup for Microsoft Office 365 infrastructure.

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

    Detailed Description

    This cmdlet adds a backup proxy to the Veeam Backup for Microsoft Office 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 backup proxy server.

    If you 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

    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 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

    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.

    SwitchParameter

    False

    Named

    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

    EnableNetworkThrottling

    Defines that Veeam Backup for Microsoft Office 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.

    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 Office 365 will assign this internet proxy server to a backup proxy that do 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

    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

    UseCustomInternetProxy
    Authentication

    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

    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

    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 Office 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.

    For more information about backup proxy server types, see the Backup Proxy Servers section of the Veeam Backup for Microsoft Office 365 User Guide.

    SwitchParameter

    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 about added to the Veeam Backup for Microsoft Office 365 backup infrastructure.

    Examples

    Add-VBOProxyExample 1. Adding Backup Proxy Using Current Windows Account Credentials

    This command adds a backup proxy with 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server. Veeam Backup for Microsoft Office 365 will use the account under which you are currently logged in to Windows server to connect to the backup proxy. The backup proxy server and Veeam Backup for Microsoft Office 365 server reside in the same domain or in trusted domains.

    Add-VBOProxy -Hostname 172.70.53.53 -Port 9193 -UseDomainNetwork

    Add-VBOProxyExample 2. Adding Backup Proxy Using Specific Credentials

    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 with the following settings:

    • Veeam Backup for Microsoft Office 365 will use the credentials that you provide to connect to the backup proxy server.
    • Veeam Backup for Microsoft Office 365 will use the 9193 port number to connect to the backup proxy server.
    • The backup proxy server will reside in a workgroup.

    $serverCredentials = Get-Credential

    Add-VBOProxy -Hostname 172.70.53.53 -Credential $serverCredentials -Port 9193

    Perform the following steps:

    1. 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.
    2. Run the Add-VBOProxy cmdlet. Set the $serverCredentials variable as the Credential parameter value. Specify the Port parameter value.

    Add-VBOProxyExample 3. Adding Backup Proxy with Internet Proxy Server Settings

    This command adds a backup proxy with the 172.70.53.53 IP address to the Veeam Backup for Microsoft Office 365 server with the following settings:

    • Veeam Backup for Microsoft Office 365 will use the account under which you are currently logged in to Windows server to connect to the backup proxy.
    • The backup proxy will use the internetProxy.local internet proxy server to access the internet.
    • The backup proxy will use the 3128 port to connect to the CustomInternetProxyPort internet proxy server.

    Add-VBOProxy -Hostname 172.70.53.53 -InternetProxyMode Custom -CustomInternetProxyHostName internetProxy.local -CustomInternetProxyPort 3128

    Add-VBOProxyExample 4. Adding Backup Proxy with Inbound Traffic Limitations

    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

    Related Commands

    Get-Credential