Sierra Wireless ES450 AirLink gateway User Guide
Annonce
Annonce
ALEOS 4.5.1
Software Configuration
User Guide for AirLink ES450
4118127
Rev 2
Important
Notice
Limitation of
Liability
Patents
Copyright
Trademarks
Preface
Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be totally lost. Although significant delays or losses of data are rare when wireless devices such as the Sierra Wireless modem are used in a normal manner with a well-constructed network, the Sierra Wireless modem should not be used in situations where failure to transmit or receive data could result in damage of any kind to the user or any other party, including but not limited to personal injury, death, or loss of property. Sierra Wireless accepts no responsibility for damages of any kind resulting from delays or errors in data transmitted or received using the Sierra Wireless modem, or for failure of the Sierra Wireless modem to transmit or receive such data.
The information in this manual is subject to change without notice and does not represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND
ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL
DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL,
PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO,
LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE
ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS
PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE
FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.
Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its affiliates aggregate liability arising under or in connection with the Sierra Wireless product, regardless of the number of events, occurrences, or claims giving rise to liability, be in excess of the price paid by the purchaser for the Sierra Wireless product.
This product may contain technology developed by or for Sierra Wireless Inc. This product includes technology licensed from QUALCOMM
®
. This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents licensed from InterDigital Group and MMP Portfolio Licensing.
© 2015 Sierra Wireless. All rights reserved.
Sierra Wireless
®
, AirPrime
®
, AirLink
®
, and the Sierra Wireless logo are registered trademarks of Sierra Wireless.
Windows
®
and Windows Vista
®
are registered trademarks of Microsoft
Corporation.
Macintosh
®
and Mac OS X
®
are registered trademarks of Apple Inc., registered in the U.S. and other countries.
QUALCOMM
®
is a registered trademark of QUALCOMM Incorporated. Used under license.
Other trademarks are the property of their respective owners.
Rev 2 Nov.15
3
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Contact
Information
International Contact Information
Contact Email or Web Site
Sales:
Sierra Wireless AirLink Sales
[email protected]
Technical support:
Contact your authorized AirLink reseller.
Additional support resources, such as technical documentation and software downloads are available at: http://source.sierrawireless.com
Company information:
New products, press releases, and more
www.sierrawireless.com
Sierra Wireless Headquarters Contact Information
Postal Address: Sierra Wireless
13811 Wireless Way
Richmond, BC
Canada V6V 3A4 www.sierrawireless.com
4 4118127
Contents
Tools and Reference Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configuring your AirLink Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Saving a Custom Configuration as a Template . . . . . . . . . . . . . . . . . . . . . . 17
Sierra Wireless Example Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Update the ALEOS Software and Radio Module Firmware . . . . . . . . . . . . . 32
Step 1—Planning Your Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Step 2—Update the ALEOS Software and Radio Module Firmware . . . . 34
Updating Only the Radio Module Firmware . . . . . . . . . . . . . . . . . . . . . . . 39
Enterprise LAN Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Configuring Your Gateway for use in a PCI Compliant System . . . . . . . . . . 41
Rev 2 Nov.15
5
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
6
Dynamic Mobile Network Routing (DMNR) . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configure the AirLink gateway to Support PPPoE . . . . . . . . . . . . . . . . 108
Configuring a PPPoE Connection in Windows 7 . . . . . . . . . . . . . . . . . . 109
4118127
Contents
Trusted IPs—Inbound (Friends) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
ALMS (AirLink Management Service) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Understanding Domain Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Sending SMS Commands to an AirLink Gateway . . . . . . . . . . . . . . . . . 160
Rev 2 Nov.15
7
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
8
Inbound SMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Trusted Phone Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
SMS Password Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
SMS > Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
RADIUS Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
TACACS+ Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Configuring Events Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Configuring Events Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Reverse Telnet/SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
4118127
Contents
Configuring IP to Serial with Answer and Serial to IP . . . . . . . . . . . . . . . . 221
ALEOS Application Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Windows Dial-up Networking (DUN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Creating a Dial-Up Networking (PPP) Connection . . . . . . . . . . . . . . . . . . . 269
SNMP: Simple Network Management Protocol. . . . . . . . . . . . . . . . . . . . . . 279
Management Information Base (MIB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Rev 2 Nov.15
9
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
AT Command Set Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Standard (Hayes) commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
SMS Command format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
10 4118127
Contents
ACEmanager Web UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Updating the ALEOS Software and Radio Module Firmware . . . . . . . . 360
Poor Wireless Network Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Connection not working . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Remote connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Radio Band Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Reliable Static Routing (RSR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Inbound Ports Used by ALEOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
AirLink Management Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
TCP/IP and UDP/IP Auto Answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
ALEOS Application Framework (AAF) . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Network Operator Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Rev 2 Nov.15
11
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
12 4118127
1: Introduction
Note: This user guide is intended for the AirLink ES450. If you have an
AirLink GX450 gateway, refer to the ALEOS Software Configuration User
Guide for the AirLInk GX450.
Overview
ACEmanager™ is the free, web-based utility used to manage and configure the AirLink
®
device. It is a web application integrated in the
ALEOS™ software that runs on the AirLink gateway. AirLink
Embedded Operating System (ALEOS) is purpose-built to maintain a wireless connection and to configure the gateway to the needs of the system. ACEmanager provides comprehensive configuration, monitoring, and control functionality to all AirLink gateways and routers.
ACEmanager enables you to:
•
Login and configure device parameters
•
Adjust network settings
•
Change security settings
•
Update events reporting and control outputs
•
Update ALEOS software and radio module firmware
•
Copy configuration settings to other AirLink gateways
Since ACEmanager can be accessed remotely over-the-air as well as locally, the many features of ALEOS can be managed from any location.
An ALEOS configuration template can be created using
ACEmanager, after a single device is configured and installed, to program other AirLink gateways with the same configuration values.
This enables quick, accurate deployment of large pools of devices.
Sierra Wireless AirLink Products
This version of ACEmanager is intended to be used with the following products:
•
AirLink GX450
•
AirLink ES450
For more information on specific AirLink products, go to www.sierrawireless.com
1
Rev 2 Nov.15
13
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
About Documentation
Each chapter in the ALEOS Configuration User Guide describes a section (a tab in the user interface) of ACEmanager.
Chapters in this user guide explain:
•
Parameter descriptions in ACEmanager
•
Relevant configuration details
•
User scenarios for certain sections in the guide.
Tools and Reference Documents
Document Description
AirLink gateway
Hardware User Guide
ALMS User Guide
This hardware document describes how to:
•
Install the AirLink gateway hardware
•
Connect the radio antennas
•
Connect a notebook computer and other input/output (I/O) devices
•
Interpret the LEDs and indicators on the AirLink gateway.
This document explains how to use AirLink Management Service for the remote management of Sierra Wireless AirLink gateways.
14 4118127
2: Gateway Configuration
To access ACEmanager:
1.
Insert the SIM card, if applicable. Refer to the AirLink gateway hardware user guide for details.
2.
Power on the AirLink gateway.
3.
Launch your browser and enter the IP address and port number http://192.168.13.31:9191
ACEmanager is supported on the latest versions of Internet
Explorer
®
and Firefox
®
.
4.
Log in:
· User Name: “user” (entered by default) or “viewer
Use the “user” login for configuring or monitoring your gateway.
Logging in as “viewer” only allows you to view the configuration and connection state. You cannot make any configuration changes.
· Default Password: 12345
Note: ACEmanager has a default session idle timeout of 15 minutes. If there is no activity for the idle timeout period, you are redirected to the login
screen. To change the session idle timeout period, see Session Idle Timeout
To prevent others from changing the AirLink gateway settings, you
can change the ACEmanager password (see Change Password on page 241).
2
Rev 2 Nov.15
Figure 2-1: ACEmanager: Main Login screen
After your initial login to ACEmanager, you have the option of displaying the gateway status parameters on subsequent login screens.
5.
In ACEmanager, go to Services > Device Status Screen.
6.
In the Device Status on Login Screen field, select Enable. (For details, see
Device Status Screen on page 195.)
15
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 2-2: ACEmanager: Main Login screen with Device Status
Toolbar
The buttons on the ACEmanager toolbar are:
•
Software and Firmware: Updates the ALEOS software and the radio module firmware
•
Template:
· Download and save a configuration as a template
· Upload a saved template to apply settings
•
Reboot: Reboots the gateway
•
Refresh All: Refreshes all ACEmanager pages
Configuring your AirLink Gateway
There are three options for configuring the AirLink gateway:
•
Use your browser-based ACEmanager (as detailed in this guide); or
•
Use a terminal emulator application (e.g., Tera Term, PuTTY, etc.) to enter AT commands for many of the configuration options.
•
Use the cloud-based AirLink Management Service application (see www.sierrawireless.com/products-and-solutions/gateway-solutions/alms/ for more details.)
16 4118127
Gateway Configuration
Saving a Custom Configuration as a
Template
If you have a gateway configured to match your requirements, you can use
ACEmanager to download and save that gateway’s configuration as a template and then apply it to other Sierra Wireless AirLink gateways.
Note: Sierra Wireless recommends that templates be created and applied to AirLink gateways running the same version of ALEOS. If you apply a template created using an older version of ALEOS to a gateway running a newer version of ALEOS, settings for newly added features are not updated.
To download and save a custom configuration as a template:
1.
Connect a laptop to the gateway with the configuration you want to save as a template.
2.
In ACEmanager, click the Template button on the toolbar
.
Figure 2-3: ACEmanager: Template button
The following window appears:
Rev 2 Nov.15
Figure 2-4: ACEmanager: Template window
Use the bottom half of the window to download and save a template.
3.
If desired, enter a Template Name. The file is saved using this name and a.xml file extension. Spaces and special characters are not supported, and if entered, are deleted from the file name.
If no Template name is entered, the file is saved as SWIApplyTemplate.xml.
4.
Choose whether or not to:
· Include Passwords
When Include Passwords is selected, passwords configured in ACEma-
17
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450 nager (such as the email password, the SMS ALEOS Command password, the Serial PPP password, etc.) are shown in plain text in the template file.
When the template is uploaded to a gateway, the passwords are included and replace any existing password configured on the gateway.
If Include Passwords is not selected, password fields are not included in the template file, and existing passwords persist when the template is uploaded to a gateway.
Note: The ACEmanager login password is not included when you select the Include
Passwords option.
· Include Device Info (selected by default)
When selected, the template file includes a “snap-shot” of the current
Status tab information with the current settings. This could be useful for troubleshooting.
5.
Click Download. The download status appears at the bottom of the window.
Figure 2-5: Download template complete
Once the download is complete, the following window opens:
18
Figure 2-6: Open or Save the template file
6.
In most cases, you will want to save the file to your computer for uploading to other AirLink gateways, but you also have the option to open the file.
4118127
Rev 2 Nov.15
Gateway Configuration
· Select Save File and click OK—file is saved to your computer (by default to the Downloads folder). If you entered a template name, the file is saved using that name. Otherwise, it is saved under the default name,
SWIApplyTemplate.xml.
· Select Open and click OK—file opens in a text or XML editor as a human readable file. Use this option if you selected Include Device Info when you saved the file and want to view the device information (the text between the
<devicestatus> and </devicestatus> tags is the snap-shot of the Device
Info), or you want to compare this template with another template.
Warning:
Do not attempt to change settings directly in the template file. Changing settings in the template file could result in unexpected behavior in the AirLink gateway.
Alter the template only if you are specifically directed to do so by your distributor or Sierra
Wireless Technical Support.
Tip:
If you want to compare a new template with the previous one, download and save the old template before applying the new one. You can use any 3rd party text comparison tool to check the differences between two templates.
Applying a Template
Note: If you are using Internet Explorer 9 to upload the template, see
To upload and apply a template to an AirLink gateway:
1.
Connect the computer (where the template is saved) to the AirLink gateway you want to upload the template to.
2.
In ACEmanager, click the Template button on the toolbar
.
Figure 2-7: ACEmanager: Template button
19
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
The following window appears:
Figure 2-8: ACEmanager: Template window
Use the top half of the window to upload and apply a template to your AirLink gateway.
3.
Click Browse... and navigate to the template you want to upload.
4.
Click Open. The template file name appears beside the Browse... button.
Figure 2-9: Apply Template file opened
5.
Click Upload.
6.
When the upload is complete, a Reboot button appears on the window.
20 4118127
Gateway Configuration
Figure 2-10: Template file uploaded
7.
Click Reboot.
8.
To confirm that the new template has been applied or to find out which template is currently on a gateway, go to Status > About and check the
Template Name field.
Note: The Template Name field shows the last template applied and does not indicate any configuration changes made since the last template was applied.
Rev 2 Nov.15
Figure 2-11: ACEmanager: Status > About
Note: If no template has been applied to the gateway since it was set or reset to the factory default settings, the template field is blank.
21
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Sierra Wireless Example Templates
To speed up the process of creating templates and deploying gateways:
•
Use the following illustrations as a guide for your initial configuration
· Reliable Static Route
Figure 2-12: Reliable Static Route example template configuration
22 4118127
· Reverse Telnet
Gateway Configuration
Figure 2-13: Reverse Telnet example configuration: Serial > Port Configuration
Rev 2 Nov.15
Figure 2-14: Reverse Telnet example configuration: Services > Telnet/SSH
23
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
•
Use the following example templates supplied by Sierra Wireless. The templates contain basic example configurations for the specific features. You will need to make some changes.
Table 2-1: Example Templates
Feature Template file
Reverse Telnet
Reverse_Telnet_Template.xml
Reliable Static Routing (RSR)
RSR_Template.xml
To use these templates:
1.
Either:
•
With this user guide PDF open in Adobe Reader:
a.
Click the Attachments icon on the left side of the screen. ( ).
b. Right-click the desired template file, select Save Attachment, and save it as a .xml file.
24
•
Copy the text below for the desired feature into a text editing application such as Microsoft Word and save it as a .xml file.
Reverse Telnet
<template>
<item title="Remote Login Server Mode" value="0" msciid="3029" />
<item title="Default Telnet User" value="None" msciid="3035" />
<item title="Remote Login Server Telnet/SSH Port" value="2332"
msciid="1034" />
<item title="Remote Login Server Telnet/SSH Port Timeout (minutes)"
value="255" msciid="1035" />
<item title="Maximum Login Attempts" value="6" msciid="3034" />
<item title="Telnet/SSH Echo" value="1" msciid="1127" />
<item title="Startup Mode Default" value="08" msciid="1043" />
<item title="Autologin Reverse Telnet" value="1" msciid="10293" />
<item title="Configure Serial Port" value="9600,8N1" msciid="1159" />
<item title="Flow Control" value="0" msciid="1160" />
<item title="DB9 Serial Echo" value="1" msciid="1125" />
<item title="Data Forwarding Timeout (.1 second)" value="1"
msciid="1046" />
<item title="Data Forwarding Character" value="0" msciid="1047" />
<item title="Device Port" value="12345" msciid="1081" />
<item title="Destination Port" value="0" msciid="1045" />
<item title="Destination Address" value="0.0.0.0" msciid="1044" />
<item title="Default Dial Mode" value="P" msciid="1201" />
<item title="Host Authentication Mode" value="0" msciid="10243" />
<item title="PPP User ID" value="" msciid="10244" />
4118127
Rev 2 Nov.15
Gateway Configuration
<item title="PPP Password" value="" msciid="10245" />
<item title="Assert DSR" value="0" msciid="1089" />
<item title="Assert DCD" value="1" msciid="1090" />
<item title="Use CTS" value="0" msciid="1079" />
<item title="DTR Mode" value="0" msciid="1165" />
<item title="Quiet Mode" value="0" msciid="1028" />
<item title="AT Verbose Mode" value="1" msciid="1027" />
<item title="Call Progress Result Mode" value="0" msciid="1033" />
<item title="Convert 12 digit Number to IP Address" value="0"
msciid="1100" />
<item title="Disable ATZ Reset" value="0" msciid="1031" />
<item title="IP List Dial" value="0" msciid="1799" />
<item title="Keep Alive Mode" value="0" msciid="10295" />
<item title="Keep Alive delay" value="10" msciid="10296" />
<item title="TCP Auto Answer" value="1" msciid="1048" />
</template>
Reliable Static Routing (RSR)
<template>
<item title="Reliable Static Routing" value="0" msciid="51000" />
<item title="Primary Interface" value="0" msciid="51001" />
<item title="Backup Interface" value="5" msciid="51002" />
<item title="Destination IP/Network" value="183.1.1.1"
msciid="51003" />
<item title="Destination Subnet Mask" value="255.255.255.255"
msciid="51004" />
<item msciid="51005" title="Tracking Object" value="1" />
<item title="Tracking Object" value="0" msciid="52000" />
<item title="Test IP Address" value="192.168.13.101"
msciid="52001" />
<item title="Test Interface" value="0" msciid="52003" />
<item title="Test Interval (seconds)" value="200" msciid="52004" />
<item title="Test Timeout (seconds)" value="10" msciid="52005" />
<item title="Maximum number of Test Retries" value="4"
msciid="52006" />
</template>
Follow the instructions in
Applying a Template on page 19 to apply the .xml file
from step 1 as a template to one AirLink gateway.
2.
For information on making any additional changes to these features, see:
·
Reverse Telnet/SSH on page 210
·
Reliable Static Routing (RSR) on page 77
3.
Save the revised template, as described in Saving a Custom Configuration as a Template on page 17.
4.
Apply the revised template to other AirLink gateways.
25
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
SSH PAD Mode
SSH PAD mode allows a PAD mode TCP connection to be encrypted using an
SSH tunnel and a serial connection to the router or other connected device.
PAD server
12345
SSHD
22
Network
SSH client
(PuTTY)
Port: 12345 client localhost
74.198.207.51
AirLink gateway (server)
Serial connection to the AirLink gateway
Router or other connected device
Figure 2-15: SSH Network
208.81.123.30
Client
Note: For the purpose of illustration, this user guide uses port 12345 on the client, the default port 22 for creating an SSH section, and PuTTY as the SSH client throughout.
When configuring SSH PAD mode, you can use any SSH client and values that are appropriate for your network.
The main steps in establishing a secure connection are:
1.
Configure an SSH tunnel (on port 12345 in this example) on the client using an SSH client such as PuTTY.
2.
Using the SSH client configuration to create the tunnel, log into the AirLink gateway with the user name and password. The SSH server authenticates the user.
3.
The client application that wants to communicate with the PAD server on the
AirLink gateway connects to “localhost” on port 12345.
4.
Any data sent on this connection is tagged with a destination port of 12345.
5.
The data is received by the SSH server on the AirLink gateway.
6.
The SSH server receives the data with the tag of 12345 and uses port forwarding to send the data to the PAD server.
26 4118127
Gateway Configuration
Server Configuration
You can enable SSH PAD mode on ALEOS by using functionality in the Secure
Shell Daemon (SSHD) and by making some changes to the ACEmanager configuration. Currently, tunneled connections can only be initiated by a client that connects to the server on ALEOS.
Enabling SSH
The SSH Daemon must be running on the AirLink gateway. To enable it:
1.
In ACEmanager, go to Services > Telnet/SSH, and in the Remote Login
Server Mode drop-down menu, select SSH.
2.
In the Remote Login Server Telnet/SSH Port field, enter the desired port number (or use the default SSH port 22).
Rev 2 Nov.15
Figure 2-16: ACEmanager: Services > Telnet/SSH
3.
Click Apply.
Enabling PAD Mode
ALEOS uses PAD mode to accept TCP connections. To enable PAD mode:
1.
In ACEmanager, go to Serial > Port Configuration.
2.
Set DB9 Serial Echo to Disable.
3.
Set the Device Port field to the desired value (12345 in this example).
4.
Set the destination Address to the IP address of the client that will be connecting to the AirLink gateway in SSH PAD mode.
5.
Under Advanced, set Quiet Mode to Enable.
6.
Under TCP, set TCP Auto Answer to Enable.
27
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
28
Figure 2-17: ACEmanager: Serial > Port Configuration
7.
Click Apply.
4118127
Gateway Configuration
Client Configuration
Creating Client Tunnel
Configure the SSH client to create a tunnel when it connects to the AirLink gateway. (In this example, PuTTY is used to create the tunnel.)
1.
Create a new SSH session by entering the IP address of the AirLink gateway, and the configured port. (In this example, the IP Address of the AirLink gateway is 74.198.207.51 and default port 22 is used.)
Rev 2 Nov.15
Figure 2-18: PuTTY: Creating a new SSH session
2.
Click Save.
3.
Go to Connection > SSH > Tunnels.
4.
Create an SSH tunnel for the connection by creating a forwarded port.
In the Source port field, enter the same value as the Device Port field configured in ACEmanager Serial port configuration (12345 in this example). This is the port that the PAD session listens on for incoming connections.
In the Destination address field, enter the IP address of the AirLink gateway.
(You can find this in ACEmanager on the Status > Home page.) The port is also listening to the TCP port for PAD mode (Device Port on the Serial tab) which, in this example, is 12345.
29
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 2-19: PuTTY: Creating an SSH tunnel
5.
Leave the Local and Auto settings selected.
30
Figure 2-20: PuTTY: SSH tunnel created
6.
Click Add.
7.
Go to Connection > SSH.
4118127
Gateway Configuration
8.
Under Protocol options, select “Don’t start a shell or command at all” to prevent getting a command prompt.
Rev 2 Nov.15
Figure 2-21: PuTTY: SSH Connection Settings
9.
Click Open to create a connection to the AirLink gateway. Log in with the user account.
10. With the client application, establish a TCP connection to localhost using the configured port. (In this example, 12345.)
Important:
If you connect to the IP address of the AirLink gateway (74.198.207.51) instead of localhost, the tunnel is bypassed and the data is unencrypted.
All data transmitted to the AirLink gateway should now be encrypted.
31
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Update the ALEOS Software and Radio
Module Firmware
To take advantage of new features available in the latest version of ALEOS, update the ALEOS software and radio module firmware on your AirLink gateways.
You can use ACEmanager to update one gateway at a time or AirLink
Management Service (ALMS) to update one or multiple gateways at the same time.
Note: These instructions are for updating from ALEOS 4.3.6 or newer. If you are updating from an older version of ALEOS, refer tot he Application Note: Updating from Older
Versions of ALEOS available at source.sierrawireless.com
.
Note: If the update includes a radio module firmware update, the radio module firmware stored on the gateway is also automatically updated. If there is not enough room in the storage, the radio module firmware update fails, so you may need to remove one of the
versions stored on the gateway to free up space. For more information, see Radio Module
Step 1—Planning Your Update
1.
Sierra Wireless recommends that you download a template from the gateway(s) before you begin the update process. For instructions, see
Saving a Custom Configuration as a Template on page 17.
2.
For each of the gateways you want to update, make a note of the:
· Device Model
· Radio Module Type
· Radio Module Identifier
· ALEOS Software Version
This information is available in ALMS and in ACEmanager (Status > About).
32 4118127
Gateway Configuration
Rev 2 Nov.15
Figure 2-22: ACEmanager: Status > About
3.
If you are planning to use ACEmanager to do the update:
a.
Go to source.sierrawireless.com
and select your product and mobile network operator to get to the download page for your gateway.
b. Download the new ALEOS software version for your system. If new radio module firmware is available, it is included with the ALEOS software in a
.zip file.
Important:
Do not install radio module firmware unless you are prompted to do so.
Note: If time of day reset ( page 244
) are configured, and the following events are likely to coincide with the update:
•
The Time of Day reset occurring
Sierra Wireless recommends that you disable these features before beginning the update.
Recommendations
If you have any questions about the update process, contact your authorized
Sierra Wireless distributor before updating the radio module firmware.
Scheduling the update
The update can take up to 30 minutes to complete, depending on the speed of your network connection. The AirLink gateway being updated will be off-line during the update, so take this into account when scheduling the update.
Important:
BE PATIENT! The firmware update can take up to 30 minutes to complete.
Ignore connection time out messages—the update process is still running.
33
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Waiting for the process to complete is faster than troubleshooting the problems that can be caused by interrupting the process midway. (Interrupting the process may result in having to return the gateway to the factory for repairs.)
Step 2—Update the ALEOS Software and Radio
Module Firmware
Using ACEmanager to Update a Single AirLink gateway
To update the ALEOS software and radio module firmware on one AirLink gateway:
1.
Connect the AirLink gateway you want to update to your laptop, launch your browser and enter the URL for the gateway. The default IP address/port for the Ethernet interface is http://192.168.13.31:9191 . If it is a remote gateway, enter the domain name or public IP (WAN) address.
Note: If you are connected to the gateway remotely, any files transferred to the gateway are transferred over-the-air and you may incur data charges.
2.
Log in to ACEmanager.
User name: user
Default password: 12345
3.
If you haven’t already done so, go to Status > About and confirm that the current version of ALEOS is 4.3.6 or newer. If not, see the note of
4.
Click the Software and Firmware link.
The Software and Firmware update window opens.
Note: These instructions show typical Software and Firmware update windows. Details such as the ALEOS version, device model, radio firmware version, etc. may vary, depending on the gateway you are updating.
34 4118127
Gateway Configuration
Rev 2 Nov.15
Figure 2-23: Software and Firmware update window
The update window gives you the option to update both ALEOS and the radio module firmware, or update only the radio module firmware.
Unless advised otherwise by Sierra Wireless, select ALEOS software (which updates ALEOS and prompts you to update the radio module firmware if a newer version is available for your gateway).
5.
Click Browse... and navigate to the ALEOS software you downloaded from the Sierra Wireless Web site.
35
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
36
Figure 2-24: ALEOS file selected in Software and Firmware update window
6.
Click Update.
The ALEOS software update runs automatically and green check marks appear beside each step as it is completed.
4118127
Gateway Configuration
Figure 2-25: ALEOS software update in progress
Important:
Do not disconnect the AirLink gateway from the computer, and do not power cycle or reset the gateway during the update. If you see any error messages, refer to the
Updating the ALEOS Software and Radio Module Firmware on page 360.
7.
Depending on the gateway and your Mobile Network Operator, you may be prompted to update the radio module firmware.
If you do not receive a prompt, the radio firmware is up to date. Proceed to
Only if prompted to update the firmware, proceed to step 8.
Rev 2 Nov.15
Figure 2-26: Prompt for Radio Module Firmware
8.
Under Applying, click Browse... and navigate to the radio module firmware file that was included in the .zip file you downloaded.
9.
Click Open.
The firmware file name appears beside the Browse button.
10. Click Upload Radio Firmware.
37
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
A message appears on the window indicating that the firmware has been successfully uploaded.
Note: Sierra Wireless recommends that you do NOT skip the radio module firmware update unless advised to do so by Sierra Wireless or an authorized distributor. If you choose to skip the radio module firmware update, you’ll see the following warning.
38
Once the radio module firmware is uploaded, it begins applying the firmware upgrade. On the AirLink gateway, the LED chase begins to indicate that the firmware is being applied.
As indicated on the window, the radio module firmware may take 10 to 20 minutes to upload and install.
Important:
Do not disconnect the AirLink gateway from the computer or reboot the gateway while the firmware update is in progress. During the radio module firmware update, the gateway LEDs flash rapidly in sequence (an LED chase or caterpillar). When the radio module firmware update is complete, the gateway reboots automatically.
Note: When you update the radio module firmware, the firmware stored on the gateway is also updated. If there is not enough room in the storage, the radio module firmware update fails. In that case, first remove one of the versions stored on the gateway to free up space.
For more information, see Radio Module Firmware on page 254.
11. When the update is complete, the AirLink gateway reboots. The Software
Update process window appears.
When the reboot is complete, you are returned to the Login screen.
12. After you log in, go to Status > About.
13. Click Refresh.
14. Check the ALEOS Software Version and the Radio Firmware Version fields to confirm that the ALEOS software and the radio module firmware have been updated.
4118127
Gateway Configuration
Using AirLink Management Service (ALMS) to Update One or
Multiple AirLink gateways Over-the-Air
You can use AirLink Management Service to update the ALEOS software and radio module firmware over-the-air on one or multiple AirLink gateways.
If you don’t have an ALMS account:
1.
In ACEmanager, go to the Services tab and ensure that ALMS is enabled and the server URL is https://na.m2mop.net/device/msci/com
.
If this is not the case, enter the correct URL, click Apply and then click Reboot.
2.
Go to www.sierrawireless.com/ALMS for more information.
Updating to ALEOS software with an ALMS account:
1.
Go to airvantage.net
and log in.
2.
Follow the instructions in the online ALMS documentation to update the
ALEOS software and radio module firmware.
Updating Only the Radio Module Firmware
Important:
This feature should be used only if directed by Sierra Wireless or an authorized reseller.
If Sierra Wireless or your authorized reseller directs you to update only the Radio
Module Firmware:
1.
Select the Radio Module Firmware button.
2.
Select the appropriate firmware file for your gateway and click Update. If you select a file for radio module firmware that is not supported on your gateway, you will see a warning message similar to the following:
Rev 2 Nov.15
Unless you have been advised by Sierra Wireless to do so, we recommend that you do not install an unsupported version of the radio module firmware.
39
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
3.
Click Update.
The radio module firmware update runs automatically and green check marks appear beside each step as it is completed.
4.
When the update is complete, the AirLink gateway reboots. The Software
Update process window appears.
When the reboot is complete, you are returned to the Login screen.
5.
After you log in, go to Status > About.
6.
Check the Radio Firmware Version has been updated.
Enterprise LAN Management
You can use AirLink gateways in the following configurations:
•
Standalone with a connection to a single device
When using the AirLink gateway with a single device, ensure that the device is
DHCP enabled.
host
AirLink gateway
•
With a router
The router allows several devices to use the AirLink gateway’s connection to the network. When using the AirLink gateway with a router:
· Configure the router to be DHCP enabled.
And either:
· Configure the router to use Network Address Translation (NAT).
Or
· Configure ALEOS (in ACEmanager) to use Host Port Routing. For information on using ALEOS with a router that is not configured to use NAT, see
Host Port Routing on page 104.
40 4118127
Gateway Configuration
Rev 2 Nov.15
Router
AirLink gateway hosts
Note: Other than for VLANs, ALEOS does not provide DHCP addresses to router connected devices.
Over the Air (OTA) Connections
Access AirLink gateways
You can use an OTA connection to access AirLink gateways that are in either configuration described above (stand alone or with a router).
Access connected devices
To use an OTA connection to access a connected device through the AirLink gateway, configure the device in ALEOS as the DMZ or port forwarding
destination. For information on inbound OTA connections to the host, see DMZ on page 142 and
Configuring Your Gateway for use in a PCI
Compliant System
The credit card industry requires retailers to comply with Payment Card Industry
(PCI) standard to maintain a secure environment when processing payment card transactions. For these transactions, the AirLink ES450 gateway acts as a wireless data conduit for routers and PoSs (point-of-sale-terminals) that have been configured for PCI compliance.
41
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
42
Internet
Cellular WAN
AirLink gateway
LAN
Router configured for
PCI compliance
LAN
WAN
Payment Processor
DSL Gateway
Retail store
Wi-Fi
PoS
Wireless Access Point
PoS
Figure 2-27: Sample PCI compliant network
The PCI compliant network must be set up so that:
•
The USBnet is on a different subnet from the point-of-sale-terminal.
•
All security protocols must be established from the point-of-sale terminal to the payment processor.
•
Payment card terminals must be on a dedicated LAN or VLAN.
•
The AirLink gateway must be connected to a router that is configured for PCI compliance.
Note: The serial port on the AirLink gateway has no access to the IP data path and does not need to be disabled.
If you are using the AirLink gateway for a payment card industry application, to meet PCI Data Security Standard compliance requirements the following steps must be done by a PCI certified service company.
For each gateway:
1.
Connect the AirLink gateway to a router that has been configured for PCI compliance.
2.
Log in to ACEmanager. (User name is user; default password is 12345.)
Change the password regularly, in accordance with PCI recommendations.
3.
Go to the Admin tab and change the default password.
Do not share the ACEmanager password.
4.
Go to Applications > ALEOS Application Framework and set the ALEOS
Application Framework field to Disable.
4118127
3: Status
All of the fields in the Status group are read-only and provide information about the AirLink gateway. Depending on the individual settings and the onboard radio module, the actual status pages may look different than the screen shot shown here.
Tip:
To be sure you are viewing the current status for all fields, it’s a good idea to first click the Refresh button on the upper right side of the screen.
Home
The Home section of the Status tab is the first page displayed when you login to ACEmanager. It shows basic information about the WAN network connection, the mobile network connection, and important information about the gateway.
Note: The fields displayed vary depending on the gateway, the radio module, the type of network the gateway is connected to, and ACEmanager settings.
For details, see
3
Rev 2 Nov.15
Figure 3-1: ACEmanager: Status > Home
43
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Phone Number
Description
The phone number associated with the Mobile Network Operator account. If the Mobile Network
Operator does not allow the account to display the phone number or there is no Mobile Network account for the gateway, “NA” is displayed.
WAN Network
Active WAN IP
Address
Network State
The current IPv4 WAN IP address for the gateway.
Current state of the WAN network connection
•
Network Ready—Connected to a mobile broadband network and ready to transfer data
•
Network Ready Ethernet—Connected to an Ethernet network with a DHCP server.
Note: This connection type has limited feature support.
•
Connecting To Network—Establishing a network connection; wait until the connection is established
•
Not Connected-Wait for Activity—The Always on connection field on the WAN/Cellular tab
(Advanced section) is set to Disabled. The gateway connects to the mobile network only when it needs to send or receive data.
•
Data connection failed. Waiting to retry—ALEOS is attempting to reconnect to the mobile broadband network. Ensure that the APN is correct or the account is activated to the ESN for your gateway. Wait until it is able to connect. If you see this status repeatedly or for an extended period of time, contact your Mobile Network Operator.
•
Network Link Down—Unable to connect to the network. Ensure that the APN is correct or the account is activated to the ESN for your gateway. If the problem persists, contact your
Mobile Network Operator.
•
No SIM or Unexpected SIM Status—Unable to read the SIM information; check that the
SIM card is installed correctly.
•
SIM PIN incorrect x attempts left—Wrong SIM PIN entered; enter the correct PIN. If the correct PIN is not entered in the specified number of attempts, the SIM is blocked. Contact your Mobile Network Operator to unblock the SIM.
•
No Service—Unable to connect to the broadband network. Check that the antenna is connected properly. If the problem persists, contact your Mobile Network Operator for information about coverage in your region.
•
Network Authentication Failed—Unable to connect to the network because of invalid authentication data. If the problem persists, contact your Mobile Network Operator.
Note: Messages displayed depend on the gateway, and the type of network.
Mobile (Cellular) Network
Cell Info
Cell information such as the Base Station Identity Code (BSIC), TCH, Received Signal Strength
Indicator (RSSI), Location Area Code (LAC), and the cell ID
For additional information, including cell info for LTE networks, see *CELLINFO2?
Network
Operator /
Current Network
Operator
Name of the Mobile Network Operator whose network the AirLink gateway is connected to
Note: The roaming operator is only displayed if the home operator allows this.
44 4118127
Status
Field Description
Radio Technology
Type of service being used by the gateway (e.g. LTE, HSPA+,1xRTT, EV-DO, UMTS, HSPA,
EDGE or GPRS)
If you are connected to a network other than that of your Mobile Network Operator, the network service type indicates that you are roaming (and additional charges may apply).
Network Service
Type
Type of network the gateway is connected to (e.g. 4G, 3G, 2G)
Signal Strength and Quality
Different radio technologies have different ways of reporting signal strength and signal quality. The fields displayed in
Signal Strength
(RSSI)
Received Signal Strength Indicator
The average received signal power measured in the air interface channel
Indicates if there is a strong signal available for the AirLink gateway to connect to
See also
LTE Signal Strength (RSRP) and LTE Signal Quality (RSRQ)
.
The value varies, depending on the network characteristics and the AirLink gateway.
RSSI
> -78 dBm
-78 dBm to -93 dBm
-94 dBm to -102 dBm
< -103 dBm
Signal strength
Good
Fair
Poor
Inadequate
Signal Quality
(ECIO)
2G/3G signal quality
Indicates the signal quality with a ratio of the average signal energy to co-channel interference in dB
EC/IO
0 to -6
-7 to -10
-11 to -20
Signal quality
Good
Fair
Poor
Received Signal
Code Power
(RSCP)
The RSCP is the power measured by the receiver on a particular physical channel. It provides an indication of signal strength for CDMA and UMTS connections. Expected values are in the range of -50 dB to -120 dB.
Rev 2 Nov.15
45
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
LTE Signal
Strength (RSRP)
Description
Reference Signal Received Power
The average signal power of all cell-specific reference signals within the LTE channel
Indicates whether the AirLink gateway has a strong connection to the wireless network
The value varies, depending on the network characteristics and the AirLink gateway.
LTE Signal
Quality (RSRQ)
RSRP
> -95 dBm
Signal strength
Good
-95 dBm to -115 dBm Fair
-116 dBm to -1000 dBm Poor
< -1000 dBm Inadequate
See also
Reference Signal Received Quality
The RSRQ indicates the quality of the AirLink gateway’s connection to the wireless network. (Is noise or interference affecting the quality of the connection?) See also
and
.
The value varies, depending on the network characteristics and the AirLink gateway.
RSRQ
> -9 dB
-9 dB to -12 dB
< -13 dB
Signal quality
Good
Fair
Poor
LTE Signal
Interference
(SINR Level)
Note: For additional information on the LTE network, use the
AT command
(described on page
).
Signal Interference Plus Noise (SINR) Level only applies to Sprint and Verizon Wireless LTE networks. The maximum value for each level is:
•
Level 0 = -9 dB
•
Level 1 = -6 dB
•
Level 2 = -4.5 dB
•
Level 3 = -3 dB
•
Level 4 = -2 dB
•
Level 5 = +1 dB
•
Level 6 = +3 dB
•
Level 7 = +6 dB
•
Level 8 = +9 dB
46 4118127
Status
Field
LTE Signal
Interference
(SINR)
Description
Signal to noise and interference ratio
Higher values indicate that signal power is much greater than noise and interference.
SINR
> 5
-3–5
6 –20
< 20
Signal Strength
Good
Fair
Poor
Inadequate
WAN Traffic
Channel
WAN network channel
The current active channel number for the mobile network connection
Number of bytes sent to the mobile network since system startup or reboot
WAN/Cellular
Bytes Sent
WAN/Cellular
Bytes Rcvd
Persisted WAN/
Cellular Bytes
Sent
Persisted WAN/
Cellular Bytes
Rcvd
Number of bytes received from the mobile network since system startup or reboot
Number of bytes sent
The count starts when the gateway first goes on air and persists over reboot. The field resets to zero on reset to factory default settings.
Number of bytes received
The count starts when the gateway first goes on air and persists over reboot. The field resets to zero on reset to factory default settings.
Gateway Information
ALEOS Software
Version
Version of ALEOS software currently installed on the gateway
Rev 2 Nov.15
47
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Customer Device
Name
By default, the name is the serial number of the gateway. If you have configured a device name in the IP Manager section of the Services > Dynamic DNS tab, that name appears in this field.
Network Operator
Switching
Network Operator Switching status (See
Radio Module Firmware on page 254.) Possible status:
•
OK—The SIM in use matches the currently active radio module firmware.
•
Manually disabled—SIM based image switching is disabled on the Admin > Radio Module
Firmware screen.
•
Disabled: <carrier> firmware is not in the local store—The required radio module firmware is not stored on the gateway. For instructions on how to install the radio module firmware,
see Radio Module Firmware on page 254.
•
Disabled: Unknown MCC/MNC—The gateway does not recognize the Mobile Country
Code (MCC) or the Mobile Network Code (MNC) for the SIM card.
•
Disabled: SIM card not ready at boot—SIM card error. Ensure that the SIM card is installed properly, and has a valid account associated with it. If the problem persists, contact your
Mobile Network Provider.
•
Disabled: SIM card not usable at boot—The gateway is unable to read the SIM card.
field to ensure that the SIM card is not PIN-blocked. Ensure that the SIM card is installed properly, and has a valid account associated with it. If the problem persists, contact your Mobile Network Provider.
•
Disabled: DVT-Mode—The gateway is in an advanced diagnostic mode, normally only used at the factory. Contact your Sierra Wireless authorized distributor.
•
Disabled: internal error—Indicates a problem with the Network Operator Switching feature.
Contact your Sierra Wireless authorized distributor.
Table 3-1: Reported Signal Strength and Quality Values
Network Signal Strength and Quality values
EV-D0, 1x
UMTS
LTE
•
Signal Strength (RSSI)
•
Signal Quality (ECIO)
•
Received Signal Power Code (RSCP)
•
LTE Signal Interference (SINR Level)
•
Signal Strength (RSSI)
•
Signal Quality (ECIO)
•
Received Signal Power Code (RSCP)
•
Signal Strength (RSSI)
•
LTE Signal Strength (RSRP)
•
LTE Signal Quality (RSRQ)
•
LTE Signal Interference (SINR)
WAN/Cellular
WAN/Cellular provides specific information about the connection including IP address and how much data has been transmitted or received. Some of the information on this screen is repeated on the Home page for quick reference.
48 4118127
Status
Figure 3-2: ACEmanager: WAN/Cellular — Status > WAN/Cellular
Field Description
Cellular IP Address
IPv4 Cellular WAN IP Address
If there is no mobile network connection, 0.0.0.0 is displayed.
WAN/Cellular Network Information
The fields in ACEmanager depend on the type of network it is connected to. Not all the fields described below appear on all gateways.
ESN/EID/IMEI
Electronic Serial Number for the internal radio
SIM ID
Identification number for the SIM card in use
Rev 2 Nov.15
49
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
APN Status
Description
Current APN in use by the network connection
•
(Configured) is a default APN based on the SIM card in use.
•
(User Entered) is a custom APN entered manually into the configuration.
Note: APN is configured on the WAN/Cellular configuration tab.
IMSI
Cell ID
International Mobile Subscriber Identity number
Unique number that identifies each base transceiver station (BTS) or sector of a BTS within an LAC
Location Area Code or Tracking Area Code (LTE)
LAC / TAC
Note: Because the following 3 fields relate to different types of network, only one of these fields is populated, depending on the type of network the gateway is connected to.
BSIC
PSC
PCI
Active Frequency Band
PN Offset
WAN Keepalive IP
Address
Keepalive Ping Time
(minutes)
Cellular Network
Watchdog
DNS Proxy
Base Station Identity Code
Relates to 2G networks
Primary Scrambling Code
Relates to 3G (UMTS) networks
Physical Cell ID
Relates to 4G (LTE) networks
Current cellular band being used (LTE BAND 4, WCDMA 2100, GSM 450, etc.)
Base station identifier used in CDMA networks
IP address that WAN Keep Alive uses to test the WAN network connectivity (see
Keepalive IP Address on page 69.)
Amount of time between Keepalive pings in minutes
DNS Override
DNS Server 1 (IPv4)
DNS Server 2 (IPv4)
Status of the Cellular Network Watchdog (Enabled or Disabled)
See
Cellular Network Watchdog on page 66.
Determines which DNS server the connected clients use for domain name resolution
•
Enable—DNS Proxy is activated. Connected DHCP clients acquire the AirLink gateway's IP address as their DNS server. The AirLink gateway performs DNS lookups on behalf of the clients.
•
Disable —Connected DHCP clients acquire the DNS servers used by the gateway.
To set this option, see DNS Proxy on page 106.
Override WAN-granted DNS
•
Enabled—Locally configured DNS servers are used.
•
Disabled—DNS servers provided by the active WAN connection are used.
1st DNS server IP address currently in use by the WAN connection to resolve domain names into IP addresses
2nd DNS server IP address
50 4118127
Status
Field Description
Current WAN Time in Use
(minutes)
The time, in minutes, that the gateway has been connected to the current WAN network.
Note: The value of this field is 0 if the gateway is not connected to a WAN mobile network.
Bytes Sent
Number of bytes sent to the mobile network since system startup or reboot
Bytes Received
Persisted Bytes Sent
Number of bytes received from the network since system startup or reboot
Number of bytes sent
The count starts when the gateway first goes on air and persists over reboot. The field resets to zero on reset to factory default settings.
Persisted Bytes Received
Number of bytes received
The count starts when the gateway first goes on air and persists over reboot. The field resets to zero on reset to factory default settings.
Packets Sent
Number of packets sent to the network since system startup or reboot
Packets Received
RSR Active Route
Number of packets received from the network since system startup or reboot
Active route for Reliable Static Routing
•
Primary—Specified network traffic is currently using the configured primary route.
•
Backup—Specified network traffic is currently using the configured backup route.
•
None—RSR is not enabled.
Result of the most recent Object Tracking test
RSR Test Result
RSR Test TimeStamp
Time of the most recent Object Tracking test
Dynamic Mobile Network Routing (DMNR) is only supported on the Verizon Wireless network.
DMNR Status
DMNR Foreign Agent
Registration Status
DMNR status:
•
Enabled
•
Disabled
This field only appears if DMNR is enabled.
The status of transactions with the Home agent
•
Pass —Connected subnets registered or de-registered successfully
•
Fail—Unable to register or de-register connected subnets
•
Unknown
DMNR Reverse Tunnelling
Agent Status
This field only appears if DMNR is enabled.
Status of the NEMO tunnel
•
Up
•
Down
Rev 2 Nov.15
51
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
LAN
This is the status of the local network. It lists information about the network and connected clients.
Figure 3-3: ACEmanager: Status > LAN
Field
Ethernet 1 Status
DHCP Mode
DHCP Status
USB Mode
Connected Clients
Description
Speed and duplex status of the connection on Ethernet port 1 (the main Ethernet port). If there is no connection, the value is None.
Status of DHCP mode
•
Server—The AirLink gateway is acting as a DHCP server for all Ethernet connections.
•
Disable—The AirLink gateway is acting as neither a DHCP server or client. All devices connected to the AirLink gateway must have a static LAN IP or use PPPoE.
•
—Default setting is used by authorized AirLink resellers for initial gateway configuration. See
for more information.
Status of DHCP mode (This field only appears when the DHCP mode is.)
•
Server—ALEOS is acting as a DHCP server.
•
Client—ALEOS is acting as a DHCP client.
Which USB port mode is set (USBnet, USB serial, or Disabled)
Number of connected devices that obtained their IP address through DHCP over Ethernet or USBnet. The value in this field does not include devices connected via PPP or PPPoE.
LAN IP Packets Sent
Number of IP packets sent to the Ethernet host interface since the system startup
LAN IP Packets
Received
Number of IP packets received from the Ethernet host interface since the system startup
52 4118127
Field
IP/MAC table
VRRP Enabled
VLAN table
Status
Description
Local IP Address and the MAC Address of connected devices that obtain their IP address through DHCP.
Configuration of the VRRP feature
Identities (Interface name and ID) of the configured VLANs
VPN
The VPN section gives an overview of the VPN settings and indicates whether a
VPN connection has been made.
Figure 3-4: ACEmanager: Status > VPN
Field Description
Incoming Out of Band
Whether Incoming Out of Band traffic is allowed or blocked
Outgoing Management Out of Band
Whether outgoing ALEOS Out of Band traffic is allowed or blocked
Outgoing Host Out of Band
Whether Outgoing Host Out of Band traffic is allowed or blocked
Rev 2 Nov.15
53
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
VPN 1 to 5 Status
Description
Status of each VPN connection:
•
Disabled—VPN is disabled (default)
•
Not Connected—The VPN failed to connect. This could be because of a mismatch in the configuration between the client and the server, no data connection on the gateway, etc.
•
Connected—The VPN is connected and ready to transmit traffic.
•
Configuration Error—This status appears when:
•
Two VPNs have both the same Local Address and the same Remote
Address
•
More than one VPN has the remote address set to “0.0.0.0”
Note: This restriction does not apply to the Additional Remote Subnets.
When either of these errors exist, only the first of the conflicting VPNs is operational.
To determine which VPNs are in conflict:
1. Go to Admin > Configure Log.
2. For the VPN Subsystem, ensure that Display in Log is set to Yes. The
Verbosity can be either Info or Debug.
3. Click View Log.
4. The resulting log shows you which VPNs are in conflict.
Failover - Primary VPN
Failover - Primary VPN
Status
ID of the primary VPN (for VPN Failover) i.e. VPN 1, VPN 2, VPN 3, VPN 4, VPN 5, or None (Default is None.) Setting persists over reboot.
Status of the primary VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—The VPN is trying to connect to the responder.
•
Active—The VPN tunnel is ready and transferring traffic.
•
Backup—This is currently the backup VPN connection.
•
Failed—Dead Peer Detection (DPD) has determined that the VPN responder is dead, or a ping sent to the VPN host failed.
•
Out of Service—There have been 5 DPD failures within an hour.
Failover - Secondary VPN
ID of the Secondary VPN (for VPN Failover) i.e. VPN 1, VPN 2, VPN 3, VPN 4,
VPN 5, or None (Default is None.) Setting persists over reboot.
Failover - Secondary VPN
Status
Status of the Secondary VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—The VPN is trying to connect to the responder.
•
Active—The VPN tunnel is ready and transferring traffic.
•
Backup—This is currently the backup VPN connection.
•
Failed—Dead Peer Detection (DPD) has determined that the VPN responder is dead, or a ping sent to the VPN host failed.
•
Out of Service—There have been 5 DPD failures within an hour.
54 4118127
Status
Field
Failover - Overall VPN
Status
Failover - Number of
Primary VPN Failures
Failover - Number of
Secondary VPN Failures
Failover - Number of
Switches to Primary VPN
Failover - Number of
Switches to Secondary
VPN
Description
Status of the overall VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—One of the VPNs is trying to connect to the responder.
•
Active—One VPN tunnel is currently in use. The backup VPN is available.
•
Backup_Unavailable —One VPN tunnel is currently in use. The backup VPN is not available.
•
Out of Service—Neither the primary nor secondary VPN is operational.
•
N/A—The overall VPN status is temporarily not available. Click Refresh.
Number of times DPD has failed on the primary VPN since the gateway has been rebooted or the “Set VPN Policy” button was clicked
Number of times DPD has failed on the Secondary VPN since the gateway has been rebooted or the “Set VPN Policy” button was clicked
Number of times traffic was switched to the primary VPN since the gateway has been rebooted or the “Set VPN Policy” button was clicked
Number of times traffic was switched to the Secondary VPN since the gateway has been rebooted or the “Set VPN Policy” button was clicked
Security
The security section provides an overview of the security settings on the AirLink gateway.
Rev 2 Nov.15
Figure 3-5: ACEmanager: Status > Security
55
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
DMZ
Port Forwarding
Port Filtering Inbound
Port Filtering Outbound
Outbound Firewall Mode
Trusted Hosts (Friends)
MAC Filtering
IP Reject Count
DMZ IP in use
Description
Status of DMZ (Automatic, Manual, or Disabled)
DMZ defines a single LAN connected device where all unsolicited data should be routed.
Status of port forwarding (Enabled or Disabled)
Status of inbound port filtering (Allowed Ports, Blocked Ports, or Disabled)
Status of outbound port filtering (Allowed Ports, Blocked Ports, or Disabled)
Status of the outbound firewall (Enabled or Disabled)
Status of the Trusted Hosts (Friends) list (Disabled or Enabled)
When this option is enabled, the AirLink gateway only accepts connections from trusted remote IP addresses.
Status of MAC filtering (Enabled or Disabled)
Number of IP addresses that have been rejected
IP address currently in use for DMZ
Services
This section shows the status of AirLink services, including the ACEmanager access level.
56
Figure 3-6: ACEmanager: Status > Services
4118127
Status
Field
ALMS
Description
Status of the connection to the AirLink Management Service
Remote Access
ACEmanager remote access (over the WAN link):
•
Disabled (default)
•
HTTPS Only
•
Both HTTP and HTTPS
Local Access
ACEmanager local access (Ethernet, USBnet, or Serial/DUN):
•
HTTPS Only
•
Both HTTP and HTTPS (default)
Dynamic DNS Service
Service in use for Dynamic DNS translation
Full Domain Name
Use SNTP to update time
If the Dynamic DNS Service is configured to use a 3rd party host, the domain name configured is displayed. If the Dynamic DNS Service is configured to use IP Manager, this field does not display.
Daily SNTP updates of the system time
Engine Hours
Time the engine has been running. Depending on your configuration, this is based on:
•
Voltage on the Power Pin from the vehicle battery (Engine Hours On Voltage Level)
•
Voltage on the Ignition Sense Pin (Engine Hours Ignition Enable)
LDAP Authentication
Status of the LDAP client:
•
Enabled
•
Disabled (default)
RADIUS
Authentication
TACACS+
Authentication
Status of the RADIUS client:
•
Enabled
•
Disabled (default)
Status of the TACACS+ client:
•
Enabled
•
Disabled (default)
Rev 2 Nov.15
57
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Serial
Figure 3-7: ACEmanager: Status > Serial
Field
Serial Port
Serial Reserved by
External
Serial Port Mode
Login reverse telnet
TCP Auto Answer
Description
Status of the serial port:
•
Enabled—The serial port is functional (default).
•
Disabled — The serial port has been manually disabled. To enable the serial port, go to
Port Configuration on page 207.
Reservation status of the serial port:
•
Enabled—The serial port is reserved for ALEOS Application Framework (ALEOS AF), and cannot be used for any other serial-related ALEOS features.
•
Disabled — The serial port is available for non-ALEOS AF, serial-related ALEOS features.
To reserve the serial port for ALEOS AF, go to Applications > ALEOS Application
Framework > Serial Port Reserved. (See
ALEOS Application Framework on page 233.)
Default power-up mode for the serial port. When the AirLink gateway is power-cycled, the serial port enters the mode specified by this command after 5 seconds.
This field only appears when reverse telnet is selected as the Serial Port Mode.
Status of login for reverse telnet. For more information, see Reverse Telnet/SSH on page 210.
This parameter determines how the AirLink gateway responds to an incoming TCP connection request. The AirLink gateway remains in AT Command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the gateway must be set for a successful TCP connection. The AirLink gateway sends a “RING” string to the host. A
“CONNECT” sent to the host indicates acknowledgment of the connection request and the
TCP session is established.
•
Disabled (default)
•
Enabled
58 4118127
Status
Field
UDP Auto Answer
How UDP auto answer mode is configured
•
Disabled (default)
•
Enabled
Serial bytes sent
Number of bytes sent over serial port to host
Serial bytes received
Number of bytes received over serial port from host
Serial Signal Level
Description
Status of the following parameters related to the host signal level:
•
DCD—Data Carrier Detect—Control signal to the PC
•
DTR—Data Terminal Ready—Used to establish a connection
•
DSR—Data Set Ready—Used to establish a connection
•
CTS—Clear to Send—Data flow control
•
RTS—Request to Send—Data flow control
Each parameter can have a value of LOW (signal not asserted) or HIGH (signal being asserted).
The first three parameters (DCD, DTR, and DSR) may be helpful for troubleshooting. If the values shown for these parameters are not as expected:
1.
Press Refresh to ensure you have the latest values.
2.
Check the cable connections.
Note: ACEmanager does not update dynamically. Press Refresh to view the current values.
Applications
The Applications section of the Status group provides information on the status of data service.
Rev 2 Nov.15
Figure 3-8: ACEmanager: Status > Applications
59
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Data Service
Available RAM (KB)
Available Flash (KB)
CPU Load
(Last 15 minutes)
Description
Data Service field displays “Available (under usage limit)” if the configured usage limit has not been exceeded.
Available RAM in kilobytes (1000 bytes), updated every 30 seconds
Available Flash on the user partition in kilobytes (1024 bytes), updated every 30 seconds
CPU load, averaged over the last 15 minutes and updated every 30 seconds
The CPU load relates to how many applications are attempting to execute in parallel over the 15-minute period. If the load is greater than 1, some applications are waiting for CPU capacity to become available and may be delayed in launching.
Whether ALEOS Application Framework is enabled or disabled
ALEOS Application
Framework
Serial Port Reserved
Reservation of the serial port:
•
Disable (default)
•
Enable
QCOM DM Port
Resource Reserve
Reservation of the QCOM DM port:
•
Disable (default)
•
Enable
About
The About section of the Status group provides basic information about the
AirLink gateway.
60
Figure 3-9: ACEmanager: Status > About
4118127
Status
Field
Device Model
Description
Model of the gateway (e.g., ES450)
Radio Module Type
Radio Module Identifier
Model number of the internal radio module (e.g. MC7304, MC7354)
Identifier for the internal mobile radio module
Radio Firmware Version
Firmware version in the radio module
PRI ID
Product Release Instructions ID number
Global ID
Ethernet Mac Address
Device ID used by ALEOS to identify itself for various management applications
MAC address of the main Ethernet port
ALEOS Software Version
Version of ALEOS software running on the AirLink gateway
ALEOS Build number
Build number for the ALEOS Software
AirLink gateway’s hardware configuration
Device Hardware
Configuration
Boot Version
Version of boot code installed on the gateway
MSCI Version
Template Name
MSCI version of the ALEOS internal configuration database
If you have installed a custom-named template, the name appears here. Otherwise, the field is blank.
Rev 2 Nov.15
61
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
62 4118127
4: WAN/Cellular Configuration
The WAN/Cellular tab in ACEmanager allows you to view and modify mobile network connection settings. The settings available depend on the gateway model and the radio module.
The first time you power up the gateway on its home network, it automatically begins the activation/provisioning process and attempts to connect to the network. This process typically takes 5–10 minutes. If the gateway does not automatically connect to the
network, see Network Credentials on page 64.
Note: The fields displayed vary depending on the ACEmanager settings.
4
Rev 2 Nov.15
Figure 4-1: ACEmanager: WAN/Cellular
63
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Network Credentials
Description
Note: If the gateway does not automatically connect to the network, you may need to manually configure your APN using the User Entered APN field. You may also need to contact your Mobile Network Operator to confirm the APN and activation status of your gateway.
Note: Network credentials shown depend on the network.
APN in Use
User Entered APN
The APN in use for the current mobile network connection.
When you power on the AirLink gateway, the APN the gateway is using for authentication on the mobile network is displayed.
•
If a User Entered APN is configured, the User Entered APN is displayed.
•
If there is no User Entered APN configured, an automatically-selected APN is displayed.
•
When the Backup APN is configured, the APN in Use displays the configured
Backup APN when it is being used for authentication on the mobile network.
If ALEOS is unable to find the appropriate APN to use (No APN found), contact your
Mobile Network Operator for the APN and enter it in the
field.
The APN entered in this field takes priority over the automatically-selected APN.
1.
Enter the APN in this field (maximum 128 characters).
2.
Click Apply.
3.
Click Reboot.
Note: If you reset the gateway to factory defaults, you have the option to preserve the
custom APN, if entered. See Reset Mode on page 249.
RX Diversity
SIM PIN
Allows two antennas to provide a more consistent connection
•
Disable
•
Enable (default)
If you are not using a diversity antenna, diversity should be disabled.
Click this button to configure the PIN stored on the AirLink gateway. For more information, see
SIM PIN on page 70. By default, the gateway does not use a SIM PIN.
Keep Alive (See
Advanced
The Advanced section fields in ACEmanager depend on the gateway product, the radio module, and the type of network it is connected to. Not all the fields described below appear on all gateways.
64 4118127
WAN/Cellular Configuration
Field
Response to Incoming
Ping
Description
When a ping is received by the gateway from a remote location, the Response to
Incoming Ping redirects it to the selected location.
•
No response: The incoming ping is completely ignored
•
ALEOS Responds (default): ALEOS returns to the Ping response.
•
Pass to Host: The ping is forwarded to the DMZ host with any response from the host forwarded back to the OTA location. If no host is connected, there is no ping response.
Note: Some Mobile Network Operators may block all ICMP traffic on their network.
When ICMP is blocked by the operator, a ping sent to the gateway from a remote location is not received.
LTE Authentication
Mode
Network User ID
Network Password
Network Watchdog
Timer
Specifies the authentication method to use when connecting to a mobile network
Options are:
•
NONE
•
CHAP
•
PAP (default)
Network User ID
The login that is used to login to the mobile network, when required.
•
Maximum 128 characters
Network Password is the password that, when required, is used to login to the mobile network.
•
Maximum 30 characters
Network Watchdog Timer
If there is no WAN connection for the time configured in this field, the gateway reboots.
Options are:
•
Disable—When this field and the
Cellular Network Watchdog field are set to
Disable, the gateway never reboots as a result of lack of network connectivity.
•
5 Minutes
•
10 Minutes
•
15 Minutes
•
30 Minutes
•
45 Minutes
•
1 Hour
•
2 Hours (default)
•
3 Hours
•
4 Hours
Rev 2 Nov.15
65
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Set Carrier [Operator]
Selection
Cellular Network
Watchdog
Connection Timeout
(minutes)
Description
Manually specify an operator. Enter the desired parameters in the following format: mode[,format[,oper]]
•
mode= 0: Automatic — any affiliated carrier [default]
•
mode= 1: Manual — use only the operator <oper> specified
•
mode= 4: Manual/Automatic — if manual selection fails, goes to automatic mode
•
format= 0: Alphanumeric (“name”)
•
format= 2: Numeric
•
oper=”name”
Note: Not all carriers or accounts allow specifying the operator. If the carrier doesn't support it, this command may appear to fail.
Cellular Network Watchdog
Options are:
•
Enable—When this Watchdog is enabled, the gateway reboots after several attempts to authenticate on the mobile network fail. (default)
•
Disable—When this field and the
Network Watchdog Timer field are both set to
Disable, the gateway never reboots as a result of lack of network connectivity.
This field is intended for International gateways on the Vodafone network.
This field only appears when Always on connection is set to Disable - Connect on traffic, and defines the timeout period for Always on connection.
If there is no outgoing packet through the WAN interface during the period set in this field (in minutes), the AirLink gateway disables the WAN connection. This timer is triggered after every outgoing packet, except AT
*IPPINGFORCE keep alive packets.
•
2–65535 minutes (default is 2)
Note: You can also use AT*TRAFWUPTOUT to set the timeout period. See
66 4118127
WAN/Cellular Configuration
Field
LTE Active Reselection
Interval
Description
This feature assists the gateway to revert back to an LTE network if one becomes available.
When an LTE AirLink gateway is connected to a non-LTE network, it may not handover to an LTE network when one becomes available if data is being continuously transmitted or received.
When the LTE Active Reselection Interval timer is configured, the AirLink gateway
temporarily halts uplink data for the length of time configured in the LTE Reselection
Time field if the gateway is connected to a non-LTE network. This allows the radio
module to go idle and reconnect to an LTE network, if one is available.
Note:
•
If the LTE signal that the AirLink gateway receives is weaker than the HSPA+ signal, the gateway may not revert to LTE, depending on the local network characteristics.
•
This feature should be disabled:
•
If the SIM in the gateway is not provisioned to work on an LTE network
•
If the gateway is roaming
To use this feature:
1.
From the drop-down menu in the LTE Active Reselection Interval field, select how long the AirLink gateway is not on an LTE network before the reselection process begins. (Disabled is the default.)
LTE Reselection Time
Current Radio Module
Band
2.
Click Apply.
3.
Reboot the gateway.
Use this field to set how long the gateway radio should attempt to find and connect to an
LTE network (i.e. how long the reselection process described in LTE Active Reselection
should last). Data for transmission during the reselection process is buffered.
Options are:
•
15 seconds
•
20 seconds (default)
•
25 seconds
•
30 seconds
Band reported by the radio module as the one currently in use.
Rev 2 Nov.15
67
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Always on connection
Connection Timeout
(minutes)
Description
This field is intended for International gateways on the Vodafone network.
This option allows you to configure the AirLink gateway to use minimal wireless network resources when there has not been any outgoing WAN network traffic.
•
Enabled—The AirLink gateway maintains a mobile network data connection.
(default)
•
Disabled—Connect on traffic—The AirLink gateway only establishes a mobile network data connection:
•
When there is network traffic
•
If SMS Wakeup is configured and the gateway receives the specified type of
SMS (For information on configuring SMS Wakeup, see
Note: You can also use AT*RADIO_CONNECT to switch the mobile network
connection on and off. See *RADIO_CONNECT on page 320.
This field is intended for International gateways on the Vodafone network.
This field only appears when Always on connection is set to Disable - Connect on traffic, and defines the timeout period for Always on connection.
If there is no outgoing packet through the WAN interface during the period set in this field (in minutes), the AirLink gateway disables the WAN connection. This timer is triggered after every outgoing packet, except AT
*IPPINGFORCE keep alive packets.
•
2–65535 minutes (default is 2)
Note: You can also use AT*TRAFWUPTOUT to set the timeout period. See
On WAN
Disconnect
If a disconnect from the Mobile Network Operator occurs:
•
Reconnect (default)
•
Reset Radio — ALEOS resets the radio after a Mobile Network Operator disconnect.
For setting for band details for your gateway, see Setting for Band on page 367.
Setting for Band
APN Backup (See
Bandwidth Throttle (See
Bandwidth Throttle on page 74.)
Keepalive
If the AirLink gateway does not receive a valid packet for a specified time,
Keepalive tests the connection to the mobile network by pinging a configured IP address. Keepalive is only recommended if you have a remote terminated device that infrequently communicates to the network or if you have experienced issues over time where the device can no longer be reached remotely.
68 4118127
WAN/Cellular Configuration
Figure 4-2: ACEmanager: WAN/Cellular > Keep Alive
Field
Keepalive IP
Address
Description
The IP address that the AirLink gateway pings to determine if there is Internet connectivity and to make sure the IP address is accessible.
Enter the IP address or fully qualified domain name for the AirLink gateway to ping to keep itself alive
(online). Options are:
•
IP address
•
Domain name
You can also use
*IPPINGADDR to set this parameter.
Rev 2 Nov.15
69
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Keepalive
Ping Time
(minutes)
Force
Keepalive
Ping
Description
The amount of time the AirLink gateway goes without receiving a valid packet before the first
Keepalive ping is sent. Options are:
•
0—Disable Keepalive ping (default)
•
1–255 minutes
Most applications work well with an interval of 15 to 60 minutes.
If the first ping fails, the AirLink gateway sends four additional pings. If all five pings fail, the AirLink gateway reboots. After rebooting, the AirLink gateway waits 60 minutes before sending another
Keepalive ping (regardless of the setting in this field). This prevents frequent rebooting (based on the
Keepalive Ping Time setting) if the IP address used for the Keepalive ping is not accessible.
Note: Using Keepalive ping may accrue data charges. Each individual ping is approximately
98 bytes (196 bytes for ping sent plus ping response).
You can also use
to set this parameter.
Determines if the ping should be sent even if IP traffic is received during the Keepalive ping interval.
Options are:
•
Disable (default)
•
Enable
If the first ping fails, the AirLink gateway sends four additional pings. If all five pings fail, the AirLink gateway reboots. After rebooting, the AirLink gateway waits 60 minutes before sending another
Keepalive ping (regardless of the setting in this field). This prevents frequent rebooting (based on the
Keepalive Ping Time setting) if the IP address used for the Keepalive ping is not accessible.
You can also use
*IPPINGFORCE to configure this parameter.
SIM PIN
If you have a SIM card with a PIN configured, you can configure ALEOS to enter the PIN on reboot, so human intervention is not required.
This feature has two requirements:
•
A PIN-locked SIM card—Contact your Mobile Network Operator to ensure that they support this feature and to obtain a PIN-locked SIM card and PIN.
•
The SIM PIN feature in ACEmanager must be enabled. See Enable the SIM
.
If the AirLink gateway has a PIN-locked SIM installed and this feature is not enabled in ACEmanager, the AirLink gateway is unable to go on air and the
Network Status field on the Status > Home screen displays the message “SIM
PIN incorrect, # attempts left”.
Enable the SIM PIN
To enable the SIM PIN in ALEOS:
1.
In ACEmanager, go to WAN/Cellular.
2.
Click the SIM PIN button. The following pop-up window appears.
70 4118127
WAN/Cellular Configuration
3.
Select Enable.
4.
Enter the PIN (obtained from your Mobile Network Operator) twice and click
Save.
5.
Reboot the AirLink gateway.
After rebooting:
•
The AirLink gateway uses the configured PIN on subsequent re-boots.
•
The SIM PIN pop-up window shows the default settings. Don’t change is selected and the SIM PIN fields are blank. “Don’t change” indicates that the
PIN is used in the same way on every boot.
Note: If you enter an incorrect PIN, the AirLink gateway is unable to go on air, and the
Network Status field on the Status > Home screen displays “SIM PIN incorrect, # attempts left”. The failed PIN is not retried on subsequent reboots to prevent exhausting the available number of retries with repeated attempts with an incorrect PIN.
Change the SIM PIN
To change the SIM PIN:
1.
In ACEmanager, go to WAN/Cellular.
2.
Click the SIM PIN button. The following pop-up window appears.
Rev 2 Nov.15
3.
Select Enable.
4.
Enter the new PIN twice and click Save.
5.
Reboot the AirLink gateway.
After rebooting:
•
The AirLink gateway uses the configured PIN on subsequent re-boots.
71
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
•
The SIM PIN pop-up window shows the default settings. Don’t change is selected and the SIM PIN fields are blank. “Don’t change” indicates that the
PIN is used in the same way on every boot.
Note: If you enter an incorrect PIN, the Network Status field on the Status > Home screen displays “SIM PIN incorrect, # attempts left”. The failed PIN is not retried on subsequent reboots to prevent exhausting the available number of retries with repeated attempts using an incorrect PIN.
Disable the SIM PIN
To disable the SIM PIN:
1.
In ACEmanager, go to WAN/Cellular.
2.
Click the SIM PIN button. The following pop-up window appears.
72
3.
Select Disable.
4.
Enter the PIN twice and click Save.
If you enter an incorrect PIN or no PIN, the feature will not be disabled.
5.
Reboot the AirLink gateway.
After rebooting:
•
The AirLink gateway no longer uses the stored PIN on subsequent re-boots.
•
The SIM PIN pop-up window shows that the feature is Disabled.
Unblocking a SIM PIN
When you enable, change or disable a SIM PIN, you have a set number of attempts to enter the correct PIN, depending on your Mobile Network Operator. If the correct PIN is not entered in the alloted number of attempts, the SIM PIN becomes blocked and you need a PUK code to unblock it.
To unblock a SIM PIN:
1.
Contact your Mobile Network Operator to obtain a PUK code.
2.
In ACEmanager, go to WAN/Cellular.
3.
Click the SIM PIN button.
When the PIN is blocked, an additional field (Enter SIM Unblock Code) appears.
4118127
WAN/Cellular Configuration
Rev 2 Nov.15
4.
Select Enable.
5.
Enter the new PIN code.
6.
Enter the PUK and click Save.
Be careful when entering the PUK. You have a limited number of attempts to enter the correct PUK (generally 10) before the SIM card is disabled. If the
PUK does not unblock the SIM PIN after the first few attempts, contact your
Mobile Network Operator.
If you have exhausted all the alloted attempts to enter the correct PUK, the
Mobile Network Operator may give you a new SIM card, or a new code to enable your existing SIM card. AirLink products do not support this type of code. To enter the code:
a.
Remove the SIM card from your AirLink gateway (following the instructions in the AirLink gateway Hardware User Guide) and insert it in a cell phone that accommodates a MiniSIM (2FF) card.
b. Enter a new code provided by the Mobile Network Operator and then return the SIM card to the AirLink gateway.
Backup APN
This feature enables you to configure a backup APN to be used as a backup network connection mechanism, only if the primary APN is not available. When it is enabled, the gateway connects to the backup APN only if it is unable to connect to the primary APN.
Note: Switching to the backup APN can take five minutes or more, depending on the gateway. If the gateway is always connecting to the backup APN, check the primary APN to ensure that it is configured correctly.
To configure a backup APN:
1.
Go to WAN/Cellular > APN Backup.
73
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
74
Figure 4-3: ACEmanager: WAN/Cellular > APN Backup
2.
Enter the backup APN (maximum 100 characters).
3.
Select the Network Authentication Mode. The options are:
· PAP (default)
· CHAP
· NONE
4.
Enter the Network User ID and Password, if these are required for the wireless network.
5.
Click Apply.
Bandwidth Throttle
This feature helps you manage your data account by allowing you to configure the
AirLink gateway to restrict the real-time available bandwidth. You can:
•
Place limits on the uplink traffic, downlink traffic, or both
•
Allow for burst of traffic on the uplink, downlink, or both, while still maintaining the over-all desired bandwidth limit
Traffic that exceeds the limits is dropped. Status fields keep running tallies of data sent and received and the number of uplink and downlink packets dropped.
4118127
WAN/Cellular Configuration
Figure 4-4: ACEmanager: WAN/Cellular > Bandwidth Throttle
Field
Bandwidth Throttle
Mode
Description
Downlink Bandwidth
(Kbps)
Allows you to Enable or Disable the feature
Default is Disable.
The maximum downlink bandwidth in Kilobits per second (Kbps)
This is the long-term bandwidth limit. Options are:
•
0–512000 (500 Mbps)
Default is 25600.
0 = feature disabled for downlink traffic
Rev 2 Nov.15
75
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Maximum Downlink
Burst Size (Kb)
Description
Maximum size for bursts of downlink traffic in Kilobits (Kb)
This field allows the AirLink gateway to handle temporary bursts of downlink traffic without dropping packets. When the actual downlink traffic is less than the value configured in the
field, ALEOS collects credits that can be used for bursty traffic. The value in this field is the maximum amount of credit that can be collected.
Options are:
•
64–512000 (500 Mb)
Default is 51200.
Note: Sierra Wireless recommends that the Maximum Downlink Burst Size be set at 2x the value configured in the
Downlink Bandwidth (Kbps) field. If the Maximum Downlink
Burst Size is set at more than 60x the value configured in the Downlink Bandwidth (Kbps)
field, the bandwidth throttle feature is disabled for downlink traffic.
Maximum Monthly
Downlink Data (MB)
Uplink Bandwidth
(Kbps)
An estimate of the maximum monthly downlink data in Megabytes (MB), based on the
.
Maximum monthly downlink data (MB) = Downlink bandwidth x 2592000 ÷ 8192
Where:
2592000 is the number of seconds in a month (30 days/month)
1 MB = 1024 KB; 1024 x 8 = 8192 Kb/MB
The maximum uplink bandwidth in Kilobits per second (Kbps)
This is the long-term bandwidth limit. Options are:
•
0–204800 (200 Mbps)
Default is 12288.
0 = feature disabled for uplink traffic
Maximum Uplink Burst
Size (Kb)
Maximum size for bursts of uplink traffic in Kilobits (Kb)
This field allows the AirLink gateway to handle temporary bursts of uplink traffic without dropping packets. When the actual uplink traffic is less than the value configured in the
Uplink Bandwidth (Kbps) field, ALEOS collects credits that can be used for bursty traffic.
The value in this field is the maximum amount of credit that can be collected. Options are:
•
32–204800 (200 Mb)
Default is 24576.
Note: Sierra Wireless recommends that the Maximum Uplink Burst Size be set at 2x the
field, the bandwidth throttle feature is disabled for uplink traffic.
Maximum Monthly
Uplink Data (MB)
Downlink Bytes Rcvd
An estimate of the maximum monthly uplink data i in Megabytes (MB), based on the value
Maximum monthly uplink data (MB) = Uplink bandwidth x 2592000 ÷ 8192
Where:
2592000 is the number of seconds in a month (30 days/month)
1 MB = 1024 KB; 1024 x 8 = 8192 Kb/MB
Number of downlink bytes received
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
76 4118127
WAN/Cellular Configuration
Field
Downlink Packets
Rcvd
Downlink Packets
Dropped
Uplink Bytes Sent
Uplink Packets Sent
Uplink Packets
Dropped
Description
Number of downlink packets received
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
Number of downlink packets dropped because the limits set in Downlink Bandwidth
and Maximum Downlink Burst Size (Kb)
have been exceeded
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
Number of uplink bytes sent
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
Number of uplink packets sent
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
Number of uplink packets dropped because the limits set in
and
Maximum Uplink Burst Size (Kb) have been exceeded
The value is updated every 30 seconds, and is reset to zero on gateway reboot or reset to factory default settings.
Reliable Static Routing (RSR)
Reliable Static Routing enables you to force specified traffic to use different routing rules (rather than the default, which is usually cellular) to direct specified traffic (from or to either the AirLink gateway or a connected device) to a designated primary route. If the primary route fails, the specified traffic uses a backup route.
First, you designate specific traffic to use the primary route, based on the destination IP address and subnet mask. A configured Tracking Object Test verifies the validity of the primary route. If the test fails, the backup route is used.
The Tracking Object Test continues to run and as soon as it returns a “Pass”, traffic is switched back to the primary route.
You can direct the traffic to a network or to an individual host.
Cellular
(Backup route)
Internet
Ethernet
(primary route)
Connected device
AirLink gateway
Figure 4-5: RSR directed to a destination network
Network Management Center
Network IP: 64.100.20.128
64.100.20.129
64.100.20.130
255.255.255.252
Rev 2 Nov.15
77
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
78
Connected device
Cellular
(Backup route)
Network Management Center
Internet
64.100.20.128
255.255.255.255
Ethernet
(primary route)
AirLink gateway
Figure 4-6: RSR directed to a destination IP address (individual host)
In a business continuity application where the router also has a routable IP address from a wireline gateway connection (as shown in
) the IT administrator may prefer to use that lower cost connection for data sourced from the AirLink gateway, such as SNMP or ALMS data. When reliable static routing is configured, the Tracking Object tests the validity of the primary route and data from the AirLink gateway is transmitted through the primary route (in this example, the wireline connection). If the tracking object determines that the primary route is down, data is transmitted through the backup (in this example, the wireless connection).
Private mode
RSR destination IP (e.g. 64.100.20.128)
Internet
Tracking object test IP (e.g. 8.8.8.8)
Wired WAN connection primary route
Wireless WAN connection
Backup route
Wireline Gateway
Tracking object
AirLink gateway
Primary route
Backup route
Tracking object
Figure 4-7: Private Mode with Reliable Static Routing
Sierra Wireless recommends a Private Mode network as the most reliable configuration to use in a business continuity failover application as defined in the
AirLink Hardware User Guide (or Figure 4-7 ) with Reliable Static Routing and
Reverse Telnet. For more information, see
Private and Public Mode on page 89.
To configure Reliable Static Routing:
1.
Connect the hardware as shown in
4118127
Rev 2 Nov.15
WAN/Cellular Configuration
2.
Use the Tracking Object to test the connection:
a.
In ACEmanager, go to WAN/Cellular > Reliable Static Route (RSR).
Figure 4-8: ACEmanager: WAN/Cellular > Reliable Static Route (RSR), Tracking Object
b. Under Tracking Object, enter the Test IP address, using a host behind the gateway that has a reliable IP address, such as 8.8.8.8.
c.
From the drop-down menu, select Ethernet 1 as the Test Interface.
d. Leave the default values for the Test Interval, Test Timeout, and
Maximum number of retries.
e.
In the Enable/Disable Tracking Object field, select Enable.
f.
Click Apply.
g. The Tracking Object pings the Test IP address configured in step b
. In
ACEmanager go to Status > WAN/Cellular and note the result in the RSR
Test Result field.
3.
Disable Tracking Object.
79
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
80
Figure 4-9: ACEmanager: WAN/Cellular > Reliable Static Route (RSR)
Note: Configure all the other fields before setting the Enable/Disable Reliable Static
Routing field. Once you enable RSR, some fields on this page are not editable.
4.
Select the interfaces for the primary and backup routes. The options are:
· Ethernet 1 (default for primary route)
· USB
· Cellular (default for backup route)
If you select Ethernet 1, you are given the option to enter a gateway IP address that is used as the next hop for reaching the destination network.
1
· If the Tracking Object test completed in step 2
was successful, leave this field at the default value (0.0.0.0).
· If the Tracking Object test completed in step 2
failed, enter the gateway IP address in this field.
5.
Set the Destination IP/Network and Destination Subnet Mask.
To configure the RSR destination as a network for this example, enter:
· 64.100.20.128 in the Destination IP/Network field.
1. This applies to both the primary and the Backup interface.
4118127
Rev 2 Nov.15
WAN/Cellular Configuration
· 255.255.255.252 in the Destination Subnet Mask field.
To configure the RSR destination as an individual host for this example, enter:
· 64.100.20.128 in the Destination IP/Network field.
· 255.255.255.255 in the Destination Subnet Mask field.
6.
Set the Tracking Object (Tracking Object 1 or No Tracking Object). Normally, you would select Tracking Object 1 from the drop-down menu.
7.
Under Tracking Object, leave the Enable/Disable Tracking Object set at
Disable until you finish configuring the other Tracking Object fields.
8.
Enter the Test IP address (normally an IP address within the Traffic Selection
Criteria Network/Subnet).
9.
From the drop-down menu, select the desired Test Interface (normally the same interface as the primary route). Options are:
· Ethernet 1
· USB
· Cellular
10. Enter the Test Interval in seconds. This is the interval between Tracking
Object Tests.
For most applications, the default values for the Test Interval, Test Timeout, and Maximum number of retries should be fine.
If you want to change these values, be aware of the following:
· Selecting a short test interval increases network traffic and may lead to false failures if the network is busy.
· Selecting a long test interval may mean that traffic does not switch to the secondary route quickly enough when the primary route fails.
· The test interval must be greater than the product of Test Timeout x
Maximum number of Test Retries.
[Test Interval] > [Test Timeout] x [Maximum number of Retries]
11. Enter the Test Timeout in seconds. This is the time to wait for a response. If this time expires before a response is received, the test attempt fails.
12. Enter the Maximum number of Test Retries. If the first Tracking Object Test fails, this is the number of times the gateway sends additional test messages
(without receiving a response) before it declares the test as failed and switches the specified traffic to the backup network.
13. In the Enable/Disable Tracking Object field, select Enable.
14. In the Enable/Disable RSR field, select Enable.
Go to Status > WAN/Cellular to check the RSR Test Result and confirm that traffic is being sent through the primary route. If the RSR Test Result field indicated that the Tracking Object Test has failed, validate the connectivity of the primary path. (The test result of Unknown indicates that the test has not yet run.)
81
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Dynamic Mobile Network Routing (DMNR)
Note: DMNR is supported only on the Verizon Wireless network.
DMNR provides direct communication between customer sites (for example, between remote subnets and the corporate data center) through a Mobile
Network Operator’s (MNO’s) private network (isolated from Internet traffic).
DMNR creates a tunnel between the home agent on the MNO’s private network and the AirLink gateway.
Primary Access Mode DMNR is supported on Ethernet LANs.
Head Office
MNO
Network
MNO’s Wireless
Private Network
DMNR tunnel
Enterprise to
Home Agent tunnel
Home Agent
AirLink DMNR client
Ethernet
Or
Ethernet
Remote office
Switch
Ethernet
Ethernet
Subnet 1
Router
Up to 8 subnets supported
Ethernet
Subnet 2
Subnet 3
82
Retail environment
Figure 4-10: DMNR Configuration
Before configuring DMNR:
1.
Go to LAN > DHCP/Addressing and ensure that the Host Connection Mode is set to All Hosts Use Private IPs (default).
2.
Go to LAN > Host Port Routing and set the Primary Gateway field to Disable.
3.
Go to VPN and disable any VPNs you have set up.
Once DMNR is configured, all traffic from the connected LANs goes through the DMNR tunnel.
4.
Go to Security > Port Forwarding and set the DMZ Enabled field to Disable.
4118127
WAN/Cellular Configuration
5.
Reboot the gateway.
Note: For the DMNR registration process to complete successfully, there must be a switch, router, or other device physically connected to the AirLink gateway’s Ethernet port.
To configure DMNR:
1.
Go to WAN/Cellular > DMNR Configuration.
Rev 2 Nov.15
Figure 4-11: ACEmanager: WAN/Cellular > DMNR Configuration
2.
Configure the fields as outlined in the following table.
83
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Dynamic Mobile Network Routing
DMNR Enable
Enables Dynamic Mobile Network Routing. Options are:
•
Enable
•
Disable (default) a
Note: Configure all the other parameters first and then set this field to Enable. When this field is set to Enable, the other fields in this window are read-only.
Home Address
Home Agent Address
N-MHAE-SPI
N-MHAE-KEY
Subnet 1 – 8
Enter a home address for the AirLink gateway. This address is used to distinguish the
AirLink gateway used for DMNR. You can enter any IP address for the Home Address, but if you are using more than one AirLink gateway for DMNR, each must have a different home address. Suggested value is 1.2.3.4. This field cannot be left blank.
IP address of the Home Agent (available from your Mobile Network Operator)
NEMO Authentication Extension Security Parameter Index (available from your Mobile
Network Operator)
NEMO Authentication Extension Key (available from your Mobile Network Operator)
Enter the IP addresses for the subnets you want to include in the DMNR network. You can configure up to 8 subnets.
0.0.0.0 indicates that the subnet is not configured.
Note: If you want to remove a subnet from the DMNR configuration, replace the IP address with 0.0.0.0 rather than deleting it.
Subnet 1 – 8 NetMask
Enter the Subnet Masks for the subnets you want to include in the DMNR network.
0.0.0.0 indicates that the subnet mask is not configured.
Note: If you want to remove a subnet mask from the DMNR configuration, replace the IP address with 0.0.0.0 rather than deleting it.
a.
If you disable DMNR when the DMNR tunnel is up, no disconnect message is sent, resulting in a temporary mismatch between the reachability of the (NEMO) subnets on the gateway and the Home Agent.
84 4118127
WAN/Cellular Configuration
3.
Click the + beside Foreign Agent and Reverse Tunnelling Agent.
4.
Configure the Foreign Agent and Reverse Tunnelling Agent.
Field
Foreign Agent
Description
Re-registration Timer
(seconds)
Retry Time Interval
(seconds)
Maximum Retry Count
The frequency with which the foreign agent re-registers its subnets
•
If the registration status is Down, the foreign agent re-registers its subnets when the time configured in this field expires.
•
If the registration status is Up, the frequency with which the foreign agent reregisters its subnets is equal to the Registration Response Lifetime minus the value configured in this field.
The Registration Response Lifetime is usually equal to the Registration Request
. Once you have enabled DMNR, you can confirm the Registration Response Lifetime in ACEmanager.
Options are:
•
1–60 seconds (Default is 60 seconds.)
The interval (in seconds) between retries if the re-registration fails. Options are:
•
1–5 seconds (Default is 5 seconds.)
Maximum number of re-registration tries allowed. Options are:
•
0–5 (Default is 3.)
Registration Request
Lifetime (seconds)
Reverse Tunnelling Agent
Enter the desired registration lease time (in seconds). Options are:
•
0–65534 seconds (Default is 65534.)
Maximum Transmission
Unit - MTU (bytes)
Use this field to set the tunnel MTU for packets sent over the DMNR/GRE tunnel. Note that the tunnel adds 24 bytes to each packet so the tunnel MTU should be set at least 24 bytes lower than the Mobile Network MTU in order to avoid packet fragmentation.
Options are:
•
576–1500 (Default is 1476.)
Maximum Segment Size
- MSS (bytes)
Use this field to set the TCP maximum segment size for the packets (in bytes). Options are:
•
68–1436 (Default is 1436.)
Force Fragmentation
Allows you to override the “Do not fragment” bit in the incoming packet header and send large packets through the DMNR tunnel
Options are:
•
Enable—The “Do not fragment” bit in incoming packet header is cleared. This setting is useful if you need to send large packets or you do not know the MTU of all the routers in the network path.
•
Disable — The “Do not fragment” bit in the incoming packet header is respected. If the bit is set, packets larger than the MTU are dropped. If the DF bit is clear, packets larger than the MTU are fragmented and sent. (Default)
5.
In the DMNR Enable field, select Enable.
Once DMNR is enabled, the fields are read-only. If you want to change any of the field entries, set the DMNR Enable field to Disable, make the required change, and then set the field to Enable.
Rev 2 Nov.15
85
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
86
Figure 4-12: ACEmanager: WAN/Cellular > DMNR Enabled
4118127
WAN/Cellular Configuration
Once DMNR is enabled, additional status fields appear, as described in the following table.
Field
Dynamic Mobile Network Routing
Subnet 1 – 8 Accepted
Description
Confirms that the subnet configuration is accepted. Options displayed are:
•
Yes—The subnet is configured and accepted.
•
No—The subnet is not configured or not accepted.
Foreign Agent
Registration Status
Foreign agent registration status
Options displayed are:
•
Pass—A response has been received from the Home Agent
•
Fail—No response from the Home Agent
•
Unknown—Initial state
Registration Response
Lifetime (seconds)
Shows the length of the current lease time (in seconds).
Total RRQ sent
Number of Registration Requests sent
Total RRP received
Reverse Tunnelling Agent
Number of Registration Responses received
Reverse Tunnelling
Agent Status
Force Fragmentation
TX packets
RX packets
DMNR tunnel status
This field only appears when DMNR is enabled. Options displayed are:
•
Up—DMNR tunnel is up.
•
Down—DMNR tunnel is down.
Status of the Force Fragmentation field
•
Enabled
•
Disabled
For more information, see
Force Fragmentation on page 85.
Number of packets transmitted
The counter is reset when:
•
DMNR is disabled.
•
When the DMNR tunnel ( Reverse Tunnelling Agent Status
) is down.
Number of packets received
The counter is reset when:
•
DMNR is disabled.
•
When the DMNR tunnel ( Reverse Tunnelling Agent Status
) is down.
Rev 2 Nov.15
87
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
88 4118127
5: LAN Configuration
You can use the AirLink gateway to route data between one or more connected devices and the Internet via the mobile network. The
AirLink gateway has two modes you can use for configuring a LAN—
Private Mode and Public Mode.
Private and Public Mode
Private mode
Private Mode and Public Mode are Sierra Wireless terms. In Private
Mode, the router or laptop connected to the AirLink gateway has a
LAN IP address. In Public Mode the AirLink gateway passes the WAN
IP address to the router or laptop.
Public mode
5
Internet Internet
WAN IP address
WAN IP address
AirLink gateway
AirLink gateway
WAN IP address
LAN IP address
Router or laptop
Figure 5-1: Private vs. Public Mode
Router or laptop
Private Mode
Private Mode uses Network Address Translation (NAT) to enable the non-routable device to access the Internet. Data from the connected devices is passed through the AirLink gateway. By default, the first connected Ethernet or USBnet host is the DMZ host.
Rev 2 Nov.15
89
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Public Mode
Public Mode is similar to IP pass-through. When Public Mode is enabled, by default the Public Mode host becomes the DMZ host. Public Mode is required when the connected device needs a routable IP address and has no other connection to obtain it.
Tip:
When using Public Mode, Sierra Wireless recommends connecting the AirLink gateway directly to the computer or other end device. Using a hub or switch may prevent the AirLink gateway from updating the IP address of the end device when an IP address is received from the mobile network.
Port Use
Applications running on a LAN client such as a router or laptop must use different ports from those used by ALEOS features on the AirLink gateway. For a list of
inbound ports used by ALEOS, see Inbound Ports Used by ALEOS on page 366.
DHCP/Addressing
This section is primarily a status display of the configurations, with a few options that are global to all interface types. Interfaces that are enabled in the current configuration are displayed with their configured settings.
DHCP addresses and subnets are assigned to the LAN side interfaces display.
Note: If the gateway has not been reset since configuration changes were made, the current configuration in use may be different.
90 4118127
LAN Configuration
Rev 2 Nov.15
Figure 5-2: ACEmanager: LAN > DHCP/Addressing
91
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
General
Host Connection
Mode
Description
Sets the Host Interface to use the Public IP address granted by the mobile network or private IP addresses. All host interfaces which are not using the public IP address use private IP addresses. The options are:
•
Ethernet Uses Public IP*
•
All Hosts Use Private IP—(default)
•
USB Uses Public IP*
•
Serial DUN Uses Public IP*
•
First Host gets Public IP*
If you select this option, you do not have to specify the type of connection that uses the Public IP address. The first device to connect uses the Public IP address, regardless of whether it has a USB or Ethernet connection.
* Until the gateway is able to obtain a mobile network connection, it provides private IP addresses in response to DHCP requests.
For more information on Private and Public mode, see
Private and Public Mode on page 89.
Note: If you plan on using
Dynamic Mobile Network Routing (DMNR)
, select Ethernet
Uses Public IP in this field.
Note: The connected computer receives the DHCP address from ALEOS and it also provides a static route (192.168.13.31 by default) that allows you to access ACEmanager from a connected device.
Public Mode Subnet
Mask
Lease Timer
(seconds)
LAN Address
Summary
Interface
Device IP
This field appears when Ethernet, USB, or Serial (RS232) Uses Public IP is selected in the
Host Connection Mode field. Public Mode subnet mask indicates the range of Public Mode host IP addresses. Options are:
•
255.255.255.0 (24-bit) (default)
•
255.255.255.255 (32-bit)
Choose the option that matches the subnet mask received from the mobile network.
The amount of time the DHCP client is given for the use of the IP address (in seconds)
Options are:
•
120–4294967295—Number of seconds the IP address is leased for.
If you want to set the value to “infinity”, enter 4294967295 (equivalent to 136 years).
The actual maximum value depends on the maximum supported by your DHCP client.
The default lease time is 3600 seconds (1 hour).
Displays the interfaces which have been enabled. By default, only the Ethernet and
USBNET Interfaces are enabled.
This table also includes VLAN if configured.
The physical interface port or VLAN ID
The IP address of the AirLink gateway for the specified interface port. By default, this is set to 192.168.13.31 for Ethernet, and 192.168.14.31 for USB/net.
92 4118127
LAN Configuration
Field
Subnet Mask
Access WAN
DHCP Server Mode
Starting IP
Ending IP
Description
Subnet mask indicates the range of device IP addresses that can be reached directly.
Changing this limits or expands the number of clients that can connect to the AirLink gateway. The default of 255.255.255.0 means that 253 clients can connect to the AirLink gateway. Uses 192.168.13. as the first three octets of the IP address if the gateway IP is
192.168.13.31.
Appears if the interface is configured to allow connected device(s) access to the Internet
Note: Internet access cannot be disabled for Ethernet hosts.
Indicates whether or not the interface has a DHCP server enabled to provide dynamically allocated IP addresses provided to connected devices
Note: The DHCP server can only be disabled for Ethernet and VLAN.
Ethernet DHCP pool starting IP address (DHCP low address)
The ending IP for the interface (DHCP high address). If the starting and ending IP are the same, there is a single address in the pool and only one connected device receives an IP address from the DHCP server for that interface. Some interfaces, such as USB, can only have a single device connection. For others, statically assigned IP addresses in the same subnet, but outside of the DHCP pool, can still connect and use the gateway in the same way as a DHCP connected device.
Tip:
If you are using Private Mode for all hosts (*HOSTPRIVMODE=1), make sure that device IP, Starting IP, and Ending
IP are on the same subnet defined by the DHCP network mask. If the subnet mask is 255.255.255.0, it is safe to use
192.168.x.y for each as long as the x is the same number (0 in the example screen shot above) and the y is different (1 and 2 in the example) and between 1 and 254.
DHCP Options
Enables IT Administrators to configure up to 10 DHCP options, allowing you to push DHCP options to connected devices.
Interface
Select the interface to use:
•
All (default)
•
Ethernet
•
USB
Note: VLAN hosts only receive the DHCP options when the Interface is set to All.
Option Code
Option Value
Choose from the options in the drop-down menu. For a list of supported Option Codes, see
. For additional information on the option codes, refer to the Internet Engineering
Task Force (IETF) memorandum on Internet Protocols and Standards, RFC-2131.
The format for the option value depends on the
Option Code selected, as formats must
conform with RFC 2132. For a list of accepted formats for each of the supported DHCP
Use a comma to separate multiple values.
DHCP Vendor Specific Options
Enables IT Administrators to configure up to 5 vendor-specific options
Rev 2 Nov.15
93
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Vendor Class
Enter the vendor class
Vendor Option Code
Enter the vendor option code. Possible entries are:
•
0–255
Vendor Option Length
This field allows you to specify the DHCP vendor specific option length in order to ensure that the DHCP datagram is correctly formatted for the DHCP client. Options are:
•
Undefined— Use this setting for IP addresses and strings (default)
•
1 byte—Use for decimal values of 255 or less
•
2 bytes—Use for decimal values between 256 and 65535
•
4 bytes—Use for decimal values greater than 65535
Note: If the size used for the data is not correct, the option is ignored by the client.
Vendor Option Value
Enter the vendor option value in one of the following formats:
•
Dotted-quad IPv4 address
•
Decimal number
•
Colon-separated hex digits
•
Text string
Use a comma to separate multiple values.
Table 5-1: Supported DHCP Options
DHCP Option
002 Time Offset
003 Router
007 Log Server
009 LPR Server
013 Boot File Size
015 Domain Name
016 Swap Server
017 Root Path
018 Extension Path
019 IP Forward Enable/Disable
020 Non-Local Source Routing
021 Policy Filter
022 Max Datagram Reassembly Size
94
Type of entry Accepted values
(if applicable)
-43200–43200 a
32-bit unsigned integer
1 or more IP addresses
1 or more IP addresses
1 or more IP addresses
16-bit unsigned integer
Fully Qualified Domain Name
(FQDN)
1 or more IP addresses
1–65535
ASCII string
ASCII string
Single octet Boolean
Single octet Boolean
0 (Disable) or 1 (Enable)
0 (Disable) or 1 (Enable)
1 or more pairs of IP addresses or
IP address/mask pairs
16-bit unsigned integer 576–65535
4118127
LAN Configuration
Table 5-1: Supported DHCP Options
DHCP Option Type of entry
023 IP TTL
026 Interface MTU
8-bit unsigned integer
16-bit unsigned integer
027 All Subnets Are Local
031 Perform Router Discovery
032 Router Solicitation Address
034 Trailer Encapsulation
035 ARP Timeout
036 Ethernet Encapsulation
037 TCP TTL
Single octet Boolean
Single octet Boolean
Single IP address
Single octet Boolean
32-bit unsigned integer
Single octet Boolean
8-bit unsigned integer
038 TCP Keepalive
040 NIS Domain
041 NIS Server
042 NTP Server
32-bit unsigned integer
ASCII string
Single IP address
Single IP address
044 NetBIOS Name Server
1 or more IP addresses
045 NetBIOS Datagram Distribution Server
1 or more IP addresses
046 NetBIOS Node Type
047 NetBIOS Scope
8-bit unsigned integer
ASCII string
048 X Windows System Font Server
049 X Windows System Display Manager
064 NIS+ Domain
065 NIS+ Server
066 TFTP Server
1 or more IP addresses
1 or more IP addresses
Domain name
Single IP address
ASCII string or IP address
067 Bootfile Name
068 Mobile IP Home
069 SMTP Server
ASCII string
1 or more IP addresses
1 or more IP addresses
070 POP3 Server
071 NNTP Server
1 or more IP addresses
1 or more IP addresses
074 IRC Server
1 or more IP addresses a.
The time offset is entered as seconds. See
for a list of hour/second conversions.
Accepted values
(if applicable)
1–255
68–65535 (Default is
1500.)
0 (Disable) or 1 (Enable)
0 (Disable) or 1 (Enable)
0 (Disable) or 1 (Enable)
6–65535
0 (Disable) or 1 (Enable)
1–255
0–65535
Domain name
1, 2, 4, or 8
Name, domain name, or
IP address
Name
Rev 2 Nov.15
95
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table 5-2: Time Offset Hour / Second conversions
Hour Seconds Hour
7
8
9
10
11
12
5
6
3
4
0
1
2
25200
28800
32400
36000
39600
43200
0
3600
7200
10800
14400
18000
21600
-5
-6
-7
-8
-1
-2
-3
-4
-9
-10
-11
-12
-3600
-7200
-10800
-14400
-18000
-21600
-25200
-28800
-32400
-36000
-39600
-43200
Seconds
Internal DHCP Server
DHCP (Dynamic Host Configuration Protocol) has become a primary component of today’s network environments. DHCP allows one server to automatically and dynamically allocate network IP addresses and other network related settings
(such as subnet masks, routers, etc.) to each computer or device without the need to set up each specifically or keep track of what addresses have already been used.
In a default configuration, the AirLink gateway acts as a DHCP host to any device connected to its ports. This DHCP host provides that device with an IP address that can be used to communicate on the Internet.
Address Assignment in Public Mode
1.
When the AirLink gateway registers on the mobile network, it is assigned an
IP address from the carrier, e.g., 10.1.2.0.
2.
When using a specific interface, the AirLink gateway acts as a DHCP server unless disabled. When the Host Connection Mode is Ethernet Uses Public IP, and the AirLink gateway receives a DHCP request from an Ethernet device connected to its ports, it hands off the assigned address to the device and sets up the default gateway address as 10.1.2.1. If the fourth octet value is already a 1, it assigns 10.1.2.2 as the router address.
96 4118127
LAN Configuration
Note: The primary gateway to the mobile network, for any connected device, is enabled by default.
3.
The AirLink gateway also sends a /24 netmask (255.255.255.0 by default) and sets up a static route which maps 192.168.13.31 (or the address configured with *HOSTPEERIP if it is changed) to 10.1.2.1 (or 10.1.2.2 if that was what the gateway address was given as).
Tip:
When PPPoE is used with the AirLink gateway, the DHCP server needs to be disabled. A tunnel is set up connecting a device (such as your computer or a router) with the AirLink gateway. The device then uses the MAC address of the AirLink gateway to send all outgoing packets.
Ethernet
The AirLink gateway is equipped with an Ethernet port that can be enabled or disabled as needed. When the port is disabled, the connected device cannot connect via Ethernet, and ARP queries do not receive responses on the port.
Rev 2 Nov.15
Figure 5-3: ACEmanager: LAN > Ethernet
97
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
General
Ethernet Port
Description
Device IP
Starting IP
Enabled or Disabled
Note: When the port is disabled, the device ignores any physical connection to the
Ethernet port.
The Ethernet IP address of the AirLink gateway. By default this is set to 192.168.13.31.
Ethernet DHCP pool starting IP address
Default is 192.168.13.100.
Note: If only one computer or device is connected directly to the Ethernet port, this is the
IP address it is assigned.
Ending IP
DHCP network mask
DHCP Mode
The ending IP address for the Ethernet interface DHCP pool
Default is 192.168.13.150.
The Netmask given to any Ethernet DHCP client
Default is 255.255.255.0.
Determines how DHCP operates on the Ethernet interface
Options are:
•
Server—The AirLink gateway acts as a DHCP server for all Ethernet connections.
•
Disable—The AirLink gateway acts as neither a DHCP server or client. All devices connected to the AirLink gateway must have a static LAN IP or use PPPoE.
•
Auto—When the gateway is powered on or reboots, it attempts to determine if a
DHCP server is present on the Ethernet network. If a DHCP server is found, the gateway obtains an IP address and uses Ethernet for communication with AirLink
Management Service (ALMS). If a DHCP server is not found, the gateway becomes a DHCP server. (default)
Most of the time you can leave this field set to the default value.
Advanced
Link Radio coverage to
Interface
This disables the specified port when there is no cellular coverage. Options are:
•
Disable (default)
•
Ethernet
•
USB
Radio Link Delay
(seconds)
The delay in seconds before the selected interface goes down when there is no cellular coverage
98 4118127
LAN Configuration
Field
Interface Disabled
Duration
Turn Off NAT
Ephemeral Port
Description
Sets the period of time (in seconds) that the LAN interface is disabled when linking a LAN port to radio coverage. Either the Ethernet or the USB LAN port can be linked to the radio coverage, but not at the same time. Options are:
•
Interface Disabled when Radio is disconnected (default)
•
5 Sec
•
10 Sec
•
15 Sec
•
20 Sec
•
25 Sec
•
30 Sec
When enabled, ALEOS routes outbound packets from connected devices without performing NAT on them. For example, when a connected device that has an IP address of 192.168.13.100 sends data to a remote destination, the outbound packets have a source IP of 192.168.13.100.
In most cases, it is best to leave this field at the default setting (Disabled), as most mobile network operators do not support this functionality.
Enable or Disable the Ephemeral Port feature
•
Disable—The source port in packets the AirLink gateway receives from a connected device and then sends out is not changed. The source port assigned to the packet when it was created in the customer’s connected device is used. (default)
•
Enable—The AirLink gateway changes the source port on all outgoing NATed UDP packets, using the range configured in the Starting Ephemeral Port field.
Rev 2 Nov.15
99
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Starting Ephemeral Port
This field appears only when the Ephemeral Port field is set to Enable. It allows you to set the starting port range used by a LAN device as the source port for over-the-air (OTA) destinations using NAT.
Note: This field is intended for advanced users only. In most cases, use the default value.
The NAT for the LAN device uses a range of 1000 ports as source ports for OTA destinations beginning with the configured Ephemeral port. Options are:
•
1024 (default)–64535
If you have a network with multiple LAN devices that are sending data to the same server and the server is not receiving data from one (or more) of the devices, it may be because the Mobile Network Operator has a WAN firewall that is blocking the ports used by the
NAT for over-the-air (OTA) destinations. This field enables you to avoid the blocked ports by changing the source port range used to send the data. For example, some users have found that changing the starting port to 42000 has resolved the issue.
Note: The ephemeral port setting does not affect any outbound traffic initiated by the device such as Events Reporting, Device Initiated ALMS connection, etc.
Ethernet 1 Link Setting
Configures the Ethernet port speed and duplex setting
Most of the time you can leave the default setting and the device you are connecting automatically negotiates the speed and duplex setting with the AirLink gateway.
However, if the connected device has a fixed setting, use this field to change the AirLink gateway setting to match that of the connected device.
Note: If you select 100 Mb Full Duplex or 10 Mb Full Duplex for the gateway, ensure that the same speed is selected on the connected device.
•
Auto 10/100 (default)
•
Auto 10 Mb only
•
100 Mb Full Duplex
•
100 Mb Half Duplex
•
10 Mb Full Duplex
•
10 Mb Half Duplex
You can view the current speed and duplex setting on the Status > LAN page. See
USB
The AirLink gateway is equipped with a USB port that increases the methods by which you can send and receive data from a connected computer. You can set up the USB port to work as either a virtual Ethernet port or a virtual serial port, or you can disable it to prevent access by USB. You may need to install a USB driver
to use these modes. For more information, see Installing the USB Drivers on page 102.
By default, the port is set to work as a virtual Ethernet port.
100 4118127
LAN Configuration
Note: Sierra Wireless recommends that you use a USB 2.0 cable with your AirLink gateway and connect directly to your computer for best throughput.
To change the USB port to allow virtual serial port communication:
1.
In ACEmanager, go to LAN > USB, and choose USB Serial as the USB
Device Mode.
To disable the USB port, select Disable from the same menu.
Figure 5-4: ACEmanager: LAN > USB
Field
General
USB Device Mode
Description
The USB mode on gateway startup
•
USB Serial—USB port acts as a virtual Serial port.
•
USBNET—USB port acts as a virtual Ethernet port. (default)
•
Disabled—USB port is disabled.
You can also configure this parameter using the AT Command *USBDEVICE. See
Note: A reboot is required to activate the USB mode change.
Device USB IP
Host USB IP
Note:
The USBNET IP address of the AirLink gateway. By default this is set to 192.168.14.31.
The IP for the computer or device connected to the USB port
Rev 2 Nov.15
101
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
USB Network Mask
Description
Use this field to configure a subnet mask for USBNET
Default is 255.255.255.0
USB Serial Echo
USBNET Host WAN
Connectivity
The AT command echo mode when the USB is configured as a virtual serial port
Options:
•
Enable—Echoes commands to the computer (so you can see what you type) (default)
•
Disable—Does not echoes commands to the computer (you cannot see what you type)
Controls access to the WAN over the USB port
Options are:
•
Enable—USB can be used to access the WAN (default)
•
Disable—Access to the WAN over USB is blocked.
Advanced
Link Radio Coverage to Interface
Radio Link Delay
(seconds)
Interface Disabled
Duration
Disables the specified port when there is no cellular coverage. Options are:
•
Disable (default)
•
Ethernet
•
USB
The delay in seconds before the selected interface goes down when there is no cellular coverage
Valid range is 0–65535. Default is 10.
Sets the period of time (in seconds) that the LAN interface is disabled when linking a LAN port to radio coverage. Either the Ethernet or the USB LAN port can be linked to the radio coverage, but not at the same time. Options are:
•
Interface Disabled when Radio Disabled (default)
•
5 seconds
•
10 seconds
•
15 seconds
•
20 seconds
•
25 seconds
•
30 seconds
Installing the USB Drivers
A USB driver is required if you want to use the USB port on the gateway as a virtual serial port (USB Serial). If you want to use the USB port as a virtual
Ethernet port (USBnet), a driver is not required as the default Microsoft Windows
7 and Windows 8 drivers are used.
To install the USB Serial drivers for Windows 7 and Windows 8:
1.
Go to source.sierrawireless.com
and download the USB Serial Driver One-
Click Tool.
2.
Double-click the downloaded file (AirLink_Serial_<version number>.exe).
3.
As the drivers installs, a progress box appears in the lower right-hand corner of the monitor.
102 4118127
LAN Configuration
Figure 5-5: USB Serial One-Click Tool progress window
4.
In ACEmanager, go to LAN > Ethernet and set the USB Device Mode field to
USB Serial.
5.
Connect a gateway to the computer using a USB cable.
The driver installation completes and a window opens indicating the Serial
Port number.
Figure 5-6: USB Serial Driver Installation Complete
At any time, you can open Device Manager to check the Serial Port number.
Rev 2 Nov.15
Figure 5-7: Device Manager
Note: USB serial and USBnet drivers available at
source.sierrawireless.com
also work with Linux CDC-ACM drivers.
103
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Note: The COM port number assigned by driver installation is the next port that is available.The port number might vary depending on the number of devices connected
(using serial or virtual serial).
Once the driver is installed, you can use the USB port just like a standard serial port.
Host Port Routing
Host port routing enables the AirLink gateway to handle network communication for up to two non-NATed networks behind the gateway or router connected to the
AirLink gateway. The following illustration shows a typical network configuration.
Note: The AirLink gateway does not handle addressing for devices behind the router or gateway.
Internet
AirLink gateway
Switch
192.168.13.20
Router
Gateway
192.168.10.0/24
Host Network 2
Figure 5-8: Host Port Routing Network Configuration
192.168.20.0/24
Host Network 3
104 4118127
LAN Configuration
Figure 5-9: ACEmanager: LAN > Host Port Routing
Field
Primary Gateway
Description
When enabled, your AirLink gateway is the primary gateway for connected LANs and responds to Address Resolution Protocol (ARP) requests to resolve WAN addresses for devices on the connected LANs. Default is Enabled.
Host Network 2 and
Host Network 3
Enter the IP address for Host Network 2 and 3. These are LAN networks connected to the AirLink gateway behind a router or gateway. They do not have the same IP range as the AirLink gateway LAN network. For example, 192.168.10.0.
Host Network Subnet
Mask 2 and Host
Network Subnet Mask 3
The subnet for the applicable network. For example, 255.255.255.0, which would with the setting above define a secondary network of 192.168.10.0/24.
Host Network 2 Route and Host Network 3
Route
Host Network 2
Gateway and Host
Network 3 Gateway
Indicates whether a router or gateway is being used for the host network. Options are:
•
Ethernet— Select this option if the network uses a router that acts as an ARP proxy for addresses on its subnet.
•
Gateway—Select this option if the network uses a device that does not handle ARP requests. When Gateway is selected, ALEOS handles ARP requests for the connected LAN devices. Any traffic destined for a host on the network behind a gateway is routed, by the device, through the gateway IP.
•
If you selected Gateway in the Host Network Route field, enter the IP address for the gateway.
•
If you selected Ethernet in the Host Network Route field, leave this field as 0.0.0.0.
Global DNS
When the mobile network grants the IP address to the device, it includes the IP addresses of its DNS servers. Global DNS allows you to override the Mobile
Network Operator’s DNS settings for all connected devices. This is useful when the connected devices need to use a private network.
Rev 2 Nov.15
105
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Note: If there are no alternate DNS servers defined, the default is the WAN network DNS server.
Figure 5-10: ACEmanager: LAN > Global DNS
Field
Primary DNS
Secondary DNS
DNS Proxy
Description
Primary Mobile Network Operator’s DNS IP Address. This and the secondary DNS are generally granted by the mobile network along with the Network IP.
Secondary Mobile Network Operator’s DNS IP Address
Determines whether or not the AirLink gateway is used as a DNS proxy server.
Note: Using the AirLink gateway as a proxy DNS server can help reduce mobile network data use.
Options are:
•
Enable (default) —All connected DHCP clients (PPP, PPPoE, USBNET, and Ethernet) send their DNS IP address resolution requests to the AirLink gateway. The AirLink gateway performs DNS lookups on behalf of the DHCP client.
•
If the AirLink gateway is able to resolve the request, it sends a response to the
DHCP client.
•
If the AirLink gateway does not have the necessary information to resolve the request, it sends the request to the DNS server configured in the DNS Override field. When the AirLink gateway receives a response, it forwards it to the DHCP client and saves the information so that it can resolve the same request in the future.
•
Disable—All connected DHCP clients send their DNS IP address resolution requests to the DNS server received from the mobile network or the alternate server specified by DNS Override, if enabled. The AirLink gateway is not used as a DNS server.
106 4118127
LAN Configuration
Field
DNS Override
Alternate Primary
DNS
Alternate Secondary
DNS
Alternate DNS Port
Description
Overrides the Mobile Network Operator’s DNS address with the DNS server configured in the Alternate Primary DNS and Alternate Secondary DNS fields.
Options are:
•
Disable (default)—Mobile Network Operator’s DNS server is used
•
Enable—Alternate DNS server is used
Configure the primary DNS server to use instead of the Mobile Network Operator’s DNS server
Configure the secondary DNS server to use instead of the Mobile Network Operator’s DNS server
If you want to specify the port on the connected device that the AirLink gateway sends IP address resolution responses to:
1.
Ensure that the DNS Override field is set to Enable.
2.
Enter the desired port number in this field.
3.
Click Apply.
When this field is set to 53 (default) or 0, packets are sent to port 53, the standard DNS port.
PPPOE
PPPoE (Point-to-Point Protocol over Ethernet) allows a point-to-point connection while using Ethernet. Just like the dial up protocol on which it is based, PPPoE can use traditional user name and password authentication to establish a direct connection between two Ethernet devices on a network (e.g., your AirLink gateway and your computer or router).
examples for PPPoE with your AirLink gateway:
•
Backup connectivity solution for your network
•
Individualized Internet connection on a LAN
•
Password restricted Internet connection
Only one computer, router, or other network device at a time can connect to the
AirLink gateway using PPPoE. If you are using the AirLink gateway connected to a router as a back up Internet connection for your network, you should configure the router to use the PPPoE connection and not the individual computers.
Note: To configure a PPPoE connection on some operating systems, you need administrator privileges to the computer you are configuring or access granted by an administrator on the network to add/remove devices to your computer.
Rev 2 Nov.15
107
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 5-11: ACEmanager: LAN > PPPoE
Field
Host Authentication
Mode
Host User ID
Host Password
Description
Host Authentication Mode: Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW is used.
•
NONE (default)
•
PAP and CHAP
•
CHAP
User ID for authentication (up to 64 bytes)
Password for authentication
Configure the AirLink gateway to Support
PPPoE
Note: You must disable the DHCP server for PPPoE to work.
To configure an AirLink gateway to support PPPoE:
1.
In ACEmanager, go to LAN > Ethernet.
2.
Under General, in the DHCP Server Mode field, select Disable.
Note: PPPoE authentication is optional. If you use PPPoE authentication, no other tethered LAN connection will have network access, regardless of whether or not the
PPPoE host is connected. If you are using non-authenticated PPPoE, other tethered LAN connections will have network access until a PPPoE host is connected.
108 4118127
LAN Configuration
3.
If you want to use authenticated PPPoE:
a.
Go to LAN > PPPoE, and in the Host Authentication Mode field, select
PAP and CHAP.
b. In the Host User ID, enter a user ID for the PPPoE connection.
c.
In the Host Password field, enter a password for the PPPoE to connection.
4.
Click Apply.
5.
Reboot the gateway.
Tip:
If you leave Host User ID and Host Password blank, any computer or device can connect to the AirLink gateway using PPPoE.
Note: ACEmanager shows the existing value for the PPPoE password as stars (****).
Optional: Configure the Device Name
1.
In ACEmanager, go to Services > Dynamic DNS.
2.
In the Service field, select IP Manager.
3.
Under Dynamic IP, enter a name in the Device Name field, such as AirLink gateway or the ESN. The name can be up to 20 characters long.
The name you choose for Device Name does not affect the connection, but may need to be configured in PPPoE settings for the router, device, or computer you connect to your AirLink gateway.
Configuring a PPPoE Connection in Windows 7
1.
In Windows 7, go to Start > Control Panel.
Rev 2 Nov.15
Figure 5-12: Windows 7: Control Panel
109
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
2.
Select Network and Internet.
Figure 5-13: Windows 7: Control Panel > Network and Internet
3.
Select Network and Sharing Center.
110
Figure 5-14: Windows 7: Control Panel > Network and Sharing Center
4.
In the middle of the page, under Change your networking settlings, select Set up a new connection or network.
4118127
LAN Configuration
Figure 5-15: Set Up an Connection or Network
5.
Select Connect to the Internet and click Next.
Rev 2 Nov.15
6.
Select Broadband (PPPoE).
111
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
112
7.
If you are using authenticated PPPoE, enter the User name and Password you configured in ACEmanager.
8.
If desired, change the Connection name to something such as PPPoE that clearly identifies the connection.
9.
Click Connect.
For subsequent connections, you can click the network icon in the Task bar ( ) and select the PPPoE connection.
VLAN
ALEOS supports up to three Virtual Local Area Networks (VLANs) on its Ethernet port. VLANs are logical groupings of network devices that share the same broadcast domain. All devices on the same VLAN can ping each other without routing. ALEOS does not support routing between VLANs.
Note: The VLANs must also be configured on the switch.
4118127
LAN Configuration
WAN
VLAN Switch
AirLink gateway
Connected device on VLAN 1
Connected device
on VLAN 1
Connected device on VLAN 2
Connected device on VLAN 2
Figure 5-16: VLAN network configuration
Connected device on VLAN 1
Connected device on VLAN 2
Field
Interface
VLAN ID
Device IP
Subnet Mask
Figure 5-17: ACEmanager: LAN > VLAN
Description
Displays the three VLANs you can configure
VLAN ID
•
0—VLAN is disabled (default)
•
1–4094—Valid range for VLAN ID
The IP address of the AirLink gateway for that VLAN interface
The subnet mask indicates the range of host IP addresses that can be reached directly.
Changing the subnet mask limits or expands the number of devices that can connect to the
AirLink gateway.
Rev 2 Nov.15
113
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Access WAN
DHCP Server Mode
Starting IP
Ending IP
Description
Choose whether or not devices on the configured VLAN have access to the WAN.
•
Yes
•
No
Choose whether or not the AirLink gateway acts as a DHCP server
Options are:
•
Enable—AirLink gateway acts as the DHCP server
•
Disable (default)
VLAN interface DHCP pool starting IP address
VLAN interface DHCP pool ending IP address
VRRP
VRRP (Virtual Router Redundancy Protocol) enables you to configure a backup
WAN connection to be used if the primary connection fails. You can configure
VRRP on the AirLink gateway’s Ethernet port or for VLANs.
You configure a VRRP Master and VRRP Backup device(s) and set their priorities. The device with the highest priority (normally the VRRP Master) becomes the primary route for the data connection.
The VRRP Master and Backups share a common virtual IP.
For information on configuring VLANs, see VLAN on page 112.
One common scenario is to use a 3rd party router for the primary connection and the AirLink gateway, either with or without VLANs, for the backup connection.
WAN
Backup WAN connection
Primary WAN connection
Router (VRRP Master)
Switch
AirLink gateway
(VRRP Backup)
Connected device
Connected device Connected device Connected device Connected device
Figure 5-18: VRRP Network Configuration without VLANs
Connected device
114 4118127
Rev 2 Nov.15
LAN Configuration
WAN
Backup WAN connection
Primary WAN connection
Router (VRRP Master)
VLAN Switch
AirLink gateway
(VRRP Backup)
Connected device on VLAN 1
Connected device
on VLAN 1
Connected device on VLAN 2
Connected device on VLAN 2
Figure 5-19: VRRP Network Configuration with VLANs
Connected device on VLAN 1
Connected device on VLAN 2
Figure 5-20: ACEmanager: LAN > VRRP (no VLANs)
115
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
116
Figure 5-21: ACEmanager: LAN > VRRP (VLANs)
You can also set up VRRP using two AirLink gateways —one configured as the
VRRP Master and the other as the VRRP Backup. The Backup AirLink gateway provides an alternate route when the Master AirLink gateway loses coverage.
For example, if you have cellular accounts with two different Mobile Network
Operators (MNOs) you might prefer to use MNO A’s connection, but to maintain continuity, you would like traffic to switch to MNO B if A’s network is down and switch back to A’s network once the connection is re-established.
WAN
Wireless connection on MNO A’s network (primary route for data)
Wireless connection on
MNO B’s network
(Backup route for data when the primary route is down)
AirLink gateway on MNO A’s network
(VRRP Master, with priority configured as 100, for example)
Switch
AirLink gateway on MNO B’s network
(VRRP Backup, with priority configured as 75, for example)
Connected device Connected device Connected device
Figure 5-22: VRRP Network Configuration using two AirLink gateways
4118127
LAN Configuration
Field
Group ID
Priority
Virtual IP
Description
VRRP Enabled
Allows you to activate VRRP. Options are:
•
Enable
•
Disable (default)
VRRP — The VLAN ID, Group ID, and Virtual IP address must be the same on the VRRP Master and
VRRP Backup devices.
Interface
Displays Ethernet port on AirLink gateway and the VLAN numbers
VLAN ID
Displays the VLAN ID
This value is inherited from the LAN > VLAN screen. (See VLAN on page 112.)
•
0—VLAN is disabled
•
1– 4094—Valid range for VLAN ID
Enter the VRRP Group ID. Configure the VRRP Master (for example, the 3rd party router) and the VRRP Backup (for example the AirLink gateway) with the same Group ID.
Options are:
•
0–255 (Default is 0.)
Use this field to configure the priority for the AirLink gateway.
The device with the highest priority (typically a 3rd party router) provides the primary data traffic route. If the device loses its connection to the WAN, its priority number drops. If the device fails, then when the failure is detected, the next highest priority router becomes the active router.
The priority number configured on the VRRP Backup (typically the AirLink gateway) should be less than the initial priority number on the VRRP Master and greater than the value that the VRRP Master’s priority number would be if it drops as a result of losing its WAN connection.
For example, if the VRRP Master router has an initial priority number of 200 that drops to
80 if it loses its WAN connection, setting the AirLink gateway’s priority to 100 ensures that it becomes the primary route if the VRRP Master loses its WAN connection. When the 3rd party router re-establishes its connection, its priority returns to 200 and it once again becomes the primary route for data.
Options are:
•
1–255 (Default is 100.)
Configure the same virtual IP for the VRRP Backup (typically the AirLink gateway) and the
VRRP Master (typically a 3rd party router). The virtual IP must be unique within the VLAN subnet and cannot be within a pool of addresses assigned via DHCP.
Rev 2 Nov.15
117
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Mode
Interval
Description
Indicates the initial mode for the AirLink gateway
Options are:
•
MASTER
•
BACKUP (default)
Note: Designating a device as “Master” in this field does not make it the primary route for data unless it is also given a higher priority number than the VRRP Backup device. See
If the AirLink gateway is acting as VRRP Master, it advertises its Master status at the interval (in seconds) configured in this field. Options are:
•
1–65535 seconds (Default value is 1.)
Host Interface Watchdog
The Host Interface Watchdog provides a way for you to ensure that the LAN connection is alive. You can use this feature to monitor:
•
A host connected to the LAN via an Ethernet or USB connection
When the Host Interface Watchdog is enabled, ALEOS sends a ping to the connected device at configured intervals. You can disable Force Keepalive to only send a ping when there is no traffic on the LAN interface. (See
If there is no response to the ping, the LAN interface is reset.
Note: The network interface is automatically determined from the IP address and the LAN configuration.
After the interface comes back up, ALEOS sends another ping to the connected device. If there is still no response to this ping, the AirLink gateway reboots. After a reboot caused by the LAN Interface Watchdog, ALEOS waits an hour before attempting pings to prevent repeated frequent reboots.
Note: DUN (PPP) is not supported. If the IP address for the host is on a DUN network, the feature is disabled.
Note: The feature is not disabled when the interface uses Public Mode, but it cannot monitor the host interface unless the mobile network provides a static IP.
118 4118127
LAN Configuration
Figure 5-23: ACEmanager: LAN > Host Interface Watchdog
Field
LAN Keepalive IP address
LAN Keepalive
Interval (minutes)
Force LAN Keepalive
Description
Enter the IP address of the device to ping
If a device IP address is not configured, the Host Interface Watchdog is disabled.
The interval (in minutes) at which ALEOS pings the LAN-connected device
Options are: 1–1440
If this field is set to 0, the Host Interface Watchdog is disabled. (default)
To prevent the gateway from rebooting frequently when a connection is not available, if the gateway reboots as a result of a failed keepalive ping, it waits 60 minutes before sending another keepalive ping. Once the ping is successful, the gateway returns to the interval configured in this field.
•
Enabled (default) —The network interface statistics are not monitored and a ping is always sent at the interval configured in the Keepalive Interval field.
•
Disabled—The network interface statistics are monitored and connectivity is assumed when there is traffic received. A ping is only sent when there is no traffic for a period greater than the interval set in the Keepalive Interval field.
Rev 2 Nov.15
119
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
120 4118127
6: VPN Configuration
The AirLink gateway can act as a Virtual Private Network (VPN) device, providing enterprise VPN access to any device connected to the AirLink gateway even when a device has no VPN client capability on its own. The AirLink gateway supports three types of VPN: IPsec,
GRE, and SSL. The AirLink gateway can support up to five VPN tunnels at the same time.
Note: Dynamic Mobile Network Routing (DMNR) is not compatible with VPN tunnels. If you are using DMNR, disable all VPN tunnels.
6
Split Tunnel
The AirLink gateway supports Global settings with one encrypted tunnel and one open tunnel. A sample server subnet for a Global setting would be 172.16.1.0/24. Global settings VPNs should be set up with care, as a Global settings configuration with both an enterprise VPN and access to the public Internet can inadvertently expose company resources.
Figure 6-1: ACEmanager: VPN > Split Tunnel
Rev 2 Nov.15
121
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
122
Field
Incoming Out of Band
Outgoing Management
Out of Band
Outgoing Host Out of
Band
Description
Controls incoming public Internet traffic
Options are:
•
Blocked—Incoming public Internet traffic is blocked. Only traffic through the VPN tunnel is allowed. (default)
•
Allowed—Incoming public Internet traffic is allowed.
Controls outgoing traffic from the AirLink gateway
•
Blocked—Outgoing traffic from the AirLink gateway to the public
Internet is blocked. Only traffic through the VPN tunnel is allowed.
•
Allowed—Outgoing traffic from the AirLink gateway to the public
Internet is allowed. (default)
Controls of outgoing Host out of band traffic.
Options are:
•
Blocked—Public Internet traffic from the host device is blocked. Only traffic through the VPN tunnel is allowed. (default)
•
Allowed—Public Internet traffic from the host device is allowed.
IPsec
The IP protocol that drives the Internet is inherently insecure. Internet Protocol
Security (IPsec), which is a standards-based protocol, secures communications of IP packets over public networks.
IPsec is a common network layer security control and is used to create a virtual private network (VPN).
The advantages of using the IPsec feature includes:
•
Data Protection: Data Content Confidentiality allows you to protect your data from any unauthorized view, because the data is encrypted (encryption algorithms are used).
•
Access Control: Access Control implies a security service that prevents unauthorized use of a Security Gateway, a network behind a gateway or bandwidth on that network.
•
Data Origin Authentication: Data Origin Authentication verifies the actual sender, thus eliminating the possibility of forging the actual sender’s identification by a third-party.
•
Data Integrity: Data Integrity Authentication allows both ends of the communication channel to confirm that the original data sent has been received as transmitted, without being tampered with in transit. This is achieved by using authentication algorithms and their outputs.
The IPsec architecture model includes the Sierra Wireless AirLink gateway as a remote gateway at one end, communicating through a VPN tunnel with a VPN gateway at the other end. The remote gateway is connected to a remote network and the VPN is connected to the local network. You can configure up to three remote subnets.
4118127
Rev 2 Nov.15
VPN Configuration
The IPsec VPN employs the IKE (Internet Key Exchange) protocol to set up a
Security Association (SA) between the AirLink gateway and a Cisco (or Cisco compatible) enterprise VPN server. IPsec has two phases for setting up an SA between peer VPNs. Phase 1 creates a secure channel between the AirLink gateway VPN and the enterprise VPN, thereby enabling IKE exchanges. Phase 2 sets up the IPsec SA that is used to securely transmit enterprise data.
Note: If you configure custom settings, they are saved and the tunnel can be disabled and re-enabled without needing to re-enter the settings. For a successful configuration, all settings for the VPN tunnel must be identical between the AirLink gateway VPN and the enterprise VPN server.
You can also configure VPN Failover for IPsec VPN tunnels. For more information, see
To configure an IPsec VPN tunnel:
1.
In ACEmanager, go to VPN.
2.
Select the VPN you want to configure (1, 2, 3, 4, or 5).
3.
In the VPN Type field, select IPsec Tunnel. The screen expands to show the
IPsec Tunnel fields.
123
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
124
Figure 6-2: ACEmanager: VPN > VPN 1 > IPsec Tunnel
4.
See the following table for instructions on completing the IPsec Tunnel fields.
5.
Once the configuration is complete:
a.
Click the Set VPN Policy button.
b. Check the VPN Status field to confirm the status of the VPN connection.
4118127
VPN Configuration
Field
General
VPN # Type
VPN # Status
Set VPN Policy
Description
Use this field to select the type of VPN tunnel. If you configure custom settings, they are saved and the tunnel can be disabled and re-enabled without needing to re-enter the settings.
Options are:
•
Tunnel Disabled (default)
•
IPsec Tunnel
•
GRE Tunnel
•
SSL Tunnel (only available for VPN 1)
Status of the VPN connection:
•
Disabled—VPN is disabled (default)
•
Not Connected—The VPN failed to connect. This could be because of a mismatch in the configuration between the client and the server, no data connection on the device, etc.
•
Connected—The VPN is connected and ready to transmit traffic.
•
Configuration Error—This status appears when:
•
Two VPNs have the same Local Address and Remote Address
•
More than one VPN has the remote address set to “0.0.0.0”
When either of these errors exist, only the first of the conflicting VPNs is operational.
To determine which VPNs are in conflict:
1.Go to Admin > Configure Log.
2. For the VPN Subsystem, ensure that Display in Log is set to Yes. The Verbosity can be either Info or Debug.
3. Click View Log.
4. The resulting log shows you which VPNs are in conflict.
After completing the VPN Configuration:
1.
Click this button to apply the new settings.
2.
Check the VPN Status field to confirm the status of the VPN connection. (See
.)
Rev 2 Nov.15
125
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
VPN Gateway
Address
Pre-shared Key 1
My Identity Type
My Identity - IP or
My Identity - FQDN
Peer Identity Type
Description
The IP address or FQDN (Fully Qualified Domain Name) of the server that this VPN client connects to. This address must be open to connections from the AirLink gateway. The default VPN Gateway IP Addresses are static address on Sierra Wireless Servers. They are:
3
4
1
2
5
VPN Gateway IP Address
208.81.123.21
208.81.123.22
208.81.123.26
208.81.123.23
208.81.123.24
You can use these default IP addresses to confirm that an IPsec connection can be established with your wireless configuration before making any configuration changes, and as an example to model your VPN configuration after.
The pre-shared key (PSK) is used to initiate the VPN tunnel.
•
Pre-shared key length: Maximum supported length is 128 characters.
•
Valid characters are: 1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLM
NOPQRSTUVWXYZ!%&-~@#$^*
•
Invalid characters: ><?
Options are:
•
IP (default) — The My Identity - IP field appears with the WAN IP address assigned by the carrier
•
FQDN — The My Identity - FQDN field appears. Enter a fully qualified domain name
(FQDN) e. g., modemname.domainname.com
•
User FQDN — The My Identity - FQDN field appears. Enter a User FQDN whose values should include a username (e.g. [email protected])
•
My Identity - IP appears only when IP is selected from the My Identity Type drop-down menu. The WAN IP address assigned by the carrier appears.
•
My Identity - FQDN appears only when User FQDN or FQDN is selected from the My
Identity Type drop-down menu. Enter an FQDN or User FQDN.
Note: If you are using a FQDN for your device (My Identity) either:
•
Set up a Dynamic DNS on the Services > Dynamic DNS tab. (See Dynamic DNS on page 154.) or
•
Use a DNS server as your domain host
Required in some configurations to identify the client or peer side of a VPN connection.
Options are:
•
IP (default) — The Peer Identity - IP field appears with the IP address of a VPN server set up by Sierra Wireless for your testing purposes
•
FQDN — The Peer Identity - FQDN field appears. Enter an FQDN
(e. g. modemname.domainname.com)
•
User FQDN — The Peer Identity - FQDN field appears. Enter a User FQDN whose values should include a username (e.g., [email protected])
126 4118127
VPN Configuration
Field
Peer Identity - IP or
Peer Identity - FQDN
Negotiation Mode
IKE Encryption
Algorithm
IKE Authentication
Algorithm
IKE Key Group
IKE SA Life Time
IKE DPD
Description
•
Peer Identity - IP appears only when IP is selected from the Peer Identity Type dropdown menu. The VPN Gateway IP Address appears.
•
Peer Identity - FQDN appears only when User FQDN or FQDN is selected from the
Peer Identity Type drop-down menu. Enter the Peer FQDN or Peer User FQDN.
Enable this configuration to operate the onboard VPN under Aggressive mode. Aggressive mode offers increased performance at the expense of security.
Options are:
•
Main (default)
•
Aggressive
Determines the type and length of encryption key used to encrypt/decrypt ESP
(Encapsulating Security Payload) packets. 3DES supports 168-bit encryption. AES
(Advanced Encryption Standard) supports both 128-bit and 256-bit encryption.
Options are: DES, 3DES, AES-128 (default), and AES-256
MD5 is an algorithm that produces a 128-bit digest for authentication. SHA is a more secure algorithm that produces both 160-bit (SHA1) and 256-bit (SHA256) digests.
Options are: MD5, SHA1 (default), and SHA256
Options are: DH1, DH2 (default), or DH5
Determines how long the VPN tunnel is active in seconds.
Options are: 180 to 86400; Default: 7200
Dead Peer Detection (DPD)
Options are:
•
Disable (default)
•
Enable
When DPD is enabled, the AirLink gateway checks to see if the server is still present if there has been no traffic for a configured interval. If it does not receive an acknowledgment, it retries at 5 second intervals. If there is no acknowledgment after 5 retries, the status of the VPN is set to Not Connected and the device attempts to renegotiate IPSEC security parameters with its peer.
Default is Disabled.
Note: Sierra Wireless recommends that you Enable IKE DPD. Otherwise the AirLink gateway has no way of detecting that the connection to the VPN server is still available.
IKE DPD Interval
(seconds)
Local Address Type
Local Address
Local Address -
Netmask
Use this field to set the DPD interval (in seconds). If there has been no traffic for the period of time set in this field, the AirLink gateway retries checking with the server, as described in
Options are: 0 to 3600 (default is 1200)
If this field is set to 0, DPD monitoring is turned off (or disabled as described in the IKE
DPD section), but the AirLink gateway still responds to DPD requests from the server.
The network information of the device. Options are: Use the Host Subnet, Single Address, and Subnet Address (default)
Device subnet address
Device subnet mask information
Default: 255.255.255.0
Rev 2 Nov.15
127
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Remote Address Type
The network information of the IPsec server behind the IPsec gateway.
Options are: Subnet Address (default) and Single Address
Remote Address
Description
The IP address or subnet of the device(s) connected to the gateway
If the remote address is 0.0.0.0, the remote address netmask should also be 0.0.0.0.
Note that you can only have one remote address of 0.0.0.0 for all the VPNs.
Default values are:
VPN
1
2
3
4
5
Remote Address
10.11.12.0
10.11.13.0
10.11.14.0
10.11.15.0
10.11.16.0
Remote Address -
Netmask
Perfect Forward
Secrecy
IPsec Encryption
Algorithm
IPsec Authentication
Algorithm
IPsec Key Group
Remote subnet mask information
Default: 255.255.255.0
0.0.0.0 is allowed for the remote address subnet mask as long as the remote address is also 0.0.0.0.
Provides additional security through a DH shared secret value. When this feature is enabled, one key cannot be derived from another. This ensures previous and subsequent encryption keys are secure even if one key is compromised. Options are: Yes (default) or
No.
Determines the type and length of encryption key used to encrypt/decrypt ESP
(Encapsulating Security Payload) packets. 3DES supports 168-bit encryption. AES
(Advanced Encryption Standard) supports both 128-bit and 256-bit encryption.
Options are: None, DES, 3DES, AES-128 (default), and AES-256.
Can be configured with MD5 or SHA1. MD5 is an algorithm that produces a 128-bit digest for authentication. SHA is a more secure algorithm that produces both 160-bit (SHA1) and
256-bit (SHA256) digests.
Options are: None, MD5, SHA1 (default), and SHA 256.
Determines how the AirLink gateway VPN creates an SA with the VPN server. The DH
(Diffie-Hellman) key exchange protocol establishes pre-shared keys during the phase 1 authentication. The AirLink gateway supports three prime key lengths, including Group 1
(768 bits), Group 2 (1,024 bits), and Group 5 (1,536 bits). Options are: None, DH1, DH2
(default), or DH5.
IPsec SA Life Time
Determines how long the VPN tunnel is active in seconds
Options are: 180 to 86400; Default: 7200
Additional Remote Subnets
Remote Subnet 2
Address type
The network information for subnet 2 IPsec server behind the IPsec gateway.
Options are: Subnet Address (default) and Single Address
Remote Subnet 2
Address
The IP address for the subnet 2 device behind the gateway
128 4118127
VPN Configuration
Field
Remote Subnet 2
Address - Netmask
Remote Subnet 3
Address type
Remote Subnet 3
Address
Remote Subnet 3
Address - Netmask
Description
Remote subnet 2 mask information
Default: 255.255.255.0
The network information for subnet 3 IPsec server behind the IPsec gateway.
Options are: Subnet Address (default) and Single Address
The IP address for the subnet 3 device behind the gateway
Remote subnet 3 mask information
Default: 255.255.255.0
GRE
The AirLink gateway can act as a Generic Routing Encapsulation (GRE) endpoint, providing a means to encapsulate a wide variety of network layer packets inside IP tunneling packets. With this feature you can reconfigure IP architectures without worrying about connectivity. GRE creates a point-to-point link between routers on an IP network.
To configure GRE:
1.
In ACEmanager, go to VPN.
2.
Select the VPN you want to configure (1, 2, 3, 4, or 5).
3.
In the VPN Type field, select GRE. The screen expands to show the GRE fields.
Rev 2 Nov.15
Figure 6-3: ACEmanager: VPN > VPN1 > GRE Tunnel
4.
See the following table for instructions on completing the GRE fields.
129
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
5.
Once the configuration is complete, either:
· Click the Set VPN Policy button.
Or
· Reboot the AirLink gateway.
Field
VPN # Type
VPN # Status
Description
Options are: Tunnel Disabled or GRE Tunnel. Enabling the GRE Tunnel will expose other options for configuring the tunnel.
Indicates the status of the GRE tunnel on the device
Options are: Disabled, Connected or Not Connected
Set VPN Policy
After completing the VPN Configuration:
1.
Click this button to apply the new settings (or reboot the device).
2.
Check the VPN Status field to confirm the status of the VPN connection. (See VPN #
.)
The IP address of the device that this client connects to. This IP address must be open to connections from the device.
VPN Gateway
Address
Remote Address Type
The network information of the GRE server behind the GRE gateway
Remote Address
The IP address of the device behind the gateway
Remote Address -
Netmask
The subnet network mask of the device behind the GRE gateway
Note: Never use a 16-bit subnet mask: GRE tunnel establishment will fail.
GRE TTL
GRE time to live (TTL) value is the upper bound on the time that a GRE packet can exist in a network. In practice, the TTL field is reduced by one on every router hop. This number is in router hops and not in seconds.
SSL Tunnel
Note: SSL Tunnel configuration is only available on VPN 1.
The SSL tunnel is implemented using OpenVPN. OpenVPN uses SSL/TLS to facilitate key exchange and supports up to 256-bit encryption. OpenVPN is capable of crossing network address translators (NATs) and firewalls. Peers can authenticate each other using pre-shared keys, certificates, or username and password.
The AirLink gateway client authenticates the server using a PKI certificate. The server likewise authenticates the client. The Root CA certificate for the server certificate must be loaded on the device.
To configure an SSL VPN tunnel:
1.
In ACEmanager, go to VPN.
2.
Select the VPN 1.
130 4118127
VPN Configuration
3.
In the VPN Type field, select SSL Tunnel. The screen expands to show the
SSL Tunnel fields.
Rev 2 Nov.15
Figure 6-4: ACEmanager: VPN > VPN1 > SSL Tunnel
4.
See the following table for instructions on completing the SSL Tunnel fields.
5.
Once the configuration is complete, either:
· Click the Set VPN Policy button.
Or
· Reboot the AirLink gateway.
131
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
General
VPN 1 Type
Description
VPN 1 Status
Options are: Tunnel Disabled or SSL Tunnel. Enabling the SSL Tunnel will expose other options for configuring the tunnel.
Indicates the status of the SSL tunnel on the device
Options are: Disabled, Connected or Not Connected
Set VPN Policy
After completing the VPN Configuration:
1.
Click this button to apply the new settings (or reboot the device).
2.
Check the VPN Status field to confirm the status of the VPN connection. (See VPN 1
.)
The AirLink gateway can only be an SSL client. Default: Client
SSL Role
Tunnel Mode
Protocol
Peer Port
Peer Identity
The Tunnel Mode is set to “Routing”.
Displays the protocol used for configuration. Only supports UDP
The Peer Port is the UPD port on the peer device.
Enter the IP address or Fully Qualified Domain Name (FQDN) of the peer device.
Encryption Algorithm
Options are: DES, Blowfish, DES, Cast128, AES-128, and AES-256
Authentication
Algorithm
Options are: MD5, SHA-1, and SHA-256
Compression
Options are: LZ0 or NONE
Load Root Certificate
Loads the server root CA (Certificate Authority) certificate
When you click the button, a window pops up and enables you to browse and select the file containing the root CA certificate.
Root Certificate Name
Displays the name of the most recently uploaded root certificate
Client Certificate
Load Client
Certificate
Enables or disables use of a client certificate.
This field appears only if Client Certificate is enabled.
Loads the client certificate
When you click the button, a window pops up and enables you to browse and select the file containing the client certificate.
Client Certificate
Number
Load Client
Certificate Key
Displays the number of the most recently uploaded client certificate.
This field appears only if Client Certificate is enabled.
Loads the client certificate key
When you click the button, a window pops up and enables you to browse and select the file containing the client certificate key.
Client Certificate Key
Name
Displays the name of the most recently uploaded client certificate key
User Name
The user name required for client authentication
User Password
The user password required for client authentication
132 4118127
VPN Configuration
Field
Additional TLS
Authentication
Description
Enables or disables use of Transport Layer Security (TLS) authentication.
Load Client TLS Key
This field appears only if Additional TLS Authentication is enabled.
Loads the client TLS key
When you click the button, a window pops up and enables you to browse and select the file containing the client TLS key.
Client TLS Key Name
Displays the name of the most recently uploaded client TLS key
Advanced
Tunnel-MTU
MSS Fix
Fragment
Allow Peer Dynamic
IP
Re-negotiation
(seconds)
Ping Interval
(seconds)
Tunnel Restart
(seconds)
NAT
Default: 1500 bytes
Default: 1400 bytes
Default: 1300 bytes
Options are: Enable or Disable
Default: 86400 (24 hours)
This is the keep-alive sent by the client. Default: 0 seconds
Enter the time for a tunnel restart (unit in seconds)
Options are: Enable or Disable. Note that this is a Mobile Network Operator NAT, not a local NAT
Load Root Certificate
Note: The process is similar for uploading the client certificate, the client certificate key and the client TLS key.
To load a root certificate:
1.
Click Load Root Certificate.
The following dialog-box appears.
Rev 2 Nov.15
2.
Select the appropriate file for your device.
3.
Click Upload File to Device.
133
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
VPN Failover
VPN Failover is only available for IPsec VPN tunnels. To use this feature, configure a primary and a secondary VPN tunnel. Dead Peer Detection (DPD) verifies the status of the primary connection. If the primary VPN goes down (i.e.
DPD detects that the end device is not responding) traffic is automatically switched to the secondary (backup) VPN tunnel. DPD continues to ping the primary VPN responder. If configured to do so, once the primary VPN tunnel is up, traffic automatically reverts to the primary VPN. Status fields in the
ACEmanager UI inform you of the current status of the two VPNs.
Primary VPN
Secondary VPN
Two IPsec VPN tunnels are configured, but only one is active at a time. The primary VPN is active unless DPD determines the responder is dead. In that case, traffic is
AirLink gateway switched to Secondary VPN.
DPD and VPN Failover configured on AirLink gateway
Switch
LAN
Subnet 1
Subnet 2
Figure 6-5: VPN Failover Configuration
To configure VPN Failover:
1.
Configure two IPsec VPN tunnels. The one you want to designate as the primary VPN must have Dead Peer Detection configured. For the Secondary
VPN, you only need to configure the remote gateway address. For other settings, such as the local and remote subnets, the secondary VPN uses the same settings as the primary VPN.
For instructions on configuring IPsec VPN tunnels, see IPsec on page 122.
2.
Go to VPN > Failover and configure the first three fields. See the table following the screen shot for details.
3.
Click Apply and reboot the AirLink gateway.
134 4118127
VPN Configuration
Figure 6-6: ACEmanager: VPN > Failover
Field
Primary VPN
Secondary VPN
Revertive
Primary VPN Status
Secondary VPN
Status
Description
ID of the primary VPN (for VPN Failover) i.e. VPN 1, VPN 2, VPN 3, VPN 4, VPN 5, or
None (None is the default.)
ID of the Secondary VPN (for VPN Failover) i.e. VPN 1, VPN 2, VPN 3, VPN 4, VPN 5, or
None (Default is None.)
When VPN Failover is configured and this field is set to Enable, traffic automatically switched from the Secondary VPN back to the primary VPN when the failure is resolved and the primary VPN tunnel is up again. Options are
•
Enable (default)
•
Disable
Status of the primary VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—The VPN is trying to connect to the responder.
•
Active—The VPN tunnel is ready and transferring traffic.
•
Backup—This is currently the backup VPN connection.
•
Failed—Dead Peer Detection (DPD) has determined that the VPN responder is dead, or a ping sent to the VPN host failed.
•
Out of Service—There have been 5 DPD failures within an hour.
Status of the Secondary VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—The VPN is trying to connect to the responder.
•
Active—The VPN tunnel is ready and transferring traffic.
•
Backup—This is currently the backup VPN connection.
•
Failed—Dead Peer Detection (DPD) has determined that the VPN responder is dead, or a ping sent to the VPN host failed.
•
Out of Service—There have been 5 DPD failures within an hour.
Rev 2 Nov.15
135
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Overall VPN Status
Description
Status of the overall VPN:
•
Disabled—VPN Failover is disabled. (default)
•
Connecting—One of the VPNs is trying to connect to the responder.
•
Active—One VPN tunnel is currently in use. The backup VPN is available.
•
Backup_Unavailable —One VPN tunnel is currently in use. The backup VPN is not available.
•
Out of Service—Neither the primary nor secondary VPN is operational.
•
N/A—The overall VPN status is temporarily not available. Click Refresh.
Number of times DPD has failed on the primary VPN since the device has been rebooted or the “Set VPN Policy” button was clicked
Number of Primary
VPN Failures
Number of Secondary
VPN Failures
Number of times DPD has failed on the Secondary VPN since the device has been rebooted or the “Set VPN Policy” button was clicked
Number of Switches to Primary VPN
Number of times traffic was switched to the primary VPN since the device has been rebooted or the “Set VPN Policy” button was clicked
Number of Switches to Secondary VPN
Number of times traffic was switched to the Secondary VPN since the device has been rebooted or the “Set VPN Policy” button was clicked
136 4118127
7: Security Configuration
The security tab covers firewall-type functions. These functions include how data is routed or restricted from one side of the device to the other, i.e., from computers or devices connected to the device
(LAN) and from computers or devices contacting it from a remote source (WAN). These features are set as rules.
Tip:
For additional security, Sierra Wireless recommends that you change
the default password for ACEmanager. See Change Password on page 241.
7
Solicited vs. Unsolicited
How the device responds to data being routed from one network connection to the other depends on the origin of the data.
•
If a computer on the LAN initiates a contact to a WAN location
(such as a LAN connected computer accessing an Internet web site), the response to that contact is solicited.
•
If, however, a remote computer initiates the contact (such as a computer on the Internet accessing a camera connected to the device), the connection is considered unsolicited.
Port Forwarding
In Port Forwarding, any unsolicited data coming in on a defined
Public Port is routed to the corresponding Private Port and Host IP of a device connected to the specified Physical Interface. You can forward a single port or a range of ports.
Note: Port Forwarding requires Private Mode. See
Private and Public Mode on page 89.
Internet
Figure 7-1: Port Forwarding
AirLink gateway
Host IP/Destination Computer
Rev 2 Nov.15
137
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Note: You can set up a maximum of 48 port forwarding rules, 24 on the Port Forwarding screen and an additional 24 on the Extended Port Forwarding screen.
Single port
To define a port forwarding rule for a single port:
1.
In ACEmanager, go to Security > Port Forwarding.
138
Figure 7-2: ACEmanager: Security > Port Forwarding (Single Port)
2.
In the Port Forwarding field, select Enable.
3.
Click “Add More” to display a rule line.
4.
In the Public Start Port field, enter the desired public network port number.
Values between 1 and 65535 are supported, although Sierra Wireless recommends using a value greater than 1024.
Unsolicited data coming in on this port is forwarded to the port you select in the Private Start Port field.
5.
In the Public End Port field, enter 0.
6.
Select the desired protocol (see
· TCP
· UDP
· TCP & UDP
7.
Enter the IP address of the computer you want to forward data to.
8.
In the Private Start Port field, enter the number of the port on the destination computer that you want to forward data to.
9.
Click Apply.
You do not need to reboot immediately, if you have additional changes to make, but port forwarding does not take effect until the device is rebooted.
The Port Forwarding screen allows for 24 port forwarding rules.
10. Optional—If you need additional port forwarding rules, click Extended Port
Forwarding on the left menu, and continue adding rules, up to a total over both screens of 48.
4118127
Security Configuration
Figure 7-3: ACEmanager: Security > Extended Port Forwarding
11. Reboot.
Range of ports
To define a port forwarding rule for a range of ports:
1.
In ACEmanager, go to Security > Port Forwarding.
Rev 2 Nov.15
Figure 7-4: ACEmanager: Security > Port Forwarding (Port Range)
2.
In the Port Forwarding field, select Enable.
3.
Click “Add More” to display a rule line.
4.
Set the port range for incoming data:
a.
In the Public Start Port field, enter the desired public network port number. Values between 1 and 65535 are supported, although Sierra
Wireless recommends using a value greater than 1024.
b. In the Public Port End field, enter the last public network port number in the range. The value you enter in the Public Port End field must be greater than the value in the Public Start Port field, or ALEOS rejects the selection.
Unsolicited data coming in on ports in this range are forwarded to a range of ports, starting with the port you select in the Private Start Port field.
139
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
5.
Select the desired protocol (see
· TCP
· UDP
· TCP & UDP
6.
Enter the IP address of the computer you want to forward data to.
To forward a port to a local ALEOS Service, set the Host IP to 127.0.0.1.
7.
In the Private Start Port field, enter the starting port number for the range of ports on the destination computer that you want to forward data to.
8.
Click Apply.
The Port Forwarding screen allows for 24 port forwarding rules.
9.
Optional—If you need additional port forwarding rules, click Extended Port
Forwarding on the left menu, and continue adding rules, up to a total over both screens of 48.
140
Figure 7-5: ACEmanager: Security > Extended Port Forwarding
10. Reboot.
You do not need to reboot immediately, if you have additional changes to make, but port forwarding does not take effect until the device is rebooted.
Note: Sierra Wireless recommends that the total number of port forwardings be fewer than
1000 ports, including single port forwarding and port forwarding within a range.
Field Description
Port Forwarding
Enables port forwarding rules. Options are Enable and Disable
(default).
Public Start Port
Port on the public network or starting port on the public network for a range of ports.
•
Supported values: 1–65535
(Recommended values: greater than 1024)
4118127
Security Configuration
Field
Public End Port
Description
Ending port for a range of ports on the public network.
•
For a single port forwarding, this field must be 0.
•
For a range of ports, this value must be greater than the value in the Public Start Port field.
Protocol
The protocol to be used with the forwarded port:
•
TCP—Only those unsolicited data requests using TCP are forwarded
•
UDP—Only those unsolicited data requests using UDP are forwarded
•
TCP & UDP—Unsolicited data requests using either TCP or
UDP are forwarded
Host IP
IP address of the computer (or device) you want to forward data to.
Private Start Port
Port on the destination computer used as the port for single port forwarding rules, or as the start port for a port forwarding range.
Port Forwarding Example
The following example shows you how to configure a port forward rule for a range of 6 ports on an Ethernet-connected device:
1.
In ACEmanager, go to Security > Port Forwarding, and enable Port
Forwarding.
2.
Click “Add More” to display a rule line.
3.
Enter 8080 for the Public Start Port.
4.
Enter 8085 for the Public End Port.
5.
Select TCP & UDP.
6.
Enter 192.168.13.30 as the Host IP.
7.
Enter 80 as the Private Start Port.
Rev 2 Nov.15
Figure 7-6: ACEmanager: Port Forwarding example
8.
Click Apply.
9.
Reboot.
141
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
You do not need to reboot immediately, if you have additional changes to make, but port forwarding does not take effect until the device is rebooted.
An unsolicited TCP and UDP data request coming in to the AirLink gateway on port 8080 is forwarded to the LAN connected device, 192.168.13.30, at port 80. In addition, unsolicited data requests coming in from the Internet on ports 8081,
8082, 8083, 8084, and 8085 are forwarded to ports 81, 82, 83, 84, and 85 respectively.
DMZ
The DMZ is used to direct unsolicited inbound traffic to a specific LAN device such as a computer running a web server or other internal application. The DMZ with public mode is particularly useful for certain services like VPN, NetMeeting, and streaming video where the remote server may require a WAN connection to the LAN device rather than being NATed by the router. In public mode unsolicited traffic to hosts in the DMZ is permitted by default.
Options for DMZ are Automatic, Manual, and Disable.
Automatic uses the first connected device. If more than one host is available
(multiple Ethernet on a switch connected to the device and/or Ethernet with
USBnet) and you want to specify the host to use as the DMZ, select Manual and enter the IP address of the desired host.
Figure 7-7: ACEmanager: Security > Port Forwarding (DMZ)
142 4118127
Security Configuration
Field
DMZ Enabled
DMZ IP
DMZ IP in use
Description
The AirLink gateway allows a single client to connect to the Internet through a demilitarized zone (DMZ). Options are Automatic (default), Manual, and Disable.
•
Automatic—enables the first connected device or the Public Mode interface as the
DMZ
•
Manual—inserts a specific IP address in the DMZ IP field
•
Disable—no connected device receives unsolicited traffic from the cellular network or
Internet
This field only appears if Manual is selected for the DMZ Enabled field; this field does not display if the DMZ is disabled. This is the IP address of the private mode host that should be used as the DMZ.
IP address of the host to which inbound unsolicited packets are sent
When the device passes the Network IP to the configured public host, the DMZ IP in Use displays the public IP.
Example of configuring the DMZ on an Ethernet connected device:
1.
Enter 192.168.13.100 for the DMZ IP.
2.
Select Ethernet as the Default Interface.
An unsolicited data request coming in to the AirLink gateway on any port is forwarded to the LAN device, 192.168.13.100, at the same port.
Note: The DMZ settings are independent of the number of Port Forward entries and can be used with port forwarding to pass anything not forwarded to specific ports.
Port Filtering—Inbound
Port Filtering
—
Inbound restricts unsolicited access to the AirLink gateway and all
LAN-connected devices.
You can enable Port Filtering to either block or allow specified ports. When enabled, all ports not matching the rule are allowed or blocked depending on the mode.
You can configure Port Filtering either on individual ports or for a range of ports.
Click Add More for each port filtering rule you want to add.
Note: Inbound restrictions do not apply to responses to outbound data requests. To restrict outbound access, you need to set the applicable outbound filter.
Rev 2 Nov.15
143
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 7-8: ACEmanager: Security > Port Filtering - Inbound
Field Description
Inbound Port Filtering
Mode
Options are:
•
Disable (default)
•
Blocked Ports—ports though which traffic is blocked (Shown in Filtered Ports list)
•
Allowed Ports—ports through which traffic is allowed (Shown in Filtered Ports list)
Filtered Ports
Start Port
End Port
A single port or the first port in a range of ports on the public network (mobile network accessible)
The end of the range on the public network (mobile network accessible).
Warning:
Selecting Allowed Ports will *block* all ports not allowed, and will *prevent remote access* if the management ports are not allowed. To allow remote management, the allowed ports list should include 8088, 17339, 17336, and ACEmanager port 9191 (or the port you selected for ACEmanager).
144
Port Filtering — Outbound
Port Filtering
—
Outbound restricts LAN access to the external network, i.e., the
Internet.
Port Filtering can be enabled to block ports specified or allow specified ports.
When enabled, all ports not matching the rule will be allowed or blocked depending on the mode.
Port Filtering can be configured on individual ports or for a range of ports. Click
Add More for each port filtering rule you want to add.
Note: Outbound restrictions do not apply to responses to inbound data requests. To restrict inbound access, you need to set the applicable inbound filter.
4118127
Security Configuration
Figure 7-9: ACEmanager: Security > Port Filtering - Outbound
Field
Outbound Port
Filtering Mode
Start Port
End Port
Description
Allowed and blocked ports through which traffic is either allowed or blocked (respectively) are listed. Options are:
•
Disable (default)
•
Blocked Ports—ports though which traffic is blocked (Shown in Filtered Port s list)
•
Allowed Ports—ports through which traffic is allowed (Shown in Filtered Port s list)
Note: Outbound IP filter supports up to 9 ports.
The first of a range or a single port on the LAN
The end of the range on the LAN
Trusted IPs—Inbound (Friends)
Trusted IPs
—
Inbound restricts unsolicited access to the AirLink gateway and all
LAN connected devices.
Tip:
Trusted IPs-Inbound was called Friends List in legacy AirLink products.
When enabled, only packets with source IP addresses matching those in the list or range of trusted hosts will have unrestricted access to the AirLink gateway and/ or LAN connected devices.
Note: Inbound restrictions do not apply to responses to outbound data requests. To restrict outbound access, you need to set the applicable outbound filter.
Rev 2 Nov.15
145
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 7-10: ACEmanager: Security > Trusted IPs > Inbound (Friends)
Field
Inbound Trusted IP
(Friends List) Mode
Non-Friends Port
Forwarding
Description
Disables or Enables port forwarding rules. Options are Disable (default) or Enable.
Inbound Trusted IP
List
Inbound Trusted IP
Range
Range Start
Range End
Non-Friends port forwarding is like an allow rule for any of the forwarded ports. If it is enabled, the port forwarding rules apply to all incoming packets. If it is disabled, only
Inbound Trusted List (or Range) IPs get through. Options are Disable (default) or Enable.
Enter a single trusted IP address for example 64.100.100.2. Click Add More to add additional IP addresses to the list.
Use this section of the page to enter a range of trusted IP addresses.
Specify the start and end IP addresses for the trusted IP address range, for example, entering 64.100.10.2 as the Range Start and 64.100.10.15 as the Ranges End would allow
64.100.10.5 but would not allow 64.100.10.16.
146 4118127
Security Configuration
Trusted IPs—Outbound
Trusted IPs
—
Outbound restricts LAN access to the external network (Internet).
When enabled, only packets with the destination IP addresses matching those in the list of trusted hosts will be routed from the LAN to the external location.
Note: Outbound restrictions do not apply to responses to inbound data requests. To restrict inbound access, you need to set the applicable inbound filter.
Figure 7-11: ACEmanager: Security > Trusted IPs - Outbound
Field
Outbound Firewall
Mode
Outbound Trusted IP
List
Description
Disables or enables the Outbound Firewall
Options are:
•
Disable (default)—Allows all outbound traffic
•
Enable—Only outbound traffic destined for an IP address on the Trusted IP list is allowed. All other outbound traffic is blocked.
Each entry can be configured to allow a single IP address (e.g., 64.100.100.2) Click Add
More to add additional IP addresses to the list.
MAC Filtering
MAC filtering restricts LAN connection access. You can create a list of up to 20 devices that are allowed a connection based on their MAC address. When MAC filtering is enabled, devices not on the allowed list are explicitly blocked. Hosts directly connected to the device but not in the Allowed list may show an active physical connection, but are blocked from sending traffic of any kind to the device or any other host connected to the device.
Rev 2 Nov.15
147
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 7-12: ACEmanager: Security > MAC Filtering
Field Description
MAC Filtering
Enable or disable (default) MAC Filtering
MAC Address allowed
List
Allows devices with the MAC Addresses listed to connect to the host and transfer data. Add
MAC addresses by clicking on the Add More button. When adding MAC addresses, use a colon between the digit groups, for example 01:23:45:67:89:ab.
Note: After adding all the desired MAC addresses, reboot the device. The MAC Address allowed List takes effect after the device is rebooted.
MAC Address
This is the MAC Address of the interface adapter on a computer or other device.
Tip:
You can use the Status > LAN page to obtain the MAC addresses of DHCP connected devices.
148 4118127
8: Services Configuration
The Services tab sections allow the configuration of external services that extend the functionality of the AirLink Device.
ALMS (AirLink Management
Service)
8
Figure 8-1: ACEmanager: Services > ALMS
Field
General
AirLink
Management
Service
Description
Disables or enables ALMS management by disabling or enabling periodic deviceinitiated communication with the ALMS server.
Rev 2 Nov.15
149
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Server URL
Description
The ALMS server URL address. By default, this is: https://na.m2mop.net/device/msci/com, which encrypts network traffic from ALEOS to ALMS.
Using an HTTPS URL enables Secure Socket Layer (SSL). When SSL is enabled
Note: The URL from earlier ALEOS versions, http://na.m2mop.net/device/msci, is still valid, but does not use SSL.
Device Initiated
Interval
(minutes)
This field determines how often the AirLink device checks for software updates and settings changes from ALMS. ALMS can also query the AirLink device at a regular interval if settings allow. Refer to AirLink Management Service documentation for more information. Default: 1440 minutes (24 hours).
ALMS Name
Use this field to assign a name of your choice to the AirLink device.This name is used by the ALMS server to identify your device. By default, this field is blank.
You can also use an AT command to assign or query the name. See
Status
Displays the status of the ALMS connection:
•
Success— Device successfully contacted ALMS during its latest communication.
•
Disable— ALMS communications are disabled. (Appears when the AirLink
Management Service drop-down menu is set to Disable.)
•
[ALEOS] Waiting for connectivity — This transitory status appears when the device is in Connect-on-traffic mode and is trying to connect to the network for an ALMS check-in. (See
Always on connection on page 68.) When the device
connects to the network, the ALMS check-in is sent and the status changes to
Success or an error message, if there is a problem with the connection.
For a list of error messages, see
Advanced
Auto
Synchronize
Configuration
This field allows you to choose when changes to the configuration are propagated to
ALMS.
•
Enable—Changes to the configuration are propagated as soon as possible and do not wait for the next communication period (as configured in the Device
Initiated Interval field). This may result in more frequent communication with
ALMS. (default)
•
Disable—Changes to the configuration are propagated to ALMS at the device initiated interval rate.
150 4118127
Services Configuration
Field
AAF
M3DA Protocol
Password
Description
SSL Verify Peer
Certificate
This field has no effect unless an HTTPS URL is used for the Server URL .
Using an HTTPS URL (for example, https://na.m2mop.net/device/msci/com ) as the server URL enables Secure Socket Layer (SSL). When SSL is enabled, use this field to set the SSL certificate validation.
•
Enable—The validity of the server certificate is checked during the SSL negotiation. (default)
If the certificate is not valid, communication with the ALMS server is terminated.
For more information, see
[HTTP] SSL peer certificate or SSH remote key was not OK on page 378.
•
Disable—The validity of the server certificate is not checked during the SSL negotiation. The SSL communication proceeds even if the server presents a non-validated certificate.
Connect
The Connect button enables you to manually connect an AirLink device to ALMS.
This may be useful for troubleshooting the connection between the platform and the remote device and confirming that AAF scripts or jobs created are executing as expected on ALMS.
M3DA Protocol Password
This password must be configured on the AirLink device and on ALMS. The default password is 12345.
Displays the current manual connection status.
Manual
Connection
Status
Connect
The Connect button enables you to manually connect an AirLink device to ALMS.
This may be useful for troubleshooting the connection between the platform and the remote device and confirming that AAF scripts or jobs created are executing as expected on ALMS.
Rev 2 Nov.15
151
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
ACEmanager
152
Figure 8-2: ACEmanager: Services > ACEmanager
Field
General
Description
Remote Access
Configure ACEmanager remote access (over the WAN link)
Options are:
•
Disable (default)
•
HTTPS Only
•
Both HTTP and HTTPS
Local Access
Configure ACEmanager local access (Ethernet, USBnet, or Serial/DUN)
Options are:
•
HTTPS Only
•
Both HTTP and HTTPS (default)
HTTP Port
Configure the HTTP port for ACEmanager access. Reboot the device after applying the port change.
Default value is 9191.
HTTPS Port
Configure the HTTPS port for ACEmanager access. Reboot the device after applying the port change.
Default is 9443.
4118127
Services Configuration
Field
Session Idle
Timeout
(minutes)
Description
If ACEmanager is idle for the configured timeout, it automatically logs out and returns you to the login screen. Options are:
•
0–60 (minutes) Default is 15.
If you set the Session Idle Timeout to zero (0), the session remains active until you manually log out.
Maximum Login
Attempts
Number of failed login attempts allowed before the user account is temporarily locked
Options are:
•
0—The account lock out feature is disabled.
•
1–5—Maximum number of failed login attempts before the user account is locked for the length of time specified in the
Unlock Time
(seconds)
The length of time (in seconds) that the user account is locked after the maximum number of failed login attempts (configured in
Options are:
•
1–3600 (1 hour)
Default is 120 (2 minutes)
Advanced
Custom
Certificate
Enabling this feature allows you to load a custom SSL certificate. (Some restrictions apply; see Note below for details.)
Options are:
•
Enable—Additional fields appear that allow you to load a custom SSL certificate and a custom private key. The ACEmanager web server uses this custom certificate for authentication during HTTPS communication, instead of the default certificate.
•
Disable—The ACEmanager web server uses the default SSL certificate for authentication during HTTPS communication. (default)
Note: The custom certificate and private key must meet the following conditions:
•
The certificate must be an X.509
•
The certificate and the private key must be in .pem format, and they must be in separate files.
•
There is no limit to the size of the private key, but the larger the key, the more the performance is affected. Sierra Wireless recommends that the key does not exceed 2048 bits.
Note: The gateway supports pre-defined cipher suites using 128-bit cipher algorithms.
Load Custom
Certificate
This field only appears when the Custom Certificate field is set to Enable.
To load a custom SSL certificate:
1.
Click Load Custom Certificate.
2.
Click Browse... and navigate to the SSL certificate file.
3.
Click Upload file to device.
4.
Once you have uploaded the custom certificate and the custom private key, click Apply and reboot the device.
Rev 2 Nov.15
153
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
154
Field
Custom
Certificate
Name
Load Custom
Private Key
Description
This field only appears when the Custom Certificate field is set to Enable.
Displays the name of the custom certificate.
This field only appears when the Custom Certificate field is set to Enable.
Allows you to enter a custom private key (Some restrictions apply; see Custom
Certificate on page 153 for details.)
To load a custom private key:
1.
Click Load Private Key.
2.
Click Browse... and navigate to the private key file.
3.
Click Upload file to device.
4.
Once you have uploaded the custom certificate and the custom private key, click Apply and reboot the device.
Custom Private
Key Name
This field only appears when the Custom Certificate field is set to Enable.
Displays the name of the private key.
Dynamic DNS
Dynamic DNS allows an AirLink gateway WAN IP address to be published either to a proprietary Sierra Wireless dynamic DNS service called IP Manager, or to an alternate 3rd party Mobile Network Operator.
Whether you have one Sierra Wireless AirLink gateway or multiple devices, it can be difficult to keep track of the current IP addresses especially if the addresses are not static but change every time the devices connect to the mobile network. If you need to connect to a specific gateway, or the device behind it, it is much easier when you have a domain name (car54.mydomain.com, where are you?).
Reasons to Contact or Connect to a Device:
•
Requesting a location update from a delivery truck
•
Contacting a surveillance camera to download logs or survey a specific area
•
Triggering an oil derrick to begin pumping
•
Sending text to be displayed by a road sign
•
Updating the songs to be played on a juke box
•
Updating advertisements to be displayed in a cab
•
Remote accessing a computer, a PLC, an RTU, or other system
•
Monitoring and troubleshooting the status of the device itself without needing to bring it in or go out to it.
A dynamic IP address is suitable for many Internet activities such as web browsing, looking up data on another computer system, for data only being sent out, or for data only being received after an initial request (also called Mobile
Originated). However, if you need to contact the AirLink gateway directly, a device connected to the AirLink gateway, or a host system using your AirLink gateway
(also called Mobile Terminated), a dynamic IP will not give you a reliable address to contact (since it may have changed since the last time it was assigned).
4118127
Services Configuration
Domain names are often only connected to static IP addresses because of the way most domain name (DNS) servers are set-up. Dynamic DNS servers require notification of IP Address changes so they can update their DNS records and link a dynamic IP address to the correct name.
•
Dynamic IP addresses are granted only when your AirLink gateway is connected and can change each time the gateway reconnects to the network.
•
Static IP addresses are granted the same address every time your AirLink gateway is connected and are not in use when your gateway is not connected.
Since many cellular providers, like wire-based ISPs, do not offer static IP addresses or static address accounts (which can cost a premium as opposed to. dynamic accounts), Sierra Wireless AirLink Solutions developed IP Manager. IP
Manager works with a Dynamic DNS server to receive notification from Sierra
Wireless AirLink gateways to translate the dynamic IP address to a fully qualified domain name. Thus, you can contact your AirLink gateway directly from the
Internet using a domain name.
Rev 2 Nov.15
Figure 8-3: ACEmanager: Services > Dynamic DNS
Field
Service
Description
Allows you to select a Dynamic DNS Mobile Network Operator.
Options are:
•
Disable (default)
•
dyndns.org
•
noip.org
•
ods.org
•
regfish.com
•
tzo.com
•
IP Manager
155
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
3rd party Services
156
Figure 8-4: ACEmanager: Services > Dynamic DNS 3rd Party Services
The 3rd party service selected from the Service drop down menu in this example is “dyndns.org.” These same fields will be displayed for all Service selections other than IP Manager and Disable.
Field Description
Service
Allows you to select a Dynamic DNS Mobile Network Operator.
Options are:
•
Disable (default)
•
dyndns.org
•
noip.org
•
ods.org
•
regfish.com
•
tzo.com
•
IP Manager
Dynamic DNS Update
Options are:
•
Only on Change
•
Periodically Update (Not Recommended)
Full Domain Name
The name of a specific AirLink gateway or device
Login
Password
Update Interval
(hours)
Shows the login name
Shows the password in encrypted format
Indicates the time (in hours) between checks for service updates from the selected 3rd party service when periodic is selected.
4118127
IP Manager
Services Configuration
Rev 2 Nov.15
Domain
Figure 8-5: ACEmanager: Services > Dynamic DNS IP Manager
Figure 8-6:
Field
Device Name
Description
The name you want for the device.
If you want to use the current device phone number as part of the
FQDN (for example, 6175551234.eairlink.com) enter #NETPHONE in this field. #NETPHONE is displayed in this field and everywhere else the device name is used, including on the Home > Status page, in SMS messages, in Event reports, as the PPPoE station name, etc.
Using #NETPHONE as the device name is recommended if the account phone number may change and you want the device to continue to use the current phone number as part of the FQDN, or if you are creating a template that will be applied to multiple devices.
To use this feature, you must have IP Manager selected in the Service
field.
The domain name to be used by the device. This is the domain name of the server configured for *IPMANAGER1.
Note: As a service, Sierra Wireless maintains IP Manager servers that can be used with any AirLink gateway. To use one of the free IP
Manager servers, enter eairlink.com in this field.
157
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
158
Field
IP Manager Server 1
(IP Address) /
IP Manager Server 2
(IP Address)
Description
The IP address or domain name of the dynamic DNS server which is running IP Manager.
Note: To use the Sierra Wireless IP Manager server, enter: edns1.eairlink.com (IP Manager Server 1) edns2.eairlink.com (IP Manager Server 2)
IP Manager Server 1
Update /
IP Manager Server 2
Update
IP Manager Server1
Update (mins) /
IP Manager Server2
Update (mins)
IP Manager Server 1
Key /
IP Manager Server 2
Key
Options are:
•
Only on Change
•
Periodic
How often, in minutes, you want the address sent to the IP Manager
User-defined password key used instead of the AirLink secret key when using an IP Manager server other than the one provided by
Sierra Wireless.
Tip:
Some PPPoE connections can use a Service Name to differentiate PPPoE devices.
Use the device name to set a Station Name for the PPPoE connection.
Understanding Domain Names
A domain name is a name of a server or device on the Internet associated with an
IP address. Similar to how the street address of your house or your phone number are ways to contact you, both the IP address and the domain name can be used to contact a server or device on the Internet. While contacting you at your house address or with your phone number employ different methods, using a domain name instead of the IP address uses the same method, just as a word based name is easier for most people to remember than a string of numbers.
Understanding the parts of a domain name can help to understand how IP
Manager works and what you need to be able to configure the device. A fully qualified domain name (FQDN) generally has several parts.
•
Top Level Domain (TLD): The TLD is the ending suffix for a domain name
(.com, .net, .org, etc.)
•
Country Code Top Level Domain (ccTLD): This suffix is often used after the
TLD for most countries except the US (.ca, .uk, .au, etc.)
•
Domain name: This is the name registered with ICANN (Internet Corporation for Assigned Names and Numbers) or the registry for a the country of the ccTLD (i.e., if a domain is part of the .ca TLD, it would be registered with the
Canadian domain registry). A name must be registered before it can be used.
•
Sub-domain or server name: A domain name can have many sub-domain or server names associated with it. Sub-domains need to be registered with
4118127
Rev 2 Nov.15
Services Configuration the domain, but do not need to be registered with ICANN or any other registry. It is the responsibility of a domain to keep track of its own subs.
car54.mydomain.com
•
.com is the TLD
•
mydomain is the domain (usually noted as mydomain.com since the domain is specific to the TLD)
•
car54 is the subdomain or server name associated with the device, computer, or device registered with mydomain.com
car54.mydomain.com.ca
This would be the same as above, but with the addition of the country code. In this example, the country code (.ca) is for Canada.
Tip:
A URL (Universal Resource Locator) is different from a domain name in that it also provides information on the protocol used by a web browser to contact that address such as
http://www.sierrawireless.com
. www.sierrawireless.com is a fully qualified
domain name, but http://, the protocol identifier, is what makes the whole thing a URL.
Dynamic Names
When an IP address is not expected to change, the DNS server can indicate to all queries that the address can be cached and not looked up for a long period of time. Dynamic DNS servers, conversely, have a short caching period for the domain information to prevent other Internet sites or queries from using the old information. Since the IP address of a device with a dynamic account can change frequently, if the old information was used (e.g., with a DNS server which indicates the address can be cached for a long period of time) when the IP address changed, the domain would no longer point to the new and correct IP address of the device.
If your AirLink gateway is configured for Dynamic IP when it first connects to the
Internet, it sends an IP change notification to the IP Manager. The IP Manager acknowledges the change and updates the Dynamic DNS server. The new IP address will then be the address for your device’s configured name.
When your device IP address has been updated in IP Manager, it can be contacted by name. If the IP address is needed, use the domain name to determine the IP address.
Note: The fully qualified domain name of your AirLink gateway will be a subdomain of the domain used by the IP Manager server.
159
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
SMS Overview
AirLink gateways can:
•
Receive commands via SMS message and send responses, even when the device does not have a data connection (for example, you can provision a device via SMS without having a data connection)
•
Act as an SMS gateway for a device connected to a local interface
Note: To use SMS with your AirLink gateway, you must have an account with SMS enabled.
ACEmanager has four SMS modes. Table 8-1 summarizes the capabilities of
each mode.
Table 8-1: SMS Mode Capabilities
Mode SMS
Command with password
SMS Command without password
Password Only
Control Only
Gateway Only
Yes
Yes
Yes
No
Yes*
No
SMS Gateway
No
No
Yes*
Control & Gateway
Yes Yes* Yes*
* Provided either:
•
Trusted Phone Number List is disabled.
•
Trusted Phone Number List is enabled and the device’s phone number is in the
Trusted Phone Number List.
For more information on Trusted Phone Number List, see
Inbound SMS Messages on page 173.
Sending SMS Commands to an AirLink
Gateway
Mobile
Network
Remote device
SMS
SMS response
AirLink gateway
Connected device
160 4118127
Rev 2 Nov.15
Services Configuration
The format for sending an SMS command varies depending on the mode. See
for details.
Table 8-2: SMS Command Formats
Mode
Password Only
Control Only (from a number on the
Trusted Phone Number list)
SMS Command Format
PW [Password] [Prefix][Command]
[Prefix][Command] or
PW [Password] [Prefix][Command]
PW [Password] [Prefix][Command]
Control Only (from a number not on the
Trusted Phone Number list)
Gateway Only
PW [Password] [Prefix][Command]
Note: Insert a space before and after [Password]; no space between [Prefix] and
[Command].
Examples:
[Prefix][Command]
“&&&reset”, where:
· &&& is the prefix
If the ALEOS Command Prefix field in ACEmanager (Services > SMS) is blank, the prefix is not required.
· reset is the command
PW [Password] [Prefix][Command]
“PW 1234 &&&reset”, where:
· 1234 is the password
For more information, see
SMS Password Security on page 175.
· &&& is the prefix
If the ALEOS Command Prefix field in ACEmanager (Services > SMS) is blank, the prefix is not required.
· reset is the command
For information on sending SMS commands and a list of available commands, see page
SMS Modes
The following sections provide instructions for configuring each of these modes and sending SMS messages:
•
•
•
•
For a list of available SMS commands, see page
355 . For a list of SMS-related AT
commands, see
161
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Password Only
In Password Only mode, you can send SMS commands to a device, provided you use the password. Gateway SMS messaging is not supported in this mode.
Note: In Password Only mode, the password is always required. The Trusted Phone
Number List is not available.
To configure Password Only mode:
1.
In ACEmanager, go to Services > SMS.
162
Figure 8-7: ACEmanager: Services > SMS (Password Only)
2.
In the SMS Mode field, select Password Only.
3.
Enter the desired password in the ALEOS Command Password field or leave the field blank to use the default password.
The password you enter can be any alphanumeric string between 1 and 255 characters long.
For more information see SMS Password Security on page 175.
4.
If desired, configure SMS Wakeup (see SMS Wakeup on page 172) and
Advanced options (see SMS > Advanced on page 177).
5.
Click Apply.
For information on the message format, see Sending SMS Commands to an
Control Only
In Control Only mode, you can send SMS commands to an AirLink gateway, but you cannot send non-command (gateway) SMS messages.
4118127
Services Configuration
You can send an SMS command without a password if:
•
Trusted Phone Number is disabled.
•
Trusted Phone Number is enabled and your phone number is on the Trusted
Phone Number List.
If Trusted Phone Number is enabled and your number is not on the Trusted Phone
Number List, you can still send an SMS command provided you use the password.
Configure ALEOS for Control Only mode
1.
In ACEmanager, go to Services > SMS.
Rev 2 Nov.15
Figure 8-8: ACEmanager: Services > SMS (Control only)
2.
In the SMS Mode field, select Control Only.
3.
Enter the desired password in the ALEOS Command Password field or leave the field as is to use the default password.
The password you enter can be any alphanumeric string between 1 and 255 characters long.
163
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
For more information see SMS Password Security on page 175.
Note: If all the SMS commands you send in Control Only mode are from a trusted number, you do not need to include a password when you send the command.
4.
If desired, change the ALEOS Command Prefix or use the default prefix,
&&&.
Note: If you leave the ALEOS Command Prefix field blank, no prefix is required when you send the SMS command. The option to omit the prefix is only available in Control Only mode.
5.
If desired, configure SMS Security options (see
SMS Wakeup (see SMS Wakeup on page 172), and Advanced options (see
6.
Click Apply.
For information on the message format, see Sending SMS Commands to an
Gateway Only
In Gateway Only mode you can send and receive SMS gateway messages through the AirLink gateway to a local device. SMS messages received by the
AirLink gateway (inbound) are sent on to the configured local device. Messages sent by the local device to a configured port on the AirLink gateway are sent out as SMSs (outbound) to a remote destination. Essentially, the AirLink gateway sends SMS messages between the cellular radio and the connected device.
In Gateway Only mode, you can also send SMS commands provided you include a password. For more information, see
Sending SMS Commands to an AirLink
To configure ALEOS for Gateway Only mode and format a Gateway message:
1.
In ACEmanager, go to Services > SMS.
164 4118127
Services Configuration
Rev 2 Nov.15
Figure 8-9: ACEmanager: Services > SMS (Gateway Only)
2.
In the SMS Mode field, select Gateway Only.
3.
Enter the desired password in the ALEOS Command Password field or leave the field blank to use the default password.
165
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
166
The password you configure can be any alphanumeric string between 1 and
255 characters long.
For more information see SMS Password Security on page 175.
4.
The SMS destination is the local interface where ALEOS forwards an SMS from the mobile network.
In the SMS destination field, select from the following options:
· Serial—Messages are forwarded to the Serial port on the destination device.
If you want to include the phone number as part of the information sent to the serial port, select Yes in the Include Phone Number on Serial field.
· IP—Messages are sent using UDP over IP to a designated LAN device.
Local Device Interface Configuration (Applies to inbound [to the local device] gateway messages when IP is the SMS destination and outbound
[from the local device])
Inbound
5.
Enter the Local Host IP address.
This is the IP address of the LAN device that is used as the destination for all incoming Gateway messages.
6.
Enter the Local Host Port.
This is the UDP port the destination device listens to for incoming messages.
Outbound
7.
Enter the ALEOS port.
This is the UDP port on which the AirLink gateway listens for outbound Gateway messages sent from any local device.
Message Format Configuration (Only applies if you selected IP in the SMS destination field)
8.
In the Start field, enter the start of message delimiter, or use the default
(<<<).
9.
In the Field Delimiter field, enter the delimiter to be used between fields in the
SMS message, or use the default (,).
10. In the End field, enter the end of message delimiter, or use the default (>>>).
11. In the ACK field, enter the desired acknowledgment message, or use the default (ACK). The acknowledgment is sent to the device as a UDP packet on the same port as the device used to send the message.
ALEOS provides a message acknowledgment for every SMS message when it is passed to the radio. If ALEOS does not send an ACK, wait for 30 seconds, and then retry.
Security
12. If desired, configure SMS Security options (see
SMS Wakeup (see SMS Wakeup on page 172), and Advanced options (see
13. Click Apply.
4118127
Rev 2 Nov.15
Services Configuration
If you are using IP as the destination and you have changed the IPs or port numbers, reboot the device.
For information on the message format for an SMS Command, see
Commands to an AirLink Gateway on page 160.
Sending a gateway message from a local IP device to a remote destination
Mobile
Network
AirLink gateway unpacks UDP packet and sends SMS to
Remote device
SMS
AirLink gateway
Ethernet or
USB Ethernet connected device
SMS message in UDP packet
The AirLink gateway acts as a gateway to send SMS messages from an IP connected device using AirLink SMS Protocol. The IP device sends a UDP packet to the AirLink gateway, which then sends the SMS to its destination.
Note: Outgoing SMS messages are limited to 140 characters.
To use AirLink SMS Protocol to send an SMS message from a connected device:
1.
Begin with the start field.
2.
Follow with the destination phone number. This number must be in the same format as the phone numbers in the Trusted Phone Number List.
Note: There is no space between the start number and the destination phone number or between any delimiter and the data fields.
3.
Add the field delimiter.
4.
Add the data type for the message:
For: Enter:
ASCII
8-bit
Unicode
ASCII
8BIT
UCS-2
Data types are case sensitive.
5.
Add another field delimiter.
6.
Add the number of ASCII characters in your original message (before it is converted to ASCII hex format).
7.
Add another field delimiter.
167
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
168
8.
Add the message to be sent in ASCII hex format. ASCII is case sensitive. Do not use any punctuation, such as a colon, or characters between hex pairs.
9.
Finish with the end field.
Example: You want to send the following message: “Test message” to phone number (510) 555-4200. To use this feature, convert the message to hex:54657374206d657373616765. Then format the message as follows:
<<<15105554200,ASCII,12,54657374206d657373616765>>> where:
· “<<<” is the start delimiter
· “15105554200” is the phone number
· “,” is the delimiter between fields
· “ASCII” is the data type
· “12” is the number of characters in the original message (before it is converted to ASCII hex format)
· “54657374206d657373616765” is the message itself
· “>>>” is the end delimiter
10. Send the UDP packet to the configured ALEOS port.
After your message is sent, you receive an ACK message in the format ACK
Field acknowledgment Code ACK Field. For example, if your message was successfully queued to be sent, you receive the message: ACK0ACK.
If you receive an error message, see
Note: You can also use AT*SMSM2M to send an SMS message to the remote device. For
more information, see SMSM2M on page 178.
Sending a gateway message to the connected device using IP address and port as the SMS destination
Mobile
Network
AirLink gateway encapsulates
SMS into a UDP packet and sends it to the connected device.
Remote device
SMS
AirLink gateway
Ethernet or
USB Ethernet
Connected device
SMS message in UDP packet
Messages from a remote device can be sent to the AirLink gateway. The AirLink gateway encapsulates the message in a UDP packet using AirLink SMS Protocol, and sends it to the configured Local Host IP and Local Host Port on the connected device.
Message example:
Example:
1. An SMS is sent from phone number (640) 555-4200 to the device: “Test message”
4118127
Rev 2 Nov.15
Services Configuration
2. The AirLink gateway receives the SMS and determines it is a gateway message.
3. The AirLink gateway converts the message into a UDP packet using the AirLink
SMS Protocol and sends it to the configured Local Host IP at Local Host Port.
The message as follows:
<<<16045554200,ASCII,12,54657374206d657373616765>>> where:
· “<<<” is the start delimiter
· “16045554200” is the phone number
· “,” is the delimiter between fields
· “ASCII” is the message type*
· “12” is the number of characters in the message
· “54657374206d657373616765” is the message itself
· “>>>” is the end delimiter
* In this example the message is in ASCII, but it could also be in 8-bit or Unicode format:
For: Enter:
ASCII
8-bit
ASCII
8BIT
Unicode UCS-2
Data types are case sensitive.
Sending a gateway message to the connected device using Serial or USB Serial as the SMS destination
Mobile
Network
AirLink gateway sends the body of the SMS message to the serial port on the connected device as ASCII text. If the Include Phone
Number on Serial field is set to Yes, it adds the phone number to the beginning of the message.
Remote device
SMS
AirLink gateway
Serial or USB Serial
Connected device
ASCII text
A message can be sent from a remote device to the AirLink gateway. The AirLink gateway sends the body of the message in ASCII text to the connected device. If the Include Phone Number on Serial field is set to Yes, the AirLink gateway prepends the phone number to the message.
169
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Control and Gateway
In Control and Gateway mode you can do both—send commands to the device and send gateway messages to the connected device. When the Trusted Phone
Number List is enabled, all SMS messages from trusted devices that do not begin with the password indicator (PW) or the command prefix are sent to the connected device as a gateway message.
For more information, see Trusted Phone Number on page 174.
Configure ALEOS for Control and Gateway mode
1.
In ACEmanager, go to Services > SMS.
2.
Select Control and Gateway.
170 4118127
Services Configuration
Rev 2 Nov.15
Figure 8-10: ACEmanager: Services > SMS (Control and Gateway)
For more information, see Control Only
on page 162 and Gateway Only on page 164.
171
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
SMS Wakeup
This feature is supported on International AirLink gateways on the Vodafone network.
a mobile network data connection on receipt of an SMS. After the connection is established, it remains active until the configured timeout expires. The mobile network data connection closes after the specified timeout period. Outgoing traffic sent after the timer is triggered does not reset the timer.
To configure SMS Wakeup:
1.
In ACEmanager go to WAN/Cellular > Advanced and ensure that the Always on connection field is set to Disabled - Connect on traffic.
2.
Go to Services > SMS.
172
Figure 8-11: ACEmanager: Services > SMS
3.
In the SMS Wakeup Trigger field, select the type of SMS that should wake up the device. The options are:
· Feature Disabled
· Any Class 0 message
· Class 0 Wake Command
· Any SMS message
· Wake Command
Note: “Class 0 Wake Command” and “Wake Command” are SMS commands.
4.
Click Apply.
4118127
Rev 2 Nov.15
Services Configuration
5.
In the Connection timeout (minutes) field, enter the number of minutes the mobile network data connection remains active after SMS Wakeup Trigger is received. Accepted values for this field are 2–65535. The default value is 2.
You can also set the Connection timeout using an AT command. For more information, see
6.
If you selected Class 0 Wake Command or Wake Command in step 3, you
can specify the SMS command name in the Wake Command field or use the default value, WAKEUP. Sending this SMS to the device will wake it up.
Example: &&&WAKEUP (&&& is the SMS command prefix.)
7.
Click Apply.
SMS Security
Inbound SMS Messages
Incoming SMS messages are received as UDP packets, and forwarded to the local device IP address and port. The UDP packets are in the same format as sent messages.
When Trusted Phone Number security is enabled, incoming messages coming from the phone numbers in the Trusted Phone Number list are the only ones for which commands will be performed (relay, response etc.) or gateway messages forwarded. Incoming messages from all other phone numbers will be ignored.
Commands sent to the device with the correct password are always treated as coming from a trusted number.
All non-alphanumeric characters except a space will be replaced by a dot in
ACEmanager.
173
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 8-12: ACEmanager: Services > SMS > Security
Field Description
SMS Security - Inbound SMS Messages
Trusted Phone
Number
Allows you to Enable or Disable a trusted phone number
Last Incoming Phone
Number
The last inbound phone number is displayed here. This will only be erased with a reset to defaults.
Last Incoming
Message
The last incoming message is the last inbound SMS from the phone number. This will only be erased with a reset to defaults.
Trusted Phone
Number List
Trusted phone numbers are listed here
Trusted Phone Number
Follow the instructions below to add a Trusted Phone Number on the SMS page.
1.
Send an SMS command to the device, and hit Refresh. If Trusted Phone
Number is enabled, and the phone number is not in the Trusted Phone
Number List, no action is performed on the message.
174 4118127
Rev 2 Nov.15
Services Configuration
2.
Once you have the Last Incoming Phone Number that shows up on the SMS window in ACEmanager, note the exact phone number displayed.
3.
Click Add More to add the Trusted Phone Number. The Last Phone Number will continue to display. Additions to the Trusted Phone Number become effective immediately. You do not need to reboot the device.
Note: The Trusted Phone number can be up to 15 characters long and must be comprised of numbers only.
Note: Phone Numbers (both trusted and not trusted) will be displayed in the Last Incoming
Phone Number field.
4.
Enter the Last Incoming Phone Number as the Trusted Phone Number.
5.
Click Apply.
Note: Do not enter any extra digits, and use the Last Incoming display as a guide to type the phone number. Use “1” only if it is used in the beginning of the Last Incoming Phone
Number.
With Trusted Phone Number enabled, only those SMS messages from Trusted
Phone Numbers will receive responses to commands or messages acted on as applicable.
SMS Password Security
The SMS Password feature enables you to use a password to send a command at any time to the device. Even if Trusted Phone Number is enabled, you can send an SMS command from a non-trusted number, provided you include the password.
A default SMS password is generated from the last four characters of the SIM ID
(for all SIM-based devices) or the ESN (for devices without a SIM, such those using EV-DO), or you can configure your own SMS password.
Tip:
If you do not know the SIM ID or ESN number you can find it in ACEmanager
(Status > WAN/Cellular).
Note: The SMS password is not the same as the ALEOS password used to access
ACEmanager or Telnet/SSH.
To configure the SMS password:
1.
Go to Services > SMS > SMS Mode.
175
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
176
Figure 8-13: ACEmanager: Services >SMS > Password
2.
Enter the desired SMS password in the ALEOS Command Password field.
The password can be any alphanumeric string with a length between 1 and
255 characters.
3.
Click Apply.
Note:
•
The SMS password is not displayed in plain text in ACEmanager. If you want to query it, use the AT command. See
•
The SMS password is not cleared by a configuration reset.
•
If an SMS command is sent with the wrong SMS password, the device replies with a
“Wrong Password” message, and the command is dropped.
Using the Default SMS Password
You can use the default SMS password (last 4 characters of either the SIM ID number for SIM-based devices, or the ESN for devices without a SIM) with no prior configuration.
Note: The default password:
•
Works with all SMS commands
•
Is not displayed in ACEmanager (If the ALEOS Command Password field is blank, the default password is used.)
•
Is overridden by a user-defined password
•
Changes if the SIM is changed, if no user-defined password is configured
4118127
SMS > Advanced
Services Configuration
Figure 8-14: ACEmanager: Services > SMS > Advanced
Field
SMS Address Type
SMS Address
Numbering Plan
Description
For most networks, use the default setting (International). The address type of the phone number used to send outgoing messages and command responses. Options are:
•
International (default)
•
National
•
Network Specific
•
Subscriber
•
Abbreviated
For most networks, use the default setting (ISDN/Telephone). The address numbering plan of the phone number used to send outgoing messages and command responses. Options are:
•
Unknown
•
ISDN/Telephone (default)
•
Date Numbering
•
Telex
•
National
•
Private
•
ERMES
Rev 2 Nov.15
177
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
AT+CGSMS
Quick Test
Quick Test
Destination
Description
Allows you to choose the technology used to send SMS messages. For most networks, use the default setting (Do nothing). Options are:
•
Do nothing (default)
•
Set AT+CGSMS=0—GPRS
•
Set AT+CGSMS=1—Circuit switched
•
Set AT+CGSMS=2—GPRS Preferred (Uses circuit switched if GPRS is not available)
•
Set AT+CGSMS=3—Circuit Switched Preferred (Uses GPRS if circuit switched is not available)
Note: If your gateway is able to receive SMS messages, but is unable to send them, try changing this field to Set AT+CGSMS=1.
Note: This field does not appear on CDMA/EV-DO devices or on LTE devices that fallback to CDMA/EV-DO.
Allows you to send a test message to the destination entered in the Quick Test Destination field.
Enter the phone number to use for the test message. Click Apply before clicking the Quick
Test button.
This field is cleared on reboot.
SMSM2M
SMS messages can be sent from the serial command interface. Enter
AT*SMSM2M=”[phone] [message]”. The phone number needs to be in the same format as numbers entered in the Trusted Phone Number List.
The message must not exceed 140 characters. To send several messages back to back, you must wait for the OK before sending the next message.
178 4118127
Command
*SMSM2M
*SMSM2M_8
*SMSM2M_u
Services Configuration
Description
*SMSM2M is the command for ASCII text.
*SMSM2M_8 is the command for 8-bit data.
*SMSM2M_u is the command for unicode.
Format:
*smsm2m=”[phone][ascii message]”
*smsm2m_8=”[phone][hex message]”
*smsm2m_u=”[phone][hex message]”
•
The phone number can only consist of numbers (NO spaces or other characters). The phone number should be as it appears in the Last
Incoming Phone Number field.
Example 1 (US): 14085551212 (including leading 1 and area code)
Example 2 (US): 4085551212 (ignore leading 1, include area code)
Example 3 (UK): 447786111717 (remove leading 0 and add country code)
Command Examples:
*smsm2m=”18005551212 THIS IS A TEST” sends in ASCII.
*smsm2m_8="17604053757 5448495320495320412054455354" sends the message “THIS IS A TEST” as 8-bit data.
*smsm2m_u="17604053757
000102030405060708090a0b0c0d0e0f808182838485868788898A8b8c8d8e
8f" sends the bytes:
00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f
80 81 82 83 84 85 86 87 88 89 8a 8b 8c 8d 8e 8f
Note: Not all cellular carriers support 8-bit or unicode SMS messages.
Rev 2 Nov.15
179
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Telnet/SSH
Use the Telnet or SSH protocol to connect to any AirLink gateway and send AT commands.
A secure mechanism to connect remote clients is a requirement for many users.
In ACEmanager, Secure Shell (SSH) is supported to ensure confidentiality of the information and make the communication less susceptible to snooping and man-in-the-middle attacks. SSH also provides for mutual authentication of the data connection.
For information on configuring an AirLink gateway to use SSH or Telnet to access
a connected serial device, see SSH PAD Mode on page 26.
Figure 8-15: ACEmanager: Services >Telnet/SSH
Field Description
Remote Login Server
Mode
Default Telnet User
Select either Telnet (default) or SSH mode.
Select a default Telnet User name
Options are:
•
None—When you log into a Telnet session, you are prompted for a user name and password.
•
user—When you log into a Telnet session, you are prompted only for a password.
Telnet uses the default user name (user).
Note: The default user name is only for Telnet; not SSH.
180 4118127
Services Configuration
Field Description
Remote Login Server
Telnet/SSH Port
Sets or queries the port used for the AT Telnet/SSH server.
Default: 2332
Tip:
Many networks have the ports below 1024 blocked. We recommend that you use a higher numbered port.
Remote Login Server
Telnet/SSH Port
Timeout (mins)
Maximum Login
Attempts
Telnet/SSH Echo
Telnet/SSH port inactivity time out.
Default: 2 (minutes)
Sets the maximum number of login attempts.
Default: 6
Enable (default) or disable AT command echo mode.
Make SSH Keys
SSH Status
Creates keys for SSH session applications
Provides the status of the SSH session
Note: When you are connected to SSH locally, you cannot have OTA SSH connected.
Email (SMTP)
For some functions, the device needs to be able to send email. Since it does not have an embedded email server, you need to specify the settings for a relay server for the device to use.
A reboot is required after configuring the email settings.
Note: The SMTP function will only work with a mail server that will allow relay email from the ALEOS device’s Net IP.
Rev 2 Nov.15
181
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure 8-16: ACEmanager: Services > Email (SMTP)
Field
General
SMTP Server
Description
Port
Specify the IP address or Fully Qualified Domain Name (FQDN) of the SMTP server to use.
•
d.d.d.d = IP Address
•
name = domain name (maximum: 40 characters)
Server port (Default is 25.)
Encryption method
SSL
StartTLS
465
Default port
587
From Email Address
Sets the email address from which the SMTP message is being sent.
•
email = email address (maximum: 30 characters)
User Name (optional)
Specifies the username to use when authenticating with the server
Password (optional)
Sets the password to use when authenticating the email account (*SMTPFROM) with the server (*SMTPADDR).
•
pw = password
Note: The email server used for the relay may require a user name or password.
182 4118127
Services Configuration
Field
Message Subject
Quick Test
Description
Allows configuration of the default Subject to use if one is not specified in the message by providing a “Subject: xxx” line as the initial message line.
•
subject = message subject
After completing the other fields on this screen, click the Quick Test button to send a test
email. The status of the test appears in the Test status field.
Enter the email address you want the test email sent to.
Quick Test
Destination
Test status
SSL/TLS
Encryption
After you press the Quick Test button, the status of the email test appears in this field.
Choose the encryption method:
•
None—No encryption is used (default)
•
SSL—Use a secure connection directly
•
StartTLS—Transforms an non-secure connection to a secure one
For SSL and StartTLS default ports, see
Verify Peer Certificate
Choose whether or not to use a peer certificate
Disable—No certificate is used (default)
Enable—Verifies that the server name used for the connection matches the name and alternative names in the certificate loaded using the
Load Trusted CA Certificate field.
Load Trusted CA
Certificate
To load a certificate:
1.
Click the Load Trusted CA Certificate button.
2.
Click browse and navigate to the certificate you want to load.
3.
Click Upload File to Device.
Note: Because the starting and expiration dates of the certificate are checked, the date used by the device must be correct. Sierra Wireless strongly recommends that you enable
Network Time Protocol (NTP) on the Services > Time (SNTP) tab.
Trusted CA Certificate
Name
The name of the loaded certificate appears in this field.
Rev 2 Nov.15
183
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Management (SNMP)
The Simple Network Management Protocol (SNMP) is designed to allow for remote management and monitoring of a variety of devices from a central location. It is generally used to monitor conditions that may require attention.
The SNMP management system is composed of:
•
One or more managers (administrative computers)
•
SNMP-compliant devices (such as your AirLink gateway, a router, a UPS, a web server, a file server, or other computer equipment)
•
An agent (data collection software running on the SNMP-compliant devices)
•
A Network Management System (NMS) that monitors all the agents on a specific network.
The agent stores information about the device in a Management Information Base
(MIB). The manager can send messages to this database to configure and query the status of the device. In addition, the agent running on the device can send traps (unsolicited messages) to the manager on startup, on status change, or when an error condition occurs.
AirLink gateways supports SNMPv2c and SNMPv3 and you can configure them as SNMP agents.
Authentication ensures SNMP messages coming from the AirLink gateway have not been modified and the device cannot be queried by unauthorized users.
SNMPv3 uses a User-Based Security Model (USM) to authenticate and, if desired or supported, message encryption. USM uses a user name and password specific to each device.
A reboot is required after configuring SNMP.
184 4118127
SNMPv2
Services Configuration
Figure 8-17: ACEmanager: Services> Management (SNMPv2)
Field
SNMP Configuration
Enable SNMP
SNMP Version
SNMP Port
SNMP Contact
SNMP Name
SNMP Location
Description
Allows you to enable/disable SNMP
Default: Disable
Allows you to select either SNMP protocol Version 2 (default) or Version 3 communications.
Controls which port the SNMP Agent listens on:
•
1–65535
•
Default is 161.
This is a personal identifier of the contact person you want to address queries to.
This is a customer defined field.
This is the name of the device you want to refer to.
This is a customer defined field.
Location of where your device is stored
Enter a meaningful description of where the AirLink gateway is located.
Rev 2 Nov.15
185
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Read Only SNMP User
Community Name
The community name is a text string that acts as a password. It is used to authenticate messages that are sent between the management station and the device.
Default is public.
Read/Write SNMP User
Community Name
TRAP Server User
TRAP Server IP/FQDN
Identifies the IP address or fully qualified domain name (FQDN) of the trap server that the
AirLink gateway sends SNMP traps to
TRAP Server Port
The community name is a text string that acts as a password. It is used to authenticate messages that are sent between the management station and the device.
Default is private.
Community Name
Identifies the specific port the trap server is on
•
1–65535
•
Default is 162.
The community name is a text string that acts as a password. It is used to authenticate messages that are sent between the management station and the device.
There is no default value.
186 4118127
SNMPv3
Services Configuration
Figure 8-18: ACEmanager: Services> Management (SNMPv3)
Field
SNMP Configuration
Enable SNMP
Description
SNMP Version
SNMP Port
SNMP Contact
SNMP Name
SNMP Location
Allows you to enable/disable SNMP
Default is Disable.
Allows you to select either SNMP protocol Version 2 (default) or Version 3 communications.
Controls which port the SNMP Agent listens on:
•
1 – 65535
•
Default is 161.
This is a personal identifier of the contact person you want to address queries to. This is a customer defined field.
This is the name of the device you want to refer to. This is a customer defined field.
Location of where your device is stored. This is a customer defined field.
Rev 2 Nov.15
187
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Read Only SNMP
User Name
Security Level
Authentication Type
Authentication Key
Privacy Type
Description
Allows these SNMP users to view, but not change the network configuration
Security types available: None, Authentication Only, and Authentication and Privacy.
Authentication types available: MD5 or SHA
Note: This field is only available when you select either Authentication and Privacy, or
Authentication Only in the Security Level field.
This key authenticates SNMP requests for SNMPv3.
•
Minimum length: 8 ASCII characters
•
Maximum length: 255 ASCII characters
Example: My Key_1234
Note: This field is only available when you select either Authentication and Privacy, or
Authentication Only in the Security Level field.
Privacy types available: AES or DES
Note: This field is only available when you select Authentication and Privacy in the
Security Level field.
Privacy Key
This key ensures the confidentiality of SNMP messages via encryption
•
Minimum length: 8 ASCII characters
•
Maximum length: 255 ASCII characters
Example: My Key_56789
Note: This field is only available when you select Authentication and Privacy in the
Security Level field.
Read/Write SNMP
For a description of the Read/Write SNMP fields, see
TRAP Server User
TRAP Server IP/FQDN
Identifies the IP address or fully qualified domain name (FQDN) of the trap server that the
AirLink gateway sends SNMP traps to
TRAP Server Port
Identifies the specific port the trap server is on
•
1 – 65535
•
Default is 162.
188 4118127
Services Configuration
Field
Engine ID
User Name
Security Level
Authentication Type
Authentication Key
Privacy Type
Privacy Key
Description
The Engine ID is a mandatory field that uniquely identifies the SNMPv3 agent in the device to the server.
The Engine ID is 5–32 octets long (1 octet is 2 hex characters). That is:
•
Minimum length: 10 hex characters
•
Maximum length: 64 hex characters
Create the engine ID by entering hex characters only, with no leading 0x. For example,
ABCDEF1020
See Security Level on page 188.
See Authentication Type on page 188.
See Authentication Key on page 188.
Time (SNTP)
The device can be configured to synchronize its internal clock with a time server on the Internet using the Simple Network Time Protocol.
Rev 2 Nov.15
Figure 8-19: ACEmanager: Services > Time (SNTP)
189
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Enable time update
Description
Enables daily SNTP update of the system time.
Default: Disable
SNTP Server Address
SNTP Server IP address, or fully qualified domain name, to use if *SNTP=1. If blank, time.nist.gov is used.
•
d.d.d.d=IP address
•
name=domain name
Authentication
ALEOS supports ACEmanager login using secure LDAP, RADIUS, and TACACS+ authentication schemes. This enables enterprise IT managers to centrally manage access to AirLink gateways and produce an audit trail showing which users logged into specific devices and when.
Note the following:
•
You can configure any or all of these schemes at the same time. When more than one scheme is configured, the authentication is successful if at least one of the schemes authenticates the user.
•
Successful authentication can take time. For example, if you have all three authentication schemes enabled, ALEOS first attempts to reach the LDAP server. If it is unable to reach the LDAP server in the configured timeout period, it abandons the attempt and tries to reach the RADIUS server. If that server is unreachable after the timeout period, it then tries to reach the
TACACS+ server. If none of the servers are reachable in the configured timeout periods, ALEOS falls back to ACEmanager user name and password authentication.
•
LDAP, RADIUS, and TACACS+ provide authentication (checks the user’s credentials) but do not check authorization (account expiration date, user rights, etc.) All users authenticated using the LDAP, RADIUS, and TACACS+ servers have administrative rights (i.e. a user account, not a viewer account) and can modify the AirLink gateway settings. Ensure that LDAP, RADIUS, and
TACACS+ users are authorized to modify device settings.
•
LDAP, RADIUS, and TACACS+ are supported for ACEmanager logins, but are not supported by other AirLink gateway services such as Telnet, SSH,
PPPoE, etc.
For instructions on configuring these authentication schemes, see:
•
LDAP Authentication on page 191
•
RADIUS Authentication on page 192
•
TACACS+ Authentication on page 193
190 4118127
Services Configuration
LDAP Authentication
Lightweight Directory Access Protocol (LDAP) is a network protocol for accessing and manipulating information stored in a directory. It is suitable for using with information that must be easily available and accessible, and does not change frequently. AirLink gateways support LDAP version 3.
To configure LDAP:
1.
Go to Services > Authentication.
2.
In the LDPA Client field, select Enable.
Rev 2 Nov.15
Figure 8-20: ACEmanager: Services > Authentication > LDAP
3.
Enter:
· The LDAP server IP address or resolvable domain name
· The Port number (default is TCP port 389)
4.
Ensure that the LDAP server IP address/port is reachable not only from outside the company, but also from inside the mobile network your gateway is on.
You can use a utility such as netcat to test this. If netcat is available try: nc -z <IP> <port; echo $?
191
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
5.
Configure the other fields as described in the following table.
Field
Timeout (seconds)
Description
The time limit for the server to respond
•
1–60 seconds
Default is 30 seconds.
Note: If the server does not respond during the timeout (no route to host, server down, network too slow etc.), the authentication fails and the next enabled authentication mechanism checks the credentials.
Encryption
Base DN
Bind DN
Bind DN User
Bind on Password
Select the encryption type
Options are:
•
None
•
SSL—Secure Sockets Layer protocol —Non-standard legacy (pre-LDAPv3) encryption type
•
StartTLS—Secure mechanism integrated into the
LDAPv3 protocol (default)
The Base DN is the path int he LDAP tree to the list of users
(example shown is dc=sierrawireless,dc=com). This is where the LDAP protocol searches for a matching user to authenticate.
Choose how the LDAP search is done
Options are:
•
Anonymous—Bind anonymously (default)
•
Explicit—Use a specific account to bind with
This field only appears if you selected Explicit in the Bind DN field
The full path of the user authorized to perform requests in the
LDAP database (example shown is cn=admin,dc=sierrawireless,dc=com)
This field only appears if you selected Explicit in the Bind DN field
User password to bind with
6.
Click Apply.
RADIUS Authentication
Remote Authentication Dial In User Service (RADIUS) uses UDP and checks authentication credentials, using a shared key.
To configure RADIUS:
1.
Go to Services > Authentication.
2.
In the RADIUS Client field, select Enable.
192 4118127
Services Configuration
Rev 2 Nov.15
Figure 8-21: ACEmanager: Services > Authentication > RADIUS
3.
Configure the other fields as described in the following table.
Field
RADIUS Server
Port
Timeout (seconds)
Description
RADIUS server IP address or resolvable domain name
By default, RADIUS uses UDP port 1812
The time limit for the server to respond
•
1–60 seconds
Default is 30 seconds.
Note: If the server does not respond during the timeout (no route to host, server down, network too slow etc.), the authentication fails and the next enabled authentication mechanism checks the credentials.
Secret
4.
Click Apply.
Shared secret for configured server
TACACS+ Authentication
Terminal Access Controller Access-Control System Plus (TACACS+) uses TCP protocol and encrypts the entire packet, except the header.
To configure TACACS+:
1.
Go to Services > Authentication.
2.
In the TACACS+ Client field, select Enable.
193
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
194
Figure 8-22: ACEmanager: Services > Authentication > TACACS+
3.
Enter:
· The TACACS+ server IP address or resolvable domain name
· The Port number (default is TCP port 389)
4.
Ensure that the TACACS+ server IP address/port is reachable not only from outside the company, but also from inside the mobile network your gateway is on.
You can use a utility such as netcat to test this. If netcat is available try: nc -z <IP> <port; echo $?
5.
Configure the other fields as described in the following table.
Field
Timeout (seconds)
Description
The time limit for the server to respond
•
1–60 seconds
Default is 30 seconds.
Note: If the server does not respond during the timeout (no route to host, server down, network too slow etc.), the authentication fails and the next enabled authentication mechanism checks the credentials.
Authentication service
Secret
The type of bind used for authentication
Options are:
•
PAP—Password Authentication Protocol (default)
•
CHAP— Challenge Handshake Authentication Protocol
The stronger of the two protocols. Recommended, provided it is supported by all the client devices.
•
Login— User name and password
Shared secret for configured server
4118127
Services Configuration
6.
Click Apply.
Device Status Screen
The Device Status Screen feature, when enabled, allows you to add network status parameters to the ACEmanager Login screen. Once enabled, subsequent logins to ACEmanager display whatever status parameters have been previously checked on the Device Status Screen.
Figure 8-23: ACEmanager: Services > Device Status Screen
Field Description
Enable Device Status on Login Screen
Enables device status parameters on the login screen
Options are: Disable or Enable (default)
Status to display
Allows you to display specific network status parameters on the login screen
Rev 2 Nov.15
195
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
196 4118127
9: Events Reporting Configuration
Introduction
You can configure the AirLink gateway to generate reports or initiate actions based on specified events. Events can either be generated internally, such as a a signal quality indicator crossing a specified threshold, or by external devices attached to the analog or digital inputs.
Events that can trigger reports or actions include:
•
A switch on connected equipment opens or closes (digital input)
•
A pulse accumulation crosses a configured threshold
•
An analog meter on connected equipment crosses a configured threshold (Analog input is reported in volts or transformed to meaningful units.)
•
Changes to network status such as signal strength, network state, and network service
•
The gateway’s power supply (in volts) crosses a configured threshold
•
The AirLink gateway board or radio temperature crosses a configured threshold
•
A configured threshold for daily or monthly data usage is crossed
Depending on the type of report, reports can be sent to a local or remote report server or an email address
summarizes how
Event reporting works.
9
Rev 2 Nov.15
Internet
Report server
Local server
Computer
AirLink gateway
Internal Events, e.g.
- RSSI
- Temperature
- Network State
Connected equipment
External Events, e.g.
- Digital I/O
- Pulse Accumulator
Figure 9-1: Events Reporting
Events/Actions are not one shot activities. After an Action is performed, the Event is still active and will trigger an Action the next time the state change or threshold crossing occurs.
197
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
198
A single Event may activate one or more Actions. For example, if RSSI is below threshold, you can send an email (Action 1) and send an SNMP TRAP (Action 2).
A single Action may be activated by one or more Events. For example, if either the network state changes to Network Ready or the RSSI crosses a configured threshold, the same Action is performed.
Configuring Events Reporting
Before you begin
If you plan to use either of the following, configure that feature in ACEmanager before configuring Events Reporting:
•
Email (
•
SNMP Trap (
Management (SNMP) on page 184)
Configuring Events Reporting
When configuring Events Reporting, first configure the Action (that is, how you want to be notified when the Event occurs). Then configure the Event you want reported, and finally, link the Event to the Action.
Note: All Events Reporting configuration changes take effect after a short delay (about one minute). No reboot of the AirLink gateway is necessary.
Configuring the Action
Note: You can define a maximum of 5 Actions.
Click the appropriate link for instructions on configuring the desired Action. Once
the Action is configured, proceed to Event Types on page 202.
•
•
Note: Sending an email report is limited to SMTP servers that are open and do not require a secure login.
To configure ALEOS to send an email report:
1.
Ensure that email is configured on the Services > Email (SMTP) screen. (See
.)
2.
On the Events Reporting tab, select Actions from the menu on the left.
3.
Enter the desired Action Name.
4118127
Events Reporting Configuration
4.
From the drop-down menu in the Action Type field, select Email.
Rev 2 Nov.15
Figure 9-2: ACEmanager: Events Reporting > Action Type > Email
5.
Complete the Email Information section with the recipient’s email address, the subject line, and the desired message.
6.
In the Body Type field, select the desired format for the Data Group information included in the report.
7.
In the Data Group section, select the data to be included in the email report.
For more information on the options, see Report Data Group on page 200.
8.
Click Apply.
The name you assigned to the Action appears under Actions. You can click on this anytime to modify the settings.
9.
Optional—If desired, after you have updated all the fields and clicked the
Apply button, wait about 1 minute, and then click the Test report button to send a test email to verify that the destination and format are correct.
199
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
10. Click Events on the menu on the left and follow the instructions on Event
Types on page 202 to configure the Event you want associated with this
Action and to link the Action to the Event.
SNMP TRAP
To configure ALEOS to send an SNMP TRAP notification:
1.
Ensure that SNMP is configured on the Services > Management (SNMP)
.)
2.
On the Events Reporting tab, select Actions from the menu on the left.
3.
Enter the desired Action Name.
4.
From the drop-down menu in the Action Type field, select SNMP TRAP.
200
Figure 9-3: ACEmanager: Event Reporting > Action Type
5.
Click Apply.
The name you assigned to the Action appears under Actions. You can click on this anytime to modify the settings.
6.
Click Events on the menu on the left and follow the instructions on Event
Types on page 202 to configure the Event you want associated with this
Action and to link the Action to the Event.
If you have more than one event or action configured, the trap indicates which
Event triggered which Action.
Report Data Group
For email messages, you can select the data you want to be included in the report. Check the box corresponding to the data displayed. By default, all the boxes are clear.
4118127
Events Reporting Configuration
Rev 2 Nov.15
Figure 9-4: ACEmanager: Events Reporting > Action (Data Group)
The reports attributes are:
•
Digital and Analog I/O
· Include Digital Input 1—The status of the digital input
· Include Digital Output 1—The status of the digital output
· Include Pulse Accumulator—The pulse count for the digital input
•
Device Name
These elements in the Device Name group are general identifiers for the Air-
Link gateway and its cellular account.
· Include Device ID—The device ID (serial number) for the AirLink gateway
· Include Phone Number—The phone number of the AirLink gateway
· Include Device Name—The name of the AirLink gateway
· Include MAC Address—The MAC Address of the Ethernet port of the
AirLink gateway
· Include SIM ID—The SIM ID of the AirLink gateway
· Include IMSI—The IMSI of the SIM installed in the AirLink gateway
· Include GPRS Operator—The wireless Mobile Network Operator the SIM card is associated with
· Include Time—The time the AirLink gateway is active
•
Network Data
The Network Data in this group relates to the mobile network and the connection state of the AirLink gateway.
· Include Network State—The network state for the AirLink gateway
· Include Network Channel—The network channel to which the AirLink gateway is connected
· Include RSSI—The signal strength for the AirLink gateway
· Radio Technology—Type of service being used by the device (e.g. EV-DO
HSPA, LTE)
· Include Network Service—The network service for the AirLink gateway
· Include Network IP—The IP address given by the mobile network
· Include Daily Usage —The daily usage of the AirLink gateway (Units as configured on the Applications > Data Usage screen)
· Include Monthly Usage —The monthly usage of the AirLink gateway (Units as configured on the Applications > Data Usage screen)
201
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
•
Tx/Rx
The Network Traffic in this group relates to the mobile network and the network between the AirLink gateway and any directly connected device(s).
· Include Bytes Sent—The number of bytes sent on the mobile network since last reset
· Include Bytes Received—The number of bytes received from the mobile network since last reset
· Include Host Bytes Sent—The number of bytes sent from the network between the AirLink gateway and the connected device(s) since last reset
· Include Host Bytes Received—The number of bytes received from the network between the AirLink gateway and the connected device(s) since last reset
· Include IP Packets Sent—The number of IP packets sent on the mobile network since last reset
· Include IP Packets Received—The number of IP packets received from the mobile network since last reset
· Include Host IP Packets Sent—The number of IP packets sent from the network between the AirLink gateway and the connected device(s) since last reset
· Include Host IP Packets Received—The number of IP packets received from the network between the AirLink gateway and the connected device(s) since last reset
•
Misc Data
Miscellaneous Data includes temperature rates and other information that does not fit in the other categories
· Include Power In—The voltage level of the power coming in to the AirLink gateway at the time of the report
· Include Board Temperature—The temperature of the internal hardware of the AirLink gateway at the time of the report
· Include Host Comm State—The signal level between the AirLink gateway and the connected device(s)
· Radio Temperature—The temperature of the internal radio module
· CDMA PRL Version—PRL version used by the AirLink gateway
· CDMA EC/IO—The quality of the signal from the cellular CDMA network
· GSM EC/IO—The quality of the signal from the cellular GSM network
· Cell Info—The mobile network cell information for the AirLink gateway
Event Types
Note: You can define a maximum of 5 Events.
To define an Event:
1.
On the Event Reporting tab, select Events > Add New from the menu on the left.
202 4118127
Events Reporting Configuration
Figure 9-5: ACEmanager: Events Reporting, Events > Add New
2.
Enter the desired name for the Event.
3.
Select the Event type from the drop-down menu.
4.
Select the Event Operator and the Value to Compare. The options available depend on the Event type you choose. See
Table 9-1 on page 204 for a list of
options for each Event type.
5.
All the configured Actions appear at the bottom of the screen. Select the check box beside the Action you want to associate this Event with.
6.
Click Apply.
Rev 2 Nov.15
Figure 9-6: ACEmanager: Events Reporting > Events
203
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table 9-1: Event Types
Event Name Event Type
Digital Inputs
Digital Input
The AirLink
ES450gateway has 1 digital input.
Pulse Accumulator
The AirLink
ES450gateway has 1 pulse accumulator.
State Change
Event Operator Options
•
Disable
•
When Switch Closed
•
When Switch Opened
•
On any change
Threshold Crossing
•
Disable
•
When Changed By
N/A
•
•
Values to Compare
Pulse Accumulator Delta
Starting Trigger Value
Network
RSSI
Network State
Network Service
Threshold Crossing
State Change
State Change
•
Disable
•
When Above Threshold
•
When Below Threshold
•
When Cross Threshold
•
Disable
When Cellular is Ready
(Triggered when a cellular connection is established)
•
Disable
•
On Service
•
On No Service
•
On Change
Value To Compare (Signal
Power (-dBm))
N/A
Value To Compare (Network
Service):
•
Roaming
•
2G Service
•
Rev A or HSUPA
•
Any Data Service
Other Report Types
Periodic Reports
Threshold Crossing
(Time)
•
Disable
•
Periodically
Value To Compare: Report
Period (secs)
Note: The minimum interval between periodic reports is
3 seconds. Setting an interval less than 3 seconds results in only one report being sent.
Power In
Threshold Crossing
•
Disable
•
When Above Threshold
•
When Below Threshold
•
When Cross Threshold
Value To Compare (Power In
Threshold (volts))
204 4118127
Events Reporting Configuration
Table 9-1: Event Types (Continued)
Board Temperature
Threshold Crossing
Radio Temperature
Threshold Crossing
•
Disable
•
When Above Threshold
•
When Below Threshold
•
When Cross Threshold
•
Disable
•
When Above Threshold
•
When Below Threshold
•
When Cross Threshold
Data Usage
Value To Compare
(Temperature Threshold (°C))
Value To Compare
(Temperature Threshold (°C))
Daily Data Usage
Threshold Crossing
Monthly Data Usage
Threshold Crossing
•
Disable
•
When Above Threshold
•
Disable
•
When Above Threshold
Value To Compare
(% of Limit)
Value To Compare
(% of Limit)
Note: You can only configure one Event with either a Daily Data Usage or Monthly Data Usage trigger. If you configure more than one, for example, a trigger when the Daily Data Usage reaches a certain percentage and a trigger when the
Monthly Data Usage reaches a certain percentage, only the last threshold configured is used.
ALEOS Data Usage is approximate and should not be compared with data usage recorded by the Mobile Network
Operator. SIERRA WIRELESS IS NOT RESPONSIBLE FOR DATA OVERAGES.
Rev 2 Nov.15
205
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
206 4118127
10: Serial Configuration
Use the serial port to connect devices or computers using a DB9-
RS232 connection.
Note: These commands are specific to the RS232 port and generally do not apply to USB/serial.
10
Port Configuration
Serial Port Configuration consists of five categories of configurable parameters:
•
Port Configuration on page 208
•
•
•
•
Rev 2 Nov.15
207
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Port Configuration
Figure 10-1: ACEmanager: Serial > Port Configuration > Port Configuration
Table 10-1: Serial Port Configuration > Port Configuration
Field Description
Port Configuration
Serial Port
This field allows you to disable the serial port. Default is Enable.
208 4118127
Serial Configuration
Table 10-1: Serial Port Configuration > Port Configuration
Field Description
Startup Mode Default
Default power-up mode for the serial port. When the AirLink gateway is power-cycled, the serial port enters the communication mode specified.
Note: It can take up to 5 minutes to establish a connection.
login Reverse Telnet
•
Normal (AT command) default
•
PPP
•
UDP
•
TCP
•
Reverse Telnet/SSH—Allows you to telnet or SSH into a router or other device connected to the AirLink gateway via a serial port. For information on configuring
reverse telnet, see Reverse Telnet/SSH on page 210.
•
UDP Multiple Unicast—This option is not supported on the ES450 gateways.
You can also use an AT command to configure this field. See MD on page 340.
This field only appears when the Startup Mode Default field is set to Reverse Telnet/SSH.
Determines the log in procedure when using reverse telnet.
•
Enable—Do not enter a user name and password when you telnet to a a router or other device that has a serial connection to your AirLink gateway. Login is automatic.
(default)
•
Disable—Enter a user name and password when you telnet to a a router or other device that has a serial connection to your AirLink gateway.
For more information about reverse telnet, see
Reverse Telnet/SSH on page 210.
Configure Serial Port
Format: [speed][data bits][parity][stop bits]
Valid speeds are 300–115200, data bits: 7 or 8, parity: O,E,N,M, stop bits: 1,1.5.
Default is 115200,8N1.
You can also use an AT command to configure this field. See S23 on page 347.
Flow Control
DB9 Serial Echo
Data Forwarding
Timeout (.1 seconds)
Serial port flow control setting
•
None—No flow control is being used (default)
•
Hardware—RTS/CTS hardware flow control is being used
•
Transparent SW—Transparent software flow control. Uses escaped XON and XOFF for flow control. XON and XOFF characters in data stream are escaped with the @ character (0x40). @ in data is sent as @@.
You can also use an AT command to configure this field. See \Q on page 346.
AT command echo mode
•
Enable—Text is visible as you type (default)
•
Disable—Text you type is not visible
You can also use an AT command to configure this field. See
The Data Forwarding Timeout feature causes ALEOS to wait until no data has been received on the serial port for the specified period of time beyond the built-in delay of
100 ms before sending a new PAD packet.
Acceptable values are: 0–255. (Unit is 0.1 second; default is 1.)
If the field is set to 0 or 1, the feature is disabled. ALEOS sends the new PAD packet after the built-in 100 ms delay.
Data Forwarding Timeout is not applicable to AT and PPP modes.
Rev 2 Nov.15
209
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table 10-1: Serial Port Configuration > Port Configuration
Field Description
Data Forwarding
Character
PAD data forwarding character. ASCII code of character that causes data to be forwarded.
Used in UDP or TCP PAD mode
Default is 0 (No forwarding character).
You can also use an AT command to configure this field. See S51 on page 341.
Device Port
Serial MTU
Destination Port
Destination Address
Default Dial Mode
Host Authentication
Mode
PPP User ID
PPP Password
The port on the AirLink gateway used for incoming TCP/UDP communication (Default is
12345)
If either, or both, of the UDP Answer or TCP Answer parameters are enabled, when the
AirLink gateway receives incoming TCP or UDP packets that are destined for this port, it strips off the IP header and send the packet payload out its serial port.
You can also use an AT command to configure this field. See
The serial maximum transmit unit (PAD payload)
Valid range: 256–4096 bytes (Default is 1304)
Recommended settings:
•
UDP PAD—1472 bytes
•
TCP PAD—1460 bytes
You can also use an AT command to configure this field. See *UDPPADMTU on page 343.
The destination port that TCP/UDP communication is sent to
You can also use an AT command to configure this field. See S53 on page 341.
IP address TCP/UDP communication is sent to
You can also use an AT command to configure this field. See S53 on page 341.
Protocol used to send messages
Options are:
•
TCP
•
UDP (default)
You can also use an AT command to configure this field. See
Sets the authentication method the host uses for PPP. Options are:
•
None (default)
•
CHAP—The stronger of the two protocols. Recommended, provided it is supported by all the client devices
•
PAP and CHAP—If CHAP is not supported by the client, the host reverts to PAP.
Sets the User ID for authentication
Sets the User Password for authentication
For information on configuring an AirLink gateway to use SSH PAD mode, see
Reverse Telnet/SSH
The Reverse Telnet/SSH feature allows you to connect to and configure a router or other device that has a serial connection to your AirLink gateway.
You can have only one Reverse Telnet session open at a time. If a new Reverse
Telnet session is started, any existing Reverse Telnet connection will be closed.
210 4118127
Serial Configuration
However, you can simultaneously have:
•
One Telnet session for Reverse Telnet (using the port configured in the
Device Port field on the Serial > Port Configuration page)
•
One Telnet session for AT Commands (using the port configured in the
Remote Login Server Telnet Port field on the Services > Telnet/SSH page)
Note: If you are using Reverse Telnet and you have VPNs, the more VPN tunnels in use, the greater the CPU load. This may result in lower throughput or greater delays.
To configure Reverse Telnet/SSH:
1.
Log into ACEmanager and go to Serial > Port Configuration.
2.
In the Startup Mode Default field, select Reverse Telnet/SSH.
3.
In the Configure Serial Port field, set the speed, data bits, parity, and stop bits. (The serial port configuration depends on the router you want to connect to. For example, to connect to a Cisco router that has a default baud rate of
9600, enter 9600,8N1 in the Configure Serial Port field.)
Rev 2 Nov.15
4.
Optional—If you are planning to use telnet (rather than SSH), you can be automatically logged in when you telnet to the AirLink gateway without having to enter a user name and password. login is not supported with SSH.
To set up automatic login:
211
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
a.
In the login Reverse Telnet field, select Enable.
b. Click Apply.
5.
Go to Services > Telnet/SSH.
6.
In the Remote Login Server Mode field, select:
· Telnet—if you want to Telnet into the connected device
· SSH—if you want to SSH into the connected device
Note: If you enabled login, select Telnet.
212
7.
Click Apply.
8.
Reboot the AirLink gateway.
9.
Use a Telnet or SSH terminal client such as Putty or Teraterm to connect to the appropriate port:
· If you are using login, Telnet to the port specified in the Device Port field
(default is 12345). SSH is not available with login.
· If you are not using login, you can Telnet or SSH into the port specified in the Remote Login Server Telnet/SSH Port field (default is 2332).
10. If prompted, log in with the following credentials:
· User name: sconsole
· Password: 12345 (default)
4118127
Rev 2 Nov.15
Serial Configuration
For information on changing the default reverse telnet password, see
ALEOS redirects you to the router or other device connected to the AirLink gateway serial port. You can use this connection to configure connected device.
Note: You may be required to enter a user name and password to access the router or other device.
213
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Advanced
Figure 10-2: ACEmanager: Serial > Port Configuration > Advanced
Table 10-2: Serial Port Configuration > Advanced
Field Description
Advanced
Assert DSR
Assert DSR always when the device is in a data mode (UDP, TCP, etc.), or when the device is in network coverage. Options are:
•
Always (default)
•
In Data Mode
•
In Coverage
You can also use an AT command to configure this field. See &S on page 346.
Assert DCD
DTR Mode
Assert DCD always, or when the device is in a data mode (UDP, TCP, etc.) or when the device is in network coverage. Options are:
•
Always
•
In Data Mode (default)
•
In Coverage
You can also use an AT command to configure this field. See &C on page 344.
Use DTR from the serial device, or ignore DTR (same as S211 on page 348). Options are:
•
Use DTR
•
Ignore DTR (default)
214 4118127
Serial Configuration
Table 10-2: Serial Port Configuration > Advanced
Field Description
Quiet Mode
Disable or enable display of device responses. Options are:
•
Disable (default)
•
Enable
You can also use an AT command to configure this field. See Q on page 346.
AT Verbose Mode
Call Progress Result
Mode
Sets the level of information returned for AT commands
Options are:
•
Verbose (default)
•
Numeric
You can also use an AT command to configure this field. See V on page 348.
When enabled adds 19200 to CONNECT messages
Options are:
•
Disable (default)
•
Enable
You can also use an AT command to configure this field. See X on page 348.
Convert 12 digit
Number to IP Address
Choose whether a 12-digit number is converted to an IP address (eg. 111222333444 to
111.222.333.444). Options are:
•
Use as Name (default)
•
Use as IP
You can also use an AT command to configure this field. See *NUMTOIP on page 341
Disable ATZ Reset
IP List Dial
The value set in this field determines whether or not issuing an ATZ Command resets the
AirLink gateway. Options are:
•
On — Block is enabled—ATZ does not reset the device.
•
Off —Block is disabled—ATZ resets the device. (default)
You can also use an AT command to configure this field. See *DATZ on page 345.
This allows access to the Modbus IP Address using the first two digits of the dial string. For example, ATDT1234567 would imply ID index 12 on the Modbus Address list and use the associated IP Address as the destination. Options are:
•
Disable (default)
•
Enable
Keep Alive Mode
Keep Alive delay
When this feature is enabled, the AirLink gateway reboots if there is no traffic for longer than the period configured in the Keep Alive Delay field. Options are”
•
Disable (default)
•
Enable
When Keep Alive Mode is enabled, use this field to set the delay (in minutes) before the
AirLink gateway reboots if there is no traffic on the serial port. Accepted values:
•
10–65535 (Default is 10.)
Rev 2 Nov.15
215
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
TCP
Figure 10-3: ACEmanager: Serial > Port Configuration > TCP
Table 10-3: Serial Port Configuration > TCP
Field Description
TCP
TCP Answer
This determines how the AirLink gateway responds to an incoming TCP connection request. The AirLink gateway remains in AT Command mode until a connection request is received. The AirLink gateway sends a “RING” string to the host. A “CONNECT” sent to the host indicates acknowledgment of the connection request and the TCP session is established.
•
Disable (default)
•
Enable
You can also use an AT command to configure this field. See S0 on page 347.
TCP Connect Timeout
(seconds)
Specifies the number of seconds to wait for a TCP connection to be established when dialing out (Default is 30.)
You can also use an AT command to configure this field.
TCP Idle Timeout
TCP idle time-out in the configured units (See TCP Idle Timeout Unit on page 217.)
Specifies a time interval upon which if there is no in or outbound traffic through a TCP connection, the connection is terminated.
Default is 5.
You can also use an AT command to configure this field. See TCPT on page 342.
216 4118127
Serial Configuration
Table 10-3: Serial Port Configuration > TCP
Field Description
TCP Idle Timeout Unit
Units used for the TCP Idle Timeout Interval.
Options are:
•
Minutes (default)
•
Seconds
You can also use an AT command to configure this field. See TCPS on page 342.
TCP Connect
Response Delay
(seconds)
The number of seconds to delay the “CONNECT' response upon establishing a TCP connection, or the number of tenths of seconds to delay before outputting ENQ on the serial port after the CONNECT when the ENQ feature is enabled.
•
0–255 (Default is 0.)
You can also use an AT command to configure this field. See S221 on page 348.
Include Device ID on
TCP Connect
If this option is enabled, after a TCP connection is established, ALEOS sends a packet that contains the device ID (and optionally a prefix, suffix, and CRLF). Options are:
•
Disable (default)
•
Enable
Device ID Prefix
Device ID Suffix
Send CR LF after
Device ID
Sets the Prefix DID in the device identification packet upon TCP connection. Maximum length of the prefix is 80 characters.
Sets the Suffix DID in the device identification packet upon TCP connection. Maximum length of the suffix is 80 characters.
Enables a carriage return to be inserted in the device identification packet after the Suffix
DID. Options are:
•
no CR LF
•
send CR
•
send CR LF (carriage return, line feed) Default
Rev 2 Nov.15
217
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
UDP
Figure 10-4: ACEmanager: Serial > Port Configuration > UDP
Table 10-4: Serial Port Configuration > UDP
Field Description
UDP
UDP Auto Answer
UDP Idle Timeout
(seconds)
Whether the AirLink gateway answers and incoming UDP connection request
Options are:
•
Disable (default)
•
Enable
You can also use an AT command to configure this field. See S82 on page 342.
UDP Idle Time-out in seconds
Specifies a time interval upon which if there is no in or outbound traffic through a UDP connection, the connection is terminated.
•
0— No idle time-out
•
1–255 Time-out in seconds (Default is 50.)
You can also use an AT command to configure this field. See S83 on page 342.
218 4118127
Serial Configuration
Table 10-4: Serial Port Configuration > UDP
Field Description
UDP Connect Last
Allows you to choose to use the last accepted IP address and port number as the default settings, instead of using S53 (destination address)
Options are:
•
Do not change S53 (default)
•
Set S53 last IP
Note: Resetting the device restores the configured S53 (destination address).
You can also use an AT command to configure this field. See *UDPLAST on page 343.
Allow Any Incoming IP
When UDP answer is enabled, use this field to select whether to allow any incoming IP address to connect or to only allow the configured destination IP address to connect.
Options are:
•
Allow only S53 (default)
•
Allow any IP address
If you select Allow only S53, the Destination Port and Destination Address fields under
Serial > Port Configuration must be configured. (See Table 10-1 on page 208.)
You can also use an AT command to configure this field. See AIP on page 339.
Allow All UDP
UDP Auto Answer
Response
Accepts UDP packets from all IP addresses when a UDP session is active. If there is no
UDP session active, an incoming UDP packet is treated according to the UDP answer and
AIP settings. Options are:
•
No effect (default)
•
Allow all—The AirLink gateway accepts all UDP traffic from any IP address during a
UDP session.
You can also use an AT command to configure this field. See *UALL on page 342.
Half-Open Response—In UDP answer (half-open) mode. Options are:
•
No Response—No Response codes when UDP session is initiated (default)
•
RING CONNECT—RING CONNECT response codes sent out serial link before the data from the first UDP packet
Dial UDP Always
UDP Serial Delay
(.1 second)
Note: Quiet Mode must be Off.
You can also use an AT command to configure this field. See HOR on page 346.
The dial command always uses UDP, even when using ATDT. Options are:
•
Disable—Dial using the means specified (default)
•
Enable—Dial UDP always, even when using ATDT
Note: When this parameter is set you cannot establish a TCP PAD connection.
You can also use an AT command to configure this field. See *DU on page 339.
Waits the specified delay before sending the first received UDP packet and the subsequent
UDP packets out to the serial port (in 100 ms units).
•
No UDP packet delay (default)
•
1–255— Delay in 100 ms units, from 100 ms to 25.5 sec.
You can also use an AT command to configure this field. See *USD on page 343.
Rev 2 Nov.15
219
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table 10-4: Serial Port Configuration > UDP
Field Description
UDP Keepalive
(seconds)
UDP Recovery Ping
Use this field to configure the time interval (in seconds) for sending UDP keepalive packets.
Options are:
•
1–65535—ALEOS sends a UDP packet, containing the AirLink gateway’s IMEI (in little endian) to the configured Destination IP Address:Destination Port when the UDP connection is first established and then at the configured interval.
If the AirLink gateways WAN IP address changes, a UDP packet is sent and the timer is reset.
•
0—UDP Keepalive is disabled. (default)
If an IP is provided in this field and no UDP packets are received from the server for the
UDP Idle Timeout period, the gateway sends a single ping to this IP.
This functionality is designed to resolve a known issue where a Verizon Wireless GX440 becomes temporarily unreachable from the mobile network after a period of time in which no data is sent or received.
PPP
Use Point-to-Point Protocol (PPP) to establish a connection between a host PC serial port and the AirLink gateway, as shown in
.
PPP connection
Serial cable
Host PC
Figure 10-5: PPP connection
AirLink gateway
WAN connection
Internet
220
Figure 10-6: ACEmanager: Serial > Port Configuration > PPP
4118127
Serial Configuration
Table 10-5: Serial Port Configuration > PPP
Description Field
PPP a
Device PPP IP
Sets the device IP address (in private mode)
Host PPP IP
Sets the host IP address (in private mode) a.
Note: This section is only visible when PPP is selected in the Startup Mode Default field.
Configuring IP to Serial with Answer and
Serial to IP
You can configure the AirLink gateway to:
•
Answer incoming TCP/IP or UDP/IP connections and send the packet payload out the AirLink gateway’s serial port to a connected device
•
Create and send TCP/IP or UDP/IP packets containing payload data that the
AirLink gateway receives over its serial port from a connected device
•
Both receive and send TCP/IP or UDP/IP packets (that is, both of the above functionalities)
Internet
Serial
Receive packets; send payload data out over serial
Receive payload data over serial; create and send out packets
TCP /IP packet
UDP/IP packet
TCP /IP packet
UDP/IP packet
AirLink gateway
Connected device
Packet contents streamed over serial
Packet contents streamed over serial
Both: receive packets; send payload data out over serial AND receive payload data, create and send out packets
TCP /IP packet
UDP/IP packet
Figure 10-7: TCP and UDP Answer
Packet contents streamed over serial
To configure the AirLink gateway for TCP/UDP answer, sending IP packets or both:
1.
In ACEmanager, go to Serial > Port Configuration.
Rev 2 Nov.15
221
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Required fields for receiving data payloads over serial, creating IP packets to send
Required fields for receiving IP packets and sending out data payloads over serial
Required fields both receiving data payloads over serial, creating IP packets to send and receiving data payloads over serial, creating IP packets to send
Figure 10-8: ACEmanager: Serial > Port Configuration
2.
Use
and the instructions following the table to configure the desired options for this feature.
Table 10-6: Quick Guide to Configuring IP to Serial with Answer and Serial to IP
Field To receive packets and send data payload out over serial
To receive data payloads over serial and send out packets
Both (to receive packets - send out data payload AND receive data payload and send out packets)
N/A UDP or TCP UDP or TCP Startup Mode Default
.
Configure Serial Port
See
Flow Control
See
115200,8N1
None
115200,8N1
None
115200,8N1
None
222 4118127
Serial Configuration
Table 10-6: Quick Guide to Configuring IP to Serial with Answer and Serial to IP
Field To receive packets and send data payload out over serial
To receive data payloads over serial and send out packets
Both (to receive packets - send out data payload AND receive data payload and send out packets)
Device Port
See
.
12345 N/A 12345
Destination Port
See
.
Destination Address
See
.
N/A
N/A
Required
Required
Required
Required
3.
Startup Default Mode—When the Startup Mode is set to UDP or TCP, the
AirLink gateway takes any data sent to its serial port by a connected device and encapsulates it into a TCP/IP or UDP/IP packet.
4.
Configure Serial Port—Set the baud rate of the serial port on the AirLink gateway so that it matches the baud rate of the serial port on the connected device. (The default baud rate is 115200 bps.) You can also use this field to set the framing characteristics for the serial port communication on those rare occasions when the default value of 8N1 does not apply.
5.
Flow Control—This field can usually be left at the default value (None) as most serial devices use only a 3-wire connection (Tx, RX, and Gnd).
However, if the serial device uses the RTS and CTS pins on the serial connection to control data flow between the two devices, set this field to
Hardware.
6.
Device Port—Data received on a TCP/IP or UDP/IP connection to the configured Device Port is sent out the serial port. The default value for the port:
· On the AirLink gateway is 12345
7.
Destination Port—The AirLink gateway uses the port value specified in this field to determine which port it sends the IP packet containing the data payload to. The AirLink gateway enters the value in the Destination Port field in the header of the IP packet it creates.
8.
Destination Address—The AirLink gateway uses the IP address specified in this field to determine the IP address to send the packet it creates to. The
AirLink gateway enters this IP address in the header of the IP packet it creates.
9.
If you are configuring the AirLink gateway to:
· Create and send packets only, go to step Step 10 .
· Receive TCP/UDP packets, complete the following instructions.
Rev 2 Nov.15
223
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
For Receiving TCP/IP Packets: a.
Expand the +TCP section of the screen.
Figure 10-9: ACEmanager: Serial > Port Configuration > TCP
b. Set the TCP Answer field to Enable.
For Receiving UDP/IP Packets: a.
Expand the +UDP section of the screen.
Figure 10-10: ACEmanager: Serial > Port Configuration > UDP
b. Set the UDP Answer field to Enable.
c.
Set the Allow Any Incoming IP field to Allow Any IP. (If this field is left at the default value, the AirLink gateway only accepts incoming UDP/IP packets from the IP address specified in the Destination Address field in the Port Configuration section of the screen.
10. For information on the other parameters, see
Port Configuration on page 207.
11. Click Apply.
12. Click Reboot (in the upper right of the screen).
13. Once the reboot is complete, this feature is enabled.
If the packet contents are not being sent to the connected device, see the
troubleshooting information in TCP/IP and UDP/IP Auto Answer on page 380.
224 4118127
Rev 2 Nov.15
Serial Configuration
LED Indicator
You can configure the Activity LED on the AirLink gateway to flash red when traffic is being transmitter or received over the serial port.
Figure 10-11: ACEmanager: Serial > LED Indicator
Table 10-7: Serial > LED Indicator
Field
Display
Description
Options are:
•
Disable (default)
•
Enable
If this field is set to Enable, the Activity LED on the AirLink gateway flashes red when traffic is being transmitted/received on the serial port selected in the Serial Port field.
Activity LED
Off
Flashing Green
Flashing Red
Flashing Yellow
Traffic
No traffic
Traffic on WAN interface
Traffic on selected serial port
Traffic on both the WAN interface and selected serial port
You can also use an AT command to configure this field. See
*SERIALLEDDISPLAY on page 342. For a complete list of LED
behavior, refer to the AirLink gateway Hardware User Guide.
225
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
226 4118127
11: Applications Configuration
The Applications tab consists of a Data Usage section and an
ALEOS Application Framework section.
Data Usage
Note: Before configuring
Data Usage, ensure that the AirLink gateway receives date and time information from the mobile network. You can also use the ACEmanager
SNTP client to receive time from an SNTP server. (See
Time (SNTP) on page 189.) If necessary,
contact your Mobile
Network Operator to confirm that the mobile network provides date and time information to connected devices.
The Data Usage feature on the Applications tab in conjunction with
Events Reporting provides you with a way to actively monitor cellular data usage.
Once data usage is configured, you can use event reporting to:
•
Actively monitor the cellular data usage by configuring monthly and/or daily usage level thresholds that result in notifications being sent to you (e.g. email or SNMP Trap) when the threshold is reached.
Note: You can configure Events Reporting to notify you when the threshold set in Data Usage is reached, but ALEOS does not block further access to the mobile network.
Note: ALEOS Data Usage is approximate and should not be compared with data usage recorded by the Mobile Network Operator.
Sierra Wireless is NOT responsible for data overages.
11
Step 1—Configure Data Usage
1.
In ACEmanager, go to Applications > Data Usage.
2.
In the Usage Monitoring field, select Enable.
3.
Enter the desired values in the Daily or Monthly Limit fields (in
GB or MB), and the day of the month that the billing cycle starts.
For more details, see the table starting on page 228 .
4.
Click Apply.
Rev 2 Nov.15
227
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
228
Figure 11-1: ACEmanager: Applications > Data Usage
Field
General
Usage Monitoring
Plan Units
Description
Use this field to enable or disable data usage monitoring. Options are:
•
Disable (default)
•
Enable
Select the units used for your data plan. The options are:
•
MB—Megabytes (default)
•
KB—Kilobytes
Note: When you change the units in this field, the units for values in
fields are not converted and must be updated manually.
4118127
Rev 2 Nov.15
Applications Configuration
Field
Daily Limit
Daily Limit
Description
This is the user-specified daily (24 hour) data usage limit (in MB or KB, depending on the value in the
Plan Units field). You can specify data
usage limits on a daily basis. A limit is essentially a threshold that can trigger the software to take a user-specified action if the usage goes above the threshold. See
Events Reporting Configuration on page 197.
Note: The Daily Limit value MUST be expressed as an integer (i.e., a whole number) and NOT as a fraction (e.g., “3.5”).
Note: Daily usage is cleared at midnight, UTC.
Caution:
Data usage limits are approximate and based on reporting conditions in ALEOS. Data usage may run over the amount set in this field before the action specified for the threshold trigger takes effect.
Tip:
ALEOS reads the data usage every 3 to 5 minutes. If you are using an application that requires high data usage, you can set an alert to warn you when data usage reaches a safe limit that takes into account the amount of data expected over the 3 to 5 minutes between data usage readings. For information on how to set an alert or other action, see
Events Reporting Configuration on page 197.
Current Daily Usage
Displays the current daily data usage (in MB or KB, depending on the
option selected in the Plan Units
field)
Note: Data usage includes data sent and data received.
229
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Monthly Limit
Monthly Limit
Description
This is the user-specified monthly data usage limit (in MB or KB, depending on the option selected in the
field). Data usage accumulates on a monthly basis and on the date you specified (the
“rolling month”). Data usage accumulates during the month until the end of the next billing period, at which point the data usage totals are reset.
Note: The Monthly Limit value MUST be expressed as an integer (i.e., a whole number) and NOT as a fraction (e.g., “3.5”)
Note: Monthly usage is cleared at midnight, UTC on the last day of the billing cycle.
Current Monthly
Caution:
Data usage limits are approximate and based on reporting conditions in ALEOS. Data usage may run over the amount set in this field before the action specified for the threshold trigger takes effect.
Displays the current monthly data usage (in MB or KB, depending on
the value configured in Plan Units on page 228.)
Note: Data usage includes data sent and data received.
Start of Billing Cycle
(Day of Month)
Enter the desired start of the billing cycle. For example, 3 (Day 3 of every month)
Changing the value in this field resets the
Current Monthly field to zero.
Previous Day
Previous Daily Usage
Shows the data usage for the previous day (in MB or KB, depending on
the value configured in Plan Units on page 228.)
Note: Data usage includes data sent and data received.
230 4118127
Applications Configuration
Step 2—Configure Event Reporting
1.
In ACEmanager, go to Events Reporting > Actions.
Rev 2 Nov.15
Figure 11-2: ACEmanager: Events Reporting > Actions
231
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
232
Figure 11-3: ACEmanager: Events Reporting > Events
2.
Select the desired Action to be performed when the Event is triggered, such as SNMP Trap or Email, and enter the appropriate information in the related fields. For detailed instructions, see
Configuring Events Reporting on page 198.
3.
Some reports give you the option to include additional information. If applicable, select the check box(es) in the Data Group section of the screen to indicate the information to be included in the report.
Note: You can have more than one Action for a single Event, but you can only have one
Daily Usage and one Monthly Usage Event.
4.
Click Apply.
5.
Go to Events Reporting > Events and configure a data usage threshold.
The threshold is specified as a percentage of the monthly or daily limit. For example, if you have a monthly limit of 5 GB, and the threshold is set at 80%, then threshold is reached at 4 GB of data. For detailed instructions, see
Configuring Events Reporting on page 198.
4118127
Applications Configuration
Rev 2 Nov.15
Figure 11-4: ACEmanager: Events Reporting > Events
6.
At the bottom of the screen, select the check box beside the Action you want to associate the Event with.
7.
Click Apply.
ALEOS Application Framework
ALEOS Application Framework (AAF) allows you to develop your own applications to run inside an AirLink gateway and leverage the ALEOS Application
Platform ( source.sierrawireless.com/resources/airlink/aleos_af/aleos_af_home/ ) or a customer-developed server platform.
Sierra Wireless gateways come without an AAF user password. Before using
AAF, select a password and go to Admin > Change Password to enter it. See
User Password on page 242. The AAF Development Studio (DevStudio)
application uses this password to communicate with the gateway.
Once the AAF user password is set up, embedded and server application developers can start using AAF by accessing the ALEOS Application Platform
( source.sierrawireless.com/resources/airlink/aleos_af/aleos_af_home/ ).
You may want to reserve the serial port for an AAF application. To do so, select
Enable in Applications > ALEOS Application Framework > Serial Port Reserved.
It is not necessary to reserve the serial port before activating AAF.
Reserving the serial port is mandatory only if the AAF application will be using the serial port.
Note: When you reserve the serial port for AAF, it cannot be used for any other serialrelated ALEOS features.
233
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
234
Figure 11-5: ACEmanager: Applications > ALEOS Application Framework
Field Description
General
Available RAM (KB)
Available Flash (KB)
CPU Load
(Last 15 minutes)
ALEOS Application
Framework
Available RAM in kilobytes (1000 bytes), updated every 30 seconds
Available Flash on the user partition in kilobytes (1024 bytes), updated every 30 seconds
CPU load, averaged over the last 15 minutes and updated every 30 seconds
The CPU load relates to how many applications are attempting to execute in parallel over the 15-minute period. If the load is greater than
1, some applications are waiting for CPU capacity to become available and may be delayed in launching.
Enable or disable (default) the ALEOS Application Framework (ALEOS
AF). If enabled, ALEOS AF starts at boot time. When the Reset to
Factory default button on the Admin > Advanced page is pressed,
ALEOS AF is disabled.
Serial Port Reserved
Select Enable to reserve the serial port for ALEOS AF. When this field is set to Enable, the serial port cannot be used for any other serialrelated ALEOS features. The options are:
•
Disable (default)
•
Enable
QCOM DM Port
Resource Reserve
Reserves the QCOM DM port for ALEOS AF applications. Options are:
Enable (Reserve access for ALEOS AF) or Disable (Reserve access for ALEOS). Default: Disable
4118127
Applications Configuration
Field Description
Installed AAF Applications
Application Name start
Version
Status
To help you manage installed applications, the table in this section shows all the installed AAF Applications and displays the:
•
Application name
•
start—true or false
•
Version
•
Status—STARTED or STOPPED
If no applications are installed, the table displays the message:
“No application installed or AAF not started”.
Rev 2 Nov.15
235
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
236 4118127
12: I/O Configuration
The I/O tab in ACEmanager applies to all Sierra Wireless AirLink gateways that feature I/O ports.
You can use the input/outputs on AirLink gateways to generate reports based on a threshold being crossed, a switch being opened or closed, or the number of times a switch has changed state.
Use the Events Reporting screen to configure reports. (See Events
Reporting Configuration on page 197.) Use the I/O screen to view the
current state of the digital inputs, to turn the relays on and off, and to configure the units you want used in the reports based on analog inputs.
The number of digital input/outputs depends on the device.
AirLink ES450
The AirLink ES450:
•
Has one pin (Pin 4 on the power connector) that can be configured as a digital input/output or a relay output
•
Does not support analog input
More information
For more information, refer to the Hardware Configuration User
Guide for your AirLink gateway.
Digital inputs
Digital inputs monitor contact closures on a switch. This allows you to monitor changes such as:
•
When a door or latch is open or closed
•
When a container is full or empty
•
When a switch or valve is opened or closed
•
The level of fuel in a vehicle (connected to an on/off sensor)
•
When the trunk of a vehicle is opened or closed
You can use Events Reporting to generate reports and actions based on the digital input values.
Volts
-0.5 –1.2
2.2 – 30
Digital 0
Digital 1
Interpreted as
12
Rev 2 Nov.15
237
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
For more information on setting up reports, see Events Reporting Configuration on page 197.
Relay outputs
You can use relay outputs to trigger an intermediary switch and change the state of equipment.
Current State
The Current State screen allows you to view the current values (as of the last refresh) of analog and digital inputs, pulse counts for digital inputs, and raw and transformed values for analog inputs. You can also use this screen to change the current values for Relay outputs. This change occurs immediately without a reboot.
Figure 12-1: ACEmanager: I/O > Current State
Table 12-1: I/O: Current State
Command Description
Digital Input 1 value
Pulse Count 1
Displays the current value for the digital input:
•
0 —Open
•
1 —Closed
Digital input 1 displays the value for Pin 4 on power connector.
You can also use an AT command to read these values. See *DIGITALIN1?
The pulse count increments when the input value changes from high to low.
Pulse count 1 displays the value for Pin 4 on power connector.
Note:
To reset the pulse count to zero, reset the device to the factory defaults.
238 4118127
I/O Configuration
Table 12-1: I/O: Current State
Command Description
Analog Input 1 (Volts)
Relay Output 1
Analog input
You can also use the AT Command
to query this setting. See page 349
.
Controls the internal current sink that you can use to drive a relay or for other use purposes where a switchable low side current sink is required. For more details refer to the hardware user guide. Options are:
•
OFF (default)—The current sink is deactivated.
•
Drive Active Low—The current sink is activated.
Note: You cannot set this field to Drive Action Low if the I/0 line is already being used by the internal pull-up resistor or by standby mode.
You can also use an AT command (see *RELAYOUT1 on page 349), an SMS
command (see [prefix]relay x y on page 356), or a RAP command (refer to the Remote
Application Protocol User Guide) to configure this field.
Note: Changes to this field go into effect immediately. No reboot of the AirLink gateway is necessary.
Pulse Count
Pulse Count details:
•
Pulses are counted on falling edge (high to low).
•
Repeated pulses cannot be counted when the device is powered off, or being reset. However, a single change in state while the device is powered off or being reset is counted properly.
•
To reset the pulse count to zero, reset the device to the factory defaults.
Configuration
This screen allows you to configure the initial relay settings
For more information, refer to the Hardware Configuration User Guide for your
AirLink gateway.
Figure 12-2: ACEmanager: I /O > Configuration
Rev 2 Nov.15
239
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Relay1 Initial Setting
Description
The initial setting for the current sink when the AirLink gateway is powered on
Options are:
•
ON
•
OFF (default)
•
Last Value (The value remains the same as it was before the AirLink gateway was powered down).
When you change this field, the corresponding digital input value on this screen reflects the change after a screen refresh.
240 4118127
13: Admin
Change Password
For system security reasons, changing the default password of the
AirLink gateway is highly recommended.
13
Rev 2 Nov.15
Figure 13-1: ACEmanager: Admin
To change the default password:
1.
Select the User Name associated with the password you want to change: user, viewer, or sconsole.
(To create an AAF user password, see AAF User Password on page 242.)
2.
Enter the old password.
3.
Enter the new password twice.
The password can be 4 to 32 characters long and can contain a mixture of letters, numbers, and/or special characters. The password is case sensitive.
Note: If the password is lost, the only way to recover access to the AirLink gateway is to use the hardware reset button to reset the device to the factory default settings. If the reset button has been disabled (using the
field on the Admin > Advanced screen) prior to the password being lost, the only way to recover access to the AirLink gateway is through AirLink Management Services, for which an account is required.
4.
Click Change Password.
If you want to confirm that the password has been changed, log out and then log in with the new password.
241
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Note: There are two user levels in the User Name drop-down menu. The ‘user’ has full administrator rights and can edit the configuration; the ‘viewer’ can only view the configuration and status of the device. Viewer can change the ‘viewer’ password. User can change both.
AAF User Password
An AAF user password is required if you want to use ALEOS Application
Framework (AAF) to develop your own applications to run inside an AirLink gateway. This password is used when installing an AAF application from
DevStudio onto the gateway.
To enter an AAF user password:
1.
In ACEmanager, go to Admin > Change Password.
2.
From the User Name drop-down menu, select AAF user.
Figure 13-2: ACEmanager > Change Password (AAF user)
3.
Enter the new password twice and click Change Password.
4.
Reboot the gateway.
For more information on using
, see
.
242 4118127
Rev 2 Nov.15
Admin
Advanced
Features which should be rarely changed and will affect the operation of the device are present on the Advanced screen.
Figure 13-3: ACEmanager: Admin > Advanced
243
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field Description
Date and Time
Queries the internal clock. The date and time are always specified in 24-hour notation
(UTC).
•
mm/dd/yyyy=date in month/day/year notation
•
hh:mm:ss=time in 24-hour notation
Default Configuration
Reset
Enables or disables the hardware reset button
Sets the AirLink gateway to allow (or not allow) the hardware reset button to reset the device to the factory default settings.
•
Allowed—Pressing the hardware reset button for 7–10 seconds reboots the device and resets it to the factory defaults. (When resetting the device to factory default settings, release the reset when all four LEDs turn from red to yellow.)
•
Not Allowed—Pressing the hardware reset button reboots the device, but does not reset it to the factory defaults.
Note: This field only affects the hardware reset button on the device. You can always use the “Reset to Factory Defaults” button in ACEmanager to reset the device.
Note: If this field is set to “Not Allowed” and the login password is subsequently lost, the only way to regain access to the AirLink gateway is through AirLink Management Service
(account required).
Status Update
Address
Enter the device Name/Port. Name is the domain name or IP address, and Port is the port of the device where the device status updates (in XML format) will be sent. This report can be sent to a LAN connected device (e.g., 192.168.13.100/1122) or a remote location
(e.g., newb.eairlink.com/17000).
Status Update Period
(seconds)
The time interval (in seconds) when a status update should be sent
Power Input Voltage
(volts)
Displays the power input voltage in volts. If the input voltage ground is connected to the
AirLink gateway case (without serial connection), this value reads .3 V (approx.) less; if ground is connected (with serial connection), the value reads .3 V (approx.) more.
Displays the board temperature in degrees (Celsius)
Board Temperature
(Celsius)
Radio Module Internal
Temperature
(Celsius)
Displays the temperature of the internal radio module in degrees (Celsius).
Number of System
Resets
Count of the number of system resets over the life of the device or since the last configuration reset
Periodic Reset Timer
(hours)
Resets the device after the specified number of hours.
0 = Disabled
Time of Day (ToD)
Reset: Reset Interval
(days)
Number of days between resets
0 = Disabled
Example: If this field is set to 3, the device resets every third day.
244 4118127
Admin
Field
ToD Reset: Hour of day when Reset occurs
Ping
Description
ToD Reset: Time Zone
Offset from UTC
Time zone adjustment (Offset in easterly direction from UTC Time)
Possible values are -12...12
Example: Pacific Standard Time would be -7
The local hour of the day when the reset occurs
Possible values are 0–23
Example: 4 is 4:00 am
Use this button to confirm that a connected device is responding.
1.
Click Ping.
2.
In the pop-up window, enter the device IP address or DNS name and click Ping Now.
IP Logging
IP Logging is used to troubleshoot issues such as:
•
Problems with the LAN or WAN connection to an AirLink gateway
•
Uncertainty about where a packet is coming from
•
Issues with port forwarding not working properly
IP Logging enables you to log network traffic and save it in a form that can be analyzed by
Sierra Wireless engineers. Before using IP Logging, contact your authorized AirLink reseller or Sierra Wireless representative to discuss the issue you are observing and obtain a .cmd file to capture the appropriate related IP traffic. When you receive the file, save it to your computer’s hard drive.
To use IP logging:
1.
Obtain a command (.cmd) file from Sierra Wireless.
2.
In ACEmanager, go to Admin > Advanced and click IP Logging.
3.
In the pop-up window, click Browse and navigate to the command file you received from Sierra Wireless.
4.
Click Open.
The file name appears in the field beside the Browse... button.
5.
Click Upload File.
Rev 2 Nov.15
245
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
IP Logging
(continued)
Description
6.
Once you see a message at the bottom of the window saying that the file has been successfully uploaded, select a command from the drop-down menu, as advised by your support contact.
246
7.
Click the Start button.
Note: If you are running more than one command, run each command sequentially and save the results before selecting the next command to run. Running a new command or rerunning the same command wipes out the results from the previous run.
When the logging is complete, the log shows the number of packets captured, received, and dropped.
Note: If the log shows only “Got 0”, no logs were captured. Contact Sierra Wireless.
4118127
Admin
Field
IP Logging
(continued)
Description
8.
Once the logging is compete, click the Download IP Logging File button at the bottom of the screen, save the tarred gzip file (file extension .tgz) to your computer, and email it to your support contact.
Rev 2 Nov.15
247
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Extended Archiver
Description
Extended Archiver is a troubleshooting tool that enables you to collect logs covering an extended period of time. Before using it, contact your authorized AirLink reseller or Sierra
Wireless representative to discuss the problem.
To start the process:
1.
Click Extended Archiver.
2.
Select the following options, as advised by Sierra Wireless:
•
The number of times to run the archiver (1–25; default is 16)
•
The interval between runs (30 minutes, 1 hour, 1.5 hours, 2 hours, 2.5 hours, 3 hours, 3.5 hours, 4 hours, 4.5 hours, 5 hours, 5.5 hours, 6 hours, or 6.5 hours; default is 1.5 hours)
3.
Click Start.
The Extended Archiver saves the current set of logs. It waits for the configured interval and then collects another set of logs, which are saved to the same file. This process continues for the number of times the Archiver is configured to run.
At any time, you can click Save Archive. The logs collected to that point are saved and the process continues.
Reset to Factory
Default
4.
Once the process is complete, click Save Archive, save the tarred gzip file (file extension .tgz) to your computer, and email it to your support contact.
Stopping and Restarting the Extended Archiver
After you click the Start button, it changes to Stop. To stop the process:
1.
Click Save Archive if you want to save the logs already collected.
2.
Click Stop. Logs not already saved will be lost. If desired, you can change the settings and restart the process.
Note: The Extended Archiver settings and the collected logs persist over reboots. Once the reboot is complete, the process resumes.
Erases all customer-defined settings, including custom APNs and resets all settings
(passwords, LAN and WAN configuration, security settings, ALEOS Applications
Framework, etc.) to the original factory settings. ALEOS AF is also reset to disabled.
248 4118127
Field
Reset Mode
Admin
Description
Before resetting the AirLink gateway to the factory default settings, you can choose to preserve the configured network connection settings. Options are:
•
Reset All—All settings including network settings are returned to the factory default values on Reset to Factory Default.
•
Preserve Cellular Authentication Settings—(default) When the device is returned to factory default settings (either by clicking the Reset to Factory Defaults button in
ACEmanager, or pressing the hardware reset button as described in the Hardware
User Guide), the following network settings are preserved:
•
Network User ID
•
Network Password
•
Network Authentication Mode
•
LTE Authentication Mode
•
APN Type
•
Select from the List (APN value)
•
User Entered APN
•
Backup APN
•
Backup Network Authentication Mode
•
Backup LTE Authentication Mode
•
Backup Network User ID
•
Backup Network Password
•
SIM Card Pin code
•
Status of the last PIN lock/unlock attempt
•
ALMS Enabled/Disabled status
•
ALMS Name (Device name in ALMS)
•
Device Initiated Interval (ALMS)
•
ALMS Server URL
•
Reset Mode
•
Network Operator Switching configuration and stored radio module firmware
•
ACEmanager remote access setting
Rev 2 Nov.15
249
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Mark
Description
This button is used to mark the start of a section in the device log and is typically used for troubleshooting. If asked to do so:
1.
Click the Mark button and enter the text you want to appear in the log file.
Alphanumeric characters, spaces, periods, commas, dashes, colons and semi-colons are allowed.
Diagnostic shell access
2.
Click Mark Now.
3.
Proceed with the configuration changes.
4.
Generate a log file. (See
When enabled, this field allows Sierra Wireless TechSupport personnel to locally access the diagnostic shell on your gateway. It should be left at the default setting unless Sierra
Wireless TechSupport asks you to change it.
Radio Passthru
Radio Passthru allows a direct connection, using USB, to the internal radio.
Normal cellular radio operation is suspended while Radio Passthru is enabled.
Radio Passthru is generally used only in certain troubleshooting scenarios.
The hardware bypass remains in effect until the gateway is rebooted.
Note: Because Radio Passthru is not USB/net or USB/serial, a different set of drivers are required to connect to the radio installed inside an AirLink gateway. Additionally, while it is possible to send AT commands to the radio using a terminal connection, there are software applications designed to communicate with the radio directly. If you need to use Radio
Passthru, contact your Sierra Wireless AirLink representative to obtain the needed drivers and/or software application.
250 4118127
Rev 2 Nov.15
Admin
Figure 13-4: ACEmanager: Radio Passtrhru
Log
The Log file is a system log of the AirLink gateway.
The Logging configuration screen enables you to configure log verbosity and display filtering. The View Log screen enables you to view and save logs. The logs are in plain text.
To configure what you want to include in the logs:
1.
In ACEmanager, go to Admin > Log.
251
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
252
Figure 13-5: ACEmanager: Admin > Log, Configure Logging
2.
For each subsystem listed:
a.
Select whether or not to display it in the log.
Separate filters, based on subsystem and severity, are applied when the messages are generated and when the messages are displayed. Six severity levels are supported for filtering in the drop-down lists for verbosity:
· Critical
· Error
· Warning
· Notice
· Info (information)
· Debug
Note: The VPN Sub System only allows for Info and Debug. For maximum information, set the VPN verbosity to Debug.
b. Select the verbosity level.
Note: Some log messages are only displayed if you display Linux Syslog. For example, If you are debugging a VPN or LAN setup, the relevant information is only displayed in the
Linux Syslog.
3.
Optional: To display Linux Syslog:
4118127
Admin
a.
Ensure that Display (default value) is selected the drop-down menu beside Linux Syslog.
4.
Click Apply.
5.
If you have changed any of the verbosity levels or the Linux syslog setting:
a.
Reboot the AirLink gateway.
b. Log into ACEmanager, go to Admin > Log.
6.
Select View Logs from the menu on the left side of the page.
Rev 2 Nov.15
Figure 13-6: ACEmanager: Admin > Log, View Log
Note: VPN info and debug information uses the term racoon (rather than VPN).
Note: If you toggle the “Display in Log?” field, clear and refresh the View Log page. (You do not need to reboot the device.)
Tip:
Use View Log for troubleshooting purposes (e.g., when setting up the IPsec configuration). The Log page allows you to establish the tunnel connection and monitor the results directly. To change the intervals at which the log is displayed, you can change the settings in Auto Refresh.
253
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Actions on the View Log screen include:
•
Auto Refresh — The drop-down menu allows you to set up an automatic log page refresh, and the interval between refreshes: 30 secs, 1 minute, or
2 minutes.
•
Refresh button — Initiates a manual page refresh
•
Clear button — Clears out the tunnels
•
Save button — Creates a text file of the log
Radio Module Firmware
254
Figure 13-7: ACEmanager: Admin > Radio Module Firmware
AirLink gateways come preloaded with two versions of radio module firmware.
When the gateway is powered on, the gateway checks the stored radio module firmware versions and automatically loads the appropriate version for the installed
SIM card onto the radio module.
This feature, which is intended for North American products, makes it easy to provision the gateway for a particular mobile network. To provision the gateway:
1.
Obtain an account and SIM card for the mobile network you want to run the gateway on.
2.
Insert the SIM card into the SIM card slot. (For instructions on installing the
SIM card, refer to the Hardware User Guide for your gateway.)
3.
Power on the gateway. It chooses the appropriate radio module firmware to use for the installed SIM card, provided it is stored on the gateway.
If the appropriate firmware is not stored on the gateway, you can download it from source.sierrawireless.com
and install it on the gateway. You can also:
•
Check which version of radio module firmware is currently active
•
Remove radio module firmware from the gateway
•
Update the radio module firmware stored on the gateway
•
Override the automatic function and manually select the radio module firmware to be used
4118127
Admin
Note: If you select Preserve Cellular Authentication Settings in the Reset Mode field
before rebooting the gateway, the configuration and the stored radio module firmware are preserved when you reset the gateway to the factory default settings.
Note: You can store a maximum of two radio module firmware versions on the gateway, so you may need to delete an unused version before installing the version you want to add.
To manage radio module firmware:
1.
In ACEmanager, go to Admin > Radio Module Firmware.
Figure 13-8: ACEmanager: Admin > Radio Module Firmware
2.
Use the information in the following table to install, update, or remove radio module firmware.
Field
Active?
Description
Indicates whether or not the radio module firmware is currently in use
Network Operator
Indicates the Mobile Network Operator associated with the radio module firmware
Version
Indicates the version number of the radio module firmware
Up to date?
Indicates if the firmware in use matches the ALEOS-referenced radio module firmware
Rev 2 Nov.15
255
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Field
Actions
Description
Action buttons beside each radio module firmware listed, enable you to:
•
Update—Click to update the radio module firmware for that RMID. Updating the active radio module firmware updates the version in storage and also updates the firmware on the radio module itself.
•
Remove—Click to remove that radio module firmware from the gateway storage
Note: The firmware cannot be removed if it is the active firmware.
•
Activate—Click to select a radio module firmware to be the active firmware for the gateway.
This option is only available if
Network Operator Switching is set to Disable. See Manually
Selecting the Radio Module Firmware .
You can also:
•
Install—Click to add an additional radio module firmware image to the gateway storage.
When the maximum number of radio module firmware versions are stored on the gateway, the Install button is not available. To free up space to add another version, first remove one of the firmware versions on the gateway.
Network Operator
Switching
Enable or disable Network Operator Switching
•
Enable—When the gateway powers on or reboots, it automatically selects and uses the appropriate radio module firmware for the installed SIM card, if it is stored on the gateway.
(default)
•
Disable—The gateway does not automatically select the appropriate radio module firmware when it is powered on or rebooted. You can manually select the firmware to use.
See Manually Selecting the Radio Module Firmware .
ALMS Radio
Module Firmware
Update
Enables you to choose which radio module firmware ALMS will update when you update
ALEOS:
•
Update Current Only—Only the radio module firmware in use is updated, if required
(default)
•
Update All—All the radio module firmware stored on the gateway is updated, if required
Manually Selecting the Radio Module Firmware
To manually select the radio module firmware to use:
1.
In ACEmanager, go to Admin > Radio Module Firmware.
256
Figure 13-9: ACEmanager: Admin > Radio Module Firmware
4118127
Admin
2.
In the SIM Based Radio Module Image switching field (under Options), select
Disable.
3.
Under Firmware, click Activate beside the firmware you want the gateway to use.
4.
Click Apply.
5.
Click reboot or press and release the reset button on the gateway.
Rev 2 Nov.15
257
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
258 4118127
A: Windows Dial-up Networking (DUN)
Dial-up Networking (DUN) enables you to use Point-to-Point Protocol
(PPP) to establish a connection between a host PC serial port and the AirLink gateway.
A
Internet
PPP connection
Serial cable
Host PC
Figure A-1: PPP connection
AirLink gateway
WAN connection
Caution:
To install any driver on your computer, you may need to be logged in as Administrator or have Administrator privileges for your login.
Microsoft Windows 7 is used in the examples below. The device driver installation and DUN setup and configuration is similar in other
Microsoft Windows operating systems, including Windows XP and
Windows CE.
Note: If your device is new, or has recently been reset to factory default settings, ensure that the device has been on air at least once before being used with a DUN connection.
Installing a Device Driver
Connect the AirLink gateway
1.
Connect the device to the computer with a DB-9 cable from one
RS-232 port to the other.
2.
Log in to ACEmanager.
3.
Go to Serial > Port Configuration.
4.
Set the DB9 Serial Echo field to Disable.
5.
Reboot.
Note: You need to set the DB9 Serial Echo field echo to Disable any time you want to set up a PPP connection.
Rev 2 Nov.15
259
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Install the driver
1.
Select Start > Control Panel > Phone and Modem Options.
Figure A-2: Phone and Modem Options
2.
Select the Modems tab.
260
Figure A-3: Phone and Modem Options: devices
4118127
Rev 2 Nov.15
3.
Click Add.
Windows Dial-up Networking (DUN)
Figure A-4: Add Hardware Wizard
4.
Select Don’t detect my modem; I will select it from a list.
5.
Click Next.
261
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
262
Figure A-5: Add Hardware Wizard: Install New Modem
6.
Under Manufacturer, select (Standard Modem Types).
7.
Under Models, select Standard 33600 bps Modem.
Tip:
If you have the speed for your device configured as something other than the default, use the Standard device that matches the speed you configured.
8.
Click Next.
4118127
Rev 2 Nov.15
Windows Dial-up Networking (DUN)
Figure A-6: Add Hardware Wizard: Select Ports
9.
Select Selected Ports.
10. Select the COM port the device is connected to (commonly COM1).
11. Click Next.
263
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure A-7: Add Hardware Wizard: Finish
12. Once the device driver is installed, click Finish.
When you return to the Phone and Modem Options page, you should see the newly installed device “attached to” the correct COM port.
264
Figure A-8: Phone and Modem Options > Modems
13. Highlight the modem, and click Properties. The following window appears:
4118127
Windows Dial-up Networking (DUN)
Figure A-9: Modem Properties
14. Select the Modem tab.
Rev 2 Nov.15
Figure A-10: Modem Properties > Modem
15. Confirm that the Maximum Port Speed is set to 115200 (default).
265
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
16. Click OK to exit.
17. Click OK again to exit out of the Phone and Modem Options.
18. Go to Start > Control Panel > Device Manager.
266
Figure A-11: Device Manager
19. Under Modems, highlight Standard 33600 bps Modem. Right-click and select
Update Driver Software....
4118127
Windows Dial-up Networking (DUN)
Figure A-12: Update Driver Software—Browse
20. Select Browse my computer for driver software.
Rev 2 Nov.15
Figure A-13: Update Driver Software—Let me pick...
267
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
21. Select Let me pick from a list of device drivers on my computer.
Figure A-14: Update Driver Software—Select Standard Modem
22. Deselect Show compatible hardware.
23. Under Manufacturer, select (Standard Modem Types).
24. Under Models, select Standard Modem.
25. Click Next.
If you see an Update Driver Warning, click Yes.
268
Figure A-15: Update Driver Software—Warning
The software driver updates and the following window appears:
4118127
Windows Dial-up Networking (DUN)
Rev 2 Nov.15
Figure A-16: Update Driver Software—Success
26. Click Close.
Creating a Dial-Up Networking (PPP)
Connection
Once you have the driver for the modem installed on your computer, you can set up and configure Dial Up Networking (DUN).
Note: No other device or program can use the COM port (serial port) configured for the modem driver while the DUN session is active.
Caution:
If you have an existing LAN connection, installing DUN for the AirLink gateway may interfere with the LAN connection. We recommend disconnecting your LAN connection before using a PPP connection with your AirLink gateway.
Once you have configured the DUN connection on your computer:
•
The DUN connection may be set as the default connection.
•
The computer may be configured to dial the DUN connection when it cannot detect any network connection.
For instructions on changing these options, see Connection settings on page 277.
269
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
If you are using a DUN connection with any other network connection (such as
Ethernet), you may need to use the route command in Windows to set up a static route through the device to access the location remotely over the PPP link and the mobile network. This guide does not provide information on the route command. Consult your network administrator for information on properly configuring routing.
Create a new network connection.
1.
Select Start > Control Panel > Network and Sharing Center.
270
Figure A-17: Network and Sharing Center Window
2.
Select Set up a new connection or network.
4118127
Windows Dial-up Networking (DUN)
Figure A-18: Set up a Connection or Network
3.
Select Set up a dial-up connection.
4.
Click Next.
If you are asked which modem you want to use, select Standard Modem.
Rev 2 Nov.15
Figure 1-19: Create a Dial up Connection
271
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
5.
In the Dial-up phone number field, type “#777”.
6.
Ignore the User name and Password fields.
7.
In the Connection name field, type “ALEOS Dial-up Connection” or other desired name.
8.
Click Connect.
Alternatively, to connect to the ALEOS Dial-up network:
a.
Click the network connection icon
1
in the system tray.
b. Select ALEOS Dial-up Connection.
c.
Click Connect.
Configure the DUN connection
After you complete the New Connection Wizard:
1.
Click the network connection icon, select ALEOS Dial-up Connection, and click Connect.
272
Figure A-20: DUN Connection
2.
If you have a user name and password configured in ACEmanager for PPP connections, enter them in the User name and Password fields. Otherwise, leave these fields blank.
3.
Click Properties.
1. The appearance of the connection icon varies depending on the type of connections available. For example, It may appear as
4118127
Windows Dial-up Networking (DUN)
Figure A-21: DUN Properties
4.
Confirm that the check box beside Use dialing rules is not selected.
5.
Click Configure... (below the Connect using box).
Rev 2 Nov.15
Figure A-22: Modem Configuration
6.
Confirm that the Maximum speed (bps) is set to 115200.
7.
Confirm that Enable hardware flow control is selected. Do not select any other options.
8.
Click OK.
273
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
9.
In the main properties window, select the Options tab.
274
Figure A-23: Networking
10. Click PPP Settings.
Figure A-24: PPP Settings
11. Clear the check boxes beside all three PPP settings.
12. Click OK.
13. Select the Networking tab.
4118127
Windows Dial-up Networking (DUN)
Rev 2 Nov.15
Figure A-25: DUN Connection > Networking tab
14. Select Internet Protocol Version 4 (TCP/IPv4) and then select Properties.
Tip:
For most configurations, getting the IP address and the DNS server address are automatic.
275
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Figure A-26: TCP/IP Properties
15. Click Advanced.
276
Figure A-27: Advanced TCP/IP
4118127
Windows Dial-up Networking (DUN)
16. Select Use default gateway on remote network.
17. Click OK.
Tip:
You may want to check the Options tab and change the settings for applications you use. The default options are generally applicable for most uses.
Caution:
Unless specifically directed to do so by Support or your network administrator, you do not need to make any changes to the options on the Security tab.
18. Click OK until you return to the Connect window.
19. Log in to ACEmanager and go to Serial > Port Configuration.
Rev 2 Nov.15
Figure 1-28: ACEmanager: Serial > Port Configuration
20. Under Port Configuration:
a.
Set the Flow Control field to Hardware.
b. Set the DB9 Serial Echo field to Disable.
21. Click Apply and reboot the device.
Connection settings
1.
To set the default connection:
2.
Go to Start > Control Panel > Network and Sharing Center.
277
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
3.
Select Change adapter settings.
4.
Right-click the icon for the DUN connection.
If you want this to be your default connection, select Set as Default Connection.
If it is already the default connection and you do not want it as your default connection, select Cancel as Default Connection.
If you do not want the DUN connection to be dialed when there is no other connection:
1.
Go to Start > Control Panel > Internet Options.
2.
Select the Connections tab.
3.
Highlight the DUN connection and select Never dial a connection.
4.
Click Apply.
5.
Click OK.
278 4118127
B: SNMP: Simple Network Management
Protocol
Management Information Base
(MIB)
ALEOS includes a Management Information Base (MIB) that contains information specific to the AirLink gateway. Reports based on this database are sent in a form designed to be parsed by the
NMS. The data is hierarchical with entries addressed through object identifiers.
The MIB complies with:
•
RFC 1213 and MIB-II
•
RFC 2665 — Ethernet-Like Interface Types
•
RFC 2863 — The Interfaces Group MIB
B
SNMP Traps
SNMP traps are alerts that can be sent from the managed device to the Network Management System when an event happens. Your
AirLink gateway is capable of sending traps when the network connection becomes available.
To send SNMP traps:
1.
In ACEmanager, go to Services > Management (SNMP).
2.
Configure the fields under Trap Server User. (For more information, see
Management (SNMP) on page 184.)
3.
Go to Events Reporting > Actions.
4.
In the Action Type field select SNMP trap. (For more information,
5.
Go Events Reporting > Events and configure monitoring for the event type that will trigger the SNMP trap. For example, the event type could be RSSI, thresholds, network state, hardware temperature, etc.
Sierra Wireless MIB
This section show the contents of the Sierra Wireless MIB file. When this file is loaded onto a remote SNMP client, you can query the
Sierra Wireless specific objects listed in this file.
For a text copy of this MIB file, go to source.sierrawireless.com
, and select your AirLink gateway.
Rev 2 Nov.15
279
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Note: Some MIB elements such as GPS do not apply to the ES450 gateways.
SIERRA-MIB DEFINITIONS ::= BEGIN
IMPORTS
OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY, IpAddress,
Integer32, Opaque, enterprises, Counter32, Unsigned32
FROM SNMPv2-SMI
TEXTUAL-CONVENTION, DisplayString, TruthValue
FROM SNMPv2-TC; sierrawireless MODULE-IDENTITY
LAST-UPDATED "201202290000Z"
ORGANIZATION "Sierra Wireless Inc"
CONTACT-INFO
"Sierra Wirelss Inc
"
DESCRIPTION
""
REVISION "201202290000Z"
DESCRIPTION
"This file defines the private Sierra MIB extensions."
::= { enterprises 20542 } sharks OBJECT IDENTIFIER ::= { sierrawireless 9}
-- MIB versions mibversion1 OBJECT IDENTIFIER ::= { sharks 1}
-- GUI Tabs for Sharks statustab OBJECT IDENTIFIER ::= { mibversion1 1} cellulartab OBJECT IDENTIFIER ::= { mibversion1 2} lantab OBJECT IDENTIFIER ::= { mibversion1 3} vpntab OBJECT IDENTIFIER ::= { mibversion1 4} securitytab OBJECT IDENTIFIER ::= { mibversion1 5} servicestab OBJECT IDENTIFIER ::= { mibversion1 6} gpstab OBJECT IDENTIFIER ::= { mibversion1 7} eventsreportingtab OBJECT IDENTIFIER ::= { mibversion1 8} serialtab OBJECT IDENTIFIER ::= { mibversion1 9} iotab OBJECT IDENTIFIER ::= { mibversion1 10} admintab OBJECT IDENTIFIER ::= { mibversion1 11} snmpconfig OBJECT IDENTIFIER ::= { mibversion1 12}
-- status elements
280 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
home OBJECT IDENTIFIER ::= { statustab 1} cellular OBJECT IDENTIFIER ::= { statustab 2} lan OBJECT IDENTIFIER ::= { statustab 3} vpn OBJECT IDENTIFIER ::= { statustab 4} security OBJECT IDENTIFIER ::= { statustab 5} services OBJECT IDENTIFIER ::= { statustab 6} gps OBJECT IDENTIFIER ::= { statustab 7} serial OBJECT IDENTIFIER ::= { statustab 8} about OBJECT IDENTIFIER ::= { statustab 9}
-- home status elements phoneNumber OBJECT-TYPE
SYNTAX DisplayString (SIZE (10))
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 17 } ipAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 301 } networkState OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 259 } rssi OBJECT-TYPE
SYNTAX INTEGER(-125..-50)
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 261 } gprsnetworkOperator OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 770 } cdmanetworkOperator OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
281
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
DESCRIPTION ""
::= { home 644 } gprsECIO OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 772 } cdmaECIO OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 643 } powerIn OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 266 } boardTemprature OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 267 } networkServiceType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 264} aleosSWVer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 4 } netChannel OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 260 }
282 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
cellularBytesSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 283 } cellularBytesRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 284 } deviceName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { home 1154 }
-- cellular status elements wanIP OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 301 } electronicID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 10 } iccid OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 771 } cellid OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 773 }
283
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
lac OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 774 } imsi OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 785 } keepAliveIpAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 1105 } keepAlivePingTime OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 1104 } dnsServer1 OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 1082 } dnsServer2 OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 1083 } cellBand OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 2056 } apn OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
284 4118127
Rev 2 Nov.15
STATUS current
DESCRIPTION ""
::= { cellular 2151 } wanUseTime OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 5046 } rscp OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 10249 } errorRate OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 263 } bytesSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 283 } bytesRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 284 } packetsSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 281 } packetsRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 282 }
SNMP: Simple Network Management Protocol
285
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
prlVersion OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 642 } prlUpdateStatus OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 646 } sid OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 648 } nid OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 649 } pnOffset OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 650 } baseClass OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { cellular 651 }
-- LAN status elements usbMode OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 1130 }
286 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
vrrpEnabled OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 9001 } lanpacketsSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 279 } lanpacketsRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 280 } wifipacketsSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 10405 } wifipacketsRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 10406 } wifiBridgeEnabled OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 10401 } wifiSecurityType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 4509 } wifiAPStatus OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
287
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
STATUS current
DESCRIPTION ""
::= { lan 4506 } wifiSSID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 4507 } wifiChannel OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { lan 4508 }
-- VPN status elements incomingOOB OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3177 } outgoingOOB OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3178 } outgoingHostOOB OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3179 } vpn1Status OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3176 } vpn2Status OBJECT-TYPE
SYNTAX DisplayString
288 4118127
Rev 2 Nov.15
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3205 } vpn3Status OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3231 } vpn4Status OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3257 } vpn5Status OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { vpn 3283 }
-- Security status elements dmz OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 5113 } portForwarding OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 5112 } portFilteringIn OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 3505 } portFilteringOut OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
SNMP: Simple Network Management Protocol
289
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
STATUS current
DESCRIPTION ""
::= { security 3506 } trustedHosts OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 1062 } macFiltering OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 3509 } badPasswdCount OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 385 } ipRejectCount OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 386 } ipRejectLog OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { security 387 }
-- Services status elements aceNet OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { services 5026 } aceManager OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
290 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
DESCRIPTION ""
::= { services 1149 } dynamicDnsService OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { services 5011 } fullDomainName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { services 5007 }
-- GPS status elements gpsFix OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 900 } satelliteCount OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 901 } latitude OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 902 } longitude OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 903 } heading OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
291
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
::= { gps 904 } speed OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 905 } engineHours OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { gps 906 }
-- Serial status elements serialPortMode OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { serial 1043 } tcpAnswer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { serial 1048 } udpAnswer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { serial 1054 } serialPacketsSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { serial 273 } serialPacketsRecvd OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { serial 274 }
292 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
-- About status elements deviceModel OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 7 } radioModelType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 9 } radioFirmwareVersion OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 8 } deviceID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 25 } macAddress OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 66 } aleosSWVersion OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 4 } deviceHwConfiguration OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 5 }
293
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
msciVersion OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION ""
::= { about 3 }
-- Read Write values snmpenable OBJECT-TYPE
SYNTAX INTEGER {
disabled(0),
enabled(1)}
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10040 } snmpversion OBJECT-TYPE
SYNTAX INTEGER {
snmpv2c(2),
snmpv3(3)}
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10041 } snmpport OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10042 } snmpContact OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 2730 } snmpName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 2731 } snmpLocation OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
294 4118127
Rev 2 Nov.15
STATUS current
DESCRIPTION ""
::= { snmpconfig 2732 } rocommunity OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10063 } rouser OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10045 } rosecuritylvl OBJECT-TYPE
SYNTAX INTEGER {
noauthnopriv(0),
authnopriv(1),
authpriv(2)}
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10046 } roauthtype OBJECT-TYPE
SYNTAX INTEGER {
md5(0),
sha(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10047 } roauthkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10048 } roprivtype OBJECT-TYPE
SYNTAX INTEGER {
aes(0),
des(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10049 }
SNMP: Simple Network Management Protocol
295
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
roprivkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10050 } rwcommunity OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10064 } rwuser OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10051 } rwsecuritylvl OBJECT-TYPE
SYNTAX INTEGER {
noauthnopriv(0),
authnopriv(1),
authpriv(2)}
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10052 } rwauthtype OBJECT-TYPE
SYNTAX INTEGER {
md5(0),
sha(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10053 } rwauthkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10054 } rwprivtype OBJECT-TYPE
SYNTAX INTEGER {
296 4118127
Rev 2 Nov.15
aes(0),
des(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10055 } rwprivkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10056 } trapipAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 1166 } trapport OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10043 } engineid OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10044 } trapcommunity OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10065 } trapuser OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10057 } trapsecuritylvl OBJECT-TYPE
SYNTAX INTEGER {
SNMP: Simple Network Management Protocol
297
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
noauthnopriv(0),
authnopriv(1),
authpriv(2)}
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10058 } trapauthtype OBJECT-TYPE
SYNTAX INTEGER {
md5(0),
sha(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10059 } trapauthkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10060 } trapprivtype OBJECT-TYPE
SYNTAX INTEGER {
aes(0),
des(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10061 } trapprivkey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 10062 } rebootmodem OBJECT-TYPE
SYNTAX INTEGER {
nop(0),
reboot(1) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION ""
::= { snmpconfig 65001 }
298 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
-- Notifications starting at 1000 modemNotifications OBJECT IDENTIFIER ::= { mibversion1 1000 } value OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"value of MSCIID that triggered this event"
::= { modemNotifications 500 } digitalInput1 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Digital Input 1 MSCIID 851"
::= { modemNotifications 1 } digitalInput2 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Digital Input 1 MSCIID 852"
::= { modemNotifications 2 } digitalInput3 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Digital Input 1 MSCIID 853"
::= { modemNotifications 3 } digitalInput4 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Digital Input 1 MSCIID 854"
::= { modemNotifications 4 } pulseAccumulator1 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Pulse Accumulator 1 MSCIID 4002"
::= { modemNotifications 5 } pulseAccumulator2 NOTIFICATION-TYPE
299
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
OBJECTS { value }
STATUS current
DESCRIPTION
"Pulse Accumulator 2 MSCIID 4003"
::= { modemNotifications 6 } pulseAccumulator3 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Pulse Accumulator 3 MSCIID 4004"
::= { modemNotifications 7 } pulseAccumulator4 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Pulse Accumulator 1 MSCIID 4005"
::= { modemNotifications 8 } analogInput1 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Analog Input 1 MSCIID 855"
::= { modemNotifications 9 } analogInput2 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Analog Input 2 MSCIID 856"
::= { modemNotifications 10 } analogInput3 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Analog Input 3 MSCIID 857"
::= { modemNotifications 11 } analogInput4 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Analog Input 4 MSCIID 858"
::= { modemNotifications 12 } scaledAnalogInput1 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
300 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
DESCRIPTION
"Scaled Analog Input 1 MSCIID 4041"
::= { modemNotifications 13 } scaledAnalogInput2 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Scaled Analog Input 2 MSCIID 4042"
::= { modemNotifications 14 } scaledAnalogInput3 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Scaled Analog Input 3 MSCIID 4043"
::= { modemNotifications 15 } scaledAnalogInput4 NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Scaled Analog Input 4 MSCIID 4044"
::= { modemNotifications 16 } gpsFixNotification NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"GPS Fix MSCIID 900"
::= { modemNotifications 17 } vehicleSpeed NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Vehicle Speed MSCIID 905"
::= { modemNotifications 18 } engineHoursNotification NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Engine Hours MSCIID 906"
::= { modemNotifications 19 } headingChange NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Heading Change MSCIID 904"
301
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
::= { modemNotifications 20 } rssiNotification NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"RSSI MSCIID 261"
::= { modemNotifications 21 } networkStateNotification NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Network State MSCIID 259"
::= { modemNotifications 22 } networkService NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Network Service 264"
::= { modemNotifications 23 } networkErrorRate NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Network Error Rate MSCIID 263"
::= { modemNotifications 24 } periodicReports NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Periodic Reports MSCIID 270"
::= { modemNotifications 25 } powerInNotification NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Power In MSCIID 266"
::= { modemNotifications 26 } boardTemp NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Board Temperature MSCIID 267"
::= { modemNotifications 27 } cdmaTemp NOTIFICATION-TYPE
302 4118127
Rev 2 Nov.15
SNMP: Simple Network Management Protocol
OBJECTS { value }
STATUS current
DESCRIPTION
"CDMA Temperature MSCIID 641"
::= { modemNotifications 28 } dailyDataUsage NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Daily Data Usage MSCIID 25001"
::= { modemNotifications 29 } monthlyDataUsage NOTIFICATION-TYPE
OBJECTS { value }
STATUS current
DESCRIPTION
"Monthly Data Usage MSCIID 25002"
::= { modemNotifications 30 }
END
303
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
304 4118127
C: AT Commands
AT Command Set Summary
Note: If you are writing software to parse AT command responses, Sierra
Wireless recommends that you design the software to be independent of the amount of whitespace. Whitespace is defined as ASCII space, tab, carriage return and linefeed characters and may appear in any combination, not necessarily containing all of the above.
Using a terminal connection (Telnet) or SSH protocol, you can send
AT commands to configure the device, command it to do something, or query a setting.
•
AT commands must always be terminated by a carriage return
<CR> (ASCII character 0x0D), i.e., pressing enter on the keyboard. Some may also include a new line or line feed <LF>.
•
If E=1 (Echo On), the AT command (including the terminating
<carriage return>) is displayed (output) before any responses.
•
Two settings affect the format of AT command output: V
(Verbose) and Q (Quiet).
•
If Q=1 (Quiet On), no result codes are output whatsoever, so there is no response generated by a (non-query) command.
•
If Q=0 (Quiet Off), result codes are output. The format of this output is then affected by the Verbose setting.
If Quiet mode is off, the result code is affected as follows:
For V=1 (Verbose mode), the textual result code is surrounded by a carriage return and new line. Any AT query response is also surrounded by a carriage return and new line.
For V=0 (Terse mode), a numeric result code is output with a single trailing carriage return (no new line is output), while any AT query response is followed by a carriage return and new line (there is no preceding output).
•
For example, possible output to the AT command “AT” with carriage return (assuming quiet mode is not on) is: carriage return — if V=0 carriage return and new line OK another carriage return and new line — if V=1
Note: AT commands work for the port on which they are executed. For example, if the user types ATE1 and then AT&W using a USB/serial port connection, it sets the USB/serial port to Echo On but not the telnet connection or the RS232 serial port.
C
Rev 2 Nov.15
305
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
If you need to change the port for Telnet (for example, you have the default port blocked on your firewall), the option is on the Services > Telnet/SSH tab. The default Telnet port is 2332. You can also change the Telnet timeout; if the connection is idle, default timeout is 2 minutes. This is the internal Telnet on the device to pass AT commands and not TCP PAD.
AT commands are shown in upper case, but they are not case sensitive.
This appendix organizes the commands into functional groups to allow you to more quickly locate a desired command when you know the operation but not the command. Commands under each topic are listed alphabetically.
Note: Some of the configuration commands listed here are only available as AT commands.
Reference Tables
Result codes are not shown in the command tables unless special conditions apply. Generally the result code
OK is returned when the command has been executed.
ERROR may be returned if parameters are out of range, and is returned if the command is not recognized or is not permitted in the current state or condition of the AirLink gateway.
Note: Unless otherwise stated, all commands are accessible locally and remotely.
AT command topics in this appendix:
•
Standard (Hayes) commands on page 344
•
•
•
•
•
•
•
•
•
•
•
306 4118127
AT Commands
Device Updates
Table C-1: Device Update AT Commands
Command Description
*TPLUPDATE
This AT command updates the template (configuration file) remotely.
The template file must be accessible on an FTP server.
The command parameters are:
AT*TPLUPDATE=<Server_IP>,<USER_NAME>,<PASSWORD>,<FILE_NAME> where:
•
SERVER_IP is the IP address of the FTP server.
•
USER_NAME is the user name used to access the FTP server.
•
PASSWORD is the password used to access the FTP server.
•
FILE_NAME is the name of the template file on the FTP server that you want to apply to the AirLink gateway. The template file must be stored on the FTP User_Name home, not in a sub-folder.
Example:
AT*TPLUPDATE=192.168.17.111,MyUserName,MyPassword,NewTemplate.xml
When the template is successfully applied, the message displayed is:
Template applied successfully
OK
Note: Configure the FTP server:
•
As passive mode (not active mode)
•
To listen to port 21
Status
Table C-2: Status AT Commands
Command Description
*BAND?
*CELLINFO?
*CELLINFO2?
+CIMI?
Query the current radio module band.
To set or query the setting for RF band range or technology, see !BAND
Query cellular connection information.
Query in depth cell information.
HSPA and LTE only.
Query the IMSI.
Rev 2 Nov.15
307
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-2: Status AT Commands (Continued)
Command Description
*DEVICEID?
When the device is configured to use the device ID with GPS reports, this command displays the 64-bit device ID created from the ESN/IMEI or phone, preceded by the hex delimiter (0x). For example: at*deviceid?
0x010112DE140B5A32
Note: If the device is not configured to use the device ID with GPS reports, the command returns “NOT SET”.
*DNS1?
*DNS2?
+ECIO?
*ETHMAC?
*ETHSTATE?
*GLOBALID?
*HOSTCOMMLVL?
+HWTEMP?
I[n]
+ICCID?
*LTERSRQ?
*LTERSRP?
*NETCHAN?
Query the primary DNS (*DNS1) and secondary (*DNS2) IP addresses.
AT*DNS1? to query DNS1
AT*DNS2? to query DNS2
Query the signal quality.
Query the MAC address of the Ethernet port
•
AT*ETHMAC? or AT*ETHMAC?1— Returns the MAC address of the main
Ethernet port
•
Query the connection state (speed and duplex) of the Ethernet port.
•
AT*ETHSTATE? or AT*ETHSTATE?1— Returns the speed and duplex state of the main Ethernet port (e.g. 100Mb/s Full Duplex)
•
Query the global ID used by ALMS to identify the device.
Query the serial host signal level.
Response example: DCD:LOW; DTR:LOW; DSR:HIGH; CTS:HIGH; RTS:LOW
Query the internal temperature of the radio module (in degrees Celsius).
Query device information.
•
n omitted—device model
•
n=0—device model
•
n=1—ALEOS software version, hardware revision, boot version
•
n=2—Radio module firmware version
•
n=3—Radio module’s unique ID (ESN, IMIEI, or EID)
HSPA and LTE only.
Query the SIM ID.
LTE only
Query the LTE signal quality (in dB).
For more information, see LTE Signal Quality (RSRQ) on page 46.
LTE only
Query the LTE signal strength (in dBm).
For more information, see LTE Signal Quality (RSRQ) on page 46.
Query the current mobile network channel.
308 4118127
AT Commands
Table C-2: Status AT Commands (Continued)
Command Description
NETIP?
Query the current WAN IP address of the device reported by the internal module
(generally obtained from your Mobile Network Operator).
If you have an Internet-routable IP address, you can use this address to contact devices from the Internet. If your device on a private mobile network, you can use this address to contact the device from another host on the same WAN network.
If required, use AT* *NETALLOWZEROIP to allow displaying an IP address ending in a
zero.
Note: If there is no current network IP address, 0.0.0.0 is returned.
*NETOP?
*NETPHONE?
*NETRSSI?
*NETSERV?
*NETSERVICE_RAW?
Query the Mobile Network Operator of the active connection. If you are roaming, the roaming operator is returned, if the home operator allows this.
Query the device's cellular phone number, if applicable or obtainable.
Query the current RSSI (Receive Signal Strength Indicator) for non-LTE cellular connections, as a negative dBm value.
Query the current connection type (e.g., LTE, HSPA+, EV-DO Rev A, etc.).
Query the numeric value for the network service type.
•
8—2G (1x, EDGE, GPRS)
•
10—2G roaming
•
16—3G (EV-DO Rev. A, HSPA, HSPA+, UMTS)
•
18—3G roaming
•
64—4G
Rev 2 Nov.15
309
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-2: Status AT Commands (Continued)
Command Description
*NETSTATE?
Query the network state of the current WAN connection.
AT*NETSTATE? returns:
•
Connecting To Network—The device is in the process of trying to connect to the mobile network.
•
Network Authentication Fail—Authentication to the mobile network has failed.
Verify settings to activate the device.
•
Data Connection Failed—The device failed to connect, and it is now waiting a set time interval before it attempts to reconnect. Verify settings to activate the device.
•
Network Negotiation Fail—Network connection negotiation failed. This is usually temporary and often clears up during a subsequent attempt.
•
Network Ready—The device is connected to the 1x mobile network and ready to send data.
•
Network Dormant—The device is connected to the 1x mobile network, but the link is dormant. It will be woken up when data is sent or received.
•
No Service—There is no mobile network detected.
•
Hardware Reset—The internal module is being reset. This is a temporary state.
•
No SIM or Unexpected SIM status—No SIM, SIM installed incorrectly, or another
SIM error.
•
Awaiting Provisioning—An EV-DO device without an account and hasn't had an account or the provisioning has been erased from the radio.
•
Provisioning... —An EV-DO device in the process of writing the account data to the radio.
•
Not Connected-Waiting for Activity — “Always On Connection” has been disabled and the device is waiting for outgoing traffic or an SMS Wakeup command to mount the PDP context. (This status applies only to International devices.)
•
Not Connected-Radio Connect off—The RADIO_CONNECT AT command was entered, and the PDP context is manually disabled. (This status applies only to
International devices.)
•
SIM Locked, but bad SIM PIN.
•
SIM PIN incorrect 3 attempts left.
•
SIM PIN incorrect 2 attempts left.
•
SIM PIN incorrect 1 attempts left.
•
SIM PIN incorrect 0 attempts left.
•
SIM Blocked, Bad unlock code.
•
SIM Blocked, unblock code incorrect.
310 4118127
AT Commands
Table C-2: Status AT Commands (Continued)
Command Description
*NETSTATE_RAW?
+PRL?
*PRLSTATUS?
*USBNETSTATE?
*WANUPTIME?
Query numeric value of the network state of the current WAN connection:
•
1—Connecting To Network—The device is in the process of trying to connect to the mobile network.
•
4—Network Access Denied—Connection rejected.
•
5—Network Ready—WAN is using cellular and is online.
•
7—No Service—The WAN link is down or unavailable
•
9—No SIM or Unexpected SIM status—No SIM, SIM installed incorrectly, or another SIM error.
•
11—Awaiting Provisioning—An EV-DO device without an account and hasn't had an account or the provisioning has been erased from the radio.
•
12—Data Connection Failed - Waiting to Retry—The device failed to connect, and it is waiting a set time interval before it attempts to reconnect.
Or
•
12—Provisioning... —An EV-DO device in the process of writing the account data to the radio.
•
13—SIM Locked, but bad SIM PIN.
•
14—SIM PIN incorrect 3 attempts left.
•
15—SIM PIN incorrect 2 attempts left.
•
16—SIM PIN incorrect 1 attempts left.
•
17—SIM PIN incorrect 0 attempts left.
•
18—SIM Blocked, Bad unlock code.
•
19—SIM Blocked, unblock code incorrect.
•
30—Not Connected-Waiting for Activity — “Always On Connection” has been disabled and the device is waiting for outgoing traffic or an SMS Wakeup command to mount the PDP context. (This status applies only to International devices.)
•
31—Not Connected-Radio Connect off—The RADIO_CONNECT AT command was entered, and the PDP context is manually disabled. (This status applies only to International devices.)
CDMA and LTE fallback to EV-DO only
Query CDMA Preferred Roaming List (PRL) version.
CDMA only
Query the status of the most recent PRL update.
•
n=0—None (No update)
•
n=1—In progress
•
n=2—Update successful
The return of any other value indicates that the update failed.
Query the status of the USB connection.
AT*USBNETSTATE? returns:
•
None—There are no USB connections to the AirLink gateway.
•
8 MB/s Half Duplex—There is a USB connection to the device.
Query the time in minutes from which the cellular IP is obtained from the mobile network.
AT*WANUPTIME?
Rev 2 Nov.15
311
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
WAN/Cellular
A reboot is required before the WAN/Cellular AT Commands described in the following table take effect.
Table C-3: WAN / Cellular AT Commands
Command
*AUTOPRL
Description
CDMA only.
Query or set automatic Preferred Roaming List updates
AT*PRL? to query
AT*PRL=n to set
•
n=0—Disable
•
n=1—Enable
Note: To query the current PRL, use
.
*AUTOPRLFREQ
CDMA only.
Query or set how often the PRL automatically updates.
AT*AUTOPRLFREQ? to query
AT*AUTOPRLFREQ=n to set
•
n= interval to check for updates (in days)
312 4118127
AT Commands
Table C-3: WAN / Cellular AT Commands (Continued)
Command
!BAND
Description
Query or set the RF band range or technology.
AT!BAND? to query the current setting
AT!BAND=n to set at the next reboot.
The values depend on the Mobile Network Operator. For a list of bands supported in
each group, see Setting for Band on page 367.
Verizon Wireless:
•
n=00—All Bands
•
n=01—North America
•
n=02—North America, 3G
•
n=03—North America, 4G
•
n=04—World Mode
Sprint:
•
n=00—Automatic
•
n=01—LTE Only
•
n=02—CDMA Only
•
n=03—GSM Only
AT&T:
•
n=00—All Bands
•
n=01—Europe 3G
•
n=02—North America 3G
•
n=03—Europe 2G
•
n=04—North America 2G
•
n=05—GSM ALL
•
n=06—Europe
•
n=07—North America
•
n=08—WCDMA ALL
•
n=09—LTE ALL
Generic North America:
•
n=00—All Bands
•
n=01—Europe 3G
•
n=02—North America 3G
•
n=03—Europe 2G
•
n=04—North America 2G
•
n=05—GSM ALL
•
n=06—Europe
•
n=07—North America
•
n=08—WCDMA ALL
•
n=09—LTE ALL
•
n=0A— CDMA ALL
•
Rev 2 Nov.15
313
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-3: WAN / Cellular AT Commands (Continued)
Command
!BAND
(continued)
International:
•
n=00—All Bands
•
n=01—Europe 3G
•
n=02—North America 3G
•
n=03—Europe 2G
•
n=04—North America 2G
•
n=05—GSM ALL
•
n=6—Europe
•
n=07—North America
•
n=08—WCDMA ALL
•
n=09—LTE ALL
Description
Note: To query the current band, use *BAND?
.
+CGDCONT
Note: For some Mobile Network Operator SIM Cards, you may need to set the radio band before installing the SIM card.
HSPA only
Query or set the PDP context, APN, and other information required to establish a connection to o an HSPA network. You only need to configure this once. The parameters are saved and used each time a connection is made to the HSPA network.
AT+CGDCONT? to query
AT+CGDCONT = PID,PDP_TYPE,APN [,IPADDR] to set
•
PID= PDP context identifier
•
PDP_TYPE = numeric parameter that specifies a PDP context definition
•
APN = Access Point Name
•
IPADDR = IP address
Examples:
AT+CGDCONT=1,IP,proxy
AT+CGDCONT=1,IP,internet
Note: When using the APN-related optons in ACEmanager, you generally do not need to configure +CGDCONT.
314 4118127
AT Commands
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*CLIENT_PPP_AUTH
Description
Query or set the Force Network Authentication mode.
AT*CLIENT_PPP_AUTH? to query
AT*CLIENT_PPP_AUTH=n to set
•
n=0—None
•
n=1—PAP
•
n=2—CHAP
Examples:
*ATCLIENT_PPP_AUTH?
1
+COPS
OK
*ATCLIENT_PPP_AUTH=2
OK
HSPA only
Query or set the network operator and the connection mode.
AT+COPS? to query
AT+COPS=MODE[,FORMAT[,OPER]] to set
MODE
•
MODE=0 — Automatic (default)
•
MODE= 1 — Manual
•
MODE=4 — Manual/Automatic; if manual failed, it defaults to automatic
FORMAT
•
FORMAT=0 — Alphanumeric (“Name”)
•
FORMAT=2 — Numeric
OPER
•
OPER= the operator numeric code
Example, AT+COPS=1,2,302610
Manual mode, numeric format, operator code 302610
Note: On some mobile networks, explicit use of +COPS allows you to select the roaming Mobile Network Operator to use.
Rev 2 Nov.15
315
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*EVDODATASERV
Description
CMDA and LTE fallback to EV-DO only.
Query or set the allowable network type.
AT*EVDODATASERV? to query
AT*EVDODATASERV=n to set
•
n=0 — EV-DO Preferred — can “fall back” on CDMA/1x
(only available on EV-DO devices)
•
n=0 — LTE Preferred — can “fall back” on CDMA/EV-DO
(only available on LTE devices)
•
n=1 — EV-DO Only — fall back disabled (only available on 1x/EV-DO devices)
•
n=2 — 1x Only — EV-DO disabled (only available on 1x/EV-DO devices)
•
n=3—CDMA Only — LTE disabled (only available on LTE devices)
•
n=4—LTE Only — Fall back disabled (only available on LTE devices)
Note: If you choose one of the options where fall back is disabled and the selected network type is not available, the device will not be able to connect to the mobile network. For example, if you select LTE Only and you are in an area where there is no LTE network available, the device will not be able to connect to a mobile network until you change this setting or move to an area with LTE coverage.
*EVDODIVERSITY
*EVDOROAMPREF
*HANGUPTORESET
CDMA only. For HSPA device, see
Query or set EV-DO Diversity, which allows two antennas to provide more consistent connection.
AT*EVDODIVERSITY? to query
AT*EVDODIVERSITY=n to set
•
n=0 — Disabled
•
n=1 — Enabled
Note: If you are not using a diversity antenna, *EVDODIVERSITY should be disabled.
CDMA and LTE fallback to EV-DO only
Query or set the network roaming preference
AT*EVDOROAMPREF? to query
AT*EVDOROAMPREF=n to set
•
n=0—Automatic
•
n=1—Home only
HSPA only.
Query or set forcing the radio module to reset when the device disconnects.
AT*HANGUPTORESET? to query
AT*HANGUPTORESET=n to set
•
n=0—Disable
•
n=1—Enable
316 4118127
AT Commands
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*IPPING
Description
Query or set the interval between keepalive pings (in minutes) if no valid packets have been received by the IP address or FQDN specified in *IPPINGADDR.
AT*IPPING? to query the Keepalive PING time interval
AT*IPPING=n to set the Keepalive PING time interval
•
n=0 — Disable pinging (default)
•
n=15–255 minutes
Note: 15 minutes is the minimum interval for Keep Alive. If you set *IPPING for a value between 0 and 15, the idle interval for pings will be 15 minutes.
*IPPINGADDR
*IPPINGFORCE
*NETALLOWZEROIP
Query or set the Keepalive PING IP address or FQDN for the device to ping when
Keepalive Ping Time (
AT*IPPINGADDR? to query
AT*IPPINGADDR=[d.d.d.d] or [n]
•
d.d.d.d=IP address
•
n=domain name
Note: AT*IPPING must to be set to a value other than 0 to enable pinging.
Query or set the Force Keepalive Ping setting. When this feature is enabled, the
Keepalive ping is sent even if IP traffic has occurred during the configured interval.
AT*IPPINGFORCE? to query
AT*IPPINGFORCE=n to set
•
n=0—Disable
•
n=1—Enable
Note: To enable this command, *IPPING must be enabled and *IPPINGADDR configured.
Query or set allowing the device to get an IP address from the mobile network that has the last octet as 0 (zero).
AT*NETALLOWZEROIP? to query
AT*NETALLOWZEROIP=n to set
•
n=0 — Do not allow
•
n=1 — Allow
Allows the device to use a WAN IP address that ends in zero (e.g. 192.168.1.0).
Rev 2 Nov.15
317
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*NETAPN
Description
HSPA and LTE fallback to HSPA only
Query or set the user entered APN.
AT*NETAPN? to query
AT*NETAPN=<apn> to set (up to 80 characters)
Examples:
AT*NETAPN?
<apn>
OK
AT*NETAPN=<apn>
OK
Note: When you set this command, the APN type is automatically set to User Entry so that the APN you enter with this AT command is used on reboot.
*NETPW
*NETUID
Query or set the mobile network account password.
AT*NETPW? to query
AT*NETPW=<password> to set (up to 128 characters)
Note: AT*NETPW? returns asterisks (****) for privacy.
Examples:
ATNETPW?
*******
OK
AT*NETPW=<password>
OK
Query or set the mobile network account user ID, if required.
AT*NETUID? to query
•
AT*NETUID=<uid>(up to 128 characters)
AT*NETUID?
<uid>
OK
AT*NETUID=<uid>
OK
318 4118127
AT Commands
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*NWDOGTIME
Description
Query or set the interval that the network connection watchdog waits for a cellular
WAN connection. If no connection is established within this interval, the device resets.
AT*NWDOGTIME? to query
AT*NWDOGTIME=n to set
Accepted values:
•
n=0—Disable
•
n=5—5 Minutes
•
n=10—10 Minutes
•
n=15—15 Minutes
•
n=30—30 Minutes
•
n=45—45 Minutes
•
n=60—1 Hour
•
n=120—2 Hours (default)
•
n=180—3 Hours
•
n=240—4 Hours
Note: This AT Command replaces AT*NETWDOG.
PING
*PRIMARYSIM
Sends 5 PING to a single address. Returns OK if there is a response: ERROR if there is no response.
ATPING[ip address or FQDN]
Note: Do not use an equal sign (=) when issuing the command.
Example: ATPINGsierrawireless.com
Query or set which SIM slot contains the primary SIM card. If two SIM cards are installed, the Primary SIM card is used for network connections.
*PRIMARYSIM? to query
*PRIMARYSIM=<slot number> to set
•
<slot number>=1—Primary SIM card is in slot 1 (upper slot)
•
<slot number>=2—Primary SIM card is in slot 2 (lower slot)
Examples:
AT*PRIMARYSIM?
<slot number>
OK
AT*PRIMARYSIM=<slot number>
OK
The change takes effect after a reboot.
Rev 2 Nov.15
319
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-3: WAN / Cellular AT Commands (Continued)
Command
$QCMIP
*RADIO_CONNECT
Description
CDMA and LTE fallback to EV-DO only
Query or set use of Mobile IP (MIP) preferences.
$QCMIP? to query
$QCMIP=n to set
•
n=0—Disabled, Simple IP (SIP) only
•
n=1—Mobile IP preferred
•
n=2—Mobile IP only
This AT Command applies only to International devices on the Vodafone network.
Query or set the wireless connection setting.
AT*RADIO_CONNECT? to query
AT*RADIO_CONNECT=n to set
•
n=0—Disables data traffic. The only way to change this mode is to issue a radio_connect=1 or radio_connect=2 AT command.
•
n=1—Enables Always on connection.
•
n=2—Disables Always on connection. The device listens for outgoing traffic and establishes a mobile network data connection for a specified time:
•
When there is outgoing traffic or
•
When it receives a Wakeup SMS, provided Wakeup SMS is configured.
(Use
*TRAFWUPTOUT on page 322 to set the timeout period.)
Note: This command is not persistent over device resets.
*RADIO_CONNECT_
STARTUP
*RXDIVERSITY
Note: You can only send this command locally over a serial, serial USB, or local telnet/SSH connection.
This AT Command applies only to International devices on the Vodafone network.
You can query this command remotely or locally, but it can only be set locally.
This command is the same as *RADIO_CONNECT, except
•
The change does not take effect until the next reboot.
•
The setting is persistent over subsequent reboots.
HSPA only. For CDMA devices, see
Query or set the RX Diversity setting.
Rx Diversity allows you to use two antennas for a more consistent connection. If you are not using a diversity antenna, Rx Diversity should be disabled.
AT*RXDIVERSITY? to query
AT*RXDIVERSITY=n to set
•
n=0—Disable
•
n=1—Enable
Note: This AT Command is not available for all AirLink gateways.
320 4118127
AT Commands
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*SIMPIN
Description
HSPA and LTE fallback to HSPA only
Query or enter the SIM pin.
AT*SIMPIN? to query
AT*SIMPIN=<pin> to enter the SIM pin
Examples:
AT*SIMPIN?
<pin>
*SIM1PIN?
*SIM2PIN?
OK
AT*SIMPIN=<pin>
OK
HSPA and LTE fallback to HSPA only
Query or enter the SIM PIN for the SIM card in SIM slot 1 (upper slot).
*SIM1PIN? to query
*SIM1PIN=<pin> to enter the SIM PIN
Examples:
AT*SIM1PIN?
<pin>
OK
AT*SIM1PIN=<pin>
OK
HSPA and LTE fallback to HSPA only
Query or enter the SIM PIN for the SIM card in SIM slot 2 (lower slot).
*SIM2PIN? to query
*SIM2PIN=<pin> to enter the SIM PIN
Examples:
AT*SIM2PIN?
<pin>
OK
AT*SIM2PIN=<pin>
OK
Rev 2 Nov.15
321
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-3: WAN / Cellular AT Commands (Continued)
Command
*SIMPINENABLE
Description
HSPA and LTE fallback to HSPA only
Query or set the status of the SIM PIN.
AT*SIMPINENABLE? to query
AT*SIMPINENABLE=<setting> to set
•
<setting>=0—Don’t change
•
<setting>=1—Enable (SIM pin required on startup)
•
<setting>=2—Disable
AT*SIMPINENABLE?
<setting>
*TRAFWUPTOUT
OK
AT*SIMPINENABLE=<setting>
OK
This AT Command applies only to International devices on the Vodafone network.
Query or set the timeout period after which, if there is no outgoing WAN traffic, the connection is terminated.
The timeout period only takes effect if *RADIO_CONNECT
or
is set to 1, or Always on connection is disabled in ACEmanager. (See
Always on connection on page 68.)
AT*TRAFWUPTOUT? to query
AT*TRAFWUPTOUT=n to set
•
n=2–65535 minutes (default is 2)
Note: This timer is reset to zero each time a WAN packet goes out.
LAN
Note: A reboot is required before these commands take effect.
Table C-4: LAN AT Commands
Command Description
*DHCPHOSTEND
*DHCPNETMASK
Query or set the ending IP address for the Ethernet DHCP pool
AT*DHCPHOSTEND? to query
AT*DHCPHOSTEND=d.d.d.d to set
•
d.d.d.d=last IP address in Ethernet DHCP pool
Query or set the Ethernet DHCP subnet mask
AT*DHCPNETMASK? to query
AT*DHCPNETMASK=d.d.d.d to set
•
d.d.d.d=Ethernet DHCP subnet mask
322 4118127
AT Commands
Table C-4: LAN AT Commands (Continued)
Command Description
*DHCPSERVER
*DNS1?
*DNS2?
Query or set the Ethernet DHCP server.
AT*DHCPSERVER? to query
AT*DHCPSERVER=n to set the DHCP server mode
•
n=0—Disable
•
n=1—Server
•
n=2—Auto
For a description of the settings, see DHCP Mode on page 98.
Query the primary DNS (*DNS1) and secondary (*DNS2) IP addresses.
AT*DNS1? to query DNS1
AT*DNS2? to query DNS2
*DNSUSER
*HOSTAUTH
*HOSTPEERIP
Query or set the first alternate server for DNS override. (Applies only to primary DNS.)
AT*DNSUSER? to query
AT*DNSUSER=d.d.d.d
•
d.d.d.d=IP address of domain server
Query or set the Host Authentication mode for PPPoE only. (It does not set host authentication for PPP/DUN.)
AT*HOSTAUTH? to query
AT*HOSTAUTH=n to set
•
n=0—None/Disables authentication for PPPoE (default).
•
n=1— Authentication through PAP
•
n=2—Authentication through PAP & CHAP
Query or set the IP address of the device’s Ethernet port. By default this is 192.168.13.31.
*HOSTPRIVIP
*HOSTPRIVMODE
Note: Any connected LAN device can access this IP addresses, whether using a private or public IP address. This IP address must be in the same subnet as the Ethernet DHCP pool.
AT*HOSTPEERIP? to query
AT*HOSTPEERIP=d.d.d.d to set
•
d.d.d.d=local or peer IP address of the device
Query or set the starting IP for the Ethernet DHCP pool.
AT*HOSTPRIVIP? to query
AT*HOSTPRIVIP=d.d.d.d to set
•
d.d.d.d=IP Address
Query or set the host communication mode used for tethered IP connections.
AT*HOSTPRIVMODE? to query
AT*HOSTPRIMODE=n to set which user interface uses the Public IP address
•
n=0—Ethernet Uses Public IP
•
n=1—All Hosts Use Private IPs
•
n=2—USB Uses Public IP
•
n=3—DUN Uses Public IP
•
n=4—First Host gets Public IP
Rev 2 Nov.15
323
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-4: LAN AT Commands (Continued)
Command Description
*HOSTPW
Query or set the host password for PPPoE only. (It does not set the password for PPP/
DUN.)
AT*HOSTPW? to query
AT*HOSTPW=PASSWORD to set
Note: PASSWORD cannot be “password”.
*HOSTUID
*USBDEVICE
Query or set the Host user ID for PPPoE only. (It does not set the user ID for PPP/DUN.)
AT*HOSTUID? to query
AT*HOSTUID=USER ID to set (up to 64 bytes)
Note: USER ID cannot be “user”.
Query or set the startup mode for the USB port.
AT*USBDEVICE? to query
AT*USBDEVICE=n to set
•
n=0— USB Serial
•
n=1— USBNET
•
n=2— Disabled
324 4118127
AT Commands
VPN
Table C-5: VPN Commands
Command
*IPSEC1_AUTH
*IPSEC2_AUTH
*IPSEC3_AUTH
*IPSEC4_AUTH
*IPSEC5_AUTH
*IPSEC1_DH
*IPSEC2_DH
*IPSEC3_DH
*IPSEC4_DH
*IPSEC5_DH
*IPSEC1_ENCRYPT
*IPSEC2_ENCRYPT
*IPSEC3_ENCRYPT
*IPSEC4_ENCRYPT
*IPSEC5_ENCRYPT
*IPSEC1_GATEWAY
*IPSEC2_GATEWAY
*IPSEC3_GATEWAY
*IPSEC4_GATEWAY
*IPSEC5_GATEWAY
Description
Query or set the authentication type for # VPN.
AT*IPSEC[VPN number]_AUTH? to query
AT*IPSEC[VPN number]_AUTH=n to set
•
n=0 — None
•
n=1 — MD5
•
n=2 — SHA1 (default)
•
n=3 — SHA 256
Note: MD5 is an algorithm that produces a 128-bit digest for authentication. SHA is a more secure algorithm that produces both 160-bit
(SHA1) and 256-bit (SHA256) digests.
Query or set how the AirLink gateway VPN creates an SA with the VPN server. The DH (Diffie-Hellman) key exchange protocol establishes preshared keys during the phase 1 authentication. The AirLink gateway supports three prime key lengths, including Group 1 (768 bits), Group 2
(1,024 bits), and Group 5 (1,536 bits).
AT*IPSEC[VPN number]_DH? to query
AT*IPSEC[VPN number]_DH=n to set
•
n=0 — None
•
n=1 — DH1
•
n=2 — DH2 (default)
•
n=5 — DH5
Query or set the type/length of encryption key used to encrypt/decrypt
ESP (Encapsulating Security Payload) packets for # VPN.
AT*IPSEC[VPN number]_ENCRYPT? to query
AT*IPSEC[VPN number]_ENCRYPT=n to set
•
n=0 — None
•
n=1 — DES
•
n=2 — 3DES
•
n=3 — AES-128 (default)
•
n=7 — AES-256
Note: 3DES supports 168-bit encryption. AES (Advanced Encryption
Standard) supports both 128-bit and 256-bit encryption.
Query or set the IP address of the server that # VPN client connects to.
AT*IPSEC[VPN number]_GATEWAY? to query
AT*IPSEC[VPN number]_GATEWAY=[IP address] to set
Rev 2 Nov.15
325
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-5: VPN Commands (Continued)
Command Description
*IPSEC1_IKE_AUTH
*IPSEC2_IKE_AUTH
*IPSEC3_IKE_AUTH
*IPSEC4_IKE_AUTH
*IPSEC5_IKE_AUTH
Query or set the IKE authentication type for # VPN.
AT*IPSEC[VPN number]_IKE_AUTH? to query
AT*IPSEC[VPN number]_IKE_AUTH=n to set
•
n=1 — MD5
•
n=2 — SHA1
•
n=3 — SHA 256
Note: MD5 is an algorithm that produces a 128-bit digest for authentication. SHA is a more secure algorithm that produces both 160-bit
(SHA1) and 256-bit (SHA256) digests.
*IPSEC1_IKE_DH
*IPSEC2_IKE_DH
*IPSEC3_IKE_DH
*IPSEC4_IKE_DH
*IPSEC5_IKE_DH
*IPSEC1_IKE_ENCRYPT
*IPSEC2_IKE_ENCRYPT
*IPSEC3_IKE_ENCRYPT
*IPSEC4_IKE_ENCRYPT
*IPSEC5_IKE_ENCRYPT
*IPSEC1_IKE_LIFETIME
*IPSEC2_IKE_LIFETIME
*IPSEC3_IKE_LIFETIME
*IPSEC4_IKE_LIFETIME
*IPSEC5_IKE_LIFETIME
*IPSEC1_LIFETIME
*IPSEC2_LIFETIME
*IPSEC3_LIFETIME
*IPSEC4_LIFETIME
*IPSEC5_LIFETIME
Query or set how the AirLink gateway VPN creates an SA with the VPN server. The DH (Diffie-Hellman) key exchange protocol establishes preshared keys during the phase 1 authentication. The AirLink gateway supports three prime key lengths, including Group 1 (768 bits), Group 2
(1,024 bits), and Group 5 (1,536 bits).
AT*IPSEC[VPN number]_IKE_DH? to query
AT*IPSEC[VPN number]_IKE_DH=n to set
•
n=1 — DH1
•
n=2 — DH2 (default)
•
n=5 — DH5
Query or set the type/length of IKE encryption key used to encrypt/ decrypt ESP (Encapsulating Security Payload) packets for # VPN.
AT*IPSEC[VPN number]_IKE_ENCRYPT? to query
AT*IPSEC[VPN number]_IKE_ENCRYPT=n to set
•
n=1 — DES
•
n=5 — 3DES
•
n=7 — AES-128 (default)
•
n=9 — AES-256
Note: 3DES supports 168-bit encryption. AES (Advanced Encryption
Standard) supports both 128-bit and 256-bit encryption.
Query or set how long the # VPN tunnel is active (in seconds).
AT*IPSEC[VPN number]_IKE_LIFETIME? to query
AT*IPSEC[VPN number]_IKE_LIFETIME=n to set
•
n= 180–86400
•
Default is 7200.
Query or set how long the # VPN tunnel is active (in seconds).
AT*IPSEC[VPN number]_LIFETIME? to query
AT*IPSEC[VPN number]_LIFETIME=n to set
•
n= 180–86400
•
Default is 7200.
326 4118127
AT Commands
Table C-5: VPN Commands (Continued)
Command Description
*IPSEC1_LOCAL_ADDR
*IPSEC2_LOCAL_ADDR
*IPSEC3_LOCAL_ADDR
*IPSEC4_LOCAL_ADDR
*IPSEC5_LOCAL_ADDR
*IPSEC1_LOCAL_ADDR_MASK
*IPSEC2_LOCAL_ADDR_MASK
*IPSEC3_LOCAL_ADDR_MASK
*IPSEC4_LOCAL_ADDR_MASK
*IPSEC5_LOCAL_ADDR_MASK
*IPSEC1_LOCAL_ADDR_TYPE
*IPSEC2_LOCAL_ADDR_TYPE
*IPSEC3_LOCAL_ADDR_TYPE
*IPSEC4_LOCAL_ADDR_TYPE
*IPSEC5_LOCAL_ADDR_TYPE
Query or set the device subnet address for # VPN.
AT*IPSEC[VPN number]_LOCAL_ADDR? returns the device subnet address
AT*IPSEC[VPN number]_LOCAL_ADDR=[subnet address] to set
Query or set the device subnet mask information (24-bit netmask)
AT*IPSEC[VPN number]_LOCAL_ADDR_MASK? to query
AT*IPSEC[VPN number]_LOCAL_ADDR_MASK =[subnet mask] to set
Default is 255.255.255.0
*IPSEC1_LOCAL_ID
*IPSEC2_LOCAL_ID
*IPSEC3_LOCAL_ID
*IPSEC4_LOCAL_ID
*IPSEC5_LOCAL_ID
*IPSEC1_LOCAL_ID_TYPE
*IPSEC2_LOCAL_ID_TYPE
*IPSEC3_LOCAL_ID_TYPE
*IPSEC4_LOCAL_ID_TYPE
*IPSEC5_LOCAL_ID_TYPE
Query or set the network address type for # VPN.
AT*IPSEC[VPN number]_LOCAL_ADDR_TYPE? to query
AT*IPSEC[VPN number]_LOCAL_ADDR_TYPE=n to set
•
n=1 — Use the Host Subnet
•
n=5 — Single Address
•
n=17 — Subnet Address (default)
Query or set the local (My Identity) ID for the # VPN.
•
If IP is selected as the local (My Identity) type,
AT*IPSEC[VPN number]_LOCAL _ID? returns the WAN IP address assigned by the Mobile Network Operator
•
If FQDN or User FQDN is selected as the local (My Identity) type,
AT*IPSEC[VPN number]_LOCAL_ID? returns the FQDN (for example [email protected])
To set the local ID:
AT*IPSEC[VPN number]_LOCAL _ID=[IP address] or [FQDN], depending on the setting for Local ID (My Identity) type.
Query or set the local (My Identity) ID type for the # VPN.
AT*IPSEC[VPN number]_LOCAL_ID_TYPE? to query
AT*IPSEC[VPN number]_LOCAL_ID_TYPE=n to set
•
n=1 — IP
•
n=2 — FQDN
•
n=3 — User FQDN
Note:
•
IP (default) allows you to use an IP address
•
FQDN allows you to use a fully qualified domain name (FQDN) e. g., modemname.domainname.com
•
User FQDN allows you to use a user FQDN whose values should include a username (e.g. [email protected])
Rev 2 Nov.15
327
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-5: VPN Commands (Continued)
Command Description
*IPSEC1_NEG_MODE
*IPSEC2_NEG_MODE
*IPSEC3_NEG_MODE
*IPSEC4_NEG_MODE
*IPSEC5_NEG_MODE
Query or set the negotiation mode for # VPN.
AT*IPSEC[VPN number]_NEG_MODE? returns
AT*IPSEC[VPN number]_NEG_MODE=n to set
•
n=1 — Main
•
n=2 — Aggressive
Note: Aggressive mode offers increased performance at the expense of security.
*IPSEC1_PFS
*IPSEC2_PFS
*IPSEC3_PFS
*IPSEC4_PFS
*IPSEC5_PFS
Query or set the Perfect Forward Secrecy (PFS) setting for # VPN.
PFS provides additional security through a DH shared secret value.
When this feature is enabled, one key cannot be derived from another.
This ensures previous and subsequent encryption keys are secure even if one key is compromised.
AT*IPSEC[VPN number]_PFS? to query PFS
AT*IPSEC[VPN number]_PFS=n to set PFS
•
n=0 — Yes (default)
•
n=1 — No
Query or set the IP address of the device behind the gateway for # VPN.
AT*IPSEC[VPN number]_REMOTE_ADDR? to query
AT*IPSEC[VPN number]_REMOTE_ADDR=[IP address] to set
*IPSEC1_REMOTE_ADDR
*IPSEC2_REMOTE_ADDR
*IPSEC3_REMOTE_ADDR
*IPSEC4_REMOTE_ADDR
*IPSEC5_REMOTE_ADDR
*IPSEC1_REMOTE_ADDR_MASK
*IPSEC2_REMOTE_ADDR_MASK
*IPSEC3_REMOTE_ADDR_MASK
*IPSEC4_REMOTE_ADDR_MASK
*IPSEC5_REMOTE_ADDR_MASK
*IPSEC1_REMOTE_ADDR_TYPE
*IPSEC2_REMOTE_ADDR_TYPE
*IPSEC3_REMOTE_ADDR_TYPE
*IPSEC4_REMOTE_ADDR_TYPE
*IPSEC5_REMOTE_ADDR_TYPE
*IPSEC1_REMOTE_ID
*IPSEC2_REMOTE_ID
*IPSEC3_REMOTE_ID
*IPSEC4_REMOTE_ID
*IPSEC5_REMOTE_ID
Query or set the remote subnet mask information (24-bit netmask).
AT*IPSEC[VPN number]_REMOTE_ADDR_MASK? to query
AT*IPSEC[VPN number]_REMOTE_ADDR_MASK =[subnet mask] to set
Default is 255.255.255.0
Query or set network information of the IPsec server behind the IPsec gateway for # VPN.
AT*IPSEC[VPN number]_REMOTE_ADDR_TYPE? to query
AT*IPSEC[VPN number]_REMOTE_ADDR_TYPE=n to set
•
n=5 — Single Address
•
n=17 — Subnet Address (default)
Query or set the remote (Peer Identity) ID for the # VPN.
•
If IP is selected as the remote (Peer Identity) type,
AT*IPSEC[VPN number]_REMOTE_ID? returns the WAN IP address assigned by the Mobile Network Operator
•
If FQDN or User FQDN is selected as the remote (Peer Identity) type, AT*IPSEC[VPN number]_REMOTE_ID? returns the FQDN (for example [email protected])
To set the remote ID:
AT*IPSEC[VPN number]_REMOTE _ID=[IP address] or [FQDN], depending on the setting for remote ID (Peer Identity) type.
328 4118127
AT Commands
Table C-5: VPN Commands (Continued)
Command Description
*IPSEC1_REMOTE_ID_TYPE
*IPSEC2_REMOTE_ID_TYPE
*IPSEC3_REMOTE_ID_TYPE
*IPSEC4_REMOTE_ID_TYPE
*IPSEC5_REMOTE_ID_TYPE
Query or set the remote (Peer Identity) ID type for the # VPN.
AT*IPSEC[VPN number]_REMOTE_ID_TYPE? to query
AT*IPSEC[VPN number]_REMOTE_ID_TYPE=n to set
•
n=1 — IP
•
n=2 — FQDN
•
n=3 — User FQDN
Note:
•
FQDN allows you to use a fully qualified domain name (FQDN) e. g., modemname.domainname.com
•
User FQDN allows you to use a user FQDN whose values should include a username (e.g. [email protected])
*IPSEC1_SHARED_KEY1
*IPSEC2_SHARED_KEY1
*IPSEC3_SHARED_KEY1
*IPSEC4_SHARED_KEY1
*IPSEC5_SHARED_KEY1
*IPSEC1_STATUS?
*IPSEC2_STATUS?
*IPSEC3_STATUS?
*IPSEC4_STATUS?
*IPSEC5_STATUS?
Query the pre-shared Key (PSK) used to initiate the # VPN tunnel.
AT*IPSEC[n]_SHARED_KEY1?
[n]=server number
*IPSEC1_TUNNEL_TYPE
*IPSEC2_TUNNEL_TYPE
*IPSEC3_TUNNEL_TYPE
*IPSEC4_TUNNEL_TYPE
*IPSEC5_TUNNEL_TYPE
Query the VPN # connection status.
AT*IPSEC[VPN number]_STATUS? to query
•
Disabled
•
Not Connected
•
Connected
Note: Use this when troubleshooting a VPN # connection.
Query or set the VPN # tunnel type.
AT*IPSEC[VPN number]_TUNNEL_TYPE? to query
AT*IPSEC[VPN number]_TUNNEL_TYPE=n to set
•
n=0 — Disable the tunnel (default)
•
n=1 — IPsec Tunnel
•
n=2 — GRE Tunnel
•
n=3 — SSL Tunnel
Note: For a successful configuration, all settings for the VPN tunnel must be identical between the AirLink gateway VPN and the enterprise
VPN server.
Rev 2 Nov.15
329
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Security
Table C-6: Security AT Commands
Command Description
F0 (F1, F2, ... F9)
Query or set the Inbound Trusted IP List.
ATF? to query the list
ATF[n]=d.d.d.d to set
•
n=0–9 Trusted IP list index number
•
d.d.d.d = IP Address
Using 255 in the IP address will allow any number
Example: 166.129.2.255 allows access by all IPs in the range 166.129.2.0–166.129.2.255.
Example: atf?
0=192.32.32.21
1=192.32.32.22
2=192.32.32.23
3=0.0.0.0
4=0.0.0.0
5=0.0.0.0
6=0.0.0.0
7=0.0.0.0
8=0.0.0.0
9=0.0.0.0
OK
If the index number does not have an IP address associated with it, the query returns
0.0.0.0 for that index number.
Note: You can only query or configure the first nine Inbound Trusted IP addresses with this
AT Command. You cannot query or configure Trusted range entries with this AT Command.
FM
Query or set the Inbound Trusted IP mode (Friends List) — Only allow specified IPs to access the device.
ATFM? to query the setting
ATFM=n to set
•
n=0 — Disable Trusted IP mode
•
n=1 — Enable Trusted IP mode — Only packets from IP addresses in the Trusted IP list are allowed. Packets from other IP addresses are ignored.
330 4118127
AT Commands
Services
Table C-7: Services AT Commands
Command Description
AirLink Management System
*AVMS_ENABLE
*AVMS_INTERVAL
*AVMS_NAME
*AVMS_SERVER
*AVMS_STATUS?
*AVMS_AUTOSYNC
*AVMS_VERIFYPEER
*ENGHRS
Query or set the ALMS activation status.
AT*AVMS_ENABLE? to query
AT*AVMS_ENABLE=n to set
•
n=0—Disable device initiated ALMS management
•
n=1—Enable device initiated ALMS management
Query or set the ALMS communication (heartbeat) interval in seconds.
AT*AVMS_INTERVAL? to query
AT*AVMS_INTERVAL= n to set
•
n= INTERVAL (in seconds)
Assigns or queries the name to the AirLink gateway as it appears in ALMS.
AT*AVMS_NAME? to query
AT*AVMS_NAME= n to set
•
n= ALMS NAME
Query or set the ALMS server IP address or FQDN.
AT*AVMS_SERVER? to query
AT*AVMS_SERVER=n to set
•
n=IP Address or FQDN of ALMS server
Query the ALMS connection status
Query or set ALMS autosynchronization of configuration parameters.
AT*AVMS_AUTOSYNC? to query
AT**AVMS_AUTOSYNC=n to set
•
n=0—Disable ALMS autosynchronization
•
n=1—Enable ALMS autosynchronization
Query or set peer certificate verification during SSL handshake.
AT*AVMS_VERIFYPEER? to query
AT*AVMS_VERIFYPEER=n to set
•
n=0—Disable peer certificate verification during SSL handshake
•
n=1—Enable peer certificate verification during SSL handshake
Query or set the number of hours the engine has been running.
AT*ENGHRS? to query
AT*ENGHRS=n to set
•
n= HOURS
Maximum value is 65535.
Dynamic DNS
Rev 2 Nov.15
331
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-7: Services AT Commands (Continued)
Command Description
*DOMAIN
Query or set the domain name used for the IP Manager Dynamic DNS configuration.
AT*DOMAIN? to query
AT*DOMAIN=DOMAIN to set (up to 20 characters)
Example: AT*DOMAIN=eairlink.com
Tip:
Only letters, numbers, hyphens, and periods can be used in a domain name.
*DYNDNS
*IPMANAGER1
*IPMANAGER2
Note: This AT command is only usable if the Dynamic DNS Service type is set to IP Manager.
Query or set the Dynamic DNS Service type to use.
AT*DYNDNS? to query
AT*DNYDNS=n to set
•
n=0—Disable (default)
•
n=2—dyndns.org
•
n=5—noip.org
•
n=6—ods.org
•
n=8—regfish.com
•
n=9—tzo.org
•
n=10—IP Manager
Note: Only IP Manager can be fully configured using AT Commands.
Note: This AT command is only usable if the Dynamic DNS Service type is set to IP Manager.
Query or set a FQDN or IP address of the IP server to send IP change notifications to. You can configure two independent IP Manager servers.
AT*IPMANAGER[n]? to query
AT*IPMANAGER[n]=SERVER to set.
•
n=1—First IP Manager server
•
n=2—Second IP Manager server
•
SERVER = Server FQDN or IP address
Note: You can disable updates to a server by setting blank entry
(e.g., “AT*IPMANAGER1=”).
332 4118127
AT Commands
Table C-7: Services AT Commands (Continued)
Command Description
*IPMGRKEY1
*IPMGRKEY2
Note: This AT command is only usable if the Dynamic DNS Service type is set to IP Manager.
Query or set the 128-bit password/key used to authenticate the IP update notifications. If the key's value is all zeros, a default key is used. If all the bytes in the key are set to FF, then no key is used (i.e., the IP change notifications will not be authenticated).
AT*IPMGRKEY[n]? to query
AT*IPMANAGER[n]=KEY to set
•
n=1—First IP Manager server
•
n=2—Second IP Manager server
•
KEY=128-bit key in hexadecimal [32 hex characters]
*IPMGRUPDATE1
*IPMGRUPDATE2
Note: This AT command is only usable if the Dynamic DNS Service type is set to IP Manager.
Query or set the interval (in minutes) to send an IP update notification to the corresponding server. This occurs even if the IP address of the device does not change. If the value is set to 0, then periodic updates are not issued (i.e.,
IP change notifications is only be sent when the IP actually changes).
AT*IPMGRUPDATE[n] to query
AT*IPMGRUPDATE[n]=INTERVAL to set
•
n=0—Disables the update interval (updates only on changes)
•
n=1—First IP Manager server
•
n=2—Second IP Manager server
•
INTERVAL=1–255—interval (in minutes) to send an update
*MODEMNAME
Note: This AT command is only usable if AT*DYNDNS is set to 10 (IP
Manager).
Query or set the device name used by IP Manager. (This name is displayed on the Status > Home page.)
AT*MODEMNAME? to query
AT*MODEMNAME=NAME to set (up to 20 characters long)
•
NAME= device name (for example, mydevice)
The value in *DOMAIN provides the domain zone to add to this name.
Example: If *MODEMNAME=mydevice and *DOMAIN=eairlink.com, the device's fully qualified domain name is mydevice.eairlink.com.
Tip:
Each device using IP Manager needs a unique name. I.e., two devices cannot both be called “mydevice”. One could be named “mydevice1” while the other could be named “mydevice2”.
Rev 2 Nov.15
333
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-7: Services AT Commands (Continued)
Command Description
SMS
*SMSM2M
*SMSM2M_8
*SMSM2M_u
You can only use these commands locally.
•
AT*SMSM2M sends an SMS in ASCII text (requires quotation marks; maximum 140 characters)
•
AT*SMSM2M_8 sends an 8-bit SMS (requires quotation marks; maximum 140 characters)
•
AT*SMSM2M_U sends a unicode SMS (requires quotation marks; maximum 140 characters)
Format:
AT*SMSM2M=“[phone] [ascii message]”
AT*SMSM2M_8=“[phone] [hex message]”
AT*SMSM2M_U=“[phone] [hex message]”
•
The phone number can only consist of numbers (NO spaces or other characters). The phone number should be as it appears in the Last
Incoming Phone Number field.
•
Example 1 (US): 14085551212 (including leading 1 and area code)
•
Example 2 (US): 4085551212 (ignore leading 1, include area code)
•
Example 3 (UK): 447786111717 (remove leading 0 and add country code)
Command Examples:
AT*SMSM2M=”18005551212 THIS IS A TEST” sends in ASCII.
AT*SMSM2M_8="17604053757 5448495320495320412054455354" sends the message “THIS IS A TEST” as 8-bit data.
AT*SMSM2M_U="17604053757
000102030405060708090a0b0c0d0e0f808182838485868788898A8b8c8d8 e8f" sends the bytes:
00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f
80 81 82 83 84 85 86 87 88 89 8a 8b 8c 8d 8e 8f
Note: Not all cellular Mobile Network Operators support 8-bit or unicode
SMS messages.
*SMS_PASSWORD
Query or set the SMS password.
AT*SMS_PASSWORD? to query
AT*SMS_PASSWORD = n n= SMS password
If no password has ever been configured, a default password is created from the last four characters of the SIM ID (for all SIM-based devices) or the ESN
(for devices without a SIM, such those using EV-DO).
Note: The configured password remains in place, even when the device is reset to factory default settings.
334 4118127
AT Commands
Table C-7: Services AT Commands (Continued)
Command Description
*SMSWUPTOUT
This AT Command only to International devices on the Vodafone network.
Query or set the connection timeout for the SMS Wakeup feature. When this feature is enabled, an IP connection is initiated on receipt of a specific type of
SMS (For information on choosing the type of SMS, see Services > SMS
>SMS Wakeup > SMS Wakeup Trigger described in step 3 on page 172
).
The IP connection closes after the timeout period specified in this AT command. Outgoing traffic sent after the timer is set does not reset the timer.
AT*SMSWUPTOUT? to query
AT*SMSWUPTOUT=n to set
•
n=2–65535 minutes (default is 2)
See also *RADIO_CONNECT on page 320.
Telnet/SSH
*DEFAULTTELNETUSER
Query or set the Telnet default user name
AT*DEFAULTTELNETUSER? to query
AT*DEFAULTTELNETUSER=n to set
•
n=None—Prompted for a user name and password when logging into a
Telnet session (default)
•
n=user—Prompted for a password only when logging into a Telnet session (User name is “user”.)
Note: The default user name is only for Telnet; not SSH.
*TELNETTIMEOUT
*TSSH
*TPORT
*TQUIT
Query or set the Telnet/SSH idle time out.
By default, this value is set to close the telnet/SSH connection if no data is received for 2 minutes.
AT*TELNETTIMEOUT? to query
AT*TELNETTIMEOUT=n to set
•
n=1—255 minutes (Default is 2.)
Query or set the remote login server mode.
AT*TSSH? to query
AT*TSSH=n to set
•
n=0—Telnet (default)
•
n=1—SSH
Query or set the Telnet/SSH port.
AT*PORT? to query
AT*PORT=n to set
•
n=1–65535 (Default is 2332.)
Many networks have the ports below 1024 blocked. It is recommended to use a higher numbered port.
AT*TQUIT which will kill an open telnet session.
Rev 2 Nov.15
335
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-7: Services AT Commands (Continued)
Command Description
Management (SNMP)
SNMP General Configuration
*SNMP
*SNMPCONTACT
*SNMPLOCATION
*SNMPNAME
*SNMPPORT
*SNMPVERSION
Query or set the SNMP option.
AT*SNMP? to query
AT*SNMP=n to set
•
n=0—Disable
•
n=1—Enable
Add string contact information in SNMPv2 and SNMPv3.
AT*SNMPCONTACT=string
•
string= email address (Example: [email protected])
Add string location information in SNMPv2 and SNMPv3.
AT*SNMPLOCATION=string
•
string= location information (Example: Building 19–67B)
Add string name in SNMPv2 and SNMPv3.
AT*SNMPNAME=STRING
•
STRING=name (Example: John Doe)
Query or set the port number in SNMPv2 and SNMPv3.
AT*SNMPPORT? to query
AT*SNMPPORT=n to set
•
n=1–65535 (Default is 161.)
Query or set the SNMP version.
AT*SNMPVERSION? to query
AT*SNMPVERSION=n to set
•
n=2—version 2
•
n=3—version 3
SNMP Read Only Configuration
*SNMPROCOMMUNITY
*SNMPROUSER
*SNMPROUSERAUTHTYPE
*SNMPROUSERSECLVL
Read-only community string in SNMPv2 and SNMPv3
(SNMP equivalent of a password; for example: public)
Query or set a read only SNMP username string in SNMPv3.
Query or set the read only authentication type in SNMPv3.
AT*SNMPROUSERAUTHTYPE? to query
AT*SNMPROUSERAUTHTYPE=n
•
n=0—MD5
•
n=1—SHA
Query or set the read only security level in SNMPv3.
AT*SNMPROUSERSECLVL? to query
AT*SNMPROUSERSECLVL=n to set
•
n=0—none
•
n=1—authentication only
•
n=2—authentication + privacy
336 4118127
AT Commands
Table C-7: Services AT Commands (Continued)
Command Description
SNMP Read/Write Configuration
*SNMPRWCOMMUNITY
*SNMPRWUSER
*SNMPRWUSERAUTHTYPE
*SNMPRWUSERSECLVL
*SNMPRWUSERPRIVTYPE
Read/write community string in SNMPv2 and SNMPv3.
(SNMP equivalent of a password; for example: private)
Query or set a read/write SNMP username string in SNMPv2 and SNMPv3.
Query or set the read/write authentication type in SNMPv3.
AT*SNMPRWUSERAUTHTYPE? to query
AT*SNMPRWUSERAUTHTYPE=n to set
•
n=0—MD5
•
n=1—SHA
Query or set the read/write security level in SNMPv3.
AT*SNMPRWUSERSECLVL? to query
AT*SNMPRWUSERSECLVL=n to set
•
n=0—none
•
n=1—authentication only
•
n=2—authentication + privacy
Query or set the read/write privacy type in SNMPv3.
AT*SNMPRWUSERPRIVTYPE? to query
AT*SNMPRWUSERPRIVTYPE=n to set
•
n=0—DES
•
n=1—AES
SNMP TRAP Configuration
*SNMPENGINEID
*SNMPTRAPAUTHTYPE
*SNMPTRAPCOMMUNITY
*SNMPTRAPDEST
*SNMPTRAPPORT
*SNMPTRAPPRIVTYPE
Specify an identification name string for a SNMP engine in SNMPv3.
(For example: Shark-0012E8)
Query or set the SNMP TRAP authentication type in SNMPv3.
AT*SNMPTRAPAUTHTYPE? to query
AT*SNMPTRAPAUTHTYPE=n to set
•
n=0—MD5
•
n=1—SHA
SNMP TRAP community string in SNMPv2 and SNMPv3.
(SNMP equivalent of a password)
Query or set the SNMP TRAP destination in SNMPv2 and SNMPv3.
(for example: 192.168.13.33)
•
Query or set the SNMP TRAP port in SNMPv2 and SNMPv3.
1–65535 (Default is 162.)
Query or set the SNMP TRAP privacy type in SNMPv3.
AT*SNMPTRAPPRIVTYPE? to query
AT*SNMPTRAPPRIVTYPE=n to set
•
n=0—DES
•
n=1—AES
Rev 2 Nov.15
337
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-7: Services AT Commands (Continued)
Command Description
*SNMPTRAPSECLVL
Query or set the SNMP TRAP security level in SNMPv3.
AT*SNMPTRAPSECLVL? to query
AT*SNMPTRAPSECLVL=n to set
•
n=0—none
•
n=1—authentication only
•
n=2—authentication + privacy
Query or set a SNMP TRAP username string in SNMPv3.
*SNMPTRAPUSER
Email (SMTP) Commands
*SMTPADDR
*SMTPFROM
*SMTPSUBJ
*SMTPPW
Query or set the mail server IP address or FQDN.
AT*SMTPADDR? to query
AT*SMTPADDR=[d.d.d.d] or [NAME] to set
•
d.d.d.d=IP Address
•
NAME=domain name (maximum: 40 characters)
Query or set the email address from which the SMTP message is being sent
(required by some mail servers).
AT*SMTPFROM? to query
AT*SMTPFROM=EMAIL to set
•
EMAIL=email address (maximum: 30 characters)
Query or set the email subject line to use for sending emails.
AT*SMTPSUBJ? to query
AT*SMTPSUBJ=STRING to set
Query or set the email server password (required by some mail servers).
AT*SMTPPW? to query
AT*SMTPPW=PASSWORD to set
*SMTPUSER
Query or set the email account username (required by some mail servers).
AT*SMTPUSER? to query
AT*SMTPUSER=USER to set (maximum: 40 characters)
Time (SNTP) Commands
*SNTP
*SNTPADDR
Query or set daily SNTP updates of the system time.
AT*SNTP? to query
AT*SNTP=n to set
•
n=0—Off
•
n=1—On
SNTP Server IP address, or fully-qualified domain name, to use if *SNTP=1.
AT*SNTPADDR? to query
AT*SNTPADDR=[d.d.d.d] or [NAME]
•
d.d.d.d=IP Address
•
NAME=FQDN
338 4118127
AT Commands
Serial
Table C-8: Serial AT Commands
Command Description
AIP
\APPP
*CTSE
DAE
*DPORT
*DU
*ENQ
Query or set the option to allow IP addresses to communicate on UDP over serial.
AT*AIP? to query
AT*AIP=n to set
•
n=0 — Allow only the IP address specified in S53 to connect when UDP auto answer is enabled (S82=2)
•
n=1 — Allow any incoming IP address to connect when UDP auto answer is enabled (S82=2)
Always subject to any security filters that may be defined. (See Security on page 330.)
Initiates a PPP connection on serial terminal.
You can also initiate a PPP connection using the ADT command and one of the supported phone numbers.
Query or set asserting Clear To Send (CTS) when there is a network coverage.
AT*CTSE? to query
AT*CTSE=n to set
•
n=0 — Disabled (default)
•
n=1 — Enable assertion of CTS when there is network coverage
Query or set AT Escape Sequence detection.
ATDAE? to query
ATDAE=n to set
•
n=0 — Enable
•
n=1 — Disable (The escape sequence (+++) is ignored.)
Query or set the device port that the device listens on for inbound packets/data/ polls.
AT*DPORT? to query
AT*DPORT=n to set
•
n=1–65535
Query or set the dial command to only use UDP.
AT*DU? to query
AT*DU=n to set
•
n=0 — Dial using the means specified (default)
•
n=1 — Dial UDP always, even when using ATDT
When this parameter is set you cannot establish a TCP PAD connection by using the
Dial command.
Query or set the option to output an ENQ [0x05] after the TCP CONNECT, delayed by the Delay Connect Response time (S221).
AT*ENQ? to query
AT*ENQ=n to set
•
n=0 — Disable (default)
•
n=1 — Enable ENQ on TCP CONNECT
Rev 2 Nov.15
339
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-8: Serial AT Commands (Continued)
Command Description
*HOSTMODE?
Query the current host mode.
AT*HOSTMODE? returns:
•
AT
•
PPP
•
TCP
•
UDP
Note: If the device is not in AT mode, Telnet into the device to execute this command.
MD
MD
Query or set the default start-up mode for the serial port. When the device is powercycled, the serial port enters the mode specified by this command after 5 seconds.
On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode.
ATMD? to query
ATMD<hh> (hex byte) to set
•
<hh>=00 — Normal (AT Command mode)
•
<hh>=02 — PPP
•
<hh>=03 — UDP
•
<hh>=04 — TCP
•
<hh>=08 — reverse telnet/ssh
•
<hh>=13 — Modbus ASCII
•
<hh>=23 — Modbus RTU (Binary)
•
<hh>=33 — BSAP
•
<hh>=63 — Variable Modbus
•
<hh>=83 — UDP Multiple Unicast
Query or set the default start-up mode for the serial port. When the device is powercycled, the serial port enters the mode specified by this command after 5 seconds.
On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. See also S53 to set the port for UDP.
ATMD? to query
ATMD<hh> to set, where <hh> is a hex byte
•
<hh>=00 — Normal (AT Command mode)
•
<hh>=02 — PPP
•
<hh>=03 — UDP
•
<hh>=04 — TCP
•
<hh>=08 — reverse telnet/ssh
•
<hh>=83 — UDP Multiple Unicast
340 4118127
AT Commands
Table C-8: Serial AT Commands (Continued)
Command Description
IPL
*NUMTOIP
S50
S51
S53
Query or set the IP list dial.
AT*IPL? to query
AT*IPL=n to set
•
n=0—Disable
•
n=1—Enable
This allows you to access to the Modbus IP address list using the first two digits of the dial string.
Example: ATDT1234567 would go to ID “12” on the Modbus list and use the associated IP as the destination.
Query or set the option to convert a 12-digit number to an IP address
For example, converts 111222333444 to 111.222.333.444
AT*NUMTOIP? to query
AT*NUMTOIP=n to set
•
n=0—Disable
•
n=1—Enable
Query or set the data forwarding idle time-out.
ATS50? to query
ATS50=n to set
•
n=0 — a forwarding time-out of 10ms is used.
•
n= tenths of a second
Query or set the PAD data forwarding character. ASCII code of character that causes data to be forwarded. Used in UDP or TCP PAD mode.
ATS51? to query
AT51=CHARACTER to set
•
n=0 — No forwarding character
•
n= CHARACTER
Query or set the method (dial mode), destination IP address, and port used as defaults for the D (Dial) AT command.
ATS53? to query
ATS53=[method][d.d.d.d][/ppppp] to set
[method] can be:
•
P — UDP
•
T — TCP
[d.d.d.d] is the destination IP address
[pppp] is the port number.
Example:
ATS53=P111.22.33.44/5555 where:
•
The first character is the dial mode (P in this example)
•
Followed by destination IP address (111.22.33.44 in this example)
•
A slash
•
Followed by the destination port (5555 in this example)
You can also use this command to set only the port. For example, AT53=/7777.
Rev 2 Nov.15
341
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-8: Serial AT Commands (Continued)
Command Description
S60
S82
S83
*SERIALLEDDISPLAY
TCPS
TCPT
*UALL
Query or set the Telnet Client Echo Mode.
ATS60? to query
ATS60=n to set
•
n=0 — No Echo
•
n=1 — Local Echo (default)
•
n=2 — Remote Echo
Query or set UDP auto answer.
ATS82? to query
ATS82=n to set
•
n=0 — Disable
•
n=1 — Enable
Query or set the UDP auto answer idle time-out. If no data is sent or received before the time-out occurs, the current UDP session is terminated. While a session is active, packets from other IP addresses are discarded (unless *UALL is set).
ATS83? to query
ATS83=n to set
•
n=0 — No idle time-out (default)
•
n=1 – 255 — Time-out in seconds
Query or set whether or not the Activity LED on the AirLink gateway indicates traffic on the selected serial port.
AT*SERIALLEDDISPLAY? to query
AT*SERIALLEDDISPLAY=n to set
•
n=0 — LED display of serial traffic disabled (default)
•
n=1 — LED display of serial traffic enabled
For a description of the Activity LED when this parameter is enabled, see
Query or set the TCP connection time-out (TCPS) units. If there is no traffic through the TCP connection for the specified interval, the connection is terminated.
AT*TCPS? to query
AT*TCPS=n to set
•
n=0 — minutes
•
n=1—seconds
Query or set the interval to terminate a TCP connection when there is no traffic. This value affects only the TCP connection in TCP PAD mode.
AT*TCPT? to query
AT*TCPT=n to set
•
n=0–255
Query or set the ability to accept UDP packets from any IP address when a UDP session is active. If there is no UDP session active, an incoming UDP packet will be treated according to the UDP auto answer and AIP settings.
AT*UALL? to query
AT*UALL=n to set
•
n=0 — No effect (default)
•
n=1 — Accept UDP data from all IP addresses when in a UDP session
342 4118127
AT Commands
Table C-8: Serial AT Commands (Continued)
Command Description
*UDPLAST
*UDPPADMTU
*USD
Query or set the option to set S53 to the last accepted IP address through UDP auto answer. This can be used in conjunction with MD3 so that when there is no UDP session, new Ethernet host data will cause a connection to be restored to the last IP accepted through UDP auto answer.
AT*UDPLAST? to query
AT*UDPLAST=n to set
•
n=0 — Does not change destination IP (default)
•
n=1 — Change destination IP to last received
Query or set the size of serial MTU (PAD payload)
AT*UDPPADMTU? to query
AT*UDPPADMTU=n to set
•
n=256–4096
Query or set the specified delay before sending the UDP packets out the serial port.
AT*USD? to query
AT*USD=n to set
•
n=0—No UDP packet delay (default)
•
n=1–255—Delay in 100ms units, from 100 ms to 25.5 sec.
Rev 2 Nov.15
343
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Standard (Hayes) commands
The following table contains Hayes commands supported on AirLink gateways.
Table C-9: Standard (Hayes) AT Commands
Command Description
+++
AT escape sequence (not preceded by AT)
If a serial terminal is in a data mode, typing this sequence on that serial terminal causes the terminal to re-enter AT command mode. There must be an idle time on the serial port before and after the sequence. The idle time is set by the value in S50.
After you type the AT escape sequence, the terminal remains in AT command mode for
15 seconds before it automatically leaves AT command mode and returns to the previous data mode.
Note: The “+” is ASCII character 0x2B.
&C
Note: The detection of this sequence is disabled if DAE=1.
Query or set Data Carrier Detect (DCD) mode.
DCD is a hardware signal that notifies the software that the device is communicating with another device.
AT&C? to query
AT&Cn to set
•
n=0 — Always assert DCD
•
n=1 — Assert DCD enable when network is ready (default)
Note: Do not use an equal sign (=) when issuing the command.
344 4118127
AT Commands
Table C-9: Standard (Hayes) AT Commands (Continued)
Command Description
D[method] [d.d.d.d]
[/ppppp] or
D[method] [[@]name]
[/ppppp]
Dial a connection to a remote IP and Port using either UDP, TCP, or Telnet.
You can only use ATD#19788 and ATDT#19788 locally.
method =
P — Establish a UDP connection
T — Establish a TCP connection
N — Establish a Telnet connection
d.d.d.d = IP address to establish connection to
name = Domain name to establish connection to
ppppp = IP port to establish connection to
Examples:
ATD — Dial (establish) default connection per S53
ATDPnnn.nnn.nnn.nnn[/ppppp] — Dial (establish) UDP session to the specified IP address/ port.
If the method, IP address, or port is omitted, the values from S53 are used. If a Telnet connection is requested (N) and the port is not supplied, port 23 will be used instead of the value from S53.
Several special dialing numbers exist to make it easy to establish a PPP connection with the device. ATD#19788 or ATDT#19788 will establish a PPP connection (see
If a domain name is specified, the ‘@’ symbol can be used to explicitly indicate the start of the name. For example, if “ATDPHONY” is issued, this will be interpreted as dial a UDP connection to “HONY”. To dial using the default method to host “PHONY”, one would issue
“ATD@PHONY”.
To end the connection, issue the +++ escape sequence or drop the DTR line (if Ignore DTR
S211=0 or &D2).
Note: The source port of the session is the Device Port (set by *DPORT).
&D
*DATZ
Query or set Data Terminal Ready (DTR) mode.
AT&D? to query
AT&Dn to set
•
n=0 — Devices ignores DTR, same effect as HW DTR always asserted (same as
S211=1); DTD is assumed to be on.
•
n=1 — DRT drop causes the device to switch to AT command mode, but does not drop the connection.
•
n=2 — DTR drop causes the connection to drop.
•
n=3—DTR drop causes the connection to reinitialize.
Note: Do not use an equal sign (=) when issuing the command.
Query or set the option to block device reset using ATZ.
AT*DATZ? to query
AT*DATZ=n to set
•
n=0 — Off. Block is disabled—ATZ resets the device. (default)
•
n=1 — On. Block is enabled—ATZ does not reset the device.
Rev 2 Nov.15
345
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-9: Standard (Hayes) AT Commands (Continued)
Command Description
E
Toggle AT command echo mode.
ATE? to query
ATEn to set
•
n=0 — Echo Off; does not echo commands to the computer
•
n=1 — Echo On; echoes commands to the computer (so you can see what you type)
Note: Do not use an equal sign (=) when issuing the command.
H
HOR
ATH hangs up, immediately terminates the session (PAD or PPP).
Half-Open Response — In UDP auto answer (half-open) mode.
AT*HOR? to query
AT*HOR=n to set
•
n=0 — No response codes when UDP session is initiated
•
n=1 — RING CONNECT response codes sent out serial link before the data from the first UDP packet
Note: Quiet Mode must be Off.
Q
\Q
&S
Query or set AT quiet-mode. If quiet mode is set, there is no responses to AT commands except for data queried.
ATQ? to query
ATQn to set
•
n=0 — Off (default)
•
n=1 — Quiet-mode on
Note: Do not use an equal sign (=) when issuing the command.
Query or set the serial port flow control.
AT\Q? to query
AT\Qn to set
•
n=0 — No flow control
•
n=1 — Hardware flow control
•
n=4 — Transparent software flow control
Note: Do not use an equal sign (=) when issuing the command.
Query or set DSR.
AT&S? to query
AT&Sn to set
•
n=0—Always assert
•
n=1—Assert DSR while in data mode (UDP, TCP, PPP)
Note: Do not use an equal sign (=) when issuing the command.
346 4118127
AT Commands
Table C-9: Standard (Hayes) AT Commands (Continued)
Command Description
S0
Query or set TCP auto answer (the number of rings required before the device automatically answers a call).
ATS0? to query
ATS0n to set
•
n=0— Disable
•
n=1—Enable
Note: Do not use an equal sign (=) when issuing the command.
S23
Query or set the Serial port configuration
ATS23? to query
ATS23=[Baud,][Data bits, Parity, Stop Bits] to set
Baud:
•
300
•
1200
•
2400
•
4800
•
9600
•
19200
•
38400
•
57600
•
115200
Data bits:
•
7
•
8
Parity:
•
O=Odd
•
E=Even
•
N=None
•
M=Mark
Stop Bits:
•
1
•
1.5
•
2
Example:
ATS23=115200,8,N,2 (Sets the device to 115200, etc.)
The settings take effect after reboot.
Note: Must be 8 data bits for PPP mode.
Rev 2 Nov.15
347
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table C-9: Standard (Hayes) AT Commands (Continued)
Command Description
S211
S221
V
For applications or situations where hardware control of the DTR signal is not possible, the device can be configured to ignore DTR. When Ignore DTR is enabled, the device operates as if the DTR signal is always asserted.
ATS211? to query
ATS211=n to set
•
n=0—Use hardware DTR (default)
•
n=1—Ignore DTR
•
n=3—Ignore DTR and assert DSR.
Query or set the Connect Delay—the number of seconds to delay the connect response when establishing a TCP connection.
ATS211? to query
ATS211=n to set
•
n=0–255
Query or set the AT command responses (verbosity).
ATV? to query
ATVn to set
•
n=0 — Numeric (terse) command responses (The numeric responses follow the Hayes
Standards for commands.)
•
n=1 — Text string (verbose) command responses (default)
Note: Do not use an equal sign (=) when issuing the command.
&V
&W
X
Z
Lists most AT commands and their current values. If the parameter is not configured, the AT command returns “Not Set”.
Saves the settings for parameters that are temporarily set without being permanently written to the memory.
This command does not apply to ALEOS because once you issue an AT command or change a setting in ACEmanager and click Apply, the changes are saved in non-volatile memory and are persist across reboots.
Query or set the Extended Call Process Result mode
ATX? to query
ATXn to set
•
n=0 — No extended code (default)
•
n=1 — Adds the text 19200 to the connect response
Reboots the AirLink gateway.
Note: If *DATZ is set to 1, Z is blocked. See *DATZ on page 345.
348 4118127
AT Commands
I/O
Table C-10: Input / Output AT Commands
Command Description
*DIGITALIN1?
Query individual digital inputs. The digital inputs report either a 0 (open) or 1 (closed).
AT*DIGITALIN1?
•
Digital 1 is the on-board digital input.
*PULSECNT1?
*RELAYOUT1
Volts
-0.5 –1.2
0
Digital value
1.3 – 30 1
Query the I/O pulse counts for digital in.
AT*PULSECNT1?
Query or set the relay status.
AT*RELAYOUT1? to query
AT*RELAYOUT1=n to set
•
n=0—OFF
•
n=1—Drive Active Low
Rev 2 Nov.15
349
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Applications
Table C-11: Applications > Data Usage Commands
Command Description
*DATACURDAY?
Display data usage for the current day (in KB).
Example:
AT*DATACURDAY?
<value>
*DATAPLANUNITS
OK
Query or set the units for the data usage report.
AT*DATAPLANUNITS? to query
AT*DATAPLANUNITS=<unit> to set
•
<unit>=1—Sets the units to Megabytes (MB)
•
<unit>=2—Sets the units to Kilobytes (KB)
Examples:
AT*DATAPLANUNITS?
<unit>
*DATAPREVDAY?
*DATAUSAGEENABLE
OK
AT*DATAPLANUNITS=<units>
OK
Query the data usage for the previous day (in KB).
Example:
AT*DATAPREVDAY?
<value>
OK
Query or set enabling Data Usage.
AT*DATAUSAGEENABLE? to query
AT*DATAUSAGEENABLE=<status> to set
•
<status>=0—Data Usage disabled
•
<status>=1—Data Usage enabled
Example:
AT*DATAUSAGEENABLE?
<status>
OK
AT*DATAUSAGEENABLE=<status>
OK
350 4118127
AT Commands
Table C-12: Applications > ALEOS Application Framework (AAF)
Command Description
*AAFINSTALL
*AAFUNINSTALL
Query installed AAF applications and their status and install new AAF applications
•
AT*AAFINSTALL? returns the installation status of the last installed application, and list of installed AAF applications and the status of each application.
•
AT*AAFINSTALL?<application name> returns the status of the specified AAF application.
•
AT*AAFINSTALL=<hostname>,<user>,<password>,<application filename> downloads and installs the specified AAF application from the FTP server at
<hostname> using <user> <password> credentials.
Install an AAF application
AT*AAFUNINSTALL=<application name> uninstalls the specified AAF application.
Admin
Table 3-13: Admin > Advanced Commands
Command
*BLOCK_RESET_CONFIG
Description
Query or set the ability to block resetting the device to factory default settings using the hardware Reset button.
AT*BLOCK_RESET_CONFIG? to query
AT*BLOCK_RESET_CONFIG=n to set
•
n=0—Reset button can be used to reset the device to factory default settings.
(default).
•
n=1—Device cannot be reset to factory default settings using the Reset button on the device.
Note: This command only blocks the ability to reset to defaults using the Reset button on the device. You can still reset the device to the factory default settings using the “Reset to Factory Default” button in ACEmanager or the
AT command.
*BOARDTEMP?
*DATE?
*MSCIUPADDR
Query the temperature of the internal hardware, in degrees Celsius.
Query the internal clock. The date and time are always specified in a 24-hour notation.
AT*DATE? to query
Query or set the IP address or FQDN and port that periodic device status updates are sent to.
AT*MSCIUPADDR[IP address or FQDN][/port]? to query
AT*MSCIUPADDR=[IP address or FQDN][/port] to set
Examples: 192.168.14.100/3333
MyDevice.com/3333
Rev 2 Nov.15
351
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table 3-13: Admin > Advanced Commands (Continued)
Command Description
*MSCIUPDPERIOD
NSLOOKUP
Query or set the device status update interval (in seconds). Thsi specifies how frequently the device status update is sent to the port configured in
AT*MSCIUPDPERIOD? to query
AT*MSCIUPDPERIOD=n to set
•
n=0 — Disabled
•
n=1–255 seconds
Immediately performs an NSLookup on the supplied FQDN.
ATNSLOOKUP=[FQDN]
*POWERIN?
*RESETCFG
Query the voltage input to the internal hardware.
AT*RESTCFG resets the device to factory default settings.
Important:
There is no confirmation requested. The AT command takes effect immediately.
*REMOTELOG
*SECUREMODE
Exports the log file to a remote destination (Syslog Server). Specifying the port is option. If the port is not specified, the default port, 514, is used.
You can only use this command locally.
AT*REMOTELOG=SYSLOG SERVER IP,PORT
Query or set the secure mode that blocks most ports (and ICMP) for over-the-air
(OTA) or OTA and local to prevent unwanted access to the device.
AT*SECUREMODE? to query
AT*SECUREMODE=n to set
•
n=0 Off; normal behavior
•
n=1 Disables:
•
Web management ports (ACEmanager and ALMS access) from the OTA interface
•
Internet Control Message Protocol (ICMP), used for PING, for OTA and
Wi-Fi
•
n=2 Disables:
•
Web management ports from the Over-the-air (OTA) interface
•
Internet Control Message Protocol (ICMP) for OTA and Wi-Fi
•
ICMP for local ports (Ethernet, USB, and Serial)
Note: Telnet and SSH ALEOS ports remain open regardless of the secure mode setting. This enables you to connect an AT console to manage the device. DHCP and DNS ports also remain open to allow the device to provide IP addresses to hosts and relay the DNS service.
352 4118127
AT Commands
Table 3-13: Admin > Advanced Commands (Continued)
Command Description
*SYSRESETS?
*USBBYPASS
Query the number of resets since the device was reset to factory default settings.
Query or set Radio Passthru mode.
AT*USBBYPASS? to query
AT*USBBYPASS=n to set
•
n=0—Disable
•
n=1—Enable
Rev 2 Nov.15
353
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
354 4118127
D: SMS Commands
SMS mode
Password Only
Control Only
Gateway Only
Control and Gateway
SMS Command format
PW [Password] [Prefix][Command or Command parameter1]
[Command parameter2 (if applicable)] [Command parameter n]
Note: There is no space between the prefix and the command (or the 1st command parameter in the case of multi-parameter commands). There must be a single space between all other fields to act as a delimiter.
The default password is the last 4 digits of the SIM ID number (for
SIM-based devices) and the last 4 digits of the ESN (for non-SIM devices). If you do not know the SIM ID or ESN number, you can find it in ACEmanager on the Status > WAN/Cellular page.
The default prefix is “&&&”.
Whether or not a password and prefix are required varies depending on the SMS mode selected in ACEmanager.
Password
(configurable in all modes)
Always required
Required when sending from a non-trusted phone number
Always required
Required when sending from a non-trusted phone number
Prefix
Required
Use default (not configurable)
Prefix is configurable.
The prefix can be omitted if the ALEOS
Command Prefix field in ACEmanager
(Services > SMS) is configured to be blank.
Required
Use default (not configurable)
Required
Configurable, but cannot be blank
When an SMS command is received, the AirLink gateway performs the action requested and sends a response back to the phone number from which it received the SMS.
For more examples and detailed instructions, see
D
Rev 2 Nov.15
355
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Command
List of SMS Commands
Action Result
Note: Some responses start with “reply from [device name]:” However, this feature is currently unavailable for the
Enable, and Provision commands.
[prefix]enable <value>
[prefix]status
[prefix]reset
Enable/disable the device(s) being managed by ALMS.
“AVMS enable set to status:” <value>
<value>=0 Disable
<value>=1 Enable
None
Resets the device 30 seconds after the first response message is sent.
status IP
[Network IP] [Network Status]:
[technology type] RSS signalled
Lat = [Latitude]
Long = [Longitude]
Time = [hh:mm:ss]
First message: Reset in 30 seconds
Second message: Status message when back up.
[prefix]relay x y
Sets the applicable relay to the desired setting.
relay x set to y x can be 1 y can be 0 or 1 (Off or Drive active low)
[prefix]Provision <APN> <Network
User ID> <Network Password>
<Network Authentication Mode>
Note: You can omit any of the above parameters.
•
To omit a parameter before the one you want to change, use a period (.) in place of the omitted parameter.
Example: &&&provision . [email protected] . chap changes only the user ID and authentication mode.
•
If you want to omit any parameters after the one you want to change, simply omit them.
Example: &&&provision access.apn changes only the apn.
After the unit is installed and the SIM card inserted, you can use this command to provision the account.
Network Authentication
Mode is optional. If used, enter one of the following:
•
None
•
PAP
•
CHAP
These are not case sensitive.
If an unknown mode is entered or the field is omitted, None is used.
“provision”
“apn:” <APN>
“user ID” <Network User ID>
“PW” <Network Password>
“auth mode” <Network Authentication Mode>
Note: If a parameter is omitted, the response displays “Not Set” for that parameter.
Note: Use of this command is valid for
LTE, HSPA, and GPRS networks, but not valid for CDMA only networks.
356 4118127
SMS Commands
Command Action
[prefix]AVMS <server> <interval>
Note: All of the above must be on a single line. The interval must be greater than 0.
Omitting any field results in a response of
“not set” and the configuration parameter does not change.
Modifies the ALMS server’s
URL and ALMS communication period
(interval in minutes)
Result
“AVMS”
“srv:” <Server>
“interval:” <Interval>
[prefix]AVMSCHECKIN
Prompts the device to communicate with the ALMS server. Once AirLink
Management Service receives the heartbeat message, it can respond and send an MSCI command to the device (i.e Write/Read/
Firmware Update).
“AVMS connection requested”
Rev 2 Nov.15
357
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
358 4118127
E: Q & A and Troubleshooting
ACEmanager Web UI
The ACEmanager page is not displaying properly.
1.
Ensure the you are using a supported browser. See page 15 for a
list of supported browsers.
2.
Hold the Shift key + click the Refresh button. This reloads the page, while ignoring what is in the cache.
If the problem persists:
•
Clear the cache. (The procedure varies, depending on the browser.)
•
Restart the browser.
•
Restart your computer.
E
Templates
The template does not upload properly when I use Internet
Explorer 9.
To resolve the problem:
1.
In Internet Explorer 9, go to Tools > Internet Options.
2.
Select the Security tab.
Rev 2 Nov.15
Figure E-1: Internet Explorer 9: Tools > Internet Options > Security tab
359
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
3.
Click Custom level....
4.
Scroll down until you see “Include local directory path when uploading files to a server”.
5.
Select Disable.
360
Figure E-2: Internet Explorer 9: Security Settings
6.
Click OK.
Updating the ALEOS Software and Radio
Module Firmware
I am unable to update the ALEOS software and radio module firmware using ACEmanager.
If you are having trouble updating the ALEOS software or radio module firmware, especially if you are updating from an older version of ALEOS:
1.
Try using a different browser. (ACEmanager supports the latest versions of
Internet Explorer and Firefox.)
2.
Delete the browser cookies/cache before logging into ACEmanager. (The
Web browser short-cut is Control + Shift + Delete.)
3.
Backup your device settings by downloading and saving the template. See
Saving a Custom Configuration as a Template on page 17.
4.
Reset the device to factory default settings. (See
Reset to Factory Default on page 248 or press and hold the reset button on the device for 7 to 10
seconds.)
5.
If you are updating from ALEOS 4.3.3 or earlier, be sure to follow the correct software update path. For more information, refer to the Upgrading to ALEOS
4.3.4 from Older Versions Application Note (part number 4115254) available on source.sierrawireless.com.
4118127
Q & A and Troubleshooting
6.
Begin the update process (see
Update the ALEOS Software and Radio
Module Firmware on page 32) and follow the prompts.
7.
If after 30 minutes the Web UI is frozen, log in using a different browser and confirm whether or not the ALEOS software and radio module firmware has been updated correctly.
8.
If you are still having problems, contact your Sierra Wireless distributor.
When I try to update ALEOS using ACEmanager, I see the following message: “... Check that your package is compatible with the device”.
Rev 2 Nov.15
This message also appears if you are only updating the radio module firmware and you have the Update ALEOS radio button selected.
To correct the problem:
1.
Close the Update page.
2.
Retry the radio firmware update, being careful to select the Radio Module
Firmware that is appropriate for your gateway.
When I try to update ALEOS using ACEmanager, I see the following message: “Please select a firmware for xxxx”.
This message appears and you are blocked from continuing with the update if you are only updating the radio module and you select a radio module firmware file designed for a different radio module.
To correct the problem:
1.
Click OK.
361
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
362
2.
Select a radio module firmware file for the radio module in the AirLink gateway you are updating and click update. (To check which radio module is in your device, in ACEmanager, go to Status > About.)
Poor Wireless Network Connection
ACE manager indicates that my AirLink gateway has a poor wireless connection. What can I do to improve it?
For GSM or CDMA networks:
1.
Check the RSSI value. If ACEmanager (Status screen) indicates a good RSSI value, go to step
2 . If it indicates a poor RSSI value:
· Check the antenna connection.
· Make sure you have the correct antenna for the device.
· You may be in an area with poor coverage. Check with your Mobile Network
Operator, or if possible, try moving the AirLink gateway to a new location.
2.
Check the Ec/Io value. If ACEmanager (Status screen) indicates a poor Ec/Io value:
· This may be a temporary network problem caused by local interference.
· A nearby laptop or other electronic equipment may be interfering with the signal. Try moving the AirLink gateway to a different location.
For LTE networks:
1.
Check the RSSI value. If ACEmanager (Status screen) indicates a good RSSI value, go to step
2 . If it indicates a poor RSSI value:
· Check the antenna connection.
· Make sure you have the correct antenna for the device.
· Try moving the AirLink gateway to a different location.
2.
Check the RSRP value. If ACEmanager (Status screen) indicates a good
RSRP value, go to step 3 . If it indicates a poor RSRP value:
· This may be a temporary network problem caused by local interference.
· Check the antenna connection.
· Make sure you have the correct antenna for the device.
· You may be in an area with poor coverage. Check with your Mobile Network
Operator, or if possible, try moving the AirLink gateway to a new location.
3.
Check the RSRQ value. If ACEmanager (Status screen) indicates a poor
RSRQ value:
· A nearby laptop or other electronic equipment may be interfering with the signal. Try moving the AirLink gateway to a different location.
Connection not working
My gateway appears to be connected to the host, but no data is being transferred.
1.
Check to see if MAC filtering is enabled (Security > MAC Filtering).
2.
If MAC filtering is enabled:
•
Ensure that the MAC Address for the host in question is on the Allowed List.
4118127
Rev 2 Nov.15
Q & A and Troubleshooting
•
Ensure that there are no typos in the MAC Address.
Or
•
If it is not required, disable MAC Filtering and reboot the device.
My host device is unable to connect to the Internet, even when there is good mobile network coverage and ALEOS can Ping an external IP address.
1.
Check the DNS proxy setting described on page 106 .
You may need to change this setting to Disable so that all connected devices acquire the Mobile Network Operator-defined DNS server as the first DNS server. The AirLink gateway is not used as the DNS resolver.
LTE Networks
How do I interpret the number shown in the Band Class field on the
Status > WAN Cellular page for a device on an LTE network?
Use the following table to interpret the values in the LTE Band Class field in
ACEmanager (STATUS > WAN Cellular).
Band Class number
Uplink frequency range
(MHz)
120 1920–1980
Downlink frequency range
(MHz)
2110–2170
121
122
123
124
1850–1910
1710–1785
1710–1755
824–849
1930–1990
1805–1880
2110–2155
869–894
129
130
131
132
125
126
127
128
133
134–135
136
137
830–840
2500–2570
880–915
1749.9–1784.9
1710–1770
1427.9–1452.9
698–716
777–787
788–798
Reserved for bands 15 and 16
704–716
815–830
875–885
2620–2690
925– 960
1844.9–1879.9
2110–2170
1475.9–1500.9
728–746
746–756
758–768
734–746
860–875
363
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Band Class number
Uplink frequency range
(MHz)
138 830–845
Downlink frequency range
(MHz)
875–890
139
140
141–151
152
832–862
1447.9–1462.9
Reserved for bands 22 to 32
1900–1920
791–821
1495.9–1510.9
1900–1920
153
154
155
156
157
158
159
2010–2025
1850–1910
1930–1990
1910–1930
2570–2620
1880–1920
2300–2400
2010–2025
1850–1910
1930–1990
1910–1930
2570–2620
1880–1920
2300–2400
How do I obtain and interpret SINR values for LTE networks?
You can use the AT*CELLINFO? command to obtain an SINR (Signal to
Interference plus Noise Ratio) value. (See *CELLINFO2?
The values vary depending on the network characteristics and the AirLink gateway, but in general, a positive value provides usable throughput. The following table provides guidelines for interpreting SINR values.
SINR Value
<
0
0 to 5
6 to 10
> 10
Poor
Fair
Good
Excellent
Throughput
If the SINR value indicates poor throughput:
•
Move the antenna away from noisy equipment.
•
Move closer to the nearest cell tower line of sight, or further away from the interfering cell tower.
SIM Card is Blocked
My SIM card has a PIN number. I’ve entered the wrong PIN several times and now the SIM card is blocked.
364 4118127
Rev 2 Nov.15
Q & A and Troubleshooting
AirLink products do not support Personal Unlocking Key (PUK) entry. However, if you need to unblock the SIM card:
1.
Contact your Mobile Network Operator to obtain the PUK.
2.
Remove the SIM card from the AirLink gateway and insert it in a cell phone that accommodates a MiniSIM (2FF) card.
3.
Enter the PUK to unblock the SIM card and then return the SIM card to the
AirLink gateway.
Note: Be careful when entering the PUK. You have a limited number of attempts to enter the correct PUK (generally 10) before the SIM card is permanently disabled and a new SIM card is required. If the PUK does not unblock the SIM card after the first few attempts, contact your Mobile Network Operator.
Remote connections
I cannot connect to the AirLink gateway remotely over the Mobile
Network Operator’s Private Network via the Web UI, although I can connect to it locally.
Some Mobile Network Operators' private networks have restrictions on the maximum transmission unit (MTU) size. This is more prevalent with LTE networks.
Possible solutions:
•
Use your Mobile Network Operator’s public network.
•
Ask your Mobile Network Operator to reduce the MTU size on the router or other equipment at their end of the private network. Setting the MTU value below 1500 bytes (for example 1326 bytes) has resolved the problem on some private networks.
Radio Band Selection
I set the radio band in the UI (WAN/Cellular > Setting the Band) or by using the AT!BAND AT command, but after I reboot the band setting reverts to its former value.
For some SIM cards, you need to set the band before inserting the SIM card.
To resolve this problem:
1.
Remove the SIM card.
2.
Set the band to the desired value.
3.
Reboot the device.
4.
Insert the SIM card.
365
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Reliable Static Routing (RSR)
I launched ACEmanager with Internet Explorer 9. I configured RSR, but after I enabled RSR and clicked Apply, all the values reverted to the defaults.
There is a known issue. If you configure and enable RSR with ACEmanager in
Internet Explorer 9, and then click Apply, the values in the ACEmanager screen appear as default values.
This is an ACEmanager display issue only. The configuration is applied properly, but the configured values are not displayed. Click Refresh to view the configured values.
Inbound Ports Used by ALEOS
When I configure ports for an application on a LAN client such as a router or laptop, I want to ensure that the ports I use do not conflict with the inbound ports that ALEOS uses. Which ports does ALEOS use?
Table E-1 shows the inbound ports that are set in ALEOS and cannot be configured. Table E-2
show the default setting for ports you can configure and where to change the ports in ACEmanager.
Table E-1: ALEOS Non-configurable Inbound Ports
Port Use
Used internally for GPS and Events Reports 9494 – 9497
17335
17345 – 17353
21000 – 21003
500
4500
8088
Used internally for IPSec VPN
Used internally for ALMS
366
Table E-2: ALEOS Configurable Inbound Ports
Default
Port
Feature ACEmanager location
161
2332
9191
9300
SNMP Port
SSH/Telnet Remote Login Server Port
ACEmanager Port
SSL tunnel Port
Services > Management (SNMP)
Services > Telnet/SSH
Services > ACEmanager
VPN > SSL Tunnel
4118127
Q & A and Troubleshooting
Table E-2: ALEOS Configurable Inbound Ports
Default
Port
Feature ACEmanager location
9443
9494
12345
ACEmanager SSL Port
GPS Poll Port
Device Port used for incoming TCP/
UDP traffic
Services > ACEmanager
GPS > Global Settings
Serial > Port Configuration
Setting for Band
The options available in the WAN/Cellular > WAN/Cellular Setting for Band field depend on your region or your Mobile Network Operator. (To check your Mobile
Network Operator, in ACEmanager, go to Status > About > Radio Module
Identifier field.) Check the appropriate table for a list of options that apply to your device:
United States of America:
AT&T
Verizon Wireless
Sprint
Generic North America
All North American Mobile Network
Operators not listed above
International
AT&T
Table E-3: Setting for Band — AT&T
Setting for Band Option Technology
All Bands 2G
3G UMTS
(DC Included)
4G LTE - FDD
Bands available
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B6 (800 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B17 (700 MHz)
Rev 2 Nov.15
367
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table E-3: Setting for Band — AT&T
Setting for Band Option Technology
Europe 3G
North America 3G
3G UMTS
(DC Included)
3G UMTS
(DC Included)
Europe 2G 2G
North America 2G
GSM ALL
2G
2G
Europe
North America
WCDMA ALL
LTE ALL
2G
3G UMTS
(DC Included)
2G
3G UMTS
(DC Included)
4G LTE - FDD
3G UMTS
(DC Included)
4G LTE - FDD
Bands available
B1 (2100 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B6 (800 MHz)
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM 850
GSM PCS 1900
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
B1 (2000 MHz)
B8 (900 MHz)
GSM 850
GSM PCS 1900
B2 (1900 MHz)
B5 (850 MHz)
B6 (800 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B17 (700 MHz)
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B6 (800 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B17 (700 MHz)
368 4118127
Q & A and Troubleshooting
Verizon Wireless
Table E-4: Setting for Band — Verizon Wireless
Setting for Band Option Technology
All Bands CDMA
2G
North America
North America 3G
North America 4G
World Mode
3G UMTS
(DC Included)
4G LTE - FDD
CDMA
4G LTE - FDD
CDMA
4G LTE - FDD
CDMA
2G
3G UMTS
(DC Included)
4G LTE - FDD
Bands available
BC0 (800 MHz)
BC1 (1900 MHz)
GSM 850
GSM EGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
B4 (AWS 1700 MHz)
B13 (700 MHz)
BC0 (800 MHz)
BC1 (1900 MHz)
B4 (AWS 1700 MHz)
B13 (700 MHz)
BC0 (800 MHz)
BC1 (1900 MHz)
B4 (AWS 1700 MHz)
B13 (700 MHz)
BC0 (800 MHz)
BC1 (1900 MHz)
GSM 850
GSM EGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
B4 (AWS 1700 MHz)
B13 (700 MHz)
Rev 2 Nov.15
369
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Sprint
Table E-5: Setting for Band — Sprint
Setting for Band Option Technology
Automatic CDMA
LTE Only
CDMA Only
GSM Only
2G
3G UMTS
(DC Included)
4G LTE - FDD
4G LTE - FDD
CDMA
2G
3G UMTS
(DC Included)
Bands available
BC0 (800 MHz)
BC1 (1900 MHz)
BC10 (1900 MHz)
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
B25 (1900 MHz G Block)
B25 (1900 MHz G Block)
BC0 (800 MHz)
BC1 (1900 MHz)
BC10 (1900 MHz)
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
370 4118127
Q & A and Troubleshooting
Generic North America
Table E-6: Setting for Band — Generic North America
Setting for Band Option Technology
All Bands CDMA
2G
Bands available
BC0 (800 MHz)
BC1 (1900 MHz)
BC10 (1900 MHz)
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
3G UMTS
(DC Included)
Europe 3G
North America 3G
Europe 2G
North America 2G
GSM ALL
Europe
4G LTE - FDD
3G UMTS
(DC Included)
3G UMTS
(DC Included)
2G
2G
2G
2G
3G UMTS
(DC Included)
B1 (2000 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B13 (700 MHz)
B17 (700 MHz)
B25 (1900 MHz G Block)
B1 (2100 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B5 (850 MHz)
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM 850
GSM PCS 1900
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
B1 (2000 MHz)
B8 (900 MHz)
Rev 2 Nov.15
371
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Table E-6: Setting for Band — Generic North America
Setting for Band Option Technology
North America CDMA
Bands available
BC0 (800 MHz)
BC1 (1900 MHz)
2G
WCDMA ALL
LTE ALL
CDMA ALL
3G UMTS
(DC Included)
4G LTE - FDD
3G UMTS
(DC Included)
4G LTE - FDD
CDMA
GSM 850
GSM PCS 1900
B2 (1900 MHz)
B5 (850 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B13 (700 MHz)
B17 (700 MHz)
B1 (2000 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B8 (900 MHz)
B2 (1900 MHz)
B4 (AWS 1700 MHz)
B5 (850 MHz)
B13 (700 MHz)
B17 (700 MHz)
B25 (1900 MHz G Block)
BC0 (800 MHz)
BC1 (1900 MHz)
BC10 (1900 MHz)
International
Table E-7: Setting for Band — International
Setting for Band Option Technology
All Bands 2G
Europe 3G
3G UMTS
(DC Included)
4G LTE - FDD
3G UMTS
(DC Included)
Bands available
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
B1 (2100 MHz)
B3 (1800 MHz)
B7 (2600 MHz)
B8 (900 MHz)
B20 (800 MHz)
B1 (2100 MHz)
B8 (900 MHz)
372 4118127
Q & A and Troubleshooting
Table E-7: Setting for Band — International
Setting for Band Option Technology
North America 3G
Europe 2G
3G UMTS
(DC Included)
2G
North America 2G
GSM ALL
Europe
North America
WCDMA ALL
LTE ALL
2G
2G
2G
3G UMTS
(DC Included)
4G LTE - FDD
2G
3G UMTS
(DC Included)
3G UMTS
(DC Included)
4G LTE - FDD
B1 (2100 MHz)
B3 (1800 MHz)
B7 (2600 MHz)
B8 (900 MHz)
B20 (800 MHz)
GSM 850
GSM PCS 1900
B2 (1900 MHz)
B5 (850 MHz)
B1 (2000 MHz)
B2 (1900 MHz)
B5 (850 MHz)
B8 (900 MHz)
B1 (2100 MHz)
B3 (1800 MHz)
B7 (2600 MHz)
B8 (900 MHz)
B20 (800 MHz)
Bands available
B2 (1900 MHz)
B5 (850 MHz)
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM 850
GSM PCS 1900
GSM 850
GSM EGSM 900
GSM PGSM 900
GSM DCS 1800
GSM PCS 1900
GSM EGSM 900
GSM PGSM 900
B1 (2000 MHz)
B8 (900 MHz)
Ethernet Ports
What do the LEDs above the Ethernet port mean?
There are two LEDs at the top of the Ethernet port. The green on is lit when there is a cable connected to the host and the connection is running at 100baseT. The amber (activity) LED blinks when traffic is passing through the port.
Rev 2 Nov.15
373
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
LAN Networks
The server on my LAN network is receiving data from some hosts on the network, but not others. What’s wrong?
If you have a network with multiple LAN devices that are sending data to the same server and the server is not receiving data from one (or more) of the devices, it may be because the Mobile Network Operator has a WAN firewall that is blocking the ports used by the NAT for over-the-air (OTA) destinations.
To correct this problem:
1.
Launch ACEmanager.
2.
Go to the LAN tab.
3.
Select Ethernet.
4.
Refer to the instructions for setting the Starting Ephemeral Port on page 100.)
VPN
My VPN connection is not working. When I try to debug it using the logs on the Admin page, VPN information does not show up in the log.
VPN information is collected in the Linux logs. To view this information:
1.
Log into ACEmanager as User and go to Admin > Log.
374 4118127
Q & A and Troubleshooting
Rev 2 Nov.15
2.
In the drop-down menu beside Linux Syslog, ensure that Display is selected.
If you change the setting:
a.
Click Apply.
b. Reboot the device.
3.
Click View Log.
4.
On the View Log page, click Clear and then click Refresh.
VPN Troubleshooting
If you see the following lines in the log, it means the VPN Server is not answering.
notice openvpn[9199]: [UNDEF] Inactivity timeout (--ping-restart), restarting notice openvpn[9199]: TCP/UDP: Closing socket
Check the VPN Server status.
When I configure a VPN, my Internet connection stops working.
When you configure a VPN, outgoing traffic from the host to the public Internet is blocked by default, as a security measure. If you want to enable public Internet traffic from the host:
1.
In ACEmanager, go to VPN > Split Tunnel.
2.
Change the Outgoing Host Out of Band field to Allowed.
3.
Click Apply.
375
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Port Forwarding
I set up port forwarding rules. I did not receive an error message, but it seems that data is not being forwarded.
If the Public Start Port and Public End Port fields are not set up correctly, data is not forwarded.
1.
In ACEmanager, go to Security > Port Forwarding.
•
If you are forwarding data to a single port:
· Ensure that the value in the Public Start Port field is not 0.
· Ensure that the value in the Public End Port field is 0.
· Ensure that the value in the Private Port start field is not 0.
•
If you are forwarding data to a range of ports:
1.
Ensure that the value in the Public Start Port field is not 0.
· Ensure that the value in the Public End Port field is greater than the value in
Public Start Port field.
· Ensure that the value in the Private Port Start field is not 0.
For complete instructions, see
SMS
I tried to send an SMS message, and received an error code. What does the error code mean?
201
202
203
204
The following acknowledgment error codes may appear if your message was not successfully sent:
Code: Explanation:
100 Not in coverage (no cellular service)
Parse Error on field #1 (Start Field)
Parse Error on field #2 (Phone number and separator)
Parse Error on field #3 (Data type and separator)
Parse Error on field #4 (Payload length and separator)
205
301
Parse Error on field #5 (Message and End Field)
No buffers available
302 SMS queue full
Supported SMS data types are ASCII, 8-bit, and Unicode, and are all casesensitive. SMS messages being sent MUST be in ASCII hex format.
I tried to send an SMS command and received the error “not set”.
The parameter was not changed.
376 4118127
Q & A and Troubleshooting
Check the format of the SMS command. There should be no space between the prefix and the command (or the 1st command parameter in the case of multiparameter commands), and a single space between all other fields to act as a
delimiter. For more information, see SMS Commands on page 355 and
AirLink Management Service
I don’t understand the message that appears in the Status field in the
Services > ALMS page.
The error messages in the Services > ALMS > Status field can be due to a communication failure, a problem with the ALMS server, or a failure when parsing a valid ALMS server response. The following table describes the error messages and the corrective action.
Error message Meaning Corrective action
Communication Failure Errors
[HTTP] Initialization error The transfer object could not be initialized.
[HTTP] Unsupported protocol The ALMS server URL protocol is not supported.
[HTTP] Failed initialization
[HTTP] URL using bad/illegal format or missing URL
[HTTP] Couldn't resolve host name
Contact ALMS support a
.
In ACEmanager, check the ALMS URL in the
Service > ALMS > Server URL field. The default value is https://na.m2mop.net/device/msci/com .
Contact ALMS support a
.
The transfer library could not be initialized.
The ALMS server URL is missing or not properly formatted.
In ACEmanager, check the ALMS URL in the
Service > ALMS > Server URL field. The default value is https://na.m2mop.net/device/msci/com .
The ALMS server URL could not be resolved.
In ACEmanager, check the ALMS URL in the
Service > ALMS > Server URL field. The default value is https://na.m2mop.net/device/msci/com .
Also check the cellular connectivity.
[HTTP] Couldn't connect to server
[HTTP] Timeout was reached
Connection to the ALMS server
URL failed.
The transfer timeout (equal to the communication period if defined or
5 minutes) expired.
In ACEmanager, check the ALMS URL in the
Service > ALMS > Server URL field. The default value is https://na.m2mop.net/device/msci/com .
Also check the cellular connectivity.
Check cellular connectivity.
Check cellular connectivity.
[HTTP] Server returned nothing
(no headers, no data)
No data was received from the
ALMS server.
[HTTP] Unrecognized or bad
HTTP Content or Transfer-
Encoding
The ALMS server HTTP response contains a malformed content or transfer-encoding header field.
[HTTP] Out of memory A memory allocation problem occurred.
Contact ALMS support
Contact ALMS support a a
.
.
Rev 2 Nov.15
377
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Error message
[HTTP] SSL peer certificate or
SSH remote key was not OK
Meaning
This message appears if you are using an HTTPS server URL, the
SSL Verify Peer Certificate field is
set to Enable, and the server SSL certificate validation fails. If this happens, communication with the
ALMS server is terminated.
Corrective action
If you see this error message:
1.
Check to see that you have a valid URL in the Server URL field.
2.
In ACEmanager, go to Admin > Advanced and check the Date and Time field to confirm that the values are correct.
b
The SSL certificates have a start and end date. If the device has a date and time outside of this interval, the certification check will fail.
3.
Contact your IT Administrator, or if you want the traffic to go through without verifying the server certificate, change the setting in the
Services > ALMS > SSL Verify Peer Certificate field (described on page 151
) to
Disable.
ALMS Server Errors
[AVMS] HTTP error '500' ALMS server reported error 500 in the HTTP response.
Refer to the available ALMS server documentation for a list of all possible error codes and their significance.
Error message indicating a failure when parsing a valid ALMS server response
XML processing error The content of a valid ALMS server response cannot be parsed.
ALMS server responses are malformatted.
Contact ALMS support a
.
a.
ALMS technical support: https://issues.m2mop.net
b.
If the values are not correct and the device is not receiving date and time from the Mobile Network Operator or GPS, go to Services > Time (SNTP), and enable time update. For the SNTP Server, use the same service as the authenticating server.
When I try to update the radio module using ALMS, I receive an error message.
The following table provides a brief explanation of the firmware update error messages.
Error message
Cannot Install Firmware
Link not up in 3 minutes...Exiting
Meaning Corrective action
The system has encountered errors from which it cannot recover and requires at least a reboot before trying to update again.
1.
Reboot the device.
2.
If the problem persists, press the reset button for 7–10 seconds to reset the device to the factory default settings (release the reset button when all four LEDs turn from red to yellow) and try again.
3.
If it still does not work, contact
ALMS support a
.
The radio module was not able to establish the connection in 3 minutes. The update has been aborted, but can be relaunched as soon as the connection is OK.
Wait for network connectivity and then try again.
378 4118127
Q & A and Troubleshooting
Error message Meaning
Unable to download JUD file from <url>
The URL is wrong, or the download failed
(interruption, no space left...).
Corrective action
Contact ALMS support a
.
Core version not found in
JUD file
JUD file is not valid. Core Version is a mandatory field.
There is a problem with the package on the ALMS server. Contact ALMS support a
.
Required information (URL,
Size or MD5) is missing from
JUD file
Cannot perform upgrade —
No space left on device
JUD file is not valid. URL, Size, and MD5 sum of the firmware package are mandatory fields.
Firmware is larger than available space for the download.
There is a problem with the package on the ALMS server. Contact ALMS support a
.
Contact ALMS support a
. The support team will need to access the device to clear space, or you can return the device to Sierra Wireless under an
RMA.
Unable to download ALEOS firmware from <url>
Firmware URL is not valid, or the download failed.
Undefined ALEOS firmware
URL
ALEOS firmware MD5 check failed
ALEOS firmware URL not specified, so firmware cannot be retrieved.
The downloaded firmware package failed the integrity check. The update is aborted.
Retry. If the download fails several times, contact ALMS support a
. The support team will need a log from the device.
Contact ALMS support a
to confirm that there is not a problem with the service.
There is a problem with the package on the device or the download may have failed. Restart the firmware download. If the problem persists, contact ALMS support a
. There may be a problem with the package on the ALMS server.
Unable to apply ALEOS firmware and Unable to apply
ALEOS firmware (retry)
ALEOS firmware could not be applied. Check the ALEOS log messages to determine exactly why the update failed.
Retry. If the problem persists, contact
ALMS support a
and provide them with the log messages.
Radio Module URL is missing from JUD file
JUD file is not valid. The Radio Module
Firmware URL is a mandatory field.
There is a problem with the package on the ALMS server. Contact ALMS support a
.
Radio Module package MD5 sum is missing from JUD file
JUD file is not valid. The Radio Module
Firmware MD5 sum is a mandatory field.
There is a problem with the package on the ALMS server. Contact ALMS support a
.
Radio Module firmware MD5 check failed
The downloaded firmware package failed the integrity check. The update is aborted.
Radio Module backup failed The radio module was saved to prevent a power failure. If the firmware cannot be backed-up on persistent storage, the firmware update will not proceed because of the risk that the radio module update will not be able to finish if interrupted.
There is a problem with the package on the device or the download may have failed. Try downloading the file again. If the problem persists, contact ALMS support a
. There may be a problem with the package on the ALMS server.
Contact ALMS support a
. The support team will need to access the device to clear space, or you can return the device to Sierra Wireless under an
RMA.
Rev 2 Nov.15
379
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Error message
Radio Module firmware download failed
Meaning Corrective action
Firmware URL is not valid, or download failed.
Retry several times. If the problem persists, contact ALMS support a
. The support team will need a log from the device.
The URL cannot be retrieved. The update is aborted.
Retry. If the problem persists, contact
ALMS support a
.
Undefined Radio Module firmware URL
Radio Module firmware update failed
Radio module firmware could not be applied.
Check the ALEOS log messages to determine exactly why the update failed.
Retry. If the problem persists, contact
ALMS support a
.
a.
ALMS technical support: https://issues.m2mop.net
Event Reporting
I set up ACEmanager to send an email/SMS report, but when I clicked the Test report button no report was sent.
After you set up the event reporting fields and click Apply, wait about a minute before you click the Test report button. The AirLink gateway needs this time to apply the new configuration.
•
I configured event reporting, but I did not receive a report when I should have.
•
If the Action Type for the Event Reporting is Email or SNMP TRAP, be sure that these services are also configured on the Services tab.
· To configure email, go to Services > Email (SMTP).
· To configure SNMP TRAP, go the Services > Management (SNMP).
TCP/IP and UDP/IP Auto Answer
I configured TCP/UDP auto answer, but the packet contents are not being streamed over the serial port to the connected device.
1.
Try polling the device connected to the AirLink gateway’s serial port.
2.
In ACEmanager, go to Status > Serial and check the Serial bytes sent field to confirm that packets are reaching the AirLink gateway from the mobile network and the packet contents are being sent out the AirLink gateway’s serial port.
380 4118127
Q & A and Troubleshooting
Rev 2 Nov.15
Figure 5-3: ACEmanager > Status > Serial
When you poll the AirLink gateway/connected device:
•
If the Serial bytes sent counter increases, the IP packets have reached the
AirLink gateway from the mobile network, the AirLink gateway has removed the header and sent the packet contents out its serial port to the connected device.
•
If the Serial bytes sent counter does not increase, either:
· The IP packet has not made it across the mobile network to the AirLink gateway.
· The destination port for the TCP/IP or UDP/IP connection does not match the configured Device Port on the ACEmanager Serial tab.
3.
Once you have confirmed that the Serial bytes sent counter is increasing, check the Serial bytes received counter (also on the Status > Serial screen).
· If the Serial bytes received counter is increasing, the connected device is responding to the poll request and sending its response back to the AirLink gateway across the serial connection.
· If the Serial bytes received counter is not increasing, the connected device is not responding to the poll request. Ensure that the serial cable is fully seated and properly connected to the AirLink gateway and the host. Check that you have the correct type of serial cable connecting the AirLink gateway to the connected device. The AirLink gateway is a DCE device. If the connected device is also a DCE device, use a null modem serial cable.
If the connected device is a DTE device, use a straight through serial cable.
4.
If you have confirmed that both the Serial bytes sent and Serial bytes received counters are increasing when you send a poll to the connected device, but you are still not receiving the response back on your original sending application, the most common reason is that the incoming packets from the AirLink gateway to your application are being blocked by a firewall on your network. The firewall may be blocking all traffic except packets destined for particular ports or arriving from particular ports.
Check with your firewall administrator. Ask the administrator to monitor the firewall when you poll the AirLink/connected device to see if any return packets from the AirLink gateway hit the firewall.
381
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
If you are still having problems, contact your Sierra Wireless distributor.
ALEOS Application Framework (AAF)
I’m unable to load an application from AAF.
1.
In ACEmanager, go to Services > Telnet/SSH.
2.
In the AT Server Mode field, select Telnet.
3.
Click Apply.
4.
Re-try loading the application from AAF.
Network Operator Switching
What happens to my Radio Module Firmware settings (Admin >
Radio Module Firmware) when I reset the gateway to the factory default settings?
If the Reset Mode field on the Admin > Advanced screen is set to “Preserve
Cellular Authentication Settings” (default setting), the Radio Module settings on the Admin > Radio Module Firmware screen are preserved over the reset, i.e. there is no change to the settings.
If the Reset Mode field on the Admin > Advanced screen is set to “Reset All”, then the settings on the Admin > Radio Module Firmware screen revert are reset. The
Automatic option is reset to “Automatic” and the ALMS option is reset to “Update
Current Only”. If you have previously selected a radio module firmware version manually that does not match the SIM card, “Reset All” may change the radio module firmware because once the gateway reverts to “Automatic”, which SIM card is installed in the gateway determines which radio module firmware is used.
This could override a previous manual selection.
382 4118127
F: Glossary of Terms
Acronym or Term
1xEV-DO
1X
3GPP
API
AT
CDG
CDMA cdmaOne
Definition
Single Carrier ( 1X ) EVolution–Data Only
A high-speed standard for cellular packet data communications. It supports Internet connections with data rates up to 3.1
. (downlink from the network) and 1.8
Mbps (uplink to the network). Average data rates are approximately:
•
Rev. A: 600-1300
. (downlink from the network) and 300-400 kbps (uplink to the network)
•
Rev. 0: 400-700 kbps (downlink from the network) and 40-80 kbps (uplink to the network)
Actual speed depends on the network conditions. Compare to
.
Single Carrier (1X) Radio Transmission Technology
A high-speed standard for cellular packet data communications.
1x supports Internet connections with data rates up to 153
(simultaneously in each direction—downlink and uplink). Actual speed depends on the network conditions. Compare to
3 rd
Generation Partnership Project
3GPP unites 6 telecommunications standard development organizations (ARIB,
ATIS, CCSA, ETSI, TTA, TTC), and provides their members with a stable environment to produce Reports and Specifications that define 3GPP technologies.
Programming Interface
A protocol intended to be used as an interface by software components to communicate with each other.
A set of device commands, preceded by “AT” originally developed by Hayes, Inc. for their devices.
The structure (but not the specific commands, which vary greatly from manufacturer to manufacturer) is a de facto device industry standard.
CDMA Development Group
A consortium of companies who joined together to lead the adoption and evolution of CDMA wireless systems around the world.
Code Division Multiple Access
A wideband spread spectrum technique used in digital cellular, personal communications services, and other wireless networks.
Wide channels (1.25 MHz) are obtained through spread spectrum transmissions, thus allowing many active users to share the same channel. Each user is assigned a unique digital code, which differentiates the individual conversations on the same channel.
A IS-95 CDMA standard developed by QUALCOMM Inc.
Also known as TIA-EIA-95.
F
Rev 2 Nov.15
383
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Acronym or Term
CE, CE Label
CnS
DCE
Diversity
Definition
The CE label is a mandatory conformity marking for products placed on the market in the European Economic Area (EEA).
With the CE marking on a product, the manufacturer declares that the product conforms with the essential requirements of the applicable EC directives.
Sierra Wireless’ proprietary Control and Status protocol interface
Data Communications Equipment
A device that sits between the data terminal equipment (DTE) and a data transmission circuit. Usually the DCE is a modem.
Antenna diversity, also called space diversity, is a scheme that uses two or more antennas to improve the quality and reliability of a wireless link.
Often, especially in urban and indoor environments, there is no clear line-of-sight
(LOS) between transmitter and receiver. Instead the signal is reflected along multiple paths before finally being received. Each bounce can introduce phase shifts, time delays, attenuations, and distortions that can destructively interfere with one another at the aperture of the receiving antenna.
Dynamic Mobile Network Routing
DMNR
EDGE
EIA
EMC
Enhanced Data rates for GSM Evolution
A digital mobile phone technology that allows improved data transmission rates as a backward-compatible extension of GSM. EDGE is considered a pre-3G radio technology and is part of ITU's 3G definition.
Also known as Enhanced GPRS (EGPRS), or IMT Single Carrier (IMT-SC), or
Enhanced Data rates for Global Evolution.
Electronics Industry Association
EIA was a standards and trade organization composed as an alliance of trade associations for electronics manufacturers in the United States.
They developed standards to ensure the equipment of different manufacturers was compatible and interchangeable. The EIA ceased operations on February 11, 2011, but the former sectors continue to serve the constituencies of EIA.
Electromagnetic Compatibility
The branch of electrical science which studies the unintentional generation, propagation and reception of electromagnetic energy with reference to the unwanted effects (Electromagnetic interference, or EMI) that such energy may induce.
EMI
ERP
ESN
Ethernet
EU
Electromagnetic Interference
The disturbance that affects an electrical circuit due to either electromagnetic induction or electromagnetic radiation emitted from an external source
Effective Radiated Power
A standardized theoretical measurement of radio frequency (RF) energy. It is determined by subtracting system losses and adding system gains.
Electronic Serial Number
The unique first-generation serial number assigned to the Air Link devices for use on the wireless network. Compare to
.
Computer networking technologies for local area networks (LANs).
The European Union Organization of European countries.
384 4118127
Glossary of Terms
Acronym or Term
EVDO
FCC
FW
GPRS
GSM
HSPA
HSPA+
IC
IEC
IOTA
Definition
Enhanced Voice-Data Optimized or Enhanced Voice-Data Only (Ev-DO, EV,
EVDO, etc.).
A telecommunications standard for the wireless transmission of data through radio signals, typically for broadband Internet access. It uses multiplexing techniques including code division multiple access (CDMA) as well as time division multiplexing (TDM) to maximize both individual users' throughput and the overall system throughput.
Federal Communications Commission
The U.S. federal agency responsible for interstate and foreign communications.
The FCC regulates commercial and private radio spectrum management, sets rates for communications services, determines standards for equipment, and controls broadcast licensing.
Firmware
Software stored in ROM or EEPROM; essential programs that remains even when the system is turned off. Firmware is easier to change than hardware but more permanent than software stored on disk.
General Packet Radio Service
A packet-oriented mobile data service on 2G and 3G cellular communication systems.
GPRS was originally standardized by European Telecommunications Standards
Institute (ETSI) in response to the earlier CDPD and i-mode packet-switched cellular technologies. It is now maintained by the 3rd Generation Partnership
Project (3GPP).
Global System for Mobile Communications (originally Groupe Spécial Mobile)
GSM is a standard developed by the European Telecommunications Standards
Institute (ETSI) to describe protocols for second generation (2G) digital mobile networks used by mobile phones
High Speed Packet Access
An amalgamation of two mobile telephony protocols: High Speed Downlink Packet
Access (HSDPA) and High Speed Uplink Packet Access (HSUPA).
This extends and improves the performance of existing 3rd generation mobile telecommunication networks utilizing the WCDMA protocols.
Also called evolved HSPA
This allows bit-rates to reach as high as 168 Mbit/s in the downlink and 22 Mbit/s in the uplink. An improved 3GPP standard.
Industry Canada
The government department responsible for overseeing and regulating wireless and communication technologies in Canada.
International Electrotechnical Commission
A non-governmental international standards organization that prepares and publishes International Standards for all electrical, electronic and related technologies – collectively known as “electro technology.”
Internet Over The Air
An mated feature, supported by some service providers, to perform account setup by making a connection to the CDMA network and using a secure Internet connection to download account parameters to the device.
Rev 2 Nov.15
385
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Acronym or Term
IS
Definition
Interim Standard
After receiving industry consensus, the TIA/EIA
forwards the standard to ANSI for approval.
IS-95
ISAKMP
ITU kbps
LED
A 2G mobile telecommunications standard using CDMA to send voice, data and signaling data (such as a dialed telephone number) between mobile telephones and cell sites.
Internet Security Association and Key Management Protocol
A security protocol defined by RFC 2408 for establishing Security Associations
(SA) and cryptographic keys in an Internet environment. ISAKMP only provides a framework for authentication and key exchange and is designed to be key exchange independent.
International Telecommunication Union
A specialized agency of the United Nations responsible for issues that concern information and communication technologies.
The ITU coordinates the shared global use of the radio spectrum, promotes international cooperation in assigning satellite orbits, and assists in the development and coordination of worldwide technical standards.
Kilobits per second
1000, not 1024, as used in computer memory size measurements of kilobytes.
Light Emitting Diode
A semiconductor diode that emits visible or infrared light.
LTE
Mbps
MEID
MSCI
NAM
NV
OEM
OTAPA
OTASP
Long Term Evolution
High performance air interface for cellular mobile communication systems.
Millions of bits per second, or Megabits per second.
Mobile Equipment IDentifier
The unique second-generation serial n umber assigned to the device for use on the wireless network. Compare to
.
Modem Status Configuration Interface
ALEOS internal configuration database
Number Assignment Module
Semi-permanent information stored in the device’s non-volatile memory, including the device’s Mobile Identification Number, the station class mark, Mobile Network
Operator code, and other cellular identifiers.
Essentially the phone number, it should be treated as confidential information and should not be disclosed to anyone other than the cellular service provider.
Non-Volatile (memory)
Original Equipment Manufacturer
A company that manufactures a product and sells it to a reseller.
Over the Air Parameter Administration
A way of distributing new software updates or configuration settings to devices like cellphones and set-top boxes.
Over the Air Service Provisioning. Also see OTAPA .
386 4118127
Glossary of Terms
Acronym or Term
PAD
PCS
PPP
PRI
Definition
Packet Assembly/Disassembly
Personal Communications Services
A cellular communication infrastructure that uses a different frequency range than
AMPS.
Point to Point Protocol
An alternative communications protocol used between computers, or between computers and routers on the Internet. PPP is an enhanced SLIP. Also see
.
Product Release Instructions
A file containing the settings used to configure devices for a particular service provider, customer, or purpose.
RF
RoHS
RS-232
Rx
SIM, SIM Card
SINR
SKU
SLIP
SMS
TCH
Radio Frequency
Restriction of use of Hazardous Substances mandated by EU Directive 2002/95.
A series of standards for serial binary single-ended data and control signals connecting between a DTE (Data Terminal Equipment) and a DCE (Data Circuitterminating Equipment). It is commonly used in computer serial ports.
Receive
Subscriber identity module or subscriber identification module.
An integrated circuit which securely stores the international mobile subscriber identity (IMSI) and the related key used to identify and authenticate subscribers on mobile telephony devices (such as mobile phones and computers).
Signal to Interference plus Noise Ratio (SINR) is an RF parameter that is directly proportional to throughput (the higher the number, the higher the throughput). It can help LTE radio installers gauge the signal quality between the cell tower and the radio module. For more information on interpreting the SINR values, see
How do I obtain and interpret SINR values for LTE networks?
Stock Keeping Unit
Identifies an inventory item: a unique code, consisting of numbers or letters and numbers, assigned to a product by a retailer for purposes of identification and inventory control.
Serial Line Internet (or Interface) Protocol
An Internet Protocol designed to work over serial ports and modem connections.
On personal computers, SLIP has been largely replaced by the Point-to-Point
Protocol (PPP), which has more features and does not require its IP address configuration to be set before it is established. On microcontrollers SLIP is still the preferred way of encapsulating IP packets due to its very small overhead.
Also see
Short Message Service
A feature which allows users of a wireless device on a wireless network to receive or transmit short electronic alphanumeric messages (up to 160 characters, depending on the service provider).
Traffic Channel
Rev 2 Nov.15
387
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
Acronym or Term
TIA / EIA
Tx
UMTS
USB
VRRP
Definition
Telecommunications Industry Association / Electronics Industry Association
A standards setting trade organization, whose members provide communications and information technology products, systems, distribution services and professional services in the United States and around the world.
Transmit
Universal Mobile Telecommunications System (UMTS).
A third generation mobile cellular system for networks based on the GSM standard.
Developed and maintained by the 3GPP (3rd Generation Partnership Project),
UMTS is a component of the International Telecommunications Union IMT-2000 standard set and compares with the CDMA2000 standard set for networks based on the competing cdmaOne technology.
Universal Serial Bus
An industry standard defining the cables, connectors and communications protocols used in a bus for connection, communication and power supply between computers and electronic devices.
Virtual Router Redundancy Protocol
X.509
A Public Key Infrastructure (PKI) and Privilege Management Infrastructure (PMI) are standards that specify formats for public key certificates, certificate revocation lists, attribute certificates, a certification path validation algorithm, etc.
388 4118127
Index
A
ACEmanager
configuring
description
idle timeout, set
ALEOS Application Framework troubleshooting
, 382 unable to load application from , 382
using
ALEOS software update
ALMS auto synchronize
configuration
always on connect
analog inputs channel configuration
APN backup
status
AT Commands
Applications > Data Usage
I/O > Current State
LAN/Wi-Fi > DHCP/Addressing
Security > Trusted IPs - Inbound , 325, 330
Serial > Port Configuration
Services > Low Power
Status > Home
using
authentication general information
TACACS+
Auto DHCP
B
Bands, LTE
bandwidth throttle
C
configuration
logging
serial
services
VPN
Rev 2 Nov.15
connection not working
D
Device Status Screen configuring
DHCP Options
digital inputs
DMNR
DMZ
DNS alternate port
dynamic
global
DNS proxy
documentation
domain name
DUN operating systems supported
Dynamic Mobile Network Routing See DMNR
E
EC/IO
Ethernet status
Ethernet port, enable and disable
troubleshooting
Extended Archiver
F
firmware update
G
global DNS
GRE
389
H
host port routing
I
Idle timeout, ACEmanager
inbound ports used by ALEOS
IP Logging
K
keepalive
L
LAN
LDAP authentication
LED indicator for serial traffic , 207
LEDs, above Ethernet port
Load Root Certificate
Log, mark a section of the log
logging
IP logging
login
M
MAC filtering
MIB (Management Information Base) , 279
N
network connection, poor , 362
network settings, retain over reset , 249
Network State
Network Watchdog, disable , 65, 66
O
Over the Air (OTA) connections
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
P
PAD mode
PCI compliance
port filtering
outbound
port forwarding
error message
troubleshooting
PPP connection, configuring , 220
public and private mode
R
radio module firmware update , 32
radio passthru
Reliable Static Routing (RSR)
reset device, retain network settings , 249
reset, periodic and time of day , 244
RSSI
S
security
serial status
LED indicator
MTU
status
serial port
PPP
TCP
services
status
Simple Network Management Protocol (SNMP) , 184
390 4118127
SMS
Control Only mode
Gateway Only mode
M2M
Password
Password Only mode
password, default
troubleshooting
SMS Commands
SMS M2M
SMS message error
SNMP traps
SNTP
SSH
SSH PAD mode
SSL tunnel
Status
Applications
Home
Serial
Services
VPN
WAN/Cellular
T
TACACS+ authentication
TCP connection configuring
troubleshooting
template applying
saving a custom configuration as
test button, SMS/email
third party services
time (SNTP)
troubleshooting
ALEOS AF
LAN network
mark a section of the log
port forwarding
radio module firmware update
SMS
software and radio firmware updates , 360
VPN
wireless connection
trusted IPs inbound
Trusted Phone Number
U
UDP connection configuring
update
ALEOS software
radio module firmware
USB port
V
VPN configuration
Failover
GRE
SSL tunnel
status
troubleshooting
Index
Rev 2 Nov.15
391
ALEOS 4.5.1 Software Configuration User Guide for AirLink ES450
392 4118127
Download
Annonce