diff options
| author | Oliver Smith <osmith@sysmocom.de> | 2019-12-02 11:17:00 +0100 |
|---|---|---|
| committer | Oliver Smith <osmith@sysmocom.de> | 2019-12-03 11:39:26 +0100 |
| commit | 118c411e81d6a3aa96a721beab937a361fa5d551 (patch) | |
| tree | 727b0cb16eca3ba640dda54b71fb573803c3cac6 | |
| parent | fa2656d14e65cfab0ae80c66db982d533de486e3 (diff) | |
doc: add OsmoGbProxy VTY reference
Depends: (osmo-gsm-manuals) I4dea3e07b88175b2a88e577129360af7ec5f87e1
Related: OS#4292
Change-Id: I24c3ca2fc2446673edceefb797c7d800c3a1a5d2
| -rw-r--r-- | doc/manuals/Makefile.am | 7 | ||||
| -rw-r--r-- | doc/manuals/osmogbproxy-vty-reference.xml | 38 | ||||
| -rw-r--r-- | doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml | 5 | ||||
| -rw-r--r-- | doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml | 1627 |
4 files changed, 1675 insertions, 2 deletions
diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am index 72e8c77e4..cd57cf148 100644 --- a/doc/manuals/Makefile.am +++ b/doc/manuals/Makefile.am @@ -5,14 +5,17 @@ EXTRA_DIST = osmosgsn-usermanual.adoc \ osmogbproxy-usermanual-docinfo.xml \ regen_doc.sh \ chapters \ - vty + vty \ + osmogbproxy-vty-reference.xml \ + vty-osmogbproxy \ + $(NULL) if BUILD_MANUALS ASCIIDOC = osmosgsn-usermanual.adoc osmogbproxy-usermanual.adoc ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc - VTY_REFERENCE = osmosgsn-vty-reference.xml + VTY_REFERENCE = osmosgsn-vty-reference.xml osmogbproxy-vty-reference.xml include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc OSMO_REPOSITORY = osmo-sgsn diff --git a/doc/manuals/osmogbproxy-vty-reference.xml b/doc/manuals/osmogbproxy-vty-reference.xml new file mode 100644 index 000000000..ecf226808 --- /dev/null +++ b/doc/manuals/osmogbproxy-vty-reference.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ex:ts=2:sw=42sts=2:et + -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN" +"http://docbook.org/xml/5.0/dtd/docbook.dtd" [ +<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" > +<!ENTITY sections-vty SYSTEM "generated/docbook_osmogbproxy-vty-reference.xml" > +]> + +<book> + <info> + <revhistory> + <revision> + <revnumber>v1</revnumber> + <date>2nd December 2019</date> + <authorinitials>hw</authorinitials> + <revremark>Initial</revremark> + </revision> + </revhistory> + + <title>OsmoGbProxy VTY Reference</title> + + <copyright> + <year>2019</year> + </copyright> + + <legalnotice> + <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved. + </para> + </legalnotice> + </info> + + <!-- Main chapters--> + &chapter-vty; +</book> + diff --git a/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml b/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml new file mode 100644 index 000000000..6da2d2f2f --- /dev/null +++ b/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml @@ -0,0 +1,5 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> + <node id='config-gbproxy'> + <description>Configure the Gb proxy</description> + </node> +</vtydoc> diff --git a/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml b/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml new file mode 100644 index 000000000..1db3c0d2f --- /dev/null +++ b/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml @@ -0,0 +1,1627 @@ +<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 (|gprs|ns|bssgp|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='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <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 (|gprs|ns|bssgp|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='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <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 gbproxy [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='gbproxy' doc='Display information about the Gb proxy' /> + <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 ns'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + </params> + </command> + <command id='show ns stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='stats' doc='Include statistics' /> + </params> + </command> + <command id='show ns persistent'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='persistent' doc='Show only persistent NS' /> + </params> + </command> + <command id='show ns (nsei|nsvc) <0-65535> [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='nsei' doc='Select one NSE by its NSE Identifier' /> + <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> + <param name='<0-65535>' doc='The Identifier of selected type' /> + <param name='[stats]' doc='Include Statistics' /> + </params> + </command> + <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='nsvc' doc='Filter based on NS Virtual Connection' /> + <param name='nsei' doc='Identify NS-VC by NSEI' /> + <param name='nsvci' doc='Identify NS-VC by NSVCI' /> + <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|bssgp|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='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <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 (|gprs|ns|bssgp|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='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <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 gbproxy [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='gbproxy' doc='Display information about the Gb proxy' /> + <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='delete-gbproxy-peer <0-65534> bvci <2-65534>'> + <params> + <param name='delete-gbproxy-peer' doc='Delete a GBProxy peer by NSEI and optionally BVCI' /> + <param name='<0-65534>' doc='NSEI number' /> + <param name='bvci' doc='Only delete peer 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 peer 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> + <command id='delete-gbproxy-link <0-65534> (tlli|imsi|sgsn-nsei) IDENT'> + <params> + <param name='delete-gbproxy-link' doc='Delete a GBProxy logical link entry by NSEI and identification' /> + <param name='<0-65534>' doc='NSEI number' /> + <param name='tlli' doc='Delete entries with a matching TLLI (hex)' /> + <param name='imsi' doc='Delete entries with a matching IMSI' /> + <param name='sgsn-nsei' doc='Delete entries with a matching SGSN NSEI' /> + <param name='IDENT' doc='Identification to match' /> + </params> + </command> + <command id='delete-gbproxy-link <0-65534> (stale|de-registered)'> + <params> + <param name='delete-gbproxy-link' doc='Delete a GBProxy logical link entry by NSEI and identification' /> + <param name='<0-65534>' doc='NSEI number' /> + <param name='stale' doc='Delete stale entries' /> + <param name='de-registered' doc='Delete de-registered entries' /> + </params> + </command> + <command id='show ns'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + </params> + </command> + <command id='show ns stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='stats' doc='Include statistics' /> + </params> + </command> + <command id='show ns persistent'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='persistent' doc='Show only persistent NS' /> + </params> + </command> + <command id='show ns (nsei|nsvc) <0-65535> [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ns' doc='Display information about the NS protocol' /> + <param name='nsei' doc='Select one NSE by its NSE Identifier' /> + <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> + <param name='<0-65535>' doc='The Identifier of selected type' /> + <param name='[stats]' doc='Include Statistics' /> + </params> + </command> + <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='nsvc' doc='Filter based on NS Virtual Connection' /> + <param name='nsei' doc='Identify NS-VC by NSEI' /> + <param name='nsvci' doc='Identify NS-VC by NSVCI' /> + <param name='<0-65535>' doc='Numeric identifier' /> + </params> + </command> + <command id='nsvc (nsei|nsvci) <0-65535> (block|unblock|reset)'> + <params> + <param name='nsvc' doc='Perform an operation on a NSVC' /> + <param name='nsei' doc='NSEI to identify NS-VC Identifier (NS-VCI)' /> + <param name='nsvci' doc='NS-VC Identifier (NS-VCI)' /> + <param name='<0-65535>' doc='The NSEI' /> + <param name='block' doc='Initiate BLOCK procedure' /> + <param name='unblock' doc='Initiate UNBLOCK procedure' /> + <param name='reset' doc='Initiate RESET procedure' /> + </params> + </command> + </node> + <node id='config'> + <name>config</name> + <command id='hostname WORD'> + <params> + <param name='hostname' doc='Set system's network name' /> + <param name='WORD' doc='This system's network name' /> + </params> + </command> + <command id='no hostname [HOSTNAME]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='hostname' doc='Reset system's network name' /> + <param name='[HOSTNAME]' doc='Host name of this router' /> + </params> + </command> + <command id='password (8|) WORD'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN line password string' /> + </params> + </command> + <command id='password LINE'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> + </params> + </command> + <command id='enable password (8|) WORD'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN 'enable' password string' /> + </params> + </command> + <command id='enable password LINE'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> + </params> + </command> + <command id='no enable password'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + </params> + </command> + <command id='banner motd default'> + <params> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + <param name='default' doc='Default string' /> + </params> + </command> + <command id='banner motd file [FILE]'> + <params> + <param name='banner' doc='Set banner' /> + <param name='motd' doc='Banner for motd' /> + <param name='file' doc='Banner from a file' /> + <param name='[FILE]' doc='Filename' /> + </params> + </command> + <command id='no banner motd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + </params> + </command> + <command id='service terminal-length <0-512>'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='no service terminal-length [<0-512>]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='line vty'> + <params> + <param name='line' doc='Configure a terminal line' /> + <param name='vty' doc='Virtual terminal' /> + </params> + </command> + <command id='service advanced-vty'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='no service advanced-vty'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='log stderr'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='no log stderr'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='log file .FILENAME'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='no log file .FILENAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='log alarms <2-32700>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + <param name='<2-32700>' doc='Maximum number of messages to log' /> + </params> + </command> + <command id='no log alarms'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + </params> + </command> + <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='authpriv' doc='Security/authorization messages facility' /> + <param name='cron' doc='Clock daemon (cron/at) facility' /> + <param name='daemon' doc='General system daemon facility' /> + <param name='ftp' doc='Ftp daemon facility' /> + <param name='lpr' doc='Line printer facility' /> + <param name='mail' doc='Mail facility' /> + <param name='news' doc='News facility' /> + <param name='user' doc='Generic facility' /> + <param name='uucp' doc='UUCP facility' /> + </params> + </command> + <command id='log syslog local <0-7>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='local' doc='Syslog LOCAL facility' /> + <param name='<0-7>' doc='Local facility number' /> + </params> + </command> + <command id='no log syslog'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + </params> + </command> + <command id='log gsmtap [HOSTNAME]'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='gsmtap' doc='Logging via GSMTAP' /> + <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> + </params> + </command> + <command id='stats reporter statsd'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='no stats reporter statsd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='stats reporter log'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='no stats reporter log'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='stats interval <1-65535>'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='interval' doc='Set the reporting interval' /> + <param name='<1-65535>' doc='Interval in seconds' /> + </params> + </command> + <command id='gbproxy'> + <params> + <param name='gbproxy' doc='Configure the Gb proxy' /> + </params> + </command> + <command id='ns'> + <params> + <param name='ns' doc='Configure the GPRS Network Service' /> + </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|bssgp|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='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <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='logging filter nsvc (nsei|nsvci) <0-65535>'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='nsvc' doc='Filter based on NS Virtual Connection' /> + <param name='nsei' doc='Identify NS-VC by NSEI' /> + <param name='nsvci' doc='Identify NS-VC by NSVCI' /> + <param name='<0-65535>' doc='Numeric identifier' /> + </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> + </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-ns'> + <name>config-ns</name> + <command id='nse <0-65535> nsvci <0-65534>'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='nsvci' doc='NS Virtual Connection' /> + <param name='<0-65534>' doc='NS Virtual Connection ID (NSVCI)' /> + </params> + </command> + <command id='nse <0-65535> remote-ip A.B.C.D'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='remote-ip' doc='Remote IP Address' /> + <param name='A.B.C.D' doc='Remote IP Address' /> + </params> + </command> + <command id='nse <0-65535> remote-port <0-65535>'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='remote-port' doc='Remote UDP Port' /> + <param name='<0-65535>' doc='Remote UDP Port Number' /> + </params> + </command> + <command id='nse <0-65535> fr-dlci <16-1007>'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='fr-dlci' doc='Frame Relay DLCI' /> + <param name='<16-1007>' doc='Frame Relay DLCI Number' /> + </params> + </command> + <command id='nse <0-65535> encapsulation (udp|framerelay-gre)'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='encapsulation' doc='Encapsulation for NS' /> + <param name='udp' doc='UDP/IP Encapsulation' /> + <param name='framerelay-gre' doc='Frame-Relay/GRE/IP Encapsulation' /> + </params> + </command> + <command id='nse <0-65535> remote-role (sgsn|bss)'> + <params> + <param name='nse' doc='Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + <param name='remote-role' doc='Remote NSE Role' /> + <param name='sgsn' doc='Remote Peer is SGSN' /> + <param name='bss' doc='Remote Peer is BSS' /> + </params> + </command> + <command id='no nse <0-65535>'> + <params> + <param name='no' doc='Delete Persistent NS Entity' /> + <param name='nse' doc='Delete Persistent NS Entity' /> + <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> + </params> + </command> + <command id='timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) <0-65535>'> + <params> + <param name='timer' doc='Network Service Timer' /> + <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' /> + <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' /> + <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' /> + <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' /> + <param name='tns-test' doc='Test Timer (Tns-test) timeout' /> + <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' /> + <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' /> + <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' /> + <param name='<0-65535>' doc='Timer Value' /> + </params> + </command> + <command id='encapsulation udp local-ip A.B.C.D'> + <params> + <param name='encapsulation' doc='NS encapsulation options' /> + <param name='udp' doc='NS over UDP Encapsulation' /> + <param name='local-ip' doc='Set the IP address on which we listen for NS/UDP' /> + <param name='A.B.C.D' doc='IP Address' /> + </params> + </command> + <command id='encapsulation udp local-port <0-65535>'> + <params> + <param name='encapsulation' doc='NS encapsulation options' /> + <param name='udp' doc='NS over UDP Encapsulation' /> + <param name='local-port' doc='Set the UDP port on which we listen for NS/UDP' /> + <param name='<0-65535>' doc='UDP port number' /> + </params> + </command> + <command id='encapsulation udp dscp <0-255>'> + <params> + <param name='encapsulation' doc='NS encapsulation options' /> + <param name='udp' doc='NS over UDP Encapsulation' /> + <param name='dscp' doc='Set DSCP/TOS on the UDP socket' /> + <param name='<0-255>' doc='DSCP Value' /> + </params> + </command> + <command id='encapsulation framerelay-gre enabled (1|0)'> + <params> + <param name='encapsulation' doc='NS encapsulation options' /> + <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> + <param name='enabled' doc='Enable or disable Frame Relay over GRE' /> + <param name='1' doc='Enable' /> + <param name='0' doc='Disable' /> + </params> + </command> + <command id='encapsulation framerelay-gre local-ip A.B.C.D'> + <params> + <param name='encapsulation' doc='NS encapsulation options' /> + <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> + <param name='local-ip' doc='Set the IP address on which we listen for NS/FR/GRE' /> + <param name='A.B.C.D' doc='IP Address' /> + </params> + </command> + </node> + <node id='config-gbproxy'> + <name>config-gbproxy</name> + <command id='sgsn nsei <0-65534>'> + <params> + <param name='sgsn' doc='SGSN information' /> + <param name='nsei' doc='NSEI to be used in the connection with the SGSN' /> + <param name='<0-65534>' doc='The NSEI' /> + </params> + </command> + <command id='core-mobile-country-code <1-999>'> + <params> + <param name='core-mobile-country-code' doc='Use this country code for the core network' /> + <param name='<1-999>' doc='MCC value' /> + </params> + </command> + <command id='core-mobile-network-code <1-999>'> + <params> + <param name='core-mobile-network-code' doc='Use this network code for the core network' /> + <param name='<1-999>' doc='NCC value' /> + </params> + </command> + <command id='match-imsi (patching|routing) .REGEXP'> + <params> + <param name='match-imsi' doc='Restrict actions to certain IMSIs' /> + <param name='patching' doc='Patch MS related information elements on match only' /> + <param name='routing' doc='Route to the secondary SGSN on match only' /> + <param name='.REGEXP' doc='Regular expression for the IMSI match' /> + </params> + </command> + <command id='core-access-point-name (APN|none)'> + <params> + <param name='core-access-point-name' doc='Use this access point name (APN) for the backbone' /> + <param name='APN' doc='Replace APN by this string' /> + <param name='none' doc='Remove APN' /> + </params> + </command> + <command id='secondary-sgsn nsei <0-65534>'> + <params> + <param name='secondary-sgsn' doc='Route matching LLC connections to a second SGSN (Experimental)' /> + <param name='nsei' doc='NSEI to be used in the connection with the SGSN' /> + <param name='<0-65534>' doc='The NSEI' /> + </params> + </command> + <command id='patch-ptmsi'> + <params> + <param name='patch-ptmsi' doc='Patch P-TMSI/TLLI' /> + </params> + </command> + <command id='acquire-imsi'> + <params> + <param name='acquire-imsi' doc='Acquire the IMSI before establishing a LLC connection (Experimental)' /> + </params> + </command> + <command id='link-list clean-stale-timer <1-999999>'> + <params> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='clean-stale-timer' doc='Periodic timer to clean stale links' /> + <param name='<1-999999>' doc='Frequency at which the periodic timer is fired (in seconds)' /> + </params> + </command> + <command id='link-list max-age <1-999999>'> + <params> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='max-age' doc='Limit maximum age' /> + <param name='<1-999999>' doc='Maximum age in seconds' /> + </params> + </command> + <command id='link-list max-length <1-99999>'> + <params> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='max-length' doc='Limit list length' /> + <param name='<1-99999>' doc='Maximum number of logical links in the list' /> + </params> + </command> + <command id='link-list keep-mode (never|re-attach|identified|always)'> + <params> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='keep-mode' doc='How to keep entries for detached logical links' /> + <param name='never' doc='Discard entry immediately after detachment' /> + <param name='re-attach' doc='Keep entry if a re-attachment has be requested' /> + <param name='identified' doc='Keep entry if it associated with an IMSI' /> + <param name='always' doc='Don't discard entries after detachment' /> + </params> + </command> + <command id='link stored-msgs-max-length <1-99999>'> + <params> + <param name='link' doc='Set TLLI parameters' /> + <param name='stored-msgs-max-length' doc='Limit list length' /> + <param name='<1-99999>' doc='Maximum number of msgb stored in the logical link waiting to acquire its IMSI' /> + </params> + </command> + <command id='no core-mobile-country-code'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='core-mobile-country-code' doc='Use this country code for the core network' /> + </params> + </command> + <command id='no core-mobile-network-code'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='core-mobile-network-code' doc='Use this network code for the core network' /> + </params> + </command> + <command id='no match-imsi'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='match-imsi' doc='Restrict actions to certain IMSIs' /> + </params> + </command> + <command id='no core-access-point-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='core-access-point-name' doc='Use this access point name (APN) for the backbone' /> + </params> + </command> + <command id='no secondary-sgsn'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='secondary-sgsn' doc='Route matching LLC connections to a second SGSN (Experimental)' /> + </params> + </command> + <command id='no patch-ptmsi'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='patch-ptmsi' doc='Patch P-TMSI/TLLI' /> + </params> + </command> + <command id='no acquire-imsi'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='acquire-imsi' doc='Acquire the IMSI before establishing a LLC connection (Experimental)' /> + </params> + </command> + <command id='no link-list clean-stale-timer'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='clean-stale-timer' doc='Periodic timer to clean stale links' /> + </params> + </command> + <command id='no link-list max-age'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='max-age' doc='Limit maximum age' /> + </params> + </command> + <command id='no link-list max-length'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='link-list' doc='Set TLLI list parameters' /> + <param name='max-length' doc='Limit list length' /> + </params> + </command> + <command id='no link stored-msgs-max-length'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='link' doc='Set TLLI parameters' /> + <param name='stored-msgs-max-length' doc='Limit list length' /> + </params> + </command> + </node> +</vtydoc> |