From 7f3d8ea4d371b7ff4a90c7a7fba11d167d8ab537 Mon Sep 17 00:00:00 2001 From: Max Date: Wed, 4 May 2016 14:52:15 +0200 Subject: Add OsmoBSC control interface description --- doc/manuals/chapters/control.adoc | 99 +++++++++++++++++++++++++++++++++++++ doc/manuals/osmobsc-usermanual.adoc | 2 + 2 files changed, 101 insertions(+) create mode 100644 doc/manuals/chapters/control.adoc (limited to 'doc') diff --git a/doc/manuals/chapters/control.adoc b/doc/manuals/chapters/control.adoc new file mode 100644 index 000000000..a1d6b435b --- /dev/null +++ b/doc/manuals/chapters/control.adoc @@ -0,0 +1,99 @@ +[[control]] +== Control interface + +The actual protocol is described in <>, the variables +common to all programs using it are described in <>. Here we +describe variables specific to OsmoBSC. The commands starting with prefix +"net.btsN." are specific to a certain BTS so N have to be replaced with BTS +number when issuing command e. g. "net.bts1.channel-load". Similarly the +TRX-specific commands are additionally prefixed with TRX number e. g. +"net.bts1.trx2.arfcn". + +.Variables available over control interface +[options="header",width="100%",cols="20%,5%,5%,50%,20%"] +|=== +|Name|Access|Trap|Value|Comment +|msc_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to MSC. +|bts_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to BTS. +|location|RW|Yes|",(invalid\|fix2d\|fix3d),,,"|Set/Get location data. +|timezone|RW|No|",,", "off"|-19 \<= hours \<= 19, mins in {0, 15, 30, 45}, and 0 \<= dst \<= 2 +|apply-configuration|WO|No|"restart"|Restart all BTSes. +|mnc|RW|No|""|Set/Get MNC (value between (0, 999)). +|mcc|RW|No|""|Set/Get MCC (value between (1, 999)). +|short-name|RW|No|""|Set/Get network's short name. +|long-name|RW|No|""|Set/Get network's long name. +|mcc-mnc-apply|WO|No|","|Apply new MCC/MNC values if different from currently used one. +|notification|WO|Yes|Arbitrary value| See <> for details. +|inform-msc-v1|WO|Yes|Arbitrary value| See <> for details. +|ussd-notify-v1|WO|No|",,"| See <> for details. +|rf_locked|RW|No|"0","1"|See <> for details. +|number-of-bts|RO|No|""|Get number of configured BTS. +|net.btsN.location-area-code|RW|No|""|Set/Get LAC (value between (0, 65535)). +|net.btsN.cell-identity|RW|No|""|Set/Get Cell Identity (value between (0, 65535)). +|net.btsN.apply-configuration|WO|No|Ignored|Restart BTS via OML. +|net.btsN.send-new-system-informations|WO|No|Ignored|Regenerate System Information messages for given BTS. +|net.btsN.channel-load|RO|No|",,"|See <> for details. +|net.btsN.oml-connection-state|RO|No|"connected", "disconnected"|Indicate the status of OML connection of BTS. +|net.btsN.gprs-mode|RW|No|""|See <> for details. +|net.btsN.rf_state|RO|No|",,"|See <> for details. +|net.btsN.trxM.arfcn|RW|No|""|Set/Get ARFCN (value between (0, 1023)). +|net.btsN.trxM.max-power-reduction|RW|No|""|See <> for details. +|=== + +[[notif]] +=== notification + +Setting this variable initiate TRAP "notification" to all the clients connected +to control interface with the value supplied in SET operation. This is not +intended to be used outside of local systems. + +[[infomsc]] +=== inform-msc-v1 + +Setting this variable initiate TRAP "inform-msc-v1" to all connected MSCs +control interfaces with the value supplied in SET operation. + +[[ussdnot]] +=== ussd-notify-v1 + +Setting this variable will send USSD Notify message to subscriber specified in +command parameters with the text specified in command parameters. + +[[chanlo]] +=== channel-load + +Obtain channel load for given BTS. Returns concatenated set of triplets +(",,") for all channel types configured on the BTS. The +"" is the channel type. The "" is the number of channels of that +type currently in use. The "" is the number of channels of that type +configured on the BTS. + +[[gprsm]] +=== gprs-mode + +Set/Get the GPRS mode of the BTS. One of the following is +accepted/returned: "none", "gprs", "egprs". + +[[rfs]] +=== rf_state + +Following triplet is returned: ",,". The "" might be +"operational" or "inoperational" representing different operational states. The +"" might be "locked" or "unlocked" representing administrative status. +The "" might be "off", "on", "grace" or "unknown" representing different +RF policies. + +[[rfl]] +=== rf_locked + +Set/Get RF locked status. The GET operation will return either "0" or "1" +depending on the RF lock status. The SET operation will set RF lock status if +RF Ctrl is enabled in the BSC Configuration. + +[[mpr]] +=== max-power-reduction + +Set/Get the value of maximum power reduction. Even values between 0 and 22 are +accepted. + +FIXME: add variables defined in src/ctrl/control_if.c? diff --git a/doc/manuals/osmobsc-usermanual.adoc b/doc/manuals/osmobsc-usermanual.adoc index dcb475a63..bf1f9241a 100644 --- a/doc/manuals/osmobsc-usermanual.adoc +++ b/doc/manuals/osmobsc-usermanual.adoc @@ -9,6 +9,8 @@ include::chapters/overview.adoc[] include::chapters/running.adoc[] +include::chapters/control.adoc[] + include::../common/chapters/vty.adoc[] include::../common/chapters/logging.adoc[] -- cgit v1.2.3