NetModule NB800 Series User manual

NetModule Router NB800 (Rev. B02)
User Manual for Software Version 4.5.0.100
Manual Version 2.272
NetModule AG, Switzerland
December 15, 2020

NBB-800
User Manual for NRSW version 4.5.0.100
2

NBB-800
User Manual for NRSW version 4.5.0.100
NetModule Router NB800 (Rev. B02)
This manual covers all variants of the NBB-800 product type.
The specifications and information regarding the products in this manual are subject to change without notice. We would
like to point out that NetModule makes no representation or warranties with respect to the contents herein and shall not
be responsible for any loss or damage caused to the user by the direct or indirect use of this information This document
may contain information about third party products or processes. Such third party information is generally out of influence
of NetModule and therefore NetModule shall not be responsible for the correctness or legitimacy of this information. Users
must take full responsibility for their application of any products.
Copyright ©2020 NetModule AG, Switzerland All rights reserved
This document contains proprietary information of NetModule. No parts of the work described herein may be reproduced.
Reverse engineering of the hardware or software is prohibited and protected by patent law. This material or any portion of
it may not be copied in any form or by any means, stored in a retrieval system, adopted or transmitted in any form or by
any means (electronic, mechanical, photographic, graphic, optic or otherwise), or translated in any language or computer
language without the prior written permission of NetModule.
A large amount of the source code to this product is available under licenses which are both free and open source. Most of it
is covered by the GNU General Public License which can be obtained from www.gnu.org. The remainder of the open source
software which is not under the GPL, is usually available under one of a variety of more permissive licenses. A detailed
license information for a particular software package can be provided on request.
All other products or company names mentioned herein are used for identification purposes only and may be trademarks or
registered trademarks of their respective owners. The following description of software, hardware or process of NetModule or
other third party provider may be included with your product and will be subject to the software, hardware or other license
agreements.
Contact
www.netmodule.com/support
NetModule AG Tel [phone]
Maulbeerstrasse 10 Fax [phone]
CH-3011 Bern inf[email protected]
Switzerland http://www.netmodule.com
3

NBB-800
User Manual for NRSW version 4.5.0.100
Contents
1. Welcome to NetModule ....................................... 10
2. Conformity .............................................. 11
2.1. Safety Instructions ....................................... 11
2.2. Declaration of Conformity ................................... 13
2.3. Waste Disposal ........................................ 13
2.4. National Restrictions ..................................... 13
2.5. Open Source Software .................................... 14
3. Specifications ............................................. 15
3.1. Appearance .......................................... 15
3.2. Features ............................................ 16
3.3. Environmental Conditions .................................. 16
3.4. Interfaces ........................................... 17
3.4.1. Overview ........................................ 17
3.4.2. Default LED Indicators ................................ 18
3.4.3. Reset .......................................... 18
3.4.4. Mobile ......................................... 19
3.4.5. Bluetooth ........................................ 19
3.4.6. WLAN ......................................... 19
3.4.7. GNSS ......................................... 20
3.4.8. USB 2.0 Host Port ................................... 21
3.4.9. RJ45 Ethernet Connector ............................... 22
3.4.10. Power Supply ..................................... 23
3.4.11. COM/IO Shield .................................... 24
3.4.12. 2xCAN Shield ..................................... 25
3.4.13. CanGI Shield ..................................... 26
4. Installation .............................................. 27
4.1. Installation of the Router ................................... 27
4.2. Installation of the Micro-SIM Card .............................. 27
4.3. Installation of the GSM/UMTS/LTE Antenna ........................ 27
4.4. Installation of the WLAN Antennas .............................. 28
4.5. Installation of the Bluetooth Antenna ............................ 28
4.6. Installation of the GNSS Antenna .............................. 29
4.7. Installation of the Local Area Network ............................ 29
4.8. Installation of the Power Supply ............................... 29
5. Configuration ............................................. 30
5.1. First Steps ........................................... 30
5.1.1. Initial Access ...................................... 30
5.1.2. Recovery ........................................ 31
5.2. HOME ............................................. 33
5.3. INTERFACES ......................................... 36
5.3.1. WAN .......................................... 36
5.3.2. Ethernet ........................................ 42
5.3.3. Mobile ......................................... 47
5.3.4. WLAN ......................................... 52
5.3.5. Software Bridges ................................... 63
5.3.6. USB .......................................... 64
5.3.7. Serial Port ....................................... 67
5.3.8. Digital I/O ....................................... 72
4

NBB-800
User Manual for NRSW version 4.5.0.100
5.3.9. Audio .......................................... 73
5.3.10. Bluetooth Low Energy ................................. 74
5.4. ROUTING ........................................... 75
5.4.1. Static Routes ..................................... 75
5.4.2. Extended Routing ................................... 77
5.4.3. Multipath Routes ................................... 78
5.4.4. Mobile IP ........................................ 79
5.4.5. Quality Of Service ................................... 83
5.4.6. Multicast ........................................ 85
5.4.7. OSPF .......................................... 86
5.4.8. BGP .......................................... 87
5.5. FIREWALL ........................................... 88
5.5.1. Administration ..................................... 88
5.5.2. Adress/Port Groups .................................. 88
5.5.3. Rules .......................................... 89
5.5.4. NAPT .......................................... 91
5.6. VPN .............................................. 94
5.6.1. OpenVPN ....................................... 94
5.6.2. IPsec .......................................... 100
5.6.3. PPTP .......................................... 106
5.6.4. GRE .......................................... 109
5.6.5. L2TP .......................................... 110
5.6.6. Dial-In ......................................... 111
5.7. SERVICES ........................................... 113
5.7.1. SDK .......................................... 113
5.7.2. DHCP Server ..................................... 122
5.7.3. DNS Server ...................................... 124
5.7.4. NTP Server ...................................... 127
5.7.5. Dynamic DNS ..................................... 128
5.7.6. E-Mail ......................................... 130
5.7.7. Events ......................................... 132
5.7.8. SMS .......................................... 133
5.7.9. SSH/Telnet Server ................................... 135
5.7.10. SNMP Agent ...................................... 137
5.7.11. Web Server ...................................... 142
5.7.12. MQTT Broker ..................................... 143
5.7.13. Softflow ......................................... 144
5.7.14. Discovery ....................................... 145
5.7.15. Redundancy ...................................... 146
5.7.16. ITxPT .......................................... 148
5.7.17. Voice Gateway ..................................... 156
5.8. SYSTEM ............................................ 162
5.8.1. System ......................................... 162
5.8.2. Authentication ..................................... 167
5.8.3. Software Update .................................... 170
5.8.4. Module Firmware Update ............................... 171
5.8.5. Software Profiles ................................... 172
5.8.6. Configuration ..................................... 173
5.8.7. Troubleshooting .................................... 176
5

NBB-800
User Manual for NRSW version 4.5.0.100
5.8.8. Keys and Certificates ................................. 179
5.8.9. Licensing ........................................ 184
5.8.10. Legal Notice ...................................... 185
5.9. LOGOUT ............................................ 186
6. Command Line Interface ....................................... 187
6.1. General Usage ........................................ 187
6.2. Print Help ........................................... 188
6.3. Getting Config Parameters .................................. 188
6.4. Setting Config Parameters .................................. 189
6.5. Checking Config Completed ................................. 189
6.6. Getting Status Information .................................. 189
6.7. Scanning Networks ...................................... 190
6.8. Sending E-Mail or SMS .................................... 190
6.9. Updating System Facilities .................................. 190
6.10. Manage keys and certificates ................................ 191
6.11. Restarting Services ...................................... 191
6.12. Debug System ......................................... 192
6.13. Resetting System ....................................... 192
6.14. Rebooting System ....................................... 193
6.15. Running Shell Commands .................................. 193
6.16. Working with History ..................................... 193
6.17. CLI-PHP ............................................ 193
A. Appendix ............................................... 199
A.1. Abbrevations .......................................... 199
A.2. System Events ......................................... 200
A.3. Factory Configuration ..................................... 203
A.4. SNMP VENDOR MIB ..................................... 204
A.5. SDK Examples ........................................ 223
6

