diff options
author | Harald Welte <laforge@osmocom.org> | 2021-02-23 16:53:47 +0100 |
---|---|---|
committer | Harald Welte <laforge@osmocom.org> | 2021-02-23 17:08:14 +0100 |
commit | 17cee2056cee8aa61d024ed1996131513962c450 (patch) | |
tree | fb3bf23eb8411aff8a8a34677105ed5c33fa905a | |
parent | 67a3c833af95b4a5da54b73ce8e3a027121d2305 (diff) |
manuals: generate vty reference xml at build time
Remove ggsn_vty_reference from the source tree.
In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-ggsn --vty-ref-xml cmdline switch.
Change-Id: I772293cc78a6c95e07565a7048c1c8dadf87d2fc
Depends: I613d692328050a036d05b49a436ab495fc2087ba
Related: OS#5041
-rw-r--r-- | doc/manuals/Makefile.am | 6 | ||||
-rw-r--r-- | doc/manuals/vty/ggsn_vty_reference.xml | 1639 |
2 files changed, 6 insertions, 1639 deletions
diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am index f9f47fb..cbaf41a 100644 --- a/doc/manuals/Makefile.am +++ b/doc/manuals/Makefile.am @@ -11,6 +11,12 @@ if BUILD_MANUALS include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc VTY_REFERENCE = osmoggsn-vty-reference.xml + + BUILT_REFERENCE_XML = $(builddir)/vty/ggsn_vty_reference.xml + $(builddir)/vty/ggsn_vty_reference.xml: $(top_builddir)/ggsn/osmo-ggsn + mkdir -p $(builddir)/vty + $(top_builddir)/ggsn/osmo-ggsn --vty-ref-xml > $@ + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc OSMO_REPOSITORY=osmo-ggsn diff --git a/doc/manuals/vty/ggsn_vty_reference.xml b/doc/manuals/vty/ggsn_vty_reference.xml deleted file mode 100644 index bbc8471..0000000 --- a/doc/manuals/vty/ggsn_vty_reference.xml +++ /dev/null @@ -1,1639 +0,0 @@ -<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> - <node id='_common_cmds_'> - <name>Common Commands</name> - <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description> - <command id='help'> - <params> - <param name='help' doc='Description of the interactive help system' /> - </params> - </command> - <command id='list'> - <params> - <param name='list' doc='Print command list' /> - </params> - </command> - <command id='write terminal'> - <params> - <param name='write' doc='Write running configuration to memory, network, or terminal' /> - <param name='terminal' doc='Write to terminal' /> - </params> - </command> - <command id='write file [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'> - <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> - <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 (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='ip' doc='IP Pool and other groups' /> - <param name='tun' doc='Tunnel interface' /> - <param name='ggsn' doc='GGSN' /> - <param name='sgsn' doc='SGSN Emulator' /> - <param name='icmp6' doc='ICMPv6' /> - <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' /> - </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 (ip|tun|ggsn|sgsn|icmp6|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='ip' doc='IP Pool and other groups' /> - <param name='tun' doc='Tunnel interface' /> - <param name='ggsn' doc='GGSN' /> - <param name='sgsn' doc='SGSN Emulator' /> - <param name='icmp6' doc='ICMPv6' /> - <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> - <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 pdp-context ggsn NAME'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Show PDP Context Information' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - </params> - </command> - <command id='show pdp-context ggsn NAME apn APN'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Show PDP Context Information' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='apn' doc='Filter by APN' /> - <param name='APN' doc='APN name' /> - </params> - </command> - <command id='show pdp-context ggsn NAME imsi IMSI [<0-15>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Display information on PDP Context' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='imsi' doc='PDP contexts for given IMSI' /> - <param name='IMSI' doc='PDP context for given NSAPI' /> - <param name='[<0-15>]' doc='(null)' /> - </params> - </command> - <command id='show pdp-context ggsn NAME ipv4 A.B.C.D'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Display information on PDP Context' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='ipv4' doc='IPv4 address type' /> - <param name='A.B.C.D' doc='IP address' /> - </params> - </command> - <command id='show ggsn [NAME]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ggsn' doc='Display information on the GGSN' /> - <param name='[NAME]' doc='(null)' /> - </params> - </command> - <command id='show cpu-sched threads'> - <params> - <param name='show' doc='Show running system information' /> - <param name='cpu-sched' doc='Show Sched section information' /> - <param name='threads' doc='Show information about running threads)' /> - </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 (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='ip' doc='IP Pool and other groups' /> - <param name='tun' doc='Tunnel interface' /> - <param name='ggsn' doc='GGSN' /> - <param name='sgsn' doc='SGSN Emulator' /> - <param name='icmp6' doc='ICMPv6' /> - <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' /> - </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 (ip|tun|ggsn|sgsn|icmp6|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='ip' doc='IP Pool and other groups' /> - <param name='tun' doc='Tunnel interface' /> - <param name='ggsn' doc='GGSN' /> - <param name='sgsn' doc='SGSN Emulator' /> - <param name='icmp6' doc='ICMPv6' /> - <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> - <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 pdp-context ggsn NAME'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Show PDP Context Information' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - </params> - </command> - <command id='show pdp-context ggsn NAME apn APN'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Show PDP Context Information' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='apn' doc='Filter by APN' /> - <param name='APN' doc='APN name' /> - </params> - </command> - <command id='show pdp-context ggsn NAME imsi IMSI [<0-15>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Display information on PDP Context' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='imsi' doc='PDP contexts for given IMSI' /> - <param name='IMSI' doc='PDP context for given NSAPI' /> - <param name='[<0-15>]' doc='(null)' /> - </params> - </command> - <command id='show pdp-context ggsn NAME ipv4 A.B.C.D'> - <params> - <param name='show' doc='Show running system information' /> - <param name='pdp-context' doc='Display information on PDP Context' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='NAME' doc='GGSN Name' /> - <param name='ipv4' doc='IPv4 address type' /> - <param name='A.B.C.D' doc='IP address' /> - </params> - </command> - <command id='show ggsn [NAME]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ggsn' doc='Display information on the GGSN' /> - <param name='[NAME]' doc='(null)' /> - </params> - </command> - <command id='show cpu-sched threads'> - <params> - <param name='show' doc='Show running system information' /> - <param name='cpu-sched' doc='Show Sched section information' /> - <param name='threads' doc='Show information about running threads)' /> - </params> - </command> - </node> - <node id='config'> - <name>config</name> - <command id='hostname WORD'> - <params> - <param name='hostname' doc='Set system's network name' /> - <param name='WORD' doc='This system's network name' /> - </params> - </command> - <command id='no hostname [HOSTNAME]'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='hostname' doc='Reset system's network name' /> - <param name='[HOSTNAME]' doc='Host name of this router' /> - </params> - </command> - <command id='password (8|) WORD'> - <params> - <param name='password' doc='Assign the terminal connection password' /> - <param name='8' doc='Specifies a HIDDEN password will follow' /> - <param name='' doc='dummy string ' /> - <param name='WORD' doc='The HIDDEN line password string' /> - </params> - </command> - <command id='password LINE'> - <params> - <param name='password' doc='Assign the terminal connection password' /> - <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> - </params> - </command> - <command id='enable password (8|) WORD'> - <params> - <param name='enable' doc='Modify enable password parameters' /> - <param name='password' doc='Assign the privileged level password' /> - <param name='8' doc='Specifies a HIDDEN password will follow' /> - <param name='' doc='dummy string ' /> - <param name='WORD' doc='The HIDDEN 'enable' password string' /> - </params> - </command> - <command id='enable password LINE'> - <params> - <param name='enable' doc='Modify enable password parameters' /> - <param name='password' doc='Assign the privileged level password' /> - <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> - </params> - </command> - <command id='no enable password'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='enable' doc='Modify enable password parameters' /> - <param name='password' doc='Assign the privileged level password' /> - </params> - </command> - <command id='banner motd default'> - <params> - <param name='banner' doc='Set banner string' /> - <param name='motd' doc='Strings for motd' /> - <param name='default' doc='Default string' /> - </params> - </command> - <command id='banner motd file [FILE]'> - <params> - <param name='banner' doc='Set banner' /> - <param name='motd' doc='Banner for motd' /> - <param name='file' doc='Banner from a file' /> - <param name='[FILE]' doc='Filename' /> - </params> - </command> - <command id='no banner motd'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='banner' doc='Set banner string' /> - <param name='motd' doc='Strings for motd' /> - </params> - </command> - <command id='service terminal-length <0-512>'> - <params> - <param name='service' doc='Set up miscellaneous service' /> - <param name='terminal-length' doc='System wide terminal length configuration' /> - <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> - </params> - </command> - <command id='no service terminal-length [<0-512>]'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='service' doc='Set up miscellaneous service' /> - <param name='terminal-length' doc='System wide terminal length configuration' /> - <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> - </params> - </command> - <command id='line vty'> - <params> - <param name='line' doc='Configure a terminal line' /> - <param name='vty' doc='Virtual terminal' /> - </params> - </command> - <command id='service advanced-vty'> - <params> - <param name='service' doc='Set up miscellaneous service' /> - <param name='advanced-vty' doc='Enable advanced mode vty interface' /> - </params> - </command> - <command id='no service advanced-vty'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='service' doc='Set up miscellaneous service' /> - <param name='advanced-vty' doc='Enable advanced mode vty interface' /> - </params> - </command> - <command id='show history'> - <params> - <param name='show' doc='Show running system information' /> - <param name='history' doc='Display the session command history' /> - </params> - </command> - <command id='log stderr'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='stderr' doc='Logging via STDERR of the process' /> - </params> - </command> - <command id='no log stderr'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='log' doc='Configure logging sub-system' /> - <param name='stderr' doc='Logging via STDERR of the process' /> - </params> - </command> - <command id='log file .FILENAME'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='file' doc='Logging to text file' /> - <param name='.FILENAME' doc='Filename' /> - </params> - </command> - <command id='no log file .FILENAME'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='log' doc='Configure logging sub-system' /> - <param name='file' doc='Logging to text file' /> - <param name='.FILENAME' doc='Filename' /> - </params> - </command> - <command id='log alarms <2-32700>'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='alarms' doc='Logging alarms to osmo_strrb' /> - <param name='<2-32700>' doc='Maximum number of messages to log' /> - </params> - </command> - <command id='no log alarms'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='log' doc='Configure logging sub-system' /> - <param name='alarms' doc='Logging alarms to osmo_strrb' /> - </params> - </command> - <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='syslog' doc='Logging via syslog' /> - <param name='authpriv' doc='Security/authorization messages facility' /> - <param name='cron' doc='Clock daemon (cron/at) facility' /> - <param name='daemon' doc='General system daemon facility' /> - <param name='ftp' doc='Ftp daemon facility' /> - <param name='lpr' doc='Line printer facility' /> - <param name='mail' doc='Mail facility' /> - <param name='news' doc='News facility' /> - <param name='user' doc='Generic facility' /> - <param name='uucp' doc='UUCP facility' /> - </params> - </command> - <command id='log syslog local <0-7>'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='syslog' doc='Logging via syslog' /> - <param name='local' doc='Syslog LOCAL facility' /> - <param name='<0-7>' doc='Local facility number' /> - </params> - </command> - <command id='no log syslog'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='log' doc='Configure logging sub-system' /> - <param name='syslog' doc='Logging via syslog' /> - </params> - </command> - <command id='log gsmtap [HOSTNAME]'> - <params> - <param name='log' doc='Configure logging sub-system' /> - <param name='gsmtap' doc='Logging via GSMTAP' /> - <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> - </params> - </command> - <command id='stats reporter statsd'> - <params> - <param name='stats' doc='Configure stats sub-system' /> - <param name='reporter' doc='Configure a stats reporter' /> - <param name='statsd' doc='Report to a STATSD server' /> - </params> - </command> - <command id='no stats reporter statsd'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='stats' doc='Configure stats sub-system' /> - <param name='reporter' doc='Configure a stats reporter' /> - <param name='statsd' doc='Report to a STATSD server' /> - </params> - </command> - <command id='stats reporter log'> - <params> - <param name='stats' doc='Configure stats sub-system' /> - <param name='reporter' doc='Configure a stats reporter' /> - <param name='log' doc='Report to the logger' /> - </params> - </command> - <command id='no stats reporter log'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='stats' doc='Configure stats sub-system' /> - <param name='reporter' doc='Configure a stats reporter' /> - <param name='log' doc='Report to the logger' /> - </params> - </command> - <command id='stats interval <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='ggsn NAME'> - <params> - <param name='ggsn' doc='Configure the Gateway GPRS Support Node' /> - <param name='NAME' doc='GGSN Name (has only local significance)' /> - </params> - </command> - <command id='no ggsn NAME'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ggsn' doc='Remove the named Gateway GPRS Support Node' /> - <param name='NAME' doc='GGSN Name (has only local significance)' /> - </params> - </command> - <command id='ctrl'> - <params> - <param name='ctrl' doc='Configure the Control Interface' /> - </params> - </command> - <command id='cpu-sched'> - <params> - <param name='cpu-sched' doc='Configure CPU Scheduler related settings' /> - </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 (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='ip' doc='IP Pool and other groups' /> - <param name='tun' doc='Tunnel interface' /> - <param name='ggsn' doc='GGSN' /> - <param name='sgsn' doc='SGSN Emulator' /> - <param name='icmp6' doc='ICMPv6' /> - <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' /> - </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-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-cpu-sched'> - <name>config-cpu-sched</name> - <command id='policy rr <1-32>'> - <params> - <param name='policy' doc='Set the scheduling policy to use for the process' /> - <param name='rr' doc='Use the SCHED_RR real-time scheduling algorithm' /> - <param name='<1-32>' doc='Set the SCHED_RR real-time priority' /> - </params> - </command> - <command id='cpu-affinity (self|all|<0-4294967295>|THREADNAME) CPUHEXMASK [delay]'> - <params> - <param name='cpu-affinity' doc='Set CPU affinity mask on a (group of) thread(s)' /> - <param name='self' doc='Set CPU affinity mask on thread running the VTY' /> - <param name='all' doc='Set CPU affinity mask on all process' threads' /> - <param name='<0-4294967295>' doc='Set CPU affinity mask on a thread with specified PID' /> - <param name='THREADNAME' doc='Set CPU affinity mask on a thread with specified thread name' /> - <param name='CPUHEXMASK' doc='CPU affinity mask' /> - <param name='[delay]' doc='If set, delay applying the affinity mask now and let the app handle it at a later point' /> - </params> - </command> - </node> - <node id='config-ggsn'> - <name>config-ggsn</name> - <command id='description .TEXT'> - <params> - <param name='description' doc='Save human-readable description of the object' /> - <param name='.TEXT' doc='Text until the end of the line' /> - </params> - </command> - <command id='no description'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='description' doc='Remove description of the object' /> - </params> - </command> - <command id='shutdown ggsn'> - <params> - <param name='shutdown' doc='Put the GGSN in administrative shut-down' /> - <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' /> - </params> - </command> - <command id='no shutdown ggsn'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='shutdown' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='ggsn' doc='Remove the GGSN from administrative shut-down' /> - </params> - </command> - <command id='gtp bind-ip A.B.C.D'> - <params> - <param name='gtp' doc='GTP Parameters' /> - <param name='bind-ip' doc='Set the IP address for the local GTP bind' /> - <param name='A.B.C.D' doc='IPv4 Address' /> - </params> - </command> - <command id='gtp control-ip A.B.C.D'> - <params> - <param name='gtp' doc='GTP Parameters' /> - <param name='control-ip' doc='Set the IP address states as local IP in GTP-C messages' /> - <param name='A.B.C.D' doc='IPv4 Address' /> - </params> - </command> - <command id='gtp user-ip A.B.C.D'> - <params> - <param name='gtp' doc='GTP Parameters' /> - <param name='user-ip' doc='Set the IP address states as local IP in GTP-U messages' /> - <param name='A.B.C.D' doc='IPv4 Address' /> - </params> - </command> - <command id='gtp state-dir PATH'> - <params> - <param name='gtp' doc='GTP Parameters' /> - <param name='state-dir' doc='Set the directory for the GTP State file' /> - <param name='PATH' doc='Local Directory' /> - </params> - </command> - <command id='apn NAME'> - <params> - <param name='apn' doc='APN Configuration' /> - <param name='NAME' doc='APN Name' /> - </params> - </command> - <command id='no apn NAME'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='apn' doc='Remove APN Configuration' /> - <param name='NAME' doc='APN Name' /> - </params> - </command> - <command id='default-apn NAME'> - <params> - <param name='default-apn' doc='Set a default-APN to be used if no other APN matches' /> - <param name='NAME' doc='APN Name' /> - </params> - </command> - <command id='no default-apn'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='default-apn' doc='Remove default-APN to be used if no other APN matches' /> - </params> - </command> - <command id='show sgsn'> - <params> - <param name='show' doc='Negate a command or set its defaults' /> - <param name='sgsn' doc='Gateway GPRS Support NODE (GGSN)' /> - </params> - </command> - <command id='echo-interval <1-36000>'> - <params> - <param name='echo-interval' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='<1-36000>' doc='GGSN Number' /> - </params> - </command> - <command id='no echo-interval'> - <params> - <param name='no' doc='Gateway GPRS Support NODE (GGSN)' /> - <param name='echo-interval' doc='GGSN Number' /> - </params> - </command> - </node> - <node id='config-ggsn-apn'> - <name>config-ggsn-apn</name> - <command id='description .TEXT'> - <params> - <param name='description' doc='Save human-readable description of the object' /> - <param name='.TEXT' doc='Text until the end of the line' /> - </params> - </command> - <command id='no description'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='description' doc='Remove description of the object' /> - </params> - </command> - <command id='shutdown'> - <params> - <param name='shutdown' doc='Put the APN in administrative shut-down' /> - </params> - </command> - <command id='no shutdown'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='shutdown' doc='Remove the APN from administrative shut-down' /> - </params> - </command> - <command id='gtpu-mode (tun|kernel-gtp)'> - <params> - <param name='gtpu-mode' doc='Set the Mode for this APN (tun or Linux Kernel GTP)' /> - <param name='tun' doc='GTP-U in userspace using TUN device' /> - <param name='kernel-gtp' doc='GTP-U in kernel using Linux Kernel GTP' /> - </params> - </command> - <command id='type-support (v4|v6|v4v6)'> - <params> - <param name='type-support' doc='Enable support for PDP Type' /> - <param name='v4' doc='IPv4(-only) PDP Type' /> - <param name='v6' doc='IPv6(-only) PDP Type' /> - <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' /> - </params> - </command> - <command id='no type-support (v4|v6|v4v6)'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='type-support' doc='Disable support for PDP Type' /> - <param name='v4' doc='IPv4(-only) PDP Type' /> - <param name='v6' doc='IPv6(-only) PDP Type' /> - <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' /> - </params> - </command> - <command id='tun-device NAME'> - <params> - <param name='tun-device' doc='Configure tun device name' /> - <param name='NAME' doc='TUN device name' /> - </params> - </command> - <command id='ipup-script PATH'> - <params> - <param name='ipup-script' doc='Configure name/path of ip-up script' /> - <param name='PATH' doc='File/Path name of ip-up script' /> - </params> - </command> - <command id='no ipup-script'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ipup-script' doc='Disable ip-up script' /> - </params> - </command> - <command id='ipdown-script PATH'> - <params> - <param name='ipdown-script' doc='Configure name/path of ip-down script' /> - <param name='PATH' doc='File/Path name of ip-down script' /> - </params> - </command> - <command id='no ipdown-script'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ipdown-script' doc='Disable ip-down script' /> - </params> - </command> - <command id='ip prefix (static|dynamic) A.B.C.D/M'> - <params> - <param name='ip' doc='IP information' /> - <param name='prefix' doc='Prefix (Network/Netmask)' /> - <param name='static' doc='IPv4 Adress/Prefix-Length' /> - <param name='dynamic' doc='(null)' /> - <param name='A.B.C.D/M' doc='(null)' /> - </params> - </command> - <command id='ipv6 prefix (static|dynamic) X:X::X:X/M'> - <params> - <param name='ipv6' doc='IPv6 Information' /> - <param name='prefix' doc='Prefix (Network/Netmask)' /> - <param name='static' doc='IPv6 Address/Prefix-Length' /> - <param name='dynamic' doc='(null)' /> - <param name='X:X::X:X/M' doc='(null)' /> - </params> - </command> - <command id='ip dns <0-1> A.B.C.D'> - <params> - <param name='ip' doc='IP information' /> - <param name='dns' doc='Configure DNS Server' /> - <param name='<0-1>' doc='primary/secondary DNS' /> - <param name='A.B.C.D' doc='IP address of DNS Sever' /> - </params> - </command> - <command id='ipv6 dns <0-1> X:X::X:X'> - <params> - <param name='ipv6' doc='IPv6 Information' /> - <param name='dns' doc='Configure DNS Server' /> - <param name='<0-1>' doc='primary/secondary DNS' /> - <param name='X:X::X:X' doc='IP address of DNS Sever' /> - </params> - </command> - <command id='no (ip|ipv6) dns <0-1>'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ip' doc='IP information' /> - <param name='ipv6' doc='IPv6 Information' /> - <param name='dns' doc='Disable DNS Server' /> - <param name='<0-1>' doc='primary/secondary DNS' /> - </params> - </command> - <command id='ip ifconfig A.B.C.D/M'> - <params> - <param name='ip' doc='IP information' /> - <param name='ifconfig' doc='GGSN-based interface configuration' /> - <param name='A.B.C.D/M' doc='IPv4 Adress/Prefix-Length' /> - </params> - </command> - <command id='no ip ifconfig'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ip' doc='IP information' /> - <param name='ifconfig' doc='GGSN-based interface configuration' /> - </params> - </command> - <command id='ipv6 ifconfig X:X::X:X/M'> - <params> - <param name='ipv6' doc='IPv6 Information' /> - <param name='ifconfig' doc='GGSN-based interface configuration' /> - <param name='X:X::X:X/M' doc='IPv6 Adress/Prefix-Length' /> - </params> - </command> - <command id='no ipv6 ifconfig'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ipv6' doc='IPv6 Information' /> - <param name='ifconfig' doc='GGSN-based interface configuration' /> - </params> - </command> - <command id='ipv6 link-local X:X::X:X/M'> - <params> - <param name='ipv6' doc='IPv6 Information' /> - <param name='link-local' doc='GGSN-based interface configuration' /> - <param name='X:X::X:X/M' doc='IPv6 Link-local Adress/Prefix-Length' /> - </params> - </command> - <command id='no ipv6 link-local'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='ipv6' doc='IPv6 Information' /> - <param name='link-local' doc='GGSN-based interface configuration' /> - </params> - </command> - <command id='g-pdu tx-sequence-numbers'> - <params> - <param name='g-pdu' doc='G-PDU Configuration' /> - <param name='tx-sequence-numbers' doc='Enable transmission of G-PDU sequence numbers' /> - </params> - </command> - <command id='no g-pdu tx-sequence-numbers'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='g-pdu' doc='G-PDU Configuration' /> - <param name='tx-sequence-numbers' doc='Disable transmission of G-PDU sequence numbers' /> - </params> - </command> - </node> -</vtydoc> |