Osmostp Vty Reference
Osmostp Vty Reference
Copyright © 2012-2017
COLLABORATORS
TITLE :
REVISION HISTORY
Contents
1 VTY reference 1
1.1 Common Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.1 end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.2 exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.3 help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.4 list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.5 show running-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.6 write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.7 write file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.8 write memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.9 write terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.1 enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.2 logging color (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.3 logging disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.4 logging enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.5 logging filter all (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.6 logging level (lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loa... . . . . . . . . . . . . . . . 6
1.2.7 logging level force-all (debug|info|notice|error|fatal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.2.8 logging level set-all (debug|info|notice|error|fatal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2.9 logging print category (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2.10 logging print category-hex (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2.11 logging print extended-timestamp (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2.12 logging print file (0|1|basename) [last] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.2.13 logging print level (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.2.14 logging set-log-mask MASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.2.15 logging timestamp (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.2.16 no logging level force-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.2.17 show alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.2.18 show asciidoc counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
OsmoSTP VTY Reference v
1.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.4.1 banner motd default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.4.2 banner motd file [FILE] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.4.3 cs7 instance <0-15> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.4.4 enable password (8|) WORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.4.5 enable password LINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.4.6 hostname WORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.4.7 line vty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.4.8 log alarms <2-32700> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.4.9 log file .FILENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.4.10 log gsmtap [HOSTNAME] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.4.11 log stderr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.4.12 log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp) . . . . . . . . . . . . . . . . . . . . . . . . 49
1.4.13 log syslog local <0-7> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.4.14 no banner motd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.4.15 no enable password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.4.16 no hostname [HOSTNAME] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.4.17 no log alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.4.18 no log file .FILENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.4.19 no log stderr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.4.20 no log syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.4.21 no service advanced-vty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.4.22 no service terminal-length [<0-512>] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.4.23 no stats reporter log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.4.24 no stats reporter statsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.4.25 password (8|) WORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
1.4.26 password LINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
1.4.27 service advanced-vty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
1.4.28 service terminal-length <0-512> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.4.29 show history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.4.30 stats interval <1-65535> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.4.31 stats reporter log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.4.32 stats reporter statsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.5 config-log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.5.1 logging color (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.5.2 logging filter all (0|1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.5.3 logging level (lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loa... . . . . . . . . . . . . . . . 57
1.5.4 logging level force-all (debug|info|notice|error|fatal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
1.5.5 logging level set-all (debug|info|notice|error|fatal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
OsmoSTP VTY Reference viii
List of Tables
Chapter 1
VTY reference
The Virtual Tele Type (VTY) has the concept of nodes and commands. This chapter lists all nodes and the commands that are
available within the node. Each command can consist out of several words followed by a variable number of parameters. There
are common patterns for the parameters, these include IPv4 addresses, number ranges, a word, a line of text and choice. The
following will explain the commonly used patterns.
The application is configured through the VTY. For configuring a system one needs to enter the enable node and then enter the
configure terminal command. Then the configuration can be made according to the available commands. After the system has
been configured one can use the write command to write the new configuration to the configuration file. The new file will be
used after the application has been restarted.
The following table lists the TCP port numbers of the VTY for the various Osmocom GSM related programs as used on sysmocom
products:
These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.
OsmoSTP VTY Reference 2 / 86
1.1.1 end
Command
end
Parameters
end
End current mode and change to enable mode.
1.1.2 exit
Command
exit
Parameters
exit
Exit current mode and down to previous mode
1.1.3 help
Command
help
Parameters
help
Description of the interactive help system
1.1.4 list
Command
list
Parameters
list
Print command list
OsmoSTP VTY Reference 3 / 86
Command
show running-config
Parameters
show
Show running system information
running-config
running configuration
1.1.6 write
Command
write
Parameters
write
Write running configuration to memory, network, or terminal
Command
write file
Parameters
write
Write running configuration to memory, network, or terminal
file
Write to configuration file
Command
write memory
Parameters
write
Write running configuration to memory, network, or terminal
memory
Write configuration to the file (same as write file)
OsmoSTP VTY Reference 4 / 86
Command
write terminal
Parameters
write
Write running configuration to memory, network, or terminal
terminal
Write to terminal
1.2 view
The view node is the default node when connecting to the VTY interface. This node does not require any additional permission
and allows to introspect the application.
1.2.1 enable
Command
enable
Parameters
enable
Turn on privileged mode command
Command
logging color (0|1)
Parameters
logging
Configure logging
color
Configure color-printing for log messages
0
Don’t use color for printing messages
1
Use color for printing messages
OsmoSTP VTY Reference 5 / 86
Command
logging disable
Parameters
logging
Configure logging
disable
Disables logging to this vty
This command is required to make logging commands available on the telnet VTY.
Command
logging enable
Parameters
logging
Configure logging
enable
Enables logging to this vty
Disable/enable general log output on a given target. Typically, ’logging filter all 1’ allows to see the usual log output on a given
target. Setting to ’0’ can be useful when logging to the telnet VTY console: mute all log output to allow typing VTY commands
on the telnet prompt without interference from log output; ’logging filter all 1’ then re-enables logging in the same log output
configuration as before. Some applications provide more specific filters, e.g. to log a given IMSI only. To employ such filters,
set ’logging filter all 0’ to disable general logging, and then enable a more specific filter instead.
Command
logging filter all (0|1)
Parameters
logging
Configure logging
filter
Filter log messages
all
Do you want to log all messages?
0
Only print messages matched by other filters
1
Bypass filter and print all messages
OsmoSTP VTY Reference 6 / 86
Command
logging level (lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7| ←-
lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
lglobal
Library-internal global log family
llapd
LAPD in libosmogsm
linp
A-bis Intput Subsystem
lmux
A-bis B-Subchannel TRAU Frame Multiplex
lmi
A-bis Input Driver for Signalling
lmib
A-bis Input Driver for B-Channels (voice)
lsms
Layer3 Short Message Service (SMS)
lctrl
Control Interface
lgtp
GPRS GTP library
lstats
Statistics messages and logging
lgsup
Generic Subscriber Update Protocol
loap
Osmocom Authentication Protocol
lss7
libosmo-sigtran Signalling System 7
lsccp
libosmo-sigtran SCCP Implementation
OsmoSTP VTY Reference 7 / 86
lsua
libosmo-sigtran SCCP User Adaptation
lm3ua
libosmo-sigtran MTP3 User Adaptation
lmgcp
libosmo-mgcp Media Gateway Control Protocol
ljibuf
libosmo-netif Jitter Buffer
lrspro
Remote SIM protocol
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging level force-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
force-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
OsmoSTP VTY Reference 8 / 86
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging level set-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
set-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging print category (0|1)
Parameters
logging
Configure logging
OsmoSTP VTY Reference 9 / 86
print
Log output settings
category
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem name
Command
logging print category-hex (0|1)
Parameters
logging
Configure logging
print
Log output settings
category-hex
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem nr in hex (’<000b>’)
Command
logging print extended-timestamp (0|1)
Parameters
logging
Configure logging
print
Log output settings
extended-timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn
OsmoSTP VTY Reference 10 / 86
Command
logging print file (0|1|basename) [last]
Parameters
logging
Configure logging
print
Log output settings
file
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with the source file and line
basename
Prefix each log message with the source file’s basename (strip leading paths) and line
[last]
Log source file info at the end of a log line. If omitted, log source file info just before the log text.
Command
logging print level (0|1)
Parameters
logging
Configure logging
print
Log output settings
level
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with the log level name
OsmoSTP VTY Reference 11 / 86
Command
logging set-log-mask MASK
Parameters
logging
Configure logging
set-log-mask
Set the logmask of this logging target
MASK
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
Command
logging timestamp (0|1)
Parameters
logging
Configure logging
timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp
Command
no logging level force-all
Parameters
no
Negate a command or set its defaults
logging
Configure logging
level
Set the log level for a specified category
force-all
Release any globally forced log level set with ’logging level force-all <level>’
OsmoSTP VTY Reference 12 / 86
Command
show alarms
Parameters
show
Show running system information
alarms
Show current logging configuration
Command
show asciidoc counters
Parameters
show
Show running system information
asciidoc
Asciidoc generation
counters
Generate table of all registered counters
Command
show cs7 (sua|m3ua|ipa) [<0-65534>]
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
[<0-65534>]
Port Number
OsmoSTP VTY Reference 13 / 86
Command
show cs7 instance <0-15> as (active|all|m3ua|sua)
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
as
Application Server (AS)
active
Display all active ASs
all
Display all ASs (default)
m3ua
Display all m3ua ASs
sua
Display all SUA ASs
Command
show cs7 instance <0-15> asp
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
asp
Application Server Process (ASP)
OsmoSTP VTY Reference 14 / 86
Command
show cs7 instance <0-15> route
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
route
Routing Table
Command
show cs7 instance <0-15> sccp addressbook
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
addressbook
List all SCCP addressbook entries
OsmoSTP VTY Reference 15 / 86
Command
show cs7 instance <0-15> sccp connections
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
connections
Show List of active SCCP connections
Command
show cs7 instance <0-15> sccp ssn <0-65535>
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
ssn
Find an SCCP User registered for the given SSN
<0-65535>
Subsystem Number (SSN)
OsmoSTP VTY Reference 16 / 86
Command
show cs7 instance <0-15> sccp timers
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signaling Connection Control Part
timers
Show List of SCCP timers
Command
show cs7 instance <0-15> sccp users
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
users
Show List of SCCP Users registered
OsmoSTP VTY Reference 17 / 86
Command
show cs7 instance <0-15> users
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
users
User Table
Command
show fsm NAME
Parameters
show
Show running system information
fsm
Show information about finite state machines
NAME
Display information about a single named finite state machine
Command
show fsm all
Parameters
show
Show running system information
fsm
Show information about finite state machines
all
Display a list of all registered finite state machines
OsmoSTP VTY Reference 18 / 86
Command
show fsm-instances NAME
Parameters
show
Show running system information
fsm-instances
Show information about finite state machine instances
NAME
Display a list of all FSM instances of the named finite state machine
Command
show fsm-instances all
Parameters
show
Show running system information
fsm-instances
Show information about finite state machine instances
all
Display a list of all FSM instances of all finite state machine
Command
show history
Parameters
show
Show running system information
history
Display the session command history
OsmoSTP VTY Reference 19 / 86
Command
show logging vty
Parameters
show
Show running system information
logging
Show current logging configuration
vty
Show current logging configuration for this vty
Command
show online-help
Parameters
show
Show running system information
online-help
Online help
Command
show rate-counters
Parameters
show
Show running system information
rate-counters
Show all rate counters
OsmoSTP VTY Reference 20 / 86
Command
show stats
Parameters
show
Show running system information
stats
Show statistical values
Command
show stats level (global|peer|subscriber)
Parameters
show
Show running system information
stats
Show statistical values
level
Set the maximum group level
global
Show global groups only
peer
Show global and network peer related groups
subscriber
Show global, peer, and subscriber groups
Command
show talloc-context (application|all) (full|brief|DEPTH)
Parameters
show
Show running system information
OsmoSTP VTY Reference 21 / 86
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
DEPTH
Specify required maximal depth value
Command
show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP
Parameters
show
Show running system information
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
DEPTH
Specify required maximal depth value
filter
Filter chunks using regular expression
REGEXP
Regular expression
OsmoSTP VTY Reference 22 / 86
Command
show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS
Parameters
show
Show running system information
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
DEPTH
Specify required maximal depth value
tree
Display only a specific memory chunk
ADDRESS
Chunk address (e.g. 0xdeadbeef)
Command
show version
Parameters
show
Show running system information
version
Displays program version
OsmoSTP VTY Reference 23 / 86
Command
terminal length <0-512>
Parameters
terminal
Set terminal line parameters
length
Set number of lines on a screen
<0-512>
Number of lines on screen (0 for no pausing)
Command
terminal no length
Parameters
terminal
Set terminal line parameters
no
Negate a command or set its defaults
length
Set number of lines on a screen
1.2.45 who
Command
who
Parameters
who
Display who is on vty
1.3 enable
The enable node is a privileged node, allowing to make changes to the configuration and to access further commands like
’configure’. All commands seen on the view node are also available here.
OsmoSTP VTY Reference 24 / 86
Command
configure terminal
Parameters
configure
Configuration from vty interface
terminal
Configuration terminal
Command
copy running-config startup-config
Parameters
copy
Copy configuration
running-config
Copy running config to...
startup-config
Copy running config to startup config (same as write file)
1.3.3 disable
Command
disable
Parameters
disable
Turn off privileged mode command
OsmoSTP VTY Reference 25 / 86
Command
logging color (0|1)
Parameters
logging
Configure logging
color
Configure color-printing for log messages
0
Don’t use color for printing messages
1
Use color for printing messages
Command
logging disable
Parameters
logging
Configure logging
disable
Disables logging to this vty
This command is required to make logging commands available on the telnet VTY.
Command
logging enable
Parameters
logging
Configure logging
enable
Enables logging to this vty
OsmoSTP VTY Reference 26 / 86
Disable/enable general log output on a given target. Typically, ’logging filter all 1’ allows to see the usual log output on a given
target. Setting to ’0’ can be useful when logging to the telnet VTY console: mute all log output to allow typing VTY commands
on the telnet prompt without interference from log output; ’logging filter all 1’ then re-enables logging in the same log output
configuration as before. Some applications provide more specific filters, e.g. to log a given IMSI only. To employ such filters,
set ’logging filter all 0’ to disable general logging, and then enable a more specific filter instead.
Command
logging filter all (0|1)
Parameters
logging
Configure logging
filter
Filter log messages
all
Do you want to log all messages?
0
Only print messages matched by other filters
1
Bypass filter and print all messages
Command
logging level (lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7| ←-
lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
lglobal
Library-internal global log family
llapd
LAPD in libosmogsm
linp
A-bis Intput Subsystem
OsmoSTP VTY Reference 27 / 86
lmux
A-bis B-Subchannel TRAU Frame Multiplex
lmi
A-bis Input Driver for Signalling
lmib
A-bis Input Driver for B-Channels (voice)
lsms
Layer3 Short Message Service (SMS)
lctrl
Control Interface
lgtp
GPRS GTP library
lstats
Statistics messages and logging
lgsup
Generic Subscriber Update Protocol
loap
Osmocom Authentication Protocol
lss7
libosmo-sigtran Signalling System 7
lsccp
libosmo-sigtran SCCP Implementation
lsua
libosmo-sigtran SCCP User Adaptation
lm3ua
libosmo-sigtran MTP3 User Adaptation
lmgcp
libosmo-mgcp Media Gateway Control Protocol
ljibuf
libosmo-netif Jitter Buffer
lrspro
Remote SIM protocol
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
OsmoSTP VTY Reference 28 / 86
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging level force-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
force-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging level set-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
OsmoSTP VTY Reference 29 / 86
set-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging print category (0|1)
Parameters
logging
Configure logging
print
Log output settings
category
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem name
Command
logging print category-hex (0|1)
Parameters
logging
Configure logging
OsmoSTP VTY Reference 30 / 86
print
Log output settings
category-hex
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem nr in hex (’<000b>’)
Command
logging print extended-timestamp (0|1)
Parameters
logging
Configure logging
print
Log output settings
extended-timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn
Command
logging print file (0|1|basename) [last]
Parameters
logging
Configure logging
print
Log output settings
file
Configure log message
OsmoSTP VTY Reference 31 / 86
0
Don’t prefix each log message
1
Prefix each log message with the source file and line
basename
Prefix each log message with the source file’s basename (strip leading paths) and line
[last]
Log source file info at the end of a log line. If omitted, log source file info just before the log text.
Command
logging print level (0|1)
Parameters
logging
Configure logging
print
Log output settings
level
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with the log level name
Command
logging set-log-mask MASK
Parameters
logging
Configure logging
set-log-mask
Set the logmask of this logging target
MASK
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
OsmoSTP VTY Reference 32 / 86
Command
logging timestamp (0|1)
Parameters
logging
Configure logging
timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp
Command
no logging level force-all
Parameters
no
Negate a command or set its defaults
logging
Configure logging
level
Set the log level for a specified category
force-all
Release any globally forced log level set with ’logging level force-all <level>’
Command
show alarms
Parameters
show
Show running system information
alarms
Show current logging configuration
OsmoSTP VTY Reference 33 / 86
Command
show asciidoc counters
Parameters
show
Show running system information
asciidoc
Asciidoc generation
counters
Generate table of all registered counters
Command
show cs7 (sua|m3ua|ipa) [<0-65534>]
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
[<0-65534>]
Port Number
Command
show cs7 instance <0-15> as (active|all|m3ua|sua)
Parameters
OsmoSTP VTY Reference 34 / 86
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
as
Application Server (AS)
active
Display all active ASs
all
Display all ASs (default)
m3ua
Display all m3ua ASs
sua
Display all SUA ASs
Command
show cs7 instance <0-15> asp
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
asp
Application Server Process (ASP)
OsmoSTP VTY Reference 35 / 86
Command
show cs7 instance <0-15> route
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
route
Routing Table
Command
show cs7 instance <0-15> sccp addressbook
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
addressbook
List all SCCP addressbook entries
OsmoSTP VTY Reference 36 / 86
Command
show cs7 instance <0-15> sccp connections
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
connections
Show List of active SCCP connections
Command
show cs7 instance <0-15> sccp ssn <0-65535>
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
ssn
Find an SCCP User registered for the given SSN
<0-65535>
Subsystem Number (SSN)
OsmoSTP VTY Reference 37 / 86
Command
show cs7 instance <0-15> sccp timers
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signaling Connection Control Part
timers
Show List of SCCP timers
Command
show cs7 instance <0-15> sccp users
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
sccp
Signalling Connection Control Part
users
Show List of SCCP Users registered
OsmoSTP VTY Reference 38 / 86
Command
show cs7 instance <0-15> users
Parameters
show
Show running system information
cs7
ITU-T Signaling System 7
instance
An instance of the SS7 stack
<0-15>
An instance of the SS7 stack
users
User Table
Command
show fsm NAME
Parameters
show
Show running system information
fsm
Show information about finite state machines
NAME
Display information about a single named finite state machine
Command
show fsm all
Parameters
show
Show running system information
fsm
Show information about finite state machines
all
Display a list of all registered finite state machines
OsmoSTP VTY Reference 39 / 86
Command
show fsm-instances NAME
Parameters
show
Show running system information
fsm-instances
Show information about finite state machine instances
NAME
Display a list of all FSM instances of the named finite state machine
Command
show fsm-instances all
Parameters
show
Show running system information
fsm-instances
Show information about finite state machine instances
all
Display a list of all FSM instances of all finite state machine
Command
show history
Parameters
show
Show running system information
history
Display the session command history
OsmoSTP VTY Reference 40 / 86
Command
show logging vty
Parameters
show
Show running system information
logging
Show current logging configuration
vty
Show current logging configuration for this vty
Command
show online-help
Parameters
show
Show running system information
online-help
Online help
Command
show rate-counters
Parameters
show
Show running system information
rate-counters
Show all rate counters
OsmoSTP VTY Reference 41 / 86
Command
show startup-config
Parameters
show
Show running system information
startup-config
Contentes of startup configuration
Command
show stats
Parameters
show
Show running system information
stats
Show statistical values
Command
show stats level (global|peer|subscriber)
Parameters
show
Show running system information
stats
Show statistical values
level
Set the maximum group level
global
Show global groups only
peer
Show global and network peer related groups
subscriber
Show global, peer, and subscriber groups
OsmoSTP VTY Reference 42 / 86
Command
show talloc-context (application|all) (full|brief|DEPTH)
Parameters
show
Show running system information
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
DEPTH
Specify required maximal depth value
Command
show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP
Parameters
show
Show running system information
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
OsmoSTP VTY Reference 43 / 86
DEPTH
Specify required maximal depth value
filter
Filter chunks using regular expression
REGEXP
Regular expression
Command
show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS
Parameters
show
Show running system information
talloc-context
Show talloc memory hierarchy
application
Application’s context
all
All contexts, if NULL-context tracking is enabled
full
Display a full talloc memory hierarchy
brief
Display a brief talloc memory hierarchy
DEPTH
Specify required maximal depth value
tree
Display only a specific memory chunk
ADDRESS
Chunk address (e.g. 0xdeadbeef)
Command
show version
Parameters
show
Show running system information
version
Displays program version
OsmoSTP VTY Reference 44 / 86
Command
terminal length <0-512>
Parameters
terminal
Set terminal line parameters
length
Set number of lines on a screen
<0-512>
Number of lines on screen (0 for no pausing)
Command
terminal monitor
Parameters
terminal
Set terminal line parameters
monitor
Copy debug output to the current terminal line
Command
terminal no length
Parameters
terminal
Set terminal line parameters
no
Negate a command or set its defaults
length
Set number of lines on a screen
OsmoSTP VTY Reference 45 / 86
Command
terminal no monitor
Parameters
terminal
Set terminal line parameters
no
Negate a command or set its defaults
monitor
Copy debug output to the current terminal line
1.3.50 who
Command
who
Parameters
who
Display who is on vty
1.4 config
The config node is the root for all configuration commands, which are identical to the config file format. Changes made on the
telnet VTY can be made persistent with the ’write file’ command.
Command
banner motd default
Parameters
banner
Set banner string
motd
Strings for motd
default
Default string
OsmoSTP VTY Reference 46 / 86
Command
banner motd file [FILE]
Parameters
banner
Set banner
motd
Banner for motd
file
Banner from a file
[FILE]
Filename
Command
cs7 instance <0-15>
Parameters
cs7
ITU-T Signaling System 7
instance
Configure a SS7 Instance
<0-15>
An instance of the SS7 stack
Command
enable password (8|) WORD
Parameters
enable
Modify enable password parameters
password
Assign the privileged level password
8
Specifies a HIDDEN password will follow
dummy string
WORD
The HIDDEN ’enable’ password string
OsmoSTP VTY Reference 47 / 86
Command
enable password LINE
Parameters
enable
Modify enable password parameters
password
Assign the privileged level password
LINE
The UNENCRYPTED (cleartext) ’enable’ password
Command
hostname WORD
Parameters
hostname
Set system’s network name
WORD
This system’s network name
Command
line vty
Parameters
line
Configure a terminal line
vty
Virtual terminal
OsmoSTP VTY Reference 48 / 86
Command
log alarms <2-32700>
Parameters
log
Configure logging sub-system
alarms
Logging alarms to osmo_strrb
<2-32700>
Maximum number of messages to log
Command
log file .FILENAME
Parameters
log
Configure logging sub-system
file
Logging to text file
.FILENAME
Filename
Command
log gsmtap [HOSTNAME]
Parameters
log
Configure logging sub-system
gsmtap
Logging via GSMTAP
[HOSTNAME]
Host name to send the GSMTAP logging to (UDP port 4729)
OsmoSTP VTY Reference 49 / 86
Command
log stderr
Parameters
log
Configure logging sub-system
stderr
Logging via STDERR of the process
Command
log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)
Parameters
log
Configure logging sub-system
syslog
Logging via syslog
authpriv
Security/authorization messages facility
cron
Clock daemon (cron/at) facility
daemon
General system daemon facility
ftp
Ftp daemon facility
lpr
Line printer facility
mail
Mail facility
news
News facility
user
Generic facility
uucp
UUCP facility
OsmoSTP VTY Reference 50 / 86
Command
log syslog local <0-7>
Parameters
log
Configure logging sub-system
syslog
Logging via syslog
local
Syslog LOCAL facility
<0-7>
Local facility number
Command
no banner motd
Parameters
no
Negate a command or set its defaults
banner
Set banner string
motd
Strings for motd
Command
no enable password
Parameters
no
Negate a command or set its defaults
enable
Modify enable password parameters
password
Assign the privileged level password
OsmoSTP VTY Reference 51 / 86
Command
no hostname [HOSTNAME]
Parameters
no
Negate a command or set its defaults
hostname
Reset system’s network name
[HOSTNAME]
Host name of this router
Command
no log alarms
Parameters
no
Negate a command or set its defaults
log
Configure logging sub-system
alarms
Logging alarms to osmo_strrb
Command
no log file .FILENAME
Parameters
no
Negate a command or set its defaults
log
Configure logging sub-system
file
Logging to text file
.FILENAME
Filename
OsmoSTP VTY Reference 52 / 86
Command
no log stderr
Parameters
no
Negate a command or set its defaults
log
Configure logging sub-system
stderr
Logging via STDERR of the process
Command
no log syslog
Parameters
no
Negate a command or set its defaults
log
Configure logging sub-system
syslog
Logging via syslog
Command
no service advanced-vty
Parameters
no
Negate a command or set its defaults
service
Set up miscellaneous service
advanced-vty
Enable advanced mode vty interface
OsmoSTP VTY Reference 53 / 86
Command
no service terminal-length [<0-512>]
Parameters
no
Negate a command or set its defaults
service
Set up miscellaneous service
terminal-length
System wide terminal length configuration
[<0-512>]
Number of lines of VTY (0 means no line control)
Command
no stats reporter log
Parameters
no
Negate a command or set its defaults
stats
Configure stats sub-system
reporter
Configure a stats reporter
log
Report to the logger
Command
no stats reporter statsd
Parameters
no
Negate a command or set its defaults
OsmoSTP VTY Reference 54 / 86
stats
Configure stats sub-system
reporter
Configure a stats reporter
statsd
Report to a STATSD server
Command
password (8|) WORD
Parameters
password
Assign the terminal connection password
8
Specifies a HIDDEN password will follow
dummy string
WORD
The HIDDEN line password string
Command
password LINE
Parameters
password
Assign the terminal connection password
LINE
The UNENCRYPTED (cleartext) line password
Command
service advanced-vty
Parameters
service
Set up miscellaneous service
advanced-vty
Enable advanced mode vty interface
OsmoSTP VTY Reference 55 / 86
Command
service terminal-length <0-512>
Parameters
service
Set up miscellaneous service
terminal-length
System wide terminal length configuration
<0-512>
Number of lines of VTY (0 means no line control)
Command
show history
Parameters
show
Show running system information
history
Display the session command history
Command
stats interval <1-65535>
Parameters
stats
Configure stats sub-system
interval
Set the reporting interval
<1-65535>
Interval in seconds
OsmoSTP VTY Reference 56 / 86
Command
stats reporter log
Parameters
stats
Configure stats sub-system
reporter
Configure a stats reporter
log
Report to the logger
Command
stats reporter statsd
Parameters
stats
Configure stats sub-system
reporter
Configure a stats reporter
statsd
Report to a STATSD server
1.5 config-log
The log node is commonly available in all Osmocom programs and allows configuring logging to stderr and/or log files, including
logging category and level filtering as well as output formatting options. Note that the ’logging enable’ command is required to
make logging commands available on the telnet VTY.
Command
logging color (0|1)
Parameters
OsmoSTP VTY Reference 57 / 86
logging
Configure logging
color
Configure color-printing for log messages
0
Don’t use color for printing messages
1
Use color for printing messages
Disable/enable general log output on a given target. Typically, ’logging filter all 1’ allows to see the usual log output on a given
target. Setting to ’0’ can be useful when logging to the telnet VTY console: mute all log output to allow typing VTY commands
on the telnet prompt without interference from log output; ’logging filter all 1’ then re-enables logging in the same log output
configuration as before. Some applications provide more specific filters, e.g. to log a given IMSI only. To employ such filters,
set ’logging filter all 0’ to disable general logging, and then enable a more specific filter instead.
Command
logging filter all (0|1)
Parameters
logging
Configure logging
filter
Filter log messages
all
Do you want to log all messages?
0
Only print messages matched by other filters
1
Bypass filter and print all messages
Command
logging level (lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7| ←-
lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
OsmoSTP VTY Reference 58 / 86
level
Set the log level for a specified category
lglobal
Library-internal global log family
llapd
LAPD in libosmogsm
linp
A-bis Intput Subsystem
lmux
A-bis B-Subchannel TRAU Frame Multiplex
lmi
A-bis Input Driver for Signalling
lmib
A-bis Input Driver for B-Channels (voice)
lsms
Layer3 Short Message Service (SMS)
lctrl
Control Interface
lgtp
GPRS GTP library
lstats
Statistics messages and logging
lgsup
Generic Subscriber Update Protocol
loap
Osmocom Authentication Protocol
lss7
libosmo-sigtran Signalling System 7
lsccp
libosmo-sigtran SCCP Implementation
lsua
libosmo-sigtran SCCP User Adaptation
lm3ua
libosmo-sigtran MTP3 User Adaptation
lmgcp
libosmo-mgcp Media Gateway Control Protocol
ljibuf
libosmo-netif Jitter Buffer
OsmoSTP VTY Reference 59 / 86
lrspro
Remote SIM protocol
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging level force-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
force-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
OsmoSTP VTY Reference 60 / 86
Command
logging level set-all (debug|info|notice|error|fatal)
Parameters
logging
Configure logging
level
Set the log level for a specified category
set-all
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.
debug
Log debug messages and higher levels
info
Log informational messages and higher levels
notice
Log noticeable messages and higher levels
error
Log error messages and higher levels
fatal
Log only fatal messages
Command
logging print category (0|1)
Parameters
logging
Configure logging
print
Log output settings
category
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem name
OsmoSTP VTY Reference 61 / 86
Command
logging print category-hex (0|1)
Parameters
logging
Configure logging
print
Log output settings
category-hex
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with category/subsystem nr in hex (’<000b>’)
Command
logging print extended-timestamp (0|1)
Parameters
logging
Configure logging
print
Log output settings
extended-timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn
OsmoSTP VTY Reference 62 / 86
Command
logging print file (0|1|basename) [last]
Parameters
logging
Configure logging
print
Log output settings
file
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with the source file and line
basename
Prefix each log message with the source file’s basename (strip leading paths) and line
[last]
Log source file info at the end of a log line. If omitted, log source file info just before the log text.
Command
logging print level (0|1)
Parameters
logging
Configure logging
print
Log output settings
level
Configure log message
0
Don’t prefix each log message
1
Prefix each log message with the log level name
OsmoSTP VTY Reference 63 / 86
Command
logging timestamp (0|1)
Parameters
logging
Configure logging
timestamp
Configure log message timestamping
0
Don’t prefix each log message
1
Prefix each log message with current timestamp
Command
no logging level force-all
Parameters
no
Negate a command or set its defaults
logging
Configure logging
level
Set the log level for a specified category
force-all
Release any globally forced log level set with ’logging level force-all <level>’
1.6 config-stats
1.6.1 disable
Command
disable
Parameters
disable
Disable the reporter
OsmoSTP VTY Reference 64 / 86
1.6.2 enable
Command
enable
Parameters
enable
Enable the reporter
Command
level (global|peer|subscriber)
Parameters
level
Set the maximum group level
global
Report global groups only
peer
Report global and network peer related groups
subscriber
Report global, peer, and subscriber groups
Command
local-ip ADDR
Parameters
local-ip
Set the IP address to which we bind locally
ADDR
IP Address
OsmoSTP VTY Reference 65 / 86
Command
mtu <100-65535>
Parameters
mtu
Set the maximum packet size
<100-65535>
Size in byte
1.6.6 no local-ip
Command
no local-ip
Parameters
no
Negate a command or set its defaults
local-ip
Set the IP address to which we bind locally
1.6.7 no mtu
Command
no mtu
Parameters
no
Negate a command or set its defaults
mtu
Set the maximum packet size
1.6.8 no prefix
Command
no prefix
Parameters
no
Negate a command or set its defaults
prefix
Set the item name prefix
OsmoSTP VTY Reference 66 / 86
Command
prefix PREFIX
Parameters
prefix
Set the item name prefix
PREFIX
The prefix string
Command
remote-ip ADDR
Parameters
remote-ip
Set the remote IP address to which we connect
ADDR
IP Address
Command
remote-port <1-65535>
Parameters
remote-port
Set the remote port to which we connect
<1-65535>
Remote port number
OsmoSTP VTY Reference 67 / 86
1.7 config-line
Command
bind A.B.C.D [<0-65535>]
Parameters
bind
Accept VTY telnet connections on local interface
A.B.C.D
Local interface IP address (default: 127.0.0.1)
[<0-65535>]
Local TCP port number
1.7.2 login
Command
login
Parameters
login
Enable password checking
1.7.3 no login
Command
no login
Parameters
no
Negate a command or set its defaults
login
Enable password checking
OsmoSTP VTY Reference 68 / 86
1.8 config-cs7
Command
as NAME (sua|m3ua|ipa)
Parameters
as
Configure an Application Server
NAME
Name of the Application Server
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
Command
asp NAME <0-65535> <0-65535> (sua|m3ua|ipa)
Parameters
asp
Configure Application Server Process
NAME
Name of ASP
<0-65535>
Remote SCTP port number
<0-65535>
Local SCTP port number
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
OsmoSTP VTY Reference 69 / 86
Command
description .TEXT
Parameters
description
Save human-readable description of the object
.TEXT
Text until the end of the line
Command
listen (sua|m3ua|ipa) <0-65534>
Parameters
listen
Configure/Enable xUA Listener
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
<0-65534>
SCTP Port number
Command
network-indicator (international | national | reserved | spare)
Parameters
network-indicator
Configure the Network Indicator
international
International Network
OsmoSTP VTY Reference 70 / 86
national
National Network
reserved
Reserved Network
spare
Spare Network
1.8.6 no as NAME
Command
no as NAME
Parameters
no
Negate a command or set its defaults
as
Disable Application Server
NAME
Name of AS
Command
no asp NAME
Parameters
no
Negate a command or set its defaults
asp
Disable Application Server Process
NAME
Name of ASP
OsmoSTP VTY Reference 71 / 86
Command
no listen (sua|m3ua|ipa) <0-65534>
Parameters
no
Negate a command or set its defaults
listen
Disable xUA Listener on given SCTP Port
sua
SCCP User Adaptation
m3ua
MTP3 User Adaptation
ipa
IPA Multiplex (SCCP Lite)
<0-65534>
SCTP Port number
Command
no sccp-address NAME
Parameters
no
Negate a command or set its defaults
sccp-address
Delete an SCCP addressbook entry
NAME
Name of the SCCP Address
Command
point-code POINT_CODE
Parameters
point-code
Configure the local Point Code
POINT_CODE
Point Code
OsmoSTP VTY Reference 72 / 86
Command
point-code delimiter (default|dash)
Parameters
point-code
Point Code
delimiter
Configure Point Code Delimiter
default
Use dot as delimiter
dash
User dash as delimiter
Command
point-code format <1-24> [<1-23>] [<1-22>]
Parameters
point-code
Point Code
format
Configure Point Code Format
<1-24>
Length of first PC component
[<1-23>]
Length of second PC component
[<1-22>]
Length of third PC component
Command
point-code format default
Parameters
OsmoSTP VTY Reference 73 / 86
point-code
Point Code
format
Configure Point Code Format
default
Default Point Code Format (3.8.3)
Command
route-table system
Parameters
route-table
Specify the name of the route table
system
Name of the route table
Command
sccp-address NAME
Parameters
sccp-address
Create/Modify an SCCP addressbook entry
NAME
Name of the SCCP Address
Command
sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) <1-999999>
Parameters
sccp-timer
Configure SCCP timer values, see ITU-T Q.714
conn_est
Waiting for connection confirm message, 1 to 2 minutes (default: 60)
OsmoSTP VTY Reference 74 / 86
ias
Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)
iar
Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)
rel
Waiting for release complete message, 10 to 20 seconds (default: 10)
repeat_rel
Waiting for release complete message; or to repeat sending released message after the initial expiry, 10 to 20 seconds
(default: 10)
int
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)
guard
Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes
(default: 1380)
reset
Waiting to release temporary connection section or alert maintenance function after reset request message is sent, 10 to 20
seconds (default: 10)
reassembly
Waiting to receive all the segments of the remaining segments, single segmented message after receiving the first segment,
10 to 20 seconds (default: 10)
<1-999999>
Timer value, in seconds
Command
xua rkm routing-key-allocation (static-only|dynamic-permitted)
Parameters
xua
SIGTRAN xxxUA related
rkm
Routing Key Management
routing-key-allocation
Routing Key Management Allocation Policy
static-only
Only static (pre-confgured) Routing Keys permitted
dynamic-permitted
Dynamically allocate Routing Keys for what ASPs request
OsmoSTP VTY Reference 75 / 86
1.9 config-cs7-as
Command
asp NAME
Parameters
asp
Specify that a given ASP is part of this AS
NAME
Name of ASP to be added to AS
Command
description .TEXT
Parameters
description
Save human-readable description of the object
.TEXT
Text until the end of the line
Command
no asp NAME
Parameters
no
Negate a command or set its defaults
asp
Specify ASP to be removed from this AS
NAME
Name of ASP to be removed
OsmoSTP VTY Reference 76 / 86
Command
point-code override dpc PC
Parameters
point-code
Point Code Specific Features
override
Override (force) a point-code to hard-coded value
dpc
Override Source Point Code
PC
Override Destination Point Code
Command
qos-class <0-255>
Parameters
qos-class
Specity QoS Class of AS
<0-255>
QoS Class of AS
Command
recovery-timeout <1-2000>
Parameters
recovery-timeout
Specifies the recovery timeout value in milliseconds
<1-2000>
Recovery Timeout in Milliseconds
OsmoSTP VTY Reference 77 / 86
Command
routing-key RCONTEXT DPC
Parameters
routing-key
Define a routing key
RCONTEXT
Routing context number
DPC
Destination Point Code
Command
routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)
Parameters
routing-key
Define a routing key
RCONTEXT
Routing context number
DPC
Destination Point Code
si
Match on Service Indicator
aal2
ATM Adaption Layer 2
bicc
Bearer Independent Call Control
b-isup
Broadband ISDN User Part
h248
H.248
isup
ISDN User Part
sat-isup
Sattelite ISDN User Part
OsmoSTP VTY Reference 78 / 86
sccp
Signalling Connection Control Part
tup
Telephony User Part
Command
routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN
Parameters
routing-key
Define a routing key
RCONTEXT
Routing context number
DPC
Destination Point Code
si
Match on Service Indicator
aal2
ATM Adaption Layer 2
bicc
Bearer Independent Call Control
b-isup
Broadband ISDN User Part
h248
H.248
isup
ISDN User Part
sat-isup
Sattelite ISDN User Part
sccp
Signalling Connection Control Part
tup
Telephony User Part
ssn
Match on Sub-System Number
SSN
Sub-System Number to match on
OsmoSTP VTY Reference 79 / 86
Command
routing-key RCONTEXT DPC ssn SSN
Parameters
routing-key
Define a routing key
RCONTEXT
Routing context number
DPC
Destination Point Code
ssn
Match on Sub-System Number
SSN
Sub-System Number to match on
Command
traffic-mode (broadcast | loadshare | roundrobin | override)
Parameters
traffic-mode
Specifies traffic mode of operation of the ASP within the AS
broadcast
Broadcast to all ASP within AS
loadshare
Share Load among all ASP within AS
roundrobin
Round-Robin between all ASP within AS
override
Override
OsmoSTP VTY Reference 80 / 86
1.10 config-cs7-asp
1.10.1 block
Command
block
Parameters
block
Allows a SCTP Association with ASP, but doesn’t let it become active
Command
description .TEXT
Parameters
description
Save human-readable description of the object
.TEXT
Text until the end of the line
Command
local-ip A.B.C.D
Parameters
local-ip
Specify Local IP Address from which to contact ASP
A.B.C.D
Local IP Address from which to contact of ASP
Command
qos-class <0-255>
Parameters
qos-class
Specify QoS Class of ASP
<0-255>
QoS Class of ASP
OsmoSTP VTY Reference 81 / 86
Command
remote-ip A.B.C.D
Parameters
remote-ip
Specify Remote IP Address of ASP
A.B.C.D
Remote IP Address of ASP
1.10.6 shutdown
Command
shutdown
Parameters
shutdown
Terminates SCTP association; New associations will be rejected
1.11 config-cs7-listen
Command
accept-asp-connections (pre-configured|dynamic-permitted)
Parameters
accept-asp-connections
Define what kind of ASP connections to accept
pre-configured
Accept only pre-confiugred ASPs (source IP/prt)
dynamic-permitted
Accept any connection and dynamically create an ASP definition
OsmoSTP VTY Reference 82 / 86
Command
local-ip A.B.C.D
Parameters
local-ip
Configure the Local IP Address for xUA
A.B.C.D
IP Address to use for XUA
1.12 config-cs7-rt
Command
description .TEXT
Parameters
description
Save human-readable description of the object
.TEXT
Text until the end of the line
Command
remove route POINT_CODE MASK
Parameters
remove
Remove a Route
route
Remove a Route
POINT_CODE
Destination Point Code
MASK
Point Code Mask
OsmoSTP VTY Reference 83 / 86
1.12.3 update route POINT_CODE MASK linkset LS_NAME [priority PRIO] [qos-class (CLASS|d...
Command
update route POINT_CODE MASK linkset LS_NAME [priority PRIO] [qos-class (CLASS|default) ←-
]
Parameters
update
Update the Route
route
Update the Route
POINT_CODE
Destination Point Code
MASK
Point Code Mask
linkset
Point Code Length
LS_NAME
Specify Destination Linkset
[priority
Linkset Name
PRIO]
Specify Priority
[qos-class
Priority
CLASS
Specify QoS Class
default
QoS Class
1.13 config-cs7-sccpaddr
1.13.1 global-title
Command
global-title
Parameters
global-title
Add/Modify Global Title
OsmoSTP VTY Reference 84 / 86
1.13.2 no global-title
Command
no global-title
Parameters
no
Negate a command or set its defaults
global-title
Remove Global Title
1.13.3 no point-code
Command
no point-code
Parameters
no
Negate a command or set its defaults
point-code
Remove point-code Number
1.13.4 no subsystem-number
Command
no subsystem-number
Parameters
no
Negate a command or set its defaults
subsystem-number
Remove Subsystem Number
Command
point-code POINT_CODE
Parameters
point-code
Add point-code Number
POINT_CODE
PC
OsmoSTP VTY Reference 85 / 86
Command
routing-indicator (GT|PC|IP)
Parameters
routing-indicator
Add Routing Indicator
GT
by global-title
PC
by point-code
IP
by ip-address
Command
subsystem-number <0-4294967295>
Parameters
subsystem-number
Add Subsystem Number
<0-4294967295>
SSN
1.14 config-cs7-sccpaddr-gt
Command
digits DIGITS
Parameters
digits
Set Global Title Digits
DIGITS
Number digits
OsmoSTP VTY Reference 86 / 86
Command
global-title-indicator <0-15>
Parameters
global-title-indicator
Set Global Title Indicator
<0-15>
GTI
Command
nature-of-address-indicator <0-127>
Parameters
nature-of-address-indicator
Set Global Title Nature of Address Indicator
<0-127>
NAI
Command
numbering-plan-indicator <0-15>
Parameters
numbering-plan-indicator
Set Global Title Numbering Plan Indicator
<0-15>
NPI
Command
translation-type <0-255>
Parameters
translation-type
Set Global Title Translation Type
<0-255>
TT