From 4a8ce87f161e97695871a4f19fa82cae983ef999 Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Fri, 17 Feb 2023 16:55:32 -0500 Subject: [PATCH] NetworkQoSPolicy CSP --- .../mdm/networkqospolicy-csp.md | 394 +++++++++++--- .../mdm/networkqospolicy-ddf.md | 492 +++++++++--------- 2 files changed, 559 insertions(+), 327 deletions(-) diff --git a/windows/client-management/mdm/networkqospolicy-csp.md b/windows/client-management/mdm/networkqospolicy-csp.md index 70a952ccd4..86e168dfb8 100644 --- a/windows/client-management/mdm/networkqospolicy-csp.md +++ b/windows/client-management/mdm/networkqospolicy-csp.md @@ -1,139 +1,383 @@ --- title: NetworkQoSPolicy CSP -description: The NetworkQoSPolicy CSP applies the Quality of Service (QoS) policy for Microsoft Surface Hub. This CSP was added in Windows 10, version 1703. +description: Learn more about the NetworkQoSPolicy CSP. +author: vinaypamnani-msft +manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/17/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 04/22/2021 -ms.reviewer: -manager: aaroncz +ms.topic: reference --- + + + # NetworkQoSPolicy CSP -The table below shows the applicability of Windows: - -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|Yes|Yes| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| - + + The NetworkQoSPolicy configuration service provider creates network Quality of Service (QoS) policies. A QoS policy performs a set of actions on network traffic based on a set of matching conditions. This CSP was added in Windows 10, version 1703. The following conditions are supported: + - Network traffic from a specific application name - Network traffic from specific source or destination ports - Network traffic from a specific IP protocol (TCP, UDP, or both) The following actions are supported: + - Layer 2 tagging using a IEEE 802.1p priority value - Layer 3 tagging using a differentiated services code point (DSCP) value > [!NOTE] > The NetworkQoSPolicy configuration service provider is officially supported for devices that are Intune managed and Azure AD joined. Currently, this CSP is not supported on the following devices: +> > - Azure AD Hybrid joined devices. > - Devices that use both GPO and CSP at the same time. > > The minimum operating system requirement for this CSP is Windows 10, version 1703. This CSP is not supported in Microsoft Surface Hub prior to Windows 10, version 1703. + + The following example shows the NetworkQoSPolicy configuration service provider in tree format. + +```text +./Device/Vendor/MSFT/NetworkQoSPolicy +--- {Name} +------ AppPathNameMatchCondition +------ DestinationPortMatchCondition +------ DSCPAction +------ IPProtocolMatchCondition +------ PriorityValue8021Action +------ SourcePortMatchCondition +--- Version ``` -./Device/Vendor/MSFT -NetworkQoSPolicy -----Version -----Name ---------IPProtocolMatchCondition ---------AppPathNameMatchCondition ---------SourcePortMatchCondition ---------DestinationPortMatchCondition ---------PriorityValue8021Action ---------DSCPAction + + + +## {Name} + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + + + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name} ``` -**NetworkQoSPolicy** -

The root node for the NetworkQoSPolicy configuration service provider.

+ -**Version** -

Specifies the version information. + + +The value of this node should be a policy name. + -

The data type is int. + + + -

The only supported operation is Get. + +**Description framework properties**: -***Name*** -

Node for the QoS policy name. +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Add, Delete, Get, Replace | +| Dynamic Node Naming | UniqueName: The value of this node should be a policy name. | + -***Name*/IPProtocolMatchCondition** -

Specifies the IP protocol used to match the network traffic. + + + -

Valid values are: + -- 0 (default) - Both TCP and UDP -- 1 - TCP -- 2 - UDP + +### {Name}/AppPathNameMatchCondition -

The data type is int. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + -

The supported operations are Add, Get, Delete, and Replace. + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/AppPathNameMatchCondition +``` + -***Name*/AppPathNameMatchCondition** -

Specifies the name of an application to be used to match the network traffic, such as `application.exe` or `%ProgramFiles%\application.exe`. + + +Specifies the name of an application to be used to match the network traffic, such as application.exe or %ProgramFiles%\application.exe. + -

The data type is char. + + + -

The supported operations are Add, Get, Delete, and Replace. + +**Description framework properties**: -***Name*/SourcePortMatchCondition** -

Specifies a single port or a range of ports to be used to match the network traffic source. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -

Valid values are: + + + -- A range of source ports: _[first port number]_-_[last port number]_ -- A single source port: _[port number]_ + -

The data type is char. + +### {Name}/DestinationPortMatchCondition -

The supported operations are Add, Get, Delete, and Replace. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + -***Name*/DestinationPortMatchCondition** -

Specifies a single source port or a range of ports to be used to match the network traffic destination. + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/DestinationPortMatchCondition +``` + -

Valid values are: + + +Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. + -- A range of destination ports: _[first port number]_-_[last port number]_ -- A single destination port: _[port number]_ + + + -

The data type is char. + +**Description framework properties**: -

The supported operations are Add, Get, Delete, and Replace. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -***Name*/PriorityValue8021Action** -

Specifies the IEEE 802.1p priority value to apply to matching network traffic. + + + -

Valid values are 0-7. + -

The data type is int. + +### {Name}/DSCPAction -

The supported operations are Add, Get, Delete, and Replace. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + -***Name*/DSCPAction** -

