1. EAGLE EIR User's Guide
  2. EAGLE EIR Commands

3 EAGLE EIR Commands

This chapter contains brief descriptions of the EAGLE commands that can be used for configuration of the EIR feature.

3.1 EAGLE Commands for EIR

This chapter describes the EAGLE commands that are used for the configuration of the EIR feature.

Refer to Commands User's Guide for complete command descriptions including parameter names, valid parameter values, examples, and dependencies.

Table 3-1 Commands used for EIR

Type Commands
System Serial Number ent/rtrv-serial-num
Card ent/dlt/rtrv/alw/inh/init/rept-stat-card
Feature Control chg/rtrv-feat, enable/chg/rtrv-ctrl-feat
EAGLE STP Self Identification chg/rtrv-sid
Mated Application (MAP) chg/dlt/ent/rtrv-map
Subsystem Application chg/dlt/ent/rtrv-ss-appl
Service Selector chg/dlt/ent/rtrv-srvsel
EIR GSM Options chg/rtrv-gsmopts
Local Subsystem Activation alw/inh-map-ss
SCTP Associations in Table IPAPSOCK chg/dlt/ent/rept-stat/rtrv-assoc
IP Host Table dlt/ent/rtrv-ip-host
Alarm Thresholds chg/rtrv-th-alm

3.1.1 EAGLE EIR GSM Options Commands

The GSM Options (gsmopts) commands are used to change and report on the values of one or more of the system-level processing options maintained in the GSMOPTS table. All values are assigned initially to system defaults at STP installation time, and they can be updated later using the chg-gsmopts command.

The options described in Table 3-2 apply to EIR.

Table 3-2 GSMOPTS Options for EIR

Parameter Range Description

EIRIMSICHK

OFF or ON

EIR IMSI Check status

EIRRSPTYPE

TYPE1, TYPE2, TYPE3

EIR Response Type

EIRGRSP

OFF, WHITELST, GRAYLST, BLKLST, UNKNOWN

EIR Global Response status

The EIRIMSICHK (EIR IMSI Check status) parameter is used to indicate whether or not the IMSI will be used when determining if an IMEI is to be Black Listed. If this parameter is on and an IMEI is found on the Black List, then the corresponding IMSI is retrieved. If the IMSI found in the message matches the IMSI retrieved, then the IMEI is considered to be on the White List. If the IMSIs do not match or the IMSI is not found, then the IMEI will remain Black Listed.

The EIRRSPTYPE parameter is used to determine the EIR Response Type. The Response Type is used to determine how the lists are searched, as shown in Table 3-3.

Table 3-3 Individual IMEI List Determination

Black List Gray List White List IMSI Check IMSI Match Result Type LOG Entry LOG Entry Result MSU Result Equipment Status

Y

N

N

Y

Y

1

N

White with IMSI Override

0

Y

N

N

Y

Y

2

N

White with IMSI Override

0

Y

N

N

Y

Y

3

N

Unknown

Return Error=7

Y

N

N

Y

N

1

Y

Black with IMSI Failed

1

Y

N

N

Y

N

2

Y

Black with IMSI Failed

1

Y

N

N

Y

N

3

N

Unknown

Return Error=7

Y

N

Y

N

DC

1

Y

Black

1

Y

N

Y

N

DC

2

Y

Black

1

Y

N

Y

N

DC

3

Y

Black

1

Y

N

Y

Y

Y

1

N

White with IMSI Override

0

Y

N

Y

Y

Y

2

N

White with IMSI Override

0

Y

N

Y

Y

Y

3

N

White with IMSI Override

0

Y

Y

N

N

DC

1

Y

Black

1

Y

Y

N

N

DC

2

Y

Black

1

Y

Y

N

N

DC

3

N

Unknown

Return Error=7

Y

Y

N

Y

Y

1

Y

White with IMSI Override

0

Y

Y

N

Y

Y

2

Y

White with IMSI Override

0

Y

Y

N

Y

Y

3

Y

