| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1 | <vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> |
| 2 | <node id='_common_cmds_'> |
| 3 | <name>Common Commands</name> |
| 4 | <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description> |
| 5 | <command id='help'> |
| 6 | <params> |
| 7 | <param name='help' doc='Description of the interactive help system' /> |
| 8 | </params> |
| 9 | </command> |
| 10 | <command id='list'> |
| 11 | <params> |
| 12 | <param name='list' doc='Print command list' /> |
| 13 | </params> |
| 14 | </command> |
| 15 | <command id='write terminal'> |
| 16 | <params> |
| 17 | <param name='write' doc='Write running configuration to memory, network, or terminal' /> |
| 18 | <param name='terminal' doc='Write to terminal' /> |
| 19 | </params> |
| 20 | </command> |
| 21 | <command id='write file'> |
| 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> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 88 | <command id='who'> |
| 89 | <params> |
| 90 | <param name='who' doc='Display who is on vty' /> |
| 91 | </params> |
| 92 | </command> |
| 93 | <command id='show history'> |
| 94 | <params> |
| 95 | <param name='show' doc='Show running system information' /> |
| 96 | <param name='history' doc='Display the session command history' /> |
| 97 | </params> |
| 98 | </command> |
| 99 | <command id='logging enable'> |
| 100 | <params> |
| 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)'> |
| 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 | </params> |
| 181 | </command> |
| 182 | <command id='logging set-log-mask MASK'> |
| 183 | <params> |
| 184 | <param name='logging' doc='Configure logging' /> |
| 185 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
| 186 | <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' /> |
| 187 | </params> |
| 188 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 189 | <command id='logging level (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'> |
| 190 | <params> |
| 191 | <param name='logging' doc='Configure logging' /> |
| 192 | <param name='level' doc='Set the log level for a specified category' /> |
| 193 | <param name='all' doc='Global setting for all subsystems' /> |
| 194 | <param name='rtp' doc='RTP stream handling' /> |
| 195 | <param name='lglobal' doc='Library-internal global log family' /> |
| 196 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 197 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 198 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 199 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 200 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 201 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 202 | <param name='lctrl' doc='Control Interface' /> |
| 203 | <param name='lgtp' doc='GPRS GTP library' /> |
| 204 | <param name='lstats' doc='Statistics messages and logging' /> |
| 205 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 206 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 207 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 208 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 209 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 210 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 211 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 212 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 213 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 214 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 215 | <param name='info' doc='Log informational messages and higher levels' /> |
| 216 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 217 | <param name='error' doc='Log error messages and higher levels' /> |
| 218 | <param name='fatal' doc='Log only fatal messages' /> |
| 219 | </params> |
| 220 | </command> |
| 221 | <command id='show logging vty'> |
| 222 | <params> |
| 223 | <param name='show' doc='Show running system information' /> |
| 224 | <param name='logging' doc='Show current logging configuration' /> |
| 225 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 226 | </params> |
| 227 | </command> |
| 228 | <command id='show alarms'> |
| 229 | <params> |
| 230 | <param name='show' doc='Show running system information' /> |
| 231 | <param name='alarms' doc='Show current logging configuration' /> |
| 232 | </params> |
| 233 | </command> |
| 234 | <command id='show talloc-context (application|all) (full|brief|DEPTH)'> |
| 235 | <params> |
| 236 | <param name='show' doc='Show running system information' /> |
| 237 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 238 | <param name='application' doc='Application's context' /> |
| 239 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 240 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 241 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 242 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 243 | </params> |
| 244 | </command> |
| 245 | <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'> |
| 246 | <params> |
| 247 | <param name='show' doc='Show running system information' /> |
| 248 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 249 | <param name='application' doc='Application's context' /> |
| 250 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 251 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 252 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 253 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 254 | <param name='tree' doc='Display only a specific memory chunk' /> |
| 255 | <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' /> |
| 256 | </params> |
| 257 | </command> |
| 258 | <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'> |
| 259 | <params> |
| 260 | <param name='show' doc='Show running system information' /> |
| 261 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 262 | <param name='application' doc='Application's context' /> |
| 263 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 264 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 265 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 266 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 267 | <param name='filter' doc='Filter chunks using regular expression' /> |
| 268 | <param name='REGEXP' doc='Regular expression' /> |
| 269 | </params> |
| 270 | </command> |
| 271 | <command id='show stats'> |
| 272 | <params> |
| 273 | <param name='show' doc='Show running system information' /> |
| 274 | <param name='stats' doc='Show statistical values' /> |
| 275 | </params> |
| 276 | </command> |
| 277 | <command id='show stats level (global|peer|subscriber)'> |
| 278 | <params> |
| 279 | <param name='show' doc='Show running system information' /> |
| 280 | <param name='stats' doc='Show statistical values' /> |
| 281 | <param name='level' doc='Set the maximum group level' /> |
| 282 | <param name='global' doc='Show global groups only' /> |
| 283 | <param name='peer' doc='Show global and network peer related groups' /> |
| 284 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 285 | </params> |
| 286 | </command> |
| 287 | <command id='show asciidoc counters'> |
| 288 | <params> |
| 289 | <param name='show' doc='Show running system information' /> |
| 290 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 291 | <param name='counters' doc='Generate table of all registered counters' /> |
| 292 | </params> |
| 293 | </command> |
| Daniel Willmann | e5ed946 | 2018-07-31 18:54:34 +0200 | [diff] [blame^] | 294 | <command id='show rate-counters'> |
| 295 | <params> |
| 296 | <param name='show' doc='Show running system information' /> |
| 297 | <param name='rate-counters' doc='Show all rate counters' /> |
| 298 | </params> |
| 299 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 300 | <command id='show mgcp [stats]'> |
| 301 | <params> |
| 302 | <param name='show' doc='Show running system information' /> |
| 303 | <param name='mgcp' doc='Display information about the MGCP Media Gateway' /> |
| 304 | <param name='[stats]' doc='Include Statistics' /> |
| 305 | </params> |
| 306 | </command> |
| 307 | </node> |
| 308 | <node id='enable'> |
| 309 | <name>enable</name> |
| 310 | <command id='disable'> |
| 311 | <params> |
| 312 | <param name='disable' doc='Turn off privileged mode command' /> |
| 313 | </params> |
| 314 | </command> |
| 315 | <command id='configure terminal'> |
| 316 | <params> |
| 317 | <param name='configure' doc='Configuration from vty interface' /> |
| 318 | <param name='terminal' doc='Configuration terminal' /> |
| 319 | </params> |
| 320 | </command> |
| 321 | <command id='copy running-config startup-config'> |
| 322 | <params> |
| 323 | <param name='copy' doc='Copy configuration' /> |
| 324 | <param name='running-config' doc='Copy running config to... ' /> |
| 325 | <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> |
| 326 | </params> |
| 327 | </command> |
| 328 | <command id='show startup-config'> |
| 329 | <params> |
| 330 | <param name='show' doc='Show running system information' /> |
| 331 | <param name='startup-config' doc='Contentes of startup configuration' /> |
| 332 | </params> |
| 333 | </command> |
| 334 | <command id='show version'> |
| 335 | <params> |
| 336 | <param name='show' doc='Show running system information' /> |
| 337 | <param name='version' doc='Displays program version' /> |
| 338 | </params> |
| 339 | </command> |
| 340 | <command id='show online-help'> |
| 341 | <params> |
| 342 | <param name='show' doc='Show running system information' /> |
| 343 | <param name='online-help' doc='Online help' /> |
| 344 | </params> |
| 345 | </command> |
| 346 | <command id='terminal length <0-512>'> |
| 347 | <params> |
| 348 | <param name='terminal' doc='Set terminal line parameters' /> |
| 349 | <param name='length' doc='Set number of lines on a screen' /> |
| 350 | <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> |
| 351 | </params> |
| 352 | </command> |
| 353 | <command id='terminal no length'> |
| 354 | <params> |
| 355 | <param name='terminal' doc='Set terminal line parameters' /> |
| 356 | <param name='no' doc='Negate a command or set its defaults' /> |
| 357 | <param name='length' doc='Set number of lines on a screen' /> |
| 358 | </params> |
| 359 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 360 | <command id='who'> |
| 361 | <params> |
| 362 | <param name='who' doc='Display who is on vty' /> |
| 363 | </params> |
| 364 | </command> |
| 365 | <command id='show history'> |
| 366 | <params> |
| 367 | <param name='show' doc='Show running system information' /> |
| 368 | <param name='history' doc='Display the session command history' /> |
| 369 | </params> |
| 370 | </command> |
| 371 | <command id='terminal monitor'> |
| 372 | <params> |
| 373 | <param name='terminal' doc='Set terminal line parameters' /> |
| 374 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 375 | </params> |
| 376 | </command> |
| 377 | <command id='terminal no monitor'> |
| 378 | <params> |
| 379 | <param name='terminal' doc='Set terminal line parameters' /> |
| 380 | <param name='no' doc='Negate a command or set its defaults' /> |
| 381 | <param name='monitor' doc='Copy debug output to the current terminal line' /> |
| 382 | </params> |
| 383 | </command> |
| 384 | <command id='logging enable'> |
| 385 | <params> |
| 386 | <param name='logging' doc='Configure logging' /> |
| 387 | <param name='enable' doc='Enables logging to this vty' /> |
| 388 | </params> |
| 389 | </command> |
| 390 | <command id='logging disable'> |
| 391 | <params> |
| 392 | <param name='logging' doc='Configure logging' /> |
| 393 | <param name='disable' doc='Disables logging to this vty' /> |
| 394 | </params> |
| 395 | </command> |
| 396 | <command id='logging filter all (0|1)'> |
| 397 | <params> |
| 398 | <param name='logging' doc='Configure logging' /> |
| 399 | <param name='filter' doc='Filter log messages' /> |
| 400 | <param name='all' doc='Do you want to log all messages?' /> |
| 401 | <param name='0' doc='Only print messages matched by other filters' /> |
| 402 | <param name='1' doc='Bypass filter and print all messages' /> |
| 403 | </params> |
| 404 | </command> |
| 405 | <command id='logging color (0|1)'> |
| 406 | <params> |
| 407 | <param name='logging' doc='Configure logging' /> |
| 408 | <param name='color' doc='Configure color-printing for log messages' /> |
| 409 | <param name='0' doc='Don't use color for printing messages' /> |
| 410 | <param name='1' doc='Use color for printing messages' /> |
| 411 | </params> |
| 412 | </command> |
| 413 | <command id='logging timestamp (0|1)'> |
| 414 | <params> |
| 415 | <param name='logging' doc='Configure logging' /> |
| 416 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 417 | <param name='0' doc='Don't prefix each log message' /> |
| 418 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 419 | </params> |
| 420 | </command> |
| 421 | <command id='logging print extended-timestamp (0|1)'> |
| 422 | <params> |
| 423 | <param name='logging' doc='Configure logging' /> |
| 424 | <param name='print' doc='Log output settings' /> |
| 425 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 426 | <param name='0' doc='Don't prefix each log message' /> |
| 427 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 428 | </params> |
| 429 | </command> |
| 430 | <command id='logging print category (0|1)'> |
| 431 | <params> |
| 432 | <param name='logging' doc='Configure logging' /> |
| 433 | <param name='print' doc='Log output settings' /> |
| 434 | <param name='category' doc='Configure log message' /> |
| 435 | <param name='0' doc='Don't prefix each log message' /> |
| 436 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 437 | </params> |
| 438 | </command> |
| 439 | <command id='logging print category-hex (0|1)'> |
| 440 | <params> |
| 441 | <param name='logging' doc='Configure logging' /> |
| 442 | <param name='print' doc='Log output settings' /> |
| 443 | <param name='category-hex' doc='Configure log message' /> |
| 444 | <param name='0' doc='Don't prefix each log message' /> |
| 445 | <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> |
| 446 | </params> |
| 447 | </command> |
| 448 | <command id='logging print level (0|1)'> |
| 449 | <params> |
| 450 | <param name='logging' doc='Configure logging' /> |
| 451 | <param name='print' doc='Log output settings' /> |
| 452 | <param name='level' doc='Configure log message' /> |
| 453 | <param name='0' doc='Don't prefix each log message' /> |
| 454 | <param name='1' doc='Prefix each log message with the log level name' /> |
| 455 | </params> |
| 456 | </command> |
| 457 | <command id='logging print file (0|1|basename)'> |
| 458 | <params> |
| 459 | <param name='logging' doc='Configure logging' /> |
| 460 | <param name='print' doc='Log output settings' /> |
| 461 | <param name='file' doc='Configure log message' /> |
| 462 | <param name='0' doc='Don't prefix each log message' /> |
| 463 | <param name='1' doc='Prefix each log message with the source file and line' /> |
| 464 | <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> |
| 465 | </params> |
| 466 | </command> |
| 467 | <command id='logging set-log-mask MASK'> |
| 468 | <params> |
| 469 | <param name='logging' doc='Configure logging' /> |
| 470 | <param name='set-log-mask' doc='Set the logmask of this logging target' /> |
| 471 | <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' /> |
| 472 | </params> |
| 473 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 474 | <command id='logging level (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'> |
| 475 | <params> |
| 476 | <param name='logging' doc='Configure logging' /> |
| 477 | <param name='level' doc='Set the log level for a specified category' /> |
| 478 | <param name='all' doc='Global setting for all subsystems' /> |
| 479 | <param name='rtp' doc='RTP stream handling' /> |
| 480 | <param name='lglobal' doc='Library-internal global log family' /> |
| 481 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 482 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 483 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 484 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 485 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 486 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 487 | <param name='lctrl' doc='Control Interface' /> |
| 488 | <param name='lgtp' doc='GPRS GTP library' /> |
| 489 | <param name='lstats' doc='Statistics messages and logging' /> |
| 490 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 491 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 492 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 493 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 494 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 495 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 496 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 497 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 498 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 499 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 500 | <param name='info' doc='Log informational messages and higher levels' /> |
| 501 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 502 | <param name='error' doc='Log error messages and higher levels' /> |
| 503 | <param name='fatal' doc='Log only fatal messages' /> |
| 504 | </params> |
| 505 | </command> |
| 506 | <command id='show logging vty'> |
| 507 | <params> |
| 508 | <param name='show' doc='Show running system information' /> |
| 509 | <param name='logging' doc='Show current logging configuration' /> |
| 510 | <param name='vty' doc='Show current logging configuration for this vty' /> |
| 511 | </params> |
| 512 | </command> |
| 513 | <command id='show alarms'> |
| 514 | <params> |
| 515 | <param name='show' doc='Show running system information' /> |
| 516 | <param name='alarms' doc='Show current logging configuration' /> |
| 517 | </params> |
| 518 | </command> |
| 519 | <command id='show talloc-context (application|all) (full|brief|DEPTH)'> |
| 520 | <params> |
| 521 | <param name='show' doc='Show running system information' /> |
| 522 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 523 | <param name='application' doc='Application's context' /> |
| 524 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 525 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 526 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 527 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 528 | </params> |
| 529 | </command> |
| 530 | <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'> |
| 531 | <params> |
| 532 | <param name='show' doc='Show running system information' /> |
| 533 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 534 | <param name='application' doc='Application's context' /> |
| 535 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 536 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 537 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 538 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 539 | <param name='tree' doc='Display only a specific memory chunk' /> |
| 540 | <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' /> |
| 541 | </params> |
| 542 | </command> |
| 543 | <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'> |
| 544 | <params> |
| 545 | <param name='show' doc='Show running system information' /> |
| 546 | <param name='talloc-context' doc='Show talloc memory hierarchy' /> |
| 547 | <param name='application' doc='Application's context' /> |
| 548 | <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> |
| 549 | <param name='full' doc='Display a full talloc memory hierarchy' /> |
| 550 | <param name='brief' doc='Display a brief talloc memory hierarchy' /> |
| 551 | <param name='DEPTH' doc='Specify required maximal depth value' /> |
| 552 | <param name='filter' doc='Filter chunks using regular expression' /> |
| 553 | <param name='REGEXP' doc='Regular expression' /> |
| 554 | </params> |
| 555 | </command> |
| 556 | <command id='show stats'> |
| 557 | <params> |
| 558 | <param name='show' doc='Show running system information' /> |
| 559 | <param name='stats' doc='Show statistical values' /> |
| 560 | </params> |
| 561 | </command> |
| 562 | <command id='show stats level (global|peer|subscriber)'> |
| 563 | <params> |
| 564 | <param name='show' doc='Show running system information' /> |
| 565 | <param name='stats' doc='Show statistical values' /> |
| 566 | <param name='level' doc='Set the maximum group level' /> |
| 567 | <param name='global' doc='Show global groups only' /> |
| 568 | <param name='peer' doc='Show global and network peer related groups' /> |
| 569 | <param name='subscriber' doc='Show global, peer, and subscriber groups' /> |
| 570 | </params> |
| 571 | </command> |
| 572 | <command id='show asciidoc counters'> |
| 573 | <params> |
| 574 | <param name='show' doc='Show running system information' /> |
| 575 | <param name='asciidoc' doc='Asciidoc generation' /> |
| 576 | <param name='counters' doc='Generate table of all registered counters' /> |
| 577 | </params> |
| 578 | </command> |
| Daniel Willmann | e5ed946 | 2018-07-31 18:54:34 +0200 | [diff] [blame^] | 579 | <command id='show rate-counters'> |
| 580 | <params> |
| 581 | <param name='show' doc='Show running system information' /> |
| 582 | <param name='rate-counters' doc='Show all rate counters' /> |
| 583 | </params> |
| 584 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 585 | <command id='show mgcp [stats]'> |
| 586 | <params> |
| 587 | <param name='show' doc='Show running system information' /> |
| 588 | <param name='mgcp' doc='Display information about the MGCP Media Gateway' /> |
| 589 | <param name='[stats]' doc='Include Statistics' /> |
| 590 | </params> |
| 591 | </command> |
| 592 | <command id='loop-endpoint <0-64> NAME (0|1)'> |
| 593 | <params> |
| 594 | <param name='loop-endpoint' doc='Loop a given endpoint' /> |
| 595 | <param name='<0-64>' doc='Trunk number' /> |
| 596 | <param name='NAME' doc='The name in hex of the endpoint' /> |
| 597 | <param name='0' doc='Disable the loop' /> |
| 598 | <param name='1' doc='Enable the loop' /> |
| 599 | </params> |
| 600 | </command> |
| 601 | <command id='tap-rtp <0-64> ENDPOINT CONN (in|out) A.B.C.D <0-65534>'> |
| 602 | <params> |
| 603 | <param name='tap-rtp' doc='Forward data on endpoint to a different system' /> |
| 604 | <param name='<0-64>' doc='Trunk number' /> |
| 605 | <param name='ENDPOINT' doc='The endpoint in hex' /> |
| 606 | <param name='CONN' doc='The connection id in hex' /> |
| 607 | <param name='in' doc='Forward incoming data' /> |
| 608 | <param name='out' doc='Forward leaving data' /> |
| 609 | <param name='A.B.C.D' doc='destination IP of the data' /> |
| 610 | <param name='<0-65534>' doc='destination port' /> |
| 611 | </params> |
| 612 | </command> |
| 613 | <command id='free-endpoint <0-64> NUMBER'> |
| 614 | <params> |
| 615 | <param name='free-endpoint' doc='Free the given endpoint' /> |
| 616 | <param name='<0-64>' doc='Trunk number' /> |
| 617 | <param name='NUMBER' doc='Endpoint number in hex.' /> |
| 618 | </params> |
| 619 | </command> |
| 620 | <command id='reset-endpoint <0-64> NUMBER'> |
| 621 | <params> |
| 622 | <param name='reset-endpoint' doc='Reset the given endpoint' /> |
| 623 | <param name='<0-64>' doc='Trunk number' /> |
| 624 | <param name='NUMBER' doc='Endpoint number in hex.' /> |
| 625 | </params> |
| 626 | </command> |
| 627 | <command id='reset-all-endpoints'> |
| 628 | <params> |
| 629 | <param name='reset-all-endpoints' doc='Reset all endpoints' /> |
| 630 | </params> |
| 631 | </command> |
| 632 | </node> |
| 633 | <node id='config'> |
| 634 | <name>config</name> |
| 635 | <command id='hostname WORD'> |
| 636 | <params> |
| 637 | <param name='hostname' doc='Set system's network name' /> |
| 638 | <param name='WORD' doc='This system's network name' /> |
| 639 | </params> |
| 640 | </command> |
| 641 | <command id='no hostname [HOSTNAME]'> |
| 642 | <params> |
| 643 | <param name='no' doc='Negate a command or set its defaults' /> |
| 644 | <param name='hostname' doc='Reset system's network name' /> |
| 645 | <param name='[HOSTNAME]' doc='Host name of this router' /> |
| 646 | </params> |
| 647 | </command> |
| 648 | <command id='password (8|) WORD'> |
| 649 | <params> |
| 650 | <param name='password' doc='Assign the terminal connection password' /> |
| 651 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 652 | <param name='' doc='dummy string ' /> |
| 653 | <param name='WORD' doc='The HIDDEN line password string' /> |
| 654 | </params> |
| 655 | </command> |
| 656 | <command id='password LINE'> |
| 657 | <params> |
| 658 | <param name='password' doc='Assign the terminal connection password' /> |
| 659 | <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> |
| 660 | </params> |
| 661 | </command> |
| 662 | <command id='enable password (8|) WORD'> |
| 663 | <params> |
| 664 | <param name='enable' doc='Modify enable password parameters' /> |
| 665 | <param name='password' doc='Assign the privileged level password' /> |
| 666 | <param name='8' doc='Specifies a HIDDEN password will follow' /> |
| 667 | <param name='' doc='dummy string ' /> |
| 668 | <param name='WORD' doc='The HIDDEN 'enable' password string' /> |
| 669 | </params> |
| 670 | </command> |
| 671 | <command id='enable password LINE'> |
| 672 | <params> |
| 673 | <param name='enable' doc='Modify enable password parameters' /> |
| 674 | <param name='password' doc='Assign the privileged level password' /> |
| 675 | <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> |
| 676 | </params> |
| 677 | </command> |
| 678 | <command id='no enable password'> |
| 679 | <params> |
| 680 | <param name='no' doc='Negate a command or set its defaults' /> |
| 681 | <param name='enable' doc='Modify enable password parameters' /> |
| 682 | <param name='password' doc='Assign the privileged level password' /> |
| 683 | </params> |
| 684 | </command> |
| 685 | <command id='banner motd default'> |
| 686 | <params> |
| 687 | <param name='banner' doc='Set banner string' /> |
| 688 | <param name='motd' doc='Strings for motd' /> |
| 689 | <param name='default' doc='Default string' /> |
| 690 | </params> |
| 691 | </command> |
| 692 | <command id='banner motd file [FILE]'> |
| 693 | <params> |
| 694 | <param name='banner' doc='Set banner' /> |
| 695 | <param name='motd' doc='Banner for motd' /> |
| 696 | <param name='file' doc='Banner from a file' /> |
| 697 | <param name='[FILE]' doc='Filename' /> |
| 698 | </params> |
| 699 | </command> |
| 700 | <command id='no banner motd'> |
| 701 | <params> |
| 702 | <param name='no' doc='Negate a command or set its defaults' /> |
| 703 | <param name='banner' doc='Set banner string' /> |
| 704 | <param name='motd' doc='Strings for motd' /> |
| 705 | </params> |
| 706 | </command> |
| 707 | <command id='service terminal-length <0-512>'> |
| 708 | <params> |
| 709 | <param name='service' doc='Set up miscellaneous service' /> |
| 710 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 711 | <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> |
| 712 | </params> |
| 713 | </command> |
| 714 | <command id='no service terminal-length [<0-512>]'> |
| 715 | <params> |
| 716 | <param name='no' doc='Negate a command or set its defaults' /> |
| 717 | <param name='service' doc='Set up miscellaneous service' /> |
| 718 | <param name='terminal-length' doc='System wide terminal length configuration' /> |
| 719 | <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> |
| 720 | </params> |
| 721 | </command> |
| 722 | <command id='line vty'> |
| 723 | <params> |
| 724 | <param name='line' doc='Configure a terminal line' /> |
| 725 | <param name='vty' doc='Virtual terminal' /> |
| 726 | </params> |
| 727 | </command> |
| 728 | <command id='service advanced-vty'> |
| 729 | <params> |
| 730 | <param name='service' doc='Set up miscellaneous service' /> |
| 731 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 732 | </params> |
| 733 | </command> |
| 734 | <command id='no service advanced-vty'> |
| 735 | <params> |
| 736 | <param name='no' doc='Negate a command or set its defaults' /> |
| 737 | <param name='service' doc='Set up miscellaneous service' /> |
| 738 | <param name='advanced-vty' doc='Enable advanced mode vty interface' /> |
| 739 | </params> |
| 740 | </command> |
| 741 | <command id='show history'> |
| 742 | <params> |
| 743 | <param name='show' doc='Show running system information' /> |
| 744 | <param name='history' doc='Display the session command history' /> |
| 745 | </params> |
| 746 | </command> |
| 747 | <command id='log stderr'> |
| 748 | <params> |
| 749 | <param name='log' doc='Configure logging sub-system' /> |
| 750 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 751 | </params> |
| 752 | </command> |
| 753 | <command id='no log stderr'> |
| 754 | <params> |
| 755 | <param name='no' doc='Negate a command or set its defaults' /> |
| 756 | <param name='log' doc='Configure logging sub-system' /> |
| 757 | <param name='stderr' doc='Logging via STDERR of the process' /> |
| 758 | </params> |
| 759 | </command> |
| 760 | <command id='log file .FILENAME'> |
| 761 | <params> |
| 762 | <param name='log' doc='Configure logging sub-system' /> |
| 763 | <param name='file' doc='Logging to text file' /> |
| 764 | <param name='.FILENAME' doc='Filename' /> |
| 765 | </params> |
| 766 | </command> |
| 767 | <command id='no log file .FILENAME'> |
| 768 | <params> |
| 769 | <param name='no' doc='Negate a command or set its defaults' /> |
| 770 | <param name='log' doc='Configure logging sub-system' /> |
| 771 | <param name='file' doc='Logging to text file' /> |
| 772 | <param name='.FILENAME' doc='Filename' /> |
| 773 | </params> |
| 774 | </command> |
| 775 | <command id='log alarms <2-32700>'> |
| 776 | <params> |
| 777 | <param name='log' doc='Configure logging sub-system' /> |
| 778 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 779 | <param name='<2-32700>' doc='Maximum number of messages to log' /> |
| 780 | </params> |
| 781 | </command> |
| 782 | <command id='no log alarms'> |
| 783 | <params> |
| 784 | <param name='no' doc='Negate a command or set its defaults' /> |
| 785 | <param name='log' doc='Configure logging sub-system' /> |
| 786 | <param name='alarms' doc='Logging alarms to osmo_strrb' /> |
| 787 | </params> |
| 788 | </command> |
| 789 | <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> |
| 790 | <params> |
| 791 | <param name='log' doc='Configure logging sub-system' /> |
| 792 | <param name='syslog' doc='Logging via syslog' /> |
| 793 | <param name='authpriv' doc='Security/authorization messages facility' /> |
| 794 | <param name='cron' doc='Clock daemon (cron/at) facility' /> |
| 795 | <param name='daemon' doc='General system daemon facility' /> |
| 796 | <param name='ftp' doc='Ftp daemon facility' /> |
| 797 | <param name='lpr' doc='Line printer facility' /> |
| 798 | <param name='mail' doc='Mail facility' /> |
| 799 | <param name='news' doc='News facility' /> |
| 800 | <param name='user' doc='Generic facility' /> |
| 801 | <param name='uucp' doc='UUCP facility' /> |
| 802 | </params> |
| 803 | </command> |
| 804 | <command id='log syslog local <0-7>'> |
| 805 | <params> |
| 806 | <param name='log' doc='Configure logging sub-system' /> |
| 807 | <param name='syslog' doc='Logging via syslog' /> |
| 808 | <param name='local' doc='Syslog LOCAL facility' /> |
| 809 | <param name='<0-7>' doc='Local facility number' /> |
| 810 | </params> |
| 811 | </command> |
| 812 | <command id='no log syslog'> |
| 813 | <params> |
| 814 | <param name='no' doc='Negate a command or set its defaults' /> |
| 815 | <param name='log' doc='Configure logging sub-system' /> |
| 816 | <param name='syslog' doc='Logging via syslog' /> |
| 817 | </params> |
| 818 | </command> |
| 819 | <command id='log gsmtap [HOSTNAME]'> |
| 820 | <params> |
| 821 | <param name='log' doc='Configure logging sub-system' /> |
| 822 | <param name='gsmtap' doc='Logging via GSMTAP' /> |
| 823 | <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> |
| 824 | </params> |
| 825 | </command> |
| 826 | <command id='stats reporter statsd'> |
| 827 | <params> |
| 828 | <param name='stats' doc='Configure stats sub-system' /> |
| 829 | <param name='reporter' doc='Configure a stats reporter' /> |
| 830 | <param name='statsd' doc='Report to a STATSD server' /> |
| 831 | </params> |
| 832 | </command> |
| 833 | <command id='no stats reporter statsd'> |
| 834 | <params> |
| 835 | <param name='no' doc='Negate a command or set its defaults' /> |
| 836 | <param name='stats' doc='Configure stats sub-system' /> |
| 837 | <param name='reporter' doc='Configure a stats reporter' /> |
| 838 | <param name='statsd' doc='Report to a STATSD server' /> |
| 839 | </params> |
| 840 | </command> |
| 841 | <command id='stats reporter log'> |
| 842 | <params> |
| 843 | <param name='stats' doc='Configure stats sub-system' /> |
| 844 | <param name='reporter' doc='Configure a stats reporter' /> |
| 845 | <param name='log' doc='Report to the logger' /> |
| 846 | </params> |
| 847 | </command> |
| 848 | <command id='no stats reporter log'> |
| 849 | <params> |
| 850 | <param name='no' doc='Negate a command or set its defaults' /> |
| 851 | <param name='stats' doc='Configure stats sub-system' /> |
| 852 | <param name='reporter' doc='Configure a stats reporter' /> |
| 853 | <param name='log' doc='Report to the logger' /> |
| 854 | </params> |
| 855 | </command> |
| 856 | <command id='stats interval <1-65535>'> |
| 857 | <params> |
| 858 | <param name='stats' doc='Configure stats sub-system' /> |
| 859 | <param name='interval' doc='Set the reporting interval' /> |
| 860 | <param name='<1-65535>' doc='Interval in seconds' /> |
| 861 | </params> |
| 862 | </command> |
| 863 | <command id='mgcp'> |
| 864 | <params> |
| 865 | <param name='mgcp' doc='Configure the MGCP' /> |
| 866 | </params> |
| 867 | </command> |
| 868 | </node> |
| 869 | <node id='config-log'> |
| 870 | <name>config-log</name> |
| 871 | <command id='logging filter all (0|1)'> |
| 872 | <params> |
| 873 | <param name='logging' doc='Configure logging' /> |
| 874 | <param name='filter' doc='Filter log messages' /> |
| 875 | <param name='all' doc='Do you want to log all messages?' /> |
| 876 | <param name='0' doc='Only print messages matched by other filters' /> |
| 877 | <param name='1' doc='Bypass filter and print all messages' /> |
| 878 | </params> |
| 879 | </command> |
| 880 | <command id='logging color (0|1)'> |
| 881 | <params> |
| 882 | <param name='logging' doc='Configure logging' /> |
| 883 | <param name='color' doc='Configure color-printing for log messages' /> |
| 884 | <param name='0' doc='Don't use color for printing messages' /> |
| 885 | <param name='1' doc='Use color for printing messages' /> |
| 886 | </params> |
| 887 | </command> |
| 888 | <command id='logging timestamp (0|1)'> |
| 889 | <params> |
| 890 | <param name='logging' doc='Configure logging' /> |
| 891 | <param name='timestamp' doc='Configure log message timestamping' /> |
| 892 | <param name='0' doc='Don't prefix each log message' /> |
| 893 | <param name='1' doc='Prefix each log message with current timestamp' /> |
| 894 | </params> |
| 895 | </command> |
| 896 | <command id='logging print extended-timestamp (0|1)'> |
| 897 | <params> |
| 898 | <param name='logging' doc='Configure logging' /> |
| 899 | <param name='print' doc='Log output settings' /> |
| 900 | <param name='extended-timestamp' doc='Configure log message timestamping' /> |
| 901 | <param name='0' doc='Don't prefix each log message' /> |
| 902 | <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> |
| 903 | </params> |
| 904 | </command> |
| 905 | <command id='logging print category (0|1)'> |
| 906 | <params> |
| 907 | <param name='logging' doc='Configure logging' /> |
| 908 | <param name='print' doc='Log output settings' /> |
| 909 | <param name='category' doc='Configure log message' /> |
| 910 | <param name='0' doc='Don't prefix each log message' /> |
| 911 | <param name='1' doc='Prefix each log message with category/subsystem name' /> |
| 912 | </params> |
| 913 | </command> |
| 914 | <command id='logging print category-hex (0|1)'> |
| 915 | <params> |
| 916 | <param name='logging' doc='Configure logging' /> |
| 917 | <param name='print' doc='Log output settings' /> |
| 918 | <param name='category-hex' doc='Configure log message' /> |
| 919 | <param name='0' doc='Don't prefix each log message' /> |
| 920 | <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> |
| 921 | </params> |
| 922 | </command> |
| 923 | <command id='logging print level (0|1)'> |
| 924 | <params> |
| 925 | <param name='logging' doc='Configure logging' /> |
| 926 | <param name='print' doc='Log output settings' /> |
| 927 | <param name='level' doc='Configure log message' /> |
| 928 | <param name='0' doc='Don't prefix each log message' /> |
| 929 | <param name='1' doc='Prefix each log message with the log level name' /> |
| 930 | </params> |
| 931 | </command> |
| 932 | <command id='logging print file (0|1|basename)'> |
| 933 | <params> |
| 934 | <param name='logging' doc='Configure logging' /> |
| 935 | <param name='print' doc='Log output settings' /> |
| 936 | <param name='file' doc='Configure log message' /> |
| 937 | <param name='0' doc='Don't prefix each log message' /> |
| 938 | <param name='1' doc='Prefix each log message with the source file and line' /> |
| 939 | <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> |
| 940 | </params> |
| 941 | </command> |
| 942 | <command id='logging level (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'> |
| 943 | <params> |
| 944 | <param name='logging' doc='Configure logging' /> |
| 945 | <param name='level' doc='Set the log level for a specified category' /> |
| 946 | <param name='all' doc='Global setting for all subsystems' /> |
| 947 | <param name='rtp' doc='RTP stream handling' /> |
| 948 | <param name='lglobal' doc='Library-internal global log family' /> |
| 949 | <param name='llapd' doc='LAPD in libosmogsm' /> |
| 950 | <param name='linp' doc='A-bis Intput Subsystem' /> |
| 951 | <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> |
| 952 | <param name='lmi' doc='A-bis Input Driver for Signalling' /> |
| 953 | <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> |
| 954 | <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> |
| 955 | <param name='lctrl' doc='Control Interface' /> |
| 956 | <param name='lgtp' doc='GPRS GTP library' /> |
| 957 | <param name='lstats' doc='Statistics messages and logging' /> |
| 958 | <param name='lgsup' doc='Generic Subscriber Update Protocol' /> |
| 959 | <param name='loap' doc='Osmocom Authentication Protocol' /> |
| 960 | <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> |
| 961 | <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> |
| 962 | <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> |
| 963 | <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> |
| 964 | <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> |
| 965 | <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> |
| 966 | <param name='everything' doc='Don't use. It doesn't log anything' /> |
| 967 | <param name='debug' doc='Log debug messages and higher levels' /> |
| 968 | <param name='info' doc='Log informational messages and higher levels' /> |
| 969 | <param name='notice' doc='Log noticeable messages and higher levels' /> |
| 970 | <param name='error' doc='Log error messages and higher levels' /> |
| 971 | <param name='fatal' doc='Log only fatal messages' /> |
| 972 | </params> |
| 973 | </command> |
| 974 | </node> |
| 975 | <node id='config-stats'> |
| 976 | <name>config-stats</name> |
| 977 | <command id='local-ip ADDR'> |
| 978 | <params> |
| 979 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 980 | <param name='ADDR' doc='IP Address' /> |
| 981 | </params> |
| 982 | </command> |
| 983 | <command id='no local-ip'> |
| 984 | <params> |
| 985 | <param name='no' doc='Negate a command or set its defaults' /> |
| 986 | <param name='local-ip' doc='Set the IP address to which we bind locally' /> |
| 987 | </params> |
| 988 | </command> |
| 989 | <command id='remote-ip ADDR'> |
| 990 | <params> |
| 991 | <param name='remote-ip' doc='Set the remote IP address to which we connect' /> |
| 992 | <param name='ADDR' doc='IP Address' /> |
| 993 | </params> |
| 994 | </command> |
| 995 | <command id='remote-port <1-65535>'> |
| 996 | <params> |
| 997 | <param name='remote-port' doc='Set the remote port to which we connect' /> |
| 998 | <param name='<1-65535>' doc='Remote port number' /> |
| 999 | </params> |
| 1000 | </command> |
| 1001 | <command id='mtu <100-65535>'> |
| 1002 | <params> |
| 1003 | <param name='mtu' doc='Set the maximum packet size' /> |
| 1004 | <param name='<100-65535>' doc='Size in byte' /> |
| 1005 | </params> |
| 1006 | </command> |
| 1007 | <command id='no mtu'> |
| 1008 | <params> |
| 1009 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1010 | <param name='mtu' doc='Set the maximum packet size' /> |
| 1011 | </params> |
| 1012 | </command> |
| 1013 | <command id='prefix PREFIX'> |
| 1014 | <params> |
| 1015 | <param name='prefix' doc='Set the item name prefix' /> |
| 1016 | <param name='PREFIX' doc='The prefix string' /> |
| 1017 | </params> |
| 1018 | </command> |
| 1019 | <command id='no prefix'> |
| 1020 | <params> |
| 1021 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1022 | <param name='prefix' doc='Set the item name prefix' /> |
| 1023 | </params> |
| 1024 | </command> |
| 1025 | <command id='level (global|peer|subscriber)'> |
| 1026 | <params> |
| 1027 | <param name='level' doc='Set the maximum group level' /> |
| 1028 | <param name='global' doc='Report global groups only' /> |
| 1029 | <param name='peer' doc='Report global and network peer related groups' /> |
| 1030 | <param name='subscriber' doc='Report global, peer, and subscriber groups' /> |
| 1031 | </params> |
| 1032 | </command> |
| 1033 | <command id='enable'> |
| 1034 | <params> |
| 1035 | <param name='enable' doc='Enable the reporter' /> |
| 1036 | </params> |
| 1037 | </command> |
| 1038 | <command id='disable'> |
| 1039 | <params> |
| 1040 | <param name='disable' doc='Disable the reporter' /> |
| 1041 | </params> |
| 1042 | </command> |
| 1043 | </node> |
| 1044 | <node id='config-line'> |
| 1045 | <name>config-line</name> |
| 1046 | <command id='login'> |
| 1047 | <params> |
| 1048 | <param name='login' doc='Enable password checking' /> |
| 1049 | </params> |
| 1050 | </command> |
| 1051 | <command id='no login'> |
| 1052 | <params> |
| 1053 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1054 | <param name='login' doc='Enable password checking' /> |
| 1055 | </params> |
| 1056 | </command> |
| 1057 | <command id='bind A.B.C.D'> |
| 1058 | <params> |
| 1059 | <param name='bind' doc='Accept VTY telnet connections on local interface' /> |
| 1060 | <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> |
| 1061 | </params> |
| 1062 | </command> |
| 1063 | </node> |
| 1064 | <node id='config-mgcp'> |
| 1065 | <name>config-mgcp</name> |
| 1066 | <command id='local ip A.B.C.D'> |
| 1067 | <params> |
| 1068 | <param name='local' doc='Local options for the SDP record' /> |
| 1069 | <param name='ip' doc='IP information' /> |
| 1070 | <param name='A.B.C.D' doc='IPv4 Address to use in SDP record' /> |
| 1071 | </params> |
| 1072 | </command> |
| 1073 | <command id='bind ip A.B.C.D'> |
| 1074 | <params> |
| 1075 | <param name='bind' doc='Listen/Bind related socket option' /> |
| 1076 | <param name='ip' doc='IP information' /> |
| 1077 | <param name='A.B.C.D' doc='IPv4 Address to bind to' /> |
| 1078 | </params> |
| 1079 | </command> |
| 1080 | <command id='bind port <0-65534>'> |
| 1081 | <params> |
| 1082 | <param name='bind' doc='Listen/Bind related socket option' /> |
| 1083 | <param name='port' doc='Port information' /> |
| 1084 | <param name='<0-65534>' doc='UDP port to listen for MGCP messages' /> |
| 1085 | </params> |
| 1086 | </command> |
| 1087 | <command id='bind early (0|1)'> |
| 1088 | <params> |
| 1089 | <param name='bind' doc='Listen/Bind related socket option' /> |
| 1090 | <param name='early' doc='Bind local ports on start up' /> |
| 1091 | <param name='0' doc='Bind on demand' /> |
| 1092 | <param name='1' doc='Bind on startup' /> |
| 1093 | </params> |
| 1094 | </command> |
| Daniel Willmann | e5ed946 | 2018-07-31 18:54:34 +0200 | [diff] [blame^] | 1095 | <command id='rtp port-range <1024-65534> <1025-65535>'> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1096 | <params> |
| 1097 | <param name='rtp' doc='RTP configuration' /> |
| 1098 | <param name='port-range' doc='Range of ports to use for the NET side' /> |
| Daniel Willmann | e5ed946 | 2018-07-31 18:54:34 +0200 | [diff] [blame^] | 1099 | <param name='<1024-65534>' doc='Start of the range of ports' /> |
| 1100 | <param name='<1025-65535>' doc='End of the range of ports' /> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1101 | </params> |
| 1102 | </command> |
| 1103 | <command id='rtp bind-ip A.B.C.D'> |
| 1104 | <params> |
| 1105 | <param name='rtp' doc='RTP configuration' /> |
| 1106 | <param name='bind-ip' doc='Bind endpoints facing the Network' /> |
| 1107 | <param name='A.B.C.D' doc='Address to bind to' /> |
| 1108 | </params> |
| 1109 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1110 | <command id='no rtp bind-ip'> |
| 1111 | <params> |
| 1112 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1113 | <param name='rtp' doc='RTP configuration' /> |
| 1114 | <param name='bind-ip' doc='Bind endpoints facing the Network' /> |
| 1115 | </params> |
| 1116 | </command> |
| 1117 | <command id='rtp ip-probing'> |
| 1118 | <params> |
| 1119 | <param name='rtp' doc='RTP configuration' /> |
| 1120 | <param name='ip-probing' doc='automatic rtp bind ip selection' /> |
| 1121 | </params> |
| 1122 | </command> |
| 1123 | <command id='no rtp ip-probing'> |
| 1124 | <params> |
| 1125 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1126 | <param name='rtp' doc='RTP configuration' /> |
| 1127 | <param name='ip-probing' doc='no automatic rtp bind ip selection' /> |
| 1128 | </params> |
| 1129 | </command> |
| 1130 | <command id='rtp ip-dscp <0-255>'> |
| 1131 | <params> |
| 1132 | <param name='rtp' doc='RTP configuration' /> |
| 1133 | <param name='ip-dscp' doc='Apply IP_TOS to the audio stream (including Osmux)' /> |
| 1134 | <param name='<0-255>' doc='The DSCP value' /> |
| 1135 | </params> |
| 1136 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1137 | <command id='rtp force-ptime (10|20|40)'> |
| 1138 | <params> |
| 1139 | <param name='rtp' doc='RTP configuration' /> |
| 1140 | <param name='force-ptime' doc='Force a fixed ptime for packets sentThe required ptime (packet duration) in ms' /> |
| 1141 | <param name='10' doc='10 ms' /> |
| 1142 | <param name='20' doc='20 ms' /> |
| 1143 | <param name='40' doc='40 ms' /> |
| 1144 | </params> |
| 1145 | </command> |
| 1146 | <command id='no rtp force-ptime'> |
| 1147 | <params> |
| 1148 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1149 | <param name='rtp' doc='RTP configuration' /> |
| 1150 | <param name='force-ptime' doc='Force a fixed ptime for packets sent' /> |
| 1151 | </params> |
| 1152 | </command> |
| 1153 | <command id='rtp keep-alive <1-120>'> |
| 1154 | <params> |
| 1155 | <param name='rtp' doc='RTP configuration' /> |
| 1156 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1157 | <param name='<1-120>' doc='Keep alive interval in secs' /> |
| 1158 | </params> |
| 1159 | </command> |
| 1160 | <command id='rtp keep-alive once'> |
| 1161 | <params> |
| 1162 | <param name='rtp' doc='RTP configuration' /> |
| 1163 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1164 | <param name='once' doc='Send dummy packet only once after CRCX/MDCX' /> |
| 1165 | </params> |
| 1166 | </command> |
| 1167 | <command id='no rtp keep-alive'> |
| 1168 | <params> |
| 1169 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1170 | <param name='rtp' doc='RTP configuration' /> |
| 1171 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1172 | </params> |
| 1173 | </command> |
| 1174 | <command id='call-agent ip A.B.C.D'> |
| 1175 | <params> |
| 1176 | <param name='call-agent' doc='Callagent information' /> |
| 1177 | <param name='ip' doc='IP information' /> |
| 1178 | <param name='A.B.C.D' doc='IPv4 Address of the callagent' /> |
| 1179 | </params> |
| 1180 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1181 | <command id='sdp audio-payload number <0-255>'> |
| 1182 | <params> |
| 1183 | <param name='sdp' doc='SDP File related options' /> |
| 1184 | <param name='audio-payload' doc='Audio payload options' /> |
| 1185 | <param name='number' doc='Number' /> |
| 1186 | <param name='<0-255>' doc='Payload number' /> |
| 1187 | </params> |
| 1188 | </command> |
| 1189 | <command id='sdp audio-payload name NAME'> |
| 1190 | <params> |
| 1191 | <param name='sdp' doc='SDP File related options' /> |
| 1192 | <param name='audio-payload' doc='Audio payload options' /> |
| 1193 | <param name='name' doc='Name' /> |
| 1194 | <param name='NAME' doc='Payload name' /> |
| 1195 | </params> |
| 1196 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1197 | <command id='loop (0|1)'> |
| 1198 | <params> |
| 1199 | <param name='loop' doc='Loop audio for all endpoints on main trunk' /> |
| 1200 | <param name='0' doc='Don't Loop' /> |
| 1201 | <param name='1' doc='Loop' /> |
| 1202 | </params> |
| 1203 | </command> |
| 1204 | <command id='force-realloc (0|1)'> |
| 1205 | <params> |
| 1206 | <param name='force-realloc' doc='Force endpoint reallocation when the endpoint is still seized' /> |
| 1207 | <param name='0' doc='Don't force reallocation' /> |
| 1208 | <param name='1' doc='force reallocation' /> |
| 1209 | </params> |
| 1210 | </command> |
| 1211 | <command id='rtp-accept-all (0|1)'> |
| 1212 | <params> |
| 1213 | <param name='rtp-accept-all' doc='Accept all RTP packets, even when the originating IP/Port does not match' /> |
| 1214 | <param name='0' doc='enable filter' /> |
| 1215 | <param name='1' doc='disable filter' /> |
| 1216 | </params> |
| 1217 | </command> |
| 1218 | <command id='number endpoints <0-65534>'> |
| 1219 | <params> |
| 1220 | <param name='number' doc='Number options' /> |
| 1221 | <param name='endpoints' doc='Endpoints available' /> |
| 1222 | <param name='<0-65534>' doc='Number endpoints' /> |
| 1223 | </params> |
| 1224 | </command> |
| 1225 | <command id='rtcp-omit'> |
| 1226 | <params> |
| 1227 | <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> |
| 1228 | </params> |
| 1229 | </command> |
| 1230 | <command id='no rtcp-omit'> |
| 1231 | <params> |
| 1232 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1233 | <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> |
| 1234 | </params> |
| 1235 | </command> |
| 1236 | <command id='rtp-patch ssrc'> |
| 1237 | <params> |
| 1238 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1239 | <param name='ssrc' doc='Force a fixed SSRC' /> |
| 1240 | </params> |
| 1241 | </command> |
| 1242 | <command id='no rtp-patch ssrc'> |
| 1243 | <params> |
| 1244 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1245 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1246 | <param name='ssrc' doc='Force a fixed SSRC' /> |
| 1247 | </params> |
| 1248 | </command> |
| 1249 | <command id='rtp-patch timestamp'> |
| 1250 | <params> |
| 1251 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1252 | <param name='timestamp' doc='Adjust RTP timestamp' /> |
| 1253 | </params> |
| 1254 | </command> |
| 1255 | <command id='no rtp-patch timestamp'> |
| 1256 | <params> |
| 1257 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1258 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1259 | <param name='timestamp' doc='Adjust RTP timestamp' /> |
| 1260 | </params> |
| 1261 | </command> |
| 1262 | <command id='no rtp-patch'> |
| 1263 | <params> |
| 1264 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1265 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1266 | </params> |
| 1267 | </command> |
| 1268 | <command id='sdp audio fmtp-extra .NAME'> |
| 1269 | <params> |
| 1270 | <param name='sdp' doc='Add extra fmtp for the SDP file' /> |
| 1271 | <param name='audio' doc='Audio' /> |
| 1272 | <param name='fmtp-extra' doc='Fmtp-extra' /> |
| 1273 | <param name='.NAME' doc='Extra Information' /> |
| 1274 | </params> |
| 1275 | </command> |
| 1276 | <command id='sdp audio-payload send-ptime'> |
| 1277 | <params> |
| 1278 | <param name='sdp' doc='SDP File related options' /> |
| 1279 | <param name='audio-payload' doc='Audio payload options' /> |
| 1280 | <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> |
| 1281 | </params> |
| 1282 | </command> |
| 1283 | <command id='no sdp audio-payload send-ptime'> |
| 1284 | <params> |
| 1285 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1286 | <param name='sdp' doc='SDP File related options' /> |
| 1287 | <param name='audio-payload' doc='Audio payload options' /> |
| 1288 | <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> |
| 1289 | </params> |
| 1290 | </command> |
| 1291 | <command id='sdp audio-payload send-name'> |
| 1292 | <params> |
| 1293 | <param name='sdp' doc='SDP File related options' /> |
| 1294 | <param name='audio-payload' doc='Audio payload options' /> |
| 1295 | <param name='send-name' doc='Send SDP rtpmap with the audio name' /> |
| 1296 | </params> |
| 1297 | </command> |
| 1298 | <command id='no sdp audio-payload send-name'> |
| 1299 | <params> |
| 1300 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1301 | <param name='sdp' doc='SDP File related options' /> |
| 1302 | <param name='audio-payload' doc='Audio payload options' /> |
| 1303 | <param name='send-name' doc='Send SDP rtpmap with the audio name' /> |
| 1304 | </params> |
| 1305 | </command> |
| 1306 | <command id='osmux (on|off|only)'> |
| 1307 | <params> |
| 1308 | <param name='osmux' doc='RTP multiplexing' /> |
| 1309 | <param name='on' doc='Enable OSMUX' /> |
| 1310 | <param name='off' doc='Disable OSMUX' /> |
| 1311 | <param name='only' doc='Only use OSMUX' /> |
| 1312 | </params> |
| 1313 | </command> |
| 1314 | <command id='osmux bind-ip A.B.C.D'> |
| 1315 | <params> |
| 1316 | <param name='osmux' doc='RTP multiplexing' /> |
| 1317 | <param name='bind-ip' doc='IP information' /> |
| 1318 | <param name='A.B.C.D' doc='IPv4 Address to bind to' /> |
| 1319 | </params> |
| 1320 | </command> |
| 1321 | <command id='osmux batch-factor <1-8>'> |
| 1322 | <params> |
| 1323 | <param name='osmux' doc='RTP multiplexing' /> |
| 1324 | <param name='batch-factor' doc='Batching factor' /> |
| 1325 | <param name='<1-8>' doc='Number of messages in the batch' /> |
| 1326 | </params> |
| 1327 | </command> |
| 1328 | <command id='osmux batch-size <1-65535>'> |
| 1329 | <params> |
| 1330 | <param name='osmux' doc='RTP multiplexing' /> |
| 1331 | <param name='batch-size' doc='batch size' /> |
| 1332 | <param name='<1-65535>' doc='Batch size in bytes' /> |
| 1333 | </params> |
| 1334 | </command> |
| 1335 | <command id='osmux port <1-65535>'> |
| 1336 | <params> |
| 1337 | <param name='osmux' doc='RTP multiplexing' /> |
| 1338 | <param name='port' doc='port' /> |
| 1339 | <param name='<1-65535>' doc='UDP port' /> |
| 1340 | </params> |
| 1341 | </command> |
| 1342 | <command id='osmux dummy (on|off)'> |
| 1343 | <params> |
| 1344 | <param name='osmux' doc='RTP multiplexing' /> |
| 1345 | <param name='dummy' doc='Dummy padding' /> |
| 1346 | <param name='on' doc='Enable dummy padding' /> |
| 1347 | <param name='off' doc='Disable dummy padding' /> |
| 1348 | </params> |
| 1349 | </command> |
| 1350 | <command id='allow-transcoding'> |
| 1351 | <params> |
| 1352 | <param name='allow-transcoding' doc='Allow transcoding' /> |
| 1353 | </params> |
| 1354 | </command> |
| 1355 | <command id='no allow-transcoding'> |
| 1356 | <params> |
| 1357 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1358 | <param name='allow-transcoding' doc='Allow transcoding' /> |
| 1359 | </params> |
| 1360 | </command> |
| 1361 | <command id='domain NAME'> |
| 1362 | <params> |
| 1363 | <param name='domain' doc='domain' /> |
| 1364 | <param name='NAME' doc='qualified domain name' /> |
| 1365 | </params> |
| 1366 | </command> |
| 1367 | <command id='trunk <1-64>'> |
| 1368 | <params> |
| 1369 | <param name='trunk' doc='Configure a SS7 trunk' /> |
| 1370 | <param name='<1-64>' doc='Trunk Nr' /> |
| 1371 | </params> |
| 1372 | </command> |
| 1373 | </node> |
| 1374 | <node id='config-mgcp-trunk'> |
| 1375 | <name>config-mgcp-trunk</name> |
| 1376 | <command id='rtp keep-alive <1-120>'> |
| 1377 | <params> |
| 1378 | <param name='rtp' doc='RTP configuration' /> |
| 1379 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1380 | <param name='<1-120>' doc='Keep-alive interval in secs' /> |
| 1381 | </params> |
| 1382 | </command> |
| 1383 | <command id='rtp keep-alive once'> |
| 1384 | <params> |
| 1385 | <param name='rtp' doc='RTP configuration' /> |
| 1386 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1387 | <param name='once' doc='Send dummy packet only once after CRCX/MDCX' /> |
| 1388 | </params> |
| 1389 | </command> |
| 1390 | <command id='no rtp keep-alive'> |
| 1391 | <params> |
| 1392 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1393 | <param name='rtp' doc='RTP configuration' /> |
| 1394 | <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> |
| 1395 | </params> |
| 1396 | </command> |
| 1397 | <command id='sdp audio-payload number <0-255>'> |
| 1398 | <params> |
| 1399 | <param name='sdp' doc='SDP File related options' /> |
| 1400 | <param name='audio-payload' doc='Audio payload options' /> |
| 1401 | <param name='number' doc='Number' /> |
| 1402 | <param name='<0-255>' doc='Payload Number' /> |
| 1403 | </params> |
| 1404 | </command> |
| 1405 | <command id='sdp audio-payload name NAME'> |
| 1406 | <params> |
| 1407 | <param name='sdp' doc='SDP File related options' /> |
| 1408 | <param name='audio-payload' doc='Audio payload options' /> |
| 1409 | <param name='name' doc='Payload' /> |
| 1410 | <param name='NAME' doc='Payload Name' /> |
| 1411 | </params> |
| 1412 | </command> |
| Neels Hofmeyr | 2818db8 | 2018-03-06 14:59:00 +0100 | [diff] [blame] | 1413 | <command id='loop (0|1)'> |
| 1414 | <params> |
| 1415 | <param name='loop' doc='Loop audio for all endpoints on this trunk' /> |
| 1416 | <param name='0' doc='Don't Loop' /> |
| 1417 | <param name='1' doc='Loop' /> |
| 1418 | </params> |
| 1419 | </command> |
| 1420 | <command id='rtcp-omit'> |
| 1421 | <params> |
| 1422 | <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> |
| 1423 | </params> |
| 1424 | </command> |
| 1425 | <command id='no rtcp-omit'> |
| 1426 | <params> |
| 1427 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1428 | <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> |
| 1429 | </params> |
| 1430 | </command> |
| 1431 | <command id='rtp-patch ssrc'> |
| 1432 | <params> |
| 1433 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1434 | <param name='ssrc' doc='Force a fixed SSRC' /> |
| 1435 | </params> |
| 1436 | </command> |
| 1437 | <command id='no rtp-patch ssrc'> |
| 1438 | <params> |
| 1439 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1440 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1441 | <param name='ssrc' doc='Force a fixed SSRC' /> |
| 1442 | </params> |
| 1443 | </command> |
| 1444 | <command id='rtp-patch timestamp'> |
| 1445 | <params> |
| 1446 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1447 | <param name='timestamp' doc='Adjust RTP timestamp' /> |
| 1448 | </params> |
| 1449 | </command> |
| 1450 | <command id='no rtp-patch timestamp'> |
| 1451 | <params> |
| 1452 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1453 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1454 | <param name='timestamp' doc='Adjust RTP timestamp' /> |
| 1455 | </params> |
| 1456 | </command> |
| 1457 | <command id='no rtp-patch'> |
| 1458 | <params> |
| 1459 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1460 | <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> |
| 1461 | </params> |
| 1462 | </command> |
| 1463 | <command id='sdp audio fmtp-extra .NAME'> |
| 1464 | <params> |
| 1465 | <param name='sdp' doc='Add extra fmtp for the SDP file' /> |
| 1466 | <param name='audio' doc='Audio' /> |
| 1467 | <param name='fmtp-extra' doc='Fmtp-extra' /> |
| 1468 | <param name='.NAME' doc='Extra Information' /> |
| 1469 | </params> |
| 1470 | </command> |
| 1471 | <command id='sdp audio-payload send-ptime'> |
| 1472 | <params> |
| 1473 | <param name='sdp' doc='SDP File related options' /> |
| 1474 | <param name='audio-payload' doc='Audio payload options' /> |
| 1475 | <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> |
| 1476 | </params> |
| 1477 | </command> |
| 1478 | <command id='no sdp audio-payload send-ptime'> |
| 1479 | <params> |
| 1480 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1481 | <param name='sdp' doc='SDP File related options' /> |
| 1482 | <param name='audio-payload' doc='Audio payload options' /> |
| 1483 | <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> |
| 1484 | </params> |
| 1485 | </command> |
| 1486 | <command id='sdp audio-payload send-name'> |
| 1487 | <params> |
| 1488 | <param name='sdp' doc='SDP File related options' /> |
| 1489 | <param name='audio-payload' doc='Audio payload options' /> |
| 1490 | <param name='send-name' doc='Send SDP rtpmap with the audio name' /> |
| 1491 | </params> |
| 1492 | </command> |
| 1493 | <command id='no sdp audio-payload send-name'> |
| 1494 | <params> |
| 1495 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1496 | <param name='sdp' doc='SDP File related options' /> |
| 1497 | <param name='audio-payload' doc='Audio payload options' /> |
| 1498 | <param name='send-name' doc='Send SDP rtpmap with the audio name' /> |
| 1499 | </params> |
| 1500 | </command> |
| 1501 | <command id='allow-transcoding'> |
| 1502 | <params> |
| 1503 | <param name='allow-transcoding' doc='Allow transcoding' /> |
| 1504 | </params> |
| 1505 | </command> |
| 1506 | <command id='no allow-transcoding'> |
| 1507 | <params> |
| 1508 | <param name='no' doc='Negate a command or set its defaults' /> |
| 1509 | <param name='allow-transcoding' doc='Allow transcoding' /> |
| 1510 | </params> |
| 1511 | </command> |
| 1512 | </node> |
| 1513 | </vtydoc> |