diff options
author | Vadim Yanitskiy <vyanitskiy@sysmocom.de> | 2020-10-26 01:24:58 +0700 |
---|---|---|
committer | Vadim Yanitskiy <vyanitskiy@sysmocom.de> | 2020-11-05 03:39:50 +0700 |
commit | a75b402f55bc9d951f897600c1314a3613e73679 (patch) | |
tree | df609ce0416b45d8f654ae486187a89ff3bed6f4 | |
parent | ef1671c6ed3362958b95a7074c8d2242b756c6cf (diff) |
doc/manuals: generate XML VTY reference at build-time
Unfortunately, we cannot re-use the existing Makefile rules from:
$(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
because they do not allow to generate the list of $(DOCBOOKS) from
a template, and require the project to store everything in separate
folders with specific names. Also, those rules expect that the
target PDFs contain only a single word in their names (for example,
'osmoapp-vty-reference', not 'osmo-app-vty-reference'), while in a
project with multiple similarly named targets this would reduce
readability (imagine 'osmotrxuhd-vty-reference').
Change-Id: Idba84164b90e3d183a20b5eb69cbfe15745e447c
Depends: I6aac73d998c5937894233631e654a160d5623198
Related: SYS#4937, SYS#4910, OS#3036
-rw-r--r-- | .gitignore | 3 | ||||
-rw-r--r-- | doc/manuals/Makefile.am | 27 | ||||
-rw-r--r-- | doc/manuals/osmobts-vty-reference.xml | 11 | ||||
-rw-r--r-- | doc/manuals/vty/Makefile.vty-reference.inc | 37 | ||||
-rw-r--r-- | doc/manuals/vty/bts_vty_reference.xml | 2018 |
5 files changed, 74 insertions, 2022 deletions
@@ -94,6 +94,9 @@ doc/manuals/*.pdf doc/manuals/*__*.png doc/manuals/*.check doc/manuals/generated/ +doc/manuals/vty/osmobts-*-vty-reference.xml +doc/manuals/vty/osmobts-*-vty-reference.xml.inc.gen +doc/manuals/vty/osmobts-*-vty-reference.xml.inc.merged doc/manuals/osmomsc-usermanual.xml doc/manuals/common doc/manuals/build diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am index e8018d57..2fd21e6b 100644 --- a/doc/manuals/Makefile.am +++ b/doc/manuals/Makefile.am @@ -18,8 +18,31 @@ if BUILD_MANUALS osmobts-abis.pdf: $(srcdir)/abis/*.adoc $(srcdir)/abis/*.msc rtp-amr.pdf: $(srcdir)/dtx.dot - VTY_REFERENCE = osmobts-vty-reference.xml - include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc + VARIANTS = $(NULL) + +if ENABLE_SYSMOBTS + VARIANTS += sysmo +endif + +if ENABLE_TRX + VARIANTS += trx +endif + +if ENABLE_OCTPHY + VARIANTS += octphy +endif + +if ENABLE_LC15BTS + VARIANTS += lc15 +endif + +if ENABLE_OC2GBTS + VARIANTS += oc2g +endif + + # This is a significantly modified, multi-target adopted copy of + # $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc + include $(srcdir)/vty/Makefile.vty-reference.inc OSMO_REPOSITORY = osmo-bts include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc diff --git a/doc/manuals/osmobts-vty-reference.xml b/doc/manuals/osmobts-vty-reference.xml index b7c8a596..a38eb059 100644 --- a/doc/manuals/osmobts-vty-reference.xml +++ b/doc/manuals/osmobts-vty-reference.xml @@ -6,7 +6,7 @@ <!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_vty.xml" > +<!ENTITY sections-vty SYSTEM "@@GENERATED@@" > ]> <book> @@ -18,12 +18,19 @@ <authorinitials>hw</authorinitials> <revremark>Initial</revremark> </revision> + <revision> + <revnumber>v2</revnumber> + <date>@@REV_DATE@@</date> + <authorinitials>s.f.m.c.</authorinitials> + <revremark>Automatic build (@@REV_NUMBER@@)</revremark> + </revision> </revhistory> <title>OsmoBTS VTY Reference</title> + <subtitle>@@VARIANT@@</subtitle> <copyright> - <year>2016</year> + <year>@@CR_YEAR@@</year> </copyright> <legalnotice> diff --git a/doc/manuals/vty/Makefile.vty-reference.inc b/doc/manuals/vty/Makefile.vty-reference.inc new file mode 100644 index 00000000..f27506bd --- /dev/null +++ b/doc/manuals/vty/Makefile.vty-reference.inc @@ -0,0 +1,37 @@ +DOCBOOKS = $(foreach v,$(VARIANTS),vty/osmobts-$(v)-vty-reference.xml) +DOCBOOKS_DEPS = $(DOCBOOKS) $(addsuffix .inc,$(DOCBOOKS)) +INC_DIR = $(abspath $(builddir)/vty) + +include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.docbook.inc + +CLEAN_FILES += $(DOCBOOKS_DEPS) +CLEAN_FILES += $(addsuffix .inc.gen,$(DOCBOOKS)) +CLEAN_FILES += $(addsuffix .inc.merged,$(DOCBOOKS)) + +$(INC_DIR): + mkdir -p $@ + +vty/osmobts-%-vty-reference.xml: $(top_srcdir)/src/osmo-bts-% $(INC_DIR) + sed -e "s|@@GENERATED@@|$@.inc|" \ + -e "s|@@VARIANT@@|$(notdir $<)|" \ + -e "s|@@REV_NUMBER@@|$(VERSION)|" \ + -e "s|@@REV_DATE@@|$(shell date +"%dth %B %Y")|" \ + -e "s|@@CR_YEAR@@|$(shell date +"%Y")|" \ + $(srcdir)/osmobts-vty-reference.xml > $@ + +vty/osmobts-%-vty-reference.xml.inc: $(top_builddir)/src/osmo-bts-*/osmo-bts-% \ + $(OSMO_GSM_MANUALS_DIR)/common/vty_additions.xml \ + $(OSMO_GSM_MANUALS_DIR)/common/chapters/vty.xml \ + $(OSMO_GSM_MANUALS_DIR)/vty_reference.xsl \ + $(srcdir)/vty/*.xml $(INC_DIR) + # a) Invoke osmo-bts-% to generate the list of commands first + $< --vty-ref-mode default --vty-ref-xml > "$@.gen" + # ... filter garbage potentially printed by libraries to stdout + sed -i '/^<vtydoc/,$$!d' "$@.gen" + # b) Merge the result of a) with global and local additions + $(OSMO_GSM_MANUALS_DIR)/build/vty_reference_combine.sh \ + $(realpath $(OSMO_GSM_MANUALS_DIR)/merge_doc.xsl) "$@.gen" \ + $(OSMO_GSM_MANUALS_DIR)/common/vty_additions.xml \ + $(srcdir)/vty/*additions*.xml > "$@.merged" + # c) Convert the result of b) into a valid docbook + xsltproc $(OSMO_GSM_MANUALS_DIR)/vty_reference.xsl "$@.merged" > $@ diff --git a/doc/manuals/vty/bts_vty_reference.xml b/doc/manuals/vty/bts_vty_reference.xml deleted file mode 100644 index a4c4be6d..00000000 --- a/doc/manuals/vty/bts_vty_reference.xml +++ /dev/null @@ -1,2018 +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='show e1_driver'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_driver' doc='Display information about available E1 drivers' /> - </params> - </command> - <command id='show e1_line [line_nr] [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_line' doc='Display information about a E1 line' /> - <param name='[line_nr]' doc='E1 Line Number' /> - <param name='[stats]' doc='Include statistics' /> - </params> - </command> - <command id='show e1_timeslot [line_nr] [ts_nr]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_timeslot' doc='Display information about a E1 timeslot' /> - <param name='[line_nr]' doc='E1 Line Number' /> - <param name='[ts_nr]' doc='E1 Timeslot Number' /> - </params> - </command> - <command id='show bts <0-255>'> - <params> - <param name='show' doc='Show running system information' /> - <param name='bts' doc='Display information about a BTS' /> - <param name='<0-255>' doc='BTS Number' /> - </params> - </command> - <command id='show trx [<0-255>] [<0-255>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='trx' doc='Display information about a TRX' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - </params> - </command> - <command id='show timeslot [<0-255>] [<0-255>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='timeslot' doc='Display information about a TS' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - </params> - </command> - <command id='show lchan [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='lchan' doc='Display information about a logical channel' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - <param name='[<0-7>]' doc='Logical Channel Number' /> - </params> - </command> - <command id='show lchan summary [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='lchan' doc='Display information about a logical channel' /> - <param name='summary' doc='Short summary' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - <param name='[<0-7>]' doc='Logical Channel Number' /> - </params> - </command> - <command id='logging filter l1-sapi (unknown|agch|bcch|cbch|facch/f|facch/h|fcch|idle|nch|pacch|pagch|pbcch|pch|pdtch|pnch|ppch|prach|ptcch|rach|sacch|sch|sdcch|tch/f|tch/h)'> - <params> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='l1-sapi' doc='L1 SAPI' /> - <param name='unknown' doc='UNKNOWN' /> - <param name='agch' doc='AGCH' /> - <param name='bcch' doc='BCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='facch/f' doc='FACCH/F' /> - <param name='facch/h' doc='FACCH/H' /> - <param name='fcch' doc='FCCH' /> - <param name='idle' doc='IDLE' /> - <param name='nch' doc='NCH' /> - <param name='pacch' doc='PACCH' /> - <param name='pagch' doc='PAGCH' /> - <param name='pbcch' doc='PBCCH' /> - <param name='pch' doc='PCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='pnch' doc='PNCH' /> - <param name='ppch' doc='PPCH' /> - <param name='prach' doc='PRACH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='rach' doc='RACH' /> - <param name='sacch' doc='SACCH' /> - <param name='sch' doc='SCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - </params> - </command> - <command id='no logging filter l1-sapi (unknown|agch|bcch|cbch|facch/f|facch/h|fcch|idle|nch|pacch|pagch|pbcch|pch|pdtch|pnch|ppch|prach|ptcch|rach|sacch|sch|sdcch|tch/f|tch/h)'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='l1-sapi' doc='L1 SAPI' /> - <param name='unknown' doc='UNKNOWN' /> - <param name='agch' doc='AGCH' /> - <param name='bcch' doc='BCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='facch/f' doc='FACCH/F' /> - <param name='facch/h' doc='FACCH/H' /> - <param name='fcch' doc='FCCH' /> - <param name='idle' doc='IDLE' /> - <param name='nch' doc='NCH' /> - <param name='pacch' doc='PACCH' /> - <param name='pagch' doc='PAGCH' /> - <param name='pbcch' doc='PBCCH' /> - <param name='pch' doc='PCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='pnch' doc='PNCH' /> - <param name='ppch' doc='PPCH' /> - <param name='prach' doc='PRACH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='rach' doc='RACH' /> - <param name='sacch' doc='SACCH' /> - <param name='sch' doc='SCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - </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 (rsl|oml|rll|rr|meas|pag|l1c|l1p|dsp|pcu|ho|trx|loop|abis|rtp|sum|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='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> - <param name='oml' doc='A-bis Network Management / O&M (NM/OML)' /> - <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> - <param name='rr' doc='Layer3 Radio Resource (RR)' /> - <param name='meas' doc='Radio Measurement Processing' /> - <param name='pag' doc='Paging Subsystem' /> - <param name='l1c' doc='Layer 1 Control (MPH)' /> - <param name='l1p' doc='Layer 1 Primitives (PH)' /> - <param name='dsp' doc='DSP Trace Messages' /> - <param name='pcu' doc='PCU interface' /> - <param name='ho' doc='Handover' /> - <param name='trx' doc='TRX interface' /> - <param name='loop' doc='Control loops' /> - <param name='abis' doc='A-bis Intput Subsystem' /> - <param name='rtp' doc='Realtime Transfer Protocol' /> - <param name='sum' doc='DSUM' /> - <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 (rsl|oml|rll|rr|meas|pag|l1c|l1p|dsp|pcu|ho|trx|loop|abis|rtp|sum|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='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> - <param name='oml' doc='A-bis Network Management / O&M (NM/OML)' /> - <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> - <param name='rr' doc='Layer3 Radio Resource (RR)' /> - <param name='meas' doc='Radio Measurement Processing' /> - <param name='pag' doc='Paging Subsystem' /> - <param name='l1c' doc='Layer 1 Control (MPH)' /> - <param name='l1p' doc='Layer 1 Primitives (PH)' /> - <param name='dsp' doc='DSP Trace Messages' /> - <param name='pcu' doc='PCU interface' /> - <param name='ho' doc='Handover' /> - <param name='trx' doc='TRX interface' /> - <param name='loop' doc='Control loops' /> - <param name='abis' doc='A-bis Intput Subsystem' /> - <param name='rtp' doc='Realtime Transfer Protocol' /> - <param name='sum' doc='DSUM' /> - <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> - </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='show e1_driver'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_driver' doc='Display information about available E1 drivers' /> - </params> - </command> - <command id='show e1_line [line_nr] [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_line' doc='Display information about a E1 line' /> - <param name='[line_nr]' doc='E1 Line Number' /> - <param name='[stats]' doc='Include statistics' /> - </params> - </command> - <command id='show e1_timeslot [line_nr] [ts_nr]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='e1_timeslot' doc='Display information about a E1 timeslot' /> - <param name='[line_nr]' doc='E1 Line Number' /> - <param name='[ts_nr]' doc='E1 Timeslot Number' /> - </params> - </command> - <command id='show bts <0-255>'> - <params> - <param name='show' doc='Show running system information' /> - <param name='bts' doc='Display information about a BTS' /> - <param name='<0-255>' doc='BTS Number' /> - </params> - </command> - <command id='show trx [<0-255>] [<0-255>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='trx' doc='Display information about a TRX' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - </params> - </command> - <command id='show timeslot [<0-255>] [<0-255>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='timeslot' doc='Display information about a TS' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - </params> - </command> - <command id='show lchan [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='lchan' doc='Display information about a logical channel' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - <param name='[<0-7>]' doc='Logical Channel Number' /> - </params> - </command> - <command id='show lchan summary [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='lchan' doc='Display information about a logical channel' /> - <param name='summary' doc='Short summary' /> - <param name='[<0-255>]' doc='BTS Number' /> - <param name='[<0-255>]' doc='TRX Number' /> - <param name='[<0-7>]' doc='Timeslot Number' /> - <param name='[<0-7>]' doc='Logical Channel Number' /> - </params> - </command> - <command id='logging filter l1-sapi (unknown|agch|bcch|cbch|facch/f|facch/h|fcch|idle|nch|pacch|pagch|pbcch|pch|pdtch|pnch|ppch|prach|ptcch|rach|sacch|sch|sdcch|tch/f|tch/h)'> - <params> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='l1-sapi' doc='L1 SAPI' /> - <param name='unknown' doc='UNKNOWN' /> - <param name='agch' doc='AGCH' /> - <param name='bcch' doc='BCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='facch/f' doc='FACCH/F' /> - <param name='facch/h' doc='FACCH/H' /> - <param name='fcch' doc='FCCH' /> - <param name='idle' doc='IDLE' /> - <param name='nch' doc='NCH' /> - <param name='pacch' doc='PACCH' /> - <param name='pagch' doc='PAGCH' /> - <param name='pbcch' doc='PBCCH' /> - <param name='pch' doc='PCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='pnch' doc='PNCH' /> - <param name='ppch' doc='PPCH' /> - <param name='prach' doc='PRACH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='rach' doc='RACH' /> - <param name='sacch' doc='SACCH' /> - <param name='sch' doc='SCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - </params> - </command> - <command id='no logging filter l1-sapi (unknown|agch|bcch|cbch|facch/f|facch/h|fcch|idle|nch|pacch|pagch|pbcch|pch|pdtch|pnch|ppch|prach|ptcch|rach|sacch|sch|sdcch|tch/f|tch/h)'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='l1-sapi' doc='L1 SAPI' /> - <param name='unknown' doc='UNKNOWN' /> - <param name='agch' doc='AGCH' /> - <param name='bcch' doc='BCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='facch/f' doc='FACCH/F' /> - <param name='facch/h' doc='FACCH/H' /> - <param name='fcch' doc='FCCH' /> - <param name='idle' doc='IDLE' /> - <param name='nch' doc='NCH' /> - <param name='pacch' doc='PACCH' /> - <param name='pagch' doc='PAGCH' /> - <param name='pbcch' doc='PBCCH' /> - <param name='pch' doc='PCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='pnch' doc='PNCH' /> - <param name='ppch' doc='PPCH' /> - <param name='prach' doc='PRACH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='rach' doc='RACH' /> - <param name='sacch' doc='SACCH' /> - <param name='sch' doc='SCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - </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 (rsl|oml|rll|rr|meas|pag|l1c|l1p|dsp|pcu|ho|trx|loop|abis|rtp|sum|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='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> - <param name='oml' doc='A-bis Network Management / O&M (NM/OML)' /> - <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> - <param name='rr' doc='Layer3 Radio Resource (RR)' /> - <param name='meas' doc='Radio Measurement Processing' /> - <param name='pag' doc='Paging Subsystem' /> - <param name='l1c' doc='Layer 1 Control (MPH)' /> - <param name='l1p' doc='Layer 1 Primitives (PH)' /> - <param name='dsp' doc='DSP Trace Messages' /> - <param name='pcu' doc='PCU interface' /> - <param name='ho' doc='Handover' /> - <param name='trx' doc='TRX interface' /> - <param name='loop' doc='Control loops' /> - <param name='abis' doc='A-bis Intput Subsystem' /> - <param name='rtp' doc='Realtime Transfer Protocol' /> - <param name='sum' doc='DSUM' /> - <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 (rsl|oml|rll|rr|meas|pag|l1c|l1p|dsp|pcu|ho|trx|loop|abis|rtp|sum|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='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> - <param name='oml' doc='A-bis Network Management / O&M (NM/OML)' /> - <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> - <param name='rr' doc='Layer3 Radio Resource (RR)' /> - <param name='meas' doc='Radio Measurement Processing' /> - <param name='pag' doc='Paging Subsystem' /> - <param name='l1c' doc='Layer 1 Control (MPH)' /> - <param name='l1p' doc='Layer 1 Primitives (PH)' /> - <param name='dsp' doc='DSP Trace Messages' /> - <param name='pcu' doc='PCU interface' /> - <param name='ho' doc='Handover' /> - <param name='trx' doc='TRX interface' /> - <param name='loop' doc='Control loops' /> - <param name='abis' doc='A-bis Intput Subsystem' /> - <param name='rtp' doc='Realtime Transfer Protocol' /> - <param name='sum' doc='DSUM' /> - <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='bts <0-0> trx <0-0> ts <0-7> lchan <0-1> rtp jitter-buffer <0-10000>'> - <params> - <param name='bts' doc='BTS related commands' /> - <param name='<0-0>' doc='BTS number' /> - <param name='trx' doc='TRX related commands' /> - <param name='<0-0>' doc='TRX number' /> - <param name='ts' doc='timeslot related commands' /> - <param name='<0-7>' doc='timeslot number' /> - <param name='lchan' doc='logical channel commands' /> - <param name='<0-1>' doc='logical channel number' /> - <param name='rtp' doc='RTP settings' /> - <param name='jitter-buffer' doc='Jitter buffer' /> - <param name='<0-10000>' doc='Size of jitter buffer in (ms)' /> - </params> - </command> - <command id='bts <0-0> trx <0-0> ts <0-7> lchan <0-1> loopback'> - <params> - <param name='bts' doc='BTS related commands' /> - <param name='<0-0>' doc='BTS number' /> - <param name='trx' doc='TRX related commands' /> - <param name='<0-0>' doc='TRX number' /> - <param name='ts' doc='timeslot related commands' /> - <param name='<0-7>' doc='timeslot number' /> - <param name='lchan' doc='logical channel commands' /> - <param name='<0-1>' doc='logical channel number' /> - <param name='loopback' doc='Set loopback' /> - </params> - </command> - <command id='no bts <0-0> trx <0-0> ts <0-7> lchan <0-1> loopback'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='bts' doc='BTS related commands' /> - <param name='<0-0>' doc='BTS number' /> - <param name='trx' doc='TRX related commands' /> - <param name='<0-0>' doc='TRX number' /> - <param name='ts' doc='timeslot related commands' /> - <param name='<0-7>' doc='timeslot number' /> - <param name='lchan' doc='logical channel commands' /> - <param name='<0-1>' doc='logical channel number' /> - <param name='loopback' doc='Set loopback' /> - </params> - </command> - <command id='test send-failure-event-report <0-255>'> - <params> - <param name='test' doc='Various testing commands' /> - <param name='send-failure-event-report' doc='Send a test OML failure event report to the BSC' /> - <param name='<0-255>' doc='BTS Number' /> - </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='ctrl'> - <params> - <param name='ctrl' doc='Configure the Control Interface' /> - </params> - </command> - <command id='e1_input'> - <params> - <param name='e1_input' doc='Configure E1/T1/J1 TDM input' /> - </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='bts BTS_NR'> - <params> - <param name='bts' doc='Select a BTS to configure' /> - <param name='BTS_NR' doc='BTS Number' /> - </params> - </command> - <command id='vty telnet-port <0-65535>'> - <params> - <param name='vty' doc='Configure the VTY' /> - <param name='telnet-port' doc='Set the VTY telnet port' /> - <param name='<0-65535>' doc='TCP Port number' /> - </params> - </command> - <command id='phy <0-255>'> - <params> - <param name='phy' doc='Select a PHY to configure' /> - <param name='<0-255>' doc='PHY number' /> - </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 (rsl|oml|rll|rr|meas|pag|l1c|l1p|dsp|pcu|ho|trx|loop|abis|rtp|sum|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='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> - <param name='oml' doc='A-bis Network Management / O&M (NM/OML)' /> - <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> - <param name='rr' doc='Layer3 Radio Resource (RR)' /> - <param name='meas' doc='Radio Measurement Processing' /> - <param name='pag' doc='Paging Subsystem' /> - <param name='l1c' doc='Layer 1 Control (MPH)' /> - <param name='l1p' doc='Layer 1 Primitives (PH)' /> - <param name='dsp' doc='DSP Trace Messages' /> - <param name='pcu' doc='PCU interface' /> - <param name='ho' doc='Handover' /> - <param name='trx' doc='TRX interface' /> - <param name='loop' doc='Control loops' /> - <param name='abis' doc='A-bis Intput Subsystem' /> - <param name='rtp' doc='Realtime Transfer Protocol' /> - <param name='sum' doc='DSUM' /> - <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-e1_input'> - <name>config-e1_input</name> - <command id='pcap .FILE'> - <params> - <param name='pcap' doc='Setup a pcap recording of all E1 traffic' /> - <param name='.FILE' doc='Filename to save the packets to' /> - </params> - </command> - <command id='no pcap'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='pcap' doc='Disable pcap recording of all E1 traffic' /> - </params> - </command> - <command id='e1_line <0-255> driver (misdn|misdn_lapd|dahdi|e1d|ipa|unixsocket)'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='driver' doc='Set driver for this line' /> - <param name='misdn' doc='mISDN supported E1 Card (kernel LAPD)' /> - <param name='misdn_lapd' doc='mISDN supported E1 Card (userspace LAPD)' /> - <param name='dahdi' doc='DAHDI supported E1/T1/J1 Card' /> - <param name='e1d' doc='IPA TCP/IP input' /> - <param name='ipa' doc='HSL TCP/IP input' /> - <param name='unixsocket' doc='Unix socket input' /> - </params> - </command> - <command id='e1_line <0-255> port <0-255>'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='port' doc='Set physical port/span/card number' /> - <param name='<0-255>' doc='E1/T1 Port/Span/Card number' /> - </params> - </command> - <command id='e1_line <0-255> socket .SOCKET'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='socket' doc='Set socket path for unixsocket' /> - <param name='.SOCKET' doc='socket path' /> - </params> - </command> - <command id='e1_line <0-255> name .LINE'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='name' doc='Set name for this line' /> - <param name='.LINE' doc='Human readable name' /> - </params> - </command> - <command id='e1_line <0-255> keepalive'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='keepalive' doc='Enable keep-alive probing' /> - </params> - </command> - <command id='e1_line <0-255> keepalive <1-300> <1-20> <1-300>'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='keepalive' doc='Enable keep-alive probing' /> - <param name='<1-300>' doc='Idle interval in seconds before probes are sent' /> - <param name='<1-20>' doc='Number of probes to sent' /> - <param name='<1-300>' doc='Delay between probe packets in seconds' /> - </params> - </command> - <command id='no e1_line <0-255> keepalive'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='keepalive' doc='Enable keep-alive probing' /> - </params> - </command> - <command id='e1_line <0-255> ipa-keepalive <1-300> <1-300>'> - <params> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' /> - <param name='<1-300>' doc='Idle interval in seconds before probes are sent' /> - <param name='<1-300>' doc='Time to wait for PONG response' /> - </params> - </command> - <command id='no e1_line <0-255> ipa-keepalive'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='e1_line' doc='Configure E1/T1/J1 Line' /> - <param name='<0-255>' doc='Line Number' /> - <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' /> - </params> - </command> - <command id='ipa bind A.B.C.D'> - <params> - <param name='ipa' doc='ipa driver config' /> - <param name='bind' doc='Set ipa local bind address' /> - <param name='A.B.C.D' doc='Listen on this IP address (default 0.0.0.0)' /> - </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='phy'> - <name>phy</name> - <command id='instance <0-255>'> - <params> - <param name='instance' doc='Select a PHY instance to configure' /> - <param name='<0-255>' doc='PHY Instance number' /> - </params> - </command> - <command id='no instance <0-255>'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='instance' doc='Select a PHY instance to remove' /> - <param name='<0-255>' doc='PHY Instance number' /> - </params> - </command> - <command id='virtual-um ms-multicast-group GROUP'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='ms-multicast-group' doc='Configure the MS multicast group' /> - <param name='GROUP' doc='(null)' /> - </params> - </command> - <command id='virtual-um ms-udp-port <0-65535>'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='ms-udp-port' doc='Configure the MS UDP port' /> - <param name='<0-65535>' doc='(null)' /> - </params> - </command> - <command id='virtual-um bts-multicast-group GROUP'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='bts-multicast-group' doc='Configure the BTS multicast group' /> - <param name='GROUP' doc='(null)' /> - </params> - </command> - <command id='virtual-um bts-udp-port <0-65535>'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='bts-udp-port' doc='Configure the BTS UDP port' /> - <param name='<0-65535>' doc='(null)' /> - </params> - </command> - <command id='virtual-um net-device NETDEV'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='net-device' doc='Configure the network device' /> - <param name='NETDEV' doc='(null)' /> - </params> - </command> - <command id='virtual-um ttl <0-255>'> - <params> - <param name='virtual-um' doc='Virtual Um layer' /> - <param name='ttl' doc='Configure the TTL for transmitted multicast GSMTAP packets' /> - <param name='<0-255>' doc='(null)' /> - </params> - </command> - </node> - <node id='phy-inst'> - <name>phy-inst</name> - </node> - <node id='bts'> - <name>bts</name> - <command id='ipa unit-id <0-65534> <0-255>'> - <params> - <param name='ipa' doc='ip.access RSL commands' /> - <param name='unit-id' doc='Set the Unit ID of this BTS' /> - <param name='<0-65534>' doc='Site ID' /> - <param name='<0-255>' doc='Unit ID' /> - </params> - </command> - <command id='oml remote-ip A.B.C.D'> - <params> - <param name='oml' doc='OML Parameters' /> - <param name='remote-ip' doc='OML IP Address' /> - <param name='A.B.C.D' doc='OML IP Address' /> - </params> - </command> - <command id='rtp jitter-buffer <0-10000> [adaptive]'> - <params> - <param name='rtp' doc='RTP parameters' /> - <param name='jitter-buffer' doc='RTP jitter buffer' /> - <param name='<0-10000>' doc='jitter buffer in ms' /> - <param name='[adaptive]' doc='(null)' /> - </params> - </command> - <command id='rtp port-range <1-65534> <1-65534>'> - <params> - <param name='rtp' doc='RTP parameters' /> - <param name='port-range' doc='Range of local ports to use for RTP/RTCP traffic' /> - <param name='<1-65534>' doc='(null)' /> - <param name='<1-65534>' doc='(null)' /> - </params> - </command> - <command id='rtp ip-dscp <0-63>'> - <params> - <param name='rtp' doc='RTP parameters' /> - <param name='ip-dscp' doc='Specify DSCP for RTP/IP packets' /> - <param name='<0-63>' doc='The DSCP value (upper 6 bits of TOS)' /> - </params> - </command> - <command id='band (450|GSM450|480|GSM480|750|GSM750|810|GSM810|850|GSM850|900|GSM900|1800|DCS1800|1900|PCS1900)'> - <params> - <param name='band' doc='Set the frequency band of this BTS' /> - <param name='450' doc='Alias for GSM450' /> - <param name='GSM450' doc='450Mhz' /> - <param name='480' doc='Alias for GSM480' /> - <param name='GSM480' doc='480Mhz' /> - <param name='750' doc='Alias for GSM750' /> - <param name='GSM750' doc='750Mhz' /> - <param name='810' doc='Alias for GSM810' /> - <param name='GSM810' doc='810Mhz' /> - <param name='850' doc='Alias for GSM850' /> - <param name='GSM850' doc='850Mhz' /> - <param name='900' doc='Alias for GSM900' /> - <param name='GSM900' doc='900Mhz' /> - <param name='1800' doc='Alias for DCS1800' /> - <param name='DCS1800' doc='1800Mhz' /> - <param name='1900' doc='Alias for PCS1900' /> - <param name='PCS1900' doc='1900Mhz' /> - </params> - </command> - <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='paging queue-size <1-1024>'> - <params> - <param name='paging' doc='Paging related parameters' /> - <param name='queue-size' doc='Maximum length of BTS-internal paging queue' /> - <param name='<1-1024>' doc='Maximum length of BTS-internal paging queue' /> - </params> - </command> - <command id='paging lifetime <0-60>'> - <params> - <param name='paging' doc='Paging related parameters' /> - <param name='lifetime' doc='Maximum lifetime of a paging record' /> - <param name='<0-60>' doc='Maximum lifetime of a paging record (secods)' /> - </params> - </command> - <command id='agch-queue-mgmt default'> - <params> - <param name='agch-queue-mgmt' doc='AGCH queue mgmt' /> - <param name='default' doc='Reset clean parameters to default values' /> - </params> - </command> - <command id='agch-queue-mgmt threshold <0-100> low <0-100> high <0-100000>'> - <params> - <param name='agch-queue-mgmt' doc='AGCH queue mgmt' /> - <param name='threshold' doc='Threshold to start cleanup' /> - <param name='<0-100>' doc='in %% of the maximum queue length' /> - <param name='low' doc='Low water mark for cleanup' /> - <param name='<0-100>' doc='in %% of the maximum queue length' /> - <param name='high' doc='High water mark for cleanup' /> - <param name='<0-100000>' doc='in %% of the maximum queue length' /> - </params> - </command> - <command id='uplink-power-target <-110-0>'> - <params> - <param name='uplink-power-target' doc='Set the nominal target Rx Level for uplink power control loop' /> - <param name='<-110-0>' doc='Target uplink Rx level in dBm' /> - </params> - </command> - <command id='min-qual-rach <-100-100>'> - <params> - <param name='min-qual-rach' doc='Set the minimum link quality level of Access Bursts to be accepted' /> - <param name='<-100-100>' doc='C/I (Carrier-to-Interference) ratio in centiBels (10e-2 B or 10e-1 dB)' /> - </params> - </command> - <command id='min-qual-norm <-100-100>'> - <params> - <param name='min-qual-norm' doc='Set the minimum link quality level of Normal Bursts to be accepted' /> - <param name='<-100-100>' doc='C/I (Carrier-to-Interference) ratio in centiBels (10e-2 B or 10e-1 dB)' /> - </params> - </command> - <command id='max-ber10k-rach <0-10000>'> - <params> - <param name='max-ber10k-rach' doc='Set the maximum BER for valid RACH requests' /> - <param name='<0-10000>' doc='BER in 1/10000 units (0=no BER; 100=1% BER)' /> - </params> - </command> - <command id='pcu-socket PATH'> - <params> - <param name='pcu-socket' doc='Configure the PCU socket file/path name' /> - <param name='PATH' doc='(null)' /> - </params> - </command> - <command id='supp-meas-info toa256'> - <params> - <param name='supp-meas-info' doc='Configure the RSL Supplementary Measurement Info' /> - <param name='toa256' doc='Report the TOA in 1/256th symbol periods' /> - </params> - </command> - <command id='no supp-meas-info toa256'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='supp-meas-info' doc='Configure the RSL Supplementary Measurement Info' /> - <param name='toa256' doc='Report the TOA in 1/256th symbol periods' /> - </params> - </command> - <command id='smscb queue-max-length <1-60>'> - <params> - <param name='smscb' doc='Maximum queue length for SMSCB (CBCH) queue. In count of messages/pages (Default: 15)' /> - <param name='queue-max-length' doc='(null)' /> - <param name='<1-60>' doc='(null)' /> - </params> - </command> - <command id='smscb queue-target-length <1-30>'> - <params> - <param name='smscb' doc='Target queue length for SMSCB (CBCH) queue. In count of messages/pages (Default: 2)' /> - <param name='queue-target-length' doc='(null)' /> - <param name='<1-30>' doc='(null)' /> - </params> - </command> - <command id='smscb queue-hysteresis <0-30>'> - <params> - <param name='smscb' doc='Hysteresis for SMSCB (CBCH) queue. In count of messages/pages (Default: 2)' /> - <param name='queue-hysteresis' doc='(null)' /> - <param name='<0-30>' doc='(null)' /> - </params> - </command> - <command id='gsmtap-sapi (bcch|ccch|rach|agch|pch|sdcch|tch/f|tch/h|pacch|pdtch|ptcch|cbch|sacch)'> - <params> - <param name='gsmtap-sapi' doc='GSMTAP SAPI' /> - <param name='bcch' doc='BCCH' /> - <param name='ccch' doc='CCCH' /> - <param name='rach' doc='RACH' /> - <param name='agch' doc='AGCH' /> - <param name='pch' doc='PCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - <param name='pacch' doc='PACCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='sacch' doc='SACCH' /> - </params> - </command> - <command id='no gsmtap-sapi (bcch|ccch|rach|agch|pch|sdcch|tch/f|tch/h|pacch|pdtch|ptcch|cbch|sacch)'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='gsmtap-sapi' doc='GSMTAP SAPI' /> - <param name='bcch' doc='BCCH' /> - <param name='ccch' doc='CCCH' /> - <param name='rach' doc='RACH' /> - <param name='agch' doc='AGCH' /> - <param name='pch' doc='PCH' /> - <param name='sdcch' doc='SDCCH' /> - <param name='tch/f' doc='TCH/F' /> - <param name='tch/h' doc='TCH/H' /> - <param name='pacch' doc='PACCH' /> - <param name='pdtch' doc='PDTCH' /> - <param name='ptcch' doc='PTCCH' /> - <param name='cbch' doc='CBCH' /> - <param name='sacch' doc='SACCH' /> - </params> - </command> - <command id='trx <0-254>'> - <params> - <param name='trx' doc='Select a TRX to configure' /> - <param name='<0-254>' doc='TRX number' /> - </params> - </command> - </node> - <node id='trx'> - <name>trx</name> - <command id='user-gain <-100000-100000> (dB|mdB)'> - <params> - <param name='user-gain' doc='Inform BTS about additional, user-provided gain or attenuation at TRX output' /> - <param name='<-100000-100000>' doc='Value of user-provided external gain(+)/attenuation(-)' /> - <param name='dB' doc='Unit is dB (decibels)' /> - <param name='mdB' doc='Unit is mdB (milli-decibels, or rather 1/10000 bel)' /> - </params> - </command> - <command id='power-ramp max-initial <0-100000> (dBm|mdBm)'> - <params> - <param name='power-ramp' doc='Power-Ramp settingsMaximum initial power' /> - <param name='max-initial' doc='Value' /> - <param name='<0-100000>' doc='Unit is dB (decibels)' /> - <param name='dBm' doc='Unit is mdB (milli-decibels, or rather 1/10000 bel)' /> - <param name='mdBm' doc='(null)' /> - </params> - </command> - <command id='power-ramp step-size <1-100000> (dB|mdB)'> - <params> - <param name='power-ramp' doc='Power-Ramp settingsPower increase by step' /> - <param name='step-size' doc='Step size' /> - <param name='<1-100000>' doc='Unit is dB (decibels)' /> - <param name='dB' doc='Unit is mdB (milli-decibels, or rather 1/10000 bel)' /> - <param name='mdB' doc='(null)' /> - </params> - </command> - <command id='power-ramp step-interval <1-100>'> - <params> - <param name='power-ramp' doc='Power-Ramp settingsPower increase by step' /> - <param name='step-interval' doc='Step time in seconds' /> - <param name='<1-100>' doc='(null)' /> - </params> - </command> - <command id='ms-power-control (dsp|osmo)'> - <params> - <param name='ms-power-control' doc='Mobile Station Power Level Control (change requires restart)' /> - <param name='dsp' doc='Handled by DSP' /> - <param name='osmo' doc='Handled by OsmoBTS' /> - </params> - </command> - <command id='phy <0-255> instance <0-255>'> - <params> - <param name='phy' doc='Configure PHY Link+Instance for this TRX' /> - <param name='<0-255>' doc='PHY Link number' /> - <param name='instance' doc='PHY instance' /> - <param name='<0-255>' doc='PHY Instance number' /> - </params> - </command> - </node> -</vtydoc> |