White with IMSI Override

0

N

Y

N

Y

DC

1

Y

Gray

2

N

Y

N

Y

DC

2

Y

Gray

2

N

Y

N

Y

DC

3

  

Unknown

Return Error=7

N

Y

Y

DC

DC

1

Y

Gray

2

N

Y

Y

DC

DC

2

Y

Gray

2

N

Y

Y

DC

DC

3

Y

Gray

2

N

N

Y

DC

DC

1

N

White

0

N

N

Y

DC

DC

2

N

White

0

N

N

Y

DC

DC

3

N

White

0

N

N

N

DC

DC

1

N

White

0

N

N

N

DC

DC

2

N

Unknown

Return Error=7

N

N

N

DC

DC

3

N

Unknown

Return Error=7

Y

Y

Y

N

DC

1

Y

Black

1

Y

Y

Y

N

DC

2

Y

Black

1

Y

Y

Y

N

DC

3

Y

Black

1

Y

Y

Y

Y

Y

1

N

White with IMSI Override

0

Y

Y

Y

Y

Y

2

N

White with IMSI Override

0

Y

Y

Y

Y

Y

3

N

White with IMSI Override

0

Y

Y

Y

Y

N

1

N

Black with IMSI Failed

1

Y

Y

Y

Y

N

2

N

Black with IMSI Failed

1

Y

Y

Y

Y

N

3

N

Black with IMSI Failed

1

For EIR Response Types 1 or 2, the IMEI searches are handled in the following manner:

  • If the IMEI is found in the Black List table, the search stops without searching the White and Gray List tables. The IMEI is considered Black Listed regardless of IMEI’s presence on the White or Gray List tables.

  • If the IMEI is found in the Gray List table, but not found in the Black List table, the search stops without searching the White List table. The IMEI is considered Gray Listed regardless of the IMEI’s presence on the White List table.

For EIR Response Type 3, the IMEI searches are handled in the following manner:

  • The White List table is searched first. If the IMEI is not found in the White List table, the IMEI is treated as unknown - no other table searches need to be performed.

  • If the IMEI is found in the White List table, the Black List table is searched next. If the IMEI is in the White and Black List tables, the IMEI is considered Black Listed - no need to search the Gray List table.

  • If the IMEI is found in White List table, but not in the Black List table, the Gray List table is searched. If the IMEI is in the White and Gray list tables, the IMEI is considered Gray Listed. If the IMEI is in the White List table, but not in the Gray List table, the IMEI is considered White Listed.

The EIRGRSP parameter is used to turn on the EIR Global Response Type. The Global Response Type is used to override the response that is normally sent back to the MSC. The default is set to OFF. When set to OFF, the normal list logic is applied to the IMEI. If the Global Response Type is set to something other than OFF, then there is no list logic processing and the corresponding response is sent to the MSC.

3.1.2 EAGLE EIR Service Selector Commands

The EIR service selector (srvsel) commands are used to enter, delete, change, and display the service selectors required to change a service entry for a DSM service entry.

  • The EIR service is eir.

  • EIR supports ANSI, ITU-I, and ITU-N Global Title Indicators.

    The Global Title Indicator (GTI) value can be either 2 or 4. The Numbering Plan and Nature of Address Indicator cannot be specified when the GTI is 2, and must be specified when the GTI is 4.

  • EIR does not support the Service Nature of Address or the Service Numbering Plan.

  • The Subsystem Number (SSN) must be defined in the MAP table, and supports the asterisk (*) value.

3.1.3 EAGLE Feature Control Commands

The chg/rtrv-feat commands are used to turn on and display the on/off status of features, such as the GTT feature, that are controlled with feature bits. After a feature that is controlled with a feature bit is turned on, the feature cannot be turned off.

The enable/chg/rtrv-ctrl-feat commands are used to enable, turn on, and display the status of controlled features that are controlled by feature access keys. The feature access key is based on the feature part number and the serial number of the system that uses the feature, making the feature access key site-specific. When a feature is enabled by entering the enable-ctrl-feat command with the feature part number and feature access key, the feature is recognized by the system. Other actions might be required to make the feature fully operational, such as turning the feature on, installing hardware, and provisioning information in database tables.

