Cellular Manager

Note: To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

EMDK For Android - 7.4

Overview

The Cellular Manager (CellularMgr) controls the way a device's cellular data connection is used. This CSP is supported only on Zebra Android devices equipped with a Wireless Wide Area Network (WWAN) adapter and access to a cellular data network. Attempts to use the CellularMgr on unsupported devices returns an error in the Result XML document.

The CellularMgr provides the ability to control the State (active/inactive) and Usage (enabled/disabled) of features. An option's "State" can be thought of as an "On/Off" switch; the feature is available to programs or the device user to make active or inactive as desired. The term "Usage" would be like a cover over the switch, locking it in its current position. When Usage of an option has been Disabled, the cover is closed and the position of the switch cannot be changed by the user. Enabling Usage lifts the cover, enabling the device user to control Cellular features.

Main Functionality

  • Enable/Disable (control Usage of):
    • Data Roaming
    • Background Data
    • SIM Slot(s)
    • Change the public land mobile network (PLMN)
    • Cellular Data
    • Cellular Data Limit
  • Turn On/Off (control State of):
    • Data Roaming
    • Background Data
    • Cellular Data
    • Cellular Data Limit
  • Enter a custom cellular data limit and warning threshold
  • Select SIM Slot
  • Lock the device to:
    • A specific public land mobile network (PLMN)
    • A specific Mobile Network Operator
    • An individual ICCID (SIM card)
    • Access only by a service technician
  • Set the number of unlock retries before service is required to unlock
  • Enter a list of acceptable Mobile Country Codes/Mobile Network Operator (MCC/MNO)
  • Store and erase Lock and Unlock codes
  • Show/hide PLMN user interface controls

SIM Socket Usage Enable/Disable

Controls whether the device user can change the selected SIM Socket using the Select SIM Socket parameter. When Disabled, the SIM Socket cannot be selected by the device user. Supported on specific Zebra devices only.

Note: Supported only on WWAN-enabled devices with more than one SIM socket.

Parm Name: SimSocketUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to user control over SIM Socket selection; any previously selected setting is retained.

MX: 6.2+

1 Enable Enables the device user to control which SIM Socket is used.

MX: 6.2+

2 Disable Prevents the user from changing the selected SIM Socket.

MX: 6.2+

Select SIM Socket

Used to select which SIM card is used to connect the device to the carrier network. Supported on specific Zebra devices only.

Note: Supported only on WWAN-enabled devices with more than one SIM socket.

Parm Name: SimSocketSelect

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change; the previously selected SIM socket is used.

MX: 6.2+

1 SIM1 Uses SIM1 to connect the device to the carrier network.

MX: 6.2+

2 SIM2 Uses SIM2 to connect the device to the carrier network.

MX: 6.2+

3 SIM3 Uses SIM3 to connect the device to the carrier network.

MX: 6.2+

4 SIM4 Uses SIM4 to connect the device to the carrier network.

MX: 6.2+

Dual-SIM Dual Standby Enable/Disable

Controls Dual-SIM Dual Standby (DSDS) mode. When enabled, both SIMs can make or receive calls and/or be designated primary/secondary or dedicated to voice/data, etc. Disabled by default (one SIM active a time).

NOTE: Supported on SD660-platform devices with dual SIM slot. Reboot required to change setting.

Note: Supported only on WWAN-enabled SD660-platform devices with dual SIM slot. Settings changes require reboot.

Parm Name: DsdsUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to cellular settings; any previously selected setting is retained.

MX: 8.1+

1 Enable Sets device to Dual-SIM, Dual Standby mode, enabling both SIMs to be active simultaneously.

MX: 8.1+

2 Disable Sets device to Dual-SIM, Single Standby mode, which allows only one active SIM at a time (default).

MX: 8.1+

Data Roaming Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of Data Roaming on the device. When Enabled, Data Roaming can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

The Data Roaming option determines whether a device can communicate over cellular data networks other than the "home" network provided by the mobile operator with which the active SIM card is affiliated. The convenience of communicating over "foreign" networks while roaming must be weighed against the roaming charges imposed by foreign carriers.

Note: Supported on WWAN-enabled devices only.

Parm Name: DataRoamingUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to usage of the Data Roaming Option; any previously selected setting is retained.

