New-NetQosPolicy

New-NetQosPolicy

Creates a new network Quality of Service (QoS) policy.

Syntax

Parameter Set: ByIP5Tuple
New-NetQosPolicy [-Name] <String> [-AppPathNameMatchCondition <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-IPDstPortEndMatchCondition <UInt16> ] [-IPDstPortMatchCondition <UInt16> ] [-IPDstPortStartMatchCondition <UInt16> ] [-IPDstPrefixMatchCondition <String> ] [-IPProtocolMatchCondition <Protocol> ] [-IPSrcPortEndMatchCondition <UInt16> ] [-IPSrcPortMatchCondition <UInt16> ] [-IPSrcPortStartMatchCondition <UInt16> ] [-IPSrcPrefixMatchCondition <String> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-UserMatchCondition <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByDefault
New-NetQosPolicy [-Name] <String> -Default [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByFCOE
New-NetQosPolicy [-Name] <String> -FCOE -PriorityValue8021Action <SByte> [-AsJob] [-CimSession <CimSession[]> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByIPWellKnownPort
New-NetQosPolicy [-Name] <String> -IPPortMatchCondition <UInt16> [-AppPathNameMatchCondition <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-IPProtocolMatchCondition <Protocol> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-UserMatchCondition <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByISCSI
New-NetQosPolicy [-Name] <String> -iSCSI [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByLiveMigration
New-NetQosPolicy [-Name] <String> -LiveMigration [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByNetworkDirectPort
New-NetQosPolicy [-Name] <String> -NetDirectPortMatchCondition <UInt16> -PriorityValue8021Action <SByte> [-AsJob] [-CimSession <CimSession[]> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByNFS
New-NetQosPolicy [-Name] <String> -NFS [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: BySMB
New-NetQosPolicy [-Name] <String> -SMB [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-MinBandwidthWeightAction <Byte> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByURI
New-NetQosPolicy [-Name] <String> -URIMatchCondition <String> [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-IPDstPrefixMatchCondition <String> ] [-NetworkProfile <NetworkProfile> ] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-URIRecursiveMatchCondition <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The New-NetQosPolicy cmdlet creates a new network Quality of Service (QoS) policy. A QoS policy consists of two main parts: match conditions also known as filters, and actions. Match conditions such as the name by which an application is run in Windows Server® 2012 and later or a TCP port number decide to what traffic the policy is relating. Parameters such as DSCPAction and ThrottleRateAction determine how the policy is to handle the matched traffic. Besides match conditions and actions, there are also some general parameters such as NetworkProfile and Precedence that the users can customize for a QoS policy.

A list of well-known match conditions, or filters, in the form of parameters is provided: FCoE, LiveMigration (6600), iSCSI (3260), NFS (2049), and SMB (445). Each of them matches a well-known TCP port specified in the brackets. The only exception is FCoE, which matches EtherType 0x8906. These filters must be used alone for filtering purpose. In other words, they cannot be mixed with other match condition parameters.

QoS policies can be stored in multiple locations. Users can choose a location by specifying the PolicyStore parameter. If the PolicyStore parameter is not specified, then the new policy is added to local computer (localhost). If a policy is stored in ActiveStore, then the policy will not persist after reboot.

Parameters

-AppPathNameMatchCondition<String>

Specifies the name by which an application is run, such as application.exe or %ProgramFiles%\application.exeapplication.

Aliases	App, ApplicationName. AppPathName
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-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

-Default

Specifies a wildcard filter that can be used to capture all traffic that is not matched by any other filter. One use case is that a user can create a QoS policy for a specific application using the AppPathNameMatchCondition parameter and create another QoS policy for all other applications using this parameter. Another use case is that a user can create several QoS policies, each of which specifies a minimum bandwidth action for the filtered traffic, and create one additional policy using this parameter to assign a minimum bandwidth action for all other traffic.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DSCPAction<SByte>

Specifies the differentiated services code point (DSCP) value. The acceptable values for this parameter are: 0 through 63.

Aliases	DSCP, DSCPValue
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-FCOE

Specifies the Fibre Channel over Ethernet (FCoE), which uses a dedicated EtherType 0x8914. If this parameter is specified, then the Windows Server® 2012 and later will instruct the network adapters in the computer that support FCoE to match the FCoE packets and apply the action specified in the policy.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPDstPortEndMatchCondition<UInt16>

Specifies the last port in a range of destination ports to be used to match the network traffic. This parameter must be used in conjunction with the IPDstPortStartMatchCondition parameter. The value of this parameter also must be larger than the value of the IPDstPortStartMatchCondition parameter.

Aliases	IPDstPortEnd
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPDstPortMatchCondition<UInt16>

Specifies the exact destination port to be used to match the network traffic. The filter of a QoS policy can be based on either a single port or a range of ports. To specify a single destination port, use this parameter. To specify a range of destination ports, use both the IPDstPortStartMatchCondition and the IPDstPortEndMatchCondition parameters.

Aliases	DestinationPort, Destport, Dp, Dstport, IPDstPort
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPDstPortStartMatchCondition<UInt16>

Specifies the first port in a range of destination ports to be used to match the network traffic. This parameter must be used in conjunction with the IPDstPortEndMatchCondition parameter. The value of this parameter also must be smaller than the value of the IPDstPortEndMatchCondition parameter.

Aliases	IPDstPortStart
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPDstPrefixMatchCondition<String>

Specifies the destination IP address, optionally with a network prefix, such as 1.2.3.4, 3ffe:ffff::1, 192.168.1.0/24, or fe80::1234/48.

Aliases	Da, DestinationAddress, Dst, Dstaddr, Dsti, IPDstPrefix
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPPortMatchCondition<UInt16>

Specifies the port to be used to match the network traffic, it can be either source port or destination port. If either the source port or the destination port in a packet matches the value of this parameter, then the QoS policy will apply to the packet. Usually this is a well-known port that a client uses to communicate with a server. With this parameter specified, the same QoS policy can be configured on both the clients and the servers and apply to the traffic in both directions. For example, specifying the IPPortMatchCondition parameter value of 80 matches HTTP traffic sent by both HTTP clients and HTTP servers.

Aliases	IPPort, Port
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPProtocolMatchCondition<Protocol>

Specifies the IP protocol to be used to match the network traffic. The acceptable values for this parameter are: TCP, UDP, or Both. If this parameter is unspecified, then Both is the default condition. The QoS policy will apply to both TCP and UDP traffic.

Aliases	IPProtocol,Protocol
Required?	false
Position?	named
Default Value	Both
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPSrcPortEndMatchCondition<UInt16>

Specifies the last port in a range of source ports to be used to match the network traffic. This parameter must be used in conjunction with the IPSrcPortStartMatchCondition parameter. The value of this parameter also must be larger than the value of the IPSrcPortStartMatchCondition parameter.

Aliases	IPSrcPortEnd
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPSrcPortMatchCondition<UInt16>

Specifies the exact source port to be used to match the network traffic. The filter of a QoS policy can be based on either a single port or a range of ports. To specify a single source port, use this parameter. To specify a range of source ports, use both the IPSrcPortStartMatchCondition and the IPSrcPortEndMatchCondition parameters.

Aliases	IPSrcPort, SourcePort, Sp, Srcport
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPSrcPortStartMatchCondition<UInt16>

Specifies the first port in a range of source ports to be used to match the network traffic. This parameter must be used in conjunction with the IPSrcPortEndMatchCondition parameter. the value of this parameter also must be smaller than the value of the IPSrcPortEndMatchCondition parameter.

Aliases	IPSrcPortStart
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-IPSrcPrefixMatchCondition<String>

Specifies the source IP address, optionally with a network prefix, such as 1.2.3.4, 3ffe:ffff::1, 192.168.1.0/24, or fe80::1234/48.

Aliases	IPSrcPrefix, Sa, SourceAddress, Src, Srcaddr, Srcip
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-iSCSI

Specifies the internet small computer system interface (iSCSI), which uses the dedicated TCP port 3260.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LiveMigration

Specifies the Microsoft live migration, which uses the well-known TCP port 6600.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MinBandwidthWeightAction<Byte>

Specifies a numerical value for minimum bandwidth that a flow should get relatively. The actual bandwidth a flow gets will depend on the weights assigned to other flows in the computer. The acceptable values for this parameter are: 1 through 100.

Aliases	MinBandwidthWeight, Minbww, Weight
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies the QoS policy name. This name must be unique for a QoS policy.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-NetDirectPortMatchCondition<UInt16>

Specifies the network direct port to be used to match the network traffic. Network Direct uses an independent port space from the TCP or UDP port space. Windows Server 2012 and later will send a Network Direct policy to a network adapter only if the network adapter supports Network Direct.

Aliases	Ndport, NetDirectPort, NetworkDirectPort
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-NetworkProfile<NetworkProfile>

Specifies the profile, or connection type, of a network, such as Domain. The acceptable values for this parameter are: Domain, Public, Private, or All. If this parameter is not specified, then the QoS policy will be effective when a computer is connected on any type of connection.

Aliases	none
Required?	false
Position?	named
Default Value	All
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-NFS

Specifies the network file system, which uses the dedicated TCP port 2049.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
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
If a policy is stored in ActiveStore, then the policy will not persist after reboot.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Precedence<UInt32>

Specifies the priority of a QoS policy. A higher priority policy will trump a lower priority policy in case the policies are conflicting. The acceptable values for this parameter are: 0 through 255. 255 represents the highest priority and 0 represents the lowest. If not specified, then the default value is 127.

Aliases	none
Required?	false
Position?	named
Default Value	127
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-PriorityValue8021Action<SByte>

Specifies the IEEE 802.1p value. The acceptable values for this parameter are: 0 through 7.

Aliases	Dot1p, Pri, PriorityValue, PriorityValue8021
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-SMB

Specifies the server message block, which uses the dedicated TCP port 445.

Aliases	none
Required?	true
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

-ThrottleRateActionBytesPerSecond<UInt64>

Specifies a throttle rate in bytes per second, also known as maximum bandwidth.

Aliases	MaxBw, Throttle, ThrottleRate, ThrottleRateAction
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-URIMatchCondition<String>

Specifies the URI to match. Only a HTTP URL is currently supported, such as http://myhost, https://*/training, http://myhost:8080/training, or https://myhost:*/training. The QoS policy will only apply to the traffic sent from HTTP server applications to HTTP clients in response to the requests from the client for the specified URI.

Aliases	Uri,Url
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-URIRecursiveMatchCondition<Boolean>

Specifies that all subdirectories and files following the URI specified in the URIMatchCondition parameter are to be included. This parameter can be specified only if the URIMatchCondition parameter is specified.

Aliases	Recursive, URIRecursive, Urlrecursive
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-UserMatchCondition<String>

Specifies the user or group name in Active Directory, such as contoso\User1. This parameter is usually specified with another filtering parameter such as the AppPathNameMatchCondtion cmdlet.

Aliases	Sid, User
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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 (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 creates a QoS policy named SMB Policy, that classifies SMB traffic and tags it with 802.1p priority value of 3. The SMB parameter is a built-in filter that matches TCP port 445, which is reserved for SMB.

PS C:\> New-NetQosPolicy –Name "SMB Policy" -SMB -PriorityValue8021Action 3

EXAMPLE 2

This example creates a QoS policy named FTP, that matches an application path at ftp.exe and throttles the traffic at 1,000,000 bytes per second. This policy is ActiveStore, meaning that it is not persistent after reboot of the computer.
An alias for the ThrottleRateActionBytesPerSecond parameter is MaxBw.

PS C:\> New-NetQosPolicy –Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBytesPerSecond 1MB -PolicyStore ActiveStore

EXAMPLE 3

This example creates a QoS policy named Backup, that matches traffic sent to 10.1.1.176/28 subnet and tags it with DSCP value of 40. This policy is effective only on traffic sent on a domain-joined network adapter.

PS C:\> New-NetQosPolicy –Name "Backup" -IPDstPrefixMatchCondition 10.1.1.176/28 -NetworkProfile Domain -DSCPAction 40

EXAMPLE 4

This example creates a QoS policy that matches TCP traffic sent to port 80 and rate-limits it at 10,000,000 bytes per second.

PS C:\> New-NetQosPolicy –Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBytesPerSecond 10MB

EXAMPLE 5

This example creates a QoS policy named Wildcard, that catches all the traffic that does not match a specific QoS policy and assigns a minimum bandwidth weight of 30 to such traffic.

PS C:\> New-NetQosPolicy –Name "Wildcard" -Default -MinBandwidthWeightAction 30

EXAMPLE 6

This example creates a QoS policy named IIS, that matches return traffic from an HTTP server application with the specified URI and rate limit the return traffic at 500,000 bytes per second.

PS C:\> New-NetQosPolicy –Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBytesPerSecond 500KB

Related topics

Get-NetQosPolicy

Remove-NetQosPolicy

Set-NetQosPolicy