blob: fddffb2836992de476c939b4620d66da8614982a [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 Hofmeyr3ad481a2019-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 Hofmeyr16a16e62019-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 Hofmeyr3ad481a2019-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 Hofmeyr3ad481a2019-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 Hofmeyr62d916f2019-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 Hofmeyr62d916f2019-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
92 logging level ss info
Neels Hofmeyrf13a8bc2019-11-20 02:36:45 +010093 logging level mslookup notice
94 logging level lu notice
Neels Hofmeyr62d916f2019-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 Hofmeyr62d916f2019-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
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
159 service NAME at IP <1-65535>
160 no service NAME
161 no service NAME at IP <1-65535>
162 msc .UNIT_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 UNIT_NAME IPA Unit Name of the local MSC to configure
200
201OsmoHLR(config-mslookup-server)# msc MSC-1
202OsmoHLR(config-mslookup-server-msc)# ?
203...
204 service Configure addresses of local services, as sent in replies to remote mslookup requests.
205 no Negate a command or set its defaults
206OsmoHLR(config-mslookup-server-msc)# list
207...
208 service NAME at IP <1-65535>
209 no service NAME
210 no service NAME at IP <1-65535>
211
212OsmoHLR(config-mslookup-server-msc)# service?
213 service Configure addresses of local services, as sent in replies to remote mslookup requests.
214OsmoHLR(config-mslookup-server-msc)# service ?
215 NAME mslookup service name, e.g. sip.voice or smpp.sms
216OsmoHLR(config-mslookup-server-msc)# service foo ?
217 at at
218OsmoHLR(config-mslookup-server-msc)# service foo at ?
219 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
220OsmoHLR(config-mslookup-server-msc)# service foo at 1.2.3.4 ?
221 <1-65535> Service-specific port number
222
223OsmoHLR(config-mslookup-server-msc)# no ?
224 service Remove one or more service address entries
225OsmoHLR(config-mslookup-server-msc)# no service ?
226 NAME mslookup service name, e.g. sip.voice or smpp.sms
227OsmoHLR(config-mslookup-server-msc)# no service foo ?
228 at at
229 <cr>
230OsmoHLR(config-mslookup-server-msc)# no service foo at ?
231 IP IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1
232OsmoHLR(config-mslookup-server-msc)# no service foo at 1.2.3.4 ?
233 <1-65535> Service-specific port number
234
235OsmoHLR(config-mslookup-server-msc)# exit
236OsmoHLR(config-mslookup-server)# exit
237OsmoHLR(config-mslookup)# client
238OsmoHLR(config-mslookup-client)# ?
239...
240 timeout How long should the mslookup client wait for remote responses before evaluating received results
241 mdns Multicast DNS related configuration
242 no Negate a command or set its defaults
243 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
244OsmoHLR(config-mslookup-client)# list
245...
246 timeout <1-100000>
247 mdns bind [IP] [<1-65535>]
248 mdns domain-suffix DOMAIN_SUFFIX
249 no mdns
250 gateway-proxy IP [<1-65535>]
251 no gateway-proxy
252
253OsmoHLR(config-mslookup-client)# timeout?
254 timeout How long should the mslookup client wait for remote responses before evaluating received results
255OsmoHLR(config-mslookup-client)# timeout ?
256 <1-100000> timeout in milliseconds
257
258OsmoHLR(config-mslookup-client)# mdns?
259 mdns Multicast DNS related configuration
260OsmoHLR(config-mslookup-client)# mdns bind?
261 bind Enable mDNS client, and configure multicast address to send mDNS mslookup requests to
262OsmoHLR(config-mslookup-client)# mdns bind ?
263 [IP] multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42
264OsmoHLR(config-mslookup-client)# mdns bind 1.2.3.4 ?
265 [<1-65535>] mDNS UDP Port number
266OsmoHLR(config-mslookup-client)# mdns domain-suffix?
267 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
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
270
271
272OsmoHLR(config-mslookup-client)# gateway-proxy?
273 gateway-proxy Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI
274OsmoHLR(config-mslookup-client)# gateway-proxy ?
275 IP IP address of the remote HLR
276OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
277 [<1-65535>] GSUP port number (omit for default 4222)
278
279OsmoHLR(config-mslookup-client)# no?
280 no Negate a command or set its defaults
281OsmoHLR(config-mslookup-client)# no ?
282 mdns Disable mDNS client, do not query remote services by mDNS
283 gateway-proxy Disable gateway proxy for GSUP with unknown IMSIs
284
285OsmoHLR(config-mslookup-client)# gateway-proxy ?
286 IP IP address of the remote HLR
287OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4 ?
288 [<1-65535>] GSUP port number (omit for default 4222)
289
290OsmoHLR(config-mslookup-client)# do show mslookup?
291 mslookup Distributed GSM / mslookup related information
292OsmoHLR(config-mslookup-client)# do show mslookup ?
293 services List configured service addresses as sent to remote mslookup requests
294
295OsmoHLR(config-mslookup-client)# gateway-proxy 1.2.3.4
296
297OsmoHLR(config-mslookup-client)# exit
298
299OsmoHLR(config-mslookup)# mdns bind
300OsmoHLR(config-mslookup)# server
301OsmoHLR(config-mslookup-server)# service qwert at 123.45.67.89 qwert
302% Unknown command.
303OsmoHLR(config-mslookup-server)# service qwert at qwert 1234
304% mslookup server: Invalid address for service qwert: qwert 1234
305OsmoHLR(config-mslookup-server)# service foo.bar at 123.45.67.89 1011
306OsmoHLR(config-mslookup-server)# service baz.bar at 121.31.41.5 1617
307OsmoHLR(config-mslookup-server)# service baz.bar at a:b:c::d 1819
308OsmoHLR(config-mslookup-server)# msc msc-901-70-23
309OsmoHLR(config-mslookup-server-msc)# service foo.bar at 76.54.32.10 1234
310OsmoHLR(config-mslookup-server-msc)# service baz.bar at 12.11.10.98 7654
311OsmoHLR(config-mslookup-server-msc)# service baz.bar at 999:999:999::999 9999
312OsmoHLR(config-mslookup-server-msc)# service baz.bar at dd:cc:bb::a 3210
313OsmoHLR(config-mslookup-server-msc)# exit
314OsmoHLR(config-mslookup-server)# msc msc-901-70-42
315OsmoHLR(config-mslookup-server-msc)# service foo.bar at 1.1.1.1 1111
316OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2.2.2.2 2222
317OsmoHLR(config-mslookup-server-msc)# service baz.bar at 2222:2222:2222::2 2222
318OsmoHLR(config-mslookup-server-msc)# do show mslookup services
319Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
320service foo.bar at 123.45.67.89 1011
321service baz.bar at 121.31.41.5 1617
322service baz.bar at a:b:c::d 1819
323msc MSC-1
324msc msc-901-70-23
325 service foo.bar at 76.54.32.10 1234
326 service baz.bar at 12.11.10.98 7654
327 service baz.bar at dd:cc:bb::a 3210
328msc msc-901-70-42
329 service foo.bar at 1.1.1.1 1111
330 service baz.bar at 2.2.2.2 2222
331 service baz.bar at 2222:2222:2222::2 2222
332
333OsmoHLR(config-mslookup-server-msc)# show running-config
334...
335mslookup
336 server
337 mdns bind 239.192.23.42 4266
338 service foo.bar at 123.45.67.89 1011
339 service baz.bar at 121.31.41.5 1617
340 service baz.bar at a:b:c::d 1819
341 msc MSC-1
342 msc msc-901-70-23
343 service foo.bar at 76.54.32.10 1234
344 service baz.bar at 12.11.10.98 7654
345 service baz.bar at dd:cc:bb::a 3210
346 msc msc-901-70-42
347 service foo.bar at 1.1.1.1 1111
348 service baz.bar at 2.2.2.2 2222
349 service baz.bar at 2222:2222:2222::2 2222
350 client
351 gateway-proxy 1.2.3.4 4222
352 mdns to 239.192.23.42 4266
353...
354
355OsmoHLR(config-mslookup-server-msc)# no service baz.bar
356OsmoHLR(config-mslookup-server-msc)# no service asdf
357% mslookup server: cannot remove service 'asdf'
358OsmoHLR(config-mslookup-server-msc)# exit
359OsmoHLR(config-mslookup-server)# msc msc-901-70-23
360OsmoHLR(config-mslookup-server-msc)# no service baz.bar at dd:cc:bb::a 3210
361% mslookup server: cannot remove service 'baz.bar' to dd:cc:bb::a 3210
362OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf asdf
363% Unknown command.
364OsmoHLR(config-mslookup-server-msc)# no service asdf at asdf 3210
365% mslookup server: Invalid address for 'no service' asdf: asdf 3210
366OsmoHLR(config-mslookup-server-msc)# no service asdf at dd:cc:bb::a 3210
367% mslookup server: cannot remove service 'asdf' to dd:cc:bb::a 3210
368OsmoHLR(config-mslookup-server-msc)# exit
369OsmoHLR(config-mslookup-server)# no service baz.bar at 2.2.2.2 2222
370% mslookup server: cannot remove service 'baz.bar' to 2.2.2.2 2222
371OsmoHLR(config-mslookup-server)# no service baz.bar at a:b:c::d 1819
372% mslookup server: cannot remove service 'baz.bar' to a:b:c::d 1819
373
374OsmoHLR(config-mslookup-server)# exit
375OsmoHLR(config-mslookup)# client
376OsmoHLR(config-mslookup-client)# no gateway-proxy
377
378OsmoHLR(config-mslookup-client)# do show mslookup services
379Local GSUP HLR address returned in mslookup responses for local IMSIs: 127.0.0.1:4222
380service foo.bar at 123.45.67.89 1011
381service baz.bar at 121.31.41.5 1617
382msc MSC-1
383msc msc-901-70-23
384 service foo.bar at 76.54.32.10 1234
385 service baz.bar at 12.11.10.98 7654
386msc msc-901-70-42
387 service foo.bar at 1.1.1.1 1111
388
389OsmoHLR(config-mslookup-client)# show running-config
390...
391mslookup
392 server
393 mdns bind 239.192.23.42 4266
394 service foo.bar at 123.45.67.89 1011
395 service baz.bar at 121.31.41.5 1617
396 msc MSC-1
397 msc msc-901-70-23
398 service foo.bar at 76.54.32.10 1234
399 service baz.bar at 12.11.10.98 7654
400 msc msc-901-70-42
401 service foo.bar at 1.1.1.1 1111
402 client
403 mdns to 239.192.23.42 4266
404...
405
406OsmoHLR(config-mslookup-client)# exit
407OsmoHLR(config-mslookup)# server
408OsmoHLR(config-mslookup-server)# service gsup.hlr at 23.42.17.11 4223
409OsmoHLR(config-mslookup-server)# do show mslookup services
410Local GSUP HLR address returned in mslookup responses for local IMSIs: 23.42.17.11:4223
411service foo.bar at 123.45.67.89 1011
412service baz.bar at 121.31.41.5 1617
413service gsup.hlr at 23.42.17.11 4223
414msc MSC-1
415msc msc-901-70-23
416 service foo.bar at 76.54.32.10 1234
417 service baz.bar at 12.11.10.98 7654
418msc msc-901-70-42
419 service foo.bar at 1.1.1.1 1111
420
421OsmoHLR(config-mslookup-server)# show running-config
422...
423mslookup
424 server
425 mdns bind 239.192.23.42 4266
426 service foo.bar at 123.45.67.89 1011
427 service baz.bar at 121.31.41.5 1617
428 service gsup.hlr at 23.42.17.11 4223
429 msc MSC-1
430 msc msc-901-70-23
431 service foo.bar at 76.54.32.10 1234
432 service baz.bar at 12.11.10.98 7654
433 msc msc-901-70-42
434 service foo.bar at 1.1.1.1 1111
435 client
436 mdns to 239.192.23.42 4266
437...