Get-NetAdapterQos

Get-NetAdapterQos

Gets the QoS properties of the network adapter, specifically 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

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

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceDescription<String[]>

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.


Aliases

ifDesc

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-Name<String[]>

Specifies an array of network adapter names.


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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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: Display hardware QoS capabilities and runtime configurations for network adapters where QoS is enabled

This command 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 }

Example 2: Display hardware QoS capabilities for network adapters where QoS is disabled

This command 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" }

Related topics

Community Additions

ADD
Show: