<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-cbc/+/22399">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">manual: Chapters on configuration + vty introspection<br><br>Change-Id: I9af54ffc6f967702e8f66265dc15b35bbc173c4b<br>---<br>A doc/manuals/chapters/configuration.adoc<br>A doc/manuals/chapters/introspection.adoc<br>M doc/manuals/osmocbc-usermanual.adoc<br>3 files changed, 142 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-cbc refs/changes/99/22399/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/configuration.adoc b/doc/manuals/chapters/configuration.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..31a5370</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/configuration.adoc</span><br><span>@@ -0,0 +1,47 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[configuration]]</span><br><span style="color: hsl(120, 100%, 40%);">+== CBSP / Peer Configuration</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+CBSP is the BSC-CBC interface within the 3GPP architecture.  It serves</span><br><span style="color: hsl(120, 100%, 40%);">+to communicate CSB and ETWS messages from the CBC to the BSC, who then</span><br><span style="color: hsl(120, 100%, 40%);">+subsequently distributes it among the (matching) cells within the BSC</span><br><span style="color: hsl(120, 100%, 40%);">+coverage area.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== Configuring the CBSP connections</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+According to 3GPP TS 48.049, a BSC typically operates as a TCP server,</span><br><span style="color: hsl(120, 100%, 40%);">+and the CBC connects as TCP client.  This would require the CBC to have</span><br><span style="color: hsl(120, 100%, 40%);">+out-of-band knowledge of all the BSCs in the network (and their IP</span><br><span style="color: hsl(120, 100%, 40%);">+addresses).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+In order to comply with the specifications, OsmoCBC supports this mode</span><br><span style="color: hsl(120, 100%, 40%);">+of operation as CBSP TCP client.  However, to make network operation and</span><br><span style="color: hsl(120, 100%, 40%);">+configuration more simple, it also can operate in TCP server mode,</span><br><span style="color: hsl(120, 100%, 40%);">+accepting incoming connections from the BSCs.  This way the BSCs need to</span><br><span style="color: hsl(120, 100%, 40%);">+know the CBC IP address, but not vice-versa.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The CBC related configuration of OsmoBSC can be found in the `cbc` configuration</span><br><span style="color: hsl(120, 100%, 40%);">+node of the VTY interface.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The default port number for the CBSP server is 48049, according to the CBSP</span><br><span style="color: hsl(120, 100%, 40%);">+specification.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Configure TCP server mode and allow arbitrary BSCs to connect</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+cbc</span><br><span style="color: hsl(120, 100%, 40%);">+ unknown-peers accept</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Configure TCP client mode and define each BSC</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+cbc</span><br><span style="color: hsl(120, 100%, 40%);">+ peer my-bsc-1</span><br><span style="color: hsl(120, 100%, 40%);">+  protocol cbsp</span><br><span style="color: hsl(120, 100%, 40%);">+  remote-port 46133</span><br><span style="color: hsl(120, 100%, 40%);">+  remote-ip 1.2.3.4</span><br><span style="color: hsl(120, 100%, 40%);">+ peer my-bsc-2</span><br><span style="color: hsl(120, 100%, 40%);">+  remote-port 46133</span><br><span style="color: hsl(120, 100%, 40%);">+  remote-ip 1.2.3.4</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more details on the available configuration commands, please check the OsmoCBC VTY Reference.</span><br><span>diff --git a/doc/manuals/chapters/introspection.adoc b/doc/manuals/chapters/introspection.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..c070cc3</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/introspection.adoc</span><br><span>@@ -0,0 +1,91 @@</span><br><span style="color: hsl(120, 100%, 40%);">+== Introspection using the VTY</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC offers a VTY interface on TCP port 4264. Like all Osmocom VTY interfaces,</span><br><span style="color: hsl(120, 100%, 40%);">+it is normally bound only to the loopback address 127.0.0.1.  You can change this</span><br><span style="color: hsl(120, 100%, 40%);">+via the configuration.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The actual IP/Port is printed to the log at startup time:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+20210124110559489 DLGLOBAL NOTICE Available via telnet 127.0.0.1 4264 (telnet_interface.c:104)</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== Peer State</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Using the `show peers` command, you can check on the state of all configured and/or connected</span><br><span style="color: hsl(120, 100%, 40%);">+peers:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Showing a list of all peers</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC> show peers</span><br><span style="color: hsl(120, 100%, 40%);">+|Name                | IP             | Port | Proto | State               |</span><br><span style="color: hsl(120, 100%, 40%);">+|--------------------|----------------|------|-------|---------------------|</span><br><span style="color: hsl(120, 100%, 40%);">+|ttcn3               | 127.0.0.1      | 9999 | CBSP  | <disconnected>      |</span><br><span style="color: hsl(120, 100%, 40%);">+|local-bsc           | 127.0.0.1      | 46133| CBSP  | IDLE                |</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== CBS Messages</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Using `show messages cbs`, a list of all current CBS messages can be obtained.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Showing a list of all CBS messages</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC> show messages cbs</span><br><span style="color: hsl(120, 100%, 40%);">+|MsgId|SerNo|      CBE Name      |  Category   |Period|E|DCS|</span><br><span style="color: hsl(120, 100%, 40%);">+|-----|-----|--------------------|-------------|------|-|---|</span><br><span style="color: hsl(120, 100%, 40%);">+| 04D2| 7000|cbc_apitool         |Normal       |  5   |N| 0f|</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Using `show message 1234`, details about a specific CBS message can be obtained:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Showing details about a single CBS message</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC> show message id 1234</span><br><span style="color: hsl(120, 100%, 40%);">+Message ID 04D2, Serial Number 7000, State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+ Created by CBE 'cbc_apitool' at Sun Jan 24 11:10:31 2021</span><br><span style="color: hsl(120, 100%, 40%);">+ Repetition Period: 5 ( 9.41s), Number of broadcasts: 999</span><br><span style="color: hsl(120, 100%, 40%);">+ Warning Period: 4294967295s</span><br><span style="color: hsl(120, 100%, 40%);">+ DCS: 0x0f, Number of pages: 1, User Data Bytes: 7</span><br><span style="color: hsl(120, 100%, 40%);">+ Page 0: cd309aad2fa7e98d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168</span><br><span style="color: hsl(120, 100%, 40%);">+ Peer: 'ttcn3', State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Installed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Failed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Number of Broadcasts Completed:</span><br><span style="color: hsl(120, 100%, 40%);">+ Peer: 'local-bsc', State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Installed:</span><br><span style="color: hsl(120, 100%, 40%);">+   CGI 901-70-1-1234</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Failed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Number of Broadcasts Completed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== ETWS Messages</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Using `show messages etws` a list of all current ETWS messages can be obtained.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Showing a list of all ETWS messages</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC> show messages etws </span><br><span style="color: hsl(120, 100%, 40%);">+|MsgId|SerNo|      CBE Name      |  Category   |Period|E|Warning Type|</span><br><span style="color: hsl(120, 100%, 40%);">+|-----|-----|--------------------|-------------|------|-|------------|</span><br><span style="color: hsl(120, 100%, 40%);">+| 03E8| 7000|cbc_apitool         |Normal       |  5   |N|        0000|</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: Showing details of one single ETWS message</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoCBC> show message id 1000</span><br><span style="color: hsl(120, 100%, 40%);">+Message ID 03E8, Serial Number 7000, State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+ Created by CBE 'cbc_apitool' at Sun Jan 24 11:14:42 2021</span><br><span style="color: hsl(120, 100%, 40%);">+ Repetition Period: 5 ( 9.41s), Number of broadcasts: 999</span><br><span style="color: hsl(120, 100%, 40%);">+ ETWS Warning Type Value: 0x00, User Alert: On, Popup: On</span><br><span style="color: hsl(120, 100%, 40%);">+ Security: 0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</span><br><span style="color: hsl(120, 100%, 40%);">+ Peer: 'ttcn3', State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Installed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Failed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Number of Broadcasts Completed:</span><br><span style="color: hsl(120, 100%, 40%);">+ Peer: 'local-bsc', State: ACTIVE</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Installed:</span><br><span style="color: hsl(120, 100%, 40%);">+   CGI 901-70-1-1234</span><br><span style="color: hsl(120, 100%, 40%);">+  Cells Failed:</span><br><span style="color: hsl(120, 100%, 40%);">+  Number of Broadcasts Completed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span>diff --git a/doc/manuals/osmocbc-usermanual.adoc b/doc/manuals/osmocbc-usermanual.adoc</span><br><span>index 391a9f1..967ec96 100644</span><br><span>--- a/doc/manuals/osmocbc-usermanual.adoc</span><br><span>+++ b/doc/manuals/osmocbc-usermanual.adoc</span><br><span>@@ -12,6 +12,10 @@</span><br><span> </span><br><span> include::{srcdir}/chapters/running.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/configuration.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/introspection.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> include::./common/chapters/counters-overview.adoc[]</span><br><span> </span><br><span> include::{srcdir}/chapters/counters.adoc[]</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-cbc/+/22399">change 22399</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-cbc/+/22399"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-cbc </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I9af54ffc6f967702e8f66265dc15b35bbc173c4b </div>
<div style="display:none"> Gerrit-Change-Number: 22399 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>