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