Some features can be enabled with a temporary part number and feature access key for a limited trial of the feature. When the trial period expires, the feature must be enabled with a permanent part number and feature access key to continue use of the feature.

3.1.4 EIR S13/S13' Interface Support Commands

The commands in Table 3-4 support the EIR S13/S13' Interface Support feature.

Table 3-4 Commands for EIR S13/S13' Interface Support feature

Command Description

chg-deiropts

configures S13-specific options

rtrv-deiropts

displays S13-specific options

ent-dconn

configures Diameter connection and flow control by entering Diameter connection values associated to a particular association in table IPAPSOCK

chg-dconn

changes Diameter connection and flow control configuration values

dlt-dconn

deletes Diameter connection

rtrv-dconn

displays Diameter connection status and flow control data

rept-stat-deir

displays S13 card statistics

Table DEIROPTS

The chg-deiropts and rtrv-deiropts commands configure and display the EIR S13/S13' Interface Support options of the virtual table DEIROPTS, which is part of table EGLEOPTS. The table DEIROPTS options are shown in Table 3-5.

Table 3-5 Table DEIROPTS options

Name Values Description

DEIRIMSICHK

OFF

ON

IMSI Check

The IMSI Check specifies whether IMSI is used when determining if an IMEI is to be blocklisted. If this option is set to ON and an IMEI is found on the Blocklist, then the corresponding IMSI will be retrieved. If the IMSI found in the message matches the IMSI retrieved, then the IMEI is considered to be on the Allowlist. If the IMSIs do not match or the IMSI is not found, then the IMEI will remain blocklisted.

Default value is OFF.

DEIRRSPTYPE

TYPE1

TYPE2

TYPE3

S13 Response Type

The S13 Response Type is used to determine how the lists are to be searched.

Default value is TYPE1.

DEIRGRSP

OFF

WHITELST

GRAYLST

BLKLST

UNKNOWN

S13 Global Response Type

The S13 Global Response Type is used to override the response that is sent to the MME or SGSN. When S13 Global Response Type is set to OFF, the normal list logic is applied to the IMEI. If the S13 Global Response Type is set to any value except OFF, then list logic processing is not performed and the corresponding response is sent to the MME or SGSN.

Default value is OFF.

CONGERR

3004

5006

Congestion Error

This is the value in the result code Attribute Value Pair (AVP) of the response sent at the time of congestion. If the incoming messages on the card running the DEIR64 GPL exceed the card or connection capacity and the card is not able to process the messages, the messages are discarded and the card responds with the configured value in the result code.

  • 3004 - DIAMETER_TOO_BUSY [default value]
  • 5006 - DIAMETER RESOURCES EXCEEDED

VENDID

unsigned32

S13 local Vendor ID

All outgoing messages that require Vendor ID in VENDOR_SPECIFIC_APPLICATION_ID use this configured value. Because only the value 10415 is supported, the CEA message contains 10415 as the Vendor Id in the response.

Default value is 0.

PRODUCT

alphanumeric string

Product Name

The configured value contains the vendor-assigned name for the product. All outgoing messages that require the Product Name AVP use this configured value.

Default value is NONE.

APPLID

unsigned32

Authentication Application ID

The configured Application ID should match the Auth-Application-Id (AVP Code 258) value in the Vendor-Specific-Application-ID AVP. Currently, only 16777252 APPLID is supported by EAGLE and this parameter cannot be changed.

Default value is 16777252.

DPRCAUSE

REBOOTING (0)

BUSY (1)

DO_NOT_WANT_TO_TALK (2)

Disconnect Cause

The Disconnect Cause in all DPR messages generated by EAGLE use this value.

Default value is DO_NOT_WANT_TO_TALK (2).

Table DCONN

