2018-03-06 15:15:24 +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>
2020-01-02 15:52:39 +00:00
<command id= 'write file [PATH]' >
2018-03-06 15:15:24 +00:00
<params >
<param name= 'write' doc= 'Write running configuration to memory, network, or terminal' />
<param name= 'file' doc= 'Write to configuration file' />
2020-01-02 15:52:39 +00:00
<param name= '[PATH]' doc= 'Set file path to store the config, or replace if already exists' />
2018-03-06 15:15:24 +00:00
</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>
2019-06-05 10:49:36 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 15:15:24 +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' />
2019-06-05 10:49:36 +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 15:15:24 +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>
2020-01-02 15:52:39 +00:00
<command id= 'logging level (main|trxclk|trxctrl|trxddl|trxdul|dev|devdrv|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 15:15:24 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'main' doc= 'Main generic category' />
2020-01-02 15:52:39 +00:00
<param name= 'trxclk' doc= 'TRX Master Clock' />
2019-06-05 10:49:36 +00:00
<param name= 'trxctrl' doc= 'TRX CTRL interface' />
2020-01-02 15:52:39 +00:00
<param name= 'trxddl' doc= 'TRX Data interface Downlink' />
<param name= 'trxdul' doc= 'TRX CTRL interface Uplink' />
2019-06-05 10:49:36 +00:00
<param name= 'dev' doc= 'Device/Driver specific code' />
2020-01-02 15:52:39 +00:00
<param name= 'devdrv' doc= 'Logging from external device driver library implementing lower level specifics' />
2018-03-06 15:15:24 +00:00
<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-05 10:49:36 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
<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 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.' />
2018-03-06 15:15:24 +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>
2019-06-05 10:49:36 +00:00
<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>
2020-01-02 15:52:39 +00:00
<command id= 'logp (main|trxclk|trxctrl|trxddl|trxdul|dev|devdrv|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE' >
<params >
<param name= 'logp' doc= 'Print a message on all log outputs; useful for placing markers in test logs' />
<param name= 'main' doc= 'Main generic category' />
<param name= 'trxclk' doc= 'TRX Master Clock' />
<param name= 'trxctrl' doc= 'TRX CTRL interface' />
<param name= 'trxddl' doc= 'TRX Data interface Downlink' />
<param name= 'trxdul' doc= 'TRX CTRL interface Uplink' />
<param name= 'dev' doc= 'Device/Driver specific code' />
<param name= 'devdrv' doc= 'Logging from external device driver library implementing lower level specifics' />
<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' />
<param name= 'lrspro' doc= 'Remote SIM protocol' />
<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' />
<param name= '.LOGMESSAGE' doc= 'Arbitrary message to log on given category and log level' />
</params>
</command>
2018-03-06 15:15:24 +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>
2020-01-02 15:52:39 +00:00
<command id= 'show trx' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'trx' doc= 'Display information on the TRX' />
</params>
</command>
2018-03-06 15:15:24 +00:00
<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>
2019-06-05 10:49:36 +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 15:15:24 +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>
2019-06-05 10:49:36 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 15:15:24 +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' />
2019-06-05 10:49:36 +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 15:15:24 +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>
2020-01-02 15:52:39 +00:00
<command id= 'logging level (main|trxclk|trxctrl|trxddl|trxdul|dev|devdrv|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 15:15:24 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'main' doc= 'Main generic category' />
2020-01-02 15:52:39 +00:00
<param name= 'trxclk' doc= 'TRX Master Clock' />
2019-06-05 10:49:36 +00:00
<param name= 'trxctrl' doc= 'TRX CTRL interface' />
2020-01-02 15:52:39 +00:00
<param name= 'trxddl' doc= 'TRX Data interface Downlink' />
<param name= 'trxdul' doc= 'TRX CTRL interface Uplink' />
2019-06-05 10:49:36 +00:00
<param name= 'dev' doc= 'Device/Driver specific code' />
2020-01-02 15:52:39 +00:00
<param name= 'devdrv' doc= 'Logging from external device driver library implementing lower level specifics' />
2018-03-06 15:15:24 +00:00
<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-05 10:49:36 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
<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 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.' />
2018-03-06 15:15:24 +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>
2019-06-05 10:49:36 +00:00
<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>
2020-01-02 15:52:39 +00:00
<command id= 'logp (main|trxclk|trxctrl|trxddl|trxdul|dev|devdrv|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE' >
<params >
<param name= 'logp' doc= 'Print a message on all log outputs; useful for placing markers in test logs' />
<param name= 'main' doc= 'Main generic category' />
<param name= 'trxclk' doc= 'TRX Master Clock' />
<param name= 'trxctrl' doc= 'TRX CTRL interface' />
<param name= 'trxddl' doc= 'TRX Data interface Downlink' />
<param name= 'trxdul' doc= 'TRX CTRL interface Uplink' />
<param name= 'dev' doc= 'Device/Driver specific code' />
<param name= 'devdrv' doc= 'Logging from external device driver library implementing lower level specifics' />
<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' />
<param name= 'lrspro' doc= 'Remote SIM protocol' />
<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' />
<param name= '.LOGMESSAGE' doc= 'Arbitrary message to log on given category and log level' />
</params>
</command>
2018-03-06 15:15:24 +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>
2020-01-02 15:52:39 +00:00
<command id= 'show trx' >
<params >
<param name= 'show' doc= 'Show running system information' />
<param name= 'trx' doc= 'Display information on the TRX' />
</params>
</command>
2018-03-06 15:15:24 +00:00
<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>
2019-06-05 10:49:36 +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 15:15:24 +00:00
</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>
2020-01-02 15:52:39 +00:00
<command id= 'ctrl' >
<params >
<param name= 'ctrl' doc= 'Configure the Control Interface' />
</params>
</command>
<command id= 'trx' >
<params >
<param name= 'trx' doc= 'Configure the TRX' />
</params>
</command>
2018-03-06 15:15:24 +00:00
<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>
</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>
2019-06-05 10:49:36 +00:00
<command id= 'logging print file (0|1|basename) [last]' >
2018-03-06 15:15:24 +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' />
2019-06-05 10:49:36 +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 15:15:24 +00:00
</params>
</command>
2020-01-02 15:52:39 +00:00
<command id= 'logging level (main|trxclk|trxctrl|trxddl|trxdul|dev|devdrv|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 15:15:24 +00:00
<params >
<param name= 'logging' doc= 'Configure logging' />
<param name= 'level' doc= 'Set the log level for a specified category' />
<param name= 'main' doc= 'Main generic category' />
2020-01-02 15:52:39 +00:00
<param name= 'trxclk' doc= 'TRX Master Clock' />
2019-06-05 10:49:36 +00:00
<param name= 'trxctrl' doc= 'TRX CTRL interface' />
2020-01-02 15:52:39 +00:00
<param name= 'trxddl' doc= 'TRX Data interface Downlink' />
<param name= 'trxdul' doc= 'TRX CTRL interface Uplink' />
2019-06-05 10:49:36 +00:00
<param name= 'dev' doc= 'Device/Driver specific code' />
2020-01-02 15:52:39 +00:00
<param name= 'devdrv' doc= 'Logging from external device driver library implementing lower level specifics' />
2018-03-06 15:15:24 +00:00
<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-05 10:49:36 +00:00
<param name= 'lrspro' doc= 'Remote SIM protocol' />
2018-03-06 15:15:24 +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>
2019-06-05 10:49:36 +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 15:15:24 +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-05 10:49:36 +00:00
<command id= 'bind A.B.C.D [<0-65535>]' >
2018-03-06 15:15:24 +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-05 10:49:36 +00:00
<param name= '[<0-65535>]' doc= 'Local TCP port number' />
2018-03-06 15:15:24 +00:00
</params>
</command>
</node>
<node id= 'config-ctrl' >
<name > config-ctrl</name>
<command id= 'bind A.B.C.D' >
<params >
<param name= 'bind' doc= 'Set bind address to listen for Control connections' />
<param name= 'A.B.C.D' doc= 'Local IP address (default 127.0.0.1)' />
</params>
</command>
</node>
<node id= 'config-trx' >
<name > config-trx</name>
<command id= 'bind-ip A.B.C.D' >
<params >
<param name= 'bind-ip' doc= 'Set the IP address for the local bind' />
<param name= 'A.B.C.D' doc= 'IPv4 Address' />
</params>
</command>
<command id= 'remote-ip A.B.C.D' >
<params >
<param name= 'remote-ip' doc= 'Set the IP address for the remote BTS' />
<param name= 'A.B.C.D' doc= 'IPv4 Address' />
</params>
</command>
<command id= 'base-port <1-65535>' >
<params >
<param name= 'base-port' doc= 'Set the TRX Base Port' />
<param name= '<1-65535>' doc= 'TRX Base Port' />
</params>
</command>
<command id= 'dev-args DESC' >
<params >
<param name= 'dev-args' doc= 'Set the device-specific arguments to pass to the device' />
<param name= 'DESC' doc= 'Device-specific arguments' />
</params>
</command>
<command id= 'tx-sps (1|4)' >
<params >
<param name= 'tx-sps' doc= 'Set the Tx Samples-per-Symbol' />
<param name= '1' doc= 'Tx Samples-per-Symbol' />
<param name= '4' doc= '(null)' />
</params>
</command>
<command id= 'rx-sps (1|4)' >
<params >
<param name= 'rx-sps' doc= 'Set the Rx Samples-per-Symbol' />
<param name= '1' doc= 'Rx Samples-per-Symbol' />
<param name= '4' doc= '(null)' />
</params>
</command>
<command id= 'clock-ref (internal|external|gpsdo)' >
<params >
<param name= 'clock-ref' doc= 'Set the Reference Clock' />
2019-10-13 17:08:00 +00:00
<param name= 'internal' doc= 'Enable internal reference (default)' />
2018-03-06 15:15:24 +00:00
<param name= 'external' doc= 'Enable external 10 MHz reference' />
<param name= 'gpsdo' doc= 'Enable GPSDO reference' />
</params>
</command>
<command id= 'multi-arfcn (disable|enable)' >
<params >
<param name= 'multi-arfcn' doc= 'Enable multi-ARFCN transceiver (default=disable)' />
<param name= 'disable' doc= '(null)' />
<param name= 'enable' doc= '(null)' />
</params>
</command>
<command id= 'offset FLOAT' >
<params >
<param name= 'offset' doc= 'Set the baseband frequency offset (default=0, auto)' />
<param name= 'FLOAT' doc= 'Baseband Frequency Offset' />
</params>
</command>
<command id= 'rssi-offset FLOAT' >
<params >
<param name= 'rssi-offset' doc= 'Set the RSSI to dBm offset in dB (default=0)' />
<param name= 'FLOAT' doc= 'RSSI to dBm offset in dB' />
</params>
</command>
<command id= 'swap-channels (disable|enable)' >
<params >
<param name= 'swap-channels' doc= 'Swap channels (default=disable)' />
<param name= 'disable' doc= '(null)' />
<param name= 'enable' doc= '(null)' />
</params>
</command>
<command id= 'egprs (disable|enable)' >
<params >
<param name= 'egprs' doc= 'Enable EDGE receiver (default=disable)' />
<param name= 'disable' doc= '(null)' />
<param name= 'enable' doc= '(null)' />
</params>
</command>
2019-06-05 10:49:36 +00:00
<command id= 'ext-rach (disable|enable)' >
<params >
<param name= 'ext-rach' doc= 'Enable extended (11-bit) RACH (default=disable)' />
<param name= 'disable' doc= '(null)' />
<param name= 'enable' doc= '(null)' />
</params>
</command>
2018-03-06 15:15:24 +00:00
<command id= 'rt-prio <1-32>' >
<params >
<param name= 'rt-prio' doc= 'Set the SCHED_RR real-time priority' />
<param name= '<1-32>' doc= 'Real time priority' />
</params>
</command>
2020-01-02 15:52:39 +00:00
<command id= 'filler type (zero|dummy|random-nb-gmsk|random-nb-8psk|random-ab)' >
<params >
<param name= 'filler' doc= 'Filler burst settings' />
<param name= 'type' doc= 'Filler burst type (default=zero)' />
<param name= 'zero' doc= 'Send an empty burst when there is nothing to send (default)' />
<param name= 'dummy' doc= 'Send a dummy burst when there is nothing to send on C0 (TRX0) and empty burst on other channels. Use for OpenBTS compatibility only, don't use with OsmoBTS as it breaks encryption.' />
<param name= 'random-nb-gmsk' doc= 'Send a GMSK modulated Normal Burst with random bits when there is nothing to send. Use for spectrum mask testing. Configure 'filler tsc' to set training sequence.' />
<param name= 'random-nb-8psk' doc= 'Send an 8-PSK modulated Normal Burst with random bits when there is nothing to send. Use for spectrum mask testing. Configure 'filler tsc' to set training sequence.' />
<param name= 'random-ab' doc= 'Send an Access Burst with random bits when there is nothing to send. Use for Rx/Tx alignment. Configure 'filler access-burst-delay' to introduce artificial delay.' />
</params>
</command>
<command id= 'filler tsc <0-7>' >
<params >
<param name= 'filler' doc= 'Filler burst settings' />
<param name= 'tsc' doc= 'Set the TSC for GMSK/8-PSK Normal Burst random fillers. Used only with 'random-nb-gmsk' and 'random-nb-8psk' filler types. (default=0)' />
<param name= '<0-7>' doc= 'TSC' />
</params>
</command>
<command id= 'filler access-burst-delay <0-68>' >
2018-03-06 15:15:24 +00:00
<params >
2020-01-02 15:52:39 +00:00
<param name= 'filler' doc= 'Filler burst settings' />
<param name= 'access-burst-delay' doc= 'Set the delay for Access Burst random fillers. Used only with 'random-ab' filler type. (default=0)' />
<param name= '<0-68>' doc= 'RACH delay in symbols' />
2018-03-06 15:15:24 +00:00
</params>
</command>
2019-07-29 18:11:25 +00:00
<command id= 'ctr-error-threshold (rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples|tx_drop_events|tx_drop_samples) <0-65535> (per-second|per-minute|per-hour|per-day)' >
2019-05-24 17:58:20 +00:00
<params >
<param name= 'ctr-error-threshold' doc= 'Threshold rate for error counter' />
<param name= 'rx_overruns' doc= 'Set threshold value for rate_ctr device:rx_overruns' />
<param name= 'tx_underruns' doc= 'Set threshold value for rate_ctr device:tx_underruns' />
<param name= 'rx_drop_events' doc= 'Set threshold value for rate_ctr device:rx_drop_events' />
<param name= 'rx_drop_samples' doc= 'Set threshold value for rate_ctr device:rx_drop_samples' />
2019-07-29 18:11:25 +00:00
<param name= 'tx_drop_events' doc= 'Set threshold value for rate_ctr device:tx_drop_events' />
<param name= 'tx_drop_samples' doc= 'Set threshold value for rate_ctr device:tx_drop_samples' />
2019-05-24 17:58:20 +00:00
<param name= '<0-65535>' doc= 'Value to set for threshold' />
<param name= 'per-second' doc= 'Threshold value sampled per-second' />
<param name= 'per-minute' doc= 'Threshold value sampled per-minute' />
<param name= 'per-hour' doc= 'Threshold value sampled per-hour' />
<param name= 'per-day' doc= 'Threshold value sampled per-day' />
</params>
</command>
2019-07-29 18:11:25 +00:00
<command id= 'no ctr-error-threshold (rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples|tx_drop_events|tx_drop_samples) <0-65535> (per-second|per-minute|per-hour|per-day)' >
2019-05-24 17:58:20 +00:00
<params >
<param name= 'no' doc= 'Negate a command or set its defaults' />
<param name= 'ctr-error-threshold' doc= 'Threshold rate for error counter' />
<param name= 'rx_overruns' doc= 'Set threshold value for rate_ctr device:rx_overruns' />
<param name= 'tx_underruns' doc= 'Set threshold value for rate_ctr device:tx_underruns' />
<param name= 'rx_drop_events' doc= 'Set threshold value for rate_ctr device:rx_drop_events' />
<param name= 'rx_drop_samples' doc= 'Set threshold value for rate_ctr device:rx_drop_samples' />
2019-07-29 18:11:25 +00:00
<param name= 'tx_drop_events' doc= 'Set threshold value for rate_ctr device:tx_drop_events' />
<param name= 'tx_drop_samples' doc= 'Set threshold value for rate_ctr device:tx_drop_samples' />
2019-05-24 17:58:20 +00:00
<param name= '<0-65535>' doc= 'Value to set for threshold' />
<param name= 'per-second' doc= 'Threshold value sampled per-second' />
<param name= 'per-minute' doc= 'Threshold value sampled per-minute' />
<param name= 'per-hour' doc= 'Threshold value sampled per-hour' />
<param name= 'per-day' doc= 'Threshold value sampled per-day' />
</params>
</command>
2019-07-29 18:11:25 +00:00
<command id= 'stack-size <0-2147483647>' >
<params >
<param name= 'stack-size' doc= 'Set the stack size per thread in BYTE, 0 = OS default' />
<param name= '<0-2147483647>' doc= 'Stack size per thread in BYTE' />
</params>
</command>
2018-03-06 15:15:24 +00:00
<command id= 'chan <0-100>' >
<params >
<param name= 'chan' doc= 'Select a channel to configure' />
<param name= '<0-100>' doc= 'Channel index' />
</params>
</command>
</node>
<node id= 'config-trx-chan' >
<name > config-trx-chan</name>
<command id= 'rx-path NAME' >
<params >
<param name= 'rx-path' doc= 'Set the Rx Path' />
<param name= 'NAME' doc= 'Rx Path name' />
</params>
</command>
<command id= 'tx-path NAME' >
<params >
<param name= 'tx-path' doc= 'Set the Tx Path' />
<param name= 'NAME' doc= 'Tx Path name' />
</params>
</command>
</node>
</vtydoc>