Sierra Wireless oMG series Operation And Configuration Manual

oMG
Operation and Configuration
Guide 3.14
4118618
Rev 4
Operation and Configuration Guide 3.14
Important Notice
Safety and Hazards
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.
Do not operate the Sierra Wireless modem in areas where blasting is in progress, where explosive atmospheres may be present, near medical equipment, near life support equipment, or any equipment which may be susceptible to any form of radio interference. In such areas, the Sierra Wireless modem MUST BE POWERED OFF. The Sierra Wireless modem can transmit signals that could interfere with this equipment.
Do not operate the Sierra Wireless modem in any aircraft, whether the aircraft is on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE POWERED OFF. When operating, the Sierra Wireless modem can transmit signals that could interfere with various onboard systems.
Note: Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is open. Sierra Wireless modems may be used at this time.
Limitation of Liability
The driver or operator of any vehicle should not operate the Sierra Wireless modem while in control of a vehicle. Doing so will detract from the driver or operator's control and operation of that vehicle. In some states and provinces, operating such communications devices while in control of a vehicle is an offence.
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.
Rev 4 May.17 2 4118618
Preface
Patents This 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 InterDigital Group and MMP Portfolio Licensing.
®
. This product is
Copyright © 2017 Sierra Wireless. All rights reserved.
Trademarks Sierra Wireless
registered trademarks of Sierra Wireless, Inc.
Windows
QUALCOMM license.
Other trademarks are the property of their respective owners.
®
, AirPrime®, AirLink®, AirVantage® and the Sierra Wireless logo are
®
and Windows Vista® are registered trademarks of Microsoft Corporation.
®
is a registered trademark of QUALCOMM Incorporated. Used under
Contact Information
Sales information and technical support, including warranty and returns
Corporate and product information Web: sierrawireless.com
Web: sierrawireless.com/company/contact-us/ Global toll-free number: 1-877-687-7795 6:00 am to 6:00 pm PST
Revision History
Revision number
1 May 2016 Imported content from oMG-ED-121006 r4.9
2 September 2016 Added Pilot Ping field to WAN Configuration screens
3 January 2017 DFS channels re-enabled, so removed rev2 note concerning removal of Wi-Fi
4 May 2017 Replaced ‘oCM’ and ‘oMM’ references with ‘ACM’ and ‘AMM’
Release date Changes
Added topic Accessing the Console on page 57 Updated MTBF
Added Configuring DNS Zones for Private DNS Server Use and updated Automatic DNS field descriptions
Noted removal of Wi-Fi channels to comply with FCC rules Noted special character restriction for Pre-Shared Key format Updated Server List format for Remote Forwarding
channels.
Updated section NMEA Messaging ‘Additional Options’—changed label for ESN option, added option to group sentences
Updated Auto Software Updates options
Rev 4 May.17 3 4118618
Contents
1: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
1.1 Who Should Read This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 What is the oMG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3 Pre-Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.4 Related Publications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2: Powering the oMG On and Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
2.1 Powering On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.2 Powering Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3: Accessing the Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
3.1 Viewing the Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4: Preparing the Network Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
5: Setting up the WAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
5.1 Basic WAN Link Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.1.1 Cellular WAN Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .15
5.1.2 WiFi WAN Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
5.1.3 Ethernet WAN Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .16
5.1.4 Serial WAN Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
5.2 Defining an Access Point Profile for WiFi Links . . . . . . . . . . . . . . . . . . . 18
5.3 Maintaining Communications with Services of a WAN. . . . . . . . . . . . . . 19
5.4 Setting up a Link Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.4.1 Special Considerations for WiFi Links . . . . . . . . . . . . . . . . . . . . . .23
5.4.2 Dynamic Priority Policy Overview . . . . . . . . . . . . . . . . . . . . . . . . . .23
5.4.3 Geographical Regions Policy Overview . . . . . . . . . . . . . . . . . . . . .26
5.4.4 Time Period Policy Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
5.4.5 Velocity Policy Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
5.4.6 Signal Strength Policy Overview . . . . . . . . . . . . . . . . . . . . . . . . . . .29
5.4.7 Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Rev 4 May.17 4 4118618
Contents
5.5 Setting up Firewall Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.5.1 Configuring the WAN Rule Firewall Settings . . . . . . . . . . . . . . . . . 31
5.5.2 Deleting WAN Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.5.3 Recovering from Dead WAN Connections . . . . . . . . . . . . . . . . . . . 31
6: Setting up the LAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1 Configuring LAN Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.2 Configuring LAN Segments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3 Configuring DHCP and Static IP Addresses . . . . . . . . . . . . . . . . . . . . . 36
6.4 Setting up the LAN Firewall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.4.1 Configuring the LAN Rule Firewall Settings . . . . . . . . . . . . . . . . . . 36
6.4.2 Deleting a LAN Network Rules: . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.5 Attaching a Network Printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.6 Setting up Virtual LANs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
7: How to Configure a VPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
7.1 Detecting Dead VPN Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
7.2 Multi-VPN Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
7.3 Configuring DNS Zones for Private DNS Server Use . . . . . . . . . . . . . . 43
8: Setting up GPS Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
9: Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
9.1 Configuring Load balancing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
9.2 Setting Quality of Service (QoS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
9.3 Configuring LAN Throughput Reporting Frequency . . . . . . . . . . . . . . . 48
10: Configuring the oMG's startup and shutdown Behavior . . . . . . . . . . . . 50
11: Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
11.1 Obtaining General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
11.2 Obtaining Network Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Rev 4 May.17 5 4118618
Operation and Configuration Guide 3.14
11.3 Configuring User Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
11.4 Changing the Root Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
11.5 Backing up and Restoring Configuration Settings. . . . . . . . . . . . . . . . 54
11.6 Configuring Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
11.7 Using the Diagnostic Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
11.8 Running Custom Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
11.9 Accessing the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
12: Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
13: Updating the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
13.1 Configuring Auto Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . 59
13.2 Over the Air Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
14: Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
14.1 Viewing Advanced System Event Information. . . . . . . . . . . . . . . . . . . 62
A: Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
A.1 Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
A.1.1 Dynamic Priority Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
A.1.2 Geographic Region Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
A.1.3 Time Period Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
A.1.4 Velocity Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
A.1.5 Signal Strength Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
A.2 Networking Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
A.2.1 Access Blocking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
A.2.2 Access Granting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
A.2.3 Port Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
A.2.4 QoS Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Rev 4 May.17 6 4118618
Contents
A.3 WAN Link Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
A.3.1 Cellular WAN Link Configuration Settings . . . . . . . . . . . . . . . . . . . 68
A.3.2 WiFi Link Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 71
A.3.3 Ethernet Link Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . 72
A.3.4 TTY Serial Port Link Configuration Settings . . . . . . . . . . . . . . . . . 74
A.4 WAN Monitor Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
A.5 WiFi Networks Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
A.6 LAN Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
A.6.1 Access Point Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
A.6.2 LAN Segment Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
A.6.3 VLAN Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
A.6.4 LAN Ethernet 802.1x Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
A.7 LAN Throughput Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
A.8 WAN Recovery Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
A.9 VPN Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
A.10 Bluetooth Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
A.10.1 Supported Adaptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
A.10.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
A.11 GPS Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
A.12 General Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
A.12.1 Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
A.12.2 Shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
A.12.3 Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
A.12.4 Advanced Routing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
A.12.5 Auto Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
B: Technical Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
B.1 Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
B.2 LED Blink Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
C: Supported USB-To-Serial Adaptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Rev 4 May.17 7 4118618

1: Overview

This document provides operation and configuration instructions for the oMG running software version 3.14.

1.1 Who Should Read This Guide

IT specialists who configure and oversee usage of the oMG should read this guide. This guide contains common configuration tasks, while the appendices contain detailed information on the available configuration options.

1.2 What is the oMG

The oMG is a ruggedized wireless gateway, designed for use in harsh mobile and portable environments. The gateway extends the utility and convenience of LAN networking to devices and applications in vehicles. The oMG interfaces with the AMM, Sierra Wireless’ mobile network management system.
1
Figure 1-1: The back panel of an oMG
Key Features of the oMG:
works in conjunction with the AMM to transmit data such as GPS, telemetry, GPIO, and asset tracking information
supports customization through the installation of select applications (purchased separately) which tailor the unit to the needs of a fleet
supports a variety of network interfaces including Ethernet, USB, Bluetooth, Serial, a wide range of 802.11 WiFi/frequencies, 3G cellular networks, and LTE networks
supports network redundancy through multiple network interface installations
Rev 4 May.17 8
Overview
supports DHCP and static IPs
provides high security through technologies like ESP, authentication,
encryption, firewall etc.
supports VLANs and VPNs

1.3 Pre-Installation Requirements

This manual assumes that the appropriate cellular modem card is already installed in the oMG base unit and that the cellular network provider has activated the card.
In some cases, the cellular modem card may be pre-installed at the factory prior to shipping. If a network card must be installed, please read the oMG Installation and Configuration Guide for your model of oMG.

1.4 Related Publications

Table 1-1: Related Publications
Title and Publication Number Description
oMG 2000 Quick Setup Guide Describes how to quickly setup the oMG for
oMG 2000 Installation Guide Describes how to install the oMG in a vehicle. Application Configuration
Guide
Passenger WiFi Application
Configuration Guide
basic operation.
Describes how to configure the oMG to work with optional applications.
Describes how to configure the oMG's passenger WiFi settings including customization of the web portal.
Rev 4 May.17 9

2: Powering the oMG On and Off

2.1 Powering On

The oMG has a factory default configuration that enables it to establish a WAN connection if a cellular modem is installed along with an appropriate SIM card, and the APN is configured correctly. Note that additional configuration is always recommended.
Start the unit using the following steps:
1. Apply power to the system: if the oMG has been installed and wired into a vehicle’s electrical system, turn on the ignition. If the oMG is not in a vehicle, an optional AC power adaptor can also be used to supply 12V-DC power to the system.
2. Turn on the unit: by default the oMG should start up automatically once it receives power. If it does not, press the reset button on the back of the unit. Once power up is complete the amber and green LED's will remain solid. For more information on the LED patterns see LED Blink Patterns on page 99.
3. Test the unit: connect a test device such as a PC, equipped with Ethernet or WiFi, to the oMG LAN. An oMG with factory default settings will provide an unsecured WiFi access point (AP) broadcasting its own Serial Number as the SSID (e.g.
H100109D0002) and will also provide LAN access using Ethernet ports 1 to 3.
2
1
Once these steps have been completed, the oMG is ready for use, however further configuration of the unit should be performed using the sections provided in this document.

2.2 Powering Off

When powering down the unit, ensure that at least three minutes have elapsed since the unit’s green Status light began to blink or at least two minutes have elapsed since the light went solid.
This is necessary to ensure proper preparation of configuration files, in particular, upon the first boot after a factory reset which takes longer than normal to prepare these files. If this process is interrupted by a premature shutdown and/or removal of power from the oMG, the process will repeat on subsequent boots until it is successfully completed.
1. oMG 1000 series has only one Ethernet Port
Rev 4 May.17 10

3: Accessing the Configuration Settings

The oMG Local Configuration Interface (LCI) is the oMG's browser-based configuration utility which organizes the various configuration pages under a series of tabs and sub tabs.
To access the LCI, navigate to the following URL using a web browser:
http://welcome.to.inmotion/MG-LCI. If this URL is not reachable, try entering:
172.22.0.1/MG-LCI. This will display the LCI login screen:
3
Figure 3-1: LCI Login Panel
Note: Configuration of the unit is best performed using a web browser running on a Windows 7 or Windows XP PC. As of version 3.8, the oMG supports Internet Explorer 9. Other devices and other browsers may work but have not been certified by Sierra Wireless.
Log in using the following default credentials:
User Name: admin
Password: admin
Most configuration settings take effect immediately. However those related to the use of the serial port only take effect after reboot.
The browser’s Forward and Back arrows can be used to navigate through the LCI. Note that unless the Save button is clicked after making configuration changes, the changes will not be saved and applied.
Rev 4 May.17 11
Operation and Configuration Guide 3.14
To log out of the LCI, click on the Logout tab which will log out the current user and return to the login screen:
Figure 3-2: Using the Logout tab to log out of the system

3.1 Viewing the Configuration Settings

The oMG includes an Easy Access page, which allows users on all devices connected to the unit to view the unit’s operational status without having to log into the unit.
To view the Easy Access page from a device (e.g. laptop) connected to the unit, navigate to the following URL using a web browser:
http://welcome.to.inmotion/MG-LCI/easyaccess.html.
This will display a read-only page showing the oMG’s operational status:
Figure 3-3: Easy Access Page
12 4118618

4: Preparing the Network Interfaces

By default the oMG comes pre configured with devices which can provide both WAN and LAN connectivity. It's recommended that the settings for each device be verified before using the oMG. This will help to ensure that each device has been recognized by the system and is properly configured to provide LAN or WAN data communications.
To view device settings, navigate to the Devices tab in the LCI:
Figure 4-1: An example of a Cellular Device on the Device Configuration Tab
A custom/descriptive name can be entered into the Friendly Name field. This can be useful for example, to identify which access point the device will be used for.
Access the sub tabs to set each of the networking devices available on the oMG for WAN or LAN usage:
Cellular: cellular connectivity is the most common method for accessing the WAN when an oMG is outside of a depot. Verify that the Installed field is checked for each device listed on the Cellular tab and that the Use field has been set to WAN for at least one of the devices listed.
Ethernet: verify that the Installed field is checked for each Ethernet port listed.
· Optional: if Ethernet is to be used for LAN devices, ensure that the Use field
has been set to LAN for at least one of the ports.
· Optional: if Ethernet is to be used for WAN connectivity, ensure the Use field
is set to WAN for at least one of the ports.
WiFi: verify that the Installed field is checked for each device listed and that the Use field has been set to WAN or LAN according to how the WiFi device will be used by the oMG. A common use of WiFi WAN connectivity is for when the oMG returns to a depot which has a wireless AP available.
Serial Modem: any modems attached to the serial port can be added via the Serial Modem tab. Select the available serial modem from the drop down and click Add New Serial Modem. Set the Use field to WAN to enable the device.
Serial: by default the serial port can be used to output information about the oMG to a console window. Change the Use field to Application if you plan to use a device with the oMG which has a serial connection, or when using a third party GPS device.
Bluetooth: if you plan to use a device with the oMG which communicates via Bluetooth, ensure that a Bluetooth device is listed and that its Installed field is checked. Click on Configure under the Actions column to configure the device.
4
Rev 4 May.17 13

5: Setting up the WAN

The oMG can access a WAN through cellular, WiFi, and wired Ethernet connection(s). Cellular WAN access is the most common method while the oMG is travelling in a vehicle and WiFi WAN access is often used when a vehicle returns to a depot where an AP is available for the oMG to connect to as a client. By default, Ethernet Port 4 is configured for WAN access, while ports 1 to 3 are configured for LAN access. While the Ethernet ports can be used for WAN access, they are more commonly used for providing connectivity to devices on the oMG's LAN.
Multiple devices can also be configured to provide redundant WAN access should one connection go down.
Note: The oMG does not support USB-to-Ethernet adapters for WAN operation.

5.1 Basic WAN Link Configuration

Each device which has been enabled for WAN connectivity (as described in Preparing
the Network Interfaces on page 13) will be listed as a WAN link, configurable under
the WAN > Links tab.
To configure how these links provide WAN access:
1. Navigate to the WAN > Links tab.
2. Click Configure in the Actions column for a link:
5
Figure 5-1: WAN Link Tab
The following subsections provide an overview of the configuration for the most common WAN links.
Rev 4 May.17 14
Setting up the WAN

5.1.1 Cellular WAN Link Configuration

Cellular WAN is the most common type of WAN connection used on the oMG because it provides connectivity from wherever cellular reception is available. This type of link requires that a cellular card be installed in the oMG with a pre­authorized cellular data plan from your Mobile Network Operator.
Configuration settings are specific to each type of cellular card installed, however typical settings can include a dial string, user ID/password, and modem initialization.
The screenshot below shows the cellular configuration settings for a Sierra Wireless Aircard:
Figure 5-2: Common Cellular WAN Link Configuration Settings
Tip: Always test the cell card in a laptop with the APN before using it in the oMG, to
ensure the card has been properly configured.
Additional information on common cellular settings is available in Cellular WAN
Link Configuration Settings on page 68. For more information on specific settings
for your card contact your Mobile Network Operator or Sierra Wireless Technical Support (see Contact Information on page 3).
Rev 4 May.17 15
Operation and Configuration Guide 3.14

5.1.2 WiFi WAN Link Configuration

A WiFi link provides WAN access to the oMG via a WiFi AP which is often available in locations such as vehicle depots. Since it's usually preferable to utilize an AP when available, WiFi links are usually configured as the primary WAN access method on the oMG.
The following screenshot shows the settings for a WiFi WAN link configuration:
Figure 5-3: WiFi WAN Link Configuration
Additional details on these settings are available in WiFi Link Configuration
Settings on page 71.
Once a WiFi WAN link has been configured it must then be assigned to an AP profile which stores credential and other information required to communicate with an AP. The creation of an AP profile and its assignment to a WiFi link is described in Defining an Access Point Profile for WiFi Links on page 18.

5.1.3 Ethernet WAN Link Configuration

An Ethernet (wired) connection can also be used to provide WAN access to the oMG, though this is less common since the main purpose of the oMG is to provide mobile WAN access using wireless methods.
16 4118618
Setting up the WAN
The following screenshot shows the settings for an Ethernet WAN link:
Figure 5-4: Ethernet WAN Configuration Settings
For information about Ethernet WAN configuration settings see Ethernet Link
Configuration Settings on page 72.

5.1.4 Serial WAN Link Configuration

A serial modem can be connected to the serial port and will have a Device Type of TTY Serial Port on the Serial Modem device listing screen.
Rev 4 May.17 17
Operation and Configuration Guide 3.14
The following screenshot shows the settings for a serial modem WAN link:
Figure 5-5: Serial WAN Link Configuration
For more information see TTY Serial Port Link Configuration Settings on page 74.
5.2 Defining an Access Point Profile for
WiFi Links
An AP profile must be created for each WiFi AP that an oMG will use to access the WAN. A profile creates an association between the actual AP and the credentials (i.e. access, security, etc) required to connect to that AP from the oMG. The settings for a profile must therefore match those defined at the actual WiFi AP itself.
To define an AP profile:
1. Navigate to WAN > WiFi Networks, click Add New WiFi Network. The WiFi Network Configuration page will be shown.
2. Configure the AP profile settings based on how they are configured in the actual AP itself. Information about these settings can be found in WiFi
Networks Configuration on page 76.
3. Click Save to save the AP profile settings.
4. Set the WiFi link to use the WiFi AP profile: a. Locate the WiFi link under WAN > Links.
18 4118618
Setting up the WAN
b. Click Configure, select the AP profile from the list next to WiFi Networks,
and click Save:
Figure 5-6: Selecting a WiFi AP profile for a WiFi WAN Link
Note: If multiple WiFi access points have been defined, each access point will be listed and available for selection in the WiFi link's configuration settings.
5.3 Maintaining Communications with
Services of a WAN
The oMG can use a monitor to detect and try to recover from "high level" communication failures occurring on a healthy connection between a WAN link and a LAN segment (e.g. server timeouts due to a server being rebooted). A monitor accomplishes detection and recovery by periodically checking against its preconfigured parameters for problems such as a minimum number of connection failures, timeouts, etc.
Using a monitor helps to ensure that communication sessions between devices connected to the oMG's LAN, and services or hosts being accessed over the WAN, are maintained and reestablished if possible.
It's highly recommended that a monitor be created and configured for cellular devices.
Note: Currently, the only supported monitoring method is ICMP ping monitoring.
Rev 4 May.17 19
Operation and Configuration Guide 3.14
Note: A monitor cannot be used for detecting "low level" communication problems such as the loss of WAN connectivity (e.g. loss of cellular reception). These types of problems must be dealt with using the oMG's WAN recovery feature as described in Recovering from
Dead WAN Connections on page 31.
To create or modify a monitor:
1. Navigate to WAN > Monitors.
2. Click the Add New WAN Monitor button to create a new monitor, or click on
Configure in the Actions column to modify an existing monitor.
3. Modify the monitor settings as required to detect a dead connection, ensuring that the correct LAN segment is selected for the Source Address field. See
WAN Monitor Settings on page 76 for information on specific settings.
4. Click Save to save the monitor configuration.
5. Enable the monitor for a link:
a. If configuring a cellular or Ethernet link, enable the monitor on the link as
follows:
i. Navigate to WAN > Links, select the link to assign a monitor to and
click Configure.
ii. Locate and enable the Monitor in the link's Monitors settings. iii. Click Save to save the link configuration.
b. If configuring a WiFi Link, enable the monitor in the AP profile assigned to
the link:
i. (Optional) Identify the AP profile assigned to the WiFi link if not
already identified, from under the WiFi Networks option in the link's configuration settings:
20 4118618
Setting up the WAN
Figure 5-7: Identifying the assigned access point profile
ii. Navigate to WAN > WiFi Networks , locate the AP and click
Configure.
iii. Select the monitor under network settings:
Figure 5-8: Assigning the Monitor to the WiFi Access Point Profile
iv. Click Save to save the AP profile settings.
Rev 4 May.17 21
Operation and Configuration Guide 3.14
To delete a monitor:
1. Navigate to WAN > Monitors.
2. Locate the desired monitor to delete and click Delete in the Actions column.
3. Click OK when prompted to confirm the deletion.

5.4 Setting up a Link Policy

After configuring WAN link(s), it's recommended that one or more policies be defined for each link.
Policies are one of the more powerful features of the oMG because they provide a variety of ways to maintain network connectivity across a range of external conditions.
The oMG includes a rich set of configurable policies, which define how and when the various WAN devices installed in the unit should provide connectivity. These policies can help maintain connections as signal strengths fluctuate, and can help to maintain the most optimal and cost efficient connectivity.
This section describes how the various policies work and how to tune them for optimal connectivity and performance. Since policies can be set up to work in concert with other policies across links, this section includes a discussion and examples on how to set up multi-policy configurations.
Policies determine which link should be used based on some sort of criteria such as stability. Selection is based on a scoring system where penalties for issues (e.g. a link being down) reduce a link's score. Each link is evaluated based on its score and the link with the highest score is set to the active link. Policies can be combined to form an arithmetic score that affects active link determination.
The general goals for implementing policies are as follows:
Reduce or eliminate loss of connectivity and associated downtime
Reduce or eliminate issues associated with the loss and re establishment of a
connection such as having to rebuild a VPN connection
Maintain a stable connection
Maintain the fastest throughput available
Reduce cellular usage costs
Use "low cost" links including WIFI
To achieve these goals and make the most of these policies, oMGs are usually equipped with multiple WAN devices which include both WiFi and multiple cellular devices. This allows for the managed switching between these devices as defined by the policies.
Policies work on a system of scores which can be decremented (penalized) when some condition is exceeded (e.g. a connection is lost), and gradually incremented again once the condition has been met (e.g. a connection is eventually re-established).
These parameters allow for the dynamic selection of links based on a variety of factors and multiple policies can be combined to select a link amid a wide range of external and environmental factors.
22 4118618
Setting up the WAN
To define a policy for a link:
1. Navigate to WAN > Links and click on Policies in the Actions column.
2. Locate the desired policy in the list and click Configure in the Actions
column.
3. Set Enable this policy to checked and proceed to configure the policy settings. See Policies on page 64 for detailed information about the policy settings.
4. Click Save when the configuration is complete. Back on the policy listing screen, verify that the Enabled field is checked for the policy.
5. Repeat the steps above for any additional policies that should be configured.
Note: Policy configurations are not global across all links, and must configured on a per link basis as required.

5.4.1 Special Considerations for WiFi Links

When planning how policies will be used to select/deselect WiFi links, be sure to take the Association Settling Period and Disassociation Settling Period of WiFi links into account (see WiFi Link Configuration Settings on page 71 for a description of these settings). These settings prevent the accidental selection and de selection of a WiFi link which could occur when brief WiFi connectivity is available (e.g. when driving past a depot's WiFi hostspot).
Note: These settings are not available on cellular devices.
By default, both are set to 15 seconds, and will prevent a WiFi link's status from changing from "down" to "up" and or "up" to "down" respectively. This makes the link unavailable for selection by a policy during that 15 second time frame.
As a result, penalties and recovery periods of policies on WiFi links can generally be set to 0, since the two settling periods already handle most situations where brief WiFi connectivity is to be ignored.

5.4.2 Dynamic Priority Policy Overview

The Dynamic Priority Policy is used to provide a managed switch between WAN links for when the current link in use goes down. This policy is typically applied when multiple WAN devices have been installed in an oMG so that backup connections are available.
A key aspect of the Dynamic Priority Policy is its inherent ability to handle the "flip flopping" of connection states, where by the link may repeatedly come back online again but then return to its disconnected state. In other words, it is intended to hold off switching back to a particular link until it has proven itself stable/ trustworthy.
The Dynamic Priority Policy avoids such flip flopping between links that might occur, by effectively waiting for the unstable device to regain an acceptable level of stability before switching back to it.
Rev 4 May.17 23
Operation and Configuration Guide 3.14
There are actually two sets of settings on the Dynamic Priority Policy configuration screen:
Figure 5-9: Settings on the Dynamic Priority Screen
The first set allows for the enabling and setting of a Priority Score on a link. The priority score is added to a base score of 1000 which is assigned by the system. This combined score then indicates the priority (preference) of the link which the system determines by comparing against the scores from other links. Note that equal values can be specified when enabling the policy on different links to indicate that those links are equally preferable.
It's important to note that although this setting appears on the configuration screen of the Dynamic Priority Policy, it's actually not specific to that policy and can be set and used in conjunction with any policy.
The second category of settings are for the Dynamic Priority policy itself and include the ability to enable and specify a Link Down Penalty value which can reduce a link's score when some condition is not being met (e.g. a link has not been able to establish a connection for some time). The other value that can be defined is the Recovery Period which specifies the amount of time that a link's score will be incremented again by the system. A link "proves" itself when its score increments back to its original combined score over this period, at which point the system may reselect it as the active link.
Consider the following example where there is a WiFi device and two cellular devices (C1 and C2) installed on an oMG. The WiFi device is the most preferred device while C1 is preferred over C2. To model this in the Dynamic Priority policy the following settings were used:
Table 5-1: Example of Dynamic Priority Settings
WiFi C1 C2
Base Score 1000 1000 1000 Priority Score 300 200 100 Link Down Penalty Not Enabled 300 300 Recover Period Not Enabled 120 120
The graph in Figure 5-10 on page 25 shows a simple time line in which a vehicle is outside of a depot, C1 is the current WAN link, but the connection is eventually lost. As a result C1's overall score is re calculated using its current score minus its assigned penalty (1200-300) to give a new score of 900. Since this is lower than C2's current score of 1100, C2 takes over.
24 4118618
Setting up the WAN
When C1's connection is re-established, its recovery period of 120 seconds begins, during which C2 remains as the current WAN link, and C1's score gradually increases. When C1's score finally becomes greater than C2 again, C1 is restored as the active link, even if its recovery period has not yet completed.
The graph also shows that a short time later, the vehicle enters the WiFi zone of a depot, at which point the WiFi link, which is the most preferred link, becomes the active link.
Figure 5-10: Basic example with WiFi and two Cellular links
Note: This graph is intended to provide a basic introduction to how policies use scoring to switch between links. In practice, other factors such as a WiFi device's Association Settling Period mean that switches won't happen instantaneously.
Tip: A priority score of 100 with a penalty of 300 and a 120 second recovery time, make
for good, "granular" numbers to use because they make it easy to monitor switchovers (e.g. via logging) when using the Dynamic Priority policy. In particular a 120 second recovery time will allow for a ping monitor to occur every 30 seconds so that three pings occur during the recovery period.
See Dynamic Priority Policy on page 64 for a summary of this policy's settings.
Rev 4 May.17 25
Operation and Configuration Guide 3.14

5.4.3 Geographical Regions Policy Overview

The Geographic Region Policy increments a link's score to make it the preferable WAN link for a defined geographic bounding region. Up to three regions can be defined per link. This policy is often used when the quality and/or cost of coverage for a particular area is known ahead of time and selection of the best WAN link can be decided in advance (i.e. when configuring the WAN link).
For example, if the cellular coverage for different Mobile Network Operators is known to be good in certain areas, then regions for those areas can be defined on the respective links and scores applied accordingly.
Similarly, if there is a WiFi connection available (e.g. within and around a depot), then a region for the depot could be defined for the WiFi WAN link with a very high score to ensure that the WiFi WAN link is used when the vehicle is in or near the yard.
As a basic example, consider the following in which there are two regions, where part of each overlaps the other. The coverage in Region 1 is known to best for Mobile Network Operator 1 (C1), and the coverage in Region 2 is known to be best for Mobile Network Operator 2 (C2).
To provide the best coverage and prevent unnecessary switchovers throughout the vehicle's journey, the following policy settings were defined for two cellular WAN links and the following settings were specified:
Table 5-2: Example of Geographical Region Policy Settings
Dynamic Priority Policy
Cellular Link 1 (C1) Priority (Base) Score:
1200
Cellular Link 2 (C2) Priority (Base) Score:
1100
Geographic Region Policy
Region 1 Score: 300 Region 2 Score: 0
Region 1 Score: 100 Region 2 Score: 300
The overall score for a cellular link is then calculated as follows:
Overall score = Priority Score + Score for current region
For example, when a vehicle is in Region 1, C1's score is 1200+300=1500 and C2's score is 1100+100=1200.
In the case of overlapping regions, each link's score is calculated by including the link's score for all regions which are part of the overlap.
For example, when a vehicle is in an overlapping region comprised of Region 1 and Region 2, C1's score is 1200+300+0=1500 and C2's score is 1100+100+300=1500.
26 4118618
Setting up the WAN
Note that the scores match in the overlapping region, so a switch between cellular links will not occur when entering the overlapping zone in order to prevent an unnecessary switch as illustrated in Figure 5-11:
Figure 5-11: Geographic Region Example with overlapp ing Regio ns
Tip: Configuring the bounding boxes for each region requires knowledge about the
latitude and longitude coordinates for the upper and lower points which make up each region, since the oMG's LCI does not provide a mapping interface to visually define zones. Therefore, configuring this policy will require you to determine the coordinates to be entered in the policy.
See Geographic Region Policy on page 64 for a summary of this policy's settings.

5.4.4 Time Period Policy Overview

The Time Period Policy promotes one link over others when operating within a defined time period. Up to three time periods can be defined per link. This can be used to make use of reduced data costs or to compensate for bandwidth saturation periods.
For example, when a link's throughput is known to drop during a particular time of day (e.g. due to network congestion), a time period could be defined on a backup link for this known period with a fairly high score applied, so that the backup link is temporarily selected and used to maintain acceptable throughput.
Another use case includes switching to the link of a Mobile Network Operator who provides cheaper cellular coverage during evenings.
See Time Period Policy on page 64 for a summary of this policy's settings.
Rev 4 May.17 27
Operation and Configuration Guide 3.14

5.4.5 Velocity Policy Overview

The Velocity Policy penalizes one link so that others become preferable based on velocity. It accomplishes this by applying a penalty on a WAN link when the oMG detects that the vehicle is exceeding a specified speed threshold. This is done to proactively switch off a link in a managed way prior to the link actually failing, which would require both the connection and VPN to be re-established.
Since this policy applies a penalty when the defined speed threshold has been met and continues to penalize the link's score while the threshold is being exceeded, this policy is typically applied to a WiFi link to facilitate a managed hand off from that link to a cellular link, such as when leaving a depot.
For example, when applied to a WiFi link, the policy could define a speed threshold of 20mph so that the vehicle can travel around a depot, utilizing that link. However, once the vehicle leaves the depot and the speed threshold is met, the link becomes penalized and another link (e.g. cellular) becomes active.
A key aspect in tuning this policy is to define an appropriate speed threshold such that the switch from WiFi to cellular happens before WiFi connectively is lost. This will provide a seamless switch without a drop in connection and will prevent issues such as having to rebuild a VPN connection which normally occur when a connection is lost.
In the example of a vehicle leaving a depot, there would likely be a small area of WiFi coverage outside of the depot, and the vehicle would also likely increase its speed as it exits the region and travels through this zone. Therefore an appropriate speed threshold should be chosen to ensure that a switch to cellular occurs before WiFi connectively is completely lost, thus preventing any drop in connection during the transition from WiFi to cellular as illustrated here:
Figure 5-12: Setting a Speed Threshold to Switch to Cellular before WiFi Coverage is lost
Note that GPS "jitter" can occur when a vehicle is parked in a location which can cause the speed threshold(s) defined in the Velocity Policy to be satisfied, thus resulting in an inadvertent switch in links. It's therefore recommended that a GPS repeater be installed near the depot to reduce such jitter.
See Velocity Policy on page 65 for a summary of this policy's settings.
28 4118618
Setting up the WAN

5.4.6 Signal Strength Policy Overview

The Signal Strength Policy is typically used for the selection of WiFi and cellular connections based on signal strengths (e.g. when located in an area with good cellular coverage). In other words, it penalizes a link so that other links become preferable and thus proactively selected based on signal strengths. This requires that multiple wireless devices have been installed, often with one link identified as the preferred link and the other(s) as the backup link(s).
Note: For cellular devices, this policy is only available for "Direct IP" cell cards and not for older "PPP style" cards. This is because the signal strength of the latter cannot be deter­mined while the call is up.
The policy applies a penalty to a link when its signal strength falls below a specified threshold to decrease its score. The link's penalty is removed when the signal strength returns and the recovery period is successfully met. This helps to ensure that signal strengths stabilize before switching back to preferred links.
If one link has been configured as the preferred link (e.g. due to lower data plan costs), then the Signal Strength Policy should be configured on each link such that lower quality signal strengths are acceptable on that preferred link. This will help to ensure that the preferred link is utilized the most as signal strengths between devices fluctuate.
If devices from different Mobile Network Operators are equally preferable, the signal strength in the policy for each device's link should be set the same. This will prevent an unnecessary switchover from occurring since both devices have been designated as equally capable.
Note that since a weak signal can still provide good throughput and a good signal may not always provide good throughput (e.g. due to the variance of the Internet), the Signal Strength policy is typically used to drop a bad connection that doesn't necessarily cause a ping monitor failure. A typical threshold for switching to another link is when the signal strength drops to -85 dBm. Dropping the connection at higher levels may unnecessarily deprive the oMG from good performance or result in the switch over to a lower performing link.
See Signal Strength Policy on page 65 for a summary of this policy's settings.

5.4.7 Use Cases

5.4.7.1 Dynamic Priority Policy and Velocity Policy
Combination
The following example shows how to combine the Dynamic Priority Policy with the Velocity Policy to choose between links.
In this example, an oMG is equipped with a WiFi and a cellular link. The Dynamic Priority Policy has been applied to both links with a default score of 1200 for the WiFi link, and 1000 for cellular. The goal here is to choose WiFi as the preferred link whenever possible since its performance, cost of use, and connection quality
Rev 4 May.17 29
Operation and Configuration Guide 3.14
should be superior to that of the cellular link, when WiFi is available. The WiFi link has been assigned a penalty of 600 which will cause its score to fall below that of the cellular link when the WiFi connection is lost.
The Velocity Policy has also been applied to the WiFi link with a speed threshold of 25mph and a penalty of 600. This ensures that the WiFi link's score falls below that of the cellular link when the vehicle's speed becomes too high.
Figure 5-13 provides a timeline showing how an oMG uses this configuration to
choose between a WiFi link and a cellular link:
Figure 5-13: Dynamic Priority and Velocity Policy Combination
The following can be observed on this timeline:
WiFi starts with a higher score of 1200; cellular with 1000. The vehicle is stationary with no speed.
At 6 minutes, the WiFi connection is lost and the cellular connection takes over because the Dynamic Priority Policy drops the WiFi link's score below that of the cellular link's.
At 9 minutes, the WiFi link recovers and a link down penalty of 600 is applied.
The WiFi connection's score continues to increase over its link recovery
period.
At 18 minutes, the WiFi's score exceeds that of the cellular link and it becomes the active link.
At around the same time the vehicle starts to accelerate.
At 26 minutes, the vehicle’s speed exceeds the speed threshold defined in
the Velocity Policy on the WiFi link. This reduces the score of that link by 600 causing the cellular link to take over.
30 4118618
Loading...
+ 71 hidden pages