Set-VBRUploadStreamsConfiguration

Short Description

Modifies data transfer settings for job sessions.

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRUploadStreamsConfiguration -Configuration <VBRUploadStreamsConfiguration> [-Enable]

[-StreamCount <Int32>] [-PassThru] [<CommonParameters>]

Detailed Description

This cmdlet modifies existing data transfer settings for job sessions.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Configuration

Specifies data transfer settings for job sessions. The cmdlet will modify these settings.

Accepts the VBRUploadStreamsConfiguration object. To get this object, run the Get-VBRUploadStreamsConfigurationReturns details on data transfer settings for job sessions. cmdlet.

VBRUploadStreamsConfiguration

True

Named

True (ByValue)

Enable

Enables the multithreaded data transfer option if it is disabled.

SwitchParameter

False

Named

False

PassThru

Defines that the command returns the output object to the Windows PowerShell console.

SwitchParameter

False

Named

False

StreamCount

Specifies a number of TCP/IP connections per job session.

Int32

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRUploadStreamsConfiguration

Examples

Modifying Data Transfer Settings to Change Number of TCP/IP Connections

This example shows how to modify data transfer settings and change a number of TCP/IP connections per job session. The cmdlet will return details about the modified data transfer settings.

$transfersettings = Get-VBRUploadStreamsConfiguration

Set-VBRUploadStreamsConfiguration -Configuration $transfersettings -StreamCount 7 -PassThru

Enabled StreamCount

------- -----------

True 7

Perform the following steps:

  1. Run the Get-VBRUploadStreamsConfigurationReturns details on data transfer settings for job sessions. cmdlet. Save the result to the $transfersettings variable.
  2. Run the Set-VBRUploadStreamsConfiguration cmdlet. Set the $transfersettings variable as the Configuration parameter value. Specify the StreamCount parameter value. Provide the PassThru parameter.

Get-VBRUploadStreamsConfigurationReturns details on data transfer settings for job sessions.

Page updated 2026-08-19

Page content applies to build 13.1.1.18