YateHSS/HLR Command Line Interface (CLI)

General

The YateHSS/HLR CLI is accessible through the Yate’s Telnet interface. It accepts connections by default on TCP port 5038 to connect to the Yate Remote Manager (rmanager).

By default the Command Line Interface is accessible from localhost only. It is possible to configure rmanager to be accessible from network but that poses security risks. Consider using firewall rules, telnet-ssl and configuring password authentication.

From the Linux console:

telnet 127.0.0.1 5038

General Yate commands are also accessible through the same interface.

help hss
hss list {sims [IMSI-PREFIX]|subscribers [MSISDN-PREFIX]}
hss list {regs|purged} {cs|ps|ims} [IMSI-PREFIX]
hss show {subscriber|sim|sqns} {MSISDN|IMSI|ICCID}
hss {push|drop|kick|kill} {cs|ps|ims|all} IMSI-PREFIX
hss repair {MSISDN|IMSI|ICCID}
Control the HSS operation

You can use the TAB key to complete the current command line. All YateHSS/HLR related commands start with hss

hss TAB 
list show push drop kick kill repair

 hss show TAB
subscriber sim sqns

Statistics

A single command with no parameters that displays some information about the HSS/HLR as a whole:

  • Total provisioned subscribers
  • Total and current registrations per type: CS (circuit voice), PS (data) and IMS (packet based voice)
  • Connected cluster node list (for cluster configurations)

hss 

Subscribers CS Regs PS Regs IMS Regs Connected
total total active total active total active cluster nodes
———– —— —— —— —— —— —— ——————-
23 21 1 22 8 4 0 (standalone)

Listing items

All commands related to lising YateHSS/HLR items start with hss list

You can use the Page Up, Page Down, Home and End keys to scroll through long lists.

SIMs

This command lists all provisioned SIMs or just those that start with a specific IMSI prefix.

hss list sims 

Primary IMSI Alternate IMSI SIM Type Algorithm CS PS LTE IMS WLAN
————— ————— ———— ——— — — — — —-
001990123456789 ISIM milenage yes yes yes yes yes
001990123456788 ISIM milenage yes yes yes yes yes
001020000000001 SIM comp128-1 yes yes yes no yes
460990010001001 310410992261045 ISIM milenage yes yes yes yes yes

hss list sims 00190

Primary IMSI Alternate IMSI SIM Type Algorithm CS PS LTE IMS WLAN
 ————— ————— ———— ——— — — — — —-
001900123456788 ISIM milenage yes yes yes yes yes
001900000000001 SIM comp128-1 yes yes no no no

Subscribers

This command lists all provisioned subscribers or just those that start with a specific MSISDN prefix.

hss list subscribers

MSISDN Primary IMSI Alternate IMSI ODB CS PS IMS SIP
————— ————— ————— — — — — —
40700012345 001990123456789 yes yes yes yes yes
40700012346 001900123456788 yes yes yes yes yes
40316201405 001020000000001 no yes yes no no

hss list subscribers 882

MSISDN Primary IMSI Alternate IMSI ODB CS PS IMS SIP
————— ————— ————— — — — — —
88270021 001150010001001 no yes yes no no
88270005 001020000000003 no yes yes no no
88270013 310410010001005 no yes yes no no

Registrations

This command lists active registrations for each subtype: CS, PS or IMS. An optional IMSI prefix added to the command allows displaying only registrations of interest.

hss list regs cs 

IMSI IMEI(SV) Protocol VLR Number Reg. time
————— —————- ——– —————— —————-
310410010001005 0134070049232090 MAP 8820016 2016-12-05 17.25

hss list regs ps 

IMSI IMEI(SV) Protocol Access SGSN / Host Reg. time
————— —————- ——– ——- ———————— —————-
001990123456789 1234567898654321 MAP e-utran 8820016 2016-11-28 13.06
001020000000001 8607830344603800 MAP  ??? 8820016 2016-10-24 23.45
001020000000003 3546540526090101 MAP geran 8820016 2016-12-12 17.48
001010000000007 3594670766703801 DIAMETER e-utran ucn.yatebts.com 2016-12-10 23.54
001010000000006 3585820515563804 DIAMETER geran ucn.yatebts.com 2016-12-09 04.21

hss list regs ps 00101 

IMSI IMEI(SV) Protocol Access SGSN / Host Reg. time
————— —————- ——– ——- ———————— —————-
001010000000007 3594670766703801 DIAMETER e-utran ucn.yatebts.com 2016-12-10 23.54
001010000000006 3585820515563804 DIAMETER geran ucn.yatebts.com 2016-12-09 04.21

Showing information

All commands showing details of YateHSS/HLR items start with hss show

SIMs

This command takes either an IMSI or ICCID parameter and displays information about selected SIM. The amount of information depends on SIM type and provisioned information.

