deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 21:37:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

WiFi CSP

Browse Source
This commit is contained in:
Vinay Pamnani 2023-02-17 13:55:51 -05:00
parent 5413e67998
commit 0ad1288408
2 changed files with 1217 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

805
windows/client-management/mdm/wifi-csp.md
View File

@ -1,32 +1,23 @@
--- ---
title: WiFi CSP title: WiFi CSP
description: The WiFi configuration service provider (CSP) provides the functionality to add or delete Wi-Fi networks on a Windows device. description: Learn more about the WiFi CSP.
ms.reviewer: author: vinaypamnani-msft
manager: aaroncz manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 06/18/2019
--- ---
<!-- Auto-Generated CSP Document -->
<!-- WiFi-Begin -->
# WiFi CSP # WiFi CSP
The table below shows the applicability of Windows: <!-- WiFi-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|Yes|Yes|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
> [!WARNING]
> Some information relates to pre-released products, which may be substantially modified before it's commercially released. Microsoft makes no warranties, expressed or implied, concerning the information provided here.
The WiFi configuration service provider provides the functionality to add or delete Wi-Fi networks on a Windows device. The configuration service provider accepts SyncML input and converts it to a network profile that is installed on the device. This profile enables the device to connect to the Wi-Fi network when it's in range. The WiFi configuration service provider provides the functionality to add or delete Wi-Fi networks on a Windows device. The configuration service provider accepts SyncML input and converts it to a network profile that is installed on the device. This profile enables the device to connect to the Wi-Fi network when it's in range.
Programming considerations: Programming considerations:
@ -34,126 +25,761 @@ Programming considerations:
- If the authentication method needs a certificate, for example, EAP-TLS requires client certificates, you must configure it through the CertificateStore configuration service provider. The WiFi configuration service provider doesn't provide that functionality; instead, the Wi-Fi profile can specify characteristics of the certificate to be used for choosing the right certificate for that network. The server must successfully enroll the certificate first before deploying the Wi-Fi network configuration. For example, for an EAP-TLS profile, the server must successfully configure and enroll the required client certificate before deploying the Wi-Fi profile. Self-signed certificate works for EAP-TLS/PEAP-MSCHAPv2, but it isn't supported in EAP-TLS. - If the authentication method needs a certificate, for example, EAP-TLS requires client certificates, you must configure it through the CertificateStore configuration service provider. The WiFi configuration service provider doesn't provide that functionality; instead, the Wi-Fi profile can specify characteristics of the certificate to be used for choosing the right certificate for that network. The server must successfully enroll the certificate first before deploying the Wi-Fi network configuration. For example, for an EAP-TLS profile, the server must successfully configure and enroll the required client certificate before deploying the Wi-Fi profile. Self-signed certificate works for EAP-TLS/PEAP-MSCHAPv2, but it isn't supported in EAP-TLS.
- For WEP, WPA, and WPA2-based networks, include the passkey in the network configuration in plaintext. The passkey is encrypted automatically when it's stored on the device. - For WEP, WPA, and WPA2-based networks, include the passkey in the network configuration in plaintext. The passkey is encrypted automatically when it's stored on the device.
- The SSID of the Wi-Fi network part of the LocURI node must be a valid URI based on RFC 2396. This condition requires that all non-ASCII characters must be escaped using a %-character. Unicode characters without the necessary escaping aren't supported. - The SSID of the Wi-Fi network part of the LocURI node must be a valid URI based on RFC 2396. This condition requires that all non-ASCII characters must be escaped using a %-character. Unicode characters without the necessary escaping aren't supported.
- The \<name>*name\_goes\_here*\</name>\<SSIDConfig> must match \<SSID>\<name> *name\_goes\_here*\</name>\</SSID>. - The `<name>name_goes_here</name>\<SSIDConfig>` must match `<SSID><name>name_goes_here</name></SSID>`.
- For the WiFi CSP, you can't use the Replace command unless the node already exists. - For the WiFi CSP, you can't use the Replace command unless the node already exists.
- Using Proxyis in Windows 10 client editions (Home, Pro, Enterprise, and Education) will result in failure. - Using ProxyPacUrl or ProxyWPAD in Windows 10 client editions (Home, Pro, Enterprise, and Education) will result in failure.
<!-- WiFi-Editable-End -->
<!-- WiFi-Tree-Begin -->
The following example shows the WiFi configuration service provider in tree format. The following example shows the WiFi configuration service provider in tree format.
```console ```text
./Device/Vendor/MSFT ./Device/Vendor/MSFT/WiFi
or --- Profile
./User/Vendor/MSFT ------ {SSID}
WiFi --------- ProfileSource
---Profile --------- Proxy
------SSID --------- ProxyPacUrl
---------WlanXML --------- ProxyWPAD
---------WiFiCost --------- WiFiCost
--------- WlanXml
./User/Vendor/MSFT/WiFi
--- Profile
------ {SSID}
--------- ProfileSource
--------- Proxy
--------- ProxyPacUrl
--------- ProxyWPAD
--------- WiFiCost
--------- WlanXml
``` ```
<!-- WiFi-Tree-End -->
The following list shows the characteristics and parameters. <!-- Device-Profile-Begin -->
## Device/Profile
<a href="" id="wifi"></a>**Device or User profile** <!-- Device-Profile-Applicability-Begin -->
For user profile, use `./User/Vendor/MSFT/Wifi` path and for device profile, use `./Device/Vendor/MSFT/Wifi` path. | Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-Profile-Applicability-End -->
<a href="" id="profile"></a>**Profile** <!-- Device-Profile-OmaUri-Begin -->
Identifies the Wi-Fi network configuration. Each Wi-Fi network configuration is represented by a profile object. This network profile includes all the information required for the device to connect to that network – for example, the SSID, authentication and encryption methods and passphrase if there's WEP or WPA2 networks. ```Device
./Device/Vendor/MSFT/WiFi/Profile
```
<!-- Device-Profile-OmaUri-End -->
Supported operation is Get. <!-- Device-Profile-Description-Begin -->
<!-- Description-Source-DDF -->
Identifies the Wi-Fi network configuration. Each Wi-Fi network configuration is represented by a profile object. This network profile includes all the information required for the device to connect to that network - for example, the SSID, authentication and encryption methods and passphrase in case of WEP or WPA2 networks.
<!-- Device-Profile-Description-End -->
<a href="" id="-ssid-"></a>**<em>\<SSID></em>** <!-- Device-Profile-Editable-Begin -->
Specifies the name of the Wi-Fi network (32 bytes maximum) to create, configure, query, or delete. The name is case sensitive and can be represented in ASCII. The SSID is added when the WlanXML node is added. When the SSID node is deleted, then all the subnodes are also deleted. <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Profile-Editable-End -->
SSID is the name of network you're connecting to, while Profile name is the name of the Profile that contains the WiFi settings information. If the Profile name isn't set right in the MDM SyncML, as per the information in the WiFi settings XML, it could lead to some unexpected errors. For example, \<LocURI>./Vendor/MSFT/WiFi/Profile/<*MUST BE NAME OF PROFILE AS PER WIFI XML*>/WlanXml\</LocURI>. <!-- Device-Profile-DFProperties-Begin -->
**Description framework properties**:
The supported operations are Add, Get, Delete, and Replace. | Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-Profile-DFProperties-End -->
<a href="" id="wlanxml"></a>**WlanXML** <!-- Device-Profile-Examples-Begin -->
The XML that describes the network configuration and follows the [WLAN\_profile Schema](/windows/win32/nativewifi/wlan-profileschema-schema) on MSDN. <!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-Examples-End -->
Supported operations are Get, Add, Delete, and Replace. <!-- Device-Profile-End -->
Value type is chr. <!-- Device-Profile-{SSID}-Begin -->
### Device/Profile/{SSID}
<!-- Device-Profile-{SSID}-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-Profile-{SSID}-Applicability-End -->
<!-- Device-Profile-{SSID}-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}
```
<!-- Device-Profile-{SSID}-OmaUri-End -->
<!-- Device-Profile-{SSID}-Description-Begin -->
<!-- Description-Source-DDF -->
The Profile name of the Wi-Fi network. This is added when WlanXml node is added and deleted when WlanXml is deleted.
<!-- Device-Profile-{SSID}-Description-End -->
<!-- Device-Profile-{SSID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
Specifies the name of the Wi-Fi network (32 bytes maximum) to create, configure, query, or delete. The name is case sensitive and can be represented in ASCII.
SSID is the name of network you're connecting to, while Profile name is the name of the Profile that contains the WiFi settings information. If the Profile name isn't set right in the MDM SyncML, as per the information in the WiFi settings XML, it could lead to some unexpected errors. For example, `<LocURI>./Vendor/MSFT/WiFi/Profile/<MUST BE NAME OF PROFILE AS PER WIFI XML>/WlanXml</LocURI>`.
<!-- Device-Profile-{SSID}-Editable-End -->
<!-- Device-Profile-{SSID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get, Replace |
| Atomic Required | True |
| Dynamic Node Naming | ServerGeneratedUniqueIdentifier |
<!-- Device-Profile-{SSID}-DFProperties-End -->
<!-- Device-Profile-{SSID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-Examples-End -->
<!-- Device-Profile-{SSID}-End -->
<!-- Device-Profile-{SSID}-ProfileSource-Begin -->
#### Device/Profile/{SSID}/ProfileSource
<!-- Device-Profile-{SSID}-ProfileSource-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 22H2 [10.0.22621] and later |
<!-- Device-Profile-{SSID}-ProfileSource-Applicability-End -->
<!-- Device-Profile-{SSID}-ProfileSource-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/ProfileSource
```
<!-- Device-Profile-{SSID}-ProfileSource-OmaUri-End -->
<!-- Device-Profile-{SSID}-ProfileSource-Description-Begin -->
<!-- Description-Source-DDF -->
Allows for defining which administrative entity is setting this Wi-Fi profile. This can currently be set to either 0=Enterprise or 1=Mobile Operator.
<!-- Device-Profile-{SSID}-ProfileSource-Description-End -->
<!-- Device-Profile-{SSID}-ProfileSource-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-ProfileSource-Editable-End -->
<!-- Device-Profile-{SSID}-ProfileSource-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 0 |
<!-- Device-Profile-{SSID}-ProfileSource-DFProperties-End -->
<!-- Device-Profile-{SSID}-ProfileSource-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| 0 (Default) | Enterprise. |
| 1 | Mobile Operator. |
<!-- Device-Profile-{SSID}-ProfileSource-AllowedValues-End -->
<!-- Device-Profile-{SSID}-ProfileSource-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-ProfileSource-Examples-End -->
<!-- Device-Profile-{SSID}-ProfileSource-End -->
<!-- Device-Profile-{SSID}-Proxy-Begin -->
#### Device/Profile/{SSID}/Proxy
<!-- Device-Profile-{SSID}-Proxy-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-Profile-{SSID}-Proxy-Applicability-End -->
<!-- Device-Profile-{SSID}-Proxy-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/Proxy
```
<!-- Device-Profile-{SSID}-Proxy-OmaUri-End -->
<!-- Device-Profile-{SSID}-Proxy-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. The format is url:port. Configuration of the network proxy (if any).
<!-- Device-Profile-{SSID}-Proxy-Description-End -->
<!-- Device-Profile-{SSID}-Proxy-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-Proxy-Editable-End -->
<!-- Device-Profile-{SSID}-Proxy-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Profile-{SSID}-Proxy-DFProperties-End -->
<!-- Device-Profile-{SSID}-Proxy-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-Proxy-Examples-End -->
<!-- Device-Profile-{SSID}-Proxy-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-Begin -->
#### Device/Profile/{SSID}/ProxyPacUrl
<!-- Device-Profile-{SSID}-ProxyPacUrl-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later |
<!-- Device-Profile-{SSID}-ProxyPacUrl-Applicability-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/ProxyPacUrl
```
<!-- Device-Profile-{SSID}-ProxyPacUrl-OmaUri-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. URL to the PAC file location.
<!-- Device-Profile-{SSID}-ProxyPacUrl-Description-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
> [!NOTE]
> Don't use. Using this configuration in Windows 10 client editions will result in failure.
<!-- Device-Profile-{SSID}-ProxyPacUrl-Editable-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Profile-{SSID}-ProxyPacUrl-DFProperties-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-Examples-End -->
<!-- Device-Profile-{SSID}-ProxyPacUrl-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-Begin -->
#### Device/Profile/{SSID}/ProxyWPAD
<!-- Device-Profile-{SSID}-ProxyWPAD-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later |
<!-- Device-Profile-{SSID}-ProxyWPAD-Applicability-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/ProxyWPAD
```
<!-- Device-Profile-{SSID}-ProxyWPAD-OmaUri-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. The presence of the field enables WPAD for proxy lookup.
<!-- Device-Profile-{SSID}-ProxyWPAD-Description-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
> [!NOTE]
> Don't use. Using this configuration in Windows 10 client editions will result in failure.
<!-- Device-Profile-{SSID}-ProxyWPAD-Editable-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | bool |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Profile-{SSID}-ProxyWPAD-DFProperties-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| false | Disable WPAD for proxy lookup. |
| true | Enable WPAD for proxy lookup. |
<!-- Device-Profile-{SSID}-ProxyWPAD-AllowedValues-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-ProxyWPAD-Examples-End -->
<!-- Device-Profile-{SSID}-ProxyWPAD-End -->
<!-- Device-Profile-{SSID}-WiFiCost-Begin -->
#### Device/Profile/{SSID}/WiFiCost
<!-- Device-Profile-{SSID}-WiFiCost-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1809 [10.0.17763] and later |
<!-- Device-Profile-{SSID}-WiFiCost-Applicability-End -->
<!-- Device-Profile-{SSID}-WiFiCost-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/WiFiCost
```
<!-- Device-Profile-{SSID}-WiFiCost-OmaUri-End -->
<!-- Device-Profile-{SSID}-WiFiCost-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. If the policy is active selecting one of the values from the following list will set the cost of WLAN connection for the Wi-Fi profile. (1:Unrestricted - unlimited connection, 2: Fixed - capacity constraints up to a certain data limit, 3: Variable - costed on per byte basic) Default behavior: Unrestricted.
<!-- Device-Profile-{SSID}-WiFiCost-Description-End -->
<!-- Device-Profile-{SSID}-WiFiCost-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-WiFiCost-Editable-End -->
<!-- Device-Profile-{SSID}-WiFiCost-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Add, Delete, Get, Replace |
| Default Value | 1 |
<!-- Device-Profile-{SSID}-WiFiCost-DFProperties-End -->
<!-- Device-Profile-{SSID}-WiFiCost-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| 1 (Default) | Unrestricted - unlimited connection. |
| 2 | Fixed - capacity constraints up to a certain data limit. |
| 3 | Variable - paid on per byte basic. |
<!-- Device-Profile-{SSID}-WiFiCost-AllowedValues-End -->
<!-- Device-Profile-{SSID}-WiFiCost-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-WiFiCost-Examples-End -->
<!-- Device-Profile-{SSID}-WiFiCost-End -->
<!-- Device-Profile-{SSID}-WlanXml-Begin -->
#### Device/Profile/{SSID}/WlanXml
<!-- Device-Profile-{SSID}-WlanXml-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-Profile-{SSID}-WlanXml-Applicability-End -->
<!-- Device-Profile-{SSID}-WlanXml-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/WiFi/Profile/{SSID}/WlanXml
```
<!-- Device-Profile-{SSID}-WlanXml-OmaUri-End -->
<!-- Device-Profile-{SSID}-WlanXml-Description-Begin -->
<!-- Description-Source-DDF -->
XML describing the network configuration and follows Windows WLAN_profile schema.
Link to schema: <https://msdn.microsoft.com/library/windows/desktop/ms707341(v=vs.85).aspx>
<!-- Device-Profile-{SSID}-WlanXml-Description-End -->
<!-- Device-Profile-{SSID}-WlanXml-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The profile XML must be escaped, as shown in the examples below. The profile XML must be escaped, as shown in the examples below.
If it exists in the blob, the **keyType** and **protected** elements must come before **keyMaterial**, as shown in the example in [WPA2-Personal Profile Sample](/windows/win32/nativewifi/wpa2-personal-profile-sample). If it exists in the blob, the **keyType** and **protected** elements must come before **keyMaterial**, as shown in the example in [WPA2-Personal Profile Sample](/windows/win32/nativewifi/wpa2-personal-profile-sample).
> [!NOTE] > [!NOTE]
> If you need to specify other advanced conditions, such as specifying criteria for certificates that can be used by the Wi-Fi profile, you can do so by specifying this through the EapHostConfig portion of the WlanXML. For more information, see [EAP configuration](./eap-configuration.md). > If you need to specify other advanced conditions, such as specifying criteria for certificates that can be used by the Wi-Fi profile, you can do so by specifying this through the EapHostConfig portion of the WlanXML. For more information, see [EAP configuration](./eap-configuration.md).
<!-- Device-Profile-{SSID}-WlanXml-Editable-End -->
The supported operations are Add, Get, Delete, and Replace. <!-- Device-Profile-{SSID}-WlanXml-DFProperties-Begin -->
**Description framework properties**:
<a href="" id="proxy"></a>**Proxy** | Property name | Property value |
Don't use. Using this configuration in Windows 10 client editions will result in failure. |:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Profile-{SSID}-WlanXml-DFProperties-End -->
<!-- 12.16.2021 mandia: Commenting out, as this CSP is specific to Windows 10 Mobile. <!-- Device-Profile-{SSID}-WlanXml-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Profile-{SSID}-WlanXml-Examples-End -->
Optional. Specifies the configuration of the network proxy. A proxy server host and port can be specified per connection for Windows 10 Mobile. This proxy configuration is only supported in Windows 10 Mobile. Using this configuration in Windows 10 for desktop editions will result in failure. <!-- Device-Profile-{SSID}-WlanXml-End -->
The format is *host:port*, where host can be one of the following: <!-- User-Profile-Begin -->
## User/Profile
- A registered host name, such as server name, FQDN, or Single Label Name, such as myweb instead of myweb.contoso.com. <!-- User-Profile-Applicability-Begin -->
- IPV4 address | Scope | Editions | Applicable OS |
- IPv6/IPvFuture address. |:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- User-Profile-Applicability-End -->
If it's an IPvFuture address, then it must be specified as an IP literal as "\[" (IP v6 address / IPvFuture ) "\]", such as "\[2441:4880:28:3:204:76ff:f43f:6eb\]:8080". <!-- User-Profile-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile
```
<!-- User-Profile-OmaUri-End -->
Supported operations are Get, Add, Delete, and Replace. <!-- User-Profile-Description-Begin -->
--> <!-- Description-Source-DDF -->
Identifies the Wi-Fi network configuration. Each Wi-Fi network configuration is represented by a profile object. This network profile includes all the information required for the device to connect to that network - for example, the SSID, authentication and encryption methods and passphrase in case of WEP or WPA2 networks.
<!-- User-Profile-Description-End -->
<a href="" id="disableinternetconnectivitychecks"></a>**DisableInternetConnectivityChecks** <!-- User-Profile-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-Profile-Editable-End -->
> [!Note] <!-- User-Profile-DFProperties-Begin -->
> This node has been deprecated since Windows 10, version 1607. **Description framework properties**:
Added in Windows 10, version 1511. Optional. Disable the internet connectivity check for the profile. | Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- User-Profile-DFProperties-End -->
Value type is chr. <!-- User-Profile-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-Examples-End -->
- True - internet connectivity check is disabled. <!-- User-Profile-End -->
- False - internet connectivity check is enabled.
Supported operations are Get, Add, Delete, and Replace. <!-- User-Profile-{SSID}-Begin -->
### User/Profile/{SSID}
<a href="" id="proxypacurl"></a>**ProxyPacUrl** <!-- User-Profile-{SSID}-Applicability-Begin -->
Don't use. Using this configuration in Windows 10 client editions will result in failure. | Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- User-Profile-{SSID}-Applicability-End -->
<!-- 12.16.2021 mandia: Commenting out, as this CSP is specific to Windows 10 Mobile. <!-- User-Profile-{SSID}-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}
```
<!-- User-Profile-{SSID}-OmaUri-End -->
Added in Windows 10, version 1607. Optional. Specifies the value of the URL to the Proxy auto-config (PAC) file location. This proxy configuration is only supported in Windows 10 Mobile. <!-- User-Profile-{SSID}-Description-Begin -->
<!-- Description-Source-DDF -->
The Profile name of the Wi-Fi network. This is added when WlanXml node is added and deleted when WlanXml is deleted.
<!-- User-Profile-{SSID}-Description-End -->
Value type is chr, e.g. http://www.contoso.com/wpad.dat. <!-- User-Profile-{SSID}-Editable-Begin -->
--> <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
Specifies the name of the Wi-Fi network (32 bytes maximum) to create, configure, query, or delete. The name is case sensitive and can be represented in ASCII.
<a href="" id="proxywpad"></a>**ProxyWPAD** SSID is the name of network you're connecting to, while Profile name is the name of the Profile that contains the WiFi settings information. If the Profile name isn't set right in the MDM SyncML, as per the information in the WiFi settings XML, it could lead to some unexpected errors. For example, `<LocURI>./Vendor/MSFT/WiFi/Profile/<MUST BE NAME OF PROFILE AS PER WIFI XML>/WlanXml</LocURI>`.
Don't use. Using this configuration in Windows 10 client editions will result in failure. <!-- User-Profile-{SSID}-Editable-End -->
<!-- 12.16.2021 mandia: Commenting out, as this CSP is specific to Windows 10 Mobile. <!-- User-Profile-{SSID}-DFProperties-Begin -->
**Description framework properties**:
Added in Windows 10, version 1607. Optional. When set to true it enables Web Proxy Auto-Discovery Protocol (WPAD) for proxy lookup.This proxy configuration is only supported in Windows 10 Mobile. | Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get, Replace |
| Atomic Required | True |
| Dynamic Node Naming | ServerGeneratedUniqueIdentifier |
<!-- User-Profile-{SSID}-DFProperties-End -->
Value type is bool. <!-- User-Profile-{SSID}-Examples-Begin -->
--> <!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-Examples-End -->
<a href="" id="wificost"></a>**WiFiCost** <!-- User-Profile-{SSID}-End -->
Added in Windows 10, version 1809. Optional. This policy sets the cost of WLAN connection for the Wi-Fi profile. Default behavior: Unrestricted.
Supported values: <!-- User-Profile-{SSID}-ProfileSource-Begin -->
#### User/Profile/{SSID}/ProfileSource
- 1 - Unrestricted - unlimited connection <!-- User-Profile-{SSID}-ProfileSource-Applicability-Begin -->
- 2 - Fixed - capacity constraints up to a certain data limit | Scope | Editions | Applicable OS |
- 3 - Variable - paid on per byte basic |:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 22H2 [10.0.22621] and later |
<!-- User-Profile-{SSID}-ProfileSource-Applicability-End -->
Supported operations are Add, Get, Replace and Delete. Value type is integer. <!-- User-Profile-{SSID}-ProfileSource-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/ProfileSource
```
<!-- User-Profile-{SSID}-ProfileSource-OmaUri-End -->
<!-- User-Profile-{SSID}-ProfileSource-Description-Begin -->
<!-- Description-Source-DDF -->
Allows for defining which administrative entity is setting this Wi-Fi profile. This can currently be set to either 0=Enterprise or 1=Mobile Operator.
<!-- User-Profile-{SSID}-ProfileSource-Description-End -->
<!-- User-Profile-{SSID}-ProfileSource-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-ProfileSource-Editable-End -->
<!-- User-Profile-{SSID}-ProfileSource-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 0 |
<!-- User-Profile-{SSID}-ProfileSource-DFProperties-End -->
<!-- User-Profile-{SSID}-ProfileSource-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| 0 (Default) | Enterprise. |
| 1 | Mobile Operator. |
<!-- User-Profile-{SSID}-ProfileSource-AllowedValues-End -->
<!-- User-Profile-{SSID}-ProfileSource-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-ProfileSource-Examples-End -->
<!-- User-Profile-{SSID}-ProfileSource-End -->
<!-- User-Profile-{SSID}-Proxy-Begin -->
#### User/Profile/{SSID}/Proxy
<!-- User-Profile-{SSID}-Proxy-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- User-Profile-{SSID}-Proxy-Applicability-End -->
<!-- User-Profile-{SSID}-Proxy-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/Proxy
```
<!-- User-Profile-{SSID}-Proxy-OmaUri-End -->
<!-- User-Profile-{SSID}-Proxy-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. The format is url:port. Configuration of the network proxy (if any).
<!-- User-Profile-{SSID}-Proxy-Description-End -->
<!-- User-Profile-{SSID}-Proxy-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-Proxy-Editable-End -->
<!-- User-Profile-{SSID}-Proxy-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- User-Profile-{SSID}-Proxy-DFProperties-End -->
<!-- User-Profile-{SSID}-Proxy-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-Proxy-Examples-End -->
<!-- User-Profile-{SSID}-Proxy-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-Begin -->
#### User/Profile/{SSID}/ProxyPacUrl
<!-- User-Profile-{SSID}-ProxyPacUrl-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later |
<!-- User-Profile-{SSID}-ProxyPacUrl-Applicability-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/ProxyPacUrl
```
<!-- User-Profile-{SSID}-ProxyPacUrl-OmaUri-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. URL to the PAC file location.
<!-- User-Profile-{SSID}-ProxyPacUrl-Description-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
> [!NOTE]
> Don't use. Using this configuration in Windows 10 client editions will result in failure.
<!-- User-Profile-{SSID}-ProxyPacUrl-Editable-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- User-Profile-{SSID}-ProxyPacUrl-DFProperties-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-ProxyPacUrl-Examples-End -->
<!-- User-Profile-{SSID}-ProxyPacUrl-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-Begin -->
#### User/Profile/{SSID}/ProxyWPAD
<!-- User-Profile-{SSID}-ProxyWPAD-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later |
<!-- User-Profile-{SSID}-ProxyWPAD-Applicability-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/ProxyWPAD
```
<!-- User-Profile-{SSID}-ProxyWPAD-OmaUri-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. The presence of the field enables WPAD for proxy lookup.
<!-- User-Profile-{SSID}-ProxyWPAD-Description-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
> [!NOTE]
> Don't use. Using this configuration in Windows 10 client editions will result in failure.
<!-- User-Profile-{SSID}-ProxyWPAD-Editable-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | bool |
| Access Type | Add, Delete, Get, Replace |
<!-- User-Profile-{SSID}-ProxyWPAD-DFProperties-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| false | Disable WPAD for proxy lookup. |
| true | Enable WPAD for proxy lookup. |
<!-- User-Profile-{SSID}-ProxyWPAD-AllowedValues-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-ProxyWPAD-Examples-End -->
<!-- User-Profile-{SSID}-ProxyWPAD-End -->
<!-- User-Profile-{SSID}-WiFiCost-Begin -->
#### User/Profile/{SSID}/WiFiCost
<!-- User-Profile-{SSID}-WiFiCost-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1809 [10.0.17763] and later |
<!-- User-Profile-{SSID}-WiFiCost-Applicability-End -->
<!-- User-Profile-{SSID}-WiFiCost-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/WiFiCost
```
<!-- User-Profile-{SSID}-WiFiCost-OmaUri-End -->
<!-- User-Profile-{SSID}-WiFiCost-Description-Begin -->
<!-- Description-Source-DDF -->
Optional node. If the policy is active selecting one of the values from the following list will set the cost of WLAN connection for the Wi-Fi profile. (1:Unrestricted - unlimited connection, 2: Fixed - capacity constraints up to a certain data limit, 3: Variable - costed on per byte basic) Default behavior: Unrestricted.
<!-- User-Profile-{SSID}-WiFiCost-Description-End -->
<!-- User-Profile-{SSID}-WiFiCost-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-WiFiCost-Editable-End -->
<!-- User-Profile-{SSID}-WiFiCost-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Add, Delete, Get, Replace |
| Default Value | 1 |
<!-- User-Profile-{SSID}-WiFiCost-DFProperties-End -->
<!-- User-Profile-{SSID}-WiFiCost-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| 1 (Default) | Unrestricted - unlimited connection. |
| 2 | Fixed - capacity constraints up to a certain data limit. |
| 3 | Variable - paid on per byte basic. |
<!-- User-Profile-{SSID}-WiFiCost-AllowedValues-End -->
<!-- User-Profile-{SSID}-WiFiCost-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-WiFiCost-Examples-End -->
<!-- User-Profile-{SSID}-WiFiCost-End -->
<!-- User-Profile-{SSID}-WlanXml-Begin -->
#### User/Profile/{SSID}/WlanXml
<!-- User-Profile-{SSID}-WlanXml-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- User-Profile-{SSID}-WlanXml-Applicability-End -->
<!-- User-Profile-{SSID}-WlanXml-OmaUri-Begin -->
```User
./User/Vendor/MSFT/WiFi/Profile/{SSID}/WlanXml
```
<!-- User-Profile-{SSID}-WlanXml-OmaUri-End -->
<!-- User-Profile-{SSID}-WlanXml-Description-Begin -->
<!-- Description-Source-DDF -->
XML describing the network configuration and follows Windows WLAN_profile schema.
Link to schema: <https://msdn.microsoft.com/library/windows/desktop/ms707341(v=vs.85).aspx>
<!-- User-Profile-{SSID}-WlanXml-Description-End -->
<!-- User-Profile-{SSID}-WlanXml-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The profile XML must be escaped, as shown in the examples below.
If it exists in the blob, the **keyType** and **protected** elements must come before **keyMaterial**, as shown in the example in [WPA2-Personal Profile Sample](/windows/win32/nativewifi/wpa2-personal-profile-sample).
> [!NOTE]
> If you need to specify other advanced conditions, such as specifying criteria for certificates that can be used by the Wi-Fi profile, you can do so by specifying this through the EapHostConfig portion of the WlanXML. For more information, see [EAP configuration](./eap-configuration.md).
<!-- User-Profile-{SSID}-WlanXml-Editable-End -->
<!-- User-Profile-{SSID}-WlanXml-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- User-Profile-{SSID}-WlanXml-DFProperties-End -->
<!-- User-Profile-{SSID}-WlanXml-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-Profile-{SSID}-WlanXml-Examples-End -->
<!-- User-Profile-{SSID}-WlanXml-End -->
<!-- WiFi-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
## Examples ## Examples
These XML examples show how to perform various tasks using OMA DM. These XML examples show how to perform various tasks using OMA DM.
### Add a network ### Add a network
The following example shows how to add PEAP-MSCHAPv2 network with SSID 'MyNetwork,'. The following example shows how to add PEAP-MSCHAPv2 network with SSID 'MyNetwork'.
```xml ```xml
<SyncML xmlns="SYNCML:SYNCML1.2"> <SyncML xmlns="SYNCML:SYNCML1.2">
@ -210,7 +836,7 @@ The following example shows the response.
### Remove a network ### Remove a network
The following example shows how to remove a network with SSID ‘MyNetwork’ and no proxy. Removing all network authentication types is done in this same manner. The following example shows how to remove a network with SSID 'MyNetwork' and no proxy. Removing all network authentication types is done in this same manner.
```xml ```xml
<Atomic> <Atomic>
@ -228,7 +854,7 @@ The following example shows how to remove a network with SSID ‘MyNetwork’ an
### Add a network and certification authority for a server certificate ### Add a network and certification authority for a server certificate
The following example shows how to add PEAP-MSCHAPv2 network with SSID ‘MyNetwork’ and root CA validation for server certificate. The following example shows how to add PEAP-MSCHAPv2 network with SSID 'MyNetwork' and root CA validation for server certificate.
```xml ```xml
<Atomic> <Atomic>
@ -247,7 +873,10 @@ The following example shows how to add PEAP-MSCHAPv2 network with SSID ‘MyNetw
</Add> </Add>
</Atomic> </Atomic>
``` ```
<!-- WiFi-CspMoreInfo-End -->
## Related topics <!-- WiFi-End -->
[Configuration service provider reference](index.yml) ## Related articles
[Configuration service provider reference](configuration-service-provider-reference.md)

522
windows/client-management/mdm/wifi-ddf-file.md
View File

@ -1,37 +1,32 @@
--- ---
title: WiFi DDF file title: WiFi DDF file
description: Learn about the OMA DM device description framework (DDF) for the WiFi configuration service provider (CSP). description: View the XML file containing the device description framework (DDF) for the WiFi configuration service provider.
ms.reviewer: author: vinaypamnani-msft
manager: aaroncz manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 06/28/2018
--- ---
<!-- Auto-Generated CSP Document -->
# WiFi DDF file # WiFi DDF file
> [!WARNING] The following XML file contains the device description framework (DDF) for the WiFi configuration service provider.
> Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This topic shows the OMA DM device description framework (DDF) for the **WiFi** configuration service provider. DDF files are used only with OMA DM provisioning XML.
The XML below is for Windows 10, version 1809 and later.
```xml ```xml
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" <!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"[<?oma-dm-ddf-ver supported-versions="1.2"?>]>
"http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"
[
<?oma-dm-ddf-ver supported-versions="1.2"?>
]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM"> <MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD> <VerDTD>1.2</VerDTD>
<MSFT:Diagnostics>
</MSFT:Diagnostics>
<Node> <Node>
<NodeName>WiFi</NodeName> <NodeName>WiFi</NodeName>
<Path>./Vendor/MSFT</Path> <Path>./User/Vendor/MSFT</Path>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get /> <Get />
@ -46,8 +41,13 @@ The XML below is for Windows 10, version 1809 and later.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<MIME>com.microsoft/1.1/MDM/WiFi</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.10586</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.0</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
</MSFT:Applicability>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>Profile</NodeName> <NodeName>Profile</NodeName>
@ -55,6 +55,7 @@ The XML below is for Windows 10, version 1809 and later.
<AccessType> <AccessType>
<Get /> <Get />
</AccessType> </AccessType>
<Description>Identifies the Wi-Fi network configuration. Each Wi-Fi network configuration is represented by a profile object. This network profile includes all the information required for the device to connect to that network – for example, the SSID, authentication and encryption methods and passphrase in case of WEP or WPA2 networks.</Description>
<DFFormat> <DFFormat>
<node /> <node />
</DFFormat> </DFFormat>
@ -65,11 +66,12 @@ The XML below is for Windows 10, version 1809 and later.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName></NodeName> <NodeName>
</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Add /> <Add />
@ -77,7 +79,7 @@ The XML below is for Windows 10, version 1809 and later.
<Get /> <Get />
<Replace /> <Replace />
</AccessType> </AccessType>
<Description>The Profile name of the Wi-Fi network. This is added when WlanXML node is added and deleted when Wlanxml is deleted.</Description> <Description>The Profile name of the Wi-Fi network. This is added when WlanXml node is added and deleted when WlanXml is deleted.</Description>
<DFFormat> <DFFormat>
<node /> <node />
</DFFormat> </DFFormat>
@ -89,8 +91,12 @@ The XML below is for Windows 10, version 1809 and later.
</Scope> </Scope>
<DFTitle>SSID</DFTitle> <DFTitle>SSID</DFTitle>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:ServerGeneratedUniqueIdentifier />
</MSFT:DynamicNodeNaming>
<MSFT:AtomicRequired />
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>WlanXml</NodeName> <NodeName>WlanXml</NodeName>
@ -103,7 +109,7 @@ The XML below is for Windows 10, version 1809 and later.
</AccessType> </AccessType>
<Description> <Description>
XML describing the network configuration and follows Windows WLAN_profile schema. XML describing the network configuration and follows Windows WLAN_profile schema.
Link to schema: https://msdn.microsoft.com/library/windows/desktop/ms707341(v=vs.85).aspx Link to schema: http://msdn.microsoft.com/en-us/library/windows/desktop/ms707341(v=vs.85).aspx
</Description> </Description>
<DFFormat> <DFFormat>
<chr /> <chr />
@ -115,16 +121,480 @@ The XML below is for Windows 10, version 1809 and later.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
</DFProperties> </DFProperties>
</Node> </Node>
<Node>
<NodeName>Proxy</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. The format is url:port. Configuration of the network proxy (if any).</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<CaseSense>
<CIS />
</CaseSense>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProxyPacUrl</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. URL to the PAC file location.</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<CaseSense>
<CIS />
</CaseSense>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.14393</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProxyWPAD</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. The presence of the field enables WPAD for proxy lookup.</Description>
<DFFormat>
<bool />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.14393</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>false</MSFT:Value>
<MSFT:ValueDescription>Disable WPAD for proxy lookup.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>true</MSFT:Value>
<MSFT:ValueDescription>Enable WPAD for proxy lookop.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>WiFiCost</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>1</DefaultValue>
<Description>Optional node. If the policy is active selecting one of the values from the following list will set the cost of WLAN connection for the Wi-Fi profile. (1:Unrestricted - unlimited connection, 2: Fixed - capacity constraints up to a certain data limit, 3: Variable - costed on per byte basic) Default behaviour: Unrestricted</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>Unrestricted - unlimited connection.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>2</MSFT:Value>
<MSFT:ValueDescription>Fixed - capacity constraints up to a certain data limit.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>3</MSFT:Value>
<MSFT:ValueDescription>Variable - paid on per byte basic.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProfileSource</NodeName>
<DFProperties>
<AccessType>
<Get />
<Replace />
</AccessType>
<DefaultValue>0</DefaultValue>
<Description>Allows for defining which administrative entity is setting this Wi-Fi profile. This can currently be set to either 0=Enterprise or 1=Mobile Operator.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.22621</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>0</MSFT:Value>
<MSFT:ValueDescription>Enterprise</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>Mobile Operator</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node>
</Node>
</Node>
<Node>
<NodeName>WiFi</NodeName>
<Path>./Device/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.10586</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.0</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
</MSFT:Applicability>
</DFProperties>
<Node>
<NodeName>Profile</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Identifies the Wi-Fi network configuration. Each Wi-Fi network configuration is represented by a profile object. This network profile includes all the information required for the device to connect to that network – for example, the SSID, authentication and encryption methods and passphrase in case of WEP or WPA2 networks.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>
</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>The Profile name of the Wi-Fi network. This is added when WlanXml node is added and deleted when WlanXml is deleted.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<ZeroOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>SSID</DFTitle>
<DFType>
<DDFName />
</DFType>
<MSFT:DynamicNodeNaming>
<MSFT:ServerGeneratedUniqueIdentifier />
</MSFT:DynamicNodeNaming>
<MSFT:AtomicRequired />
</DFProperties>
<Node>
<NodeName>WlanXml</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>
XML describing the network configuration and follows Windows WLAN_profile schema.
Link to schema: http://msdn.microsoft.com/en-us/library/windows/desktop/ms707341(v=vs.85).aspx
</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>Proxy</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. The format is url:port. Configuration of the network proxy (if any).</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<CaseSense>
<CIS />
</CaseSense>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProxyPacUrl</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. URL to the PAC file location.</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<CaseSense>
<CIS />
</CaseSense>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.14393</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProxyWPAD</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional node. The presence of the field enables WPAD for proxy lookup.</Description>
<DFFormat>
<bool />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.14393</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>false</MSFT:Value>
<MSFT:ValueDescription>Disable WPAD for proxy lookup.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>true</MSFT:Value>
<MSFT:ValueDescription>Enable WPAD for proxy lookop.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>WiFiCost</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>1</DefaultValue>
<Description>Optional node. If the policy is active selecting one of the values from the following list will set the cost of WLAN connection for the Wi-Fi profile. (1:Unrestricted - unlimited connection, 2: Fixed - capacity constraints up to a certain data limit, 3: Variable - costed on per byte basic) Default behaviour: Unrestricted</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>Unrestricted - unlimited connection.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>2</MSFT:Value>
<MSFT:ValueDescription>Fixed - capacity constraints up to a certain data limit.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>3</MSFT:Value>
<MSFT:ValueDescription>Variable - paid on per byte basic.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>ProfileSource</NodeName>
<DFProperties>
<AccessType>
<Get />
<Replace />
</AccessType>
<DefaultValue>0</DefaultValue>
<Description>Allows for defining which administrative entity is setting this Wi-Fi profile. This can currently be set to either 0=Enterprise or 1=Mobile Operator.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.22621</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>0</MSFT:Value>
<MSFT:ValueDescription>Enterprise</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>Mobile Operator</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node> </Node>
</Node> </Node>
</Node> </Node>
</MgmtTree> </MgmtTree>
``` ```
## Related topics ## Related articles
[WiFi configuration service provider](wifi-csp.md) [WiFi configuration service provider reference](wifi-csp.md)