Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NetAdapterChecksumOffload

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

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

SYNTAX

ByName (Default)

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

ByInstanceID

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

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: Get the checksum offload properties of the specified network adapter

PS C:\> Get-NetAdapterChecksumOffload -Name "MyAdapter"

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

Example 2: Get the checksum offload properties of the specified network adapter and display them

PS C:\> $NetworkAdapterC01 = Get-NetAdapterChecksumOffload -Name "MyAdapter"
PS C:\> $NetworkAdapterC01.ChecksumOffloadHardwareCapabilities

The first command gets the state of checksum offload properties from the network adapter named MyAdapter and stores the result in the variable named $NetworkAdapterC01.

The second command displays the checksum offload hardware capabilities of the network adapter stored in the $NetworkAdapterC01.

PARAMETERS

-AsJob

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-InterfaceDescription

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

Type: String[]
Parameter Sets: ByInstanceID
Aliases: ifDesc, InstanceID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies an array of network adapter names.

Type: String[]
Parameter Sets: ByName
Aliases: ifAlias, InterfaceAlias

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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

None

OUTPUTS

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.

NOTES

Disable-NetAdapterChecksumOffload

Enable-NetAdapterChecksumOffload

Set-NetAdapterChecksumOffload

© 2017 Microsoft