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 transmission, 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

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

Indicates that the cmdlet includes both visible and hidden network adapters in the operation. 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 an array of network adapter interface descriptions. 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

-IpIPv4

Indicates that this cmdlet enables checksum offload for IPv4 traffic.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of network adapter names.


Aliases

ifAlias, InterfaceAlias

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-NoRestart

Indicates that the cmdlet does not restart the network adapter after completing the operation. 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

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

-TcpIPv4

Indicates that the cmdlet enables checksum offload for TCP IPv4 traffic.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TcpIPv6

Indicates that the cmdlet enables checksum offload for TCP IPv6 traffic.


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

-UdpIPv4

Indicates that the cmdlet enables checksum offload for UDP IPv4 traffic.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UdpIPv6

Indicates that the cmdlet enables checksum offload for UDP IPv6 traffic.


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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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_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: Enable IPv4 checksum offloads on all network adapters

This command 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: Enable all checksum offloads on all network adapters

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


PS C:\> Enable-NetAdapterChecksumOffload –Name "*"

Related topics

Community Additions

ADD
Show: