Max | 7f3d8ea | 2016-05-04 14:52:15 +0200 | [diff] [blame^] | 1 | [[control]] |
| 2 | == Control interface |
| 3 | |
| 4 | The actual protocol is described in <<common-control-if>>, the variables |
| 5 | common to all programs using it are described in <<ctrl_common_vars>>. Here we |
| 6 | describe variables specific to OsmoBSC. The commands starting with prefix |
| 7 | "net.btsN." are specific to a certain BTS so N have to be replaced with BTS |
| 8 | number when issuing command e. g. "net.bts1.channel-load". Similarly the |
| 9 | TRX-specific commands are additionally prefixed with TRX number e. g. |
| 10 | "net.bts1.trx2.arfcn". |
| 11 | |
| 12 | .Variables available over control interface |
| 13 | [options="header",width="100%",cols="20%,5%,5%,50%,20%"] |
| 14 | |=== |
| 15 | |Name|Access|Trap|Value|Comment |
| 16 | |msc_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to MSC. |
| 17 | |bts_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to BTS. |
| 18 | |location|RW|Yes|"<unixtime>,(invalid\|fix2d\|fix3d),<lat>,<lon>,<height>"|Set/Get location data. |
| 19 | |timezone|RW|No|"<hours>,<mins>,<dst>", "off"|-19 \<= hours \<= 19, mins in {0, 15, 30, 45}, and 0 \<= dst \<= 2 |
| 20 | |apply-configuration|WO|No|"restart"|Restart all BTSes. |
| 21 | |mnc|RW|No|"<mnc>"|Set/Get MNC (value between (0, 999)). |
| 22 | |mcc|RW|No|"<mcc>"|Set/Get MCC (value between (1, 999)). |
| 23 | |short-name|RW|No|"<name>"|Set/Get network's short name. |
| 24 | |long-name|RW|No|"<name>"|Set/Get network's long name. |
| 25 | |mcc-mnc-apply|WO|No|"<mcc>,<mnc>"|Apply new MCC/MNC values if different from currently used one. |
| 26 | |notification|WO|Yes|Arbitrary value| See <<notif>> for details. |
| 27 | |inform-msc-v1|WO|Yes|Arbitrary value| See <<infomsc>> for details. |
| 28 | |ussd-notify-v1|WO|No|"<cic>,<alert>,<text>"| See <<ussdnot>> for details. |
| 29 | |rf_locked|RW|No|"0","1"|See <<rfl>> for details. |
| 30 | |number-of-bts|RO|No|"<num>"|Get number of configured BTS. |
| 31 | |net.btsN.location-area-code|RW|No|"<lac>"|Set/Get LAC (value between (0, 65535)). |
| 32 | |net.btsN.cell-identity|RW|No|"<id>"|Set/Get Cell Identity (value between (0, 65535)). |
| 33 | |net.btsN.apply-configuration|WO|No|Ignored|Restart BTS via OML. |
| 34 | |net.btsN.send-new-system-informations|WO|No|Ignored|Regenerate System Information messages for given BTS. |
| 35 | |net.btsN.channel-load|RO|No|"<name>,<used>,<total>"|See <<chanlo>> for details. |
| 36 | |net.btsN.oml-connection-state|RO|No|"connected", "disconnected"|Indicate the status of OML connection of BTS. |
| 37 | |net.btsN.gprs-mode|RW|No|"<mode>"|See <<gprsm>> for details. |
| 38 | |net.btsN.rf_state|RO|No|"<oper>,<admin>,<pol>"|See <<rfs>> for details. |
| 39 | |net.btsN.trxM.arfcn|RW|No|"<arfcn>"|Set/Get ARFCN (value between (0, 1023)). |
| 40 | |net.btsN.trxM.max-power-reduction|RW|No|"<mpr>"|See <<mpr>> for details. |
| 41 | |=== |
| 42 | |
| 43 | [[notif]] |
| 44 | === notification |
| 45 | |
| 46 | Setting this variable initiate TRAP "notification" to all the clients connected |
| 47 | to control interface with the value supplied in SET operation. This is not |
| 48 | intended to be used outside of local systems. |
| 49 | |
| 50 | [[infomsc]] |
| 51 | === inform-msc-v1 |
| 52 | |
| 53 | Setting this variable initiate TRAP "inform-msc-v1" to all connected MSCs |
| 54 | control interfaces with the value supplied in SET operation. |
| 55 | |
| 56 | [[ussdnot]] |
| 57 | === ussd-notify-v1 |
| 58 | |
| 59 | Setting this variable will send USSD Notify message to subscriber specified in |
| 60 | command parameters with the text specified in command parameters. |
| 61 | |
| 62 | [[chanlo]] |
| 63 | === channel-load |
| 64 | |
| 65 | Obtain channel load for given BTS. Returns concatenated set of triplets |
| 66 | ("<name>,<used>,<total>") for all channel types configured on the BTS. The |
| 67 | "<name>" is the channel type. The "<used>" is the number of channels of that |
| 68 | type currently in use. The "<total>" is the number of channels of that type |
| 69 | configured on the BTS. |
| 70 | |
| 71 | [[gprsm]] |
| 72 | === gprs-mode |
| 73 | |
| 74 | Set/Get the GPRS mode of the BTS. One of the following is |
| 75 | accepted/returned: "none", "gprs", "egprs". |
| 76 | |
| 77 | [[rfs]] |
| 78 | === rf_state |
| 79 | |
| 80 | Following triplet is returned: "<oper>,<admin>,<pol>". The "<oper>" might be |
| 81 | "operational" or "inoperational" representing different operational states. The |
| 82 | "<admin>" might be "locked" or "unlocked" representing administrative status. |
| 83 | The "<pol>" might be "off", "on", "grace" or "unknown" representing different |
| 84 | RF policies. |
| 85 | |
| 86 | [[rfl]] |
| 87 | === rf_locked |
| 88 | |
| 89 | Set/Get RF locked status. The GET operation will return either "0" or "1" |
| 90 | depending on the RF lock status. The SET operation will set RF lock status if |
| 91 | RF Ctrl is enabled in the BSC Configuration. |
| 92 | |
| 93 | [[mpr]] |
| 94 | === max-power-reduction |
| 95 | |
| 96 | Set/Get the value of maximum power reduction. Even values between 0 and 22 are |
| 97 | accepted. |
| 98 | |
| 99 | FIXME: add variables defined in src/ctrl/control_if.c? |