Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Set-VBOProxy

Short Description

Modifies backup proxy settings.

Syntax

Set-VBOProxy -Proxy <VBOProxy> [-Credential <PSCredential>] [-Description <String>] [-Port <Int32>] [-ThreadsNumber <Int32>] [-EnableNetworkThrottling [<SwitchParameter>]] [-ThrottlingValue <UInt64>] [-ThrottlingUnit <VBOThrottlingUnit>]  [<CommonParameters>]

Detailed Description

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

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOProxy Note:

This cmdlet requires a PSCredential object. Use Get-Credential to create the PSCredentials object.

For more information on Get-Credential, see https://msdn.microsoft.com/en-us/powershell/reference/5.1/microsoft.powershell.security/get-credential.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Proxy

Specifies the backup proxy that you want to modify.

True

Named

True (ByValue)

False

ThreadsNumber

Specifies the number of threads running against Exchange organization.

False

Named

False

False

Enable
Network
Throttling

Indicates that Veeam Backup for Microsoft Office 365 will limit the network bandwidth for performance optimization.

False

Named

False

False

Throttling
Value

Specifies the network bandwidth limit value.

False

Named

False

False

Throttling
Unit

Specifies a measuring unit for the network bandwidth limit:

  • Mbps
  • MBs
  • KBs

False

Named

False

False

Description

Specifies the description of a backup proxy.

False

Named

False

False

Port

Specifies the port for connecting with the proxy server.

False

Named

False

False

Credential

Specifies Windows user credentials to connect to the proxy server.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to modify performance settings of a backup proxy:

  • Set the number of threads to 16,
  • Set the network bandwidth limit to 10 Mbps.

You will need to perform the following steps:

  1. Run Get-VBOProxy to get the backup proxy whose settings you want to change. Save the result to the $proxy variable.
  2. Run Set-VBOProxy with the $proxy variable.

PS C:\PS> $job = Get-VBOJob -Name "Critical Backup"

PS C:\PS> Set-VBOProxy -Proxy $proxy -ThreadsNumber 16 -EnableNetworkThrottling -ThrottlingValue 10 -ThrottlingUnit Mbps

Example 2

This example shows how to change Windows user credentials for connecting to the proxy server:

You will need to perform the following steps:

  1. Run Get-VBOProxy to get the backup proxy whose settings you want to change. Save the result to the $proxy variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for connecting to the proxy server. Save the result to the $credential variable.
  3. Run Set-VBOProxy with the $proxy and $credential variables.

PS C:\PS> $proxy = Get-VBOProxy -Hostname "support.east.local"

PS C:\PS> Set-VBOProxy -Proxy $proxy -Credential $credential

Related Commands

Get-VBOProxy

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference