ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
Important
Notice
Limitation of
Liability
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.
PatentsThis product may contain technology developed by or for Sierra Wireless Inc. This
product includes technology licensed from QUALCOMM
manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more
patents licensed from MMP Portfolio Licensing.
Note: This user guide is intended for the AirLink RV50 Series. If you have a different AirLink
gateway, refer to the ALEOS Software Configuration User Guide for the your gateway.
Overview
ACEmanager™ is the free, web-based utility used to manage and configure AirLink®
gateways. 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:
•Log in and configure 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
1
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 RV50 Series
•AirLink ES450
•AirLink MP70
For more information on specific AirLink products, go to www.sierrawireless.com
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
Rev 1 Dec. 171241111088
•User scenarios for certain sections in the guide.
Tools and Reference Documents
DocumentDescription
Introduction
AirLink Gateway
Hardware User Guide
ALMS User GuideThis document explains how to use AirLink Management Service for the remote
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.
management of Sierra Wireless AirLink gateways.
Rev 1 Dec. 171341111088
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®.
Figure 2-1: ACEmanager: Main Login screen
4. Log in:
· User Name: “user” (entered by default)
· Default Password: 12345
2
Note: ACEmanager sessions, by default, time out in 15 minutes. If there is no activity for this
idle timeout period, you are redirected to the Login screen. To change the session idle timeout
period, see Session Idle Timeout (minutes) on page 171.
To prevent others from changing the AirLink gateway settings, you can change the
ACEmanager password (see Change Password on page 307).
If the gateway is using the default password, a banner at the top of the screen
reminds you to change it.
Click the banner to go to the Change Password screen.
After your initial log in 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.
Rev 1 Dec. 171441111088
Gateway Configuration
6. In the Device Status on Login Screen field, select Enable. (For details, see
Device Status Screen on page 223.)
Figure 2-2: ACEmanager: Main Login screen with Location and Device Status enabled.
If you have Location fields selected on the Device Status screen, but Location
Service is disabled, the gateway Login screen will show Location Service
Disabled.
Recovery Mode
In the unlikely event that ALEOS becomes corrupted, or, if the gateway is
unresponsive to ACEmanager input and AT commands, you can manually put the
gateway into recovery mode.
Recovery mode enables you to update the ALEOS software and return the
gateway to working order.
Note: To use Recovery Mode, you must update older gateways to ALEOS 4.7.0 or later
and use the *RCVRUPDATE command (see page 400) to install the recovery mode
manager. These steps must be done while the gateway is operating normally. For
gateways shipped from the factory with ALEOS 4.8.0, no action is required.
Note: ALEOS software updates done in Recovery mode do not preserve any custom
setting such as cellular settings, AAF applications, etc.
To enter Recovery mode:
1. Use an Ethernet cable to connect the gateway to your computer. (Recovery
mode is not supported on USBnet.)
Rev 1 Dec. 171541111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
2. Power on the AirLink gateway.
3. On the gateway, press the Reset button for more than 20 seconds. (Release
the button when the Power LED flashes amber.)
4. Launch your browser and enter the IP address and port number
http://192.168.13.31:9191.
The following screen appears:
Figure 2-3: Recovery screen
5. Click Choose File and navigate to the appropriate ALEOS software version
for your gateway.
6. Click Update.
The screen lets you know that the update was successful and automatically
reboots the gateway.
When the reboot is complete, the gateway exits Recovery mode, and the
ACEmanager Login screen appears.
If you select an inappropriate version of ALEOS, an error message, such as
the following appears.
If this happens, click the Log button and save the log file for review by Sierra
Wireless or your authorized reseller.
Rev 1 Dec. 171641111088
Gateway Configuration
Click Back to return to the previous screen to select the correct version of
ALEOS.
If you have inadvertently entered Recovery mode, you can exit it by doing one of
the following:
•Press the reset button on the gateway to reboot it.
•Click the Reboot button on the Recovery screen.
•Wait 10 minutes. If no action is taken within 10 minutes of the device entering
Recovery mode (for example, if the Recovery screen has not been loaded by
the web browser), it automatically reboots and exits Recovery mode.
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
•Help
•Logout
Configuring your AirLink Gateway
There are three options for configuring the AirLink gateway:
•Use your browser-based ACEmanager (as detailed in this guide)
•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.)
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.
Rev 1 Dec. 171741111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
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-4: ACEmanager: Template button
The following window appears:
Figure 2-5: 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 ACEmanager (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
Rev 1 Dec. 171841111088
Gateway Configuration
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-6: Download template complete
Once the download is complete, the following window opens:
Figure 2-7: 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.
· 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.
Rev 1 Dec. 171941111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
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 Te mpl at es on
page 474 for instructions on configuring the browser’s Internet options to allow the upload.
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, or connect to the gateway over the air.
2. Log in to ACEmanager, and go to Admin > Advanced.
Note: Sierra Wireless
recommends resetting the
gateway to the factory
default settings before
applying the template.
3. Select the Reset Mode:
· Preserve Cellular Authentication Settings—Recommended if you are
applying a template remotely using a remote ACEmanager connection (or
ALMS). For a list of preserved settings, see Reset Mode on page 319.
· Reset All— Recommended if you are applying a template locally (i.e your
computer is physically connected to the gateway).
4. Once the gateway reboots, log in to ACEmanager.
5. In ACEmanager, click the Template button on the toolbar.
Figure 2-8: ACEmanager: Template button
Rev 1 Dec. 172041111088
Gateway Configuration
The following window appears:
Figure 2-9: ACEmanager: Template window
Use the top half of the window to upload and apply a template to your AirLink
gateway.
6. Click Browse... and navigate to the template you want to upload.
7. Click Open. The template file name appears beside the Browse... button.
Figure 2-10: Apply Template file opened
8. Click Upload.
9. When the upload is complete, a Reboot button appears on the window.
Rev 1 Dec. 172141111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
Figure 2-11: Template file uploaded
10. Click Reboot.
11. 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.
Figure 2-12: ACEmanager: Status > About
Rev 1 Dec. 172241111088
Gateway Configuration
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.
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.
Important: Once the gateway has been upgraded to ALEOS 4.7.0, you cannot
downgrade to earlier versions of ALEOS.
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: 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
Firmware on page 326.
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).
Figure 2-13:
Rev 1 Dec. 172341111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
Figure 2-14: 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 low power mode or time of day reboot areconfigured, and the following events
arelikely to coincide with the update:
•The gateway entering low power mode
•The Time of Day reset occurring
Sierra Wireless recommends that you disablethese 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.
Rev 1 Dec. 172441111088
Gateway Configuration
Important: BE PATIENT! The firmware update can take up to 30 minutes to complete.
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.
Default user name: user
Default password: 12345
3. 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.
Figure 2-15:
Rev 1 Dec. 172541111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
Figure 2-16: 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).
4. Click Browse... and navigate to the ALEOS software you downloaded from
the Sierra Wireless Web site. This is a .bin file named for the gateway and the
ALEOS software version. For example, RV50_4.6.1.014.bin.
Figure 2-17:
Rev 1 Dec. 172641111088
Gateway Configuration
Figure 2-18: ALEOS file selected in Software and Firmware update window
5. Click Update.
The ALEOS software update runs automatically and green check marks
appear beside each step as it is completed.
Figure 2-19:
Rev 1 Dec. 172741111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
Figure 2-20: 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 475.
6. 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
step 9.
Only if prompted to update the firmware, proceed to step 9.
Figure 2-21: Prompt for Radio Module Firmware
7. Under Applying, click Browse... and navigate to the radio module firmware file
that was included in the .zip file you downloaded. This is an .iso file named for
the gateway’s radio module and the mobile network operator’s network (or
“GENERIC”, if it is intended for more than one operator network). For
example, MC7354_GENERIC_2820.iso.
8. Click Upload Radio Firmware.
Rev 1 Dec. 172841111088
Gateway Configuration
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.
Once the radio module firmware is uploaded, the gateway 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 326.
9. When the update is complete, the AirLink gateway reboots. The Software
Update progress window appears.
When the reboot is complete, you are returned to the Login screen.
10. After you log in, go to Status > About.
11. Click Refresh.
12. 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.
Rev 1 Dec. 172941111088
ALEOS 4.9.0 Software Configuration User Guide for AirLink RV50 Series
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
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 autho-
rized reseller.
.
If this is not the
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. This is
an .iso file named for the gateway’s radio module and the mobile network
operator’s network (or “GENERIC”, if it is intended for more than one operator
network). For example, MC7354_GENERIC_2820.iso.
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 1 Dec. 173041111088
Loading...
+ 479 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.