The ent-dconn, chg-dconn, dlt-dconn, and rtrv-dconn commands configure and display the EIR S13/S13' Interface Support options of the table DCONN, which supports the provisioning information associated with the Diameter connection. The table DCONN options are shown in Table 3-6.

Table 3-6 Table DCONN options

Name Values Description

DCNAME

alphanumeric string

Diameter Connection Name

The Diameter Connection Name identifies the Diameter connection linked to an association. This option is mandatory.

ANAME

alphanumeric string

Association Name

This name identifies the association configured in the association table with the Diameter adapter. This option is mandatory.

RSVDTPS

integer from 100 to 8000, inclusive

Reserved TPS

This is the guaranteed TPS for a connection. Total RSVDTPS on a card cannot exceed 8000.

Default value is 250.

MAXTPS

integer from 100 to 8000, inclusive

Max TPS

The unused S13 card capacity is allocated among the connections that have exceeded their RSVDTPS values up to the limit of MAXTPS value provisioned for the particular connection.

Default value is 8000.

TW

6sec - 30sec

Diameter Watchdog Timer

Default value is 6sec.

TD

1sec - 10sec

Diameter Peer Disconnect Timer

Default value is 3sec.

REPT-STAT-DEIR Command

The rept-stat-deir command displays the overall status of the Diameter EIR S13/S13' service on the EAGLE. This command is similar to the rept-stat-sccp and rept-stat-sip commands. The Diameter connection status is displayed in the Status field when the rept-stat-deir command is entered with the dcname parameter. The possible values for Diameter Status parameter are:
  • UP - The Diameter connection status is up and active. This status supports the following Diameter connection states: Active, Closing, Pending.
  • DOWN - The Diameter connection status is down or closed. This status supports the following Diameter connection states: Inactive, Open, Closed.
The rept-stat-deir command can be entered with or without parameters. If the rept-stat-deir command is entered without parameters, the displayed consists of a per diameter card status, TPS on each S13 card, total S13 statistics, and alarms associated with the Diameter EIR S13/S13' service in the DEIR ALARM STATUS field. The following parameters can be entered with the rept-stat-deir command:
  • loc - Diameter card location for which card status, overall card TPS, and per-connection card statistics are reported
  • peakreset - Reset peak values for a card or a specified Diameter connection
  • mode - Overall S13 TPS and per diameter connection statistics in the EAGLE displayed; allowed value: perf
  • dcname - Diameter connection name, which is the unique logical name assigned to each diameter connection; output display: status, TPS, and statistics of the specified Diameter connection

The rept-stat-deir command displays the pegs shown in Table 3-7.

Table 3-7 REPT-STAT-DEIR Pegs

Pegs Condition
SUCCESS
Messages which fall in these categories:
  • Success response
  • IMEI Lookup failure and DEIRRSPTYPE=TYPE1
ERROR
Messages which fall in these categories:
  • Decoding error
  • Unsupported messages
WARNING
Messages which fall in these categories:
  • IMEI Lookup failure and DEIRRSPTYPE=TYPE2 or TYPE3
  • Unknown equipment is sent in response
OVERFLOW Number of message discarded due to congestion
TOTAL MSGS Total number of messages received: Success + Error + Warning messages

PASS Commands supported by S13 card

The S13 card supports the following PASS commands:
  • ARP - displays and modifies the Internet to Ethernet address translation tables used by the address resolution protocol
  • ASSOCRTT - displays round-trip statistics for a given association
  • CPUM - displays CPU utilization
  • MSUCOUNT - displays MSU count for particular association and routes, including S13/S13' protocol
  • NETSTAT - displays network statistics from the IP stack
  • NSLOOKUP - returns the IP address for a specified hostname, or returns a hostname for a specified IP address
  • PING - tests for the presence of hosts on the network
  • SCTP - displays MSU count and current state of specific association
  • SYSSTAT - display system buffer, CPU configuration, and database-related information
  • TRACEROUTE - returns/traces the complete path a message has taken to reach the destination