diff options
| author | Daniel Willmann <dwillmann@sysmocom.de> | 2019-07-29 12:10:21 +0200 |
|---|---|---|
| committer | Daniel Willmann <dwillmann@sysmocom.de> | 2019-07-29 12:11:22 +0200 |
| commit | dc468e644294b10126530cf401d1860d4b21fcd7 (patch) | |
| tree | 1f8b1da30317e9512324414062fff404a0ef9a1d | |
| parent | 30301f263cdc90c5a6a6bdbe695b8bd416213422 (diff) | |
Add VTY reference manual
Fixes: OS#2589
Change-Id: I042734fa9979b598d5471839e408cbf39bba57b5
| -rw-r--r-- | configure.ac | 43 | ||||
| -rw-r--r-- | doc/Makefile.am | 5 | ||||
| -rw-r--r-- | doc/manuals/Makefile.am | 12 | ||||
| -rw-r--r-- | doc/manuals/osmohnbgw-vty-reference.xml | 38 | ||||
| -rwxr-xr-x | doc/manuals/regen_doc.sh | 17 | ||||
| -rw-r--r-- | doc/manuals/vty/hnbgw_vty_additions.xml | 2 | ||||
| -rw-r--r-- | doc/manuals/vty/hnbgw_vty_reference.xml | 1535 |
7 files changed, 1651 insertions, 1 deletions
diff --git a/configure.ac b/configure.ac index 559db39..dc3d1eb 100644 --- a/configure.ac +++ b/configure.ac @@ -79,6 +79,48 @@ fi CFLAGS="$CFLAGS -Wall" CPPFLAGS="$CPPFLAGS -Wall" +# Generate manuals +AC_ARG_ENABLE(manuals, + [AS_HELP_STRING( + [--enable-manuals], + [Generate manual PDFs [default=no]], + )], + [osmo_ac_build_manuals=$enableval], [osmo_ac_build_manuals="no"]) +AM_CONDITIONAL([BUILD_MANUALS], [test x"$osmo_ac_build_manuals" = x"yes"]) +AC_ARG_VAR(OSMO_GSM_MANUALS_DIR, [path to common osmo-gsm-manuals files, overriding pkg-config and "../osmo-gsm-manuals" + fallback]) +if test x"$osmo_ac_build_manuals" = x"yes" +then + # Find OSMO_GSM_MANUALS_DIR (env, pkg-conf, fallback) + if test -n "$OSMO_GSM_MANUALS_DIR"; then + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from env)" + else + OSMO_GSM_MANUALS_DIR="$($PKG_CONFIG osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null)" + if test -n "$OSMO_GSM_MANUALS_DIR"; then + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from pkg-conf)" + else + OSMO_GSM_MANUALS_DIR="../osmo-gsm-manuals" + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (fallback)" + fi + fi + if ! test -d "$OSMO_GSM_MANUALS_DIR"; then + AC_MSG_ERROR("OSMO_GSM_MANUALS_DIR does not exist! Install osmo-gsm-manuals or set OSMO_GSM_MANUALS_DIR.") + fi + + # Find and run check-depends + CHECK_DEPENDS="$OSMO_GSM_MANUALS_DIR/check-depends.sh" + if ! test -x "$CHECK_DEPENDS"; then + CHECK_DEPENDS="osmo-gsm-manuals-check-depends" + fi + if ! $CHECK_DEPENDS; then + AC_MSG_ERROR("missing dependencies for --enable-manuals") + fi + + # Put in Makefile with absolute path + OSMO_GSM_MANUALS_DIR="$(realpath "$OSMO_GSM_MANUALS_DIR")" + AC_SUBST([OSMO_GSM_MANUALS_DIR]) +fi + # https://www.freedesktop.org/software/systemd/man/daemon.html AC_ARG_WITH([systemdsystemunitdir], [AS_HELP_STRING([--with-systemdsystemunitdir=DIR], [Directory for systemd service files])],, @@ -114,6 +156,7 @@ AC_OUTPUT( include/osmocom/iuh/Makefile doc/Makefile doc/examples/Makefile + doc/manuals/Makefile contrib/Makefile contrib/systemd/Makefile ) diff --git a/doc/Makefile.am b/doc/Makefile.am index 81a25e2..eeed875 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,7 @@ -SUBDIRS = examples +SUBDIRS = \ + examples \ + manuals \ + $(NULL) EXTRA_DIST = \ hnb_cs_lu.msc \ diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am new file mode 100644 index 0000000..91aa8f8 --- /dev/null +++ b/doc/manuals/Makefile.am @@ -0,0 +1,12 @@ +EXTRA_DIST = \ + osmohnbgw-vty-reference.xml \ + regen_doc.sh \ + vty + +if BUILD_MANUALS + VTY_REFERENCE = osmohnbgw-vty-reference.xml + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc + + OSMO_REPOSITORY = osmo-hnbgw + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc +endif diff --git a/doc/manuals/osmohnbgw-vty-reference.xml b/doc/manuals/osmohnbgw-vty-reference.xml new file mode 100644 index 0000000..cd69333 --- /dev/null +++ b/doc/manuals/osmohnbgw-vty-reference.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ex:ts=2:sw=42sts=2:et + -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN" +"http://docbook.org/xml/5.0/dtd/docbook.dtd" [ +<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" > +<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" > +]> + +<book> + <info> + <revhistory> + <revision> + <revnumber>v1</revnumber> + <date>29th July 2019</date> + <authorinitials>dw</authorinitials> + <revremark>Initial</revremark> + </revision> + </revhistory> + + <title>OsmoHNBGW VTY Reference</title> + + <copyright> + <year>2019</year> + </copyright> + + <legalnotice> + <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved. + </para> + </legalnotice> + </info> + + <!-- Main chapters--> + &chapter-vty; +</book> + diff --git a/doc/manuals/regen_doc.sh b/doc/manuals/regen_doc.sh new file mode 100755 index 0000000..39dd9ee --- /dev/null +++ b/doc/manuals/regen_doc.sh @@ -0,0 +1,17 @@ +#!/bin/sh -x + +if [ -z "$DOCKER_PLAYGROUND" ]; then + echo "You need to set DOCKER_PLAYGROUND" + exit 1 +fi + +SCRIPT=$(realpath "$0") +MANUAL_DIR=$(dirname "$SCRIPT") + +COMMIT=${COMMIT:-$(git log -1 --format=format:%H)} + +cd "$DOCKER_PLAYGROUND/scripts" || exit 1 + +OSMO_SGSN_BRANCH=$COMMIT ./regen_doc.sh osmo-hnbgw 4261 \ + "$MANUAL_DIR/chapters/counters_generated.adoc" \ + "$MANUAL_DIR/vty/hnbgw_vty_reference.xml" diff --git a/doc/manuals/vty/hnbgw_vty_additions.xml b/doc/manuals/vty/hnbgw_vty_additions.xml new file mode 100644 index 0000000..a4c675e --- /dev/null +++ b/doc/manuals/vty/hnbgw_vty_additions.xml @@ -0,0 +1,2 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> +</vtydoc> diff --git a/doc/manuals/vty/hnbgw_vty_reference.xml b/doc/manuals/vty/hnbgw_vty_reference.xml new file mode 100644 index 0000000..4046636 --- /dev/null +++ b/doc/manuals/vty/hnbgw_vty_reference.xml @@ -0,0 +1,1535 @@ +<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 <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='show cs7 instance <0-15> users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='users' doc='User Table' /> + </params> + </command> + <command id='show cs7 (sua|m3ua|ipa) [<0-65534>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + <param name='[<0-65534>]' doc='Port Number' /> + </params> + </command> + <command id='show cs7 instance <0-15> asp'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='asp' doc='Application Server Process (ASP)' /> + </params> + </command> + <command id='show cs7 instance <0-15> as (active|all|m3ua|sua)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='as' doc='Application Server (AS)' /> + <param name='active' doc='Display all active ASs' /> + <param name='all' doc='Display all ASs (default)' /> + <param name='m3ua' doc='Display all m3ua ASs' /> + <param name='sua' doc='Display all SUA ASs' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp addressbook'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='addressbook' doc='List all SCCP addressbook entries' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='users' doc='Show List of SCCP Users registered' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp ssn <0-65535>'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='ssn' doc='Find an SCCP User registered for the given SSN' /> + <param name='<0-65535>' doc='Subsystem Number (SSN)' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='connections' doc='Show List of active SCCP connections' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp timers'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signaling Connection Control Part' /> + <param name='timers' doc='Show List of SCCP timers' /> + </params> + </command> + <command id='show cnlink'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cnlink' doc='Display information on core network link' /> + </params> + </command> + <command id='show hnb all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='hnb' doc='Display information about all HNB' /> + <param name='all' doc='(null)' /> + </params> + </command> + <command id='show hnb NAME '> + <params> + <param name='show' doc='Show running system information' /> + <param name='hnb' doc='Display information about a HNB' /> + <param name='NAME' doc='(null)' /> + </params> + </command> + <command id='show ue all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ue' doc='Display information about a UE' /> + <param name='all' doc='(null)' /> + </params> + </command> + <command id='show talloc'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc' doc='Display talloc info' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='main' doc='Main program' /> + <param name='hnbap' doc='Home Node B Application Part' /> + <param name='rua' doc='RANAP User Adaptation' /> + <param name='ranap' doc='RAN Application Part' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='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> + </node> + <node id='enable'> + <name>enable</name> + <command id='disable'> + <params> + <param name='disable' doc='Turn off privileged mode command' /> + </params> + </command> + <command id='configure terminal'> + <params> + <param name='configure' doc='Configuration from vty interface' /> + <param name='terminal' doc='Configuration terminal' /> + </params> + </command> + <command id='copy running-config startup-config'> + <params> + <param name='copy' doc='Copy configuration' /> + <param name='running-config' doc='Copy running config to... ' /> + <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> + </params> + </command> + <command id='show startup-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='startup-config' doc='Contentes of startup configuration' /> + </params> + </command> + <command id='show version'> + <params> + <param name='show' doc='Show running system information' /> + <param name='version' doc='Displays program version' /> + </params> + </command> + <command id='show online-help'> + <params> + <param name='show' doc='Show running system information' /> + <param name='online-help' doc='Online help' /> + </params> + </command> + <command id='terminal length <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='terminal monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='terminal no monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='show cs7 instance <0-15> users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='users' doc='User Table' /> + </params> + </command> + <command id='show cs7 (sua|m3ua|ipa) [<0-65534>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + <param name='[<0-65534>]' doc='Port Number' /> + </params> + </command> + <command id='show cs7 instance <0-15> asp'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='asp' doc='Application Server Process (ASP)' /> + </params> + </command> + <command id='show cs7 instance <0-15> as (active|all|m3ua|sua)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='as' doc='Application Server (AS)' /> + <param name='active' doc='Display all active ASs' /> + <param name='all' doc='Display all ASs (default)' /> + <param name='m3ua' doc='Display all m3ua ASs' /> + <param name='sua' doc='Display all SUA ASs' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp addressbook'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='addressbook' doc='List all SCCP addressbook entries' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='users' doc='Show List of SCCP Users registered' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp ssn <0-65535>'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='ssn' doc='Find an SCCP User registered for the given SSN' /> + <param name='<0-65535>' doc='Subsystem Number (SSN)' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='connections' doc='Show List of active SCCP connections' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp timers'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signaling Connection Control Part' /> + <param name='timers' doc='Show List of SCCP timers' /> + </params> + </command> + <command id='show cnlink'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cnlink' doc='Display information on core network link' /> + </params> + </command> + <command id='show hnb all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='hnb' doc='Display information about all HNB' /> + <param name='all' doc='(null)' /> + </params> + </command> + <command id='show hnb NAME '> + <params> + <param name='show' doc='Show running system information' /> + <param name='hnb' doc='Display information about a HNB' /> + <param name='NAME' doc='(null)' /> + </params> + </command> + <command id='show ue all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ue' doc='Display information about a UE' /> + <param name='all' doc='(null)' /> + </params> + </command> + <command id='show talloc'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc' doc='Display talloc info' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='main' doc='Main program' /> + <param name='hnbap' doc='Home Node B Application Part' /> + <param name='rua' doc='RANAP User Adaptation' /> + <param name='ranap' doc='RAN Application Part' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='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> + </node> + <node id='config'> + <name>config</name> + <command id='hostname WORD'> + <params> + <param name='hostname' doc='Set system's network name' /> + <param name='WORD' doc='This system's network name' /> + </params> + </command> + <command id='no hostname [HOSTNAME]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='hostname' doc='Reset system's network name' /> + <param name='[HOSTNAME]' doc='Host name of this router' /> + </params> + </command> + <command id='password (8|) WORD'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN line password string' /> + </params> + </command> + <command id='password LINE'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> + </params> + </command> + <command id='enable password (8|) WORD'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN 'enable' password string' /> + </params> + </command> + <command id='enable password LINE'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> + </params> + </command> + <command id='no enable password'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + </params> + </command> + <command id='banner motd default'> + <params> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + <param name='default' doc='Default string' /> + </params> + </command> + <command id='banner motd file [FILE]'> + <params> + <param name='banner' doc='Set banner' /> + <param name='motd' doc='Banner for motd' /> + <param name='file' doc='Banner from a file' /> + <param name='[FILE]' doc='Filename' /> + </params> + </command> + <command id='no banner motd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + </params> + </command> + <command id='service terminal-length <0-512>'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='no service terminal-length [<0-512>]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='line vty'> + <params> + <param name='line' doc='Configure a terminal line' /> + <param name='vty' doc='Virtual terminal' /> + </params> + </command> + <command id='service advanced-vty'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='no service advanced-vty'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='cs7 instance <0-15>'> + <params> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='Configure a SS7 Instance' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + </params> + </command> + <command id='hnbgw'> + <params> + <param name='hnbgw' doc='Configure HNBGW options' /> + </params> + </command> + <command id='log stderr'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='no log stderr'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='log file .FILENAME'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='no log file .FILENAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='log alarms <2-32700>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + <param name='<2-32700>' doc='Maximum number of messages to log' /> + </params> + </command> + <command id='no log alarms'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + </params> + </command> + <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='authpriv' doc='Security/authorization messages facility' /> + <param name='cron' doc='Clock daemon (cron/at) facility' /> + <param name='daemon' doc='General system daemon facility' /> + <param name='ftp' doc='Ftp daemon facility' /> + <param name='lpr' doc='Line printer facility' /> + <param name='mail' doc='Mail facility' /> + <param name='news' doc='News facility' /> + <param name='user' doc='Generic facility' /> + <param name='uucp' doc='UUCP facility' /> + </params> + </command> + <command id='log syslog local <0-7>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='local' doc='Syslog LOCAL facility' /> + <param name='<0-7>' doc='Local facility number' /> + </params> + </command> + <command id='no log syslog'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + </params> + </command> + <command id='log gsmtap [HOSTNAME]'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='gsmtap' doc='Logging via GSMTAP' /> + <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> + </params> + </command> + </node> + <node id='config-log'> + <name>config-log</name> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging level (main|hnbap|rua|ranap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='main' doc='Main program' /> + <param name='hnbap' doc='Home Node B Application Part' /> + <param name='rua' doc='RANAP User Adaptation' /> + <param name='ranap' doc='RAN Application Part' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + </node> + <node id='config-line'> + <name>config-line</name> + <command id='login'> + <params> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='no login'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='bind A.B.C.D [<0-65535>]'> + <params> + <param name='bind' doc='Accept VTY telnet connections on local interface' /> + <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> + <param name='[<0-65535>]' doc='Local TCP port number' /> + </params> + </command> + </node> + <node id='config-cs7'> + <name>config-cs7</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='network-indicator (international | national | reserved | spare)'> + <params> + <param name='network-indicator' doc='Configure the Network Indicator' /> + <param name='international' doc='International Network' /> + <param name='national' doc='National Network' /> + <param name='reserved' doc='Reserved Network' /> + <param name='spare' doc='Spare Network' /> + </params> + </command> + <command id='point-code POINT_CODE'> + <params> + <param name='point-code' doc='Configure the local Point Code' /> + <param name='POINT_CODE' doc='Point Code' /> + </params> + </command> + <command id='point-code format <1-24> [<1-23>] [<1-22>]'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='format' doc='Configure Point Code Format' /> + <param name='<1-24>' doc='Length of first PC component' /> + <param name='[<1-23>]' doc='Length of second PC component' /> + <param name='[<1-22>]' doc='Length of third PC component' /> + </params> + </command> + <command id='point-code format default'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='format' doc='Configure Point Code Format' /> + <param name='default' doc='Default Point Code Format (3.8.3)' /> + </params> + </command> + <command id='point-code delimiter (default|dash)'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='delimiter' doc='Configure Point Code Delimiter' /> + <param name='default' doc='Use dot as delimiter' /> + <param name='dash' doc='User dash as delimiter' /> + </params> + </command> + <command id='xua rkm routing-key-allocation (static-only|dynamic-permitted)'> + <params> + <param name='xua' doc='SIGTRAN xxxUA related' /> + <param name='rkm' doc='Routing Key Management' /> + <param name='routing-key-allocation' doc='Routing Key Management Allocation Policy' /> + <param name='static-only' doc='Only static (pre-confgured) Routing Keys permitted' /> + <param name='dynamic-permitted' doc='Dynamically allocate Routing Keys for what ASPs request' /> + </params> + </command> + <command id='asp NAME <0-65535> <0-65535> (sua|m3ua|ipa)'> + <params> + <param name='asp' doc='Configure Application Server Process' /> + <param name='NAME' doc='Name of ASP' /> + <param name='<0-65535>' doc='Remote SCTP port number' /> + <param name='<0-65535>' doc='Local SCTP port number' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + </params> + </command> + <command id='no asp NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='asp' doc='Disable Application Server Process' /> + <param name='NAME' doc='Name of ASP' /> + </params> + </command> + <command id='as NAME (sua|m3ua|ipa)'> + <params> + <param name='as' doc='Configure an Application Server' /> + <param name='NAME' doc='Name of the Application Server' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + </params> + </command> + <command id='no as NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='as' doc='Disable Application Server' /> + <param name='NAME' doc='Name of AS' /> + </params> + </command> + <command id='sccp-address NAME'> + <params> + <param name='sccp-address' doc='Create/Modify an SCCP addressbook entry' /> + <param name='NAME' doc='Name of the SCCP Address' /> + </params> + </command> + <command id='no sccp-address NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sccp-address' doc='Delete an SCCP addressbook entry' /> + <param name='NAME' doc='Name of the SCCP Address' /> + </params> + </command> + <command id='sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) <1-999999>'> + <params> + <param name='sccp-timer' doc='Configure SCCP timer values, see ITU-T Q.714' /> + <param name='conn_est' doc='Waiting for connection confirm message, 1 to 2 minutes (default: 60)' /> + <param name='ias' doc='Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)' /> + <param name='iar' doc='Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)' /> + <param name='rel' doc='Waiting for release complete message, 10 to 20 seconds (default: 10)' /> + <param name='repeat_rel' doc='Waiting for release complete message; or to repeat sending released message after the initial expiry, 10 to 20 seconds (default: 10)' /> + <param name='int' doc='Waiting for release complete message; or to release connection resources, freeze the LRN and alert a maintenance function after the initial expiry, extending to 1 minute (default: 60)' /> + <param name='guard' doc='Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes (default: 1380)' /> + <param name='reset' doc='Waiting to release temporary connection section or alert maintenance function after reset request message is sent, 10 to 20 seconds (default: 10)' /> + <param name='reassembly' doc='Waiting to receive all the segments of the remaining segments, single segmented message after receiving the first segment, 10 to 20 seconds (default: 10)' /> + <param name='<1-999999>' doc='Timer value, in seconds' /> + </params> + </command> + </node> + <node id='config-cs7-as'> + <name>config-cs7-as</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='asp NAME'> + <params> + <param name='asp' doc='Specify that a given ASP is part of this AS' /> + <param name='NAME' doc='Name of ASP to be added to AS' /> + </params> + </command> + <command id='no asp NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='asp' doc='Specify ASP to be removed from this AS' /> + <param name='NAME' doc='Name of ASP to be removed' /> + </params> + </command> + <command id='traffic-mode (broadcast | loadshare | roundrobin | override)'> + <params> + <param name='traffic-mode' doc='Specifies traffic mode of operation of the ASP within the AS' /> + <param name='broadcast' doc='Broadcast to all ASP within AS' /> + <param name='loadshare' doc='Share Load among all ASP within AS' /> + <param name='roundrobin' doc='Round-Robin between all ASP within AS' /> + <param name='override' doc='Override' /> + </params> + </command> + <command id='recovery-timeout <1-2000>'> + <params> + <param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' /> + <param name='<1-2000>' doc='Recovery Timeout in Milliseconds' /> + </params> + </command> + <command id='qos-class <0-255>'> + <params> + <param name='qos-class' doc='Specity QoS Class of AS' /> + <param name='<0-255>' doc='QoS Class of AS' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='si' doc='Match on Service Indicator' /> + <param name='aal2' doc='ATM Adaption Layer 2' /> + <param name='bicc' doc='Bearer Independent Call Control' /> + <param name='b-isup' doc='Broadband ISDN User Part' /> + <param name='h248' doc='H.248' /> + <param name='isup' doc='ISDN User Part' /> + <param name='sat-isup' doc='Sattelite ISDN User Part' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='tup' doc='Telephony User Part' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC ssn SSN'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='ssn' doc='Match on Sub-System Number' /> + <param name='SSN' doc='Sub-System Number to match on' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='si' doc='Match on Service Indicator' /> + <param name='aal2' doc='ATM Adaption Layer 2' /> + <param name='bicc' doc='Bearer Independent Call Control' /> + <param name='b-isup' doc='Broadband ISDN User Part' /> + <param name='h248' doc='H.248' /> + <param name='isup' doc='ISDN User Part' /> + <param name='sat-isup' doc='Sattelite ISDN User Part' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='tup' doc='Telephony User Part' /> + <param name='ssn' doc='Match on Sub-System Number' /> + <param name='SSN' doc='Sub-System Number to match on' /> + </params> + </command> + <command id='point-code override dpc PC'> + <params> + <param name='point-code' doc='Point Code Specific Features' /> + <param name='override' doc='Override (force) a point-code to hard-coded value' /> + <param name='dpc' doc='Override Source Point Code' /> + <param name='PC' doc='Override Destination Point Code' /> + </params> + </command> + </node> + <node id='config-cs7-asp'> + <name>config-cs7-asp</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='remote-ip A.B.C.D'> + <params> + <param name='remote-ip' doc='Specify Remote IP Address of ASP' /> + <param name='A.B.C.D' doc='Remote IP Address of ASP' /> + </params> + </command> + <command id='local-ip A.B.C.D'> + <params> + <param name='local-ip' doc='Specify Local IP Address from which to contact ASP' /> + <param name='A.B.C.D' doc='Local IP Address from which to contact of ASP' /> + </params> + </command> + <command id='qos-class <0-255>'> + <params> + <param name='qos-class' doc='Specify QoS Class of ASP' /> + <param name='<0-255>' doc='QoS Class of ASP' /> + </params> + </command> + <command id='block'> + <params> + <param name='block' doc='Allows a SCTP Association with ASP, but doesn't let it become active' /> + </params> + </command> + <command id='shutdown'> + <params> + <param name='shutdown' doc='Terminates SCTP association; New associations will be rejected' /> + </params> + </command> + </node> + <node id='config-cs7-sccpaddr'> + <name>config-cs7-sccpaddr</name> + <command id='no point-code'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='point-code' doc='Remove point-code Number' /> + </params> + </command> + <command id='no subsystem-number'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='subsystem-number' doc='Remove Subsystem Number' /> + </params> + </command> + <command id='no global-title'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='global-title' doc='Remove Global Title' /> + </params> + </command> + <command id='routing-indicator (GT|PC|IP)'> + <params> + <param name='routing-indicator' doc='Add Routing Indicator' /> + <param name='GT' doc='by global-title' /> + <param name='PC' doc='by point-code' /> + <param name='IP' doc='by ip-address' /> + </params> + </command> + <command id='point-code POINT_CODE'> + <params> + <param name='point-code' doc='Add point-code Number' /> + <param name='POINT_CODE' doc='PC' /> + </params> + </command> + <command id='subsystem-number <0-4294967295>'> + <params> + <param name='subsystem-number' doc='Add Subsystem Number' /> + <param name='<0-4294967295>' doc='SSN' /> + </params> + </command> + <command id='global-title'> + <params> + <param name='global-title' doc='Add/Modify Global Title' /> + </params> + </command> + </node> + <node id='config-cs7-sccpaddr-gt'> + <name>config-cs7-sccpaddr-gt</name> + <command id='global-title-indicator <0-15>'> + <params> + <param name='global-title-indicator' doc='Set Global Title Indicator' /> + <param name='<0-15>' doc='GTI' /> + </params> + </command> + <command id='translation-type <0-255>'> + <params> + <param name='translation-type' doc='Set Global Title Translation Type' /> + <param name='<0-255>' doc='TT' /> + </params> + </command> + <command id='numbering-plan-indicator <0-15>'> + <params> + <param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' /> + <param name='<0-15>' doc='NPI' /> + </params> + </command> + <command id='nature-of-address-indicator <0-127>'> + <params> + <param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' /> + <param name='<0-127>' doc='NAI' /> + </params> + </command> + <command id='digits DIGITS'> + <params> + <param name='digits' doc='Set Global Title Digits' /> + <param name='DIGITS' doc='Number digits' /> + </params> + </command> + </node> + <node id='config-hnbgw'> + <name>config-hnbgw</name> + <command id='rnc-id <0-65535>'> + <params> + <param name='rnc-id' doc='Configure the HNBGW's RNC Id, the common RNC Id used for all connected hNodeB. It is sent to each hNodeB upon HNBAP HNB-Register-Accept, and the hNodeB will subsequently send this as RANAP InitialUE Messages' GlobalRNC-ID IE. Takes effect as soon as the hNodeB re-registers.' /> + <param name='<0-65535>' doc='RNC Id value' /> + </params> + </command> + <command id='iuh'> + <params> + <param name='iuh' doc='Configure Iuh options' /> + </params> + </command> + <command id='iucs'> + <params> + <param name='iucs' doc='Configure IuCS options' /> + </params> + </command> + <command id='iups'> + <params> + <param name='iups' doc='Configure IuPS options' /> + </params> + </command> + </node> + <node id='config-hnbgw-iuh'> + <name>config-hnbgw-iuh</name> + <command id='local-ip A.B.C.D'> + <params> + <param name='local-ip' doc='Accept Iuh connections on local interface' /> + <param name='A.B.C.D' doc='Local interface IP address (default: 0.0.0.0)' /> + </params> + </command> + <command id='local-port <1-65535>'> + <params> + <param name='local-port' doc='Accept Iuh connections on local port' /> + <param name='<1-65535>' doc='Local interface port (default: 29169)' /> + </params> + </command> + <command id='hnbap-allow-tmsi (0|1)'> + <params> + <param name='hnbap-allow-tmsi' doc='Allow HNBAP UE Register messages with TMSI or PTMSI identity' /> + <param name='0' doc='Only accept IMSI identity, reject TMSI or PTMSI' /> + <param name='1' doc='Accept IMSI, TMSI or PTMSI as UE identity' /> + </params> + </command> + </node> + <node id='config-hnbgw-iucs'> + <name>config-hnbgw-iucs</name> + <command id='remote-addr NAME'> + <params> + <param name='remote-addr' doc='SCCP address to send IuCS to (MSC)' /> + <param name='NAME' doc='SCCP address book entry name (see 'cs7-instance')' /> + </params> + </command> + </node> + <node id='config-hnbgw-iups'> + <name>config-hnbgw-iups</name> + <command id='remote-addr NAME'> + <params> + <param name='remote-addr' doc='SCCP address to send IuPS to (SGSN)' /> + <param name='NAME' doc='SCCP address book entry name (see 'cs7-instance')' /> + </params> + </command> + </node> +</vtydoc> |