NetModule NB3710 User Manual
Hide thumbs Also See for NB3710:
Table of Contents

Advertisement

Quick Links

NetModule Router NB3710
User Manual for Software Version 4.0
Manual Version 1.8
NetModule AG, Switzerland
September 15, 2016

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NB3710 and is the answer not in the manual?

Questions and answers

Summary of Contents for NetModule NB3710

  • Page 1 NetModule Router NB3710 User Manual for Software Version 4.0 Manual Version 1.8 NetModule AG, Switzerland September 15, 2016...
  • Page 2 A detailed license information for a particular software package can be provided on request. NetModule and NB3710 are trademarks and the logo is a service mark of NetModule AG, Switzerland. All other products or company names mentioned herein are used for identification purposes only and may be trademarks or registered trademarks of their respective owners.
  • Page 3: Table Of Contents

    NB3710 User Manual 4.0 Contents 1 Welcome to NetModule 2 Conformity 2.1 Safety Instructions ......
  • Page 4 NB3710 User Manual 4.0 5 Configuration 5.1 First Steps ........
  • Page 5 NB3710 User Manual 4.0 5.7.8 ........125 5.7.9...
  • Page 6 A.5 SDK Examples ....... . 203 List of Figures 5.1 Initial Login .
  • Page 7 ........166 List of Tables 3.1 NB3710 Status Indicators ......
  • Page 8 NB3710 User Manual 4.0 3.5 GPS Specifications ......3.6 GNSS Specifications .
  • Page 9: Welcome To Netmodule

    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.
  • Page 10: Conformity

    Possible antenna circuits must be limited to over-voltage transient levels below 1 500 V (according to IEC 60950-1, TNV-1 circuit levels) by using safety approved components. NB3710 routers shall only be used with a certified (CE or equivalent) power supply which must have a power limited and SELV circuit output.
  • Page 11: Declaration Of Conformity

    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...
  • Page 12: Open Source Software

    NB3710 User Manual 4.0 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)
  • Page 13: Specifications

    • Software Key Voice Note:All LTE models include support for UMTS/EDGE/GPRS. Due to its modular approach, the NB3710 router and its hardware components can be arbitrarily assembled according to its indented usage or application. Please contact us in case of special project requirements.
  • Page 14: Operating Elements

    NB3710 User Manual 4.0 3.2. Operating Elements The following table describes the NB3710 status indicators. 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.
  • Page 15: Nb3710 Status Indicators

    Ext2 Extension port 2 is on. off Extension port 2 is off. The color of the LED represents the signal quality for wireless links. red means low yellow means moderate green means good or excellent Table 3.1.: NB3710 Status Indicators...
  • Page 16: Interfaces

    NB3710 User Manual 4.0 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.
  • Page 17: Mobile

    NB3710 User Manual 4.0 3.3.2. Mobile The various variants of the NB3710support up to two multimode modules for mobile communication. Standard Bands 4G (LTE/FDD) B1(2100), B2(1900), B3(1800), B5(850), B7(2600), B8(900), B20(800) 3G (DC-HSPA+/UMTS) B5(850), B8(900), B2(1900), B1(2100) 2G (EDGE/GPRS/GSM) B9(900), B3(1800), B2(1900)
  • Page 18: Usb 2.0 Host Port

    NB3710 User Manual 4.0 Feature Specification Systems GPS/GLONASS Data stream JSON or NMEA Tracking sensitivity -154 dBm Supported antennas Active and passive Table 3.5.: GPS Specifications GNSS (Option Ge) The GNSS module supports Dead Reckoning with onboard 3D accelerometer and 3D gyroscope.
  • Page 19: Power Supply

    NB3710 User Manual 4.0 Feature Specification Isolation 1500 V Speed 10/100 Mbps Mode Half- & Full-Duplex Crossover Automatic MDI/MDI-X Table 3.8.: Ethernet Port Specification Pin Assignment on M12, 4 poles, D-coded female Pin Signal Pinning Table 3.9.: Pin Assignments of Ethernet Connectors 3.3.7.
  • Page 20: Digital Inputs And Outputs

    NB3710 User Manual 4.0 Feature Specification Table 3.10.: Power Input Specifications Pin Assignment M12, 4 poles, A-coded male Pin Signal Pinning V+ (12 60 V Not connected Not connected Table 3.11.: Pin Assignments of Power Connector 3.3.8. Digital Inputs and Outputs The isolated input and oputput ports have the following specification in common:...
  • Page 21: Extension Connector

    3.3.9. Extension Connector Available Options The NB3710 has an M12 extension connector with 8 pins. The 8 pins are split into two logical ports: Pins 1 to 4 represent Extension Port 1 (EP1) and pin 5 to 8 represent Extension Port 2 (EP2). On both EP1 and EP2 the following interfaces may be present: •...
  • Page 22: Pin Assignments Of Digital Inputs And Outputs

    NB3710 User Manual 4.0 • IBIS (Option I) • Isolated RS-485 (Option Sa) • Isolated RS-232 (Option Sb) Pin Signal Pinning EP1 - Pin 1 EP1 - Pin 2 EP1 - Pin 3 EP1 - Pin 4 EP2 - Pin 1...
  • Page 23: Pin Assignments Of Audio Port Signals (Ep1 / Ep2)

    NB3710 User Manual 4.0 EP Pins Signal 3 / 7 Output Channel 4 / 8 Output Channel + Table 3.18.: Pin Assignments of Audio Port Signals (EP1 / EP2) CAN Port Specification (Option C) The CAN port has the following specification: Feature Specification...
  • Page 24: Ibis Port Specification

    NB3710 User Manual 4.0 Feature Specification Galvanic isolation 1500 V Table 3.21.: IBIS Port Specification EP Pins Signal 1 / 5 Call Signal 2 / 6 Call GND (’Aufrufbus’) 3 / 7 Reply GND (’Antwortbus’) 4 / 8 Reply Signal Table 3.22.: Pin Assignments of IBIS Port Signals (EP1 / EP2)
  • Page 25: Pin Assignments Of Rs-232 Port Signals (Ep1 / Ep2)

    NB3710 User Manual 4.0 EP Pins Signal 3 / 7 4 / 8 Table 3.24.: Pin Assignments of RS-232 Port Signals (EP1 / EP2) Isolated 3-wire RS-232 Port Specification (Option Sb) The isolated 3-wire RS-232 port has the following specification: Feature Specification...
  • Page 26: Port Specification

    NB3710 User Manual 4.0 Feature Specification Protocol 3-wire RS-485 (GND, A, B) Baud rate 600, 1 200, 2 400, 4 800, 9 600, 19 200, 38 400, 57 600, 115 200, 230 400, 460 800 Data bits 7 bit, 8 bit...
  • Page 27: Installation

    , the router MUST be connected to an earth protection. 4.2. Installation of the Router The NB3710 is designed for mounting it on a worktop or wall. Please consider the safety instructions and the environmental conditions in chapter 2. 4.3. Installation of the Mini-SIM Card...
  • Page 28: Installation Of The Gsm/Umts/Lte Antenna

    Further information about SIM configuration can be found in chapter 5.3.3. 4.4. 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 circum- stances it might be necessary to use remote antennas together with an extended cable to reach a better location offering an adequate signal.
  • Page 29: Installation Of The Local Area Network

    NB3710 User Manual 4.0 4.7. Installation of the Local Area Network Up to five 10/100 Mbps Ethernet devices can be directly connected to the router, fur- ther devices can be attached via an addtional Ethernet switch. Please ensure that the connector has been plugged in properly and remains in a fixed state, you might other-...
  • Page 30: Configuration

    4.0. 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 31: Initial Access

    NB3710 User Manual 4.0 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.
  • Page 32: Recovery

    NB3710 User Manual 4.0 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.
  • Page 33: Home

    NB3710 User Manual 4.0 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...
  • Page 34 NB3710 User Manual 4.0 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.
  • Page 35 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.
  • Page 36: Interfaces

    NB3710 User Manual 4.0 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 37 NB3710 User Manual 4.0 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...
  • Page 38 NB3710 User Manual 4.0 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.
  • Page 39: Wan Settings

    NB3710 User Manual 4.0 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...
  • Page 40: Link Supervision

    NB3710 User Manual 4.0 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.
  • Page 41 NB3710 User Manual 4.0 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...
  • Page 42: Ethernet

    NB3710 User Manual 4.0 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.
  • Page 43: Ethernet Link Settings

    NB3710 User Manual 4.0 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.
  • Page 44: Vlan Management

    NB3710 User Manual 4.0 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 45 NB3710 User Manual 4.0 Parameter VLAN Priority Levels Critical Applications Video (< 100 ms latency and jitter) Voice (< 10 ms latency and jitter) Internetwork Control Network Control...
  • Page 46: Lan Ip Configuration

    NB3710 User Manual 4.0 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.
  • Page 47 NB3710 User Manual 4.0 Parameter LAN IP Settings 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:...
  • Page 48: Mobile

    NB3710 User Manual 4.0 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 49 NB3710 User Manual 4.0 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 50 NB3710 User Manual 4.0 mentary Service Data (USSD) requests, e.g. for querying the available balance of a prepaid account.
  • Page 51: Wwan Interfaces

    NB3710 User Manual 4.0 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.
  • Page 52 NB3710 User Manual 4.0 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 The phone number to be dialed, for 3G+ connections this commonly refers to be *99***1#.
  • Page 53: Wlan

    NB3710 User Manual 4.0 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, access point or managed mode. As a client it can create an additional WAN link which for instance can be used as backup link.
  • Page 54 NB3710 User Manual 4.0 Configurable parameters for access-point and client 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. Please refer to the antennas datasheet for the correct gain value.
  • Page 55: Ieee 802.11 Network Standards

    866.7 Mbit/s Table 5.18.: IEEE 802.11 Network Standards Note: NetModule Routers with 802.11n and 802.11ac support 2x2 MIMO 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.
  • Page 56 NB3710 User Manual 4.0 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 57: Wlan Configuration

    NB3710 User Manual 4.0 Running in access-point mode you can create up to 4 SSIDs with each running their own network configuration. The networks can be individually bridged to a LAN interface or operate as dedicated interface in routing-mode. Figure 5.13.: WLAN Configuration...
  • Page 58 NB3710 User Manual 4.0 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 WPA2 should preferred over WPA1, running mode WPA/WPA2 mixed-mode offers both.
  • Page 59: Wlan Ip Configuration

    NB3710 User Manual 4.0 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 60: Usb

    NB3710 User Manual 4.0 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.
  • Page 61: Usb Device Management

    NB3710 User Manual 4.0 Linux drivers. Further installation instructions can be provided on demand. Please note that some USB devices behave latency-sensitive which may raise problems when operating over a slow IP connection. Some devices may generally not work with the USB/IP driver.
  • Page 62 NB3710 User Manual 4.0 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. For authentication, a file called autorun.key must exist in the root directory of a FAT16/32 formatted stick.
  • Page 63: Serial Port

    The serial port will be exposed over a TCP/IP port and can be used to implement a Serial/IP gateway. The serial port will be reserved for SDK scripts. Figure 5.17.: Serial Port Administration An RS485 serial port is optional on NB3710.
  • Page 64: Serial Port Settings

    NB3710 User Manual 4.0 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...
  • Page 65 NB3710 User Manual 4.0 Parameter Serial Settings 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 Timeout The timeout until a client is declared as disconnected...
  • Page 66: Digital I/O

    NB3710 User Manual 4.0 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:...
  • Page 67: Gnss

    NB3710 User Manual 4.0 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 68 NB3710 User Manual 4.0 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...
  • Page 69 NB3710 User Manual 4.0 Parameter GNNS Supervision Max. downtime The period of time without valid NMEA information after which an emergency action will be taken 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.
  • Page 70: Routing

    NB3710 User Manual 4.0 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.
  • Page 71: Static Route Flags

    NB3710 User Manual 4.0 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.
  • Page 72: Extended Routing

    NB3710 User Manual 4.0 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 73 NB3710 User Manual 4.0 Parameter Extended Route Configuration Route to Specifies the target interface or gateway to where the packet should get routed to discard if down Discard packets if the specified interface is down...
  • Page 74: Multipath Routes

    NB3710 User Manual 4.0 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.
  • Page 75: Mobile Ip

    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 76 NB3710 User Manual 4.0 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...
  • Page 77: Mobile Ip

    NB3710 User Manual 4.0 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...
  • Page 78: Quality Of Service

    NB3710 User Manual 4.0 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 79 NB3710 User Manual 4.0 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 shaping is intended Each queue can be configured as follows:...
  • Page 80: Multicast

    NB3710 User Manual 4.0 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.
  • Page 81: Ospf

    NB3710 User Manual 4.0 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 connected Redistribute routes to networks which are directly con-...
  • Page 82 NB3710 User Manual 4.0 Parameter OSPF Networks Area Routing area to which this interface belongs (0-65535, 0 means backbone)
  • Page 83: Bgp

    NB3710 User Manual 4.0 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 AS number...
  • Page 84: Firewall

    NB3710 User Manual 4.0 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).
  • Page 85: Rules

    NB3710 User Manual 4.0 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 86 NB3710 User Manual 4.0 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...
  • Page 87: Napt

    NB3710 User Manual 4.0 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.
  • Page 88 NB3710 User Manual 4.0 Parameter Masqerading Rules Source netmask The source netmask of the network from which matching packets are masqueraded NAPT Inbound Rules Inbound rules can be used to modify the target section of IP packets and, for instance, forward a service or port to an internal host.
  • Page 89 NB3710 User Manual 4.0 Parameter Outbound NAPT Rules Source address The source address of matching packets (optional) Protocol The used protocol of matching packets Ports The used UDP/TCP port of matching packets Rewrite source address The address to which the source address of matching packets...
  • Page 90: Inbound Napt

    NB3710 User Manual 4.0 Figure 5.27.: Inbound NAPT...
  • Page 91: Vpn

    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...
  • Page 92: Openvpn Configuration

    NB3710 User Manual 4.0 Figure 5.29.: OpenVPN Configuration...
  • Page 93 NB3710 User Manual 4.0 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 94 NB3710 User Manual 4.0 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.
  • Page 95 NB3710 User Manual 4.0 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 system has to be set prior to creating certificates and establishing a...
  • Page 96: Openvpn Client Management

    NB3710 User Manual 4.0 Figure 5.30.: OpenVPN Client Management...
  • Page 97: Ipsec

    NB3710 User Manual 4.0 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.
  • Page 98: Ipsec Administration

    NB3710 User Manual 4.0 Figure 5.31.: IPsec Administration...
  • Page 99: Ipsec Configuration

    NB3710 User Manual 4.0 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. Please note that running NAT-Traversal makes IKE using UDP port 4500 rather than 500 which has to be taken into account when setting up firewall rules.
  • Page 100 Restart the peer. 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 101 NB3710 User Manual 4.0 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:...
  • Page 102 NB3710 User Manual 4.0 Parameter IPsec Proposal Settings Encryption algorithm The desired IKE encryption method (we recommend AES256) Authentication algo- The desired IKE authentication method (we prefer SHA1 rithm over MD5) SA life time The lifetime of Security Associations Perfect forward secrecy Specifies whether Perfect Forward Secrecy (PFS) should be...
  • Page 103: Pptp

    NB3710 User Manual 4.0 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.
  • Page 104: Pptp Tunnel Configuration

    NB3710 User Manual 4.0 Figure 5.34.: PPTP Tunnel Configuration...
  • Page 105: Pptp Client Management

    NB3710 User Manual 4.0 Setting up a server requires the following settings: 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...
  • Page 106: Gre

    NB3710 User Manual 4.0 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.
  • Page 107: Dial-In

    NB3710 User Manual 4.0 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 108 NB3710 User Manual 4.0 as GSM voice calls, they suffer from unreliability and poor bandwidth.
  • Page 109: Services

    NB3710 User Manual 4.0 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 110 NB3710 User Manual 4.0 /* We are going to eavesdrop on the first serial port * and turn on lights via a digital I / O output port , * otherwise we d have to send a short message .
  • Page 111 NB3710 User Manual 4.0 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 112 NB3710 User Manual 4.0 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 113 NB3710 User Manual 4.0 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 114: Sdk Administration

    NB3710 User Manual 4.0 Figure 5.37.: SDK Administration...
  • Page 115 NB3710 User Manual 4.0 Administration This page can be used to control the SDK host and apply the following settings: Parameter SDK Administration Settings Administrative status Specifies whether SDK scripts should run or not Scheduling priority Specifies the process priority of the sdkhost, higher priorities...
  • Page 116 NB3710 User Manual 4.0 Parameter SDK Script Parameters 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...
  • Page 117: Sdk Jobs

    NB3710 User Manual 4.0 Figure 5.38.: SDK Jobs...
  • Page 118 NB3710 User Manual 4.0 /* arguments : schnick schnack " s c h n u c k " for ( i = 0; i < argc ; i ++) { printf (" argv % d : % s \ n " , i , argv [ i ]) ;...
  • Page 119: Sms Control Commands

    NB3710 User Manual 4.0 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...
  • Page 120: Dhcp Server

    NB3710 User Manual 4.0 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.
  • Page 121: Dhcp Server

    NB3710 User Manual 4.0 Figure 5.39.: DHCP Server...
  • Page 122: Dns Server

    NB3710 User Manual 4.0 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 123 NB3710 User Manual 4.0 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.
  • Page 124: Ntp Server

    NB3710 User Manual 4.0 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...
  • Page 125: Dynamic Dns

    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 126 NB3710 User Manual 4.0 Parameter Dynamic DNS 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.
  • Page 127: E-Mail

    NB3710 User Manual 4.0 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.
  • Page 128 NB3710 User Manual 4.0 Parameter E-Mail Client Settings Password Password used for authentication...
  • Page 129: Events

    NB3710 User Manual 4.0 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...
  • Page 130: Sms

    NB3710 User Manual 4.0 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.
  • Page 131: Sms Configuration

    NB3710 User Manual 4.0 Figure 5.44.: SMS Configuration...
  • Page 132 NB3710 User Manual 4.0 Please note that numbers have to be entered in international format including a valid 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.
  • Page 133: Ssh/Telnet Server

    NB3710 User Manual 4.0 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 134 NB3710 User Manual 4.0 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 By turning on this option, all users will have to authenticate login by SSH keys which can be uploaded to the router.
  • Page 135: Snmp Agent

    NB3710 User Manual 4.0 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 IF-MIB (RFC2863) .1.3.6.1.2.1.4...
  • Page 136: Snmp Agent

    NB3710 User Manual 4.0 router. 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...
  • Page 137 NB3710 User Manual 4.0 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 138 NB3710 User Manual 4.0 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 139 NB3710 User Manual 4.0 Running a software update: 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.13.0 s "http://server/directory" Getting the software update status: snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1...
  • Page 140 NB3710 User Manual 4.0 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.20.0 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...
  • Page 141: Web Server

    NB3710 User Manual 4.0 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.
  • Page 142: Redundancy

    NB3710 User Manual 4.0 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 143 NB3710 User Manual 4.0 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.
  • Page 144: Voice Gateway

    NB3710 User Manual 4.0 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...
  • Page 145 NB3710 User Manual 4.0 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...
  • Page 146: Voice Gateway Endpoint Configuration

    NB3710 User Manual 4.0 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...
  • Page 147 NB3710 User Manual 4.0 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 148 NB3710 User Manual 4.0 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)
  • Page 149: Voice Gateway Routing Configuration

    NB3710 User Manual 4.0 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 150 NB3710 User Manual 4.0 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 151: System

    NB3710 User Manual 4.0 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 152 (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 GNSS. If enabled, the time synchronization is usually triggered after a WAN link has come up but before starting any VPN connections.
  • Page 153: Regional Settings

    NB3710 User Manual 4.0 Parameter Time Zone Time Zone Set the local time zone. Daylight saving changes Enable/disable daylight saving changes. Figure 5.53.: Regional settings Reboot This page can be used to set up a periodic automatic reboot but also to trigger a manual...
  • Page 154: Authentication

    NB3710 User Manual 4.0 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...
  • Page 155 NB3710 User Manual 4.0 can be added, they can also alter the system configuration or perform administrative system tasks. Other users only have the permission to view status information. They can be also used for VPN access. The Web Manager supports up to 5 concurrent users. Inactive users will be kicked after being idle for 30 minutes.
  • Page 156: Remote Authentication

    NB3710 User Manual 4.0 Figure 5.55.: Remote Authentication...
  • Page 157: Software Update

    NB3710 User Manual 4.0 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...
  • Page 158: Module Firmware Update

    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.
  • Page 159: Configuration

    NB3710 User Manual 4.0 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.
  • Page 160: Automatic File Configuration

    NB3710 User Manual 4.0 Figure 5.57.: Automatic File Configuration...
  • Page 161: Factory Configuration

    NB3710 User Manual 4.0 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 162 NB3710 User Manual 4.0 the default settings can be achieved by restoring the original factory configuration and initiating the factory reset again.
  • Page 163: Troubleshooting

    NB3710 User Manual 4.0 5.8.7. Troubleshooting Network Debugging There are serveral tools for network debugging like ping, traceroute, tcpdump and dark- stat. Parameter Automatic software update Ping The ping utility can be used to verify whether a remote host can be reached via IP.
  • Page 164: Log Viewer

    NB3710 User Manual 4.0 Figure 5.59.: Log Viewer...
  • Page 165: Tech Support File

    NB3710 User Manual 4.0 Figure 5.60.: Tech Support File...
  • Page 166: Keys And Certificates

    NB3710 User Manual 4.0 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.
  • Page 167: Certificate Sections

    NB3710 User Manual 4.0 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).
  • Page 168: Certificate Configuration

    NB3710 User Manual 4.0 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...
  • Page 169 NB3710 User Manual 4.0 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...
  • Page 170 NB3710 User Manual 4.0 Parameter SCEP Configuration Fingerprint algorithm The fingerprint algorithm for identifying the CA (MD5 or SHA1) Poll interval The polling interval in seconds for a certificate request Request timeout The max. polling time in seconds for a certificate request...
  • Page 171: Licensing

    NB3710 User Manual 4.0 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 172: Legal Notice

    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 173: Logout

    NB3710 User Manual 4.0 5.9. LOGOUT Please use this menu to log out from the Web Manager.
  • Page 174: Command Line Interface

    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 175: Print Help

    NB3710 User Manual 4.0 Key Sequence Action Clear the screen leaving the current line at the top of the screen; CTRL-l with an argument given, refresh the current line without clearing the screen Fetch the previous command from the history list, moving back in...
  • Page 176: Getting Config Parameters

    NB3710 User Manual 4.0 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...
  • Page 177: Getting Status Information

    NB3710 User Manual 4.0 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. > status Usage : status [ hs ] <section>...
  • Page 178: Scanning Networks

    NB3710 User Manual 4.0 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>...
  • Page 179: Manage Keys And Certificates

    NB3710 User Manual 4.0 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...
  • Page 180: Debug System

    NB3710 User Manual 4.0 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...
  • Page 181: Resetting System

    NB3710 User Manual 4.0 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...
  • Page 182: Working With History

    NB3710 User Manual 4.0 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 183 NB3710 User Manual 4.0 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...
  • Page 184 NB3710 User Manual 4.0 http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php ? version=2&output=html&command=status get - Get configuration parameter Key usage : command=get&arg0=<config key>[&arg1=<config key > . . ] Examples : http : / / 1 9 2 .
  • Page 185 NB3710 User Manual 4.0 arg0= h Examples : http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php ? version=2&output=html&usr=admin&pwd= admin01&command=restart&arg0= h http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php ? version=2&output=html&usr=admin&pwd= admin01&command=restart&arg0=link manager...
  • Page 186 NB3710 User Manual 4.0 admin01&command=update&arg0=config&arg1=tftp : / / 1 9 2 . 1 6 8 . 1 . 2 5 4 / user config . zip http : / / 1 9 2 . 1 6 8 . 1 . 1 / cli . php ? version=2&output=html&usr=admin&pwd= admin01&command=update&arg0=license&arg1=http : / / 1 9 2 .
  • Page 187 NB3710 User Manual 4.0 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 188: A Appendix

    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 189 NB3710 User Manual 4.0 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...
  • Page 190: System Events

    NB3710 User Manual 4.0 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...
  • Page 191 NB3710 User Manual 4.0 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...
  • Page 192: System Events

    NB3710 User Manual 4.0 Event Description call-outgoing Outgoing voice call is being established 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...
  • Page 193: Factory Configuration

    NB3710 User Manual 4.0 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 194: Snmp Vendor Mib

    -- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -- NetModule AG VENDOR MIB -- ( c ) COPYRIGHT 2016 by NetModule AG , Switzerland -- All rights reserved .
  • Page 195 NB3710 User Manual 4.0 -- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *...
  • Page 196 NB3710 User Manual 4.0 " Force a device restart " ::= { admin 10 } -- Update -- updateOperation OBJECT - TYPE SYNTAX INTEGER { update (0) , store (1) MAX - ACCESS read - write STATUS current DESCRIPTION " The desired operation for configuration or software updates "...
  • Page 197 NB3710 User Manual 4.0 co nfigUpd ateMod e OBJECT - TYPE SYNTAX INTEGER { full (0) , partial (1) MAX - ACCESS read - write STATUS current DESCRIPTION " The desired system configuration update mode ( full or partial ) "...
  • Page 198 NB3710 User Manual 4.0 STATUS current DESCRIPTION " The version of the alternative software " ::= { admin 35 } altSoftwareHash OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " The hash of the alternative software "...
  • Page 199 NB3710 User Manual 4.0 STATUS current DESCRIPTION " An entry describing a WWAN modem and its current settings " INDEX { w wanM odemIndex } ::= { nbWwanTable 1 } NBWwanEntry ::= SEQUENCE { wwanModemIndex Integer32 , wwanModemName DisplayString ,...
  • Page 200 NB3710 User Manual 4.0 MAX - ACCESS read - only STATUS current DESCRIPTION " The Local Area Code ( LAC ) to which the WWAN modem is currently registered " ::= { nbWwanEntry 9 } wwanCellId OBJECT - TYPE SYNTAX...
  • Page 201 NB3710 User Manual 4.0 gnssLon OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " The current longitude value received by the GNSS device " ::= { nbGnssEntry 5 } gnssAlt OBJECT - TYPE SYNTAX...
  • Page 202 NB3710 User Manual 4.0 -- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *...
  • Page 203 NB3710 User Manual 4.0 " WAN link type " ::= { nbWanEntry 5 } wa nLinkIn terfac e OBJECT - TYPE SYNTAX DisplayString MAX - ACCESS read - only STATUS current DESCRIPTION " WAN link interface " ::= { nbWanEntry 6 }...
  • Page 204 NB3710 User Manual 4.0 ::= { nbWanEntry 15 } wanUploadRate OBJECT - TYPE SYNTAX Integer32 MAX - ACCESS read - only STATUS current DESCRIPTION " WAN link upload rate " ::= { nbWanEntry 16 } -- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *...
  • Page 205 NB3710 User Manual 4.0 -- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *...
  • Page 206 NB3710 User Manual 4.0 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...
  • Page 207 NB3710 User Manual 4.0 STATUS current DESCRIPTION " System poweroff has been triggered " ::= { events 509 } sms - sent NOTIFICATION - TYPE STATUS current DESCRIPTION " SMS has been sent " ::= { events 601 } sms - notsent NOTIFICATION - TYPE...
  • Page 208 NB3710 User Manual 4.0 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 209 NB3710 User Manual 4.0 Event Description mount-media.are This script can be used to mount an USB storage stick. opcua-browse.are This script will browse for nodes at a remote OPC-UA server. opcua-json.are This script polls any temperature nodes of an OPC-UA server and sends them JSON-encoded to a remote server.
  • Page 210 NB3710 User Manual 4.0 Event Description sms-control.are This script will execute commands received by SMS. sms-delete-inbox.are This script can be used to flush the SMS inbox. sms-read-inbox.are This script can be used to read the SMS inbox. sms-to-email.are This script will forward incoming SMS messages to a given E-mail address.
  • Page 211: Sdk Examples

    NB3710 User Manual 4.0 Event Description Table A.3.: SDK Examples...

Table of Contents