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.

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

== configuration reference ==

=== 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> ====

==== [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.

=== 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.  You set the Unit ID of the BTS by using the [wiki:ipaccess-config] program.  Make sure you use the same Unit ID in the nanoBTS as well as in OpenBSC.

==== 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 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).

==== channel allocator ====

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?

==== 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?

==== gprs enabled (0|1) ====

Is GPRS enabled on this BTS at all?

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

To which GPRS routing area does this BTS belong?

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

BSGP Virtual Connection Identifier

==== 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

=== trx level ===

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

==== arfcn ====

The ARFCN of a non-hopping 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.

== Runtime Options ==

The bsc_hack 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) NUMBER sms TEXT ====

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

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