This topic has not yet been rated - Rate this topic

Get-NetAdapterQos

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-NetAdapterQos

Gets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB) settings.

Syntax

Parameter Set: ByName
Get-NetAdapterQos [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceID
Get-NetAdapterQos -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetAdapterQos cmdlet gets quality of service (QoS) capabilities and runtime configurations of a DCB-capable network adapter. If QoS is disabled, then this cmdlet only gets the hardware QoS capabilities of the network adapter. If QoS is enabled, then this cmdlet gets the operational traffic class and flow control configurations in addition. If the network adapter supports the DCB Exchange protocol and is connected to a switch that also supports the protocol, then this cmdlet can also return the QoS configurations on the switch.

If a network adapter does not support QoS, specifically DCB, then this cmdlet does not return any information.

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.

Aliases	none
Required?	false
Position?	named
Default Value	false
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	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.

Aliases	none
Required?	false
Position?	named
Default Value	false
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	false
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	true

-Name<String[]>

Specifies the name of the network adapter.

Aliases	ifAlias, InterfaceAlias
Required?	false
Position?	1
Default Value	false
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	false
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 (http://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_NetAdapterQosSettingData
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.
The output object contains QoS capabilities and configurations on a network adapter.

Examples

EXAMPLE 1

This example displays the hardware QoS capabilities and the runtime QoS configurations for a network adapter on which QoS is enabled.

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

Name                       : DCBADAPTER1 
Enabled                    : True 
Capabilities               :                       Hardware     Current 
--------     ------- 
MacSecBypass        : NotSupported NotSupported 
DcbxSupport         : IEEE         None 
NumTCs(Max/ETS/PFC) : 8/8/8        8/8/8 
 
OperationalTrafficClasses  : TC TSA    Bandwidth Priorities 
-- ---    --------- ---------- 
0  ETS           40 0-3,5-7 
1  ETS           60 4 
 
OperationalFlowControl     : Priority 4 Enabled 
OperationalClassifications : Not Available

EXAMPLE 2

This example displays only the hardware QoS capabilities for a network adapter on which QoS is disabled.

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

Name         : DCBADAPTER1 
Enabled      : False 
Capabilities :                       Hardware     Current 
--------     ------- 
MacSecBypass        : NotSupported NotSupported 
DcbxSupport         : None         None 
NumTCs(Max/ETS/PFC) : 8/8/8        0/0/0

Get-NetAdapterQos