hss show sim 001990123456789

Primary IMSI Alternate IMSI SIM Type Algorithm CS PS LTE IMS WLAN
————— ————— ———— ——— — — — — —-
001990123456789 ISIM milenage yes yes yes yes yes

ICCID Vendor PIN PIN 2 PUK PUK 2
——————– ——————– —— —— ———- ———-
8996399000000002493 SmartJac 0000 0000 11111111 22222222

AMF CS PS IMS WLAN USIM ISIM WLAN
AMF LTE SQN SQN SQN SQN Opc Opc Opc
—- —- —– —– —– —– —- —- —-
0000 9001 0-15 16-31 0-31 (=PS) no yes no

Subscribers

This command takes either a MSISDN, IMSI or ICCID parameter and displays information about selected subscriber. The amount of information depends on provisioned information.

hss show subscriber 001990123456789

ODB BOIC BIC PS PS AP AP
MSISDN Roam BAOC BOIC ExHC BAIC Roam All Roam HPMN VPMN
————— —- —- —- —- —- —- —- —- —- —-
40700012345 no no no no no no no yes no yes

SS BOIC BIC Mult
Pass CLIP CLIR BAOC BOIC ExHC BAIC Roam CW HOLD PTY
—- —- —- —- —- —- —- —- —- —- —-
no yes no no no no no no yes yes no

CFU Number CFB Number CFNRC Number CFNRY Number Time
————— ————— ————— ————— —-
(not provision) 40700099999 40700099999 (not provision) 30

CS Profile PS Profile EPS Profile IMS Profile
—————— —————— —————— ——————
Prepaid voice Prepaid data Prepaid data VoLTE with CAMEL

SIP Username Authname Realm Active
———————- ———————- ———————- ——
40700012345 SIP service yes

Private identity Public identity Alternate public ID Active
———————- ———————- ———————- ——
001990123456789@ims.ex sip:+40700012345@examp tel:+40700012345 yes

Primary IMSI Alternate IMSI SIM Type Algorithm CS PS LTE WLAN
————— ————— ———— ——— — — — —-
001990123456789 ISIM milenage yes yes yes yes

Sequence numbers

This command takes either an IMSI or ICCID parameter and displays sequence numbers usage for selected USIM or ISIM.

hss show sqns 8996399000000002493

IDX Sequence SQN Network node Last use time
— ———– ———— —————————– ——————-
0 72 000000000900 mme:8820016 2016-11-08 15:31:23
1 3 000000000061 wlan-aaa-server:8820016 2016-08-03 13:05:11
2 9 000000000122 mme:8820020 2016-08-09 15:15:23
3 31 0000000003e3 vlr:8820016 2016-09-30 23:08:04
4 39 0000000004e4 sgsn:8820016 2016-09-30 23:08:08
5 1 000000000025 2016-07-22 14:03:41
6 1 000000000026 2016-07-22 14:03:41

Registration operations

These operations work on currently registered subscribers since address of the visited network node must be known. Subscribers that are not registered are silently ignored.

Push data

This operation pushes subscribers data to the visited network node where it is registered.

The domain to send information for must be provided as parameter, must be either cspsims or all (which sends data for all domains).

Last parameter is an IMSI prefix (of at least 5 digits) that selects for which subscribers to push data. A full length IMSI may be provided.

hss push cs 310410010001005

Pushed CS data for 1 subscribers

hss push ps 00102000

Pushed PS data for 2 subscribers

hss push all 00101

Pushed CS data for 0 subscribers
Pushed PS data for 2 subscribers
Pushed IMS data for 0 subscribers

Deregister

This family of operations cause the subscriber to be deregistered from HSS/HLR.

The operation name does as follows:

  • drop - cancels the location with reason Update Procedure
  • kick - cancels the location with reason Subscription Withdrawn
  • kill - cancels the location with reason Subscription Withdrawn and deletes registration entry preventing further registrations. The repair operation should be used to restore service.

The domain to deregister must be provided as parameter, must be either cspsims or all (which deregisters all domains).

Last parameter is an IMSI prefix (of at least 5 digits) that selects which subscribers to deregister. The dangerous kill operation requires at least 14 digits (matches at most 10 IMSIs).

hss drop all 001020000000001

Kicked out 0 CS registrations
Kicked out 1 PS registrations
Kicked out 0 IMS registrations

hss kick ps 00199

Kicked out 1 PS registrations

hss kill ps 001010000000006

Kicked out 1 PS registrations

Check and repair

This command takes a MSISDN, IMSI or ICCID and tries to fix any database inconsistencies related to matching subscriber, registrations, SIM and sequence numbers.

At the end the command reports the problems detected and actions taken – if any.

hss repair 001010000000006

Errors detected:
Has PS or EPS profile but no PS registration… fixed

hss repair 40316201405

Nothing needed fixing

Our solutions