Table of contents
TOC
Collapse the table of content
Expand the table of content

CM_CellularEntries CSP

Last Updated: 1/24/2017
Warning

Some information relates to prereleased 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.

The CM_CellularEntries configuration service provider is used to configure the General Packet Radio Service (GPRS) entries on the device. It defines each GSM data access point.

Note

Starting in the next major update to Windows 10, the CM_CellularEntries CSP is supported in Windows 10 Home, Pro, Enterprise, and Education editions.

This configuration service provider requires the ID_CAP_NETWORKING_ADMIN capability to be accessed from a network configuration application.

The following diagram shows the CM_CellularEntries configuration service provider management object in tree format as used by Open Mobile Alliance Client Provisioning (OMA CP). The OMA DM protocol is not supported with this configuration service provider.

cm\-cellularentries csp

entryname

Defines the name of the connection.

The CMPolicy configuration service provider uses the value of entryname to identify the connection that is associated with a policy and CM_ProxyEntries configuration service provider uses the value of entryname to identify the connection that is associated with a proxy.

AlwaysOn

Type: Int. Specifies if the Connection Manager will automatically attempt to connect to the APN when a connection is available.

A value of "0" specifies that AlwaysOn is not supported, and the Connection Manager will only attempt to connect to the APN when an application requests the connection. This setting is recommended for applications that use a connection occasionally, for example, an APN that only controls MMS.

A value of "1" specifies that AlwaysOn is supported, and the Connection Manager will automatically attempt to connect to the APN when it is available. This setting is recommended for general purpose Internet APNs.

There must be at least one AlwaysOn Internet connection provisioned for the mobile operator.

AuthType

Optional. Type: String. Specifies the method of authentication used for a connection.

A value of "CHAP" specifies the Challenge Handshake Application Protocol. A value of "PAP" specifies the Password Authentication Protocol. A value of "None" specifies that the UserName and Password parameters are ignored. The default value is "None".

ConnectionType

Optional. Type: String. Specifies the type of connection used for the APN. The following connection types are available:

gprs

Default. Used for GPRS type connections (GPRS + GSM + EDGE + UMTS + LTE).

cdma

Used for CDMA type connections (1XRTT + EVDO).

lte

Used for LTE type connections (eHRPD + LTE) when the device is registered HOME.

legacy

Used for GPRS + GSM + EDGE + UMTS connections.

lte_iwlan

Used for GPRS type connections that may be offloaded over WiFi

iwlan

Used for connections that are implemented over WiFi offload only

Desc.langid

Optional. Specifies the UI display string used by the defined language ID.

A parameter name in the format of Desc.langid will be used as the language-specific identifier for the specified entry. For example, a parameter defined as Desc.0409 with a value of "GPRS Connection" will force "GPRS Connection" to be displayed in the UI to represent this connection when the device is set to English language (language ID 0409). Descriptions for multiple languages may be provisioned using this mechanism, and the system will automatically switch among them if the user changes language preferences on the device. If no Desc parameter is provisioned for a given language, the system will default to the name used to create the entry.

Enabled

Specifies if the connection is enabled.

A value of "0" specifies that the connection is disabled. A value of "1" specifies that the connection is enabled.

IpHeaderCompression

Optional. Specifies if IP header compression is enabled.

A value of "0" specifies that IP header compression for the connection is disabled. A value of "1" specifies that IP header compression for the connection is enabled.

Password

Required if AuthType is set to a value other than "None". Specifies the password used to connect to the APN.

SwCompression

Optional. Specifies if software compression is enabled.

A value of "0" specifies that software compression for the connection is disabled. A value of "1" specifies that software compression for the connection is enabled.

UserName

Required if AuthType is set to a value other than "None". Specifies the user name used to connect to the APN.

UseRequiresMappingsPolicy

Optional. Specifies if the connection requires a corresponding mappings policy.

A value of "0" specifies that the connection can be used for any general Internet communications. A value of "1" specifies that the connection is only used if a mapping policy is present.

