paulmataruso/osmo-hlr
1
0
Fork 0
mirror of https://gitea.osmocom.org/cellular-infrastructure/osmo-hlr.git synced 2025-11-02 05:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

hlr: update vty reference

Browse Source 
Change-Id: I5a2322c0488cb36b089303bbfec5d4db18c41099
This commit is contained in:
Neels Hofmeyr
2018-11-05 03:18:46 +01:00
parent 79efdf3474
commit bf6b4eb0b9
1 changed files with 184 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

230
doc/manuals/vty/hlr_vty_reference.xml
View File

@@ -85,12 +85,6 @@
<param name='length' doc='Set number of lines on a screen' />
</params>
</command>
<command id='echo .MESSAGE'>
<params>
<param name='echo' doc='Echo a message back to the vty' />
<param name='.MESSAGE' doc='The message to echo' />
</params>
</command>
<command id='who'>
<params>
<param name='who' doc='Display who is on vty' />
@@ -175,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' />
@@ -183,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'>
@@ -192,23 +187,14 @@
<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 set log mask MASK'>
<params>
<param name='logging' doc='Configure logging' />
<param name='set' doc='Decide which categories to output.' />
<param name='log' doc='Log commands' />
<param name='mask' doc='Mask commands' />
<param name='MASK' doc='&apos;set log mask&apos; is deprecated, please refer to the docs of &apos;set-log-mask&apos; instead' />
</params>
</command>
<command id='logging level (all|main|db|auc|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 (main|db|auc|ss|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='main' doc='Main Program' />
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -227,7 +213,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' />
@@ -235,6 +220,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' />
@@ -285,6 +302,12 @@
<param name='REGEXP' doc='Regular expression' />
</params>
</command>
<command id='show gsup-connections'>
<params>
<param name='show' doc='Show running system information' />
<param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
</params>
</command>
<command id='subscriber (imsi|msisdn|id) IDENT show'>
<params>
<param name='subscriber' doc='Subscriber management commands' />
@@ -348,12 +371,6 @@
<param name='length' doc='Set number of lines on a screen' />
</params>
</command>
<command id='echo .MESSAGE'>
<params>
<param name='echo' doc='Echo a message back to the vty' />
<param name='.MESSAGE' doc='The message to echo' />
</params>
</command>
<command id='who'>
<params>
<param name='who' doc='Display who is on vty' />
@@ -451,7 +468,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' />
@@ -459,6 +476,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'>
@@ -468,23 +486,14 @@
<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 set log mask MASK'>
<params>
<param name='logging' doc='Configure logging' />
<param name='set' doc='Decide which categories to output.' />
<param name='log' doc='Log commands' />
<param name='mask' doc='Mask commands' />
<param name='MASK' doc='&apos;set log mask&apos; is deprecated, please refer to the docs of &apos;set-log-mask&apos; instead' />
</params>
</command>
<command id='logging level (all|main|db|auc|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 (main|db|auc|ss|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='main' doc='Main Program' />
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -503,7 +512,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' />
@@ -511,6 +519,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' />
@@ -561,6 +601,12 @@
<param name='REGEXP' doc='Regular expression' />
</params>
</command>
<command id='show gsup-connections'>
<params>
<param name='show' doc='Show running system information' />
<param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
</params>
</command>
<command id='subscriber (imsi|msisdn|id) IDENT show'>
<params>
<param name='subscriber' doc='Subscriber management commands' />
@@ -574,9 +620,9 @@
<command id='subscriber imsi IDENT create'>
<params>
<param name='subscriber' doc='Subscriber management commands' />
<param name='imsi' doc='Create subscriber by IMSI' />
<param name='imsi' doc='Identify subscriber by IMSI' />
<param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
<param name='create' doc='(null)' />
<param name='create' doc='Create subscriber by IMSI' />
</params>
</command>
<command id='subscriber (imsi|msisdn|id) IDENT delete'>
@@ -837,8 +883,7 @@
<param name='user' doc='Generic facility' />
<param name='uucp' doc='UUCP facility' />
</params>
</command>
<command id='log syslog local &lt;0-7&gt;'>
</command> <command id='log syslog local &lt;0-7&gt;'>
<params>
<param name='log' doc='Configure logging sub-system' />
<param name='syslog' doc='Logging via syslog' />
@@ -929,7 +974,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,16 +982,17 @@
<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|main|db|auc|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 (main|db|auc|ss|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='main' doc='Main Program' />
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -965,7 +1011,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' />
@@ -973,6 +1018,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-line'>
<name>config-line</name>
@@ -1010,6 +1087,64 @@
<param name='gsup' doc='Configure GSUP options' />
</params>
</command>
<command id='euse NAME'>
<params>
<param name='euse' doc='Configure a particular External USSD Entity' />
<param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
</params>
</command>
<command id='no euse NAME'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
<param name='euse' doc='Remove a particular External USSD Entity' />
<param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
</params>
</command>
<command id='ussd route prefix PREFIX internal (own-msisdn|own-imsi)'>
<params>
<param name='ussd' doc='USSD Configuration' />
<param name='route' doc='Routing Configuration' />
<param name='prefix' doc='Prefix-Matching Route' />
<param name='PREFIX' doc='USSD Prefix' />
<param name='internal' doc='Internal USSD Handler' />
<param name='own-msisdn' doc='Respond with subscribers&apos; own MSISDN' />
<param name='own-imsi' doc='Respond with subscribers&apos; own IMSI' />
</params>
</command>
<command id='ussd route prefix PREFIX external EUSE'>
<params>
<param name='ussd' doc='USSD Configuration' />
<param name='route' doc='Routing Configuration' />
<param name='prefix' doc='Prefix-Matching Route' />
<param name='PREFIX' doc='USSD Prefix' />
<param name='external' doc='External USSD Handler' />
<param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
</params>
</command>
<command id='no ussd route prefix PREFIX'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
<param name='ussd' doc='USSD Configuration' />
<param name='route' doc='Routing Configuration' />
<param name='prefix' doc='Prefix-Matching Route' />
<param name='PREFIX' doc='USSD Prefix' />
</params>
</command>
<command id='ussd default-route external EUSE'>
<params>
<param name='ussd' doc='USSD Configuration' />
<param name='default-route' doc='Configure default-route for all USSD to unknown destinations' />
<param name='external' doc='External USSD Handler' />
<param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
</params>
</command>
<command id='no ussd default-route'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
<param name='ussd' doc='USSD Configuration' />
<param name='default-route' doc='Remove the default-route for all USSD to unknown destinations' />
</params>
</command>
</node>
<node id='config-hlr-gsup'>
<name>config-hlr-gsup</name>
@@ -1021,4 +1156,7 @@
</params>
</command>
</node>
<node id='config-hlr-euse'>
<name>config-hlr-euse</name>
</node>
</vtydoc>