From 0b446caf429a576c71157e6fa70adf3016f29fc1 Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Fri, 17 Feb 2023 16:51:11 -0500 Subject: [PATCH] NetworkProxy CSP --- .../client-management/mdm/networkproxy-csp.md | 378 +++++++++++++--- .../client-management/mdm/networkproxy-ddf.md | 406 +++++++++++------- 2 files changed, 564 insertions(+), 220 deletions(-) diff --git a/windows/client-management/mdm/networkproxy-csp.md b/windows/client-management/mdm/networkproxy-csp.md index 4be3316fbb..b45dc88ffd 100644 --- a/windows/client-management/mdm/networkproxy-csp.md +++ b/windows/client-management/mdm/networkproxy-csp.md @@ -1,29 +1,23 @@ --- title: NetworkProxy CSP -description: Learn how the NetworkProxy configuration service provider (CSP) is used to configure a proxy server for ethernet and Wi-Fi connections. +description: Learn more about the NetworkProxy 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: 08/29/2018 -ms.reviewer: -manager: aaroncz +ms.topic: reference --- + + + # NetworkProxy CSP -The table below shows the applicability of Windows: - -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| - + + The NetworkProxy configuration service provider (CSP) is used to configure a proxy server for ethernet and Wi-Fi connections. These settings do not apply to VPN connections. This CSP was added in Windows 10, version 1703. How the settings work: @@ -32,73 +26,332 @@ How the settings work: - If #1 fails and a setup script is specified, the system tries to download the explicitly configured PAC script. - If #2 fails and a proxy server is specified, the system tries to use the explicitly configured proxy server. - Otherwise, the system tries to reach the site directly. + -The following shows the NetworkProxy configuration service provider in tree format. + +The following example shows the NetworkProxy configuration service provider in tree format. -```console -./Vendor/MSFT -NetworkProxy -----ProxySettingsPerUser -----AutoDetect -----SetupScriptUrl -----ProxyServer ---------ProxyAddress ---------Exceptions ---------UseProxyForLocalAddresses +```text +./Vendor/MSFT/NetworkProxy +--- AutoDetect +--- ProxyServer +------ Exceptions +------ ProxyAddress +------ UseProxyForLocalAddresses +--- ProxySettingsPerUser +--- SetupScriptUrl ``` + -**./Vendor/MSFT/NetworkProxy** -The root node for the NetworkProxy configuration service provider. + +## AutoDetect -**ProxySettingsPerUser** -Added in Windows 10, version 1803. When set to 0, it enables proxy configuration as global, machine wide. + +| 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 1703 [10.0.15063] and later | + -Supported operations are Add, Get, Replace, and Delete. + +```Device +./Vendor/MSFT/NetworkProxy/AutoDetect +``` + -> [!Note] -> Per user proxy configuration setting is not supported using a configuration file, only modifying registry settings on a local machine. - -**AutoDetect** + + Automatically detect settings. If enabled, the system tries to find the path to a PAC script. + -Valid values: + + + -- 0 - Disabled -- 1 (default) - Enabled + +**Description framework properties**: -The data type is integer. Supported operations are Get and Replace. Starting in Windows 10, version 1803, the Delete operation is also supported. +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Delete, Get, Replace | +| Default Value | 1 | + -**SetupScriptUrl** -Address to the PAC script you want to use. + +**Allowed values**: -The data type is string. Supported operations are Get and Replace. Starting in Windows 10, version 1803, the Delete operation is also supported. +| Value | Description | +|:--|:--| +| 0 | Disabled. | +| 1 (Default) | Enabled. | + -**ProxyServer** + + + + + + + +## ProxyServer + + +| 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 1703 [10.0.15063] and later | + + + +```Device +./Vendor/MSFT/NetworkProxy/ProxyServer +``` + + + + Node for configuring a static proxy for Ethernet and Wi-Fi connections. The same proxy server is used for all protocols - including HTTP, HTTPS, FTP, and SOCKS. These settings do not apply to VPN connections. + -Supported operation is Get. + + + -**ProxyAddress** -Address to the proxy server. Specify an address in the format <server>[“:”<port>].  + +**Description framework properties**: -The data type is string. Supported operations are Get and Replace. Starting in Windows 10, version 1803, the Delete operation is also supported. +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + -**Exceptions** -Addresses that should not use the proxy server. The system will not use the proxy server for addresses beginning with what is specified in this node. Use semicolons (;) to separate entries.  + + + -The data type is string. Supported operations are Get and Replace. Starting in Windows 10, version 1803, the Delete operation is also supported. + -**UseProxyForLocalAddresses** -Specifies whether the proxy server should be used for local (intranet) addresses.  + +### ProxyServer/Exceptions -Valid values: + +| 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 1703 [10.0.15063] and later | + -- 0 (default) - Use proxy server for local addresses -- 1 - Do not use proxy server for local addresses + +```Device +./Vendor/MSFT/NetworkProxy/ProxyServer/Exceptions +``` + -The data type is integer. Supported operations are Get and Replace. Starting in Windows 10, version 1803, the Delete operation is also supported. + + +Addresses that should not use the proxy server. The system will not use the proxy server for addresses beginning with what is specified in this node. Use semicolons (;) to separate entries. + -## Configuration Example + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Delete, Get, Replace | +| Allowed Values | List (Delimiter: `;`) | + + + + + + + + + +### ProxyServer/ProxyAddress + + +| 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 1703 [10.0.15063] and later | + + + +```Device +./Vendor/MSFT/NetworkProxy/ProxyServer/ProxyAddress +``` + + + + +Address to the proxy server. Specify an address in the format ``[":"``]. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Delete, Get, Replace | + + + + + + + + + +### ProxyServer/UseProxyForLocalAddresses + + +| 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 1703 [10.0.15063] and later | + + + +```Device +./Vendor/MSFT/NetworkProxy/ProxyServer/UseProxyForLocalAddresses +``` + + + + +Specifies whether the proxy server should be used for local (intranet) addresses. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Delete, Get, Replace | +| Default Value | 0 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 (Default) | Use proxy server for local addresses. | +| 1 | Do not use proxy server for local addresses. | + + + + + + + + + +## ProxySettingsPerUser + + +| 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 1803 [10.0.17134] and later | + + + +```Device +./Vendor/MSFT/NetworkProxy/ProxySettingsPerUser +``` + + + + +When set to 0, it enables proxy configuration as global, machine wide. + + + + +> [!NOTE] +> Per user proxy configuration setting is not supported using a configuration file, only modifying registry settings on a local machine. + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Delete, Get, Replace | +| Default Value | 1 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 | Proxy configuration is global, machine wide. | +| 1 (Default) | Proxy configuration is per user. | + + + + + + + + + +## SetupScriptUrl + + +| 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 1703 [10.0.15063] and later | + + + +```Device +./Vendor/MSFT/NetworkProxy/SetupScriptUrl +``` + + + + +Address to the PAC script you want to use. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Delete, Get, Replace | + + + + + + + + + + +## Examples These generic code portions for the options **ProxySettingsPerUser**, **Autodetect**, and **SetupScriptURL** can be used for a specific operation, for example Replace. Only enter the portion of code needed in the **Replace** section. @@ -149,3 +402,10 @@ These generic code portions for the options **ProxySettingsPerUser**, **Autodete ``` + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/networkproxy-ddf.md b/windows/client-management/mdm/networkproxy-ddf.md index b83fb6eab6..06042fcea6 100644 --- a/windows/client-management/mdm/networkproxy-ddf.md +++ b/windows/client-management/mdm/networkproxy-ddf.md @@ -1,178 +1,262 @@ --- title: NetworkProxy DDF file -description: AppNetworkProxyLocker DDF file +description: View the XML file containing the device description framework (DDF) for the NetworkProxy 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.reviewer: -manager: aaroncz +ms.topic: reference --- + + # NetworkProxy DDF file -This topic shows the OMA DM device description framework (DDF) for the **NetworkProxy** configuration service provider. - -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 NetworkProxy configuration service provider. ```xml -]> +]> - 1.2 + 1.2 + + + + NetworkProxy + ./Vendor/MSFT + + + + + The root node for the NetworkProxy configuration service provider. + + + + + + + + + + + + + + 10.0.15063 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD; + + - NetworkProxy - ./Vendor/MSFT - - - - - - - - - - - - - - - com.microsoft/1.0/MDM/NetworkProxy - - - - AutoDetect - - - - - - 1 - - - - - - - - - - - text/plain - - - - - SetupScriptUrl - - - - - - - - - - - - - - - - text/plain - - - - - ProxyServer - - - - - - - - - - - - - - - - - - - ProxyAddress - - - - - - - - - - - - - - - - text/plain - - - - - Exceptions - - - - - - - - - - - - - - - - text/plain - - - - - UseProxyForLocalAddresses - - - - - - 0 - - - - - - - - - - - text/plain - - - - + ProxySettingsPerUser + + + + + + + 1 + When set to 0, it enables proxy configuration as global, machine wide. + + + + + + + + + + + + + + 10.0.17134 + 1.0 + + + + 0 + Proxy configuration is global, machine wide. + + + 1 + Proxy configuration is per user. + + + + + AutoDetect + + + + + + + 1 + Automatically detect settings. If enabled, the system tries to find the path to a PAC script. + + + + + + + + + + + + + + + 0 + Disabled + + + 1 + Enabled + + + + + + SetupScriptUrl + + + + + + + Address to the PAC script you want to use. + + + + + + + + + + + + + + + + + + ProxyServer + + + + + Node for configuring a static proxy for Ethernet and Wi-Fi connections. The same proxy server is used for all protocols - including HTTP, HTTPS, FTP, and SOCKS. These settings do not apply to VPN connections. + + + + + + + + + + + + + + + ProxyAddress + + + + + + + [“:”]. ]]> + + + + + + + + + + + + + + + + + + Exceptions + + + + + + + Addresses that should not use the proxy server. The system will not use the proxy server for addresses beginning with what is specified in this node. Use semicolons (;) to separate entries. + + + + + + + + + + + + + + + + + + + UseProxyForLocalAddresses + + + + + + + 0 + Specifies whether the proxy server should be used for local (intranet) addresses. Valid values: + + + + + + + + + + + + + + + 0 + Use proxy server for local addresses + + + 1 + Do not use proxy server for local addresses + + + + + + ``` + +## Related articles + +[NetworkProxy configuration service provider reference](networkproxy-csp.md)