For example, if the multimedia messaging service (MMS) APN should not have any other traffic except MMS, you can configure a mapping policy that sends MMS traffic to this connection. Then, you set the value of UseRequiresMappingsPolicy to be equal to "1" and Connection Manager will only use the connection for MMS traffic. Without this, Connection Manager will try to use the connection for any general purpose Internet traffic.

Version

Type: Int. Specifies the XML version number and is used to verify that the XML is supported by Connection Manager's configuration service provider.

This value must be "1" if included.

GPRSInfoAccessPointName

Specifies the logical name to select the GPRS gateway. For more information about allowable values, see GSM specification 07.07 "10.1.1 Define PDP Context +CGDCONT".

Roaming

Optional. Type: Int. This parameter specifies the roaming conditions under which the connection should be activated. The following conditions are available:

  • 0 - Home network only.
  • 1 (default)- All roaming conditions (home and roaming).
  • 2 - Home and domestic roaming only.
  • 3 - Domestic roaming only.
  • 4 - Non-domestic roaming only.
  • 5 - Roaming only.

OEMConnectionID

Optional. Type: GUID. Specifies a GUID to use to identify a specific connection in the modem. If a value is not specified, the default value is 00000000-0000-0000-0000-000000000000. This parameter is only used on LTE devices.

ApnId

Optional. Type: Int. Specifies the purpose of the APN. If a value is not specified, the default value is "0" (none). This parameter is only used on LTE devices.

IPType

Optional. Type: String. Specifies the network protocol of the connection. Available values are "IPv4", "IPv6", "IPv4v6", and "IPv4v6xlat". If a value is not specified, the default value is "IPv4".

Warning

Do not use IPv6 or IPv4v6xlat on a device or network that does not support IPv6. Data functionality will not work. In addition, the device will not be able to connect to a roaming network that does not support IPv6 unless you configure roaming connections with an IPType of IPv4v6.

ExemptFromDisablePolicy

Added back in Windows 10, version 1511. Optional. Type: Int. This should only be specified for special purpose connections whose applications directly manage their disable state (such as MMS). A value of "0" specifies that the connection is subject to the disable policy used by general purpose connections (not exempt). A value of "1" specifies that the connection is exempt. If a value is not specified, the default value is "0" (not exempt).

To allow MMS when data is set to OFF, set both ExemptFromDisablePolicy and UseRequiresMappingsPolicy to "1". This indicates that the connection is a dedicated MMS connection and that it should not be disabled when all other connections are disabled. As a result, MMS can be sent and received when data is set to OFF. Note that sending MMS while roaming is still not allowed.

Important

Do not set ExemptFromDisablePolicy to "1", ExemptFromRoaming to "1", or UseRequiresMappingsPolicy to "1" for general purpose connections.

To avoid UX inconsistency with certain value combinations of ExemptFromDisablePolicy and AllowMmsIfDataIsOff, when you do not set ExemptFromDisablePolicy to 1 (default is 0), you should:

  • Hide the toggle for AllowMmsIfDataIsOff by setting AllowMmsIfDataIsOffEnabled to 0 (default is 1)
  • Set AllowMMSIfDataIsOff to 1 (default is 0)

ExemptFromRoaming

Added back in Windows 10, version 1511. Optional. Type: Int. This should be specified only for special purpose connections whose applications directly manage their roaming state. It should never be used with general purpose connections. A value of "0" specifies that the connection is subject to the roaming policy (not exempt). A value of "1" specifies that the connection is exempt (unaffected by the roaming policy). If a value is not specified, the default value is "0" (not exempt).

TetheringNAI

Optional. Type: Int. CDMA only. Specifies if the connection is a tethering connection. A value of "0" specifies that the connection is not a tethering connection. A value of "1" specifies that the connection is a tethering connection. If a value is not specified, the default value is "0".

IdleDisconnectTimeout

