List of Commands EIR

LIST OF COMMANDSSetting 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

IDNameDescription

IMEIIMEIRepresents the international mobile station equipment identity of the equipment.

Value: a decimal number of 14 digits

IMEIFILEName of IMEI fileSpecifies the name of an IMEI file.

Value: a string of 1 to 16 alphanumeric characters

The IMEI file contains multiple inconsecutive IMEIs.

PROVOperation typeSpecifies whether to add, modify, or delete the IMEI status information.

Value:

TRUE: Add or modify the IMEI status information.

FALSE: Delete the IMEI status information.

STATUSIMEI statusSpecifies the status of the IMEI.

Value:

WhiteList

BlackList

GreyList

ACTIONIDAction template IDSpecifies the ID of an action template.

Value range: 0 to 65535

REASONCODECause codeSpecifies a cause code.


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


Parameters

IDNameDescription






OPTYPEQuery typeSpecifies 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

IDNameDescription

BEGINIMEIStart IMEISpecifies the first IMEI of an IMEI segment.


ENDIMEISNEnd IMEI serial numberSpecifies the serial number of the last IMEI of an IMEI segment.


IMEIRANGEFILEName of IMEIRANGE fileSpecifies the name of an IMEI segment file.


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.

OPTYPEOperation typeSpecifies whether to add, modify, or delete the status information of the IMEI segment.

Value:

ADD: Add the status information.

MOD: Modify the status information.

DEL: Delete the status information.

STATUSIMEI segment statusSpecifies the status of the IMEI segment.

Value:

WhiteList

BlackList

GreyList

ACTIONIDAction template IDSpecifies the ID of an action template.


REASONCODECause codeSpecifies a cause code.


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

IDNameDescription

BEGINIMEIStart IMEISpecifies the first IMEI of an IMEI segment.


ENDIMEIEnd IMEISpecifies the last IMEI of an IMEI segment.


OPOBJOperation typeSpecifies the information to be queried.

Value:

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

STATUSIMEI segment statusSpecifies the status of the IMEI segment.

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

IDNameDescription

OSTATUSOriginal statusSpecifies the original status of the IMEIs or IMEI segments.

Value:

WhiteList

BlackList

GreyList

DSTATUSDestination statusSpecifies the destination status of the IMEIs or IMEI segments.

Value:

WhiteList

BlackList

GreyList

OPOBJOperation objectSpecifies 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

IDNameDescription

RESULTQuery resultSpecifies the information to be queried.

Value:

CountOfIMEIStatus: number of IMEI records

DataOfIMEIStatus: information about the IMEI records

CountOfIMEIRangeStatus: number of IMEI segment records

DataOfIMEIRangeStatus: information about the IMEI segment records

CONDQuery conditionSpecifies 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.

PARA1Start IMEISpecifies the first IMEI of an IMEI segment.


PARA2End IMEISpecifies the last IMEI of an IMEI segment.


STATUSIMEI/IMEI segment statusSpecifies the status based on which the data needs to be queried.

Value:

WhiteList

BlackList

GreyList

RESULTCONDPARA1PARA2STATUS

CountOfIMEIStatus (Number of IMEIs)

DataOfIMEIStatus (IMEI value)All (all IMEIs)---

RangeByIMEI (based on the IMEI segment)Start IMEI (M)End IMEI (M)-

Status (based on the status)-- WhiteList

BlackList

GreyList

RangeByIMEIAndStatus (based on the IMEI segment and IMEI status)Start IMEI (M)End IMEI (M) WhiteList

BlackList

GreyList

CountOfIMEIRangeStatus (Number of IMEIs)

DataOfIMEIRangeStatus (IMEI segment)All (all IMEI segments)---

Status (based on the status)-- WhiteList

BlackList

GreyList

Example

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

IDNameDescription



EIRIMSIIMSIRepresents the international mobile subscriber identity of a subscriber.

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

FILEName of IMEI/IMSI fileSpecifies the name of an IMEI/IMSI file.


PROVProvide bindingSpecifies whether to bind or unbind the IMSI for the IMEI.

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


Parameters

IDNameDescription





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

IDNameDescription





FILEName of IMSI/IMEI fileSpecifies the name of an IMSI/IMEI file.


PROVProvide bindingSpecifies whether to bind or unbind the IMEI for the IMSI.

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

IDNameDescription



EIRIMSIFILEName of IMSI fileSpecifies the name of an IMSI file.


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

IDNameDescription

EIRISDNMSISDNMobile subscriber ISDN number.




FILEName of MSISDN/IMEI fileSpecifies the name of an MSISDN/IMEI file.


PROVProvide bindingSpecifies whether to bind or unbind the IMEI for the MSISDN.

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

IDNameDescription

EIRISDNMSISDNMobile subscriber ISDN number.


EIRISDNFILEName of MSISDN fileSpecifies the name of an MSISDN file.


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

IDNameDescription





RECORDCOUNTNumber of subscribersSpecifies the number of subscribers.


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.




EIRIMSIFILEName of IMSI fileSpecifies the name of an IMSI file.


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


Parameters

IDNameDescription





Example

To query the dynamic data for the IMEI 11111111111111, run the following command:

LST DYNIMEIDATA: IMEI="11111111111111";

Documents

List of Commands EIR