LIST OF COMMANDS

Setting the IMEI Status (MOD IMEI)

Function
Use this command to add, modify, or delete the status information of an IMEI as
well as the information of the action template ID and cause code. The status of
an IMEI can be WhiteList, BlackList, or GreyList.
Note

The parameters IMEI and Name of IMEI file are optional. Specify only
one of them.
If Operation type is set to FALSE, IMEI status, Action template ID and
Cause code are not present.

If Operation type is set to TRUE, IMEI status must be specified.

If Action template ID is set to 65535, the action template set for the
specified IMEI is withdrawn.

Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

IMEIFILE

Name of
IMEI file

Specifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric characters
The IMEI file contains multiple inconsecutive IMEIs.

PROV

Operation Specifies whether to add, modify, or delete the IMEI

type
status information.
Value:

TRUE: Add or modify the IMEI status

information.

STATUS

IMEI
status

FALSE: Delete the IMEI status information.

Specifies the status of the IMEI.

Value:

ACTIONID

Action
template
ID

REASONCODE Cause
code

WhiteList
BlackList

GreyList

Specifies the ID of an action template.

Value range: 0 to 65535
Specifies a cause code.
Value range: 1 to 999

Example
To set the status of the IMEI 77777777123400 to WhiteList with action template
1 and cause code 12, run the following command:
MOD IMEI: IMEI="77777777123400", PROV=TRUE, STATUS=WhiteList,
ACTIONID=1, REASONCODE=12;
Listing the IMEI Status (LST IMEI)
Function
Use this command to query the status information of an IMEI as well as the
information of the action template ID and cause code.
Note
The parameters IMEI and Name of IMEI file are optional. Specify only one of
them.
Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.

Value: a decimal number of 14 digits
IMEIFILE Name of IMEI
file

Specifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric characters
The IMEI file contains multiple inconsecutive IMEIs.

OPTYPE Query type

Specifies the information to be queried.

Value:

CHKIMEI: IMEI status

DETAIL: detailed information about the IMEI

Default value: CHKIMEI

Example
To query the status, action template ID and cause code of the IMEI
77777777123400, run the following command:
LST IMEI: IMEI="77777777123400", OPTYPE=CHKIMEI;
Setting the IMEI Segment Status (MOD IMEIRANGE)
Function
Use this command to add, modify, or delete the status information of one or more
IMEI segments as well as the information of the action template ID and cause
code. The status of the IMEI segments can be WhiteList, BlackList, or GreyList.
Note

The parameters Start IMEI and End IMEI serial number specify an IMEI
segment. You must specify both of them or leave both of them blank
based on the actual condition. The end IMEI serial number must be
greater than the last six digits of the first IMEI.
The parameter Operation type is mandatory.

If Operation type is set to DEL, IMEI segment status, Action template

ID, and Cause code is not present.

If Operation type is set to ADD or MOD, IMEI segment status must be

specified.

Each IMEI segment can be configured with only one state. The IMEI
segments cannot have any intersection.

If Action template ID is set to 65535, the action template set for the
specified IMEI segment is withdrawn.

If you use the BAT command to run this command in batches, the number
of commands contained in the batch operation file must be smaller than
10,000.

Parameters
ID

Name

Description

BEGINIMEI

Start IMEI

Specifies the first IMEI of an IMEI segment.

Value: a decimal number of 14 digits

ENDIMEISN

End IMEI
serial
number

Specifies the serial number of the last IMEI of an

IMEI segment.
Value: a decimal number of 6 digits

IMEIRANGEFILE Name of
Specifies the name of an IMEI segment file.
IMEIRANGE
file
Value: a string of 1 to 16 alphanumeric
characters
The IMEI segment file contains multiple IMEI
segments.
The number of entries contained in the IMEI
segment status file must be smaller than 10,000.
OPTYPE

Operation
type

Specifies whether to add, modify, or delete the

status information of the IMEI segment.
Value:

STATUS

IMEI
segment
status

ADD: Add the status information.

MOD: Modify the status information.

DEL: Delete the status information.

Specifies the status of the IMEI segment.

Value:

ACTIONID

Action
template ID

WhiteList
BlackList

GreyList

Specifies the ID of an action template.

Value range: 0 to 65535

