40 KiB
title, description, ms.date, ms.topic
| title | description | ms.date | ms.topic |
|---|---|---|---|
| WirelessNetworkPreference CSP | Learn more about the WirelessNetworkPreference CSP. | 04/30/2025 | generated-reference |
WirelessNetworkPreference CSP
[!INCLUDE Windows Insider tip]
The following list shows the WirelessNetworkPreference configuration service provider nodes:
- ./Device/Vendor/MSFT/WirelessNetworkPreference
ConnectionProfiles
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles
Profiles to connect to wireless networks in a specified priority order.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
ConnectionProfiles/{ConnectionProfileID}
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles/{ConnectionProfileID}
Unique identifier of a network preference policy. Unique ID is auto-generated.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | ServerGeneratedUniqueIdentifier |
ConnectionProfiles/{ConnectionProfileID}/Cellular
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles/{ConnectionProfileID}/Cellular
Identifiers for cellular networks.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Add, Delete, Get |
ConnectionProfiles/{ConnectionProfileID}/Cellular/PLMNID
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles/{ConnectionProfileID}/Cellular/PLMNID
5- or 6-digit string identifying a cellular network. It consists of the combination of Mobile Country Code (MCC) and Mobile Network Code (MNC).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
| Allowed Values | Regular Expression: ^[0-9]{5,6}$ |
ConnectionProfiles/{ConnectionProfileID}/Priority
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles/{ConnectionProfileID}/Priority
Priority of a policy compared to the others where 1 represents the highest priority. Thus, the smaller this value is, the higher preference this specific network will receive in establishing a data connection.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Add, Delete, Get, Replace |
| Allowed Values | Range: [1-2147483647] |
ConnectionProfiles/{ConnectionProfileID}/WirelessType
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/ConnectionProfiles/{ConnectionProfileID}/WirelessType
Type of wireless network (either Cellular or Wi-Fi). 0 represents Cellular, and 1 represents Wi-Fi. Currently only cellular is supported.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bin |
| Access Type | Add, Delete, Get, Replace |
| Default Value | 0 |
Allowed values:
| Value | Description |
|---|---|
| 0 (Default) | Cellular. |
| 1 | Wi-Fi. |
IsEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/IsEnabled
It determines whether the wireless connectivity management policy is enabled or not.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
| Default Value | False |
Allowed values:
| Value | Description |
|---|---|
| False (Default) | Disable the wireless management policy. |
| True | Enable the wireless management policy. |
Parameters
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters
Parameters to configure the behavior of the wireless connectivity management service.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
Parameters/CellularParameters
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters
Parameters to configure the cellular-specific behavior of the wireless connectivity management service.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
Parameters/CellularParameters/MaxRescanIntervalInSeconds
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters/MaxRescanIntervalInSeconds
Maximum time (in seconds) from the point that no connection could be established using the permissible eSIM profiles on the device to the start of the next round of network discovery attempts. A smaller interval increases network discovery frequency and can decrease battery life significantly. A value of 0 means that the device is to pick a reasonable interval per its own discretion.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [0-360] |
| Default Value | 0 |
Parameters/CellularParameters/NetworkDiscoveryOption
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters/NetworkDiscoveryOption
Configures which approach should be used in the network discovery process. There are two possible values: (0) no network scan will be performed - rather, registration and connection will be attempted with each eSIM profile in descending order of preference; or (1) Network scan will be performed using the current active eSIM profile. This option works for modems that when performing a network scan show the complete list of available networks independently of which eSIM profile is active.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 0 |
Allowed values:
| Value | Description |
|---|---|
| 0 (Default) | No network scan will be performed -- rather, registration and connection will be attempted with each eSIM profile in descending order of preference. |
| 1 | Network scan will be performed using the current active eSIM profile. |
Parameters/CellularParameters/PreferredProfileWakeConnectionTimerInSeconds
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters/PreferredProfileWakeConnectionTimerInSeconds
When the device is woken from sleep with the most-preferred profile already enabled, this value configures the amount of time (in seconds) before the agent will give up on waiting for connection re-establishment with the most-preferred profile and start network discovery.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [30-360] |
| Default Value | 200 |
Parameters/CellularParameters/ProfileRegistrationTimerInSeconds
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters/ProfileRegistrationTimerInSeconds
When evaluating eSIM profiles for connectivity, this value configures the amount of time (in seconds) that the agent will wait for network registration before considering this profile unsatisfactory and moving on to the next one.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [20-360] |
| Default Value | 30 |
Parameters/CellularParameters/ScreenOffDurationToTriggerNetworkDiscoveryInMinutes
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Parameters/CellularParameters/ScreenOffDurationToTriggerNetworkDiscoveryInMinutes
When the device experiences screen off and back on, this value configures the minimum duration (in minutes) of the screen off period that will trigger network discovery.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [0-30] |
| Default Value | 10 |
PreferCellularOverWiFi
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/PreferCellularOverWiFi
It determines the order of preference between Wi-Fi and cellular networks. When the value is set to "False", Wi-Fi is preferred over cellular. When the value is set to "True", cellular is preferred over Wi-Fi.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
| Default Value | False |
Allowed values:
| Value | Description |
|---|---|
| False (Default) | Prefer Wi-Fi over Cellular. |
| True | Prefer Cellular over Wi-Fi. |
Status
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Status
Nodes that indicate the status of the wireless connectivity management service.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
Status/eSIMpolicyStatus
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Status/eSIMpolicyStatus
An integer indicating the current status of the wireless connectivity management service. If the value is zero, there are no errors. \n\n 0 = No errors. \n 1 = No policies are configured. \n 2 = More than one policy has the same priority. \n 3 = More than one policy references the same PLMN ID. \n 4 = Invalid PLMN ID for one or more of the configured profiles. \n 5 = More than one eSIM profile stored in the eUICC with the same PLMN ID. \n 6 = Invalid configuration value for one or more of the cellular parameters. Please review CSP documentation. \n\n Warning: Any of these errors will result in a complete halt of the wireless connectivity management service.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
Status/eSIMprofilesCount
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Status/eSIMprofilesCount
Count of operational eSIM profiles stored in the eUICC.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
Status/eSIMprofilesMatched
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows Insider Preview |
./Device/Vendor/MSFT/WirelessNetworkPreference/Status/eSIMprofilesMatched
Count of operational eSIM profiles stored on the eUICC whose PLMN ID matches one of the ConnectionProfileIDs setup under the ConnectionProfiles node. Only matched profiles with no errors will be counted. If more than one eSIM profile with the same PLMN ID is configured on the policy and/or more than one eSIM profile with the same PLMN ID is stored in the eUICC, then they won't be counted even if there is a match.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |