| Harald Welte | a5ad7a4 | 2019-03-21 22:52:44 +0100 | [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 |
| Daniel Willmann | fcf0abb | 2021-01-26 18:19:48 +0100 | [diff] [blame] | 6 | describe variables specific to OsmoGbProxy. |
| Harald Welte | a5ad7a4 | 2019-03-21 22:52:44 +0100 | [diff] [blame] | 7 | |
| 8 | .Variables available over control interface |
| 9 | [options="header",width="100%",cols="20%,5%,5%,50%,20%"] |
| 10 | |=== |
| 11 | |Name|Access|Trap|Value|Comment |
| 12 | |nsvc-state|RO|No|"<nsei>,<nsvci>,<local-alive>,<local-blocked>,<remote-role>,<remote-alive>,<remote-blocked>"|See <<nsvc_state>> for details. |
| 13 | |gbproxy-state|RO|No|"<nsei>,<bvci>,<mcc>,<mnc>,<lac>,<rac>,<blocked>"|See <<gbproxy_state>> for details. |
| 14 | |number-of-peers|RO|No|"<num-of-bss>"|Count of concurrent BSS(BTS) peers. |
| 15 | |=== |
| 16 | |
| 17 | [[nsvc_state]] |
| 18 | === nsvc-state |
| 19 | |
| 20 | Return the list of active NS-VCs (NS Virtual Circuits), including information |
| 21 | on the key parameters, such as NSEI, NSVCI and the local + remote ALIVE |
| 22 | and BLOCKED state. |
| 23 | |
| 24 | [[gbproxy_state]] |
| 25 | === gbproxy-state |
| 26 | |
| 27 | Return the list of active Peers, including information on the key |
| 28 | parameters, such as NSEI, BVCI, and the MCC-MNC-LAC-RAC of the attached |
| 29 | BSS, as well as the overall state (BLOCKED or UNBLOCKED). |