OSX: 4.4+

MX: 4.4+

1 Enable Enables the device user to control the state of Data Roaming (active/inactive) on the device.

OSX: 4.4+

MX: 4.4+

2 Disable Prevents the device user from changing the state (active/inactive) of Data Roaming on the device; state can still be controlled programmatically.

OSX: 4.4+

MX: 4.4+

Data Roaming On/Off

This is the On/Off switch for Data Roaming, which gives a device user the option of allowing cellular data connections to be established while a device is outside its "home" network.

Note: Supported on WWAN-enabled devices only.

Parm Name: DataRoamingState

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to the current state of the Data Roaming; any previously selected setting is retained.

MX: 4.3+

Android API: 17+

1 Turn On Turns On Data Roaming, allowing cellular data connections while a device is outside the carrier's home network.

MX: 4.3+

Android API: 17+

2 Turn Off Turns Off Data Roaming, preventing cellular data connections while a device is outside the carrier's home network.

MX: 4.3+

Android API: 17+

Cellular Data Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of cellular data on the device. When Enabled, cellular data can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

Note: Supported on WWAN-enabled devices only.

Parm Name: CellularDataUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

MX: 6.3+

1 Enable Allows the device user to change the state (active/inactive) of cellular data on the device.

MX: 6.3+

2 Disable Prevents the device user from changing the state (active/inactive) of cellular data on the device; state can still be controlled programmatically.

MX: 6.3+

Cellular Data On/Off

This is the On/Off switch for device users or apps to control the ability to establish a cellular data connection on the device. This parameter controls only cellular data; voice and SMS messaging apps are uneffected by this setting.

Note: Supported on WWAN-enabled devices only.

Parm Name: CellularDataState

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

MX: 6.3+

1 Turn On Allows a cellular data connection to be established on the device.

MX: 6.3+

2 Turn Off Prevents a cellular data connection from being established on the device.

MX: 6.3+

Cellular Data Limit Enable/Disable

Controls whether a limit can be placed on cellular data usage on the device. When Enabled, the device user or an app running on the device can access other parameters that turn data limiting on and off and that control the limit value (in MB per month) and the warning message displayed when the limit is reached. If this parameter is Disabled and cellular data is Enabled on the device, there is no means of limiting data usage over the cellular network, and all related parameters are inaccessible by apps or the device user.

Note: Supported on WWAN-enabled devices only.

Parm Name: CellularDataLimitUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

MX: 6.3+

1 Enable Enables a limit to be set on cellular data usage and the state (active/inactive) of the limit to be controlled by the device user.

MX: 6.3+

2 Disable Prevents a limit on cellular data usage from being set on the device.

MX: 6.3+

Cellular Data Limit On/Off

This is the On/Off switch for limiting cellular data (in MB per month) on the device, and the selector for applying the Android-default or a custom limitation. When Enabled using the Android default limit, the limit is the greater of 5GB or 1.2 times the value specified in the Cellular Data Warning Value parameter, to a maximum of 1TB. If the custom limit is selected, the limit is the value specified in the Cellular Data Limit Value parameter. Once the limit is reached, the cellular data connection is terminated until a new month begins or the restriction is lifted. If no value is specified with the Cellular Data Limit Value parameter, this parameter is ignored and the previously selected Cellular Data Limit State is retained.

Note: Supported on WWAN-enabled devices only.

Shown if: Cellular Data State is set to "Enable"

Parm Name: CellularDataLimitState

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

MX: 6.3+

1 Enable and set default limit Limits cellular data usage to the Android default value.

MX: 6.3+

2 Enable and set custom limit Limits cellular data usage to the amount set in the Cellular Data Limit Value parameter.

MX: 6.3+

3 Disable Prevents a limit on cellular data usage from being imposed on the device.

MX: 6.3+

Cellular Data Limit Value

Used to enter the limit (in MB per month) of cellular data usage by the device. Once the limit is reached, the cellular data connection is terminated until a new month begins or the restriction is lifted.

Parm value input rules:

  • Integer from 5-1048576 (5MB-1TB) corresponding to the data usage monthly limit

Note: Supported on WWAN-enabled devices only.

Shown if: Cellular Data State is set to "Enable" and Cellular Data Limit State is set to "Enable and set custom limit"

