Set-NetQosPolicy

Set-NetQosPolicy

Updates the Quality of Service (QoS) policy settings.

Syntax

Parameter Set: __cmdletization_Query
Set-NetQosPolicy [[-Name] <String[]> ] [-AppPathNameMatchCondition <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-IPDstPortEndMatchCondition <UInt16> ] [-IPDstPortMatchCondition <UInt16> ] [-IPDstPortStartMatchCondition <UInt16> ] [-IPDstPrefixMatchCondition <String> ] [-IPPortMatchCondition <UInt16> ] [-IPProtocolMatchCondition <Protocol> ] [-IPSrcPortEndMatchCondition <UInt16> ] [-IPSrcPortMatchCondition <UInt16> ] [-IPSrcPortStartMatchCondition <UInt16> ] [-IPSrcPrefixMatchCondition <String> ] [-MinBandwidthWeightAction <Byte> ] [-NetDirectPortMatchCondition <UInt16> ] [-NetworkProfile <NetworkProfile> ] [-PassThru] [-PolicyStore <String> ] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-TemplateMatchCondition <Template> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-URIMatchCondition <String> ] [-URIRecursiveMatchCondition <Boolean> ] [-UserMatchCondition <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: __cmdletization_InputObject
Set-NetQosPolicy -InputObject <CimInstance[]> [-AppPathNameMatchCondition <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-DSCPAction <SByte> ] [-IPDstPortEndMatchCondition <UInt16> ] [-IPDstPortMatchCondition <UInt16> ] [-IPDstPortStartMatchCondition <UInt16> ] [-IPDstPrefixMatchCondition <String> ] [-IPPortMatchCondition <UInt16> ] [-IPProtocolMatchCondition <Protocol> ] [-IPSrcPortEndMatchCondition <UInt16> ] [-IPSrcPortMatchCondition <UInt16> ] [-IPSrcPortStartMatchCondition <UInt16> ] [-IPSrcPrefixMatchCondition <String> ] [-MinBandwidthWeightAction <Byte> ] [-NetDirectPortMatchCondition <UInt16> ] [-NetworkProfile <NetworkProfile> ] [-PassThru] [-Precedence <UInt32> ] [-PriorityValue8021Action <SByte> ] [-TemplateMatchCondition <Template> ] [-ThrottleLimit <Int32> ] [-ThrottleRateActionBytesPerSecond <UInt64> ] [-URIMatchCondition <String> ] [-URIRecursiveMatchCondition <Boolean> ] [-UserMatchCondition <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-NetQosPolicy cmdlet modifies an existing Quality of Service (QoS) policy. Match conditions or actions or general parameters of the policy such as NetworkProfile or Precedence can be changed.

Users cannot change the location of where an existing QoS policy is stored. Changing the PolicyStore parameter value will fail.

If a policy was created to be in ActiveStore and a user attempts to make it persistent, such as storing the policy on the local computer, the user has to create a new policy and place it on the local computer (localhost).

If the PolicyStore parameter is not specified, then the cmdlet will search for and update the policy on the local computer (localhost).

Parameters

-AppPathNameMatchCondition<String>

Specifies the name by which an application is run in Windows Server® 2012, 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

-DSCPAction<SByte>

Specifies the differentiated services code point (DSCP) value. A valid DSCP value is in the range between 0 and 63. In addition, users can enter -1 to remove the DSCP setting from the policy.

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

-InputObject<CimInstance[]>

Specified the object which will be modified by this cmdlet. The object must be piped to the cmdlet.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
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, Dest, Destaddr, DestinationAddress, Destip, Dst, Dstaddr, Dstip, 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 this parameter value to 80 matches HTTP traffic sent by both HTTP clients and HTTP servers.

Aliases	IPPort, Port
Required?	false
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 value. 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

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

Aliases	none
Required?	false
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 will send a Network Direct policy to a network adapter only if the network adapter supports Network Direct.

Aliases	Ndport, NetDirectPort, Networkdirectport
Required?	false
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. 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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

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

-Precedence<UInt32>

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

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

-PriorityValue8021Action<SByte>

Specifies the IEEE 802.1p value. A valid 802.1p value is in the range between 0 and 7. In addition, users can enter -1 to remove the 802.1p priority setting from the policy.

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

-TemplateMatchCondition<Template>

Specifies a number of filters built in Windows Server® 2012. The acceptable values for this parameter are: FCoE, iSCSI, LiveMigration, NFS, SMB, or. Note: Refer to the corresponding parameter descriptions for the New-NetQosPolicy cmdlet.

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

-UserMatchCondition<String>

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

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.

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

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. Only when the PassThru parameter is specified will this cmdlet return the MSFT_NetQosPolicySettingData object.

Examples

EXAMPLE 1

This example updates the QoS policy named SMB Policy so that it only applies to traffic that is outgoing from a domain-joined network adapter.

PS C:\> Set-NetQosPolicy –Name "SMB Policy" -NetworkProfile Domain

EXAMPLE 2

This example gets the QoS policy named wildcard and updates the precedence of the policy to 250.

PS C:\> Get-NetQosPolicy –Name "wildcard" | Set-NetQosPolicy -Precedence 250

EXAMPLE 3

This example updates the QoS policy named Backup with additional matching conditions.

PS C:\> Set-NetQosPolicy –Name "Backup" -IPDstPortStart 3501 -IPDstPortEnd 3510

EXAMPLE 4

This example updates the QoS policy named IIS, so that it applies to the return traffic for both the specified URI and subdirectories and files under the URI. This cmdlet also sets a new throttling rate at 3,000,000 bytes per second. Note: An alias for the ThrottleRateActionBytesPerSecond parameter is ThrottleRateAction. Another alias is MaxBw.

PS C:\> Set-NetQosPolicy –Name "IIS" -Recursive $true -ThrottleRateActionBytesPerSecond 3000KB

Related topics

Get-NetQosPolicy

New-NetQosPolicy

Remove-NetQosPolicy