NBB-800
User Manual for NRSW version 4.5.0.100
List of Figures
5.1. Initial Login ........................................... 31
5.2. Home .............................................. 33
5.3. WAN Links ........................................... 36
5.4. WAN Settings ......................................... 39
5.5. Link Supervision ........................................ 40
5.6. Ethernet Ports ......................................... 42
5.7. Ethernet Link Settings .................................... 43
5.8. VLAN Management ...................................... 44
5.9. LAN IP Configuration ..................................... 45
5.10. SIMs .............................................. 47
5.11. WWAN Interfaces ....................................... 50
5.12. WLAN Management ...................................... 52
5.13. WLAN Configuration ..................................... 57
5.14. WLAN IP Configuration .................................... 61
5.15. USB Administration ...................................... 64
5.16. USB Device Management .................................. 65
5.17. Serial Port Administration ................................... 68
5.18. Serial Port Settings ...................................... 69
5.19. Digital I/O Ports ........................................ 72
5.20. Static Routing ......................................... 75
5.21. Extended Routing ....................................... 77
5.22. Multipath Routes ....................................... 78
5.23. Mobile IP ............................................ 81
5.24. Firewall Groups ........................................ 88
5.25. Firewall Rules ......................................... 89
5.26. Masquerading ......................................... 91
5.27. Inbound NAPT ......................................... 92
5.28. OpenVPN Administration ................................... 94
5.29. OpenVPN Configuration ................................... 95
5.30. OpenVPN Client Management ................................ 99
5.31. IPsec Administration ..................................... 101
5.32. IPsec Configuration ...................................... 102
5.33. PPTP Administration ..................................... 106
5.34. PPTP Tunnel Configuration .................................. 107
5.35. PPTP Client Management .................................. 108
5.36. Dial-in Server Settings .................................... 111
5.37. SDK Administration ...................................... 117
5.38. SDK Jobs ........................................... 118
5.39. DHCP Server ......................................... 122
5.40. DNS Server .......................................... 124
5.41. NTP Server .......................................... 127
5.42. Dynamic DNS Settings .................................... 128
5.43. E-Mail Settings ........................................ 130
5.44. SMS Configuration ...................................... 133
5.45. SSH and Telnet Server .................................... 135
5.46. SNMP Agent .......................................... 138
5.47. Web Server .......................................... 142
7

NBB-800
User Manual for NRSW version 4.5.0.100
5.48. VRRP Configuration ...................................... 146
5.49. ITxPT configuration ...................................... 148
5.50. ITxPT FMStoIP ........................................ 149
5.51. ITxPT GNSS .......................................... 153
5.52. ITxPT Time .......................................... 154
5.53. ITxPT VEHICLEtoIP ...................................... 155
5.54. Voice Gateway Administration ................................ 156
5.55. System ............................................. 162
5.56. Regional settings ....................................... 164
5.57. User Accounts ......................................... 167
5.58. Remote Authentication .................................... 168
5.59. Manual File Configuration .................................. 173
5.60. Automatic File Configuration ................................. 174
5.61. Factory Configuration ..................................... 175
5.62. Log Viewer ........................................... 177
5.63. Tech Support File ....................................... 178
5.64. Keys and certificates ..................................... 179
5.65. Certificate Configuration ................................... 181
5.66. Licensing ............................................ 184
8

NBB-800
User Manual for NRSW version 4.5.0.100
List of Tables
3.1. Environmental Conditions .................................. 16
3.2. NB800 (Rev. B02) Interfaces ................................ 17
3.3. NB800 (Rev. B02) Status Indicators ............................ 18
3.4. Ethernet Status Indicators .................................. 18
3.5. Mobile Interface ....................................... 19
3.6. Mobile Antenna Port Specification ............................. 19
3.7. IEEE 802.11 Standards ................................... 19
3.8. WLAN Antenna Port Specification ............................. 20
3.9. GNSS Specifications option G ............................... 20
3.10. GNSS / GPS Antenna Port Specification ......................... 20
3.11. USB 2.0 Host Port Specification .............................. 21
3.12. Ethernet Port Specification ................................. 22
3.13. Pin Assignments of RJ45 Ethernet Connector ...................... 22
3.14. Power Specifications ..................................... 23
3.15. Power Connector ....................................... 23
3.16. Pin Assignments of Terminal Block ............................. 23
3.17. Specification of COMIO Shield ............................... 24
3.18. Pin Assignments of COMIO Shield ............................. 24
3.19. Specification of 2xCAN Shield ............................... 25
3.20. Pin Assignments of 2xCAN Shield ............................. 25
3.21. Pin Assignments of CanGI Shield ............................. 26
5.20. IEEE 802.11 Network Standards .............................. 54
5.43. Static Route Flags ...................................... 76
5.90. SMS Control Commands .................................. 121
5.100. SMS Number Expressions ................................. 134
5.152. Certificate Sections ..................................... 180
5.153. Certificate Operations .................................... 180
A.1. Abbreviations ......................................... 200
A.2. System Events ........................................ 202
A.3. SDK Examples ........................................ 225
9

