OmniEIR Operations Guide

Overview | Configuration Reference | Metrics and Monitoring | Troubleshooting

Role

OmniEIR is the 5G Equipment Identity Register. During UE registration the AMF asks it whether the device's PEI (IMEI/IMEISV) is permitted; OmniEIR returns WHITELISTED, BLACKLISTED, or GREYLISTED. The verdict is computed from the operator's rules held in OmniHSS.

Endpoints

The SBI listener exposes the N5g-eir_EquipmentIdentityCheck service (TS 29.511):

Method	Path	Description
GET	/n5g-eir-eic/v1/equipment-status?pei={pei}&supi={supi}	Returns EirResponseData: {"status": "<EquipmentStatus>"}. pei is mandatory; supi is optional.
GET	/n5g-eir-eic/v1/status	Liveness probe ({"status":"UP"}).

pei is a PEI in TS 23.003 form: imei-<15 digits> or imeisv-<16 digits>. supi is imsi-<digits>.

Example:

curl 'http://127.0.0.23:7777/n5g-eir-eic/v1/equipment-status?pei=imei-353160051234567'
# -> {"status":"WHITELISTED"}

Message Flow

For a WHITELISTED or GREYLISTED verdict (or any EIR error), the AMF proceeds with registration.

Matching logic

OmniEIR mirrors the 4G S13 decision so a single rule set governs both radios. Given the parsed equipment, it tries, in order, and stops at the first rule whose regex matches:

1. the full IMEISV digit string (IMEI + software version), then
2. the IMEI alone, then
3. the IMSI (from the SUPI).

If nothing matches, the configured unknown_equipment_status is returned.

Fail-open behaviour

The AMF-side gate is deliberately fail-open: if the EIR is unreachable, returns an error, or the UE presented no PEI, registration proceeds. Only an explicit BLACKLISTED verdict bars a device. This prevents a broken EIR or HSS from stranding every subscriber. A deployment that requires fail-closed semantics sets unknown_equipment_status: "BLACKLISTED" on OmniEIR (so unmatched devices are barred). Note that a total EIR outage still fails open at the AMF by design.

Enabling in a deployment

1. Provision rules in OmniHSS (POST /api/eir/rule).
2. Start OmniEIR; confirm it registers with the NRF as 5G_EIR.
3. Set config :omniamf, eir_enabled: true and restart the AMF.
4. Verify with a phone reboot / UE re-attach and watch the AMF logs for the 5G-EIR decision line.