Parm Name: CellularDataLimitValue

Requires:

  • MX: 6.3+

Cellular Data Warning

Controls whether the device user or an app running on the device can enter a threshold for cellular data usage that triggers a warning.

Note: Supported on WWAN-enabled devices only.

Shown if: Cellular Data State is set to "Turn On"

Parm Name: CellularDataWarning

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

MX: 6.3+

1 Set new warning Enables a data limit warning threshold (in MB) to be specified.

MX: 6.3+

Set Cellular Data Warning

Used to enter a threshold (in MB per month) for cellular data usage after which a warning is displayed on the device.

Parm value input rules:

  • Integer from 5-1048576 (5MB-1TB) corresponding to the data usage limit

Note: Supported on WWAN-enabled devices only.

Shown if: Cellular Data State is set to "Turn On" and Cellular Data Warning is set to "Set new warning"

Parm Name: CellularDataWarningValue

Requires:

  • MX: 6.3+

Background Data Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of the background data usage on the device. When Enabled, background data can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

Background data enablement determines whether applications that are not in the foreground are permitted to maintain a data connection over the cellular network (if they are capable of doing so). For example, some email applications continue to download messages while other apps are active or when the device's screen is turned off. When planning for cellular costs and bandwidth utilization, the convenience of having data ready "when it's asked for" must be weighed against the potential for data overage and roaming costs.

Note: Supported on WWAN-enabled devices only.

Parm Name: BackgroundDataUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

OSX: 4.4+

MX: 4.4+

1 Enable Enables the background data state (active/inactive) to be controlled by the device user.

OSX: 4.4+

MX: 4.4+

2 Disable Prevents the background data state (active/inactive) from being controlled by the device user; state can still be controlled programmatically.

OSX: 4.4+

MX: 4.4+

Background Data Blocking On/Off

This is the On/Off switch for background data communication blocking. When On, apps are allowed to use the cellular data connection only when in the foreground, and blocked at all other times. When Off, all background-capable apps are allowed to maintain a data connection whenever they're running, even if they're not in the foreground.

Note: Supported on WWAN-enabled devices only.

Shown if: Background Data Usage is set to "Enable"

Parm Name: BackgroundDataState

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

OSX: 1.3+

MX: 4.3+

1 Turn On Prevents background-capable apps from using the cellular data connection when the app is not in the foreground.

OSX: 1.3+

MX: 4.3+

2 Turn Off Allows background-capable apps to use the cellular data connection when in the background or the foreground.

OSX: 1.3+

MX: 4.3+

Manual PLMN Enable/Disable

Controls whether the device user can change the selected public land mobile network (PLMN), such as that of a carrier network.

Note: Supported on WWAN-enabled devices only.

Parm Name: ManualPlmnLock

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to celular settings; any previously selected setting is retained.

MX: 8.1+

1 Enable Enables the device user to change the selected PLMN.

MX: 8.1+

2 Disable Prevents the user from chaging the selected PLMN.

MX: 8.1+

Manual PLMN LockSet

Used to enter the PLMN LockSet for use on the device. This number includes the mobile country code (MCC) first, which is always three numerical digits, followed by the mobile network code (MNC), which can be two or three digits. Therefore when combined, entry must be expressed as either a single five- or six-digit number (MCCMNC i.e. XXXYY or XXXYYY).

Parm value input rules:

  • String of 5 or 6 numerical characters

Note: Supported on WWAN-enabled devices only.

Shown if: Manual PLMN Lock is set to "Enable"

Parm Name: ManualPlmnLockSet

Requires:

  • MX: 8.1+

PLMN Lock UI Show/Hide

Controls whether the PLMN locking switch appears in the Android Network Settings panel on the device.

Note: Supported on WWAN-enabled devices only.

Parm Name: ShowPlmnLock

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no change to cellular settings; any previously selected setting is retained.

MX: 8.1+

1 Enable Displays the PLMN locking switch in the Android Network Settings panel.

MX: 8.1+

2 Disable Hides the PLMN locking switch in the Android Network Settings panel.

MX: 8.1+

DA Advanced Features (checkbox)

Controls whether the device administrator (DA) has access to configuration of advanced features:

  • DA Lock Type
  • DA Network Lock
  • DA Unlock code
  • DA Unlock retry count

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: DAAdvancedFeatures