REASONCODE

Cause code Specifies a cause code.

Value range: 1 to 999

Example
To set the status of the IMEI segment ranging from 77777777123400 to
77777777123499 to WhiteList with action template 1 and cause code 12, run
the following command:
MOD IMEIRANGE: BEGINIMEI="77777777123400", ENDIMEISN="123499",
OPTYPE=ADD, STATUS=WhiteList, ACTIONID=1, REASONCODE=12;
Listing the Information of IMEIs and IMEI Segments (LST IMEIRANGE)
Function
Use this command to query information about one or more IMEI segments or
information about the IMEIs in the specified IMEI segmentas well as the
information of the action template ID and cause code.
Note
If the number of queried records exceeds 500, the system prompts you to query
the data by running the LST IMEIDATA command.
Parameters
ID

Name

BEGINIMEI Start IMEI

Description
Specifies the first IMEI of an IMEI segment.
Value: a decimal number of 14 digits

ENDIMEI

End IMEI

Specifies the last IMEI of an IMEI segment.

Value: a decimal number of 14 digits

OPOBJ

Operation
type

Specifies the information to be queried.

Value:

STATUS

COUNT: The number of IMEIs in the entered

number segment and the number of IMEI
number segments those have intersection
with the specified IMEI number segment
SINGLE: The IMEIs in the specified number
segment
RANGE: The IMEI number segments those
have intersection with the specified IMEI
number segment

IMEI segment Specifies the status of the IMEI segment.

status
Value:

WhiteList
BlackList

GreyList

This parameter is optional. If this parameter is not

specified, all the IMEIs in the specified IMEI
segment are displayed.
Example
To list the number of IMEI segments and IMEIs that are in the BlackList state in
the range of 77777722000000-77777822999999, run the following command:
LST IMEIRANGE: BEGINIMEI="77777722000000",
ENDIMEI="77777822999999", OPOBJ = COUNT, STATUS = BlackList;
Modifying the IMEI Status Information (MOD STATUSLIST)
Function
Use this command to modify the status information of the IMEIs or IMEI
segments stored in a status list.
Note
None.

Parameters
ID

Name

OSTATUS Original status

Description
Specifies the original status of the IMEIs or IMEI
segments.
Value:

DSTATUS Destination
status

WhiteList
BlackList

GreyList

Specifies the destination status of the IMEIs or IMEI

segments.
Value:

OPOBJ

Operation
object

WhiteList
BlackList

GreyList

Specifies the object for which the operation needs to

be performed.
Value:

SINGLE: IMEI status list

RANGE: IMEI segment status list

This parameter is mandatory.

Example
To change the status of the IMEIs in the IMEI status list from BlackList to
WhiteList, run the following command:
MOD STATUSLIST: OSTATUS=BlackList, DSTATUS=WhiteList,
OPOBJ=SINGLE;
Listing the IMEI Data (LST IMEIDATA)
Function

Use this command to query the IMEI data based on the specified conditions. The
results are saved in a text file on the PGW board, and the directory is
/opt/pgw/pgwtmpfile/SYSHLRSN+OPNAME. Here, the default length of
SYSHLRSN is 3 bits. For example, when SYSHLRSN=1, OPNAME=admin,
SYSHLRSN+OPNAME is 001admin.
Note

The execution of the LST IMEIDATA command affects the system

performance. You are advised to run this command when the traffic is
light.

Parameters
ID

Name

RESULT Query result

Description
Specifies the information to be queried.
Value:

COND

Query condition

CountOfIMEIStatus: number of IMEI records

DataOfIMEIStatus: information about the IMEI
records

CountOfIMEIRangeStatus: number of IMEI

segment records

DataOfIMEIRangeStatus: information about

the IMEI segment records

Specifies the condition based on which the data

needs to be queried.
Value:

All: Query all the data records.

RangeByIMEI: Query the data records of the
IMEIs in the specified IMEI segment.

RangeByIMEIAndStatus: Query the data

records of the IMEIs that belong to the
specified IMEI segment and meet the
specified state.

Status: Query all the data records that meet

the specified state.

PARA1

Start IMEI

Specifies the first IMEI of an IMEI segment.

Value: a decimal number of 14 digits

PARA2

End IMEI

