diff --git a/windows/client-management/mdm/policies-in-preview.md b/windows/client-management/mdm/policies-in-preview.md index 6aaae7383f..9be89eb1f4 100644 --- a/windows/client-management/mdm/policies-in-preview.md +++ b/windows/client-management/mdm/policies-in-preview.md @@ -1,7 +1,7 @@ --- title: Configuration service provider preview policies description: Learn more about configuration service provider (CSP) policies that are available for Windows Insider Preview. -ms.date: 04/04/2025 +ms.date: 04/21/2025 ms.topic: generated-reference --- @@ -111,6 +111,17 @@ This article lists the policies that are applicable for Windows Insider Preview - [StartInstallation](language-pack-management-csp.md#installlanguage-idstartinstallation) - [SystemPreferredUILanguages](language-pack-management-csp.md#languagesettingssystempreferreduilanguages) +## LanmanServer + +- [AuditClientDoesNotSupportEncryption](policy-csp-lanmanserver.md#auditclientdoesnotsupportencryption) +- [AuditClientDoesNotSupportSigning](policy-csp-lanmanserver.md#auditclientdoesnotsupportsigning) +- [AuditInsecureGuestLogon](policy-csp-lanmanserver.md#auditinsecureguestlogon) +- [AuthRateLimiterDelayInMs](policy-csp-lanmanserver.md#authratelimiterdelayinms) +- [EnableAuthRateLimiter](policy-csp-lanmanserver.md#enableauthratelimiter) +- [EnableMailslots](policy-csp-lanmanserver.md#enablemailslots) +- [MaxSmb2Dialect](policy-csp-lanmanserver.md#maxsmb2dialect) +- [MinSmb2Dialect](policy-csp-lanmanserver.md#minsmb2dialect) + ## LanmanWorkstation - [AuditInsecureGuestLogon](policy-csp-lanmanworkstation.md#auditinsecureguestlogon) @@ -218,6 +229,22 @@ This article lists the policies that are applicable for Windows Insider Preview - [DisableSubscription](windowslicensing-csp.md#subscriptionsdisablesubscription) - [RemoveSubscription](windowslicensing-csp.md#subscriptionsremovesubscription) +## WirelessNetworkPreference CSP + +- [IsEnabled](wirelessnetworkpreference-csp.md#isenabled) +- [PreferCellularOverWiFi](wirelessnetworkpreference-csp.md#prefercellularoverwifi) +- [eSIMprofilesCount](wirelessnetworkpreference-csp.md#statusesimprofilescount) +- [eSIMprofilesMatched](wirelessnetworkpreference-csp.md#statusesimprofilesmatched) +- [eSIMpolicyStatus](wirelessnetworkpreference-csp.md#statusesimpolicystatus) +- [NetworkDiscoveryOption](wirelessnetworkpreference-csp.md#parameterscellularparametersnetworkdiscoveryoption) +- [MaxRescanIntervalInSeconds](wirelessnetworkpreference-csp.md#parameterscellularparametersmaxrescanintervalinseconds) +- [PreferredProfileWakeConnectionTimerInSeconds](wirelessnetworkpreference-csp.md#parameterscellularparameterspreferredprofilewakeconnectiontimerinseconds) +- [ProfileRegistrationTimerInSeconds](wirelessnetworkpreference-csp.md#parameterscellularparametersprofileregistrationtimerinseconds) +- [ScreenOffDurationToTriggerNetworkDiscoveryInMinutes](wirelessnetworkpreference-csp.md#parameterscellularparametersscreenoffdurationtotriggernetworkdiscoveryinminutes) +- [Priority](wirelessnetworkpreference-csp.md#connectionprofilesconnectionprofileidpriority) +- [WirelessType](wirelessnetworkpreference-csp.md#connectionprofilesconnectionprofileidwirelesstype) +- [PLMNID](wirelessnetworkpreference-csp.md#connectionprofilesconnectionprofileidcellularplmnid) + ## Related articles [Policy configuration service provider](policy-configuration-service-provider.md) diff --git a/windows/client-management/mdm/policy-configuration-service-provider.md b/windows/client-management/mdm/policy-configuration-service-provider.md index d71bb02821..d622986db6 100644 --- a/windows/client-management/mdm/policy-configuration-service-provider.md +++ b/windows/client-management/mdm/policy-configuration-service-provider.md @@ -1,7 +1,7 @@ --- title: Policy CSP description: Learn more about the Policy CSP. -ms.date: 03/12/2025 +ms.date: 04/21/2025 ms.topic: generated-reference --- @@ -1120,6 +1120,7 @@ Specifies the name/value pair used in the policy. See the individual Area DDFs f - [InternetExplorer](policy-csp-internetexplorer.md) - [Kerberos](policy-csp-kerberos.md) - [KioskBrowser](policy-csp-kioskbrowser.md) +- [LanmanServer](policy-csp-lanmanserver.md) - [LanmanWorkstation](policy-csp-lanmanworkstation.md) - [Licensing](policy-csp-licensing.md) - [LocalPoliciesSecurityOptions](policy-csp-localpoliciessecurityoptions.md) diff --git a/windows/client-management/mdm/policy-csp-lanmanserver.md b/windows/client-management/mdm/policy-csp-lanmanserver.md new file mode 100644 index 0000000000..7319615e1f --- /dev/null +++ b/windows/client-management/mdm/policy-csp-lanmanserver.md @@ -0,0 +1,557 @@ +--- +title: LanmanServer Policy CSP +description: Learn more about the LanmanServer Area in Policy CSP. +ms.date: 04/21/2025 +ms.topic: generated-reference +--- + + + + +# Policy CSP - LanmanServer + +[!INCLUDE [Windows Insider tip](includes/mdm-insider-csp-note.md)] + + + + + + +## AuditClientDoesNotSupportEncryption + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/AuditClientDoesNotSupportEncryption +``` + + + + +This policy controls whether the SMB server will log the event when the SMB client doesn't support encryption. + +- If you enable this policy setting, the SMB server will log the event when the SMB client doesn't support encryption. + +- If you disable or don't configure this policy setting, the SMB server won't log the event. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 (Default) | Disabled. | +| 1 | Enabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_AuditClientDoesNotSupportEncryption | +| Friendly Name | Audit client does not support encryption | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| Registry Value Name | AuditClientDoesNotSupportEncryption | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## AuditClientDoesNotSupportSigning + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/AuditClientDoesNotSupportSigning +``` + + + + +This policy controls whether the SMB server will log the event when the SMB client doesn't support signing. + +If you enable this policy setting, the SMB server will log the event when the SMB client doesn't support signing. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 (Default) | Disabled. | +| 1 | Enabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_AuditClientDoesNotSupportSigning | +| Friendly Name | Audit client does not support signing | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| Registry Value Name | AuditClientDoesNotSupportSigning | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## AuditInsecureGuestLogon + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/AuditInsecureGuestLogon +``` + + + + +This policy controls whether the SMB server will enable the audit event when the client is logged-on as guest account. + +- If you enable this policy setting, the SMB server will log the event when the client is logged-on as guest account. + +- If you disable or don't configure this policy setting, the SMB server won't log the event. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 (Default) | Disabled. | +| 1 | Enabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_AuditInsecureGuestLogon | +| Friendly Name | Audit insecure guest logon | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| Registry Value Name | AuditInsecureGuestLogon | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## AuthRateLimiterDelayInMs + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/AuthRateLimiterDelayInMs +``` + + + + +This policy controls whether the SMB server will use a default value in milliseconds for the invalid authentication delay. + +- If you configure this policy setting, the authentication rate limiter will use the specified value for delaying invalid authentication attempts. + +- If you don't configure this policy setting, the authentication rate limiter will use the default value or the value from local registry under HKLM\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[0-10000]` | +| Default Value | 2000 | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_AuthRateLimiterDelayInMs | +| Friendly Name | Set authentication rate limiter delay (milliseconds) | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## EnableAuthRateLimiter + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/EnableAuthRateLimiter +``` + + + + +This policy controls whether the SMB server will enable or disable the authentication rate limiter. + +- If you disable this policy setting, the authentication rate limiter won't be enabled. + +- If you don't configure this policy setting, the authentication rate limiter may still be working depending on the delay settings (the recommended delay value is 2000ms). + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 1 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 | Disabled. | +| 1 (Default) | Enabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_EnableAuthRateLimiter | +| Friendly Name | Enable authentication rate limiter | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| Registry Value Name | EnableAuthRateLimiter | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## EnableMailslots + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/EnableMailslots +``` + + + + +This policy controls whether the SMB server will enable or disable remote mailslots over the computer browser service. + +- If you disable this policy setting, the computer browser service will no longer run as expected. + +- If you don't configure this policy setting, the computer browser may still be working with remote mailslots enabled. + +> [!NOTE] +> This policy requires a Windows reboot to take effect. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 (Default) | Disabled. | +| 1 | Enabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_EnableMailslots | +| Friendly Name | Enable remote mailslots | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\Bowser | +| Registry Value Name | EnableMailslots | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## MaxSmb2Dialect + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/MaxSmb2Dialect +``` + + + + +This policy controls the maximum version of SMB protocol. + +> [!NOTE] +> This group policy doesn't prevent use of SMB 1 if that component is still installed and enabled. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 785 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 514 | SMB 2.0.2. | +| 528 | SMB 2.1.0. | +| 768 | SMB 3.0.0. | +| 770 | SMB 3.0.2. | +| 785 (Default) | SMB 3.1.1. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_MaxSmb2Dialect | +| Friendly Name | Mandate the maximum version of SMB | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + +## MinSmb2Dialect + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100.3613] and later
✅ Windows Insider Preview | + + + +```Device +./Device/Vendor/MSFT/Policy/Config/LanmanServer/MinSmb2Dialect +``` + + + + +This policy controls the minimum version of SMB protocol. + +> [!NOTE] +> This group policy doesn't prevent use of SMB 1 if that component is still installed and enabled. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 514 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 514 (Default) | SMB 2.0.2. | +| 528 | SMB 2.1.0. | +| 768 | SMB 3.0.0. | +| 770 | SMB 3.0.2. | +| 785 | SMB 3.1.1. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | Pol_MinSmb2Dialect | +| Friendly Name | Mandate the minimum version of SMB | +| Location | Computer Configuration | +| Path | Network > Lanman Server | +| Registry Key Name | Software\Policies\Microsoft\Windows\LanmanServer | +| ADMX File Name | LanmanServer.admx | + + + + + + + + + + + + + + +## Related articles + +[Policy configuration service provider](policy-configuration-service-provider.md) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index 28c696c112..51966229d9 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -471,6 +471,8 @@ items: href: policy-csp-kerberos.md - name: KioskBrowser href: policy-csp-kioskbrowser.md + - name: LanmanServer + href: policy-csp-lanmanserver.md - name: LanmanWorkstation href: policy-csp-lanmanworkstation.md - name: Licensing @@ -999,3 +1001,8 @@ items: items: - name: WiredNetwork DDF file href: wirednetwork-ddf-file.md + - name: WirelessNetworkPreference + href: wirelessnetworkpreference-csp.md + items: + - name: WirelessNetworkPreference DDF file + href: wirelessnetworkpreference-ddf-file.md diff --git a/windows/client-management/mdm/wirelessnetworkpreference-csp.md b/windows/client-management/mdm/wirelessnetworkpreference-csp.md new file mode 100644 index 0000000000..b356a16a04 --- /dev/null +++ b/windows/client-management/mdm/wirelessnetworkpreference-csp.md @@ -0,0 +1,844 @@ +--- +title: WirelessNetworkPreference CSP +description: Learn more about the WirelessNetworkPreference CSP. +ms.date: 04/21/2025 +ms.topic: generated-reference +--- + + + + +# WirelessNetworkPreference CSP + +[!INCLUDE [Windows Insider tip](includes/mdm-insider-csp-note.md)] + + + + + + +The following list shows the WirelessNetworkPreference configuration service provider nodes: + +- ./Device/Vendor/MSFT/WirelessNetworkPreference + - [ConnectionProfiles](#connectionprofiles) + - [{ConnectionProfileID}](#connectionprofilesconnectionprofileid) + - [Cellular](#connectionprofilesconnectionprofileidcellular) + - [PLMNID](#connectionprofilesconnectionprofileidcellularplmnid) + - [Priority](#connectionprofilesconnectionprofileidpriority) + - [WirelessType](#connectionprofilesconnectionprofileidwirelesstype) + - [IsEnabled](#isenabled) + - [Parameters](#parameters) + - [CellularParameters](#parameterscellularparameters) + - [MaxRescanIntervalInSeconds](#parameterscellularparametersmaxrescanintervalinseconds) + - [NetworkDiscoveryOption](#parameterscellularparametersnetworkdiscoveryoption) + - [PreferredProfileWakeConnectionTimerInSeconds](#parameterscellularparameterspreferredprofilewakeconnectiontimerinseconds) + - [ProfileRegistrationTimerInSeconds](#parameterscellularparametersprofileregistrationtimerinseconds) + - [ScreenOffDurationToTriggerNetworkDiscoveryInMinutes](#parameterscellularparametersscreenoffdurationtotriggernetworkdiscoveryinminutes) + - [PreferCellularOverWiFi](#prefercellularoverwifi) + - [Status](#status) + - [eSIMpolicyStatus](#statusesimpolicystatus) + - [eSIMprofilesCount](#statusesimprofilescount) + - [eSIMprofilesMatched](#statusesimprofilesmatched) + + + +## ConnectionProfiles + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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 +./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: `[30-360]` | +| Default Value | 60 | + + + + + + + + + +#### Parameters/CellularParameters/ScreenOffDurationToTriggerNetworkDiscoveryInMinutes + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./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 +./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 +./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 +./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 PLMNID. \n 4 = Invalid PLMNID 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 +./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 +./Device/Vendor/MSFT/WirelessNetworkPreference/Status/eSIMprofilesMatched +``` + + + + +Count of operational eSIM profiles stored on the eUICC whose PLMN 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 | + + + + + + + + + + + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/wirelessnetworkpreference-ddf-file.md b/windows/client-management/mdm/wirelessnetworkpreference-ddf-file.md new file mode 100644 index 0000000000..e23616812e --- /dev/null +++ b/windows/client-management/mdm/wirelessnetworkpreference-ddf-file.md @@ -0,0 +1,543 @@ +--- +title: WirelessNetworkPreference DDF file +description: View the XML file containing the device description framework (DDF) for the WirelessNetworkPreference configuration service provider. +ms.date: 04/21/2025 +ms.topic: generated-reference +--- + + + +# WirelessNetworkPreference DDF file + +The following XML file contains the device description framework (DDF) for the WirelessNetworkPreference configuration service provider. + +```xml + +]> + + 1.2 + + + + WirelessNetworkPreference + ./Device/Vendor/MSFT + + + + + Represents information associated with wireless networks prioritization including detailed connectivity priorities for specific cellular networks with a unique PLMN_ID. + + + + + + + + + + + + + + 99.9.99999 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x88;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xBC;0xBF;0xCA;0xCB;0xCD;0xCF;0xD2; + + + + IsEnabled + + + + + + False + It determines whether the wireless connectivity management policy is enabled or not. + + + + + + + + + + + + + + + False + Disable the wireless management policy. + + + True + Enable the wireless management policy. + + + + + + PreferCellularOverWiFi + + + + + + False + 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. + + + + + + + + + + + + + + + False + Prefer Wi-Fi over Cellular. + + + True + Prefer Cellular over Wi-Fi. + + + + + + Status + + + + + Nodes that indicate the status of the wireless connectivity management service. + + + + + + + + + + + + + + + eSIMprofilesCount + + + + + Count of operational eSIM profiles stored in the eUICC. + + + + + + + + + + + + + + + + eSIMprofilesMatched + + + + + Count of operational eSIM profiles stored on the eUICC whose PLMN 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 will not be counted even if there is a match. + + + + + + + + + + + + + + + + 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 PLMNID. \n 4 = Invalid PLMNID 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. + + + + + + + + + + + + + + + + + Parameters + + + + + Parameters to configure the behavior of the wireless connectivity management service. + + + + + + + + + + + + + + + CellularParameters + + + + + Parameters to configure the cellular-specific behavior of the wireless connectivity management service. + + + + + + + + + + + + + + + NetworkDiscoveryOption + + + + + + 0 + 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. + + + + + + + + + + + + + + + 0 + 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. + + + + + + MaxRescanIntervalInSeconds + + + + + + 0 + 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. + + + + + + + + + + + + + + [0-360] + + + + + PreferredProfileWakeConnectionTimerInSeconds + + + + + + 200 + 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. + + + + + + + + + + + + + + [30-360] + + + + + ProfileRegistrationTimerInSeconds + + + + + + 60 + 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. + + + + + + + + + + + + + + [30-360] + + + + + ScreenOffDurationToTriggerNetworkDiscoveryInMinutes + + + + + + 10 + 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. + + + + + + + + + + + + + + [0-30] + + + + + + + ConnectionProfiles + + + + + Profiles to connect to wireless networks in a specified priority order. + + + + + + + + + + + + + + + + + + + + + + + Unique identifier of a network preference policy. Unique ID is auto-generated. + + + + + + + + + + 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. + + + + + + + + + + + + + + [1-2147483647] + + + + + WirelessType + + + + + + + + 0 + Type of wireless network (either Cellular or Wi-Fi). 0 represents Cellular, and 1 represents Wi-Fi. Currently only cellular is supported. + + + + + + + + + + + + + + + 0 + Cellular + + + 1 + Wi-Fi + + + + + + Cellular + + + + + + + Identifiers for cellular networks. + + + + + + + + + + + + + + + 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). + + + + + + + + + + + + + + ^[0-9]{5,6}$ + + + + + + + + +``` + +## Related articles + +[WirelessNetworkPreference configuration service provider reference](wirelessnetworkpreference-csp.md)