2018-03-06 13:59:00 +00:00
<vtydoc xmlns= 'urn:osmocom:xml:libosmocore:vty:doc:1.0' >
<node id= '_common_cmds_' >
<name > Common Commands</name>
<description > These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
<command id= 'help' >
<params >
<param name= 'help' doc= 'Description of the interactive help system' />
</params>
</command>
<command id= 'list' >
<params >
<param name= 'list' doc= 'Print command list' />
</params>
</command>
<command id= 'write terminal' >
<params >
<param name= 'write' doc= 'Write running configuration to memory, network, or terminal' />
<param name= 'terminal' doc= 'Write to terminal' />
</params>
</command>
<command id= 'write file' >
<params >
<param name= 'write' doc= 'Write running configuration to memory, network, or terminal' />
<param name= 'file' doc= 'Write to configuration file' />
</params>
</command>
<command id= 'write memory' >
<params >
<param name= 'write' doc= 'Write running configuration to memory, network, or terminal' />
<param name= 'memory' doc= 'Write configuration to the file (same as write file)' />
</params>
</command>
<command id= 'write' >
<params >
<param name= 'write' doc= 'Write running configuration to memory, network, or terminal' />
</params>
</command>
<command id= 'show running-config' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'running-config' doc= 'running configuration' />
</params>
</command>
<command id= 'exit' >
<params >
<param name= 'exit' doc= 'Exit current mode and down to previous mode' />
</params>
</command>
<command id= 'end' >
<params >
<param name= 'end' doc= 'End current mode and change to enable mode.' />
</params>
</command>
</node>
<node id= 'view' >
<name > view</name>
<command id= 'show version' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'version' doc= 'Displays program version' />
</params>
</command>
<command id= 'show online-help' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'online-help' doc= 'Online help' />
</params>
</command>
<command id= 'enable' >
<params >
<param name= 'enable' doc= 'Turn on privileged mode command' />
</params>
</command>
<command id= 'terminal length <0-512>' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'length' doc= 'Set number of lines on a screen' />
<param name= '<0-512>' doc= 'Number of lines on screen (0 for no pausing)' />
</params>
</command>
<command id= 'terminal no length' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'length' doc= 'Set number of lines on a screen' />
</params>
</command>
<command id= 'who' >
<params >
<param name= 'who' doc= 'Display who is on vty' />
</params>
</command>
<command id= 'show history' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'history' doc= 'Display the session command history' />
</params>
</command>
<command id= 'logging enable' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'enable' doc= 'Enables logging to this vty' />
</params>
</command>
<command id= 'logging disable' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'disable' doc= 'Disables logging to this vty' />
</params>
</command>
<command id= 'logging filter all (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'filter' doc= 'Filter log messages' />
<param name= 'all' doc= 'Do you want to log all messages?' />
<param name= '0' doc= 'Only print messages matched by other filters' />
<param name= '1' doc= 'Bypass filter and print all messages' />
</params>
</command>
<command id= 'logging color (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'color' doc= 'Configure color-printing for log messages' />
<param name= '0' doc= 'Don't use color for printing messages' />
<param name= '1' doc= 'Use color for printing messages' />
</params>
</command>
<command id= 'logging timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp' />
</params>
</command>
<command id= 'logging print extended-timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'extended-timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
</params>
</command>
<command id= 'logging print category (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem name' />
</params>
</command>
<command id= 'logging print category-hex (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category-hex' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem nr in hex ('<000b>')' />
</params>
</command>
<command id= 'logging print level (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'level' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the log level name' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'file' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the source file and line' />
<param name= 'basename' doc= 'Prefix each log message with the source file's basename (strip leading paths) and line' />
2018-11-05 02:18:55 +00:00
<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.' />
2018-03-06 13:59:00 +00:00
</params>
</command>
<command id= 'logging set-log-mask MASK' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'set-log-mask' doc= 'Set the logmask of this logging target' />
<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' />
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'rtp' doc= 'RTP stream handling' />
<param name= 'lglobal' doc= 'Library-internal global log family' />
<param name= 'llapd' doc= 'LAPD in libosmogsm' />
<param name= 'linp' doc= 'A-bis Intput Subsystem' />
<param name= 'lmux' doc= 'A-bis B-Subchannel TRAU Frame Multiplex' />
<param name= 'lmi' doc= 'A-bis Input Driver for Signalling' />
<param name= 'lmib' doc= 'A-bis Input Driver for B-Channels (voice)' />
<param name= 'lsms' doc= 'Layer3 Short Message Service (SMS)' />
<param name= 'lctrl' doc= 'Control Interface' />
<param name= 'lgtp' doc= 'GPRS GTP library' />
<param name= 'lstats' doc= 'Statistics messages and logging' />
<param name= 'lgsup' doc= 'Generic Subscriber Update Protocol' />
<param name= 'loap' doc= 'Osmocom Authentication Protocol' />
<param name= 'lss7' doc= 'libosmo-sigtran Signalling System 7' />
<param name= 'lsccp' doc= 'libosmo-sigtran SCCP Implementation' />
<param name= 'lsua' doc= 'libosmo-sigtran SCCP User Adaptation' />
<param name= 'lm3ua' doc= 'libosmo-sigtran MTP3 User Adaptation' />
<param name= 'lmgcp' doc= 'libosmo-mgcp Media Gateway Control Protocol' />
<param name= 'ljibuf' doc= 'libosmo-netif Jitter Buffer' />
2019-06-19 12:08:22 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
2018-03-06 13:59:00 +00:00
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging level set-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
<command id= 'logging level force-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
<command id= 'no logging level force-all' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'force-all' doc= 'Release any globally forced log level set with 'logging level force-all <level>'' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'show logging vty' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'logging' doc= 'Show current logging configuration' />
<param name= 'vty' doc= 'Show current logging configuration for this vty' />
</params>
</command>
<command id= 'show alarms' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'alarms' doc= 'Show current logging configuration' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH)' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
<param name= 'tree' doc= 'Display only a specific memory chunk' />
<param name= 'ADDRESS' doc= 'Chunk address (e.g. 0xdeadbeef)' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
<param name= 'filter' doc= 'Filter chunks using regular expression' />
<param name= 'REGEXP' doc= 'Regular expression' />
</params>
</command>
<command id= 'show stats' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'stats' doc= 'Show statistical values' />
</params>
</command>
<command id= 'show stats level (global|peer|subscriber)' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'stats' doc= 'Show statistical values' />
<param name= 'level' doc= 'Set the maximum group level' />
<param name= 'global' doc= 'Show global groups only' />
<param name= 'peer' doc= 'Show global and network peer related groups' />
<param name= 'subscriber' doc= 'Show global, peer, and subscriber groups' />
</params>
</command>
<command id= 'show asciidoc counters' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'asciidoc' doc= 'Asciidoc generation' />
<param name= 'counters' doc= 'Generate table of all registered counters' />
</params>
</command>
2018-07-31 16:54:34 +00:00
<command id= 'show rate-counters' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'rate-counters' doc= 'Show all rate counters' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'show mgcp [stats]' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= '[stats]' doc= 'Include Statistics' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'show mgcp endpoint NAME' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= 'endpoint' doc= 'Display information about an endpoint' />
<param name= 'NAME' doc= 'The name of the endpoint' />
</params>
</command>
<command id= 'show mgcp trunk <0-64> endpoint NAME' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= 'trunk' doc= 'Display information about a trunk' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'endpoint' doc= 'Display information about an endpoint' />
<param name= 'NAME' doc= 'The name of the endpoint' />
</params>
</command>
2018-03-06 13:59:00 +00:00
</node>
<node id= 'enable' >
<name > enable</name>
<command id= 'disable' >
<params >
<param name= 'disable' doc= 'Turn off privileged mode command' />
</params>
</command>
<command id= 'configure terminal' >
<params >
<param name= 'configure' doc= 'Configuration from vty interface' />
<param name= 'terminal' doc= 'Configuration terminal' />
</params>
</command>
<command id= 'copy running-config startup-config' >
<params >
<param name= 'copy' doc= 'Copy configuration' />
<param name= 'running-config' doc= 'Copy running config to... ' />
<param name= 'startup-config' doc= 'Copy running config to startup config (same as write file)' />
</params>
</command>
<command id= 'show startup-config' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'startup-config' doc= 'Contentes of startup configuration' />
</params>
</command>
<command id= 'show version' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'version' doc= 'Displays program version' />
</params>
</command>
<command id= 'show online-help' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'online-help' doc= 'Online help' />
</params>
</command>
<command id= 'terminal length <0-512>' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'length' doc= 'Set number of lines on a screen' />
<param name= '<0-512>' doc= 'Number of lines on screen (0 for no pausing)' />
</params>
</command>
<command id= 'terminal no length' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'length' doc= 'Set number of lines on a screen' />
</params>
</command>
<command id= 'who' >
<params >
<param name= 'who' doc= 'Display who is on vty' />
</params>
</command>
<command id= 'show history' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'history' doc= 'Display the session command history' />
</params>
</command>
<command id= 'terminal monitor' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'monitor' doc= 'Copy debug output to the current terminal line' />
</params>
</command>
<command id= 'terminal no monitor' >
<params >
<param name= 'terminal' doc= 'Set terminal line parameters' />
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'monitor' doc= 'Copy debug output to the current terminal line' />
</params>
</command>
<command id= 'logging enable' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'enable' doc= 'Enables logging to this vty' />
</params>
</command>
<command id= 'logging disable' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'disable' doc= 'Disables logging to this vty' />
</params>
</command>
<command id= 'logging filter all (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'filter' doc= 'Filter log messages' />
<param name= 'all' doc= 'Do you want to log all messages?' />
<param name= '0' doc= 'Only print messages matched by other filters' />
<param name= '1' doc= 'Bypass filter and print all messages' />
</params>
</command>
<command id= 'logging color (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'color' doc= 'Configure color-printing for log messages' />
<param name= '0' doc= 'Don't use color for printing messages' />
<param name= '1' doc= 'Use color for printing messages' />
</params>
</command>
<command id= 'logging timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp' />
</params>
</command>
<command id= 'logging print extended-timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'extended-timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
</params>
</command>
<command id= 'logging print category (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem name' />
</params>
</command>
<command id= 'logging print category-hex (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category-hex' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem nr in hex ('<000b>')' />
</params>
</command>
<command id= 'logging print level (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'level' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the log level name' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'file' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the source file and line' />
<param name= 'basename' doc= 'Prefix each log message with the source file's basename (strip leading paths) and line' />
2018-11-05 02:18:55 +00:00
<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.' />
2018-03-06 13:59:00 +00:00
</params>
</command>
<command id= 'logging set-log-mask MASK' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'set-log-mask' doc= 'Set the logmask of this logging target' />
<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' />
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'rtp' doc= 'RTP stream handling' />
<param name= 'lglobal' doc= 'Library-internal global log family' />
<param name= 'llapd' doc= 'LAPD in libosmogsm' />
<param name= 'linp' doc= 'A-bis Intput Subsystem' />
<param name= 'lmux' doc= 'A-bis B-Subchannel TRAU Frame Multiplex' />
<param name= 'lmi' doc= 'A-bis Input Driver for Signalling' />
<param name= 'lmib' doc= 'A-bis Input Driver for B-Channels (voice)' />
<param name= 'lsms' doc= 'Layer3 Short Message Service (SMS)' />
<param name= 'lctrl' doc= 'Control Interface' />
<param name= 'lgtp' doc= 'GPRS GTP library' />
<param name= 'lstats' doc= 'Statistics messages and logging' />
<param name= 'lgsup' doc= 'Generic Subscriber Update Protocol' />
<param name= 'loap' doc= 'Osmocom Authentication Protocol' />
<param name= 'lss7' doc= 'libosmo-sigtran Signalling System 7' />
<param name= 'lsccp' doc= 'libosmo-sigtran SCCP Implementation' />
<param name= 'lsua' doc= 'libosmo-sigtran SCCP User Adaptation' />
<param name= 'lm3ua' doc= 'libosmo-sigtran MTP3 User Adaptation' />
<param name= 'lmgcp' doc= 'libosmo-mgcp Media Gateway Control Protocol' />
<param name= 'ljibuf' doc= 'libosmo-netif Jitter Buffer' />
2019-06-19 12:08:22 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
2018-03-06 13:59:00 +00:00
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging level set-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
2019-06-19 12:08:22 +00:00
<param name= 'error' doc= 'Log error messages and higher levels' /> <param name= 'fatal' doc= 'Log only fatal messages' />
2018-11-05 02:18:55 +00:00
</params>
</command>
<command id= 'logging level force-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
<command id= 'no logging level force-all' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'force-all' doc= 'Release any globally forced log level set with 'logging level force-all <level>'' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'show logging vty' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'logging' doc= 'Show current logging configuration' />
<param name= 'vty' doc= 'Show current logging configuration for this vty' />
</params>
</command>
<command id= 'show alarms' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'alarms' doc= 'Show current logging configuration' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH)' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
<param name= 'tree' doc= 'Display only a specific memory chunk' />
<param name= 'ADDRESS' doc= 'Chunk address (e.g. 0xdeadbeef)' />
</params>
</command>
<command id= 'show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'talloc-context' doc= 'Show talloc memory hierarchy' />
<param name= 'application' doc= 'Application's context' />
<param name= 'all' doc= 'All contexts, if NULL-context tracking is enabled' />
<param name= 'full' doc= 'Display a full talloc memory hierarchy' />
<param name= 'brief' doc= 'Display a brief talloc memory hierarchy' />
<param name= 'DEPTH' doc= 'Specify required maximal depth value' />
<param name= 'filter' doc= 'Filter chunks using regular expression' />
<param name= 'REGEXP' doc= 'Regular expression' />
</params>
</command>
<command id= 'show stats' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'stats' doc= 'Show statistical values' />
</params>
</command>
<command id= 'show stats level (global|peer|subscriber)' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'stats' doc= 'Show statistical values' />
<param name= 'level' doc= 'Set the maximum group level' />
<param name= 'global' doc= 'Show global groups only' />
<param name= 'peer' doc= 'Show global and network peer related groups' />
<param name= 'subscriber' doc= 'Show global, peer, and subscriber groups' />
</params>
</command>
<command id= 'show asciidoc counters' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'asciidoc' doc= 'Asciidoc generation' />
<param name= 'counters' doc= 'Generate table of all registered counters' />
</params>
</command>
2018-07-31 16:54:34 +00:00
<command id= 'show rate-counters' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'rate-counters' doc= 'Show all rate counters' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'show mgcp [stats]' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= '[stats]' doc= 'Include Statistics' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'show mgcp endpoint NAME' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= 'endpoint' doc= 'Display information about an endpoint' />
<param name= 'NAME' doc= 'The name of the endpoint' />
</params>
</command>
<command id= 'show mgcp trunk <0-64> endpoint NAME' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'mgcp' doc= 'Display information about the MGCP Media Gateway' />
<param name= 'trunk' doc= 'Display information about a trunk' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'endpoint' doc= 'Display information about an endpoint' />
<param name= 'NAME' doc= 'The name of the endpoint' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'loop-endpoint <0-64> NAME (0|1)' >
<params >
<param name= 'loop-endpoint' doc= 'Loop a given endpoint' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'NAME' doc= 'The name in hex of the endpoint' />
<param name= '0' doc= 'Disable the loop' />
<param name= '1' doc= 'Enable the loop' />
</params>
</command>
<command id= 'tap-rtp <0-64> ENDPOINT CONN (in|out) A.B.C.D <0-65534>' >
<params >
<param name= 'tap-rtp' doc= 'Forward data on endpoint to a different system' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'ENDPOINT' doc= 'The endpoint in hex' />
<param name= 'CONN' doc= 'The connection id in hex' />
<param name= 'in' doc= 'Forward incoming data' />
<param name= 'out' doc= 'Forward leaving data' />
<param name= 'A.B.C.D' doc= 'destination IP of the data' />
<param name= '<0-65534>' doc= 'destination port' />
</params>
</command>
<command id= 'free-endpoint <0-64> NUMBER' >
<params >
<param name= 'free-endpoint' doc= 'Free the given endpoint' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'NUMBER' doc= 'Endpoint number in hex.' />
</params>
</command>
<command id= 'reset-endpoint <0-64> NUMBER' >
<params >
<param name= 'reset-endpoint' doc= 'Reset the given endpoint' />
<param name= '<0-64>' doc= 'Trunk number' />
<param name= 'NUMBER' doc= 'Endpoint number in hex.' />
</params>
</command>
<command id= 'reset-all-endpoints' >
<params >
<param name= 'reset-all-endpoints' doc= 'Reset all endpoints' />
</params>
</command>
</node>
<node id= 'config' >
<name > config</name>
<command id= 'hostname WORD' >
<params >
<param name= 'hostname' doc= 'Set system's network name' />
<param name= 'WORD' doc= 'This system's network name' />
</params>
</command>
<command id= 'no hostname [HOSTNAME]' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'hostname' doc= 'Reset system's network name' />
<param name= '[HOSTNAME]' doc= 'Host name of this router' />
</params>
</command>
<command id= 'password (8|) WORD' >
<params >
<param name= 'password' doc= 'Assign the terminal connection password' />
<param name= '8' doc= 'Specifies a HIDDEN password will follow' />
<param name= '' doc= 'dummy string ' />
<param name= 'WORD' doc= 'The HIDDEN line password string' />
</params>
</command>
<command id= 'password LINE' >
<params >
<param name= 'password' doc= 'Assign the terminal connection password' />
<param name= 'LINE' doc= 'The UNENCRYPTED (cleartext) line password' />
</params>
</command>
<command id= 'enable password (8|) WORD' >
<params >
<param name= 'enable' doc= 'Modify enable password parameters' />
<param name= 'password' doc= 'Assign the privileged level password' />
<param name= '8' doc= 'Specifies a HIDDEN password will follow' />
<param name= '' doc= 'dummy string ' />
<param name= 'WORD' doc= 'The HIDDEN 'enable' password string' />
</params>
</command>
<command id= 'enable password LINE' >
<params >
<param name= 'enable' doc= 'Modify enable password parameters' />
<param name= 'password' doc= 'Assign the privileged level password' />
<param name= 'LINE' doc= 'The UNENCRYPTED (cleartext) 'enable' password' />
</params>
</command>
<command id= 'no enable password' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'enable' doc= 'Modify enable password parameters' />
<param name= 'password' doc= 'Assign the privileged level password' />
</params>
</command>
<command id= 'banner motd default' >
<params >
<param name= 'banner' doc= 'Set banner string' />
<param name= 'motd' doc= 'Strings for motd' />
<param name= 'default' doc= 'Default string' />
</params>
</command>
<command id= 'banner motd file [FILE]' >
<params >
<param name= 'banner' doc= 'Set banner' />
<param name= 'motd' doc= 'Banner for motd' />
<param name= 'file' doc= 'Banner from a file' />
<param name= '[FILE]' doc= 'Filename' />
</params>
</command>
<command id= 'no banner motd' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'banner' doc= 'Set banner string' />
<param name= 'motd' doc= 'Strings for motd' />
</params>
</command>
<command id= 'service terminal-length <0-512>' >
<params >
<param name= 'service' doc= 'Set up miscellaneous service' />
<param name= 'terminal-length' doc= 'System wide terminal length configuration' />
<param name= '<0-512>' doc= 'Number of lines of VTY (0 means no line control)' />
</params>
</command>
<command id= 'no service terminal-length [<0-512>]' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'service' doc= 'Set up miscellaneous service' />
<param name= 'terminal-length' doc= 'System wide terminal length configuration' />
<param name= '[<0-512>]' doc= 'Number of lines of VTY (0 means no line control)' />
</params>
</command>
<command id= 'line vty' >
<params >
<param name= 'line' doc= 'Configure a terminal line' />
<param name= 'vty' doc= 'Virtual terminal' />
</params>
</command>
<command id= 'service advanced-vty' >
<params >
<param name= 'service' doc= 'Set up miscellaneous service' />
<param name= 'advanced-vty' doc= 'Enable advanced mode vty interface' />
</params>
</command>
<command id= 'no service advanced-vty' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'service' doc= 'Set up miscellaneous service' />
<param name= 'advanced-vty' doc= 'Enable advanced mode vty interface' />
</params>
</command>
<command id= 'show history' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'history' doc= 'Display the session command history' />
</params>
</command>
<command id= 'log stderr' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'stderr' doc= 'Logging via STDERR of the process' />
</params>
</command>
<command id= 'no log stderr' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'stderr' doc= 'Logging via STDERR of the process' />
</params>
</command>
<command id= 'log file .FILENAME' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'file' doc= 'Logging to text file' />
<param name= '.FILENAME' doc= 'Filename' />
</params>
</command>
<command id= 'no log file .FILENAME' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'file' doc= 'Logging to text file' />
<param name= '.FILENAME' doc= 'Filename' />
</params>
</command>
<command id= 'log alarms <2-32700>' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'alarms' doc= 'Logging alarms to osmo_strrb' />
<param name= '<2-32700>' doc= 'Maximum number of messages to log' />
</params>
</command>
<command id= 'no log alarms' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'alarms' doc= 'Logging alarms to osmo_strrb' />
</params>
</command>
<command id= 'log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'syslog' doc= 'Logging via syslog' />
<param name= 'authpriv' doc= 'Security/authorization messages facility' />
<param name= 'cron' doc= 'Clock daemon (cron/at) facility' />
<param name= 'daemon' doc= 'General system daemon facility' />
<param name= 'ftp' doc= 'Ftp daemon facility' />
<param name= 'lpr' doc= 'Line printer facility' />
<param name= 'mail' doc= 'Mail facility' />
<param name= 'news' doc= 'News facility' />
<param name= 'user' doc= 'Generic facility' />
<param name= 'uucp' doc= 'UUCP facility' />
</params>
</command>
<command id= 'log syslog local <0-7>' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'syslog' doc= 'Logging via syslog' />
<param name= 'local' doc= 'Syslog LOCAL facility' />
<param name= '<0-7>' doc= 'Local facility number' />
</params>
</command>
<command id= 'no log syslog' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'syslog' doc= 'Logging via syslog' />
</params>
</command>
<command id= 'log gsmtap [HOSTNAME]' >
<params >
<param name= 'log' doc= 'Configure logging sub-system' />
<param name= 'gsmtap' doc= 'Logging via GSMTAP' />
<param name= '[HOSTNAME]' doc= 'Host name to send the GSMTAP logging to (UDP port 4729)' />
</params>
</command>
<command id= 'stats reporter statsd' >
<params >
<param name= 'stats' doc= 'Configure stats sub-system' />
<param name= 'reporter' doc= 'Configure a stats reporter' />
<param name= 'statsd' doc= 'Report to a STATSD server' />
</params>
</command>
<command id= 'no stats reporter statsd' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'stats' doc= 'Configure stats sub-system' />
<param name= 'reporter' doc= 'Configure a stats reporter' />
<param name= 'statsd' doc= 'Report to a STATSD server' />
</params>
</command>
<command id= 'stats reporter log' >
<params >
<param name= 'stats' doc= 'Configure stats sub-system' />
<param name= 'reporter' doc= 'Configure a stats reporter' />
<param name= 'log' doc= 'Report to the logger' />
</params>
</command>
<command id= 'no stats reporter log' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'stats' doc= 'Configure stats sub-system' />
<param name= 'reporter' doc= 'Configure a stats reporter' />
<param name= 'log' doc= 'Report to the logger' />
</params>
</command>
<command id= 'stats interval <1-65535>' >
<params >
<param name= 'stats' doc= 'Configure stats sub-system' />
<param name= 'interval' doc= 'Set the reporting interval' />
<param name= '<1-65535>' doc= 'Interval in seconds' />
</params>
</command>
<command id= 'mgcp' >
<params >
<param name= 'mgcp' doc= 'Configure the MGCP' />
</params>
</command>
</node>
<node id= 'config-log' >
<name > config-log</name>
<command id= 'logging filter all (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'filter' doc= 'Filter log messages' />
<param name= 'all' doc= 'Do you want to log all messages?' />
<param name= '0' doc= 'Only print messages matched by other filters' />
<param name= '1' doc= 'Bypass filter and print all messages' />
</params>
</command>
<command id= 'logging color (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'color' doc= 'Configure color-printing for log messages' />
<param name= '0' doc= 'Don't use color for printing messages' />
<param name= '1' doc= 'Use color for printing messages' />
</params>
</command>
<command id= 'logging timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp' />
</params>
</command>
<command id= 'logging print extended-timestamp (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'extended-timestamp' doc= 'Configure log message timestamping' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
</params>
</command>
<command id= 'logging print category (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem name' />
</params>
</command>
<command id= 'logging print category-hex (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'category-hex' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with category/subsystem nr in hex ('<000b>')' />
</params>
</command>
<command id= 'logging print level (0|1)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'level' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the log level name' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'print' doc= 'Log output settings' />
<param name= 'file' doc= 'Configure log message' />
<param name= '0' doc= 'Don't prefix each log message' />
<param name= '1' doc= 'Prefix each log message with the source file and line' />
<param name= 'basename' doc= 'Prefix each log message with the source file's basename (strip leading paths) and line' />
2018-11-05 02:18:55 +00:00
<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.' />
2018-03-06 13:59:00 +00:00
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'rtp' doc= 'RTP stream handling' />
<param name= 'lglobal' doc= 'Library-internal global log family' />
<param name= 'llapd' doc= 'LAPD in libosmogsm' />
<param name= 'linp' doc= 'A-bis Intput Subsystem' />
<param name= 'lmux' doc= 'A-bis B-Subchannel TRAU Frame Multiplex' />
<param name= 'lmi' doc= 'A-bis Input Driver for Signalling' />
<param name= 'lmib' doc= 'A-bis Input Driver for B-Channels (voice)' />
<param name= 'lsms' doc= 'Layer3 Short Message Service (SMS)' />
<param name= 'lctrl' doc= 'Control Interface' />
<param name= 'lgtp' doc= 'GPRS GTP library' />
<param name= 'lstats' doc= 'Statistics messages and logging' />
<param name= 'lgsup' doc= 'Generic Subscriber Update Protocol' />
<param name= 'loap' doc= 'Osmocom Authentication Protocol' />
<param name= 'lss7' doc= 'libosmo-sigtran Signalling System 7' />
<param name= 'lsccp' doc= 'libosmo-sigtran SCCP Implementation' />
<param name= 'lsua' doc= 'libosmo-sigtran SCCP User Adaptation' />
<param name= 'lm3ua' doc= 'libosmo-sigtran MTP3 User Adaptation' />
<param name= 'lmgcp' doc= 'libosmo-mgcp Media Gateway Control Protocol' />
<param name= 'ljibuf' doc= 'libosmo-netif Jitter Buffer' />
2019-06-19 12:08:22 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
2018-03-06 13:59:00 +00:00
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
2018-11-05 02:18:55 +00:00
<command id= 'logging level set-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
<command id= 'logging level force-all (debug|info|notice|error|fatal)' >
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<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.' />
<param name= 'debug' doc= 'Log debug messages and higher levels' />
<param name= 'info' doc= 'Log informational messages and higher levels' />
<param name= 'notice' doc= 'Log noticeable messages and higher levels' />
<param name= 'error' doc= 'Log error messages and higher levels' />
<param name= 'fatal' doc= 'Log only fatal messages' />
</params>
</command>
<command id= 'no logging level force-all' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'force-all' doc= 'Release any globally forced log level set with 'logging level force-all <level>'' />
</params>
</command>
2018-03-06 13:59:00 +00:00
</node>
<node id= 'config-stats' >
<name > config-stats</name>
<command id= 'local-ip ADDR' >
<params >
<param name= 'local-ip' doc= 'Set the IP address to which we bind locally' />
<param name= 'ADDR' doc= 'IP Address' />
</params>
</command>
<command id= 'no local-ip' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'local-ip' doc= 'Set the IP address to which we bind locally' />
</params>
</command>
<command id= 'remote-ip ADDR' >
<params >
<param name= 'remote-ip' doc= 'Set the remote IP address to which we connect' />
<param name= 'ADDR' doc= 'IP Address' />
</params>
</command>
<command id= 'remote-port <1-65535>' >
<params >
<param name= 'remote-port' doc= 'Set the remote port to which we connect' />
<param name= '<1-65535>' doc= 'Remote port number' />
</params>
</command>
<command id= 'mtu <100-65535>' >
<params >
<param name= 'mtu' doc= 'Set the maximum packet size' />
<param name= '<100-65535>' doc= 'Size in byte' />
</params>
</command>
<command id= 'no mtu' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'mtu' doc= 'Set the maximum packet size' />
</params>
</command>
<command id= 'prefix PREFIX' >
<params >
<param name= 'prefix' doc= 'Set the item name prefix' />
<param name= 'PREFIX' doc= 'The prefix string' />
</params>
</command>
<command id= 'no prefix' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'prefix' doc= 'Set the item name prefix' />
</params>
</command>
<command id= 'level (global|peer|subscriber)' >
<params >
<param name= 'level' doc= 'Set the maximum group level' />
<param name= 'global' doc= 'Report global groups only' />
<param name= 'peer' doc= 'Report global and network peer related groups' />
<param name= 'subscriber' doc= 'Report global, peer, and subscriber groups' />
</params>
</command>
<command id= 'enable' >
<params >
<param name= 'enable' doc= 'Enable the reporter' />
</params>
</command>
<command id= 'disable' >
<params >
<param name= 'disable' doc= 'Disable the reporter' />
</params>
</command>
</node>
<node id= 'config-line' >
<name > config-line</name>
<command id= 'login' >
<params >
<param name= 'login' doc= 'Enable password checking' />
</params>
</command>
<command id= 'no login' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'login' doc= 'Enable password checking' />
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'bind A.B.C.D [<0-65535>]' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'bind' doc= 'Accept VTY telnet connections on local interface' />
<param name= 'A.B.C.D' doc= 'Local interface IP address (default: 127.0.0.1)' />
2019-06-19 12:08:22 +00:00
<param name= '[<0-65535>]' doc= 'Local TCP port number' />
2018-03-06 13:59:00 +00:00
</params>
</command>
</node>
<node id= 'config-mgcp' >
<name > config-mgcp</name>
<command id= 'local ip A.B.C.D' >
<params >
<param name= 'local' doc= 'Local options for the SDP record' />
<param name= 'ip' doc= 'IP information' />
<param name= 'A.B.C.D' doc= 'IPv4 Address to use in SDP record' />
</params>
</command>
<command id= 'bind ip A.B.C.D' >
<params >
<param name= 'bind' doc= 'Listen/Bind related socket option' />
<param name= 'ip' doc= 'IP information' />
<param name= 'A.B.C.D' doc= 'IPv4 Address to bind to' />
</params>
</command>
<command id= 'bind port <0-65534>' >
<params >
<param name= 'bind' doc= 'Listen/Bind related socket option' />
<param name= 'port' doc= 'Port information' />
<param name= '<0-65534>' doc= 'UDP port to listen for MGCP messages' />
</params>
</command>
<command id= 'bind early (0|1)' >
<params >
<param name= 'bind' doc= 'Listen/Bind related socket option' />
<param name= 'early' doc= 'Bind local ports on start up' />
<param name= '0' doc= 'Bind on demand' />
<param name= '1' doc= 'Bind on startup' />
</params>
</command>
2018-07-31 16:54:34 +00:00
<command id= 'rtp port-range <1024-65534> <1025-65535>' >
2018-03-06 13:59:00 +00:00
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'port-range' doc= 'Range of ports to use for the NET side' />
2018-07-31 16:54:34 +00:00
<param name= '<1024-65534>' doc= 'Start of the range of ports' />
<param name= '<1025-65535>' doc= 'End of the range of ports' />
2018-03-06 13:59:00 +00:00
</params>
</command>
<command id= 'rtp bind-ip A.B.C.D' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'bind-ip' doc= 'Bind endpoints facing the Network' />
<param name= 'A.B.C.D' doc= 'Address to bind to' />
</params>
</command>
<command id= 'no rtp bind-ip' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'bind-ip' doc= 'Bind endpoints facing the Network' />
</params>
</command>
<command id= 'rtp ip-probing' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'ip-probing' doc= 'automatic rtp bind ip selection' />
</params>
</command>
<command id= 'no rtp ip-probing' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'ip-probing' doc= 'no automatic rtp bind ip selection' />
</params>
</command>
<command id= 'rtp ip-dscp <0-255>' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'ip-dscp' doc= 'Apply IP_TOS to the audio stream (including Osmux)' />
<param name= '<0-255>' doc= 'The DSCP value' />
</params>
</command>
<command id= 'rtp force-ptime (10|20|40)' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'force-ptime' doc= 'Force a fixed ptime for packets sentThe required ptime (packet duration) in ms' />
<param name= '10' doc= '10 ms' />
<param name= '20' doc= '20 ms' />
<param name= '40' doc= '40 ms' />
</params>
</command>
<command id= 'no rtp force-ptime' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'force-ptime' doc= 'Force a fixed ptime for packets sent' />
</params>
</command>
<command id= 'rtp keep-alive <1-120>' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
<param name= '<1-120>' doc= 'Keep alive interval in secs' />
</params>
</command>
<command id= 'rtp keep-alive once' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
<param name= 'once' doc= 'Send dummy packet only once after CRCX/MDCX' />
</params>
</command>
<command id= 'no rtp keep-alive' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
</params>
</command>
<command id= 'call-agent ip A.B.C.D' >
<params >
<param name= 'call-agent' doc= 'Callagent information' />
<param name= 'ip' doc= 'IP information' />
<param name= 'A.B.C.D' doc= 'IPv4 Address of the callagent' />
</params>
</command>
<command id= 'sdp audio-payload number <0-255>' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'number' doc= 'Number' />
<param name= '<0-255>' doc= 'Payload number' />
</params>
</command>
<command id= 'sdp audio-payload name NAME' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'name' doc= 'Name' />
<param name= 'NAME' doc= 'Payload name' />
</params>
</command>
<command id= 'loop (0|1)' >
<params >
<param name= 'loop' doc= 'Loop audio for all endpoints on main trunk' />
<param name= '0' doc= 'Don't Loop' />
<param name= '1' doc= 'Loop' />
</params>
</command>
<command id= 'force-realloc (0|1)' >
<params >
<param name= 'force-realloc' doc= 'Force endpoint reallocation when the endpoint is still seized' />
<param name= '0' doc= 'Don't force reallocation' />
<param name= '1' doc= 'force reallocation' />
</params>
</command>
<command id= 'rtp-accept-all (0|1)' >
<params >
<param name= 'rtp-accept-all' doc= 'Accept all RTP packets, even when the originating IP/Port does not match' />
<param name= '0' doc= 'enable filter' />
<param name= '1' doc= 'disable filter' />
</params>
</command>
<command id= 'number endpoints <0-65534>' >
<params >
<param name= 'number' doc= 'Number options' />
<param name= 'endpoints' doc= 'Endpoints available' />
<param name= '<0-65534>' doc= 'Number endpoints' />
</params>
</command>
<command id= 'rtcp-omit' >
<params >
<param name= 'rtcp-omit' doc= 'Drop RTCP packets in both directions' />
</params>
</command>
<command id= 'no rtcp-omit' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtcp-omit' doc= 'Drop RTCP packets in both directions' />
</params>
</command>
<command id= 'rtp-patch ssrc' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'ssrc' doc= 'Force a fixed SSRC' />
</params>
</command>
<command id= 'no rtp-patch ssrc' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'ssrc' doc= 'Force a fixed SSRC' />
</params>
</command>
<command id= 'rtp-patch timestamp' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'timestamp' doc= 'Adjust RTP timestamp' />
</params>
</command>
<command id= 'no rtp-patch timestamp' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'timestamp' doc= 'Adjust RTP timestamp' />
</params>
</command>
<command id= 'no rtp-patch' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'rtp-patch rfc5993hr' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'rfc5993hr' doc= 'Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
</params>
</command>
<command id= 'no rtp-patch rfc5993hr' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'rfc5993hr' doc= 'Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'sdp audio fmtp-extra .NAME' >
<params >
<param name= 'sdp' doc= 'Add extra fmtp for the SDP file' />
<param name= 'audio' doc= 'Audio' />
<param name= 'fmtp-extra' doc= 'Fmtp-extra' />
<param name= '.NAME' doc= 'Extra Information' />
</params>
</command>
<command id= 'sdp audio-payload send-ptime' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-ptime' doc= 'Send SDP ptime (packet duration) attribute' />
</params>
</command>
<command id= 'no sdp audio-payload send-ptime' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-ptime' doc= 'Send SDP ptime (packet duration) attribute' />
</params>
</command>
<command id= 'sdp audio-payload send-name' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-name' doc= 'Send SDP rtpmap with the audio name' />
</params>
</command>
<command id= 'no sdp audio-payload send-name' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-name' doc= 'Send SDP rtpmap with the audio name' />
</params>
</command>
<command id= 'osmux (on|off|only)' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'on' doc= 'Enable OSMUX' />
<param name= 'off' doc= 'Disable OSMUX' />
<param name= 'only' doc= 'Only use OSMUX' />
</params>
</command>
<command id= 'osmux bind-ip A.B.C.D' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'bind-ip' doc= 'IP information' />
<param name= 'A.B.C.D' doc= 'IPv4 Address to bind to' />
</params>
</command>
<command id= 'osmux batch-factor <1-8>' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'batch-factor' doc= 'Batching factor' />
<param name= '<1-8>' doc= 'Number of messages in the batch' />
</params>
</command>
<command id= 'osmux batch-size <1-65535>' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'batch-size' doc= 'batch size' />
<param name= '<1-65535>' doc= 'Batch size in bytes' />
</params>
</command>
<command id= 'osmux port <1-65535>' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'port' doc= 'port' />
<param name= '<1-65535>' doc= 'UDP port' />
</params>
</command>
<command id= 'osmux dummy (on|off)' >
<params >
<param name= 'osmux' doc= 'RTP multiplexing' />
<param name= 'dummy' doc= 'Dummy padding' />
<param name= 'on' doc= 'Enable dummy padding' />
<param name= 'off' doc= 'Disable dummy padding' />
</params>
</command>
<command id= 'allow-transcoding' >
<params >
<param name= 'allow-transcoding' doc= 'Allow transcoding' />
</params>
</command>
<command id= 'no allow-transcoding' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'allow-transcoding' doc= 'Allow transcoding' />
</params>
</command>
<command id= 'domain NAME' >
<params >
2018-11-05 02:18:55 +00:00
<param name= 'domain' doc= 'Set the domain part expected in MGCP messages' endpoint names' />
<param name= 'NAME' doc= 'Qualified domain name expected in MGCP endpoint names, or '*' to accept any domain' />
2018-03-06 13:59:00 +00:00
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'conn-timeout <1-65534>' >
<params >
<param name= 'conn-timeout' doc= 'Set a time after which inactive connections (CIs) are closed. This can be used to work around interoperability problems causing connections to stay open forever, and slowly exhausting all available ports. Do not enable when LCLS is used (connections in LCLS state appear to be inactive)!' />
<param name= '<1-65534>' doc= 'Timeout value (sec.)' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'trunk <1-64>' >
<params >
<param name= 'trunk' doc= 'Configure a SS7 trunk' />
<param name= '<1-64>' doc= 'Trunk Nr' />
</params>
</command>
</node>
<node id= 'config-mgcp-trunk' >
<name > config-mgcp-trunk</name>
<command id= 'rtp keep-alive <1-120>' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
<param name= '<1-120>' doc= 'Keep-alive interval in secs' />
</params>
</command>
<command id= 'rtp keep-alive once' >
<params >
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
<param name= 'once' doc= 'Send dummy packet only once after CRCX/MDCX' />
</params>
</command>
<command id= 'no rtp keep-alive' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp' doc= 'RTP configuration' />
<param name= 'keep-alive' doc= 'Send dummy UDP packet to net RTP destination' />
</params>
</command>
<command id= 'sdp audio-payload number <0-255>' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'number' doc= 'Number' />
<param name= '<0-255>' doc= 'Payload Number' />
</params>
</command>
<command id= 'sdp audio-payload name NAME' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'name' doc= 'Payload' />
<param name= 'NAME' doc= 'Payload Name' />
</params>
</command>
<command id= 'loop (0|1)' >
<params >
<param name= 'loop' doc= 'Loop audio for all endpoints on this trunk' />
<param name= '0' doc= 'Don't Loop' />
<param name= '1' doc= 'Loop' />
</params>
</command>
<command id= 'rtcp-omit' >
<params >
<param name= 'rtcp-omit' doc= 'Drop RTCP packets in both directions' />
</params>
</command>
<command id= 'no rtcp-omit' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtcp-omit' doc= 'Drop RTCP packets in both directions' />
</params>
</command>
<command id= 'rtp-patch ssrc' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'ssrc' doc= 'Force a fixed SSRC' />
</params>
</command>
<command id= 'no rtp-patch ssrc' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'ssrc' doc= 'Force a fixed SSRC' />
</params>
</command>
<command id= 'rtp-patch timestamp' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'timestamp' doc= 'Adjust RTP timestamp' />
</params>
</command>
2019-06-19 12:08:22 +00:00
<command id= 'rtp-patch rfc5993hr' >
<params >
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'rfc5993hr' doc= 'Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
</params>
</command>
<command id= 'no rtp-patch rfc5993hr' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'rfc5993hr' doc= 'Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
</params>
</command>
2018-03-06 13:59:00 +00:00
<command id= 'no rtp-patch timestamp' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
<param name= 'timestamp' doc= 'Adjust RTP timestamp' />
</params>
</command>
<command id= 'no rtp-patch' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'rtp-patch' doc= 'Modify RTP packet header in both directions' />
</params>
</command>
<command id= 'sdp audio fmtp-extra .NAME' >
<params >
<param name= 'sdp' doc= 'Add extra fmtp for the SDP file' />
<param name= 'audio' doc= 'Audio' />
<param name= 'fmtp-extra' doc= 'Fmtp-extra' />
<param name= '.NAME' doc= 'Extra Information' />
</params>
</command>
<command id= 'sdp audio-payload send-ptime' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-ptime' doc= 'Send SDP ptime (packet duration) attribute' />
</params>
</command>
<command id= 'no sdp audio-payload send-ptime' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-ptime' doc= 'Send SDP ptime (packet duration) attribute' />
</params>
</command>
<command id= 'sdp audio-payload send-name' >
<params >
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-name' doc= 'Send SDP rtpmap with the audio name' />
</params>
</command>
<command id= 'no sdp audio-payload send-name' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'sdp' doc= 'SDP File related options' />
<param name= 'audio-payload' doc= 'Audio payload options' />
<param name= 'send-name' doc= 'Send SDP rtpmap with the audio name' />
</params>
</command>
<command id= 'allow-transcoding' >
<params >
<param name= 'allow-transcoding' doc= 'Allow transcoding' />
</params>
</command>
<command id= 'no allow-transcoding' >
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'allow-transcoding' doc= 'Allow transcoding' />
</params>
</command>
</node>
</vtydoc>
