Get-NetQosPolicy

Get-NetQosPolicy

Retrieves network Quality of Service (QoS) policies.

Syntax

Parameter Set: __cmdletization_Query
Get-NetQosPolicy [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetQosPolicy cmdlet allows users to retrieve Quality of Service (QoS) policies from a computer. QoS policies can originate from many sources, such as from the administrator of a local computer, from a domain controller, or from applications that use the QoS Windows Management Instrumentation (WMI) APIs. Therefore, the QoS policies are stored in different locations. If the location as provided by the PolicyStore parameter is not specified, then this cmdlet retrieves all the policies stored on the local computer (localhost).

ActiveStore is a special location. If ActiveStore is specified as the location, then the user will see all the effective QoS policies, regardless of where the QoS policies are stored.

Parameters

-AsJob

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

-Name<String[]>

Specifies the QoS policy name.

-PolicyStore<String>

Specifies the location of the policy that is stored. The acceptable values for this parameter are:
- ActiveStore
- COMPUTERNAME
- GPO:COMPUTERNAME
- GPO:DOMAIN\GPONAME
- LDAP://LDAP-URL

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

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

  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 MSFT_NetQosPolicySettingData object contains a QoS policy.

Examples

EXAMPLE 1

This example gets a list of QoS policies stored on the local computer (localhost).

PS C:\> Get-NetQoSPolicy

EXAMPLE 2

This example gets a list of QoS policies currently effective on the computer.

PS C:\> Get-NetQosPolicy -PolicyStore ActiveStore

EXAMPLE 3

This example gets all of the properties of a specific QoS policy. Some parameters on the left side of the output are actually aliases for real parameters. For example, the AppName parameter is an alias for the AppPathNameMatchCondition parameter.

PS C:\> Get-NetQosPolicy –Name "SMB policy" | Format-List -Property *

Related topics

New-NetQosPolicy

Remove-NetQosPolicy

Set-NetQosPolicy

Format-List