Page 1
NetModule Router NB800 (Rev. B02) User Manual for Software Version 4.5.0.100 Manual Version 2.272 NetModule AG, Switzerland December 15, 2020...
Page 2
NBB-800 User Manual for NRSW version 4.5.0.100...
Page 3
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.
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.
– 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).
Page 12
– 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.
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 http://www.netmodule.com/downloads...
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) , GNU...
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 –...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4. Interfaces 3.4.1. Overview Nr. Label Function LED Indicators LED Indicators for the different interfaces Power supply 12-24 V EXT1 Extension connector e.g. for CAN or COM/IO FastEthernet port, can be used as LAN or WAN interface. Reset Reboot and factory reset button USB 2.0 host port, can be used for software/configuration updates.
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 blinking The device is busy due to startup, software or configuration up- date. The device is ready. blinking Wireless link connection is establishing.
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)
Table 3.10.: GNSS / GPS Antenna Port Specification Note: 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...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.8. USB 2.0 Host Port The USB 2.0 host port has the following specification: Feature Specification Speed Low, Full & Hi-Speed Current max. 500 mA Max. cable length Cable shield mandatory Connector type Type A Table 3.11.: USB 2.0 Host Port Specification...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.9. RJ45 Ethernet Connector Specification The Ethernet port is specified as follows: Feature Specification Isolation 1500 V Speed 10/100 Mbit/s Mode Half- & Full-Duplex Crossover Automatic MDI/MDI-X Max. cable length 100 m Cable type CAT5e or better Cable shield mandatory...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.10. Power Supply NB800 (Rev. B02) routers have a non-isolated power supply input. It has the following specifications: Feature Specification Power supply nominal voltages 12 V and 24 V Voltage range 12 V to 24 V ( 20% / +20%) Avg.
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.11. COM/IO Shield The COM/IO Shield has the following specification: Feature Specification Feature 1xRS-232/485 1xdigital input 1xdigital output RS-232 Signals TX, RX RS-232 Signal Level High > 5 V , low < -5 V RS-232 Bitrate Up to 1 Mbit/s RS-485 Signals...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.12. 2xCAN Shield The 2xCAN Shield has the following specification: Feature Specification Features 2x CAN V2.0B Signals CANH, CANL Signal Level High > 2.75 V , low < 2.0 V Bitrate Up to 1 Mbit/s Termination No internal bus termination On request: 120 Ω...
NBB-800 User Manual for NRSW version 4.5.0.100 3.4.13. CanGI Shield – 1x GNSS to SMA – 1x CAN on 8 pin terminal block header 3.5mm Pin Assignment Signal CAN_H CAN_L Table 3.21.: Pin Assignments of CanGI Shield Note: Cables with length >30m must be shielded.
SIM card connector. 4.3. Installation of the GSM/UMTS/LTE Antenna NetModule routers will only operate efficiently in the cellular network if there is a good signal. A stub antenna will be suitable for most applications. However, in some circumstances it might be necessary to use remote antennas together with an extended cable (max.
– WLAN antennas must only be installed in buildings or within vehicle hulls. – WLAN antennas may have an amplification of maximum 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 certified specialized personnel.
8A current without heating up significantly or dam- aging its isolation. Attention: Only CE-compliant power supplies with a current-limited SELV output voltage range may be used with the NetModule routers.
5.1. First Steps NetModule routers can be easily set up by using the HTTP-based configuration interface, called the Web Manager. It is supported by the latest web browsers (e.g. Microsoft Internet Explorer 11, Mozilla Firefox 28.0, Safari 7 and many others). Please ensure to have JavaScript turned on.
Page 32
NBB-800 User Manual for NRSW version 4.5.0.100 2. Serial Console Login: It is also possible to log into the system via the serial port. This would re- quire a terminal emulator (such as PuTTY or HyperTerminal) and an RS232 connection (115200 8N1) attached to the serial port of your local computer.
Page 34
NBB-800 User Manual for NRSW version 4.5.0.100 power of the interface as well as the list of associated stations. GNSS This page displays the position status values, such as latitude/longitude, the satellites in view and more details about the used satellites. Ethernet This page shows information about the Ethernet interfaces and packet statistics information.
Page 35
NBB-800 User Manual for NRSW version 4.5.0.100 OSPF This page provides information about the Open Shortest Path First routing protocol. DynDNS This page provides information about Dynamic DNS. System Status The system status page displays various details of your NB800 (Rev. B02) router, including system details, information about mounted modules and software release information.
Page 37
NBB-800 User Manual for NRSW version 4.5.0.100 In general, a link will be only dialed or declared as up if the following prerequisites are met: Condition WWAN WLAN PPPoE Modem is registered Registered with valid service type Valid SIM state Sufficient signal strength Client is associated Client is authenticated...
Page 38
If WLAN client, the LAN interface to which the WAN link should be bridged. NetModule routers provide a feature called IP pass-through (aka Drop-In mode). If enabled, the WAN address will be be passed-through to the first DHCP client of the specified LAN interface. As Ethernet- based communication requires additional addresses, we pick an appropriate subnet to talk to the LAN host.
Page 41
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Supervision Settings Ping interval The interval in seconds at which pings are transmitted on each inter- face Retry interval The interval in seconds at which pings are re-transmitted in case a first ping failed Max.
VLAN Management NetModule routers support Virtual LAN according to IEEE 802.1Q which can be used to create virtual interfaces on top of an Ethernet interface. The VLAN protocol inserts an additional header to Ethernet frames carrying a VLAN Identifier (VLAN ID) which is used for distributing the packets to the associated...
Page 46
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter LAN IP Settings Alias subnet mask The alias subnet mask for this interface When running in WAN mode, the interface may be configured with the following settings: Parameter WAN IP Settings WAN mode The WAN operation mode, defines whether the interface should run as DHCP client, statically configured or over PPPoE.
Page 48
NBB-800 User Manual for NRSW version 4.5.0.100 not, please double-check your PIN. Please keep in mind that registering to a network usually takes some time and depends on signal strength and possible radio interferences. You may hit the Update button at any time in order to restart PIN unlocking and trigger another network registration attempt.
Page 49
NBB-800 User Manual for NRSW version 4.5.0.100 Configuration A SIM card is generally assigned to a default modem but might be switched, for instance if you set up two WWAN interfaces with one modem but different SIM cards. Close attention has to be paid when other services (such as SMS or Voice) are operating on that modem, as a SIM switch will naturally affect their operation.
Page 51
NBB-800 User Manual for NRSW version 4.5.0.100 Generally, the connection settings are derived automatically as soon as the modem has registered and the network provider has been found in our database. Otherwise, it will be required to configure the following settings manually: Parameter WWAN Connection Parameters Phone number...
Page 53
NBB-800 User Manual for NRSW version 4.5.0.100 Configurable parameters for access-point, client mode, mesh point and any dual mode: Parameter WLAN Management Regulatory Domain Select the country the Router operates in Number of antennas Set the number of connected antennas Antenna gain Specify the antenna gain for the connected antennas.
NBB-800 User Manual for NRSW version 4.5.0.100 Standard Frequencies Bandwidth Data Rate 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 5.20.: IEEE 802.11 Network Standards...
Page 55
NBB-800 User Manual for NRSW version 4.5.0.100 Running as mesh point, you can further configure the following settings: Parameter WLAN Mesh-Point Management Operation type Specifies the desired IEEE 802.11 operation mode Radio band Selects the radio band to be used for connections, depending on your module it could be 2.4 or 5 GHz Channel Specifies the channel to be used...
Page 56
NBB-800 User Manual for NRSW version 4.5.0.100 Prior to setting up an access point, it is always a good idea to run a network scan for getting a list of neighboring WLAN networks and then choose the less interfering channel. Please note that two adequate channels are required for getting good throughputs with 802.11n and a bandwidth of 40 MHz.
Page 58
NBB-800 User Manual for NRSW version 4.5.0.100 This section can be used to configure security-related settings. Parameter WLAN Access-Point Configuration SSID The network name (called SSID) Security mode The desired security mode WPA/WPA2 mixed mode WPA2 should be preferred over WPA1, running WPA/WPA2 mixed- mode offers both.
Page 59
NBB-800 User Manual for NRSW version 4.5.0.100 Running in mesh point mode, it is possible to connect to one or more mesh points within the mesh network at the same time. The system will automatically join the wireless network, connect to the other mesh partners with the same ID and sercurtiy credentials.
Page 60
NBB-800 User Manual for NRSW version 4.5.0.100 The following security modes can be configured: Parameter WLAN Mesh-Point Security Modes MESHID is disabled None No authentication, provides an open network SAE (Simultaneous Authentication of Equals) is a secure password- based authentication and key establishment protocol...
Page 62
NBB-800 User Manual for NRSW version 4.5.0.100 The following feature can be configured if the WLAN interface is bridged Parameter WLAN Bridging features IAPP Enables the Inter-Access Point Protocol feature Pre-auth Enables the pre-authentication mechanism for roaming clients (if sup- ported by the client)
NBB-800 User Manual for NRSW version 4.5.0.100 5.3.5. Software Bridges Software bridges can be used to bridge layer-2 devices like OpenVPN TAP, GRE or WLAN interfaces without the need for a physical LAN interface. Bridge Settings This page can be used to enable/disable software bridges. It can be configured as follows: Parameter Bridge Settings...
User Manual for NRSW version 4.5.0.100 5.3.6. USB NetModule routers ship with a standard USB host port which can be used to connect a storage, network or serial USB device. Please contact our support in order to get a list of supported devices.
Page 66
NBB-800 User Manual for NRSW version 4.5.0.100 USB Autorun This feature can be used to automatically launch a shell script or perform a software/config update as soon as an USB storage stick has been plugged in. For authentication, a file called autorun.key must exist in the root directory of a FAT16/32 formatted stick.
Bridges the Serial Interface to the Modem TTY of an intergrated WWAN Modem. modem emulator Emulates a classical AT command driven modem on the serial inter- http://wiki.netmodule.com/app-notes/hayes-modem- face. See at-simulator for detailed information. The serial port will be reserved for SDK scripts.
Page 70
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Serial Settings Defines the software flow control for the serial port, XOFF will send a Software flow control stop, XON a start character to the other end to control the rate of any incoming data Hardware flow control You may enable RTS/CTS hardware flow control, so that the RTS and...
Page 71
NBB-800 User Manual for NRSW version 4.5.0.100 When running the serial port as AT modem emulator the following settings can be applied: Parameter Serial Port Settings Physical protocol Selects the desired physical protocol on the serial port Baud rate Specifies the baud rate run on the serial port Hardware flow control You may enable RTS/CTS hardware flow control, so that the RTS and CTS lines are used to control the flow of data...
NBB-800 User Manual for NRSW version 4.5.0.100 5.3.9. Audio Audio Administration This page can be used to pre-configure the audio module. It can be later used for the voice gateway. It can be configured as follows: Parameter Audio Settings Volume level Default volume level for line-out Audio Testing This page can be used to play or record an audio sample.
NBB-800 User Manual for NRSW version 4.5.0.100 5.3.10. Bluetooth Low Energy If a Bluetooth interface is available it can be used either with the SDK scripting engine or forwarded to the Virtualization. Bluetooth Settings This page can be used to assign the Bluetooth module either to SDK or Virtualization or to turn Blue- tooth functionality off.
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Static Route Configuration Destination The destination address of a packet Netmask The subnet mask which forms, in combination with the destination, the network to be addressed. A single host can be specified by a netmask of 255.255.255.255, a default route corresponds to 0.0.0.0.
Cisco 2900 Series home agent implementation has been verified. However, since NetModule routers implement a mobile node as well as a home agent, a MIP network with up to 10 mobile nodes can be implemented without requiring expensive third party routers.
Page 80
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Mobile IP Configuration The shared secret used for authentication of the mobile node at the Shared secret home agent. This can be either a 128-bit hexadecimal value or a random length ASCII string. Life time The lifetime of security associations in seconds UDP encapsulation...
Page 82
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Mobile IP Node Configuration The shared secret used for authentication of the mobile node at the Shared secret home agent. This can be either a 128-bit hexadecimal value or a random length ASCII string.
User Manual for NRSW version 4.5.0.100 5.4.5. Quality Of Service NetModule routers are able to prioritize and shape certain kinds of IP traffic. This is currently limited on egress, which means that only outgoing traffic can be stipulated. The current QoS solution is using Stochastic Fairness Queueing (SFQ) classes in combination with Hierarchy Token Bucket (HTB) qdiscs.
Page 84
NBB-800 User Manual for NRSW version 4.5.0.100 In case an interface has been activated, the system will automatically create the following queues: Parameter QoS Default Queues high A high priority queue which may hold any latency-critical services (such as VoIP) default A default queue which will handle all other services A low priority queue which may hold less-critical services for which...
5.4.6. Multicast Multicast routing (MCR) can be configured and managed by a daemon. Only one MCR daemon can be used at a time. NetModule routers ship with two different MCR daemons to select from depending on your dependen- cies: Parameter...
NBB-800 User Manual for NRSW version 4.5.0.100 5.4.7. OSPF The OSPF tab allows the NetModule router to be added to a network of OSPF routers. Parameter OSPF General Settings OSPF status Specifies whether the OSPF routing protocol is active Redistribute...
NBB-800 User Manual for NRSW version 4.5.0.100 5.4.8. BGP The BGP tab allows to set up peerings of the NetModule router with other Border Gateway Protocol enabled routers. Parameter BGP General Settings BGP status Specifies whether the BGP routing protocol is active...
NBB-800 User Manual for NRSW version 4.5.0.100 5.5. FIREWALL 5.5.1. Administration NetModule routers use Linux’s netfilter/iptables firewall framework http://www.netfilter.org (see for more information) which supports stateful inspection, that is, granting the same permissions for inherited connections within an IP session (e.g. FTP which builds up a control and data connection).
Page 90
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Firewall Rule Configuration Protocol The used IP protocol of matching packets (UDP, TCP or ICMP) Destination port(s) The destination port of matching packets, which can be specified by a single port or a range of ports (only UDP/TCP). The statistics page can be used to figure out if rules have matched any packets and provides a conve- nient way to debug your firewall setup.
Page 93
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Inbound NAPT Rules Ports The used UDP/TCP port of matching packets Redirect to The address to which matching packets shall be redirected Redirect port The port to which matching packets will be redirected Select mapping context according to your needs: Parameter Mapping contexts...
User Manual for NRSW version 4.5.0.100 Tunnel Configuration NetModule routers support one single server tunnel and up to four client tunnels. You can specify tunnel parameters either in standard configuration or upload an expert mode file which has been created in advance. Refer to chapter 5.6.1...
Page 96
NBB-800 User Manual for NRSW version 4.5.0.100 If the tunnel is operated in client mode, the following settings can be applied: Parameter OpenVPN Client Configuration Peer selection Specifies how the remote peer shall be selected, besides a single server you may configure multiple servers which can, in case of fail- ures, either be selected sequently (i.e.
Page 97
NBB-800 User Manual for NRSW version 4.5.0.100 The following further options can be applied: Parameter OpenVPN Options use compression Enable or disable LZO packet compression use keepalive Can be used to send a periodic keepalive packet in order to keep the tunnel up despite of inactivity redirect gateway By redirecting the gateway, all packets will be directed to the VPN...
Page 98
NBB-800 User Manual for NRSW version 4.5.0.100 OpenVPN Expert Configuration (Server) A server tunnel typically requires the following files: Parameter Server Expert Files server.conf OpenVPN configuration file ca.crt Root certificate authority file server.crt Certificate file server.key Private key file dh1024.pem Diffie-Hellman parameters file A directory containing client-specific configuration files Keep in mind that a certificate becomes valid once its validity time has been reached, thus an accurate...
NBB-800 User Manual for NRSW version 4.5.0.100 5.6.2. IPsec IPsec is a protocol suite for securing IP communications by authenticating and encrypting each packet of a communication session and thus establishing a secure virtual private network. IPsec includes various cryptographic protocols and ciphers for key exchange and data encryption and can be seen as one of the strongest VPN technologies in terms of security.
Page 103
Restart the peer. IKE Authentication NetModule routers support IKE authentication through pre-shared keys (PSK) or certificates within a public key infrastructure. Extended Authentication (XAUTH) leverages RADIUS-like authentication and can be used to apply user level access control over IPSec.
Page 104
NBB-800 User Manual for NRSW version 4.5.0.100 IKE Proposal This section can be used to configure the phase 1 settings: Parameter IPsec IKE Proposal Settings Choose the desired negotiation mode. Preferably, main mode should Negotiation mode be used but aggressive mode might be applicable when dealing with dynamic endpoint addresses.
Page 105
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter IPsec Network Settings Local network The address of your local area network Local netmask The netmask of your local area network Peer network The address of the remote network behind the peer Peer netmask The netmask of the remote network behind the peer NAT address...
NBB-800 User Manual for NRSW version 4.5.0.100 5.6.4. GRE The Generic Routing Encapsulation (GRE) is a tunneling protocol that can encapsulate a wide variety of network layer protocols inside virtual point-to-point links over IP. GRE is defined in RFC 1701, 1702 and 2784.
NBB-800 User Manual for NRSW version 4.5.0.100 5.6.5. L2TP The Layer 2 Tunneling Protocol is a tunneling protocol which does not support any encryption or confidentiality. It relies on an encryption protocol that it passes within the tunnel to provide privacy. The following parameters are required for setting up a tunnel: Parameter L2TP Configuration...
NBB-800 User Manual for NRSW version 4.5.0.100 5.6.6. Dial-In On this page you can configure the Dial-In server in order to establish a data connection over GSM calls. Thus, one would generally apply a required service type of 2G-only, so that the modem registers to GSM only.
Page 112
NBB-800 User Manual for NRSW version 4.5.0.100 Please note that Dial-In connections are generally discouraged. As they are implemented as GSM voice calls, they suffer from unreliability and poor bandwidth.
5.7. SERVICES 5.7.1. SDK NetModule routers are shipping with a Software Development Kit (SDK) which offers a simple and fast way to implement customer-specific functions and applications. It consists of: 1. An SDK host which defines the runtime environment (a so-called sandbox), that is, controlling...
Page 114
NBB-800 User Manual for NRSW version 4.5.0.100 SDK API Functions The current range of API functions can be used to implement the following features: 1. Send/Retrieve SMS 2. Send E-mail 3. Read/Write from/to serial device 4. Control digital input/output ports 5.
Page 115
NBB-800 User Manual for NRSW version 4.5.0.100 Let’s now pay some attention to the very powerful API function nb_status. It can be used to query the router’s status values in the same manner as they can be shown with the CLI. It returns a structure of variables for a specific section (a list of available sections can be obtained by running cli status -h).
Page 116
NBB-800 User Manual for NRSW version 4.5.0.100 Here is an example how one might adopt those functions: /* check current city and enable the second WAN link */ location = nb_status ( " location " ( location ) { city = struct_get ( location , "...
Page 119
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter SDK Script Parameters Name A meaningful name to identify the script Description An optional description of the script Arguments An optional set of arguments passed to the script (supports quoting) Action You may either edit a script, upload it to the system or select one of the example scripts or an already uploaded script You are ready to set up a job afterwards, it can be created by using the following parameters: Parameter...
Page 120
NBB-800 User Manual for NRSW version 4.5.0.100 Testing The testing page offers an editor and an input field for optional arguments which can be used to perform test runs of your script or test dedicated portions of it or upload an entire file. Please note that you might need to quote arguments as they will otherwise be separated by white-spaces.
NBB-800 User Manual for NRSW version 4.5.0.100 The following commands are supported: Command Action status Will reply a message to the sender including a short system overview connect Will enable the first WAN link configured on the system disconnect Will disable the first WAN link configured on the system reboot Initiates a reboot of the system output 1 on...
Page 123
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter DHCP Server Settings Persistent leases By turning on this option the router will remember issued leases even after a reboot. This can be used to ensure that the same IP address will be assigned to a particular host. DHCP options By default the DHCP will hand out the interface address as default gateway and the current DNS server addresses if not configured else-...
Page 125
NBB-800 User Manual for NRSW version 4.5.0.100...
Page 126
NBB-800 User Manual for NRSW version 4.5.0.100 You may further configure static hosts for serving fixed IP addresses for various host names. Parameter DNS Static Hosts Settings Address The IP address of the static host Hostname The hostname of the static host Please remember to point DNS lookups of local hosts to the router’s address.
We provide support for a bunch of common DynDNS operators but it is also possible to define a custom update URL. Please note that your NetModule router can operate as DynDNS server on its own, provided that you have your hosts pointed to the DNS service of the router.
Page 129
NBB-800 User Manual for NRSW version 4.5.0.100 A DynDNS service can receive the following parameters: Parameter Dynamic DNS Settings Provider You can choose one of the listed providers or provide a custom URL Dynamic address Specifies whether the address is derived from the hot-link or via an external service Hostname The host-name provided by your DynDNS service (e.g.
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.7. Events By using the event manager you can notify remote systems about system events. A notification can be sent using E-Mail, SMS or SNMP traps. Parameter Event Notification Settings E-Mail address The E-Mail address to which the notification shall be sent (E-Mail client must be enabled) Phone number The phone number to which the notification shall be sent (SMS ser-...
5.7.8. SMS Administration NetModule routers can receive or send short messages (SMS) if enabled by your SIM provider. Messages are received/sent by the modem which has been assigned to a SIM, so one has to properly configure a SMS-capable default modem as described in chapter 5.3.3.
NBB-800 User Manual for NRSW version 4.5.0.100 identify SIMs based on their IMEI number and track their statistics in a non-volatile manner. Parameter SMS SIM Configuration SMS gateway The service center number for sending short messages. It is generally retrieved automatically from your SIM card but you may define a fix number here.
Page 136
NBB-800 User Manual for NRSW version 4.5.0.100 The following parameters can be applied to the SSH service: Parameter SSH Server Settings Administrative status Whether the SSH service is enabled or disabled Server port The TCP port of the service (usually 22) Disable admin login Disable login for admin users Disable password-based lo-...
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.10. SNMP Agent NetModule routers are equipped with an SNMP daemon, supporting basic MIB tables (such as ifTable), plus additional enterprise MIBs to manage multiple systems. Parameter Supported MIBs .1.3.6.1.2.1 MIB-II (RFC1213), SNMPv2-MIB (RFC3418) .1.3.6.1.2.1.2.1...
Page 139
NBB-800 User Manual for NRSW version 4.5.0.100 SNMP Authentication When running in SNMPv3, it is possible to configure the following authentication settings: Parameter SNMPv3 Authentication Authentication Defines the authentication (MD5 or SHA) Encryption Defines the privacy protocols to use (DES or AES) In general, the admin user can read and write any values.
Page 140
NBB-800 User Manual for NRSW version 4.5.0.100 Getting the current config description: snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1 1.3.6.1.4.1.31496.10.40.4.0 Getting the current config hash: snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1 1.3.6.1.4.1.31496.10.40.5.0 Restarting the device: snmpset -v 3 -u admin -n ""...
Page 141
NBB-800 User Manual for NRSW version 4.5.0.100 Switching to alternative software: snmpset -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1 1.3.6.1.4.1.31496.10.40.16.0 i 0 The return value can be derived from the software update status. Switching to alternative config: snmpset -v 3 -u admin -n ""...
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.12. MQTT Broker The MQTT Broker can be used to distribute MQTT messages between MQTT clients. Please set up appropriate firewall rules if you want to restrict access to the MQTT Broker. Keys and certificates for TLS encryption are managed via Keys & Certificates (see chapter 5.8.8). The MQTT Broker service can receive the following parameters: Parameter MQTT Broker Settings...
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.13. Softflow This page can be used to configure the network traffic analyser daemon softflowd used for exporting NetFlow traffic data. Parameter Softflow Settings Interface Interface on which to listen for traffic Host Address Destination address of the traffic data Port Port of the destination address...
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.14. Discovery This page can be used to enabled discovery protocols which can be used to discover and to get discovered by other hosts. Parameter Discovery Configuration Administrative status Administrative status Enabled protocols List of enabled discovery protocols The following protocols are supported: Parameter...
User Manual for NRSW version 4.5.0.100 5.7.15. Redundancy This page can be used to set up a redundant pair of NetModule routers (or other systems) by running the Virtual Router Redundancy Protocol (VRRP) between them. A typical VRRP scenario defines a first host playing the master and another the backup device, they both define a virtual gateway IP...
Page 147
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Redundancy Configuration Role The role of this system (either master or backup) The Virtual Router ID (you can theoretically run multiple instances) Interface Interface on which VRRP should be performed Virtual gateway address The virtual gateway address formed by the participating hosts We assign a priority of 100 to the master and 1 to the backup router.
NBB-800 User Manual for NRSW version 4.5.0.100 5.7.16. ITxPT This is an integration of the ITxPT standard v2.0.1. (see ITxPT Onboard Architecture Specifications v2.0.1) Configuration Figure 5.49.: ITxPT configuration The following parameters can be used to set it up: Parameter ITxPT Administration Administrative status Specifies whether the ITxPT functionality should be enabled or dis-...
NBB-800 User Manual for NRSW version 4.5.0.100 FMS to IP Figure 5.50.: ITxPT FMStoIP On this page you can configure the FMS to IP functionality. Parameter FMS to IP options Enable Specifies whether the FMS to IP functionality should be enabled or disabled.
Page 150
NBB-800 User Manual for NRSW version 4.5.0.100 FMS to IP database format The json file format is used. The database file describes the incoming data-packages. There are two basic components to describe any signal used in the FMS standard. The Parameter Group Number (PGN) and the Suspect Parameter Number (SPN).
Page 151
NBB-800 User Manual for NRSW version 4.5.0.100 The top level structure is an array. It contains PGN objects that define a PGN with the following types: PGN Definition Parameter PGN definition name Name of the pgn. The PGN number in decimal. length Length of the can message.
Page 152
NBB-800 User Manual for NRSW version 4.5.0.100 SPN Definition The SPN are divided into three types: nummerical, status and string. Parameter Nummerical SPN byteSize Size of the data in bytes. offset The offset in the can-data. formatGain The numerical factor used to give the value. formatOffset The numerical offset of the value.
NBB-800 User Manual for NRSW version 4.5.0.100 ITxPT GNSS Figure 5.51.: ITxPT GNSS Parameter ITxPT GNSS Enable Specifies whether the ITxPT GNSS should be enabled or disabled.
NBB-800 User Manual for NRSW version 4.5.0.100 ITxPT Time Figure 5.52.: ITxPT Time Parameter ITxPT Time Enable Specifies whether the ITxPT Time should be enabled or disabled.
NBB-800 User Manual for NRSW version 4.5.0.100 VEHICLE to IP Figure 5.53.: ITxPT VEHICLEtoIP Parameter ITxPT VEHICLEtoIP Enable Specifies whether the ITxPT VEHICLEtoIP should be enabled or dis- abled. A VEHICLEtoIP database is necessary to enable this service.
Page 157
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Voice Gateway Administration Settings SIP interface Specifies the interface (LAN or WAN) on which the agent should listen for incoming calls SIP port Specifies the agent’s listening port SIP register expires Specifies the registration interval in seconds In case you are running multiple WWAN interfaces sharing the same SIM, please bear in mind that the system may switch SIMs during operation which will also result in different settings for voice commu- nication.
Page 158
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Voice-Over-Mobile Audio Profiles Speakerphone Handle situations of loud echo with extreme acoustic distortion. This mode is intended for use with a car kit or speakerphone appli- cations with high volume and high distortion. Acoustic echo in this situation has negative ERL and is impossible to cancel completely.
Page 159
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Endpoint Settings SIP (user-agent) Register Selects whether the user-agent shall register at the registrar Expires The expiry time in seconds after registration will be triggered again...
Page 160
NBB-800 User Manual for NRSW version 4.5.0.100 Voice Routing This page can be used to configure generic voice routing between the endpoints. Enhanced routing facilities are provided via the SDK interface which is able to dispatch voice calls based on their attributes (such as phone numer) and other system related status information (e.g. number/duration of calls per endpoint, registration status and so on).
Page 161
NBB-800 User Manual for NRSW version 4.5.0.100 Client Configuration Any SIP client must be configured to use the router as its registrar/proxy. Parameter X-Lite Configuration User ID SIP username used in from headers (i.e. subscriber name) Domain SIP Domain used in from headers (optional) Authorization name Username used for authentication (i.e.
Page 163
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter System Settings Enable TCP timestamps Enable TCP timestamps for system wide TCP communication. This is needed for Protection Against Wrapped Sequence numbers (PAWS), but with these timestamps enabled a remote attacker can guess the uptime of the system.
This page can be used for setting the system time and configuring the time zone. You may further enable daylight saving changes for your specific time zone. NetModule routers can synchronize their system time by using one or more servers by the help of the Network Time Protocol (NTP) or via GNSS.
Page 165
Virtualization techniques can be used to run multiple isolated guests on top of the host system. The netmodule routers use OS-level virtualization: A system is virtualized at the operating system level, enabling multiple isolated user-space instances called containers. The same operating system kernel is used to implement the guest environments, applications running in a guest environment view it as a stand-alone system.
Page 166
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Install Install If this trigger is set the image download will start on apply. Any existing root file system will be overwritten. This parameter will not be stored in the configuration. After the installation was proceeded the value will be reset and needs to be set again if a new image shall be installed.
Page 169
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Remote authentication settings RADIUS server The RADIUS server address RADIUS secret The secret used to authenticate against the RADIUS server Authentication port The port used for authentication Accounting port The port used for accounting messages Use for login This option enables remotely-defined users to access the Web Man- ager, otherwise it is only used by services which have explicitly con-...
NBB-800 User Manual for NRSW version 4.5.0.100 5.8.3. Software Update Manual Software Update This menu can be used to run a manual software update of the system. Parameter Manual Software Update Update operation The update operation method being used. You can upload the image, download it from an URL or use the latest version from our server The server URL where the software update image should be down- loaded from...
NBB-800 User Manual for NRSW version 4.5.0.100 Attention In case you perform a major downgrade with a previous release line (e.g. 3.7.0 to 3.6.0), please ensure to always use the latest release of that branch (i.e. 3.6.0.X) as only those tend to be fully forward-compatible.
TFTP, HTTP, HTTPS, and FTP. For boxes with limited amount of flash you may also use usb0://<path-to-firmware-package>. A firmware package (ZIP) usually consists of a flash utility, an info file and the corresponding firmware files. Please follow http://www.netmodule.com/support/supportform.aspx in order to get the latest ver- sion. 5.8.5. Software Profiles The system consists of two root partitions which can hold different software versions and this menu can be used to switch between them.
NBB-800 User Manual for NRSW version 4.5.0.100 5.8.7. Troubleshooting Network Debugging There are serveral tools for network debugging like ping, traceroute, tcpdump and darkstat. Parameter Automatic software update Ping The ping utility can be used to verify whether a remote host can be reached via IP.
NBB-800 User Manual for NRSW version 4.5.0.100 Type Description SSH Authorization The keys used for SSH authorization. OpenVPN Server or client keys and certificates for running OpenVPN tunnels. IPsec Server or client keys and certificates for running IPsec tunnels. WLAN Keys and certificates for implementing certificate-based WLAN au- thentication (e.g.
Page 182
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Certificate Configuration Country (C) The certificate owner’s country (usually a TLD abbreviation) Common Name (CN) The certificate owner’s common name, mainly used to identify a host E-Mail The certificate owner’s email address Expiry period The number of days a certificate will be valid from now on Key size...
Page 183
NBB-800 User Manual for NRSW version 4.5.0.100 When enrolling certificates, the CA certificate will be initially fetched from the specified SCEP URL using the getca operation. It will be shown on the configuration page and it has to be verified that it belongs to the correct authority.
User Manual for NRSW version 4.5.0.100 5.8.9. Licensing Certain features of NetModule routers require a valid license to be present in the system, some of them also depend on the mounted modules. Please contact us for getting a valid license for available components and we will provide a license file based on your serial number which can be installed to...
5.8.10. Legal Notice OSS Notice 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), GNU Lesser General Public License (LGPL) or other open-source licenses.
NBB-800 User Manual for NRSW version 4.5.0.100 6. Command Line Interface The Command Line Interface (CLI) offers a generic control interface to the router and can be used to get/set configuration parameters, apply updates, restart services or perform other system tasks. It will be started automatically in interactive mode when logging in as admin user or by running cli -i.
NBB-800 User Manual for NRSW version 4.5.0.100 Key Sequence Action ALT-t Drag the word before point past the word after point, moving point over that word as well. If point is at the end of the line, this transposes the last two words on the line.
NBB-800 User Manual for NRSW version 4.5.0.100 validate config parameter get factory default rather than current value show configuration sections 6.4. Setting Config Parameters The set command can be used to set configuration values. > set Usage : set [ hv ] <parameter >=<value > [ < parameter >=<value > . . ] Options : validate config parameter 6.5.
NBB-800 User Manual for NRSW version 4.5.0.100 ipsec IPsec connection status pptp PPTP connection status GRE connection status dialin Dial In connection status mobileip MobileIP status Digital IO status audio Audio module status CAN module status uart UART module status ibis IBIS module status redundancy...
NBB-800 User Manual for NRSW version 4.5.0.100 Options : reboot after update force update t reset missing config values with factory defaults show update status Available update targets : software Perform software update firmware Perform module firmware update config Update configuration license Update licenses sshkeys...
NBB-800 User Manual for NRSW version 4.5.0.100 > reset Usage : reset [ h ] 6.14. Rebooting System The reboot command can be used to reboot the router. > reboot Usage : reboot [ h ] 6.15. Running Shell Commands The shell command can be used to execute a system shell and run any arbitrary application or script.
Page 194
NBB-800 User Manual for NRSW version 4.5.0.100 Available keys : output Output format ( html , plain ) Username to be used for authentication Password to be used for authentication command Command to be executed arg0 . . arg31 Arguments passed to commands Notes : The commands correspond to CLI commands as seen by cli -l...
Page 197
NBB-800 User Manual for NRSW version 4.5.0.100 Examples : http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php?version=2&output=html&usr=admin&pwd=admin01&command= send&arg0=sms&arg1=%2B123456789&arg2=test send - Send E-Mail Key usage : command=send&arg0=mail&arg1=<address>&arg2=<text > Notes : The address has to be a valid E Mail address such as abc@abc .
Page 198
NBB-800 User Manual for NRSW version 4.5.0.100 http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php?version=2&output=html&usr=admin&pwd=admin01&command= send&arg0=ussd&arg1=0&arg2=%2A100%23...
NBB-800 User Manual for NRSW version 4.5.0.100 A. Appendix A.1. Abbrevations Parameter Description ETHx Corresponds to Ethernet interfaces (either single or switched ones) LANx LAN interfaces which are generally based on Ethernet interfaces (in- cluding bridges) WLANx Refers to a Wireless LAN interface which will be represented as addi- tional LAN interface when configured as access point WWANx Refers to a Wireless Wide Area Network (2G/3G/4G) connection...
NBB-800 User Manual for NRSW version 4.5.0.100 Parameter Description Short Message Service SSID Service Set Identifiers, can be used to define multiple WLAN networks on a module Spanning Tree Protocol USSD Unstructured Supplementary Service Data VRRP Virtual Router Redundancy Protocol Virtual Private Network WAN links include all Wide Area Network interfaces which are cur- rently activated in the system...
Page 201
NBB-800 User Manual for NRSW version 4.5.0.100 Event Description dio-in2-on DIO IN2 turned on dio-in2-off DIO IN2 turned off dio-out1-on DIO OUT1 turned on dio-out1-off DIO OUT1 turned off dio-out2-on DIO OUT2 turned on dio-out2-off DIO OUT2 turned off gps-up GPS signal is available gps-down GPS signal is not available...
NBB-800 User Manual for NRSW version 4.5.0.100 Event Description sms-notsent SMS has not been sent sms-received SMS has been received sms-report-received SMS report has been received call-incoming A voice call is coming in call-outgoing Outgoing voice call is being established ddns-update- Dynamic DNS update succeeded succeeded...
NBB-800 User Manual for NRSW version 4.5.0.100 A.3. Factory Configuration The factory configuration including default values for any configuration parameter can be derived from the file /etc/config/factory-config.cfg on the router. You may also call cli get -f <parameter> for obtaining a specific default value.
Page 206
NBB-800 User Manual for NRSW version 4.5.0.100 MAX - ACCESS read - only STATUS current DESCRIPTION " The hash of the current software " ::= { admin 6 } systemStatus OBJECT - TYPE SYNTAX INTEGER { ok (1) , degraded (2) , outoforder (3) MAX - ACCESS read - only...
Page 207
NBB-800 User Manual for NRSW version 4.5.0.100 SYNTAX URLString MAX - ACCESS read - write STATUS current DESCRIPTION " Update the system configuration from the specified URL , the URL must be preceded by a valid prefix ( e . g . tftp :// , sftp :// , ftp :// , https :// or http ://) and either point to the update package or to a server directory which contains a file named <...
Page 208
NBB-800 User Manual for NRSW version 4.5.0.100 altConfigDesc OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " The description of the alternative configuration " ::= { admin 30 } altConfigHash OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only...
Page 209
NBB-800 User Manual for NRSW version 4.5.0.100 STATUS current DESCRIPTION " The status of the last config upload cycle " ::= { admin 43 } -- Further System Paramters -- sy st em T em p er a t ur e OBJECT - TYPE SYNTAX FloatSyntax UNITS...
Page 210
NBB-800 User Manual for NRSW version 4.5.0.100 ::= { nbWwanEntry 4 } w w a n R e g i s t r a t i o n S t a t e OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current...
Page 211
NBB-800 User Manual for NRSW version 4.5.0.100 DESCRIPTION " The current Received Signal Code Power ( UMTS ) of the WWAN modem " ::= { nbWwanEntry 16 } wwanECIO OBJECT - TYPE SYNTAX DisplayString UNITS " dB " MAX - ACCESS read - only STATUS current...
Page 212
NBB-800 User Manual for NRSW version 4.5.0.100 STATUS current DESCRIPTION " The current longitude value received by the GNSS device " ::= { nbGnssEntry 5 } gnssAlt OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION "...
Page 213
NBB-800 User Manual for NRSW version 4.5.0.100 MAX - ACCESS read - only STATUS current DESCRIPTION " WLAN module name " ::= { nbWlanEntry 2 } wlanMod uleType OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION "...
Page 214
NBB-800 User Manual for NRSW version 4.5.0.100 wlanSta tionMac OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " The MAC address of a connected station " ::= { n b Wl a n St a ti o nE n t ry 3 } w l a n S t a t i o n S i g n a l S t r e n g t h OBJECT - TYPE SYNTAX Integer32...
Page 215
NBB-800 User Manual for NRSW version 4.5.0.100 wa nD at a Do wnl oa de d Counter64 , wanData Up load ed Counter64 , wanDown lo adRa te Integer32 , wanUploadRate Integer32 , w a n D a t a D o w n l o a d e d R o a m i n g Counter64 , w a n D a t a U p l o a d e d R o a m i n g Counter64 wanLinkIndex OBJECT - TYPE SYNTAX...
Page 216
NBB-800 User Manual for NRSW version 4.5.0.100 w anDialFai lu res OBJECT - TYPE SYNTAX Integer32 MAX - ACCESS read - only STATUS current DESCRIPTION " WAN link dial failures " ::= { nbWanEntry 12 } wa nD at a Do w nl o a de d OBJECT - TYPE SYNTAX Counter64 UNITS...
Page 217
NBB-800 User Manual for NRSW version 4.5.0.100 on (1) MAX - ACCESS read - only STATUS current DESCRIPTION " The current value of digital I / O port OUT1 " ::= { dio 3 } dioStatusOut2 OBJECT - TYPE SYNTAX INTEGER { off (0) , on (1)
Page 218
NBB-800 User Manual for NRSW version 4.5.0.100 STATUS current DESCRIPTION " The current state of the serial port " ::= { nbSerialEntry 3 } serialRxBytes OBJECT - TYPE SYNTAX Integer32 MAX - ACCESS read - only STATUS current DESCRIPTION " The number of bytes received on the serial port " ::= { nbSerialEntry 4 } serialTxBytes OBJECT - TYPE SYNTAX...
Page 219
NBB-800 User Manual for NRSW version 4.5.0.100 " trap history index " ::= { n b Tr a p Hi s to r yE n t ry 1 } t r a p H i s t o r y T i m e s t a m p OBJECT - TYPE SYNTAX Counter64 UNITS...
Page 220
NBB-800 User Manual for NRSW version 4.5.0.100 gps - down NOTIFICATION - TYPE STATUS current DESCRIPTION " GPS signal is not available " ::= { events 302 } openvpn - up NOTIFICATION - TYPE STATUS current DESCRIPTION " OpenVPN connection came up " ::= { events 401 } openvpn - down NOTIFICATION - TYPE STATUS current...
Page 221
NBB-800 User Manual for NRSW version 4.5.0.100 system - startup NOTIFICATION - TYPE STATUS current DESCRIPTION " System has been started " ::= { events 505 } test NOTIFICATION - TYPE STATUS current DESCRIPTION " test event " ::= { events 506 } sdk - startup NOTIFICATION - TYPE STATUS current DESCRIPTION...
Page 222
NBB-800 User Manual for NRSW version 4.5.0.100 usb - serial - added NOTIFICATION - TYPE STATUS current DESCRIPTION " USB serial device has been added " ::= { events 905 } usb - serial - removed NOTIFICATION - TYPE STATUS current DESCRIPTION "...
NBB-800 User Manual for NRSW version 4.5.0.100 A.5. SDK Examples Event Description best-operator.are This script will scan for operators on startup and choose the one with the best signal candump.are This script can be used to receive CAN messages config-summary.are This script shows a summary of the currently running configuration.
Page 224
NBB-800 User Manual for NRSW version 4.5.0.100 Event Description remote-mail.are This script reads and sends mails from a remote IMAP/POP3/SMTP server scan-mobile.are This script can be used to switch the Mobile LAI according to available networks scan-wlan.are This script can be used to switch the WLAN client network according to availability send-mail.are This script will send an E-Mail to the specified address.
NBB-800 User Manual for NRSW version 4.5.0.100 Event Description transfer.are This scripts stores the latest GNSS positions in a remote FTP file transfer-file.are This scripts archives a remote file udpclient.are This script sends a message to a remote UDP server. udp-msg-server.are This script will run an UDP server which is able to receive messages and forward them as SMS/E-Mail.
Need help?
Do you have a question about the NB800 Series and is the answer not in the manual?
Questions and answers