Enable-NetAdapterChecksumOffload

Enable-NetAdapterChecksumOffload

Enables checksum offloads on the network adapter.

Syntax

Parameter Set: ByName
Enable-NetAdapterChecksumOffload [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-IpIPv4] [-NoRestart] [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit <Int32> ] [-UdpIPv4] [-UdpIPv6] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByInstanceID
Enable-NetAdapterChecksumOffload -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-IpIPv4] [-NoRestart] [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit <Int32> ] [-UdpIPv4] [-UdpIPv6] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Enable-NetAdapterChecksumOffload -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-IpIPv4] [-NoRestart] [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit <Int32> ] [-UdpIPv4] [-UdpIPv6] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Enable-NetAdapterChecksumOffload cmdlet enables checksum offloads on the network adapter. When specified IPv4, TCPv4, or TCPv6 can be enabled in the transmit, receive, or both directions. By default all checksums are enabled in both directions. Physical network adapters have various checksum offloads in which the checksum calculations occur in the network adapter and not in the main processor. This reduces processor utilization and can increase network throughput. This cmdlet enables the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. Checksum offloading is also required for other stateless offloads to work including receive side scaling (RSS), receive segment coalescing (RSC), and large send offload (LSO).

Parameters

-AsJob

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

-IncludeHidden

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.

-InputObject<CimInstance[]>

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

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

-IpIPv4

Enables checksum offload for IPv4 traffic.

-Name<String[]>

Specifies the name of the network adapter.

-NoRestart

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.

-PassThru

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

-TcpIPv4

Enables checksum offload for TCP IPv4 traffic.

-TcpIPv6

Enables checksum offload for TCP IPv6 traffic.

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

-UdpIPv4

Enables checksum offload for UDP IPv4 traffic.

-UdpIPv6

Enables checksum offload for UDP IPv6 traffic.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

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

  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.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData

  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.

Examples

EXAMPLE 1

This example enables all IPv4 checksum offloads on all visible network adapters and restarts the network adapters.

PS C:\> Enable-NetAdapterChecksumOffload –Name * -TcpIPv4 -UdpIPv4 -IpIPv4

EXAMPLE 2

This example enables all checksum offloads on all visible network adapters and restarts the network adapters.

PS C:\> Enable-NetAdapterChecksumOffload –Name *

Related topics

Disable-NetAdapterChecksumOffload

Get-NetAdapterChecksumOffload

Set-NetAdapterChecksumOffload