diff options
Diffstat (limited to 'doc/manuals/vty/bsc_vty_reference.xml')
| -rw-r--r-- | doc/manuals/vty/bsc_vty_reference.xml | 169 |
1 files changed, 128 insertions, 41 deletions
diff --git a/doc/manuals/vty/bsc_vty_reference.xml b/doc/manuals/vty/bsc_vty_reference.xml index f56b951ec..9992267fb 100644 --- a/doc/manuals/vty/bsc_vty_reference.xml +++ b/doc/manuals/vty/bsc_vty_reference.xml @@ -152,6 +152,14 @@ <param name='[<0-255>]' doc='TRX Number' /> </params> </command> + <command id='show trx (connected|disconnected)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='trx' doc='Display information about a TRX' /> + <param name='connected' doc='Show TRX with RSL connected' /> + <param name='disconnected' doc='Show TRX with RSL disconnected' /> + </params> + </command> <command id='show timeslot [<0-255>] [<0-255>] [<0-7>]'> <params> <param name='show' doc='Show running system information' /> @@ -175,13 +183,31 @@ <params> <param name='show' doc='Show running system information' /> <param name='lchan' doc='Display information about a logical channel' /> - <param name='summary' doc='Short summary' /> + <param name='summary' doc='Short summary (used lchans)' /> + <param name='[<0-255>]' doc='BTS Number' /> + <param name='[<0-255>]' doc='TRX Number' /> + <param name='[<0-7>]' doc='Timeslot Number' /> + <param name='[<0-7>]' doc='Logical Channel Number' /> + </params> + </command> + <command id='show lchan summary-all [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='lchan' doc='Display information about a logical channel' /> + <param name='summary-all' doc='Short summary (all lchans)' /> <param name='[<0-255>]' doc='BTS Number' /> <param name='[<0-255>]' doc='TRX Number' /> <param name='[<0-7>]' doc='Timeslot Number' /> <param name='[<0-7>]' doc='Logical Channel Number' /> </params> </command> + <command id='show timer [TNNNN]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='timer' doc='Show timers' /> + <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> + </params> + </command> <command id='show conns'> <params> <param name='show' doc='Show running system information' /> @@ -294,7 +320,7 @@ <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|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|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' /> @@ -335,6 +361,7 @@ <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' /> @@ -424,13 +451,6 @@ <param name='REGEXP' doc='Regular expression' /> </params> </command> - <command id='show timer [TNNNN]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='timer' doc='GSM Timers' /> - <param name='[TNNNN]' doc='Specific timer to show, or all timers if omitted.' /> - </params> - </command> <command id='show bts <0-255> neighbor arfcn <0-1023> bsic (<0-63>|any)'> <params> <param name='show' doc='Show running system information' /> @@ -759,6 +779,14 @@ <param name='[<0-255>]' doc='TRX Number' /> </params> </command> + <command id='show trx (connected|disconnected)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='trx' doc='Display information about a TRX' /> + <param name='connected' doc='Show TRX with RSL connected' /> + <param name='disconnected' doc='Show TRX with RSL disconnected' /> + </params> + </command> <command id='show timeslot [<0-255>] [<0-255>] [<0-7>]'> <params> <param name='show' doc='Show running system information' /> @@ -782,13 +810,31 @@ <params> <param name='show' doc='Show running system information' /> <param name='lchan' doc='Display information about a logical channel' /> - <param name='summary' doc='Short summary' /> + <param name='summary' doc='Short summary (used lchans)' /> <param name='[<0-255>]' doc='BTS Number' /> <param name='[<0-255>]' doc='TRX Number' /> <param name='[<0-7>]' doc='Timeslot Number' /> <param name='[<0-7>]' doc='Logical Channel Number' /> </params> </command> + <command id='show lchan summary-all [<0-255>] [<0-255>] [<0-7>] [<0-7>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='lchan' doc='Display information about a logical channel' /> + <param name='summary-all' doc='Short summary (all lchans)' /> + <param name='[<0-255>]' doc='BTS Number' /> + <param name='[<0-255>]' doc='TRX Number' /> + <param name='[<0-7>]' doc='Timeslot Number' /> + <param name='[<0-7>]' doc='Logical Channel Number' /> + </params> + </command> + <command id='show timer [TNNNN]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='timer' doc='Show timers' /> + <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> + </params> + </command> <command id='show conns'> <params> <param name='show' doc='Show running system information' /> @@ -925,7 +971,7 @@ <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|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|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' /> @@ -966,6 +1012,7 @@ <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' /> @@ -1055,13 +1102,6 @@ <param name='REGEXP' doc='Regular expression' /> </params> </command> - <command id='show timer [TNNNN]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='timer' doc='GSM Timers' /> - <param name='[TNNNN]' doc='Specific timer to show, or all timers if omitted.' /> - </params> - </command> <command id='show bts <0-255> neighbor arfcn <0-1023> bsic (<0-63>|any)'> <params> <param name='show' doc='Show running system information' /> @@ -1172,11 +1212,14 @@ <param name='assignment' doc='Manually trigger assignment (for debugging)' /> </params> </command> - <command id='bts <0-255> smscb-command <1-4> HEXSTRING'> + <command id='bts <0-255> smscb-command (normal|schedule|default) <1-4> HEXSTRING'> <params> <param name='bts' doc='BTS related commands' /> <param name='<0-255>' doc='BTS Number' /> <param name='smscb-command' doc='SMS Cell Broadcast' /> + <param name='normal' doc='Normal (one-shot) SMSCB Message; sent once over Abis+Um' /> + <param name='schedule' doc='Schedule (one-shot) SMSCB Messag; sent once over Abis+Um' /> + <param name='default' doc='Default (repeating) SMSCB Message; sent once over Abis, unlimited ovrer Um' /> <param name='<1-4>' doc='Last Valid Block' /> <param name='HEXSTRING' doc='Hex Encoded SMSCB message (up to 88 octets)' /> </params> @@ -1790,7 +1833,7 @@ <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|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|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' /> @@ -1831,6 +1874,7 @@ <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' /> @@ -1961,10 +2005,11 @@ <param name='login' doc='Enable password checking' /> </params> </command> - <command id='bind A.B.C.D'> + <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> @@ -2470,12 +2515,12 @@ <param name='NAME' doc='Name string, up to 31 characters' /> </params> </command> - <command id='timer TNNNN (default|<1-65535>)'> + <command id='timer [TNNNN] [(<0-2147483647>|default)]'> <params> - <param name='timer' doc='Configure GSM Timers' /> - <param name='TNNNN' doc='T-number, optionally preceded by 't' or 'T'.See also 'show timer' for a list of available timers.' /> - <param name='default' doc='Set to default timer value' /> - <param name='<1-65535>' doc='Timer value' /> + <param name='timer' doc='Configure or show timers' /> + <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format '1234' or 'T1234' or 't1234'; Osmocom-specific timer number of the format: 'X1234' or 'x1234'.' /> + <param name='[<0-2147483647>]' doc='New timer value' /> + <param name='[default]' doc='Set to default timer value' /> </params> </command> <command id='neci (0|1)'> @@ -2960,6 +3005,13 @@ <param name='<0-7>' doc='Number of blocks reserved for access grant' /> </params> </command> + <command id='ccch load-indication-threshold <0-100>'> + <params> + <param name='ccch' doc='Common Control Channel' /> + <param name='load-indication-threshold' doc='Percentage of CCCH load at which BTS sends RSL CCCH LOAD IND' /> + <param name='<0-100>' doc='CCCH Load Threshold in percent (Default: 10)' /> + </params> + </command> <command id='rach nm busy threshold <0-255>'> <params> <param name='rach' doc='Random Access Control Channel' /> @@ -3117,7 +3169,7 @@ <param name='1' doc='Enable 11 bit RACH for EGPRS' /> </params> </command> - <command id='gprs ns timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries) <0-255>'> + <command id='gprs ns timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) <0-255>'> <params> <param name='gprs' doc='GPRS Packet Network' /> <param name='ns' doc='Network Service' /> @@ -3129,6 +3181,7 @@ <param name='tns-test' doc='Test Timer (Tns-test) timeout' /> <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' /> <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' /> + <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' /> <param name='<0-255>' doc='Timer Value' /> </params> </command> @@ -3301,6 +3354,19 @@ <param name='HEXSTRING' doc='Static user-specified SI content in HEX notation' /> </params> </command> + <command id='system-information unused-send-empty'> + <params> + <param name='system-information' doc='System Information Messages' /> + <param name='unused-send-empty' doc='Send BCCH Info with empty 'Full BCCH Info' TLV to notify disabled SI. Some nanoBTS fw versions are known to fail upon receival of these messages.' /> + </params> + </command> + <command id='no system-information unused-send-empty'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='system-information' doc='System Information Messages' /> + <param name='unused-send-empty' doc='Avoid sending BCCH Info with empty 'Full BCCH Info' TLV to notify disabled SI. Some nanoBTS fw versions are known to fail upon receival of these messages.' /> + </params> + </command> <command id='early-classmark-sending (allowed|forbidden)'> <params> <param name='early-classmark-sending' doc='Early Classmark Sending' /> @@ -3319,7 +3385,7 @@ <params> <param name='neighbor-list' doc='Neighbor List' /> <param name='mode' doc='Mode of Neighbor List generation' /> - <param name='automatic' doc='Automatically from all BTS in this OpenBSC' /> + <param name='automatic' doc='Automatically from all BTS in this BSC' /> <param name='manual' doc='Manual' /> <param name='manual-si5' doc='Manual with different lists for SI2 and SI5' /> </params> @@ -3868,6 +3934,19 @@ <param name='<1-10>' doc='Set the number of Access Control Classes to enable per ramping step' /> </params> </command> + <command id='timer-dynamic TNNNN'> + <params> + <param name='timer-dynamic' doc='Calculate T3113 dynamically based on channel config and load' /> + <param name='TNNNN' doc='T-number, optionally preceded by 't' or 'T'' /> + </params> + </command> + <command id='no timer-dynamic TNNNN'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='timer-dynamic' doc='Set given timer to non-dynamic and use the default or user provided fixed value' /> + <param name='TNNNN' doc='T-number, optionally preceded by 't' or 'T'' /> + </params> + </command> <command id='neighbor bts <0-255>'> <params> <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' /> @@ -4573,11 +4652,19 @@ <param name='forbidden' doc='Forbidden' /> </params> </command> - <command id='lcls-mode (disabled|mgw-loop)'> + <command id='amr-payload (octet-aligned|bandwith-efficient'> + <params> + <param name='amr-payload' doc='Set AMR payload framing mode' /> + <param name='octet-aligned' doc='payload fields aligned on octet boundaries' /> + <param name='bandwith-efficient' doc='payload fields packed (AoIP)' /> + </params> + </command> + <command id='lcls-mode (disabled|mgw-loop|bts-loop)'> <params> <param name='lcls-mode' doc='Configure 3GPP LCLS (Local Call, Local Switch)' /> <param name='disabled' doc='Disable LCLS for all calls of this MSC' /> - <param name='mgw-loop' doc='Enable LCLS with loopping traffic in MGW' /> + <param name='mgw-loop' doc='Enable LCLS with looping traffic in MGW' /> + <param name='bts-loop' doc='Enable LCLS with looping traffic between BTS' /> </params> </command> <command id='lcls-codec-mismatch (allowed|forbidden)'> @@ -4647,19 +4734,11 @@ <param name='<0-65535>' doc='remote port' /> </params> </command> - <command id='mgw endpoint-range <1-65534> <1-65534>'> + <command id='mgw endpoint-domain NAME'> <params> <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> - <param name='endpoint-range' doc='usable range of endpoint identifiers' /> - <param name='<1-65534>' doc='set first usable endpoint identifier' /> - <param name='<1-65534>' doc='set last usable endpoint identifier' /> - </params> - </command> - <command id='mgw bts-base <0-65534>'> - <params> - <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> - <param name='bts-base' doc='First UDP port allocated for the BTS side' /> - <param name='<0-65534>' doc='UDP Port number' /> + <param name='endpoint-domain' doc='Set the domain name to send in MGCP messages, e.g. the part 'foo' in 'rtpbridge/*@foo'.' /> + <param name='NAME' doc='Domain name, should be alphanumeric.' /> </params> </command> <command id='mgw x-osmo-ign call-id'> @@ -4676,6 +4755,14 @@ <param name='x-osmo-ign' doc='Do not send X-Osmo-IGN MGCP header to this MSC' /> </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> </node> <node id='om2k'> <name>om2k</name> |