Option Name Description Note Requires
0 (unchecked) Prevents configuration of advanced features.

MX: 9.2+

Android API: 26+

1 (checked) Allows configuration of advanced features.

MX: 9.2+

Android API: 26+

DA Lock Type

Used to select how the device is locked– either to a Mobile Network Operator (MNO) or an Integrated Circuit Card Identifier (ICCID) SIM card serial number.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: DA Network Lock is "Lock" or "Unlock"

Parm Name: DALockType

Option Name Description Note Requires
0 Network Lock Locks the device by MNO.

MX: 9.2+

Android API: 26+

1 ICCID Lock Locks the device by SIM card.

MX: 9.2+

Android API: 26+

Device Admin Network Lock

Used to Lock the device to a specific Mobile Network Operator (MNO) and Unlock it for use on other networks.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: DeviceAdminNetworkLock

Option Name Description Note Requires
1 Lock Locks the MNO.

MX: 9.2+

2 Unlock Unlocks the MNO using a key code.

MX: 9.2+

Retry Count

Used to enter the maximum number of failed attempts to unlock the device, after which the unlock feature is disabled and a service technician is required to re-enable it.

Parm value input rules:

  • String from 1–2 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: DA Network Lock is "Lock" or "Unlock"

Parm Name: RetryCount

Requires:

  • MX: 9.2+
  • Android API: 26+

DA Unlock Code

Used to enter the Device Admin Lock/Unlock Code.

Parm value input rules:

  • String from 1–255 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: DA Network Lock is "Lock" or "Unlock"

Parm Name: DAUnlockCode

Requires:

  • MX: 9.2+
  • Android API: 26+

Enter ICCID

Used to enter the Integrated Circuit Card Identifier (ICCID) number, which uniquely identifies a SIM card.

Parm value input rules:

  • String from 5–255 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: DA Network Lock is "Lock" and DA Lock Type is "ICCID Lock"

Parm Name: Iccid

Requires:

  • MX: 9.2+
  • Android API: 26+

MCC MNC List

Used to enter at least one mobile country code (MCC) and mobile network code (MNC) for use by the device. This number includes the MCC first–which is always three numerical digits–followed by the MNC, which can be two or three digits. Therefore when combined, each entry must be expressed as either a five- or six-digit number (MCCMNC i.e. XXXYY or XXXYYY).

Parm value input rules:

  • String from 5–255 characters
  • Separate multiple values using commas, such as "310410,31090,001001"

Note: Supported on WWAN-enabled devices only.

Shown if: DA Network Lock is "Lock" and DA Lock Type is "Network Lock" or "ICCID Lock"

Parm Name: MccMncList

Requires:

  • MX: 9.2+

MNO Advanced Features (checkbox)

Controls access to configuration of Mobile Metwork Operator (MNO) advanced features:

  • MNO Lock Action
  • MNO Activation ID
  • MNO Unlock Code
  • MNO Control Key
  • MNO Retry Count
  • MNO MCCMNC List

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: MNOAdvancedFeatures

Option Name Description Note Requires
0 (unchecked) Prevents configuration of MNO advanced features.

MX: 9.2+

Android API: 26+

1 (checked) Allows configuration of MNO advanced features.

MX: 9.2+

Android API: 26+

MNO Lock Action

Used to Lock and Unlock the Mobile Network Operator (MNO) on the device using a key code provided by the MNO.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: MNOLockAction

Option Name Description Note Requires
1 Lock Locks the MNO.

MX: 9.2+

2 Unlock Unlocks the MNO.

MX: 9.2+

Lock Codes Store/Erase

Used to manage Mobile Network Operator (MNO) Lock codes stored on the device. Codes provided by the MNO are stored on the device and used to lock and unlock the device's MNO.

Note: Supported on WWAN-enabled devices only.

Parm Name: StoreWipeMNOLock

Option Name Description Note Requires
1 StoreMNOLock Stores key code for locking and unlocking the MNO.

MX: 9.2+

2 WipeMNOLock Erases all MNO lock key codes stored in the device.

MX: 9.2+

MNO Activation ID

Used to enter the license Activation ID to authorize use of MNO advanced features.

