Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 1 | <vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> |
Neels Hofmeyr | e010dea | 2017-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 Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 54 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 55 | <node id='view'> |
| 56 | <name>view</name> |
Neels Hofmeyr | f453044 | 2017-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 Hofmeyr | f453044 | 2017-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 <0-512>'> |
| 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='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> |
| 79 | </params> |
| 80 | </command> |
| 81 | <command id='terminal no length'> |
| 82 | <params> |
| 83 | <param name='terminal' doc='Set terminal line parameters' /> |
| 84 | <param name='no' doc='Negate a command or set its defaults' /> |
| 85 | <param name='length' doc='Set number of lines on a screen' /> |
| 86 | </params> |
| 87 | </command> |
| 88 | <command id='echo .MESSAGE'> |
| 89 | <params> |
| 90 | <param name='echo' doc='Echo a message back to the vty' /> |
| 91 | <param name='.MESSAGE' doc='The message to echo' /> |
| 92 | </params> |
| 93 | </command> |
| 94 | <command id='who'> |
| 95 | <params> |
| 96 | <param name='who' doc='Display who is on vty' /> |
| 97 | </params> |
| 98 | </command> |
| 99 | <command id='show history'> |
| 100 | <params> |
| 101 | <param name='show' doc='Show running system information' /> |
| 102 | <param name='history' doc='Display the session command history' /> |
| 103 | </params> |
| 104 | </command> |
| 105 | <command id='logging enable'> |
| 106 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 107 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 108 | <param name='enable' doc='Enables logging to this vty' /> |
| 109 | </params> |
| 110 | </command> |
| 111 | <command id='logging disable'> |
| 112 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 113 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 114 | <param name='disable' doc='Disables logging to this vty' /> |
| 115 | </params> |
| 116 | </command> |
| 117 | <command id='logging filter all (0|1)'> |
| 118 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 119 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 120 | <param name='filter' doc='Filter log messages' /> |
| 121 | <param name='all' doc='Do you want to log all messages?' /> |
| 122 | <param name='0' doc='Only print messages matched by other filters' /> |
| 123 | <param name='1' doc='Bypass filter and print all messages' /> |
| 124 | </params> |
| 125 | </command> |
| 126 | <command id='logging color (0|1)'> |
| 127 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 128 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 129 | <param name='color' doc='Configure color-printing for log messages' /> |
| 130 | <param name='0' doc='Don't use color for printing messages' /> |
| 131 | <param name='1' doc='Use color for printing messages' /> |
| 132 | </params> |
| 133 | </command> |
| 134 | <command id='logging timestamp (0|1)'> |
| 135 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 136 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 137 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 138 | <param name='0' doc='Don't prefix each log message' /> |
| 139 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 140 | </params> |
| 141 | </command> |
| 142 | <command id='logging print extended-timestamp (0|1)'> |
| 143 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 144 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 145 | <param name='print' doc='Log output settings' /> |
| 146 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 147 | <param name='0' doc='Don't prefix each log message' /> |
| 148 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 149 | </params> |
| 150 | </command> |
| 151 | <command id='logging print category (0|1)'> |
| 152 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 153 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 154 | <param name='print' doc='Log output settings' /> |
| 155 | <param name='category' doc='Configure log message' /> |
| 156 | <param name='0' doc='Don't prefix each log message' /> |
| 157 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 158 | </params> |
| 159 | </command> |
| 160 | <command id='logging set-log-mask MASK'> |
| 161 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 162 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 163 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 164 | <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 165 | </params> |
| 166 | </command> |
| 167 | <command id='logging set log mask MASK'> |
| 168 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 169 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 170 | <param name='set' doc='Decide which categories to output.' /> |
| 171 | <param name='log' doc='Log commands' /> |
| 172 | <param name='mask' doc='Mask commands' /> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 173 | <param name='MASK' doc=''set log mask' is deprecated, please refer to the docs of 'set-log-mask' instead' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 174 | </params> |
| 175 | </command> |
| 176 | <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp) (everything|debug|info|notice|error|fatal)'> |
| 177 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 178 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 179 | <param name='level' doc='Set the log level for a specified category' /> |
| 180 | <param name='all' doc='Global setting for all subsystems' /> |
| 181 | <param name='ip' doc='IP Pool and other groups' /> |
| 182 | <param name='tun' doc='Tunnel interface' /> |
| 183 | <param name='ggsn' doc='GGSN' /> |
| 184 | <param name='sgsn' doc='SGSN Emulator' /> |
| 185 | <param name='icmp6' doc='ICMPv6' /> |
| 186 | <param name='lglobal' doc='Library-internal global log family' /> |
| 187 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 188 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 189 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 190 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 191 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 192 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 193 | <param name='lctrl' doc='Control Interface' /> |
| 194 | <param name='lgtp' doc='GPRS GTP library' /> |
| 195 | <param name='lstats' doc='Statistics messages and logging' /> |
| 196 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 197 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 198 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 199 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 200 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 201 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 202 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 203 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 204 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 205 | <param name='info' doc='Log informational messages and higher levels' /> |
| 206 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 207 | <param name='error' doc='Log error messages and higher levels' /> |
| 208 | <param name='fatal' doc='Log only fatal messages' /> |
| 209 | </params> |
| 210 | </command> |
| 211 | <command id='show logging vty'> |
| 212 | <params> |
| 213 | <param name='show' doc='Show running system information' /> |
| 214 | <param name='logging' doc='Show current logging configuration' /> |
| 215 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 216 | </params> |
| 217 | </command> |
| 218 | <command id='show alarms'> |
| 219 | <params> |
| 220 | <param name='show' doc='Show running system information' /> |
| 221 | <param name='alarms' doc='Show current logging configuration' /> |
| 222 | </params> |
| 223 | </command> |
| 224 | <command id='show stats'> |
| 225 | <params> |
| 226 | <param name='show' doc='Show running system information' /> |
| 227 | <param name='stats' doc='Show statistical values' /> |
| 228 | </params> |
| 229 | </command> |
| 230 | <command id='show stats level (global|peer|subscriber)'> |
| 231 | <params> |
| 232 | <param name='show' doc='Show running system information' /> |
| 233 | <param name='stats' doc='Show statistical values' /> |
| 234 | <param name='level' doc='Set the maximum group level' /> |
| 235 | <param name='global' doc='Show global groups only' /> |
| 236 | <param name='peer' doc='Show global and network peer related groups' /> |
| 237 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 238 | </params> |
| 239 | </command> |
| 240 | <command id='show asciidoc counters'> |
| 241 | <params> |
| 242 | <param name='show' doc='Show running system information' /> |
| 243 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 244 | <param name='counters' doc='Generate table of all registered counters' /> |
| 245 | </params> |
| 246 | </command> |
| 247 | <command id='show pdp-context ggsn NAME [apn APN]'> |
| 248 | <params> |
| 249 | <param name='show' doc='Show running system information' /> |
| 250 | <param name='pdp-context' doc='Show PDP Context Information' /> |
| 251 | <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> |
| 252 | <param name='NAME' doc='GGSN Name' /> |
| 253 | <param name='[apn' doc='(null)' /> |
| 254 | <param name='APN]' doc='(null)' /> |
| 255 | </params> |
| 256 | </command> |
| 257 | <command id='show pdp-context imsi IMSI [<0-15>]'> |
| 258 | <params> |
| 259 | <param name='show' doc='Show running system information' /> |
| 260 | <param name='pdp-context' doc='Display information on PDP Context' /> |
| 261 | <param name='imsi' doc='PDP contexts for given IMSI' /> |
| 262 | <param name='IMSI' doc='PDP context for given NSAPI' /> |
| 263 | <param name='[<0-15>]' doc='(null)' /> |
| 264 | </params> |
| 265 | </command> |
| 266 | <command id='show ggsn [NAME]'> |
| 267 | <params> |
| 268 | <param name='show' doc='Show running system information' /> |
| 269 | <param name='ggsn' doc='Display information on the GGSN' /> |
| 270 | <param name='[NAME]' doc='(null)' /> |
| 271 | </params> |
| 272 | </command> |
| 273 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 274 | <node id='enable'> |
| 275 | <name>enable</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 276 | <command id='disable'> |
| 277 | <params> |
| 278 | <param name='disable' doc='Turn off privileged mode command' /> |
| 279 | </params> |
| 280 | </command> |
| 281 | <command id='configure terminal'> |
| 282 | <params> |
| 283 | <param name='configure' doc='Configuration from vty interface' /> |
| 284 | <param name='terminal' doc='Configuration terminal' /> |
| 285 | </params> |
| 286 | </command> |
| 287 | <command id='copy running-config startup-config'> |
| 288 | <params> |
| 289 | <param name='copy' doc='Copy configuration' /> |
| 290 | <param name='running-config' doc='Copy running config to... ' /> |
| 291 | <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> |
| 292 | </params> |
| 293 | </command> |
| 294 | <command id='show startup-config'> |
| 295 | <params> |
| 296 | <param name='show' doc='Show running system information' /> |
| 297 | <param name='startup-config' doc='Contentes of startup configuration' /> |
| 298 | </params> |
| 299 | </command> |
| 300 | <command id='show version'> |
| 301 | <params> |
| 302 | <param name='show' doc='Show running system information' /> |
| 303 | <param name='version' doc='Displays program version' /> |
| 304 | </params> |
| 305 | </command> |
| 306 | <command id='show online-help'> |
| 307 | <params> |
| 308 | <param name='show' doc='Show running system information' /> |
| 309 | <param name='online-help' doc='Online help' /> |
| 310 | </params> |
| 311 | </command> |
| 312 | <command id='terminal length <0-512>'> |
| 313 | <params> |
| 314 | <param name='terminal' doc='Set terminal line parameters' /> |
| 315 | <param name='length' doc='Set number of lines on a screen' /> |
| 316 | <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> |
| 317 | </params> |
| 318 | </command> |
| 319 | <command id='terminal no length'> |
| 320 | <params> |
| 321 | <param name='terminal' doc='Set terminal line parameters' /> |
| 322 | <param name='no' doc='Negate a command or set its defaults' /> |
| 323 | <param name='length' doc='Set number of lines on a screen' /> |
| 324 | </params> |
| 325 | </command> |
| 326 | <command id='echo .MESSAGE'> |
| 327 | <params> |
| 328 | <param name='echo' doc='Echo a message back to the vty' /> |
| 329 | <param name='.MESSAGE' doc='The message to echo' /> |
| 330 | </params> |
| 331 | </command> |
| 332 | <command id='who'> |
| 333 | <params> |
| 334 | <param name='who' doc='Display who is on vty' /> |
| 335 | </params> |
| 336 | </command> |
| 337 | <command id='show history'> |
| 338 | <params> |
| 339 | <param name='show' doc='Show running system information' /> |
| 340 | <param name='history' doc='Display the session command history' /> |
| 341 | </params> |
| 342 | </command> |
| 343 | <command id='terminal monitor'> |
| 344 | <params> |
| 345 | <param name='terminal' doc='Set terminal line parameters' /> |
| 346 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 347 | </params> |
| 348 | </command> |
| 349 | <command id='terminal no monitor'> |
| 350 | <params> |
| 351 | <param name='terminal' doc='Set terminal line parameters' /> |
| 352 | <param name='no' doc='Negate a command or set its defaults' /> |
| 353 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 354 | </params> |
| 355 | </command> |
| 356 | <command id='logging enable'> |
| 357 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 358 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 359 | <param name='enable' doc='Enables logging to this vty' /> |
| 360 | </params> |
| 361 | </command> |
| 362 | <command id='logging disable'> |
| 363 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 364 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 365 | <param name='disable' doc='Disables logging to this vty' /> |
| 366 | </params> |
| 367 | </command> |
| 368 | <command id='logging filter all (0|1)'> |
| 369 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 370 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 371 | <param name='filter' doc='Filter log messages' /> |
| 372 | <param name='all' doc='Do you want to log all messages?' /> |
| 373 | <param name='0' doc='Only print messages matched by other filters' /> |
| 374 | <param name='1' doc='Bypass filter and print all messages' /> |
| 375 | </params> |
| 376 | </command> |
| 377 | <command id='logging color (0|1)'> |
| 378 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 379 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 380 | <param name='color' doc='Configure color-printing for log messages' /> |
| 381 | <param name='0' doc='Don't use color for printing messages' /> |
| 382 | <param name='1' doc='Use color for printing messages' /> |
| 383 | </params> |
| 384 | </command> |
| 385 | <command id='logging timestamp (0|1)'> |
| 386 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 387 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 388 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 389 | <param name='0' doc='Don't prefix each log message' /> |
| 390 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 391 | </params> |
| 392 | </command> |
| 393 | <command id='logging print extended-timestamp (0|1)'> |
| 394 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 395 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 396 | <param name='print' doc='Log output settings' /> |
| 397 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 398 | <param name='0' doc='Don't prefix each log message' /> |
| 399 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 400 | </params> |
| 401 | </command> |
| 402 | <command id='logging print category (0|1)'> |
| 403 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 404 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 405 | <param name='print' doc='Log output settings' /> |
| 406 | <param name='category' doc='Configure log message' /> |
| 407 | <param name='0' doc='Don't prefix each log message' /> |
| 408 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 409 | </params> |
| 410 | </command> |
| 411 | <command id='logging set-log-mask MASK'> |
| 412 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 413 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 414 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 415 | <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 416 | </params> |
| 417 | </command> |
| 418 | <command id='logging set log mask MASK'> |
| 419 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 420 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 421 | <param name='set' doc='Decide which categories to output.' /> |
| 422 | <param name='log' doc='Log commands' /> |
| 423 | <param name='mask' doc='Mask commands' /> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 424 | <param name='MASK' doc=''set log mask' is deprecated, please refer to the docs of 'set-log-mask' instead' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 425 | </params> |
| 426 | </command> |
| 427 | <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp) (everything|debug|info|notice|error|fatal)'> |
| 428 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 429 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 430 | <param name='level' doc='Set the log level for a specified category' /> |
| 431 | <param name='all' doc='Global setting for all subsystems' /> |
| 432 | <param name='ip' doc='IP Pool and other groups' /> |
| 433 | <param name='tun' doc='Tunnel interface' /> |
| 434 | <param name='ggsn' doc='GGSN' /> |
| 435 | <param name='sgsn' doc='SGSN Emulator' /> |
| 436 | <param name='icmp6' doc='ICMPv6' /> |
| 437 | <param name='lglobal' doc='Library-internal global log family' /> |
| 438 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 439 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 440 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 441 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 442 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 443 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 444 | <param name='lctrl' doc='Control Interface' /> |
| 445 | <param name='lgtp' doc='GPRS GTP library' /> |
| 446 | <param name='lstats' doc='Statistics messages and logging' /> |
| 447 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 448 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 449 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 450 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 451 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 452 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 453 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 454 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 455 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 456 | <param name='info' doc='Log informational messages and higher levels' /> |
| 457 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 458 | <param name='error' doc='Log error messages and higher levels' /> |
| 459 | <param name='fatal' doc='Log only fatal messages' /> |
| 460 | </params> |
| 461 | </command> |
| 462 | <command id='show logging vty'> |
| 463 | <params> |
| 464 | <param name='show' doc='Show running system information' /> |
| 465 | <param name='logging' doc='Show current logging configuration' /> |
| 466 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 467 | </params> |
| 468 | </command> |
| 469 | <command id='show alarms'> |
| 470 | <params> |
| 471 | <param name='show' doc='Show running system information' /> |
| 472 | <param name='alarms' doc='Show current logging configuration' /> |
| 473 | </params> |
| 474 | </command> |
| 475 | <command id='show stats'> |
| 476 | <params> |
| 477 | <param name='show' doc='Show running system information' /> |
| 478 | <param name='stats' doc='Show statistical values' /> |
| 479 | </params> |
| 480 | </command> |
| 481 | <command id='show stats level (global|peer|subscriber)'> |
| 482 | <params> |
| 483 | <param name='show' doc='Show running system information' /> |
| 484 | <param name='stats' doc='Show statistical values' /> |
| 485 | <param name='level' doc='Set the maximum group level' /> |
| 486 | <param name='global' doc='Show global groups only' /> |
| 487 | <param name='peer' doc='Show global and network peer related groups' /> |
| 488 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 489 | </params> |
| 490 | </command> |
| 491 | <command id='show asciidoc counters'> |
| 492 | <params> |
| 493 | <param name='show' doc='Show running system information' /> |
| 494 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 495 | <param name='counters' doc='Generate table of all registered counters' /> |
| 496 | </params> |
| 497 | </command> |
| 498 | <command id='show pdp-context ggsn NAME [apn APN]'> |
| 499 | <params> |
| 500 | <param name='show' doc='Show running system information' /> |
| 501 | <param name='pdp-context' doc='Show PDP Context Information' /> |
| 502 | <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> |
| 503 | <param name='NAME' doc='GGSN Name' /> |
| 504 | <param name='[apn' doc='(null)' /> |
| 505 | <param name='APN]' doc='(null)' /> |
| 506 | </params> |
| 507 | </command> |
| 508 | <command id='show pdp-context imsi IMSI [<0-15>]'> |
| 509 | <params> |
| 510 | <param name='show' doc='Show running system information' /> |
| 511 | <param name='pdp-context' doc='Display information on PDP Context' /> |
| 512 | <param name='imsi' doc='PDP contexts for given IMSI' /> |
| 513 | <param name='IMSI' doc='PDP context for given NSAPI' /> |
| 514 | <param name='[<0-15>]' doc='(null)' /> |
| 515 | </params> |
| 516 | </command> |
| 517 | <command id='show ggsn [NAME]'> |
| 518 | <params> |
| 519 | <param name='show' doc='Show running system information' /> |
| 520 | <param name='ggsn' doc='Display information on the GGSN' /> |
| 521 | <param name='[NAME]' doc='(null)' /> |
| 522 | </params> |
| 523 | </command> |
| 524 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 525 | <node id='config'> |
| 526 | <name>config</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 527 | <command id='hostname WORD'> |
| 528 | <params> |
| 529 | <param name='hostname' doc='Set system's network name' /> |
| 530 | <param name='WORD' doc='This system's network name' /> |
| 531 | </params> |
| 532 | </command> |
| 533 | <command id='no hostname [HOSTNAME]'> |
| 534 | <params> |
| 535 | <param name='no' doc='Negate a command or set its defaults' /> |
| 536 | <param name='hostname' doc='Reset system's network name' /> |
| 537 | <param name='[HOSTNAME]' doc='Host name of this router' /> |
| 538 | </params> |
| 539 | </command> |
| 540 | <command id='password (8|) WORD'> |
| 541 | <params> |
| 542 | <param name='password' doc='Assign the terminal connection password' /> |
| 543 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 544 | <param name='' doc='dummy string ' /> |
| 545 | <param name='WORD' doc='The HIDDEN line password string' /> |
| 546 | </params> |
| 547 | </command> |
| 548 | <command id='password LINE'> |
| 549 | <params> |
| 550 | <param name='password' doc='Assign the terminal connection password' /> |
| 551 | <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> |
| 552 | </params> |
| 553 | </command> |
| 554 | <command id='enable password (8|) WORD'> |
| 555 | <params> |
| 556 | <param name='enable' doc='Modify enable password parameters' /> |
| 557 | <param name='password' doc='Assign the privileged level password' /> |
| 558 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 559 | <param name='' doc='dummy string ' /> |
| 560 | <param name='WORD' doc='The HIDDEN 'enable' password string' /> |
| 561 | </params> |
| 562 | </command> |
| 563 | <command id='enable password LINE'> |
| 564 | <params> |
| 565 | <param name='enable' doc='Modify enable password parameters' /> |
| 566 | <param name='password' doc='Assign the privileged level password' /> |
| 567 | <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> |
| 568 | </params> |
| 569 | </command> |
| 570 | <command id='no enable password'> |
| 571 | <params> |
| 572 | <param name='no' doc='Negate a command or set its defaults' /> |
| 573 | <param name='enable' doc='Modify enable password parameters' /> |
| 574 | <param name='password' doc='Assign the privileged level password' /> |
| 575 | </params> |
| 576 | </command> |
| 577 | <command id='banner motd default'> |
| 578 | <params> |
| 579 | <param name='banner' doc='Set banner string' /> |
| 580 | <param name='motd' doc='Strings for motd' /> |
| 581 | <param name='default' doc='Default string' /> |
| 582 | </params> |
| 583 | </command> |
| 584 | <command id='banner motd file [FILE]'> |
| 585 | <params> |
| 586 | <param name='banner' doc='Set banner' /> |
| 587 | <param name='motd' doc='Banner for motd' /> |
| 588 | <param name='file' doc='Banner from a file' /> |
| 589 | <param name='[FILE]' doc='Filename' /> |
| 590 | </params> |
| 591 | </command> |
| 592 | <command id='no banner motd'> |
| 593 | <params> |
| 594 | <param name='no' doc='Negate a command or set its defaults' /> |
| 595 | <param name='banner' doc='Set banner string' /> |
| 596 | <param name='motd' doc='Strings for motd' /> |
| 597 | </params> |
| 598 | </command> |
| 599 | <command id='service terminal-length <0-512>'> |
| 600 | <params> |
| 601 | <param name='service' doc='Set up miscellaneous service' /> |
| 602 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 603 | <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> |
| 604 | </params> |
| 605 | </command> |
| 606 | <command id='no service terminal-length [<0-512>]'> |
| 607 | <params> |
| 608 | <param name='no' doc='Negate a command or set its defaults' /> |
| 609 | <param name='service' doc='Set up miscellaneous service' /> |
| 610 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 611 | <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> |
| 612 | </params> |
| 613 | </command> |
| 614 | <command id='line vty'> |
| 615 | <params> |
| 616 | <param name='line' doc='Configure a terminal line' /> |
| 617 | <param name='vty' doc='Virtual terminal' /> |
| 618 | </params> |
| 619 | </command> |
| 620 | <command id='service advanced-vty'> |
| 621 | <params> |
| 622 | <param name='service' doc='Set up miscellaneous service' /> |
| 623 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 624 | </params> |
| 625 | </command> |
| 626 | <command id='no service advanced-vty'> |
| 627 | <params> |
| 628 | <param name='no' doc='Negate a command or set its defaults' /> |
| 629 | <param name='service' doc='Set up miscellaneous service' /> |
| 630 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 631 | </params> |
| 632 | </command> |
| 633 | <command id='show history'> |
| 634 | <params> |
| 635 | <param name='show' doc='Show running system information' /> |
| 636 | <param name='history' doc='Display the session command history' /> |
| 637 | </params> |
| 638 | </command> |
| 639 | <command id='log stderr'> |
| 640 | <params> |
| 641 | <param name='log' doc='Configure logging sub-system' /> |
| 642 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 643 | </params> |
| 644 | </command> |
| 645 | <command id='no log stderr'> |
| 646 | <params> |
| 647 | <param name='no' doc='Negate a command or set its defaults' /> |
| 648 | <param name='log' doc='Configure logging sub-system' /> |
| 649 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 650 | </params> |
| 651 | </command> |
| 652 | <command id='log file .FILENAME'> |
| 653 | <params> |
| 654 | <param name='log' doc='Configure logging sub-system' /> |
| 655 | <param name='file' doc='Logging to text file' /> |
| 656 | <param name='.FILENAME' doc='Filename' /> |
| 657 | </params> |
| 658 | </command> |
| 659 | <command id='no log file .FILENAME'> |
| 660 | <params> |
| 661 | <param name='no' doc='Negate a command or set its defaults' /> |
| 662 | <param name='log' doc='Configure logging sub-system' /> |
| 663 | <param name='file' doc='Logging to text file' /> |
| 664 | <param name='.FILENAME' doc='Filename' /> |
| 665 | </params> |
| 666 | </command> |
| 667 | <command id='log alarms <2-32700>'> |
| 668 | <params> |
| 669 | <param name='log' doc='Configure logging sub-system' /> |
| 670 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 671 | <param name='<2-32700>' doc='Maximum number of messages to log' /> |
| 672 | </params> |
| 673 | </command> |
| 674 | <command id='no log alarms'> |
| 675 | <params> |
| 676 | <param name='no' doc='Negate a command or set its defaults' /> |
| 677 | <param name='log' doc='Configure logging sub-system' /> |
| 678 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 679 | </params> |
| 680 | </command> |
| 681 | <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> |
| 682 | <params> |
| 683 | <param name='log' doc='Configure logging sub-system' /> |
| 684 | <param name='syslog' doc='Logging via syslog' /> |
| 685 | <param name='authpriv' doc='Security/authorization messages facility' /> |
| 686 | <param name='cron' doc='Clock daemon (cron/at) facility' /> |
| 687 | <param name='daemon' doc='General system daemon facility' /> |
| 688 | <param name='ftp' doc='Ftp daemon facility' /> |
| 689 | <param name='lpr' doc='Line printer facility' /> |
| 690 | <param name='mail' doc='Mail facility' /> |
| 691 | <param name='news' doc='News facility' /> |
| 692 | <param name='user' doc='Generic facility' /> |
| 693 | <param name='uucp' doc='UUCP facility' /> |
| 694 | </params> |
| 695 | </command> |
| 696 | <command id='log syslog local <0-7>'> |
| 697 | <params> |
| 698 | <param name='log' doc='Configure logging sub-system' /> |
| 699 | <param name='syslog' doc='Logging via syslog' /> |
| 700 | <param name='local' doc='Syslog LOCAL facility' /> |
| 701 | <param name='<0-7>' doc='Local facility number' /> |
| 702 | </params> |
| 703 | </command> |
| 704 | <command id='no log syslog'> |
| 705 | <params> |
| 706 | <param name='no' doc='Negate a command or set its defaults' /> |
| 707 | <param name='log' doc='Configure logging sub-system' /> |
| 708 | <param name='syslog' doc='Logging via syslog' /> |
| 709 | </params> |
| 710 | </command> |
| 711 | <command id='log gsmtap [HOSTNAME]'> |
| 712 | <params> |
| 713 | <param name='log' doc='Configure logging sub-system' /> |
| 714 | <param name='gsmtap' doc='Logging via GSMTAP' /> |
| 715 | <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> |
| 716 | </params> |
| 717 | </command> |
| 718 | <command id='stats reporter statsd'> |
| 719 | <params> |
| 720 | <param name='stats' doc='Configure stats sub-system' /> |
| 721 | <param name='reporter' doc='Configure a stats reporter' /> |
| 722 | <param name='statsd' doc='Report to a STATSD server' /> |
| 723 | </params> |
| 724 | </command> |
| 725 | <command id='no stats reporter statsd'> |
| 726 | <params> |
| 727 | <param name='no' doc='Negate a command or set its defaults' /> |
| 728 | <param name='stats' doc='Configure stats sub-system' /> |
| 729 | <param name='reporter' doc='Configure a stats reporter' /> |
| 730 | <param name='statsd' doc='Report to a STATSD server' /> |
| 731 | </params> |
| 732 | </command> |
| 733 | <command id='stats reporter log'> |
| 734 | <params> |
| 735 | <param name='stats' doc='Configure stats sub-system' /> |
| 736 | <param name='reporter' doc='Configure a stats reporter' /> |
| 737 | <param name='log' doc='Report to the logger' /> |
| 738 | </params> |
| 739 | </command> |
| 740 | <command id='no stats reporter log'> |
| 741 | <params> |
| 742 | <param name='no' doc='Negate a command or set its defaults' /> |
| 743 | <param name='stats' doc='Configure stats sub-system' /> |
| 744 | <param name='reporter' doc='Configure a stats reporter' /> |
| 745 | <param name='log' doc='Report to the logger' /> |
| 746 | </params> |
| 747 | </command> |
| 748 | <command id='stats interval <1-65535>'> |
| 749 | <params> |
| 750 | <param name='stats' doc='Configure stats sub-system' /> |
| 751 | <param name='interval' doc='Set the reporting interval' /> |
| 752 | <param name='<1-65535>' doc='Interval in seconds' /> |
| 753 | </params> |
| 754 | </command> |
| 755 | <command id='ggsn NAME'> |
| 756 | <params> |
| 757 | <param name='ggsn' doc='Configure the Gateway GPRS Support Node' /> |
| 758 | <param name='NAME' doc='GGSN Name (has only local significance)' /> |
| 759 | </params> |
| 760 | </command> |
| 761 | <command id='no ggsn NAME'> |
| 762 | <params> |
| 763 | <param name='no' doc='Negate a command or set its defaults' /> |
| 764 | <param name='ggsn' doc='Remove the named Gateway GPRS Support Node' /> |
| 765 | <param name='NAME' doc='GGSN Name (has only local significance)' /> |
| 766 | </params> |
| 767 | </command> |
| 768 | <command id='ctrl'> |
| 769 | <params> |
| 770 | <param name='ctrl' doc='Configure the Control Interface' /> |
| 771 | </params> |
| 772 | </command> |
| 773 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 774 | <node id='config-log'> |
| 775 | <name>config-log</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 776 | <command id='logging filter all (0|1)'> |
| 777 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 778 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 779 | <param name='filter' doc='Filter log messages' /> |
| 780 | <param name='all' doc='Do you want to log all messages?' /> |
| 781 | <param name='0' doc='Only print messages matched by other filters' /> |
| 782 | <param name='1' doc='Bypass filter and print all messages' /> |
| 783 | </params> |
| 784 | </command> |
| 785 | <command id='logging color (0|1)'> |
| 786 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 787 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 788 | <param name='color' doc='Configure color-printing for log messages' /> |
| 789 | <param name='0' doc='Don't use color for printing messages' /> |
| 790 | <param name='1' doc='Use color for printing messages' /> |
| 791 | </params> |
| 792 | </command> |
| 793 | <command id='logging timestamp (0|1)'> |
| 794 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 795 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 796 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 797 | <param name='0' doc='Don't prefix each log message' /> |
| 798 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 799 | </params> |
| 800 | </command> |
| 801 | <command id='logging print extended-timestamp (0|1)'> |
| 802 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 803 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 804 | <param name='print' doc='Log output settings' /> |
| 805 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 806 | <param name='0' doc='Don't prefix each log message' /> |
| 807 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 808 | </params> |
| 809 | </command> |
| 810 | <command id='logging print category (0|1)'> |
| 811 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 812 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 813 | <param name='print' doc='Log output settings' /> |
| 814 | <param name='category' doc='Configure log message' /> |
| 815 | <param name='0' doc='Don't prefix each log message' /> |
| 816 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 817 | </params> |
| 818 | </command> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 819 | <command id='logging set-log-mask MASK'> |
| 820 | <params> |
| 821 | <param name='logging' doc='Configure logging' /> |
| 822 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
| 823 | <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> |
| 824 | </params> |
| 825 | </command> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 826 | <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp) (everything|debug|info|notice|error|fatal)'> |
| 827 | <params> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 828 | <param name='logging' doc='Configure logging' /> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 829 | <param name='level' doc='Set the log level for a specified category' /> |
| 830 | <param name='all' doc='Global setting for all subsystems' /> |
| 831 | <param name='ip' doc='IP Pool and other groups' /> |
| 832 | <param name='tun' doc='Tunnel interface' /> |
| 833 | <param name='ggsn' doc='GGSN' /> |
| 834 | <param name='sgsn' doc='SGSN Emulator' /> |
| 835 | <param name='icmp6' doc='ICMPv6' /> |
| 836 | <param name='lglobal' doc='Library-internal global log family' /> |
| 837 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 838 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 839 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 840 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 841 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 842 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 843 | <param name='lctrl' doc='Control Interface' /> |
| 844 | <param name='lgtp' doc='GPRS GTP library' /> |
| 845 | <param name='lstats' doc='Statistics messages and logging' /> |
| 846 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 847 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 848 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 849 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 850 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 851 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 852 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 853 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 854 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 855 | <param name='info' doc='Log informational messages and higher levels' /> |
| 856 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 857 | <param name='error' doc='Log error messages and higher levels' /> |
| 858 | <param name='fatal' doc='Log only fatal messages' /> |
| 859 | </params> |
| 860 | </command> |
| 861 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 862 | <node id='config-stats'> |
| 863 | <name>config-stats</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 864 | <command id='local-ip ADDR'> |
| 865 | <params> |
| 866 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 867 | <param name='ADDR' doc='IP Address' /> |
| 868 | </params> |
| 869 | </command> |
| 870 | <command id='no local-ip'> |
| 871 | <params> |
| 872 | <param name='no' doc='Negate a command or set its defaults' /> |
| 873 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 874 | </params> |
| 875 | </command> |
| 876 | <command id='remote-ip ADDR'> |
| 877 | <params> |
| 878 | <param name='remote-ip' doc='Set the remote IP address to which we connect' /> |
| 879 | <param name='ADDR' doc='IP Address' /> |
| 880 | </params> |
| 881 | </command> |
| 882 | <command id='remote-port <1-65535>'> |
| 883 | <params> |
| 884 | <param name='remote-port' doc='Set the remote port to which we connect' /> |
| 885 | <param name='<1-65535>' doc='Remote port number' /> |
| 886 | </params> |
| 887 | </command> |
| 888 | <command id='mtu <100-65535>'> |
| 889 | <params> |
| 890 | <param name='mtu' doc='Set the maximum packet size' /> |
| 891 | <param name='<100-65535>' doc='Size in byte' /> |
| 892 | </params> |
| 893 | </command> |
| 894 | <command id='no mtu'> |
| 895 | <params> |
| 896 | <param name='no' doc='Negate a command or set its defaults' /> |
| 897 | <param name='mtu' doc='Set the maximum packet size' /> |
| 898 | </params> |
| 899 | </command> |
| 900 | <command id='prefix PREFIX'> |
| 901 | <params> |
| 902 | <param name='prefix' doc='Set the item name prefix' /> |
| 903 | <param name='PREFIX' doc='The prefix string' /> |
| 904 | </params> |
| 905 | </command> |
| 906 | <command id='no prefix'> |
| 907 | <params> |
| 908 | <param name='no' doc='Negate a command or set its defaults' /> |
| 909 | <param name='prefix' doc='Set the item name prefix' /> |
| 910 | </params> |
| 911 | </command> |
| 912 | <command id='level (global|peer|subscriber)'> |
| 913 | <params> |
| 914 | <param name='level' doc='Set the maximum group level' /> |
| 915 | <param name='global' doc='Report global groups only' /> |
| 916 | <param name='peer' doc='Report global and network peer related groups' /> |
| 917 | <param name='subscriber' doc='Report global, peer, and subscriber groups' /> |
| 918 | </params> |
| 919 | </command> |
| 920 | <command id='enable'> |
| 921 | <params> |
| 922 | <param name='enable' doc='Enable the reporter' /> |
| 923 | </params> |
| 924 | </command> |
| 925 | <command id='disable'> |
| 926 | <params> |
| 927 | <param name='disable' doc='Disable the reporter' /> |
| 928 | </params> |
| 929 | </command> |
| 930 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 931 | <node id='config-line'> |
| 932 | <name>config-line</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 933 | <command id='login'> |
| 934 | <params> |
| 935 | <param name='login' doc='Enable password checking' /> |
| 936 | </params> |
| 937 | </command> |
| 938 | <command id='no login'> |
| 939 | <params> |
| 940 | <param name='no' doc='Negate a command or set its defaults' /> |
| 941 | <param name='login' doc='Enable password checking' /> |
| 942 | </params> |
| 943 | </command> |
| 944 | <command id='bind A.B.C.D'> |
| 945 | <params> |
| 946 | <param name='bind' doc='Accept VTY telnet connections on local interface' /> |
| 947 | <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> |
| 948 | </params> |
| 949 | </command> |
| 950 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 951 | <node id='config-ctrl'> |
| 952 | <name>config-ctrl</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 953 | <command id='bind A.B.C.D'> |
| 954 | <params> |
| 955 | <param name='bind' doc='Set bind address to listen for Control connections' /> |
| 956 | <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' /> |
| 957 | </params> |
| 958 | </command> |
| 959 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 960 | <node id='config-ggsn'> |
| 961 | <name>config-ggsn</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 962 | <command id='description .TEXT'> |
| 963 | <params> |
| 964 | <param name='description' doc='Save human-readable description of the object' /> |
| 965 | <param name='.TEXT' doc='Text until the end of the line' /> |
| 966 | </params> |
| 967 | </command> |
| 968 | <command id='no description'> |
| 969 | <params> |
| 970 | <param name='no' doc='Negate a command or set its defaults' /> |
| 971 | <param name='description' doc='Remove description of the object' /> |
| 972 | </params> |
| 973 | </command> |
| 974 | <command id='shutdown ggsn'> |
| 975 | <params> |
| 976 | <param name='shutdown' doc='Put the GGSN in administrative shut-down' /> |
| 977 | <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> |
| 978 | </params> |
| 979 | </command> |
| 980 | <command id='no shutdown ggsn'> |
| 981 | <params> |
| 982 | <param name='no' doc='Negate a command or set its defaults' /> |
| 983 | <param name='shutdown' doc='Gateway GPRS Support NODE (GGSN)' /> |
| 984 | <param name='ggsn' doc='Remove the GGSN from administrative shut-down' /> |
| 985 | </params> |
| 986 | </command> |
| 987 | <command id='gtp bind-ip A.B.C.D'> |
| 988 | <params> |
| 989 | <param name='gtp' doc='GTP Parameters' /> |
| 990 | <param name='bind-ip' doc='Set the IP address for the local GTP bind' /> |
| 991 | <param name='A.B.C.D' doc='IPv4 Address' /> |
| 992 | </params> |
| 993 | </command> |
| 994 | <command id='gtp control-ip A.B.C.D'> |
| 995 | <params> |
| 996 | <param name='gtp' doc='GTP Parameters' /> |
| 997 | <param name='control-ip' doc='Set the IP address states as local IP in GTP-C messages' /> |
| 998 | <param name='A.B.C.D' doc='IPv4 Address' /> |
| 999 | </params> |
| 1000 | </command> |
| 1001 | <command id='gtp user-ip A.B.C.D'> |
| 1002 | <params> |
| 1003 | <param name='gtp' doc='GTP Parameters' /> |
| 1004 | <param name='user-ip' doc='Set the IP address states as local IP in GTP-U messages' /> |
| 1005 | <param name='A.B.C.D' doc='IPv4 Address' /> |
| 1006 | </params> |
| 1007 | </command> |
| 1008 | <command id='gtp state-dir PATH'> |
| 1009 | <params> |
| 1010 | <param name='gtp' doc='GTP Parameters' /> |
| 1011 | <param name='state-dir' doc='Set the directory for the GTP State file' /> |
| 1012 | <param name='PATH' doc='Local Directory' /> |
| 1013 | </params> |
| 1014 | </command> |
| 1015 | <command id='apn NAME'> |
| 1016 | <params> |
| 1017 | <param name='apn' doc='APN Configuration' /> |
| 1018 | <param name='NAME' doc='APN Name' /> |
| 1019 | </params> |
| 1020 | </command> |
| 1021 | <command id='no apn NAME'> |
| 1022 | <params> |
| 1023 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1024 | <param name='apn' doc='Remove APN Configuration' /> |
| 1025 | <param name='NAME' doc='APN Name' /> |
| 1026 | </params> |
| 1027 | </command> |
| 1028 | <command id='default-apn NAME'> |
| 1029 | <params> |
| 1030 | <param name='default-apn' doc='Set a default-APN to be used if no other APN matches' /> |
| 1031 | <param name='NAME' doc='APN Name' /> |
| 1032 | </params> |
| 1033 | </command> |
| 1034 | <command id='no default-apn'> |
| 1035 | <params> |
| 1036 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1037 | <param name='default-apn' doc='Remove default-APN to be used if no other APN matches' /> |
| 1038 | </params> |
| 1039 | </command> |
| 1040 | </node> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 1041 | <node id='config-ggsn-apn'> |
| 1042 | <name>config-ggsn-apn</name> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 1043 | <command id='description .TEXT'> |
| 1044 | <params> |
| 1045 | <param name='description' doc='Save human-readable description of the object' /> |
| 1046 | <param name='.TEXT' doc='Text until the end of the line' /> |
| 1047 | </params> |
| 1048 | </command> |
| 1049 | <command id='no description'> |
| 1050 | <params> |
| 1051 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1052 | <param name='description' doc='Remove description of the object' /> |
| 1053 | </params> |
| 1054 | </command> |
| 1055 | <command id='shutdown'> |
| 1056 | <params> |
| 1057 | <param name='shutdown' doc='Put the APN in administrative shut-down' /> |
| 1058 | </params> |
| 1059 | </command> |
| 1060 | <command id='no shutdown'> |
| 1061 | <params> |
| 1062 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1063 | <param name='shutdown' doc='Remove the APN from administrative shut-down' /> |
| 1064 | </params> |
| 1065 | </command> |
| 1066 | <command id='gtpu-mode (tun|kernel-gtp)'> |
| 1067 | <params> |
| 1068 | <param name='gtpu-mode' doc='Set the Mode for this APN (tun or Linux Kernel GTP)' /> |
| 1069 | <param name='tun' doc='GTP-U in userspace using TUN device' /> |
| 1070 | <param name='kernel-gtp' doc='GTP-U in kernel using Linux Kernel GTP' /> |
| 1071 | </params> |
| 1072 | </command> |
| 1073 | <command id='type-support (v4|v6|v4v6)'> |
| 1074 | <params> |
| 1075 | <param name='type-support' doc='Enable support for PDP Type' /> |
| 1076 | <param name='v4' doc='IPv4(-only) PDP Type' /> |
| 1077 | <param name='v6' doc='IPv6(-only) PDP Type' /> |
| 1078 | <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' /> |
| 1079 | </params> |
| 1080 | </command> |
| 1081 | <command id='no type-support (v4|v6|v4v6)'> |
| 1082 | <params> |
| 1083 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1084 | <param name='type-support' doc='Disable support for PDP Type' /> |
| 1085 | <param name='v4' doc='IPv4(-only) PDP Type' /> |
| 1086 | <param name='v6' doc='IPv6(-only) PDP Type' /> |
| 1087 | <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' /> |
| 1088 | </params> |
| 1089 | </command> |
| 1090 | <command id='tun-device NAME'> |
| 1091 | <params> |
| 1092 | <param name='tun-device' doc='Configure tun device name' /> |
| 1093 | <param name='NAME' doc='TUN device name' /> |
| 1094 | </params> |
| 1095 | </command> |
| 1096 | <command id='ipup-script PATH'> |
| 1097 | <params> |
| 1098 | <param name='ipup-script' doc='Configure name/path of ip-up script' /> |
| 1099 | <param name='PATH' doc='File/Path name of ip-up script' /> |
| 1100 | </params> |
| 1101 | </command> |
| 1102 | <command id='no ipup-script'> |
| 1103 | <params> |
| 1104 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1105 | <param name='ipup-script' doc='Disable ip-up script' /> |
| 1106 | </params> |
| 1107 | </command> |
| 1108 | <command id='ipdown-script PATH'> |
| 1109 | <params> |
| 1110 | <param name='ipdown-script' doc='Configure name/path of ip-down script' /> |
| 1111 | <param name='PATH' doc='File/Path name of ip-down script' /> |
| 1112 | </params> |
| 1113 | </command> |
| 1114 | <command id='no ipdown-script'> |
| 1115 | <params> |
| 1116 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1117 | <param name='ipdown-script' doc='Disable ip-down script' /> |
| 1118 | </params> |
| 1119 | </command> |
| 1120 | <command id='ip prefix (static|dynamic) A.B.C.D/M'> |
| 1121 | <params> |
| 1122 | <param name='ip' doc='IP information' /> |
| 1123 | <param name='prefix' doc='Prefix (Network/Netmask)' /> |
| 1124 | <param name='static' doc='IPv4 Adress/Prefix-Length' /> |
| 1125 | <param name='dynamic' doc='(null)' /> |
| 1126 | <param name='A.B.C.D/M' doc='(null)' /> |
| 1127 | </params> |
| 1128 | </command> |
| 1129 | <command id='ipv6 prefix (static|dynamic) X:X::X:X/M'> |
| 1130 | <params> |
| 1131 | <param name='ipv6' doc='IPv6 Information' /> |
| 1132 | <param name='prefix' doc='Prefix (Network/Netmask)' /> |
| 1133 | <param name='static' doc='IPv6 Address/Prefix-Length' /> |
| 1134 | <param name='dynamic' doc='(null)' /> |
| 1135 | <param name='X:X::X:X/M' doc='(null)' /> |
| 1136 | </params> |
| 1137 | </command> |
| 1138 | <command id='ip dns <0-1> A.B.C.D'> |
| 1139 | <params> |
| 1140 | <param name='ip' doc='IP information' /> |
| 1141 | <param name='dns' doc='Configure DNS Server' /> |
| 1142 | <param name='<0-1>' doc='primary/secondary DNS' /> |
| 1143 | <param name='A.B.C.D' doc='IP address of DNS Sever' /> |
| 1144 | </params> |
| 1145 | </command> |
| 1146 | <command id='ipv6 dns <0-1> X:X::X:X'> |
| 1147 | <params> |
| 1148 | <param name='ipv6' doc='IPv6 Information' /> |
| 1149 | <param name='dns' doc='Configure DNS Server' /> |
| 1150 | <param name='<0-1>' doc='primary/secondary DNS' /> |
| 1151 | <param name='X:X::X:X' doc='IP address of DNS Sever' /> |
| 1152 | </params> |
| 1153 | </command> |
| 1154 | <command id='no (ip|ipv6) dns <0-1>'> |
| 1155 | <params> |
| 1156 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1157 | <param name='ip' doc='IP information' /> |
| 1158 | <param name='ipv6' doc='IPv6 Information' /> |
| 1159 | <param name='dns' doc='Disable DNS Server' /> |
| 1160 | <param name='<0-1>' doc='primary/secondary DNS' /> |
| 1161 | </params> |
| 1162 | </command> |
| 1163 | <command id='ip ifconfig A.B.C.D/M'> |
| 1164 | <params> |
| 1165 | <param name='ip' doc='IP information' /> |
| 1166 | <param name='ifconfig' doc='GGSN-based interface configuration' /> |
| 1167 | <param name='A.B.C.D/M' doc='IPv4 Adress/Prefix-Length' /> |
| 1168 | </params> |
| 1169 | </command> |
| 1170 | <command id='no ip ifconfig'> |
| 1171 | <params> |
| 1172 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1173 | <param name='ip' doc='IP information' /> |
| 1174 | <param name='ifconfig' doc='GGSN-based interface configuration' /> |
| 1175 | </params> |
| 1176 | </command> |
| 1177 | <command id='ipv6 ifconfig X:X::X:X/M'> |
| 1178 | <params> |
| 1179 | <param name='ipv6' doc='IPv6 Information' /> |
| 1180 | <param name='ifconfig' doc='GGSN-based interface configuration' /> |
| 1181 | <param name='X:X::X:X/M' doc='IPv6 Adress/Prefix-Length' /> |
| 1182 | </params> |
| 1183 | </command> |
| 1184 | <command id='no ipv6 ifconfig'> |
| 1185 | <params> |
| 1186 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1187 | <param name='ipv6' doc='IPv6 Information' /> |
| 1188 | <param name='ifconfig' doc='GGSN-based interface configuration' /> |
| 1189 | </params> |
| 1190 | </command> |
Neels Hofmeyr | e010dea | 2017-12-09 03:26:01 +0100 | [diff] [blame^] | 1191 | <command id='g-pdu tx-sequence-numbers'> |
| 1192 | <params> |
| 1193 | <param name='g-pdu' doc='G-PDU Configuration' /> |
| 1194 | <param name='tx-sequence-numbers' doc='Enable transmission of G-PDU sequence numbers' /> |
| 1195 | </params> |
| 1196 | </command> |
| 1197 | <command id='no g-pdu tx-sequence-numbers'> |
| 1198 | <params> |
| 1199 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1200 | <param name='g-pdu' doc='G-PDU Configuration' /> |
| 1201 | <param name='tx-sequence-numbers' doc='Disable transmission of G-PDU sequence numbers' /> |
| 1202 | </params> |
| 1203 | </command> |
Neels Hofmeyr | f453044 | 2017-12-09 03:22:34 +0100 | [diff] [blame] | 1204 | </node> |
| 1205 | </vtydoc> |