Export (0) Print
Expand All

Set-NetTCPSetting

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-NetTCPSetting

Modifies a TCP setting.

Syntax

Parameter Set: ByName
Set-NetTCPSetting [[-SettingName] <String[]> ] [-AsJob] [-AutomaticUseCustom <AutomaticUseCustom> ] [-AutoTuningLevelLocal <AutoTuningLevelLocal> ] [-CimSession <CimSession[]> ] [-CongestionProvider <CongestionProvider> ] [-CwndRestart <CwndRestart> ] [-DelayedAckFrequency <Byte> ] [-DelayedAckTimeoutMs <UInt32> ] [-DynamicPortRangeNumberOfPorts <UInt16> ] [-DynamicPortRangeStartPort <UInt16> ] [-EcnCapability <EcnCapability> ] [-ForceWS <ForceWS> ] [-InitialCongestionWindowMss <UInt32> ] [-InitialRtoMs <UInt32> ] [-MaxSynRetransmissions <Byte> ] [-MemoryPressureProtection <MemoryPressureProtection> ] [-MinRtoMs <UInt32> ] [-NonSackRttResiliency <NonSackRttResiliency> ] [-PassThru] [-ScalingHeuristics <ScalingHeuristics> ] [-ThrottleLimit <Int32> ] [-Timestamps <Timestamps> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetTCPSetting -InputObject <CimInstance[]> [-AsJob] [-AutomaticUseCustom <AutomaticUseCustom> ] [-AutoTuningLevelLocal <AutoTuningLevelLocal> ] [-CimSession <CimSession[]> ] [-CongestionProvider <CongestionProvider> ] [-CwndRestart <CwndRestart> ] [-DelayedAckFrequency <Byte> ] [-DelayedAckTimeoutMs <UInt32> ] [-DynamicPortRangeNumberOfPorts <UInt16> ] [-DynamicPortRangeStartPort <UInt16> ] [-EcnCapability <EcnCapability> ] [-ForceWS <ForceWS> ] [-InitialCongestionWindowMss <UInt32> ] [-InitialRtoMs <UInt32> ] [-MaxSynRetransmissions <Byte> ] [-MemoryPressureProtection <MemoryPressureProtection> ] [-MinRtoMs <UInt32> ] [-NonSackRttResiliency <NonSackRttResiliency> ] [-PassThru] [-ScalingHeuristics <ScalingHeuristics> ] [-ThrottleLimit <Int32> ] [-Timestamps <Timestamps> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-NetTCPSetting cmdlet modifies a TCP setting. TCP settings are optimized for different network conditions including latency and congestion. To apply a TCP setting to a port number or destination IP address range, create a transport filter by using the New-NetTransportFilter cmdlet.

You can only modify the Custom TCP setting.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticUseCustom<AutomaticUseCustom>

Specifies whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The acceptable values for this parameter are: 

-- True
-- False


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutoTuningLevelLocal<AutoTuningLevelLocal>

Specifies a TCP auto-tuning level for the host computer. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are: 

-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CongestionProvider<CongestionProvider>

Specifies the congestion provider property that TCP uses. The acceptable values for this parameter are: 

-- CTCP. Compound TCP increases the receive window and amount of data sent. CTCP can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. DCTCP may improve throughput on low latency links.
-- Default. Servers use DCTCP by default. Client computers use NewReno. For information about NewReno, see RFC 3782 (http://www.ietf.org/rfc/rfc3782.txt).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CwndRestart<CwndRestart>

Specifies whether to enable congestion window restart. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see RFC 2581 (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are: 

-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DelayedAckFrequency<Byte>

Specifies the number of acknowledgments (ACKs) received before the computer sends a response.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DelayedAckTimeoutMs<UInt32>

Specifies the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are:  increments of 10, from 10 through 600.


Aliases

DelayedAckTimeout

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DynamicPortRangeNumberOfPorts<UInt16>

Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DynamicPortRangeStartPort<UInt16>

Specifies the starting port for the dynamic port range. This parameter sets the starting port to send and receive TCP traffic. The acceptable values for this parameter are:  1 through 65535.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EcnCapability<EcnCapability>

Specifies whether to enable ECN capability. The acceptable values for this parameter are: 

-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability.

If you specify a value of Disabled, UseECT0, or UseEct1 for the EcnMarking parameter of the Set-NetIPInterface cmdlet, the current parameter has no effect.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ForceWS<ForceWS>

Specifies whether to force window scaling for retransmission. The acceptable values for this parameter are: 

-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission.

The default value is Disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InitialCongestionWindowMss<UInt32>

Specifies the initial size of the congestion window. Provide a value to multiply by the maximum segment size (MSS). The acceptable values for this parameter are:  even numbers from 2 through 64.


Aliases

InitialCongestionWindow

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InitialRtoMs<UInt32>

Specifies the period, in milliseconds, before connect, or SYN, retransmit. The acceptable values for this parameter are:  increments of 10, from 300 ms through 3000 ms.


Aliases

InitialRto

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-MaxSynRetransmissions<Byte>

Specifies the maximum number of times the computer sends SYN packets without receiving a response.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MemoryPressureProtection<MemoryPressureProtection>

Specifies whether to use memory pressure protection. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are: 

-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MinRtoMs<UInt32>

Specifies a value, in milliseconds, for the TCP retransmission to time out. The acceptable values for this parameter are:  increments of 10, from 20 ms through 300 ms.


Aliases

MinRto

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NonSackRttResiliency<NonSackRttResiliency>

Specifies whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The acceptable values for this parameter are: 

-- Enabled
-- Disabled


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ScalingHeuristics<ScalingHeuristics>

Specifies whether to enable scaling heuristics. The acceptable values for this parameter are: 

-- Enabled
-- Disabled


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SettingName<String[]>

Specifies an array of setting names. You can specify only Custom for this parameter.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Timestamps<Timestamps>

Specifies whether to enable timestamps. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see RFC 1323 (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are: 

-- Enabled
-- Disabled


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTCPSetting

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

Example 1: Change the custom TCP setting

This command changes the custom TCP setting to have a value of 6 for the initial congestion window and use compound TCP.


PS C:\> Set-NetTCPSetting –SettingName Custom –CongestionProvider CTCP –InitialCongestionWindowMss 6 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft