OmniEIR Configuration Reference

Overview | Operations Guide | Metrics and Monitoring | Troubleshooting

All OmniEIR configuration lives under the :omnieir application key. A subset of keys can be overridden by environment variables, but that only takes effect in the production runtime configuration (config/runtime.exs).

Configuration Structure

config :omnieir,
  # SBI listener identity (advertised to the NRF)
  sbi_scheme: "http",
  sbi_addr: "127.0.0.23",
  sbi_port: 7777,

  # NRF registration
  nrf_uri: "http://127.0.0.10:7777",
  heartbeat_interval: 10_000,

  # Served PLMN (override per deployment)
  mcc: "999",
  mnc: "70",

  # OmniHSS REST API holding the operator's EIR rules
  hss_api_base_url: "https://127.0.0.1:8443",

  # Verdict returned when no rule matches the presented equipment
  unknown_equipment_status: "WHITELISTED"

Core Parameters

Parameter	Type	Default	Env Var	Description
sbi_scheme	string	"http"	EIR_SBI_SCHEME	Scheme advertised for the SBI listener.
sbi_addr	string	"127.0.0.23"	EIR_SBI_ADDR	Address the SBI listener binds to and advertises to the NRF.
sbi_port	integer	7777	EIR_SBI_PORT	SBI listener port.
nrf_uri	string	"http://127.0.0.10:7777"	EIR_NRF_URI	NRF base URI for registration and heartbeats.
heartbeat_interval	integer (ms)	10_000	none	NRF heartbeat period.
mcc	string	"999"	EIR_MCC	Served PLMN mobile country code.
mnc	string	"70"	EIR_MNC	Served PLMN mobile network code.
hss_api_base_url	string	"https://127.0.0.1:8443"	HSS_API_BASE_URL	Base URL of the OmniHSS REST API. The EIR rules are read from {base}/api/eir/rule.
unknown_equipment_status	string	"WHITELISTED"	EIR_UNKNOWN_EQUIPMENT_STATUS	EquipmentStatus returned when no provisioned rule matches. One of WHITELISTED, BLACKLISTED, GREYLISTED. Mirrors the HSS eir.unknown_equipment_behaviour.

The self-signed TLS certificate of the lab OmniHSS is accepted (verify_none), matching the other HSS-REST consumers (OmniUDR). Terminate the HSS behind a trusted CA in production.

Provisioning the rules (OmniHSS)

OmniEIR has no provisioning API of its own. Rules are created against OmniHSS, exactly as for the 4G S13 interface, e.g.:

curl -k -X POST https://<hss>:8443/api/eir/rule \
  -H 'content-type: application/json' \
  -d '{"action":"blacklist","regex":"^35316005"}'

• action is one of whitelist, blacklist, greylist.
• regex is matched against the equipment identity string. Rules are evaluated in the order OmniHSS returns them; the first match wins.

AMF-side configuration (turning the check on)

The equipment check is performed by the AMF, and is disabled by default so existing deployments are unaffected. Enable it under the :omniamf key:

Parameter	Type	Default	Description
eir_enabled	boolean	false	When true, the AMF queries the 5G-EIR during registration and rejects blacklisted PEIs.
eir_uri	string | nil	nil	Static 5G-EIR SBI URI. When nil, the AMF discovers the EIR via the NRF (NFType 5G_EIR).

config :omniamf,
  eir_enabled: true
  # eir_uri: "http://127.0.0.23:7777"   # optional; omit to use NRF discovery