NBB-800
User Manual for NRSW version 4.5.0.100
1. Welcome to NetModule
Thank you for purchasing a NetModule product. This document should give you an introduction to the
device and its features. The following chapters describe any aspects of commissioning the device,
installation procedure and provide helpful information towards configuration and maintenance.
Please find further imformation such as sample SDK script or configuration samples in our wiki on
http://wiki.netmodule.com.
10

NBB-800
User Manual for NRSW version 4.5.0.100
2. Conformity
This chapter provides general information for putting the router into operation.
2.1. Safety Instructions
Please carefully observe all safety instructions in the manual that are marked with the symbol .
Compliance information: The NetModule routers must be used in compliance with
any and all applicable national and international laws and with any special restrictions
regulating the utilization of the communication module in prescribed applications and
environments.
Information about the accessories / changes to the device:
– Please only use original accessories to prevent injuries and health risks.
– Changes made to the device or the use of non-authorized accessories will render the
warranty null and void and potentially invalidate the operating license.
– NetModule routers must not be opened (SIM cards may be used according to the
instructions).
11

NBB-800
User Manual for NRSW version 4.5.0.100
Information about the device interfaces:
– All systems that are connected to the NetModule router interfaces must meet the
requirements for SELV (Safety Extra Low Voltage) systems.
– Interconnections must not leave the building nor penetrate the body shell of a vehicle.
– Connections for antennas may only exit the building or the vehicle hull if transient
overvoltages (according to IEC 62368-1) are limited by external protection circuits
down to 1 500 Vpeak. All other connections must remain within the building or the vehicle
hull.
– Always keep a distance of more than 40 cm from the antenna in order to reduce
exposure to electromagnetic fields below the legal limits.
– Devices with a WLAN interface may be operated only with applicable Regulatory Do-
main configured. Special attention must be paid to country, number of antennas and
the antenna gain (see also chapter 5.3.4). The maximum allowed gain is 3dBi in
the relevant frequency range. WLAN antennas with a higher amplification may be
used with the NetModule router "Enhanced-RF-Configuration" software license and
the antenna gain and cable attenuation that have been correctly configured by certi-
fied specialized personnel. A misconfiguration will lead to loss of the approval.
– Cellular antennas attached to the router must have an antenna gain of equal or less
than 2.5 dBi. The user is responsible for the compliance with the legal regulations.
– Only CE-compliant power supplies with a current-limited SELV output voltage range
may be used with the NetModule routers.
General safety instructions:
– Observe the usage limitations of radio units at filling stations, in chemical plants, in
systems with explosives or potentially explosive locations.
– The devices may not be used in airplanes.
– Exercise particular caution near personal medical aids, such as pacemakers and hear-
ing aids.
– The NetModule routers may also cause interference in the nearer distance of TV sets,
radio receivers and personal computers.
– Never perform work on the antenna system during a thunderstorm.
– The devices are generally designed for normal indoor use. Do not expose the devices
to extraordinary environmental conditions worse than IP40.
– Protect them against aggressive chemical atmospheres and humidity or temperatures
outside specifications.
– We highly recommended creating a copy of a working system configuration. It can be
easily applied to a newer software release afterwards.
12

NBB-800
User Manual for NRSW version 4.5.0.100
2.2. Declaration of Conformity
NetModule hereby declares that under our own responsibility that the routers
comply with the relevant standards following the provisions of the RED Directive
2014/53/EU. The signed version of the Declaration of Conformity can be obtained
from http://www.netmodule.com/downloads
2.3. Waste Disposal
In accordance with the requirements of the Council Directive 2012/19/EU regard-
ing Waste Electrical and Electronic Equipment (WEEE), you are urged to ensure
that this product will be segregated from other waste at end-of-life and delivered
to the WEEE collection system in your country for proper recycling.
2.4. National Restrictions
This product may be generally used in all EU countries (and other countries following the RED Directive
2014/53/EU) without any limitation. Please refer to our WLAN Regulatory Database for getting further
national radio interface regulations and requirements for a particular country.
13

