Set-Net Adapter Encapsulated Packet Task Offload

Module:
netadapter
Sets the encapsulated packet task offload property of the network adapter.

Syntax 

Set-NetAdapterEncapsulatedPacketTaskOffload
   [-Name] <String[]>
   [-IncludeHidden]
   [-NvgreEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanUDPPortNumber <UInt16>]
   [-NoRestart]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetAdapterEncapsulatedPacketTaskOffload
   -InterfaceDescription <String[]>
   [-IncludeHidden]
   [-NvgreEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanUDPPortNumber <UInt16>]
   [-NoRestart]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetAdapterEncapsulatedPacketTaskOffload
   -InputObject <CimInstance[]>
   [-NvgreEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanEncapsulatedPacketTaskOffloadEnabled <Boolean>]
   [-VxlanUDPPortNumber <UInt16>]
   [-NoRestart]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetAdapterEncapsulatedPacketTaskOffload cmdlet sets the encapsulated packet task offload property of the network adapter. Encapsulated task offload allows the network adapter to perform offload operations such as large send offload (LSO) and virtual machine queue (VMQ) on the inner header for encapsulated packets. The Enable-NetAdapterEncapsulatedPacketTaskoffload and Disable-NetAdapterEncapsulatedPacketTaskOffload cmdlets can also be used to manage encapsulated packet task offload.

Examples

Example 1: Enable encapsulated packet task offload on the specified network adapter 

PS C:\> Set-NetAdapterEncapsulatedPacketTaskOffload -Name "MyAdapter" -EncapsulatedPacketTaskOffloadEnabled $True

This command enables encapsulated packet task offload on the network adapter named MyAdapter and restarts the network adapter. The Enable-NetAdapterEncapsulatedPacketTaskOffload cmdlet is the preferred cmdlet to perform this operation.

Example 2: Disable encapsulated packet task offload on the specified network adapter 

PS C:\> Set-NetAdapterEncapsulatedPacketTaskOffload -Name "MyAdapter"  -EncapsulatedPacketTaskOffloadEnabled $False

This command disables encapsulated packet task offload on the network adapter named MyAdapter and restarts the network adapter. The Disable-NetAdapterEncapsulatedPacketTaskOffload cmdlet is the preferred cmdlet to perform this operation.

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

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

Specifies an array of network adapter names.

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

Optional 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
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[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

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

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

{{Fill NvgreEncapsulatedPacketTaskOffloadEnabled Description}}

Type: Boolean
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
-VxlanEncapsulatedPacketTaskOffloadEnabled

{{Fill VxlanEncapsulatedPacketTaskOffloadEnabled Description}}

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

{{Fill VxlanUDPPortNumber Description}}

Type: UInt16
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
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

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

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 EncapsulatedPacketTaskOffloadSettingData

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.