3CX SBC v20: installing and configuring your Rack Matrix appliance

Tutorials
22
May
2024
3CX SBC v20: installing and configuring your Rack Matrix appliance

Your Rack Matrix 3CX SBC v20 comes ready to use: Debian 12 and 3CX SBC v20 are installed, the disk is expanded and the hardware has been tested in our workshop. This tutorial, written for the installer, explains how to adapt it to your network and connect it to your 3CX v20 PBX.

Rack Matrix SBC 30R: front panel

Example: SBC 30R. Front panel: network ports eth0, eth1, eth2, Console RS232 port (RJ45), HDMI and USB.

The same content is available as a PDF, in French: SBC 3CX v20 installation guide (4 pages).

Note: the SBC screens and menu are in French; this page gives the English meaning of each entry.

1. Before you start

  • An SBC v20 only works with a 3CX v20 PBX.
  • The SBC must reach the Internet (DNS and HTTPS) and the PBX.
  • Port 5060 UDP/TCP of the SBC must stay free (the SBC uses it itself).
  • First add the SBC on the PBX: you get a provisioning URL and an authentication key ID (see section 5).

2. Factory settings

  • Network port : eth0 (LAN port)
  • IP address : 10.15.10.99 / 255.255.255.0 (static)
  • Gateway / DNS : 10.15.10.1 / 8.8.8.8
  • Debian account : root / admin (change it as soon as you commission the SBC)
  • Host name : sbc3cx
  • Serial console : Console RS232 port (RJ45): 115200 baud, 8 bits, no parity, 1 stop bit (8N1), no flow control
  • Screen / keyboard : HDMI + USB
The SBC root password has nothing to do with the password of the 3CX PBX web interface.

3. Connecting to the SBC: serial port or SSH

There are two ways to configure the SBC. Both give the same login screen and the same configuration menu; choose the most convenient one on site.

A. Serial port (recommended)
  • Console cable on the Console RS232 port
  • No network setting on the PC: only the COM port (115200 8N1)
  • Changing the SBC IP: the session goes on, you see the result at once
  • Unknown SBC IP: no problem, it is shown on the login screen
  • Also shows the whole boot (GRUB, kernel, services)
B. SSH (network)
  • Network cable on eth0
  • Temporary address to give the PC in 10.15.10.0/24, to remove afterwards
  • Changing the SBC IP: the session is cut, you must reconfigure the PC and reconnect
  • Unknown SBC IP: you cannot connect without it
The serial port is recommended for commissioning: no temporary SSH connection to prepare (PC address, isolated network...), and it works whatever the network configuration of the SBC, even after a typo in the IP address. SSH remains convenient afterwards, for remote operation.

A. Through the serial port (Console RS232) - recommended

  • RJ45 to DB9 console cable (or RJ45 to USB) between the Console RS232 port and your PC.
  • Settings: 115200 baud, 8N1, no flow control. Terminal in UTF-8.
  • PuTTY: Connection type = Serial, Serial line = your port (COM3...), Speed = 115200; Connection > Serial: Flow control = None; Window > Translation: UTF-8.
  • On Linux or macOS: screen /dev/ttyUSB0 115200 or picocom -b 115200 /dev/ttyUSB0.
  • Press Enter to show the login prompt.

B. Through the network (SSH)

  • Plug the network cable into eth0, directly between the PC and the SBC or on an isolated switch.
  • Temporary connection: give your PC an address in 10.15.10.0/24, for example 10.15.10.50 / 255.255.255.0 (no gateway).
  • Connect: ssh This email address is being protected from spambots. You need JavaScript enabled to view it.; with PuTTY: type SSH, Window > Translation = UTF-8, Terminal > Features: tick "Disable application keypad mode".
  • On first access, accept the key fingerprint: it is unique to each SBC.
  • Once the SBC has its final address (menu, entry 1), restore the usual configuration of your PC and reconnect to the new address.

Troubleshooting: an HDMI screen and a USB keyboard also give access to the login screen.

Login screen (serial port, SSH or screen; "Adresse IP" = IP address, "connectez-vous en root" = log in as root):

Rack Matrix - SBC 3CX v20   (sbc3cx, ttyS0)
Adresse IP : 10.15.10.99

Menu de configuration : connectez-vous en root.

sbc3cx login: root
Password:

The current IP address is shown even before you log in: handy if the address has already been changed.

4. The configuration menu

Log in as root: the menu opens automatically. Use the keyboard (arrows, Tab, Space to tick, Enter to confirm, Esc to cancel). The top of the menu sums up the state of the SBC.