NBB-800
User Manual for NRSW version 4.5.0.100
2.5. Open Source Software
We inform you that NetModule products may contain in part open-source software. We are distributing
such open-source software to you under the terms of GNU General Public License (GPL)1, GNU
Lesser General Public License (LGPL)2or other open-source licenses3. These licenses allow you to
run, copy, distribute, study, change and improve any software covered by GPL, Lesser GPL, or other
open-source licenses without any restrictions from us or our end user license agreement on what
you may do with that software. Unless required by applicable law or agreed to in writing, software
distributed under open-source licenses is distributed on an "AS IS" basis, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied.
To obtain the corresponding open source codes covered by these licenses, please contact our techni-
cal support at [e-mail].
Acknowledgements
This product includes:
– PHP, freely available from http://www.php.net
– Software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org)
– Cryptographic software written by Eric Young ([e-mail])
– Software written by Tim Hudson ([e-mail])
– Software written Jean-loup Gailly and Mark Adler
– MD5 Message-Digest Algorithm by RSA Data Security, Inc.
– An implementation of the AES encryption algorithm based on code released by Dr Brian Glad-
man
– Multiple-precision arithmetic code originally written by David Ireland
– Software from The FreeBSD Project (http://www.freebsd.org)
1Please find the GPL text under http://www.gnu.org/licenses/gpl-2.0.txt
2Please find the LGPL text under http://www.gnu.org/licenses/lgpl.txt
3Please find the license texts of OSI licenses (ISC License, MIT License, PHP License v3.0, zlib License) under
http://opensource.org/licenses
14

NBB-800
User Manual for NRSW version 4.5.0.100
3. Specifications
3.1. Appearance
15

NBB-800
User Manual for NRSW version 4.5.0.100
3.2. Features
All models of NB800 (Rev. B02) have following standard functionalities:
– 1x Ethernet port (10/100 Mbit/s)
– 1x Micro SIM (3FF) card slot
– 1x USB
– 4 GB internal storage
– Full featured router software
The NB800 (Rev. B02) can be equipped with the following options:
– 1x LTE, UMTS, GSM or UMTS, GSM
– 1x WLAN IEEE 802.11
– 1x Bluetooth and Bluetooth Low Energy
– 1x GNSS
– 1x Extension shields
– Software Keys
Due to its modular approach, the NB800 (Rev. B02) router and its hardware components can be
arbitrarily assembled according to its indented usage or application. Please contact us in case of
special project requirements.
3.3. Environmental Conditions
Parameter Rating
Input Voltage 12 VDC to 24 VDC (−20% / +20%)
Operating Temperature Range −40 ◦Cto +70 ◦C
Storage Temperature Range −40 ◦Cto +85 ◦C
Humidity 0 to 95% (non-condensing)
Altitude up to 4000m
Over-Voltage Category I
Pollution Degree 2
Ingress Protection Rating IP40
Table 3.1.: Environmental Conditions
16

NBB-800
User Manual for NRSW version 4.5.0.100
3.4. Interfaces
3.4.1. Overview
Nr. Label Function
1 LED Indicators LED Indicators for the different interfaces
2PWR Power supply 12-24 VDC.
3EXT1 Extension connector e.g. for CAN or COM/IO
4ETH FastEthernet port, can be used as LAN or WAN interface.
5 Reset Reboot and factory reset button
6 USB USB 2.0 host port, can be used for software/configuration updates.
7WLAN SMA female connectors for MIMO WLAN antenna. A3 is the main port, A4
is the auxiliary port.
8BT SMA female connector (A3) for Bluetooth.
9MOB SMA female connectors for LTE/UMTS antennas. A1 is the main, A2 the
auxiliary port
10 GNSS SMA female connector for GNSS
11 SIM Slot for 1 Micro SIM (3FF)
Table 3.2.: NB800 (Rev. B02) Interfaces
17

NBB-800
User Manual for NRSW version 4.5.0.100
3.4.2. Default LED Indicators
The following table describes the NB800 (Rev. B02) status indicators.
Label Color State Function
STAT lblinking The device is busy due to startup, software or configuration up-
date.
lon The device is ready.
MOB lblinking Wireless link connection is establishing.
USR lon Wireless link connection is up.
moff Wireless link connection is down.
Table 3.3.: NB800 (Rev. B02) Status Indicators
Ethernet LEDs
The following table describes the Ethernet status indicators.
Label Color State Function
S
(Speed)
lg On Link (10 Mbit/s or 100 Mbit/s
mOff No Link
L/A
(Link/Ac-
tivity)
ly On Link
ly Blinking Activity
mOff No Link
Table 3.4.: Ethernet Status Indicators
3.4.3. Reset
The reset button has two functions:
1. Reboot the system:
Press at least 3 seconds to release a system reboot.
The reboot is indicated with the red blinking STAT LED.
2. Factory reset:
Press at least 10 seconds to release a factory reset.
The start of the factory reset is confirmed by all LEDs lighting up for a second.
18

NBB-800
User Manual for NRSW version 4.5.0.100
3.4.4. Mobile
The various variants of the NB800 (Rev. B02)support multiple multimode modules for mobile commu-
nication. The LTE module supports 2x2 MIMO.
Standard Bands
4G (LTE/FDD) B1 (2100), B3 (1800), B5 (850), B7 (2600), B8 (900), B20 (800)
3G (DC-HSPA+/UMTS) B1 (2100), B2 (1900), B5 (850), B8 (900)
2G (EDGE/GPRS/GSM) B2 (1900), B3 (1800), B5 (850), B8 (900)
Table 3.5.: Mobile Interface
The mobile antenna ports have the following specification:
Feature Specification
Max. allowed cable length 30 m
Max. allowed antenna gain
including cable attenuation
2.5 dBi
Min. distance between collocated ra-
dio transmitter antennas
(Example: MOB1 to MOB2)
20 cm
Min. distance between people and an-
tenna
40 cm
Connector type SMA
Table 3.6.: Mobile Antenna Port Specification
3.4.5. Bluetooth
The NB800 (Rev. B02)supports Bluetooth 4.2 including Bluetooth Low Energy.
3.4.6. WLAN
The variants of the NB800 (Rev. B02)support a IEEE 802.11a/b/g/n WLAN module.
Standard Frequencies Bandwidth Max. Data Rate
802.11a 5 GHz 20 MHz 54 Mbit/s
802.11b 2.4 GHz 20 MHz 11 Mbit/s
802.11g 2.4 GHz 20 MHz 54 Mbit/s
802.11n 2.4 GHz 20 MHz 144 Mbit/s
802.11n 5 GHz 40 MHz 150 Mbit/s
Table 3.7.: IEEE 802.11 Standards
19

NBB-800
User Manual for NRSW version 4.5.0.100
Note: 802.11n supports 2x2 MIMO in 2.4 GHz and 1x1 in 5 GHz.
The WLAN antenna ports have the following specification:
Feature Specification
Max. allowed cable length 30 m
Max. allowed antenna gain
including cable attenuation
3.0 dBi1
Min. distance between collocated ra-
dio transmitter antennas
(Example: WLAN1 to MOB1)
20 cm
Min. distance between people and an-
tenna
40 cm
Connector type SMA
Table 3.8.: WLAN Antenna Port Specification
3.4.7. GNSS
Feature Specification
Systems GPS/GLONASS/GALILEO/BEIDOU
Data stream JSON or NMEA
Tracking sensitivity up to -162 dBm
Supported antennas Active and passive
Table 3.9.: GNSS Specifications option G
The GNSS antenna port have the following specification:
Feature Specification
Max. allowed cable length 30 m
Max. allowed antenna gain 3.0 dBi
Min. distance between collocated ra-
dio transmitter antennas
(Example: GNSS to MOB1)
20 cm
Connector type SMA
Table 3.10.: GNSS / GPS Antenna Port Specification
1Note: WLAN antennas with a higher amplification may be used with the NetModule router "Enhanced-RF-Configuration"
software license and the antenna gain and cable attenuation that have been correctly configured by certified specialized
personnel.
20