Export (0) Print
Expand All

Get-NetQosPolicy

Updated: August 15, 2012

Applies To: Windows Server 2012

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

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

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

-Name<String[]>

Specifies the QoS policy name.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

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
Name           : Backup 
Owner          : Group Policy (Machine) 
NetworkProfile : Domain 
Precedence     : 127 
IPProtocol     : Both 
IPDstPrefix    : 10.1.1.176/28 
DSCPValue      : 40 
 
Name               : ntttcp 1 
Owner              : Group Policy (Machine) 
NetworkProfile     : All 
Precedence         : 127 
AppPathName        : ntttcp.exe 
MinBandwidthWeight : 30 
 
Name           : SMB Policy 
Owner          : Group Policy (Machine) 
NetworkProfile : All 
Precedence     : 127 
Template       : SMB 
PriorityValue  : 3 

EXAMPLE 2

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


PS C:\> Get-NetQosPolicy -PolicyStore ActiveStore
Name           : smb policy 
Owner          : Group Policy (Machine) 
NetworkProfile : All 
Precedence     : 127 
Template       : SMB 
PriorityValue  : 3 

Name               : ntttcp 1 
Owner              : Group Policy (Machine) 
NetworkProfile     : All 
Precedence         : 127 
AppPathName        : ntttcp.exe 
MinBandwidthWeight : 30 

Name           : backup 
Owner          : Group Policy (Machine) 
NetworkProfile : Domain 
Precedence     : 127 
IPProtocol     : Both 
DSCPValue      : 40 

Name           : ftp 
Owner          : PowerShell / WMI 
NetworkProfile : All 
Precedence     : 127 
AppPathName    : ftp.exe 
ThrottleRate   : 1 MBytes/sec 

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 *
User                         : 
AppPathName                  : 
Template                     : SMB 
NetDirectPort                : 0 
IPProtocol                   : None 
IPPort                       : 0 
IPSrcPrefix                  : 
IPSrcPortStart               : 0 
IPSrcPortEnd                 : 0 
IPDstPrefix                  : 
IPDstPortStart               : 0 
IPDstPortEnd                 : 0 
URI                          : 
URIRecursive                 : False 
PriorityValue                : 3 
DSCPValue                    : -1 
MinBandwidthWeight           : 0 
ThrottleRate                 : 0 
NetworkProfile               : All 
TemplateMatchCondition       : SMB 
UserMatchCondition           : 
AppPathNameMatchCondition    : 
NetDirectPortMatchCondition  : 0 
IPProtocolMatchCondition     : None 
IPPortMatchCondition         : 0 
IPSrcPrefixMatchCondition    : 
IPSrcPortStartMatchCondition : 0 
IPSrcPortEndMatchCondition   : 0 
IPDstPrefixMatchCondition    : 
IPDstPortStartMatchCondition : 0 
IPDstPortEndMatchCondition   : 0 
URIMatchCondition            : 
URIRecursiveMatchCondition   : False 
PriorityValue8021Action      : 3 
DSCPAction                   : -1 
MinBandwidthWeightAction     : 0 
ThrottleRateAction           : 0 
Caption                      : 
Description                  : 
ElementName                  : 
InstanceID                   : {382ACFAD-1E73-46BD-A0A0-64EE0E587B95}\SMB Policy 
Name                         : SMB Policy 
Owner                        : Group Policy (Machine) 
Precedence                   : 127 
Version                      : 2.0 
PSComputerName               : 
ComputerName                 : CHARLEY-MP1 
ClassName                    : MSFT_NetQosPolicySettingData 
Class                        : ROOT/StandardCimv2:MSFT_NetQosPolicySettingData 
CimClass                     : ROOT/StandardCimv2:MSFT_NetQosPolicySettingData 
Namespace                    : ROOT/StandardCimv2 
Properties                   : {Caption, Description, ElementName, InstanceID...} 
CimInstanceProperties        : {Caption, Description, ElementName, InstanceID...} 
CimSystemProperties          : Microsoft.Management.Infrastructure.CimSystemProperties 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft