| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [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'> |
| 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> |
| 54 | </node> |
| 55 | <node id='view'> |
| 56 | <name>view</name> |
| 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> |
| 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='who'> |
| 89 | <params> |
| 90 | <param name='who' doc='Display who is on vty' /> |
| 91 | </params> |
| 92 | </command> |
| 93 | <command id='show history'> |
| 94 | <params> |
| 95 | <param name='show' doc='Show running system information' /> |
| 96 | <param name='history' doc='Display the session command history' /> |
| 97 | </params> |
| 98 | </command> |
| 99 | <command id='logging enable'> |
| 100 | <params> |
| 101 | <param name='logging' doc='Configure logging' /> |
| 102 | <param name='enable' doc='Enables logging to this vty' /> |
| 103 | </params> |
| 104 | </command> |
| 105 | <command id='logging disable'> |
| 106 | <params> |
| 107 | <param name='logging' doc='Configure logging' /> |
| 108 | <param name='disable' doc='Disables logging to this vty' /> |
| 109 | </params> |
| 110 | </command> |
| 111 | <command id='logging filter all (0|1)'> |
| 112 | <params> |
| 113 | <param name='logging' doc='Configure logging' /> |
| 114 | <param name='filter' doc='Filter log messages' /> |
| 115 | <param name='all' doc='Do you want to log all messages?' /> |
| 116 | <param name='0' doc='Only print messages matched by other filters' /> |
| 117 | <param name='1' doc='Bypass filter and print all messages' /> |
| 118 | </params> |
| 119 | </command> |
| 120 | <command id='logging color (0|1)'> |
| 121 | <params> |
| 122 | <param name='logging' doc='Configure logging' /> |
| 123 | <param name='color' doc='Configure color-printing for log messages' /> |
| 124 | <param name='0' doc='Don't use color for printing messages' /> |
| 125 | <param name='1' doc='Use color for printing messages' /> |
| 126 | </params> |
| 127 | </command> |
| 128 | <command id='logging timestamp (0|1)'> |
| 129 | <params> |
| 130 | <param name='logging' doc='Configure logging' /> |
| 131 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 132 | <param name='0' doc='Don't prefix each log message' /> |
| 133 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 134 | </params> |
| 135 | </command> |
| 136 | <command id='logging print extended-timestamp (0|1)'> |
| 137 | <params> |
| 138 | <param name='logging' doc='Configure logging' /> |
| 139 | <param name='print' doc='Log output settings' /> |
| 140 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 141 | <param name='0' doc='Don't prefix each log message' /> |
| 142 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 143 | </params> |
| 144 | </command> |
| 145 | <command id='logging print category (0|1)'> |
| 146 | <params> |
| 147 | <param name='logging' doc='Configure logging' /> |
| 148 | <param name='print' doc='Log output settings' /> |
| 149 | <param name='category' doc='Configure log message' /> |
| 150 | <param name='0' doc='Don't prefix each log message' /> |
| 151 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 152 | </params> |
| 153 | </command> |
| 154 | <command id='logging print category-hex (0|1)'> |
| 155 | <params> |
| 156 | <param name='logging' doc='Configure logging' /> |
| 157 | <param name='print' doc='Log output settings' /> |
| 158 | <param name='category-hex' doc='Configure log message' /> |
| 159 | <param name='0' doc='Don't prefix each log message' /> |
| 160 | <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> |
| 161 | </params> |
| 162 | </command> |
| 163 | <command id='logging print level (0|1)'> |
| 164 | <params> |
| 165 | <param name='logging' doc='Configure logging' /> |
| 166 | <param name='print' doc='Log output settings' /> |
| 167 | <param name='level' doc='Configure log message' /> |
| 168 | <param name='0' doc='Don't prefix each log message' /> |
| 169 | <param name='1' doc='Prefix each log message with the log level name' /> |
| 170 | </params> |
| 171 | </command> |
| 172 | <command id='logging print file (0|1|basename) [last]'> |
| 173 | <params> |
| 174 | <param name='logging' doc='Configure logging' /> |
| 175 | <param name='print' doc='Log output settings' /> |
| 176 | <param name='file' doc='Configure log message' /> |
| 177 | <param name='0' doc='Don't prefix each log message' /> |
| 178 | <param name='1' doc='Prefix each log message with the source file and line' /> |
| 179 | <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> |
| 180 | <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> |
| 181 | </params> |
| 182 | </command> |
| 183 | <command id='logging set-log-mask MASK'> |
| 184 | <params> |
| 185 | <param name='logging' doc='Configure logging' /> |
| 186 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
| 187 | <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' /> |
| 188 | </params> |
| 189 | </command> |
| 190 | <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> |
| 191 | <params> |
| 192 | <param name='logging' doc='Configure logging' /> |
| 193 | <param name='level' doc='Set the log level for a specified category' /> |
| 194 | <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' /> |
| 195 | <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' /> |
| 196 | <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' /> |
| 197 | <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' /> |
| 198 | <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' /> |
| 199 | <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' /> |
| 200 | <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' /> |
| 201 | <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' /> |
| 202 | <param name='tbf' doc='Temporary Block Flow (TBF)' /> |
| 203 | <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' /> |
| 204 | <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' /> |
| 205 | <param name='ns' doc='GPRS Network Service Protocol (NS)' /> |
| 206 | <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> |
| 207 | <param name='pcu' doc='GPRS Packet Control Unit (PCU)' /> |
| 208 | <param name='lglobal' doc='Library-internal global log family' /> |
| 209 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 210 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 211 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 212 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 213 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 214 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 215 | <param name='lctrl' doc='Control Interface' /> |
| 216 | <param name='lgtp' doc='GPRS GTP library' /> |
| 217 | <param name='lstats' doc='Statistics messages and logging' /> |
| 218 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 219 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 220 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 221 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 222 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 223 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 224 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 225 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 226 | <param name='lrspro' doc='Remote SIM protocol' /> |
| 227 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 228 | <param name='info' doc='Log informational messages and higher levels' /> |
| 229 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 230 | <param name='error' doc='Log error messages and higher levels' /> |
| 231 | <param name='fatal' doc='Log only fatal messages' /> |
| 232 | </params> |
| 233 | </command> |
| 234 | <command id='logging level set-all (debug|info|notice|error|fatal)'> |
| 235 | <params> |
| 236 | <param name='logging' doc='Configure logging' /> |
| 237 | <param name='level' doc='Set the log level for a specified category' /> |
| 238 | <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.' /> |
| 239 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 240 | <param name='info' doc='Log informational messages and higher levels' /> |
| 241 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 242 | <param name='error' doc='Log error messages and higher levels' /> |
| 243 | <param name='fatal' doc='Log only fatal messages' /> |
| 244 | </params> |
| 245 | </command> |
| 246 | <command id='logging level force-all (debug|info|notice|error|fatal)'> |
| 247 | <params> |
| 248 | <param name='logging' doc='Configure logging' /> |
| 249 | <param name='level' doc='Set the log level for a specified category' /> |
| 250 | <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.' /> |
| 251 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 252 | <param name='info' doc='Log informational messages and higher levels' /> |
| 253 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 254 | <param name='error' doc='Log error messages and higher levels' /> |
| 255 | <param name='fatal' doc='Log only fatal messages' /> |
| 256 | </params> |
| 257 | </command> |
| 258 | <command id='no logging level force-all'> |
| 259 | <params> |
| 260 | <param name='no' doc='Negate a command or set its defaults' /> |
| 261 | <param name='logging' doc='Configure logging' /> |
| 262 | <param name='level' doc='Set the log level for a specified category' /> |
| 263 | <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> |
| 264 | </params> |
| 265 | </command> |
| Oliver Smith | 37ae22a | 2019-09-05 15:35:43 +0200 | [diff] [blame] | 266 | <command id='logp (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|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'> |
| 267 | <params> |
| 268 | <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> |
| 269 | <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' /> |
| 270 | <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' /> |
| 271 | <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' /> |
| 272 | <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' /> |
| 273 | <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' /> |
| 274 | <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' /> |
| 275 | <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' /> |
| 276 | <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' /> |
| 277 | <param name='tbf' doc='Temporary Block Flow (TBF)' /> |
| 278 | <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' /> |
| 279 | <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' /> |
| 280 | <param name='ns' doc='GPRS Network Service Protocol (NS)' /> |
| 281 | <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> |
| 282 | <param name='pcu' doc='GPRS Packet Control Unit (PCU)' /> |
| 283 | <param name='lglobal' doc='Library-internal global log family' /> |
| 284 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 285 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 286 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 287 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 288 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 289 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 290 | <param name='lctrl' doc='Control Interface' /> |
| 291 | <param name='lgtp' doc='GPRS GTP library' /> |
| 292 | <param name='lstats' doc='Statistics messages and logging' /> |
| 293 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 294 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 295 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 296 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 297 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 298 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 299 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 300 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 301 | <param name='lrspro' doc='Remote SIM protocol' /> |
| 302 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 303 | <param name='info' doc='Log informational messages and higher levels' /> |
| 304 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 305 | <param name='error' doc='Log error messages and higher levels' /> |
| 306 | <param name='fatal' doc='Log only fatal messages' /> |
| 307 | <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' /> |
| 308 | </params> |
| 309 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 310 | <command id='show logging vty'> |
| 311 | <params> |
| 312 | <param name='show' doc='Show running system information' /> |
| 313 | <param name='logging' doc='Show current logging configuration' /> |
| 314 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 315 | </params> |
| 316 | </command> |
| 317 | <command id='show alarms'> |
| 318 | <params> |
| 319 | <param name='show' doc='Show running system information' /> |
| 320 | <param name='alarms' doc='Show current logging configuration' /> |
| 321 | </params> |
| 322 | </command> |
| 323 | <command id='show stats'> |
| 324 | <params> |
| 325 | <param name='show' doc='Show running system information' /> |
| 326 | <param name='stats' doc='Show statistical values' /> |
| 327 | </params> |
| 328 | </command> |
| 329 | <command id='show stats level (global|peer|subscriber)'> |
| 330 | <params> |
| 331 | <param name='show' doc='Show running system information' /> |
| 332 | <param name='stats' doc='Show statistical values' /> |
| 333 | <param name='level' doc='Set the maximum group level' /> |
| 334 | <param name='global' doc='Show global groups only' /> |
| 335 | <param name='peer' doc='Show global and network peer related groups' /> |
| 336 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 337 | </params> |
| 338 | </command> |
| 339 | <command id='show asciidoc counters'> |
| 340 | <params> |
| 341 | <param name='show' doc='Show running system information' /> |
| 342 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 343 | <param name='counters' doc='Generate table of all registered counters' /> |
| 344 | </params> |
| 345 | </command> |
| 346 | <command id='show rate-counters'> |
| 347 | <params> |
| 348 | <param name='show' doc='Show running system information' /> |
| 349 | <param name='rate-counters' doc='Show all rate counters' /> |
| 350 | </params> |
| 351 | </command> |
| 352 | <command id='show bts statistics'> |
| 353 | <params> |
| 354 | <param name='show' doc='Show running system information' /> |
| 355 | <param name='bts' doc='BTS related functionality' /> |
| 356 | <param name='statistics' doc='Statistics' /> |
| 357 | </params> |
| 358 | </command> |
| 359 | <command id='show tbf (all|ccch|pacch)'> |
| 360 | <params> |
| 361 | <param name='show' doc='Show running system information' /> |
| 362 | <param name='tbf' doc='information about TBFs' /> |
| 363 | <param name='all' doc='All TBFs' /> |
| 364 | <param name='ccch' doc='TBFs allocated via CCCH' /> |
| 365 | <param name='pacch' doc='TBFs allocated via PACCH' /> |
| 366 | </params> |
| 367 | </command> |
| 368 | <command id='show ms all'> |
| 369 | <params> |
| 370 | <param name='show' doc='Show running system information' /> |
| 371 | <param name='ms' doc='information about MSs' /> |
| 372 | <param name='all' doc='All TBFs' /> |
| 373 | </params> |
| 374 | </command> |
| 375 | <command id='show ms tlli TLLI'> |
| 376 | <params> |
| 377 | <param name='show' doc='Show running system information' /> |
| 378 | <param name='ms' doc='information about MSs' /> |
| 379 | <param name='tlli' doc='Select MS by TLLI' /> |
| 380 | <param name='TLLI' doc='TLLI as hex' /> |
| 381 | </params> |
| 382 | </command> |
| 383 | <command id='show ms imsi IMSI'> |
| 384 | <params> |
| 385 | <param name='show' doc='Show running system information' /> |
| 386 | <param name='ms' doc='information about MSs' /> |
| 387 | <param name='imsi' doc='Select MS by IMSI' /> |
| 388 | <param name='IMSI' doc='IMSI' /> |
| 389 | </params> |
| 390 | </command> |
| Pau Espin Pedrol | 28f160e | 2019-09-05 14:48:35 +0200 | [diff] [blame] | 391 | <command id='show bts-timer [TNNNN]'> |
| 392 | <params> |
| 393 | <param name='show' doc='Show running system information' /> |
| 394 | <param name='bts-timer' doc='Show BTS controlled timers' /> |
| 395 | <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> |
| 396 | </params> |
| 397 | </command> |
| 398 | <command id='show timer [TNNNN]'> |
| 399 | <params> |
| 400 | <param name='show' doc='Show running system information' /> |
| 401 | <param name='timer' doc='Show PCU timers' /> |
| 402 | <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> |
| 403 | </params> |
| 404 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 405 | <command id='show ns'> |
| 406 | <params> |
| 407 | <param name='show' doc='Show running system information' /> |
| 408 | <param name='ns' doc='Display information about the NS protocol' /> |
| 409 | </params> |
| 410 | </command> |
| 411 | <command id='show ns stats'> |
| 412 | <params> |
| 413 | <param name='show' doc='Show running system information' /> |
| 414 | <param name='ns' doc='Display information about the NS protocol' /> |
| 415 | <param name='stats' doc='Include statistics' /> |
| 416 | </params> |
| 417 | </command> |
| 418 | <command id='show ns persistent'> |
| 419 | <params> |
| 420 | <param name='show' doc='Show running system information' /> |
| 421 | <param name='ns' doc='Display information about the NS protocol' /> |
| 422 | <param name='persistent' doc='Show only persistent NS' /> |
| 423 | </params> |
| 424 | </command> |
| 425 | <command id='show ns (nsei|nsvc) <0-65535> [stats]'> |
| 426 | <params> |
| 427 | <param name='show' doc='Show running system information' /> |
| 428 | <param name='ns' doc='Display information about the NS protocol' /> |
| 429 | <param name='nsei' doc='Select one NSE by its NSE Identifier' /> |
| 430 | <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> |
| 431 | <param name='<0-65535>' doc='The Identifier of selected type' /> |
| 432 | <param name='[stats]' doc='Include Statistics' /> |
| 433 | </params> |
| 434 | </command> |
| 435 | <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> |
| 436 | <params> |
| 437 | <param name='logging' doc='Configure logging' /> |
| 438 | <param name='filter' doc='Filter log messages' /> |
| 439 | <param name='nsvc' doc='Filter based on NS Virtual Connection' /> |
| 440 | <param name='nsei' doc='Identify NS-VC by NSEI' /> |
| 441 | <param name='nsvci' doc='Identify NS-VC by NSVCI' /> |
| 442 | <param name='<0-65535>' doc='Numeric identifier' /> |
| 443 | </params> |
| 444 | </command> |
| 445 | </node> |
| 446 | <node id='enable'> |
| 447 | <name>enable</name> |
| 448 | <command id='disable'> |
| 449 | <params> |
| 450 | <param name='disable' doc='Turn off privileged mode command' /> |
| 451 | </params> |
| 452 | </command> |
| 453 | <command id='configure terminal'> |
| 454 | <params> |
| 455 | <param name='configure' doc='Configuration from vty interface' /> |
| 456 | <param name='terminal' doc='Configuration terminal' /> |
| 457 | </params> |
| 458 | </command> |
| 459 | <command id='copy running-config startup-config'> |
| 460 | <params> |
| 461 | <param name='copy' doc='Copy configuration' /> |
| 462 | <param name='running-config' doc='Copy running config to... ' /> |
| 463 | <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> |
| 464 | </params> |
| 465 | </command> |
| 466 | <command id='show startup-config'> |
| 467 | <params> |
| 468 | <param name='show' doc='Show running system information' /> |
| 469 | <param name='startup-config' doc='Contentes of startup configuration' /> |
| 470 | </params> |
| 471 | </command> |
| 472 | <command id='show version'> |
| 473 | <params> |
| 474 | <param name='show' doc='Show running system information' /> |
| 475 | <param name='version' doc='Displays program version' /> |
| 476 | </params> |
| 477 | </command> |
| 478 | <command id='show online-help'> |
| 479 | <params> |
| 480 | <param name='show' doc='Show running system information' /> |
| 481 | <param name='online-help' doc='Online help' /> |
| 482 | </params> |
| 483 | </command> |
| 484 | <command id='terminal length <0-512>'> |
| 485 | <params> |
| 486 | <param name='terminal' doc='Set terminal line parameters' /> |
| 487 | <param name='length' doc='Set number of lines on a screen' /> |
| 488 | <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> |
| 489 | </params> |
| 490 | </command> |
| 491 | <command id='terminal no length'> |
| 492 | <params> |
| 493 | <param name='terminal' doc='Set terminal line parameters' /> |
| 494 | <param name='no' doc='Negate a command or set its defaults' /> |
| 495 | <param name='length' doc='Set number of lines on a screen' /> |
| 496 | </params> |
| 497 | </command> |
| 498 | <command id='who'> |
| 499 | <params> |
| 500 | <param name='who' doc='Display who is on vty' /> |
| 501 | </params> |
| 502 | </command> |
| 503 | <command id='show history'> |
| 504 | <params> |
| 505 | <param name='show' doc='Show running system information' /> |
| 506 | <param name='history' doc='Display the session command history' /> |
| 507 | </params> |
| 508 | </command> |
| 509 | <command id='terminal monitor'> |
| 510 | <params> |
| 511 | <param name='terminal' doc='Set terminal line parameters' /> |
| 512 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 513 | </params> |
| 514 | </command> |
| 515 | <command id='terminal no monitor'> |
| 516 | <params> |
| 517 | <param name='terminal' doc='Set terminal line parameters' /> |
| 518 | <param name='no' doc='Negate a command or set its defaults' /> |
| 519 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 520 | </params> |
| 521 | </command> |
| 522 | <command id='logging enable'> |
| 523 | <params> |
| 524 | <param name='logging' doc='Configure logging' /> |
| 525 | <param name='enable' doc='Enables logging to this vty' /> |
| 526 | </params> |
| 527 | </command> |
| 528 | <command id='logging disable'> |
| 529 | <params> |
| 530 | <param name='logging' doc='Configure logging' /> |
| 531 | <param name='disable' doc='Disables logging to this vty' /> |
| 532 | </params> |
| 533 | </command> |
| 534 | <command id='logging filter all (0|1)'> |
| 535 | <params> |
| 536 | <param name='logging' doc='Configure logging' /> |
| 537 | <param name='filter' doc='Filter log messages' /> |
| 538 | <param name='all' doc='Do you want to log all messages?' /> |
| 539 | <param name='0' doc='Only print messages matched by other filters' /> |
| 540 | <param name='1' doc='Bypass filter and print all messages' /> |
| 541 | </params> |
| 542 | </command> |
| 543 | <command id='logging color (0|1)'> |
| 544 | <params> |
| 545 | <param name='logging' doc='Configure logging' /> |
| 546 | <param name='color' doc='Configure color-printing for log messages' /> |
| 547 | <param name='0' doc='Don't use color for printing messages' /> |
| 548 | <param name='1' doc='Use color for printing messages' /> |
| 549 | </params> |
| 550 | </command> |
| 551 | <command id='logging timestamp (0|1)'> |
| 552 | <params> |
| 553 | <param name='logging' doc='Configure logging' /> |
| 554 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 555 | <param name='0' doc='Don't prefix each log message' /> |
| 556 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 557 | </params> |
| 558 | </command> |
| 559 | <command id='logging print extended-timestamp (0|1)'> |
| 560 | <params> |
| 561 | <param name='logging' doc='Configure logging' /> |
| 562 | <param name='print' doc='Log output settings' /> |
| 563 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 564 | <param name='0' doc='Don't prefix each log message' /> |
| 565 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 566 | </params> |
| 567 | </command> |
| 568 | <command id='logging print category (0|1)'> |
| 569 | <params> |
| 570 | <param name='logging' doc='Configure logging' /> |
| 571 | <param name='print' doc='Log output settings' /> |
| 572 | <param name='category' doc='Configure log message' /> |
| 573 | <param name='0' doc='Don't prefix each log message' /> |
| 574 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 575 | </params> |
| 576 | </command> |
| 577 | <command id='logging print category-hex (0|1)'> |
| 578 | <params> |
| 579 | <param name='logging' doc='Configure logging' /> |
| 580 | <param name='print' doc='Log output settings' /> |
| 581 | <param name='category-hex' doc='Configure log message' /> |
| 582 | <param name='0' doc='Don't prefix each log message' /> |
| 583 | <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> |
| 584 | </params> |
| 585 | </command> |
| 586 | <command id='logging print level (0|1)'> |
| 587 | <params> |
| 588 | <param name='logging' doc='Configure logging' /> |
| 589 | <param name='print' doc='Log output settings' /> |
| 590 | <param name='level' doc='Configure log message' /> |
| 591 | <param name='0' doc='Don't prefix each log message' /> |
| 592 | <param name='1' doc='Prefix each log message with the log level name' /> |
| 593 | </params> |
| 594 | </command> |
| 595 | <command id='logging print file (0|1|basename) [last]'> |
| 596 | <params> |
| 597 | <param name='logging' doc='Configure logging' /> |
| 598 | <param name='print' doc='Log output settings' /> |
| 599 | <param name='file' doc='Configure log message' /> |
| 600 | <param name='0' doc='Don't prefix each log message' /> |
| 601 | <param name='1' doc='Prefix each log message with the source file and line' /> |
| 602 | <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> |
| 603 | <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.' /> |
| 604 | </params> |
| 605 | </command> |
| 606 | <command id='logging set-log-mask MASK'> |
| 607 | <params> |
| 608 | <param name='logging' doc='Configure logging' /> |
| 609 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
| 610 | <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' /> |
| 611 | </params> |
| 612 | </command> |
| 613 | <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> |
| 614 | <params> |
| 615 | <param name='logging' doc='Configure logging' /> |
| 616 | <param name='level' doc='Set the log level for a specified category' /> |
| 617 | <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' /> |
| 618 | <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' /> |
| 619 | <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' /> |
| 620 | <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' /> |
| 621 | <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' /> |
| 622 | <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' /> |
| 623 | <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' /> |
| 624 | <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' /> |
| 625 | <param name='tbf' doc='Temporary Block Flow (TBF)' /> |
| 626 | <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' /> |
| 627 | <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' /> |
| 628 | <param name='ns' doc='GPRS Network Service Protocol (NS)' /> |
| 629 | <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> |
| 630 | <param name='pcu' doc='GPRS Packet Control Unit (PCU)' /> |
| 631 | <param name='lglobal' doc='Library-internal global log family' /> |
| 632 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 633 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 634 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 635 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 636 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 637 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 638 | <param name='lctrl' doc='Control Interface' /> |
| 639 | <param name='lgtp' doc='GPRS GTP library' /> |
| 640 | <param name='lstats' doc='Statistics messages and logging' /> |
| 641 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 642 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 643 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 644 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 645 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 646 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 647 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 648 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 649 | <param name='lrspro' doc='Remote SIM protocol' /> |
| 650 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 651 | <param name='info' doc='Log informational messages and higher levels' /> |
| 652 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 653 | <param name='error' doc='Log error messages and higher levels' /> |
| 654 | <param name='fatal' doc='Log only fatal messages' /> |
| 655 | </params> |
| 656 | </command> |
| 657 | <command id='logging level set-all (debug|info|notice|error|fatal)'> |
| 658 | <params> |
| 659 | <param name='logging' doc='Configure logging' /> |
| 660 | <param name='level' doc='Set the log level for a specified category' /> |
| 661 | <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.' /> |
| 662 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 663 | <param name='info' doc='Log informational messages and higher levels' /> |
| 664 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 665 | <param name='error' doc='Log error messages and higher levels' /> |
| 666 | <param name='fatal' doc='Log only fatal messages' /> |
| 667 | </params> |
| 668 | </command> |
| 669 | <command id='logging level force-all (debug|info|notice|error|fatal)'> |
| 670 | <params> |
| 671 | <param name='logging' doc='Configure logging' /> |
| 672 | <param name='level' doc='Set the log level for a specified category' /> |
| 673 | <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.' /> |
| 674 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 675 | <param name='info' doc='Log informational messages and higher levels' /> |
| 676 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 677 | <param name='error' doc='Log error messages and higher levels' /> |
| 678 | <param name='fatal' doc='Log only fatal messages' /> |
| 679 | </params> |
| 680 | </command> |
| 681 | <command id='no logging level force-all'> |
| 682 | <params> |
| 683 | <param name='no' doc='Negate a command or set its defaults' /> |
| 684 | <param name='logging' doc='Configure logging' /> |
| 685 | <param name='level' doc='Set the log level for a specified category' /> |
| 686 | <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> |
| 687 | </params> |
| 688 | </command> |
| Oliver Smith | 37ae22a | 2019-09-05 15:35:43 +0200 | [diff] [blame] | 689 | <command id='logp (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|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'> |
| 690 | <params> |
| 691 | <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> |
| 692 | <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' /> |
| 693 | <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' /> |
| 694 | <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' /> |
| 695 | <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' /> |
| 696 | <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' /> |
| 697 | <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' /> |
| 698 | <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' /> |
| 699 | <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' /> |
| 700 | <param name='tbf' doc='Temporary Block Flow (TBF)' /> |
| 701 | <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' /> |
| 702 | <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' /> |
| 703 | <param name='ns' doc='GPRS Network Service Protocol (NS)' /> |
| 704 | <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> |
| 705 | <param name='pcu' doc='GPRS Packet Control Unit (PCU)' /> |
| 706 | <param name='lglobal' doc='Library-internal global log family' /> |
| 707 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 708 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 709 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 710 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 711 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 712 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 713 | <param name='lctrl' doc='Control Interface' /> |
| 714 | <param name='lgtp' doc='GPRS GTP library' /> |
| 715 | <param name='lstats' doc='Statistics messages and logging' /> |
| 716 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 717 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 718 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 719 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 720 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 721 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 722 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 723 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 724 | <param name='lrspro' doc='Remote SIM protocol' /> |
| 725 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 726 | <param name='info' doc='Log informational messages and higher levels' /> |
| 727 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 728 | <param name='error' doc='Log error messages and higher levels' /> |
| 729 | <param name='fatal' doc='Log only fatal messages' /> |
| 730 | <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' /> |
| 731 | </params> |
| 732 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 733 | <command id='show logging vty'> |
| 734 | <params> |
| 735 | <param name='show' doc='Show running system information' /> |
| 736 | <param name='logging' doc='Show current logging configuration' /> |
| 737 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 738 | </params> |
| 739 | </command> |
| 740 | <command id='show alarms'> |
| 741 | <params> |
| 742 | <param name='show' doc='Show running system information' /> |
| 743 | <param name='alarms' doc='Show current logging configuration' /> |
| 744 | </params> |
| 745 | </command> |
| 746 | <command id='show stats'> |
| 747 | <params> |
| 748 | <param name='show' doc='Show running system information' /> |
| 749 | <param name='stats' doc='Show statistical values' /> |
| 750 | </params> |
| 751 | </command> |
| 752 | <command id='show stats level (global|peer|subscriber)'> |
| 753 | <params> |
| 754 | <param name='show' doc='Show running system information' /> |
| 755 | <param name='stats' doc='Show statistical values' /> |
| 756 | <param name='level' doc='Set the maximum group level' /> |
| 757 | <param name='global' doc='Show global groups only' /> |
| 758 | <param name='peer' doc='Show global and network peer related groups' /> |
| 759 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 760 | </params> |
| 761 | </command> |
| 762 | <command id='show asciidoc counters'> |
| 763 | <params> |
| 764 | <param name='show' doc='Show running system information' /> |
| 765 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 766 | <param name='counters' doc='Generate table of all registered counters' /> |
| 767 | </params> |
| 768 | </command> |
| 769 | <command id='show rate-counters'> |
| 770 | <params> |
| 771 | <param name='show' doc='Show running system information' /> |
| 772 | <param name='rate-counters' doc='Show all rate counters' /> |
| 773 | </params> |
| 774 | </command> |
| 775 | <command id='show bts statistics'> |
| 776 | <params> |
| 777 | <param name='show' doc='Show running system information' /> |
| 778 | <param name='bts' doc='BTS related functionality' /> |
| 779 | <param name='statistics' doc='Statistics' /> |
| 780 | </params> |
| 781 | </command> |
| 782 | <command id='show tbf (all|ccch|pacch)'> |
| 783 | <params> |
| 784 | <param name='show' doc='Show running system information' /> |
| 785 | <param name='tbf' doc='information about TBFs' /> |
| 786 | <param name='all' doc='All TBFs' /> |
| 787 | <param name='ccch' doc='TBFs allocated via CCCH' /> |
| 788 | <param name='pacch' doc='TBFs allocated via PACCH' /> |
| 789 | </params> |
| 790 | </command> |
| 791 | <command id='show ms all'> |
| 792 | <params> |
| 793 | <param name='show' doc='Show running system information' /> |
| 794 | <param name='ms' doc='information about MSs' /> |
| 795 | <param name='all' doc='All TBFs' /> |
| 796 | </params> |
| 797 | </command> |
| 798 | <command id='show ms tlli TLLI'> |
| 799 | <params> |
| 800 | <param name='show' doc='Show running system information' /> |
| 801 | <param name='ms' doc='information about MSs' /> |
| 802 | <param name='tlli' doc='Select MS by TLLI' /> |
| 803 | <param name='TLLI' doc='TLLI as hex' /> |
| 804 | </params> |
| 805 | </command> |
| 806 | <command id='show ms imsi IMSI'> |
| 807 | <params> |
| 808 | <param name='show' doc='Show running system information' /> |
| 809 | <param name='ms' doc='information about MSs' /> |
| 810 | <param name='imsi' doc='Select MS by IMSI' /> |
| 811 | <param name='IMSI' doc='IMSI' /> |
| 812 | </params> |
| 813 | </command> |
| Pau Espin Pedrol | 28f160e | 2019-09-05 14:48:35 +0200 | [diff] [blame] | 814 | <command id='show bts-timer [TNNNN]'> |
| 815 | <params> |
| 816 | <param name='show' doc='Show running system information' /> |
| 817 | <param name='bts-timer' doc='Show BTS controlled timers' /> |
| 818 | <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> |
| 819 | </params> |
| 820 | </command> |
| 821 | <command id='show timer [TNNNN]'> |
| 822 | <params> |
| 823 | <param name='show' doc='Show running system information' /> |
| 824 | <param name='timer' doc='Show PCU timers' /> |
| 825 | <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> |
| 826 | </params> |
| 827 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 828 | <command id='show ns'> |
| 829 | <params> |
| 830 | <param name='show' doc='Show running system information' /> |
| 831 | <param name='ns' doc='Display information about the NS protocol' /> |
| 832 | </params> |
| 833 | </command> |
| 834 | <command id='show ns stats'> |
| 835 | <params> |
| 836 | <param name='show' doc='Show running system information' /> |
| 837 | <param name='ns' doc='Display information about the NS protocol' /> |
| 838 | <param name='stats' doc='Include statistics' /> |
| 839 | </params> |
| 840 | </command> |
| 841 | <command id='show ns persistent'> |
| 842 | <params> |
| 843 | <param name='show' doc='Show running system information' /> |
| 844 | <param name='ns' doc='Display information about the NS protocol' /> |
| 845 | <param name='persistent' doc='Show only persistent NS' /> |
| 846 | </params> |
| 847 | </command> |
| 848 | <command id='show ns (nsei|nsvc) <0-65535> [stats]'> |
| 849 | <params> |
| 850 | <param name='show' doc='Show running system information' /> |
| 851 | <param name='ns' doc='Display information about the NS protocol' /> |
| 852 | <param name='nsei' doc='Select one NSE by its NSE Identifier' /> |
| 853 | <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> |
| 854 | <param name='<0-65535>' doc='The Identifier of selected type' /> |
| 855 | <param name='[stats]' doc='Include Statistics' /> |
| 856 | </params> |
| 857 | </command> |
| 858 | <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> |
| 859 | <params> |
| 860 | <param name='logging' doc='Configure logging' /> |
| 861 | <param name='filter' doc='Filter log messages' /> |
| 862 | <param name='nsvc' doc='Filter based on NS Virtual Connection' /> |
| 863 | <param name='nsei' doc='Identify NS-VC by NSEI' /> |
| 864 | <param name='nsvci' doc='Identify NS-VC by NSVCI' /> |
| 865 | <param name='<0-65535>' doc='Numeric identifier' /> |
| 866 | </params> |
| 867 | </command> |
| 868 | <command id='nsvc (nsei|nsvci) <0-65535> (block|unblock|reset)'> |
| 869 | <params> |
| 870 | <param name='nsvc' doc='Perform an operation on a NSVC' /> |
| 871 | <param name='nsei' doc='NSEI to identify NS-VC Identifier (NS-VCI)' /> |
| 872 | <param name='nsvci' doc='NS-VC Identifier (NS-VCI)' /> |
| 873 | <param name='<0-65535>' doc='The NSEI' /> |
| 874 | <param name='block' doc='Initiate BLOCK procedure' /> |
| 875 | <param name='unblock' doc='Initiate UNBLOCK procedure' /> |
| 876 | <param name='reset' doc='Initiate RESET procedure' /> |
| 877 | </params> |
| 878 | </command> |
| 879 | </node> |
| 880 | <node id='config'> |
| 881 | <name>config</name> |
| 882 | <command id='hostname WORD'> |
| 883 | <params> |
| 884 | <param name='hostname' doc='Set system's network name' /> |
| 885 | <param name='WORD' doc='This system's network name' /> |
| 886 | </params> |
| 887 | </command> |
| 888 | <command id='no hostname [HOSTNAME]'> |
| 889 | <params> |
| 890 | <param name='no' doc='Negate a command or set its defaults' /> |
| 891 | <param name='hostname' doc='Reset system's network name' /> |
| 892 | <param name='[HOSTNAME]' doc='Host name of this router' /> |
| 893 | </params> |
| 894 | </command> |
| 895 | <command id='password (8|) WORD'> |
| 896 | <params> |
| 897 | <param name='password' doc='Assign the terminal connection password' /> |
| 898 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 899 | <param name='' doc='dummy string ' /> |
| 900 | <param name='WORD' doc='The HIDDEN line password string' /> |
| 901 | </params> |
| 902 | </command> |
| 903 | <command id='password LINE'> |
| 904 | <params> |
| 905 | <param name='password' doc='Assign the terminal connection password' /> |
| 906 | <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> |
| 907 | </params> |
| 908 | </command> |
| 909 | <command id='enable password (8|) WORD'> |
| 910 | <params> |
| 911 | <param name='enable' doc='Modify enable password parameters' /> |
| 912 | <param name='password' doc='Assign the privileged level password' /> |
| 913 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 914 | <param name='' doc='dummy string ' /> |
| 915 | <param name='WORD' doc='The HIDDEN 'enable' password string' /> |
| 916 | </params> |
| 917 | </command> |
| 918 | <command id='enable password LINE'> |
| 919 | <params> |
| 920 | <param name='enable' doc='Modify enable password parameters' /> |
| 921 | <param name='password' doc='Assign the privileged level password' /> |
| 922 | <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> |
| 923 | </params> |
| 924 | </command> |
| 925 | <command id='no enable password'> |
| 926 | <params> |
| 927 | <param name='no' doc='Negate a command or set its defaults' /> |
| 928 | <param name='enable' doc='Modify enable password parameters' /> |
| 929 | <param name='password' doc='Assign the privileged level password' /> |
| 930 | </params> |
| 931 | </command> |
| 932 | <command id='banner motd default'> |
| 933 | <params> |
| 934 | <param name='banner' doc='Set banner string' /> |
| 935 | <param name='motd' doc='Strings for motd' /> |
| 936 | <param name='default' doc='Default string' /> |
| 937 | </params> |
| 938 | </command> |
| 939 | <command id='banner motd file [FILE]'> |
| 940 | <params> |
| 941 | <param name='banner' doc='Set banner' /> |
| 942 | <param name='motd' doc='Banner for motd' /> |
| 943 | <param name='file' doc='Banner from a file' /> |
| 944 | <param name='[FILE]' doc='Filename' /> |
| 945 | </params> |
| 946 | </command> |
| 947 | <command id='no banner motd'> |
| 948 | <params> |
| 949 | <param name='no' doc='Negate a command or set its defaults' /> |
| 950 | <param name='banner' doc='Set banner string' /> |
| 951 | <param name='motd' doc='Strings for motd' /> |
| 952 | </params> |
| 953 | </command> |
| 954 | <command id='service terminal-length <0-512>'> |
| 955 | <params> |
| 956 | <param name='service' doc='Set up miscellaneous service' /> |
| 957 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 958 | <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> |
| 959 | </params> |
| 960 | </command> |
| 961 | <command id='no service terminal-length [<0-512>]'> |
| 962 | <params> |
| 963 | <param name='no' doc='Negate a command or set its defaults' /> |
| 964 | <param name='service' doc='Set up miscellaneous service' /> |
| 965 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 966 | <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> |
| 967 | </params> |
| 968 | </command> |
| 969 | <command id='line vty'> |
| 970 | <params> |
| 971 | <param name='line' doc='Configure a terminal line' /> |
| 972 | <param name='vty' doc='Virtual terminal' /> |
| 973 | </params> |
| 974 | </command> |
| 975 | <command id='service advanced-vty'> |
| 976 | <params> |
| 977 | <param name='service' doc='Set up miscellaneous service' /> |
| 978 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 979 | </params> |
| 980 | </command> |
| 981 | <command id='no service advanced-vty'> |
| 982 | <params> |
| 983 | <param name='no' doc='Negate a command or set its defaults' /> |
| 984 | <param name='service' doc='Set up miscellaneous service' /> |
| 985 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 986 | </params> |
| 987 | </command> |
| 988 | <command id='show history'> |
| 989 | <params> |
| 990 | <param name='show' doc='Show running system information' /> |
| 991 | <param name='history' doc='Display the session command history' /> |
| 992 | </params> |
| 993 | </command> |
| 994 | <command id='log stderr'> |
| 995 | <params> |
| 996 | <param name='log' doc='Configure logging sub-system' /> |
| 997 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 998 | </params> |
| 999 | </command> |
| 1000 | <command id='no log stderr'> |
| 1001 | <params> |
| 1002 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1003 | <param name='log' doc='Configure logging sub-system' /> |
| 1004 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 1005 | </params> |
| 1006 | </command> |
| 1007 | <command id='log file .FILENAME'> |
| 1008 | <params> |
| 1009 | <param name='log' doc='Configure logging sub-system' /> |
| 1010 | <param name='file' doc='Logging to text file' /> |
| 1011 | <param name='.FILENAME' doc='Filename' /> |
| 1012 | </params> |
| 1013 | </command> |
| 1014 | <command id='no log file .FILENAME'> |
| 1015 | <params> |
| 1016 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1017 | <param name='log' doc='Configure logging sub-system' /> |
| 1018 | <param name='file' doc='Logging to text file' /> |
| 1019 | <param name='.FILENAME' doc='Filename' /> |
| 1020 | </params> |
| 1021 | </command> |
| 1022 | <command id='log alarms <2-32700>'> |
| 1023 | <params> |
| 1024 | <param name='log' doc='Configure logging sub-system' /> |
| 1025 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 1026 | <param name='<2-32700>' doc='Maximum number of messages to log' /> |
| 1027 | </params> |
| 1028 | </command> |
| 1029 | <command id='no log alarms'> |
| 1030 | <params> |
| 1031 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1032 | <param name='log' doc='Configure logging sub-system' /> |
| 1033 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 1034 | </params> |
| 1035 | </command> |
| 1036 | <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> |
| 1037 | <params> |
| 1038 | <param name='log' doc='Configure logging sub-system' /> |
| 1039 | <param name='syslog' doc='Logging via syslog' /> |
| 1040 | <param name='authpriv' doc='Security/authorization messages facility' /> |
| 1041 | <param name='cron' doc='Clock daemon (cron/at) facility' /> |
| 1042 | <param name='daemon' doc='General system daemon facility' /> |
| 1043 | <param name='ftp' doc='Ftp daemon facility' /> |
| 1044 | <param name='lpr' doc='Line printer facility' /> |
| 1045 | <param name='mail' doc='Mail facility' /> |
| 1046 | <param name='news' doc='News facility' /> |
| 1047 | <param name='user' doc='Generic facility' /> |
| 1048 | <param name='uucp' doc='UUCP facility' /> |
| 1049 | </params> |
| 1050 | </command> |
| 1051 | <command id='log syslog local <0-7>'> |
| 1052 | <params> |
| 1053 | <param name='log' doc='Configure logging sub-system' /> |
| 1054 | <param name='syslog' doc='Logging via syslog' /> |
| 1055 | <param name='local' doc='Syslog LOCAL facility' /> |
| 1056 | <param name='<0-7>' doc='Local facility number' /> |
| 1057 | </params> |
| 1058 | </command> |
| 1059 | <command id='no log syslog'> |
| 1060 | <params> |
| 1061 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1062 | <param name='log' doc='Configure logging sub-system' /> |
| 1063 | <param name='syslog' doc='Logging via syslog' /> |
| 1064 | </params> |
| 1065 | </command> |
| 1066 | <command id='log gsmtap [HOSTNAME]'> |
| 1067 | <params> |
| 1068 | <param name='log' doc='Configure logging sub-system' /> |
| 1069 | <param name='gsmtap' doc='Logging via GSMTAP' /> |
| 1070 | <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> |
| 1071 | </params> |
| 1072 | </command> |
| 1073 | <command id='stats reporter statsd'> |
| 1074 | <params> |
| 1075 | <param name='stats' doc='Configure stats sub-system' /> |
| 1076 | <param name='reporter' doc='Configure a stats reporter' /> |
| 1077 | <param name='statsd' doc='Report to a STATSD server' /> |
| 1078 | </params> |
| 1079 | </command> |
| 1080 | <command id='no stats reporter statsd'> |
| 1081 | <params> |
| 1082 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1083 | <param name='stats' doc='Configure stats sub-system' /> |
| 1084 | <param name='reporter' doc='Configure a stats reporter' /> |
| 1085 | <param name='statsd' doc='Report to a STATSD server' /> |
| 1086 | </params> |
| 1087 | </command> |
| 1088 | <command id='stats reporter log'> |
| 1089 | <params> |
| 1090 | <param name='stats' doc='Configure stats sub-system' /> |
| 1091 | <param name='reporter' doc='Configure a stats reporter' /> |
| 1092 | <param name='log' doc='Report to the logger' /> |
| 1093 | </params> |
| 1094 | </command> |
| 1095 | <command id='no stats reporter log'> |
| 1096 | <params> |
| 1097 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1098 | <param name='stats' doc='Configure stats sub-system' /> |
| 1099 | <param name='reporter' doc='Configure a stats reporter' /> |
| 1100 | <param name='log' doc='Report to the logger' /> |
| 1101 | </params> |
| 1102 | </command> |
| 1103 | <command id='stats interval <1-65535>'> |
| 1104 | <params> |
| 1105 | <param name='stats' doc='Configure stats sub-system' /> |
| 1106 | <param name='interval' doc='Set the reporting interval' /> |
| 1107 | <param name='<1-65535>' doc='Interval in seconds' /> |
| 1108 | </params> |
| 1109 | </command> |
| 1110 | <command id='pcu'> |
| 1111 | <params> |
| 1112 | <param name='pcu' doc='BTS specific configure' /> |
| 1113 | </params> |
| 1114 | </command> |
| 1115 | <command id='ns'> |
| 1116 | <params> |
| 1117 | <param name='ns' doc='Configure the GPRS Network Service' /> |
| 1118 | </params> |
| 1119 | </command> |
| 1120 | </node> |
| 1121 | <node id='config-log'> |
| 1122 | <name>config-log</name> |
| 1123 | <command id='logging filter all (0|1)'> |
| 1124 | <params> |
| 1125 | <param name='logging' doc='Configure logging' /> |
| 1126 | <param name='filter' doc='Filter log messages' /> |
| 1127 | <param name='all' doc='Do you want to log all messages?' /> |
| 1128 | <param name='0' doc='Only print messages matched by other filters' /> |
| 1129 | <param name='1' doc='Bypass filter and print all messages' /> |
| 1130 | </params> |
| 1131 | </command> |
| 1132 | <command id='logging color (0|1)'> |
| 1133 | <params> |
| 1134 | <param name='logging' doc='Configure logging' /> |
| 1135 | <param name='color' doc='Configure color-printing for log messages' /> |
| 1136 | <param name='0' doc='Don't use color for printing messages' /> |
| 1137 | <param name='1' doc='Use color for printing messages' /> |
| 1138 | </params> |
| 1139 | </command> |
| 1140 | <command id='logging timestamp (0|1)'> |
| 1141 | <params> |
| 1142 | <param name='logging' doc='Configure logging' /> |
| 1143 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 1144 | <param name='0' doc='Don't prefix each log message' /> |
| 1145 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 1146 | </params> |
| 1147 | </command> |
| 1148 | <command id='logging print extended-timestamp (0|1)'> |
| 1149 | <params> |
| 1150 | <param name='logging' doc='Configure logging' /> |
| 1151 | <param name='print' doc='Log output settings' /> |
| 1152 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 1153 | <param name='0' doc='Don't prefix each log message' /> |
| 1154 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 1155 | </params> |
| 1156 | </command> |
| 1157 | <command id='logging print category (0|1)'> |
| 1158 | <params> |
| 1159 | <param name='logging' doc='Configure logging' /> |
| 1160 | <param name='print' doc='Log output settings' /> |
| 1161 | <param name='category' doc='Configure log message' /> |
| 1162 | <param name='0' doc='Don't prefix each log message' /> |
| 1163 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 1164 | </params> |
| 1165 | </command> |
| 1166 | <command id='logging print category-hex (0|1)'> |
| 1167 | <params> |
| 1168 | <param name='logging' doc='Configure logging' /> |
| 1169 | <param name='print' doc='Log output settings' /> |
| 1170 | <param name='category-hex' doc='Configure log message' /> |
| 1171 | <param name='0' doc='Don't prefix each log message' /> |
| 1172 | <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> |
| 1173 | </params> |
| 1174 | </command> |
| 1175 | <command id='logging print level (0|1)'> |
| 1176 | <params> |
| 1177 | <param name='logging' doc='Configure logging' /> |
| 1178 | <param name='print' doc='Log output settings' /> |
| 1179 | <param name='level' doc='Configure log message' /> |
| 1180 | <param name='0' doc='Don't prefix each log message' /> |
| 1181 | <param name='1' doc='Prefix each log message with the log level name' /> |
| 1182 | </params> |
| 1183 | </command> |
| 1184 | <command id='logging print file (0|1|basename) [last]'> |
| 1185 | <params> |
| 1186 | <param name='logging' doc='Configure logging' /> |
| 1187 | <param name='print' doc='Log output settings' /> |
| 1188 | <param name='file' doc='Configure log message' /> |
| 1189 | <param name='0' doc='Don't prefix each log message' /> |
| 1190 | <param name='1' doc='Prefix each log message with the source file and line' /> |
| 1191 | <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> |
| 1192 | <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.' /> |
| 1193 | </params> |
| 1194 | </command> |
| 1195 | <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> |
| 1196 | <params> |
| 1197 | <param name='logging' doc='Configure logging' /> |
| 1198 | <param name='level' doc='Set the log level for a specified category' /> |
| 1199 | <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' /> |
| 1200 | <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' /> |
| 1201 | <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' /> |
| 1202 | <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' /> |
| 1203 | <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' /> |
| 1204 | <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' /> |
| 1205 | <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' /> |
| 1206 | <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' /> |
| 1207 | <param name='tbf' doc='Temporary Block Flow (TBF)' /> |
| 1208 | <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' /> |
| 1209 | <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' /> |
| 1210 | <param name='ns' doc='GPRS Network Service Protocol (NS)' /> |
| 1211 | <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> |
| 1212 | <param name='pcu' doc='GPRS Packet Control Unit (PCU)' /> |
| 1213 | <param name='lglobal' doc='Library-internal global log family' /> |
| 1214 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 1215 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 1216 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 1217 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 1218 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 1219 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 1220 | <param name='lctrl' doc='Control Interface' /> |
| 1221 | <param name='lgtp' doc='GPRS GTP library' /> |
| 1222 | <param name='lstats' doc='Statistics messages and logging' /> |
| 1223 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 1224 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 1225 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 1226 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 1227 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 1228 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 1229 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 1230 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 1231 | <param name='lrspro' doc='Remote SIM protocol' /> |
| 1232 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 1233 | <param name='info' doc='Log informational messages and higher levels' /> |
| 1234 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 1235 | <param name='error' doc='Log error messages and higher levels' /> |
| 1236 | <param name='fatal' doc='Log only fatal messages' /> |
| 1237 | </params> |
| 1238 | </command> |
| 1239 | <command id='logging level set-all (debug|info|notice|error|fatal)'> |
| 1240 | <params> |
| 1241 | <param name='logging' doc='Configure logging' /> |
| 1242 | <param name='level' doc='Set the log level for a specified category' /> |
| 1243 | <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.' /> |
| 1244 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 1245 | <param name='info' doc='Log informational messages and higher levels' /> |
| 1246 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 1247 | <param name='error' doc='Log error messages and higher levels' /> |
| 1248 | <param name='fatal' doc='Log only fatal messages' /> |
| 1249 | </params> |
| 1250 | </command> |
| 1251 | <command id='logging level force-all (debug|info|notice|error|fatal)'> |
| 1252 | <params> |
| 1253 | <param name='logging' doc='Configure logging' /> |
| 1254 | <param name='level' doc='Set the log level for a specified category' /> |
| 1255 | <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.' /> |
| 1256 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 1257 | <param name='info' doc='Log informational messages and higher levels' /> |
| 1258 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 1259 | <param name='error' doc='Log error messages and higher levels' /> |
| 1260 | <param name='fatal' doc='Log only fatal messages' /> |
| 1261 | </params> |
| 1262 | </command> |
| 1263 | <command id='no logging level force-all'> |
| 1264 | <params> |
| 1265 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1266 | <param name='logging' doc='Configure logging' /> |
| 1267 | <param name='level' doc='Set the log level for a specified category' /> |
| 1268 | <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> |
| 1269 | </params> |
| 1270 | </command> |
| 1271 | <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> |
| 1272 | <params> |
| 1273 | <param name='logging' doc='Configure logging' /> |
| 1274 | <param name='filter' doc='Filter log messages' /> |
| 1275 | <param name='nsvc' doc='Filter based on NS Virtual Connection' /> |
| 1276 | <param name='nsei' doc='Identify NS-VC by NSEI' /> |
| 1277 | <param name='nsvci' doc='Identify NS-VC by NSVCI' /> |
| 1278 | <param name='<0-65535>' doc='Numeric identifier' /> |
| 1279 | </params> |
| 1280 | </command> |
| 1281 | </node> |
| 1282 | <node id='config-stats'> |
| 1283 | <name>config-stats</name> |
| 1284 | <command id='local-ip ADDR'> |
| 1285 | <params> |
| 1286 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 1287 | <param name='ADDR' doc='IP Address' /> |
| 1288 | </params> |
| 1289 | </command> |
| 1290 | <command id='no local-ip'> |
| 1291 | <params> |
| 1292 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1293 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 1294 | </params> |
| 1295 | </command> |
| 1296 | <command id='remote-ip ADDR'> |
| 1297 | <params> |
| 1298 | <param name='remote-ip' doc='Set the remote IP address to which we connect' /> |
| 1299 | <param name='ADDR' doc='IP Address' /> |
| 1300 | </params> |
| 1301 | </command> |
| 1302 | <command id='remote-port <1-65535>'> |
| 1303 | <params> |
| 1304 | <param name='remote-port' doc='Set the remote port to which we connect' /> |
| 1305 | <param name='<1-65535>' doc='Remote port number' /> |
| 1306 | </params> |
| 1307 | </command> |
| 1308 | <command id='mtu <100-65535>'> |
| 1309 | <params> |
| 1310 | <param name='mtu' doc='Set the maximum packet size' /> |
| 1311 | <param name='<100-65535>' doc='Size in byte' /> |
| 1312 | </params> |
| 1313 | </command> |
| 1314 | <command id='no mtu'> |
| 1315 | <params> |
| 1316 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1317 | <param name='mtu' doc='Set the maximum packet size' /> |
| 1318 | </params> |
| 1319 | </command> |
| 1320 | <command id='prefix PREFIX'> |
| 1321 | <params> |
| 1322 | <param name='prefix' doc='Set the item name prefix' /> |
| 1323 | <param name='PREFIX' doc='The prefix string' /> |
| 1324 | </params> |
| 1325 | </command> |
| 1326 | <command id='no prefix'> |
| 1327 | <params> |
| 1328 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1329 | <param name='prefix' doc='Set the item name prefix' /> |
| 1330 | </params> |
| 1331 | </command> |
| 1332 | <command id='level (global|peer|subscriber)'> |
| 1333 | <params> |
| 1334 | <param name='level' doc='Set the maximum group level' /> |
| 1335 | <param name='global' doc='Report global groups only' /> |
| 1336 | <param name='peer' doc='Report global and network peer related groups' /> |
| 1337 | <param name='subscriber' doc='Report global, peer, and subscriber groups' /> |
| 1338 | </params> |
| 1339 | </command> |
| 1340 | <command id='enable'> |
| 1341 | <params> |
| 1342 | <param name='enable' doc='Enable the reporter' /> |
| 1343 | </params> |
| 1344 | </command> |
| 1345 | <command id='disable'> |
| 1346 | <params> |
| 1347 | <param name='disable' doc='Disable the reporter' /> |
| 1348 | </params> |
| 1349 | </command> |
| 1350 | </node> |
| 1351 | <node id='config-line'> |
| 1352 | <name>config-line</name> |
| 1353 | <command id='login'> |
| 1354 | <params> |
| 1355 | <param name='login' doc='Enable password checking' /> |
| 1356 | </params> |
| 1357 | </command> |
| 1358 | <command id='no login'> |
| 1359 | <params> |
| 1360 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1361 | <param name='login' doc='Enable password checking' /> |
| 1362 | </params> |
| 1363 | </command> |
| 1364 | <command id='bind A.B.C.D [<0-65535>]'> |
| 1365 | <params> |
| 1366 | <param name='bind' doc='Accept VTY telnet connections on local interface' /> |
| 1367 | <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> |
| 1368 | <param name='[<0-65535>]' doc='Local TCP port number' /> |
| 1369 | </params> |
| 1370 | </command> |
| 1371 | </node> |
| 1372 | <node id='config-ns'> |
| 1373 | <name>config-ns</name> |
| 1374 | <command id='nse <0-65535> nsvci <0-65534>'> |
| 1375 | <params> |
| 1376 | <param name='nse' doc='Persistent NS Entity' /> |
| 1377 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1378 | <param name='nsvci' doc='NS Virtual Connection' /> |
| 1379 | <param name='<0-65534>' doc='NS Virtual Connection ID (NSVCI)' /> |
| 1380 | </params> |
| 1381 | </command> |
| 1382 | <command id='nse <0-65535> remote-ip A.B.C.D'> |
| 1383 | <params> |
| 1384 | <param name='nse' doc='Persistent NS Entity' /> |
| 1385 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1386 | <param name='remote-ip' doc='Remote IP Address' /> |
| 1387 | <param name='A.B.C.D' doc='Remote IP Address' /> |
| 1388 | </params> |
| 1389 | </command> |
| 1390 | <command id='nse <0-65535> remote-port <0-65535>'> |
| 1391 | <params> |
| 1392 | <param name='nse' doc='Persistent NS Entity' /> |
| 1393 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1394 | <param name='remote-port' doc='Remote UDP Port' /> |
| 1395 | <param name='<0-65535>' doc='Remote UDP Port Number' /> |
| 1396 | </params> |
| 1397 | </command> |
| 1398 | <command id='nse <0-65535> fr-dlci <16-1007>'> |
| 1399 | <params> |
| 1400 | <param name='nse' doc='Persistent NS Entity' /> |
| 1401 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1402 | <param name='fr-dlci' doc='Frame Relay DLCI' /> |
| 1403 | <param name='<16-1007>' doc='Frame Relay DLCI Number' /> |
| 1404 | </params> |
| 1405 | </command> |
| 1406 | <command id='nse <0-65535> encapsulation (udp|framerelay-gre)'> |
| 1407 | <params> |
| 1408 | <param name='nse' doc='Persistent NS Entity' /> |
| 1409 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1410 | <param name='encapsulation' doc='Encapsulation for NS' /> |
| 1411 | <param name='udp' doc='UDP/IP Encapsulation' /> |
| 1412 | <param name='framerelay-gre' doc='Frame-Relay/GRE/IP Encapsulation' /> |
| 1413 | </params> |
| 1414 | </command> |
| 1415 | <command id='nse <0-65535> remote-role (sgsn|bss)'> |
| 1416 | <params> |
| 1417 | <param name='nse' doc='Persistent NS Entity' /> |
| 1418 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1419 | <param name='remote-role' doc='Remote NSE Role' /> |
| 1420 | <param name='sgsn' doc='Remote Peer is SGSN' /> |
| 1421 | <param name='bss' doc='Remote Peer is BSS' /> |
| 1422 | </params> |
| 1423 | </command> |
| 1424 | <command id='no nse <0-65535>'> |
| 1425 | <params> |
| 1426 | <param name='no' doc='Delete Persistent NS Entity' /> |
| 1427 | <param name='nse' doc='Delete Persistent NS Entity' /> |
| 1428 | <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> |
| 1429 | </params> |
| 1430 | </command> |
| 1431 | <command id='timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) <0-65535>'> |
| 1432 | <params> |
| 1433 | <param name='timer' doc='Network Service Timer' /> |
| 1434 | <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' /> |
| 1435 | <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' /> |
| 1436 | <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' /> |
| 1437 | <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' /> |
| 1438 | <param name='tns-test' doc='Test Timer (Tns-test) timeout' /> |
| 1439 | <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' /> |
| 1440 | <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' /> |
| 1441 | <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' /> |
| 1442 | <param name='<0-65535>' doc='Timer Value' /> |
| 1443 | </params> |
| 1444 | </command> |
| 1445 | <command id='encapsulation udp local-ip A.B.C.D'> |
| 1446 | <params> |
| 1447 | <param name='encapsulation' doc='NS encapsulation options' /> |
| 1448 | <param name='udp' doc='NS over UDP Encapsulation' /> |
| 1449 | <param name='local-ip' doc='Set the IP address on which we listen for NS/UDP' /> |
| 1450 | <param name='A.B.C.D' doc='IP Address' /> |
| 1451 | </params> |
| 1452 | </command> |
| 1453 | <command id='encapsulation udp local-port <0-65535>'> |
| 1454 | <params> |
| 1455 | <param name='encapsulation' doc='NS encapsulation options' /> |
| 1456 | <param name='udp' doc='NS over UDP Encapsulation' /> |
| 1457 | <param name='local-port' doc='Set the UDP port on which we listen for NS/UDP' /> |
| 1458 | <param name='<0-65535>' doc='UDP port number' /> |
| 1459 | </params> |
| 1460 | </command> |
| 1461 | <command id='encapsulation udp dscp <0-255>'> |
| 1462 | <params> |
| 1463 | <param name='encapsulation' doc='NS encapsulation options' /> |
| 1464 | <param name='udp' doc='NS over UDP Encapsulation' /> |
| 1465 | <param name='dscp' doc='Set DSCP/TOS on the UDP socket' /> |
| 1466 | <param name='<0-255>' doc='DSCP Value' /> |
| 1467 | </params> |
| 1468 | </command> |
| 1469 | <command id='encapsulation framerelay-gre enabled (1|0)'> |
| 1470 | <params> |
| 1471 | <param name='encapsulation' doc='NS encapsulation options' /> |
| 1472 | <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> |
| 1473 | <param name='enabled' doc='Enable or disable Frame Relay over GRE' /> |
| 1474 | <param name='1' doc='Enable' /> |
| 1475 | <param name='0' doc='Disable' /> |
| 1476 | </params> |
| 1477 | </command> |
| 1478 | <command id='encapsulation framerelay-gre local-ip A.B.C.D'> |
| 1479 | <params> |
| 1480 | <param name='encapsulation' doc='NS encapsulation options' /> |
| 1481 | <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> |
| 1482 | <param name='local-ip' doc='Set the IP address on which we listen for NS/FR/GRE' /> |
| 1483 | <param name='A.B.C.D' doc='IP Address' /> |
| 1484 | </params> |
| 1485 | </command> |
| 1486 | </node> |
| 1487 | <node id='config-pcu'> |
| 1488 | <name>config-pcu</name> |
| 1489 | <command id='egprs only'> |
| 1490 | <params> |
| 1491 | <param name='egprs' doc='EGPRS configuration' /> |
| 1492 | <param name='only' doc='Use EGPRS and disable plain GPRS' /> |
| 1493 | </params> |
| 1494 | </command> |
| 1495 | <command id='no egprs'> |
| 1496 | <params> |
| 1497 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1498 | <param name='egprs' doc='EGPRS configuration' /> |
| 1499 | </params> |
| 1500 | </command> |
| 1501 | <command id='no two-phase-access'> |
| 1502 | <params> |
| 1503 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1504 | <param name='two-phase-access' doc='Only use two phase access when requested my MS' /> |
| 1505 | </params> |
| 1506 | </command> |
| 1507 | <command id='cs <1-4> [<1-4>]'> |
| 1508 | <params> |
| 1509 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1510 | <param name='<1-4>' doc='Initial CS value to be used (overrides BTS config)' /> |
| 1511 | <param name='[<1-4>]' doc='Use a different initial CS value for the uplink' /> |
| 1512 | </params> |
| 1513 | </command> |
| 1514 | <command id='no cs'> |
| 1515 | <params> |
| 1516 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1517 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1518 | </params> |
| 1519 | </command> |
| 1520 | <command id='cs max <1-4> [<1-4>]'> |
| 1521 | <params> |
| 1522 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1523 | <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' /> |
| 1524 | <param name='<1-4>' doc='Maximum CS value to be used' /> |
| 1525 | <param name='[<1-4>]' doc='Use a different maximum CS value for the uplink' /> |
| 1526 | </params> |
| 1527 | </command> |
| 1528 | <command id='no cs max'> |
| 1529 | <params> |
| 1530 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1531 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1532 | <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' /> |
| 1533 | </params> |
| 1534 | </command> |
| 1535 | <command id='cs threshold <0-100> <0-100>'> |
| 1536 | <params> |
| 1537 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1538 | <param name='threshold' doc='set thresholds for error rate based CS adjustment' /> |
| 1539 | <param name='<0-100>' doc='lower limit in %' /> |
| 1540 | <param name='<0-100>' doc='upper limit in %' /> |
| 1541 | </params> |
| 1542 | </command> |
| 1543 | <command id='no cs threshold'> |
| 1544 | <params> |
| 1545 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1546 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1547 | <param name='threshold' doc='set thresholds for error rate based CS adjustment' /> |
| 1548 | </params> |
| 1549 | </command> |
| 1550 | <command id='cs downgrade-threshold <1-10000>'> |
| 1551 | <params> |
| 1552 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1553 | <param name='downgrade-threshold' doc='set threshold for data size based CS downgrade' /> |
| 1554 | <param name='<1-10000>' doc='downgrade if less octets left' /> |
| 1555 | </params> |
| 1556 | </command> |
| 1557 | <command id='no cs downgrade-threshold'> |
| 1558 | <params> |
| 1559 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1560 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1561 | <param name='downgrade-threshold' doc='set threshold for data size based CS downgrade' /> |
| 1562 | </params> |
| 1563 | </command> |
| 1564 | <command id='cs link-quality-ranges cs1 <0-35> cs2 <0-35> <0-35> cs3 <0-35> <0-35> cs4 <0-35>'> |
| 1565 | <params> |
| 1566 | <param name='cs' doc='Coding Scheme configuration' /> |
| 1567 | <param name='link-quality-ranges' doc='Set link quality ranges' /> |
| 1568 | <param name='cs1' doc='Set quality range for CS-1 (high value only)' /> |
| 1569 | <param name='<0-35>' doc='CS-1 high (dB)' /> |
| 1570 | <param name='cs2' doc='Set quality range for CS-2' /> |
| 1571 | <param name='<0-35>' doc='CS-2 low (dB)' /> |
| 1572 | <param name='<0-35>' doc='CS-2 high (dB)' /> |
| 1573 | <param name='cs3' doc='Set quality range for CS-3' /> |
| 1574 | <param name='<0-35>' doc='CS-3 low (dB)' /> |
| 1575 | <param name='<0-35>' doc='CS-3 high (dB)' /> |
| 1576 | <param name='cs4' doc='Set quality range for CS-4 (low value only)' /> |
| 1577 | <param name='<0-35>' doc='CS-4 low (dB)' /> |
| 1578 | </params> |
| 1579 | </command> |
| 1580 | <command id='mcs link-quality-ranges mcs1 <0-35> mcs2 <0-35> <0-35> mcs3 <0-35> <0-35> mcs4 <0-35> <0-35> mcs5 <0-35> <0-35> mcs6 <0-35> <0-35> mcs7 <0-35> <0-35> mcs8 <0-35> <0-35> mcs9 <0-35>'> |
| 1581 | <params> |
| 1582 | <param name='mcs' doc='Coding Scheme configuration' /> |
| 1583 | <param name='link-quality-ranges' doc='Set link quality ranges' /> |
| 1584 | <param name='mcs1' doc='Set quality range for MCS-1 (high value only)' /> |
| 1585 | <param name='<0-35>' doc='MCS-1 high (dB)' /> |
| 1586 | <param name='mcs2' doc='Set quality range for MCS-2' /> |
| 1587 | <param name='<0-35>' doc='MCS-2 high (dB)' /> |
| 1588 | <param name='<0-35>' doc='MCS-2 low (dB)' /> |
| 1589 | <param name='mcs3' doc='Set quality range for MCS-3' /> |
| 1590 | <param name='<0-35>' doc='MCS-3 high (dB)' /> |
| 1591 | <param name='<0-35>' doc='MCS-3 low (dB)' /> |
| 1592 | <param name='mcs4' doc='Set quality range for MCS-4' /> |
| 1593 | <param name='<0-35>' doc='MCS-4 high (dB)' /> |
| 1594 | <param name='<0-35>' doc='MCS-4 low (dB)' /> |
| 1595 | <param name='mcs5' doc='Set quality range for MCS-5' /> |
| 1596 | <param name='<0-35>' doc='MCS-5 high (dB)' /> |
| 1597 | <param name='<0-35>' doc='MCS-5 low (dB)' /> |
| 1598 | <param name='mcs6' doc='Set quality range for MCS-6' /> |
| 1599 | <param name='<0-35>' doc='MCS-6 low (dB)' /> |
| 1600 | <param name='<0-35>' doc='MCS-6 high (dB)' /> |
| 1601 | <param name='mcs7' doc='Set quality range for MCS-7' /> |
| 1602 | <param name='<0-35>' doc='MCS-7 low (dB)' /> |
| 1603 | <param name='<0-35>' doc='MCS-7 high (dB)' /> |
| 1604 | <param name='mcs8' doc='Set quality range for MCS-8' /> |
| 1605 | <param name='<0-35>' doc='MCS-8 low (dB)' /> |
| 1606 | <param name='<0-35>' doc='MCS-8 high (dB)' /> |
| 1607 | <param name='mcs9' doc='Set quality range for MCS-9 (low value only)' /> |
| 1608 | <param name='<0-35>' doc='MCS-9 low (dB)' /> |
| 1609 | </params> |
| 1610 | </command> |
| 1611 | <command id='mcs <1-9> [<1-9>]'> |
| 1612 | <params> |
| 1613 | <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' /> |
| 1614 | <param name='<1-9>' doc='Initial MCS value to be used (default 1)' /> |
| 1615 | <param name='[<1-9>]' doc='Use a different initial MCS value for the uplink' /> |
| 1616 | </params> |
| 1617 | </command> |
| 1618 | <command id='egprs dl arq-type (spb|arq2)'> |
| 1619 | <params> |
| 1620 | <param name='egprs' doc='EGPRS configuration' /> |
| 1621 | <param name='dl' doc='downlink specific configuration' /> |
| 1622 | <param name='arq-type' doc='ARQ options' /> |
| 1623 | <param name='spb' doc='enable SPB(ARQ1) support' /> |
| 1624 | <param name='arq2' doc='enable ARQ2 support' /> |
| 1625 | </params> |
| 1626 | </command> |
| 1627 | <command id='no mcs'> |
| 1628 | <params> |
| 1629 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1630 | <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' /> |
| 1631 | </params> |
| 1632 | </command> |
| 1633 | <command id='mcs max <1-9> [<1-9>]'> |
| 1634 | <params> |
| 1635 | <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' /> |
| 1636 | <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' /> |
| 1637 | <param name='<1-9>' doc='Maximum MCS value to be used' /> |
| 1638 | <param name='[<1-9>]' doc='Use a different maximum MCS value for the uplink' /> |
| 1639 | </params> |
| 1640 | </command> |
| 1641 | <command id='no mcs max'> |
| 1642 | <params> |
| 1643 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1644 | <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' /> |
| 1645 | <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' /> |
| 1646 | </params> |
| 1647 | </command> |
| 1648 | <command id='window-size <0-1024> [<0-256>]'> |
| 1649 | <params> |
| 1650 | <param name='window-size' doc='Window size configuration (b + N_PDCH * f)' /> |
| 1651 | <param name='<0-1024>' doc='Base value (b)' /> |
| 1652 | <param name='[<0-256>]' doc='Factor for number of PDCH (f)' /> |
| 1653 | </params> |
| 1654 | </command> |
| 1655 | <command id='queue lifetime <1-65534>'> |
| 1656 | <params> |
| 1657 | <param name='queue' doc='Packet queue options' /> |
| 1658 | <param name='lifetime' doc='Set lifetime limit of LLC frame in centi-seconds (overrides the value given by SGSN)' /> |
| 1659 | <param name='<1-65534>' doc='Lifetime in centi-seconds' /> |
| 1660 | </params> |
| 1661 | </command> |
| 1662 | <command id='queue lifetime infinite'> |
| 1663 | <params> |
| 1664 | <param name='queue' doc='Packet queue options' /> |
| 1665 | <param name='lifetime' doc='Set lifetime limit of LLC frame in centi-seconds (overrides the value given by SGSN)' /> |
| 1666 | <param name='infinite' doc='Infinite lifetime' /> |
| 1667 | </params> |
| 1668 | </command> |
| 1669 | <command id='no queue lifetime'> |
| 1670 | <params> |
| 1671 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1672 | <param name='queue' doc='Packet queue options' /> |
| 1673 | <param name='lifetime' doc='Disable lifetime limit of LLC frame (use value given by SGSN)' /> |
| 1674 | </params> |
| 1675 | </command> |
| 1676 | <command id='queue hysteresis <1-65535>'> |
| 1677 | <params> |
| 1678 | <param name='queue' doc='Packet queue options' /> |
| 1679 | <param name='hysteresis' doc='Set lifetime hysteresis of LLC frame in centi-seconds (continue discarding until lifetime-hysteresis is reached)' /> |
| 1680 | <param name='<1-65535>' doc='Hysteresis in centi-seconds' /> |
| 1681 | </params> |
| 1682 | </command> |
| 1683 | <command id='no queue hysteresis'> |
| 1684 | <params> |
| 1685 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1686 | <param name='queue' doc='Packet queue options' /> |
| 1687 | <param name='hysteresis' doc='Set lifetime hysteresis of LLC frame in centi-seconds (continue discarding until lifetime-hysteresis is reached)' /> |
| 1688 | </params> |
| 1689 | </command> |
| 1690 | <command id='queue codel'> |
| 1691 | <params> |
| 1692 | <param name='queue' doc='Packet queue options' /> |
| 1693 | <param name='codel' doc='Set CoDel queue management' /> |
| 1694 | </params> |
| 1695 | </command> |
| 1696 | <command id='queue codel interval <1-1000>'> |
| 1697 | <params> |
| 1698 | <param name='queue' doc='Packet queue options' /> |
| 1699 | <param name='codel' doc='Set CoDel queue management' /> |
| 1700 | <param name='interval' doc='Specify interval' /> |
| 1701 | <param name='<1-1000>' doc='Interval in centi-seconds' /> |
| 1702 | </params> |
| 1703 | </command> |
| 1704 | <command id='no queue codel'> |
| 1705 | <params> |
| 1706 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1707 | <param name='queue' doc='Packet queue options' /> |
| 1708 | <param name='codel' doc='Set CoDel queue management' /> |
| 1709 | </params> |
| 1710 | </command> |
| 1711 | <command id='queue idle-ack-delay <1-65535>'> |
| 1712 | <params> |
| 1713 | <param name='queue' doc='Packet queue options' /> |
| 1714 | <param name='idle-ack-delay' doc='Request an ACK after the last DL LLC frame in centi-seconds' /> |
| 1715 | <param name='<1-65535>' doc='Idle ACK delay in centi-seconds' /> |
| 1716 | </params> |
| 1717 | </command> |
| 1718 | <command id='no queue idle-ack-delay'> |
| 1719 | <params> |
| 1720 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1721 | <param name='queue' doc='Packet queue options' /> |
| 1722 | <param name='idle-ack-delay' doc='Request an ACK after the last DL LLC frame in centi-seconds' /> |
| 1723 | </params> |
| 1724 | </command> |
| 1725 | <command id='alloc-algorithm (a|b|dynamic)'> |
| 1726 | <params> |
| 1727 | <param name='alloc-algorithm' doc='Select slot allocation algorithm to use when assigning timeslots on PACCH' /> |
| 1728 | <param name='a' doc='Single slot is assigned only' /> |
| 1729 | <param name='b' doc='Multiple slots are assigned for semi-duplex operation' /> |
| 1730 | <param name='dynamic' doc='Dynamically select the algorithm based on the system state' /> |
| 1731 | </params> |
| 1732 | </command> |
| 1733 | <command id='two-phase-access'> |
| 1734 | <params> |
| 1735 | <param name='two-phase-access' doc='Force two phase access when MS requests single phase access' /> |
| 1736 | </params> |
| 1737 | </command> |
| 1738 | <command id='flow-control-interval <1-10>'> |
| 1739 | <params> |
| 1740 | <param name='flow-control-interval' doc='Interval between sending subsequent Flow Control PDUs' /> |
| 1741 | <param name='<1-10>' doc='Interval time in seconds' /> |
| 1742 | </params> |
| 1743 | </command> |
| 1744 | <command id='flow-control bucket-time <1-65534>'> |
| 1745 | <params> |
| 1746 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1747 | <param name='bucket-time' doc='Set target downlink maximum queueing time (only affects the advertised bucket size)' /> |
| 1748 | <param name='<1-65534>' doc='Time in centi-seconds' /> |
| 1749 | </params> |
| 1750 | </command> |
| 1751 | <command id='no flow-control bucket-time'> |
| 1752 | <params> |
| 1753 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1754 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1755 | <param name='bucket-time' doc='Set target downlink maximum queueing time (only affects the advertised bucket size)' /> |
| 1756 | </params> |
| 1757 | </command> |
| 1758 | <command id='flow-control force-bvc-bucket-size <1-6553500>'> |
| 1759 | <params> |
| 1760 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1761 | <param name='force-bvc-bucket-size' doc='Force a fixed value for the BVC bucket size' /> |
| 1762 | <param name='<1-6553500>' doc='Bucket size in octets' /> |
| 1763 | </params> |
| 1764 | </command> |
| 1765 | <command id='no flow-control force-bvc-bucket-size'> |
| 1766 | <params> |
| 1767 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1768 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1769 | <param name='force-bvc-bucket-size' doc='Force a fixed value for the BVC bucket size' /> |
| 1770 | </params> |
| 1771 | </command> |
| 1772 | <command id='flow-control force-bvc-leak-rate <1-6553500>'> |
| 1773 | <params> |
| 1774 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1775 | <param name='force-bvc-leak-rate' doc='Force a fixed value for the BVC leak rate' /> |
| 1776 | <param name='<1-6553500>' doc='Leak rate in bit/s' /> |
| 1777 | </params> |
| 1778 | </command> |
| 1779 | <command id='no flow-control force-bvc-leak-rate'> |
| 1780 | <params> |
| 1781 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1782 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1783 | <param name='force-bvc-leak-rate' doc='Force a fixed value for the BVC leak rate' /> |
| 1784 | </params> |
| 1785 | </command> |
| 1786 | <command id='flow-control force-ms-bucket-size <1-6553500>'> |
| 1787 | <params> |
| 1788 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1789 | <param name='force-ms-bucket-size' doc='Force a fixed value for the default MS bucket size' /> |
| 1790 | <param name='<1-6553500>' doc='Bucket size in octets' /> |
| 1791 | </params> |
| 1792 | </command> |
| 1793 | <command id='no flow-control force-ms-bucket-size'> |
| 1794 | <params> |
| 1795 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1796 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1797 | <param name='force-ms-bucket-size' doc='Force a fixed value for the default MS bucket size' /> |
| 1798 | </params> |
| 1799 | </command> |
| 1800 | <command id='flow-control force-ms-leak-rate <1-6553500>'> |
| 1801 | <params> |
| 1802 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1803 | <param name='force-ms-leak-rate' doc='Force a fixed value for the default MS leak rate' /> |
| 1804 | <param name='<1-6553500>' doc='Leak rate in bit/s' /> |
| 1805 | </params> |
| 1806 | </command> |
| 1807 | <command id='no flow-control force-ms-leak-rate'> |
| 1808 | <params> |
| 1809 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1810 | <param name='flow-control' doc='BSSGP Flow Control configuration' /> |
| 1811 | <param name='force-ms-leak-rate' doc='Force a fixed value for the default MS leak rate' /> |
| 1812 | </params> |
| 1813 | </command> |
| 1814 | <command id='alpha <0-10>'> |
| 1815 | <params> |
| 1816 | <param name='alpha' doc='Alpha parameter for MS power control in units of 0.1 (see TS 05.08) NOTE: Be sure to set Alpha value at System information 13 too.' /> |
| 1817 | <param name='<0-10>' doc='Alpha in units of 0.1' /> |
| 1818 | </params> |
| 1819 | </command> |
| 1820 | <command id='gamma <0-62>'> |
| 1821 | <params> |
| 1822 | <param name='gamma' doc='Gamma parameter for MS power control in units of dB (see TS 05.08)' /> |
| 1823 | <param name='<0-62>' doc='Gamma in even unit of dBs' /> |
| 1824 | </params> |
| 1825 | </command> |
| 1826 | <command id='dl-tbf-idle-time <1-5000>'> |
| 1827 | <params> |
| 1828 | <param name='dl-tbf-idle-time' doc='keep an idle DL TBF alive for the time given' /> |
| 1829 | <param name='<1-5000>' doc='idle time in msec' /> |
| 1830 | </params> |
| 1831 | </command> |
| 1832 | <command id='no dl-tbf-idle-time'> |
| 1833 | <params> |
| 1834 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1835 | <param name='dl-tbf-idle-time' doc='keep an idle DL TBF alive for the time given' /> |
| 1836 | </params> |
| 1837 | </command> |
| Oliver Smith | 45fdc44 | 2019-09-05 15:12:20 +0200 | [diff] [blame] | 1838 | <command id='dl-tbf-preemptive-retransmission'> |
| 1839 | <params> |
| 1840 | <param name='dl-tbf-preemptive-retransmission' doc='retransmit blocks even before the MS had a chance to receive them (better throughput, less readable traces) (enabled by default)' /> |
| 1841 | </params> |
| 1842 | </command> |
| 1843 | <command id='no dl-tbf-preemptive-retransmission'> |
| 1844 | <params> |
| 1845 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1846 | <param name='dl-tbf-preemptive-retransmission' doc='retransmit blocks even before the MS had a chance to receive them (better throughput, less readable traces)' /> |
| 1847 | </params> |
| 1848 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 1849 | <command id='ms-idle-time <1-7200>'> |
| 1850 | <params> |
| 1851 | <param name='ms-idle-time' doc='keep an idle MS object alive for the time given' /> |
| 1852 | <param name='<1-7200>' doc='idle time in sec' /> |
| 1853 | </params> |
| 1854 | </command> |
| 1855 | <command id='no ms-idle-time'> |
| 1856 | <params> |
| 1857 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1858 | <param name='ms-idle-time' doc='keep an idle MS object alive for the time given' /> |
| 1859 | </params> |
| 1860 | </command> |
| 1861 | <command id='gsmtap-category (dl-unknown|dl-dummy|dl-ctrl|dl-data-gprs|dl-data-egprs|dl-ptcch|ul-unknown|ul-dummy|ul-ctrl|ul-data-gprs|ul-data-egprs)'> |
| 1862 | <params> |
| 1863 | <param name='gsmtap-category' doc='GSMTAP Category' /> |
| 1864 | <param name='dl-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' /> |
| 1865 | <param name='dl-dummy' doc='Downlink Dummy Blocks' /> |
| 1866 | <param name='dl-ctrl' doc='Downlink Control Blocks' /> |
| 1867 | <param name='dl-data-gprs' doc='Downlink Data Blocks (GPRS)' /> |
| 1868 | <param name='dl-data-egprs' doc='Downlink Data Blocks (EGPRS)' /> |
| 1869 | <param name='dl-ptcch' doc='Downlink PTCCH Blocks' /> |
| 1870 | <param name='ul-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' /> |
| 1871 | <param name='ul-dummy' doc='Uplink Dummy Blocks' /> |
| 1872 | <param name='ul-ctrl' doc='Uplink Control Blocks' /> |
| 1873 | <param name='ul-data-gprs' doc='Uplink Data Blocks (GPRS)' /> |
| 1874 | <param name='ul-data-egprs' doc='Uplink Data Blocks (EGPRS)' /> |
| 1875 | </params> |
| 1876 | </command> |
| 1877 | <command id='no gsmtap-category (dl-unknown|dl-dummy|dl-ctrl|dl-data-gprs|dl-data-egprs|dl-ptcch|ul-unknown|ul-dummy|ul-ctrl|ul-data-gprs|ul-data-egprs)'> |
| 1878 | <params> |
| 1879 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1880 | <param name='gsmtap-category' doc='GSMTAP Category' /> |
| 1881 | <param name='dl-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' /> |
| 1882 | <param name='dl-dummy' doc='Downlink Dummy Blocks' /> |
| 1883 | <param name='dl-ctrl' doc='Downlink Control Blocks' /> |
| 1884 | <param name='dl-data-gprs' doc='Downlink Data Blocks (GPRS)' /> |
| 1885 | <param name='dl-data-egprs' doc='Downlink Data Blocks (EGPRS)' /> |
| 1886 | <param name='dl-ptcch' doc='Downlink PTCCH Blocks' /> |
| 1887 | <param name='ul-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' /> |
| 1888 | <param name='ul-dummy' doc='Uplink Dummy Blocks' /> |
| 1889 | <param name='ul-ctrl' doc='Uplink Control Blocks' /> |
| 1890 | <param name='ul-data-gprs' doc='Uplink Data Blocks (GPRS)' /> |
| 1891 | <param name='ul-data-egprs' doc='Uplink Data Blocks (EGPRS)' /> |
| 1892 | </params> |
| 1893 | </command> |
| 1894 | <command id='pcu-socket PATH'> |
| 1895 | <params> |
| 1896 | <param name='pcu-socket' doc='Configure the osmo-bts PCU socket file/path name' /> |
| 1897 | <param name='PATH' doc='Path of the socket to connect to' /> |
| 1898 | </params> |
| 1899 | </command> |
| 1900 | <command id='gb-dialect (classic|ip-sns)'> |
| 1901 | <params> |
| 1902 | <param name='gb-dialect' doc='Select which Gb interface dialect to use' /> |
| 1903 | <param name='classic' doc='Classic Gb interface with NS-{RESET,BLOCK,UNBLOCK} and static configuration' /> |
| 1904 | <param name='ip-sns' doc='Modern Gb interface with IP-SNS (Sub Network Service) and dynamic configuration' /> |
| 1905 | </params> |
| 1906 | </command> |
| Pau Espin Pedrol | 28f160e | 2019-09-05 14:48:35 +0200 | [diff] [blame] | 1907 | <command id='timer [TNNNN] [(<0-2147483647>|default)]'> |
| 1908 | <params> |
| 1909 | <param name='timer' doc='Configure or show PCU timers' /> |
| 1910 | <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> |
| 1911 | <param name='[<0-2147483647>]' doc='New timer value' /> |
| 1912 | <param name='[default]' doc='Set to default timer value' /> |
| 1913 | </params> |
| 1914 | </command> |
| Daniel Willmann | 79c6c4d | 2019-06-19 12:05:05 +0200 | [diff] [blame] | 1915 | </node> |
| 1916 | </vtydoc> |