Rack Matrix - SBC 3CX v20
┌────────────────────────┤ Configuration du SBC ├────────────────────────┐
│ Nom         : sbc3cx                                                   │
│ Réseau      : eth0 (static)  10.15.10.99/24  câble branché             │
│ SBC 3CX     : 20.0.100  service active  ProvLink A REGLER              │
│                                                                        │
│      1  Adresse IP                                                     │
│      2  Mot de passe root                                              │
│      3  Nom de la machine                                              │
│      4  SBC 3CX v20 : lien de provisioning (ProvLink)                  │
│      5  Redémarrer                                                     │
│      6  Eteindre                                                       │
│      Q  Quitter vers le shell                                          │
│                                                                        │
│                                 <Ok>                                   │
└────────────────────────────────────────────────────────────────────────┘
  • 1 Adresse IP (IP address) : choose the network port, then a static address (IP, netmask, gateway, DNS: every value is checked) or DHCP. Applied at once. The previous configuration is kept in /etc/network/interfaces.precedent.
  • 2 Mot de passe root (root password) : typed twice, 6 characters minimum.
  • 3 Nom de la machine (host name) : updates /etc/hostname and /etc/hosts.
  • 4 ProvLink : provisioning link of the SBC (section 5). The SBC is restarted and the last line of its log is shown. The previous file is kept in /etc/3cxsbc.conf.precedent.
  • 5 / 6 : restart / shut down the SBC (with confirmation).
  • Q : quit to the Debian shell. To open the menu again: sbc-menu.

Recommended order for commissioning

2
Change the root passwordMenu entry 2.
4
Enter the ProvLinkEntry 4, if the SBC already reaches the Internet (section 5).
3
Name the machineEntry 3, optional.
1
Set the final IP addressEntry 1, then plug the SBC into its network.
If you are connected through SSH, changing the IP address cuts your session: reconnect to the new address. Through the serial console, the session is not cut.

5. Connecting the SBC to your 3CX v20 PBX

On the PBX, add a Session Border Controller (3CX documentation: Installing a 3CX SBC). In the SBC record, note:

  • the provisioning URL, for example https://test.on3cx.fr;
  • the authentication key ID, for example AzertyUIOp68.

The ProvLink to type in the menu (entry 4) joins them, with /sbc/ in the middle:

https://test.on3cx.fr/sbc/AzertyUIOp68

After a few seconds, the SBC should show as connected in the PBX interface.

6. Configuring without the menu (shell)

Everything the menu does can also be done by hand (menu option Q), for example:

nano /etc/network/interfaces    # address, netmask, gateway, dns-nameservers of port eth0
ifdown eth0 ; ifup eth0         # apply (or reboot)
nano /etc/hostname /etc/hosts   # host name, then: hostname <new-name>
passwd root                     # root password
nano /etc/3cxsbc.conf           # ProvLink= line only
systemctl restart 3cxsbc        # load the new ProvLink

DNS is managed by resolvconf: change dns-nameservers in /etc/network/interfaces, not /etc/resolv.conf.

7. Checks and troubleshooting

ip -br addr                              # port addresses
ping -c3 8.8.8.8                         # Internet access
getent hosts downloads-global.3cx.com    # DNS
systemctl status 3cxsbc                  # SBC status
tail -f /var/log/3cxsbc/3cxsbc.log       # SBC log (Ctrl+C to quit)
  • Nothing on the serial console : console cable (RJ45 on the SBC side), COM port, 115200 8N1, flow control None. Press Enter.
  • Accented characters or frames unreadable : terminal in UTF-8 (PuTTY: Window > Translation).
  • No SSH answer : cable on eth0, temporary PC address in the right network. Simplest: use the serial port, which shows the current address and lets you correct it.
  • The SBC does not show on the PBX : ProvLink (URL + /sbc/ + ID), Internet access and DNS of the SBC, v20 PBX, SBC log.
  • Wrong network configuration : go back to the previous one: cp /etc/network/interfaces.precedent /etc/network/interfaces then reboot.

8. Restart after a power cut

For the SBC to start again on its own when power comes back, set the BIOS (Del key at boot): option Restore on AC Power Loss (or AC Power Recovery) to Power On or Last State, then save (F4 or F10 depending on the BIOS).

Rack Matrix 3CX SBCs in our store

This tutorial applies to the three models, delivered with 3CX SBC v20 pre-installed:

SBC 30R: 19" rackmount, 30 devicesSBC 50R: 19" rackmount, 50 devicesSBC 30D: desktop, 30 devices