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