This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
laforge gerrit-no-reply at lists.osmocom.orglaforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-cbc/+/22399 ) Change subject: manual: Chapters on configuration + vty introspection ...................................................................... manual: Chapters on configuration + vty introspection Change-Id: I9af54ffc6f967702e8f66265dc15b35bbc173c4b --- A doc/manuals/chapters/configuration.adoc A doc/manuals/chapters/introspection.adoc M doc/manuals/osmocbc-usermanual.adoc 3 files changed, 142 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved diff --git a/doc/manuals/chapters/configuration.adoc b/doc/manuals/chapters/configuration.adoc new file mode 100644 index 0000000..31a5370 --- /dev/null +++ b/doc/manuals/chapters/configuration.adoc @@ -0,0 +1,47 @@ +[[configuration]] +== CBSP / Peer Configuration + +CBSP is the BSC-CBC interface within the 3GPP architecture. It serves +to communicate CSB and ETWS messages from the CBC to the BSC, who then +subsequently distributes it among the (matching) cells within the BSC +coverage area. + +=== Configuring the CBSP connections + +According to 3GPP TS 48.049, a BSC typically operates as a TCP server, +and the CBC connects as TCP client. This would require the CBC to have +out-of-band knowledge of all the BSCs in the network (and their IP +addresses). + +In order to comply with the specifications, OsmoCBC supports this mode +of operation as CBSP TCP client. However, to make network operation and +configuration more simple, it also can operate in TCP server mode, +accepting incoming connections from the BSCs. This way the BSCs need to +know the CBC IP address, but not vice-versa. + +The CBC related configuration of OsmoBSC can be found in the `cbc` configuration +node of the VTY interface. + +The default port number for the CBSP server is 48049, according to the CBSP +specification. + +.Example: Configure TCP server mode and allow arbitrary BSCs to connect +---- +cbc + unknown-peers accept +---- + + +.Example: Configure TCP client mode and define each BSC +---- +cbc + peer my-bsc-1 + protocol cbsp + remote-port 46133 + remote-ip 1.2.3.4 + peer my-bsc-2 + remote-port 46133 + remote-ip 1.2.3.4 +---- + +For more details on the available configuration commands, please check the OsmoCBC VTY Reference. diff --git a/doc/manuals/chapters/introspection.adoc b/doc/manuals/chapters/introspection.adoc new file mode 100644 index 0000000..c070cc3 --- /dev/null +++ b/doc/manuals/chapters/introspection.adoc @@ -0,0 +1,91 @@ +== Introspection using the VTY + +OsmoCBC offers a VTY interface on TCP port 4264. Like all Osmocom VTY interfaces, +it is normally bound only to the loopback address 127.0.0.1. You can change this +via the configuration. + +The actual IP/Port is printed to the log at startup time: + +---- +20210124110559489 DLGLOBAL NOTICE Available via telnet 127.0.0.1 4264 (telnet_interface.c:104) +---- + +=== Peer State + +Using the `show peers` command, you can check on the state of all configured and/or connected +peers: + +.Example: Showing a list of all peers +---- +OsmoCBC> show peers +|Name | IP | Port | Proto | State | +|--------------------|----------------|------|-------|---------------------| +|ttcn3 | 127.0.0.1 | 9999 | CBSP | <disconnected> | +|local-bsc | 127.0.0.1 | 46133| CBSP | IDLE | +---- + +=== CBS Messages + +Using `show messages cbs`, a list of all current CBS messages can be obtained. + +.Example: Showing a list of all CBS messages +---- +OsmoCBC> show messages cbs +|MsgId|SerNo| CBE Name | Category |Period|E|DCS| +|-----|-----|--------------------|-------------|------|-|---| +| 04D2| 7000|cbc_apitool |Normal | 5 |N| 0f| +---- + +Using `show message 1234`, details about a specific CBS message can be obtained: + +.Example: Showing details about a single CBS message +---- +OsmoCBC> show message id 1234 +Message ID 04D2, Serial Number 7000, State: ACTIVE + Created by CBE 'cbc_apitool' at Sun Jan 24 11:10:31 2021 + Repetition Period: 5 ( 9.41s), Number of broadcasts: 999 + Warning Period: 4294967295s + DCS: 0x0f, Number of pages: 1, User Data Bytes: 7 + Page 0: cd309aad2fa7e98d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168341a8d46a3d168 + Peer: 'ttcn3', State: ACTIVE + Cells Installed: + Cells Failed: + Number of Broadcasts Completed: + Peer: 'local-bsc', State: ACTIVE + Cells Installed: + CGI 901-70-1-1234 + Cells Failed: + Number of Broadcasts Completed: +---- + + +=== ETWS Messages + +Using `show messages etws` a list of all current ETWS messages can be obtained. + +.Example: Showing a list of all ETWS messages +---- +OsmoCBC> show messages etws +|MsgId|SerNo| CBE Name | Category |Period|E|Warning Type| +|-----|-----|--------------------|-------------|------|-|------------| +| 03E8| 7000|cbc_apitool |Normal | 5 |N| 0000| +---- + +.Example: Showing details of one single ETWS message +---- +OsmoCBC> show message id 1000 +Message ID 03E8, Serial Number 7000, State: ACTIVE + Created by CBE 'cbc_apitool' at Sun Jan 24 11:14:42 2021 + Repetition Period: 5 ( 9.41s), Number of broadcasts: 999 + ETWS Warning Type Value: 0x00, User Alert: On, Popup: On + Security: 0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + Peer: 'ttcn3', State: ACTIVE + Cells Installed: + Cells Failed: + Number of Broadcasts Completed: + Peer: 'local-bsc', State: ACTIVE + Cells Installed: + CGI 901-70-1-1234 + Cells Failed: + Number of Broadcasts Completed: +---- diff --git a/doc/manuals/osmocbc-usermanual.adoc b/doc/manuals/osmocbc-usermanual.adoc index 391a9f1..967ec96 100644 --- a/doc/manuals/osmocbc-usermanual.adoc +++ b/doc/manuals/osmocbc-usermanual.adoc @@ -12,6 +12,10 @@ include::{srcdir}/chapters/running.adoc[] +include::{srcdir}/chapters/configuration.adoc[] + +include::{srcdir}/chapters/introspection.adoc[] + include::./common/chapters/counters-overview.adoc[] include::{srcdir}/chapters/counters.adoc[] -- To view, visit https://gerrit.osmocom.org/c/osmo-cbc/+/22399 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-cbc Gerrit-Branch: master Gerrit-Change-Id: I9af54ffc6f967702e8f66265dc15b35bbc173c4b Gerrit-Change-Number: 22399 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge at osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge at osmocom.org> Gerrit-MessageType: merged -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210124/327091de/attachment.htm>