provision

Purpose

Provisions the CDMA module in a Digi device with cellular capability. Provisioning establishes configuration settings in the CDMA module for use in a mobile network. Examples of CDMA-based mobile service providers include Sprint, Verizon, Alltel, and Midwest. The CDMA module must be provisioned before you will be able to create a data connection to the mobile network.

Provisioning needs to be performed once only. It is not necessary for Digi Cellular Family devices that use GSM (Global System for Mobile Communication).

Provisioning is done either from the command line, using this command, or from the web interface, by launching the Mobile Device Provisioning Wizard from the Mobile Configuration page.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to set permissions s‑ppp=read to display provisioning settings, and set permissions s‑ppp=rw to enter the “provision” command with options. See set permissions for details on setting user permissions for commands.

Provisioning types

There are several types of provisioning, each with different sets of parameters. Your mobile service provider can tell you which type is appropriate for your CDMA module.

Simple IP only (SIPONLY).
Mobile IP (MIP), which is a superset of SIPONLY.
IP-Based Over-the-Air (IOTA).
OTASP: Over-the-Air Service Provisioning (OTASP).

Check with your mobile service provider for provisioning parameters

The information that you need to specify during provisioning depends on your CDMA module and the settings that your mobile service provider has given you or already set up in your CDMA module.

Contact your mobile service provider for the most appropriate provisioning type and the required provisioning parameters. Have the ESN (Electronic Serial Number) for your Digi device ready to give to the provider. This number is located on the label on the bottom of the device.

Use “display provisioning” to get current provisioning parameters

You can query for the currently configured provisioning parameters in the CDMA cellular module by entering a display provisioning command.

Important: Close mobile PPP sessions before issuing provisioning commands

The provision and display provisioning commands cannot be used while mobile Point-to-Point Protocol (PPP) sessions are active. To close any existing mobile PPP sessions:

Disable the mobile PPP interface by entering a set mobileppp command with these options:

#> set mobileppp index=index of SIM card (1 or 2) state=disabled

Identify the ID of the mobile PPP session, by issuing a who command. Any active PPP sessions are listed in the Protocol column as ppp [connected]. Note the ID number assigned to the PPP session. In the example below, the active PPP connection has a session ID of 2.

#> who

ID  From                   To                     Protocol              Sessions
--  ---------------------  ---------------------  --------------------  ------
1   serial 1               local shell            term
2   166.130.0.159          166.130.0.154          ppp [connected]
3   166.130.0.159:57078    184.73.237.26:3197     dcloud tcp
4   10.8.16.115            local shell            telnet

Once the session is identified, issue a kill command to end the mobile PPP session, specifying the ID for the mobile PPP session that was displayed in the who command, for example:

#> kill 2

Enter the provision command.

#> provision [command options]

Enable the mobile PPP interface by entering another set mobileppp command:

#> set mobileppp index=index of SIM card (1 or 2) state=enabled

Syntax

Depending on your mobile service provider and the information they have given you, parameters may be required, optional, or preset and not to be changed. Enter phone numbers as numbers only with no dashes; some mobile services providers do not accept dashes in phone numbers.

Display current provisioning parameters

display provisioning

Manually provision the module for a SIP-only network

provision type=siponly
  spc=service programming code (also known as master subsidy lock or MSL) 
  mdn=mobile directory number
 min=mobile ID number

Manually provision the module for a MIP network

provision type=mip
  spc=service programming code (also known as master subsidy lock or MSL)
  mdn=mobile directory number
 min=mobile ID number
 nai=network access id
 aaass=AAA shared secret
 aaasstype={ascii|hex} default=ascii
  ha=home address
 priha=primary host agent IP address
 secha=secondary host agent IP address
 hass=host agent shared secret
 hasstype={ascii|hex} default=ascii
  haspi=index 
  aaaspi=index 
  rtun={0|1}
  profile=MIP profile number

Use IOTA to provision the module

provision type=iota
  spc=service programming code (MSL)(also known as master subsidy lock or MSL)
  mdn=mobile directory number
 min=mobile ID number

Use OTASP to provision the module

provision type=otasp
  otaspnumber=OTASP number - for example, *228 or *22899

Options

SIP-only provisioning parameters

type=siponly

Specifies that the CDMA module is being provisioned using the SIPONLY method.

spc=service programming code (MSL)

A six-digit number required to program CDMA module parameters. This code is also known as a master subsidy lock or MSL.

mdn=mobile directory number

The phone number of the CDMA module.

min=mobile ID number

How the CDMA module is identified in the cellular network. Depending on the cellular provider, this number may be the same as the mobile directory number.

MIP provisioning parameters

type=mip

Specifies that the CDMA module is being provisioned using the MIP method.

nai=network access id

Internet Authentication, Authorization and Accounting (AAA) protocols such as RADIUS or DIAMETER identify users with the Network Access Identifier (NAI). When used with Mobile IP and AAA, the NAI is composed of a username and a realm, separated by the @ character. The username portion identifies the subscriber within the realm. The AAA nodes use the realm portion of the NAI to route AAA requests to the correct AAA server.

aaass=AAA shared secret

The shared secret used in authentication by Internet AAA protocols such as RADIUS or DIAMETER.

The format of the shared secret differs depending on whether it is entered in ASCII or hexadecimal, as specified by the aaasstype option.

If aaasstype=ascii, enter the shared secret as a string in quotation marks.

If aaasstype=hex, enter the shared secret as a hexadecimal number with no leading 0x or trailing h.

aaasstype={ascii|hex} default=ascii

Specifies whether the AAA shared secret is specified in ASCII or hexadecimal form. This option affects how the shared-secret values are specified on the aaass option.

ha=home address

The home address for the CDMA module, specified as an IP address

priha=primary host agent IP address

The IP address of the primary host agent that provides mobile service for the CDMA module.

secha=secondary host agent IP address

The IP address of the secondary host agent that provides mobile service for the CDMA module.

hass=host agent shared secret

The shared secret used for authentication for the host agent.

The format of the shared secret differs depending on whether it is entered in ASCII or hexadecimal, as specified by the hasstype option.

If hasstype=ascii, enter the shared secret as a string in quotation marks.

If hasstype=hex, enter the shared secret as a hexadecimal number with no leading 0x or trailing h.

hasstype={ascii|hex} default=ascii

Specifies whether the host agent shared secret is specified in ASCII or hexadecimal form. This option affects how the shared-secret values are specified on the hass option.

haspi=index
aaaspi=index

A Security Parameter Index (SPI) is an index identifying a security context between a pair of routers among the contexts available in the mobility security association. These are index options that set the security context between the host agent and the AAA server.

rtun= {0|1}

Enables or disables use of reverse tunnelling.

profile=MIP profile number

Specifies which of several profiles, or configuration scenarios, that the cellular module will use when communicating with the cellular network. This is a numeric value; the values available depend on your cellular provider.

IOTA provisioning parameters

type=iota

Specifies that the CDMA module is being provisioned using the IOTA method.