doc/manuals/vty/hlr_vty_reference.xml

<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'>
      <params>
        <param name='write' doc='Write running configuration to memory, network, or terminal' />
        <param name='file' doc='Write to configuration file' />
      </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 &lt;0-512&gt;'>
      <params>
        <param name='terminal' doc='Set terminal line parameters' />
        <param name='length' doc='Set number of lines on a screen' />
        <param name='&lt;0-512&gt;' 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='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' />
      </params>
    </command>
    <command id='show history'>
      <params>
        <param name='show' doc='Show running system information' />
        <param name='history' doc='Display the session command history' />
      </params>
    </command>
    <command id='logging enable'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='enable' doc='Enables logging to this vty' />
      </params>
    </command>
    <command id='logging disable'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='disable' doc='Disables logging to this vty' />
      </params>
    </command>
    <command id='logging filter all (0|1)'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='filter' doc='Filter log messages' />
        <param name='all' doc='Do you want to log all messages?' />
        <param name='0' doc='Only print messages matched by other filters' />
        <param name='1' doc='Bypass filter and print all messages' />
      </params>
    </command>
    <command id='logging color (0|1)'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='color' doc='Configure color-printing for log messages' />
        <param name='0' doc='Don&apos;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&apos;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&apos;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&apos;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&apos;t prefix each log message' />
        <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
      </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&apos;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)'>
      <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&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' />
      </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. &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)'>
      <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='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='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' />
        <param name='error' doc='Log error messages and higher levels' />
        <param name='fatal' doc='Log only fatal messages' />
      </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&apos;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&apos;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&apos;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='subscriber (imsi|msisdn|id) IDENT show'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='show' doc='Show subscriber information' />
      </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 &lt;0-512&gt;'>
      <params>
        <param name='terminal' doc='Set terminal line parameters' />
        <param name='length' doc='Set number of lines on a screen' />
        <param name='&lt;0-512&gt;' 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='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' />
      </params>
    </command>
    <command id='show history'>
      <params>
        <param name='show' doc='Show running system information' />
        <param name='history' doc='Display the session command history' />
      </params>
    </command>
    <command id='terminal monitor'>
      <params>
        <param name='terminal' doc='Set terminal line parameters' />
        <param name='monitor' doc='Copy debug output to the current terminal line' />
      </params>
    </command>
    <command id='terminal no monitor'>
      <params>
        <param name='terminal' doc='Set terminal line parameters' />
        <param name='no' doc='Negate a command or set its defaults' />
        <param name='monitor' doc='Copy debug output to the current terminal line' />
      </params>
    </command>
    <command id='logging enable'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='enable' doc='Enables logging to this vty' />
      </params>
    </command>
    <command id='logging disable'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='disable' doc='Disables logging to this vty' />
      </params>
    </command>
    <command id='logging filter all (0|1)'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='filter' doc='Filter log messages' />
        <param name='all' doc='Do you want to log all messages?' />
        <param name='0' doc='Only print messages matched by other filters' />
        <param name='1' doc='Bypass filter and print all messages' />
      </params>
    </command>
    <command id='logging color (0|1)'>
      <params>
        <param name='logging' doc='Configure logging' />
        <param name='color' doc='Configure color-printing for log messages' />
        <param name='0' doc='Don&apos;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&apos;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&apos;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&apos;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&apos;t prefix each log message' />
        <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
      </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&apos;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)'>
      <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&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' />
      </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. &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)'>
      <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='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='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' />
        <param name='error' doc='Log error messages and higher levels' />
        <param name='fatal' doc='Log only fatal messages' />
      </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&apos;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&apos;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&apos;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='subscriber (imsi|msisdn|id) IDENT show'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='show' doc='Show subscriber information' />
      </params>
    </command>
    <command id='subscriber imsi IDENT create'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Create subscriber by IMSI' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='create' doc='(null)' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT delete'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='delete' doc='Delete subscriber from database' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT update msisdn MSISDN'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='update' doc='Set or update subscriber data' />
        <param name='msisdn' doc='Set MSISDN (phone number) of the subscriber' />
        <param name='MSISDN' doc='New MSISDN (phone number)' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT update aud2g none'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='update' doc='Set or update subscriber data' />
        <param name='aud2g' doc='Set 2G authentication data' />
        <param name='none' doc='Delete 2G authentication data' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT update aud2g (comp128v1|comp128v2|comp128v3|xor) ki KI'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='update' doc='Set or update subscriber data' />
        <param name='aud2g' doc='Set 2G authentication data' />
        <param name='comp128v1' doc='Use COMP128v1 algorithm' />
        <param name='comp128v2' doc='Use COMP128v2 algorithm' />
        <param name='comp128v3' doc='Use COMP128v3 algorithm' />
        <param name='xor' doc='Use XOR algorithm' />
        <param name='ki' doc='Set Ki Encryption Key' />
        <param name='KI' doc='Ki as 32 hexadecimal characters' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT update aud3g none'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='update' doc='Set or update subscriber data' />
        <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
        <param name='none' doc='Delete 3G authentication data' />
      </params>
    </command>
    <command id='subscriber (imsi|msisdn|id) IDENT update aud3g milenage k K (op|opc) OP_C [ind-bitlen] [&lt;0-28&gt;]'>
      <params>
        <param name='subscriber' doc='Subscriber management commands' />
        <param name='imsi' doc='Identify subscriber by IMSI' />
        <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
        <param name='id' doc='Identify subscriber by database ID' />
        <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
        <param name='update' doc='Set or update subscriber data' />
        <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
        <param name='milenage' doc='Use Milenage algorithm' />
        <param name='k' doc='Set Encryption Key K' />
        <param name='K' doc='K as 32 hexadecimal characters' />
        <param name='op' doc='Set OP key' />
        <param name='opc' doc='Set OPC key' />
        <param name='OP_C' doc='OP or OPC as 32 hexadecimal characters' />
        <param name='[ind-bitlen]' doc='Set IND bit length' />
        <param name='[&lt;0-28&gt;]' doc='IND bit length value (default: 5)' />
      </params>
    </command>
  </node>
  <node id='config'>
    <name>config</name>
    <command id='hostname WORD'>
      <params>
        <param name='hostname' doc='Set system&apos;s network name' />
        <param name='WORD' doc='This system&apos;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&apos;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 &apos;enable&apos; 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) &apos;enable&apos; 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 &lt;0-512&gt;'>
      <params>
        <param name='service' doc='Set up miscellaneous service' />
        <param name='terminal-length' doc='System wide terminal length configuration' />
        <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
      </params>
    </command>
    <command id='no service terminal-length [&lt;0-512&gt;]'>
      <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='[&lt;0-512&gt;]' 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='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 &lt;2-32700&gt;'>
      <params>
        <param name='log' doc='Configure logging sub-system' />
        <param name='alarms' doc='Logging alarms to osmo_strrb' />
        <param name='&lt;2-32700&gt;' 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 &lt;0-7&gt;'>
      <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='&lt;0-7&gt;' 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='hlr'>
      <params>
        <param name='hlr' doc='Configure the HLR' />
      </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&apos;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&apos;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&apos;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&apos;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&apos;t prefix each log message' />
        <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
      </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&apos;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)'>
      <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&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' />
      </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)'>
      <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='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='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' />
        <param name='error' doc='Log error messages and higher levels' />
        <param name='fatal' doc='Log only fatal messages' />
      </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'>
      <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)' />
      </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='config-hlr'>
    <name>config-hlr</name>
    <command id='gsup'>
      <params>
        <param name='gsup' doc='Configure GSUP options' />
      </params>
    </command>
  </node>
  <node id='config-hlr-gsup'>
    <name>config-hlr-gsup</name>
    <command id='bind ip A.B.C.D'>
      <params>
        <param name='bind' doc='Listen/Bind related socket option' />
        <param name='ip' doc='IP information' />
        <param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
      </params>
    </command>
  </node>
</vtydoc>