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