Specifies the last IMEI of an IMEI segment.

Value: a decimal number of 14 digits

STATUS IMEI/IMEI
segment status

Specifies the status based on which the data needs

to be queried.
Value:

RESULT
CountOfIMEIStatus
(Number of IMEIs)
DataOfIMEIStatus
(IMEI value)

WhiteList
BlackList

GreyList

COND
All (all IMEIs)

PARA PARA
1
2
-

RangeByIMEI (based Start

on the IMEI segment) IMEI
(M)

End
IMEI
(M)

Status (based on the status)

RangeByIMEIAndSta Start
tus (based on the
IMEI
IMEI segment and
(M)
IMEI status)
CountOfIMEIRangeSta All (all IMEI
tus (Number of IMEIs) segments)

End
IMEI
(M)

DataOfIMEIRangeStat Status (based on the status)

us (IMEI segment)

Example

STATUS

WhiteList

BlackList

GreyList

WhiteList

BlackList

GreyList

WhiteList

BlackList

GreyList

Example 1:
To query the total number of IMEI records, run the following command:
LST IMEIDATA: RESULT=CountOfIMEIStatus, COND=All;
Example 2:
To query the number of IMEI segments that are in the WhiteList state, run the
following command:
LST IMEIDATA: RESULT=CountOfIMEIRangeStatus, COND=Status,
STATUS=WhiteList;
Binding or Unbinding IMSIs for an IMEI (MOD IMEILOCK)
Function
Use this command to bind or unbind one or more IMSIs for an IMEI. One IMEI
can be bound with multiple IMSIs. The MS identified by the IMEI becomes
unusable if it is inserted with the SIM card identified by any other IMSI.
Note
None.
Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

EIRIMSI IMSI

Represents the international mobile subscriber

identity of a subscriber.
Value: an E.212 format decimal number of 6 to 15
digits

FILE

PROV

Name of
IMEI/IMSI file

Specifies the name of an IMEI/IMSI file.

Provide binding

Specifies whether to bind or unbind the IMSI for the

IMEI.

Value: a string of 1 to 16 alphanumeric characters

Value:

TRUE: Bind the IMSI with the IMEI.

FALSE: Unbind the IMSI and the IMEI.

Example
To bind the IMEI 11111111111111 with the IMSI 460000000000123, run the
following command:
MOD IMEILOCK: IMEI="11111111111111", EIRIMSI="460000000000123",
PROV=TRUE;
Listing IMSIs Bound with an IMEI (LST IMEILOCK)
Function
Use this command to query the IMSIs bound with an IMEI.
Note
The parameters IMEI and Name of IMEI file are optional. Specify only one of
them.
Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

IMEIFILE Name of IMEI

file

Specifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric characters

Example
To query the IMSIs bound with the IMEI 11111111111111, run the following
command:
LST IMEILOCK: IMEI="11111111111111";

Binding or Unbinding IMEIs for an IMSI (MOD IMSILOCK)

Function
Use this command to bind or unbind one or more IMEIs for an IMSI. One IMSI
can be bound with multiple IMEIs. The SIM card identified by the IMSI becomes
unusable if it is inserted in the MS identified by any other IMEI.
Note
None.
Parameters
ID

Name

EIRIMSI IMSI

Description
Represents the international mobile subscriber
identity of a subscriber.
Value: an E.212 format decimal number of 6 to 15
digits

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

FILE

PROV

Name of
IMSI/IMEI file

Specifies the name of an IMSI/IMEI file.

Provide binding

Specifies whether to bind or unbind the IMEI for the

IMSI.

Value: a string of 1 to 16 alphanumeric characters

Value:

TRUE: Bind the IMEI with the IMSI.

FALSE: Unbind the IMEI and the IMSI.

Example
To bind the IMSI 460000000000010 with the IMEI 11111111111111, run the
following command:
MOD IMSILOCK: EIRIMSI="460000000000010", IMEI="11111111111111",
PROV=TRUE;

Listing IMEIs Bound with an IMSI (LST IMSILOCK)

Function
Use this command to query the IMEIs bound with an IMSI.
Note
The parameters IMSI and Name of IMSI file are optional. Specify only one of
them.
Parameters
ID

Name

Description

EIRIMSI

