Get-NetAdapterRsc

Get-NetAdapterRsc

Gets network adapters that support receive segment coalescing (RSC).

Syntax

Parameter Set: ByName
Get-NetAdapterRsc [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-IPv4FailureReason <FailureReason[]> ] [-IPv4OperationalState <Boolean[]> ] [-IPv6FailureReason <FailureReason[]> ] [-IPv6OperationalState <Boolean[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceID
Get-NetAdapterRsc -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-IPv4FailureReason <FailureReason[]> ] [-IPv4OperationalState <Boolean[]> ] [-IPv6FailureReason <FailureReason[]> ] [-IPv6OperationalState <Boolean[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetAdapterRsc cmdelt gets network adapters that support receive segment coalescing (RSC). RSC takes multiple packets received within the same interrupt period and combines the packets into a single large package to be processed by the network stack. This reduces the processing overhead for incoming packets and reduces the number of processor cycles that are used, leading to better scalability.

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

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceDescription<String[]>

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.

Aliases

ifDesc

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-IPv4FailureReason<FailureReason[]>

Returns the reason that RSC may not be working on IPv4 traffic. The acceptable values for this parameter are: NoFailure, NicPropertyDisabled, WFPCompatibility, NDISCompatibility, ForwardingEnabled, or NetOffloadGlobalDisabled. If RSC is desired, then the following actions can be taken:
- NicPropertyDisabled: Run the Enable-NetAdapterRsc cmdlet to enable RSC on the specified network adapter.
- WFPCompatibility: Disable the WFP filters.
- NDISCompatibility: Upgrade to an NDIS 6.30 driver.
- ForwardingEnabled: Disable forwarding.
- NetOffloadGlobalDisabled: Run the Set-NetOffloadGlobalSetting cmdlet with the ReceiveSegmentCoalescing parameter set to Enabled.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-IPv4OperationalState<Boolean[]>

Specifies the state of the TCP/IP protocol driver for RSC. See the IPv4FailureReason parameter value for more information.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-IPv6FailureReason<FailureReason[]>

Returns the reason that of RSC may not be working on IPv6 traffic. The acceptable values for this parameter are: NoFailure, NicPropertyDisabled, WFPCompatibility, NDISCompatibility, ForwardingEnabled, or NetOffloadGlobalDisabled. If RSC is desired, then the following actions can be taken:
For NicPropertyDisabled: Run the Enable-NetAdapterRsc cmdlet to enable RSC on the specified network adapter.
- WFPCompatibility: Disable the WFP filters.
- NDISCompatibility: Upgrade to an NDIS 6.30 driver.
- ForwardingEnabled: Disable forwarding.
- NetOffloadGlobalDisabled: Run the Set-NetOffloadGlobalSetting cmdlet with the ReceiveSegmentCoalescing parameter set to Enabled.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-IPv6OperationalState<Boolean[]>

Specifies the state of the TCP/IP protocol driver for RSC. See the IPv6FailureReason parameter value for more information.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the network adapter.

Aliases

ifAlias, InterfaceAlias

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData

    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

This example gets the RSC properties of the network adapter named MyAdapter.

PS C:\> Get-NetAdapterRsc –Name MyAdapter

EXAMPLE 2

This example gets all of the RSC capable network adapters.

PS C:\> Get-NetAdapterRsc –Name *

EXAMPLE 3

This example gets all of the RSC capable network adapters.

PS C:\> Get-NetAdapterRsc –Name * | Where-Object -FilterScript { $_.Enabled }

Disable-NetAdapterRsc

Enable-NetAdapterRsc

Set-NetAdapterRsc

Set-NetOffloadGlobalSetting

Where-Object