Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetAdapterChecksumOffload

Set-NetAdapterChecksumOffload

msft_netadapterchecksumoffload.cdxml

Synopsis

Sets the various checksum offload settings.

Syntax

Set-NetAdapterChecksumOffload [-Name] [-AsJob] [-CimSession] [-IncludeHidden] [-IpIPv4Enabled] [-NoRestart] [-PassThru] [-TcpIPv4Enabled] [-TcpIPv6Enabled] [-ThrottleLimit] [-UdpIPv4Enabled] [-UdpIPv6Enabled] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterChecksumOffload [-AsJob] [-CimSession] [-IncludeHidden] [-IpIPv4Enabled] [-NoRestart] [-PassThru] [-TcpIPv4Enabled] [-TcpIPv6Enabled] [-ThrottleLimit] [-UdpIPv4Enabled] [-UdpIPv6Enabled] [-InterfaceDescription] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterChecksumOffload [-AsJob] [-CimSession] [-IpIPv4Enabled] [-NoRestart] [-PassThru] [-TcpIPv4Enabled] [-TcpIPv6Enabled] [-ThrottleLimit] [-UdpIPv4Enabled] [-UdpIPv6Enabled] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetAdapterChecksumOffload cmdlet sets the state of the checksum offload properties. The network adapter computes the checksums, therefore reducing processor utilization because the processor is not performing this computation. This cmdlet sets the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. This cmdlet enables a few types of checksums while disabling others. If only setting the enabled state, run the Enable-NetAdapterChecksumOffload or Disable-NetAdapterChecksumOffload cmdlet.

Parameters

-AsJob <SwitchParameter>

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

-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

-IncludeHidden <SwitchParameter>

Specifies both visible and hidden network adapters should be included. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.

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?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-InterfaceDescription <String[]>

Specifies the network adapter interface description. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.

Aliases

ifDesc

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-IpIPv4Enabled <Direction>

Specifies the direction of the IP traffic for IPv4. The acceptable values for this parameter are:  Disabled, RxTxEnabled, RxEnabled, or TxEnabled. If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of the network adapter.

Aliases

ifAlias, InterfaceAlias

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-NoRestart <SwitchParameter>

Specifies that the network adapter is not restarted as part of running this cmdlet. Note: Many advanced properties require restarting the network adapter before the new settings take effect.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-TcpIPv4Enabled <Direction>

Specifies the direction of the TCP traffic for IPv4. The acceptable values for this parameter are:  Disabled, RxTxEnabled, RxEnabled, or TxEnabled. If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TcpIPv6Enabled <Direction>

Specifies the direction of the TCP traffic for IPv6. The acceptable values for this parameter are:  Disabled, RxTxEnabled, RxEnabled, or TxEnabled. If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled.

Aliases

None

Required?

false

Position

named

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

-UdpIPv4Enabled <Direction>

Specifies the direction of the UDP traffic for IPv4. The acceptable values for this parameter are:  Disabled, RxTxEnabled, RxEnabled, or TxEnabled. If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-UdpIPv6Enabled <Direction>

Specifies the direction of the UDP traffic for IPv6. The acceptable values for this parameter are:  Disabled, RxTxEnabled, RxEnabled, or TxEnabled. If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[]

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[]

Notes

None

Examples

EXAMPLE 1

This example enables the IPv4 checksum offload in both receive and transmit directions on all visible network adapters.

PS C:\>Set-NetAdapterChecksumOffload –Name * -IpIPv4Enabled RxTxEnabled

EXAMPLE 2

This example enables the IPv4 checksum, the UDPv4 and IPv4 checksum, and the TCPv4 and IPv4 checksum in both receive and transmit directions on the network adapter named MyAdapter.

PS C:\>Set-NetAdapterChecksumOffload –Name MyAdapter -IpIPv4Enabled RxTxEnabled -TcpIpv4Enabled RxTxEnabled -UdpIpv4Enabled RxTxEnabled

Online Version
Disable-NetAdapterChecksumOffload
Enable-NetAdapterChecksumOffload
Get-NetAdapterChecksumOffload