IMSI

Represents the international mobile subscriber

identity of a subscriber.
Value: an E.212 format decimal number of 6 to 15
digits

EIRIMSIFILE Name of
IMSI file

Specifies the name of an IMSI file.

Value: a string of 1 to 16 alphanumeric characters

Example
To query the IMEIs bound with the IMSI 460000000000010, run the following
command:
LST IMSILOCK: EIRIMSI="460000000000010";
Binding or Unbinding IMEIs for an MSISDN (MOD ISDNIMEILOCK)
Function
Use this command to bind or unbind one or more IMEIs for an MSISDN. One
MSISDN can be bound with multiple IMEIs.
Note
A maximum of 10 IMEIs can be bound to a MSISDN. When more than 10
bounding records are added, the system deletes the earliest records. Specify
either MSISDN and IMEI or Name of MSISDNIMEI file.
Parameters

ID

Name

EIRISDN MSISDN

Description
Mobile subscriber ISDN number.
Value: an E.164 format decimal number of 1 to 15
digits

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

FILE

PROV

Name of
MSISDN/IMEI
file

Specifies the name of an MSISDN/IMEI file.

Provide binding

Specifies whether to bind or unbind the IMEI for the

MSISDN.

Value: a string of 1 to 16 alphanumeric characters

Value:

TRUE: Bind the IMEI with the MSISDN.

FALSE: Unbind the IMEI and the MSISDN.

Example
To bind the MSISDN 111111111111111 with the IMEI 11111111111111, run the
following command:
MOD ISDNIMEILOCK: EIRISDN="111111111111111", IMEI="11111111111111",
PROV=TRUE;
Listing IMEIs Bound with an MSISDN (LST ISDNIMEILOCK)
Function
Use this command to query the IMEIs bound with an MSISDN.
Note
The parameters MSISDN and Name of MSISDN file are optional. Specify only
one of them.
Parameters

ID

Name

Description

EIRISDN

MSISDN

Mobile subscriber ISDN number.

Value: an E.164 format decimal number of 1 to 15
digits

EIRISDNFILE Name of
Specifies the name of an MSISDN file.
MSISDN file
Value: a string of 1 to 16 alphanumeric characters
Example
To query the IMEIs bound with the MSISDN 111111111111111, run the following
command:
LST ISDNIMEILOCK: EIRISDN="111111111111111";
Checking the EIR Data Consistency (CHK EIRCONSY)
Function
Use this command to check whether the IMEI data stored on the nodes of the
memory database is consistent. The system displays the verification results and
synchronizes the IMEI data on the slave nodes with the master node.
Note

Specify only one of the parameters IMEI, IMSI, Name of IMEI file, and
Name of IMSI file.
Number of subscribers cannot be specified together with Name of IMEI
file or Name of IMSI file.

Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

EIRIMSI

IMSI

Represents the international mobile subscriber

identity of a subscriber.
Value: an E.212 format decimal number of 6 to
15 digits

RECORDCOUNT Number of Specifies the number of subscribers.

subscribers
Value range: 1 to 100000
This parameter must be specified together with
IMEI or IMSI but cannot be specified together
with Name of IMEI file or Name of IMSI file.
IMEIFILE

Name of
IMEI file

Specifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric
characters
The IMEI file contains multiple inconsecutive
IMEIs.

EIRIMSIFILE

Name of
IMSI file

Specifies the name of an IMSI file.

Value: a string of 1 to 16 alphanumeric
characters
The IMSI file contains multiple inconsecutive
IMSIs.

Example
To check data consistency for the IMEI 77777777771234, run the following
command:
CHK EIRCONSY: IMEI="77777777771234";
Listing the Dynamic IMEI Data(LST DYNIMEIDATA)
Function
Use this command to query the dynamic data for an IMEI.
Note
The parameters IMEI and Name of IMEI file are optional. Specify only one of
them.
Parameters
ID

Name

Description

IMEI

IMEI

Represents the international mobile station

equipment identity of the equipment.
Value: a decimal number of 14 digits

IMEIFILE Name of IMEI

file

Specifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric characters

Example
To query the dynamic data for the IMEI 11111111111111, run the following
command:
LST DYNIMEIDATA: IMEI="11111111111111";