Set-VBOProxy

In this article

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

    Detailed Description

    This cmdlet modifies settings of a backup proxy that is added to Veeam Backup for Microsoft Office 365 infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    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)

    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

    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

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

    <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 Office 365 backup infrastructure.

    Examples

    Set-VBOProxyExample 1. Modifying Inbound Traffic Limitations of Backup Proxy

    This example shows how to modify a backup proxy with the d96f55a4-d15d-410b-b0f0-d51d17ccdab6 ID. Veeam Backup for Microsoft Office 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:

    1. Run the Get-VBOProxy cmdlet. Specify the Id parameter value. Save the result to the $proxy variable.
    2. Run the Set-VBOProxy cmdlet. Specify the following settings:
    • Set the $proxy variable as the Proxy parameter value.
    • Specify the ThreadsNumber parameter value.
    • Specify the EnableNetworkThrottling parameter value.
    • Specify the ThrottlingValue parameter value.
    • Specify the ThrottlingUnit parameter value.

    Set-VBOProxyExample 2. Modifying Credentials of Backup Proxy

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

    $credentials = Get-Credential

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

    Set-VBOProxy -Proxy $proxy -Credential $credentials

    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 Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $proxy variable.
    3. Run the Set-VBOProxy cmdlet. Set the $proxy variable as the Proxy parameter value. Set the $credentials variable as the Credential parameter value.

    Set-VBOProxyExample 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.

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

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

    Perform the following steps:

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

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.