Set-NetAdapterLso

Sets the large send offload (LSO) properties of the network adapter.

Syntax

Set-NetAdapterLso
   [-Name] <String[]>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   [-IPv4Enabled <Boolean>]
   [-IPv6Enabled <Boolean>]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-V1IPv4Enabled <Boolean>]
   [-Confirm]
   [-WhatIf]
Set-NetAdapterLso
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   [-IPv4Enabled <Boolean>]
   [-IPv6Enabled <Boolean>]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-V1IPv4Enabled <Boolean>]
   -InterfaceDescription <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterLso
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IPv4Enabled <Boolean>]
   [-IPv6Enabled <Boolean>]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-V1IPv4Enabled <Boolean>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]

Description

The Set-NetAdapterLso cmdlet manages the large send offload property which can improve send side performance by having the network adapter distribute a large send request into smaller sizes that can be sent out by the network adapter. Without this setting Windows Server® 2012 and later would have to perform this work. The offload reduces the load on the processor, so that the processor can to do more application level work. If only setting the enabled state of LSO, then use the Enable-NetAdapterLso or Disable-NetAdapterLso cmdlets.

Examples

EXAMPLE 1

PS C:\>Set-NetAdapterLso -Name MyAdapter -IPv4Enabled $True -IPv6Enabled $False

This example enables LSO for IPv4 and disables LSO for IPv6 on the network adapter named MyAdapter.

Required Parameters

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-InterfaceDescription

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.

Type:String[]
Aliases:ifDesc
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True
-Name

Specifies the name of the network adapter.

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

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
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-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
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-IPv4Enabled

Specifies the enabled state of LSO for IPv4 traffic.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IPv6Enabled

Specifies the enabled state of LSO for IPv6 traffic.

Type:Boolean
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:SwitchParameter
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-V1IPv4Enabled

Enables LSOv1 on the network adapter.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

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

Inputs

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

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

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData

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.