Edit

Share via


Set-NetOffloadGlobalSetting

Modifies the global TCP/IP offload settings.

Syntax

Default (Default)

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

Description

The Set-NetOffloadGlobalSetting cmdlet modifies the global TCP/IP offload settings. The global settings include Receive Side Scaling, Receive Segment Coalescing, task offload, and NetworkDirect properties.

Examples

Example 1: Enable Receive Segment Coalescing

PS C:\>Set-NetOffloadGlobalSetting -ReceiveSegmentCoalescing Enabled

This command enables Receive Segment Coalescing on the computer.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Chimney

Specifies the TCP Chimney global state on the computer. The acceptable values for this parameter are:

  • Enabled

  • Disabled

  • Automatic

The default value is Disabled.

Parameter properties

Type:ChimneyEnum
Default value:None
Accepted values:Disabled, Enabled, Automatic
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the input object that is used in a pipeline command.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-NetworkDirect

Specifies the NetworkDirect Remote Direct Memory Access (RDMA) value on the computer. Use this parameter only on servers. The acceptable values for this parameter are:

  • Enabled

  • Disabled

The default value is Enabled.

Parameter properties

Type:EnabledDisabledEnum
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NetworkDirectAcrossIPSubnets

Specifies a value for NetworkDirect connectivity from outside a local IP network. The acceptable values for this parameter are:

  • Allowed
  • Blocked

Parameter properties

Type:AllowedBlockedEnum
Default value:None
Accepted values:Blocked, Allowed
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PacketCoalescingFilter

Specifies the values for the packet-coalescing filter on the computer. To reduce the number of interrupts that a computer processes, the packet-coalescing filter combines random broadcast and multicast packets, such as Address Resolution Protocol (ARP) requests, Neighbor Discovery messages, and Simple Service Discovery Protocol (SSDP) requests, into a single packet. Use this parameter only on client computers. The acceptable values for this parameter are:

  • Enabled

  • Disabled

The default value is Enabled.

Parameter properties

Type:EnabledDisabledEnum
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReceiveSegmentCoalescing

Specifies the Receive Segment Coalescing settings on the computer. Receive Segment Coalescing parses small packets of data and combines the data into a single packet. Coalescing small packets into a single packet reduces the overhead that is required to process packets. The acceptable values for this parameter are:

  • Enabled

  • Disabled

The default value is Enabled.

Parameter properties

Type:EnabledDisabledEnum
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReceiveSideScaling

Specifies the Receive Side Scaling settings on the computer. Receive Side Scaling distributes the network processing load across multiple processor cores. The acceptable values for this parameter are:

  • Enabled

  • Disabled

The default value is Enabled.

Parameter properties

Type:EnabledDisabledEnum
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskOffload

Specifies the global TCP/IP task offload settings. Task offload settings include IP checksum offload, Internet Protocol security (IPsec) task offload, and Large Send Offload. These features reduce the overhead of per-packet processing by distributing packet processing tasks, such as checksum calculation, to a network adapter. A modification takes effect after a computer restarts or a network adapter restarts. The acceptable values for this parameter are:

  • Enabled

  • Disabled

The default value is Enabled.

Parameter properties

Type:EnabledDisabledEnum
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CimInstance

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

None