Section 7. Configuring EIR

7. Configuring EIR

This section describes how to configure EIR parameters.

The EIR is a database that contains information on mobile devices that are banned from using the network or need to be tracked for some purpose. The devices are listed by their IMEI (International Mobile Equipment Identity).

7.1. <AuthBy DiaEIR>

This section describes the configuring parameters of <AuthBy DiaEIR>.

<AuthBy DiaEIR> queries IMEI status from EIR using Diameter S13/S13' interface. It can also query the software version and IMSI (International mobile subscriber identity) status. The result from EIR determines if the request is accepted or rejected.

The distribution package contains an example configuration file goodies/eir-client.cfg.

7.1.2. MakeAnswer

When MakeAnswer is set, a simple Diameter answer with either DIAMETER_SUCCESS or DIAMETER_UNABLE_TO_COMPLY is sent if <AuthBy DiaEIR> does not return ignore. This parameter is not set by default.

7.1.3. EIR_UnknownAction

EIR_UnknownAction defines the return value for <AuthBy DiaEIR> if the EIR request gets DIAMETER_UNKNOWN_EQUIPMENT. The value can be either accept or reject, accept is the default value.

7.1.4. EIR_AttributesHook

This parameter is a hook that allows customising how to set IMEI and other values are passed to EIR. This has not any default value.

When this is set, IMEIAttribute, IMSIAttribute, and SoftwareVersionAttribute are ignored.

Here is an example that shows how to get the values from current request attributes:

EIR_AttributesHook sub 
      { my $p = $_[0]; my $imei = $_[1]; my $sv = $_[2]; my $imsi = $_[3]; \
      $$imei = $p->get_attr('X-OSC-SIM-IMEI'); \
      $$sv   = $p->get_attr('X-OSC-SIM-Software-Version'); \
      $$imsi = $p->get_attr('X-OSC-SIM-IMSI'); }

7.1.5. IMEIAttribute

This parameter defines the IMEI attribute in the current request that must have a value for IMEI. This is ignored when EIR_AttributesHook is defined. The default value is OSC-SIM-IMEI.

7.1.6. SoftwareVersionAttribute

This parameter defines the software version attribute in the current request that must have a value for software version. This is ignored when EIR_AttributesHook is defined. The default value is OSC-SIM-Software-Version.

7.1.7. IMSIAttribute

This parameter defines the IMSI attribute in the current request that must have a value for IMSI. This is ignored when EIR_AttributesHook is defined. The default value is OSC-SIM-IMSI.

7.2. <DiaEIR>

This section describes the configuring parameters of <DiaEIR>. <DiaEIR> implements the interface for querying EIR.

7.3. <EIRCacheInternal>

This section describes the configuring parameters of <EIRCacheInternal>. <EIRCacheInternal> is an optional module for caching EIR responses.

7.3.2. CacheTimeout

CacheTimeout defines (in seconds) for how long the successful EIR responses are cached. The default value is 1800 (30 minutes).

7.3.3. NegativeCacheTimeout

If EIR cannot be connected or it returns an answer that cannot be successfully processed, NegativeCacheTimeout defines the time (in seconds) for how long time the answer is cached. Using this feature gives EIR time to recover from the possible error condition. The default value is 300 (5 minutes).

7.4. <ServerDiaEIR>

This section describes the configuring parameters of <ServerDiaEIR>. Apart from the parameters listed here, <ServerDiaEIR> inherits other parameters from <ServerDIAMETER>. <ServerDIAMETER> is documented in Radiator reference manual

The distribution package contains an example configuration file goodies/eir-server.cfg. The test IMEIs are currently listed in ServerEIR.pm. Different test IMEIs trigger different responses, including errors, from this example EIR server. You can add your test device's IMEI into ServerEIR.pm. Later it will be possible to create a separate configuration file for <ServerDiaEIR> that contains the IMEI list.

7.4.1. VendorAuthApplicationIds

VendorAuthApplicationIds is an optional parameter that defines the Vendor-Specific-Application-Ids announced in CEA. The default value is S13/S13'.