Export (0) Print
Expand All

Set-NetOffloadGlobalSetting

Applies To: Windows Server 2012

Set-NetOffloadGlobalSetting

Modifies information about the global TCP/IP offload settings.

Syntax

Parameter Set: InputObject (cdxml)
Set-NetOffloadGlobalSetting [-AsJob] [-Chimney <ChimneyEnum> ] [-CimSession <CimSession[]> ] [-InputObject <CimInstance[]> ] [-NetworkDirect <EnabledDisabledEnum> ] [-NetworkDirectAcrossIPSubnets <AllowedBlockedEnum> ] [-PacketCoalescingFilter <EnabledDisabledEnum> ] [-PassThru] [-ReceiveSegmentCoalescing <EnabledDisabledEnum> ] [-ReceiveSideScaling <EnabledDisabledEnum> ] [-TaskOffload <EnabledDisabledEnum> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-NetOffloadGlobalSetting cmdlet modifies the global TCP/IP offload settings. This includes properties such as receive side scaling (RSS), receive segment coalescing (RSC), task offload and network direct.

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

-Chimney<ChimneyEnum>

Modifies the TCP Chimney global state on the computer. The acceptable values for this parameter are: 
-- Enabled: Chimney offload is enabled.
-- Disabled: Chimney offload is disabled.
-- Automatic: Chimney offload is automatically used.
The default value is Disabled.


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

none

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?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-NetworkDirect<EnabledDisabledEnum>

Modifies the Network Direct (RDMA) global state on the computer. This is a server only setting. The acceptable values for this parameter are: 
-- Enabled: NetworkDirect is globally enabled.
-- Disabled: NetworkDirect is globally disabled.
The default value is Enabled.


Aliases

none

Required?

false

Position?

named

Default Value

disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NetworkDirectAcrossIPSubnets<AllowedBlockedEnum>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PacketCoalescingFilter<EnabledDisabledEnum>

Modifies the Packet Coalescing Filter state on the computer. When the computer is not in a power saving state, the Packet Coalescing filter batches certain delay-tolerant packets (such as ARP, Neighbor Solicitations and SSDP) at the network adapter, reducing the number of CPU interrupts. This is a client only setting. The acceptable values for this parameter are: 
-- Enabled: The packet coalescing filter is enabled.
-- Disabled: The packet coalescing filter is disabled.
The default value is Enabled.


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

-ReceiveSegmentCoalescing<EnabledDisabledEnum>

Modifies the Receive Segment Coalescing (RSC) global state on the computer. An RSC capable network card may parse multiple TCP/IP packets, strip the headers and indicate the TCP payload gathered from the multiple packets in one indication to the TCP/IP stack. This reduces the per-packet processing overhead. The acceptable values for this parameter are: 
-- Enabled: Enables Receive Segment Coalescing.
-- Disabled: Disables Receive Segment Coalescing.
The default value is Enabled.


Aliases

none

Required?

false

Position?

named

Default Value

disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReceiveSideScaling<EnabledDisabledEnum>

Modifies the Receive Side Scaling (RSS) global state on the computer. Receive-Side Scaling (RSS) resolves the single-processor bottleneck by allowing the receive side network load from a network adapter to be shared across multiple processors. The acceptable values for this parameter are: 
-- Enabled: Enables Receive Side Scaling.
-- Disabled: Disables Receive Side Scaling.
The default value is Enabled.


Aliases

none

Required?

false

Position?

named

Default Value

disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskOffload<EnabledDisabledEnum>

Modifies the global TCP/IP offload settings by TaskOffload. Task Offload determines the state of IP checksum offload, IPsec task offload, and Large Send Offload (LSO). These features reduce the per-packet processing overhead by offloading packet processing such as checksum calculation to the network adapter. A modification setting only takes effect when upon computer reboot or network adapter restart. The acceptable values for this parameter are: 
-- Enabled: Enables task offload.
-- Disabled: Disables task offload.
The default value is Enabled.


Aliases

none

Required?

false

Position?

named

Default Value

enabled

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

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

    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

This example sets receive segment coalescing to enabled.


PS C:\> Set-NetOffloadGlobalSetting –ReceiveSegmentCoalescing Enabled

Related topics

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