blob: cf412073736f7a0f59b0d5df04f76d4a92d0d666 [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
Oliver Smith02078b72019-01-11 15:41:29 +010016 subscriber (imsi|msisdn|id|imei) IDENT show
17 show subscriber (imsi|msisdn|id|imei) IDENT
Neels Hofmeyr407925d2019-11-20 03:35:37 +010018 show mslookup services
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020019
20OsmoHLR> enable
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010021OsmoHLR# ?
Neels Hofmeyr86b507b2019-12-04 02:36:25 +010022...
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010023 subscriber Subscriber management commands
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020024
25OsmoHLR# configure terminal
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010026OsmoHLR(config)# ?
27...
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010028 hlr Configure the HLR
Neels Hofmeyr407925d2019-11-20 03:35:37 +010029 mslookup Configure Distributed GSM mslookup
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020030OsmoHLR(config)# list
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020031...
32 hlr
Neels Hofmeyr407925d2019-11-20 03:35:37 +010033 mslookup
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020034
35OsmoHLR(config)# hlr
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010036OsmoHLR(config-hlr)# ?
37...
38 euse Configure a particular External USSD Entity
39 no Negate a command or set its defaults
40 ussd USSD Configuration
41 ncss-guard-timeout Set guard timer for NCSS (call independent SS) session activity
42 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').
43 subscriber-create-on-demand Make a new record when a subscriber is first seen.
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020044OsmoHLR(config-hlr)# list
Oliver Smith2b0bf312019-10-08 11:06:09 +020045...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020046 gsup
Neels Hofmeyr5857c592019-04-02 04:24:49 +020047 database PATH
Harald Welte4956ae12018-06-15 22:04:28 +020048 euse NAME
49 no euse NAME
Harald Weltedab544e2018-07-29 16:14:48 +020050 ussd route prefix PREFIX internal (own-msisdn|own-imsi)
51 ussd route prefix PREFIX external EUSE
52 no ussd route prefix PREFIX
53 ussd default-route external EUSE
54 no ussd default-route
Vadim Yanitskiyd157a562018-12-01 00:03:39 +070055 ncss-guard-timeout <0-255>
Oliver Smith851814a2019-01-11 15:30:21 +010056 store-imei
57 no store-imei
Oliver Smithc7f17872019-03-04 15:10:44 +010058 subscriber-create-on-demand (no-msisdn|<3-15>) (none|cs|ps|cs+ps)
59 no subscriber-create-on-demand
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020060
61OsmoHLR(config-hlr)# gsup
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010062OsmoHLR(config-hlr-gsup)# ?
Oliver Smith2b0bf312019-10-08 11:06:09 +020063...
Neels Hofmeyr76328bd2019-11-20 03:35:37 +010064 bind Listen/Bind related socket option
65 ipa-name Set the IPA name of this HLR, for proxying to remote HLRs
Neels Hofmeyrabdfdb82019-11-25 03:42:43 +010066OsmoHLR(config-hlr-gsup)# list
67...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020068 bind ip A.B.C.D
Neels Hofmeyr76328bd2019-11-20 03:35:37 +010069 ipa-name NAME
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020070
71OsmoHLR(config-hlr-gsup)# exit
72OsmoHLR(config-hlr)# exit
73OsmoHLR(config)# exit
74OsmoHLR# configure terminal
75OsmoHLR(config)# hlr
Oliver Smith851814a2019-01-11 15:30:21 +010076OsmoHLR(config-hlr)# store-imei
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020077OsmoHLR(config-hlr)# gsup
78OsmoHLR(config-hlr-gsup)# end
79OsmoHLR# disable
80OsmoHLR> enable
81
82OsmoHLR# show running-config
83
84Current configuration:
85!
86!
87log stderr
Neels Hofmeyr13000d82018-09-13 18:13:57 +020088...
Harald Weltec88bdab2018-09-26 09:18:13 +020089 logging level main notice
90 logging level db notice
91 logging level auc notice
Philipp Maier377fe5a2020-03-24 20:38:34 +010092 logging level ss notice
Neels Hofmeyrad868e22019-11-20 02:36:45 +010093 logging level mslookup notice
94 logging level lu notice
Neels Hofmeyr76328bd2019-11-20 03:35:37 +010095 logging level dgsm notice
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020096...
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +020097hlr
Oliver Smith851814a2019-01-11 15:30:21 +010098 store-imei
Neels Hofmeyr5857c592019-04-02 04:24:49 +020099 database hlr_vty_test.db
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200100 gsup
101 bind ip 127.0.0.1
Harald Weltedab544e2018-07-29 16:14:48 +0200102 ussd route prefix *#100# internal own-msisdn
Neels Hofmeyra5b36a02018-09-13 18:22:24 +0200103 ussd route prefix *#101# internal own-imsi
Neels Hofmeyr86d09ec2017-10-15 04:58:50 +0200104end
Neels Hofmeyr76328bd2019-11-20 03:35:37 +0100105
106OsmoHLR# configure terminal
107
108OsmoHLR(config)# mslookup
109OsmoHLR(config-mslookup)# ?
110...
111 mdns Multicast DNS related configuration
112 no Negate a command or set its defaults
113 server Enable and configure Distributed GSM mslookup server
114 client Enable and configure Distributed GSM mslookup client
115OsmoHLR(config-mslookup)# list
116...
117 mdns bind [IP] [<1-65535>]
118 mdns domain-suffix DOMAIN_SUFFIX
119 no mdns bind
120 server
121 no server
122 client
123 no client
124
125OsmoHLR(config-mslookup)# ?
126...
127 mdns Multicast DNS related configuration
128 no Negate a command or set its defaults
129 server Enable and configure Distributed GSM mslookup server
130 client Enable and configure Distributed GSM mslookup client
131OsmoHLR(config-mslookup)# no?
132 no Negate a command or set its defaults
133OsmoHLR(config-mslookup)# no ?
134 mdns Disable both server and client for mDNS mslookup
135 server Disable Distributed GSM mslookup server
136 client Disable Distributed GSM mslookup client
137OsmoHLR(config-mslookup)# mdns ?
138 bind Convenience shortcut: enable and configure both server and client for mDNS mslookup
139 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
140OsmoHLR(config-mslookup)# mdns bind ?
141 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
142OsmoHLR(config-mslookup)# mdns bind 1.2.3.4 ?
143 [<1-65535>] mDNS UDP Port number
144OsmoHLR(config-mslookup)# mdns domain-suffix ?
145 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
146
147OsmoHLR(config-mslookup)# server
148OsmoHLR(config-mslookup-server)# ?
149...
150 mdns Multicast DNS related configuration
151 no Negate a command or set its defaults
152 service Configure addresses of local services, as sent in replies to remote mslookup requests.
153 msc Configure services for individual local MSCs
154OsmoHLR(config-mslookup-server)# list
155...
156 mdns bind [IP] [<1-65535>]
157 mdns domain-suffix DOMAIN_SUFFIX
158 no mdns bind
159 service NAME at IP <1-65535>
160 no service NAME
161 no service NAME at IP <1-65535>
162 msc ipa-name .IPA_NAME
163
164OsmoHLR(config-mslookup-server)# mdns ?
165 bind Configure where the mDNS server listens for mslookup requests
166 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
167OsmoHLR(config-mslookup-server)# mdns bind ?
168 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
169OsmoHLR(config-mslookup-server)# mdns bind 1.2.3.4 ?
170 [<1-65535>] mDNS UDP Port number
171
172OsmoHLR(config-mslookup-server)# service?
173 service Configure addresses of local services, as sent in replies to remote mslookup requests.
174OsmoHLR(config-mslookup-server)# service ?
175 NAME mslookup service name, e.g. sip.voice or smpp.sms
176OsmoHLR(config-mslookup-server)# service foo ?
177 at at
178OsmoHLR(config-mslookup-server)# service foo at ?
179 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
180OsmoHLR(config-mslookup-server)# service foo at 1.2.3.4 ?
181 <1-65535> Service-specific port number
182
183OsmoHLR(config-mslookup-server)# no ?
184 mdns Disable server for mDNS mslookup (do not answer remote requests)
185 service Remove one or more service address entries
186OsmoHLR(config-mslookup-server)# no service ?
187 NAME mslookup service name, e.g. sip.voice or smpp.sms
188OsmoHLR(config-mslookup-server)# no service foo ?
189 at at
190 <cr>
191OsmoHLR(config-mslookup-server)# no service foo at ?
192 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
193OsmoHLR(config-mslookup-server)# no service foo at 1.2.3.4 ?
194 <1-65535> Service-specific port number
195
196OsmoHLR(config-mslookup-server)# msc?
197 msc Configure services for individual local MSCs
198OsmoHLR(config-mslookup-server)# msc ?
199 ipa-name Identify locally connected MSC by IPA Unit Name
200OsmoHLR(config-mslookup-server)# msc ipa-name ?
201 IPA_NAME IPA Unit Name of the local MSC to configure
202
203OsmoHLR(config-mslookup-server)# msc ipa-name MSC-1
204OsmoHLR(config-mslookup-server-msc)# ?
205...
206 service Configure addresses of local services, as sent in replies to remote mslookup requests.
207 no Negate a command or set its defaults
208OsmoHLR(config-mslookup-server-msc)# list
209...
210 service NAME at IP <1-65535>
211 no service NAME
212 no service NAME at IP <1-65535>
213
214OsmoHLR(config-mslookup-server-msc)# service?
215 service Configure addresses of local services, as sent in replies to remote mslookup requests.
216OsmoHLR(config-mslookup-server-msc)# service ?
217 NAME mslookup service name, e.g. sip.voice or smpp.sms
218OsmoHLR(config-mslookup-server-msc)# service foo ?
219 at at
220OsmoHLR(config-mslookup-server-msc)# service foo at ?
221 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
222OsmoHLR(config-mslookup-server-msc)# service foo at 1.2.3.4 ?
223 <1-65535> Service-specific port number
224
225OsmoHLR(config-mslookup-server-msc)# no ?
226 service Remove one or more service address entries
227OsmoHLR(config-mslookup-server-msc)# no service ?
228 NAME mslookup service name, e.g. sip.voice or smpp.sms
229OsmoHLR(config-mslookup-server-msc)# no service foo ?
230 at at
231 <cr>
232OsmoHLR(config-mslookup-server-msc)# no service foo at ?
233 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
234OsmoHLR(config-mslookup-server-msc)# no service foo at 1.2.3.4 ?
235 <1-65535> Service-specific port number
236
237OsmoHLR(config-mslookup-server-msc)# exit
238OsmoHLR(config-mslookup-server)# exit
239OsmoHLR(config-mslookup)# client
240OsmoHLR(config-mslookup-client)# ?
241...
242 timeout How long should the mslookup client wait for remote responses before evaluating received results
243 mdns Multicast DNS related configuration
244 no Negate a command or set its defaults
245 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
246OsmoHLR(config-mslookup-client)# list
247...
248 timeout <1-100000>
249 mdns bind [IP] [<1-65535>]
250 mdns domain-suffix DOMAIN_SUFFIX
251 no mdns bind
252 gateway-proxy IP [<1-65535>]
253 no gateway-proxy
254
255OsmoHLR(config-mslookup-client)# timeout?
256 timeout How long should the mslookup client wait for remote responses before evaluating received results
257OsmoHLR(config-mslookup-client)# timeout ?
258 <1-100000> timeout in milliseconds
259
260OsmoHLR(config-mslookup-client)# mdns?
261 mdns Multicast DNS related configuration
262OsmoHLR(config-mslookup-client)# mdns bind?
263 bind Enable mDNS client, and configure multicast address to send mDNS mslookup requests to
264OsmoHLR(config-mslookup-client)# mdns bind ?
265 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
266OsmoHLR(config-mslookup-client)# mdns bind 1.2.3.4 ?
267 [<1-65535>] mDNS UDP Port number
268OsmoHLR(config-mslookup-client)# mdns domain-suffix?
269 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
270OsmoHLR(config-mslookup-client)# mdns domain-suffix ?
271 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
272
273
274OsmoHLR(config-mslookup-client)# gateway-proxy?
275 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
276OsmoHLR(config-mslookup-client)# gateway-proxy ?
277 IP IP address of the remote HLR
278OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
279 [<1-65535>] GSUP port number (omit for default 4222)
280
281OsmoHLR(config-mslookup-client)# no?
282 no Negate a command or set its defaults
283OsmoHLR(config-mslookup-client)# no ?
284 mdns Disable mDNS client, do not query remote services by mDNS
285 gateway-proxy Disable gateway proxy for GSUP with unknown IMSIs
286
287OsmoHLR(config-mslookup-client)# gateway-proxy ?
288 IP IP address of the remote HLR
289OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
290 [<1-65535>] GSUP port number (omit for default 4222)
291
292OsmoHLR(config-mslookup-client)# do show mslookup?
293 mslookup Distributed GSM / mslookup related information
294OsmoHLR(config-mslookup-client)# do show mslookup ?
295 services List configured service addresses as sent to remote mslookup requests
296
297OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4
298
299OsmoHLR(config-mslookup-client)# exit
300
301OsmoHLR(config-mslookup)# mdns bind
302OsmoHLR(config-mslookup)# server
303OsmoHLR(config-mslookup-server)# service qwert at 123.45.67.89 qwert
304% Unknown command.
305OsmoHLR(config-mslookup-server)# service qwert at qwert 1234
306% mslookup server: Invalid address for service qwert: qwert 1234
307OsmoHLR(config-mslookup-server)# service foo.bar at 123.45.67.89 1011
308OsmoHLR(config-mslookup-server)# service baz.bar at 121.31.41.5 1617
309OsmoHLR(config-mslookup-server)# service baz.bar at a:b:c::d 1819
310OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-23
311OsmoHLR(config-mslookup-server-msc)# service foo.bar at 76.54.32.10 1234
312OsmoHLR(config-mslookup-server-msc)# service baz.bar at 12.11.10.98 7654
313OsmoHLR(config-mslookup-server-msc)# service baz.bar at 999:999:999::999 9999
314OsmoHLR(config-mslookup-server-msc)# service baz.bar at dd:cc:bb::a 3210
315OsmoHLR(config-mslookup-server-msc)# exit
316OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-42
317OsmoHLR(config-mslookup-server-msc)# service foo.bar at 1.1.1.1 1111
318OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2.2.2.2 2222
319OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2222:2222:2222::2 2222
320OsmoHLR(config-mslookup-server-msc)# do show mslookup services
321Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
322service foo.bar at 123.45.67.89 1011
323service baz.bar at 121.31.41.5 1617
324service baz.bar at a:b:c::d 1819
325msc ipa-name MSC-1
326msc ipa-name msc-901-70-23
327 service foo.bar at 76.54.32.10 1234
328 service baz.bar at 12.11.10.98 7654
329 service baz.bar at dd:cc:bb::a 3210
330msc ipa-name msc-901-70-42
331 service foo.bar at 1.1.1.1 1111
332 service baz.bar at 2.2.2.2 2222
333 service baz.bar at 2222:2222:2222::2 2222
334
335OsmoHLR(config-mslookup-server-msc)# show running-config
336...
337mslookup
338 server
339 mdns bind 239.192.23.42 4266
340 service foo.bar at 123.45.67.89 1011
341 service baz.bar at 121.31.41.5 1617
342 service baz.bar at a:b:c::d 1819
343 msc MSC-1
344 msc msc-901-70-23
345 service foo.bar at 76.54.32.10 1234
346 service baz.bar at 12.11.10.98 7654
347 service baz.bar at dd:cc:bb::a 3210
348 msc msc-901-70-42
349 service foo.bar at 1.1.1.1 1111
350 service baz.bar at 2.2.2.2 2222
351 service baz.bar at 2222:2222:2222::2 2222
352 client
353 gateway-proxy 1.2.3.4 4222
354 mdns bind 239.192.23.42 4266
355...
356
357OsmoHLR(config-mslookup-server-msc)# no service baz.bar
358OsmoHLR(config-mslookup-server-msc)# no service asdf
359% mslookup server: cannot remove service 'asdf'
360OsmoHLR(config-mslookup-server-msc)# exit
361OsmoHLR(config-mslookup-server)# msc ipa-name msc-901-70-23
362OsmoHLR(config-mslookup-server-msc)# no service baz.bar at dd:cc:bb::a 3210
363% mslookup server: cannot remove service 'baz.bar' to dd:cc:bb::a 3210
364OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf asdf
365% Unknown command.
366OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf 3210
367% mslookup server: Invalid address for 'no service' asdf: asdf 3210
368OsmoHLR(config-mslookup-server-msc)# no service asdf at dd:cc:bb::a 3210
369% mslookup server: cannot remove service 'asdf' to dd:cc:bb::a 3210
370OsmoHLR(config-mslookup-server-msc)# exit
371OsmoHLR(config-mslookup-server)# no service baz.bar at 2.2.2.2 2222
372% mslookup server: cannot remove service 'baz.bar' to 2.2.2.2 2222
373OsmoHLR(config-mslookup-server)# no service baz.bar at a:b:c::d 1819
374% mslookup server: cannot remove service 'baz.bar' to a:b:c::d 1819
375
376OsmoHLR(config-mslookup-server)# exit
377OsmoHLR(config-mslookup)# client
378OsmoHLR(config-mslookup-client)# no gateway-proxy
379
380OsmoHLR(config-mslookup-client)# do show mslookup services
381Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
382service foo.bar at 123.45.67.89 1011
383service baz.bar at 121.31.41.5 1617
384msc ipa-name MSC-1
385msc ipa-name msc-901-70-23
386 service foo.bar at 76.54.32.10 1234
387 service baz.bar at 12.11.10.98 7654
388msc ipa-name msc-901-70-42
389 service foo.bar at 1.1.1.1 1111
390
391OsmoHLR(config-mslookup-client)# show running-config
392...
393mslookup
394 server
395 mdns bind 239.192.23.42 4266
396 service foo.bar at 123.45.67.89 1011
397 service baz.bar at 121.31.41.5 1617
398 msc MSC-1
399 msc msc-901-70-23
400 service foo.bar at 76.54.32.10 1234
401 service baz.bar at 12.11.10.98 7654
402 msc msc-901-70-42
403 service foo.bar at 1.1.1.1 1111
404 client
405 mdns bind 239.192.23.42 4266
406...
407
408OsmoHLR(config-mslookup-client)# exit
409OsmoHLR(config-mslookup)# server
410OsmoHLR(config-mslookup-server)# service gsup.hlr at 23.42.17.11 4223
411OsmoHLR(config-mslookup-server)# do show mslookup services
412Local GSUP HLR address returned in mslookup responses for local IMSIs: 23.42.17.11:4223
413service foo.bar at 123.45.67.89 1011
414service baz.bar at 121.31.41.5 1617
415service gsup.hlr at 23.42.17.11 4223
416msc ipa-name MSC-1
417msc ipa-name msc-901-70-23
418 service foo.bar at 76.54.32.10 1234
419 service baz.bar at 12.11.10.98 7654
420msc ipa-name msc-901-70-42
421 service foo.bar at 1.1.1.1 1111
422
423OsmoHLR(config-mslookup-server)# show running-config
424...
425mslookup
426 server
427 mdns bind 239.192.23.42 4266
428 service foo.bar at 123.45.67.89 1011
429 service baz.bar at 121.31.41.5 1617
430 service gsup.hlr at 23.42.17.11 4223
431 msc MSC-1
432 msc msc-901-70-23
433 service foo.bar at 76.54.32.10 1234
434 service baz.bar at 12.11.10.98 7654
435 msc msc-901-70-42
436 service foo.bar at 1.1.1.1 1111
437 client
438 mdns bind 239.192.23.42 4266
439...