Cellular Network Infrastructure » cni-legacy » OpenBSC » OsmoNITB

[[PageOutline]]

This page is a reference fo all VTY commands that you can use interactively on the OpenBSC VTY telnet interface (port 4242 by default).

In addition, the same commands are used for the configuration file.

== configuration reference ==

=== e1_input level ===

At the e1_line level, you configure which E1 line number is using which driver

==== e1_line <0-255> driver (misdn|dahdi) ====

You can specify which of your line numbers shall be using which driver.

==== e1_line <0-255> port <0-255> ====

Configure the port number of the underlying driver subsystem to be used for a given OpenBSC line number.

This establishes the mapping between e.g. mISDN port number 3 and OpenBSC line 1:

{{{e1_line 1 port 3}}}

=== log file FILENAME ===

Configure the logging parameters for logging to the indicated text file

=== log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp) ===

Configure logging via {{{syslogd}}} using the facility as indicated.

=== log syslog local <0-7> ===

Configure logging via {{{syslogd}}} using the facility LOG_LOCAL0...LOG_LOCAL7

=== log stderr ===

Configure logging via stderr of the process

=== Commands below the log level ===

The following commands work on any 'log level' command, independent of stderr/syslog/file based logging.

==== logging filter all (0|1) ====

Define whether to use the '''filter all''', i.e. to match and log all messages.

==== logging color (0|1) ====

Define whether to use color when writing log lines.

==== logging timestamp (0|1) ====

Define whether the log statements should include a timestamp.

==== logging level SUBSYS LEVEL ====

=== mncc-int level ===

==== default-codec tch-f (fr|efr|amr) ====

Set the default speech codec to be used on TCH/F channels

==== default-codec tch-h (hr|amr) ====

Set the default speech codec to be used on TCH/H channels

=== network level ===

At the network level, we specify parameters that are global for an entire GSM network.

==== network country code ====

The network country code (NCC) to be used for this network.  Default is 1.

==== mobile network code ====

The mobile network code (MNC) to be used for this network.  Default is 1.

==== short name ====

This is the short network name to be used in the GSM 04.08 MM INFO message.

==== long name ====

This is the long network name to be used in the GSM 04.08 MM INFO message.

==== auth policy ====

This defines the authentication policy of the network.  Possible values are:

 * ''closed'': Don't allow anyone who is not marked as authorized=1 in the hlr database

 * ''accept-all': Accept everyone into the network

 * ''token'': Use a special [wiki:TokenAuthPolicy]

==== location updating reject cause <2-111> ====

Set the CAUSE value when sending LOCATION UPDATING REJECT to a MS.  Possible values are

defined in GSM TS 04.08 / 10.5.3.6.

==== encryption a5 (0|1|2) ====

* Enable/Disable A5/X encryption on the network.

==== neci (0|1) ====

Changes the Cell Selection Parameter called NECI Half Rate Support.

 * "0": New establishment causes are not supported.

 * "1": New establishment causes are supported.

==== rrlp mode (none|ms-based|ms-preferred|ass-preferred) ====

Set the RRLP mode, i.e. if OpenBSC should routinely send RRLP inquiries to phones and store the response

 * none: Do not perform RRLP inquiries

 * ms-based: Ask for a MS-Based location

 * ms-preferred: Ask for a location, MS based is preferred over Network Assistance based

 * ass-preferred: Ask for a location, Netowrk Assistance based is preferred over MS based

==== mm info (0|1) ====

Should we send MM INFO messages with network name and timezone information?

==== handover (0|1) ====

Should the BSC enable in-call handover between multiple BTS?

==== handover window rxlev averaging <1-10> ====

Over how many SACCH frames should the Rx Level of the serving cell be averaged?

==== handover window rxqual averaging <1-10> ====

Over how many SACCH frames should the Rx Quality of the serving cell be averaged?

==== handover window rxlev neighbor averaging <1-10> ====

Over how many SACCH frames should the Rx Level of a neighbor cell be averaged?

==== handover power budget interval <1-99> ====

Every how many SACCH frames should the BSC think about performing a power budget (rx level)

handover?

==== handover power budget hysteresis <0-999> ====

How large should the hysteresis be, i.e. to prevent continuous handover back and forth

==== handover maximum distance <0-9999> ====

What is the maximum distance from a BTS, after which we try to perform distance handover?

==== timer t3101 <0-65535> ====

 * Started after IMMEDIATE ASSIGMENT, should be higher than the time for a L2 establishment attempt

==== timer t3103 <0-65535> ====

 * Started by sending a HANDOVER message. This timer is currently not in use.

==== timer t3105 <0-65535> ====

 * Used for the repetition of the PHYSICAL INFORMATION message during handover. This timer is currently not in use.

==== timer t3107 <0-65535> ====

 * Started after ASSIGMENT COMMAND to keep the old channel long enough alive. This timer is currently not in use due the usage of very early assignment in Call Control

==== timer t3109 <0-65535> ====

 * The purpose of this timer is to release channels in case of loss of communucation.

==== timer t3111 <0-65535> ====

 * GSM Spec: This timer value is equal to T3110 and is used to delay the channel deactivation after disconnecting the main signalling link.

 * OpenBSC will wait t3111 seconds after all SAPIs were released to send the RF Channel Release to the BTS. After the following RF Channel Release ACK OpenBSC will reuse the channel for further requests.

==== timer t3113 <0-65535> ====

 * This timer is used for the PAGING REQUEST

==== timer t3115 <0-65535> ====

 * This timer is used for the repetition of the VGCS UPLINK GRANT message, it is currently not in use.

==== timer t3117 <0-65535> ====

 *  This is started after sending the PDCH ASSIGNMENT COMMAND

==== timer t3119 <0-65535> ====

 * This is started after sending the RR-CELL CHANGE ORDER message.

==== timer t3141 <0-65535> ====

==== dtx-used (0|1) ====

Enable or disable the use of DTX (discontinuous transmission)

==== subscriber-keep-in-ram (0|1) ====

Determine whether subscriber database should be kept in RAM or not

==== paging any sue tch (0|1) ====

Whether or not the BSC should allocate a TCH for RACH requests indicating 'any channel'

==== [bsc_msc_ip] ipacc rtp_payload <0-256> ====

 * This option is currently only available in the on-waves/bsc-master branch (but it will be merged in one way or another).

 * This configuration will override the RTP Payload in the MDCX message to not use the returned value by the nanoBTS but use this network setting.

==== [bsc_msc_ip] rtp base <0-65534> ====

 * This option is currently only available in the on-waves/bsc-master branch (but it will be merged in one way or another).

 * In the bsc_msc_ip sceneriao the BSC and the MGCP do not communicate with each other. To make it work they will need to share the secret of the base port.

==== [bsc_msc_ip] core mobile network code <1-999> ====

 * A network specific hack

 * Be able to use a different network code inside the A communication than used on A-bis.

 * This way one can differentiate networks on the phone but use the same one in the core network

==== [bsc_msc_ip] token TOKEN ====

 * Send this token to the MSC when asked for the id.

 * It can be any text..

 * This is a very weak authentication scheme.

==== [bsc_msc_ip] msc ip IP ====

 * The IP address to use when attempting to connect to the MSC.

==== [bsc_msc_ip] msc port PORT ====

 * The port to use when attempting to connect to the MSC.

==== [bsc_msc_ip] msc ip-tos TOS ====

 * The IP Type of Service (TOS) to use for the connection to the MSC.

=== bts level ===

At the BTS level, we define parameters that are global for this particular BTS.

==== type ====

The type of the BTS.  Currently supported;

 * ''bs-11''

 * ''nanobts''

==== band ====

The GSM band of the BTS.  Currently supported:

 * GSM400

 * GSM850

 * GSM900

 * DCS1800

 * PCS1900

==== cell_identity <0-65535> ====

The Cell Identity of this BTS

==== location_area_code <0-65535> ====

The LAC of the location area to which this BTS belongs.

==== training_sequence_code <0-255> ====

Set the Training Sequence Code (TSC) of this BTS

==== base_station_id_code <0-63> ====

The BSIC of this BTS within the location area.

==== ip.access unit_id ====

The ip.access Unit ID.  Unit ID is used to identify the BTS to the BSC.  E.g.:

{{{

ip.access unit_id 1801 0

}}}

You need to use the same Unit ID in the BTS as well as in OpenBSC.  If you connect nanoBTS, you may use [wiki:ipaccess-config] program to change its Unit ID.  If you connect [wiki:OsmoBTS], set `ipa unit-id` in OsmoBTS config.  E.g.:

{{{

ip unit-id 1801 0

}}}

In order to connect another BTS, you usually need to change just the first number: e.g. `1802 0`.

==== oml ip.access stream_id <0-255> ====

Which IPA stream identifier is to be used for the OML link between BTS and BSC.

==== oml e1 tei ====

The Q.921 TEI to be used for the A-bis OML link of this BTS.

Make sure you use the same value than you have set in the BTS (by bs11-config or LMT).

==== oml hsl line E1_LINE ====

Configure the virtual E1 line to be used for a HSL type BTS

==== oml e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3|full) ====

Set the E1 line, E1 timeslot and E1 sub-slot for the OML link to this BTS.

Make sure you use the same value than you have set in the BTS (by bs11-config or LMT).

==== oml e1 tei <0-63> ====

Configure the LAPD TEI used for the OML DLC of the given BTS

==== channel allocator (ascending|descending) ====

Whether the channels should be allocated in ascending or descending order.

If the channel allocator is in ascending mode, it will first allocate timeslot 0, then timeslot 1, ... of TRX0. If TRX0 is full, it will switch to TRX1.  In descending order, it is the other way around.

==== rach tx integer <0-15> ====

The RACH TX Integer announced on the BCCH in System Information messages

==== rach max transmission (1|2|4|7) ====

How many retransmissions should a MS make on a RACH request?

==== rach nm busy threshold <0-255> ====

Threshold to be set in the BTS for RACH/CCCH load indications

==== rach nm load average <0-65535> ====

Load averaging to be set in the BTS for RACH/CCCH load indications

==== rach emergency call allowed (0|1) ====

'''ATTENTION: Only use this option when you know what you are doing and can route emergency calls to a proper place.'''

This setting is used in the System Information on the BCCH and indicates if this cell can be used to do emergency calls. The default value for this option is 0.

==== cell barred (0|1) ====

Whether this BTS is barred from access or not.

==== ms max power <0-40> ====

maximum transmit power (in dBm) to be used by MS in this BTS.  This is used in the System Information on the BCCH as

well as for the MS power level at the time a dedicated channel is activated.

==== periodic location update <0-1530> ====

Periodic Location Updating interval in minutes.

If you set this to a non-zero value, every MS will perform a periodic location updating procedure at the given interval.

A value of 0 will deactivate periodic location updating.

==== cell reselection hysteresis <0-14> ====

How many dB has a neighbor cell to be received better than the serving cell to perform cell reselection in idle mode.

==== rxlev access min <0-63> ====

How strong has the signal to be received at the MS, before a MS is allowed to switch to this cell in idle mode?

==== cell bar qualify (0|1) ====

FIXME

==== cell reselection offset <0-126> ====

Set the Cell Reselection Offset (CRO), a parameter involved in the cell (re)selection algorithm used by mobile

stations in idle mode.

==== temporary offset <0-60> ====

Set the temporary offset parameter for cell (re)selection.

==== temporary offset infinite ====

Set the temporary offset parameter for cell (re)selection.

==== penalty time <20-620> ====

Set the penalty time parameter for cell (re)selection.

==== penalty time reserved ====

Set the penalty time parameter for cell (re)selection.

==== gprs mode (none|gprs|egprs) ====

Do you want to enable GPRS or EGPRS (EDGE) on this BTS?

==== gprs routing area <0-255> ====

To which GPRS routing area does this BTS belong?

==== gprs cell bvci <0-65535> ====

BSGP Virtual Connection Identifier

==== gprs cell timer (blocking-timer|blocking-retries|unblocking-retries|reset-timer|reset-retries|suspend-timer|suspend-retries|resume-timer|resume-retries|capability-update-timer|capability-update-retries) <0-255> ====

Set a variety of GPRS related timers

==== gprs nsei <0-65535> ====

NS Entity Identifier

==== gprs nsvc <0-1> nsvci <0-65535> ====

NS Virtual Connection Identifier

==== gprs nsvc <0-1> local udp port <0-65535> ====

The local UDP port (on the BTS) to be used for NS-over-IP

==== gprs nsvc <0-1> remote udp port <0-65535> ====

The remote UDP port (of the SGSN) to be used for NS-over-IP

==== gprs nsvc <0-1> remote ip A.B.C.D ====

The remote IP address (of the SGSN) to be used for NS-over-IP

==== paging free FREE_NR ====

FIXME

==== system-information (1|2|3|4|5|6|7|8|9|10|13|16|17|18|19|20|2bis|2ter|2quater|5bis|5ter) mode (static|computed) ====

Switch the specified system information message between regular (computed) mode, and static mode.

==== system-information (1|2|3|4|5|6|7|8|9|10|13|16|17|18|19|20|2bis|2ter|2quater|5bis|5ter) static HEXSTRING ====

Specify (as a hex string) the static content of the system information message.  This only works if mode is set to static.

==== neighbor-list mode (automatic|manual|manual-si5) ====

Switch the neighbor list generation between three modes

 * automatic: automatically generate list of neigbor cells in all SI

 * manual: manually specify the list of neighbor cells in all SI

 * manual-si5: automatically generate list of neighbor cells on BCCH but manually specify it for SACCH/SI5

==== neighbor-list (add|del) arfcn <0-1023> ====

Add or delete an ARFCN from the manual neighbor list for BCCH+SACCH

==== si5 neighbor-list (add|del) arfcn <0-1023> ====

Add or delete an ARFCN from the manual neighbor list for SACCH/SI5

==== is-connection-list (add|del) <0-2047> <0-2047> <0-255> ====

Vendor-specific configuration of the IS (Interface Switch) in Ericsson RBS2000.  Please refer to vendor documentation.

=== trx level ===

At the trx level, we specify parameters for one particular TRX (transceiver).

==== arfcn ====

The ARFCN of a non-hopping TRX.

==== description .TEXT ====

Free-format textual description of this TRX

==== nominal power <0-100> ====

How many dBm is the nominal power of this BTS.  This setting is only used as a base for computing

power levels displayed to the user.

==== max_power_red <0-100> ====

How many dB the nominal transmit power of the TRX should be reduced from its maximum (by OML means)

If your transmitter is set to e.g. 24 dBm and you set this to 10, your actual output power will be 14 dBm.

==== rf_locked (0|1) ====

This option can be used at start and at runtime to enable/disable RF of the transceiver.

 * "0": RF is not locked (enabled)

 * "1": RF is locked (disabled)

==== rsl e1 tei <0-63> ====

The Q.921 TEI to be used for the A-bis RSL link between BTS and BSC.

Make sure you don't use the same TEI twice in one E1 Link!

==== rsl e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3|full) ====

Set the E1 Line, E1 timeslot and E1 sub-slot for the RSL link to this BTS.

=== timeslot level ===

The timeslot level lists parameters for one specific on-air timeslot.

==== phys_chan_config ====

Set the physical channel configuration of this GSM on-air timeslot:

 * ''NONE'': do not use this timeslot

 * ''CCCH'': regular CCCH configuration (BCCH+RACH+PCH+AGCH)

 * ''CCCH+SDCCH4'': CCCH plus SDCCH/4 combination

 * ''TCH/F'': Full TCH

 * ''TCH/H'': Half TCH

 * ''SDCCH8'': SDCCH/8 combination

 * ''PDCH'': Packed Data CHannel

 * ''TCH/F_PDCH'': Alternating TCH/F and PDCH use

==== e1 line e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3) ====

Set the E1 line, E1 timeslot and E1 sub-slot to be used for this on-air timeslot if it is used as a TCH.

The TRAU frames for this on-air timeslot will be sent to the sub-slot you have specified here.

==== training_sequence_code <0-7> ====

Set the TSC for this given timeslot

==== hopping enabled (0|1) ====

Enalbe or disable frequency hopping on this timeslot

==== hopping sequence-number <0-63> ====

Set the HSN for this timeslot

==== hopping maio <0-63> ====

Set the MAIO (Mobile Allocation Index Offset) for this timeslot

==== hopping arfcn (add|del) <0-1023> ====

Add or delete an ARFCN to the list of hopping channels

== Runtime Options ==

The [wiki:osmo-nitb] application listens on port 4242 on localhost and one can use telnet to connect to it. With the VTY interface one can use commands to inspect the state of OpenBSC, change the configuration and schedule work. Typing '?' will print a list of commands that are available in this screen and with tab completion one can complete command.

=== Subscriber commands ===

 * OpenBSC VTY has multiple ways to address a subscriber. It can be addressed by IMSI, by TMSI, the assigned extension and finally the id inside the database.

==== subscriber (extension|imsi|tmsi|id) ID sms send TEXT ====

 {{{OpenBSC> subscriber extension 666 sms send "Hello"}}}

 * The above command will allow you to send a SMS to the subscriber.

==== subscriber (extension|imsi|tmsi|id) ID silent-sms send TEXT ====

==== subscriber (extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch) ====

==== subscriber (extension|imsi|tmsi|id) ID silent-call stop ====

==== subscriber (extension|imsi|tmsi|id) ID ussd-notify (0|1|2) TEXT ====

==== subscriber (extension|imsi|tmsi|id) ID update ====

==== subscriber (extension|imsi|tmsi|id) ID name .NAME ====

Assign a name with a given subscriber

==== subscriber (extension|imsi|tmsi|id) ID extension EXTENSION ====

Set / Change the phone number of a given subscriber

==== subscriber (extension|imsi|tmsi|id) ID authorized (0|1) ====

Authorize (1) or unauthorize (0) a given subscriber

==== subscriber (extension|imsi|tmsi|id) ID a3a8 (none|xor|comp128v1) [KI] ====

Set the authentication algorithm and optionally the Ki for a given subscriber

==== subscriber (extension|imsi|tmsi|id) ID clear-requests ====

Clear any pending paging requests for the given subscriber

==== subscriber (extension|imsi|tmsi|id) ID show-pending ====

Show any pending paging requests for the given subscriber

==== subscriber (extension|imsi|tmsi|id) ID kick-pending ====

Clear any pending paging requests for the given subscriber

==== subscriber purge-inactive ====

Purge subscribers with zero use count from RAM

=== show statistics ===

This will display some runtime statistics like this:

{{{

OpenBSC> show statistics

Channel Requests        : 0 total, 0 no channel

Channel Failures        : 0 rf_failures, 0 rll failures

Paging                  : 0 attempted, 0 complete, 0 expired

BTS failures            : 0 OML, 0 RSL

Channel Requests        : 0 total, 0 no channel

Location Update         : 0 attach, 0 normal, 0 periodic

IMSI Detach Indications : 0

Location Update Response: 0 accept, 0 reject

Handover                : 0 attempted, 0 no_channel, 0 timeout, 0 completed, 0 failed

SMS MO                  : 0 submitted, 0 no receiver

SMS MT                  : 0 delivered, 0 no memory, 0 other error

MO Calls                : 0 setup, 0 connect ack

MT Calls                : 0 setup, 0 connect

}}}