Optional. Type: Int. Specifies how long an on-demand connection can be unused before Connection Manager tears the connection down. This value is specified in seconds. Valid value range is 5 to 60 seconds. If not specified, the default is 30 seconds.

Important

You must specify the IdleDisconnectTimeout value when updating an on-demand connection to ensure that the desired value is still configured. If it is not specified, the default value of 30 seconds may be used.

Note

If tear-down/activation requests occur too frequently, this value should be set to greater than 5 seconds.

SimIccId

For single SIM phones, this parm is optional. However, it is highly recommended to include this value when creating future updates. For dual SIM phones, this parm is required. Type: String. Specifies the SIM ICCID that services the connection.

PurposeGroups

Optional. Type: String. Specifies the purposes of the connection by a comma-separated list of GUIDs representing purpose values. The following purpose values are available:

  • Internet - 3E5545D2-1137-4DC8-A198-33F1C657515F
  • MMS - 53E2C5D3-D13C-4068-AA38-9C48FF2E55A8
  • IMS - 474D66ED-0E4B-476B-A455-19BB1239ED13
  • SUPL - 6D42669F-52A9-408E-9493-1071DCC437BD
  • Purchase - 95522B2B-A6D1-4E40-960B-05E6D3F962AB (added in the next version of Windows 10)
  • Administrative - 2FFD9261-C23C-4D27-8DCF-CDE4E14A3364 (added in the next version of Windows 10)

Additional information

To delete a connection, you must first delete any associated proxies and then delete the connection. The following example shows how to delete the proxy and then the connection.

<wap-provisioningdoc>
   <characteristic type="CM_ProxyEntries">
      <nocharacteristic type="GPRS_Proxy"/>
   </characteristic>  
   <characteristic type="CM_CellularEntries">
      <nocharacteristic type="GPRS1"/>
   </characteristic>
</wap-provisioningdoc>

OMA client provisioning examples

Configuring a GPRS connection:

<wap-provisioningdoc>
   <characteristic type="CM_CellularEntries">
      <characteristic type="GPRSConn">
         <parm name="ConnectionType" value="gprs" />
         <characteristic type="DevSpecificCellular">
            <parm name="GPRSInfoAccessPointName" value="apn.adatum.com" />
         </characteristic>
         <parm name="AlwaysOn" value="0" />
         <parm name="Enabled" value="1" />
      </characteristic>
   </characteristic>
</wap-provisioningdoc>

Configuring an LTE connection:

<wap-provisioningdoc>
   <characteristic type="CM_CellularEntries">
      <characteristic type="LteConn">
         <parm name="ConnectionType" value="lte" />
         <characteristic type="DevSpecificCellular">
            <parm name="GPRSInfoAccessPointName" value="INTERNET_LTE" />
         </characteristic>
         <parm name="ApnId" value="0" />
         <parm name="IPType" value="IPv4v6" />
         <parm name="Enabled" value="1" />
         <parm name="OemConnectionId" value="01234567-89AB-CDEF-0123-456789ABCDEF" />
      </characteristic> 
   </characteristic>
</wap-provisioningdoc>

Configuring a CDMA connection:

<wap-provisioningdoc>
   <characteristic type="CM_CellularEntries">
      <characteristic type="CDMAConn">
         <parm name="Version" value="1"/>
         <parm name="AuthType" value="chap" />
         <parm name="ConnectionType" value="cdma"/>
         <parm name="Enabled" value="1"/>
         <parm name="AlwaysOn" value="0"/>
         <parm name="UseRequiresMappingsPolicy" value="0"/>
         <parm name="UserName" value="user@adatum.com"/>
         <parm name="Password" value="fakeuserpassword"/>
      </characteristic>
   </characteristic>
</wap-provisioningdoc>

Microsoft Custom Elements

The following table shows the Microsoft custom elements that this configuration service provider supports for OMA Client Provisioning.

ElementAvailable

nocharacteristic

Yes

characteristic-query

Yes

parm-query

Yes

Configuration service provider reference

© 2017 Microsoft