paulmataruso/osmo-mgw
1
0
Fork 0
mirror of https://gitea.osmocom.org/cellular-infrastructure/osmo-mgw.git synced 2025-10-23 08:12:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

mgw: update vty reference

Browse Source 
Change-Id: Ib30ea8b02f8a950648b85e7ebc96a40ba5a36b34
This commit is contained in:
Neels Hofmeyr
2018-11-05 03:18:55 +01:00
parent da026abc27
commit c0a2196f91
1 changed files with 146 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
doc/manuals/vty/mgw_vty_reference.xml
View File

@@ -169,7 +169,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
<command id='logging print file (0|1|basename)'>
<command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -177,6 +177,7 @@
<param name='0' doc='Don&apos;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&apos;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'>
@@ -186,12 +187,12 @@
<param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, 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 (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
<command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (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='all' doc='Global setting for all subsystems' />
<param name='rtp' doc='RTP stream handling' />
<param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -210,7 +211,6 @@
<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='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
<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' />
@@ -218,6 +218,38 @@
<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 &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; 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 &apos;logging level force-all &lt;level&gt;&apos;' />
</params>
</command>
<command id='show logging vty'>
<params>
<param name='show' doc='Show running system information' />
@@ -304,6 +336,24 @@
<param name='[stats]' doc='Include Statistics' />
</params>
</command>
<command id='show mgcp endpoint NAME'>
<params>
<param name='show' doc='Show running system information' />
<param name='mgcp' doc='Display information about the MGCP Media Gateway' />
<param name='endpoint' doc='Display information about an endpoint' />
<param name='NAME' doc='The name of the endpoint' />
</params>
</command>
<command id='show mgcp trunk &lt;0-64&gt; endpoint NAME'>
<params>
<param name='show' doc='Show running system information' />
<param name='mgcp' doc='Display information about the MGCP Media Gateway' />
<param name='trunk' doc='Display information about a trunk' />
<param name='&lt;0-64&gt;' doc='Trunk number' />
<param name='endpoint' doc='Display information about an endpoint' />
<param name='NAME' doc='The name of the endpoint' />
</params>
</command>
</node>
<node id='enable'>
<name>enable</name>
@@ -454,7 +504,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
<command id='logging print file (0|1|basename)'>
<command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -462,6 +512,7 @@
<param name='0' doc='Don&apos;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&apos;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'>
@@ -471,12 +522,12 @@
<param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, 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 (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
<command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (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='all' doc='Global setting for all subsystems' />
<param name='rtp' doc='RTP stream handling' />
<param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -495,7 +546,6 @@
<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='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
<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' />
@@ -503,6 +553,38 @@
<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 &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; 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 &apos;logging level force-all &lt;level&gt;&apos;' />
</params>
</command>
<command id='show logging vty'>
<params>
<param name='show' doc='Show running system information' />
@@ -589,6 +671,24 @@
<param name='[stats]' doc='Include Statistics' />
</params>
</command>
<command id='show mgcp endpoint NAME'>
<params>
<param name='show' doc='Show running system information' />
<param name='mgcp' doc='Display information about the MGCP Media Gateway' />
<param name='endpoint' doc='Display information about an endpoint' />
<param name='NAME' doc='The name of the endpoint' />
</params>
</command>
<command id='show mgcp trunk &lt;0-64&gt; endpoint NAME'>
<params>
<param name='show' doc='Show running system information' />
<param name='mgcp' doc='Display information about the MGCP Media Gateway' />
<param name='trunk' doc='Display information about a trunk' />
<param name='&lt;0-64&gt;' doc='Trunk number' />
<param name='endpoint' doc='Display information about an endpoint' />
<param name='NAME' doc='The name of the endpoint' />
</params>
</command>
<command id='loop-endpoint &lt;0-64&gt; NAME (0|1)'>
<params>
<param name='loop-endpoint' doc='Loop a given endpoint' />
@@ -929,7 +1029,7 @@
<param name='1' doc='Prefix each log message with the log level name' />
</params>
</command>
<command id='logging print file (0|1|basename)'>
<command id='logging print file (0|1|basename) [last]'>
<params>
<param name='logging' doc='Configure logging' />
<param name='print' doc='Log output settings' />
@@ -937,14 +1037,15 @@
<param name='0' doc='Don&apos;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&apos;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 (all|rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
<command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (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='all' doc='Global setting for all subsystems' />
<param name='rtp' doc='RTP stream handling' />
<param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -963,7 +1064,6 @@
<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='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
<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' />
@@ -971,6 +1071,38 @@
<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 &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; 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 &apos;logging level force-all &lt;level&gt;&apos;' />
</params>
</command>
</node>
<node id='config-stats'>
<name>config-stats</name>
@@ -1360,8 +1492,8 @@
</command>
<command id='domain NAME'>
<params>
<param name='domain' doc='domain' />
<param name='NAME' doc='qualified domain name' />
<param name='domain' doc='Set the domain part expected in MGCP messages&apos; endpoint names' />
<param name='NAME' doc='Qualified domain name expected in MGCP endpoint names, or &apos;*&apos; to accept any domain' />
</params>
</command>
<command id='trunk &lt;1-64&gt;'>