blob: 5848fe14124dbebdaf5694841484c3204fc002f2 [file] [log] [blame]
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +01001OsmoHLR> ?
2 show Show running system information
3 list Print command list
4 exit Exit current mode and down to previous mode
5 help Description of the interactive help system
6 enable Turn on privileged mode command
7 terminal Set terminal line parameters
8 who Display who is on vty
9 logging Configure logging
10 no Negate a command or set its defaults
11 logp Print a message on all log outputs; useful for placing markers in test logs
12 subscriber Subscriber management commands
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020013OsmoHLR> list
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020014...
Harald Weltefa7ee332018-06-24 13:20:32 +020015 show gsup-connections
Keith89fda302021-01-19 07:01:33 +010016 show subscribers all
17 show subscribers (imsi|msisdn) FILTER
18 show subscribers (cs|ps) (on|off)
19 show subscribers last-seen
Oliver Smith02078b72019-01-11 15:41:29 +010020 subscriber (imsi|msisdn|id|imei) IDENT show
21 show subscriber (imsi|msisdn|id|imei) IDENT
Neels Hofmeyr407925d2019-11-20 03:35:37 +010022 show mslookup services
Pau Espin Pedroled18fa92020-08-18 12:58:36 +020023...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020024
25OsmoHLR> enable
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010026OsmoHLR# ?
Neels Hofmeyr86b507b2019-12-04 02:36:25 +010027...
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010028 subscriber Subscriber management commands
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020029
30OsmoHLR# configure terminal
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010031OsmoHLR(config)# ?
32...
Pau Espin Pedroled18fa92020-08-18 12:58:36 +020033 hlr Configure the HLR
34 mslookup Configure Distributed GSM mslookup
35...
36
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020037OsmoHLR(config)# list
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020038...
39 hlr
Neels Hofmeyr407925d2019-11-20 03:35:37 +010040 mslookup
Pau Espin Pedroled18fa92020-08-18 12:58:36 +020041...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020042
43OsmoHLR(config)# hlr
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010044OsmoHLR(config-hlr)# ?
45...
46 euse Configure a particular External USSD Entity
47 no Negate a command or set its defaults
48 ussd USSD Configuration
49 ncss-guard-timeout Set guard timer for NCSS (call independent SS) session activity
50 store-imei Save the IMEI in the database when receiving Check IMEI requests. Note that an MSC does not necessarily send Check IMEI requests (for OsmoMSC, you may want to set 'check-imei-rqd 1').
51 subscriber-create-on-demand Make a new record when a subscriber is first seen.
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020052OsmoHLR(config-hlr)# list
Oliver Smith2b0bf312019-10-08 11:06:09 +020053...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020054 gsup
Neels Hofmeyr5857c592019-04-02 04:24:49 +020055 database PATH
Harald Welte4956ae12018-06-15 22:04:28 +020056 euse NAME
57 no euse NAME
Vadim Yanitskiydac855e2020-11-17 04:17:46 +070058 ussd route prefix PREFIX internal (own-msisdn|own-imsi|test-idle)
Harald Weltedab544e2018-07-29 16:14:48 +020059 ussd route prefix PREFIX external EUSE
60 no ussd route prefix PREFIX
61 ussd default-route external EUSE
62 no ussd default-route
Vadim Yanitskiyd157a562018-12-01 00:03:39 +070063 ncss-guard-timeout <0-255>
Oliver Smith851814a2019-01-11 15:30:21 +010064 store-imei
65 no store-imei
Oliver Smithc7f17872019-03-04 15:10:44 +010066 subscriber-create-on-demand (no-msisdn|<3-15>) (none|cs|ps|cs+ps)
67 no subscriber-create-on-demand
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020068
69OsmoHLR(config-hlr)# gsup
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010070OsmoHLR(config-hlr-gsup)# ?
Oliver Smith2b0bf312019-10-08 11:06:09 +020071...
Neels Hofmeyr76328bd2019-11-20 03:35:37 +010072 bind Listen/Bind related socket option
73 ipa-name Set the IPA name of this HLR, for proxying to remote HLRs
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010074OsmoHLR(config-hlr-gsup)# list
75...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020076 bind ip A.B.C.D
Neels Hofmeyr76328bd2019-11-20 03:35:37 +010077 ipa-name NAME
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020078
79OsmoHLR(config-hlr-gsup)# exit
80OsmoHLR(config-hlr)# exit
81OsmoHLR(config)# exit
82OsmoHLR# configure terminal
83OsmoHLR(config)# hlr
Oliver Smith851814a2019-01-11 15:30:21 +010084OsmoHLR(config-hlr)# store-imei
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020085OsmoHLR(config-hlr)# gsup
86OsmoHLR(config-hlr-gsup)# end
87OsmoHLR# disable
88OsmoHLR> enable
89
90OsmoHLR# show running-config
91
92Current configuration:
93!
94!
95log stderr
Neels Hofmeyr13000d82018-09-13 18:13:57 +020096...
Harald Weltec88bdab2018-09-26 09:18:13 +020097 logging level main notice
98 logging level db notice
99 logging level auc notice
Philipp Maier377fe5a2020-03-24 20:38:34 +0100100 logging level ss notice
Neels Hofmeyrad868e22019-11-20 02:36:45 +0100101 logging level mslookup notice
102 logging level lu notice
Neels Hofmeyr76328bd2019-11-20 03:35:37 +0100103 logging level dgsm notice
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200104...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200105hlr
Oliver Smith851814a2019-01-11 15:30:21 +0100106 store-imei
Neels Hofmeyr5857c592019-04-02 04:24:49 +0200107 database hlr_vty_test.db
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200108 gsup
109 bind ip 127.0.0.1
Harald Weltedab544e2018-07-29 16:14:48 +0200110 ussd route prefix *#100# internal own-msisdn
Neels Hofmeyra5b36a02018-09-13 18:22:24 +0200111 ussd route prefix *#101# internal own-imsi
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200112end
Neels Hofmeyr76328bd2019-11-20 03:35:37 +0100113
114OsmoHLR# configure terminal
115
116OsmoHLR(config)# mslookup
117OsmoHLR(config-mslookup)# ?
118...
119 mdns Multicast DNS related configuration
120 no Negate a command or set its defaults
121 server Enable and configure Distributed GSM mslookup server
122 client Enable and configure Distributed GSM mslookup client
123OsmoHLR(config-mslookup)# list
124...
125 mdns bind [IP] [<1-65535>]
126 mdns domain-suffix DOMAIN_SUFFIX
127 no mdns bind
128 server
129 no server
130 client
131 no client
132
133OsmoHLR(config-mslookup)# ?
134...
135 mdns Multicast DNS related configuration
136 no Negate a command or set its defaults
137 server Enable and configure Distributed GSM mslookup server
138 client Enable and configure Distributed GSM mslookup client
139OsmoHLR(config-mslookup)# no?
140 no Negate a command or set its defaults
141OsmoHLR(config-mslookup)# no ?
142 mdns Disable both server and client for mDNS mslookup
143 server Disable Distributed GSM mslookup server
144 client Disable Distributed GSM mslookup client
145OsmoHLR(config-mslookup)# mdns ?
146 bind Convenience shortcut: enable and configure both server and client for mDNS mslookup
147 domain-suffix mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA
148OsmoHLR(config-mslookup)# mdns bind ?
149 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
150OsmoHLR(config-mslookup)# mdns bind 1.2.3.4 ?
151 [<1-65535>] mDNS UDP Port number
152OsmoHLR(config-mslookup)# mdns domain-suffix ?
153 DOMAIN_SUFFIX mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA
154
155OsmoHLR(config-mslookup)# server
156OsmoHLR(config-mslookup-server)# ?
157...
158 mdns Multicast DNS related configuration
159 no Negate a command or set its defaults
160 service Configure addresses of local services, as sent in replies to remote mslookup requests.
161 msc Configure services for individual local MSCs
162OsmoHLR(config-mslookup-server)# list
163...
164 mdns bind [IP] [<1-65535>]
165 mdns domain-suffix DOMAIN_SUFFIX
166 no mdns bind
167 service NAME at IP <1-65535>
168 no service NAME
169 no service NAME at IP <1-65535>
170 msc ipa-name .IPA_NAME
171
172OsmoHLR(config-mslookup-server)# mdns ?
173 bind Configure where the mDNS server listens for mslookup requests
174 domain-suffix mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA
175OsmoHLR(config-mslookup-server)# mdns bind ?
176 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
177OsmoHLR(config-mslookup-server)# mdns bind 1.2.3.4 ?
178 [<1-65535>] mDNS UDP Port number
179
180OsmoHLR(config-mslookup-server)# service?
181 service Configure addresses of local services, as sent in replies to remote mslookup requests.
182OsmoHLR(config-mslookup-server)# service ?
183 NAME mslookup service name, e.g. sip.voice or smpp.sms
184OsmoHLR(config-mslookup-server)# service foo ?
185 at at
186OsmoHLR(config-mslookup-server)# service foo at ?
187 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
188OsmoHLR(config-mslookup-server)# service foo at 1.2.3.4 ?
189 <1-65535> Service-specific port number
190
191OsmoHLR(config-mslookup-server)# no ?
192 mdns Disable server for mDNS mslookup (do not answer remote requests)
193 service Remove one or more service address entries
194OsmoHLR(config-mslookup-server)# no service ?
195 NAME mslookup service name, e.g. sip.voice or smpp.sms
196OsmoHLR(config-mslookup-server)# no service foo ?
197 at at
198 <cr>
199OsmoHLR(config-mslookup-server)# no service foo at ?
200 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
201OsmoHLR(config-mslookup-server)# no service foo at 1.2.3.4 ?
202 <1-65535> Service-specific port number
203
204OsmoHLR(config-mslookup-server)# msc?
205 msc Configure services for individual local MSCs
206OsmoHLR(config-mslookup-server)# msc ?
207 ipa-name Identify locally connected MSC by IPA Unit Name
208OsmoHLR(config-mslookup-server)# msc ipa-name ?
209 IPA_NAME IPA Unit Name of the local MSC to configure
210
211OsmoHLR(config-mslookup-server)# msc ipa-name MSC-1
212OsmoHLR(config-mslookup-server-msc)# ?
213...
214 service Configure addresses of local services, as sent in replies to remote mslookup requests.
215 no Negate a command or set its defaults
216OsmoHLR(config-mslookup-server-msc)# list
217...
218 service NAME at IP <1-65535>
219 no service NAME
220 no service NAME at IP <1-65535>
221
222OsmoHLR(config-mslookup-server-msc)# service?
223 service Configure addresses of local services, as sent in replies to remote mslookup requests.
224OsmoHLR(config-mslookup-server-msc)# service ?
225 NAME mslookup service name, e.g. sip.voice or smpp.sms
226OsmoHLR(config-mslookup-server-msc)# service foo ?
227 at at
228OsmoHLR(config-mslookup-server-msc)# service foo at ?
229 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
230OsmoHLR(config-mslookup-server-msc)# service foo at 1.2.3.4 ?
231 <1-65535> Service-specific port number
232
233OsmoHLR(config-mslookup-server-msc)# no ?
234 service Remove one or more service address entries
235OsmoHLR(config-mslookup-server-msc)# no service ?
236 NAME mslookup service name, e.g. sip.voice or smpp.sms
237OsmoHLR(config-mslookup-server-msc)# no service foo ?
238 at at
239 <cr>
240OsmoHLR(config-mslookup-server-msc)# no service foo at ?
241 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
242OsmoHLR(config-mslookup-server-msc)# no service foo at 1.2.3.4 ?
243 <1-65535> Service-specific port number
244
245OsmoHLR(config-mslookup-server-msc)# exit
246OsmoHLR(config-mslookup-server)# exit
247OsmoHLR(config-mslookup)# client
248OsmoHLR(config-mslookup-client)# ?
249...
250 timeout How long should the mslookup client wait for remote responses before evaluating received results
251 mdns Multicast DNS related configuration
252 no Negate a command or set its defaults
253 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
254OsmoHLR(config-mslookup-client)# list
255...
256 timeout <1-100000>
257 mdns bind [IP] [<1-65535>]
258 mdns domain-suffix DOMAIN_SUFFIX
259 no mdns bind
260 gateway-proxy IP [<1-65535>]
261 no gateway-proxy
262
263OsmoHLR(config-mslookup-client)# timeout?
264 timeout How long should the mslookup client wait for remote responses before evaluating received results
265OsmoHLR(config-mslookup-client)# timeout ?
266 <1-100000> timeout in milliseconds
267
268OsmoHLR(config-mslookup-client)# mdns?
269 mdns Multicast DNS related configuration
270OsmoHLR(config-mslookup-client)# mdns bind?
271 bind Enable mDNS client, and configure multicast address to send mDNS mslookup requests to
272OsmoHLR(config-mslookup-client)# mdns bind ?
273 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
274OsmoHLR(config-mslookup-client)# mdns bind 1.2.3.4 ?
275 [<1-65535>] mDNS UDP Port number
276OsmoHLR(config-mslookup-client)# mdns domain-suffix?
277 domain-suffix mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA
278OsmoHLR(config-mslookup-client)# mdns domain-suffix ?
279 DOMAIN_SUFFIX mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA
280
281
282OsmoHLR(config-mslookup-client)# gateway-proxy?
283 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
284OsmoHLR(config-mslookup-client)# gateway-proxy ?
285 IP IP address of the remote HLR
286OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
287 [<1-65535>] GSUP port number (omit for default 4222)
288
289OsmoHLR(config-mslookup-client)# no?
290 no Negate a command or set its defaults
291OsmoHLR(config-mslookup-client)# no ?
292 mdns Disable mDNS client, do not query remote services by mDNS
293 gateway-proxy Disable gateway proxy for GSUP with unknown IMSIs
294
295OsmoHLR(config-mslookup-client)# gateway-proxy ?
296 IP IP address of the remote HLR
297OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
298 [<1-65535>] GSUP port number (omit for default 4222)
299
300OsmoHLR(config-mslookup-client)# do show mslookup?
301 mslookup Distributed GSM / mslookup related information
302OsmoHLR(config-mslookup-client)# do show mslookup ?
303 services List configured service addresses as sent to remote mslookup requests
304
305OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4
306
307OsmoHLR(config-mslookup-client)# exit
308
309OsmoHLR(config-mslookup)# mdns bind
310OsmoHLR(config-mslookup)# server
311OsmoHLR(config-mslookup-server)# service qwert at 123.45.67.89 qwert
312% Unknown command.
313OsmoHLR(config-mslookup-server)# service qwert at qwert 1234
314% mslookup server: Invalid address for service qwert: qwert 1234
315OsmoHLR(config-mslookup-server)# service foo.bar at 123.45.67.89 1011
316OsmoHLR(config-mslookup-server)# service baz.bar at 121.31.41.5 1617
317OsmoHLR(config-mslookup-server)# service baz.bar at a:b:c::d 1819
318OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-23
319OsmoHLR(config-mslookup-server-msc)# service foo.bar at 76.54.32.10 1234
320OsmoHLR(config-mslookup-server-msc)# service baz.bar at 12.11.10.98 7654
321OsmoHLR(config-mslookup-server-msc)# service baz.bar at 999:999:999::999 9999
322OsmoHLR(config-mslookup-server-msc)# service baz.bar at dd:cc:bb::a 3210
323OsmoHLR(config-mslookup-server-msc)# exit
324OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-42
325OsmoHLR(config-mslookup-server-msc)# service foo.bar at 1.1.1.1 1111
326OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2.2.2.2 2222
327OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2222:2222:2222::2 2222
328OsmoHLR(config-mslookup-server-msc)# do show mslookup services
329Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
330service foo.bar at 123.45.67.89 1011
331service baz.bar at 121.31.41.5 1617
332service baz.bar at a:b:c::d 1819
333msc ipa-name MSC-1
334msc ipa-name msc-901-70-23
335 service foo.bar at 76.54.32.10 1234
336 service baz.bar at 12.11.10.98 7654
337 service baz.bar at dd:cc:bb::a 3210
338msc ipa-name msc-901-70-42
339 service foo.bar at 1.1.1.1 1111
340 service baz.bar at 2.2.2.2 2222
341 service baz.bar at 2222:2222:2222::2 2222
342
343OsmoHLR(config-mslookup-server-msc)# show running-config
344...
345mslookup
346 server
347 mdns bind 239.192.23.42 4266
348 service foo.bar at 123.45.67.89 1011
349 service baz.bar at 121.31.41.5 1617
350 service baz.bar at a:b:c::d 1819
351 msc MSC-1
352 msc msc-901-70-23
353 service foo.bar at 76.54.32.10 1234
354 service baz.bar at 12.11.10.98 7654
355 service baz.bar at dd:cc:bb::a 3210
356 msc msc-901-70-42
357 service foo.bar at 1.1.1.1 1111
358 service baz.bar at 2.2.2.2 2222
359 service baz.bar at 2222:2222:2222::2 2222
360 client
361 gateway-proxy 1.2.3.4 4222
362 mdns bind 239.192.23.42 4266
363...
364
365OsmoHLR(config-mslookup-server-msc)# no service baz.bar
366OsmoHLR(config-mslookup-server-msc)# no service asdf
367% mslookup server: cannot remove service 'asdf'
368OsmoHLR(config-mslookup-server-msc)# exit
369OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-23
370OsmoHLR(config-mslookup-server-msc)# no service baz.bar at dd:cc:bb::a 3210
371% mslookup server: cannot remove service 'baz.bar' to dd:cc:bb::a 3210
372OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf asdf
373% Unknown command.
374OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf 3210
375% mslookup server: Invalid address for 'no service' asdf: asdf 3210
376OsmoHLR(config-mslookup-server-msc)# no service asdf at dd:cc:bb::a 3210
377% mslookup server: cannot remove service 'asdf' to dd:cc:bb::a 3210
378OsmoHLR(config-mslookup-server-msc)# exit
379OsmoHLR(config-mslookup-server)# no service baz.bar at 2.2.2.2 2222
380% mslookup server: cannot remove service 'baz.bar' to 2.2.2.2 2222
381OsmoHLR(config-mslookup-server)# no service baz.bar at a:b:c::d 1819
382% mslookup server: cannot remove service 'baz.bar' to a:b:c::d 1819
383
384OsmoHLR(config-mslookup-server)# exit
385OsmoHLR(config-mslookup)# client
386OsmoHLR(config-mslookup-client)# no gateway-proxy
387
388OsmoHLR(config-mslookup-client)# do show mslookup services
389Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
390service foo.bar at 123.45.67.89 1011
391service baz.bar at 121.31.41.5 1617
392msc ipa-name MSC-1
393msc ipa-name msc-901-70-23
394 service foo.bar at 76.54.32.10 1234
395 service baz.bar at 12.11.10.98 7654
396msc ipa-name msc-901-70-42
397 service foo.bar at 1.1.1.1 1111
398
399OsmoHLR(config-mslookup-client)# show running-config
400...
401mslookup
402 server
403 mdns bind 239.192.23.42 4266
404 service foo.bar at 123.45.67.89 1011
405 service baz.bar at 121.31.41.5 1617
406 msc MSC-1
407 msc msc-901-70-23
408 service foo.bar at 76.54.32.10 1234
409 service baz.bar at 12.11.10.98 7654
410 msc msc-901-70-42
411 service foo.bar at 1.1.1.1 1111
412 client
413 mdns bind 239.192.23.42 4266
414...
415
416OsmoHLR(config-mslookup-client)# exit
417OsmoHLR(config-mslookup)# server
418OsmoHLR(config-mslookup-server)# service gsup.hlr at 23.42.17.11 4223
419OsmoHLR(config-mslookup-server)# do show mslookup services
420Local GSUP HLR address returned in mslookup responses for local IMSIs: 23.42.17.11:4223
421service foo.bar at 123.45.67.89 1011
422service baz.bar at 121.31.41.5 1617
423service gsup.hlr at 23.42.17.11 4223
424msc ipa-name MSC-1
425msc ipa-name msc-901-70-23
426 service foo.bar at 76.54.32.10 1234
427 service baz.bar at 12.11.10.98 7654
428msc ipa-name msc-901-70-42
429 service foo.bar at 1.1.1.1 1111
430
431OsmoHLR(config-mslookup-server)# show running-config
432...
433mslookup
434 server
435 mdns bind 239.192.23.42 4266
436 service foo.bar at 123.45.67.89 1011
437 service baz.bar at 121.31.41.5 1617
438 service gsup.hlr at 23.42.17.11 4223
439 msc MSC-1
440 msc msc-901-70-23
441 service foo.bar at 76.54.32.10 1234
442 service baz.bar at 12.11.10.98 7654
443 msc msc-901-70-42
444 service foo.bar at 1.1.1.1 1111
445 client
446 mdns bind 239.192.23.42 4266
447...