diff options
authorNeels Hofmeyr <neels@hofmeyr.de>2020-09-03 13:30:06 +0200
committerNeels Hofmeyr <neels@hofmeyr.de>2020-09-03 14:34:49 +0200
commitca979b7857c96ef9396d167054f3cb39ee8cb1e5 (patch)
parent7630a29212abf6d2807e9593a18ac703a59542aa (diff)
CBSP: adjust manual to reflect new 'cbc' VTY config
1 files changed, 42 insertions, 20 deletions
diff --git a/doc/manuals/chapters/smscb.adoc b/doc/manuals/chapters/smscb.adoc
index f7469a375..011aec413 100644
--- a/doc/manuals/chapters/smscb.adoc
+++ b/doc/manuals/chapters/smscb.adoc
@@ -13,7 +13,7 @@ specification is <<3gpp-ts-23-041>>.
In order to use SMSCB with OsmoBSC, you will need to
-* Configure the CBSP server and/or client
+* Configure OsmoBSC as either CBSP server or client
* Use a channel combination including a CBCH on the BTSs
=== Enabling a CBCH channel combination
@@ -41,41 +41,63 @@ addresses).
In order to comply with the specifications, OsmoBSC supports this mode
of operation as CBSP TCP server. However, to make network operation and
configuration more simple, it also can operate in TCP client mode,
-connecting to the CBC. This way the all the BSCs need to know is the CBC IP
+connecting to the CBC. This way the BSCs need to know the CBC IP
address, but not vice-versa.
-The BSC can operate both CBSP TCP server and CBSP TCP client mode in
+The BSC can operate in either CBSP TCP server mode or CBSP TCP client mode.
The CBC related configuration of OsmoBSC can be found in the `cbc` configuration
node of the VTY interface.
-.Example: Configure CBSP TCP client to connect to CBC at
+The default port number for the CBSP server is 48049, according to the CBSP
+specification. Hence it normally suffices to configure only the IP addresses for
+the remote CBC server or the local CBSP server:
+.Example: Configure CBSP TCP client to connect to CBC at in osmo-bsc.cfg
-OsmoBSC> enable
-OsmoBSC# configure terminal
-OsmoBSC(config)# cbc
-OsmoBSC(config-cbc)# remote-ip
-OsmoBSC(config-cbc)# remote-port 48049
-OsmoBSC(config-cbc)# end
+ mode client
+ client
+ remote-ip
-.Example: Disable CBSP TCP client
+In server mode, the default configuration is, so it suffices to
+set `mode server` to accept CBSP connections from localhost:
-OsmoBSC> enable
-OsmoBSC# configure terminal
-OsmoBSC(config)# cbc
-OsmoBSC(config-cbc)# no remote-ip
-OsmoBSC(config-cbc)# end
+ mode server
+To also listen for inbound CBSP connections on all interfaces, both IPv4 and
+.Example: Configure CBSP TCP server to listen on all interfaces in osmo-bsc.cfg
+ mode server
+ server
+ local-ip ::
+Should non-standard port numbers be required, these can be configured with the
+`client` / `local-port` or the `server` / `remote-port` settings.
+The `client` config also supports an explicit local bind for connecting to the
+remote CBC, using `client` / `local-ip` and `local-port`.
+IP addresses for client and server can remain configured at the same time, and
+the `mode` command can be used to switch between client and server operation.
+The `mode` command takes immediate effect, no restart of OsmoBSC is required.
+After changing `cbc` IP addresses in the telnet VTY, it is required to switch
+`mode` to `disabled` and back to `client` or `server` to take effect.
-.Example: Configure CBSP TCP server to listen for CBC at
+.Example: Disable the CBSP link in the telnet VTY
OsmoBSC> enable
OsmoBSC# configure terminal
OsmoBSC(config)# cbc
-OsmoBSC(config-cbc)# listen-ip
-OsmoBSC(config-cbc)# listen-port 9999
+OsmoBSC(config-cbc)# mode disabled
OsmoBSC(config-cbc)# end