Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-gbproxy / b643765d0ae78054035a88c116b51142f665dc34 / . / doc / manuals / vty / gbproxy_vty_reference.xml
blob: 19b04e1f0be270115f56c6beef2d45d1395a9cea [file] [log] [blame]
Oliver Smith149a95c2019-12-02 11:17: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>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]10 <command id='list [with-flags]'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]11 <params>
12 <param name='list' doc='Print command list' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]13 <param name='[with-flags]' doc='Also print the VTY attribute flags' />
14 </params>
15 </command>
16 <command id='show vty-attributes'>
17 <params>
18 <param name='show' doc='Show running system information' />
19 <param name='vty-attributes' doc='List of VTY attributes' />
20 </params>
21 </command>
22 <command id='show vty-attributes (application|library|global)'>
23 <params>
24 <param name='show' doc='Show running system information' />
25 <param name='vty-attributes' doc='List of VTY attributes' />
26 <param name='application' doc='Application specific attributes only' />
27 <param name='library' doc='Library specific attributes only' />
28 <param name='global' doc='Global attributes only' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]29 </params>
30 </command>
31 <command id='write terminal'>
32 <params>
33 <param name='write' doc='Write running configuration to memory, network, or terminal' />
34 <param name='terminal' doc='Write to terminal' />
35 </params>
36 </command>
37 <command id='write file [PATH]'>
38 <params>
39 <param name='write' doc='Write running configuration to memory, network, or terminal' />
40 <param name='file' doc='Write to configuration file' />
41 <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' />
42 </params>
43 </command>
44 <command id='write memory'>
45 <params>
46 <param name='write' doc='Write running configuration to memory, network, or terminal' />
47 <param name='memory' doc='Write configuration to the file (same as write file)' />
48 </params>
49 </command>
50 <command id='write'>
51 <params>
52 <param name='write' doc='Write running configuration to memory, network, or terminal' />
53 </params>
54 </command>
55 <command id='show running-config'>
56 <params>
57 <param name='show' doc='Show running system information' />
58 <param name='running-config' doc='running configuration' />
59 </params>
60 </command>
61 <command id='exit'>
62 <params>
63 <param name='exit' doc='Exit current mode and down to previous mode' />
64 </params>
65 </command>
66 <command id='end'>
67 <params>
68 <param name='end' doc='End current mode and change to enable mode.' />
69 </params>
70 </command>
71 </node>
72 <node id='view'>
73 <name>view</name>
74 <command id='show version'>
75 <params>
76 <param name='show' doc='Show running system information' />
77 <param name='version' doc='Displays program version' />
78 </params>
79 </command>
80 <command id='show online-help'>
81 <params>
82 <param name='show' doc='Show running system information' />
83 <param name='online-help' doc='Online help' />
84 </params>
85 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]86 <command id='enable [expert-mode]'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]87 <params>
88 <param name='enable' doc='Turn on privileged mode command' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]89 <param name='[expert-mode]' doc='Enable the expert mode (show hidden commands)' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]90 </params>
91 </command>
92 <command id='terminal length &lt;0-512&gt;'>
93 <params>
94 <param name='terminal' doc='Set terminal line parameters' />
95 <param name='length' doc='Set number of lines on a screen' />
96 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
97 </params>
98 </command>
99 <command id='terminal no length'>
100 <params>
101 <param name='terminal' doc='Set terminal line parameters' />
102 <param name='no' doc='Negate a command or set its defaults' />
103 <param name='length' doc='Set number of lines on a screen' />
104 </params>
105 </command>
106 <command id='who'>
107 <params>
108 <param name='who' doc='Display who is on vty' />
109 </params>
110 </command>
111 <command id='show history'>
112 <params>
113 <param name='show' doc='Show running system information' />
114 <param name='history' doc='Display the session command history' />
115 </params>
116 </command>
117 <command id='logging enable'>
118 <params>
119 <param name='logging' doc='Configure logging' />
120 <param name='enable' doc='Enables logging to this vty' />
121 </params>
122 </command>
123 <command id='logging disable'>
124 <params>
125 <param name='logging' doc='Configure logging' />
126 <param name='disable' doc='Disables logging to this vty' />
127 </params>
128 </command>
129 <command id='logging filter all (0|1)'>
130 <params>
131 <param name='logging' doc='Configure logging' />
132 <param name='filter' doc='Filter log messages' />
133 <param name='all' doc='Do you want to log all messages?' />
134 <param name='0' doc='Only print messages matched by other filters' />
135 <param name='1' doc='Bypass filter and print all messages' />
136 </params>
137 </command>
138 <command id='logging color (0|1)'>
139 <params>
140 <param name='logging' doc='Configure logging' />
141 <param name='color' doc='Configure color-printing for log messages' />
142 <param name='0' doc='Don&apos;t use color for printing messages' />
143 <param name='1' doc='Use color for printing messages' />
144 </params>
145 </command>
146 <command id='logging timestamp (0|1)'>
147 <params>
148 <param name='logging' doc='Configure logging' />
149 <param name='timestamp' doc='Configure log message timestamping' />
150 <param name='0' doc='Don&apos;t prefix each log message' />
151 <param name='1' doc='Prefix each log message with current timestamp' />
152 </params>
153 </command>
154 <command id='logging print extended-timestamp (0|1)'>
155 <params>
156 <param name='logging' doc='Configure logging' />
157 <param name='print' doc='Log output settings' />
158 <param name='extended-timestamp' doc='Configure log message timestamping' />
159 <param name='0' doc='Don&apos;t prefix each log message' />
160 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
161 </params>
162 </command>
163 <command id='logging print category (0|1)'>
164 <params>
165 <param name='logging' doc='Configure logging' />
166 <param name='print' doc='Log output settings' />
167 <param name='category' doc='Configure log message' />
168 <param name='0' doc='Don&apos;t prefix each log message' />
169 <param name='1' doc='Prefix each log message with category/subsystem name' />
170 </params>
171 </command>
172 <command id='logging print category-hex (0|1)'>
173 <params>
174 <param name='logging' doc='Configure logging' />
175 <param name='print' doc='Log output settings' />
176 <param name='category-hex' doc='Configure log message' />
177 <param name='0' doc='Don&apos;t prefix each log message' />
178 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
179 </params>
180 </command>
181 <command id='logging print level (0|1)'>
182 <params>
183 <param name='logging' doc='Configure logging' />
184 <param name='print' doc='Log output settings' />
185 <param name='level' doc='Configure log message' />
186 <param name='0' doc='Don&apos;t prefix each log message' />
187 <param name='1' doc='Prefix each log message with the log level name' />
188 </params>
189 </command>
190 <command id='logging print file (0|1|basename) [last]'>
191 <params>
192 <param name='logging' doc='Configure logging' />
193 <param name='print' doc='Log output settings' />
194 <param name='file' doc='Configure log message' />
195 <param name='0' doc='Don&apos;t prefix each log message' />
196 <param name='1' doc='Prefix each log message with the source file and line' />
197 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
198 <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.' />
199 </params>
200 </command>
201 <command id='logging set-log-mask MASK'>
202 <params>
203 <param name='logging' doc='Configure logging' />
204 <param name='set-log-mask' doc='Set the logmask of this logging target' />
205 <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' />
206 </params>
207 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]208 <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (debug|info|notice|error|fatal)'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]209 <params>
210 <param name='logging' doc='Configure logging' />
211 <param name='level' doc='Set the log level for a specified category' />
212 <param name='gprs' doc='GPRS Packet Service' />
213 <param name='ns' doc='GPRS Network Service (NS)' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]214 <param name='obj' doc='GbProxy object allocation/release' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]215 <param name='lglobal' doc='Library-internal global log family' />
216 <param name='llapd' doc='LAPD in libosmogsm' />
217 <param name='linp' doc='A-bis Intput Subsystem' />
218 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
219 <param name='lmi' doc='A-bis Input Driver for Signalling' />
220 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
221 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
222 <param name='lctrl' doc='Control Interface' />
223 <param name='lgtp' doc='GPRS GTP library' />
224 <param name='lstats' doc='Statistics messages and logging' />
225 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
226 <param name='loap' doc='Osmocom Authentication Protocol' />
227 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
228 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
229 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
230 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
231 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
232 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
233 <param name='lrspro' doc='Remote SIM protocol' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]234 <param name='lns' doc='GPRS NS layer' />
235 <param name='lbssgp' doc='GPRS BSSGP layer' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]236 <param name='debug' doc='Log debug messages and higher levels' />
237 <param name='info' doc='Log informational messages and higher levels' />
238 <param name='notice' doc='Log noticeable messages and higher levels' />
239 <param name='error' doc='Log error messages and higher levels' />
240 <param name='fatal' doc='Log only fatal messages' />
241 </params>
242 </command>
243 <command id='logging level set-all (debug|info|notice|error|fatal)'>
244 <params>
245 <param name='logging' doc='Configure logging' />
246 <param name='level' doc='Set the log level for a specified category' />
247 <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.' />
248 <param name='debug' doc='Log debug messages and higher levels' />
249 <param name='info' doc='Log informational messages and higher levels' />
250 <param name='notice' doc='Log noticeable messages and higher levels' />
251 <param name='error' doc='Log error messages and higher levels' />
252 <param name='fatal' doc='Log only fatal messages' />
253 </params>
254 </command>
255 <command id='logging level force-all (debug|info|notice|error|fatal)'>
256 <params>
257 <param name='logging' doc='Configure logging' />
258 <param name='level' doc='Set the log level for a specified category' />
259 <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.' />
260 <param name='debug' doc='Log debug messages and higher levels' />
261 <param name='info' doc='Log informational messages and higher levels' />
262 <param name='notice' doc='Log noticeable messages and higher levels' />
263 <param name='error' doc='Log error messages and higher levels' />
264 <param name='fatal' doc='Log only fatal messages' />
265 </params>
266 </command>
267 <command id='no logging level force-all'>
268 <params>
269 <param name='no' doc='Negate a command or set its defaults' />
270 <param name='logging' doc='Configure logging' />
271 <param name='level' doc='Set the log level for a specified category' />
272 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
273 </params>
274 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]275 <command id='logp (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (debug|info|notice|error|fatal) .LOGMESSAGE'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]276 <params>
277 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
278 <param name='gprs' doc='GPRS Packet Service' />
279 <param name='ns' doc='GPRS Network Service (NS)' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]280 <param name='obj' doc='GbProxy object allocation/release' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]281 <param name='lglobal' doc='Library-internal global log family' />
282 <param name='llapd' doc='LAPD in libosmogsm' />
283 <param name='linp' doc='A-bis Intput Subsystem' />
284 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
285 <param name='lmi' doc='A-bis Input Driver for Signalling' />
286 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
287 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
288 <param name='lctrl' doc='Control Interface' />
289 <param name='lgtp' doc='GPRS GTP library' />
290 <param name='lstats' doc='Statistics messages and logging' />
291 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
292 <param name='loap' doc='Osmocom Authentication Protocol' />
293 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
294 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
295 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
296 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
297 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
298 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
299 <param name='lrspro' doc='Remote SIM protocol' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]300 <param name='lns' doc='GPRS NS layer' />
301 <param name='lbssgp' doc='GPRS BSSGP layer' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]302 <param name='debug' doc='Log debug messages and higher levels' />
303 <param name='info' doc='Log informational messages and higher levels' />
304 <param name='notice' doc='Log noticeable messages and higher levels' />
305 <param name='error' doc='Log error messages and higher levels' />
306 <param name='fatal' doc='Log only fatal messages' />
307 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
308 </params>
309 </command>
310 <command id='show logging vty'>
311 <params>
312 <param name='show' doc='Show running system information' />
313 <param name='logging' doc='Show current logging configuration' />
314 <param name='vty' doc='Show current logging configuration for this vty' />
315 </params>
316 </command>
317 <command id='show alarms'>
318 <params>
319 <param name='show' doc='Show running system information' />
320 <param name='alarms' doc='Show current logging configuration' />
321 </params>
322 </command>
323 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
324 <params>
325 <param name='show' doc='Show running system information' />
326 <param name='talloc-context' doc='Show talloc memory hierarchy' />
327 <param name='application' doc='Application&apos;s context' />
328 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
329 <param name='full' doc='Display a full talloc memory hierarchy' />
330 <param name='brief' doc='Display a brief talloc memory hierarchy' />
331 <param name='DEPTH' doc='Specify required maximal depth value' />
332 </params>
333 </command>
334 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
335 <params>
336 <param name='show' doc='Show running system information' />
337 <param name='talloc-context' doc='Show talloc memory hierarchy' />
338 <param name='application' doc='Application&apos;s context' />
339 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
340 <param name='full' doc='Display a full talloc memory hierarchy' />
341 <param name='brief' doc='Display a brief talloc memory hierarchy' />
342 <param name='DEPTH' doc='Specify required maximal depth value' />
343 <param name='tree' doc='Display only a specific memory chunk' />
344 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
345 </params>
346 </command>
347 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
348 <params>
349 <param name='show' doc='Show running system information' />
350 <param name='talloc-context' doc='Show talloc memory hierarchy' />
351 <param name='application' doc='Application&apos;s context' />
352 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
353 <param name='full' doc='Display a full talloc memory hierarchy' />
354 <param name='brief' doc='Display a brief talloc memory hierarchy' />
355 <param name='DEPTH' doc='Specify required maximal depth value' />
356 <param name='filter' doc='Filter chunks using regular expression' />
357 <param name='REGEXP' doc='Regular expression' />
358 </params>
359 </command>
360 <command id='show stats'>
361 <params>
362 <param name='show' doc='Show running system information' />
363 <param name='stats' doc='Show statistical values' />
364 </params>
365 </command>
366 <command id='show stats level (global|peer|subscriber)'>
367 <params>
368 <param name='show' doc='Show running system information' />
369 <param name='stats' doc='Show statistical values' />
370 <param name='level' doc='Set the maximum group level' />
371 <param name='global' doc='Show global groups only' />
372 <param name='peer' doc='Show global and network peer related groups' />
373 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
374 </params>
375 </command>
376 <command id='show asciidoc counters'>
377 <params>
378 <param name='show' doc='Show running system information' />
379 <param name='asciidoc' doc='Asciidoc generation' />
380 <param name='counters' doc='Generate table of all registered counters' />
381 </params>
382 </command>
383 <command id='show rate-counters'>
384 <params>
385 <param name='show' doc='Show running system information' />
386 <param name='rate-counters' doc='Show all rate counters' />
387 </params>
388 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]389 <command id='show fsm NAME'>
390 <params>
391 <param name='show' doc='Show running system information' />
392 <param name='fsm' doc='Show information about finite state machines' />
393 <param name='NAME' doc='Display information about a single named finite state machine' />
394 </params>
395 </command>
396 <command id='show fsm all'>
397 <params>
398 <param name='show' doc='Show running system information' />
399 <param name='fsm' doc='Show information about finite state machines' />
400 <param name='all' doc='Display a list of all registered finite state machines' />
401 </params>
402 </command>
403 <command id='show fsm-instances NAME'>
404 <params>
405 <param name='show' doc='Show running system information' />
406 <param name='fsm-instances' doc='Show information about finite state machine instances' />
407 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
408 </params>
409 </command>
410 <command id='show fsm-instances all'>
411 <params>
412 <param name='show' doc='Show running system information' />
413 <param name='fsm-instances' doc='Show information about finite state machine instances' />
414 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
415 </params>
416 </command>
417 <command id='show gbproxy bvc (bss|sgsn) [stats]'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]418 <params>
419 <param name='show' doc='Show running system information' />
420 <param name='gbproxy' doc='Display information about the Gb proxy' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]421 <param name='bvc' doc='Show BSSGP Virtual Connections' />
422 <param name='bss' doc='Display BSS-side BVCs' />
423 <param name='sgsn' doc='Display SGSN-side BVCs' />
424 <param name='[stats]' doc='Show statistics' />
425 </params>
426 </command>
427 <command id='show gbproxy cell [stats]'>
428 <params>
429 <param name='show' doc='Show running system information' />
430 <param name='gbproxy' doc='Display information about the Gb proxy' />
431 <param name='cell' doc='Show GPRS Cell Information' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]432 <param name='[stats]' doc='Show statistics' />
433 </params>
434 </command>
435 <command id='show gbproxy links'>
436 <params>
437 <param name='show' doc='Show running system information' />
438 <param name='gbproxy' doc='Display information about the Gb proxy' />
439 <param name='links' doc='Show logical links' />
440 </params>
441 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]442 <command id='show gbproxy tlli-cache'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]443 <params>
444 <param name='show' doc='Show running system information' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]445 <param name='gbproxy' doc='Display information about the Gb proxy' />
446 <param name='tlli-cache' doc='Show TLLI cache entries' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]447 </params>
448 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]449 <command id='show gbproxy imsi-cache'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]450 <params>
451 <param name='show' doc='Show running system information' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]452 <param name='gbproxy' doc='Display information about the Gb proxy' />
453 <param name='imsi-cache' doc='Show IMSI cache entries' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]454 </params>
455 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]456 <command id='show nri all'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]457 <params>
458 <param name='show' doc='Show running system information' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]459 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
460 <param name='all' doc='Show all SGSNs' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]461 </params>
462 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]463 <command id='show nri nsei &lt;0-65535&gt;'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]464 <params>
465 <param name='show' doc='Show running system information' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]466 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
467 <param name='nsei' doc='Identify SGSN by NSEI' />
468 <param name='&lt;0-65535&gt;' doc='NSEI of the SGSN' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]469 </params>
470 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]471 <command id='logging filter bvc bvci &lt;0-65535&gt;'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]472 <params>
473 <param name='logging' doc='Configure logging' />
474 <param name='filter' doc='Filter log messages' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]475 <param name='bvc' doc='Filter based on BSSGP VC' />
476 <param name='bvci' doc='Identify BVC by BVCI' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]477 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
478 </params>
479 </command>
480 </node>
481 <node id='enable'>
482 <name>enable</name>
483 <command id='disable'>
484 <params>
485 <param name='disable' doc='Turn off privileged mode command' />
486 </params>
487 </command>
488 <command id='configure terminal'>
489 <params>
490 <param name='configure' doc='Configuration from vty interface' />
491 <param name='terminal' doc='Configuration terminal' />
492 </params>
493 </command>
494 <command id='copy running-config startup-config'>
495 <params>
496 <param name='copy' doc='Copy configuration' />
497 <param name='running-config' doc='Copy running config to... ' />
498 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
499 </params>
500 </command>
501 <command id='show startup-config'>
502 <params>
503 <param name='show' doc='Show running system information' />
504 <param name='startup-config' doc='Contentes of startup configuration' />
505 </params>
506 </command>
507 <command id='show version'>
508 <params>
509 <param name='show' doc='Show running system information' />
510 <param name='version' doc='Displays program version' />
511 </params>
512 </command>
513 <command id='show online-help'>
514 <params>
515 <param name='show' doc='Show running system information' />
516 <param name='online-help' doc='Online help' />
517 </params>
518 </command>
519 <command id='terminal length &lt;0-512&gt;'>
520 <params>
521 <param name='terminal' doc='Set terminal line parameters' />
522 <param name='length' doc='Set number of lines on a screen' />
523 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
524 </params>
525 </command>
526 <command id='terminal no length'>
527 <params>
528 <param name='terminal' doc='Set terminal line parameters' />
529 <param name='no' doc='Negate a command or set its defaults' />
530 <param name='length' doc='Set number of lines on a screen' />
531 </params>
532 </command>
533 <command id='who'>
534 <params>
535 <param name='who' doc='Display who is on vty' />
536 </params>
537 </command>
538 <command id='show history'>
539 <params>
540 <param name='show' doc='Show running system information' />
541 <param name='history' doc='Display the session command history' />
542 </params>
543 </command>
544 <command id='terminal monitor'>
545 <params>
546 <param name='terminal' doc='Set terminal line parameters' />
547 <param name='monitor' doc='Copy debug output to the current terminal line' />
548 </params>
549 </command>
550 <command id='terminal no monitor'>
551 <params>
552 <param name='terminal' doc='Set terminal line parameters' />
553 <param name='no' doc='Negate a command or set its defaults' />
554 <param name='monitor' doc='Copy debug output to the current terminal line' />
555 </params>
556 </command>
557 <command id='logging enable'>
558 <params>
559 <param name='logging' doc='Configure logging' />
560 <param name='enable' doc='Enables logging to this vty' />
561 </params>
562 </command>
563 <command id='logging disable'>
564 <params>
565 <param name='logging' doc='Configure logging' />
566 <param name='disable' doc='Disables logging to this vty' />
567 </params>
568 </command>
569 <command id='logging filter all (0|1)'>
570 <params>
571 <param name='logging' doc='Configure logging' />
572 <param name='filter' doc='Filter log messages' />
573 <param name='all' doc='Do you want to log all messages?' />
574 <param name='0' doc='Only print messages matched by other filters' />
575 <param name='1' doc='Bypass filter and print all messages' />
576 </params>
577 </command>
578 <command id='logging color (0|1)'>
579 <params>
580 <param name='logging' doc='Configure logging' />
581 <param name='color' doc='Configure color-printing for log messages' />
582 <param name='0' doc='Don&apos;t use color for printing messages' />
583 <param name='1' doc='Use color for printing messages' />
584 </params>
585 </command>
586 <command id='logging timestamp (0|1)'>
587 <params>
588 <param name='logging' doc='Configure logging' />
589 <param name='timestamp' doc='Configure log message timestamping' />
590 <param name='0' doc='Don&apos;t prefix each log message' />
591 <param name='1' doc='Prefix each log message with current timestamp' />
592 </params>
593 </command>
594 <command id='logging print extended-timestamp (0|1)'>
595 <params>
596 <param name='logging' doc='Configure logging' />
597 <param name='print' doc='Log output settings' />
598 <param name='extended-timestamp' doc='Configure log message timestamping' />
599 <param name='0' doc='Don&apos;t prefix each log message' />
600 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
601 </params>
602 </command>
603 <command id='logging print category (0|1)'>
604 <params>
605 <param name='logging' doc='Configure logging' />
606 <param name='print' doc='Log output settings' />
607 <param name='category' doc='Configure log message' />
608 <param name='0' doc='Don&apos;t prefix each log message' />
609 <param name='1' doc='Prefix each log message with category/subsystem name' />
610 </params>
611 </command>
612 <command id='logging print category-hex (0|1)'>
613 <params>
614 <param name='logging' doc='Configure logging' />
615 <param name='print' doc='Log output settings' />
616 <param name='category-hex' doc='Configure log message' />
617 <param name='0' doc='Don&apos;t prefix each log message' />
618 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
619 </params>
620 </command>
621 <command id='logging print level (0|1)'>
622 <params>
623 <param name='logging' doc='Configure logging' />
624 <param name='print' doc='Log output settings' />
625 <param name='level' doc='Configure log message' />
626 <param name='0' doc='Don&apos;t prefix each log message' />
627 <param name='1' doc='Prefix each log message with the log level name' />
628 </params>
629 </command>
630 <command id='logging print file (0|1|basename) [last]'>
631 <params>
632 <param name='logging' doc='Configure logging' />
633 <param name='print' doc='Log output settings' />
634 <param name='file' doc='Configure log message' />
635 <param name='0' doc='Don&apos;t prefix each log message' />
636 <param name='1' doc='Prefix each log message with the source file and line' />
637 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
638 <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.' />
639 </params>
640 </command>
641 <command id='logging set-log-mask MASK'>
642 <params>
643 <param name='logging' doc='Configure logging' />
644 <param name='set-log-mask' doc='Set the logmask of this logging target' />
645 <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' />
646 </params>
647 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]648 <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (debug|info|notice|error|fatal)'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]649 <params>
650 <param name='logging' doc='Configure logging' />
651 <param name='level' doc='Set the log level for a specified category' />
652 <param name='gprs' doc='GPRS Packet Service' />
653 <param name='ns' doc='GPRS Network Service (NS)' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]654 <param name='obj' doc='GbProxy object allocation/release' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]655 <param name='lglobal' doc='Library-internal global log family' />
656 <param name='llapd' doc='LAPD in libosmogsm' />
657 <param name='linp' doc='A-bis Intput Subsystem' />
658 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
659 <param name='lmi' doc='A-bis Input Driver for Signalling' />
660 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
661 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
662 <param name='lctrl' doc='Control Interface' />
663 <param name='lgtp' doc='GPRS GTP library' />
664 <param name='lstats' doc='Statistics messages and logging' />
665 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
666 <param name='loap' doc='Osmocom Authentication Protocol' />
667 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
668 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
669 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
670 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
671 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
672 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
673 <param name='lrspro' doc='Remote SIM protocol' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]674 <param name='lns' doc='GPRS NS layer' />
675 <param name='lbssgp' doc='GPRS BSSGP layer' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]676 <param name='debug' doc='Log debug messages and higher levels' />
677 <param name='info' doc='Log informational messages and higher levels' />
678 <param name='notice' doc='Log noticeable messages and higher levels' />
679 <param name='error' doc='Log error messages and higher levels' />
680 <param name='fatal' doc='Log only fatal messages' />
681 </params>
682 </command>
683 <command id='logging level set-all (debug|info|notice|error|fatal)'>
684 <params>
685 <param name='logging' doc='Configure logging' />
686 <param name='level' doc='Set the log level for a specified category' />
687 <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.' />
688 <param name='debug' doc='Log debug messages and higher levels' />
689 <param name='info' doc='Log informational messages and higher levels' />
690 <param name='notice' doc='Log noticeable messages and higher levels' />
691 <param name='error' doc='Log error messages and higher levels' />
692 <param name='fatal' doc='Log only fatal messages' />
693 </params>
694 </command>
695 <command id='logging level force-all (debug|info|notice|error|fatal)'>
696 <params>
697 <param name='logging' doc='Configure logging' />
698 <param name='level' doc='Set the log level for a specified category' />
699 <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.' />
700 <param name='debug' doc='Log debug messages and higher levels' />
701 <param name='info' doc='Log informational messages and higher levels' />
702 <param name='notice' doc='Log noticeable messages and higher levels' />
703 <param name='error' doc='Log error messages and higher levels' />
704 <param name='fatal' doc='Log only fatal messages' />
705 </params>
706 </command>
707 <command id='no logging level force-all'>
708 <params>
709 <param name='no' doc='Negate a command or set its defaults' />
710 <param name='logging' doc='Configure logging' />
711 <param name='level' doc='Set the log level for a specified category' />
712 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
713 </params>
714 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]715 <command id='logp (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (debug|info|notice|error|fatal) .LOGMESSAGE'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]716 <params>
717 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
718 <param name='gprs' doc='GPRS Packet Service' />
719 <param name='ns' doc='GPRS Network Service (NS)' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]720 <param name='obj' doc='GbProxy object allocation/release' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]721 <param name='lglobal' doc='Library-internal global log family' />
722 <param name='llapd' doc='LAPD in libosmogsm' />
723 <param name='linp' doc='A-bis Intput Subsystem' />
724 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
725 <param name='lmi' doc='A-bis Input Driver for Signalling' />
726 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
727 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
728 <param name='lctrl' doc='Control Interface' />
729 <param name='lgtp' doc='GPRS GTP library' />
730 <param name='lstats' doc='Statistics messages and logging' />
731 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
732 <param name='loap' doc='Osmocom Authentication Protocol' />
733 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
734 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
735 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
736 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
737 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
738 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
739 <param name='lrspro' doc='Remote SIM protocol' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]740 <param name='lns' doc='GPRS NS layer' />
741 <param name='lbssgp' doc='GPRS BSSGP layer' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]742 <param name='debug' doc='Log debug messages and higher levels' />
743 <param name='info' doc='Log informational messages and higher levels' />
744 <param name='notice' doc='Log noticeable messages and higher levels' />
745 <param name='error' doc='Log error messages and higher levels' />
746 <param name='fatal' doc='Log only fatal messages' />
747 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
748 </params>
749 </command>
750 <command id='show logging vty'>
751 <params>
752 <param name='show' doc='Show running system information' />
753 <param name='logging' doc='Show current logging configuration' />
754 <param name='vty' doc='Show current logging configuration for this vty' />
755 </params>
756 </command>
757 <command id='show alarms'>
758 <params>
759 <param name='show' doc='Show running system information' />
760 <param name='alarms' doc='Show current logging configuration' />
761 </params>
762 </command>
763 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
764 <params>
765 <param name='show' doc='Show running system information' />
766 <param name='talloc-context' doc='Show talloc memory hierarchy' />
767 <param name='application' doc='Application&apos;s context' />
768 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
769 <param name='full' doc='Display a full talloc memory hierarchy' />
770 <param name='brief' doc='Display a brief talloc memory hierarchy' />
771 <param name='DEPTH' doc='Specify required maximal depth value' />
772 </params>
773 </command>
774 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
775 <params>
776 <param name='show' doc='Show running system information' />
777 <param name='talloc-context' doc='Show talloc memory hierarchy' />
778 <param name='application' doc='Application&apos;s context' />
779 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
780 <param name='full' doc='Display a full talloc memory hierarchy' />
781 <param name='brief' doc='Display a brief talloc memory hierarchy' />
782 <param name='DEPTH' doc='Specify required maximal depth value' />
783 <param name='tree' doc='Display only a specific memory chunk' />
784 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
785 </params>
786 </command>
787 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
788 <params>
789 <param name='show' doc='Show running system information' />
790 <param name='talloc-context' doc='Show talloc memory hierarchy' />
791 <param name='application' doc='Application&apos;s context' />
792 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
793 <param name='full' doc='Display a full talloc memory hierarchy' />
794 <param name='brief' doc='Display a brief talloc memory hierarchy' />
795 <param name='DEPTH' doc='Specify required maximal depth value' />
796 <param name='filter' doc='Filter chunks using regular expression' />
797 <param name='REGEXP' doc='Regular expression' />
798 </params>
799 </command>
800 <command id='show stats'>
801 <params>
802 <param name='show' doc='Show running system information' />
803 <param name='stats' doc='Show statistical values' />
804 </params>
805 </command>
806 <command id='show stats level (global|peer|subscriber)'>
807 <params>
808 <param name='show' doc='Show running system information' />
809 <param name='stats' doc='Show statistical values' />
810 <param name='level' doc='Set the maximum group level' />
811 <param name='global' doc='Show global groups only' />
812 <param name='peer' doc='Show global and network peer related groups' />
813 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
814 </params>
815 </command>
816 <command id='show asciidoc counters'>
817 <params>
818 <param name='show' doc='Show running system information' />
819 <param name='asciidoc' doc='Asciidoc generation' />
820 <param name='counters' doc='Generate table of all registered counters' />
821 </params>
822 </command>
823 <command id='show rate-counters'>
824 <params>
825 <param name='show' doc='Show running system information' />
826 <param name='rate-counters' doc='Show all rate counters' />
827 </params>
828 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]829 <command id='stats report'>
830 <params>
831 <param name='stats' doc='Stats related commands' />
832 <param name='report' doc='Manurally trigger reporting of stats' />
833 </params>
834 </command>
835 <command id='stats reset'>
836 <params>
837 <param name='stats' doc='Stats related commands' />
838 <param name='reset' doc='Reset all stats' />
839 </params>
840 </command>
841 <command id='show fsm NAME'>
842 <params>
843 <param name='show' doc='Show running system information' />
844 <param name='fsm' doc='Show information about finite state machines' />
845 <param name='NAME' doc='Display information about a single named finite state machine' />
846 </params>
847 </command>
848 <command id='show fsm all'>
849 <params>
850 <param name='show' doc='Show running system information' />
851 <param name='fsm' doc='Show information about finite state machines' />
852 <param name='all' doc='Display a list of all registered finite state machines' />
853 </params>
854 </command>
855 <command id='show fsm-instances NAME'>
856 <params>
857 <param name='show' doc='Show running system information' />
858 <param name='fsm-instances' doc='Show information about finite state machine instances' />
859 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
860 </params>
861 </command>
862 <command id='show fsm-instances all'>
863 <params>
864 <param name='show' doc='Show running system information' />
865 <param name='fsm-instances' doc='Show information about finite state machine instances' />
866 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
867 </params>
868 </command>
869 <command id='show gbproxy bvc (bss|sgsn) [stats]'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]870 <params>
871 <param name='show' doc='Show running system information' />
872 <param name='gbproxy' doc='Display information about the Gb proxy' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]873 <param name='bvc' doc='Show BSSGP Virtual Connections' />
874 <param name='bss' doc='Display BSS-side BVCs' />
875 <param name='sgsn' doc='Display SGSN-side BVCs' />
876 <param name='[stats]' doc='Show statistics' />
877 </params>
878 </command>
879 <command id='show gbproxy cell [stats]'>
880 <params>
881 <param name='show' doc='Show running system information' />
882 <param name='gbproxy' doc='Display information about the Gb proxy' />
883 <param name='cell' doc='Show GPRS Cell Information' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]884 <param name='[stats]' doc='Show statistics' />
885 </params>
886 </command>
887 <command id='show gbproxy links'>
888 <params>
889 <param name='show' doc='Show running system information' />
890 <param name='gbproxy' doc='Display information about the Gb proxy' />
891 <param name='links' doc='Show logical links' />
892 </params>
893 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]894 <command id='show gbproxy tlli-cache'>
895 <params>
896 <param name='show' doc='Show running system information' />
897 <param name='gbproxy' doc='Display information about the Gb proxy' />
898 <param name='tlli-cache' doc='Show TLLI cache entries' />
899 </params>
900 </command>
901 <command id='show gbproxy imsi-cache'>
902 <params>
903 <param name='show' doc='Show running system information' />
904 <param name='gbproxy' doc='Display information about the Gb proxy' />
905 <param name='imsi-cache' doc='Show IMSI cache entries' />
906 </params>
907 </command>
908 <command id='show nri all'>
909 <params>
910 <param name='show' doc='Show running system information' />
911 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
912 <param name='all' doc='Show all SGSNs' />
913 </params>
914 </command>
915 <command id='show nri nsei &lt;0-65535&gt;'>
916 <params>
917 <param name='show' doc='Show running system information' />
918 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
919 <param name='nsei' doc='Identify SGSN by NSEI' />
920 <param name='&lt;0-65535&gt;' doc='NSEI of the SGSN' />
921 </params>
922 </command>
923 <command id='logging filter bvc bvci &lt;0-65535&gt;'>
924 <params>
925 <param name='logging' doc='Configure logging' />
926 <param name='filter' doc='Filter log messages' />
927 <param name='bvc' doc='Filter based on BSSGP VC' />
928 <param name='bvci' doc='Identify BVC by BVCI' />
929 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
930 </params>
931 </command>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]932 <command id='delete-gbproxy-peer &lt;0-65534&gt; bvci &lt;2-65534&gt;'>
933 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]934 <param name='delete-gbproxy-peer' doc='Delete a GBProxy bvc by NSEI and optionally BVCI' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]935 <param name='&lt;0-65534&gt;' doc='NSEI number' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]936 <param name='bvci' doc='Only delete bvc with a matching BVCI' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]937 <param name='&lt;2-65534&gt;' doc='BVCI number' />
938 </params>
939 </command>
940 <command id='delete-gbproxy-peer &lt;0-65534&gt; (only-bvc|only-nsvc|all) [dry-run]'>
941 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]942 <param name='delete-gbproxy-peer' doc='Delete a GBProxy bvc by NSEI and optionally BVCI' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]943 <param name='&lt;0-65534&gt;' doc='NSEI number' />
944 <param name='only-bvc' doc='Only delete BSSGP connections (BVC)' />
945 <param name='only-nsvc' doc='Only delete dynamic NS connections (NS-VC)' />
946 <param name='all' doc='Delete BVC and dynamic NS connections' />
947 <param name='[dry-run]' doc='Show what would be deleted instead of actually deleting' />
948 </params>
949 </command>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]950 </node>
951 <node id='config'>
952 <name>config</name>
953 <command id='hostname WORD'>
954 <params>
955 <param name='hostname' doc='Set system&apos;s network name' />
956 <param name='WORD' doc='This system&apos;s network name' />
957 </params>
958 </command>
959 <command id='no hostname [HOSTNAME]'>
960 <params>
961 <param name='no' doc='Negate a command or set its defaults' />
962 <param name='hostname' doc='Reset system&apos;s network name' />
963 <param name='[HOSTNAME]' doc='Host name of this router' />
964 </params>
965 </command>
966 <command id='password (8|) WORD'>
967 <params>
968 <param name='password' doc='Assign the terminal connection password' />
969 <param name='8' doc='Specifies a HIDDEN password will follow' />
970 <param name='' doc='dummy string ' />
971 <param name='WORD' doc='The HIDDEN line password string' />
972 </params>
973 </command>
974 <command id='password LINE'>
975 <params>
976 <param name='password' doc='Assign the terminal connection password' />
977 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
978 </params>
979 </command>
980 <command id='enable password (8|) WORD'>
981 <params>
982 <param name='enable' doc='Modify enable password parameters' />
983 <param name='password' doc='Assign the privileged level password' />
984 <param name='8' doc='Specifies a HIDDEN password will follow' />
985 <param name='' doc='dummy string ' />
986 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
987 </params>
988 </command>
989 <command id='enable password LINE'>
990 <params>
991 <param name='enable' doc='Modify enable password parameters' />
992 <param name='password' doc='Assign the privileged level password' />
993 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
994 </params>
995 </command>
996 <command id='no enable password'>
997 <params>
998 <param name='no' doc='Negate a command or set its defaults' />
999 <param name='enable' doc='Modify enable password parameters' />
1000 <param name='password' doc='Assign the privileged level password' />
1001 </params>
1002 </command>
1003 <command id='banner motd default'>
1004 <params>
1005 <param name='banner' doc='Set banner string' />
1006 <param name='motd' doc='Strings for motd' />
1007 <param name='default' doc='Default string' />
1008 </params>
1009 </command>
1010 <command id='banner motd file [FILE]'>
1011 <params>
1012 <param name='banner' doc='Set banner' />
1013 <param name='motd' doc='Banner for motd' />
1014 <param name='file' doc='Banner from a file' />
1015 <param name='[FILE]' doc='Filename' />
1016 </params>
1017 </command>
1018 <command id='no banner motd'>
1019 <params>
1020 <param name='no' doc='Negate a command or set its defaults' />
1021 <param name='banner' doc='Set banner string' />
1022 <param name='motd' doc='Strings for motd' />
1023 </params>
1024 </command>
1025 <command id='service terminal-length &lt;0-512&gt;'>
1026 <params>
1027 <param name='service' doc='Set up miscellaneous service' />
1028 <param name='terminal-length' doc='System wide terminal length configuration' />
1029 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
1030 </params>
1031 </command>
1032 <command id='no service terminal-length [&lt;0-512&gt;]'>
1033 <params>
1034 <param name='no' doc='Negate a command or set its defaults' />
1035 <param name='service' doc='Set up miscellaneous service' />
1036 <param name='terminal-length' doc='System wide terminal length configuration' />
1037 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
1038 </params>
1039 </command>
1040 <command id='line vty'>
1041 <params>
1042 <param name='line' doc='Configure a terminal line' />
1043 <param name='vty' doc='Virtual terminal' />
1044 </params>
1045 </command>
1046 <command id='service advanced-vty'>
1047 <params>
1048 <param name='service' doc='Set up miscellaneous service' />
1049 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1050 </params>
1051 </command>
1052 <command id='no service advanced-vty'>
1053 <params>
1054 <param name='no' doc='Negate a command or set its defaults' />
1055 <param name='service' doc='Set up miscellaneous service' />
1056 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1057 </params>
1058 </command>
1059 <command id='show history'>
1060 <params>
1061 <param name='show' doc='Show running system information' />
1062 <param name='history' doc='Display the session command history' />
1063 </params>
1064 </command>
1065 <command id='log stderr'>
1066 <params>
1067 <param name='log' doc='Configure logging sub-system' />
1068 <param name='stderr' doc='Logging via STDERR of the process' />
1069 </params>
1070 </command>
1071 <command id='no log stderr'>
1072 <params>
1073 <param name='no' doc='Negate a command or set its defaults' />
1074 <param name='log' doc='Configure logging sub-system' />
1075 <param name='stderr' doc='Logging via STDERR of the process' />
1076 </params>
1077 </command>
1078 <command id='log file .FILENAME'>
1079 <params>
1080 <param name='log' doc='Configure logging sub-system' />
1081 <param name='file' doc='Logging to text file' />
1082 <param name='.FILENAME' doc='Filename' />
1083 </params>
1084 </command>
1085 <command id='no log file .FILENAME'>
1086 <params>
1087 <param name='no' doc='Negate a command or set its defaults' />
1088 <param name='log' doc='Configure logging sub-system' />
1089 <param name='file' doc='Logging to text file' />
1090 <param name='.FILENAME' doc='Filename' />
1091 </params>
1092 </command>
1093 <command id='log alarms &lt;2-32700&gt;'>
1094 <params>
1095 <param name='log' doc='Configure logging sub-system' />
1096 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1097 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1098 </params>
1099 </command>
1100 <command id='no log alarms'>
1101 <params>
1102 <param name='no' doc='Negate a command or set its defaults' />
1103 <param name='log' doc='Configure logging sub-system' />
1104 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1105 </params>
1106 </command>
1107 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1108 <params>
1109 <param name='log' doc='Configure logging sub-system' />
1110 <param name='syslog' doc='Logging via syslog' />
1111 <param name='authpriv' doc='Security/authorization messages facility' />
1112 <param name='cron' doc='Clock daemon (cron/at) facility' />
1113 <param name='daemon' doc='General system daemon facility' />
1114 <param name='ftp' doc='Ftp daemon facility' />
1115 <param name='lpr' doc='Line printer facility' />
1116 <param name='mail' doc='Mail facility' />
1117 <param name='news' doc='News facility' />
1118 <param name='user' doc='Generic facility' />
1119 <param name='uucp' doc='UUCP facility' />
1120 </params>
1121 </command>
1122 <command id='log syslog local &lt;0-7&gt;'>
1123 <params>
1124 <param name='log' doc='Configure logging sub-system' />
1125 <param name='syslog' doc='Logging via syslog' />
1126 <param name='local' doc='Syslog LOCAL facility' />
1127 <param name='&lt;0-7&gt;' doc='Local facility number' />
1128 </params>
1129 </command>
1130 <command id='no log syslog'>
1131 <params>
1132 <param name='no' doc='Negate a command or set its defaults' />
1133 <param name='log' doc='Configure logging sub-system' />
1134 <param name='syslog' doc='Logging via syslog' />
1135 </params>
1136 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1137 <command id='log systemd-journal [raw]'>
1138 <params>
1139 <param name='log' doc='Configure logging sub-system' />
1140 <param name='systemd-journal' doc='Logging to systemd-journal' />
1141 <param name='[raw]' doc='Offload rendering of the meta information (location, category) to systemd' />
1142 </params>
1143 </command>
1144 <command id='no log systemd-journal'>
1145 <params>
1146 <param name='no' doc='Negate a command or set its defaults' />
1147 <param name='log' doc='Configure logging sub-system' />
1148 <param name='systemd-journal' doc='Logging to systemd-journal' />
1149 </params>
1150 </command>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1151 <command id='log gsmtap [HOSTNAME]'>
1152 <params>
1153 <param name='log' doc='Configure logging sub-system' />
1154 <param name='gsmtap' doc='Logging via GSMTAP' />
1155 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1156 </params>
1157 </command>
1158 <command id='stats reporter statsd'>
1159 <params>
1160 <param name='stats' doc='Configure stats sub-system' />
1161 <param name='reporter' doc='Configure a stats reporter' />
1162 <param name='statsd' doc='Report to a STATSD server' />
1163 </params>
1164 </command>
1165 <command id='no stats reporter statsd'>
1166 <params>
1167 <param name='no' doc='Negate a command or set its defaults' />
1168 <param name='stats' doc='Configure stats sub-system' />
1169 <param name='reporter' doc='Configure a stats reporter' />
1170 <param name='statsd' doc='Report to a STATSD server' />
1171 </params>
1172 </command>
1173 <command id='stats reporter log'>
1174 <params>
1175 <param name='stats' doc='Configure stats sub-system' />
1176 <param name='reporter' doc='Configure a stats reporter' />
1177 <param name='log' doc='Report to the logger' />
1178 </params>
1179 </command>
1180 <command id='no stats reporter log'>
1181 <params>
1182 <param name='no' doc='Negate a command or set its defaults' />
1183 <param name='stats' doc='Configure stats sub-system' />
1184 <param name='reporter' doc='Configure a stats reporter' />
1185 <param name='log' doc='Report to the logger' />
1186 </params>
1187 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1188 <command id='stats interval &lt;0-65535&gt;'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1189 <params>
1190 <param name='stats' doc='Configure stats sub-system' />
1191 <param name='interval' doc='Set the reporting interval' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1192 <param name='&lt;0-65535&gt;' doc='Interval in seconds (0 disables the reporting interval)' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1193 </params>
1194 </command>
1195 <command id='gbproxy'>
1196 <params>
1197 <param name='gbproxy' doc='Configure the Gb proxy' />
1198 </params>
1199 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1200 <command id='sgsn nsei &lt;0-65534&gt;'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1201 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1202 <param name='sgsn' doc='Configure the SGSN' />
1203 <param name='nsei' doc='NSEI to be used in the connection with the SGSN' />
1204 <param name='&lt;0-65534&gt;' doc='The NSEI' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1205 </params>
1206 </command>
1207 </node>
1208 <node id='config-log'>
1209 <name>config-log</name>
1210 <command id='logging filter all (0|1)'>
1211 <params>
1212 <param name='logging' doc='Configure logging' />
1213 <param name='filter' doc='Filter log messages' />
1214 <param name='all' doc='Do you want to log all messages?' />
1215 <param name='0' doc='Only print messages matched by other filters' />
1216 <param name='1' doc='Bypass filter and print all messages' />
1217 </params>
1218 </command>
1219 <command id='logging color (0|1)'>
1220 <params>
1221 <param name='logging' doc='Configure logging' />
1222 <param name='color' doc='Configure color-printing for log messages' />
1223 <param name='0' doc='Don&apos;t use color for printing messages' />
1224 <param name='1' doc='Use color for printing messages' />
1225 </params>
1226 </command>
1227 <command id='logging timestamp (0|1)'>
1228 <params>
1229 <param name='logging' doc='Configure logging' />
1230 <param name='timestamp' doc='Configure log message timestamping' />
1231 <param name='0' doc='Don&apos;t prefix each log message' />
1232 <param name='1' doc='Prefix each log message with current timestamp' />
1233 </params>
1234 </command>
1235 <command id='logging print extended-timestamp (0|1)'>
1236 <params>
1237 <param name='logging' doc='Configure logging' />
1238 <param name='print' doc='Log output settings' />
1239 <param name='extended-timestamp' doc='Configure log message timestamping' />
1240 <param name='0' doc='Don&apos;t prefix each log message' />
1241 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1242 </params>
1243 </command>
1244 <command id='logging print category (0|1)'>
1245 <params>
1246 <param name='logging' doc='Configure logging' />
1247 <param name='print' doc='Log output settings' />
1248 <param name='category' doc='Configure log message' />
1249 <param name='0' doc='Don&apos;t prefix each log message' />
1250 <param name='1' doc='Prefix each log message with category/subsystem name' />
1251 </params>
1252 </command>
1253 <command id='logging print category-hex (0|1)'>
1254 <params>
1255 <param name='logging' doc='Configure logging' />
1256 <param name='print' doc='Log output settings' />
1257 <param name='category-hex' doc='Configure log message' />
1258 <param name='0' doc='Don&apos;t prefix each log message' />
1259 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1260 </params>
1261 </command>
1262 <command id='logging print level (0|1)'>
1263 <params>
1264 <param name='logging' doc='Configure logging' />
1265 <param name='print' doc='Log output settings' />
1266 <param name='level' doc='Configure log message' />
1267 <param name='0' doc='Don&apos;t prefix each log message' />
1268 <param name='1' doc='Prefix each log message with the log level name' />
1269 </params>
1270 </command>
1271 <command id='logging print file (0|1|basename) [last]'>
1272 <params>
1273 <param name='logging' doc='Configure logging' />
1274 <param name='print' doc='Log output settings' />
1275 <param name='file' doc='Configure log message' />
1276 <param name='0' doc='Don&apos;t prefix each log message' />
1277 <param name='1' doc='Prefix each log message with the source file and line' />
1278 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
1279 <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.' />
1280 </params>
1281 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1282 <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (debug|info|notice|error|fatal)'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1283 <params>
1284 <param name='logging' doc='Configure logging' />
1285 <param name='level' doc='Set the log level for a specified category' />
1286 <param name='gprs' doc='GPRS Packet Service' />
1287 <param name='ns' doc='GPRS Network Service (NS)' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1288 <param name='obj' doc='GbProxy object allocation/release' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1289 <param name='lglobal' doc='Library-internal global log family' />
1290 <param name='llapd' doc='LAPD in libosmogsm' />
1291 <param name='linp' doc='A-bis Intput Subsystem' />
1292 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1293 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1294 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1295 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1296 <param name='lctrl' doc='Control Interface' />
1297 <param name='lgtp' doc='GPRS GTP library' />
1298 <param name='lstats' doc='Statistics messages and logging' />
1299 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1300 <param name='loap' doc='Osmocom Authentication Protocol' />
1301 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1302 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1303 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1304 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1305 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1306 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
1307 <param name='lrspro' doc='Remote SIM protocol' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1308 <param name='lns' doc='GPRS NS layer' />
1309 <param name='lbssgp' doc='GPRS BSSGP layer' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1310 <param name='debug' doc='Log debug messages and higher levels' />
1311 <param name='info' doc='Log informational messages and higher levels' />
1312 <param name='notice' doc='Log noticeable messages and higher levels' />
1313 <param name='error' doc='Log error messages and higher levels' />
1314 <param name='fatal' doc='Log only fatal messages' />
1315 </params>
1316 </command>
1317 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1318 <params>
1319 <param name='logging' doc='Configure logging' />
1320 <param name='level' doc='Set the log level for a specified category' />
1321 <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.' />
1322 <param name='debug' doc='Log debug messages and higher levels' />
1323 <param name='info' doc='Log informational messages and higher levels' />
1324 <param name='notice' doc='Log noticeable messages and higher levels' />
1325 <param name='error' doc='Log error messages and higher levels' />
1326 <param name='fatal' doc='Log only fatal messages' />
1327 </params>
1328 </command>
1329 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1330 <params>
1331 <param name='logging' doc='Configure logging' />
1332 <param name='level' doc='Set the log level for a specified category' />
1333 <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.' />
1334 <param name='debug' doc='Log debug messages and higher levels' />
1335 <param name='info' doc='Log informational messages and higher levels' />
1336 <param name='notice' doc='Log noticeable messages and higher levels' />
1337 <param name='error' doc='Log error messages and higher levels' />
1338 <param name='fatal' doc='Log only fatal messages' />
1339 </params>
1340 </command>
1341 <command id='no logging level force-all'>
1342 <params>
1343 <param name='no' doc='Negate a command or set its defaults' />
1344 <param name='logging' doc='Configure logging' />
1345 <param name='level' doc='Set the log level for a specified category' />
1346 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1347 </params>
1348 </command>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1349 </node>
1350 <node id='config-stats'>
1351 <name>config-stats</name>
1352 <command id='local-ip ADDR'>
1353 <params>
1354 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1355 <param name='ADDR' doc='IP Address' />
1356 </params>
1357 </command>
1358 <command id='no local-ip'>
1359 <params>
1360 <param name='no' doc='Negate a command or set its defaults' />
1361 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1362 </params>
1363 </command>
1364 <command id='remote-ip ADDR'>
1365 <params>
1366 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1367 <param name='ADDR' doc='IP Address' />
1368 </params>
1369 </command>
1370 <command id='remote-port &lt;1-65535&gt;'>
1371 <params>
1372 <param name='remote-port' doc='Set the remote port to which we connect' />
1373 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1374 </params>
1375 </command>
1376 <command id='mtu &lt;100-65535&gt;'>
1377 <params>
1378 <param name='mtu' doc='Set the maximum packet size' />
1379 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1380 </params>
1381 </command>
1382 <command id='no mtu'>
1383 <params>
1384 <param name='no' doc='Negate a command or set its defaults' />
1385 <param name='mtu' doc='Set the maximum packet size' />
1386 </params>
1387 </command>
1388 <command id='prefix PREFIX'>
1389 <params>
1390 <param name='prefix' doc='Set the item name prefix' />
1391 <param name='PREFIX' doc='The prefix string' />
1392 </params>
1393 </command>
1394 <command id='no prefix'>
1395 <params>
1396 <param name='no' doc='Negate a command or set its defaults' />
1397 <param name='prefix' doc='Set the item name prefix' />
1398 </params>
1399 </command>
1400 <command id='level (global|peer|subscriber)'>
1401 <params>
1402 <param name='level' doc='Set the maximum group level' />
1403 <param name='global' doc='Report global groups only' />
1404 <param name='peer' doc='Report global and network peer related groups' />
1405 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1406 </params>
1407 </command>
1408 <command id='enable'>
1409 <params>
1410 <param name='enable' doc='Enable the reporter' />
1411 </params>
1412 </command>
1413 <command id='disable'>
1414 <params>
1415 <param name='disable' doc='Disable the reporter' />
1416 </params>
1417 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1418 <command id='flush-period &lt;0-65535&gt;'>
1419 <params>
1420 <param name='flush-period' doc='Configure stats sub-system' />
1421 <param name='&lt;0-65535&gt;' doc='Send all stats even if they have not changed (i.e. force the flush)every N-th reporting interval. Set to 0 to disable regular flush (default).' />
1422 </params>
1423 </command>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1424 </node>
1425 <node id='config-line'>
1426 <name>config-line</name>
1427 <command id='login'>
1428 <params>
1429 <param name='login' doc='Enable password checking' />
1430 </params>
1431 </command>
1432 <command id='no login'>
1433 <params>
1434 <param name='no' doc='Negate a command or set its defaults' />
1435 <param name='login' doc='Enable password checking' />
1436 </params>
1437 </command>
1438 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
1439 <params>
1440 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1441 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1442 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
1443 </params>
1444 </command>
1445 </node>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1446 <node id='config-gbproxy'>
1447 <name>config-gbproxy</name>
1448 <command id='pool bvc-flow-control-ratio &lt;1-100&gt;'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1449 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1450 <param name='pool' doc='SGSN Pool related configuration' />
1451 <param name='bvc-flow-control-ratio' doc='Ratio of BSS-advertised bucket size + leak rate advertised to each SGSN' />
1452 <param name='&lt;1-100&gt;' doc='Ratio of BSS-advertised bucket size + leak rate advertised to each SGSN (Percent)' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1453 </params>
1454 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1455 <command id='nri bitlen &lt;0-15&gt;'>
1456 <attributes scope='global'>
1457 <attribute doc='This command applies immediately' flag='!' />
1458 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1459 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1460 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
1461 <param name='bitlen' doc='Set number of bits that an NRI has, to extract from TMSI identities (always starting just after the TMSI&apos;s most significant octet).' />
1462 <param name='&lt;0-15&gt;' doc='bit count (0 disables) pooling)' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1463 </params>
1464 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1465 <command id='nri null add &lt;0-32767&gt; [&lt;0-32767&gt;]'>
1466 <attributes scope='global'>
1467 <attribute doc='This command applies immediately' flag='!' />
1468 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1469 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1470 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
1471 <param name='null' doc='Define NULL-NRI values that cause re-assignment of an MS to a different SGSN, for SGSN pooling.' />
1472 <param name='add' doc='Add NULL-NRI value (or range)' />
1473 <param name='&lt;0-32767&gt;' doc='First value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos;.' />
1474 <param name='[&lt;0-32767&gt;]' doc='Last value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos; and be larger than the first value; if omitted, apply only the first value.' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1475 </params>
1476 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1477 <command id='nri null del &lt;0-32767&gt; [&lt;0-32767&gt;]'>
1478 <attributes scope='global'>
1479 <attribute doc='This command applies immediately' flag='!' />
1480 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1481 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1482 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
1483 <param name='null' doc='Define NULL-NRI values that cause re-assignment of an MS to a different SGSN, for SGSN pooling.' />
1484 <param name='del' doc='Remove NRI value or range from the NRI mapping for this MSC' />
1485 <param name='&lt;0-32767&gt;' doc='First value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos;.' />
1486 <param name='[&lt;0-32767&gt;]' doc='Last value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos; and be larger than the first value; if omitted, apply only the first value.' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1487 </params>
1488 </command>
1489 </node>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1490 <node id='config-sgsn'>
1491 <name>config-sgsn</name>
1492 <command id='name NAME'>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1493 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1494 <param name='name' doc='Configure the SGSN' />
1495 <param name='NAME' doc='Name the SGSN' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1496 </params>
1497 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1498 <command id='allow-attach'>
1499 <attributes scope='global'>
1500 <attribute doc='This command applies immediately' flag='!' />
1501 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1502 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1503 <param name='allow-attach' doc='Allow this SGSN to attach new subscribers (default).' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1504 </params>
1505 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1506 <command id='no allow-attach'>
1507 <attributes scope='global'>
1508 <attribute doc='This command applies immediately' flag='!' />
1509 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1510 <params>
1511 <param name='no' doc='Negate a command or set its defaults' />
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1512 <param name='allow-attach' doc='Do not assign new subscribers to this MSC. Useful if an MSC in an MSC pool is configured to off-load subscribers. The MSC will still be operational for already IMSI-Attached subscribers, but the NAS node selection function will skip this MSC for new subscribers' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1513 </params>
1514 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1515 <command id='nri add &lt;0-32767&gt; [&lt;0-32767&gt;]'>
1516 <attributes scope='global'>
1517 <attribute doc='This command applies immediately' flag='!' />
1518 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1519 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1520 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
1521 <param name='add' doc='Add NRI value or range to the NRI mapping for this MSC' />
1522 <param name='&lt;0-32767&gt;' doc='First value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos;.' />
1523 <param name='[&lt;0-32767&gt;]' doc='Last value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos; and be larger than the first value; if omitted, apply only the first value.' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1524 </params>
1525 </command>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1526 <command id='nri del &lt;0-32767&gt; [&lt;0-32767&gt;]'>
1527 <attributes scope='global'>
1528 <attribute doc='This command applies immediately' flag='!' />
1529 </attributes>
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1530 <params>
Harald Welte936dfd72021-01-31 19:36:06 +0100[diff] [blame]1531 <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' />
1532 <param name='del' doc='Remove NRI value or range from the NRI mapping for this MSC' />
1533 <param name='&lt;0-32767&gt;' doc='First value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos;.' />
1534 <param name='[&lt;0-32767&gt;]' doc='Last value of the NRI value range, should not surpass the configured &apos;nri bitlen&apos; and be larger than the first value; if omitted, apply only the first value.' />
Oliver Smith149a95c2019-12-02 11:17:00 +0100[diff] [blame]1535 </params>
1536 </command>
1537 </node>
1538</vtydoc>