=== show logging vty ===

displays the logging configuration for the current VTY

=== show e1_driver ===

displays a list of all supported E1 / abis input drivers

{{{

OpenBSC> show e1_driver

E1 Input Driver misdn

E1 Input Driver misdn_lapd

E1 Input Driver dahdi

E1 Input Driver ipa

E1 Input Driver hsl

E1 Input Driver rs232

}}}

=== show e1_line [line_nr] [stats] ===

display statistics regarding the specified E1 line

OpenBSC> show e1_line 0 stats

{{{

E1 Line Number 0, Name , Driver ipa

 E1 Input subsystem:

  HDLC abort:        0 (0/s 0/m 0/h 0/d)

  HLDC Bad FCS:        0 (0/s 0/m 0/h 0/d)

  HDLC Overrun:        0 (0/s 0/m 0/h 0/d)

  Alarm:        0 (0/s 0/m 0/h 0/d)

  Line removed:        0 (0/s 0/m 0/h 0/d)

}}}

=== show e1_timeslot [line_nr] [ts_nr] === 

display information about a E1 timeslot.

=== show network ===

{{{

OpenBSC> show network    

BSC is on Country Code 262, Network Code 88 and has 1 BTS

  Long network name: 'OpenBSC'

  Short network name: 'OpenBSC'

  Authentication policy: closed

  Location updating reject cause: 13

  Encryption: A5/0

  NECI (TCH/H): 1

  Use TCH for Paging any: 0

  RRLP Mode: none

  MM Info: On

  Handover: Off

  Current Channel Load:

}}}

=== show bts [bts_nr] ===

{{{

OpenBSC> show bts

BTS 0 is of nanobts type in band DCS1800, has CI 0 LAC 1, BSIC 63, TSC 7 and 1 TRX

Description: (null)

MS Max power: 15 dBm

Minimum Rx Level for Access: -110 dBm

Cell Reselection Hysteresis: 4 dBm

RACH TX-Integer: 9

RACH Max transmissions: 7

System Information present: 0x00000000, static: 0x00000000

  Unit ID: 8888/0/0, OML Stream ID 0xff

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

  Site Mgr NM State: Oper 'NULL', Admin 0, Avail 'Power off'

  Paging: 0 pending requests, 0 free slots

  OML Link state: disconnected.

  Current Channel Load:

}}}

=== show trx [bts_nr] [trx_nr] ===

{{{

OpenBSC> show trx

TRX 0 of BTS 0 is on ARFCN 871

Description: (null)

  RF Nominal Power: 23 dBm, reduced by 0 dB, resulting BS power: 23 dBm

  NM State: Oper 'NULL', Admin 2, Avail 'Power off'

  Baseband Transceiver NM State: Oper 'NULL', Admin 0, Avail 'Power off'

  ip.access stream ID: 0x00

}}}

=== show timeslot [bts_nr] [trx_nr] [ts_nr] ===

{{{

OpenBSC> show timeslot 

BTS 0, TRX 0, Timeslot 0, phys cfg CCCH, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 1, phys cfg SDCCH8, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 2, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 3, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 4, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 5, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 6, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

BTS 0, TRX 0, Timeslot 7, phys cfg TCH/H, TSC 7

  NM State: Oper 'NULL', Admin 0, Avail 'Power off'

}}}

=== show subscriber (extension|imsi|tms|id) ID ===

display information about a given subscriber

{{{

OpenBSC> show subscriber id 1

    ID: 1, Authorized: 1

    Name: ''

    Extension: 2342

    LAC: 1/0x1

    IMSI: 262022080345046

    TMSI: 4DB8B4D8

    Pending: 0

    Use count: 1

}}}