1. Welcome to NetModule Thank you for purchasing a NetModule Router. This document should give you an introduction to the router and its features. The following chapters describe any aspects of commissioning the device, installation procedure and provide helpful information towards configuration and maintenance.
This chapter provides general information for putting the router into operation. 2.1. Safety Instructions 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.
Council Directive 1999/5/EC. The signed version of the Declara- tions of Conformity can be found on the NetModule web page. 2.3. Waste Disposal In accordance with the requirements of the Council Directive...
NB3710 User Manual 3.8 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 Lesser General Public License (LGPL)
3. Specifications 3.1. Features There are several different models of NB3710 available: Model WLAN Audio NB3710-LWA NB3710-LWC NB3710-2LW NB3710-2L2W NB3710-4L2W Table 3.1.: NB3710 Models Note: All LTE models include support for UMTS/EDGE/GPRS. LTE models can be equipped with a supplementary VOICE (-V) or GNSS (-G) option.
Page 13
NB3710 User Manual 3.8 yellow means moderate green means good or excellent Label Color State Function Status blinking The device is busy due to startup, software or configu- ration update. The device is ready. The captions of the top bank apply. The device is ready.
NB3710 User Manual 3.8 Label Color State Function Normally closed output port 2 is closed. off Normally closed output port 2 is open. Input port 1 is set. off Input port 1 is not set. Input port 2 is set. off...
NB3710 User Manual 3.8 3.3. Interfaces 3.3.1. Overview Label Panel Function SIM 1 Front SIM 1, it can be assigned dynamically to any modem by configuration. SIM 2 Front SIM 2, it can be assigned dynamically to any modem by configuration.
NB3710 User Manual 3.8 3.3.2. 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 Table 3.4.: USB 2.0 Host Port Specification 3.3.3. M12 Ethernet Connectors Specification The five Ethernet ports have the following specification: Feature...
NB3710 User Manual 3.8 Feature Specification Power supply nominal voltages 24 V , 36 V and 48 V according to EN 50155 Voltage range 12 V to 60 V ( 15% / +5%) Max. power consumption 15 W DC isolation Power Interruption Class S2 Sustains interruptions up to 10 ms, there are no batteries included...
NB3710 User Manual 3.8 Isolated Inputs The isolated digital input ports have the following specification: Feature Specification Number of inputs maximum input voltage 40 V Minimum voltage for level 1 (set) 7.2 V Maximum voltage for level 0 (not set) 5.0 V Table 3.10.: Isolated Digital Inputs Specification Note: A negative input voltage is not recognized.
NB3710 User Manual 3.8 Feature Specification Input galvanic isolation functional (max. 250 V Output impedance 100 Ω, signal level 2 V Output bandwidth 300 Hz - 4 kHz Output galvanic isolation 1500 V Table 3.13.: Audio Port Specification The CAN port has the following specification: Feature Specification Protocol...
NB3710 User Manual 3.8 Feature Specification Data bits 7 bit, 8 bit Parity none, odd, even Stop bits 1, 2 Software flow control None, XON/XOFF Hardware flow control None Galvanic isolation 1500 V Internal bus termination none Table 3.18.: RS-485 Port Specification...
4. Installation 4.1. Environmental Conditions The following precautions must be taken before installing a NB3710 router: • Avoid direct solar radiation • Protect the device from humidity, steam and aggressive fluids • Guarantee sufficient circulation of air around the device •...
NB3710 User Manual 3.8 provider upon a certain condition. However, a SIM switch usually takes about 10-20 seconds which can be bypassed (e.g. at bootup) if SIMs are installed reasonably. Using only a single SIM with one modem, it should be preferably placed into the SIM 1 holder. For systems which should operate two modems with two SIMs in parallel, we recommend to assign Mobile 1...
3.8. 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.
NB3710 User Manual 3.8 5.1.1. Initial Access In factory state you will be prompted for a new administrator password. Please choose a password which is both, easy to remember but also robust against dictionary attacks (such as one that contains numbers, letters and punctuation characters). The password shall have a minimum length of 6 characters.
NB3710 User Manual 3.8 5.1.2. Recovery Following actions might be taken in case the router has been misconfigured and cannot be reached anymore: 1. Factory Reset: You can initiate a reset back to factory settings via the Web Man- ager, by running the command factory-reset or by pressing the reset button. The latter would require a slim needle or paper clip which must be inserted into the hole to the left of the LEDs .
NB3710 User Manual 3.8 5.2. HOME This page provides a status overview of enabled features and connections. Figure 5.2.: Home Summary This page offers a short summary about the administrative and operational status of the router’s interfaces. This page offers details about any enabled Wide Area Network (WAN) links (such as the IP addresses, network information, signal strength, etc.) The information about the amount of downloaded/uploaded data is stored in non-volatile memory, thus survive a reboot of the system.
Page 29
NB3710 User Manual 3.8 WLAN The WLAN page offers details about the enabled WLAN interfaces when operating in access-point mode. This includes the SSID, IP and MAC address and the currently used frequency and transmit 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.
Page 30
NB3710 User Manual 3.8 DynDNS This page provides information about Dynamic DNS. System Status The system status page displays various details of your NB3710 router, including system details, information about mounted modules and software release information. This section will list all webpages generated by SDK scripts.
NB3710 User Manual 3.8 5.3. INTERFACES 5.3.1. WAN Link Management Depending on your hardware model, WAN links can be made up of either Wireless Wide Area Network (WWAN), Wireless LAN (WLAN), Ethernet or PPP over Ethernet (PPPoE) connections. Please note that each WAN link has to be configured and enabled in order to appear on this page.
Page 32
NB3710 User Manual 3.8 In general, a link will be only dialed or declared as up if the following prerequisites are met: Condition WWAN WLAN ETH PPPoE Modem is registered Registered with valid service type X Valid SIM state Sufficient signal strength Client is associated Client is authenticated Valid DHCP address retrieved...
Page 33
NB3710 User Manual 3.8 We recommend to use the permanent operation mode for WAN links in general. How- ever, in case of time-limited mobile tariffs for instance, the switchover mode might be applicable. By using the distributed mode, it is possible to distribute outgoing traffic over multiple WAN links based on their weight ratio.
NB3710 User Manual 3.8 WAN Settings This page can be used to configure WAN specific settings like the Maximum Segment Size (MSS). The MSS corresponds to the largest amount of data (in bytes) that the router can handle in a single, unfragmented TCP segment. In order to avoid any negative side effects the number of bytes in the data segment and the headers must not add up to more than the number of bytes in the Maximum Transmission Unit (MTU).
NB3710 User Manual 3.8 Supervision Network outage detection on a per-link basis can be performed by sending pings on each link to some authoritative hosts. A link will be declared as down in case all trials have failed and only as up if at least one host can be reached. Figure 5.5.: Link Supervision Parameter Supervision Settings...
Page 36
NB3710 User Manual 3.8 Parameter Supervision Settings Ping interval The interval in seconds at which pings are transmitted on each interface Retry interval The interval in seconds at which pings are re-transmitted in case a first ping failed Max. number of failed The maximum number of failed ping trials until the link will trials be declared as down...
NB3710 User Manual 3.8 5.3.2. Ethernet NB3710 routers ship with an Ethernet switch (ETH1-ETH5) which can be linked via M12 connectors. ETH1 usually forms the LAN1 interface which should be used for LAN purposes. Other interfaces can be used to connect other LAN segments or for configuring a WAN link. The LAN10 interface will be available as soon as a pre-configured USB Ethernet device has been plugged in.
NB3710 User Manual 3.8 Ethernet Link Settings Figure 5.7.: Ethernet Link Settings Link negotiation can be set for each Ethernet port individually. Most devices support auto-negotiation which will configure the link speed automatically to comply with other devices in the network. In case of negotiation problems, you may assign the modes manually but it has to be ensured that all devices in the network utilize the same settings then.
NB3710 User Manual 3.8 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 virtual interface.
Page 40
NB3710 User Manual 3.8 Parameter VLAN Priority Levels Excellent Effort Critical Applications Video (< 100 ms latency and jitter) Voice (< 10 ms latency and jitter) Internetwork Control Network Control...
NB3710 User Manual 3.8 IP Settings This page can be used to configure IP addressing for your LAN/WAN Ethernet inter- faces. In addition to the primary IP address/subnet mask you may define an additional IP address alias on the interface. Please keep in mind that the DNS servers can be set globally in the DNS server config- uration menu.
Page 42
NB3710 User Manual 3.8 Parameter LAN IP Settings IP address The IP interface address Subnet mask The subnet mask for this interface Alias IP address The alias IP interface address 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...
NB3710 User Manual 3.8 5.3.3. Mobile SIMs Figure 5.10.: SIMs The SIM page gives an overview about the available SIM cards, their assigned modems and the current state. Once a SIM card has been inserted, assigned to a modem and successfully unlocked, the card should remain in state ready and the network registration status should have turned to registered.
Page 44
NB3710 User Manual 3.8 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 45
NB3710 User Manual 3.8 mentary Service Data (USSD) requests, e.g. for querying the available balance of a prepaid account.
NB3710 User Manual 3.8 WWAN Interfaces This page can be used to manage your WWAN interfaces. The resulting link will pop up automatically as WAN link once an interface has been added. Please refer to chap- 5.3.1 for how to manage them. The Mobile LED will be blinking during the connection establishment process and goes on as soon as the connection is up.
Page 47
NB3710 User Manual 3.8 link is being dialed. 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...
NB3710 User Manual 3.8 5.3.4. WLAN WLAN Management In case your router is shipping with a WLAN (or Wi-Fi) module you can operate it either as client or access point. As a client it can create an additional WAN link which for instance can be used as backup link.
NB3710 User Manual 3.8 Running as access point, you can further configure the following settings: Parameter WLAN 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 Available operation modes are:...
NB3710 User Manual 3.8 WLAN Configuration Running in client mode, it is possible to connect to one ore more remote access-points. The system will switch to the next network in the list in case one goes down and return to the highest-prioritized network as soon as it comes back. You can perform a WLAN network scan and pick the settings from the discovered information directly.
Page 51
NB3710 User Manual 3.8 This section can be used to configure security-related settings. Parameter WLAN Configuration SSID The network name (called SSID) Security mode The desired security mode. WPA-PSK provides password- based authentication, WPA-RADIUS can be used to au- thenticate against a remote RADIUS server which can be configured in chapter 5.8.2 and WPA-EAP-TLS performs...
NB3710 User Manual 3.8 WLAN IP Settings This section lets you configure the TCP/IP settings of your WLAN network. A client interface can be run over DHCP or with a statically configured address and default gateway. Figure 5.14.: WLAN IP Configuration The access point networks can be bridged to any LAN interface for letting WLAN clients and Ethernet hosts operate in the same subnet.
Page 53
NB3710 User Manual 3.8 Parameter WLAN IP Settings IP address / netmask In routing-mode, the IP address and netmask for this WLAN network...
NB3710 User Manual 3.8 5.3.5. 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.
NB3710 User Manual 3.8 If the USB/IP device server has been enabled you can discover the mounted USB devices and attach them to the USB/IP server. Enabled devices can now be exported to a remote host. You will need an additional driver on the client for which we provide Windows or Linux drivers.
Page 56
NB3710 User Manual 3.8 Parameter USB Devices Module The USB module and type of driver to be applied for this device Any ID must be specified in hexadecimal notation, wildcards are supported (e.g. AB[0-1][2-3] or AB*) A USB network device will be referenced as LAN10. 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.
NB3710 User Manual 3.8 5.3.6. Serial Port This page can be used to manage your serial ports. A serial port can be used by: Parameter Serial Port Usage none The serial port is not used login console The serial port is used to open a console which can be ac- cessed with a serial terminal client from the other side.
NB3710 User Manual 3.8 Running a device server, the following settings can be applied: Figure 5.18.: Serial Port Settings Parameter Serial Settings Physical protocol Selects the desired physical protocol on the serial port Baud rate Specifies the baud rate run on the serial port Data bits Specifies the number of data bits contained in each frame Parity...
Page 59
NB3710 User Manual 3.8 Parameter Serial Settings 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 Protocol on TCP/IP You may choose the IP protocols Telnet or TCP raw for the device server Port The TCP port for the device server...
NB3710 User Manual 3.8 5.3.7. Digital I/O The Digital I/O page displays the current status of the I/O ports and can be used to turn output ports on or off. Figure 5.19.: Digital I/O Ports You can apply the following settings: Parameter Digital I/O Settings DO1 after reboot...
NB3710 User Manual 3.8 5.3.8. GNSS Administration The GNSS page lets you enable or disable the GNSS modules present in the system and can be used to configure the daemon that can be used to share access to receivers without contention or loss of data and to respond to queries with a format that is substantially easier to parse than the NMEA 0183 emitted directly by the GNSS device.
Page 62
NB3710 User Manual 3.8 Position This pages provides further information about the satellites in view and values derived from them: Parameter GNSS Information Latitude The geographic coordinate specifying the north-south posi- tion Longitude The geographic coordinate specifying the east-west position Altitude The height above sea level of the current location Satellites in view...
Page 63
NB3710 User Manual 3.8 Parameter GNNS Supervision Emergency action The corresponding emergency action. You can either let just restart the server which also re-initializes GPS on the module or also reset the module in severe cases. Please note that this might also have effect any running WWAN/SMS services.
NB3710 User Manual 3.8 5.4. ROUTING 5.4.1. Static Routes This menu shows all routing entries of the system. They are typically formed by an address/netmask couple (represented in IPv4 dotted decimal notation) which specify the destination of a packet. The packets can be directed to either a gateway or an interface or both.
NB3710 User Manual 3.8 Parameter Static Route Configuration Netmask The subnet mask which forms, in combination with the des- tination, 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. Gateway The next hop which operates as gateway for this network (can be omitted on peer-to-peer links)
NB3710 User Manual 3.8 5.4.2. Extended Routing Extended routes can be used to perform policy-based routing, they generally precede static routes. Figure 5.21.: Extended Routing In contrast to statis routes, extended routes can be made up, not only of a destination address/netmask, but also a source address/netmask, incoming interface and the type of service (TOS) of packets.
Page 67
NB3710 User Manual 3.8 Parameter Extended Route Configuration Type of service The TOS value within the header of the packet Route to Specifies the target interface or gateway to where the packet should get routed to...
NB3710 User Manual 3.8 5.4.3. Multipath Routes Multipath routes will perform weighted IP-session distribution for particular subnets across multiple interfaces. Figure 5.22.: Multipath Routes At least two interfaces have to be defined to establish multipath routing. Additional interfaces can be added by pressing the plus sign. Parameter Add Multipath Routes Target...
Effectively, any WAN link switch causes very small outages during switchover while keeping all IP connections alive. Moreover, NetModule routers also support NAT-Traversal for mobile nodes running behind a firewall (performing NAT), which makes mobile nodes even there accessible from a central office via their home address, and thus, bypassing any complicated VPN...
Page 70
NB3710 User Manual 3.8 If MIP is run as a mobile node, the following settings can be configured: Parameter Mobile IP Configuration Primary home agent ad- The address of the primary home agent dress Secondary home agent The address of the secondary home agent. The mobile node address will try to register with this home agent, if the primary home agent is not reachable.
NB3710 User Manual 3.8 If MIP is run as a home agent, you will have to set up a home address and network mask for the home agent first. Then you will need to add the configuration for all mobile nodes which is made up of the following settings: Figure 5.23.: Mobile IP Parameter...
NB3710 User Manual 3.8 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 com- bination with Hierarchy Token Bucket (HTB) qdiscs.
Page 73
NB3710 User Manual 3.8 Parameter QoS Default Queues A low priority queue which may hold less-critical services for which shaping is intended Each queue can be configured as follows: Parameter QoS Queue Parameters Name The name of the QoS queue Priority A numerical priority for the queue, lower values indicate higher priorities...
NB3710 User Manual 3.8 5.4.6. Multicast NetModule routers ship with an IGMP proxy which is able to maintain multicast groups on a particular interface and distribute incoming multicast packets towards the down- stream interfaces on which hosts have joined the groups.
NB3710 User Manual 3.8 5.5. FIREWALL 5.5.1. Administration NetModule routers use Linux’s netfilter/iptables firewall framework (see http://www. for more information) which supports stateful inspection, that is, grant- netfilter.org ing the same permissions for inherited connections within an IP session (e.g. FTP which builds up a control and data connection).
NB3710 User Manual 3.8 5.5.3. Rules In general, the firewall is set up of a range of rules which control each packet’s permis- sion to pass the router. Please note that the rules are processed by order, that means traversing the list from top to bottom until a matching rule is found. Packets which are not matching any of the rules configured will be ALLOWED.
Page 77
NB3710 User Manual 3.8 Parameter Firewall Rule Configuration Destination The destination address of matching packets, can be any, local (addressed to the system itself) or specified by ad- dress/network Incoming interface The interface on which matching packets are received Protocol The used IP protocol of matching packets (UDP, TCP or ICMP) Destination port(s)
NB3710 User Manual 3.8 5.5.4. NAPT This page can be used to configure Network Address and Port Translation (NAPT) for packets traversing the system. NAPT hereby modifies IP addresses or/and TCP/UDP ports in matching IP packets. By tracking those connections, it will also automatically adjust the returning packets of an IP session.
NB3710 User Manual 3.8 Figure 5.27.: Inbound NAPT...
Page 80
NB3710 User Manual 3.8 Please note that the specified rules are processed by order, that means, traversing the list from top to bottom until a matching rule is found. If there is no matching rule found, the packet will pass as is. Parameter Inbound NAPT Rules Description...
Figure 5.28.: OpenVPN Administration 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...
NB3710 User Manual 3.8 Figure 5.29.: OpenVPN Configuration...
Page 83
NB3710 User Manual 3.8 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 failures, either be selected sequently (i.e.
Page 84
NB3710 User Manual 3.8 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 tunnel.
NB3710 User Manual 3.8 Parameter Server Expert Files 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 system has to be set prior to creating certificates and establishing a tunnel connection.
Page 86
NB3710 User Manual 3.8 Please note that, if you intend to use a fixed address for a particular client, you would have to apply fixed addresses to the other ones as well. You may specify the network behind the clients as well as the routes to be pushed to each client.
NB3710 User Manual 3.8 5.6.2. IPsec IPsec is a protocol suite for securing IP communications by authenticating and encrypt- ing 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.
NB3710 User Manual 3.8 Administration This page can be used to enable/disable IPsec, you may also specify whether NAT- Traversal should be used. NAT-Traversal is mainly used for connections which traverse a path where a router modifies the IP address/port of packets. It encapsulates packets in UDP and therefore requires a slight overhead which has to be taken into account when running over small- sized MTU interfaces.
Page 90
IKE Authentication NetModule routers support IKE authentication through pre-shared keys (PSK) or certifi- cates 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 91
NB3710 User Manual 3.8 Parameter IPsec XAUTH Settings User name The name of the XAUTH user User password The password of the XAUTH user Group name The group ID Group password The group secret IKE Proposal This section can be used to configure the phase 1 settings: Parameter IPsec IKE Proposal Settings Negotiation mode...
Page 92
NB3710 User Manual 3.8 Parameter IPsec Proposal Settings Authentication algo- The desired IKE authentication method (we prefer SHA1 rithm over MD5) SA life time The lifetime of Security Associations Networks When creating Security Associations, IPsec will keep track of routed networks within the tunnel.
NB3710 User Manual 3.8 5.6.3. PPTP The Point-to-Point Tunneling Protocol (PPTP) is a method for implementing virtual private networks between two hosts. PPTP is easy to configure and widely deployed amongst Microsoft Dial-up networking servers. However, due to its weak encryption algorithms, it is nowadays considered insecure but it still provides a straightforward way for establishing tunnels.
NB3710 User Manual 3.8 Parameter PPTP Server Settings Listen address Specifies on which IP address should be listened for incom- ing client connections Server address The server address within the tunnel Client address range Specifies a range of IP addresses assigned to each client PPTP Client Management PPTP clients for a server tunnel need to be configured here.
NB3710 User Manual 3.8 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. It does not provide encryption nor authorization but can be used on an address-basis on top of other VPN techniques (such as IPsec) for tunneling purposes.
NB3710 User Manual 3.8 5.6.5. 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. Naturally, a concurrent use of outgoing WWAN interfaces and Dial-In connection is not possible.
Page 98
NB3710 User Manual 3.8 which shall be allowed to dial-in. Please note that Dial-In connections are generally discouraged. As they are implemented as GSM voice calls, they suffer from unreliability and poor bandwidth.
NB3710 User Manual 3.8 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...
Page 100
A set of example scripts can be downloaded directly from the router, you can find a list of them in the appendix. The manual which can be obtained from the NetModule support web page gives a detailed introduction of the language, including a description of all available functions.
Page 101
NB3710 User Manual 3.8 16. Create your own web pages 17. Voice control functions 18. SNMP functions 19. CAN socket functions 20. Various network-related functions 21. Other system-related functions The SDK API manual (which can be downloaded from the router) provides an overview but also explains all functions in detail.
Page 102
NB3710 User Manual 3.8 wanlink.0.mode wanlink.0.name wanlink.0.prio wanlink.0.weight Running the CLI in interactive mode, you will be also able to step through possible configuration parameters by the help of the TAB key.
Page 103
NB3710 User Manual 3.8 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 , "...
NB3710 User Manual 3.8 Figure 5.37.: SDK Administration...
Page 105
NB3710 User Manual 3.8 Administration This page can be used to control the SDK host and apply the following settings: Parameter SDK Administration Settings Parameter Description Administrative status Specifies whether SDK scripts should run or not Scheduling priority Specifies the process priority of the sdkhost, higher priorities will speed up scheduling your scripts, lower ones will have less impact to the host system Maximum flash usage...
Page 107
NB3710 User Manual 3.8 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...
Page 108
NB3710 User Manual 3.8 /* arguments : schnick schnack " s c h n u c k " for ( i = 0; i < argc ; i ++) { printf (" argv % d : % s \ n " , i , argv [ i ]) ; /* generates : argv0 : scriptname argv1 : schnick...
NB3710 User Manual 3.8 Command Action disconnect Will disable the first WAN link configured on the system reboot Initiates a reboot of the system output 1 on Turns on the first digital output port output 1 off Turns off the first digital output port output 2 on Turns on the second digital output port output 2 off...
NB3710 User Manual 3.8 5.7.2. DHCP Server This section can be used to individually configure the Dynamic Host Configuration Protocol (DHCP) service for each LAN interface which will serve dynamic IP addresses to hosts in the local network. You may also have a look to the status page where you can find an overview about negotiated client addresses.
NB3710 User Manual 3.8 5.7.3. DNS Server The DNS server can be used to proxy DNS requests towards servers on the net which have for instance been negotiated during WAN link negotiation. By pointing DNS requests to the router, one can reduce outbound DNS traffic as it is caching already resolved names but it can be also used for serving fixed addresses for particular host names.
Page 113
NB3710 User Manual 3.8 names. Please remember to point local hosts to the router’s address for resolving them.
NB3710 User Manual 3.8 5.7.4. NTP Server This section can be used to individually configure the Network Time Protocol (NTP) server function. Figure 5.41.: NTP Server The following settings for each interface can be applied then: Parameter NTP Server Settings Administrative status Specifies whether the NTP server is enabled or not Poll interval...
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 116
NB3710 User Manual 3.8 Parameter DynDNS Settings Provider You can choose one of the listed providers or provide a cus- tom 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. my- box.dyndns.org) Port The HTTP port of the service (typically 80)
NB3710 User Manual 3.8 5.7.6. E-Mail The E-Mail client can be used to send notifications to a particular E-Mail address upon certain events or by SDK scripts. Figure 5.43.: E-Mail Settings It can be enabled by applying the following settings. Parameter E-Mail Client Settings E-mail client status...
NB3710 User Manual 3.8 5.7.7. Events By using the event manager you can notify one or more recipients by SMS or E-Mail upon certain system events. The messages will contain a description provided by you and a short system info. A list of all system events can be found in the appendix A.2.
5.7.8. SMS Administration On NetModule routers it is possible to receive or send short messages (SMS) over each mounted modem (depending on the assembly options). Messages are received by query- ing the SIM card over a modem, so prior to that, the required assignment of a SIM card to a modem needs to be specified on the SIMs page.
NB3710 User Manual 3.8 Figure 5.44.: SMS Configuration...
Page 121
NB3710 User Manual 3.8 prefix. On the other hand, you can also define rules to drop outgoing messages, for instance, when you want to avoid using any expensive service or international numbers. Both types of rules form a list will be processed by order, forwarding outgoing messages over the specified modem or dropping them.
NB3710 User Manual 3.8 5.7.9. SSH/Telnet Server Apart from the Web Manager, the SSH and Telnet services can be used to log into the system. Valid users include root and admin as well as additional users as they can be created in the User Accounts section.
Page 123
NB3710 User Manual 3.8 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 password-based By turning on this option, all users will have to authenticate login by SSH keys which can be uploaded to the router.
NB3710 User Manual 3.8 SNMP Configuration Figure 5.46.: SNMP Agent The following parameters can be used to configure the SNMP agent: Parameter SNMP Configuration Administrative status Enable or disable the SNMP agent Operation mode Specifies if agent should run in compatibilty mode or for SNMPv3 only Contact System maintainer or other contact information...
Page 126
NB3710 User Manual 3.8 SNMP Authentication When running in SNMPv3, it is possible to configure the following authentication set- tings: 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 127
NB3710 User Manual 3.8 Typical SNMP Commands Setting MIB values and triggering extensions is generally limited to the SNMPv3 admin user. It is possible to specify an administrative host for SNMP v1/2c. The SNMP extensions can be read and triggered as follows: Getting the software version of the system: snmpget -v 3 -u admin -n ""...
Page 128
NB3710 User Manual 3.8 The return value can be one of: succeeded (1), failed (2), inprogress (3), notstarted (4). Setting digital OUT1: 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.53.10.0 i 0 snmpset -v 3 -u admin -n ""...
NB3710 User Manual 3.8 5.7.11. Web Server This page can be used to configure different ports for accessing the Web Manager via HTTP/HTTPS. We strongly recommend to use HTTPS when accessing the web service via a WAN interface as the communication will be encrypted and thus avoids any misuse of the system.
NB3710 User Manual 3.8 5.7.12. 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 address which will be distributed by gratuitous...
Page 131
NB3710 User Manual 3.8 Parameter Redundancy Configuration Administrative status Administrative status 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.
NB3710 User Manual 3.8 5.7.13. Voice Gateway Depending on your hardware, you can set up a voice gateway on the router which can be used to connect mobile calls to VoIP clients and vice versa. Administration Figure 5.49.: Voice Gateway Administration The following parameters can be used to set it up: Parameter Voice Gateway Administration Settings...
Page 133
NB3710 User Manual 3.8 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 user name Specifies the username used in from headers SIP register expires Specifies the registration interval in seconds In case you are running multiple WWAN interfaces sharing the same SIM, please bear...
NB3710 User Manual 3.8 Voice Endpoints Figure 5.50.: Voice Gateway Endpoint Configuration On this page you can activate the endpoints used for voice communication, the following types are supported: Parameter Voice Gateway Endpoint Types Voice-Over-Mobile Endpoint for GSM/UMTS/LTE calls (can be used for calls to mobile or landline phones) SIP (registrar) SIP endpoint which can be a client registered to our registrar...
Page 135
NB3710 User Manual 3.8 Based on your equipment, we recommend to adjust the modem’s audio profile for a better sound experience. The following profiles are available: Parameter Voice-Over-Mobile Audio Profiles Handset Provides a mild echo, short delay (less than 16-ms disper- sion).
Page 136
NB3710 User Manual 3.8 Parameter Endpoint Settings Voice-Over-Mobile Modem Specifies the modem which will be used for voice-over-mobile calls Audio profile Specifies the modem’s audio profile Volume level Specifies the modem’s volume level - 1 = low Parameter Endpoint Settings SIP (registrar) Subscriber The subscriber name for a registering SIP client Username...
NB3710 User Manual 3.8 Voice Routing This page can be used to configure generic voice routing between the endpoints. Figure 5.51.: Voice Gateway Routing Configuration 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.
Page 138
NB3710 User Manual 3.8 Parameter Voice Gateway Routing Settings Destination Specfies the target endpoint (i.e. where to call is routed to) 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.
NB3710 User Manual 3.8 5.8. SYSTEM 5.8.1. System System Settings Figure 5.52.: System The following system parameters can be set: Parameter System Settings Local hostname The hostname of the system Application area The desired application area which influences the system behaviour such as registration timeouts or other adaptions when operating in mobile enviroments.
Page 140
(e.g. automatically switching from summer to winter time) 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 GPS. If enabled, the time synchronization is usually triggered after a WAN link has come up but before starting any VPN connections.
Page 141
NB3710 User Manual 3.8 Parameter Time & Region NTP server 2 Optionally, the address of a second NTP server Sync time from GPS Derive time from first GPS device (if enabled) Reboot This page can be used to set up a periodic automatic reboot but also to trigger a manual reboot which will be issued immediately.
NB3710 User Manual 3.8 5.8.2. Authentication This page can be used to define the access model for all management interfaces (e.g. GUI, SSH/telnet server). Parameter Authentication Methods Authentication required Users can login via HTTP/telnet if authentication succeeds Secure authentication Users can only login via HTTPS/ssh required Secure authentication...
Page 144
NB3710 User Manual 3.8 Manager and other administrative services and is used by several services as default user. Keep in mind that the admin password will be also applied to the root user which is able to enter a system shell. Any other user represents a user with lower privileges, for instance it has only permission to view the status page or retrieve status values when using the CLI.
NB3710 User Manual 3.8 Figure 5.55.: Remote Authentication...
Page 146
NB3710 User Manual 3.8 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 downloaded from.
Page 147
A firmware package (ZIP) usually consists of a flash utility and a firmware file. Please follow http://www.netmodule.com/support/supportform.aspxin order to get the latest version. 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.
NB3710 User Manual 3.8 5.8.6. Configuration Configuration via the Web Manager becomes tedious for larger volumes of devices. The router therefore offers automatic and manual file-based configuration to automate things. Once you have successfully set up the system you can back up the configuration and restore the system with it afterwards.
NB3710 User Manual 3.8 Automatic File Configuration This menu can be used to run an automatic configuration update of the system. It is configured as follows: Parameter Automatic File Configuration Status Enable/disable an automatic configuration update Time of day Time of day when the system should check for updates The URL where the configuration file should be retrieved from (supported protocols are HTTP, HTTPS, TFTP, FTP) Factory Configuration...
Page 151
NB3710 User Manual 3.8 Ethernet interface back to 192.168.1.1. You will be able to communicate again with the device using the default network parameters. You may store the currently running configuration as factory defaults which will reside active even when a factory reset has been initiated (e.g.
NB3710 User Manual 3.8 5.8.7. Troubleshooting Network Debugging Log Files You can view the system log here by selection the option Debug log or if you are interested in the boot log select Boot log. Another way to see what is going on on the box is opening a SSH or Telnet session as root and typing tail-log.
NB3710 User Manual 3.8 analysis of potential configuration issues. Figure 5.60.: Tech Support File It is possible to trace any IP interface and inspect individual packet flows between hosts. This can be achieved by logging onto the box and start a network packet capture by using the tool tcdump.
NB3710 User Manual 3.8 5.8.8. Keys and Certificates The key and certificate page lets you generate required files for securing your services (such as HTTP and SSH server) but also to implement authentication and encryption for certificate-based VPN tunnels and WLAN clients. Figure 5.61.: Keys and certificates The entry pages shows an overview about installed keys and certificates.
NB3710 User Manual 3.8 Type Description OpenVPN Server or client keys and certificates for running OpenVPN tunnels. IPsec Server or client keys and certificates for running IPsec tun- nels. WLAN Keys and certificates for implementing certificate-based WLAN authentication (e.g. WPA-EAP-TLS). Authorities Other certificate authorities which we trust when establish- ing SSL client connections.
NB3710 User Manual 3.8 Configuration Figure 5.62.: Certificate Configuration This page provides some general configuration options which will be applied when op- erating on keys and certificates. If keys, certificates and signing requests are generated locally, the following settings will be take into account: Parameter Certificate Configuration...
Page 157
NB3710 User Manual 3.8 Parameter Certificate Configuration Common Name (CN) The certificate owner’s common name, mainly used to iden- tify 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 The length of the private key in bit Passphrase...
Page 158
NB3710 User Manual 3.8 Parameter SCEP Configuration Request timeout The max. polling time in seconds for a certificate request 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.
NB3710 User Manual 3.8 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 the router afterwards.
Page 160
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.
Page 161
NB3710 User Manual 3.8 5.9. LOGOUT Please use this menu to log out from the Web Manager.
Page 162
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 per- form other system tasks. It will be started automatically in interactive mode when logging in as admin user or by running cli -i.
Page 163
NB3710 User Manual 3.8 Key Sequence Action Clear the screen leaving the current line at the top of the CTRL-l screen; with an argument given, refresh the current line without clearing the screen Fetch the previous command from the history list, moving CTRL-p back in the list Fetch the next command from the history list, moving for-...
Page 164
NB3710 User Manual 3.8 Usage : help [<command >] Available commands : Get config parameters Set config parameters update Update system facilities cert Manage keys and certificates status Get status information scan Scan networks send Send message , mail , techsupport or ussd restart Restart service debug...
Page 165
NB3710 User Manual 3.8 Usage : set [ hv ] <parameter>= <value> [<parameter>= <value > . . ] Options : validate config parameter 6.5. Getting Status Information The status command can be used to get various status information of the system. >...
Page 166
NB3710 User Manual 3.8 SMS status firewall Firewall status QoS status neigh Neighborhood status location Current Location 6.6. Scanning Networks The scan command can be used to scan for available WWAN and WLAN networks. > scan Usage : scan [ hs ] <interface> Options : generate sourceable output 6.7.
Page 167
NB3710 User Manual 3.8 Options : reboot after update force update don 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 Install SSH authorized keys...
Page 168
NB3710 User Manual 3.8 Usage : restart [ h ] <service> Available services : configd Configuration daemon dnsmasq DNS / DHCP server dropbear SSH server firewall Firewall and NAPT gpsd GPS daemon GRE connections ipsec IPsec connections lighttpd HTTP server link manager WAN links network...
Page 169
NB3710 User Manual 3.8 link manager mobile node qmid qosd scripts sdkhost ser2net smsd surveyor swupdate system voiced watchdog wwan manager wwanmd 6.12. Resetting System The reset command can be used to reset the router back to factory defaults. > reset Usage : reset [ h ] 6.13.
Page 170
NB3710 User Manual 3.8 6.15. Working with History The history command will print the list of entered commands on a per-user basis. > history Usage : history [ c ] It can be cleared by history -c. 6.16. CLI-PHP CLI-PHP, the HTTP frontend to the CLI application, can be used to configure and control the router remotely.
Page 171
NB3710 User Manual 3.8 command=get&arg0=admin . password&arg1=admin . debug&arg2=admin . access will lead to cli being called as : cli get " admin . password " " admin . debug " " admin . access " It supports whitespaces but please be aware that any special characters in the URL must be specified according to RFC1738 ( usually done by common...
Page 175
NB3710 User Manual 3.8 send - Send TechSupport Key usage : command=send&arg0=techsupport&arg1=stdout command=send&arg0=techsupport&arg1=<address>&arg2=<subject> Notes : The address has to be a valid E Mail address such as abc@abc . com ( the at sign can be encoded with \%40) . The E Mail client must be properly configured prior to using that function .
Page 176
7. Technical Support NetModule’s mission statement is to provide you with state of the art products, technolo- gies and services for your embedded applications. This certainly includes a professional and friendly team of support engineers which will be pleased to offer consultancy, pro- vide assistance and deliver solutions in case of technical issues.
Page 177
The information in this document is 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.
Page 179
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 in- terfaces (including bridges) WLANx Refers to a Wireless LAN interface which will be represented as additional LAN interface when configured as access point WWANx Refers to a Wireless Wide Area Network (2G/3G/4G) con-...
Page 180
NB3710 User Manual 3.8 Parameter Description The Location Area Code corresponds to an identifier of a set of base stations that are grouped together to optimize signaling The Location Area Identity is a globally unique number that identifies the country, network provider and location area Maximum Segment Size Maximum Transmission Unit Domain Name System...
NB3710 User Manual 3.8 Parameter Description Mobile Country Code Mobile Network Code Cell-ID MSISDN Mobile Subscriber Integrated Services Digital Network Number ICCID Integrated Circuit Card Identifier MEID Mobile Equipment Identifier IMSI International Mobile Subscriber Identity IMEI International Mobile Station Equipment Identity Table A.1.: Abbreviations In general, internal interfaces are written lower-case and may have a different naming.
Page 182
NB3710 User Manual 3.8 Event Description openvpn-up OpenVPN connection came up openvpn-down OpenVPN connection went down ipsec-up IPsec connection came up ipsec-down IPsec connection went down pptp-up PPTP connection came up pptp-down PPTP connection went down dialin-up Dial-In connection came up dialin-down Dial-In connection went down mobileip-up...
NB3710 User Manual 3.8 Event Description ddns-update- Dynamic DNS update succeeded succeeded ddns-update-failed Dynamic DNS update failed usb-storage-added USB storage device has been added usb-storage- USB storage device has been removed removed usb-eth-added USB Ethernet device has been added usb-eth-removed USB Ethernet device has been removed usb-serial-added USB serial device has been added...
Page 184
NB3710 User Manual 3.8 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 188
NB3710 User Manual 3.8 SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " The network name to which the WWAN modem is currently registered " ::= { nbWwanEntry 7 } w w a n L o c a l A r e a I d e n t i f i c a t i o n OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS...
Page 189
NB3710 User Manual 3.8 gnssSystem OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " GNSS system used by the device " ::= { nbGnssEntry 3 } gnssLat OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current...
Page 190
NB3710 User Manual 3.8 ::= { nbWlanEntry 2 } wlanModuleTy pe OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " WLAN module type " ::= { nbWlanEntry 3 } wlanNumClien ts OBJECT - TYPE SYNTAX Integer32 MAX - ACCESS...
Page 192
NB3710 User Manual 3.8 ipsec - down NOTIFICATION - TYPE STATUS current DESCRIPTION " IPsec connection went down " ::= { events 404 } pptp - up NOTIFICATION - TYPE STATUS current DESCRIPTION " PPTP connection came up " ::= { events 406 } pptp - down NOTIFICATION - TYPE STATUS current DESCRIPTION...
Page 193
NB3710 User Manual 3.8 sms - sent NOTIFICATION - TYPE STATUS current DESCRIPTION " SMS has been sent " ::= { events 601 } sms - notsent NOTIFICATION - TYPE STATUS current DESCRIPTION " SMS has not been sent " ::= { events 602 } sms - received NOTIFICATION - TYPE STATUS current...
Page 194
NB3710 User Manual 3.8 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 con- figuration.
Page 195
NB3710 User Manual 3.8 Event Description modbus-tcp-rtu- This script implements a Modbus TCP RTU gateway gateway.are mount-media.are This script can be used to mount an USB storage stick. ping-supervision.are This script will supervise a specified host. read-config.are This script can be used to read a configuration parameter. remote-mail.are This script reads and sends mails from a remote IMAP/POP3/SMTP server...
NB3710 User Manual 3.8 Event Description sms-to-serial.are This script can be used to write a received SMS to the serial port. snmp-agent.are This script extends MIB entries of the SNMP agent snmp-cmd.are This script issues SNMP set/get commands snmp-trap.are This script can be used to send SNMP traps status.are This script can be used to display all status variables syslog.are...
Need help?
Do you have a question about the NB3710-LWA and is the answer not in the manual?
Questions and answers