Edit

Get-NetAdapterChecksumOffload

  • Reference
Module:
NetAdapter

Gets the various checksum offload settings from network adapters that support these checksum offloads.

Syntax

Get-NetAdapterChecksumOffload
   [[-Name] <String[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   [-ThrottleLimit <Int32>]
Get-NetAdapterChecksumOffload
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   [-ThrottleLimit <Int32>]
   -InterfaceDescription <String[]>

Description

The Get-NetAdapterChecksumOffload cmdlet gets the various checksum offload settings. 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 gets the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6.

Examples

EXAMPLE 1

PS C:\>Get-NetAdapterChecksumOffload -Name MyAdapter

This example gets the state of checksum offload properties of the network adapter named MyAdapter.

EXAMPLE 2

PS C:\>$networkAdapterCO1 = Get-NetAdapterChecksumOffload -Name MyAdapter



PS C:\>$networkAdapterCO1.ChecksumOffloadHardwareCapabilities

This example displays the checksum offload hardware capabilities of the network adapter named MyAdapter.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceDescription

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

Type:String[]
Aliases:ifDesc
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

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.