Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-msc / 8fa2dbe5b1c69bf2c481c9893bc88675bdfb0ede / . / doc / manuals / vty / msc_vty_reference.xml
blob: bb7e958b2e8741883c28a991b63cb51f28039469 [file] [log] [blame]
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
2 <node id='_common_cmds_'>
3 <name>Common Commands</name>
4 <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
5 <command id='help'>
6 <params>
7 <param name='help' doc='Description of the interactive help system' />
8 </params>
9 </command>
10 <command id='list'>
11 <params>
12 <param name='list' doc='Print command list' />
13 </params>
14 </command>
15 <command id='write terminal'>
16 <params>
17 <param name='write' doc='Write running configuration to memory, network, or terminal' />
18 <param name='terminal' doc='Write to terminal' />
19 </params>
20 </command>
21 <command id='write file'>
22 <params>
23 <param name='write' doc='Write running configuration to memory, network, or terminal' />
24 <param name='file' doc='Write to configuration file' />
25 </params>
26 </command>
27 <command id='write memory'>
28 <params>
29 <param name='write' doc='Write running configuration to memory, network, or terminal' />
30 <param name='memory' doc='Write configuration to the file (same as write file)' />
31 </params>
32 </command>
33 <command id='write'>
34 <params>
35 <param name='write' doc='Write running configuration to memory, network, or terminal' />
36 </params>
37 </command>
38 <command id='show running-config'>
39 <params>
40 <param name='show' doc='Show running system information' />
41 <param name='running-config' doc='running configuration' />
42 </params>
43 </command>
44 <command id='exit'>
45 <params>
46 <param name='exit' doc='Exit current mode and down to previous mode' />
47 </params>
48 </command>
49 <command id='end'>
50 <params>
51 <param name='end' doc='End current mode and change to enable mode.' />
52 </params>
53 </command>
54 </node>
55 <node id='view'>
56 <name>view</name>
57 <command id='show version'>
58 <params>
59 <param name='show' doc='Show running system information' />
60 <param name='version' doc='Displays program version' />
61 </params>
62 </command>
63 <command id='show online-help'>
64 <params>
65 <param name='show' doc='Show running system information' />
66 <param name='online-help' doc='Online help' />
67 </params>
68 </command>
69 <command id='enable'>
70 <params>
71 <param name='enable' doc='Turn on privileged mode command' />
72 </params>
73 </command>
74 <command id='terminal length &lt;0-512&gt;'>
75 <params>
76 <param name='terminal' doc='Set terminal line parameters' />
77 <param name='length' doc='Set number of lines on a screen' />
78 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
79 </params>
80 </command>
81 <command id='terminal no length'>
82 <params>
83 <param name='terminal' doc='Set terminal line parameters' />
84 <param name='no' doc='Negate a command or set its defaults' />
85 <param name='length' doc='Set number of lines on a screen' />
86 </params>
87 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]88 <command id='who'>
89 <params>
90 <param name='who' doc='Display who is on vty' />
91 </params>
92 </command>
93 <command id='show history'>
94 <params>
95 <param name='show' doc='Show running system information' />
96 <param name='history' doc='Display the session command history' />
97 </params>
98 </command>
99 <command id='show cs7 instance &lt;0-15&gt; users'>
100 <params>
101 <param name='show' doc='Show running system information' />
102 <param name='cs7' doc='ITU-T Signaling System 7' />
103 <param name='instance' doc='An instance of the SS7 stack' />
104 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
105 <param name='users' doc='User Table' />
106 </params>
107 </command>
108 <command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
109 <params>
110 <param name='show' doc='Show running system information' />
111 <param name='cs7' doc='ITU-T Signaling System 7' />
112 <param name='sua' doc='SCCP User Adaptation' />
113 <param name='m3ua' doc='MTP3 User Adaptation' />
114 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
115 <param name='[&lt;0-65534&gt;]' doc='Port Number' />
116 </params>
117 </command>
118 <command id='show cs7 instance &lt;0-15&gt; asp'>
119 <params>
120 <param name='show' doc='Show running system information' />
121 <param name='cs7' doc='ITU-T Signaling System 7' />
122 <param name='instance' doc='An instance of the SS7 stack' />
123 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
124 <param name='asp' doc='Application Server Process (ASP)' />
125 </params>
126 </command>
127 <command id='show cs7 instance &lt;0-15&gt; as (active|all|m3ua|sua)'>
128 <params>
129 <param name='show' doc='Show running system information' />
130 <param name='cs7' doc='ITU-T Signaling System 7' />
131 <param name='instance' doc='An instance of the SS7 stack' />
132 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
133 <param name='as' doc='Application Server (AS)' />
134 <param name='active' doc='Display all active ASs' />
135 <param name='all' doc='Display all ASs (default)' />
136 <param name='m3ua' doc='Display all m3ua ASs' />
137 <param name='sua' doc='Display all SUA ASs' />
138 </params>
139 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]140 <command id='show cs7 instance &lt;0-15&gt; sccp addressbook'>
141 <params>
142 <param name='show' doc='Show running system information' />
143 <param name='cs7' doc='ITU-T Signaling System 7' />
144 <param name='instance' doc='An instance of the SS7 stack' />
145 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
146 <param name='sccp' doc='Signalling Connection Control Part' />
147 <param name='addressbook' doc='List all SCCP addressbook entries' />
148 </params>
149 </command>
150 <command id='show cs7 instance &lt;0-15&gt; sccp users'>
151 <params>
152 <param name='show' doc='Show running system information' />
153 <param name='cs7' doc='ITU-T Signaling System 7' />
154 <param name='instance' doc='An instance of the SS7 stack' />
155 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
156 <param name='sccp' doc='Signalling Connection Control Part' />
157 <param name='users' doc='Show List of SCCP Users registered' />
158 </params>
159 </command>
160 <command id='show cs7 instance &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
161 <params>
162 <param name='show' doc='Show running system information' />
163 <param name='cs7' doc='ITU-T Signaling System 7' />
164 <param name='instance' doc='An instance of the SS7 stack' />
165 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
166 <param name='sccp' doc='Signalling Connection Control Part' />
167 <param name='ssn' doc='Find an SCCP User registered for the given SSN' />
168 <param name='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
169 </params>
170 </command>
171 <command id='show cs7 instance &lt;0-15&gt; sccp connections'>
172 <params>
173 <param name='show' doc='Show running system information' />
174 <param name='cs7' doc='ITU-T Signaling System 7' />
175 <param name='instance' doc='An instance of the SS7 stack' />
176 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
177 <param name='sccp' doc='Signalling Connection Control Part' />
178 <param name='connections' doc='Show List of active SCCP connections' />
179 </params>
180 </command>
181 <command id='show cs7 instance &lt;0-15&gt; sccp timers'>
182 <params>
183 <param name='show' doc='Show running system information' />
184 <param name='cs7' doc='ITU-T Signaling System 7' />
185 <param name='instance' doc='An instance of the SS7 stack' />
186 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
187 <param name='sccp' doc='Signaling Connection Control Part' />
188 <param name='timers' doc='Show List of SCCP timers' />
189 </params>
190 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]191 <command id='logging enable'>
192 <params>
193 <param name='logging' doc='Configure logging' />
194 <param name='enable' doc='Enables logging to this vty' />
195 </params>
196 </command>
197 <command id='logging disable'>
198 <params>
199 <param name='logging' doc='Configure logging' />
200 <param name='disable' doc='Disables logging to this vty' />
201 </params>
202 </command>
203 <command id='logging filter all (0|1)'>
204 <params>
205 <param name='logging' doc='Configure logging' />
206 <param name='filter' doc='Filter log messages' />
207 <param name='all' doc='Do you want to log all messages?' />
208 <param name='0' doc='Only print messages matched by other filters' />
209 <param name='1' doc='Bypass filter and print all messages' />
210 </params>
211 </command>
212 <command id='logging color (0|1)'>
213 <params>
214 <param name='logging' doc='Configure logging' />
215 <param name='color' doc='Configure color-printing for log messages' />
216 <param name='0' doc='Don&apos;t use color for printing messages' />
217 <param name='1' doc='Use color for printing messages' />
218 </params>
219 </command>
220 <command id='logging timestamp (0|1)'>
221 <params>
222 <param name='logging' doc='Configure logging' />
223 <param name='timestamp' doc='Configure log message timestamping' />
224 <param name='0' doc='Don&apos;t prefix each log message' />
225 <param name='1' doc='Prefix each log message with current timestamp' />
226 </params>
227 </command>
228 <command id='logging print extended-timestamp (0|1)'>
229 <params>
230 <param name='logging' doc='Configure logging' />
231 <param name='print' doc='Log output settings' />
232 <param name='extended-timestamp' doc='Configure log message timestamping' />
233 <param name='0' doc='Don&apos;t prefix each log message' />
234 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
235 </params>
236 </command>
237 <command id='logging print category (0|1)'>
238 <params>
239 <param name='logging' doc='Configure logging' />
240 <param name='print' doc='Log output settings' />
241 <param name='category' doc='Configure log message' />
242 <param name='0' doc='Don&apos;t prefix each log message' />
243 <param name='1' doc='Prefix each log message with category/subsystem name' />
244 </params>
245 </command>
246 <command id='logging print category-hex (0|1)'>
247 <params>
248 <param name='logging' doc='Configure logging' />
249 <param name='print' doc='Log output settings' />
250 <param name='category-hex' doc='Configure log message' />
251 <param name='0' doc='Don&apos;t prefix each log message' />
252 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
253 </params>
254 </command>
255 <command id='logging print level (0|1)'>
256 <params>
257 <param name='logging' doc='Configure logging' />
258 <param name='print' doc='Log output settings' />
259 <param name='level' doc='Configure log message' />
260 <param name='0' doc='Don&apos;t prefix each log message' />
261 <param name='1' doc='Prefix each log message with the log level name' />
262 </params>
263 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]264 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]265 <params>
266 <param name='logging' doc='Configure logging' />
267 <param name='print' doc='Log output settings' />
268 <param name='file' doc='Configure log message' />
269 <param name='0' doc='Don&apos;t prefix each log message' />
270 <param name='1' doc='Prefix each log message with the source file and line' />
271 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]272 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]273 </params>
274 </command>
275 <command id='logging set-log-mask MASK'>
276 <params>
277 <param name='logging' doc='Configure logging' />
278 <param name='set-log-mask' doc='Set the logmask of this logging target' />
279 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
280 </params>
281 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]282 <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]283 <params>
284 <param name='logging' doc='Configure logging' />
285 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]286 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
287 <param name='cc' doc='Layer3 Call Control (CC)' />
288 <param name='mm' doc='Layer3 Mobility Management (MM)' />
289 <param name='rr' doc='Layer3 Radio Resource (RR)' />
290 <param name='mncc' doc='MNCC API for Call Control application' />
291 <param name='pag' doc='Paging Subsystem' />
292 <param name='msc' doc='Mobile Switching Center' />
293 <param name='mgcp' doc='Media Gateway Control Protocol' />
294 <param name='ho' doc='Hand-Over' />
295 <param name='db' doc='Database Layer' />
296 <param name='ref' doc='Reference Counting' />
297 <param name='ctrl' doc='Control interface' />
298 <param name='smpp' doc='SMPP interface for external SMS apps' />
299 <param name='ranap' doc='Radio Access Network Application Part Protocol' />
300 <param name='vlr' doc='Visitor Location Register' />
301 <param name='iucs' doc='Iu-CS Protocol' />
302 <param name='bssap' doc='BSSAP Protocol (A Interface)' />
303 <param name='lglobal' doc='Library-internal global log family' />
304 <param name='llapd' doc='LAPD in libosmogsm' />
305 <param name='linp' doc='A-bis Intput Subsystem' />
306 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
307 <param name='lmi' doc='A-bis Input Driver for Signalling' />
308 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
309 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
310 <param name='lctrl' doc='Control Interface' />
311 <param name='lgtp' doc='GPRS GTP library' />
312 <param name='lstats' doc='Statistics messages and logging' />
313 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
314 <param name='loap' doc='Osmocom Authentication Protocol' />
315 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
316 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
317 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
318 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
319 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
320 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]321 <param name='debug' doc='Log debug messages and higher levels' />
322 <param name='info' doc='Log informational messages and higher levels' />
323 <param name='notice' doc='Log noticeable messages and higher levels' />
324 <param name='error' doc='Log error messages and higher levels' />
325 <param name='fatal' doc='Log only fatal messages' />
326 </params>
327 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]328 <command id='logging level set-all (debug|info|notice|error|fatal)'>
329 <params>
330 <param name='logging' doc='Configure logging' />
331 <param name='level' doc='Set the log level for a specified category' />
332 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
333 <param name='debug' doc='Log debug messages and higher levels' />
334 <param name='info' doc='Log informational messages and higher levels' />
335 <param name='notice' doc='Log noticeable messages and higher levels' />
336 <param name='error' doc='Log error messages and higher levels' />
337 <param name='fatal' doc='Log only fatal messages' />
338 </params>
339 </command>
340 <command id='logging level force-all (debug|info|notice|error|fatal)'>
341 <params>
342 <param name='logging' doc='Configure logging' />
343 <param name='level' doc='Set the log level for a specified category' />
344 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
345 <param name='debug' doc='Log debug messages and higher levels' />
346 <param name='info' doc='Log informational messages and higher levels' />
347 <param name='notice' doc='Log noticeable messages and higher levels' />
348 <param name='error' doc='Log error messages and higher levels' />
349 <param name='fatal' doc='Log only fatal messages' />
350 </params>
351 </command>
352 <command id='no logging level force-all'>
353 <params>
354 <param name='no' doc='Negate a command or set its defaults' />
355 <param name='logging' doc='Configure logging' />
356 <param name='level' doc='Set the log level for a specified category' />
357 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
358 </params>
359 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]360 <command id='show logging vty'>
361 <params>
362 <param name='show' doc='Show running system information' />
363 <param name='logging' doc='Show current logging configuration' />
364 <param name='vty' doc='Show current logging configuration for this vty' />
365 </params>
366 </command>
367 <command id='show alarms'>
368 <params>
369 <param name='show' doc='Show running system information' />
370 <param name='alarms' doc='Show current logging configuration' />
371 </params>
372 </command>
373 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
374 <params>
375 <param name='show' doc='Show running system information' />
376 <param name='talloc-context' doc='Show talloc memory hierarchy' />
377 <param name='application' doc='Application&apos;s context' />
378 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
379 <param name='full' doc='Display a full talloc memory hierarchy' />
380 <param name='brief' doc='Display a brief talloc memory hierarchy' />
381 <param name='DEPTH' doc='Specify required maximal depth value' />
382 </params>
383 </command>
384 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
385 <params>
386 <param name='show' doc='Show running system information' />
387 <param name='talloc-context' doc='Show talloc memory hierarchy' />
388 <param name='application' doc='Application&apos;s context' />
389 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
390 <param name='full' doc='Display a full talloc memory hierarchy' />
391 <param name='brief' doc='Display a brief talloc memory hierarchy' />
392 <param name='DEPTH' doc='Specify required maximal depth value' />
393 <param name='tree' doc='Display only a specific memory chunk' />
394 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
395 </params>
396 </command>
397 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
398 <params>
399 <param name='show' doc='Show running system information' />
400 <param name='talloc-context' doc='Show talloc memory hierarchy' />
401 <param name='application' doc='Application&apos;s context' />
402 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
403 <param name='full' doc='Display a full talloc memory hierarchy' />
404 <param name='brief' doc='Display a brief talloc memory hierarchy' />
405 <param name='DEPTH' doc='Specify required maximal depth value' />
406 <param name='filter' doc='Filter chunks using regular expression' />
407 <param name='REGEXP' doc='Regular expression' />
408 </params>
409 </command>
410 <command id='show stats'>
411 <params>
412 <param name='show' doc='Show running system information' />
413 <param name='stats' doc='Show statistical values' />
414 </params>
415 </command>
416 <command id='show stats level (global|peer|subscriber)'>
417 <params>
418 <param name='show' doc='Show running system information' />
419 <param name='stats' doc='Show statistical values' />
420 <param name='level' doc='Set the maximum group level' />
421 <param name='global' doc='Show global groups only' />
422 <param name='peer' doc='Show global and network peer related groups' />
423 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
424 </params>
425 </command>
426 <command id='show asciidoc counters'>
427 <params>
428 <param name='show' doc='Show running system information' />
429 <param name='asciidoc' doc='Asciidoc generation' />
430 <param name='counters' doc='Generate table of all registered counters' />
431 </params>
432 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]433 <command id='show rate-counters'>
434 <params>
435 <param name='show' doc='Show running system information' />
436 <param name='rate-counters' doc='Show all rate counters' />
437 </params>
438 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]439 <command id='show fsm NAME'>
440 <params>
441 <param name='show' doc='Show running system information' />
442 <param name='fsm' doc='Show information about finite state machines' />
443 <param name='NAME' doc='Display information about a single named finite state machine' />
444 </params>
445 </command>
446 <command id='show fsm all'>
447 <params>
448 <param name='show' doc='Show running system information' />
449 <param name='fsm' doc='Show information about finite state machines' />
450 <param name='all' doc='Display a list of all registered finite state machines' />
451 </params>
452 </command>
453 <command id='show fsm-instances NAME'>
454 <params>
455 <param name='show' doc='Show running system information' />
456 <param name='fsm-instances' doc='Show information about finite state machine instances' />
457 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
458 </params>
459 </command>
460 <command id='show fsm-instances all'>
461 <params>
462 <param name='show' doc='Show running system information' />
463 <param name='fsm-instances' doc='Show information about finite state machine instances' />
464 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
465 </params>
466 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]467 <command id='show subscriber (msisdn|extension|imsi|tmsi|id) ID'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]468 <params>
469 <param name='show' doc='Show running system information' />
470 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]471 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
472 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]473 <param name='imsi' doc='Identify subscriber by IMSI' />
474 <param name='tmsi' doc='Identify subscriber by TMSI' />
475 <param name='id' doc='Identify subscriber by database ID' />
476 <param name='ID' doc='Identifier for the subscriber' />
477 </params>
478 </command>
479 <command id='show subscriber cache'>
480 <params>
481 <param name='show' doc='Show running system information' />
482 <param name='subscriber' doc='Show information about subscribers' />
483 <param name='cache' doc='Display contents of subscriber cache' />
484 </params>
485 </command>
486 <command id='show connection'>
487 <params>
488 <param name='show' doc='Show running system information' />
489 <param name='connection' doc='Subscriber Connections' />
490 </params>
491 </command>
492 <command id='show transaction'>
493 <params>
494 <param name='show' doc='Show running system information' />
495 <param name='transaction' doc='Transactions' />
496 </params>
497 </command>
498 <command id='sms send pending'>
499 <params>
500 <param name='sms' doc='SMS related commands' />
501 <param name='send' doc='SMS Sending related commands' />
502 <param name='pending' doc='Send all pending SMS' />
503 </params>
504 </command>
505 <command id='sms delete expired'>
506 <params>
507 <param name='sms' doc='SMS related commands' />
508 <param name='delete' doc='SMS Database related commands' />
509 <param name='expired' doc='Delete all expired SMS' />
510 </params>
511 </command>
512 <command id='subscriber create imsi ID'>
513 <params>
514 <param name='subscriber' doc='Operations on a Subscriber' />
515 <param name='create' doc='Create new subscriber' />
516 <param name='imsi' doc='Identify the subscriber by his IMSI' />
517 <param name='ID' doc='Identifier for the subscriber' />
518 </params>
519 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]520 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]521 <params>
522 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]523 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
524 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]525 <param name='imsi' doc='Identify subscriber by IMSI' />
526 <param name='tmsi' doc='Identify subscriber by TMSI' />
527 <param name='id' doc='Identify subscriber by database ID' />
528 <param name='ID' doc='Identifier for the subscriber' />
529 <param name='sms' doc='SMS Operations' />
530 <param name='sender' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]531 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
532 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]533 <param name='imsi' doc='Identify subscriber by IMSI' />
534 <param name='tmsi' doc='Identify subscriber by TMSI' />
535 <param name='id' doc='Identify subscriber by database ID' />
536 <param name='SENDER_ID' doc='Identifier for the subscriber' />
537 <param name='send' doc='Send SMS' />
538 <param name='.LINE' doc='Actual SMS Text' />
539 </params>
540 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]541 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]542 <params>
543 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]544 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
545 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]546 <param name='imsi' doc='Identify subscriber by IMSI' />
547 <param name='tmsi' doc='Identify subscriber by TMSI' />
548 <param name='id' doc='Identify subscriber by database ID' />
549 <param name='ID' doc='Identifier for the subscriber' />
550 <param name='silent-sms' doc='Silent SMS Operations' />
551 <param name='sender' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]552 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
553 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]554 <param name='imsi' doc='Identify subscriber by IMSI' />
555 <param name='tmsi' doc='Identify subscriber by TMSI' />
556 <param name='id' doc='Identify subscriber by database ID' />
557 <param name='SENDER_ID' doc='Identifier for the subscriber' />
558 <param name='send' doc='Send SMS' />
559 <param name='.LINE' doc='Actual SMS Text' />
560 </params>
561 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]562 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]563 <params>
564 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]565 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
566 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]567 <param name='imsi' doc='Identify subscriber by IMSI' />
568 <param name='tmsi' doc='Identify subscriber by TMSI' />
569 <param name='id' doc='Identify subscriber by database ID' />
570 <param name='ID' doc='Identifier for the subscriber' />
571 <param name='silent-call' doc='Silent call operation' />
572 <param name='start' doc='Start silent call' />
573 <param name='any' doc='Any channel' />
574 <param name='tch/f' doc='TCH/F channel' />
575 <param name='tch/any' doc='Any TCH channel' />
576 <param name='sdcch' doc='SDCCH channel' />
577 </params>
578 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]579 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call stop'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]580 <params>
581 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]582 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
583 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]584 <param name='imsi' doc='Identify subscriber by IMSI' />
585 <param name='tmsi' doc='Identify subscriber by TMSI' />
586 <param name='id' doc='Identify subscriber by database ID' />
587 <param name='ID' doc='Identifier for the subscriber' />
588 <param name='silent-call' doc='Silent call operation' />
589 <param name='stop' doc='Stop silent call' />
590 </params>
591 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]592 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]593 <params>
594 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]595 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
596 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]597 <param name='imsi' doc='Identify subscriber by IMSI' />
598 <param name='tmsi' doc='Identify subscriber by TMSI' />
599 <param name='id' doc='Identify subscriber by database ID' />
600 <param name='ID' doc='Identifier for the subscriber' />
601 <param name='ussd-notify' doc='Send a USSD notify to the subscriber' />
602 <param name='0' doc='Alerting Level 0' />
603 <param name='1' doc='Alerting Level 1' />
604 <param name='2' doc='Alerting Level 2' />
605 <param name='.TEXT' doc='Text of USSD message to send' />
606 </params>
607 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]608 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test close-loop (a|b|c|d|e|f|i)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]609 <params>
610 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]611 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
612 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]613 <param name='imsi' doc='Identify subscriber by IMSI' />
614 <param name='tmsi' doc='Identify subscriber by TMSI' />
615 <param name='id' doc='Identify subscriber by database ID' />
616 <param name='ID' doc='Identifier for the subscriber' />
617 <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' />
618 <param name='close-loop' doc='Close a TCH Loop inside the MS' />
619 <param name='a' doc='Loop Type A' />
620 <param name='b' doc='Loop Type B' />
621 <param name='c' doc='Loop Type C' />
622 <param name='d' doc='Loop Type D' />
623 <param name='e' doc='Loop Type E' />
624 <param name='f' doc='Loop Type F' />
625 <param name='i' doc='Loop Type I' />
626 </params>
627 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]628 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test open-loop'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]629 <params>
630 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]631 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
632 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]633 <param name='imsi' doc='Identify subscriber by IMSI' />
634 <param name='tmsi' doc='Identify subscriber by TMSI' />
635 <param name='id' doc='Identify subscriber by database ID' />
636 <param name='ID' doc='Identifier for the subscriber' />
637 <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' />
638 <param name='open-loop' doc='Open a TCH Loop inside the MS' />
639 </params>
640 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]641 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID paging'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]642 <params>
643 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]644 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
645 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]646 <param name='imsi' doc='Identify subscriber by IMSI' />
647 <param name='tmsi' doc='Identify subscriber by TMSI' />
648 <param name='id' doc='Identify subscriber by database ID' />
649 <param name='ID' doc='Identifier for the subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]650 <param name='paging' doc='Issue an empty Paging for the subscriber (for debugging)' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]651 </params>
652 </command>
653 <command id='show statistics'>
654 <params>
655 <param name='show' doc='Show running system information' />
656 <param name='statistics' doc='Display network statistics' />
657 </params>
658 </command>
659 <command id='show sms-queue'>
660 <params>
661 <param name='show' doc='Show running system information' />
662 <param name='sms-queue' doc='Display SMSqueue statistics' />
663 </params>
664 </command>
665 <command id='logging filter imsi IMSI'>
666 <params>
667 <param name='logging' doc='Configure logging' />
668 <param name='filter' doc='Filter log messages' />
669 <param name='imsi' doc='Filter log messages by IMSI' />
670 <param name='IMSI' doc='IMSI to be used as filter' />
671 </params>
672 </command>
673 <command id='show smpp esme'>
674 <params>
675 <param name='show' doc='Show running system information' />
676 <param name='smpp' doc='SMPP Interface' />
677 <param name='esme' doc='SMPP Extrenal SMS Entity' />
678 </params>
679 </command>
680 </node>
681 <node id='enable'>
682 <name>enable</name>
683 <command id='disable'>
684 <params>
685 <param name='disable' doc='Turn off privileged mode command' />
686 </params>
687 </command>
688 <command id='configure terminal'>
689 <params>
690 <param name='configure' doc='Configuration from vty interface' />
691 <param name='terminal' doc='Configuration terminal' />
692 </params>
693 </command>
694 <command id='copy running-config startup-config'>
695 <params>
696 <param name='copy' doc='Copy configuration' />
697 <param name='running-config' doc='Copy running config to... ' />
698 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
699 </params>
700 </command>
701 <command id='show startup-config'>
702 <params>
703 <param name='show' doc='Show running system information' />
704 <param name='startup-config' doc='Contentes of startup configuration' />
705 </params>
706 </command>
707 <command id='show version'>
708 <params>
709 <param name='show' doc='Show running system information' />
710 <param name='version' doc='Displays program version' />
711 </params>
712 </command>
713 <command id='show online-help'>
714 <params>
715 <param name='show' doc='Show running system information' />
716 <param name='online-help' doc='Online help' />
717 </params>
718 </command>
719 <command id='terminal length &lt;0-512&gt;'>
720 <params>
721 <param name='terminal' doc='Set terminal line parameters' />
722 <param name='length' doc='Set number of lines on a screen' />
723 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
724 </params>
725 </command>
726 <command id='terminal no length'>
727 <params>
728 <param name='terminal' doc='Set terminal line parameters' />
729 <param name='no' doc='Negate a command or set its defaults' />
730 <param name='length' doc='Set number of lines on a screen' />
731 </params>
732 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]733 <command id='who'>
734 <params>
735 <param name='who' doc='Display who is on vty' />
736 </params>
737 </command>
738 <command id='show history'>
739 <params>
740 <param name='show' doc='Show running system information' />
741 <param name='history' doc='Display the session command history' />
742 </params>
743 </command>
744 <command id='terminal monitor'>
745 <params>
746 <param name='terminal' doc='Set terminal line parameters' />
747 <param name='monitor' doc='Copy debug output to the current terminal line' />
748 </params>
749 </command>
750 <command id='terminal no monitor'>
751 <params>
752 <param name='terminal' doc='Set terminal line parameters' />
753 <param name='no' doc='Negate a command or set its defaults' />
754 <param name='monitor' doc='Copy debug output to the current terminal line' />
755 </params>
756 </command>
757 <command id='show cs7 instance &lt;0-15&gt; users'>
758 <params>
759 <param name='show' doc='Show running system information' />
760 <param name='cs7' doc='ITU-T Signaling System 7' />
761 <param name='instance' doc='An instance of the SS7 stack' />
762 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
763 <param name='users' doc='User Table' />
764 </params>
765 </command>
766 <command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
767 <params>
768 <param name='show' doc='Show running system information' />
769 <param name='cs7' doc='ITU-T Signaling System 7' />
770 <param name='sua' doc='SCCP User Adaptation' />
771 <param name='m3ua' doc='MTP3 User Adaptation' />
772 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
773 <param name='[&lt;0-65534&gt;]' doc='Port Number' />
774 </params>
775 </command>
776 <command id='show cs7 instance &lt;0-15&gt; asp'>
777 <params>
778 <param name='show' doc='Show running system information' />
779 <param name='cs7' doc='ITU-T Signaling System 7' />
780 <param name='instance' doc='An instance of the SS7 stack' />
781 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
782 <param name='asp' doc='Application Server Process (ASP)' />
783 </params>
784 </command>
785 <command id='show cs7 instance &lt;0-15&gt; as (active|all|m3ua|sua)'>
786 <params>
787 <param name='show' doc='Show running system information' />
788 <param name='cs7' doc='ITU-T Signaling System 7' />
789 <param name='instance' doc='An instance of the SS7 stack' />
790 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
791 <param name='as' doc='Application Server (AS)' />
792 <param name='active' doc='Display all active ASs' />
793 <param name='all' doc='Display all ASs (default)' />
794 <param name='m3ua' doc='Display all m3ua ASs' />
795 <param name='sua' doc='Display all SUA ASs' />
796 </params>
797 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]798 <command id='show cs7 instance &lt;0-15&gt; sccp addressbook'>
799 <params>
800 <param name='show' doc='Show running system information' />
801 <param name='cs7' doc='ITU-T Signaling System 7' />
802 <param name='instance' doc='An instance of the SS7 stack' />
803 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
804 <param name='sccp' doc='Signalling Connection Control Part' />
805 <param name='addressbook' doc='List all SCCP addressbook entries' />
806 </params>
807 </command>
808 <command id='show cs7 instance &lt;0-15&gt; sccp users'>
809 <params>
810 <param name='show' doc='Show running system information' />
811 <param name='cs7' doc='ITU-T Signaling System 7' />
812 <param name='instance' doc='An instance of the SS7 stack' />
813 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
814 <param name='sccp' doc='Signalling Connection Control Part' />
815 <param name='users' doc='Show List of SCCP Users registered' />
816 </params>
817 </command>
818 <command id='show cs7 instance &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
819 <params>
820 <param name='show' doc='Show running system information' />
821 <param name='cs7' doc='ITU-T Signaling System 7' />
822 <param name='instance' doc='An instance of the SS7 stack' />
823 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
824 <param name='sccp' doc='Signalling Connection Control Part' />
825 <param name='ssn' doc='Find an SCCP User registered for the given SSN' />
826 <param name='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
827 </params>
828 </command>
829 <command id='show cs7 instance &lt;0-15&gt; sccp connections'>
830 <params>
831 <param name='show' doc='Show running system information' />
832 <param name='cs7' doc='ITU-T Signaling System 7' />
833 <param name='instance' doc='An instance of the SS7 stack' />
834 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
835 <param name='sccp' doc='Signalling Connection Control Part' />
836 <param name='connections' doc='Show List of active SCCP connections' />
837 </params>
838 </command>
839 <command id='show cs7 instance &lt;0-15&gt; sccp timers'>
840 <params>
841 <param name='show' doc='Show running system information' />
842 <param name='cs7' doc='ITU-T Signaling System 7' />
843 <param name='instance' doc='An instance of the SS7 stack' />
844 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
845 <param name='sccp' doc='Signaling Connection Control Part' />
846 <param name='timers' doc='Show List of SCCP timers' />
847 </params>
848 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]849 <command id='logging enable'>
850 <params>
851 <param name='logging' doc='Configure logging' />
852 <param name='enable' doc='Enables logging to this vty' />
853 </params>
854 </command>
855 <command id='logging disable'>
856 <params>
857 <param name='logging' doc='Configure logging' />
858 <param name='disable' doc='Disables logging to this vty' />
859 </params>
860 </command>
861 <command id='logging filter all (0|1)'>
862 <params>
863 <param name='logging' doc='Configure logging' />
864 <param name='filter' doc='Filter log messages' />
865 <param name='all' doc='Do you want to log all messages?' />
866 <param name='0' doc='Only print messages matched by other filters' />
867 <param name='1' doc='Bypass filter and print all messages' />
868 </params>
869 </command>
870 <command id='logging color (0|1)'>
871 <params>
872 <param name='logging' doc='Configure logging' />
873 <param name='color' doc='Configure color-printing for log messages' />
874 <param name='0' doc='Don&apos;t use color for printing messages' />
875 <param name='1' doc='Use color for printing messages' />
876 </params>
877 </command>
878 <command id='logging timestamp (0|1)'>
879 <params>
880 <param name='logging' doc='Configure logging' />
881 <param name='timestamp' doc='Configure log message timestamping' />
882 <param name='0' doc='Don&apos;t prefix each log message' />
883 <param name='1' doc='Prefix each log message with current timestamp' />
884 </params>
885 </command>
886 <command id='logging print extended-timestamp (0|1)'>
887 <params>
888 <param name='logging' doc='Configure logging' />
889 <param name='print' doc='Log output settings' />
890 <param name='extended-timestamp' doc='Configure log message timestamping' />
891 <param name='0' doc='Don&apos;t prefix each log message' />
892 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
893 </params>
894 </command>
895 <command id='logging print category (0|1)'>
896 <params>
897 <param name='logging' doc='Configure logging' />
898 <param name='print' doc='Log output settings' />
899 <param name='category' doc='Configure log message' />
900 <param name='0' doc='Don&apos;t prefix each log message' />
901 <param name='1' doc='Prefix each log message with category/subsystem name' />
902 </params>
903 </command>
904 <command id='logging print category-hex (0|1)'>
905 <params>
906 <param name='logging' doc='Configure logging' />
907 <param name='print' doc='Log output settings' />
908 <param name='category-hex' doc='Configure log message' />
909 <param name='0' doc='Don&apos;t prefix each log message' />
910 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
911 </params>
912 </command>
913 <command id='logging print level (0|1)'>
914 <params>
915 <param name='logging' doc='Configure logging' />
916 <param name='print' doc='Log output settings' />
917 <param name='level' doc='Configure log message' />
918 <param name='0' doc='Don&apos;t prefix each log message' />
919 <param name='1' doc='Prefix each log message with the log level name' />
920 </params>
921 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]922 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]923 <params>
924 <param name='logging' doc='Configure logging' />
925 <param name='print' doc='Log output settings' />
926 <param name='file' doc='Configure log message' />
927 <param name='0' doc='Don&apos;t prefix each log message' />
928 <param name='1' doc='Prefix each log message with the source file and line' />
929 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]930 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]931 </params>
932 </command>
933 <command id='logging set-log-mask MASK'>
934 <params>
935 <param name='logging' doc='Configure logging' />
936 <param name='set-log-mask' doc='Set the logmask of this logging target' />
937 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
938 </params>
939 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]940 <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]941 <params>
942 <param name='logging' doc='Configure logging' />
943 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]944 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
945 <param name='cc' doc='Layer3 Call Control (CC)' />
946 <param name='mm' doc='Layer3 Mobility Management (MM)' />
947 <param name='rr' doc='Layer3 Radio Resource (RR)' />
948 <param name='mncc' doc='MNCC API for Call Control application' />
949 <param name='pag' doc='Paging Subsystem' />
950 <param name='msc' doc='Mobile Switching Center' />
951 <param name='mgcp' doc='Media Gateway Control Protocol' />
952 <param name='ho' doc='Hand-Over' />
953 <param name='db' doc='Database Layer' />
954 <param name='ref' doc='Reference Counting' />
955 <param name='ctrl' doc='Control interface' />
956 <param name='smpp' doc='SMPP interface for external SMS apps' />
957 <param name='ranap' doc='Radio Access Network Application Part Protocol' />
958 <param name='vlr' doc='Visitor Location Register' />
959 <param name='iucs' doc='Iu-CS Protocol' />
960 <param name='bssap' doc='BSSAP Protocol (A Interface)' />
961 <param name='lglobal' doc='Library-internal global log family' />
962 <param name='llapd' doc='LAPD in libosmogsm' />
963 <param name='linp' doc='A-bis Intput Subsystem' />
964 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
965 <param name='lmi' doc='A-bis Input Driver for Signalling' />
966 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
967 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
968 <param name='lctrl' doc='Control Interface' />
969 <param name='lgtp' doc='GPRS GTP library' />
970 <param name='lstats' doc='Statistics messages and logging' />
971 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
972 <param name='loap' doc='Osmocom Authentication Protocol' />
973 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
974 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
975 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
976 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
977 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
978 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]979 <param name='debug' doc='Log debug messages and higher levels' />
980 <param name='info' doc='Log informational messages and higher levels' />
981 <param name='notice' doc='Log noticeable messages and higher levels' />
982 <param name='error' doc='Log error messages and higher levels' />
983 <param name='fatal' doc='Log only fatal messages' />
984 </params>
985 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]986 <command id='logging level set-all (debug|info|notice|error|fatal)'>
987 <params>
988 <param name='logging' doc='Configure logging' />
989 <param name='level' doc='Set the log level for a specified category' />
990 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
991 <param name='debug' doc='Log debug messages and higher levels' />
992 <param name='info' doc='Log informational messages and higher levels' />
993 <param name='notice' doc='Log noticeable messages and higher levels' />
994 <param name='error' doc='Log error messages and higher levels' />
995 <param name='fatal' doc='Log only fatal messages' />
996 </params>
997 </command>
998 <command id='logging level force-all (debug|info|notice|error|fatal)'>
999 <params>
1000 <param name='logging' doc='Configure logging' />
1001 <param name='level' doc='Set the log level for a specified category' />
1002 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
1003 <param name='debug' doc='Log debug messages and higher levels' />
1004 <param name='info' doc='Log informational messages and higher levels' />
1005 <param name='notice' doc='Log noticeable messages and higher levels' />
1006 <param name='error' doc='Log error messages and higher levels' />
1007 <param name='fatal' doc='Log only fatal messages' />
1008 </params>
1009 </command>
1010 <command id='no logging level force-all'>
1011 <params>
1012 <param name='no' doc='Negate a command or set its defaults' />
1013 <param name='logging' doc='Configure logging' />
1014 <param name='level' doc='Set the log level for a specified category' />
1015 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1016 </params>
1017 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1018 <command id='show logging vty'>
1019 <params>
1020 <param name='show' doc='Show running system information' />
1021 <param name='logging' doc='Show current logging configuration' />
1022 <param name='vty' doc='Show current logging configuration for this vty' />
1023 </params>
1024 </command>
1025 <command id='show alarms'>
1026 <params>
1027 <param name='show' doc='Show running system information' />
1028 <param name='alarms' doc='Show current logging configuration' />
1029 </params>
1030 </command>
1031 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
1032 <params>
1033 <param name='show' doc='Show running system information' />
1034 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1035 <param name='application' doc='Application&apos;s context' />
1036 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1037 <param name='full' doc='Display a full talloc memory hierarchy' />
1038 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1039 <param name='DEPTH' doc='Specify required maximal depth value' />
1040 </params>
1041 </command>
1042 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
1043 <params>
1044 <param name='show' doc='Show running system information' />
1045 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1046 <param name='application' doc='Application&apos;s context' />
1047 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1048 <param name='full' doc='Display a full talloc memory hierarchy' />
1049 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1050 <param name='DEPTH' doc='Specify required maximal depth value' />
1051 <param name='tree' doc='Display only a specific memory chunk' />
1052 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
1053 </params>
1054 </command>
1055 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
1056 <params>
1057 <param name='show' doc='Show running system information' />
1058 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1059 <param name='application' doc='Application&apos;s context' />
1060 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1061 <param name='full' doc='Display a full talloc memory hierarchy' />
1062 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1063 <param name='DEPTH' doc='Specify required maximal depth value' />
1064 <param name='filter' doc='Filter chunks using regular expression' />
1065 <param name='REGEXP' doc='Regular expression' />
1066 </params>
1067 </command>
1068 <command id='show stats'>
1069 <params>
1070 <param name='show' doc='Show running system information' />
1071 <param name='stats' doc='Show statistical values' />
1072 </params>
1073 </command>
1074 <command id='show stats level (global|peer|subscriber)'>
1075 <params>
1076 <param name='show' doc='Show running system information' />
1077 <param name='stats' doc='Show statistical values' />
1078 <param name='level' doc='Set the maximum group level' />
1079 <param name='global' doc='Show global groups only' />
1080 <param name='peer' doc='Show global and network peer related groups' />
1081 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
1082 </params>
1083 </command>
1084 <command id='show asciidoc counters'>
1085 <params>
1086 <param name='show' doc='Show running system information' />
1087 <param name='asciidoc' doc='Asciidoc generation' />
1088 <param name='counters' doc='Generate table of all registered counters' />
1089 </params>
1090 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1091 <command id='show rate-counters'>
1092 <params>
1093 <param name='show' doc='Show running system information' />
1094 <param name='rate-counters' doc='Show all rate counters' />
1095 </params>
1096 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1097 <command id='show fsm NAME'>
1098 <params>
1099 <param name='show' doc='Show running system information' />
1100 <param name='fsm' doc='Show information about finite state machines' />
1101 <param name='NAME' doc='Display information about a single named finite state machine' />
1102 </params>
1103 </command>
1104 <command id='show fsm all'>
1105 <params>
1106 <param name='show' doc='Show running system information' />
1107 <param name='fsm' doc='Show information about finite state machines' />
1108 <param name='all' doc='Display a list of all registered finite state machines' />
1109 </params>
1110 </command>
1111 <command id='show fsm-instances NAME'>
1112 <params>
1113 <param name='show' doc='Show running system information' />
1114 <param name='fsm-instances' doc='Show information about finite state machine instances' />
1115 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
1116 </params>
1117 </command>
1118 <command id='show fsm-instances all'>
1119 <params>
1120 <param name='show' doc='Show running system information' />
1121 <param name='fsm-instances' doc='Show information about finite state machine instances' />
1122 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
1123 </params>
1124 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1125 <command id='show subscriber (msisdn|extension|imsi|tmsi|id) ID'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1126 <params>
1127 <param name='show' doc='Show running system information' />
1128 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1129 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1130 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1131 <param name='imsi' doc='Identify subscriber by IMSI' />
1132 <param name='tmsi' doc='Identify subscriber by TMSI' />
1133 <param name='id' doc='Identify subscriber by database ID' />
1134 <param name='ID' doc='Identifier for the subscriber' />
1135 </params>
1136 </command>
1137 <command id='show subscriber cache'>
1138 <params>
1139 <param name='show' doc='Show running system information' />
1140 <param name='subscriber' doc='Show information about subscribers' />
1141 <param name='cache' doc='Display contents of subscriber cache' />
1142 </params>
1143 </command>
1144 <command id='show connection'>
1145 <params>
1146 <param name='show' doc='Show running system information' />
1147 <param name='connection' doc='Subscriber Connections' />
1148 </params>
1149 </command>
1150 <command id='show transaction'>
1151 <params>
1152 <param name='show' doc='Show running system information' />
1153 <param name='transaction' doc='Transactions' />
1154 </params>
1155 </command>
1156 <command id='sms send pending'>
1157 <params>
1158 <param name='sms' doc='SMS related commands' />
1159 <param name='send' doc='SMS Sending related commands' />
1160 <param name='pending' doc='Send all pending SMS' />
1161 </params>
1162 </command>
1163 <command id='sms delete expired'>
1164 <params>
1165 <param name='sms' doc='SMS related commands' />
1166 <param name='delete' doc='SMS Database related commands' />
1167 <param name='expired' doc='Delete all expired SMS' />
1168 </params>
1169 </command>
1170 <command id='subscriber create imsi ID'>
1171 <params>
1172 <param name='subscriber' doc='Operations on a Subscriber' />
1173 <param name='create' doc='Create new subscriber' />
1174 <param name='imsi' doc='Identify the subscriber by his IMSI' />
1175 <param name='ID' doc='Identifier for the subscriber' />
1176 </params>
1177 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1178 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1179 <params>
1180 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1181 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1182 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1183 <param name='imsi' doc='Identify subscriber by IMSI' />
1184 <param name='tmsi' doc='Identify subscriber by TMSI' />
1185 <param name='id' doc='Identify subscriber by database ID' />
1186 <param name='ID' doc='Identifier for the subscriber' />
1187 <param name='sms' doc='SMS Operations' />
1188 <param name='sender' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1189 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1190 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1191 <param name='imsi' doc='Identify subscriber by IMSI' />
1192 <param name='tmsi' doc='Identify subscriber by TMSI' />
1193 <param name='id' doc='Identify subscriber by database ID' />
1194 <param name='SENDER_ID' doc='Identifier for the subscriber' />
1195 <param name='send' doc='Send SMS' />
1196 <param name='.LINE' doc='Actual SMS Text' />
1197 </params>
1198 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1199 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1200 <params>
1201 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1202 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1203 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1204 <param name='imsi' doc='Identify subscriber by IMSI' />
1205 <param name='tmsi' doc='Identify subscriber by TMSI' />
1206 <param name='id' doc='Identify subscriber by database ID' />
1207 <param name='ID' doc='Identifier for the subscriber' />
1208 <param name='silent-sms' doc='Silent SMS Operations' />
1209 <param name='sender' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1210 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1211 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1212 <param name='imsi' doc='Identify subscriber by IMSI' />
1213 <param name='tmsi' doc='Identify subscriber by TMSI' />
1214 <param name='id' doc='Identify subscriber by database ID' />
1215 <param name='SENDER_ID' doc='Identifier for the subscriber' />
1216 <param name='send' doc='Send SMS' />
1217 <param name='.LINE' doc='Actual SMS Text' />
1218 </params>
1219 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1220 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1221 <params>
1222 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1223 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1224 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1225 <param name='imsi' doc='Identify subscriber by IMSI' />
1226 <param name='tmsi' doc='Identify subscriber by TMSI' />
1227 <param name='id' doc='Identify subscriber by database ID' />
1228 <param name='ID' doc='Identifier for the subscriber' />
1229 <param name='silent-call' doc='Silent call operation' />
1230 <param name='start' doc='Start silent call' />
1231 <param name='any' doc='Any channel' />
1232 <param name='tch/f' doc='TCH/F channel' />
1233 <param name='tch/any' doc='Any TCH channel' />
1234 <param name='sdcch' doc='SDCCH channel' />
1235 </params>
1236 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1237 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call stop'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1238 <params>
1239 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1240 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1241 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1242 <param name='imsi' doc='Identify subscriber by IMSI' />
1243 <param name='tmsi' doc='Identify subscriber by TMSI' />
1244 <param name='id' doc='Identify subscriber by database ID' />
1245 <param name='ID' doc='Identifier for the subscriber' />
1246 <param name='silent-call' doc='Silent call operation' />
1247 <param name='stop' doc='Stop silent call' />
1248 </params>
1249 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1250 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1251 <params>
1252 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1253 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1254 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1255 <param name='imsi' doc='Identify subscriber by IMSI' />
1256 <param name='tmsi' doc='Identify subscriber by TMSI' />
1257 <param name='id' doc='Identify subscriber by database ID' />
1258 <param name='ID' doc='Identifier for the subscriber' />
1259 <param name='ussd-notify' doc='Send a USSD notify to the subscriber' />
1260 <param name='0' doc='Alerting Level 0' />
1261 <param name='1' doc='Alerting Level 1' />
1262 <param name='2' doc='Alerting Level 2' />
1263 <param name='.TEXT' doc='Text of USSD message to send' />
1264 </params>
1265 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1266 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test close-loop (a|b|c|d|e|f|i)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1267 <params>
1268 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1269 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1270 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1271 <param name='imsi' doc='Identify subscriber by IMSI' />
1272 <param name='tmsi' doc='Identify subscriber by TMSI' />
1273 <param name='id' doc='Identify subscriber by database ID' />
1274 <param name='ID' doc='Identifier for the subscriber' />
1275 <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' />
1276 <param name='close-loop' doc='Close a TCH Loop inside the MS' />
1277 <param name='a' doc='Loop Type A' />
1278 <param name='b' doc='Loop Type B' />
1279 <param name='c' doc='Loop Type C' />
1280 <param name='d' doc='Loop Type D' />
1281 <param name='e' doc='Loop Type E' />
1282 <param name='f' doc='Loop Type F' />
1283 <param name='i' doc='Loop Type I' />
1284 </params>
1285 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1286 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test open-loop'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1287 <params>
1288 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1289 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1290 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1291 <param name='imsi' doc='Identify subscriber by IMSI' />
1292 <param name='tmsi' doc='Identify subscriber by TMSI' />
1293 <param name='id' doc='Identify subscriber by database ID' />
1294 <param name='ID' doc='Identifier for the subscriber' />
1295 <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' />
1296 <param name='open-loop' doc='Open a TCH Loop inside the MS' />
1297 </params>
1298 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1299 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID paging'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1300 <params>
1301 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1302 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1303 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1304 <param name='imsi' doc='Identify subscriber by IMSI' />
1305 <param name='tmsi' doc='Identify subscriber by TMSI' />
1306 <param name='id' doc='Identify subscriber by database ID' />
1307 <param name='ID' doc='Identifier for the subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1308 <param name='paging' doc='Issue an empty Paging for the subscriber (for debugging)' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1309 </params>
1310 </command>
1311 <command id='show statistics'>
1312 <params>
1313 <param name='show' doc='Show running system information' />
1314 <param name='statistics' doc='Display network statistics' />
1315 </params>
1316 </command>
1317 <command id='show sms-queue'>
1318 <params>
1319 <param name='show' doc='Show running system information' />
1320 <param name='sms-queue' doc='Display SMSqueue statistics' />
1321 </params>
1322 </command>
1323 <command id='logging filter imsi IMSI'>
1324 <params>
1325 <param name='logging' doc='Configure logging' />
1326 <param name='filter' doc='Filter log messages' />
1327 <param name='imsi' doc='Filter log messages by IMSI' />
1328 <param name='IMSI' doc='IMSI to be used as filter' />
1329 </params>
1330 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1331 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID expire'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1332 <params>
1333 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1334 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1335 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1336 <param name='imsi' doc='Identify subscriber by IMSI' />
1337 <param name='tmsi' doc='Identify subscriber by TMSI' />
1338 <param name='id' doc='Identify subscriber by database ID' />
1339 <param name='ID' doc='Identifier for the subscriber' />
1340 <param name='expire' doc='Expire the subscriber Now' />
1341 </params>
1342 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1343 <command id='sms-queue trigger'>
1344 <params>
1345 <param name='sms-queue' doc='SMS Queue' />
1346 <param name='trigger' doc='Trigger sending messages' />
1347 </params>
1348 </command>
1349 <command id='sms-queue max-pending &lt;1-500&gt;'>
1350 <params>
1351 <param name='sms-queue' doc='SMS Queue' />
1352 <param name='max-pending' doc='SMS to deliver in parallel' />
1353 <param name='&lt;1-500&gt;' doc='Amount' />
1354 </params>
1355 </command>
1356 <command id='sms-queue clear'>
1357 <params>
1358 <param name='sms-queue' doc='SMS Queue' />
1359 <param name='clear' doc='Clear the queue of pending SMS' />
1360 </params>
1361 </command>
1362 <command id='sms-queue max-failure &lt;1-500&gt;'>
1363 <params>
1364 <param name='sms-queue' doc='SMS Queue' />
1365 <param name='max-failure' doc='Maximum amount of delivery failures' />
1366 <param name='&lt;1-500&gt;' doc='Amount' />
1367 </params>
1368 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1369 <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms pending-send'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1370 <params>
1371 <param name='subscriber' doc='Operations on a Subscriber' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1372 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
1373 <param name='extension' doc='Legacy alias for &apos;msisdn&apos;' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1374 <param name='imsi' doc='Identify subscriber by IMSI' />
1375 <param name='tmsi' doc='Identify subscriber by TMSI' />
1376 <param name='id' doc='Identify subscriber by database ID' />
1377 <param name='ID' doc='Identifier for the subscriber' />
1378 <param name='sms' doc='SMS Operations' />
1379 <param name='pending-send' doc='Send pending SMS' />
1380 </params>
1381 </command>
1382 <command id='show smpp esme'>
1383 <params>
1384 <param name='show' doc='Show running system information' />
1385 <param name='smpp' doc='SMPP Interface' />
1386 <param name='esme' doc='SMPP Extrenal SMS Entity' />
1387 </params>
1388 </command>
1389 </node>
1390 <node id='config'>
1391 <name>config</name>
1392 <command id='hostname WORD'>
1393 <params>
1394 <param name='hostname' doc='Set system&apos;s network name' />
1395 <param name='WORD' doc='This system&apos;s network name' />
1396 </params>
1397 </command>
1398 <command id='no hostname [HOSTNAME]'>
1399 <params>
1400 <param name='no' doc='Negate a command or set its defaults' />
1401 <param name='hostname' doc='Reset system&apos;s network name' />
1402 <param name='[HOSTNAME]' doc='Host name of this router' />
1403 </params>
1404 </command>
1405 <command id='password (8|) WORD'>
1406 <params>
1407 <param name='password' doc='Assign the terminal connection password' />
1408 <param name='8' doc='Specifies a HIDDEN password will follow' />
1409 <param name='' doc='dummy string ' />
1410 <param name='WORD' doc='The HIDDEN line password string' />
1411 </params>
1412 </command>
1413 <command id='password LINE'>
1414 <params>
1415 <param name='password' doc='Assign the terminal connection password' />
1416 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
1417 </params>
1418 </command>
1419 <command id='enable password (8|) WORD'>
1420 <params>
1421 <param name='enable' doc='Modify enable password parameters' />
1422 <param name='password' doc='Assign the privileged level password' />
1423 <param name='8' doc='Specifies a HIDDEN password will follow' />
1424 <param name='' doc='dummy string ' />
1425 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
1426 </params>
1427 </command>
1428 <command id='enable password LINE'>
1429 <params>
1430 <param name='enable' doc='Modify enable password parameters' />
1431 <param name='password' doc='Assign the privileged level password' />
1432 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
1433 </params>
1434 </command>
1435 <command id='no enable password'>
1436 <params>
1437 <param name='no' doc='Negate a command or set its defaults' />
1438 <param name='enable' doc='Modify enable password parameters' />
1439 <param name='password' doc='Assign the privileged level password' />
1440 </params>
1441 </command>
1442 <command id='banner motd default'>
1443 <params>
1444 <param name='banner' doc='Set banner string' />
1445 <param name='motd' doc='Strings for motd' />
1446 <param name='default' doc='Default string' />
1447 </params>
1448 </command>
1449 <command id='banner motd file [FILE]'>
1450 <params>
1451 <param name='banner' doc='Set banner' />
1452 <param name='motd' doc='Banner for motd' />
1453 <param name='file' doc='Banner from a file' />
1454 <param name='[FILE]' doc='Filename' />
1455 </params>
1456 </command>
1457 <command id='no banner motd'>
1458 <params>
1459 <param name='no' doc='Negate a command or set its defaults' />
1460 <param name='banner' doc='Set banner string' />
1461 <param name='motd' doc='Strings for motd' />
1462 </params>
1463 </command>
1464 <command id='service terminal-length &lt;0-512&gt;'>
1465 <params>
1466 <param name='service' doc='Set up miscellaneous service' />
1467 <param name='terminal-length' doc='System wide terminal length configuration' />
1468 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
1469 </params>
1470 </command>
1471 <command id='no service terminal-length [&lt;0-512&gt;]'>
1472 <params>
1473 <param name='no' doc='Negate a command or set its defaults' />
1474 <param name='service' doc='Set up miscellaneous service' />
1475 <param name='terminal-length' doc='System wide terminal length configuration' />
1476 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
1477 </params>
1478 </command>
1479 <command id='line vty'>
1480 <params>
1481 <param name='line' doc='Configure a terminal line' />
1482 <param name='vty' doc='Virtual terminal' />
1483 </params>
1484 </command>
1485 <command id='service advanced-vty'>
1486 <params>
1487 <param name='service' doc='Set up miscellaneous service' />
1488 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1489 </params>
1490 </command>
1491 <command id='no service advanced-vty'>
1492 <params>
1493 <param name='no' doc='Negate a command or set its defaults' />
1494 <param name='service' doc='Set up miscellaneous service' />
1495 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1496 </params>
1497 </command>
1498 <command id='show history'>
1499 <params>
1500 <param name='show' doc='Show running system information' />
1501 <param name='history' doc='Display the session command history' />
1502 </params>
1503 </command>
1504 <command id='cs7 instance &lt;0-15&gt;'>
1505 <params>
1506 <param name='cs7' doc='ITU-T Signaling System 7' />
1507 <param name='instance' doc='Configure a SS7 Instance' />
1508 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1509 </params>
1510 </command>
1511 <command id='ctrl'>
1512 <params>
1513 <param name='ctrl' doc='Configure the Control Interface' />
1514 </params>
1515 </command>
1516 <command id='log stderr'>
1517 <params>
1518 <param name='log' doc='Configure logging sub-system' />
1519 <param name='stderr' doc='Logging via STDERR of the process' />
1520 </params>
1521 </command>
1522 <command id='no log stderr'>
1523 <params>
1524 <param name='no' doc='Negate a command or set its defaults' />
1525 <param name='log' doc='Configure logging sub-system' />
1526 <param name='stderr' doc='Logging via STDERR of the process' />
1527 </params>
1528 </command>
1529 <command id='log file .FILENAME'>
1530 <params>
1531 <param name='log' doc='Configure logging sub-system' />
1532 <param name='file' doc='Logging to text file' />
1533 <param name='.FILENAME' doc='Filename' />
1534 </params>
1535 </command>
1536 <command id='no log file .FILENAME'>
1537 <params>
1538 <param name='no' doc='Negate a command or set its defaults' />
1539 <param name='log' doc='Configure logging sub-system' />
1540 <param name='file' doc='Logging to text file' />
1541 <param name='.FILENAME' doc='Filename' />
1542 </params>
1543 </command>
1544 <command id='log alarms &lt;2-32700&gt;'>
1545 <params>
1546 <param name='log' doc='Configure logging sub-system' />
1547 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1548 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1549 </params>
1550 </command>
1551 <command id='no log alarms'>
1552 <params>
1553 <param name='no' doc='Negate a command or set its defaults' />
1554 <param name='log' doc='Configure logging sub-system' />
1555 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1556 </params>
1557 </command>
1558 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1559 <params>
1560 <param name='log' doc='Configure logging sub-system' />
1561 <param name='syslog' doc='Logging via syslog' />
1562 <param name='authpriv' doc='Security/authorization messages facility' />
1563 <param name='cron' doc='Clock daemon (cron/at) facility' />
1564 <param name='daemon' doc='General system daemon facility' />
1565 <param name='ftp' doc='Ftp daemon facility' />
1566 <param name='lpr' doc='Line printer facility' />
1567 <param name='mail' doc='Mail facility' />
1568 <param name='news' doc='News facility' />
1569 <param name='user' doc='Generic facility' />
1570 <param name='uucp' doc='UUCP facility' />
1571 </params>
1572 </command>
1573 <command id='log syslog local &lt;0-7&gt;'>
1574 <params>
1575 <param name='log' doc='Configure logging sub-system' />
1576 <param name='syslog' doc='Logging via syslog' />
1577 <param name='local' doc='Syslog LOCAL facility' />
1578 <param name='&lt;0-7&gt;' doc='Local facility number' />
1579 </params>
1580 </command>
1581 <command id='no log syslog'>
1582 <params>
1583 <param name='no' doc='Negate a command or set its defaults' />
1584 <param name='log' doc='Configure logging sub-system' />
1585 <param name='syslog' doc='Logging via syslog' />
1586 </params>
1587 </command>
1588 <command id='log gsmtap [HOSTNAME]'>
1589 <params>
1590 <param name='log' doc='Configure logging sub-system' />
1591 <param name='gsmtap' doc='Logging via GSMTAP' />
1592 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1593 </params>
1594 </command>
1595 <command id='stats reporter statsd'>
1596 <params>
1597 <param name='stats' doc='Configure stats sub-system' />
1598 <param name='reporter' doc='Configure a stats reporter' />
1599 <param name='statsd' doc='Report to a STATSD server' />
1600 </params>
1601 </command>
1602 <command id='no stats reporter statsd'>
1603 <params>
1604 <param name='no' doc='Negate a command or set its defaults' />
1605 <param name='stats' doc='Configure stats sub-system' />
1606 <param name='reporter' doc='Configure a stats reporter' />
1607 <param name='statsd' doc='Report to a STATSD server' />
1608 </params>
1609 </command>
1610 <command id='stats reporter log'>
1611 <params>
1612 <param name='stats' doc='Configure stats sub-system' />
1613 <param name='reporter' doc='Configure a stats reporter' />
1614 <param name='log' doc='Report to the logger' />
1615 </params>
1616 </command>
1617 <command id='no stats reporter log'>
1618 <params>
1619 <param name='no' doc='Negate a command or set its defaults' />
1620 <param name='stats' doc='Configure stats sub-system' />
1621 <param name='reporter' doc='Configure a stats reporter' />
1622 <param name='log' doc='Report to the logger' />
1623 </params>
1624 </command>
1625 <command id='stats interval &lt;1-65535&gt;'>
1626 <params>
1627 <param name='stats' doc='Configure stats sub-system' />
1628 <param name='interval' doc='Set the reporting interval' />
1629 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
1630 </params>
1631 </command>
1632 <command id='network'>
1633 <params>
1634 <param name='network' doc='Configure the GSM network' />
1635 </params>
1636 </command>
1637 <command id='msc'>
1638 <params>
1639 <param name='msc' doc='Configure MSC options' />
1640 </params>
1641 </command>
1642 <command id='mncc-int'>
1643 <params>
1644 <param name='mncc-int' doc='Configure internal MNCC handler' />
1645 </params>
1646 </command>
1647 <command id='hlr'>
1648 <params>
1649 <param name='hlr' doc='Configure connection to the HLR' />
1650 </params>
1651 </command>
1652 <command id='smpp'>
1653 <params>
1654 <param name='smpp' doc='Configure SMPP SMS Interface' />
1655 </params>
1656 </command>
1657 </node>
1658 <node id='config-log'>
1659 <name>config-log</name>
1660 <command id='logging filter all (0|1)'>
1661 <params>
1662 <param name='logging' doc='Configure logging' />
1663 <param name='filter' doc='Filter log messages' />
1664 <param name='all' doc='Do you want to log all messages?' />
1665 <param name='0' doc='Only print messages matched by other filters' />
1666 <param name='1' doc='Bypass filter and print all messages' />
1667 </params>
1668 </command>
1669 <command id='logging color (0|1)'>
1670 <params>
1671 <param name='logging' doc='Configure logging' />
1672 <param name='color' doc='Configure color-printing for log messages' />
1673 <param name='0' doc='Don&apos;t use color for printing messages' />
1674 <param name='1' doc='Use color for printing messages' />
1675 </params>
1676 </command>
1677 <command id='logging timestamp (0|1)'>
1678 <params>
1679 <param name='logging' doc='Configure logging' />
1680 <param name='timestamp' doc='Configure log message timestamping' />
1681 <param name='0' doc='Don&apos;t prefix each log message' />
1682 <param name='1' doc='Prefix each log message with current timestamp' />
1683 </params>
1684 </command>
1685 <command id='logging print extended-timestamp (0|1)'>
1686 <params>
1687 <param name='logging' doc='Configure logging' />
1688 <param name='print' doc='Log output settings' />
1689 <param name='extended-timestamp' doc='Configure log message timestamping' />
1690 <param name='0' doc='Don&apos;t prefix each log message' />
1691 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1692 </params>
1693 </command>
1694 <command id='logging print category (0|1)'>
1695 <params>
1696 <param name='logging' doc='Configure logging' />
1697 <param name='print' doc='Log output settings' />
1698 <param name='category' doc='Configure log message' />
1699 <param name='0' doc='Don&apos;t prefix each log message' />
1700 <param name='1' doc='Prefix each log message with category/subsystem name' />
1701 </params>
1702 </command>
1703 <command id='logging print category-hex (0|1)'>
1704 <params>
1705 <param name='logging' doc='Configure logging' />
1706 <param name='print' doc='Log output settings' />
1707 <param name='category-hex' doc='Configure log message' />
1708 <param name='0' doc='Don&apos;t prefix each log message' />
1709 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1710 </params>
1711 </command>
1712 <command id='logging print level (0|1)'>
1713 <params>
1714 <param name='logging' doc='Configure logging' />
1715 <param name='print' doc='Log output settings' />
1716 <param name='level' doc='Configure log message' />
1717 <param name='0' doc='Don&apos;t prefix each log message' />
1718 <param name='1' doc='Prefix each log message with the log level name' />
1719 </params>
1720 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1721 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1722 <params>
1723 <param name='logging' doc='Configure logging' />
1724 <param name='print' doc='Log output settings' />
1725 <param name='file' doc='Configure log message' />
1726 <param name='0' doc='Don&apos;t prefix each log message' />
1727 <param name='1' doc='Prefix each log message with the source file and line' />
1728 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1729 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1730 </params>
1731 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1732 <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1733 <params>
1734 <param name='logging' doc='Configure logging' />
1735 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1736 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
1737 <param name='cc' doc='Layer3 Call Control (CC)' />
1738 <param name='mm' doc='Layer3 Mobility Management (MM)' />
1739 <param name='rr' doc='Layer3 Radio Resource (RR)' />
1740 <param name='mncc' doc='MNCC API for Call Control application' />
1741 <param name='pag' doc='Paging Subsystem' />
1742 <param name='msc' doc='Mobile Switching Center' />
1743 <param name='mgcp' doc='Media Gateway Control Protocol' />
1744 <param name='ho' doc='Hand-Over' />
1745 <param name='db' doc='Database Layer' />
1746 <param name='ref' doc='Reference Counting' />
1747 <param name='ctrl' doc='Control interface' />
1748 <param name='smpp' doc='SMPP interface for external SMS apps' />
1749 <param name='ranap' doc='Radio Access Network Application Part Protocol' />
1750 <param name='vlr' doc='Visitor Location Register' />
1751 <param name='iucs' doc='Iu-CS Protocol' />
1752 <param name='bssap' doc='BSSAP Protocol (A Interface)' />
1753 <param name='lglobal' doc='Library-internal global log family' />
1754 <param name='llapd' doc='LAPD in libosmogsm' />
1755 <param name='linp' doc='A-bis Intput Subsystem' />
1756 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1757 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1758 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1759 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1760 <param name='lctrl' doc='Control Interface' />
1761 <param name='lgtp' doc='GPRS GTP library' />
1762 <param name='lstats' doc='Statistics messages and logging' />
1763 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1764 <param name='loap' doc='Osmocom Authentication Protocol' />
1765 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1766 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1767 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1768 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1769 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1770 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1771 <param name='debug' doc='Log debug messages and higher levels' />
1772 <param name='info' doc='Log informational messages and higher levels' />
1773 <param name='notice' doc='Log noticeable messages and higher levels' />
1774 <param name='error' doc='Log error messages and higher levels' />
1775 <param name='fatal' doc='Log only fatal messages' />
1776 </params>
1777 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]1778 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1779 <params>
1780 <param name='logging' doc='Configure logging' />
1781 <param name='level' doc='Set the log level for a specified category' />
1782 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
1783 <param name='debug' doc='Log debug messages and higher levels' />
1784 <param name='info' doc='Log informational messages and higher levels' />
1785 <param name='notice' doc='Log noticeable messages and higher levels' />
1786 <param name='error' doc='Log error messages and higher levels' />
1787 <param name='fatal' doc='Log only fatal messages' />
1788 </params>
1789 </command>
1790 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1791 <params>
1792 <param name='logging' doc='Configure logging' />
1793 <param name='level' doc='Set the log level for a specified category' />
1794 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
1795 <param name='debug' doc='Log debug messages and higher levels' />
1796 <param name='info' doc='Log informational messages and higher levels' />
1797 <param name='notice' doc='Log noticeable messages and higher levels' />
1798 <param name='error' doc='Log error messages and higher levels' />
1799 <param name='fatal' doc='Log only fatal messages' />
1800 </params>
1801 </command>
1802 <command id='no logging level force-all'>
1803 <params>
1804 <param name='no' doc='Negate a command or set its defaults' />
1805 <param name='logging' doc='Configure logging' />
1806 <param name='level' doc='Set the log level for a specified category' />
1807 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1808 </params>
1809 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]1810 <command id='logging filter imsi IMSI'>
1811 <params>
1812 <param name='logging' doc='Configure logging' />
1813 <param name='filter' doc='Filter log messages' />
1814 <param name='imsi' doc='Filter log messages by IMSI' />
1815 <param name='IMSI' doc='IMSI to be used as filter' />
1816 </params>
1817 </command>
1818 </node>
1819 <node id='config-stats'>
1820 <name>config-stats</name>
1821 <command id='local-ip ADDR'>
1822 <params>
1823 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1824 <param name='ADDR' doc='IP Address' />
1825 </params>
1826 </command>
1827 <command id='no local-ip'>
1828 <params>
1829 <param name='no' doc='Negate a command or set its defaults' />
1830 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1831 </params>
1832 </command>
1833 <command id='remote-ip ADDR'>
1834 <params>
1835 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1836 <param name='ADDR' doc='IP Address' />
1837 </params>
1838 </command>
1839 <command id='remote-port &lt;1-65535&gt;'>
1840 <params>
1841 <param name='remote-port' doc='Set the remote port to which we connect' />
1842 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1843 </params>
1844 </command>
1845 <command id='mtu &lt;100-65535&gt;'>
1846 <params>
1847 <param name='mtu' doc='Set the maximum packet size' />
1848 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1849 </params>
1850 </command>
1851 <command id='no mtu'>
1852 <params>
1853 <param name='no' doc='Negate a command or set its defaults' />
1854 <param name='mtu' doc='Set the maximum packet size' />
1855 </params>
1856 </command>
1857 <command id='prefix PREFIX'>
1858 <params>
1859 <param name='prefix' doc='Set the item name prefix' />
1860 <param name='PREFIX' doc='The prefix string' />
1861 </params>
1862 </command>
1863 <command id='no prefix'>
1864 <params>
1865 <param name='no' doc='Negate a command or set its defaults' />
1866 <param name='prefix' doc='Set the item name prefix' />
1867 </params>
1868 </command>
1869 <command id='level (global|peer|subscriber)'>
1870 <params>
1871 <param name='level' doc='Set the maximum group level' />
1872 <param name='global' doc='Report global groups only' />
1873 <param name='peer' doc='Report global and network peer related groups' />
1874 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1875 </params>
1876 </command>
1877 <command id='enable'>
1878 <params>
1879 <param name='enable' doc='Enable the reporter' />
1880 </params>
1881 </command>
1882 <command id='disable'>
1883 <params>
1884 <param name='disable' doc='Disable the reporter' />
1885 </params>
1886 </command>
1887 </node>
1888 <node id='config-line'>
1889 <name>config-line</name>
1890 <command id='login'>
1891 <params>
1892 <param name='login' doc='Enable password checking' />
1893 </params>
1894 </command>
1895 <command id='no login'>
1896 <params>
1897 <param name='no' doc='Negate a command or set its defaults' />
1898 <param name='login' doc='Enable password checking' />
1899 </params>
1900 </command>
1901 <command id='bind A.B.C.D'>
1902 <params>
1903 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1904 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1905 </params>
1906 </command>
1907 </node>
1908 <node id='config-ctrl'>
1909 <name>config-ctrl</name>
1910 <command id='bind A.B.C.D'>
1911 <params>
1912 <param name='bind' doc='Set bind address to listen for Control connections' />
1913 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1914 </params>
1915 </command>
1916 </node>
1917 <node id='config-cs7'>
1918 <name>config-cs7</name>
1919 <command id='description .TEXT'>
1920 <params>
1921 <param name='description' doc='Save human-readable description of the object' />
1922 <param name='.TEXT' doc='Text until the end of the line' />
1923 </params>
1924 </command>
1925 <command id='network-indicator (international | national | reserved | spare)'>
1926 <params>
1927 <param name='network-indicator' doc='Configure the Network Indicator' />
1928 <param name='international' doc='International Network' />
1929 <param name='national' doc='National Network' />
1930 <param name='reserved' doc='Reserved Network' />
1931 <param name='spare' doc='Spare Network' />
1932 </params>
1933 </command>
1934 <command id='point-code POINT_CODE'>
1935 <params>
1936 <param name='point-code' doc='Configure the local Point Code' />
1937 <param name='POINT_CODE' doc='Point Code' />
1938 </params>
1939 </command>
1940 <command id='point-code format &lt;1-24&gt; [&lt;1-23&gt;] [&lt;1-22&gt;]'>
1941 <params>
1942 <param name='point-code' doc='Point Code' />
1943 <param name='format' doc='Configure Point Code Format' />
1944 <param name='&lt;1-24&gt;' doc='Length of first PC component' />
1945 <param name='[&lt;1-23&gt;]' doc='Length of second PC component' />
1946 <param name='[&lt;1-22&gt;]' doc='Length of third PC component' />
1947 </params>
1948 </command>
1949 <command id='point-code format default'>
1950 <params>
1951 <param name='point-code' doc='Point Code' />
1952 <param name='format' doc='Configure Point Code Format' />
1953 <param name='default' doc='Default Point Code Format (3.8.3)' />
1954 </params>
1955 </command>
1956 <command id='point-code delimiter (default|dash)'>
1957 <params>
1958 <param name='point-code' doc='Point Code' />
1959 <param name='delimiter' doc='Configure Point Code Delimiter' />
1960 <param name='default' doc='Use dot as delimiter' />
1961 <param name='dash' doc='User dash as delimiter' />
1962 </params>
1963 </command>
1964 <command id='xua rkm routing-key-allocation (static-only|dynamic-permitted)'>
1965 <params>
1966 <param name='xua' doc='SIGTRAN xxxUA related' />
1967 <param name='rkm' doc='Routing Key Management' />
1968 <param name='routing-key-allocation' doc='Routing Key Management Allocation Policy' />
1969 <param name='static-only' doc='Only static (pre-confgured) Routing Keys permitted' />
1970 <param name='dynamic-permitted' doc='Dynamically allocate Routing Keys for what ASPs request' />
1971 </params>
1972 </command>
1973 <command id='asp NAME &lt;0-65535&gt; &lt;0-65535&gt; (sua|m3ua|ipa)'>
1974 <params>
1975 <param name='asp' doc='Configure Application Server Process' />
1976 <param name='NAME' doc='Name of ASP' />
1977 <param name='&lt;0-65535&gt;' doc='Remote SCTP port number' />
1978 <param name='&lt;0-65535&gt;' doc='Local SCTP port number' />
1979 <param name='sua' doc='SCCP User Adaptation' />
1980 <param name='m3ua' doc='MTP3 User Adaptation' />
1981 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
1982 </params>
1983 </command>
1984 <command id='no asp NAME'>
1985 <params>
1986 <param name='no' doc='Negate a command or set its defaults' />
1987 <param name='asp' doc='Disable Application Server Process' />
1988 <param name='NAME' doc='Name of ASP' />
1989 </params>
1990 </command>
1991 <command id='as NAME (sua|m3ua|ipa)'>
1992 <params>
1993 <param name='as' doc='Configure an Application Server' />
1994 <param name='NAME' doc='Name of the Application Server' />
1995 <param name='sua' doc='SCCP User Adaptation' />
1996 <param name='m3ua' doc='MTP3 User Adaptation' />
1997 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
1998 </params>
1999 </command>
2000 <command id='no as NAME'>
2001 <params>
2002 <param name='no' doc='Negate a command or set its defaults' />
2003 <param name='as' doc='Disable Application Server' />
2004 <param name='NAME' doc='Name of AS' />
2005 </params>
2006 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]2007 <command id='sccp-address NAME'>
2008 <params>
2009 <param name='sccp-address' doc='Create/Modify an SCCP addressbook entry' />
2010 <param name='NAME' doc='Name of the SCCP Address' />
2011 </params>
2012 </command>
2013 <command id='no sccp-address NAME'>
2014 <params>
2015 <param name='no' doc='Negate a command or set its defaults' />
2016 <param name='sccp-address' doc='Delete an SCCP addressbook entry' />
2017 <param name='NAME' doc='Name of the SCCP Address' />
2018 </params>
2019 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]2020 <command id='sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) &lt;1-999999&gt;'>
2021 <params>
2022 <param name='sccp-timer' doc='Configure SCCP timer values, see ITU-T Q.714' />
2023 <param name='conn_est' doc='Waiting for connection confirm message, 1 to 2 minutes (default: 60)' />
2024 <param name='ias' doc='Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)' />
2025 <param name='iar' doc='Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)' />
2026 <param name='rel' doc='Waiting for release complete message, 10 to 20 seconds (default: 10)' />
2027 <param name='repeat_rel' doc='Waiting for release complete message; or to repeat sending released message after the initial expiry, 10 to 20 seconds (default: 10)' />
2028 <param name='int' doc='Waiting for release complete message; or to release connection resources, freeze the LRN and alert a maintenance function after the initial expiry, extending to 1 minute (default: 60)' />
2029 <param name='guard' doc='Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes (default: 1380)' />
2030 <param name='reset' doc='Waiting to release temporary connection section or alert maintenance function after reset request message is sent, 10 to 20 seconds (default: 10)' />
2031 <param name='reassembly' doc='Waiting to receive all the segments of the remaining segments, single segmented message after receiving the first segment, 10 to 20 seconds (default: 10)' />
2032 <param name='&lt;1-999999&gt;' doc='Timer value, in seconds' />
2033 </params>
2034 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]2035 </node>
2036 <node id='config-cs7-as'>
2037 <name>config-cs7-as</name>
2038 <command id='description .TEXT'>
2039 <params>
2040 <param name='description' doc='Save human-readable description of the object' />
2041 <param name='.TEXT' doc='Text until the end of the line' />
2042 </params>
2043 </command>
2044 <command id='asp NAME'>
2045 <params>
2046 <param name='asp' doc='Specify that a given ASP is part of this AS' />
2047 <param name='NAME' doc='Name of ASP to be added to AS' />
2048 </params>
2049 </command>
2050 <command id='no asp NAME'>
2051 <params>
2052 <param name='no' doc='Negate a command or set its defaults' />
2053 <param name='asp' doc='Specify ASP to be removed from this AS' />
2054 <param name='NAME' doc='Name of ASP to be removed' />
2055 </params>
2056 </command>
2057 <command id='traffic-mode (broadcast | loadshare | roundrobin | override)'>
2058 <params>
2059 <param name='traffic-mode' doc='Specifies traffic mode of operation of the ASP within the AS' />
2060 <param name='broadcast' doc='Broadcast to all ASP within AS' />
2061 <param name='loadshare' doc='Share Load among all ASP within AS' />
2062 <param name='roundrobin' doc='Round-Robin between all ASP within AS' />
2063 <param name='override' doc='Override' />
2064 </params>
2065 </command>
2066 <command id='recovery-timeout &lt;1-2000&gt;'>
2067 <params>
2068 <param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' />
2069 <param name='&lt;1-2000&gt;' doc='Recovery Timeout in Milliseconds' />
2070 </params>
2071 </command>
2072 <command id='qos-class &lt;0-255&gt;'>
2073 <params>
2074 <param name='qos-class' doc='Specity QoS Class of AS' />
2075 <param name='&lt;0-255&gt;' doc='QoS Class of AS' />
2076 </params>
2077 </command>
2078 <command id='routing-key RCONTEXT DPC'>
2079 <params>
2080 <param name='routing-key' doc='Define a routing key' />
2081 <param name='RCONTEXT' doc='Routing context number' />
2082 <param name='DPC' doc='Destination Point Code' />
2083 </params>
2084 </command>
2085 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)'>
2086 <params>
2087 <param name='routing-key' doc='Define a routing key' />
2088 <param name='RCONTEXT' doc='Routing context number' />
2089 <param name='DPC' doc='Destination Point Code' />
2090 <param name='si' doc='Match on Service Indicator' />
2091 <param name='aal2' doc='ATM Adaption Layer 2' />
2092 <param name='bicc' doc='Bearer Independent Call Control' />
2093 <param name='b-isup' doc='Broadband ISDN User Part' />
2094 <param name='h248' doc='H.248' />
2095 <param name='isup' doc='ISDN User Part' />
2096 <param name='sat-isup' doc='Sattelite ISDN User Part' />
2097 <param name='sccp' doc='Signalling Connection Control Part' />
2098 <param name='tup' doc='Telephony User Part' />
2099 </params>
2100 </command>
2101 <command id='routing-key RCONTEXT DPC ssn SSN'>
2102 <params>
2103 <param name='routing-key' doc='Define a routing key' />
2104 <param name='RCONTEXT' doc='Routing context number' />
2105 <param name='DPC' doc='Destination Point Code' />
2106 <param name='ssn' doc='Match on Sub-System Number' />
2107 <param name='SSN' doc='Sub-System Number to match on' />
2108 </params>
2109 </command>
2110 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN'>
2111 <params>
2112 <param name='routing-key' doc='Define a routing key' />
2113 <param name='RCONTEXT' doc='Routing context number' />
2114 <param name='DPC' doc='Destination Point Code' />
2115 <param name='si' doc='Match on Service Indicator' />
2116 <param name='aal2' doc='ATM Adaption Layer 2' />
2117 <param name='bicc' doc='Bearer Independent Call Control' />
2118 <param name='b-isup' doc='Broadband ISDN User Part' />
2119 <param name='h248' doc='H.248' />
2120 <param name='isup' doc='ISDN User Part' />
2121 <param name='sat-isup' doc='Sattelite ISDN User Part' />
2122 <param name='sccp' doc='Signalling Connection Control Part' />
2123 <param name='tup' doc='Telephony User Part' />
2124 <param name='ssn' doc='Match on Sub-System Number' />
2125 <param name='SSN' doc='Sub-System Number to match on' />
2126 </params>
2127 </command>
2128 <command id='point-code override dpc PC'>
2129 <params>
2130 <param name='point-code' doc='Point Code Specific Features' />
2131 <param name='override' doc='Override (force) a point-code to hard-coded value' />
2132 <param name='dpc' doc='Override Source Point Code' />
2133 <param name='PC' doc='Override Destination Point Code' />
2134 </params>
2135 </command>
2136 </node>
2137 <node id='config-cs7-asp'>
2138 <name>config-cs7-asp</name>
2139 <command id='description .TEXT'>
2140 <params>
2141 <param name='description' doc='Save human-readable description of the object' />
2142 <param name='.TEXT' doc='Text until the end of the line' />
2143 </params>
2144 </command>
2145 <command id='remote-ip A.B.C.D'>
2146 <params>
2147 <param name='remote-ip' doc='Specify Remote IP Address of ASP' />
2148 <param name='A.B.C.D' doc='Remote IP Address of ASP' />
2149 </params>
2150 </command>
2151 <command id='local-ip A.B.C.D'>
2152 <params>
2153 <param name='local-ip' doc='Specify Local IP Address from which to contact ASP' />
2154 <param name='A.B.C.D' doc='Local IP Address from which to contact of ASP' />
2155 </params>
2156 </command>
2157 <command id='qos-class &lt;0-255&gt;'>
2158 <params>
2159 <param name='qos-class' doc='Specify QoS Class of ASP' />
2160 <param name='&lt;0-255&gt;' doc='QoS Class of ASP' />
2161 </params>
2162 </command>
2163 <command id='block'>
2164 <params>
2165 <param name='block' doc='Allows a SCTP Association with ASP, but doesn&apos;t let it become active' />
2166 </params>
2167 </command>
2168 <command id='shutdown'>
2169 <params>
2170 <param name='shutdown' doc='Terminates SCTP association; New associations will be rejected' />
2171 </params>
2172 </command>
2173 </node>
2174 <node id='config-cs7-sccpaddr'>
2175 <name>config-cs7-sccpaddr</name>
2176 <command id='no point-code'>
2177 <params>
2178 <param name='no' doc='Negate a command or set its defaults' />
2179 <param name='point-code' doc='Remove point-code Number' />
2180 </params>
2181 </command>
2182 <command id='no subsystem-number'>
2183 <params>
2184 <param name='no' doc='Negate a command or set its defaults' />
2185 <param name='subsystem-number' doc='Remove Subsystem Number' />
2186 </params>
2187 </command>
2188 <command id='no global-title'>
2189 <params>
2190 <param name='no' doc='Negate a command or set its defaults' />
2191 <param name='global-title' doc='Remove Global Title' />
2192 </params>
2193 </command>
2194 <command id='routing-indicator (GT|PC|IP)'>
2195 <params>
2196 <param name='routing-indicator' doc='Add Routing Indicator' />
2197 <param name='GT' doc='by global-title' />
2198 <param name='PC' doc='by point-code' />
2199 <param name='IP' doc='by ip-address' />
2200 </params>
2201 </command>
2202 <command id='point-code POINT_CODE'>
2203 <params>
2204 <param name='point-code' doc='Add point-code Number' />
2205 <param name='POINT_CODE' doc='PC' />
2206 </params>
2207 </command>
2208 <command id='subsystem-number &lt;0-4294967295&gt;'>
2209 <params>
2210 <param name='subsystem-number' doc='Add Subsystem Number' />
2211 <param name='&lt;0-4294967295&gt;' doc='SSN' />
2212 </params>
2213 </command>
2214 <command id='global-title'>
2215 <params>
2216 <param name='global-title' doc='Add/Modify Global Title' />
2217 </params>
2218 </command>
2219 </node>
2220 <node id='config-cs7-sccpaddr-gt'>
2221 <name>config-cs7-sccpaddr-gt</name>
2222 <command id='global-title-indicator &lt;0-15&gt;'>
2223 <params>
2224 <param name='global-title-indicator' doc='Set Global Title Indicator' />
2225 <param name='&lt;0-15&gt;' doc='GTI' />
2226 </params>
2227 </command>
2228 <command id='translation-type &lt;0-255&gt;'>
2229 <params>
2230 <param name='translation-type' doc='Set Global Title Translation Type' />
2231 <param name='&lt;0-255&gt;' doc='TT' />
2232 </params>
2233 </command>
2234 <command id='numbering-plan-indicator &lt;0-15&gt;'>
2235 <params>
2236 <param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' />
2237 <param name='&lt;0-15&gt;' doc='NPI' />
2238 </params>
2239 </command>
2240 <command id='nature-of-address-indicator &lt;0-127&gt;'>
2241 <params>
2242 <param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' />
2243 <param name='&lt;0-127&gt;' doc='NAI' />
2244 </params>
2245 </command>
2246 <command id='digits DIGITS'>
2247 <params>
2248 <param name='digits' doc='Set Global Title Digits' />
2249 <param name='DIGITS' doc='Number digits' />
2250 </params>
2251 </command>
2252 </node>
2253 <node id='config-net'>
2254 <name>config-net</name>
2255 <command id='network country code &lt;1-999&gt;'>
2256 <params>
2257 <param name='network' doc='Set the GSM network country code' />
2258 <param name='country' doc='Country commands' />
2259 <param name='code' doc='Code commands' />
2260 <param name='&lt;1-999&gt;' doc='Network Country Code to use' />
2261 </params>
2262 </command>
2263 <command id='mobile network code &lt;0-999&gt;'>
2264 <params>
2265 <param name='mobile' doc='Set the GSM mobile network code' />
2266 <param name='network' doc='Network Commands' />
2267 <param name='code' doc='Code commands' />
2268 <param name='&lt;0-999&gt;' doc='Mobile Network Code to use' />
2269 </params>
2270 </command>
2271 <command id='short name NAME'>
2272 <params>
2273 <param name='short' doc='Set the short GSM network name' />
2274 <param name='name' doc='Name Commands' />
2275 <param name='NAME' doc='Name to use' />
2276 </params>
2277 </command>
2278 <command id='long name NAME'>
2279 <params>
2280 <param name='long' doc='Set the long GSM network name' />
2281 <param name='name' doc='Name Commands' />
2282 <param name='NAME' doc='Name to use' />
2283 </params>
2284 </command>
2285 <command id='encryption a5 &lt;0-3&gt; [&lt;0-3&gt;] [&lt;0-3&gt;] [&lt;0-3&gt;]'>
2286 <params>
2287 <param name='encryption' doc='Encryption options' />
2288 <param name='a5' doc='GSM A5 Air Interface Encryption' />
2289 <param name='&lt;0-3&gt;' doc='A5/n Algorithm Number' />
2290 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2291 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2292 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2293 </params>
2294 </command>
2295 <command id='authentication (optional|required)'>
2296 <params>
2297 <param name='authentication' doc='Whether to enforce MS authentication in 2G' />
2298 <param name='optional' doc='Allow MS to attach via 2G BSC without authentication' />
2299 <param name='required' doc='Always do authentication' />
2300 </params>
2301 </command>
2302 <command id='rrlp mode (none|ms-based|ms-preferred|ass-preferred)'>
2303 <params>
2304 <param name='rrlp' doc='Radio Resource Location Protocol' />
2305 <param name='mode' doc='Set the Radio Resource Location Protocol Mode' />
2306 <param name='none' doc='Don&apos;t send RRLP request' />
2307 <param name='ms-based' doc='Request MS-based location' />
2308 <param name='ms-preferred' doc='Request any location, prefer MS-based' />
2309 <param name='ass-preferred' doc='Request any location, prefer MS-assisted' />
2310 </params>
2311 </command>
2312 <command id='mm info (0|1)'>
2313 <params>
2314 <param name='mm' doc='Mobility Management' />
2315 <param name='info' doc='Send MM INFO after LOC UPD ACCEPT' />
2316 <param name='0' doc='Disable' />
2317 <param name='1' doc='Enable' />
2318 </params>
2319 </command>
2320 <command id='timezone &lt;-19-19&gt; (0|15|30|45)'>
2321 <params>
2322 <param name='timezone' doc='Set the Timezone Offset of the network' />
2323 <param name='&lt;-19-19&gt;' doc='Timezone offset (hours)' />
2324 <param name='0' doc='Timezone offset (00 minutes)' />
2325 <param name='15' doc='Timezone offset (15 minutes)' />
2326 <param name='30' doc='Timezone offset (30 minutes)' />
2327 <param name='45' doc='Timezone offset (45 minutes)' />
2328 </params>
2329 </command>
2330 <command id='timezone &lt;-19-19&gt; (0|15|30|45) &lt;0-2&gt;'>
2331 <params>
2332 <param name='timezone' doc='Set the Timezone Offset of the network' />
2333 <param name='&lt;-19-19&gt;' doc='Timezone offset (hours)' />
2334 <param name='0' doc='Timezone offset (00 minutes)' />
2335 <param name='15' doc='Timezone offset (15 minutes)' />
2336 <param name='30' doc='Timezone offset (30 minutes)' />
2337 <param name='45' doc='Timezone offset (45 minutes)' />
2338 <param name='&lt;0-2&gt;' doc='DST offset (hours)' />
2339 </params>
2340 </command>
2341 <command id='no timezone'>
2342 <params>
2343 <param name='no' doc='Negate a command or set its defaults' />
2344 <param name='timezone' doc='Disable network timezone override, use system tz' />
2345 </params>
2346 </command>
2347 <command id='periodic location update &lt;6-1530&gt;'>
2348 <params>
2349 <param name='periodic' doc='Periodic Location Updating Interval' />
2350 <param name='location' doc='Periodic Location Updating Interval' />
2351 <param name='update' doc='Periodic Location Updating Interval' />
2352 <param name='&lt;6-1530&gt;' doc='Periodic Location Updating Interval in Minutes' />
2353 </params>
2354 </command>
2355 <command id='no periodic location update'>
2356 <params>
2357 <param name='no' doc='Negate a command or set its defaults' />
2358 <param name='periodic' doc='Periodic Location Updating Interval' />
2359 <param name='location' doc='Periodic Location Updating Interval' />
2360 <param name='update' doc='Periodic Location Updating Interval' />
2361 </params>
2362 </command>
2363 </node>
2364 <node id='config-msc'>
2365 <name>config-msc</name>
2366 <command id='assign-tmsi'>
2367 <params>
2368 <param name='assign-tmsi' doc='Assign TMSI during Location Updating.' />
2369 </params>
2370 </command>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]2371 <command id='mncc-guard-timeout &lt;0-255&gt;'>
2372 <params>
2373 <param name='mncc-guard-timeout' doc='Set global guard timer for mncc interface activity' />
2374 <param name='&lt;0-255&gt;' doc='guard timer value (sec.)' />
2375 </params>
2376 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]2377 <command id='no assign-tmsi'>
2378 <params>
2379 <param name='no' doc='Negate a command or set its defaults' />
2380 <param name='assign-tmsi' doc='Assign TMSI during Location Updating.' />
2381 </params>
2382 </command>
2383 <command id='auth-tuple-max-reuse-count &lt;-1-2147483647&gt;'>
2384 <params>
2385 <param name='auth-tuple-max-reuse-count' doc='Configure authentication tuple re-use' />
2386 <param name='&lt;-1-2147483647&gt;' doc='0 to use each auth tuple at most once (default), &gt;0 to limit re-use, -1 to re-use infinitely (vulnerable!).' />
2387 </params>
2388 </command>
2389 <command id='auth-tuple-reuse-on-error (0|1)'>
2390 <params>
2391 <param name='auth-tuple-reuse-on-error' doc='Configure authentication tuple re-use when HLR is not responsive' />
2392 <param name='0' doc='0 = never re-use auth tuples beyond auth-tuple-max-reuse-count (default)' />
2393 <param name='1' doc='1 = if the HLR does not deliver new tuples, do re-use already available old ones.' />
2394 </params>
2395 </command>
2396 <command id='cs7-instance-a &lt;0-15&gt;'>
2397 <params>
2398 <param name='cs7-instance-a' doc='Set SS7 to be used by the A-Interface.' />
2399 <param name='&lt;0-15&gt;' doc='SS7 instance reference number' />
2400 </params>
2401 </command>
2402 <command id='cs7-instance-iu &lt;0-15&gt;'>
2403 <params>
2404 <param name='cs7-instance-iu' doc='Set SS7 to be used by the Iu-Interface.' />
2405 <param name='&lt;0-15&gt;' doc='SS7 instance reference number' />
2406 </params>
2407 </command>
2408 <command id='paging response-timer (default|&lt;1-65535&gt;)'>
2409 <params>
2410 <param name='paging' doc='Configure Paging' />
2411 <param name='response-timer' doc='Set Paging timeout, the minimum time to pass between (unsuccessful) Pagings sent towards BSS or RNC' />
2412 <param name='default' doc='Set to default timeout (10 seconds)' />
2413 <param name='&lt;1-65535&gt;' doc='Set paging timeout in seconds' />
2414 </params>
2415 </command>
2416 <command id='emergency-call route-to-msisdn MSISDN'>
2417 <params>
2418 <param name='emergency-call' doc='Configure Emergency Call Behaviour' />
2419 <param name='route-to-msisdn' doc='MSISDN to which Emergency Calls are Dispatched' />
2420 <param name='MSISDN' doc='MSISDN (E.164 Phone Number)' />
2421 </params>
2422 </command>
2423 <command id='mgw local-ip A.B.C.D'>
2424 <params>
2425 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2426 <param name='local-ip' doc='local bind to connect to MGW from' />
2427 <param name='A.B.C.D' doc='local bind IP address' />
2428 </params>
2429 </command>
2430 <command id='mgw local-port &lt;0-65535&gt;'>
2431 <params>
2432 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2433 <param name='local-port' doc='local port to connect to MGW from' />
2434 <param name='&lt;0-65535&gt;' doc='local bind port' />
2435 </params>
2436 </command>
2437 <command id='mgw remote-ip A.B.C.D'>
2438 <params>
2439 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2440 <param name='remote-ip' doc='remote IP address to reach the MGW at' />
2441 <param name='A.B.C.D' doc='remote IP address' />
2442 </params>
2443 </command>
2444 <command id='mgw remote-port &lt;0-65535&gt;'>
2445 <params>
2446 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2447 <param name='remote-port' doc='remote port to reach the MGW at' />
2448 <param name='&lt;0-65535&gt;' doc='remote port' />
2449 </params>
2450 </command>
2451 <command id='mgw endpoint-range &lt;1-65534&gt; &lt;1-65534&gt;'>
2452 <params>
2453 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2454 <param name='endpoint-range' doc='usable range of endpoint identifiers' />
2455 <param name='&lt;1-65534&gt;' doc='set first usable endpoint identifier' />
2456 <param name='&lt;1-65534&gt;' doc='set last usable endpoint identifier' />
2457 </params>
2458 </command>
2459 <command id='mgw bts-base &lt;0-65534&gt;'>
2460 <params>
2461 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
2462 <param name='bts-base' doc='First UDP port allocated for the BTS side' />
2463 <param name='&lt;0-65534&gt;' doc='UDP Port number' />
2464 </params>
2465 </command>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]2466 <command id='iu rab-assign-addr-enc (x213|v4raw)'>
2467 <params>
2468 <param name='iu' doc='Iu interface protocol options' />
2469 <param name='rab-assign-addr-enc' doc='Choose RAB Assignment&apos;s Transport Layer Address encoding' />
2470 <param name='x213' doc='ITU-T X.213 compliant address encoding (default)' />
2471 <param name='v4raw' doc='32bit length raw IPv4 address (for ip.access nano3G)' />
2472 </params>
2473 </command>
2474 <command id='asn1 debug (1|0)'>
2475 <params>
2476 <param name='asn1' doc='ASN.1 settings' />
2477 <param name='debug' doc='Enable ASN.1 debug messages' />
2478 <param name='1' doc='Log ASN.1 debug messages to stderr' />
2479 <param name='0' doc='Do not log ASN.1 debug messages to stderr' />
2480 </params>
2481 </command>
2482 <command id='asn1 xer-print (1|0)'>
2483 <params>
2484 <param name='asn1' doc='ASN.1 settings' />
2485 <param name='xer-print' doc='Log human readable representations of all ASN.1 messages to stderr' />
2486 <param name='1' doc='Log XML representation of all ASN.1 messages to stderr' />
2487 <param name='0' doc='Do not log decoded ASN.1 messages to stderr' />
2488 </params>
2489 </command>
2490 </node>
2491 <node id='config-mncc-int'>
2492 <name>config-mncc-int</name>
2493 <command id='default-codec tch-f (fr|efr|amr)'>
2494 <params>
2495 <param name='default-codec' doc='Set default codec' />
2496 <param name='tch-f' doc='Codec for TCH/F' />
2497 <param name='fr' doc='Full-Rate' />
2498 <param name='efr' doc='Enhanced Full-Rate' />
2499 <param name='amr' doc='Adaptive Multi-Rate' />
2500 </params>
2501 </command>
2502 <command id='default-codec tch-h (hr|amr)'>
2503 <params>
2504 <param name='default-codec' doc='Set default codec' />
2505 <param name='tch-h' doc='Codec for TCH/H' />
2506 <param name='hr' doc='Half-Rate' />
2507 <param name='amr' doc='Adaptive Multi-Rate' />
2508 </params>
2509 </command>
2510 </node>
2511 <node id='config-smpp'>
2512 <name>config-smpp</name>
2513 <command id='smpp-first'>
2514 <params>
2515 <param name='smpp-first' doc='Try SMPP routes before the subscriber DB' />
2516 </params>
2517 </command>
2518 <command id='no smpp-first'>
2519 <params>
2520 <param name='no' doc='Negate a command or set its defaults' />
2521 <param name='smpp-first' doc='Try SMPP before routes before the subscriber DB' />
2522 </params>
2523 </command>
2524 <command id='local-tcp-port &lt;1-65535&gt;'>
2525 <params>
2526 <param name='local-tcp-port' doc='Set the local TCP port on which we listen for SMPP' />
2527 <param name='&lt;1-65535&gt;' doc='TCP port number' />
2528 </params>
2529 </command>
2530 <command id='local-tcp-ip A.B.C.D &lt;1-65535&gt;'>
2531 <params>
2532 <param name='local-tcp-ip' doc='Set the local IP address and TCP port on which we listen for SMPP' />
2533 <param name='A.B.C.D' doc='Local IP address' />
2534 <param name='&lt;1-65535&gt;' doc='TCP port number' />
2535 </params>
2536 </command>
2537 <command id='system-id ID'>
2538 <params>
2539 <param name='system-id' doc='Set the System ID of this SMSC' />
2540 <param name='ID' doc='Alphanumeric SMSC System ID' />
2541 </params>
2542 </command>
2543 <command id='policy (accept-all|closed)'>
2544 <params>
2545 <param name='policy' doc='Set the authentication policy of this SMSC' />
2546 <param name='accept-all' doc='Accept all SMPP connections independeint of system ID / passwd' />
2547 <param name='closed' doc='Accept only SMPP connections from ESMEs explicitly configured' />
2548 </params>
2549 </command>
2550 <command id='esme NAME'>
2551 <params>
2552 <param name='esme' doc='Configure a particular ESME' />
2553 <param name='NAME' doc='Alphanumeric System ID of the ESME to be configured' />
2554 </params>
2555 </command>
2556 <command id='no esme NAME'>
2557 <params>
2558 <param name='no' doc='Negate a command or set its defaults' />
2559 <param name='esme' doc='Remove ESME configuration' />
2560 <param name='NAME' doc='Alphanumeric System ID of the ESME to be removed' />
2561 </params>
2562 </command>
2563 </node>
2564 <node id='config-smpp-esme'>
2565 <name>config-smpp-esme</name>
2566 <command id='password PASSWORD'>
2567 <params>
2568 <param name='password' doc='Set the password for this ESME' />
2569 <param name='PASSWORD' doc='Alphanumeric password string' />
2570 </params>
Neels Hofmeyrab3ade72018-11-05 03:19:12 +0100[diff] [blame]2571 </command> <command id='no password'>
Neels Hofmeyrdf7d7ff2018-03-06 14:59:00 +0100[diff] [blame]2572 <params>
2573 <param name='no' doc='Negate a command or set its defaults' />
2574 <param name='password' doc='Remove the password for this ESME' />
2575 </params>
2576 </command>
2577 <command id='route prefix (unknown|international|national|network|subscriber|alpha|abbrev) (unknown|isdn|x121|f69|e212|national|private|ermes|ip|wap) PREFIX'>
2578 <params>
2579 <param name='route' doc='Configure a route for MO-SMS to be sent to this ESME' />
2580 <param name='prefix' doc='Prefix-match route' />
2581 <param name='unknown' doc='Unknown type-of-number' />
2582 <param name='international' doc='International type-of-number' />
2583 <param name='national' doc='National type-of-number' />
2584 <param name='network' doc='Network specific type-of-number' />
2585 <param name='subscriber' doc='Subscriber type-of-number' />
2586 <param name='alpha' doc='Alphanumeric type-of-number' />
2587 <param name='abbrev' doc='Abbreviated type-of-number' />
2588 <param name='unknown' doc='Unknown numbering plan' />
2589 <param name='isdn' doc='ISDN (E.164) numbering plan' />
2590 <param name='x121' doc='X.121 numbering plan' />
2591 <param name='f69' doc='F.69 numbering plan' />
2592 <param name='e212' doc='E.212 numbering plan' />
2593 <param name='national' doc='National numbering plan' />
2594 <param name='private' doc='Private numbering plan' />
2595 <param name='ermes' doc='ERMES numbering plan' />
2596 <param name='ip' doc='IP numbering plan' />
2597 <param name='wap' doc='WAP numbeing plan' />
2598 <param name='PREFIX' doc='Destination number prefix' />
2599 </params>
2600 </command>
2601 <command id='no route prefix (unknown|international|national|network|subscriber|alpha|abbrev) (unknown|isdn|x121|f69|e212|national|private|ermes|ip|wap) PREFIX'>
2602 <params>
2603 <param name='no' doc='Negate a command or set its defaults' />
2604 <param name='route' doc='Configure a route for MO-SMS to be sent to this ESME' />
2605 <param name='prefix' doc='Prefix-match route' />
2606 <param name='unknown' doc='Unknown type-of-number' />
2607 <param name='international' doc='International type-of-number' />
2608 <param name='national' doc='National type-of-number' />
2609 <param name='network' doc='Network specific type-of-number' />
2610 <param name='subscriber' doc='Subscriber type-of-number' />
2611 <param name='alpha' doc='Alphanumeric type-of-number' />
2612 <param name='abbrev' doc='Abbreviated type-of-number' />
2613 <param name='unknown' doc='Unknown numbering plan' />
2614 <param name='isdn' doc='ISDN (E.164) numbering plan' />
2615 <param name='x121' doc='X.121 numbering plan' />
2616 <param name='f69' doc='F.69 numbering plan' />
2617 <param name='e212' doc='E.212 numbering plan' />
2618 <param name='national' doc='National numbering plan' />
2619 <param name='private' doc='Private numbering plan' />
2620 <param name='ermes' doc='ERMES numbering plan' />
2621 <param name='ip' doc='IP numbering plan' />
2622 <param name='wap' doc='WAP numbeing plan' />
2623 <param name='PREFIX' doc='Destination number prefix' />
2624 </params>
2625 </command>
2626 <command id='default-route'>
2627 <params>
2628 <param name='default-route' doc='Set this ESME as default-route for all SMS to unknown destinations' />
2629 </params>
2630 </command>
2631 <command id='no default-route'>
2632 <params>
2633 <param name='no' doc='Negate a command or set its defaults' />
2634 <param name='default-route' doc='Remove this ESME as default-route for all SMS to unknown destinations' />
2635 </params>
2636 </command>
2637 <command id='deliver-src-imsi'>
2638 <params>
2639 <param name='deliver-src-imsi' doc='Enable the use of IMSI as source address in DELIVER' />
2640 </params>
2641 </command>
2642 <command id='no deliver-src-imsi'>
2643 <params>
2644 <param name='no' doc='Negate a command or set its defaults' />
2645 <param name='deliver-src-imsi' doc='Disable the use of IMSI as source address in DELIVER' />
2646 </params>
2647 </command>
2648 <command id='osmocom-extensions'>
2649 <params>
2650 <param name='osmocom-extensions' doc='Enable the use of Osmocom SMPP Extensions for this ESME' />
2651 </params>
2652 </command>
2653 <command id='no osmocom-extensions'>
2654 <params>
2655 <param name='no' doc='Negate a command or set its defaults' />
2656 <param name='osmocom-extensions' doc='Disable the use of Osmocom SMPP Extensions for this ESME' />
2657 </params>
2658 </command>
2659 <command id='dcs-transparent'>
2660 <params>
2661 <param name='dcs-transparent' doc='Enable the transparent pass-through of TP-DCS to SMPP DataCoding' />
2662 </params>
2663 </command>
2664 <command id='no dcs-transparent'>
2665 <params>
2666 <param name='no' doc='Negate a command or set its defaults' />
2667 <param name='dcs-transparent' doc='Disable the transparent pass-through of TP-DCS to SMPP DataCoding' />
2668 </params>
2669 </command>
2670 </node>
2671 <node id='config-hlr'>
2672 <name>config-hlr</name>
2673 <command id='remote-ip A.B.C.D'>
2674 <params>
2675 <param name='remote-ip' doc='Remote GSUP address of the HLR' />
2676 <param name='A.B.C.D' doc='Remote GSUP address (default: 127.0.0.1)' />
2677 </params>
2678 </command>
2679 <command id='remote-port &lt;1-65535&gt;'>
2680 <params>
2681 <param name='remote-port' doc='Remote GSUP port of the HLR' />
2682 <param name='&lt;1-65535&gt;' doc='Remote GSUP port (default: MSC_HLR_REMOTE_PORT_DEFAULT)' />
2683 </params>
2684 </command>
2685 </node>
2686</vtydoc>