SMSEagle NXS-9700-5G User Manual

Table of Contents

Quick Links

Download this manual

SMSEAGLE

NXS-9700-3G

NXS-9700-4G

NXS-9700-5G

Rev. 1, Rev. 2, Rev. 3, Rev.4

User's Manual

NTP

Table of Contents

Need help?

Do you have a question about the NXS-9700-5G and is the answer not in the manual?

Questions and answers

Summary of Contents for SMSEagle NXS-9700-5G

Page 1 SMSEAGLE NXS-9700-3G NXS-9700-4G NXS-9700-5G Rev. 1, Rev. 2, Rev. 3, Rev.4 User’s Manual...
Page 2 Congratulations on purchasing SMSEAGLE The materials used in this publication are copyright and are not to be duplicated, copied, or used without the prior consent of the copyright holder. Technical specifications and information in this document is subject to change without prior notice being given.
Page 3: Table Of Contents
CONTENTS SMSEagle Software Licensing Information ......................8 What’s In The Box ..............................14 Prepare for First Start ............................. 15 Get to know with Connectors, Ports and LEDs ....................20 Basic Operations ..............................21 SMSEagle basic features ............................22 Compose SMS ............................... 22 Importing SMS from CSV and using placeholders ..................
Page 4 Subscriptions (newsletter) ..........................88 SMSEagle API ................................90 API Reference (Documentation) ........................90 API Access................................90 Plugins and integration manuals for NMS & Auth systems ................ 91 Extras ................................... 93 Delivery Reports ..............................93 Connecting directly to SMSEagle SQL database ..................93...
Page 5 Injecting short SMS using SQL ........................94 Injecting long SMS using SQL ......................... 95 Database cleaning scripts ..........................97 SNMP agent ................................98 Setting up SNMP v3 access control ......................101 Forwarding logs to external server......................103 Automatic software updates check......................104 Knowledgebase &...
Page 6 Restriction of Hazardous Substances Directive (RoHS) ................ 122...
Page 7 GET READY TO START | SMSEagle NXS-9700-3G | User’s Manual...
Page 8: Smseagle Software Licensing Information
YOU AGREE TO BE LEGALLY BOUND BY THE HEREIN-CONTAINED TERMS OF THIS LICENSE AGREEMENT. IF YOU DO NOT AGREE TO BE BOUND BY THE TERMS OF THIS EULA, DO NOT USE THE SMSEAGLE DEVICE AND YOU MAY CHOOSE TO PROMPTLY RETURN THE DEVICE FOR A REFUND OF ITS PURCHASE PRICE BY CONTACTING PROXIMUS AT THE ADDRESS ABOVE.
Page 9 1.04 "Update" means maintenance of, or a fix to, a version of SMSEagle Software, including, but not limited to a hot fix, patch, or enhancement, none of which function as a standalone service or other software package and which do not have an additional cost for an existing Licensee.
Page 10 Intellectual Property laws and treaties. 3.02 RESTRICTIONS ON USE. As a Licensee, You may not: (a) Make use of the SMSEagle Software on more than one device at a time, without prior purchase of additional devices; (b) Share or otherwise make available the SMSEagle Software, in any manner whatsoever, to any third party (c) Modify, adapt, create derivative works from or translate any part of the SMSEagle Software other than what may be used within Your SMSEagle device in accordance with this License;...
Page 11 FOR A PARTICULAR USE, AND NONINFRINGEMENT. LIMITATION OF LIABILITY AND REMEDIES IN SPITE OF ANY DAMAGES ARISING FROM OR RELATED TO THE SMSEAGLE DEVICE AND SMSEAGLE SOFTWARE OR ITS OPERATION THAT YOU MAY INCUR FOR ANY REASON, WHICH MAY INCLUDE, BUT ARE NOT LIMITED TO, ANY AND ALL DAMAGES IN CONTRACT, TORT OR...
Page 12 DATA COLLECTION STATEMENT. PROXIMUS does NOT collect ANY data you are working with when You use SMSEagle device. We could not see or collect any data saved on SMSEagle device, because we do not have any access to Your device.
Page 13 CONTACT INFORMATION If you have questions regarding this EULA, please contact PROXIMUS at: Proximus Sp. z o.o. Ul. Piątkowska 163 60-650 Poznań Poland | Europe tel. + 48 61 6713 413 https:/ /www.smseagle.eu hello@smseagle.eu support@smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
Page 14: What's In The Box
WHAT’S IN THE BOX Your SMSEagle box contains: SMSEagle hardware SMS gateway • External omnidirectional antenna (with magnetic foot) – 3G/4G device • 2x External MIMO antennas (with magnetic/adhesive foot) – 5G device • AC/DC power supply (input voltage: 100-240V) •...
Page 15: Prepare For First Start
PREPARE FOR FIRST START Your SMSEagle is designed so that you can set it up quickly and start using it right away. Follow the steps below to get started. Install the antenna(s) STEP 1: ANTENNA INSTALLATION GUIDELINES Install the antenna(s) in a location with access to a cellular network radio signal.
Page 16 STEP 4: SMSEAGLE DEFAULT NETWORK CONFIGURATION: DHCP CLIENT IS ON IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER CONNECT SMSEAGLE TO YOUR LAN AND OBTAIN IP ADDRESS AUTOMATICALLY connect the device to your LAN using Ethernet cable • •...
Page 17 PREPARE FOR FIRST START LOG IN TO SMSEAGLE Open an internet browser on your PC and go to the IP address assigned to your gateway SMSEAGLE DEFAULT USER: Username: admin Password: password Login to application with above username and password.
Page 18 SSL certificate or a free Let’s Encrypt SSL certificate. Using HTTPS only By default, SMSEagle webGUI can be accessed via HTTP or HTTPS. For improved security we recommend using HTTPS. If you would like to redirect HTTP > HTTPS, follow instructions in the chapter SSL Certificate and HTTPS Redirection.
Page 19 USING OF SMSEAGLE | SMSEagle NXS-9700 | User’s Manual...
Page 20: Get To Know With Connectors, Ports And Leds
LED for user application purpose SIM1,2 LEDs Modem 1,2 (optional) LED indicator for modem status Ready LED LED indication device status Reset Switch for rebooting the device User Switch Switch for restoring to factory settings | SMSEagle NXS-9700 | User’s Manual...
Page 21: Basic Operations
SMSEagle is capable of working at various screen resolutions, making it accessible for wide range of devices: computers, laptops, tablets, smartphones, etc. Open a web browser on your device, type in SMSEagle’s IP address (as set in previous chapter). At login screen type in your username/password. Default username and password is given in chapter Prepare for First Start.
Page 22: Smseagle Basic Features
SMSEAGLE BASIC FEATURES Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items). Different message • types (normal SMS, flash, WAP push, USSD codes) Sending & Receiving MMS (webGUI & API) • Smartphone-like conversation mode (messages are nicely grouped by phone number). You can •...
Page 23: Importing Sms From Csv And Using Placeholders
Importing SMS from CSV and using placeholders SMSEagle software allows you to import SMS text from CSV file and (optionally) use special placeholders in a message body. Placeholders are special fields which are replaced with unique values for each message.
Page 24: Folders
• Trash • The view of conversations can be either of type “Balloons” (smartphone like conversation) or “Table” (tabular view). The view type can be changed in menu Settings > Application. Balloons view type: | SMSEagle NXS-9700 | User’s Manual...
Page 25: Mms
The status of a sent message can be seen in Folders>Sent Items>in selected message. There are 2 places where the sending status is displayed: status icon in the right bottom corner of each message and status text in message details (button “Show Details”). | SMSEagle NXS-9700 | User’s Manual...
Page 26: Cleanup Folders
Delivery Reports are enabled) Cleanup Folders This function allows you to add rules on when to automatically purge (clean up) messages & logs in selected folders. Screenshot with example from Cleanup folders screen | SMSEagle NXS-9700 | User’s Manual...
Page 27: Calls (Voice Feature)
SMS containing a critical alert. When a wake-up call is made SMSEagle device will ring to a specified phone number or phonebook entry for a specified number of seconds.
Page 28 When a TTS call is made SMSEagle device will call a specified phone number or phonebook entry and text message will be read by a built-in voice synthesizer (currently the English language is supported by voice synthesis).
Page 29: Phonebook
MHD-8100-4G devices. Phonebook Web-GUI of SMSEagle device is equipped with Phonebook for managing contacts, groups and shifts. Each user can create private and public contacts, gather contacts in private and public groups. Contacts can also be optionally assigned to working shifts. Contacts and groups from Phonebook allows users efficient sending of messages.
Page 30 Define Contact name and Telephone number • Choose if contact is Private/Public • Add contact to a Group • Add contact to a Working Shift • Enable/disable Vacation mode (messages are not sent when Vacation mode is enabled) • | SMSEagle NXS-9700 | User’s Manual...
Page 31: Phonebook Groups
Escalation group is a special version of a Phonebook group. When a group is set as an “Escallation group” a single message sent to the group will be escalated to the group members. The message will be escalated with given time interval until a set STOP word is received. | SMSEagle NXS-9700 | User’s Manual...
Page 32 You can change the escalation order by dragging contacts up or down. Screenshot from Manage Groups with set escalation Current escalation queue can be viewed and managed via menu Folders>Outbox>Escalation queues Screenshot with example from Folders>Outbox>Escalation queues window | SMSEagle NXS-9700 | User’s Manual...
Page 33: Phonebook Working Shifts
There are two access levels for a user: User role “Administrator”: • Allows full access & control of the device including settings and User management. User role “User”: • Limits access only allowing to Compose, Folders, Phonebook and Reporting module. | SMSEagle NXS-9700 | User’s Manual...
Page 34: Multi-User Capabilities
Screenshot of Edit/Add User window Multi-User Capabilities As described in the “Users” chapter, SMSEagle software allows to create multiple users with different access levels (Administrator or User). Those users may access the device simultaneously via webGUI or API. The following set of features is available in multi-user work scenario: Multiple users may acess the device simultaneously via webGUI or API •...
Page 35: Statistics View
Statistics view The reporting module allows also to view daily statistics of sent/received messages. The statistics view displays number of messages per day and sender/receiver number. Screenshot of Statistics view in Reporting module Multi-Factor Authentication | SMSEagle NXS-9700 | User’s Manual...
Page 36 USER LOGIN WITH MFA Once MFA is activated, the user must provide two factor authentication (user and password + one-time SMS token) every time he logs in to Web-GUI. One-time SMS token is valid for 10 minutes. | SMSEagle NXS-9700 | User’s Manual...
Page 37 Screenshot from User Settings > MFA. Recovery code is revealed after entering password ENABLE MFA BY ADMINISTRATOR MFA can also be enabled by an administrator role for selected users. This is done in the menu Users > Edit User. | SMSEagle NXS-9700 | User’s Manual...
Page 38: Settings
Screenshot from Edit/Add User Settings Settings menu is divided into several tabs for easier maintenance. Application Settings Application settings can be changed under the Settings Tab > Application. | SMSEagle NXS-9700 | User’s Manual...
Page 39 8 characters long and include at least one lowercase letter, uppercase letter, number and special character You can enable to force MFA (Multifactor Authentication) for user role: for all users, only new users, • or leave users to choose their MFA settings (disable force) | SMSEagle NXS-9700 | User’s Manual...
Page 40: Ip Settings
You can input Hostname • You can choose to Use proxy • Failover Failover configuration has been described in chapter “Failover (HA-cluster) feature”. Date/Time Date/Time settings can be changed under the Settings Tab > Date/Time | SMSEagle NXS-9700 | User’s Manual...
Page 41: Maintenance
You can set automatic time synchronization with NTP timeserver, disable automatic time • synchronization or create NTP server on SMSEagle device (date & time will be obtained from 3G/4G/5G network) You can set NTP timeserver address (or several addresses separated with comma) •...
Page 42: Email Alerts
This feature allows you to find the best location of antenna for environments with poor cellular signal strength. When enabled, signal strength value on SMSEagle dashboard will refresh every 3s. This allows you to try different location of antenna and find a spot with the best signal.
Page 43 You can save debug information in system log (enable this only for troubleshooting) • Notice: To prevent false alarms we recommend to set parameter “Send alert when error counter exceeds” to value > 2. | SMSEagle NXS-9700 | User’s Manual...
Page 44: Call Forward
You can choose to forward all incoming calls to a chosen number • Important Notice: This feature is not available in NXS-97xx-4G Rev.3 devices. MMS Settings can be accessed under the Settings tab > MMS. | SMSEagle NXS-9700 | User’s Manual...
Page 45: Data Connection
You can input MMS autoresponder message • *The values for all fields can be found on the website of your SIM-card operator* Data Connection Data connection settings can be accessed under the Settings tab > Data conn. | SMSEagle NXS-9700 | User’s Manual...
Page 46: Ssl Certificate And Https Redirection
Here you can control a mobile data connection on your device. It can be used, for example, to utilize SMSEagle as a backup Internet source. Data connection is NOT REQUIRED for normal operation of SMSEagle device. Leave it disabled (OFF) if you don't want to use it.
Page 47 SSL Certificate BY default, SMSEagle device is equipped with a self-signed SSL certificate. If you want to install your own certificate on the device, please obtain a valid certificate file issued by a Certificate Authority. To upload the certificate, please provide the certificate file and private key in PEM format. The certificate cannot be password protected.
Page 48: Backup/Restore
You can restore device settings form a previously saved file • You can choose to additionally restore the database • *WARNING* Restore backup settings only works with the same version of device and software | SMSEagle NXS-9700 | User’s Manual...
Page 49: Snmp
Update settings can be accessed under the menu Settings > Updates tab. SMSEagle software is under process of continual improvement. We listen to our customers, and new releases are based on our customer’s inputs/requests. Software updates are released frequently, and offer access to new features and fixes to reported issues.
Page 50 Screenshot from “General Settings-Updates” Notice: Your SMSEagle device must have a HTTPS connectivity with the address updates.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700...
Page 51: Failover (Ha-Cluster) Feature
SMSEagle NXS-family devices have their own failover mechanism based on HA-cluster. This feature allows you to assure high availability of SMSEagle devices in critical environments. To enable failover (HA-cluster) you need 2 devices ('aka' nodes). The failover feature monitors devices working in the cluster, and detects...
Page 52 When the daemon running at MASTER device detects failure of at least one described feature it immediately automatically switches cluster's IP assignment to the BACKUP device (node) providing continuous usage of the SMSEagle HA-cluster for the user. Devices (nodes) should see each other on the network. By default, HA-nodes use 224.0.0.18 multicast IP address for VRRP (Virtual Router Redundancy Protocol) for communication between two nodes.
Page 53 Failover feature uses KEEPALIVED-MIB for SNMP monitoring. DEVICE CLUSTER STATE EXAMPLE OF READING VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.9586.100.5.2.3.1.4.1 Result: KEEPALIVED-MIB::vrrpInstanceState.1 = INTEGER: master(2) Comment: Current device state is master | SMSEagle NXS-9700...
Page 54: Smseagle Plugins
Basic features of SMSEagle software are extended by plugins that provide extra features to the software. Below you will find a description of plugins available in each SMSEagle device. All plugins are an integral part of SMSEagle software. That means that all described plugins are installed in a standard software of SMSEagle device and are available for free.
Page 55 ICMP (ping) to monitor a server with ICMP protocol • or PORT (TCP/UDP) to monitor your service on a selected port (SMSEagle will check if port is open) • or SNMP to monitor objects via SNMP protocol (supported return types: numeric, string) •...
Page 56 MONITORING FREQUENCY Monitoring tasks are performed in a parallel mode. Software automatically optimizes number of parallel tasks and frequency of tasks taking into account the performance of the device and adjusts monitoring period when needed. | SMSEagle NXS-9700 | User’s Manual...
Page 57 What makes the Trap unique is that they are triggered instantaneously by an agent, rather than waiting for a status request from SNMP get query. Screenshot from Network Monitor > SNMP TRAPS window. | SMSEagle NXS-9700 | User’s Manual...
Page 58: Email To Sms Plugin
The text of the email is the text of the SMS message (optionally you can append email subject at the beginning of SMS message). Example: email message sent to the address: 123456789@192.168.0.101 will be converted to SMS message and delivered to phone number 123456789. | SMSEagle NXS-9700 | User’s Manual...
Page 59 LDAP plugin must be configured on your SMSEagle device. USING FQDN IN EMAIL ADDRESS It is also possible to use Fully Qualified Domain Name in an email address sent to SMSEagle box (eg.: 123456789@mydomain.com). Please refer to our FAQ article:...
Page 60 Screenshot from Email To SMS > Rules window Screenshot from Email to SMS > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
Page 61 ‘What to do with email subject’ setting to ‘Use for • authentication’. If user authentication is enabled, provide in a subject of an email your login and | SMSEagle NXS-9700 | User’s Manual...
Page 62: Email To Sms Poller
IP in the email address. This requires configuring proper domain and DNS entries at your DNS server - both A and MX entries, pointing to the SMSEagle's IP. With this configured email sent to newly configured domain will reach the SMSEagle, and be properly processed by the plugin.
Page 63 SMS message to +48333444555 mobile number. SEND TO USERNAME/GROUP If you want to send SMS to a contact or group from SMSEagle phonebook, put the contact/group name in SUBJECT field. SEND TO LDAP CONTACTS/GROUPS If your company uses LDAP (Active Directory or OpenLDAP) for contacts management, you may use LDAP Contacts or Groups to send email to SMS text message.
Page 64 Screenshot from Email to SMS Poller > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
Page 65 How to setup Office365 for Oauth2? to get • values for Client ID, Tenant ID, Client Secret from Microsoft Azure Portal Enter the values Client ID, Tenant ID, Client Secret in plugin settings • | SMSEagle NXS-9700 | User’s Manual...
Page 66: Sms To Email Plugin
SMS to email of last sender (so called Two-way Email2SMS & SMS2Email) In this mode, when SMSEagle receives incoming SMS, it checks if earlier anyone was sending SMS to the number from incoming SMS using Emai2SMS. If last sender is found, the incoming SMS is forwarded to the email address of last sender.
Page 67 Screenshot from SMS to Email > Rules> Add or Edit rule In the rule definition you may choose to forward all incoming messages or just messages from specified senders/with specific text. | SMSEagle NXS-9700 | User’s Manual...
Page 68: Sms Forward
SMS (and phonebook contact name if found) • Date, time when SMS is received • SMS message • Example email text sent from plugin: From: +483334455 (John Doe) Received: 2017-06-01 14:38:12 Message: My SMS message SMS Forward | SMSEagle NXS-9700 | User’s Manual...
Page 69 • phone number or name of group from phonebook. User may define many forwarding rules in the plugin. • Each rule is processed independently. • There is a possibility to enable/disable each rule. • | SMSEagle NXS-9700 | User’s Manual...
Page 70: Callback Url Plugin (Webhooks)
If the plugin is enabled, each defined rule will trigger HTTP(S) request to a defined URL. HTTP(S) request can be of type GET or POST. PLUGIN CONFIGURATION Plugin “Callback URL” allows to add unlimited number of rules. Each rule can be enabled or disabled by user. | SMSEagle NXS-9700 | User’s Manual...
Page 71 ‘URL’ field defines remote address of your callback script • ‘Test URL’ button allows to test whether your Callback URL configuration is correct. SMSEagle will • make a callback request with test parameters and will verify the response of remote server ‘URL method’...
Page 72: Periodic Sms
After sending HTTP(S) GET/POST request to your callback URL, SMSEagle will be expecting HTTP response: 200 [OK]. If other or no response is received from your callback URL, SMSEagle will keep retrying every X minute for 24 hours. Retry interval can be set in main plugin Window: Periodic SMS The feature “Periodic SMS”...
Page 73: Autoreply Plugin
• Message type (SMS, USSD Code) • The content of the SMS text • The recipients (phone number(s) separated with comma or group(s) from phonebook) • Screenshot from “Add new rule” window Autoreply plugin | SMSEagle NXS-9700 | User’s Manual...
Page 74 If autoreply message text should be sent as Unicode characters Plugin also allows to deﬁne sending limit for autoreply messages. It is possible to set limita�on of max 5 messages / 10 minutes / phone number. | SMSEagle NXS-9700 | User’s Manual...
Page 75: Digital Input/Output
Screenshot form “Add/edit autoreply rule” Digital input/output The NXS- family of SMSEagle devices is equipped with digital inputs (DI) and digital outputs (DO). The digital inputs can be used to receive signals from outside sensors or devices and automatically trigger sending of SMS message based on input state.
Page 76 Digital Output - example of usage with external relay Digital USING DIGITAL INPUTS Digital inputs (DI) of SMSEagle device are of type “pull-up resistor”. This type of input is used to prevent accidental switching of digital circuits. In order to achieve it any unconnected inputs called “floating inputs”...
Page 77 Digital Input - most simple usage. Optional 500 Ohm resistor is needed when using long cables Digital Input - connection example with a device with open collector output | SMSEagle NXS-9700 | User’s Manual...
Page 78 DI/DO PLUGIN CONFIGURATION The plugin “Digital input/output” allows you to define rules that control the behaviour of digital inputs/outputs on SMSEagle device. User may define several processing rules for both inputs and outputs. Screenshot from plugin window | SMSEagle NXS-9700...
Page 79 State of output signal that will be triggered by incoming SMS message • Output signal duration in seconds (0 = without time limit) • Output signal delay before signal is set • Define outgoing SMS that will be sent after output signal is triggered • | SMSEagle NXS-9700 | User’s Manual...
Page 80: Temperature & Humidity Sensors
±0.5°C accuracy and humidity with ±2% RH accuracy. Additionally, NXS-97xx Rev.3 (and higher) devices also support external sensors via 1-Wire interface. A measured values from sensors can be displayed in web-gui of SMSEagle and used to trigger SMS message to single/many recipients.
Page 81 • Sensor (internal or external) • On what condition SMS alarm should be sent (temperature/humidity is higher/lower than given • value) SMS text • SMS recipient: contact name or group name from Phonebook • | SMSEagle NXS-9700 | User’s Manual...
Page 82 Celsius or Fahrenheit. Screenshot from “Settings” window READING TEMP/HUMIDITY VIA SNMP PROTOCOL Current temperature and humidity values from internal/external sensor can be also read via SNMP protocol. See chapter “SNMP agent” for detailed description. | SMSEagle NXS-9700 | User’s Manual...
Page 83: Ldap Plugin
SMSEagle device using directory services. PLUGIN CONFIGURATION Choose “LDAP” from left side menu in SMSEagle web-GUI to access plugin configuration. After enabling the plugin, user needs to fill in all requested fields according to AD settings.
Page 84 Screenshot from “LDAP settings” window Click “Save” and “Test connection” to make sure that SMSEagle is connected with AD server. Screenshot showing successful connection to AD server. | SMSEagle NXS-9700 | User’s Manual...
Page 85 • name in SMSEagle webGUI > LDAP > "Admin group name in LDAP" create in your directory services a new group for SMSEagle user role. Enter the created group name • in SMSEagle webGUI > LDAP > "User group name in LDAP"...
Page 86: Blacklist
• userPrincipalName • During first login using LDAP authentication type, the system will create a new user on SMSEagle device, linked to the LDAP account. This account settings will be synchronized with LDAP during every login. Blacklist This feature allows you to add a number to a Blacklist. When a number is on this list, the device automatically blocks any sent and received SMS from the number as well as deletes the messages from your inbox.
Page 87 You may add a defined a STOP keyword. When incoming message contains the keyword then the • sender number will be automatically added to exclude-list. Screenshot from Blacklist > Add number to blacklist In “Add number to blacklist” window: | SMSEagle NXS-9700 | User’s Manual...
Page 88: Subscriptions (Newsletter)
This feature allows to enable newsletter-style subscriptions via SMS. When someone sends a message to your SMSEagle which includes a defined text, the sending number will be automatically added to a Phonebook group. This group can be later used to send messages via web-GUI/API/Email To SMS.
Page 89 When a phone number is added to SMSEagle Phonebook via this feature, first a phonebook contact is created with a name: [RULE NAME] [PHONE NUMBER]. For example: “Alert Sub +48123456789“. Then the contact is added to a defined Phonebook group.
Page 90: Smseagle Api
API. API Access Before you can use SMSEagle API you must enable API access in web-GUI (menu Users). Below you can find the description how to enable API on your device. Screenshot from menu “Users” with marked “Access to API” link.
Page 91: Plugins And Integration Manuals For Nms & Auth Systems
“Access to resources of all users” in Access to API window. PLUGINS AND INTEGRATION MANUALS FOR NMS & AUTH SYSTEMS SMSEagle has a number of ready-to-use plugins and integration manuals for an easy and quick integration of SMSEagle device with external software (Network Monitoring Systems, Authentication Systems and other).
Page 92 The list grows constantly and is published on SMSEagle website. For a complete and up to date list of plugins please go to: https://www.smseagle.eu/integration-plugins/ | SMSEagle NXS-9700 | User’s Manual...
Page 93: Extras
EXTRAS Delivery Reports SMSEagle software allows you to enable delivery reports for each sent SMS. Delivery reports is afeature that allows to receive a confirmation that SMS was received on recipients phone. In order to enable delivery reports, please go to web-GUI > menu Settings and set “Delivery Reports” to “Yes”...
Page 94: Injecting Short Sms Using Sql
Once database access isenabled, it is possible to connect to the database from external application using the following credentials: OSTGRE DATABASE CREDENTIALS Host: IP address of your device Database name: smseagle User: smseagleuser Password: postgreeagle Injecting short SMS using SQL The simplest example is short text message (limited to 160 chars):...
Page 95: Injecting Long Sms Using Sql
Ut enim ad minim veniam, qui', 'Default_No_Compression', 'smseagle1' INSERT INTO outbox_multipart ( "ID", "SequencePosition", "UDH", "TextDecoded", "Coding", "Class" ) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), '050003D30202', 's nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', | SMSEagle NXS-9700 | User’s Manual...
Page 96 'Default_No_Compression', INSERT INTO user_outbox ( id_outbox, id_user ) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), Note: Adding UDH means that you have less space for text, in above example you can use only 153 characters in single message. | SMSEagle NXS-9700 | User’s Manual...
Page 97: Database Cleaning Scripts
1) Create a file inside /etc/cron.d/ directory with your desired name (eg. pico db_cleaner) 2) Example content of this file: 0 0 1 * * root /mnt/nand-user/scripts/db_delete_allfolders This will run cleaning script every 1 day of month. | SMSEagle NXS-9700 | User’s Manual...
Page 98: Snmp Agent
It is used mostly in network management systems to monitor network-attached devices for conditions that warrant administrative attention” (source: Wikipedia). SMSEagle device has a built-in Net-SNMP agent. The SNMP agent provides access to Linux Host MIB tree of the device, and additionally (using extension NET-SNMP-EXTEND-MIB) allows access to custom metrics specific to SMSEagle.
Page 99 (for example: NET-SNMP library for Linux or iReasoning MiB-Browser for Windows). EXAMPLE OF READING GSM_SIGNAL VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public localhost .1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71.83.77.95.83.105.103.110.97.108.49 Result: | SMSEagle NXS-9700 | User’s Manual...
Page 100 DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (216622) 0:36:06.22 Comment: Linux system is up for 36 hours, 6.22 minutes EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpwalk -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.8072.1.3.2.3.1.2 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal"...
Page 101: Setting Up Snmp V3 Access Control
EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING MIB-BROWSER Setting up SNMP v3 access control By default, SMSEagle devices uses SNMP v2 access control. Using v3 can strengthen security, however is not mandatory. To easily switch to SNMP v3 access control we’ve prepared special shell script located at /mnt/nand-user/smseagle directory.
Page 102 ./snmpv3 del 7. To disable v2 access policy run: ./snmpv3 disablev2 8. To enable v2 access policy run: ./snmpv3 enablev2 | SMSEagle NXS-9700 | User’s Manual...
Page 103: Forwarding Logs To External Server
PORT – port on receiving server PROTOCOL one of the values: tcp, udp Example: • *.* action(type="omfwd" target="192.168.0.250" port="10514" protocol="tcp" action.resumeRetryCount="10" queue.type="linkedList" queue.size="10000") • SSL-encryption of your log traffic: please have a look at this article: https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html | SMSEagle NXS-9700 | User’s Manual...
Page 104: Automatic Software Updates Check
(if the phone number is entered in the account) with a notification about new software update. Screenshot from “General settings-Maintenance” Notice: Your SMSEagle device must have a HTTPS connectivity with address www.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700...
Page 105: Knowledgebase & Support Portal
Knowledgebase & Support Portal More information and useful hints about SMSEagle device configuration can be found in our online knowledgebase and support portal at: https://support.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
Page 106 I I I TROUBLESHOOTING | SMSEagle NXS-9700 | User’s Manual...
Page 107: Troubleshooting
In case of any problems with the device these logs are a valuable source of troubleshooting information. Extended device logs can be downloaded via button “Download device logs” in menu “Settings” > “Sysinfo”. | SMSEagle NXS-9700 | User’s Manual...
Page 108: When The Device Is Not Reachable
Restore service is counting button for 10 seconds down. System is reading factory 3. Release SW button defaults. after 10 seconds. User LED will begin to Factory settings are being blink. applied to the device. | SMSEagle NXS-9700 | User’s Manual...
Page 109 System is going for a reboot. reboots. Default settings are restored. Please note, that after reboot the device will be finishing the process of factory reset, therefore it can take longer for the system to start. | SMSEagle NXS-9700 | User’s Manual...
Page 110 SERVICE & REPAIR | SMSEagle NXS-9700 | User’s Manual...
Page 111: Service & Repair
Go to menu Settings > Sysinfo > “Download device logs”. Provide log package to support team when requested. MAC address Each SMSEagle device has its unique MAC address. MAC address is printed on the device body or can be found in menu Settings > IP Settings | SMSEagle NXS-9700...
Page 112 TECH SPECS & SAFETY INFORMATION | SMSEagle NXS-9700 | User’s Manual...
Page 113: Tech Specs & Safety Information
RTC Clock: RTC 240B SRAM, Watchdog timer • Internal humidity & temperature sensor: Accuracy ± 0,5 °C, ±2 %RH • Power consumption: • hardware Rev.4: max 25W hardware Rev.3-Rev.1: max 12W Noise level: Fan-less • | SMSEagle NXS-9700 | User’s Manual...
Page 114 • Operating temperature: 0 ~ 40°C Humidity: 8 ~ 90% RH (no condensation) Internal modem • Device type NXS-9700-5G Rev.4: Wavebands: 5G NR, LTE, UMTS. 5G NR 3GPP Release 15 NSA/SA operation, Sub-6 GHz 5G NR NSA/SA: n1/n2/n3/n5/n7/n8/n12/n20/n25/n28/n38/n40/n41/ /n66/n71/n77/n78/n79 LTE DL Cat 16/ UL Cat 18...
Page 115 EDGE 900: Class E2, EDGE 1800: Class E2  FDD I: Class 3, FDD VIII: Class 3  SIM card standard: mini • Antenna connector: SMA • Country of origin: European Union (Poland) • POWER SUPPLY hardware Rev.4: • | SMSEagle NXS-9700 | User’s Manual...
Page 116 Voltage ranges: 100–240V alternating current (AC)  Frequency: 50–60Hz single phase  DC plug type: 5.5/2.5  ANTENNA Device type NXS-9700-5G: • 2x Omnidirectional MIMO 2,5dBi antenna with magnetic/adhesive foot Waveband: UMTS, LTE, 5GNR Cable length 2m Plug type: SMA Impedance: 50 Ohm Device type NXS-9700-4G: •...
Page 117 • built-in PostgreSQL database server • built-in Postfix email server • built-in SNMP agent • built-in NTP-client • built-in Failover (HA-cluster) service • watchdog mechanism for 3G/4G/5G modem • modern responsive web interface • | SMSEagle NXS-9700 | User’s Manual...
Page 118: Important Safety Information
SAR regulation. DISCLAIMER: The manufacturer is not responsible for any damages caused by inappropriate installation, not maintaining the proper technical condition or using a product against its destination. | SMSEagle NXS-9700 | User’s Manual...
Page 119: Regulatory Statements
REGULATORY STATEMENTS EU Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G, NXS-9700-5G is in compliance with Directive 2014/53/EU. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
Page 120: Fcc Supplier's Declaration Of Conformity
Proximus Sp. z o.o. ul. Piatkowska 163 60-650 Poznan, Poland The product NXS-9700-4G, NXS-9700-5G complies with the applicable requirements of FCC Rule Part 15B for the corresponding equipment classes of Unintentional Radiators. RESPONSIBLE PARTY located in the United States: Testing Partners LLC...
Page 121: Avis De Conformité A ̀ La Réglementation D'industrie Canada
CAN ICES-3 (B)/NMB-3(B) UK Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G, NXS-9700-5G is in compliance with The Radio Equipment Regulations 2017. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
Page 122: Information Gemäß § 4 Absatz 4 Elektrogesetz (De)
Restriction of Hazardous Substances Directive (RoHS) European Union RoHS SMSEagle devices sold in the European Union, on or after 3 January 2013 meet the requirements of Directive 2015/863 on the restriction of the use of certain hazardous substances in electrical and electronic equipment (“RoHS 3”).
Page 123 Proximus Sp. z o.o. Ul. Piątkowska 163, 60-650 Poznań, Poland l Europe T +48 61 6713 413 E hello@smseagle.eu www.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...

This manual is also suitable for:

Nxs-9700-4g Nxs-9700-3g

SMSEagle NXS-9700-5G User Manual

Quick Links

Need help?

Questions and answers

Related Manuals for SMSEagle NXS-9700-5G

Summary of Contents for SMSEagle NXS-9700-5G

This manual is also suitable for:

Table of Contents