Parm value input rules:

  • String from 1–255 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: MNO Lock Action is "Lock"

Parm Name: MNOActivationID

Requires:

  • MX: 9.2+
  • Android API: 26+

MNO Unlock Code

MNOUnlockCode

Used to enter the Integrated Circuit Card Identifier (ICCID) number, which uniquely identifies a SIM card.

Parm value input rules:

  • String from 1–255 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: MNO Lock Action is "Unlock"

Parm Name: MNOUnlockCode

Requires:

  • MX: 9.2+
  • Android API: 26+

MNO Control Key

Used to enter the 16-digit code to be used to Lock the device.

Parm value input rules:

  • String from 1–255 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: MNO Lock Action is "Lock"

Parm Name: MNOControlKey

Requires:

  • MX: 9.2+
  • Android API: 26+

MNO Retry Count

Used to enter the maximum number of failed attempts to unlock the device, after which the unlock feature is disabled and a service technician is required to unlock the device.

Parm value input rules:

  • String from 1–2 characters

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: MNO Lock Action is "Lock"

Parm Name: MNORetryCount

Requires:

  • MX: 9.2+
  • Android API: 26+

MNO MCC MNC List

Used to enter at least one mobile country code (MCC) and mobile network code (MNC) for use by the device. This number includes the MCC first–which is always three numerical digits–followed by the MNC, which can be two or three digits. Therefore when combined, each entry must be expressed as either a five- or six-digit number (MCCMNC i.e. XXXYY or XXXYYY).

Parm value input rules:

  • String from 5–255 characters
  • Separate multiple values using commas, such as "310410,31090,001001"

Note: Supported on WWAN-enabled SDM660-platform devices only.

Shown if: MNO Lock Action is "Lock"

Parm Name: MNOMccMncList

Requires:

  • MX: 9.2+
  • Android API: 26+

Service Tech Features (checkbox)

Controls access to Service Technician Advanced Features:

  • Service Tech Activation ID
  • Import MNO Lock
  • Export MNO Lock
  • Wipe MNO Lock

Note: Supported only on WWAN-enabled devices.

Parm Name: SvcAdvancedFeatures

Option Name Description Note Requires
0 (unchecked) Prevents Service Technician Features from being used.

MX: 9.2+

1 (checked) Allows Service Technician Features to be used.

MX: 9.2+

Service Tech Activation ID

Used to enter the license Activation ID to authorize use of Service Technician Advanced Features.

Parm value input rules:

  • String from 1–255 characters

Note: Supported on WWAN-enabled devices only.

Shown if: Service Tech Advanced Features is "checked"

Parm Name: SvcActivationID

Requires:

  • MX: 9.2+

Import MNO Lock Info (checkbox)

Controls whether to Import and restore Mobile Metwork Operator (MNO) Lock information from an SD card to restore an MNO Lock.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: ImportMNOLock

Option Name Description Note Requires
0 (unchecked) Prevents importation of MNO Lock information.

MX: 9.2+

1 (checked) Allows importation of MNO Lock information.

MX: 9.2+

Export MNO Lock Info (checkbox)

Controls whether Mobile Metwork Operator (MNO) Lock information is saved to internal device storage.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: ExportMNOLock

Option Name Description Note Requires
0 (unchecked) Prevents MNO Lock information from being saved to the SD card.

MX: 9.2+

Android API: 26+

1 (checked) Allows MNO Lock information to be saved to the SD card.

MX: 9.2+

Android API: 26+

Erase MNO Lock Info (checkbox)

Controls whether to remove (erase) the current Mobile Metwork Operator (MNO) Lock information stored internally on the device.

Note: Supported on WWAN-enabled SDM660-platform devices only.

Parm Name: WipeMNOLock

Option Name Description Note Requires
0 (unchecked) Leaves MNO Lock information stored on the device.

MX: 9.2+

1 (checked) Removes MNO Lock information from the device.

MX: 9.2+

Examples

Turn Off Data Roaming and Background Data


<wap-provisioningdoc>
    <characteristic type="CellularMgr" version="4.3" >
        <parm name="DataRoamingState" value="2"/>
        <parm name="BackgroundDataState" value="2"/>
    </characteristic>
</wap-provisioningdoc>