| <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 [with-flags]'> |
| <params> |
| <param name='list' doc='Print command list' /> |
| <param name='[with-flags]' doc='Also print the VTY attribute flags' /> |
| </params> |
| </command> |
| <command id='show vty-attributes'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='vty-attributes' doc='List of VTY attributes' /> |
| </params> |
| </command> |
| <command id='show vty-attributes (application|library|global)'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='vty-attributes' doc='List of VTY attributes' /> |
| <param name='application' doc='Application specific attributes only' /> |
| <param name='library' doc='Library specific attributes only' /> |
| <param name='global' doc='Global attributes only' /> |
| </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 [PATH]'> |
| <params> |
| <param name='write' doc='Write running configuration to memory, network, or terminal' /> |
| <param name='file' doc='Write to configuration file' /> |
| <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' /> |
| </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 [expert-mode]'> |
| <params> |
| <param name='enable' doc='Turn on privileged mode command' /> |
| <param name='[expert-mode]' doc='Enable the expert mode (show hidden commands)' /> |
| </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> |
| <command id='logging print file (0|1|basename) [last]'> |
| <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' /> |
| <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.' /> |
| </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> |
| <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (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='gprs' doc='GPRS Packet Service' /> |
| <param name='ns' doc='GPRS Network Service (NS)' /> |
| <param name='obj' doc='GbProxy object allocation/release' /> |
| <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='lns' doc='GPRS NS layer' /> |
| <param name='lbssgp' doc='GPRS BSSGP layer' /> |
| <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.' /> |
| <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> |
| <command id='logp (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (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='gprs' doc='GPRS Packet Service' /> |
| <param name='ns' doc='GPRS Network Service (NS)' /> |
| <param name='obj' doc='GbProxy object allocation/release' /> |
| <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='lns' doc='GPRS NS layer' /> |
| <param name='lbssgp' doc='GPRS BSSGP layer' /> |
| <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> |
| <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> |
| <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> |
| <command id='show fsm NAME'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm' doc='Show information about finite state machines' /> |
| <param name='NAME' doc='Display information about a single named finite state machine' /> |
| </params> |
| </command> |
| <command id='show fsm all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm' doc='Show information about finite state machines' /> |
| <param name='all' doc='Display a list of all registered finite state machines' /> |
| </params> |
| </command> |
| <command id='show fsm-instances NAME'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm-instances' doc='Show information about finite state machine instances' /> |
| <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' /> |
| </params> |
| </command> |
| <command id='show fsm-instances all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm-instances' doc='Show information about finite state machine instances' /> |
| <param name='all' doc='Display a list of all FSM instances of all finite state machine' /> |
| </params> |
| </command> |
| <command id='show gbproxy bvc (bss|sgsn) [stats]'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='bvc' doc='Show BSSGP Virtual Connections' /> |
| <param name='bss' doc='Display BSS-side BVCs' /> |
| <param name='sgsn' doc='Display SGSN-side BVCs' /> |
| <param name='[stats]' doc='Show statistics' /> |
| </params> |
| </command> |
| <command id='show gbproxy cell [stats]'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='cell' doc='Show GPRS Cell Information' /> |
| <param name='[stats]' doc='Show statistics' /> |
| </params> |
| </command> |
| <command id='show gbproxy links'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='links' doc='Show logical links' /> |
| </params> |
| </command> |
| <command id='show gbproxy tlli-cache'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='tlli-cache' doc='Show TLLI cache entries' /> |
| </params> |
| </command> |
| <command id='show gbproxy imsi-cache'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='imsi-cache' doc='Show IMSI cache entries' /> |
| </params> |
| </command> |
| <command id='show nri all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='all' doc='Show all SGSNs' /> |
| </params> |
| </command> |
| <command id='show nri nsei <0-65535>'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='nsei' doc='Identify SGSN by NSEI' /> |
| <param name='<0-65535>' doc='NSEI of the SGSN' /> |
| </params> |
| </command> |
| <command id='logging filter bvc bvci <0-65535>'> |
| <params> |
| <param name='logging' doc='Configure logging' /> |
| <param name='filter' doc='Filter log messages' /> |
| <param name='bvc' doc='Filter based on BSSGP VC' /> |
| <param name='bvci' doc='Identify BVC by BVCI' /> |
| <param name='<0-65535>' doc='Numeric identifier' /> |
| </params> |
| </command> |
| </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> |
| <command id='logging print file (0|1|basename) [last]'> |
| <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' /> |
| <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.' /> |
| </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> |
| <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (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='gprs' doc='GPRS Packet Service' /> |
| <param name='ns' doc='GPRS Network Service (NS)' /> |
| <param name='obj' doc='GbProxy object allocation/release' /> |
| <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='lns' doc='GPRS NS layer' /> |
| <param name='lbssgp' doc='GPRS BSSGP layer' /> |
| <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.' /> |
| <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> |
| <command id='logp (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (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='gprs' doc='GPRS Packet Service' /> |
| <param name='ns' doc='GPRS Network Service (NS)' /> |
| <param name='obj' doc='GbProxy object allocation/release' /> |
| <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='lns' doc='GPRS NS layer' /> |
| <param name='lbssgp' doc='GPRS BSSGP layer' /> |
| <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> |
| <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> |
| <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> |
| <command id='stats report'> |
| <params> |
| <param name='stats' doc='Stats related commands' /> |
| <param name='report' doc='Manurally trigger reporting of stats' /> |
| </params> |
| </command> |
| <command id='stats reset'> |
| <params> |
| <param name='stats' doc='Stats related commands' /> |
| <param name='reset' doc='Reset all stats' /> |
| </params> |
| </command> |
| <command id='show fsm NAME'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm' doc='Show information about finite state machines' /> |
| <param name='NAME' doc='Display information about a single named finite state machine' /> |
| </params> |
| </command> |
| <command id='show fsm all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm' doc='Show information about finite state machines' /> |
| <param name='all' doc='Display a list of all registered finite state machines' /> |
| </params> |
| </command> |
| <command id='show fsm-instances NAME'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm-instances' doc='Show information about finite state machine instances' /> |
| <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' /> |
| </params> |
| </command> |
| <command id='show fsm-instances all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='fsm-instances' doc='Show information about finite state machine instances' /> |
| <param name='all' doc='Display a list of all FSM instances of all finite state machine' /> |
| </params> |
| </command> |
| <command id='show gbproxy bvc (bss|sgsn) [stats]'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='bvc' doc='Show BSSGP Virtual Connections' /> |
| <param name='bss' doc='Display BSS-side BVCs' /> |
| <param name='sgsn' doc='Display SGSN-side BVCs' /> |
| <param name='[stats]' doc='Show statistics' /> |
| </params> |
| </command> |
| <command id='show gbproxy cell [stats]'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='cell' doc='Show GPRS Cell Information' /> |
| <param name='[stats]' doc='Show statistics' /> |
| </params> |
| </command> |
| <command id='show gbproxy links'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='links' doc='Show logical links' /> |
| </params> |
| </command> |
| <command id='show gbproxy tlli-cache'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='tlli-cache' doc='Show TLLI cache entries' /> |
| </params> |
| </command> |
| <command id='show gbproxy imsi-cache'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='gbproxy' doc='Display information about the Gb proxy' /> |
| <param name='imsi-cache' doc='Show IMSI cache entries' /> |
| </params> |
| </command> |
| <command id='show nri all'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='all' doc='Show all SGSNs' /> |
| </params> |
| </command> |
| <command id='show nri nsei <0-65535>'> |
| <params> |
| <param name='show' doc='Show running system information' /> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='nsei' doc='Identify SGSN by NSEI' /> |
| <param name='<0-65535>' doc='NSEI of the SGSN' /> |
| </params> |
| </command> |
| <command id='logging filter bvc bvci <0-65535>'> |
| <params> |
| <param name='logging' doc='Configure logging' /> |
| <param name='filter' doc='Filter log messages' /> |
| <param name='bvc' doc='Filter based on BSSGP VC' /> |
| <param name='bvci' doc='Identify BVC by BVCI' /> |
| <param name='<0-65535>' doc='Numeric identifier' /> |
| </params> |
| </command> |
| <command id='delete-gbproxy-peer <0-65534> bvci <2-65534>'> |
| <params> |
| <param name='delete-gbproxy-peer' doc='Delete a GBProxy bvc by NSEI and optionally BVCI' /> |
| <param name='<0-65534>' doc='NSEI number' /> |
| <param name='bvci' doc='Only delete bvc with a matching BVCI' /> |
| <param name='<2-65534>' doc='BVCI number' /> |
| </params> |
| </command> |
| <command id='delete-gbproxy-peer <0-65534> (only-bvc|only-nsvc|all) [dry-run]'> |
| <params> |
| <param name='delete-gbproxy-peer' doc='Delete a GBProxy bvc by NSEI and optionally BVCI' /> |
| <param name='<0-65534>' doc='NSEI number' /> |
| <param name='only-bvc' doc='Only delete BSSGP connections (BVC)' /> |
| <param name='only-nsvc' doc='Only delete dynamic NS connections (NS-VC)' /> |
| <param name='all' doc='Delete BVC and dynamic NS connections' /> |
| <param name='[dry-run]' doc='Show what would be deleted instead of actually deleting' /> |
| </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 systemd-journal [raw]'> |
| <params> |
| <param name='log' doc='Configure logging sub-system' /> |
| <param name='systemd-journal' doc='Logging to systemd-journal' /> |
| <param name='[raw]' doc='Offload rendering of the meta information (location, category) to systemd' /> |
| </params> |
| </command> |
| <command id='no log systemd-journal'> |
| <params> |
| <param name='no' doc='Negate a command or set its defaults' /> |
| <param name='log' doc='Configure logging sub-system' /> |
| <param name='systemd-journal' doc='Logging to systemd-journal' /> |
| </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 <0-65535>'> |
| <params> |
| <param name='stats' doc='Configure stats sub-system' /> |
| <param name='interval' doc='Set the reporting interval' /> |
| <param name='<0-65535>' doc='Interval in seconds (0 disables the reporting interval)' /> |
| </params> |
| </command> |
| <command id='gbproxy'> |
| <params> |
| <param name='gbproxy' doc='Configure the Gb proxy' /> |
| </params> |
| </command> |
| <command id='sgsn nsei <0-65534>'> |
| <params> |
| <param name='sgsn' doc='Configure the SGSN' /> |
| <param name='nsei' doc='NSEI to be used in the connection with the SGSN' /> |
| <param name='<0-65534>' doc='The NSEI' /> |
| </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> |
| <command id='logging print file (0|1|basename) [last]'> |
| <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' /> |
| <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.' /> |
| </params> |
| </command> |
| <command id='logging level (|gprs|ns|obj|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro|lns|lbssgp) (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='gprs' doc='GPRS Packet Service' /> |
| <param name='ns' doc='GPRS Network Service (NS)' /> |
| <param name='obj' doc='GbProxy object allocation/release' /> |
| <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='lns' doc='GPRS NS layer' /> |
| <param name='lbssgp' doc='GPRS BSSGP layer' /> |
| <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.' /> |
| <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> |
| </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> |
| <command id='flush-period <0-65535>'> |
| <params> |
| <param name='flush-period' doc='Configure stats sub-system' /> |
| <param name='<0-65535>' doc='Send all stats even if they have not changed (i.e. force the flush)every N-th reporting interval. Set to 0 to disable regular flush (default).' /> |
| </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> |
| <command id='bind A.B.C.D [<0-65535>]'> |
| <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)' /> |
| <param name='[<0-65535>]' doc='Local TCP port number' /> |
| </params> |
| </command> |
| </node> |
| <node id='config-gbproxy'> |
| <name>config-gbproxy</name> |
| <command id='pool bvc-flow-control-ratio <1-100>'> |
| <params> |
| <param name='pool' doc='SGSN Pool related configuration' /> |
| <param name='bvc-flow-control-ratio' doc='Ratio of BSS-advertised bucket size + leak rate advertised to each SGSN' /> |
| <param name='<1-100>' doc='Ratio of BSS-advertised bucket size + leak rate advertised to each SGSN (Percent)' /> |
| </params> |
| </command> |
| <command id='nri bitlen <0-15>'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='bitlen' doc='Set number of bits that an NRI has, to extract from TMSI identities (always starting just after the TMSI's most significant octet).' /> |
| <param name='<0-15>' doc='bit count (0 disables) pooling)' /> |
| </params> |
| </command> |
| <command id='nri null add <0-32767> [<0-32767>]'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='null' doc='Define NULL-NRI values that cause re-assignment of an MS to a different SGSN, for SGSN pooling.' /> |
| <param name='add' doc='Add NULL-NRI value (or range)' /> |
| <param name='<0-32767>' doc='First value of the NRI value range, should not surpass the configured 'nri bitlen'.' /> |
| <param name='[<0-32767>]' doc='Last value of the NRI value range, should not surpass the configured 'nri bitlen' and be larger than the first value; if omitted, apply only the first value.' /> |
| </params> |
| </command> |
| <command id='nri null del <0-32767> [<0-32767>]'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='null' doc='Define NULL-NRI values that cause re-assignment of an MS to a different SGSN, for SGSN pooling.' /> |
| <param name='del' doc='Remove NRI value or range from the NRI mapping for this MSC' /> |
| <param name='<0-32767>' doc='First value of the NRI value range, should not surpass the configured 'nri bitlen'.' /> |
| <param name='[<0-32767>]' doc='Last value of the NRI value range, should not surpass the configured 'nri bitlen' and be larger than the first value; if omitted, apply only the first value.' /> |
| </params> |
| </command> |
| </node> |
| <node id='config-sgsn'> |
| <name>config-sgsn</name> |
| <command id='name NAME'> |
| <params> |
| <param name='name' doc='Configure the SGSN' /> |
| <param name='NAME' doc='Name the SGSN' /> |
| </params> |
| </command> |
| <command id='allow-attach'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='allow-attach' doc='Allow this SGSN to attach new subscribers (default).' /> |
| </params> |
| </command> |
| <command id='no allow-attach'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='no' doc='Negate a command or set its defaults' /> |
| <param name='allow-attach' doc='Do not assign new subscribers to this MSC. Useful if an MSC in an MSC pool is configured to off-load subscribers. The MSC will still be operational for already IMSI-Attached subscribers, but the NAS node selection function will skip this MSC for new subscribers' /> |
| </params> |
| </command> |
| <command id='nri add <0-32767> [<0-32767>]'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='add' doc='Add NRI value or range to the NRI mapping for this MSC' /> |
| <param name='<0-32767>' doc='First value of the NRI value range, should not surpass the configured 'nri bitlen'.' /> |
| <param name='[<0-32767>]' doc='Last value of the NRI value range, should not surpass the configured 'nri bitlen' and be larger than the first value; if omitted, apply only the first value.' /> |
| </params> |
| </command> |
| <command id='nri del <0-32767> [<0-32767>]'> |
| <attributes scope='global'> |
| <attribute doc='This command applies immediately' flag='!' /> |
| </attributes> |
| <params> |
| <param name='nri' doc='Mapping of Network Resource Indicators to this SGSN, for SGSN pooling' /> |
| <param name='del' doc='Remove NRI value or range from the NRI mapping for this MSC' /> |
| <param name='<0-32767>' doc='First value of the NRI value range, should not surpass the configured 'nri bitlen'.' /> |
| <param name='[<0-32767>]' doc='Last value of the NRI value range, should not surpass the configured 'nri bitlen' and be larger than the first value; if omitted, apply only the first value.' /> |
| </params> |
| </command> |
| </node> |
| </vtydoc> |