diff options
| author | Daniel Willmann <dwillmann@sysmocom.de> | 2019-06-19 13:23:21 +0200 |
|---|---|---|
| committer | Daniel Willmann <dwillmann@sysmocom.de> | 2019-07-18 20:41:07 +0200 |
| commit | 2e5fc99327d2cac24852db0af6085e08b649fdf5 (patch) | |
| tree | c81b81b1e6b2c9f3b7ae508ff223fd650bf6f561 | |
| parent | 50b60b33ccca54a2567ec044e2d1aa8c0eb4e2d6 (diff) | |
manuals: Generate vty/counter documentation for osmo-bscnat
Change-Id: Ice7f15192a57e2c964d07d364732af888972ba0f
Depends: I44bb395009582f5e1399f277e15203553c2dcf78 (docker-playground.git)
Depends: I52c3cb2cdcfb143e71ac2c1aa40bb466e41a0f5c (docker-playground.git)
Related: OS#1700
| -rw-r--r-- | manuals/OsmoBSCNAT/chapters/counters_generated.adoc | 52 | ||||
| -rw-r--r-- | manuals/OsmoBSCNAT/vty/nat_vty_reference.xml | 4350 | ||||
| -rwxr-xr-x | openbsc/doc/regen_doc.sh | 7 |
3 files changed, 2345 insertions, 2064 deletions
diff --git a/manuals/OsmoBSCNAT/chapters/counters_generated.adoc b/manuals/OsmoBSCNAT/chapters/counters_generated.adoc new file mode 100644 index 000000000..16aa72451 --- /dev/null +++ b/manuals/OsmoBSCNAT/chapters/counters_generated.adoc @@ -0,0 +1,52 @@ + +// autogenerated by show asciidoc counters +These counters and their description based on OsmoBSCNAT 1.3.0 (OsmoBSCNAT). + +=== Rate Counters + +// generating tables for rate_ctr_group +// rate_ctr_group table NAT Access-List Statistics +.nat:filter - NAT Access-List Statistics +[options="header"] +|=== +| Name | Reference | Description +| access-list:local-filter | <<nat:filter_access-list:local-filter>> | Rejected by rule for local +| access-list:global-filter | <<nat:filter_access-list:global-filter>> | Rejected by rule for global +|=== +// rate_ctr_group table NAT BSC Statistics +.nat:bsc - NAT BSC Statistics +[options="header"] +|=== +| Name | Reference | Description +| sccp:conn | <<nat:bsc_sccp:conn>> | SCCP Connections +| sccp:calls | <<nat:bsc_sccp:calls>> | SCCP Assignment Commands +| net:reconnects | <<nat:bsc_net:reconnects>> | Network reconnects +| dropped:sccp | <<nat:bsc_dropped:sccp>> | Dropped SCCP connections +| dropped:calls | <<nat:bsc_dropped:calls>> | Dropped active calls. +| rejected:cr | <<nat:bsc_rejected:cr>> | Rejected CR due filter +| rejected:msg | <<nat:bsc_rejected:msg>> | Rejected MSG due filter +| rejected:ill | <<nat:bsc_rejected:ill>> | Rejected due parse error +| conn:lu | <<nat:bsc_conn:lu>> | Conn Location Update +| conn:rq | <<nat:bsc_conn:rq>> | Conn CM Service Req +| conn:pag | <<nat:bsc_conn:pag>> | Conn Paging Response +| conn:ssa | <<nat:bsc_conn:ssa>> | Conn USSD +| conn:other | <<nat:bsc_conn:other>> | Conn Other +|=== +== Osmo Stat Items + +// generating tables for osmo_stat_items +== Osmo Counters + +// generating tables for osmo_counters +// ungrouped osmo_counters +.ungrouped osmo counters +[options="header"] +|=== +| Name | Reference | Description +| nat.sccp.conn | <<ungroup_counter_nat.sccp.conn>> | +| nat.sccp.calls | <<ungroup_counter_nat.sccp.calls>> | +| nat.bsc.conn | <<ungroup_counter_nat.bsc.conn>> | +| nat.bsc.auth_fail | <<ungroup_counter_nat.bsc.auth_fail>> | +| nat.msc.conn | <<ungroup_counter_nat.msc.conn>> | +| nat.ussd.conn | <<ungroup_counter_nat.ussd.conn>> | +|=== diff --git a/manuals/OsmoBSCNAT/vty/nat_vty_reference.xml b/manuals/OsmoBSCNAT/vty/nat_vty_reference.xml index 80fe08f35..3ed49038b 100644 --- a/manuals/OsmoBSCNAT/vty/nat_vty_reference.xml +++ b/manuals/OsmoBSCNAT/vty/nat_vty_reference.xml @@ -1,2061 +1,2289 @@ -<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
- <node id='0'>
- </node>
- <node id='1'>
- <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='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='enable'>
- <params>
- <param name='enable' doc='Turn on privileged mode command' />
- </params>
- </command>
- <command id='terminal length <0-512>'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='length' doc='Set number of lines on a screen' />
- <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' />
- </params>
- </command>
- <command id='terminal no length'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='length' doc='Set number of lines on a screen' />
- </params>
- </command>
- <command id='echo .MESSAGE'>
- <params>
- <param name='echo' doc='Echo a message back to the vty' />
- <param name='.MESSAGE' doc='The message to echo' />
- </params>
- </command>
- <command id='who'>
- <params>
- <param name='who' doc='Display who is on vty' />
- </params>
- </command>
- <command id='show history'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='history' doc='Display the session command history' />
- </params>
- </command>
- <command id='logging enable'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='enable' doc='Enables logging to this vty' />
- </params>
- </command>
- <command id='logging disable'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='disable' doc='Disables logging to this vty' />
- </params>
- </command>
- <command id='logging filter all (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='filter' doc='Filter log messages' />
- <param name='all' doc='Do you want to log all messages?' />
- <param name='0' doc='Only print messages matched by other filters' />
- <param name='1' doc='Bypass filter and print all messages' />
- </params>
- </command>
- <command id='logging color (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='color' doc='Configure color-printing for log messages' />
- <param name='0' doc='Don't use color for printing messages' />
- <param name='1' doc='Use color for printing messages' />
- </params>
- </command>
- <command id='logging timestamp (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='timestamp' doc='Configure log message timestamping' />
- <param name='0' doc='Don't prefix each log message' />
- <param name='1' doc='Prefix each log message with current timestamp' />
- </params>
- </command>
- <command id='logging set-log-mask MASK'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='set-log-mask' doc='Set the logmask of this logging target' />
- <param name='MASK' doc='The logmask to use' />
- </params>
- </command>
- <command id='logging set log mask MASK'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='set' doc='Decide which categories to output.' />
- <param name='log' doc='Log commands' />
- <param name='mask' doc='Mask commands' />
- <param name='MASK' doc='The logmask to use' />
- </params>
- </command>
- <command id='logging level (all|rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
- <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
- <param name='cc' doc='Layer3 Call Control (CC)' />
- <param name='mm' doc='Layer3 Mobility Management (MM)' />
- <param name='rr' doc='Layer3 Radio Resource (RR)' />
- <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' />
- <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' />
- <param name='mncc' doc='MNCC API for Call Control application' />
- <param name='pag' doc='Paging Subsystem' />
- <param name='meas' doc='Radio Measurement Processing' />
- <param name='sccp' doc='SCCP Protocol' />
- <param name='msc' doc='Mobile Switching Center' />
- <param name='mgcp' doc='Media Gateway Control Protocol' />
- <param name='ho' doc='Hand-Over' />
- <param name='db' doc='Database Layer' />
- <param name='ref' doc='Reference Counting' />
- <param name='gprs' doc='GPRS Packet Service' />
- <param name='ns' doc='GPRS Network Service (NS)' />
- <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
- <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
- <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
- <param name='nat' doc='GSM 08.08 NAT/Multiplexer' />
- <param name='ctrl' doc='Control interface' />
- <param name='smpp' doc='SMPP interface for external SMS apps' />
- <param name='lglobal' doc='Library-internal global log family' />
- <param name='llapd' doc='LAPD in libosmogsm' />
- <param name='linp' doc='A-bis Intput Subsystem' />
- <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
- <param name='lmi' doc='A-bis Input Driver for Signalling' />
- <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
- <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
- <param name='everything' doc='Log simply everything' />
- <param name='debug' doc='Log debug messages and higher levels' />
- <param name='info' doc='Log informational messages and higher levels' />
- <param name='notice' doc='Log noticable messages and higher levels' />
- <param name='error' doc='Log error messages and higher levels' />
- <param name='fatal' doc='Log only fatal messages' />
- </params>
- </command>
- <command id='show logging vty'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='logging' doc='Show current logging configuration' />
- <param name='vty' doc='Show current logging configuration for this vty' />
- </params>
- </command>
- <command id='show alarms'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='alarms' doc='Show current logging configuration' />
- </params>
- </command>
- <command id='show sccp connections'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='sccp' doc='Display information about SCCP' />
- <param name='connections' doc='All active connections' />
- </params>
- </command>
- <command id='show bsc connections'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='connections' doc='All active connections' />
- </params>
- </command>
- <command id='show bsc config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='config' doc='Configuration of BSCs' />
- </params>
- </command>
- <command id='show statistics [NR]'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='statistics' doc='Display network statistics' />
- <param name='[NR]' doc='Number of the BSC' />
- </params>
- </command>
- <command id='show statistics-by-lac <0-65535>'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='statistics-by-lac' doc='Display network statistics by lac' />
- <param name='<0-65535>' doc='The lac of the BSC' />
- </params>
- </command>
- <command id='close bsc connection BSC_NR'>
- <params>
- <param name='close' doc='Close' />
- <param name='bsc' doc='A-link' />
- <param name='connection' doc='Connection' />
- <param name='BSC_NR' doc='Identifier of the BSC' />
- </params>
- </command>
- <command id='show msc connection'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='msc' doc='MSC related information' />
- <param name='connection' doc='Status of the A-link connection' />
- </params>
- </command>
- <command id='test regex PATTERN STRING'>
- <params>
- <param name='test' doc='Test utilities' />
- <param name='regex' doc='Regexp testing' />
- <param name='PATTERN' doc='The regexp pattern' />
- <param name='STRING' doc='The string to match' />
- </params>
- </command>
- <command id='show bsc mgcp NR'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='mgcp' doc='MGCP related status' />
- <param name='NR' doc='Identifier of the BSC' />
- </params>
- </command>
- <command id='show access-list NAME'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='access-list' doc='IMSI access list' />
- <param name='NAME' doc='Name of the access list' />
- </params>
- </command>
- <command id='show imsi-black-list'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='imsi-black-list' doc='IMSIs barred from the network' />
- </params>
- </command>
- <command id='show prefix-tree'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='prefix-tree' doc='Prefix tree for number rewriting' />
- </params>
- </command>
- <command id='show ussd-connection'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='ussd-connection' doc='USSD connection related information' />
- </params>
- </command>
- <command id='show mgcp [stats]'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
- <param name='[stats]' doc='Include Statistics' />
- </params>
- </command>
- </node>
- <node id='2'>
- </node>
- <node id='3'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='disable'>
- <params>
- <param name='disable' doc='Turn off privileged mode command' />
- </params>
- </command>
- <command id='configure terminal'>
- <params>
- <param name='configure' doc='Configuration from vty interface' />
- <param name='terminal' doc='Configuration terminal' />
- </params>
- </command>
- <command id='copy running-config startup-config'>
- <params>
- <param name='copy' doc='Copy configuration' />
- <param name='running-config' doc='Copy running config to... ' />
- <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
- </params>
- </command>
- <command id='show startup-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='startup-config' doc='Contentes of startup configuration' />
- </params>
- </command>
- <command id='show version'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='version' doc='Displays program version' />
- </params>
- </command>
- <command id='show online-help'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='online-help' doc='Online help' />
- </params>
- </command>
- <command id='terminal length <0-512>'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='length' doc='Set number of lines on a screen' />
- <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' />
- </params>
- </command>
- <command id='terminal no length'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='length' doc='Set number of lines on a screen' />
- </params>
- </command>
- <command id='echo .MESSAGE'>
- <params>
- <param name='echo' doc='Echo a message back to the vty' />
- <param name='.MESSAGE' doc='The message to echo' />
- </params>
- </command>
- <command id='who'>
- <params>
- <param name='who' doc='Display who is on vty' />
- </params>
- </command>
- <command id='show history'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='history' doc='Display the session command history' />
- </params>
- </command>
- <command id='terminal monitor'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='monitor' doc='Copy debug output to the current terminal line' />
- </params>
- </command>
- <command id='terminal no monitor'>
- <params>
- <param name='terminal' doc='Set terminal line parameters' />
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='monitor' doc='Copy debug output to the current terminal line' />
- </params>
- </command>
- <command id='logging enable'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='enable' doc='Enables logging to this vty' />
- </params>
- </command>
- <command id='logging disable'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='disable' doc='Disables logging to this vty' />
- </params>
- </command>
- <command id='logging filter all (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='filter' doc='Filter log messages' />
- <param name='all' doc='Do you want to log all messages?' />
- <param name='0' doc='Only print messages matched by other filters' />
- <param name='1' doc='Bypass filter and print all messages' />
- </params>
- </command>
- <command id='logging color (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='color' doc='Configure color-printing for log messages' />
- <param name='0' doc='Don't use color for printing messages' />
- <param name='1' doc='Use color for printing messages' />
- </params>
- </command>
- <command id='logging timestamp (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='timestamp' doc='Configure log message timestamping' />
- <param name='0' doc='Don't prefix each log message' />
- <param name='1' doc='Prefix each log message with current timestamp' />
- </params>
- </command>
- <command id='logging set-log-mask MASK'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='set-log-mask' doc='Set the logmask of this logging target' />
- <param name='MASK' doc='The logmask to use' />
- </params>
- </command>
- <command id='logging set log mask MASK'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='set' doc='Decide which categories to output.' />
- <param name='log' doc='Log commands' />
- <param name='mask' doc='Mask commands' />
- <param name='MASK' doc='The logmask to use' />
- </params>
- </command>
- <command id='logging level (all|rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
- <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
- <param name='cc' doc='Layer3 Call Control (CC)' />
- <param name='mm' doc='Layer3 Mobility Management (MM)' />
- <param name='rr' doc='Layer3 Radio Resource (RR)' />
- <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' />
- <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' />
- <param name='mncc' doc='MNCC API for Call Control application' />
- <param name='pag' doc='Paging Subsystem' />
- <param name='meas' doc='Radio Measurement Processing' />
- <param name='sccp' doc='SCCP Protocol' />
- <param name='msc' doc='Mobile Switching Center' />
- <param name='mgcp' doc='Media Gateway Control Protocol' />
- <param name='ho' doc='Hand-Over' />
- <param name='db' doc='Database Layer' />
- <param name='ref' doc='Reference Counting' />
- <param name='gprs' doc='GPRS Packet Service' />
- <param name='ns' doc='GPRS Network Service (NS)' />
- <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
- <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
- <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
- <param name='nat' doc='GSM 08.08 NAT/Multiplexer' />
- <param name='ctrl' doc='Control interface' />
- <param name='smpp' doc='SMPP interface for external SMS apps' />
- <param name='lglobal' doc='Library-internal global log family' />
- <param name='llapd' doc='LAPD in libosmogsm' />
- <param name='linp' doc='A-bis Intput Subsystem' />
- <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
- <param name='lmi' doc='A-bis Input Driver for Signalling' />
- <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
- <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
- <param name='everything' doc='Log simply everything' />
- <param name='debug' doc='Log debug messages and higher levels' />
- <param name='info' doc='Log informational messages and higher levels' />
- <param name='notice' doc='Log noticable messages and higher levels' />
- <param name='error' doc='Log error messages and higher levels' />
- <param name='fatal' doc='Log only fatal messages' />
- </params>
- </command>
- <command id='show logging vty'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='logging' doc='Show current logging configuration' />
- <param name='vty' doc='Show current logging configuration for this vty' />
- </params>
- </command>
- <command id='show alarms'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='alarms' doc='Show current logging configuration' />
- </params>
- </command>
- <command id='show sccp connections'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='sccp' doc='Display information about SCCP' />
- <param name='connections' doc='All active connections' />
- </params>
- </command>
- <command id='show bsc connections'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='connections' doc='All active connections' />
- </params>
- </command>
- <command id='show bsc config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='config' doc='Configuration of BSCs' />
- </params>
- </command>
- <command id='show statistics [NR]'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='statistics' doc='Display network statistics' />
- <param name='[NR]' doc='Number of the BSC' />
- </params>
- </command>
- <command id='show statistics-by-lac <0-65535>'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='statistics-by-lac' doc='Display network statistics by lac' />
- <param name='<0-65535>' doc='The lac of the BSC' />
- </params>
- </command>
- <command id='close bsc connection BSC_NR'>
- <params>
- <param name='close' doc='Close' />
- <param name='bsc' doc='A-link' />
- <param name='connection' doc='Connection' />
- <param name='BSC_NR' doc='Identifier of the BSC' />
- </params>
- </command>
- <command id='show msc connection'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='msc' doc='MSC related information' />
- <param name='connection' doc='Status of the A-link connection' />
- </params>
- </command>
- <command id='test regex PATTERN STRING'>
- <params>
- <param name='test' doc='Test utilities' />
- <param name='regex' doc='Regexp testing' />
- <param name='PATTERN' doc='The regexp pattern' />
- <param name='STRING' doc='The string to match' />
- </params>
- </command>
- <command id='show bsc mgcp NR'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='bsc' doc='Information about BSCs' />
- <param name='mgcp' doc='MGCP related status' />
- <param name='NR' doc='Identifier of the BSC' />
- </params>
- </command>
- <command id='show access-list NAME'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='access-list' doc='IMSI access list' />
- <param name='NAME' doc='Name of the access list' />
- </params>
- </command>
- <command id='show imsi-black-list'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='imsi-black-list' doc='IMSIs barred from the network' />
- </params>
- </command>
- <command id='show prefix-tree'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='prefix-tree' doc='Prefix tree for number rewriting' />
- </params>
- </command>
- <command id='show ussd-connection'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='ussd-connection' doc='USSD connection related information' />
- </params>
- </command>
- <command id='set bsc last-used-endpoint <0-9999999999> <0-1024>'>
- <params>
- <param name='set' doc='Set a value' />
- <param name='bsc' doc='Operate on a BSC' />
- <param name='last-used-endpoint' doc='Last used endpoint for an assignment' />
- <param name='<0-9999999999>' doc='BSC configuration number' />
- <param name='<0-1024>' doc='Endpoint number used' />
- </params>
- </command>
- <command id='nat-block (block|unblock)'>
- <params>
- <param name='nat-block' doc='Block the NAT for new connections' />
- <param name='block' doc='Block' />
- <param name='unblock' doc='Unblock' />
- </params>
- </command>
- <command id='show mgcp [stats]'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
- <param name='[stats]' doc='Include Statistics' />
- </params>
- </command>
- <command id='loop-endpoint <0-64> NAME (0|1)'>
- <params>
- <param name='loop-endpoint' doc='Loop a given endpoint' />
- <param name='<0-64>' doc='Trunk number' />
- <param name='NAME' doc='The name in hex of the endpoint' />
- <param name='0' doc='Disable the loop' />
- <param name='1' doc='Enable the loop' />
- </params>
- </command>
- <command id='tap-call <0-64> ENDPOINT (bts-in|bts-out|net-in|net-out) A.B.C.D <0-65534>'>
- <params>
- <param name='tap-call' doc='Forward data on endpoint to a different system' />
- <param name='<0-64>' doc='Trunk number' />
- <param name='ENDPOINT' doc='The endpoint in hex' />
- <param name='bts-in' doc='Forward the data coming from the bts' />
- <param name='bts-out' doc='Forward the data coming from the bts leaving to the network' />
- <param name='net-in' doc='Forward the data coming from the net' />
- <param name='net-out' doc='Forward the data coming from the net leaving to the bts' />
- <param name='A.B.C.D' doc='destination IP of the data' />
- <param name='<0-65534>' doc='destination port' />
- </params>
- </command>
- <command id='free-endpoint <0-64> NUMBER'>
- <params>
- <param name='free-endpoint' doc='Free the given endpoint' />
- <param name='<0-64>' doc='Trunk number' />
- <param name='NUMBER' doc='Endpoint number in hex.' />
- </params>
- </command>
- <command id='reset-endpoint <0-64> NUMBER'>
- <params>
- <param name='reset-endpoint' doc='Reset the given endpoint' />
- <param name='<0-64>' doc='Trunk number' />
- <param name='NUMBER' doc='Endpoint number in hex.' />
- </params>
- </command>
- <command id='reset-all-endpoints'>
- <params>
- <param name='reset-all-endpoints' doc='Reset all endpoints' />
- </params>
- </command>
- </node>
- <node id='4'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='hostname WORD'>
- <params>
- <param name='hostname' doc='Set system's network name' />
- <param name='WORD' doc='This system's network name' />
- </params>
- </command>
- <command id='no hostname [HOSTNAME]'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='hostname' doc='Reset system's network name' />
- <param name='[HOSTNAME]' doc='Host name of this router' />
- </params>
- </command>
- <command id='password (8|) WORD'>
- <params>
- <param name='password' doc='Assign the terminal connection password' />
- <param name='8' doc='Specifies a HIDDEN password will follow' />
- <param name='' doc='dummy string ' />
- <param name='WORD' doc='The HIDDEN line password string' />
- </params>
- </command>
- <command id='password LINE'>
- <params>
- <param name='password' doc='Assign the terminal connection password' />
- <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
- </params>
- </command>
- <command id='enable password (8|) WORD'>
- <params>
- <param name='enable' doc='Modify enable password parameters' />
- <param name='password' doc='Assign the privileged level password' />
- <param name='8' doc='Specifies a HIDDEN password will follow' />
- <param name='' doc='dummy string ' />
- <param name='WORD' doc='The HIDDEN 'enable' password string' />
- </params>
- </command>
- <command id='enable password LINE'>
- <params>
- <param name='enable' doc='Modify enable password parameters' />
- <param name='password' doc='Assign the privileged level password' />
- <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' />
- </params>
- </command>
- <command id='no enable password'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='enable' doc='Modify enable password parameters' />
- <param name='password' doc='Assign the privileged level password' />
- </params>
- </command>
- <command id='banner motd default'>
- <params>
- <param name='banner' doc='Set banner string' />
- <param name='motd' doc='Strings for motd' />
- <param name='default' doc='Default string' />
- </params>
- </command>
- <command id='banner motd file [FILE]'>
- <params>
- <param name='banner' doc='Set banner' />
- <param name='motd' doc='Banner for motd' />
- <param name='file' doc='Banner from a file' />
- <param name='[FILE]' doc='Filename' />
- </params>
- </command>
- <command id='no banner motd'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='banner' doc='Set banner string' />
- <param name='motd' doc='Strings for motd' />
- </params>
- </command>
- <command id='service terminal-length <0-512>'>
- <params>
- <param name='service' doc='Set up miscellaneous service' />
- <param name='terminal-length' doc='System wide terminal length configuration' />
- <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' />
- </params>
- </command>
- <command id='no service terminal-length [<0-512>]'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='service' doc='Set up miscellaneous service' />
- <param name='terminal-length' doc='System wide terminal length configuration' />
- <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' />
- </params>
- </command>
- <command id='line vty'>
- <params>
- <param name='line' doc='Configure a terminal line' />
- <param name='vty' doc='Virtual terminal' />
- </params>
- </command>
- <command id='service advanced-vty'>
- <params>
- <param name='service' doc='Set up miscellaneous service' />
- <param name='advanced-vty' doc='Enable advanced mode vty interface' />
- </params>
- </command>
- <command id='no service advanced-vty'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='service' doc='Set up miscellaneous service' />
- <param name='advanced-vty' doc='Enable advanced mode vty interface' />
- </params>
- </command>
- <command id='show history'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='history' doc='Display the session command history' />
- </params>
- </command>
- <command id='log stderr'>
- <params>
- <param name='log' doc='Configure logging sub-system' />
- <param name='stderr' doc='Logging via STDERR of the process' />
- </params>
- </command>
- <command id='no log stderr'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='log' doc='Configure logging sub-system' />
- <param name='stderr' doc='Logging via STDERR of the process' />
- </params>
- </command>
- <command id='log file .FILENAME'>
- <params>
- <param name='log' doc='Configure logging sub-system' />
- <param name='file' doc='Logging to text file' />
- <param name='.FILENAME' doc='Filename' />
- </params>
- </command>
- <command id='no log file .FILENAME'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='log' doc='Configure logging sub-system' />
- <param name='file' doc='Logging to text file' />
- <param name='.FILENAME' doc='Filename' />
- </params>
- </command>
- <command id='log alarms <2-32700>'>
- <params>
- <param name='log' doc='Configure logging sub-system' />
- <param name='alarms' doc='Logging alarms to osmo_strrb' />
- <param name='<2-32700>' doc='Maximum number of messages to log' />
- </params>
- </command>
- <command id='no log alarms'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='log' doc='Configure logging sub-system' />
- <param name='alarms' doc='Logging alarms to osmo_strrb' />
- </params>
- </command>
- <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
- <params>
- <param name='log' doc='Configure logging sub-system' />
- <param name='syslog' doc='Logging via syslog' />
- <param name='authpriv' doc='Security/authorization messages facility' />
- <param name='cron' doc='Clock daemon (cron/at) facility' />
- <param name='daemon' doc='General system daemon facility' />
- <param name='ftp' doc='Ftp daemon facility' />
- <param name='lpr' doc='Line printer facility' />
- <param name='mail' doc='Mail facility' />
- <param name='news' doc='News facility' />
- <param name='user' doc='Generic facility' />
- <param name='uucp' doc='UUCP facility' />
- </params>
- </command>
- <command id='log syslog local <0-7>'>
- <params>
- <param name='log' doc='Configure logging sub-system' />
- <param name='syslog' doc='Logging via syslog' />
- <param name='local' doc='Syslog LOCAL facility' />
- <param name='<0-7>' doc='Local facility number' />
- </params>
- </command>
- <command id='no log syslog'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='log' doc='Configure logging sub-system' />
- <param name='syslog' doc='Logging via syslog' />
- </params>
- </command>
- <command id='nat'>
- <params>
- <param name='nat' doc='Configure the NAT' />
- </params>
- </command>
- <command id='mgcp'>
- <params>
- <param name='mgcp' doc='Configure the MGCP' />
- </params>
- </command>
- </node>
- <node id='7'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='logging filter all (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='filter' doc='Filter log messages' />
- <param name='all' doc='Do you want to log all messages?' />
- <param name='0' doc='Only print messages matched by other filters' />
- <param name='1' doc='Bypass filter and print all messages' />
- </params>
- </command>
- <command id='logging color (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='color' doc='Configure color-printing for log messages' />
- <param name='0' doc='Don't use color for printing messages' />
- <param name='1' doc='Use color for printing messages' />
- </params>
- </command>
- <command id='logging timestamp (0|1)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='timestamp' doc='Configure log message timestamping' />
- <param name='0' doc='Don't prefix each log message' />
- <param name='1' doc='Prefix each log message with current timestamp' />
- </params>
- </command>
- <command id='logging level (all|rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
- <params>
- <param name='logging' doc='Configure log message to this terminal' />
- <param name='level' doc='Set the log level for a specified category' />
- <param name='all' doc='Global setting for all subsystems' />
- <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
- <param name='cc' doc='Layer3 Call Control (CC)' />
- <param name='mm' doc='Layer3 Mobility Management (MM)' />
- <param name='rr' doc='Layer3 Radio Resource (RR)' />
- <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' />
- <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' />
- <param name='mncc' doc='MNCC API for Call Control application' />
- <param name='pag' doc='Paging Subsystem' />
- <param name='meas' doc='Radio Measurement Processing' />
- <param name='sccp' doc='SCCP Protocol' />
- <param name='msc' doc='Mobile Switching Center' />
- <param name='mgcp' doc='Media Gateway Control Protocol' />
- <param name='ho' doc='Hand-Over' />
- <param name='db' doc='Database Layer' />
- <param name='ref' doc='Reference Counting' />
- <param name='gprs' doc='GPRS Packet Service' />
- <param name='ns' doc='GPRS Network Service (NS)' />
- <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
- <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
- <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
- <param name='nat' doc='GSM 08.08 NAT/Multiplexer' />
- <param name='ctrl' doc='Control interface' />
- <param name='smpp' doc='SMPP interface for external SMS apps' />
- <param name='lglobal' doc='Library-internal global log family' />
- <param name='llapd' doc='LAPD in libosmogsm' />
- <param name='linp' doc='A-bis Intput Subsystem' />
- <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
- <param name='lmi' doc='A-bis Input Driver for Signalling' />
- <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
- <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
- <param name='everything' doc='Log simply everything' />
- <param name='debug' doc='Log debug messages and higher levels' />
- <param name='info' doc='Log informational messages and higher levels' />
- <param name='notice' doc='Log noticable messages and higher levels' />
- <param name='error' doc='Log error messages and higher levels' />
- <param name='fatal' doc='Log only fatal messages' />
- </params>
- </command>
- </node>
- <node id='8'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <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>
- </node>
- <node id='19'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='local ip A.B.C.D'>
- <params>
- <param name='local' doc='Local options for the SDP record' />
- <param name='ip' doc='IP information' />
- <param name='A.B.C.D' doc='IPv4 Address to use in SDP record' />
- </params>
- </command>
- <command id='bts ip A.B.C.D'>
- <params>
- <param name='bts' doc='BTS Audio source/destination options' />
- <param name='ip' doc='IP information' />
- <param name='A.B.C.D' doc='IPv4 Address of the BTS' />
- </params>
- </command>
- <command id='bind ip A.B.C.D'>
- <params>
- <param name='bind' doc='Listen/Bind related socket option' />
- <param name='ip' doc='IP information' />
- <param name='A.B.C.D' doc='IPv4 Address to bind to' />
- </params>
- </command>
- <command id='bind port <0-65534>'>
- <params>
- <param name='bind' doc='Listen/Bind related socket option' />
- <param name='port' doc='Port information' />
- <param name='<0-65534>' doc='UDP port to listen for MGCP messages' />
- </params>
- </command>
- <command id='bind early (0|1)'>
- <params>
- <param name='bind' doc='Listen/Bind related socket option' />
- <param name='early' doc='Bind local ports on start up' />
- <param name='0' doc='Bind on demand' />
- <param name='1' doc='Bind on startup' />
- </params>
- </command>
- <command id='rtp base <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='base' doc='First UDP port allocated for the BTS side' />
- <param name='<0-65534>' doc='UDP Port number' />
- </params>
- </command>
- <command id='rtp bts-base <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='bts-base' doc='First UDP port allocated for the BTS side' />
- <param name='<0-65534>' doc='UDP Port number' />
- </params>
- </command>
- <command id='rtp net-base <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='net-base' doc='First UDP port allocated for the NET side' />
- <param name='<0-65534>' doc='UDP Port number' />
- </params>
- </command>
- <command id='rtp bts-range <0-65534> <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='bts-range' doc='Range of ports to use for the BTS side' />
- <param name='<0-65534>' doc='Start of the range of ports' />
- <param name='<0-65534>' doc='End of the range of ports' />
- </params>
- </command>
- <command id='rtp net-range <0-65534> <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='net-range' doc='Range of ports to use for the NET side' />
- <param name='<0-65534>' doc='Start of the range of ports' />
- <param name='<0-65534>' doc='End of the range of ports' />
- </params>
- </command>
- <command id='rtp transcoder-range <0-65534> <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='transcoder-range' doc='Range of ports to use for the Transcoder' />
- <param name='<0-65534>' doc='Start of the range of ports' />
- <param name='<0-65534>' doc='End of the range of ports' />
- </params>
- </command>
- <command id='rtp transcoder-base <0-65534>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='transcoder-base' doc='First UDP port allocated for the Transcoder side' />
- <param name='<0-65534>' doc='UDP Port number' />
- </params>
- </command>
- <command id='rtp ip-dscp <0-255>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='ip-dscp' doc='Apply IP_TOS to the audio stream' />
- <param name='<0-255>' doc='The DSCP value' />
- </params>
- </command>
- <command id='rtp ip-tos <0-255>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='ip-tos' doc='Apply IP_TOS to the audio stream' />
- <param name='<0-255>' doc='The DSCP value' />
- </params>
- </command>
- <command id='rtp keep-alive <1-120>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- <param name='<1-120>' doc='Keep alive interval in secs' />
- </params>
- </command>
- <command id='rtp keep-alive once'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- <param name='once' doc='Send dummy packet only once after CRCX/MDCX' />
- </params>
- </command>
- <command id='no rtp keep-alive'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- </params>
- </command>
- <command id='call-agent ip A.B.C.D'>
- <params>
- <param name='call-agent' doc='Callagent information' />
- <param name='ip' doc='IP information' />
- <param name='A.B.C.D' doc='IPv4 Address of the callagent' />
- </params>
- </command>
- <command id='call agent ip A.B.C.D'>
- <params>
- <param name='call' doc='Callagent information' />
- <param name='agent' doc='Callagent information' />
- <param name='ip' doc='IP information' />
- <param name='A.B.C.D' doc='IPv4 Address of the callagent' />
- </params>
- </command>
- <command id='transcoder-mgw A.B.C.D'>
- <params>
- <param name='transcoder-mgw' doc='Use a MGW to detranscoder RTP' />
- <param name='A.B.C.D' doc='The IP address of the MGW' />
- </params>
- </command>
- <command id='no transcoder-mgw'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='transcoder-mgw' doc='Disable the transcoding' />
- </params>
- </command>
- <command id='transcoder-remote-base <0-65534>'>
- <params>
- <param name='transcoder-remote-base' doc='Set the base port for the transcoder' />
- <param name='<0-65534>' doc='The RTP base port on the transcoder' />
- </params>
- </command>
- <command id='sdp audio-payload number <1-255>'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='number' doc='Number' />
- <param name='<1-255>' doc='Payload number' />
- </params>
- </command>
- <command id='sdp audio-payload name NAME'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='name' doc='Name' />
- <param name='NAME' doc='Payload name' />
- </params>
- </command>
- <command id='sdp audio payload number <1-255>'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio' doc='Audio payload options' />
- <param name='payload' doc='Audio payload options' />
- <param name='number' doc='Number' />
- <param name='<1-255>' doc='Payload number' />
- </params>
- </command>
- <command id='sdp audio payload name NAME'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio' doc='Audio payload options' />
- <param name='payload' doc='Audio payload options' />
- <param name='name' doc='Name' />
- <param name='NAME' doc='Payload name' />
- </params>
- </command>
- <command id='loop (0|1)'>
- <params>
- <param name='loop' doc='Loop audio for all endpoints on main trunk' />
- <param name='0' doc='Don't Loop' />
- <param name='1' doc='Loop' />
- </params>
- </command>
- <command id='number endpoints <0-65534>'>
- <params>
- <param name='number' doc='Number options' />
- <param name='endpoints' doc='Endpoints available' />
- <param name='<0-65534>' doc='Number endpoints' />
- </params>
- </command>
- <command id='rtcp-omit'>
- <params>
- <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
- </params>
- </command>
- <command id='no rtcp-omit'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
- </params>
- </command>
- <command id='rtp-patch ssrc'>
- <params>
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='ssrc' doc='Force a fixed SSRC' />
- </params>
- </command>
- <command id='no rtp-patch ssrc'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='ssrc' doc='Force a fixed SSRC' />
- </params>
- </command>
- <command id='rtp-patch timestamp'>
- <params>
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='timestamp' doc='Adjust RTP timestamp' />
- </params>
- </command>
- <command id='no rtp-patch timestamp'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='timestamp' doc='Adjust RTP timestamp' />
- </params>
- </command>
- <command id='no rtp-patch'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- </params>
- </command>
- <command id='sdp audio fmtp-extra .NAME'>
- <params>
- <param name='sdp' doc='Add extra fmtp for the SDP file' />
- <param name='audio' doc='Audio' />
- <param name='fmtp-extra' doc='Fmtp-extra' />
- <param name='.NAME' doc='Extra Information' />
- </params>
- </command>
- <command id='sdp audio-payload send-ptime'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
- </params>
- </command>
- <command id='no sdp audio-payload send-ptime'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
- </params>
- </command>
- <command id='trunk <1-64>'>
- <params>
- <param name='trunk' doc='Configure a SS7 trunk' />
- <param name='<1-64>' doc='Trunk Nr' />
- </params>
- </command>
- </node>
- <node id='23'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='msc ip A.B.C.D'>
- <params>
- <param name='msc' doc='MSC related configuration' />
- <param name='ip' doc='Configure the IP address' />
- <param name='A.B.C.D' doc='IP information' />
- </params>
- </command>
- <command id='msc port <1-65500>'>
- <params>
- <param name='msc' doc='MSC related configuration' />
- <param name='port' doc='Configure the port' />
- <param name='<1-65500>' doc='Port number' />
- </params>
- </command>
- <command id='timeout auth <1-256>'>
- <params>
- <param name='timeout' doc='Timeout configuration' />
- <param name='auth' doc='Authentication timeout' />
- <param name='<1-256>' doc='Timeout in seconds' />
- </params>
- </command>
- <command id='timeout ping NR'>
- <params>
- <param name='timeout' doc='Timeout configuration' />
- <param name='ping' doc='Time between two pings' />
- <param name='NR' doc='Timeout in seconds' />
- </params>
- </command>
- <command id='timeout pong NR'>
- <params>
- <param name='timeout' doc='Timeout configuration' />
- <param name='pong' doc='Waiting for pong timeout' />
- <param name='NR' doc='Timeout in seconds' />
- </params>
- </command>
- <command id='token TOKEN'>
- <params>
- <param name='token' doc='Authentication token configuration' />
- <param name='TOKEN' doc='Token of the BSC, currently transferred in cleartext' />
- </params>
- </command>
- <command id='ip-dscp <0-255>'>
- <params>
- <param name='ip-dscp' doc='Set the IP DSCP for the BSCs to use' />
- <param name='<0-255>' doc='Set the IP_TOS attribute' />
- </params>
- </command>
- <command id='ip-tos <0-255>'>
- <params>
- <param name='ip-tos' doc='Use ip-dscp in the future.' />
- <param name='<0-255>' doc='Set the DSCP' />
- </params>
- </command>
- <command id='access-list-name NAME'>
- <params>
- <param name='access-list-name' doc='Set the name of the access list to use.' />
- <param name='NAME' doc='The name of the to be used access list.' />
- </params>
- </command>
- <command id='no access-list-name'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='access-list-name' doc='Remove the access list from the NAT.' />
- </params>
- </command>
- <command id='imsi-black-list-file-name NAME'>
- <params>
- <param name='imsi-black-list-file-name' doc='IMSI black listing' />
- <param name='NAME' doc='Filename IMSI and reject-cause' />
- </params>
- </command>
- <command id='no imsi-black-list-file-name'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='imsi-black-list-file-name' doc='Remove the imsi-black-list' />
- </params>
- </command>
- <command id='ussd-list-name NAME'>
- <params>
- <param name='ussd-list-name' doc='Set the name of the access list to check for IMSIs for USSD message' />
- <param name='NAME' doc='The name of the access list for HLR USSD handling' />
- </params>
- </command>
- <command id='ussd-query REGEXP'>
- <params>
- <param name='ussd-query' doc='Set the USSD query to match with the ussd-list-name' />
- <param name='REGEXP' doc='The query to match' />
- </params>
- </command>
- <command id='ussd-token TOKEN'>
- <params>
- <param name='ussd-token' doc='Set the token used to identify the USSD module' />
- <param name='TOKEN' doc='Secret key' />
- </params>
- </command>
- <command id='ussd-local-ip A.B.C.D'>
- <params>
- <param name='ussd-local-ip' doc='Set the IP to listen for the USSD Provider' />
- <param name='A.B.C.D' doc='IP Address' />
- </params>
- </command>
- <command id='use-msc-ipa-for-mgcp'>
- <params>
- <param name='use-msc-ipa-for-mgcp' doc='This needs to be set at start. Handle MGCP messages through the IPA protocol and not through the UDP socket.' />
- </params>
- </command>
- <command id='access-list NAME imsi-allow [REGEXP]'>
- <params>
- <param name='access-list' doc='Access list commands' />
- <param name='NAME' doc='Name of the access list' />
- <param name='imsi-allow' doc='Add allowed IMSI to the list' />
- <param name='[REGEXP]' doc='Regexp for IMSIs' />
- </params>
- </command>
- <command id='access-list NAME imsi-deny [REGEXP] (<0-256>) (<0-256>)'>
- <params>
- <param name='access-list' doc='Access list commands' />
- <param name='NAME' doc='Name of the access list' />
- <param name='imsi-deny' doc='Add denied IMSI to the list' />
- <param name='[REGEXP]' doc='Regexp for IMSIs' />
- <param name='<0-256>' doc='CM Service Reject reason' />
- <param name='<0-256>' doc='LU Reject reason' />
- </params>
- </command>
- <command id='no access-list NAME'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='access-list' doc='Remove an access-list by name' />
- <param name='NAME' doc='The access-list to remove' />
- </params>
- </command>
- <command id='number-rewrite FILENAME'>
- <params>
- <param name='number-rewrite' doc='Set the file with rewriting rules.' />
- <param name='FILENAME' doc='Filename' />
- </params>
- </command>
- <command id='no number-rewrite'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='number-rewrite' doc='Set the file with rewriting rules.' />
- </params>
- </command>
- <command id='number-rewrite-post FILENAME'>
- <params>
- <param name='number-rewrite-post' doc='Set the file with post-routing rewriting rules.' />
- <param name='FILENAME' doc='Filename' />
- </params>
- </command>
- <command id='no number-rewrite-post'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='number-rewrite-post' doc='Set the file with post-routing rewriting rules.' />
- </params>
- </command>
- <command id='rewrite-smsc addr FILENAME'>
- <params>
- <param name='rewrite-smsc' doc='SMSC Rewriting' />
- <param name='addr' doc='The SMSC Address to match and replace in RP-DATA' />
- <param name='FILENAME' doc='File with rules for the SMSC Address replacing' />
- </params>
- </command>
- <command id='rewrite-smsc tp-dest-match FILENAME'>
- <params>
- <param name='rewrite-smsc' doc='SMSC Rewriting' />
- <param name='tp-dest-match' doc='Match TP-Destination of a SMS.' />
- <param name='FILENAME' doc='File with rules for matching MSISDN and TP-DEST' />
- </params>
- </command>
- <command id='sms-clear-tp-srr FILENAME'>
- <params>
- <param name='sms-clear-tp-srr' doc='SMS TPDU Sender Report Request clearing' />
- <param name='FILENAME' doc='Files with rules for matching MSISDN' />
- </params>
- </command>
- <command id='no sms-clear-tp-srr'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='sms-clear-tp-srr' doc='SMS TPDU Sender Report Request clearing' />
- </params>
- </command>
- <command id='sms-number-rewrite FILENAME'>
- <params>
- <param name='sms-number-rewrite' doc='SMS TP-DA Number rewriting' />
- <param name='FILENAME' doc='Files with rules for matching MSISDN' />
- </params>
- </command>
- <command id='no sms-number-rewrite'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='sms-number-rewrite' doc='Disable SMS TP-DA rewriting' />
- </params>
- </command>
- <command id='prefix-tree FILENAME'>
- <params>
- <param name='prefix-tree' doc='Prefix tree for number rewriting' />
- <param name='FILENAME' doc='File to load' />
- </params>
- </command>
- <command id='no prefix-tree'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='prefix-tree' doc='Prefix tree for number rewriting' />
- </params>
- </command>
- <command id='paging-group <0-1000>'>
- <params>
- <param name='paging-group' doc='Create a Paging Group' />
- <param name='<0-1000>' doc='Number of the Group' />
- </params>
- </command>
- <command id='no paging-group <0-1000>'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='paging-group' doc='Delete paging-group' />
- <param name='<0-1000>' doc='Paging-group number' />
- </params>
- </command>
- <command id='bsc BSC_NR'>
- <params>
- <param name='bsc' doc='BSC configuration' />
- <param name='BSC_NR' doc='Identifier of the BSC' />
- </params>
- </command>
- </node>
- <node id='24'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='token TOKEN'>
- <params>
- <param name='token' doc='Authentication token configuration' />
- <param name='TOKEN' doc='Token of the BSC, currently transferred in cleartext' />
- </params>
- </command>
- <command id='location_area_code <0-65535>'>
- <params>
- <param name='location_area_code' doc='Add the Location Area Code (LAC) of this BSC' />
- <param name='<0-65535>' doc='LAC' />
- </params>
- </command>
- <command id='no location_area_code <0-65535>'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='location_area_code' doc='Remove the Location Area Code (LAC) of this BSC' />
- <param name='<0-65535>' doc='LAC' />
- </params>
- </command>
- <command id='paging forbidden (0|1)'>
- <params>
- <param name='paging' doc='Paging' />
- <param name='forbidden' doc='Forbid sending PAGING REQUESTS to the BSC.' />
- <param name='0' doc='Do not forbid' />
- <param name='1' doc='Forbid' />
- </params>
- </command>
- <command id='description DESC'>
- <params>
- <param name='description' doc='Provide a description for the given BSC.' />
- <param name='DESC' doc='Description' />
- </params>
- </command>
- <command id='access-list-name NAME'>
- <params>
- <param name='access-list-name' doc='Set the name of the access list to use.' />
- <param name='NAME' doc='The name of the to be used access list.' />
- </params>
- </command>
- <command id='no access-list-name'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='access-list-name' doc='Do not use an access-list for the BSC.' />
- </params>
- </command>
- <command id='max-endpoints <1-1024>'>
- <params>
- <param name='max-endpoints' doc='Highest endpoint to use (exclusively)' />
- <param name='<1-1024>' doc='Number of ports' />
- </params>
- </command>
- <command id='paging-group <0-1000>'>
- <params>
- <param name='paging-group' doc='Use a paging group' />
- <param name='<0-1000>' doc='Paging Group to use' />
- </params>
- </command>
- <command id='paging group <0-1000>'>
- <params>
- <param name='paging' doc='Paging' />
- <param name='group' doc='Use a paging group' />
- <param name='<0-1000>' doc='Paging Group to use' />
- </params>
- </command>
- <command id='no paging group'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='paging' doc='Paging' />
- <param name='group' doc='Disable the usage of a paging group.' />
- </params>
- </command>
- </node>
- <node id='27'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='rtp keep-alive <1-120>'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- <param name='<1-120>' doc='Keep-alive interval in secs' />
- </params>
- </command>
- <command id='rtp keep-alive once'>
- <params>
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- <param name='once' doc='Send dummy packet only once after CRCX/MDCX' />
- </params>
- </command>
- <command id='no rtp keep-alive'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp' doc='RTP configuration' />
- <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
- </params>
- </command>
- <command id='sdp audio-payload number <1-255>'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='number' doc='Number' />
- <param name='<1-255>' doc='Payload Number' />
- </params>
- </command>
- <command id='sdp audio-payload name NAME'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='name' doc='Payload' />
- <param name='NAME' doc='Payload Name' />
- </params>
- </command>
- <command id='sdp audio payload number <1-255>'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio' doc='Audio payload options' />
- <param name='payload' doc='Audio payload options' />
- <param name='number' doc='Number' />
- <param name='<1-255>' doc='Payload Number' />
- </params>
- </command>
- <command id='sdp audio payload name NAME'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio' doc='Audio payload options' />
- <param name='payload' doc='Audio payload options' />
- <param name='name' doc='Payload' />
- <param name='NAME' doc='Payload Name' />
- </params>
- </command>
- <command id='loop (0|1)'>
- <params>
- <param name='loop' doc='Loop audio for all endpoints on this trunk' />
- <param name='0' doc='Don't Loop' />
- <param name='1' doc='Loop' />
- </params>
- </command>
- <command id='rtcp-omit'>
- <params>
- <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
- </params>
- </command>
- <command id='no rtcp-omit'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
- </params>
- </command>
- <command id='rtp-patch ssrc'>
- <params>
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='ssrc' doc='Force a fixed SSRC' />
- </params>
- </command>
- <command id='no rtp-patch ssrc'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='ssrc' doc='Force a fixed SSRC' />
- </params>
- </command>
- <command id='rtp-patch timestamp'>
- <params>
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='timestamp' doc='Adjust RTP timestamp' />
- </params>
- </command>
- <command id='no rtp-patch timestamp'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- <param name='timestamp' doc='Adjust RTP timestamp' />
- </params>
- </command>
- <command id='no rtp-patch'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
- </params>
- </command>
- <command id='sdp audio fmtp-extra .NAME'>
- <params>
- <param name='sdp' doc='Add extra fmtp for the SDP file' />
- <param name='audio' doc='Audio' />
- <param name='fmtp-extra' doc='Fmtp-extra' />
- <param name='.NAME' doc='Extra Information' />
- </params>
- </command>
- <command id='sdp audio-payload send-ptime'>
- <params>
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
- </params>
- </command>
- <command id='no sdp audio-payload send-ptime'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='sdp' doc='SDP File related options' />
- <param name='audio-payload' doc='Audio payload options' />
- <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
- </params>
- </command>
- </node>
- <node id='28'>
- <command id='help'>
- <params>
- <param name='help' doc='Description of the interactive help system' />
- </params>
- </command>
- <command id='list'>
- <params>
- <param name='list' doc='Print command list' />
- </params>
- </command>
- <command id='write terminal'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='terminal' doc='Write to terminal' />
- </params>
- </command>
- <command id='write file'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='file' doc='Write to configuration file' />
- </params>
- </command>
- <command id='write memory'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- <param name='memory' doc='Write configuration to the file (same as write file)' />
- </params>
- </command>
- <command id='write'>
- <params>
- <param name='write' doc='Write running configuration to memory, network, or terminal' />
- </params>
- </command>
- <command id='show running-config'>
- <params>
- <param name='show' doc='Show running system information' />
- <param name='running-config' doc='running configuration' />
- </params>
- </command>
- <command id='exit'>
- <params>
- <param name='exit' doc='Exit current mode and down to previous mode' />
- </params>
- </command>
- <command id='end'>
- <params>
- <param name='end' doc='End current mode and change to enable mode.' />
- </params>
- </command>
- <command id='location_area_code <0-65535>'>
- <params>
- <param name='location_area_code' doc='Add the Location Area Code (LAC)' />
- <param name='<0-65535>' doc='LAC' />
- </params>
- </command>
- <command id='no location_area_code <0-65535>'>
- <params>
- <param name='no' doc='Negate a command or set its defaults' />
- <param name='location_area_code' doc='Remove the Location Area Code (LAC)' />
- <param name='<0-65535>' doc='LAC' />
- </params>
- </command>
- </node>
-</vtydoc>
\ No newline at end of file +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> + <node id='_common_cmds_'> + <name>Common Commands</name> + <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description> + <command id='help'> + <params> + <param name='help' doc='Description of the interactive help system' /> + </params> + </command> + <command id='list'> + <params> + <param name='list' doc='Print command list' /> + </params> + </command> + <command id='write terminal'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='terminal' doc='Write to terminal' /> + </params> + </command> + <command id='write file'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='file' doc='Write to configuration file' /> + </params> + </command> + <command id='write memory'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='memory' doc='Write configuration to the file (same as write file)' /> + </params> + </command> + <command id='write'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + </params> + </command> + <command id='show running-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='running-config' doc='running configuration' /> + </params> + </command> + <command id='exit'> + <params> + <param name='exit' doc='Exit current mode and down to previous mode' /> + </params> + </command> + <command id='end'> + <params> + <param name='end' doc='End current mode and change to enable mode.' /> + </params> + </command> + </node> + <node id='view'> + <name>view</name> + <command id='show version'> + <params> + <param name='show' doc='Show running system information' /> + <param name='version' doc='Displays program version' /> + </params> + </command> + <command id='show online-help'> + <params> + <param name='show' doc='Show running system information' /> + <param name='online-help' doc='Online help' /> + </params> + </command> + <command id='enable'> + <params> + <param name='enable' doc='Turn on privileged mode command' /> + </params> + </command> + <command id='terminal length <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|filter|ranap|sua|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> + <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='meas' doc='Radio Measurement Processing' /> + <param name='sccp' doc='SCCP Protocol' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' /> + <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' /> + <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='filter' doc='BSC/NAT IMSI based filtering' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='sua' doc='SCCP User Adaptation Protocol' /> + <param name='pcu' doc='PCU Interface' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='show logging vty'> + <params> + <param name='show' doc='Show running system information' /> + <param name='logging' doc='Show current logging configuration' /> + <param name='vty' doc='Show current logging configuration for this vty' /> + </params> + </command> + <command id='show alarms'> + <params> + <param name='show' doc='Show running system information' /> + <param name='alarms' doc='Show current logging configuration' /> + </params> + </command> + <command id='show stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + </params> + </command> + <command id='show stats level (global|peer|subscriber)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Show global groups only' /> + <param name='peer' doc='Show global and network peer related groups' /> + <param name='subscriber' doc='Show global, peer, and subscriber groups' /> + </params> + </command> + <command id='show asciidoc counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='asciidoc' doc='Asciidoc generation' /> + <param name='counters' doc='Generate table of all registered counters' /> + </params> + </command> + <command id='show rate-counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='rate-counters' doc='Show all rate counters' /> + </params> + </command> + <command id='show sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='sccp' doc='Display information about SCCP' /> + <param name='connections' doc='All active connections' /> + </params> + </command> + <command id='show bsc connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='connections' doc='All active connections' /> + </params> + </command> + <command id='show nat num-bscs-configured'> + <params> + <param name='show' doc='Show running system information' /> + <param name='nat' doc='Display NAT configuration details' /> + <param name='num-bscs-configured' doc='BSCs-related' /> + </params> + </command> + <command id='show bsc status (nr|token|lac|all) [IDENT]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='status' doc='Status of BSC' /> + <param name='nr' doc='Identify BSC by nr' /> + <param name='token' doc='Identify BSC by token' /> + <param name='lac' doc='Identify BSC by lac' /> + <param name='all' doc='Show all BSC' /> + <param name='[IDENT]' doc='NR/token/lac of the BSC' /> + </params> + </command> + <command id='close bsc connection BSC_NR'> + <params> + <param name='close' doc='Close' /> + <param name='bsc' doc='A-link' /> + <param name='connection' doc='Connection' /> + <param name='BSC_NR' doc='Identifier of the BSC' /> + </params> + </command> + <command id='show msc connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='msc' doc='MSC related information' /> + <param name='connection' doc='Status of the A-link connection' /> + </params> + </command> + <command id='test regex PATTERN STRING'> + <params> + <param name='test' doc='Test utilities' /> + <param name='regex' doc='Regexp testing' /> + <param name='PATTERN' doc='The regexp pattern' /> + <param name='STRING' doc='The string to match' /> + </params> + </command> + <command id='show bsc mgcp NR'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='mgcp' doc='MGCP related status' /> + <param name='NR' doc='Identifier of the BSC' /> + </params> + </command> + <command id='show bscs-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bscs-config' doc='Show configured BSCs' /> + </params> + </command> + <command id='show imsi-black-list'> + <params> + <param name='show' doc='Show running system information' /> + <param name='imsi-black-list' doc='IMSIs barred from the network' /> + </params> + </command> + <command id='show prefix-tree'> + <params> + <param name='show' doc='Show running system information' /> + <param name='prefix-tree' doc='Prefix tree for number rewriting' /> + </params> + </command> + <command id='show ussd-connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ussd-connection' doc='USSD connection related information' /> + </params> + </command> + <command id='show access-list NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='access-list' doc='IMSI access list' /> + <param name='NAME' doc='Name of the access list' /> + </params> + </command> + <command id='show mgcp [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='mgcp' doc='Display information about the MGCP Media Gateway' /> + <param name='[stats]' doc='Include Statistics' /> + </params> + </command> + </node> + <node id='enable'> + <name>enable</name> + <command id='disable'> + <params> + <param name='disable' doc='Turn off privileged mode command' /> + </params> + </command> + <command id='configure terminal'> + <params> + <param name='configure' doc='Configuration from vty interface' /> + <param name='terminal' doc='Configuration terminal' /> + </params> + </command> + <command id='copy running-config startup-config'> + <params> + <param name='copy' doc='Copy configuration' /> + <param name='running-config' doc='Copy running config to... ' /> + <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> + </params> + </command> + <command id='show startup-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='startup-config' doc='Contentes of startup configuration' /> + </params> + </command> + <command id='show version'> + <params> + <param name='show' doc='Show running system information' /> + <param name='version' doc='Displays program version' /> + </params> + </command> + <command id='show online-help'> + <params> + <param name='show' doc='Show running system information' /> + <param name='online-help' doc='Online help' /> + </params> + </command> + <command id='terminal length <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='terminal monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='terminal no monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|filter|ranap|sua|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> + <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='meas' doc='Radio Measurement Processing' /> + <param name='sccp' doc='SCCP Protocol' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' /> + <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' /> + <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='filter' doc='BSC/NAT IMSI based filtering' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='sua' doc='SCCP User Adaptation Protocol' /> + <param name='pcu' doc='PCU Interface' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='show logging vty'> + <params> + <param name='show' doc='Show running system information' /> + <param name='logging' doc='Show current logging configuration' /> + <param name='vty' doc='Show current logging configuration for this vty' /> + </params> + </command> + <command id='show alarms'> + <params> + <param name='show' doc='Show running system information' /> + <param name='alarms' doc='Show current logging configuration' /> + </params> + </command> + <command id='show stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + </params> + </command> + <command id='show stats level (global|peer|subscriber)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Show global groups only' /> + <param name='peer' doc='Show global and network peer related groups' /> + <param name='subscriber' doc='Show global, peer, and subscriber groups' /> + </params> + </command> + <command id='show asciidoc counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='asciidoc' doc='Asciidoc generation' /> + <param name='counters' doc='Generate table of all registered counters' /> + </params> + </command> + <command id='show rate-counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='rate-counters' doc='Show all rate counters' /> + </params> + </command> + <command id='show sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='sccp' doc='Display information about SCCP' /> + <param name='connections' doc='All active connections' /> + </params> + </command> + <command id='show bsc connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='connections' doc='All active connections' /> + </params> + </command> + <command id='show nat num-bscs-configured'> + <params> + <param name='show' doc='Show running system information' /> + <param name='nat' doc='Display NAT configuration details' /> + <param name='num-bscs-configured' doc='BSCs-related' /> + </params> + </command> + <command id='show bsc status (nr|token|lac|all) [IDENT]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='status' doc='Status of BSC' /> + <param name='nr' doc='Identify BSC by nr' /> + <param name='token' doc='Identify BSC by token' /> + <param name='lac' doc='Identify BSC by lac' /> + <param name='all' doc='Show all BSC' /> + <param name='[IDENT]' doc='NR/token/lac of the BSC' /> + </params> + </command> + <command id='close bsc connection BSC_NR'> + <params> + <param name='close' doc='Close' /> + <param name='bsc' doc='A-link' /> + <param name='connection' doc='Connection' /> + <param name='BSC_NR' doc='Identifier of the BSC' /> + </params> + </command> + <command id='show msc connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='msc' doc='MSC related information' /> + <param name='connection' doc='Status of the A-link connection' /> + </params> + </command> + <command id='test regex PATTERN STRING'> + <params> + <param name='test' doc='Test utilities' /> + <param name='regex' doc='Regexp testing' /> + <param name='PATTERN' doc='The regexp pattern' /> + <param name='STRING' doc='The string to match' /> + </params> + </command> + <command id='show bsc mgcp NR'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bsc' doc='Information about BSCs' /> + <param name='mgcp' doc='MGCP related status' /> + <param name='NR' doc='Identifier of the BSC' /> + </params> + </command> + <command id='show bscs-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bscs-config' doc='Show configured BSCs' /> + </params> + </command> + <command id='show imsi-black-list'> + <params> + <param name='show' doc='Show running system information' /> + <param name='imsi-black-list' doc='IMSIs barred from the network' /> + </params> + </command> + <command id='show prefix-tree'> + <params> + <param name='show' doc='Show running system information' /> + <param name='prefix-tree' doc='Prefix tree for number rewriting' /> + </params> + </command> + <command id='show ussd-connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='ussd-connection' doc='USSD connection related information' /> + </params> + </command> + <command id='set bsc last-used-endpoint <0-9999999999> <0-1024>'> + <params> + <param name='set' doc='Set a value' /> + <param name='bsc' doc='Operate on a BSC' /> + <param name='last-used-endpoint' doc='Last used endpoint for an assignment' /> + <param name='<0-9999999999>' doc='BSC configuration number' /> + <param name='<0-1024>' doc='Endpoint number used' /> + </params> + </command> + <command id='nat-block (block|unblock)'> + <params> + <param name='nat-block' doc='Block the NAT for new connections' /> + <param name='block' doc='Block' /> + <param name='unblock' doc='Unblock' /> + </params> + </command> + <command id='show access-list NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='access-list' doc='IMSI access list' /> + <param name='NAME' doc='Name of the access list' /> + </params> + </command> + <command id='show mgcp [stats]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='mgcp' doc='Display information about the MGCP Media Gateway' /> + <param name='[stats]' doc='Include Statistics' /> + </params> + </command> + <command id='loop-endpoint <0-64> NAME (0|1)'> + <params> + <param name='loop-endpoint' doc='Loop a given endpoint' /> + <param name='<0-64>' doc='Trunk number' /> + <param name='NAME' doc='The name in hex of the endpoint' /> + <param name='0' doc='Disable the loop' /> + <param name='1' doc='Enable the loop' /> + </params> + </command> + <command id='tap-call <0-64> ENDPOINT (bts-in|bts-out|net-in|net-out) A.B.C.D <0-65534>'> + <params> + <param name='tap-call' doc='Forward data on endpoint to a different system' /> + <param name='<0-64>' doc='Trunk number' /> + <param name='ENDPOINT' doc='The endpoint in hex' /> + <param name='bts-in' doc='Forward the data coming from the bts' /> + <param name='bts-out' doc='Forward the data coming from the bts leaving to the network' /> + <param name='net-in' doc='Forward the data coming from the net' /> + <param name='net-out' doc='Forward the data coming from the net leaving to the bts' /> + <param name='A.B.C.D' doc='destination IP of the data' /> + <param name='<0-65534>' doc='destination port' /> + </params> + </command> + <command id='free-endpoint <0-64> NUMBER'> + <params> + <param name='free-endpoint' doc='Free the given endpoint' /> + <param name='<0-64>' doc='Trunk number' /> + <param name='NUMBER' doc='Endpoint number in hex.' /> + </params> + </command> + <command id='reset-endpoint <0-64> NUMBER'> + <params> + <param name='reset-endpoint' doc='Reset the given endpoint' /> + <param name='<0-64>' doc='Trunk number' /> + <param name='NUMBER' doc='Endpoint number in hex.' /> + </params> + </command> + <command id='reset-all-endpoints'> + <params> + <param name='reset-all-endpoints' doc='Reset all endpoints' /> + </params> + </command> + </node> + <node id='config'> + <name>config</name> + <command id='hostname WORD'> + <params> + <param name='hostname' doc='Set system's network name' /> + <param name='WORD' doc='This system's network name' /> + </params> + </command> + <command id='no hostname [HOSTNAME]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='hostname' doc='Reset system's network name' /> + <param name='[HOSTNAME]' doc='Host name of this router' /> + </params> + </command> + <command id='password (8|) WORD'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN line password string' /> + </params> + </command> + <command id='password LINE'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> + </params> + </command> + <command id='enable password (8|) WORD'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN 'enable' password string' /> + </params> + </command> + <command id='enable password LINE'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> + </params> + </command> + <command id='no enable password'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + </params> + </command> + <command id='banner motd default'> + <params> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + <param name='default' doc='Default string' /> + </params> + </command> + <command id='banner motd file [FILE]'> + <params> + <param name='banner' doc='Set banner' /> + <param name='motd' doc='Banner for motd' /> + <param name='file' doc='Banner from a file' /> + <param name='[FILE]' doc='Filename' /> + </params> + </command> + <command id='no banner motd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + </params> + </command> + <command id='service terminal-length <0-512>'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='no service terminal-length [<0-512>]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='line vty'> + <params> + <param name='line' doc='Configure a terminal line' /> + <param name='vty' doc='Virtual terminal' /> + </params> + </command> + <command id='service advanced-vty'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='no service advanced-vty'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='log stderr'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='no log stderr'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='log file .FILENAME'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='no log file .FILENAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='log alarms <2-32700>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + <param name='<2-32700>' doc='Maximum number of messages to log' /> + </params> + </command> + <command id='no log alarms'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + </params> + </command> + <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='authpriv' doc='Security/authorization messages facility' /> + <param name='cron' doc='Clock daemon (cron/at) facility' /> + <param name='daemon' doc='General system daemon facility' /> + <param name='ftp' doc='Ftp daemon facility' /> + <param name='lpr' doc='Line printer facility' /> + <param name='mail' doc='Mail facility' /> + <param name='news' doc='News facility' /> + <param name='user' doc='Generic facility' /> + <param name='uucp' doc='UUCP facility' /> + </params> + </command> + <command id='log syslog local <0-7>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='local' doc='Syslog LOCAL facility' /> + <param name='<0-7>' doc='Local facility number' /> + </params> + </command> + <command id='no log syslog'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + </params> + </command> + <command id='log gsmtap [HOSTNAME]'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='gsmtap' doc='Logging via GSMTAP' /> + <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> + </params> + </command> + <command id='stats reporter statsd'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='no stats reporter statsd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='stats reporter log'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='no stats reporter log'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='stats interval <1-65535>'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='interval' doc='Set the reporting interval' /> + <param name='<1-65535>' doc='Interval in seconds' /> + </params> + </command> + <command id='nat'> + <params> + <param name='nat' doc='Configure the NAT' /> + </params> + </command> + <command id='mgcp'> + <params> + <param name='mgcp' doc='Configure the MGCP' /> + </params> + </command> + <command id='ctrl'> + <params> + <param name='ctrl' doc='Configure the Control Interface' /> + </params> + </command> + </node> + <node id='config-log'> + <name>config-log</name> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|rsl|nm|mncc|pag|meas|sccp|msc|mgcp|ho|db|ref|gprs|ns|bssgp|llc|sndcp|nat|ctrl|smpp|filter|ranap|sua|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='rsl' doc='A-bis Radio Siganlling Link (RSL)' /> + <param name='nm' doc='A-bis Network Management / O&M (NM/OML)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='meas' doc='Radio Measurement Processing' /> + <param name='sccp' doc='SCCP Protocol' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='gprs' doc='GPRS Packet Service' /> + <param name='ns' doc='GPRS Network Service (NS)' /> + <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> + <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' /> + <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' /> + <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='filter' doc='BSC/NAT IMSI based filtering' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='sua' doc='SCCP User Adaptation Protocol' /> + <param name='pcu' doc='PCU Interface' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='lrspro' doc='Remote SIM protocol' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + </node> + <node id='config-stats'> + <name>config-stats</name> + <command id='local-ip ADDR'> + <params> + <param name='local-ip' doc='Set the IP address to which we bind locally' /> + <param name='ADDR' doc='IP Address' /> + </params> + </command> + <command id='no local-ip'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='local-ip' doc='Set the IP address to which we bind locally' /> + </params> + </command> + <command id='remote-ip ADDR'> + <params> + <param name='remote-ip' doc='Set the remote IP address to which we connect' /> + <param name='ADDR' doc='IP Address' /> + </params> + </command> + <command id='remote-port <1-65535>'> + <params> + <param name='remote-port' doc='Set the remote port to which we connect' /> + <param name='<1-65535>' doc='Remote port number' /> + </params> + </command> + <command id='mtu <100-65535>'> + <params> + <param name='mtu' doc='Set the maximum packet size' /> + <param name='<100-65535>' doc='Size in byte' /> + </params> + </command> + <command id='no mtu'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='mtu' doc='Set the maximum packet size' /> + </params> + </command> + <command id='prefix PREFIX'> + <params> + <param name='prefix' doc='Set the item name prefix' /> + <param name='PREFIX' doc='The prefix string' /> + </params> + </command> + <command id='no prefix'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='prefix' doc='Set the item name prefix' /> + </params> + </command> + <command id='level (global|peer|subscriber)'> + <params> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Report global groups only' /> + <param name='peer' doc='Report global and network peer related groups' /> + <param name='subscriber' doc='Report global, peer, and subscriber groups' /> + </params> + </command> + <command id='enable'> + <params> + <param name='enable' doc='Enable the reporter' /> + </params> + </command> + <command id='disable'> + <params> + <param name='disable' doc='Disable the reporter' /> + </params> + </command> + </node> + <node id='config-line'> + <name>config-line</name> + <command id='login'> + <params> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='no login'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='bind A.B.C.D [<0-65535>]'> + <params> + <param name='bind' doc='Accept VTY telnet connections on local interface' /> + <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> + <param name='[<0-65535>]' doc='Local TCP port number' /> + </params> + </command> + </node> + <node id='config-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-mgcp'> + <name>config-mgcp</name> + <command id='local ip A.B.C.D'> + <params> + <param name='local' doc='Local options for the SDP record' /> + <param name='ip' doc='IP information' /> + <param name='A.B.C.D' doc='IPv4 Address to use in SDP record' /> + </params> + </command> + <command id='bts ip A.B.C.D'> + <params> + <param name='bts' doc='BTS Audio source/destination options' /> + <param name='ip' doc='IP information' /> + <param name='A.B.C.D' doc='IPv4 Address of the BTS' /> + </params> + </command> + <command id='bind ip A.B.C.D'> + <params> + <param name='bind' doc='Listen/Bind related socket option' /> + <param name='ip' doc='IP information' /> + <param name='A.B.C.D' doc='IPv4 Address to bind to' /> + </params> + </command> + <command id='bind port <0-65534>'> + <params> + <param name='bind' doc='Listen/Bind related socket option' /> + <param name='port' doc='Port information' /> + <param name='<0-65534>' doc='UDP port to listen for MGCP messages' /> + </params> + </command> + <command id='bind early (0|1)'> + <params> + <param name='bind' doc='Listen/Bind related socket option' /> + <param name='early' doc='Bind local ports on start up' /> + <param name='0' doc='Bind on demand' /> + <param name='1' doc='Bind on startup' /> + </params> + </command> + <command id='rtp bts-base <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='bts-base' doc='First UDP port allocated for the BTS side' /> + <param name='<0-65534>' doc='UDP Port number' /> + </params> + </command> + <command id='rtp net-base <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='net-base' doc='First UDP port allocated for the NET side' /> + <param name='<0-65534>' doc='UDP Port number' /> + </params> + </command> + <command id='rtp bts-range <0-65534> <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='bts-range' doc='Range of ports to use for the BTS side' /> + <param name='<0-65534>' doc='Start of the range of ports' /> + <param name='<0-65534>' doc='End of the range of ports' /> + </params> + </command> + <command id='rtp bts-bind-ip A.B.C.D'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='bts-bind-ip' doc='Bind endpoints facing the BTS' /> + <param name='A.B.C.D' doc='Address to bind to' /> + </params> + </command> + <command id='no rtp bts-bind-ip'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp' doc='RTP configuration' /> + <param name='bts-bind-ip' doc='Bind endpoints facing the BTS' /> + </params> + </command> + <command id='rtp net-range <0-65534> <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='net-range' doc='Range of ports to use for the NET side' /> + <param name='<0-65534>' doc='Start of the range of ports' /> + <param name='<0-65534>' doc='End of the range of ports' /> + </params> + </command> + <command id='rtp net-bind-ip A.B.C.D'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='net-bind-ip' doc='Bind endpoints facing the Network' /> + <param name='A.B.C.D' doc='Address to bind to' /> + </params> + </command> + <command id='no rtp net-bind-ip'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp' doc='RTP configuration' /> + <param name='net-bind-ip' doc='Bind endpoints facing the Network' /> + </params> + </command> + <command id='rtp transcoder-range <0-65534> <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='transcoder-range' doc='Range of ports to use for the Transcoder' /> + <param name='<0-65534>' doc='Start of the range of ports' /> + <param name='<0-65534>' doc='End of the range of ports' /> + </params> + </command> + <command id='rtp transcoder-base <0-65534>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='transcoder-base' doc='First UDP port allocated for the Transcoder side' /> + <param name='<0-65534>' doc='UDP Port number' /> + </params> + </command> + <command id='rtp ip-dscp <0-255>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='ip-dscp' doc='Apply IP_TOS to the audio stream (including Osmux)' /> + <param name='<0-255>' doc='The DSCP value' /> + </params> + </command> + <command id='rtp force-ptime (10|20|40)'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='force-ptime' doc='Force a fixed ptime for packets sent to the BTSThe required ptime (packet duration) in ms' /> + <param name='10' doc='10 ms' /> + <param name='20' doc='20 ms' /> + <param name='40' doc='40 ms' /> + </params> + </command> + <command id='no rtp force-ptime'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp' doc='RTP configuration' /> + <param name='force-ptime' doc='Force a fixed ptime for packets sent to the BTS' /> + </params> + </command> + <command id='rtp keep-alive <1-120>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + <param name='<1-120>' doc='Keep alive interval in secs' /> + </params> + </command> + <command id='rtp keep-alive once'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + <param name='once' doc='Send dummy packet only once after CRCX/MDCX' /> + </params> + </command> + <command id='no rtp keep-alive'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + </params> + </command> + <command id='call-agent ip A.B.C.D'> + <params> + <param name='call-agent' doc='Callagent information' /> + <param name='ip' doc='IP information' /> + <param name='A.B.C.D' doc='IPv4 Address of the callagent' /> + </params> + </command> + <command id='transcoder-mgw A.B.C.D'> + <params> + <param name='transcoder-mgw' doc='Use a MGW to detranscoder RTP' /> + <param name='A.B.C.D' doc='The IP address of the MGW' /> + </params> + </command> + <command id='no transcoder-mgw'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='transcoder-mgw' doc='Disable the transcoding' /> + </params> + </command> + <command id='transcoder-remote-base <0-65534>'> + <params> + <param name='transcoder-remote-base' doc='Set the base port for the transcoder' /> + <param name='<0-65534>' doc='The RTP base port on the transcoder' /> + </params> + </command> + <command id='sdp audio-payload number <0-255>'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='number' doc='Number' /> + <param name='<0-255>' doc='Payload number' /> + </params> + </command> + <command id='sdp audio-payload name NAME'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='name' doc='Name' /> + <param name='NAME' doc='Payload name' /> + </params> + </command> + <command id='loop (0|1)'> + <params> + <param name='loop' doc='Loop audio for all endpoints on main trunk' /> + <param name='0' doc='Don't Loop' /> + <param name='1' doc='Loop' /> + </params> + </command> + <command id='force-realloc (0|1)'> + <params> + <param name='force-realloc' doc='Force endpoint reallocation when the endpoint is still seized' /> + <param name='0' doc='Don't force reallocation' /> + <param name='1' doc='force reallocation' /> + </params> + </command> + <command id='number endpoints <0-65534>'> + <params> + <param name='number' doc='Number options' /> + <param name='endpoints' doc='Endpoints available' /> + <param name='<0-65534>' doc='Number endpoints' /> + </params> + </command> + <command id='rtcp-omit'> + <params> + <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> + </params> + </command> + <command id='no rtcp-omit'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> + </params> + </command> + <command id='rtp-patch ssrc'> + <params> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='ssrc' doc='Force a fixed SSRC' /> + </params> + </command> + <command id='no rtp-patch ssrc'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='ssrc' doc='Force a fixed SSRC' /> + </params> + </command> + <command id='rtp-patch timestamp'> + <params> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='timestamp' doc='Adjust RTP timestamp' /> + </params> + </command> + <command id='no rtp-patch timestamp'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='timestamp' doc='Adjust RTP timestamp' /> + </params> + </command> + <command id='no rtp-patch'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + </params> + </command> + <command id='sdp audio fmtp-extra .NAME'> + <params> + <param name='sdp' doc='Add extra fmtp for the SDP file' /> + <param name='audio' doc='Audio' /> + <param name='fmtp-extra' doc='Fmtp-extra' /> + <param name='.NAME' doc='Extra Information' /> + </params> + </command> + <command id='sdp audio-payload send-ptime'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> + </params> + </command> + <command id='no sdp audio-payload send-ptime'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> + </params> + </command> + <command id='sdp audio-payload send-name'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-name' doc='Send SDP rtpmap with the audio name' /> + </params> + </command> + <command id='no sdp audio-payload send-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-name' doc='Send SDP rtpmap with the audio name' /> + </params> + </command> + <command id='osmux (on|off|only)'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='on' doc='Enable OSMUX' /> + <param name='off' doc='Disable OSMUX' /> + <param name='only' doc='Only use OSMUX' /> + </params> + </command> + <command id='osmux bind-ip A.B.C.D'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='bind-ip' doc='IP information' /> + <param name='A.B.C.D' doc='IPv4 Address to bind to' /> + </params> + </command> + <command id='osmux batch-factor <1-8>'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='batch-factor' doc='Batching factor' /> + <param name='<1-8>' doc='Number of messages in the batch' /> + </params> + </command> + <command id='osmux batch-size <1-65535>'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='batch-size' doc='batch size' /> + <param name='<1-65535>' doc='Batch size in bytes' /> + </params> + </command> + <command id='osmux port <1-65535>'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='port' doc='port' /> + <param name='<1-65535>' doc='UDP port' /> + </params> + </command> + <command id='osmux dummy (on|off)'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='dummy' doc='Dummy padding' /> + <param name='on' doc='Enable dummy padding' /> + <param name='off' doc='Disable dummy padding' /> + </params> + </command> + <command id='allow-transcoding'> + <params> + <param name='allow-transcoding' doc='Allow transcoding' /> + </params> + </command> + <command id='no allow-transcoding'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='allow-transcoding' doc='Allow transcoding' /> + </params> + </command> + <command id='bts-jitter-buffer'> + <params> + <param name='bts-jitter-buffer' doc='Uplink Jitter Buffer' /> + </params> + </command> + <command id='no bts-jitter-buffer'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='bts-jitter-buffer' doc='Uplink Jitter Buffer' /> + </params> + </command> + <command id='bts-jitter-buffer-delay-min <1-65535>'> + <params> + <param name='bts-jitter-buffer-delay-min' doc='Uplink Jitter Buffer Minimum Delay in ms' /> + <param name='<1-65535>' doc='Minimum Delay in ms' /> + </params> + </command> + <command id='bts-jitter-buffer-delay-max <1-65535>'> + <params> + <param name='bts-jitter-buffer-delay-max' doc='Uplink Jitter Buffer Maximum Delay in ms' /> + <param name='<1-65535>' doc='Maximum Delay in ms' /> + </params> + </command> + <command id='trunk <1-64>'> + <params> + <param name='trunk' doc='Configure a SS7 trunk' /> + <param name='<1-64>' doc='Trunk Nr' /> + </params> + </command> + </node> + <node id='config-nat'> + <name>config-nat</name> + <command id='msc ip A.B.C.D'> + <params> + <param name='msc' doc='MSC related configuration' /> + <param name='ip' doc='Configure the IP address' /> + <param name='A.B.C.D' doc='IP information' /> + </params> + </command> + <command id='msc port <1-65500>'> + <params> + <param name='msc' doc='MSC related configuration' /> + <param name='port' doc='Configure the port' /> + <param name='<1-65500>' doc='Port number' /> + </params> + </command> + <command id='timeout auth <1-256>'> + <params> + <param name='timeout' doc='Timeout configuration' /> + <param name='auth' doc='Authentication timeout' /> + <param name='<1-256>' doc='Timeout in seconds' /> + </params> + </command> + <command id='timeout ping NR'> + <params> + <param name='timeout' doc='Timeout configuration' /> + <param name='ping' doc='Time between two pings' /> + <param name='NR' doc='Timeout in seconds' /> + </params> + </command> + <command id='timeout pong NR'> + <params> + <param name='timeout' doc='Timeout configuration' /> + <param name='pong' doc='Waiting for pong timeout' /> + <param name='NR' doc='Timeout in seconds' /> + </params> + </command> + <command id='token TOKEN'> + <params> + <param name='token' doc='Authentication token configuration' /> + <param name='TOKEN' doc='Token of the BSC, currently transferred in cleartext' /> + </params> + </command> + <command id='ip-dscp <0-255>'> + <params> + <param name='ip-dscp' doc='Set the IP DSCP for the BSCs to use' /> + <param name='<0-255>' doc='Set the IP_TOS attribute' /> + </params> + </command> + <command id='access-list-name NAME'> + <params> + <param name='access-list-name' doc='Set the name of the access list to use.' /> + <param name='NAME' doc='The name of the to be used access list.' /> + </params> + </command> + <command id='no access-list-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='access-list-name' doc='Remove the access list from the NAT.' /> + </params> + </command> + <command id='bscs-config-file NAME'> + <params> + <param name='bscs-config-file' doc='Set the filename of the BSC configuration to include.' /> + <param name='NAME' doc='The filename to be included.' /> + </params> + </command> + <command id='imsi-black-list-file-name NAME'> + <params> + <param name='imsi-black-list-file-name' doc='IMSI black listing' /> + <param name='NAME' doc='Filename IMSI and reject-cause' /> + </params> + </command> + <command id='no imsi-black-list-file-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='imsi-black-list-file-name' doc='Remove the imsi-black-list' /> + </params> + </command> + <command id='ussd-list-name NAME'> + <params> + <param name='ussd-list-name' doc='Set the name of the access list to check for IMSIs for USSD message' /> + <param name='NAME' doc='The name of the access list for HLR USSD handling' /> + </params> + </command> + <command id='ussd-query REGEXP'> + <params> + <param name='ussd-query' doc='Set the USSD query to match with the ussd-list-name' /> + <param name='REGEXP' doc='The query to match' /> + </params> + </command> + <command id='ussd-token TOKEN'> + <params> + <param name='ussd-token' doc='Set the token used to identify the USSD module' /> + <param name='TOKEN' doc='Secret key' /> + </params> + </command> + <command id='ussd-local-ip A.B.C.D'> + <params> + <param name='ussd-local-ip' doc='Set the IP to listen for the USSD Provider' /> + <param name='A.B.C.D' doc='IP Address' /> + </params> + </command> + <command id='use-msc-ipa-for-mgcp'> + <params> + <param name='use-msc-ipa-for-mgcp' doc='This needs to be set at start. Handle MGCP messages through the IPA protocol and not through the UDP socket.' /> + </params> + </command> + <command id='access-list NAME imsi-allow [REGEXP]'> + <params> + <param name='access-list' doc='Access list commands' /> + <param name='NAME' doc='Name of the access list' /> + <param name='imsi-allow' doc='Add allowed IMSI to the list' /> + <param name='[REGEXP]' doc='Regexp for IMSIs' /> + </params> + </command> + <command id='access-list NAME imsi-deny [REGEXP] (<0-256>) (<0-256>)'> + <params> + <param name='access-list' doc='Access list commands' /> + <param name='NAME' doc='Name of the access list' /> + <param name='imsi-deny' doc='Add denied IMSI to the list' /> + <param name='[REGEXP]' doc='Regexp for IMSIs' /> + <param name='<0-256>' doc='CM Service Reject reason' /> + <param name='<0-256>' doc='LU Reject reason' /> + </params> + </command> + <command id='no access-list NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='access-list' doc='Remove an access-list by name' /> + <param name='NAME' doc='The access-list to remove' /> + </params> + </command> + <command id='number-rewrite FILENAME'> + <params> + <param name='number-rewrite' doc='Set the file with rewriting rules.' /> + <param name='FILENAME' doc='Filename' /> + </params> + </command> + <command id='no number-rewrite'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='number-rewrite' doc='Set the file with rewriting rules.' /> + </params> + </command> + <command id='number-rewrite-post FILENAME'> + <params> + <param name='number-rewrite-post' doc='Set the file with post-routing rewriting rules.' /> + <param name='FILENAME' doc='Filename' /> + </params> + </command> + <command id='no number-rewrite-post'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='number-rewrite-post' doc='Set the file with post-routing rewriting rules.' /> + </params> + </command> + <command id='rewrite-smsc addr FILENAME'> + <params> + <param name='rewrite-smsc' doc='SMSC Rewriting' /> + <param name='addr' doc='The SMSC Address to match and replace in RP-DATA' /> + <param name='FILENAME' doc='File with rules for the SMSC Address replacing' /> + </params> + </command> + <command id='rewrite-smsc tp-dest-match FILENAME'> + <params> + <param name='rewrite-smsc' doc='SMSC Rewriting' /> + <param name='tp-dest-match' doc='Match TP-Destination of a SMS.' /> + <param name='FILENAME' doc='File with rules for matching MSISDN and TP-DEST' /> + </params> + </command> + <command id='sms-clear-tp-srr FILENAME'> + <params> + <param name='sms-clear-tp-srr' doc='SMS TPDU Sender Report Request clearing' /> + <param name='FILENAME' doc='Files with rules for matching MSISDN' /> + </params> + </command> + <command id='no sms-clear-tp-srr'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sms-clear-tp-srr' doc='SMS TPDU Sender Report Request clearing' /> + </params> + </command> + <command id='sms-number-rewrite FILENAME'> + <params> + <param name='sms-number-rewrite' doc='SMS TP-DA Number rewriting' /> + <param name='FILENAME' doc='Files with rules for matching MSISDN' /> + </params> + </command> + <command id='no sms-number-rewrite'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sms-number-rewrite' doc='Disable SMS TP-DA rewriting' /> + </params> + </command> + <command id='prefix-tree FILENAME'> + <params> + <param name='prefix-tree' doc='Prefix tree for number rewriting' /> + <param name='FILENAME' doc='File to load' /> + </params> + </command> + <command id='no prefix-tree'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='prefix-tree' doc='Prefix tree for number rewriting' /> + </params> + </command> + <command id='sdp-ensure-amr-mode-set'> + <params> + <param name='sdp-ensure-amr-mode-set' doc='Ensure that SDP records include a mode-set' /> + </params> + </command> + <command id='no sdp-ensure-amr-mode-set'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sdp-ensure-amr-mode-set' doc='Ensure that SDP records include a mode-set' /> + </params> + </command> + <command id='paging-bss-forward'> + <params> + <param name='paging-bss-forward' doc='Forward Paging messages with BSS as Cell Identity Discriminator' /> + </params> + </command> + <command id='no paging-bss-forward'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='paging-bss-forward' doc='Forward Paging messages with BSS as Cell Identity Discriminator' /> + </params> + </command> + <command id='paging-group <0-1000>'> + <params> + <param name='paging-group' doc='Create a Paging Group' /> + <param name='<0-1000>' doc='Number of the Group' /> + </params> + </command> + <command id='no paging-group <0-1000>'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='paging-group' doc='Delete paging-group' /> + <param name='<0-1000>' doc='Paging-group number' /> + </params> + </command> + <command id='bsc BSC_NR'> + <params> + <param name='bsc' doc='BSC configuration' /> + <param name='BSC_NR' doc='Identifier of the BSC' /> + </params> + </command> + </node> + <node id='config-nat-bsc'> + <name>config-nat-bsc</name> + <command id='token TOKEN'> + <params> + <param name='token' doc='Authentication token configuration' /> + <param name='TOKEN' doc='Token of the BSC, currently transferred in cleartext' /> + </params> + </command> + <command id='auth-key KEY'> + <params> + <param name='auth-key' doc='Authentication (secret) key configuration' /> + <param name='KEY' doc='Non null security key' /> + </params> + </command> + <command id='no auth-key'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='auth-key' doc='Authentication (secret) key configuration' /> + </params> + </command> + <command id='location_area_code <0-65535>'> + <params> + <param name='location_area_code' doc='Add the Location Area Code (LAC) of this BSC' /> + <param name='<0-65535>' doc='LAC' /> + </params> + </command> + <command id='no location_area_code <0-65535>'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='location_area_code' doc='Remove the Location Area Code (LAC) of this BSC' /> + <param name='<0-65535>' doc='LAC' /> + </params> + </command> + <command id='paging forbidden (0|1)'> + <params> + <param name='paging' doc='Paging' /> + <param name='forbidden' doc='Forbid sending PAGING REQUESTS to the BSC.' /> + <param name='0' doc='Do not forbid' /> + <param name='1' doc='Forbid' /> + </params> + </command> + <command id='description DESC'> + <params> + <param name='description' doc='Provide a description for the given BSC.' /> + <param name='DESC' doc='Description' /> + </params> + </command> + <command id='access-list-name NAME'> + <params> + <param name='access-list-name' doc='Set the name of the access list to use.' /> + <param name='NAME' doc='The name of the to be used access list.' /> + </params> + </command> + <command id='no access-list-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='access-list-name' doc='Do not use an access-list for the BSC.' /> + </params> + </command> + <command id='max-endpoints <1-1024>'> + <params> + <param name='max-endpoints' doc='Highest endpoint to use (exclusively)' /> + <param name='<1-1024>' doc='Number of ports' /> + </params> + </command> + <command id='paging group <0-1000>'> + <params> + <param name='paging' doc='Paging' /> + <param name='group' doc='Use a paging group' /> + <param name='<0-1000>' doc='Paging Group to use' /> + </params> + </command> + <command id='no paging group'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='paging' doc='Paging' /> + <param name='group' doc='Disable the usage of a paging group.' /> + </params> + </command> + <command id='osmux (on|off|only)'> + <params> + <param name='osmux' doc='RTP multiplexing' /> + <param name='on' doc='Enable OSMUX' /> + <param name='off' doc='Disable OSMUX' /> + <param name='only' doc='Only OSMUX' /> + </params> + </command> + <command id='bts-jitter-buffer'> + <params> + <param name='bts-jitter-buffer' doc='Uplink Jitter Buffer' /> + </params> + </command> + <command id='no bts-jitter-buffer'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='bts-jitter-buffer' doc='Uplink Jitter Buffer' /> + </params> + </command> + <command id='bts-jitter-buffer-delay-min <1-65535>'> + <params> + <param name='bts-jitter-buffer-delay-min' doc='Uplink Jitter Buffer Minimum Delay in ms' /> + <param name='<1-65535>' doc='Minimum Delay in ms' /> + </params> + </command> + <command id='bts-jitter-buffer-delay-max <1-65535>'> + <params> + <param name='bts-jitter-buffer-delay-max' doc='Uplink Jitter Buffer Maximum Delay in ms' /> + <param name='<1-65535>' doc='Maximum Delay in ms' /> + </params> + </command> + </node> + <node id='config-mgcp-trunk'> + <name>config-mgcp-trunk</name> + <command id='rtp keep-alive <1-120>'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + <param name='<1-120>' doc='Keep-alive interval in secs' /> + </params> + </command> + <command id='rtp keep-alive once'> + <params> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + <param name='once' doc='Send dummy packet only once after CRCX/MDCX' /> + </params> + </command> + <command id='no rtp keep-alive'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp' doc='RTP configuration' /> + <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' /> + </params> + </command> + <command id='sdp audio-payload number <0-255>'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='number' doc='Number' /> + <param name='<0-255>' doc='Payload Number' /> + </params> + </command> + <command id='sdp audio-payload name NAME'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='name' doc='Payload' /> + <param name='NAME' doc='Payload Name' /> + </params> + </command> + <command id='loop (0|1)'> + <params> + <param name='loop' doc='Loop audio for all endpoints on this trunk' /> + <param name='0' doc='Don't Loop' /> + <param name='1' doc='Loop' /> + </params> + </command> + <command id='rtcp-omit'> + <params> + <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> + </params> + </command> + <command id='no rtcp-omit'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtcp-omit' doc='Drop RTCP packets in both directions' /> + </params> + </command> + <command id='rtp-patch ssrc'> + <params> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='ssrc' doc='Force a fixed SSRC' /> + </params> + </command> + <command id='no rtp-patch ssrc'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='ssrc' doc='Force a fixed SSRC' /> + </params> + </command> + <command id='rtp-patch timestamp'> + <params> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='timestamp' doc='Adjust RTP timestamp' /> + </params> + </command> + <command id='no rtp-patch timestamp'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + <param name='timestamp' doc='Adjust RTP timestamp' /> + </params> + </command> + <command id='no rtp-patch'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='rtp-patch' doc='Modify RTP packet header in both directions' /> + </params> + </command> + <command id='sdp audio fmtp-extra .NAME'> + <params> + <param name='sdp' doc='Add extra fmtp for the SDP file' /> + <param name='audio' doc='Audio' /> + <param name='fmtp-extra' doc='Fmtp-extra' /> + <param name='.NAME' doc='Extra Information' /> + </params> + </command> + <command id='sdp audio-payload send-ptime'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> + </params> + </command> + <command id='no sdp audio-payload send-ptime'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' /> + </params> + </command> + <command id='sdp audio-payload send-name'> + <params> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-name' doc='Send SDP rtpmap with the audio name' /> + </params> + </command> + <command id='no sdp audio-payload send-name'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sdp' doc='SDP File related options' /> + <param name='audio-payload' doc='Audio payload options' /> + <param name='send-name' doc='Send SDP rtpmap with the audio name' /> + </params> + </command> + <command id='allow-transcoding'> + <params> + <param name='allow-transcoding' doc='Allow transcoding' /> + </params> + </command> + <command id='no allow-transcoding'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='allow-transcoding' doc='Allow transcoding' /> + </params> + </command> + </node> + <node id='config-nat-paging-group'> + <name>config-nat-paging-group</name> + <command id='location_area_code <0-65535>'> + <params> + <param name='location_area_code' doc='Add the Location Area Code (LAC)' /> + <param name='<0-65535>' doc='LAC' /> + </params> + </command> + <command id='no location_area_code <0-65535>'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='location_area_code' doc='Remove the Location Area Code (LAC)' /> + <param name='<0-65535>' doc='LAC' /> + </params> + </command> + </node> +</vtydoc> diff --git a/openbsc/doc/regen_doc.sh b/openbsc/doc/regen_doc.sh index 5552dec2c..12bb878f8 100755 --- a/openbsc/doc/regen_doc.sh +++ b/openbsc/doc/regen_doc.sh @@ -16,6 +16,7 @@ OSMO_NITB_BRANCH=$COMMIT ./regen_doc.sh osmo-nitb 4242 \ "$MANUAL_DIR/OsmoNITB/chapters/counters_generated.adoc" \ "$MANUAL_DIR/OsmoNITB/vty/nitb_vty_reference.xml" -#OSMO_BSCNAT_BRANCH=$COMMIT ./regen_doc.sh osmo-bscnat 4244 \ -# "$MANUAL_DIR/OsmoBSCNAT/chapters/counters_generated.adoc" \ -# "$MANUAL_DIR/OsmoBSCNAT/vty/nat_vty_reference.xml" +OSMO_BSCNAT_BRANCH=$COMMIT ./regen_doc.sh osmo-nitb 4244 \ + "$MANUAL_DIR/OsmoBSCNAT/chapters/counters_generated.adoc" \ + "$MANUAL_DIR/OsmoBSCNAT/vty/nat_vty_reference.xml" \ + "osmo-bsc_nat -c /data/osmo-bsc-nat.cfg" |