cellular-infrastructure
/
osmo-smlc
mirror of https://gerrit.osmocom.org/osmo-smlc
9
0
Fork 0
Code Issues Releases Wiki Activity

fix build of usermanual 

Change-Id: Ibbe52ee595d13292ac2f2ef2b3477263894ed75c
This commit is contained in:
Harald Welte 2020-08-23 20:29:20 +02:00
parent b6ebda3594
commit 97362c57bc
6 changed files with 903 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/manuals/Makefile.am
View File

@ -9,7 +9,7 @@ EXTRA_DIST = \
if BUILD_MANUALS
ASCIIDOC = osmosmlc-usermanual.adoc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
osmosmlc-usermanual.pdf: $(srcdir)/chapters/*.adoc $(srcdir)/chapters/*.dot
osmosmlc-usermanual.pdf: $(srcdir)/chapters/*.adoc #$(srcdir)/chapters/*.dot
VTY_REFERENCE = osmosmlc-vty-reference.xml

2
doc/manuals/osmosmlc-usermanual.adoc
View File

@ -26,8 +26,6 @@ include::./common/chapters/control_if.adoc[]
// include::{srcdir}/chapters/control.adoc[]
include::{srcdir}/chapters/osmux_bsc.adoc[]
include::./common/chapters/port_numbers.adoc[]
include::./common/chapters/bibliography.adoc[]

899
doc/manuals/vty/smlc_vty_reference.xml Normal file
View File

@ -0,0 +1,899 @@
<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 [PATH]'>
<params>
<param name='write' doc='Write running configuration to memory, network, or terminal' />
<param name='file' doc='Write to configuration file' />
<param name='[PATH]' doc='Set file path to store the config, or replace if already exists' />
</params>
</command>
<command id='write memory'>
<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='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 &lt;0-15&gt; 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='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
<param name='users' doc='User Table' />
</params>
</command>
<command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
<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='[&lt;0-65534&gt;]' doc='Port Number' />
</params>
</command>
<command id='show cs7 config'>
<params>
<param name='show' doc='Show running system information' />
<param name='cs7' doc='ITU-T Signaling System 7' />
<param name='config' doc='Currently running cs7 configuration' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
<param name='asp' doc='Application Server Process (ASP)' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
<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='&lt;0-15&gt;' 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='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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>
</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='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 &lt;0-15&gt; 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='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
<param name='users' doc='User Table' />
</params>
</command>
<command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
<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='[&lt;0-65534&gt;]' doc='Port Number' />
</params>
</command>
<command id='show cs7 config'>
<params>
<param name='show' doc='Show running system information' />
<param name='cs7' doc='ITU-T Signaling System 7' />
<param name='config' doc='Currently running cs7 configuration' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
<param name='asp' doc='Application Server Process (ASP)' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
<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='&lt;0-15&gt;' 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='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
</params>
</command>
<command id='show cs7 instance &lt;0-15&gt; 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='&lt;0-15&gt;' 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 &lt;0-15&gt; 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='&lt;0-15&gt;' 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>
</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='cs7 instance &lt;0-15&gt;'>
<params>
<param name='cs7' doc='ITU-T Signaling System 7' />
<param name='instance' doc='Configure a SS7 Instance' />
<param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
</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 [&lt;0-65535&gt;]'>
<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='[&lt;0-65535&gt;]' doc='Local TCP port number' />
</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-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 &lt;1-24&gt; [&lt;1-23&gt;] [&lt;1-22&gt;]'>
<params>
<param name='point-code' doc='Point Code' />
<param name='format' doc='Configure Point Code Format' />
<param name='&lt;1-24&gt;' doc='Length of first PC component' />
<param name='[&lt;1-23&gt;]' doc='Length of second PC component' />
<param name='[&lt;1-22&gt;]' 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 &lt;0-65535&gt; &lt;0-65535&gt; (sua|m3ua|ipa)'>
<params>
<param name='asp' doc='Configure Application Server Process' />
<param name='NAME' doc='Name of ASP' />
<param name='&lt;0-65535&gt;' doc='Remote SCTP port number' />
<param name='&lt;0-65535&gt;' 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) &lt;1-999999&gt;'>
<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='&lt;1-999999&gt;' 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='no traffic-mode'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
<param name='traffic-mode' doc='Remove explicit traffic mode of operation of this AS' />
</params>
</command>
<command id='recovery-timeout &lt;1-2000&gt;'>
<params>
<param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' />
<param name='&lt;1-2000&gt;' doc='Recovery Timeout in Milliseconds' />
</params>
</command>
<command id='qos-class &lt;0-255&gt;'>
<params>
<param name='qos-class' doc='Specity QoS Class of AS' />
<param name='&lt;0-255&gt;' 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>
<command id='point-code override patch-sccp (disabled|both)'>
<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='patch-sccp' doc='Patch point code values into SCCP called/calling address' />
<param name='disabled' doc='Don&apos;t patch any point codes into SCCP called/calling address' />
<param name='both' doc='Patch both origin and destination point codes into SCCP called/calling address' />
</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 &lt;0-255&gt;'>
<params>
<param name='qos-class' doc='Specify QoS Class of ASP' />
<param name='&lt;0-255&gt;' doc='QoS Class of ASP' />
</params>
</command>
<command id='role (sg|asp|ipsp)'>
<params>
<param name='role' doc='Specify the xUA role for this ASP' />
<param name='sg' doc='SG (Signaling Gateway)' />
<param name='asp' doc='ASP (Application Server Process)' />
<param name='ipsp' doc='IPSP (IP Signalling Point)' />
</params>
</command>
<command id='sctp-role (client|server)'>
<params>
<param name='sctp-role' doc='Specify the SCTP role for this ASP' />
<param name='client' doc='Operate as SCTP client; connect to a server' />
<param name='server' doc='Operate as SCTP server; wait for client connections' />
</params>
</command>
<command id='block'>
<params>
<param name='block' doc='Allows a SCTP Association with ASP, but doesn&apos;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 &lt;0-4294967295&gt;'>
<params>
<param name='subsystem-number' doc='Add Subsystem Number' />
<param name='&lt;0-4294967295&gt;' 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 &lt;0-15&gt;'>
<params>
<param name='global-title-indicator' doc='Set Global Title Indicator' />
<param name='&lt;0-15&gt;' doc='GTI' />
</params>
</command>
<command id='translation-type &lt;0-255&gt;'>
<params>
<param name='translation-type' doc='Set Global Title Translation Type' />
<param name='&lt;0-255&gt;' doc='TT' />
</params>
</command>
<command id='numbering-plan-indicator &lt;0-15&gt;'>
<params>
<param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' />
<param name='&lt;0-15&gt;' doc='NPI' />
</params>
</command>
<command id='nature-of-address-indicator &lt;0-127&gt;'>
<params>
<param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' />
<param name='&lt;0-127&gt;' 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>
</vtydoc>

3
tests/Makefile.am
View File

@ -24,6 +24,7 @@ EXTRA_DIST = \
$(srcdir)/package.m4 \
$(TESTSUITE) \
test_nodes.vty \
test_nodes.ctrl \
$(NULL)
TESTSUITE = $(srcdir)/testsuite
@ -60,7 +61,7 @@ ctrl-test:
-rm -f $(CTRL_TEST_DB)
osmo_verify_transcript_ctrl.py -v \
-p 4272 \
-r "$(top_builddir)/src/osmo-smlc/osmo-smlc -c $(top_srcdir)/doc/examples/osmo-smlc.cfg -l $(CTRL_TEST_DB)" \
-r "$(top_builddir)/src/osmo-smlc/osmo-smlc -c $(top_srcdir)/doc/examples/osmo-smlc/osmo-smlc.cfg" \
$(U) $(srcdir)/*.ctrl
-rm -f $(CTRL_TEST_DB)
-rm $(CTRL_TEST_DB)-*

0
tests/test_nodes.ctrl Normal file
View File

2
tests/test_nodes.vty
View File

@ -1,3 +1,3 @@
OsmoSMLC> enable
OsmoSMLC#
OsmoSMLC# configure terminal
...