The Differentiated Services Code Point (DSCP) value to apply to matching network traffic. + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/DSCPAction +``` + -

Valid values are 0-63. + + +The differentiated services code point (DSCP) value to apply to matching network traffic. Valid values are 0-63. + -

The data type is int. + + + -

The supported operations are Add, Get, Delete, and Replace. + +**Description framework properties**: +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[0-63]` | + -## Related topics + + + -Read more about the XML DDF structure to create this policy by following the links below: + -- [More Information about DDF and structure](networkqospolicy-ddf.md) -- [CSP DDF files download](configuration-service-provider-ddf.md) + +### {Name}/IPProtocolMatchCondition + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + + + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/IPProtocolMatchCondition +``` + + + + +Specifies the IP protocol used to match the network traffic. Valid values are 0: Both TCP and UDP (default), 1: TCP, 2: UDP. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + + + + + + + + + +### {Name}/PriorityValue8021Action + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + + + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/PriorityValue8021Action +``` + + + + +The IEEE 802.1p value to apply to matching network traffice. Valid values are 0-7. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[0-7]` | + + + + + + + + + +### {Name}/SourcePortMatchCondition + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + + + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/{Name}/SourcePortMatchCondition +``` + + + + +Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +## Version + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later | + + + +```Device +./Device/Vendor/MSFT/NetworkQoSPolicy/Version +``` + + + + +Version information. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + + + + + + + + + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/networkqospolicy-ddf.md b/windows/client-management/mdm/networkqospolicy-ddf.md index f90310942f..c2846f500d 100644 --- a/windows/client-management/mdm/networkqospolicy-ddf.md +++ b/windows/client-management/mdm/networkqospolicy-ddf.md @@ -1,285 +1,273 @@ --- -title: NetworkQoSPolicy DDF -description: View the OMA DM device description framework (DDF) for the NetworkQoSPolicy configuration service provider. DDF files are used only with OMA DM provisioning XML. -ms.reviewer: +title: NetworkQoSPolicy DDF file +description: View the XML file containing the device description framework (DDF) for the NetworkQoSPolicy configuration service provider. +author: vinaypamnani-msft manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/17/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 12/05/2017 +ms.topic: reference --- -# NetworkQoSPolicy DDF + -This topic shows the OMA DM device description framework (DDF) for the **NetworkQoSPolicy** configuration service provider. DDF files are used only with OMA DM provisioning XML. +# NetworkQoSPolicy DDF file -Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md). - -The XML below is the current version for this CSP. +The following XML file contains the device description framework (DDF) for the NetworkQoSPolicy configuration service provider. ```xml -]> +]> 1.2 + + + + NetworkQoSPolicy + ./Device/Vendor/MSFT + + + + + The NetworkQoSPolicy configuration service provider creates network Quality of Service (QoS) policies. A QoS policy performs a set of actions on network traffic based on a set of matching conditions. This CSP was added in Windows 10, version 1703. This CSP is supported only in Microsoft Surface Hub prior to Window 10, version 2004. + + + + + + + + + + + + + + 10.0.19042 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x88;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD; + + + + Version + + + + + Version information. + + + + + + + + + + Version + + + + + + + + + + + + + + + + The value of this node should be a policy name. + + + + + + + + + + Name + + + + + The value of this node should be a policy name. + + - NetworkQoSPolicy - ./Device/Vendor/MSFT + IPProtocolMatchCondition + + + + 0 + Specifies the IP protocol used to match the network traffic. Valid values are 0: Both TCP and UDP (default), 1: TCP, 2: UDP. - + - + - + + IPProtocolMatchCondition - com.microsoft/1.0/MDM/NetworkQoSPolicy - + - - Version - - - - - Version information. - - - - - - - - - - Version - - text/plain - - - - - - - - - - - - - The value of this node should be a policy name. - - - - - - - - - - Name - - - - - - PolicyStore - - - - - - - - The location where the QoS policy is stored. - - - - - - - - - - PolicyStore - - text/plain - - - - - IPProtocolMatchCondition - - - - - - - - 0 - Specifies the IP protocol used to match the network traffic. Valid values are 0: Both TCP and UDP (default), 1: TCP, 2: UDP. - - - - - - - - - - IPProtocolMatchCondition - - text/plain - - - - - AppPathNameMatchCondition - - - - - - - - Specifies the name of an application to be used to match the network traffic, such as application.exe or %ProgramFiles%\application.exe. - - - - - - - - - - AppPathNameMatchCondition - - text/plain - - - - - SourcePortMatchCondition - - - - - - - - Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. - - - - - - - - - - SourcePortMatchCondition - - text/plain - - - - - DestinationPortMatchCondition - - - - - - - - Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. - - - - - - - - - - DestinationPortMatchCondition - - text/plain - - - - - PriorityValue8021Action - - - - - - - - The IEEE 802.1p value to apply to matching network traffice. Valid values are 0-7. - - - - - - - - - - PriorityValue8021Action - - text/plain - - - - - DSCPAction - - - - - - - - The differentiated services code point (DSCP) value to apply to matching network traffic. Valid values are 0-63. - - - - - - - - - - DSCPAction - - text/plain - - - - + + AppPathNameMatchCondition + + + + + + + + Specifies the name of an application to be used to match the network traffic, such as application.exe or %ProgramFiles%\application.exe. + + + + + + + + + + AppPathNameMatchCondition + + + + + + + + + SourcePortMatchCondition + + + + + + + + Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. + + + + + + + + + + SourcePortMatchCondition + + + + + + + + + DestinationPortMatchCondition + + + + + + + + Specifies a single port or a range of ports to be used to match the network traffic. Valid values are [first port number]-[last port number] or [port number]. + + + + + + + + + + DestinationPortMatchCondition + + + + + + + + + PriorityValue8021Action + + + + + + + + The IEEE 802.1p value to apply to matching network traffice. Valid values are 0-7. + + + + + + + + + + PriorityValue8021Action + + + + + [0-7] + + + + + DSCPAction + + + + + + + + The differentiated services code point (DSCP) value to apply to matching network traffic. Valid values are 0-63. + + + + + + + + + + DSCPAction + + + + + [0-63] + + + + + ``` -  - -  - - - - - +## Related articles +[NetworkQoSPolicy configuration service provider reference](networkqospolicy-csp.md)