doc: Update VTY reference xml file
Change-Id: Ifdefba331ae2542b1cdc5860d0f9e53ef9f703c4
diff --git a/doc/manuals/vty/hlr_vty_reference.xml b/doc/manuals/vty/hlr_vty_reference.xml
index 71a0236..8e56f4b 100644
--- a/doc/manuals/vty/hlr_vty_reference.xml
+++ b/doc/manuals/vty/hlr_vty_reference.xml
@@ -18,10 +18,11 @@
<param name='terminal' doc='Write to terminal' />
</params>
</command>
- <command id='write file'>
+ <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'>
@@ -187,7 +188,7 @@
<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 (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
+ <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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' />
@@ -195,6 +196,9 @@
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
+ <param name='mslookup' doc='Mobile Subscriber Lookup' />
+ <param name='lu' doc='Location Updating' />
+ <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -253,6 +257,43 @@
<param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' />
</params>
</command>
+ <command id='logp (main|db|auc|ss|mslookup|lu|dgsm|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='main' doc='Main Program' />
+ <param name='db' doc='Database Layer' />
+ <param name='auc' doc='Authentication Center' />
+ <param name='ss' doc='Supplementary Services' />
+ <param name='mslookup' doc='Mobile Subscriber Lookup' />
+ <param name='lu' doc='Location Updating' />
+ <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
+ <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' />
@@ -360,6 +401,13 @@
<param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
</params>
</command>
+ <command id='show mslookup services'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mslookup' doc='Distributed GSM / mslookup related information' />
+ <param name='services' doc='List configured service addresses as sent to remote mslookup requests' />
+ </params>
+ </command>
</node>
<node id='enable'>
<name>enable</name>
@@ -528,7 +576,7 @@
<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 (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
+ <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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' />
@@ -536,6 +584,9 @@
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
+ <param name='mslookup' doc='Mobile Subscriber Lookup' />
+ <param name='lu' doc='Location Updating' />
+ <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -564,7 +615,8 @@
</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='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' />
@@ -593,6 +645,43 @@
<param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' />
</params>
</command>
+ <command id='logp (main|db|auc|ss|mslookup|lu|dgsm|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='main' doc='Main Program' />
+ <param name='db' doc='Database Layer' />
+ <param name='auc' doc='Authentication Center' />
+ <param name='ss' doc='Supplementary Services' />
+ <param name='mslookup' doc='Mobile Subscriber Lookup' />
+ <param name='lu' doc='Location Updating' />
+ <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
+ <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' />
@@ -672,6 +761,18 @@
<param name='rate-counters' doc='Show all rate counters' />
</params>
</command>
+ <command id='stats report'>
+ <params>
+ <param name='stats' doc='Stats related commands' />
+ <param name='report' doc='Manurally trigger reporting of stats' />
+ </params>
+ </command>
+ <command id='stats reset'>
+ <params>
+ <param name='stats' doc='Stats related commands' />
+ <param name='reset' doc='Reset all stats' />
+ </params>
+ </command>
<command id='show gsup-connections'>
<params>
<param name='show' doc='Show running system information' />
@@ -827,6 +928,13 @@
<param name='cs+ps' doc='Allow access to both circuit and packet switched services' />
</params>
</command>
+ <command id='show mslookup services'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mslookup' doc='Distributed GSM / mslookup related information' />
+ <param name='services' doc='List configured service addresses as sent to remote mslookup requests' />
+ </params>
+ </command>
</node>
<node id='config'>
<name>config</name>
@@ -1056,11 +1164,11 @@
<param name='log' doc='Report to the logger' />
</params>
</command>
- <command id='stats interval <1-65535>'>
+ <command id='stats interval <0-65535>'>
<params>
<param name='stats' doc='Configure stats sub-system' />
<param name='interval' doc='Set the reporting interval' />
- <param name='<1-65535>' doc='Interval in seconds' />
+ <param name='<0-65535>' doc='Interval in seconds (0 disables the reporting interval)' />
</params>
</command>
<command id='hlr'>
@@ -1068,6 +1176,11 @@
<param name='hlr' doc='Configure the HLR' />
</params>
</command>
+ <command id='mslookup'>
+ <params>
+ <param name='mslookup' doc='Configure Distributed GSM mslookup' />
+ </params>
+ </command>
</node>
<node id='config-log'>
<name>config-log</name>
@@ -1143,7 +1256,7 @@
<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 (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
+ <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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' />
@@ -1151,6 +1264,9 @@
<param name='db' doc='Database Layer' />
<param name='auc' doc='Authentication Center' />
<param name='ss' doc='Supplementary Services' />
+ <param name='mslookup' doc='Mobile Subscriber Lookup' />
+ <param name='lu' doc='Location Updating' />
+ <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -1278,6 +1394,12 @@
<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>
@@ -1424,8 +1546,192 @@
<param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
</params>
</command>
+ <command id='ipa-name NAME'>
+ <params>
+ <param name='ipa-name' doc='Set the IPA name of this HLR, for proxying to remote HLRs' />
+ <param name='NAME' doc='A globally unique name for this HLR. For example: PLMN + redundancy server number: HLR-901-70-0. This name is used for GSUP routing and must be set if multiple HLRs interconnect (e.g. mslookup for Distributed GSM).' />
+ </params>
+ </command>
</node>
<node id='config-hlr-euse'>
<name>config-hlr-euse</name>
</node>
+ <node id='config-mslookup'>
+ <name>config-mslookup</name>
+ <command id='mdns bind [IP] [<1-65535>]'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='bind' doc='Convenience shortcut: enable and configure both server and client for mDNS mslookup' />
+ <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
+ <param name='[<1-65535>]' doc='mDNS UDP Port number' />
+ </params>
+ </command>
+ <command id='mdns domain-suffix DOMAIN_SUFFIX'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ </params>
+ </command>
+ <command id='no mdns bind'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='mdns' doc='Disable both server and client for mDNS mslookup' />
+ <param name='bind' doc='(null)' />
+ </params>
+ </command>
+ <command id='server'>
+ <params>
+ <param name='server' doc='Enable and configure Distributed GSM mslookup server' />
+ </params>
+ </command>
+ <command id='no server'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='server' doc='Disable Distributed GSM mslookup server' />
+ </params>
+ </command>
+ <command id='client'>
+ <params>
+ <param name='client' doc='Enable and configure Distributed GSM mslookup client' />
+ </params>
+ </command>
+ <command id='no client'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='client' doc='Disable Distributed GSM mslookup client' />
+ </params>
+ </command>
+ </node>
+ <node id='config-mslookup-server'>
+ <name>config-mslookup-server</name>
+ <command id='mdns bind [IP] [<1-65535>]'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='bind' doc='Configure where the mDNS server listens for mslookup requests' />
+ <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
+ <param name='[<1-65535>]' doc='mDNS UDP Port number' />
+ </params>
+ </command>
+ <command id='mdns domain-suffix DOMAIN_SUFFIX'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ </params>
+ </command>
+ <command id='no mdns bind'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='mdns' doc='Disable server for mDNS mslookup (do not answer remote requests)' />
+ <param name='bind' doc='(null)' />
+ </params>
+ </command>
+ <command id='service NAME at IP <1-65535>'>
+ <params>
+ <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ <param name='at' doc='at' />
+ <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
+ <param name='<1-65535>' doc='Service-specific port number' />
+ </params>
+ </command>
+ <command id='no service NAME'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='service' doc='Remove one or more service address entries' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ </params>
+ </command>
+ <command id='no service NAME at IP <1-65535>'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='service' doc='Remove one or more service address entries' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ <param name='at' doc='at' />
+ <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
+ <param name='<1-65535>' doc='Service-specific port number' />
+ </params>
+ </command>
+ <command id='msc ipa-name .IPA_NAME'>
+ <params>
+ <param name='msc' doc='Configure services for individual local MSCs' />
+ <param name='ipa-name' doc='Identify locally connected MSC by IPA Unit Name' />
+ <param name='.IPA_NAME' doc='IPA Unit Name of the local MSC to configure' />
+ </params>
+ </command>
+ </node>
+ <node id='config-mslookup-server-msc'>
+ <name>config-mslookup-server-msc</name>
+ <command id='service NAME at IP <1-65535>'>
+ <params>
+ <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ <param name='at' doc='at' />
+ <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
+ <param name='<1-65535>' doc='Service-specific port number' />
+ </params>
+ </command>
+ <command id='no service NAME'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='service' doc='Remove one or more service address entries' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ </params>
+ </command>
+ <command id='no service NAME at IP <1-65535>'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='service' doc='Remove one or more service address entries' />
+ <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
+ <param name='at' doc='at' />
+ <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
+ <param name='<1-65535>' doc='Service-specific port number' />
+ </params>
+ </command>
+ </node>
+ <node id='config-mslookup-client'>
+ <name>config-mslookup-client</name>
+ <command id='timeout <1-100000>'>
+ <params>
+ <param name='timeout' doc='How long should the mslookup client wait for remote responses before evaluating received results' />
+ <param name='<1-100000>' doc='timeout in milliseconds' />
+ </params>
+ </command>
+ <command id='mdns bind [IP] [<1-65535>]'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='bind' doc='Enable mDNS client, and configure multicast address to send mDNS mslookup requests to' />
+ <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
+ <param name='[<1-65535>]' doc='mDNS UDP Port number' />
+ </params>
+ </command>
+ <command id='mdns domain-suffix DOMAIN_SUFFIX'>
+ <params>
+ <param name='mdns' doc='Multicast DNS related configuration' />
+ <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don't collide with top-level domains administrated by IANA' />
+ </params>
+ </command>
+ <command id='no mdns bind'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='mdns' doc='Disable mDNS client, do not query remote services by mDNS' />
+ <param name='bind' doc='(null)' />
+ </params>
+ </command>
+ <command id='gateway-proxy IP [<1-65535>]'>
+ <params>
+ <param name='gateway-proxy' doc='Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI' />
+ <param name='IP' doc='IP address of the remote HLR' />
+ <param name='[<1-65535>]' doc='GSUP port number (omit for default 4222)' />
+ </params>
+ </command>
+ <command id='no gateway-proxy'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='gateway-proxy' doc='Disable gateway proxy for GSUP with unknown IMSIs' />
+ </params>
+ </command>
+ </node>
</vtydoc>