blob: 4046636f3cc3060807c7b882f39588b007321f79 [file] [log] [blame]
Daniel Willmanndc468e62019-07-29 12:10:21 +02001<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>
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>
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>
191 <command id='show cnlink'>
192 <params>
193 <param name='show' doc='Show running system information' />
194 <param name='cnlink' doc='Display information on core network link' />
195 </params>
196 </command>
197 <command id='show hnb all'>
198 <params>
199 <param name='show' doc='Show running system information' />
200 <param name='hnb' doc='Display information about all HNB' />
201 <param name='all' doc='(null)' />
202 </params>
203 </command>
204 <command id='show hnb NAME '>
205 <params>
206 <param name='show' doc='Show running system information' />
207 <param name='hnb' doc='Display information about a HNB' />
208 <param name='NAME' doc='(null)' />
209 </params>
210 </command>
211 <command id='show ue all'>
212 <params>
213 <param name='show' doc='Show running system information' />
214 <param name='ue' doc='Display information about a UE' />
215 <param name='all' doc='(null)' />
216 </params>
217 </command>
218 <command id='show talloc'>
219 <params>
220 <param name='show' doc='Show running system information' />
221 <param name='talloc' doc='Display talloc info' />
222 </params>
223 </command>
224 <command id='logging enable'>
225 <params>
226 <param name='logging' doc='Configure logging' />
227 <param name='enable' doc='Enables logging to this vty' />
228 </params>
229 </command>
230 <command id='logging disable'>
231 <params>
232 <param name='logging' doc='Configure logging' />
233 <param name='disable' doc='Disables logging to this vty' />
234 </params>
235 </command>
236 <command id='logging filter all (0|1)'>
237 <params>
238 <param name='logging' doc='Configure logging' />
239 <param name='filter' doc='Filter log messages' />
240 <param name='all' doc='Do you want to log all messages?' />
241 <param name='0' doc='Only print messages matched by other filters' />
242 <param name='1' doc='Bypass filter and print all messages' />
243 </params>
244 </command>
245 <command id='logging color (0|1)'>
246 <params>
247 <param name='logging' doc='Configure logging' />
248 <param name='color' doc='Configure color-printing for log messages' />
249 <param name='0' doc='Don&apos;t use color for printing messages' />
250 <param name='1' doc='Use color for printing messages' />
251 </params>
252 </command>
253 <command id='logging timestamp (0|1)'>
254 <params>
255 <param name='logging' doc='Configure logging' />
256 <param name='timestamp' doc='Configure log message timestamping' />
257 <param name='0' doc='Don&apos;t prefix each log message' />
258 <param name='1' doc='Prefix each log message with current timestamp' />
259 </params>
260 </command>
261 <command id='logging print extended-timestamp (0|1)'>
262 <params>
263 <param name='logging' doc='Configure logging' />
264 <param name='print' doc='Log output settings' />
265 <param name='extended-timestamp' doc='Configure log message timestamping' />
266 <param name='0' doc='Don&apos;t prefix each log message' />
267 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
268 </params>
269 </command>
270 <command id='logging print category (0|1)'>
271 <params>
272 <param name='logging' doc='Configure logging' />
273 <param name='print' doc='Log output settings' />
274 <param name='category' doc='Configure log message' />
275 <param name='0' doc='Don&apos;t prefix each log message' />
276 <param name='1' doc='Prefix each log message with category/subsystem name' />
277 </params>
278 </command>
279 <command id='logging print category-hex (0|1)'>
280 <params>
281 <param name='logging' doc='Configure logging' />
282 <param name='print' doc='Log output settings' />
283 <param name='category-hex' doc='Configure log message' />
284 <param name='0' doc='Don&apos;t prefix each log message' />
285 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
286 </params>
287 </command>
288 <command id='logging print level (0|1)'>
289 <params>
290 <param name='logging' doc='Configure logging' />
291 <param name='print' doc='Log output settings' />
292 <param name='level' doc='Configure log message' />
293 <param name='0' doc='Don&apos;t prefix each log message' />
294 <param name='1' doc='Prefix each log message with the log level name' />
295 </params>
296 </command>
297 <command id='logging print file (0|1|basename) [last]'>
298 <params>
299 <param name='logging' doc='Configure logging' />
300 <param name='print' doc='Log output settings' />
301 <param name='file' doc='Configure log message' />
302 <param name='0' doc='Don&apos;t prefix each log message' />
303 <param name='1' doc='Prefix each log message with the source file and line' />
304 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
305 <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.' />
306 </params>
307 </command>
308 <command id='logging set-log-mask MASK'>
309 <params>
310 <param name='logging' doc='Configure logging' />
311 <param name='set-log-mask' doc='Set the logmask of this logging target' />
312 <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' />
313 </params>
314 </command>
315 <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
316 <params>
317 <param name='logging' doc='Configure logging' />
318 <param name='level' doc='Set the log level for a specified category' />
319 <param name='main' doc='Main program' />
320 <param name='hnbap' doc='Home Node B Application Part' />
321 <param name='rua' doc='RANAP User Adaptation' />
322 <param name='ranap' doc='RAN Application Part' />
323 <param name='lglobal' doc='Library-internal global log family' />
324 <param name='llapd' doc='LAPD in libosmogsm' />
325 <param name='linp' doc='A-bis Intput Subsystem' />
326 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
327 <param name='lmi' doc='A-bis Input Driver for Signalling' />
328 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
329 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
330 <param name='lctrl' doc='Control Interface' />
331 <param name='lgtp' doc='GPRS GTP library' />
332 <param name='lstats' doc='Statistics messages and logging' />
333 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
334 <param name='loap' doc='Osmocom Authentication Protocol' />
335 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
336 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
337 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
338 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
339 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
340 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
341 <param name='lrspro' doc='Remote SIM protocol' />
342 <param name='debug' doc='Log debug messages and higher levels' />
343 <param name='info' doc='Log informational messages and higher levels' />
344 <param name='notice' doc='Log noticeable messages and higher levels' />
345 <param name='error' doc='Log error messages and higher levels' />
346 <param name='fatal' doc='Log only fatal messages' />
347 </params>
348 </command>
349 <command id='logging level set-all (debug|info|notice|error|fatal)'>
350 <params>
351 <param name='logging' doc='Configure logging' />
352 <param name='level' doc='Set the log level for a specified category' />
353 <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.' />
354 <param name='debug' doc='Log debug messages and higher levels' />
355 <param name='info' doc='Log informational messages and higher levels' />
356 <param name='notice' doc='Log noticeable messages and higher levels' />
357 <param name='error' doc='Log error messages and higher levels' />
358 <param name='fatal' doc='Log only fatal messages' />
359 </params>
360 </command>
361 <command id='logging level force-all (debug|info|notice|error|fatal)'>
362 <params>
363 <param name='logging' doc='Configure logging' />
364 <param name='level' doc='Set the log level for a specified category' />
365 <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.' />
366 <param name='debug' doc='Log debug messages and higher levels' />
367 <param name='info' doc='Log informational messages and higher levels' />
368 <param name='notice' doc='Log noticeable messages and higher levels' />
369 <param name='error' doc='Log error messages and higher levels' />
370 <param name='fatal' doc='Log only fatal messages' />
371 </params>
372 </command>
373 <command id='no logging level force-all'>
374 <params>
375 <param name='no' doc='Negate a command or set its defaults' />
376 <param name='logging' doc='Configure logging' />
377 <param name='level' doc='Set the log level for a specified category' />
378 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
379 </params>
380 </command>
381 <command id='show logging vty'>
382 <params>
383 <param name='show' doc='Show running system information' />
384 <param name='logging' doc='Show current logging configuration' />
385 <param name='vty' doc='Show current logging configuration for this vty' />
386 </params>
387 </command>
388 <command id='show alarms'>
389 <params>
390 <param name='show' doc='Show running system information' />
391 <param name='alarms' doc='Show current logging configuration' />
392 </params>
393 </command>
394 </node>
395 <node id='enable'>
396 <name>enable</name>
397 <command id='disable'>
398 <params>
399 <param name='disable' doc='Turn off privileged mode command' />
400 </params>
401 </command>
402 <command id='configure terminal'>
403 <params>
404 <param name='configure' doc='Configuration from vty interface' />
405 <param name='terminal' doc='Configuration terminal' />
406 </params>
407 </command>
408 <command id='copy running-config startup-config'>
409 <params>
410 <param name='copy' doc='Copy configuration' />
411 <param name='running-config' doc='Copy running config to... ' />
412 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
413 </params>
414 </command>
415 <command id='show startup-config'>
416 <params>
417 <param name='show' doc='Show running system information' />
418 <param name='startup-config' doc='Contentes of startup configuration' />
419 </params>
420 </command>
421 <command id='show version'>
422 <params>
423 <param name='show' doc='Show running system information' />
424 <param name='version' doc='Displays program version' />
425 </params>
426 </command>
427 <command id='show online-help'>
428 <params>
429 <param name='show' doc='Show running system information' />
430 <param name='online-help' doc='Online help' />
431 </params>
432 </command>
433 <command id='terminal length &lt;0-512&gt;'>
434 <params>
435 <param name='terminal' doc='Set terminal line parameters' />
436 <param name='length' doc='Set number of lines on a screen' />
437 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
438 </params>
439 </command>
440 <command id='terminal no length'>
441 <params>
442 <param name='terminal' doc='Set terminal line parameters' />
443 <param name='no' doc='Negate a command or set its defaults' />
444 <param name='length' doc='Set number of lines on a screen' />
445 </params>
446 </command>
447 <command id='who'>
448 <params>
449 <param name='who' doc='Display who is on vty' />
450 </params>
451 </command>
452 <command id='show history'>
453 <params>
454 <param name='show' doc='Show running system information' />
455 <param name='history' doc='Display the session command history' />
456 </params>
457 </command>
458 <command id='terminal monitor'>
459 <params>
460 <param name='terminal' doc='Set terminal line parameters' />
461 <param name='monitor' doc='Copy debug output to the current terminal line' />
462 </params>
463 </command>
464 <command id='terminal no monitor'>
465 <params>
466 <param name='terminal' doc='Set terminal line parameters' />
467 <param name='no' doc='Negate a command or set its defaults' />
468 <param name='monitor' doc='Copy debug output to the current terminal line' />
469 </params>
470 </command>
471 <command id='show cs7 instance &lt;0-15&gt; users'>
472 <params>
473 <param name='show' doc='Show running system information' />
474 <param name='cs7' doc='ITU-T Signaling System 7' />
475 <param name='instance' doc='An instance of the SS7 stack' />
476 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
477 <param name='users' doc='User Table' />
478 </params>
479 </command>
480 <command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
481 <params>
482 <param name='show' doc='Show running system information' />
483 <param name='cs7' doc='ITU-T Signaling System 7' />
484 <param name='sua' doc='SCCP User Adaptation' />
485 <param name='m3ua' doc='MTP3 User Adaptation' />
486 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
487 <param name='[&lt;0-65534&gt;]' doc='Port Number' />
488 </params>
489 </command>
490 <command id='show cs7 instance &lt;0-15&gt; asp'>
491 <params>
492 <param name='show' doc='Show running system information' />
493 <param name='cs7' doc='ITU-T Signaling System 7' />
494 <param name='instance' doc='An instance of the SS7 stack' />
495 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
496 <param name='asp' doc='Application Server Process (ASP)' />
497 </params>
498 </command>
499 <command id='show cs7 instance &lt;0-15&gt; as (active|all|m3ua|sua)'>
500 <params>
501 <param name='show' doc='Show running system information' />
502 <param name='cs7' doc='ITU-T Signaling System 7' />
503 <param name='instance' doc='An instance of the SS7 stack' />
504 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
505 <param name='as' doc='Application Server (AS)' />
506 <param name='active' doc='Display all active ASs' />
507 <param name='all' doc='Display all ASs (default)' />
508 <param name='m3ua' doc='Display all m3ua ASs' />
509 <param name='sua' doc='Display all SUA ASs' />
510 </params>
511 </command>
512 <command id='show cs7 instance &lt;0-15&gt; sccp addressbook'>
513 <params>
514 <param name='show' doc='Show running system information' />
515 <param name='cs7' doc='ITU-T Signaling System 7' />
516 <param name='instance' doc='An instance of the SS7 stack' />
517 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
518 <param name='sccp' doc='Signalling Connection Control Part' />
519 <param name='addressbook' doc='List all SCCP addressbook entries' />
520 </params>
521 </command>
522 <command id='show cs7 instance &lt;0-15&gt; sccp users'>
523 <params>
524 <param name='show' doc='Show running system information' />
525 <param name='cs7' doc='ITU-T Signaling System 7' />
526 <param name='instance' doc='An instance of the SS7 stack' />
527 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
528 <param name='sccp' doc='Signalling Connection Control Part' />
529 <param name='users' doc='Show List of SCCP Users registered' />
530 </params>
531 </command>
532 <command id='show cs7 instance &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
533 <params>
534 <param name='show' doc='Show running system information' />
535 <param name='cs7' doc='ITU-T Signaling System 7' />
536 <param name='instance' doc='An instance of the SS7 stack' />
537 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
538 <param name='sccp' doc='Signalling Connection Control Part' />
539 <param name='ssn' doc='Find an SCCP User registered for the given SSN' />
540 <param name='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
541 </params>
542 </command>
543 <command id='show cs7 instance &lt;0-15&gt; sccp connections'>
544 <params>
545 <param name='show' doc='Show running system information' />
546 <param name='cs7' doc='ITU-T Signaling System 7' />
547 <param name='instance' doc='An instance of the SS7 stack' />
548 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
549 <param name='sccp' doc='Signalling Connection Control Part' />
550 <param name='connections' doc='Show List of active SCCP connections' />
551 </params>
552 </command>
553 <command id='show cs7 instance &lt;0-15&gt; sccp timers'>
554 <params>
555 <param name='show' doc='Show running system information' />
556 <param name='cs7' doc='ITU-T Signaling System 7' />
557 <param name='instance' doc='An instance of the SS7 stack' />
558 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
559 <param name='sccp' doc='Signaling Connection Control Part' />
560 <param name='timers' doc='Show List of SCCP timers' />
561 </params>
562 </command>
563 <command id='show cnlink'>
564 <params>
565 <param name='show' doc='Show running system information' />
566 <param name='cnlink' doc='Display information on core network link' />
567 </params>
568 </command>
569 <command id='show hnb all'>
570 <params>
571 <param name='show' doc='Show running system information' />
572 <param name='hnb' doc='Display information about all HNB' />
573 <param name='all' doc='(null)' />
574 </params>
575 </command>
576 <command id='show hnb NAME '>
577 <params>
578 <param name='show' doc='Show running system information' />
579 <param name='hnb' doc='Display information about a HNB' />
580 <param name='NAME' doc='(null)' />
581 </params>
582 </command>
583 <command id='show ue all'>
584 <params>
585 <param name='show' doc='Show running system information' />
586 <param name='ue' doc='Display information about a UE' />
587 <param name='all' doc='(null)' />
588 </params>
589 </command>
590 <command id='show talloc'>
591 <params>
592 <param name='show' doc='Show running system information' />
593 <param name='talloc' doc='Display talloc info' />
594 </params>
595 </command>
596 <command id='logging enable'>
597 <params>
598 <param name='logging' doc='Configure logging' />
599 <param name='enable' doc='Enables logging to this vty' />
600 </params>
601 </command>
602 <command id='logging disable'>
603 <params>
604 <param name='logging' doc='Configure logging' />
605 <param name='disable' doc='Disables logging to this vty' />
606 </params>
607 </command>
608 <command id='logging filter all (0|1)'>
609 <params>
610 <param name='logging' doc='Configure logging' />
611 <param name='filter' doc='Filter log messages' />
612 <param name='all' doc='Do you want to log all messages?' />
613 <param name='0' doc='Only print messages matched by other filters' />
614 <param name='1' doc='Bypass filter and print all messages' />
615 </params>
616 </command>
617 <command id='logging color (0|1)'>
618 <params>
619 <param name='logging' doc='Configure logging' />
620 <param name='color' doc='Configure color-printing for log messages' />
621 <param name='0' doc='Don&apos;t use color for printing messages' />
622 <param name='1' doc='Use color for printing messages' />
623 </params>
624 </command>
625 <command id='logging timestamp (0|1)'>
626 <params>
627 <param name='logging' doc='Configure logging' />
628 <param name='timestamp' doc='Configure log message timestamping' />
629 <param name='0' doc='Don&apos;t prefix each log message' />
630 <param name='1' doc='Prefix each log message with current timestamp' />
631 </params>
632 </command>
633 <command id='logging print extended-timestamp (0|1)'>
634 <params>
635 <param name='logging' doc='Configure logging' />
636 <param name='print' doc='Log output settings' />
637 <param name='extended-timestamp' doc='Configure log message timestamping' />
638 <param name='0' doc='Don&apos;t prefix each log message' />
639 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
640 </params>
641 </command>
642 <command id='logging print category (0|1)'>
643 <params>
644 <param name='logging' doc='Configure logging' />
645 <param name='print' doc='Log output settings' />
646 <param name='category' doc='Configure log message' />
647 <param name='0' doc='Don&apos;t prefix each log message' />
648 <param name='1' doc='Prefix each log message with category/subsystem name' />
649 </params>
650 </command>
651 <command id='logging print category-hex (0|1)'>
652 <params>
653 <param name='logging' doc='Configure logging' />
654 <param name='print' doc='Log output settings' />
655 <param name='category-hex' doc='Configure log message' />
656 <param name='0' doc='Don&apos;t prefix each log message' />
657 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
658 </params>
659 </command>
660 <command id='logging print level (0|1)'>
661 <params>
662 <param name='logging' doc='Configure logging' />
663 <param name='print' doc='Log output settings' />
664 <param name='level' doc='Configure log message' />
665 <param name='0' doc='Don&apos;t prefix each log message' />
666 <param name='1' doc='Prefix each log message with the log level name' />
667 </params>
668 </command>
669 <command id='logging print file (0|1|basename) [last]'>
670 <params>
671 <param name='logging' doc='Configure logging' />
672 <param name='print' doc='Log output settings' />
673 <param name='file' doc='Configure log message' />
674 <param name='0' doc='Don&apos;t prefix each log message' />
675 <param name='1' doc='Prefix each log message with the source file and line' />
676 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
677 <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.' />
678 </params>
679 </command>
680 <command id='logging set-log-mask MASK'>
681 <params>
682 <param name='logging' doc='Configure logging' />
683 <param name='set-log-mask' doc='Set the logmask of this logging target' />
684 <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' />
685 </params>
686 </command>
687 <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
688 <params>
689 <param name='logging' doc='Configure logging' />
690 <param name='level' doc='Set the log level for a specified category' />
691 <param name='main' doc='Main program' />
692 <param name='hnbap' doc='Home Node B Application Part' />
693 <param name='rua' doc='RANAP User Adaptation' />
694 <param name='ranap' doc='RAN Application Part' />
695 <param name='lglobal' doc='Library-internal global log family' />
696 <param name='llapd' doc='LAPD in libosmogsm' />
697 <param name='linp' doc='A-bis Intput Subsystem' />
698 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
699 <param name='lmi' doc='A-bis Input Driver for Signalling' />
700 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
701 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
702 <param name='lctrl' doc='Control Interface' />
703 <param name='lgtp' doc='GPRS GTP library' />
704 <param name='lstats' doc='Statistics messages and logging' />
705 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
706 <param name='loap' doc='Osmocom Authentication Protocol' />
707 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
708 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
709 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
710 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
711 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
712 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
713 <param name='lrspro' doc='Remote SIM protocol' />
714 <param name='debug' doc='Log debug messages and higher levels' />
715 <param name='info' doc='Log informational messages and higher levels' />
716 <param name='notice' doc='Log noticeable messages and higher levels' />
717 <param name='error' doc='Log error messages and higher levels' />
718 <param name='fatal' doc='Log only fatal messages' />
719 </params>
720 </command>
721 <command id='logging level set-all (debug|info|notice|error|fatal)'>
722 <params>
723 <param name='logging' doc='Configure logging' />
724 <param name='level' doc='Set the log level for a specified category' />
725 <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.' />
726 <param name='debug' doc='Log debug messages and higher levels' />
727 <param name='info' doc='Log informational messages and higher levels' />
728 <param name='notice' doc='Log noticeable messages and higher levels' />
729 <param name='error' doc='Log error messages and higher levels' />
730 <param name='fatal' doc='Log only fatal messages' />
731 </params>
732 </command>
733 <command id='logging level force-all (debug|info|notice|error|fatal)'>
734 <params>
735 <param name='logging' doc='Configure logging' />
736 <param name='level' doc='Set the log level for a specified category' />
737 <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.' />
738 <param name='debug' doc='Log debug messages and higher levels' />
739 <param name='info' doc='Log informational messages and higher levels' />
740 <param name='notice' doc='Log noticeable messages and higher levels' />
741 <param name='error' doc='Log error messages and higher levels' />
742 <param name='fatal' doc='Log only fatal messages' />
743 </params>
744 </command>
745 <command id='no logging level force-all'>
746 <params>
747 <param name='no' doc='Negate a command or set its defaults' />
748 <param name='logging' doc='Configure logging' />
749 <param name='level' doc='Set the log level for a specified category' />
750 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
751 </params>
752 </command>
753 <command id='show logging vty'>
754 <params>
755 <param name='show' doc='Show running system information' />
756 <param name='logging' doc='Show current logging configuration' />
757 <param name='vty' doc='Show current logging configuration for this vty' />
758 </params>
759 </command>
760 <command id='show alarms'>
761 <params>
762 <param name='show' doc='Show running system information' />
763 <param name='alarms' doc='Show current logging configuration' />
764 </params>
765 </command>
766 </node>
767 <node id='config'>
768 <name>config</name>
769 <command id='hostname WORD'>
770 <params>
771 <param name='hostname' doc='Set system&apos;s network name' />
772 <param name='WORD' doc='This system&apos;s network name' />
773 </params>
774 </command>
775 <command id='no hostname [HOSTNAME]'>
776 <params>
777 <param name='no' doc='Negate a command or set its defaults' />
778 <param name='hostname' doc='Reset system&apos;s network name' />
779 <param name='[HOSTNAME]' doc='Host name of this router' />
780 </params>
781 </command>
782 <command id='password (8|) WORD'>
783 <params>
784 <param name='password' doc='Assign the terminal connection password' />
785 <param name='8' doc='Specifies a HIDDEN password will follow' />
786 <param name='' doc='dummy string ' />
787 <param name='WORD' doc='The HIDDEN line password string' />
788 </params>
789 </command>
790 <command id='password LINE'>
791 <params>
792 <param name='password' doc='Assign the terminal connection password' />
793 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
794 </params>
795 </command>
796 <command id='enable password (8|) WORD'>
797 <params>
798 <param name='enable' doc='Modify enable password parameters' />
799 <param name='password' doc='Assign the privileged level password' />
800 <param name='8' doc='Specifies a HIDDEN password will follow' />
801 <param name='' doc='dummy string ' />
802 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
803 </params>
804 </command>
805 <command id='enable password LINE'>
806 <params>
807 <param name='enable' doc='Modify enable password parameters' />
808 <param name='password' doc='Assign the privileged level password' />
809 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
810 </params>
811 </command>
812 <command id='no enable password'>
813 <params>
814 <param name='no' doc='Negate a command or set its defaults' />
815 <param name='enable' doc='Modify enable password parameters' />
816 <param name='password' doc='Assign the privileged level password' />
817 </params>
818 </command>
819 <command id='banner motd default'>
820 <params>
821 <param name='banner' doc='Set banner string' />
822 <param name='motd' doc='Strings for motd' />
823 <param name='default' doc='Default string' />
824 </params>
825 </command>
826 <command id='banner motd file [FILE]'>
827 <params>
828 <param name='banner' doc='Set banner' />
829 <param name='motd' doc='Banner for motd' />
830 <param name='file' doc='Banner from a file' />
831 <param name='[FILE]' doc='Filename' />
832 </params>
833 </command>
834 <command id='no banner motd'>
835 <params>
836 <param name='no' doc='Negate a command or set its defaults' />
837 <param name='banner' doc='Set banner string' />
838 <param name='motd' doc='Strings for motd' />
839 </params>
840 </command>
841 <command id='service terminal-length &lt;0-512&gt;'>
842 <params>
843 <param name='service' doc='Set up miscellaneous service' />
844 <param name='terminal-length' doc='System wide terminal length configuration' />
845 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
846 </params>
847 </command>
848 <command id='no service terminal-length [&lt;0-512&gt;]'>
849 <params>
850 <param name='no' doc='Negate a command or set its defaults' />
851 <param name='service' doc='Set up miscellaneous service' />
852 <param name='terminal-length' doc='System wide terminal length configuration' />
853 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
854 </params>
855 </command>
856 <command id='line vty'>
857 <params>
858 <param name='line' doc='Configure a terminal line' />
859 <param name='vty' doc='Virtual terminal' />
860 </params>
861 </command>
862 <command id='service advanced-vty'>
863 <params>
864 <param name='service' doc='Set up miscellaneous service' />
865 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
866 </params>
867 </command>
868 <command id='no service advanced-vty'>
869 <params>
870 <param name='no' doc='Negate a command or set its defaults' />
871 <param name='service' doc='Set up miscellaneous service' />
872 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
873 </params>
874 </command>
875 <command id='show history'>
876 <params>
877 <param name='show' doc='Show running system information' />
878 <param name='history' doc='Display the session command history' />
879 </params>
880 </command>
881 <command id='cs7 instance &lt;0-15&gt;'>
882 <params>
883 <param name='cs7' doc='ITU-T Signaling System 7' />
884 <param name='instance' doc='Configure a SS7 Instance' />
885 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
886 </params>
887 </command>
888 <command id='hnbgw'>
889 <params>
890 <param name='hnbgw' doc='Configure HNBGW options' />
891 </params>
892 </command>
893 <command id='log stderr'>
894 <params>
895 <param name='log' doc='Configure logging sub-system' />
896 <param name='stderr' doc='Logging via STDERR of the process' />
897 </params>
898 </command>
899 <command id='no log stderr'>
900 <params>
901 <param name='no' doc='Negate a command or set its defaults' />
902 <param name='log' doc='Configure logging sub-system' />
903 <param name='stderr' doc='Logging via STDERR of the process' />
904 </params>
905 </command>
906 <command id='log file .FILENAME'>
907 <params>
908 <param name='log' doc='Configure logging sub-system' />
909 <param name='file' doc='Logging to text file' />
910 <param name='.FILENAME' doc='Filename' />
911 </params>
912 </command>
913 <command id='no log file .FILENAME'>
914 <params>
915 <param name='no' doc='Negate a command or set its defaults' />
916 <param name='log' doc='Configure logging sub-system' />
917 <param name='file' doc='Logging to text file' />
918 <param name='.FILENAME' doc='Filename' />
919 </params>
920 </command>
921 <command id='log alarms &lt;2-32700&gt;'>
922 <params>
923 <param name='log' doc='Configure logging sub-system' />
924 <param name='alarms' doc='Logging alarms to osmo_strrb' />
925 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
926 </params>
927 </command>
928 <command id='no log alarms'>
929 <params>
930 <param name='no' doc='Negate a command or set its defaults' />
931 <param name='log' doc='Configure logging sub-system' />
932 <param name='alarms' doc='Logging alarms to osmo_strrb' />
933 </params>
934 </command>
935 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
936 <params>
937 <param name='log' doc='Configure logging sub-system' />
938 <param name='syslog' doc='Logging via syslog' />
939 <param name='authpriv' doc='Security/authorization messages facility' />
940 <param name='cron' doc='Clock daemon (cron/at) facility' />
941 <param name='daemon' doc='General system daemon facility' />
942 <param name='ftp' doc='Ftp daemon facility' />
943 <param name='lpr' doc='Line printer facility' />
944 <param name='mail' doc='Mail facility' />
945 <param name='news' doc='News facility' />
946 <param name='user' doc='Generic facility' />
947 <param name='uucp' doc='UUCP facility' />
948 </params>
949 </command>
950 <command id='log syslog local &lt;0-7&gt;'>
951 <params>
952 <param name='log' doc='Configure logging sub-system' />
953 <param name='syslog' doc='Logging via syslog' />
954 <param name='local' doc='Syslog LOCAL facility' />
955 <param name='&lt;0-7&gt;' doc='Local facility number' />
956 </params>
957 </command>
958 <command id='no log syslog'>
959 <params>
960 <param name='no' doc='Negate a command or set its defaults' />
961 <param name='log' doc='Configure logging sub-system' />
962 <param name='syslog' doc='Logging via syslog' />
963 </params>
964 </command>
965 <command id='log gsmtap [HOSTNAME]'>
966 <params>
967 <param name='log' doc='Configure logging sub-system' />
968 <param name='gsmtap' doc='Logging via GSMTAP' />
969 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
970 </params>
971 </command>
972 </node>
973 <node id='config-log'>
974 <name>config-log</name>
975 <command id='logging filter all (0|1)'>
976 <params>
977 <param name='logging' doc='Configure logging' />
978 <param name='filter' doc='Filter log messages' />
979 <param name='all' doc='Do you want to log all messages?' />
980 <param name='0' doc='Only print messages matched by other filters' />
981 <param name='1' doc='Bypass filter and print all messages' />
982 </params>
983 </command>
984 <command id='logging color (0|1)'>
985 <params>
986 <param name='logging' doc='Configure logging' />
987 <param name='color' doc='Configure color-printing for log messages' />
988 <param name='0' doc='Don&apos;t use color for printing messages' />
989 <param name='1' doc='Use color for printing messages' />
990 </params>
991 </command>
992 <command id='logging timestamp (0|1)'>
993 <params>
994 <param name='logging' doc='Configure logging' />
995 <param name='timestamp' doc='Configure log message timestamping' />
996 <param name='0' doc='Don&apos;t prefix each log message' />
997 <param name='1' doc='Prefix each log message with current timestamp' />
998 </params>
999 </command>
1000 <command id='logging print extended-timestamp (0|1)'>
1001 <params>
1002 <param name='logging' doc='Configure logging' />
1003 <param name='print' doc='Log output settings' />
1004 <param name='extended-timestamp' doc='Configure log message timestamping' />
1005 <param name='0' doc='Don&apos;t prefix each log message' />
1006 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1007 </params>
1008 </command>
1009 <command id='logging print category (0|1)'>
1010 <params>
1011 <param name='logging' doc='Configure logging' />
1012 <param name='print' doc='Log output settings' />
1013 <param name='category' doc='Configure log message' />
1014 <param name='0' doc='Don&apos;t prefix each log message' />
1015 <param name='1' doc='Prefix each log message with category/subsystem name' />
1016 </params>
1017 </command>
1018 <command id='logging print category-hex (0|1)'>
1019 <params>
1020 <param name='logging' doc='Configure logging' />
1021 <param name='print' doc='Log output settings' />
1022 <param name='category-hex' doc='Configure log message' />
1023 <param name='0' doc='Don&apos;t prefix each log message' />
1024 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1025 </params>
1026 </command>
1027 <command id='logging print level (0|1)'>
1028 <params>
1029 <param name='logging' doc='Configure logging' />
1030 <param name='print' doc='Log output settings' />
1031 <param name='level' doc='Configure log message' />
1032 <param name='0' doc='Don&apos;t prefix each log message' />
1033 <param name='1' doc='Prefix each log message with the log level name' />
1034 </params>
1035 </command>
1036 <command id='logging print file (0|1|basename) [last]'>
1037 <params>
1038 <param name='logging' doc='Configure logging' />
1039 <param name='print' doc='Log output settings' />
1040 <param name='file' doc='Configure log message' />
1041 <param name='0' doc='Don&apos;t prefix each log message' />
1042 <param name='1' doc='Prefix each log message with the source file and line' />
1043 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
1044 <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.' />
1045 </params>
1046 </command>
1047 <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
1048 <params>
1049 <param name='logging' doc='Configure logging' />
1050 <param name='level' doc='Set the log level for a specified category' />
1051 <param name='main' doc='Main program' />
1052 <param name='hnbap' doc='Home Node B Application Part' />
1053 <param name='rua' doc='RANAP User Adaptation' />
1054 <param name='ranap' doc='RAN Application Part' />
1055 <param name='lglobal' doc='Library-internal global log family' />
1056 <param name='llapd' doc='LAPD in libosmogsm' />
1057 <param name='linp' doc='A-bis Intput Subsystem' />
1058 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1059 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1060 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1061 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1062 <param name='lctrl' doc='Control Interface' />
1063 <param name='lgtp' doc='GPRS GTP library' />
1064 <param name='lstats' doc='Statistics messages and logging' />
1065 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1066 <param name='loap' doc='Osmocom Authentication Protocol' />
1067 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1068 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1069 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1070 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1071 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1072 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
1073 <param name='lrspro' doc='Remote SIM protocol' />
1074 <param name='debug' doc='Log debug messages and higher levels' />
1075 <param name='info' doc='Log informational messages and higher levels' />
1076 <param name='notice' doc='Log noticeable messages and higher levels' />
1077 <param name='error' doc='Log error messages and higher levels' />
1078 <param name='fatal' doc='Log only fatal messages' />
1079 </params>
1080 </command>
1081 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1082 <params>
1083 <param name='logging' doc='Configure logging' />
1084 <param name='level' doc='Set the log level for a specified category' />
1085 <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.' />
1086 <param name='debug' doc='Log debug messages and higher levels' />
1087 <param name='info' doc='Log informational messages and higher levels' />
1088 <param name='notice' doc='Log noticeable messages and higher levels' />
1089 <param name='error' doc='Log error messages and higher levels' />
1090 <param name='fatal' doc='Log only fatal messages' />
1091 </params>
1092 </command>
1093 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1094 <params>
1095 <param name='logging' doc='Configure logging' />
1096 <param name='level' doc='Set the log level for a specified category' />
1097 <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.' />
1098 <param name='debug' doc='Log debug messages and higher levels' />
1099 <param name='info' doc='Log informational messages and higher levels' />
1100 <param name='notice' doc='Log noticeable messages and higher levels' />
1101 <param name='error' doc='Log error messages and higher levels' />
1102 <param name='fatal' doc='Log only fatal messages' />
1103 </params>
1104 </command>
1105 <command id='no logging level force-all'>
1106 <params>
1107 <param name='no' doc='Negate a command or set its defaults' />
1108 <param name='logging' doc='Configure logging' />
1109 <param name='level' doc='Set the log level for a specified category' />
1110 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1111 </params>
1112 </command>
1113 </node>
1114 <node id='config-line'>
1115 <name>config-line</name>
1116 <command id='login'>
1117 <params>
1118 <param name='login' doc='Enable password checking' />
1119 </params>
1120 </command>
1121 <command id='no login'>
1122 <params>
1123 <param name='no' doc='Negate a command or set its defaults' />
1124 <param name='login' doc='Enable password checking' />
1125 </params>
1126 </command>
1127 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
1128 <params>
1129 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1130 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1131 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
1132 </params>
1133 </command>
1134 </node>
1135 <node id='config-cs7'>
1136 <name>config-cs7</name>
1137 <command id='description .TEXT'>
1138 <params>
1139 <param name='description' doc='Save human-readable description of the object' />
1140 <param name='.TEXT' doc='Text until the end of the line' />
1141 </params>
1142 </command>
1143 <command id='network-indicator (international | national | reserved | spare)'>
1144 <params>
1145 <param name='network-indicator' doc='Configure the Network Indicator' />
1146 <param name='international' doc='International Network' />
1147 <param name='national' doc='National Network' />
1148 <param name='reserved' doc='Reserved Network' />
1149 <param name='spare' doc='Spare Network' />
1150 </params>
1151 </command>
1152 <command id='point-code POINT_CODE'>
1153 <params>
1154 <param name='point-code' doc='Configure the local Point Code' />
1155 <param name='POINT_CODE' doc='Point Code' />
1156 </params>
1157 </command>
1158 <command id='point-code format &lt;1-24&gt; [&lt;1-23&gt;] [&lt;1-22&gt;]'>
1159 <params>
1160 <param name='point-code' doc='Point Code' />
1161 <param name='format' doc='Configure Point Code Format' />
1162 <param name='&lt;1-24&gt;' doc='Length of first PC component' />
1163 <param name='[&lt;1-23&gt;]' doc='Length of second PC component' />
1164 <param name='[&lt;1-22&gt;]' doc='Length of third PC component' />
1165 </params>
1166 </command>
1167 <command id='point-code format default'>
1168 <params>
1169 <param name='point-code' doc='Point Code' />
1170 <param name='format' doc='Configure Point Code Format' />
1171 <param name='default' doc='Default Point Code Format (3.8.3)' />
1172 </params>
1173 </command>
1174 <command id='point-code delimiter (default|dash)'>
1175 <params>
1176 <param name='point-code' doc='Point Code' />
1177 <param name='delimiter' doc='Configure Point Code Delimiter' />
1178 <param name='default' doc='Use dot as delimiter' />
1179 <param name='dash' doc='User dash as delimiter' />
1180 </params>
1181 </command>
1182 <command id='xua rkm routing-key-allocation (static-only|dynamic-permitted)'>
1183 <params>
1184 <param name='xua' doc='SIGTRAN xxxUA related' />
1185 <param name='rkm' doc='Routing Key Management' />
1186 <param name='routing-key-allocation' doc='Routing Key Management Allocation Policy' />
1187 <param name='static-only' doc='Only static (pre-confgured) Routing Keys permitted' />
1188 <param name='dynamic-permitted' doc='Dynamically allocate Routing Keys for what ASPs request' />
1189 </params>
1190 </command>
1191 <command id='asp NAME &lt;0-65535&gt; &lt;0-65535&gt; (sua|m3ua|ipa)'>
1192 <params>
1193 <param name='asp' doc='Configure Application Server Process' />
1194 <param name='NAME' doc='Name of ASP' />
1195 <param name='&lt;0-65535&gt;' doc='Remote SCTP port number' />
1196 <param name='&lt;0-65535&gt;' doc='Local SCTP port number' />
1197 <param name='sua' doc='SCCP User Adaptation' />
1198 <param name='m3ua' doc='MTP3 User Adaptation' />
1199 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
1200 </params>
1201 </command>
1202 <command id='no asp NAME'>
1203 <params>
1204 <param name='no' doc='Negate a command or set its defaults' />
1205 <param name='asp' doc='Disable Application Server Process' />
1206 <param name='NAME' doc='Name of ASP' />
1207 </params>
1208 </command>
1209 <command id='as NAME (sua|m3ua|ipa)'>
1210 <params>
1211 <param name='as' doc='Configure an Application Server' />
1212 <param name='NAME' doc='Name of the Application Server' />
1213 <param name='sua' doc='SCCP User Adaptation' />
1214 <param name='m3ua' doc='MTP3 User Adaptation' />
1215 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
1216 </params>
1217 </command>
1218 <command id='no as NAME'>
1219 <params>
1220 <param name='no' doc='Negate a command or set its defaults' />
1221 <param name='as' doc='Disable Application Server' />
1222 <param name='NAME' doc='Name of AS' />
1223 </params>
1224 </command>
1225 <command id='sccp-address NAME'>
1226 <params>
1227 <param name='sccp-address' doc='Create/Modify an SCCP addressbook entry' />
1228 <param name='NAME' doc='Name of the SCCP Address' />
1229 </params>
1230 </command>
1231 <command id='no sccp-address NAME'>
1232 <params>
1233 <param name='no' doc='Negate a command or set its defaults' />
1234 <param name='sccp-address' doc='Delete an SCCP addressbook entry' />
1235 <param name='NAME' doc='Name of the SCCP Address' />
1236 </params>
1237 </command>
1238 <command id='sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) &lt;1-999999&gt;'>
1239 <params>
1240 <param name='sccp-timer' doc='Configure SCCP timer values, see ITU-T Q.714' />
1241 <param name='conn_est' doc='Waiting for connection confirm message, 1 to 2 minutes (default: 60)' />
1242 <param name='ias' doc='Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)' />
1243 <param name='iar' doc='Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)' />
1244 <param name='rel' doc='Waiting for release complete message, 10 to 20 seconds (default: 10)' />
1245 <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)' />
1246 <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)' />
1247 <param name='guard' doc='Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes (default: 1380)' />
1248 <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)' />
1249 <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)' />
1250 <param name='&lt;1-999999&gt;' doc='Timer value, in seconds' />
1251 </params>
1252 </command>
1253 </node>
1254 <node id='config-cs7-as'>
1255 <name>config-cs7-as</name>
1256 <command id='description .TEXT'>
1257 <params>
1258 <param name='description' doc='Save human-readable description of the object' />
1259 <param name='.TEXT' doc='Text until the end of the line' />
1260 </params>
1261 </command>
1262 <command id='asp NAME'>
1263 <params>
1264 <param name='asp' doc='Specify that a given ASP is part of this AS' />
1265 <param name='NAME' doc='Name of ASP to be added to AS' />
1266 </params>
1267 </command>
1268 <command id='no asp NAME'>
1269 <params>
1270 <param name='no' doc='Negate a command or set its defaults' />
1271 <param name='asp' doc='Specify ASP to be removed from this AS' />
1272 <param name='NAME' doc='Name of ASP to be removed' />
1273 </params>
1274 </command>
1275 <command id='traffic-mode (broadcast | loadshare | roundrobin | override)'>
1276 <params>
1277 <param name='traffic-mode' doc='Specifies traffic mode of operation of the ASP within the AS' />
1278 <param name='broadcast' doc='Broadcast to all ASP within AS' />
1279 <param name='loadshare' doc='Share Load among all ASP within AS' />
1280 <param name='roundrobin' doc='Round-Robin between all ASP within AS' />
1281 <param name='override' doc='Override' />
1282 </params>
1283 </command>
1284 <command id='recovery-timeout &lt;1-2000&gt;'>
1285 <params>
1286 <param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' />
1287 <param name='&lt;1-2000&gt;' doc='Recovery Timeout in Milliseconds' />
1288 </params>
1289 </command>
1290 <command id='qos-class &lt;0-255&gt;'>
1291 <params>
1292 <param name='qos-class' doc='Specity QoS Class of AS' />
1293 <param name='&lt;0-255&gt;' doc='QoS Class of AS' />
1294 </params>
1295 </command>
1296 <command id='routing-key RCONTEXT DPC'>
1297 <params>
1298 <param name='routing-key' doc='Define a routing key' />
1299 <param name='RCONTEXT' doc='Routing context number' />
1300 <param name='DPC' doc='Destination Point Code' />
1301 </params>
1302 </command>
1303 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)'>
1304 <params>
1305 <param name='routing-key' doc='Define a routing key' />
1306 <param name='RCONTEXT' doc='Routing context number' />
1307 <param name='DPC' doc='Destination Point Code' />
1308 <param name='si' doc='Match on Service Indicator' />
1309 <param name='aal2' doc='ATM Adaption Layer 2' />
1310 <param name='bicc' doc='Bearer Independent Call Control' />
1311 <param name='b-isup' doc='Broadband ISDN User Part' />
1312 <param name='h248' doc='H.248' />
1313 <param name='isup' doc='ISDN User Part' />
1314 <param name='sat-isup' doc='Sattelite ISDN User Part' />
1315 <param name='sccp' doc='Signalling Connection Control Part' />
1316 <param name='tup' doc='Telephony User Part' />
1317 </params>
1318 </command>
1319 <command id='routing-key RCONTEXT DPC ssn SSN'>
1320 <params>
1321 <param name='routing-key' doc='Define a routing key' />
1322 <param name='RCONTEXT' doc='Routing context number' />
1323 <param name='DPC' doc='Destination Point Code' />
1324 <param name='ssn' doc='Match on Sub-System Number' />
1325 <param name='SSN' doc='Sub-System Number to match on' />
1326 </params>
1327 </command>
1328 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN'>
1329 <params>
1330 <param name='routing-key' doc='Define a routing key' />
1331 <param name='RCONTEXT' doc='Routing context number' />
1332 <param name='DPC' doc='Destination Point Code' />
1333 <param name='si' doc='Match on Service Indicator' />
1334 <param name='aal2' doc='ATM Adaption Layer 2' />
1335 <param name='bicc' doc='Bearer Independent Call Control' />
1336 <param name='b-isup' doc='Broadband ISDN User Part' />
1337 <param name='h248' doc='H.248' />
1338 <param name='isup' doc='ISDN User Part' />
1339 <param name='sat-isup' doc='Sattelite ISDN User Part' />
1340 <param name='sccp' doc='Signalling Connection Control Part' />
1341 <param name='tup' doc='Telephony User Part' />
1342 <param name='ssn' doc='Match on Sub-System Number' />
1343 <param name='SSN' doc='Sub-System Number to match on' />
1344 </params>
1345 </command>
1346 <command id='point-code override dpc PC'>
1347 <params>
1348 <param name='point-code' doc='Point Code Specific Features' />
1349 <param name='override' doc='Override (force) a point-code to hard-coded value' />
1350 <param name='dpc' doc='Override Source Point Code' />
1351 <param name='PC' doc='Override Destination Point Code' />
1352 </params>
1353 </command>
1354 </node>
1355 <node id='config-cs7-asp'>
1356 <name>config-cs7-asp</name>
1357 <command id='description .TEXT'>
1358 <params>
1359 <param name='description' doc='Save human-readable description of the object' />
1360 <param name='.TEXT' doc='Text until the end of the line' />
1361 </params>
1362 </command>
1363 <command id='remote-ip A.B.C.D'>
1364 <params>
1365 <param name='remote-ip' doc='Specify Remote IP Address of ASP' />
1366 <param name='A.B.C.D' doc='Remote IP Address of ASP' />
1367 </params>
1368 </command>
1369 <command id='local-ip A.B.C.D'>
1370 <params>
1371 <param name='local-ip' doc='Specify Local IP Address from which to contact ASP' />
1372 <param name='A.B.C.D' doc='Local IP Address from which to contact of ASP' />
1373 </params>
1374 </command>
1375 <command id='qos-class &lt;0-255&gt;'>
1376 <params>
1377 <param name='qos-class' doc='Specify QoS Class of ASP' />
1378 <param name='&lt;0-255&gt;' doc='QoS Class of ASP' />
1379 </params>
1380 </command>
1381 <command id='block'>
1382 <params>
1383 <param name='block' doc='Allows a SCTP Association with ASP, but doesn&apos;t let it become active' />
1384 </params>
1385 </command>
1386 <command id='shutdown'>
1387 <params>
1388 <param name='shutdown' doc='Terminates SCTP association; New associations will be rejected' />
1389 </params>
1390 </command>
1391 </node>
1392 <node id='config-cs7-sccpaddr'>
1393 <name>config-cs7-sccpaddr</name>
1394 <command id='no point-code'>
1395 <params>
1396 <param name='no' doc='Negate a command or set its defaults' />
1397 <param name='point-code' doc='Remove point-code Number' />
1398 </params>
1399 </command>
1400 <command id='no subsystem-number'>
1401 <params>
1402 <param name='no' doc='Negate a command or set its defaults' />
1403 <param name='subsystem-number' doc='Remove Subsystem Number' />
1404 </params>
1405 </command>
1406 <command id='no global-title'>
1407 <params>
1408 <param name='no' doc='Negate a command or set its defaults' />
1409 <param name='global-title' doc='Remove Global Title' />
1410 </params>
1411 </command>
1412 <command id='routing-indicator (GT|PC|IP)'>
1413 <params>
1414 <param name='routing-indicator' doc='Add Routing Indicator' />
1415 <param name='GT' doc='by global-title' />
1416 <param name='PC' doc='by point-code' />
1417 <param name='IP' doc='by ip-address' />
1418 </params>
1419 </command>
1420 <command id='point-code POINT_CODE'>
1421 <params>
1422 <param name='point-code' doc='Add point-code Number' />
1423 <param name='POINT_CODE' doc='PC' />
1424 </params>
1425 </command>
1426 <command id='subsystem-number &lt;0-4294967295&gt;'>
1427 <params>
1428 <param name='subsystem-number' doc='Add Subsystem Number' />
1429 <param name='&lt;0-4294967295&gt;' doc='SSN' />
1430 </params>
1431 </command>
1432 <command id='global-title'>
1433 <params>
1434 <param name='global-title' doc='Add/Modify Global Title' />
1435 </params>
1436 </command>
1437 </node>
1438 <node id='config-cs7-sccpaddr-gt'>
1439 <name>config-cs7-sccpaddr-gt</name>
1440 <command id='global-title-indicator &lt;0-15&gt;'>
1441 <params>
1442 <param name='global-title-indicator' doc='Set Global Title Indicator' />
1443 <param name='&lt;0-15&gt;' doc='GTI' />
1444 </params>
1445 </command>
1446 <command id='translation-type &lt;0-255&gt;'>
1447 <params>
1448 <param name='translation-type' doc='Set Global Title Translation Type' />
1449 <param name='&lt;0-255&gt;' doc='TT' />
1450 </params>
1451 </command>
1452 <command id='numbering-plan-indicator &lt;0-15&gt;'>
1453 <params>
1454 <param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' />
1455 <param name='&lt;0-15&gt;' doc='NPI' />
1456 </params>
1457 </command>
1458 <command id='nature-of-address-indicator &lt;0-127&gt;'>
1459 <params>
1460 <param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' />
1461 <param name='&lt;0-127&gt;' doc='NAI' />
1462 </params>
1463 </command>
1464 <command id='digits DIGITS'>
1465 <params>
1466 <param name='digits' doc='Set Global Title Digits' />
1467 <param name='DIGITS' doc='Number digits' />
1468 </params>
1469 </command>
1470 </node>
1471 <node id='config-hnbgw'>
1472 <name>config-hnbgw</name>
1473 <command id='rnc-id &lt;0-65535&gt;'>
1474 <params>
1475 <param name='rnc-id' doc='Configure the HNBGW&apos;s RNC Id, the common RNC Id used for all connected hNodeB. It is sent to each hNodeB upon HNBAP HNB-Register-Accept, and the hNodeB will subsequently send this as RANAP InitialUE Messages&apos; GlobalRNC-ID IE. Takes effect as soon as the hNodeB re-registers.' />
1476 <param name='&lt;0-65535&gt;' doc='RNC Id value' />
1477 </params>
1478 </command>
1479 <command id='iuh'>
1480 <params>
1481 <param name='iuh' doc='Configure Iuh options' />
1482 </params>
1483 </command>
1484 <command id='iucs'>
1485 <params>
1486 <param name='iucs' doc='Configure IuCS options' />
1487 </params>
1488 </command>
1489 <command id='iups'>
1490 <params>
1491 <param name='iups' doc='Configure IuPS options' />
1492 </params>
1493 </command>
1494 </node>
1495 <node id='config-hnbgw-iuh'>
1496 <name>config-hnbgw-iuh</name>
1497 <command id='local-ip A.B.C.D'>
1498 <params>
1499 <param name='local-ip' doc='Accept Iuh connections on local interface' />
1500 <param name='A.B.C.D' doc='Local interface IP address (default: 0.0.0.0)' />
1501 </params>
1502 </command>
1503 <command id='local-port &lt;1-65535&gt;'>
1504 <params>
1505 <param name='local-port' doc='Accept Iuh connections on local port' />
1506 <param name='&lt;1-65535&gt;' doc='Local interface port (default: 29169)' />
1507 </params>
1508 </command>
1509 <command id='hnbap-allow-tmsi (0|1)'>
1510 <params>
1511 <param name='hnbap-allow-tmsi' doc='Allow HNBAP UE Register messages with TMSI or PTMSI identity' />
1512 <param name='0' doc='Only accept IMSI identity, reject TMSI or PTMSI' />
1513 <param name='1' doc='Accept IMSI, TMSI or PTMSI as UE identity' />
1514 </params>
1515 </command>
1516 </node>
1517 <node id='config-hnbgw-iucs'>
1518 <name>config-hnbgw-iucs</name>
1519 <command id='remote-addr NAME'>
1520 <params>
1521 <param name='remote-addr' doc='SCCP address to send IuCS to (MSC)' />
1522 <param name='NAME' doc='SCCP address book entry name (see &apos;cs7-instance&apos;)' />
1523 </params>
1524 </command>
1525 </node>
1526 <node id='config-hnbgw-iups'>
1527 <name>config-hnbgw-iups</name>
1528 <command id='remote-addr NAME'>
1529 <params>
1530 <param name='remote-addr' doc='SCCP address to send IuPS to (SGSN)' />
1531 <param name='NAME' doc='SCCP address book entry name (see &apos;cs7-instance&apos;)' />
1532 </params>
1533 </command>
1534 </node>
1535</vtydoc>