Cypress Solutions Oxygen 3 Oxygen Gateway User Guide

The Oxygen 3 is a 4G LTE cellular gateway with a built-in battery. It can provide for 6-8 hours of power under normal operating conditions. The Oxygen 3 can be configured to send alerts via SNMP when the transition to battery power occurs. This provides for immediate notification of AC power issues. The Oxygen 3 can subsequently be queried for battery life, and further alerts can be sent based on remaining battery life.

PDF

Document

Oxygen 3 User

Guide

Model

Revision

Firmware

Oxygen-3

Rev 1.3

Rev 4.4.1

3066 Beta Avenue Burnaby, B.C. V5G 4K4

Phone: 604.294.4465

Fax: 604.294.4471 [email protected]

Revision Control 2

Revision Control

Description

Release Update

Revision

Rev 1.3

Rev 1.2

Rev 1.1

Date

29-‐Sep-‐2015

23-‐Sep-‐2015

04-‐Mar-‐2015

Contents

Revision Control ............................................................................................................................................. 2

Contents ......................................................................................................................................................... 2

Legal Notices ........................................................................................................................................... 5

1.1

Regulatory Restrictions .................................................................................................................... 5

1.2

Electromagnetic Interference (EMI) – United States FCC Information ............................................. 5

1.3

Electromagnetic Interference (EMI) – Canada Information ............................................................. 6

1.4

Li-‐Ion Battery .................................................................................................................................... 6

Specifications ........................................................................................................................................... 7

2.1

Package Contents ............................................................................................................................. 7

2.2

General ............................................................................................................................................. 7

2.3

Wireless ............................................................................................................................................ 7

2.4

Ports ................................................................................................................................................. 8

2.5

Processor and Memory .................................................................................................................... 8

2.6

Power ............................................................................................................................................... 8

2.6.1

Integrated Battery Operation .................................................................................................... 8

2.6.2

Power over Ethernet ................................................................................................................. 8

2.7

Environmental .................................................................................................................................. 9

2.8

Physical Dimensions and Weight ...................................................................................................... 9

2.9

Antennas .......................................................................................................................................... 9

Hardware Setup and Installation ........................................................................................................... 10

3.1

Inserting the SIM card .................................................................................................................... 10

3.2

Connector Overview ....................................................................................................................... 11

Contents 3

3.3

Installing the Antennas ................................................................................................................... 11

3.4

Supplying the Oxygen Gateway with Power ................................................................................... 11

3.5

Physical Installation ........................................................................................................................ 12

Basic Operation ..................................................................................................................................... 13

4.1

Power Up ........................................................................................................................................ 13

4.2

LEDs ................................................................................................................................................ 13

4.3

Logging into the Oxygen Gateway .................................................................................................. 15

4.4

Changing and Saving the Config ..................................................................................................... 15

4.5

Quick Start Configuration ............................................................................................................... 16

Using the Web Interface ........................................................................................................................ 17

5.1

LAN Port page ................................................................................................................................. 17

5.1.1

Router Mode ........................................................................................................................... 17

5.1.2

Pass-‐Through Mode ................................................................................................................. 18

5.1.3

LAN Port Speed ........................................................................................................................ 21

5.1.4

Secondary IP Address .............................................................................................................. 21

5.1.5

DNS Support ............................................................................................................................ 22

5.1.6

Customer Premise Equipment (CPE) Monitoring .................................................................... 23

5.2

WWAN Page ................................................................................................................................... 23

5.2.1

WWAN Connection Settings .................................................................................................... 23

5.2.2

Network Technology and LTE Band Selection ......................................................................... 24

5.2.3

WWAN Connection Timeouts .................................................................................................. 25

5.2.4

Bandwidth Throttling ............................................................................................................... 25

5.2.5

Cellular Network Watchdog .................................................................................................... 25

5.3

Access Control Page ....................................................................................................................... 26

5.4

Routing Page ................................................................................................................................... 27

5.5

IPsec VPN Page ............................................................................................................................... 27

5.5.1

Dead Peer Detection ............................................................................................................... 29

5.5.2

NAT Traversal .......................................................................................................................... 29

5.5.3

Secondary IPSec Peer .............................................................................................................. 30

5.6

Dynamic DNS .................................................................................................................................. 31

5.7

Name and Password ....................................................................................................................... 31

5.7.1

Hostname ................................................................................................................................ 31

5.7.2

Radius Authentication ............................................................................................................. 32

5.7.3

Date and Time ......................................................................................................................... 32

Contents 4

5.8

Advanced Settings .......................................................................................................................... 33

5.8.1

Flash Upgrade .......................................................................................................................... 33

5.8.2

Automatic Background Ping .................................................................................................... 36

5.8.3

Transparent TCP Proxy ............................................................................................................ 36

5.8.4

Failsafe Configuration .............................................................................................................. 38

5.8.5

Configuration Download ......................................................................................................... 38

5.9

Event Logging ................................................................................................................................. 39

5.10

Traffic Counter .............................................................................................................................. 40

5.11

Cypress Cloud Manager ................................................................................................................ 40

5.11.1

Basic Setup ............................................................................................................................ 41

5.11.2

Advanced Setup ..................................................................................................................... 41

5.12

SNMP Settings .............................................................................................................................. 42

5.12.1

Cypress Vendor MIB .............................................................................................................. 42

5.12.2

SNMP Polling ......................................................................................................................... 42

5.12.3

SNMP Traps ........................................................................................................................... 43

Using the Command Line ...................................................................................................................... 44

6.1

Accessing the Command Line Interface ......................................................................................... 44

6.2

Configuration Tool Utility (cfgtool) ................................................................................................. 45

6.3

Packet Tracing (tcpdump) ............................................................................................................... 46

6.4

Wireless Network Information (rssimon) ....................................................................................... 47

6.5

Ping ................................................................................................................................................. 48

6.6

HPing .............................................................................................................................................. 49

6.7

iPerf ................................................................................................................................................ 50

6.8

Arp Cache ....................................................................................................................................... 51

Understanding the Signal Quality Indicator (SQI) .................................................................................. 52

Reverting to Factory Default Configuration .......................................................................................... 53

Troubleshooting .................................................................................................................................... 54

Contact ......................................................................................................................................................... 55

Legal Notices 5

Legal Notices

Due to the nature of wireless communication the reception or transmission of data can never be guaranteed. Data may be delayed, corrupted or never received. Data transfer problems are rare with well-‐constructed and configured wireless networks used in conjunction with devices such as the Oxygen

wireless gateway.

Cypress Solutions Inc. accepts no responsibility for damages of any kind including but not limited to personal injury, death, or loss of property due to the delay or loss of data resulting from the use of the

Oxygen wireless gateway.

1.1

Regulatory Restrictions

CAUTION: Any modifications to the Oxygen 3 wireless gateway not expressly authorized by Cypress

Solutions Inc. may cause its regulatory approval status to become invalidated, thereby voiding your authority to use the product.

The Oxygen 3 wireless gateway contains a wireless device approved under FCC CFR 47 part 2.1091 and

Industry Canada RSS-‐102 rules for operation as a mobile or fixed device. Maximum allowed antenna gain including cable loss is as follows:

• 6.5 dBi in Cellular band

• 3.0 dBi in PCS band

• 3.0 dBi in LTE Band 2

• 6.0 dBi in LTE Band 4

• 6.5 dBi in LTE Band 5

• 9.0 dBi in LTE Band 13

• 9.0 dBi in LTE Band 17

• 3.0 dBi in LTE Band 25

Separation distance of at least 20cm (8”) must be maintained from all persons at all times and during all modes of operation. The antenna used must not be co-‐located or operated in conjunction with any other antenna or transmitter. These rules are in place to prevent any possible hazard due to personal exposure

to electromagnetic radiation.

1.2

Electromagnetic Interference (EMI) – United States FCC Information

This equipment has been tested and found to comply with limits for a class B digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a commercial installation. This equipment generates, uses, and can radiate radio frequency energy, and if not installed and used in accordance with the instructions, may cause harmful

Legal Notices 6

interference to radio communication. However, there is no guarantee that harmful interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:

• Reorient or relocate the receiving antenna

• Increase the separation between the equipment and receiver

• Connect the equipment into an outlet on a circuit different from that to which the receiver is connected

• Consult the dealer or an experienced radio/TV technician for help

1.3

Electromagnetic Interference (EMI) – Canada Information

This digital apparatus does not exceed the class B limits for radio noise emissions from digital apparatus as set out in the interference causing equipment standard entitles “Digital Apparatus”, ICES-‐003 of the

Department of Communications.

Cet appareil numérique respecte les limites de bruits radioélectriques applicables aux appareils numériques de Classe B prescrites dans la norme sur le matériel brouilleur: “Appareils Numériques”,

NMB-‐003 édictée par le Ministre des Communications.

1.4

Li-‐Ion Battery

The Oxygen-‐3 Gateway contains a rechargeable and non-‐removable Li-‐Ion battery. The Li-‐

Ion battery should last for the life of the product and replacement can only be done at the factory. If for any reason the Li-‐Ion battery pack is being discarded, it must be disposed of in accordance with regulations for battery recycling in the region the device is

being operated in.

The Li-‐Ion battery contained within the Oxygen-‐3 Gateway complies with UN/DOT 38.3

UN Transportation testing for Lithium Batteries.

Specifications 7

Specifications

2.1

Package Contents

The Oxygen-‐3 gateway comes with the following items:

• Oxygen 3 wireless gateway

• Rubberized mounting bracket

• Cat5e cable

• Cellular antennas (2)

• Power adaptor, 90-‐250VAC to 12VDC

2.2

General

• Input Voltage: 9-‐16 VDC with transient (spike) protection, 12 Volt nominal

• Locking power connector

• Built-‐in 15Wh Li-‐Ion backup battery

• Current consumption: 300-‐400 mA @ 12V during regular operation, up to 1A when simultaneously charging the built-‐in battery

• Power over Ethernet (PoE PD – fully 802.3af compliant)

Power connector pin-‐out for Oxygen-‐3 P/N: 5115-‐9001, Molex P/N: 39-‐30-‐1040

PWR Power

GND Ground

CHG Currently not used

IGN Currently not used

Power connector pin-‐out for Oxygen-‐3 P/N: 5115-‐2001, Molex P/N: 39-‐30-‐1040

PWR Power

GND Ground

CHG Charge

IGN Ignition

2.3

Wireless

LTE

LTE Bands

WCDMA

WCDMA Bands

GSM/GPRS/EDGE

Category 3

2, 4, 5, 13, 17, 25 -‐ not all bands are available with all carriers

HSDPA (cat. 14), HSUPA (cat. 6), DC-‐HSPA (cat. 24)

I, II, IV, V, VIII

Supported for 2G fallback when available

Specifications 8

• Fall back to GSM/GPRS/EDGE where available

• On board logic for always-‐on, always-‐connected operation.

• Embedded radio design

2.4

Ports

• 1x Fast Ethernet auto MDI/MDIx (RJ45)

• USB 2.0 device support (Micro USB)

• 2x SMA RF Antenna ports: MIMO, Diversity

• Power Connector (Molex P/N: 39-‐30-‐1040)

Note:

The USB Port is not used unless Oxygen-‐3 gateway is ordered for USB Mode of operation

2.5

Processor and Memory

• Hardware ·∙ 800 Mhz Super Scalar ARM Cortex processor

• 256 MB RAM

• 128 MB Flash

• Dual Flash image technology avoids firmware corruption

2.6

Power

2.6.1

Integrated Battery Operation

The Oxygen has an integrated battery that can provide for 6-‐8 hours of power under normal operating conditions. Transitioning from AC or PoE power to running on battery is non-‐disruptive, with cellular connectivity and customer applications unaffected. This provides the following benefits:

• Initial placement and positioning of the unit to achieve the best RF conditions can be performed free of cabling restraints.

• The Oxygen-‐3 can be configured to send alerts via SNMP when the transition to battery power occurs, providing for immediate notification of AC power issues at a location. The Oxygen-‐3 can subsequently be queried for battery life, and further alerts can be sent based on remaining battery life.

2.6.2

Power over Ethernet

The Oxygen-‐3’s Ethernet port supports Power over Ethernet (PoE) and is fully 802.3af compliant. The

Oxygen Gateway will act as a PoE PD (‘Powered Device’), meaning that it will draw power from a PoE power source.

This allows for flexibility in the installation process, specifically if the unit is located in an area where AC power may not be available.

Specifications 9

2.7

Environmental

• Environmental MIL-‐STD-‐810G o Clause 501.5: Procedure II – High Temp (+75°C operational test) o Clause 502.5: Procedure II -‐ Low Temp ·∙ (-‐35°C operational test) o Clause 503.5: Procedure I-‐C -‐ Thermal Shock (+75°C to -‐35°C operational test) o Clause 507.5: Procedure II -‐ Humidity 95% RH operational test

• MIL-‐STD-‐810F: ·∙ o Method 514.5C -‐ Random Vibration freq. range 5-‐500 Hz, 0.008 g2/hz spectral density o Method 516-‐I -‐ Shock -‐ 40g, 11ms, Saw-‐ tooth pulse shape, 3 axis operational test

2.8

Physical Dimensions and Weight

Dimensions

Weight

173mm x 103mm x 42mm (L x W x H)

455 grams

2.9

Antennas

Antenna Specifications:

Frequencies 700/2100 694-‐960/1710-‐2170 MHz

Hardware Setup and Installation 10

Gain

VSWR

Impedance

Maximum Power

3dBi peak

2:1 max over range

50 Ohm nominal

5 Watt

Operating Temperature -‐40 deg.C to +85 deg.C

Connector SMA Plug (Male)

Hardware Setup and Installation

3.1

Inserting the SIM card

Step 1 -‐ Remove Mounting Bracket

To gain access to the SIM card holder, first remove the black mounting bracket by bending the corner clasps on the connector side of the Oxygen-‐3 Gateway outwards.

Step 2 – Remove SIM card cover

Place the Oxygen-‐3 on a clean work surface with the bottom side up. Lift and remove the small cover door and place it aside.

Step3 -‐ Insert SIM Card

Slide the black SIM card holder lid towards the back to the unlock position; lift the SIM card holder door until it is flipped open.

Ensure the contact area of the SIM card is visible and that the chamfer corner (angled corner) of the SIM card is located as shown.

Close the black SIM card holder.

Press and slide the black SIM card holder lid forward until the lid locks into place.

Hardware Setup and Installation 11

3.2

Connector Overview

Secondary Antenna

Connector (SMA)

LAN Port

PoE 802.3af compliant

Step 4 -‐ Reassemble Cover

Place the cover door back onto the device.

(Optional re-‐assembly of mounting bracket not shown)

Primary Antenna

Connector (SMA)

Reset / Power

Switch

DC Power

Connector

3.3

Installing the Antennas

Connect both antennas to the primary and secondary cellular SMA ports on the Oxygen. These ports are labelled PRI-‐RF and SEC-‐RF. The antennas can be attached by turning the antenna thumb wheel in a clockwise direction until they are snug.

Do not tighten the antenna using any means other than normal thumb pressure. Turning the

antennas independent of the thumb wheel may result in damage to the SMA jacks.

3.4

Supplying the Oxygen Gateway with Power

Hardware Setup and Installation 12

The Oxygen Gateway can run off three different power sources:

• The built-‐in battery (temporary only – the battery can typically supply power for 6-‐8 hours)

• DC power via the Molex locking power connector

• PoE power via the Ethernet port from a 802.3af compliant power source

Depending on your installation conditions, connect the supplied power adapter to the Oxygen Gateway’s power connector or connect to a PoE power source using an Ethernet cable.

3.5

Physical Installation

The Oxygen Gateway ships with a rubberized mounting bracket attached. This bracket can be removed by

bending the rubber clasps at the corners outwards.

The mounting bracket has 8 holes to mount it securely to a flat surface. Cypress Solutions recommends using at least two mount points in diagonally opposite corners.

Use the drawing below for dimensions:

After the mounting bracket has been firmly installed, the Oxygen Gateway can be inserted by bending the corner clasps outwards and slipping the Oxygen Gateway in.

Basic Operation 13

Basic Operation

4.1

Power Up

Reset

Off

The Oxygen has a small 3-‐way switch on the back panel which serves as a power and reset switch.

• When set to the ‘Off’ position, the Oxygen Gateway is permanently off with only the integrated Real

Time Clock (RTC) still being powered

• When set to the ‘On’ position, the Oxygen Gateway will power up immediately when DC power or

PoE power are applied. It will remain on and will continue to run off the built-‐in battery if DC power or PoE power are removed.

• Moving the switch to the temporary ‘Reset’ position will cause the Oxygen Gateway to power up using battery power, even if no DC or PoE power are applied. The switch is spring-‐loaded and will not remain in the ‘Reset’ position, but will automatically move back to the ‘On’ position.

If moving the switch to the ‘Reset’ position fails to power up the Oxygen Gateway, then the built-‐in

battery is likely fully discharged.

The reset switch is also used to revert the Oxygen Gateway back to factory default configuration. See section 7 for more information.

4.2

LEDs

The Oxygen Gateway has 6 LEDs on its top panel:

• 1x Power LED (blue)

• 3x Signal strength LEDs (green)

• 1x Network Technology Indicator LED (orange)

• 1x Online Status LED (red)

Basic Operation 14

On: Online

Online Status Rapid Flashing: Attempting to Connect

Flashing:

Network Type Flashing:

Power

On:

Off:

On:

Disconnected

4G (LTE)

3G (WCDMA)

Unit is turned on

Off: Unit is powered off

The 3 signal quality LEDs will light up and/or flash in a distinct pattern to provide a granular reading of the

current signal strength:

SQI:

1-‐10

11-‐17

18-‐24

25-‐31

Off

No Signal

Slow Flashing

Regular Flashing

Rapid Flashing

32-‐38

39-‐45

Refer to section 7 for more information on how to interpret the Signal Quality

Index (SQI) value.

46-‐52

53-‐59

60-‐66

67-‐73

74-‐80

81-‐100

Very Strong Signal

Basic Operation 15

4.3

Logging into the Oxygen Gateway

The Oxygen wireless gateway can be configured via a web configuration interface. The primary method to access the configuration interface is by plugging a standard Ethernet cable into the LAN port of the

Oxygen wireless gateway.

By default, the Oxygen Gateway will act as a DHCP server and provide the IP address

169.254.0.2/24

to a connected computer.

If your computer is not setup to obtain an IP address via DHCP, then you have to configure your

computer’s LAN interface manually as follows:

IP Address: 169.254.0.2 -‐ Network Mask: 255.255.255.0 -‐ Gateway: 169.254.0.1

After plugging into the LAN port, the Oxygen Gateway’s web interface can be accessed at:

http://169.254.0.1

When logging into the web interface, the Oxygen Gateway will show its status and overview screen. To access any of the configuration pages, a login and password and password are required. The default login

and password for the Oxygen wireless gateway are:

Login: admin

Password: cypress

4.4

Changing and Saving the Config

The Oxygen Gateway’s web interface is designed so that configuration changes can be made and temporarily saved on any of the configuration pages without having to wait for the device to apply those changes.

Once all desired configuration changes have been made, they can be permanently saved and applied by

clicking on the ‘Apply New Config’ at the top left corner of the web interface:

Basic Operation 16

A typical configuration session looks as follows:

Point browser to

169.254.0.1

Click on any config page link on the left

1 st

time: login with admin/cypress

Make changes to configuration

Note:

repeat, if required…

Click on

when done…

Click on

Clicking on ‘Save’ only saves configuration changes temporarily and will not yet apply them.

Without clicking on ‘Apply New Config’ at the end of the configuration session, all changes will be lost after a reboot.

4.5

Quick Start Configuration

The Oxygen Gateway ships with its default configuration set to ‘Automatic Pass-‐Through’. After having

inserted a SIM (see section 3.1), only one more step is required to obtain basic connectivity:

• Click on the ‘WWAN’ link on the left side of the Oxygen Gateways web interface

• Enter the APN as required by your carrier

• Click on ‘Save’, then click on ‘Apply New Config’

The Oxygen Gateway should now successfully connect to the wireless network and the ‘Online’ LED

should light up red after a short time (refer to section 4.2 for more information).

If your computer is setup to obtain its IP address via DHCP, it should renew its DHCP lease and obtain an

IP address provided by your wireless carrier. For more information on the default ‘Automatic

Pass-‐Through’ mode, refer to section 5.1.2.2.

Using the Web Interface 17

Using the Web Interface

5.1

LAN Port page

5.1.1

Router Mode

The Oxygen Gateway can operate in two fundamental Modes of Operation: ‘Router Mode’ and ‘Pass-‐

Through Mode’. To select the desired Mode of Operation, go to the ‘LAN Port’ configuration page within the web configuration interface.

In Router Mode, the Oxygen wireless gateway will obtain an IP address from the wireless carrier.

Additional devices can connect via the LAN port by using network address translation (NAT) and/or IPsec tunneling.

IP addresses can be statically assigned to connected devices, or the can be automatically assigned using

DHCP. If using DHCP, the Enable DHCP Server on LAN Port checkbox must be checked, and a range of valid addresses be specified in the DHCP IP Range Start and DHCP IP Range End fields.

If IPsec is required by the application, it is mandatory that the Mode of Operation be set to Router Mode.

IPsec will not operate in Pass-‐Through Mode.

Network Address Translation (NAT) can be turned on or off by selecting or deselecting the Enable NAT on

LAN Port checkbox.

If IPsec is NOT being used, enabling NAT will translate all source IP addresses for traffic outbound on the cellular interface (wwan0) to the IP address assigned by the carrier network when the modem is connected to the network successfully. Inbound traffic to the Oxygen Gateway from the cellular network

Using the Web Interface 18 will not be passed to the LAN network unless an established session was previously initiated by a LAN-‐ connected device.

If IPsec is being used, enabling NAT will translate all source IP addresses for traffic outbound on the cellular interface (wwan0) to the IP address assigned by the carrier network when the modem is connected to the network successfully, unless the destination IP address of the packet matches the

destination private network of a defined IPsec tunnel. This is commonly referred to as Split Tunneling.

Link-‐down Time when IP Changes is not applicable in this mode.

5.1.2

Pass-‐Through Mode

In Pass-‐Through Mode, the IP address assigned by your carrier will be passed on to another device connected to the Oxygen Gateway on the Ethernet port.

Since the connected device will assume the IP address assigned by your carrier, that IP address is no longer available for any of the Oxygen’s interfaces: neither the internal cellular interface nor the Oxygen’s

LAN interface.

However, it is required for the LAN interface to have an IP address and network mask so that it forms a valid IP network which includes the IP address provided by your carrier which has been assigned to the connected device.

Even though in this mode packets generally just pass through the Oxygen Gateway, you can still access this gateway over the cellular WWAN interface for configuration and monitoring by setting up access rules on the 'Access Control' screen. This allows for all inbound traffic to “pass-‐through” the Oxygen

Gateway to the connected Ethernet device, with the exception of traffic on specified management ports.

This is also referred to as “pin-‐hole” management

5.1.2.1 Pass-‐Through Mode with static LAN Port IP Addresses

In this mode, the Oxygen’s LAN port will assume a static IP address and network mask.

The IP address of the connected device (which has to be the IP address provided by your cellular carrier) can either be configured statically on the connected device, or the Oxygen Gateway can assign this

address to the connected device using DHCP.

In both cases, the IP address and network mask of the LAN port can be arbitrarily chosen, however the IP network created by the LAN address and mask has to include the IP address of the connected device.

Example 1:

Assuming that the wireless carrier assigns a static IP address to your SIM of 74.198.154.37, this address

would be configured on the connected device. Then, an arbitrary network mask and IP address for the

Oxygen’s LAN port would need to be identified. In this case, using an IP subnet calculator and smallest possible mask, it is clear that the Oxygen’s LAN port can be configured for 74.198.154.38, with a 30 bit subnet mask.

Using the Web Interface 19

In the above example, the Oxygen Gateway’s LAN port is configured as 74.198.154.38/30, while the

connected device is configured with the real wireless carrier IP of 74.198.154.37/30.

Since the IP address of the connected device is configured manually, the Enable DHCP Server on LAN Port option can be left unchecked.

Example 2:

Using a custom APN, your wireless carrier assigns a dynamic IP address, however it is known that this IP address will always be part of the 22.33.44.0/24 network. The custom APN is also set up in a way so that

the address 22.33.44.1 will never be assigned.

This makes it possible to configure the Oxygen Gateways LAN port statically and use DHCP to assign the carrier provided IP address to the connected device.

In this case the Oxygen’s LAN port IP address and network mask would be set to 22.33.44.1/24 and DHCP would be enabled. Since the Oxygen Gateway will always assign the carrier-‐provided IP address to the

connected device, it is not required to enter anything in the DHCP IP Range Start and DHCP IP Range End fields.

Using the Web Interface 20

5.1.2.2 Pass-‐Through Mode with fully automatic IP assignment

This option will automatically assign the correct carrier-‐provided IP address to the connected device and will also configure the Oxygen wireless gateway’s LAN interface using a suitable IP address and subnet.

This option requires DHCP be enabled on the Oxygen Gateway in order to function correctly.

The connected device must also be set to use DHCP to obtain an IP address, mask, and gateway from the

Oxygen Gateway in order for this mode to work correctly.

Upon connecting to the cellular network, the Oxygen Gateway receives an IP address from the carrier.

The Oxygen will then, based on received IP address, determine the smallest possible subnet mask and IP address for its Ethernet port.

The connected device running DHCP will receive the IP address provided by the carrier as well as a matching network mask and gateway IP address from the Oxygen Gateway.

Note:

If your wireless carrier assigns dynamic IP addresses, the IP address received by the Oxygen Gateway may change upon each connection attempt. However, the DHCP protocol, which is used by the connected device to obtain the IP address, contains no method for the DHCP host (the Oxygen Gateway) to inform the client (the connected device) that an IP address change has occurred.

Instead, the Oxygen Gateway will turn off the carrier (‘bringing the link down’) on the local Ethernet segment for a configurable amount of time in an attempt to encourage the connected device to release its current IP address and obtain a new one.

For most connected devices, the default link-‐down time of 3 seconds is sufficient, however some devices may require a longer time which can be configured using the Link-‐down Time when IP Changes option.

Using the Web Interface 21

A small number of devices may not react to a link-‐down event at all -‐ some Cisco routers with pre 15.x IOS firmware are known to behave this way. Unfortunately, those devices will never reliably work with dynamic IP addresses in Pass-‐Through mode.

Since the Oxygen Gateway will always assign the carrier-‐provided IP address to the connected device, it is

not required to enter anything in the DHCP IP Range Start and DHCP IP Range End fields.

5.1.3

LAN Port Speed

The Oxygen Gateway’s Lan Port Speed settings can be automatically negotiated, or fixed for specific speed and duplex settings as per requirements. Settings are applied using a pull down menu.

When selecting a fixed LAN Port speed, make sure it matches that of the connected device,

otherwise no communication is possible.

5.1.4

Secondary IP Address

The Oxygen wireless gateway also has support for a secondary static IP address on the LAN port. This option is useful when the connected device (for example a Cisco router) has the capability of supporting a secondary IP address on the same physical port.

Even though the Oxygen Gateway supports management over the wireless network, it can be desirable to manage the Oxygen via the Ethernet port. This maybe particularly true in cases where the wireless carrier provides a dynamic (and therefore changing) IP address. However, even with static carrier provided IP

addresses, using the Oxygen’s Ethernet port for management avoids additional data usage charges on cellular subscriptions and can therefore be advantageous.

By default, the Oxygen Gateway has a secondary IP network of 169.254.0.1/24 enabled on its LAN port:

It is important to note that the Oxygen’s default route is the internal wireless interface. When accessing the Oxygen Gateway via the Ethernet interface for management purposes, routes may have to be established to return traffic via the Ethernet port to the management server(s). This can be achieved

using the Routing configuration screen.

Example:

The example below shows an Oxygen-‐3 configured with secondary IP implementation in a Cisco router network:

Using the Web Interface 22

• The Oxygen-‐3 operates in Pass-‐Through mode, and has obtained a public static IP address from the cellular carrier.

• A secondary IP network has been configured on the Oxygen Gateway, as well as on the cisco router. The secondary IP network has been added to the cisco routing process, advertising the subnet to distant downstream networks and routers.

• The Oxygen Gateway has been configured to route all traffic from the 192.168.37.0/24 network via the Ethernet port, keeping this traffic away from the cellular network.

5.1.5

DNS Support

The Oxygen Gateway can be set up to use up to two static DNS servers or it can be configured to use the

DNS server(s) provided by your wireless carriers. Alternatively, DNS can also be disabled altogether.

DNS settings configured on the LAN Port page apply to connections originating from the Oxygen Gateway

and they will also be provided to any connected device that uses DHCP if enabled.

Using the Web Interface 23

Note:

Changes made to the DNS settings here will not automatically propagate to attached devices that use

DHCP to obtain their DNS settings. It is required to either wait until the attached device renews its DHCP lease or to manually initiate a DHCP lease renewal on the attached device.

5.1.6

Customer Premise Equipment (CPE) Monitoring

The Oxygen Gateway can monitor CPE devices connected to the Ethernet port using ICMP echo requests.

The Oxygen Gateway will monitor for ICMP echo replies, and consider the connected device up when replies are received. If/when the device connected behind the Oxygen stops responding to ICMP packets, an outbound SNMP trap can be transmitted to notify parties monitoring the equipment.

CPE monitoring works with all modes of operation. When configured for Router Mode, it is mandatory configure the IP Address to Monitor field. In Pass-‐Through Mode, the Oxygen Gateway will always monitor the IP address provided by your carrier and the IP Address to Monitor field can be left empty.

5.2

WWAN Page

5.2.1

WWAN Connection Settings

In order to successfully connect the Oxygen wireless gateway to a cellular network of your choosing, an access point name (APN) must be entered into the gateway. Your wireless carrier will provide this APN at the time your SIM card is activated.

Some carriers may also need a unique login and password in addition to the APN name in order to gain

access to the wireless network, even though this has become increasingly rare.

In addition to providing a username and/or password, it may also be necessary to specify the authentication method as ‘PAP’ or ‘CHAP’. Again, this has become increasingly rare and in almost all cases

this configuration option can be left unchanged.

Using the Web Interface 24

5.2.2

Network Technology and LTE Band Selection

In some cases it may be necessary to restrict the Oxygen Gateway’s wireless module to a certain network

technology (2G, 3G, 4G or a combination thereof) or to force the exclusive usage of a certain LTE band:

When the Oxygen Gateway is configured to use a certain LTE band, the following rules apply:

• If ‘Network Type Selection’ is set to ‘All Available’, the Oxygen Gateway will fall back to 3G and/or

2G service if the selected LTE band is not available or the LTE signal is otherwise disrupted.

• If ‘Network Type Selection’ is set to ‘4G/3G only’, the Oxygen Gateway will fall back to 3G service if the selected LTE band is not available or the LTE signal is otherwise disrupted.

• If ‘Network Type Selection’ is set to ‘4G (LTE) only’, the Oxygen Gateway will be unable to connect to the wireless network if the selected LTE band is not available or the LTE signal is otherwise disrupted.

Using the Web Interface 25

5.2.3

WWAN Connection Timeouts

Less Aggressive Dialing is required for certain networks and is recommended to be used on Rogers

Wireless in Canada, Verizon Wireless in the United States, as well as all Jasper Control Center based carriers. Enabling this option will increase the delay between unsuccessful connection attempts.

Maximum Connection Time sets the unit to automatically disconnect from the network based on a time interval.

In case of network instability, this can be used as a means to restart the

connection after a certain amount of time.

Enabling the Idle Disconnect Timer forces the Oxygen Gateway to disconnect after a configurable period of no bidirectional traffic was detected on the wireless interface. Since this presents another mechanism to recover from potential network problems, it is recommend to

leave this option enabled.

5.2.4

Bandwidth Throttling

Bandwidth throttling on the cellular interface is possible when using the Oxygen Wireless

Gateway. Upload and download limits are configurable for both directions in kilobits per second. If no throttling is desired, simply leave the value as zero to disable the feature.

5.2.5

Cellular Network Watchdog

The Oxygen Wireless Gateway has the ability to monitor the availability of the cellular downlink via the watchdog function. The watchdog encompasses two dimensions; first, if an ICMP packet fails to reach either the primary or secondary monitoring IP address the radio module will be reinitialized. Second, if successive attempts to reach the primary or secondary monitoring IP address fail, the device will reboot at the prescribed interval.

Using the Web Interface 26

5.3

Access Control Page

The Oxygen wireless gateway offers granular access control depending on what interfaced is used to

access the unit for administrative or monitoring purposes.

Use caution when configuring Access Control rules. For example, disabling all Web access will

make it impossible to further access the Oxygen Gateway using a web browser. It may be necessary to resort to reverting to factory default settings to re-‐gain access.

The default Access Control settings are shown below:

As can be seen above, there are a 5 administrative services available on the Oxygen Gateway:

Web/HTTP – HTTPS – SSH – Telnet -‐ SNMP

Each one of these services can be accessed in 4 different ways. Each combination of service and access method can be turned on or off and a specific access port can be selected.

By default access via the WWAN interface, as well as Telnet access, is turned off for security reasons.

Note:

The default access ports on the WWAN interface are set to non-‐standard ports. This is to avoid conflicts with services running on the connected device when operating on Pass-‐Through mode. In Pass-‐Through mode all incoming WWAN traffic will be forwarded (“passed through”) to the connected device, except for traffic which is designated here to be management traffic.

For example, If the WWAN SSH access port were to be set to the default port 22, then the Oxygen

Gateway would intercept all regular port 22 SSH traffic and thereby prevent it from reaching the connected device. It therefore is advisable to use non-‐standard ports for access via the WWAN interface.

The Oxygen Gateway also allows for white-‐listing up to eight specific networks for exclusive access by

these networks:

Using the Web Interface 27

If the configuration fields above are left empty, then access is granted to all source networks.

5.4

Routing Page

The Oxygen wireless gateway attempts to automatically establish its own IP routes, using the WWAN interface as the default route.

However this can be changed manually (in Pass-‐Through mode only) and additional static routes can be configured for up to 5 destination networks. For each of these networks, either the LAN or WWAN interfaces can be designated as the outbound route.

It is not required to add routing table entries for SNMP traps, remote syslog servers or NTP servers. These routes are automatically established depending on the settings on their corresponding configuration screens.

5.5

IPsec VPN Page

The Oxygen Gateway has support for IPsec. The following IPsec features are supported:

• Single primary ISAKMP peer, with the ability to include a backup peer

• Up to 5 simultaneous IPsec tunnels (5 remote encrypted subnets, 5 IPsec security associations)

• Tunnel Mode only (Transport Mode is not supported)

• Support for 3DES, AES-‐128, AES-‐192, AES-‐256 encryption protocols

• Support MD5, SHA1, SHA-‐256, SHA-‐384, SHA-‐512 hashes

• Support for DH Groups 1, 2, 5, 14, 15, 16, 17, 18 (768 bits to 8192 bits)

• Support for Main Mode and Aggressive Mode

Using the Web Interface 28

• Support for NAT Traversal

• Split tunneling

• Dead Peer Detection (DPD)

• Debugging facility for trouble-‐shooting IPsec connections

In order to enable IPsec, the basic mode of operation (on the LAN Port page) must be set to Router Mode.

Once Router mode has been selected, this setting has to be saved and now IPsec can be configured by

selecting the corresponding link on the left side of the screen.

Note:

The Oxygen Gateway will always act as the ‘IPsec initiator’ and it will immediately try to establish an

ISAKMP security association. However, IPsec (Phase 2) security associations will only be created ‘on demand’, once there is data to be transmitted.

Fill in the appropriate IPsec parameters for the customer application. If the Oxygen Gateway and the remote end fail to establish an IPsec tunnel, enable the Enable Additional Debug Information in Syslog

option below and check the system log for possible failure reasons.

Do not leave the “Extra Logging / Debug Options” feature enabled for an extended period of time. The logging is quite verbose and will not only fill the system log with large amounts of debug log, but over time will cause older log entries to be discarded.

Using the Web Interface 29

5.5.1

Dead Peer Detection

Cypress Solutions always recommends the use of IPsec Dead Peer Detection (DPD) in wireless networks.

Failure to enable this feature on both ends of an IPsec connection can result in inoperable IPsec tunnels

due to the dynamic nature of cellular wireless connections.

5.5.2

NAT Traversal

The Oxygen Gateway supports the use of IPsec NAT Traversal (NAT-‐T). This should be enabled if the

Oxygen Gateway is running on an APN performing NAT, or if a NAT is expected prior to packets reaching

Using the Web Interface 30

the designated IPsec peer. NAT-‐T keepalive can be set at selected intervals to ensure NAT Translations do not expire on the NAT boundary for the IPsec connection.

Note:

NAT-‐Traversal is not always guaranteed to work and debugging NAT-‐Traversal related problems can be difficult. Some routers have special ‘IPsec pass-‐through’ modes which are meant to be enabled if IPsec packets are passing through. However, depending how these IPsec pass-‐through modes are implemented they can actually prevent the proper functioning of an IPsec NAT-‐T tunnel.

5.5.3

Secondary IPSec Peer

The Oxygen Wireless Gateway supports both primary and alternate IPSec peers. This support is intended for customers who have multiple data centers where IPSec tunnels may terminate. This feature allows for automatic reconnection in the event of a primary data center disaster, or primary data center maintenance.

The second IPSec peer will be used should the primary peer become unavailable. When the secondary peer is being used, the Oxygen Wireless Gateway will always attempt to connect to the primary peer first, and resort to the secondary should the primary become unavailable.

On start up, if the primary peer is available, the Oxygen Wireless Gateway will connect the tunnel(s) to that peer. If the primary peer is not available on start-‐up, the Oxygen Wireless Gateway will attempt to establish Phase 1 to the primary peer, and when phase 1 fails, it will restart IPsec and connect to the

secondary peer.

When the Oxygen Wireless Gateway is connected to the primary peer successfully, and subsequently experiences a disruption, the Oxygen Wireless Gateway will shutdown, and attempt to connect to the secondary peer. Disruption may include being disconnected from the cellular network, or phase 1 failing due to DPD (detecting loss of a peer), if DPD is configured and used.

When the Oxygen Wireless Gateway is connected to the secondary peer successfully, and subsequently experiences a disruption, the Oxygen Wireless Gateway will shutdown, and attempt to connect to the primary peer. Disruption may include being disconnected from the cellular network, or phase 1 failing due to DPD (detecting loss of a peer), if DPD is configured and used.

Using the Web Interface 31

5.6

Dynamic DNS

When using carrier supplied dynamic IP addresses, dynamic DNS can be employed as a means to determine the current IP address of the Oxygen Gateway. Currently there is support for the following dynamic DNS providers:

• changeip.com

• dyndns.org

• no-‐ip.com

• zoneedit.com

A third party dynamic DNS provider is the quickest way to setup this feature and most of the providers

noted above will offer a free account for a limited number of hostnames.

Aside from the above commercial providers, the Oxygen Gateway also supports custom (possibly

‘in-‐house’) dynamic DNS services. When using a custom provider, please specify the update URL. The URL will be called in the following fashion: http://<user_name>:<password>@<update_URL>?hostname=<domain_name>&myip=<ip_address>

The Oxygen wireless gateway will expect a reply that starts with the strings ‘ good

’ or ‘ nochg

’ as an indication that the update was either successfully completed or that no change in IP address has been detected.

5.7

Name and Password

5.7.1

Hostname

By configuring each Oxygen Gateway with a unique hostname, Oxygen units can be easily distinguished.

Each SNMP trap generated by the Oxygen Gateway will contain the hostname selected here.

Additionally, location and contact information can be configured and these values can be queried using

SNMP:

Using the Web Interface 32

5.7.2

Radius Authentication

Authentication for accessing the Oxygen wireless gateway can be achieved by either using a local password or by configuring the gateway to use a RADIUS server. When using the local password, only one password for the user ‘admin’ can be set.

When using RADIUS, multiple accounts can be setup with unique passwords and controlled by the server,

however they will all have the same rights as the local ‘admin’ user.

When using RADIUS, it is advisable to enable ‘local password fallback’ in combination with a strong local password. Without ‘local password fallback’ the Oxygen Gateway will be inaccessible if it loses connectivity to the RADIUS server and the only way to re-‐gain access will be to revert to the factory default configuration.

If Server reachable via is configured for ‘LAN interface’, the Oxygen Gateway will automatically set the

required routes. It is not required to configure a dedicated static route on the Routing screen.

5.7.3

Date and Time

The Oxygen-‐3 gateway contains a Real-‐Time Clock (RTC) which will maintain accurate time even when the

Oxygen-‐3 gateway is powered off. However, the RTC has to be adjusted initially and some drift can be expected over time.

For initial time adjustment of the RTC and to set the Oxygen Gateway’s system clock, the time can be set

manually, or it can be synchronized with the host PC.

Using the Web Interface 33

Setting the time manually does not account for the inevitable RTC drift over time. It is therefore recommended to configure an NTP server from which the Oxygen Gateway will obtain the precise time

whenever it connects to the WWAN network. When this happens, the Oxygen Gateway will also update its internal Real-‐Time Clock.

When the Adjust for Daylight Saving Time option is enabled, the Oxygen Gateway will automatically

account for daylight saving time when required.

5.8

Advanced Settings

5.8.1

Flash Upgrade

Cypress Solutions regularly provides new firmware images for the Oxygen Gateway to address to add new features or address other issues. These images are provided in the form of a single compressed binary file which includes an internal checksum as well as version and product information. This prevents possible

upgrade file corruption or accidental use of an incompatible upgrade file.

Upgrading is a two-‐step process:

1. The Oxygen wireless gateway will download the new firmware image. The download process can be interrupted with no ill effect. It is possible to upgrade the Oxygen Gateway ‘over the air’, meaning that the firmware image file can be downloaded over the WWAN connection.

2. After the firmware image passes all integrity checks, the actual upgrade will begin. The Oxygen

Gateway’s LED will flash in a distinctive pattern to illustrate that the upgrade process has begun.

The Oxygen-‐3 uses two flash images in parallel, one being the active one and the other one being the spare one. During the upgrade process, the spare image will be overwritten. Once the write process is complete and verified, the previous spare image will be made the active one and the previous active one will become the spare one.

If the upgrade process gets interrupted for any reason, the existing working image will have remained untouched and the Oxygen Gateway will remain operational.

By default all configuration data will get retained during the upgrade process. The same applies to the

system log, which will NOT get cleared.

Using the Web Interface 34

There are three different ways to upgrade the firmware of an Oxygen-‐3 wireless gateway: using the HTTP,

TFTP or FTP protocol:

5.8.1.1 Upgrading using the HTTP Protocol

There are three different ways to upgrade the firmware of an Oxygen-‐3 wireless gateway. The first is via

HTTP, and does not require any server setup. You can select a firmware file from your local hard drive and begin the upgrade process immediately by clicking on the ‘Start HTTP Upgrade’ button.

The Ignore Firmware Version Information option allows for downgrading to older firmware versions, however when doing so, Cypress Solutions Inc. does not guarantee that all configuration settings will be

retained.

Enabling the Revert to Factory Configuration option will cause the Oxygen Gateway to NOT save any configuration data. After the firmware upgrade, the Oxygen Gateway will restart with factory default configuration. Enabling this option does NOT affect the system log. The system log will still be retained across firmware upgrades, even if this option is checked.

5.8.1.2 Upgrading using the TFTP Protocol

Using TFTP is convenient when you have a TFTP server available on the local area network. It is inadvisable to use TFTP over wireless as the higher latency usually found over a wireless link will slow down the transfer of the firmware image file.

To start a TFTP upgrade, enter the TFTP server address and firmware image filename and click on the

‘Start TFTP Upgrade’ button.

Using the Web Interface 35

Refer to section 5.8.1.1 above for information on the Ignore Firmware Version Information and the

Revert to Factory Configuration options.

5.8.1.3 Upgrading from the Command Line Interface (TFTP, FTP)

Firmware upgrades can also be performed from the Oxygen Gateway’s command line interface, making this a suitable option for scripting, etc. Both the TFTP and the FTP protocol are supported, which FTP being the preferred option when transferring the firmware image across the wireless interface.

• Step 1:

Log into the Oxygen Gateway using SSH or Telnet – refer to section 6.1 for more information

• Step 2:

Use the netflash command as follows:

TFTP: netflash <tftp server IP> <firmware image name>

FTP: netflash –f <ftp server IP> <firmware image name>

In case of FTP, the Oxygen Gateway will prompt for a username and password to log into the FTP server:

Oxygen-3:~ # netflash -f 172.16.100.2 Oxygen-3-4.1.0-RC4.bin netflash: netflash: saving current config netflash: login to remote host 172.16.100.2

Name (172.16.100.2:admin): anonymous

Password: netflash: ftping file "Oxygen-3-4.1.0-RC4.bin" from 172.16.100.2

4614K netflash: got "Oxygen-3-4.1.0-RC4.bin", length=5350473 netflash: image is compressed, decompressed length=50331648 netflash: currently using flash partition #2, writing new image to partition #1 netflash: flashing root filesystem, kill is forced

[...]

The ‘netflash’ upgrade tool supports additional command line options:

usage: netflash [-fhiStvz?] [-I ip-address] [net-server] file-name

-f use FTP as load protocol

-h print help

-i ignore any version information

-I originate TFTP request from this address

-S don't preserve existing configuration

-t check the image and then throw it away

-v display version number

• The ‘-‐i’ option is the equivalent to the Ignore Firmware Version Information option described in section 5.8.1.1 above.

Using the Web Interface 36

• The ‘-‐S’ option is the equivalent to the Revert to Factory Configuration option described in section 5.8.1.1 above.

5.8.2

Automatic Background Ping

In order to maintain wireless stability for latency sensitive applications, the Oxygen wireless gateway offers the ability to generate continuous traffic over the wireless connection. This will prevent the WWAN connection from going idle, thereby preventing the modem falling into an idle state.

Background pinging will generate additional traffic, and it permanently allocates resources on the wireless network. Use this feature with caution and make sure to consult with your wireless carrier before activating this feature.

There are three different kinds of pings that can be used to maintain the wireless link:

1. ICMP pings are regular pings. These are the least likely to be filtered and most likely to receive a reply from the destination host. ICMP pings generate the most traffic, using a minimum of 56 bytes per round trip ping, more if additional payload data is specified.

2. UDP pings consist of a single outbound UDP packet, with no inbound reply. These packets are 28 bytes. If the sole purpose of background pings is to prevent the wireless link from going dormant, then it may not be necessary to elicit a reply, making UDP pings a viable option.

3. Raw pings are IP packets with no additional payload included. There will be no reply, and with the smallest packet size being 20 bytes, no additional load will be placed on the network. However there is the risk that the wireless carrier will filter these packets as invalid.

5.8.3

Transparent TCP Proxy

In order to enable the Transparent TCP Proxy feature, the basic mode of operation (on the LAN Port page)

must be set to Router Mode.

Using the Web Interface 37

Once Router mode has been selected, this setting has to be saved and now the Proxy can be configured.

Typically the Oxygen wireless gateway acts as a router, passing data between two TCP endpoints. The

Oxygen wireless gateway does not modify or interfere with the data stream. However, when configured to use the Transparent TCP proxy, the gateway will listen for the TCP streams identified on the configuration page:

When the transparent Proxy is enabled, the Oxygen Gateway will intercept those connections, terminate them locally and establish a new connection from the gateway to the original endpoint, spoofing the original source IP address.

This means there are now two TCP connections:

• One from the connected device to the Oxygen Gateway

• Another one from the Oxygen Gateway across the wireless network to the remote endpoint.

The Oxygen Gateway will forward data transparently in both directions. By having control over the TCP connection across the wireless network, the Oxygen Gateway can now set TCP parameters such as keep alive and retry counters and timers. This can be used to avoid problems with connected devices that have their TCP parameters set too tight for the slightly higher delay on wireless networks.

The TCP proxy supports IP address only, it is not possible to enter Hostnames in the configuration fields

above.

Using the Web Interface 38

5.8.4

Failsafe Configuration

The Oxygen Gateway supports a ‘Failsafe Configuration’ feature. The currently running configuration

(which should be a configuration that’s known to be good) can be declared the ‘Failsafe Configuration’ by clicking on the ‘Set Failsafe Config’ button:

Should, at a later date, access ever be lost due to misconfiguration, it is possible to revert to the saved

failsafe configuration.

To do so, move the power switch to the reset position and keep it there.

• Immediately, all LEDs, except the blue power LED will go off. Keep the power switch in the reset position.

• After about 5 seconds, one of the green signal LEDs will light up. Keep the power switch in the reset position.

• After about 10 seconds, two of the green signal LEDs and the orange Network Technology LED will light up. Now release the power switch.

The Oxygen Gateway will now reboot and restart with the failsafe configuration activated. If no failsafe

configuration has ever been defined, the factory default configuration will be used instead.

The Oxygen Gateway also supports the ability to schedule a failsafe configuration. This allows an added degree of safety when setting configuration parameters that may result in the device rendering itself unreachable. The settings to schedule a failsafe configuration can be found below the ‘Create Failsafe

Config’ screen.

When a failsafe configuration is scheduled, a timer will display in the ‘Clear Scheduled Failsafe Activation’ that counts down to zero. Once the timer has reached zero, the failsafe configuration will activate and the

Oxygen Wireless Gateway will reboot.

5.8.5

Configuration Download

When clicking on the ‘Config File’ web configuration page, the Oxygen Gateway will create a configuration

tarball on the fly and present it as a downloadable link on that page.

Similarly, an existing configuration tarball can be uploaded to the unit using ‘Choose file’ and ‘Upload’

buttons on the same page.

This allows for easy provisioning of a large number of Oxygen Gateways with the same configuration.

Using the Web Interface 39

After uploading a configuration tarball, it is necessary to reboot the Oxygen Gateway for the new configuration to become active.

5.9

Event Logging

The Oxygen wireless gateway maintains a system log that can provide useful information for trouble-‐shooting purposes. The system log will remain on the Oxygen Gateway even if the device is rebooted, is powered off or if the firmware gets upgraded.

The system log can be viewed by clicking on the ‘System Log’ link under ‘Diagnostics’ on the web

interface, or by entering cat /var/log/messages from the command line interface (refer to section 6.1 on how to access the command line interface).

When viewing the system log from the command line interface, the full log with all entries will always be shown. When viewing the system log through the web interface, it is possible to filter out less important message by changing the setting for ‘System Log – Level of Detail’.

The Oxygen Gateway will also periodically log wireless radio statistics. This feature can be turned on or off

here, and the log frequency can be adjusted:

Events are captured in two files, with the older one being overwritten in a circular fashion once they

reach a certain size.

Log events can also be forward to a remote syslog server. To enable this feature, check the Enable

Remote Logging option and specify the IP address of the server. It is also required to specify whether this server can be reached via the LAN interface or via the wireless WWAN interface. The Oxygen Gateway will then set routes accordingly.

Using the Web Interface 40

5.10

Traffic Counter

For applications that are sensitive to mobile traffic usage, the Oxygen wireless gateway features two data

counters to monitor data volume on the wireless WWAN interface:

• A per-‐session counter will monitor the usage on the WWAN interface in bytes for the duration that the gateway remains connected to the cellular network. This counter will automatically get reset once the Oxygen Gateway disconnects from the cellular network. The current byte counter value can be viewed on the main web interface overview screen or via SNMP. It is not possible to reset this counter manually.

• A persistent data volume byte counter will retain its value even when the wireless link is disconnected, the Oxygen Gateway is rebooted, or remains powered off for an extended duration, or has its firmware upgraded.

This counter can reset manually by clicking on the ‘Clear Counter Now’ button, or it can be configured to automatically reset on a scheduled day of the month to synchronize the counter with the wireless carrier’s billing cycle.

On the SNMP configuration screen, you can also enable automatic warnings when data usage has

exceeded a predefined threshold. This warning will be send via an SNMP trap to the IP specified.

5.11

Cypress Cloud Manager

All Oxygen modems have the ability to be managed remotely, thereby simplifying management of large fleets. Cypress Cloud Manager is Cypress Solutions’ configuration and management platform. It can be

installed ‘in the cloud’ or locally on your own server.

Communication to the CCM server is always initiated by the modem, to the server. This allows management even when modems are on dynamic IP ranges, or behind natted APN’s.

Note: If you enable CCM support with the default factory configuration, the Oxygen Wireless gateway will contact Cypress Solutions’ CCM server. This allows Cypress support staff the ability to access the unit remotely for troubleshooting and support purposes. If you do not wish to permit access please either

disable CCM or point the ‘CCM Server URL’ towards your own installation.

Using the Web Interface 41

5.11.1

Basic Setup

In order to enable Cypress Cloud Manager’s functionality, set the “Enable CCM Support” to “Always On”.

This will enable check-‐ins towards the CCM server that is hosted by Cypress Solutions by default.

5.11.1.1 CCM Server URL and Port

By default an Oxygen Wireless Gateway can be configured to check into the CCM server that is hosted by

Cypress Solutions. Should a customer require their own instance of CCM, these settings can be

reconfigured to point to a different IP address and port.

5.11.2

Advanced Setup

Cypress Cloud Manager features a number of features intended to simplify and ease the task of managing large fleets of Oxygen Wireless Gateways.

5.11.2.1 Daily Maintenance Window

The ability to schedule when configuration updates are requested from CCM exists within the Oxygen

Wireless Gateway. To enable the maintenance window, simply change “Enable CCM Support” to “During

Maintenance Window Below”. This will force the Oxygen Wireless Gateway to abide by the maintenance schedule as detailed in the screenshot below.

5.11.2.2 Check-‐In Interval

This feature simply defines the rate at which an Oxygen Wireless Gateway will attempt to connect

Cypress Cloud Monitor. It can be set to as little as 5 minutes, or as large as 24 hours.

5.11.2.3 CCM Traffic Interface

The Oxygen Wireless Gateway can send CCM check-‐ins via the wireless radio, the primary LAN IP, or the secondary LAN IP. This is configured within the “Server reachable via” pull-‐down menu.

Using the Web Interface 42

5.12

SNMP Settings

The Oxygen wireless gateway offers the benefit of in-‐depth SNMP monitoring as well as event-‐triggered

SNMP traps. Metrics such as signal, noise, band, frequency and many others are available to monitor via

industry-‐standard third-‐party SNMP monitoring applications.

The Oxygen Gateway’s SNMP implementation supports SNMPv2 and can be enabled by checking the

Enable SNMP option on the SNMP configuration page.

5.12.1

Cypress Vendor MIB

Cypress Solutions provides a ‘Vendor-‐MIB’ which allows the SNMP monitoring station to make use of the many customized monitoring options provided by the Oxygen Gateway. This MIB needs to be installed on the SNMP monitoring station prior to querying the Oxygen Gateway.

The MIB can be downloaded from the SNMP page of the Oxygen Gateway’s web interface by clicking on

the link at the top of the page.

5.12.2

SNMP Polling

The Oxygen Gateway can be monitored via SNMP ‘GET’ request, commonly referred to as ‘polling’. The

Oxygen Gateway will only reply to polls if the configured SNMP Read Community String matches that of

the SNMP monitoring station.

In addition to querying the Oxygen Gateway using ‘GET’ requests, there are a number of actions that can be initiated via SNMP ‘SET’ requests:

• Resetting the Oxygen Gateway

• Reverting to Factory Default configuration

• Reverting to the Failsafe configuration (see section 5.8.4 for more information)

The Oxygen Gateway will only preform the requested action if the configured SNMP Read/Write

Community String matches that of the SNMP monitoring station.

For additional security, up to three IP networks can be white-‐listed. Only SNMP requests originating from these networks will be answered. If no white-‐listed networks are defined, then requests from all sources will be answered.

Using the Web Interface 43

5.12.3

SNMP Traps

The Oxygen Gateways can be configured to send a number of event-‐driven or periodic traps. This feature can prove useful in cases where the wireless carrier only provides a private IP address and inbound access is restricted.

To enable traps, configure an SNMP Trap Community String and enter the IP address of the SNMP trap receiver. Again, the Community string configured here should match the community string of the trap receiver, however it is important to realize that traps will be send out regardless whether there is a match or not. In case of a mismatch, the receiver will simply discard the incoming trap packet.

By default, the Oxygen Gateway will send traps using the IANA-‐registered Cypress Solutions Enterprise ID of ‘28954’. For backwards compatibility with older Agilink or GNCI branded installations, this can be changed by adjusting the setting for Use Vendor ID.

All traps contain a ‘hostname’ field as described in section 5.7.1. This can be used to easily identify incoming traps at the SNMP management station, even if these traps originate from Oxygen Gateways with dynamic IP addresses.

The following traps are available:

Trap

WWAN Status

Type

periodic

Modem Status

RSSI Alert

Interface up/down

CPE up/down

High Traffic Alert event-‐driven event-‐driven

Battery Power Alert event-‐driven

Low Battery Alert periodic event-‐driven event-‐driven event-‐driven

Description

Contains up-‐to-‐date wireless network information, such as signal quality, network type information, channel, band, data counters and more. The trap interval can be configured from 1min to 2h.

Contains static wireless account and equipment information, such as

IMEI, IMSI, ICCID and more. The trap interval can be configured from

30min to 24h.

Triggered by poor signal quality. Threshold values for sending the alert trap as well as the ‘alert cleared’ trap can be defined below.

Triggered by LAN interface link-‐down/up events.

Triggered by absence (and re-‐occurrence) of ping replies from a connected CPE device. CPE monitoring needs to be enabled and configured on the LAN Port configuration screen (see section 5.1.6).

Triggered if a configurable traffic counter threshold is exceeded.

Repeat alerts will be sent at 110%, 120%, 130%, etc. of configured threshold. See section 5.10 for more information on the traffic counter.

Triggered by a loss (or re-‐occurrence) of external power sources (DC

Power or PoE) and subsequent seamless switchover to the built-‐in battery as the primary power source.

Triggered by the internal battery being discharged to a level of approximately 20% or less.

Precise information on what OIDs are contained in each trap can be found in the

Cypress Solutions Vendor MIB

Using the Command Line 44

Using the Command Line

6.1

Accessing the Command Line Interface

The Oxygen Gateway’s command line interface (CLI) can be accessed via SSH (recommended) or via

Telnet (not recommended for security reasons).

Depending on your chosen access method and access path, make sure that access is enabled on the

‘Access Control’ page of the Oxygen Gateway’s web interface. Refer to section 5.3 for more information.

By default, only SSH access on the LAN port and via an IPsec tunnel is enabled:

Note:

Using the Command Line 45

Access via the WWAN interface, even if enabled on the ‘Access Control’ page, will not work if your wireless carrier provides a private IP address. Access may also be restricted if your wireless account uses a custom APN.

On a Windows computer, the freely downloadable

PuTTY SSH client can be used to access the Oxygen

Gateway’s command line. Linux and Mac OS X come with built-‐in SSH clients. The screenshot to the right

shows how to establish an SSH session using PuTTY.

In this example the Oxygen Gateway is reachable at its default IP address of 169.254.0.1 using the default port

22.

After establishing a connection to the Oxygen Gateway, you will be prompted for a username and password.

The default username and password are:

Username: admin

Password: cypress

The Oxygen Gateway will present a standard Linux command prompt with following diagnostic tools

available:

6.2

Configuration Tool Utility (cfgtool)

The Oxygen Gateway contains a utility that allows changing configuration parameters via command line called cfgtool. This is executed from the command line of the Oxygen Gateway.

Use caution when configuring the Oxygen Wireless Gateway via CLI, the ordinary logic checks incorporated into the graphic interface is not present. Always test your configuration scripts before deploying configuration to production units!

cfgtool can be invoked in the following manners:

Command

Type apply help info

Flag

-‐a

-‐h

-‐i

Long Flag

-‐-‐apply

-‐-‐help

-‐-‐info

Description

Apply all pending configuration changes (may cause a

WWAN disconnect or other service interruptions).

Print the cfgtool manual page. pending -‐p -‐-‐pending

Show meta information for selected configuration parameters.

Show current configuration for selected configuration parameters.

Using the Command Line 46 write revert

-‐w

-‐x

-‐-‐write

-‐-‐revert

Write the configuration value to the selected configuration parameter.

Revert selected configuration parameter values.

Each configuration parameter is tied to the configuration parameter name contained in

/etc/config/config.running

The first numeric value of a configuration parameter will begin with zero, and increment upward. For example, the configuration value GATEWAY_MODE enumerates in the following manner:

Value 0 = Router, use with NAT and/or IPsec

Value 1 = Pass-‐Through, static LAN IP

Value 2 = Pass-‐Through, all IP’s automatic

If this parameter needed to be set to value 0, the following cfgtool commands would be issued in the CLI: cfgtool -‐w gateway_mode 0 cfgtool -‐a

Best Practice Recommendation: Always run a single apply command at the end of configuration scripts. This will allow the Oxygen Wireless Gateway to configure itself in the most efficient manner.

6.3

Packet Tracing (tcpdump)

The Oxygen Gateway contains a Linux based packet tracing facility called tcpdump. This is executed from the command line of the Oxygen Gateway.

tcpdump is a convenient troubleshooting tool, as it allows for the near real-‐time display of traffic traversing the Oxygen Gateway. This is particularly useful when attempting to identify issues that are related to customer configuration problems, downstream firewall issues, or needing verification of traffic

in and out of the Oxygen Gateway.

A help facility is available by typing tcpdump –help. Further information on tcpdump can be obtained

from the Linux manual pages for tcpdump.

Oxygen-3:~ # tcpdump --help tcpdump version 3.9.2 libpcap version 0.9.2

Usage: tcpdump [-aAdDeflLnNOpqRStuUvxX] [-c count] [ -C file_size ]

[ -E algo:secret ] [ -F file ] [ -i interface ] [ -M secret ]

[ -r file ] [ -s snaplen ] [ -T type ] [ -w file ]

[ -W filecount ] [ -y datalinktype ] [ -Z user ]

[ expression ]

Some common ways of using tcpdump: tcpdump –n –i wwan0 host <IP address>

Using the Command Line 47

This will output all packets that traverse the wireless WWAN interface and that have <IP address> as either their source or destination address. The -‐n operand is used to NOT resolve IP addresses to host names. A concrete example with sample output is shown below:

Oxygen-3:~ # tcpdump –n -i wwan0 host 216.133.237.18 tcpdump: verbose output suppressed, use -v or -vv for full protocol decode listening on wwan0, link-type EN10MB (Ethernet), capture size 96 bytes

13:14:50.302447 IP 216.133.237.18.500 > 74.198.34.133.500: UDP, length 92

13:14:50.314989 IP 74.198.34.133.500 > 216.133.237.18.500: UDP, length 92

The results of the above tcpdump packet trace confirm that there is UDP port 500 traffic being exchanged between the IP addresses shown. The packets are time stamped with the current time according to the

Oxygen Gateway.

The following command captures all data on the wireless WWAN interface and gives a more verbose output, including packet payload:

Oxygen-3:~ # tcpdump -xvnNs 1500 -i wwan0 tcpdump: listening on wwan0, link-type EN10MB (Ethernet), capture size 1500 bytes

19:50:17.466056 IP (tos 0x0, ttl 64, id 0, offset 0, flags [DF], proto: ICMP (1), length: 84) 173.182.151.71 > 8.8.8.8: ICMP echo request, id 50950, seq 0, length 64

0x0000: 4500 0054 0000 4000 4001 0d9c adb6 6f47

0x0010: 0808 0808 0800 22eb c706 0000 f7c9 1644

0x0020: 0000 0000 0000 0000 0000 0000 0000 0000

0x0030: 0000 0000 0000 0000 0000 0000 0000 0000

0x0040: 0000 0000 0000 0000 0000 0000 0000 0000

0x0050: 0000 0000

19:50:18.297935 IP (tos 0x0, ttl 46, id 0, offset 0, flags [none], proto: ICMP (1),

length: 84) 8.8.8.8 > 173.182.151.71: ICMP echo reply, id 50950, seq 0, length 64

0x0000: 4500 0054 0000 0000 2e01 5f9c 0808 0808

0x0010: adb6 6f47 0000 2aeb c706 0000 f7c9 1644

0x0020: 0000 0000 0000 0000 0000 0000 0000 0000

0x0030: 0000 0000 0000 0000 0000 0000 0000 0000

0x0040: 0000 0000 0000 0000 0000 0000 0000 0000

0x0050: 0000 0000

Pressing the key combination <ctrl>-‐c stops tcpdump.

6.4

Wireless Network Information (rssimon)

The Oxygen Gateway provides a simple command line tool to obtain real-‐time wireless network status

information in 1 second intervals. It can be started by entering: rssimon

from the command line. This is particularly useful when troubleshooting, as well as when trying to

determine a location with optimal RF conditions during initial placement of the unit.

Using the Command Line 48

Since rssimon displays the Cell ID, it is also very useful when using directional antennas. This provides a level of certainty should the unit be required to connect to a particular cell site using a directional antenna.

In the example below, rssimon has been issued from the command line. There is a pause of 1 second

between the output of each line.

Oxygen-3:~ # rssimon

Airprime MC7354, SQI: 56%, RSSI: -82 dBm, RSCP: -92 dBm, , , , , Chan: 1057 , , Band: B5 (850MHz, Cellular) , ,

RAT: HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 54%, RSSI: -82 dBm, RSCP: -93 dBm, , , , , Chan: 1057 , , Band: B5 (850MHz, Cellular) , ,

RAT: HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 54%, RSSI: -84 dBm, RSCP: -93 dBm, , , , , Chan: 557 , , Band: B2 (1900 MHz, PCS) , , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 54%, RSSI: -84 dBm, RSCP: -93 dBm, , , , , Chan: 557 , , Band: B2 (1900 MHz, PCS) , , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 54%, RSSI: -84 dBm, RSCP: -93 dBm, , , , , Chan: 557 , , Band: B2 (1900 MHz, PCS) , , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 64%, RSSI: -84 dBm, RSCP: -88 dBm, , , , , Chan: 557 , , Band: B2 (1900 MHz, PCS) , , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 64%, RSSI: -83 dBm, RSCP: -88 dBm, , , , , Chan: 1057 , , Band: B5 (850MHz, Cellular) , ,

RAT: HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 64%, RSSI: -83 dBm, RSCP: -88 dBm, , , , , Chan: 1057 , , Band: B5 (850MHz, Cellular) , ,

RAT: HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 402, MNC: 240

Airprime MC7354, SQI: 64%, RSSI: -83 dBm, RSCP: -88 dBm, , , , , Chan: 1057 , , Band: B5 (850MHz, Cellular) , ,

RAT: HSDPA, no roam, Temperature: 46, , , Cell-ID: 62428922, , LAC: 11101, MCC: 302, MNC: 220

The example shows that the Oxygen Gateway is on the 3G WCDMA network and switches from the

850MHz band (channel 1057) to the 1900MHz band (channel 557) and then back. Signal quality is average, the Cell-‐ID is 62428922 and it is NOT roaming.

Since the unit can run on battery, rssimon can be issued while the Oxygen Gateway is being moved around within a customer premise without any need for device to be connected to an external power source. The immediate output can provide quick insight as to be best RF location within the premises.

Pressing the key combination <ctrl>-‐c stops rssimon.

In cases where rssimon is being called from a script it may be desirable to only output a certain number of lines and then stop automatically. rssimon provides the -‐c command line switch for that. The following example provides 3 lines of rssimon output:

Oxygen-3:~ # rssimon -c 3

Airprime MC7354, SQI: 56%, RSSI: -84 dBm, RSCP: -92 dBm, , , , , Chan: 537, , Band: B2 (1900 MHz, PCS), , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 72428922, , LAC: 11101, MCC: 302, MNC: 220

Airprime MC7354, SQI: 56%, RSSI: -84 dBm, RSCP: -92 dBm, , , , , Chan: 537, , Band: B2 (1900 MHz, PCS), , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 72428922, , LAC: 11101, MCC: 302, MNC: 220

Airprime MC7354, SQI: 56%, RSSI: -84 dBm, RSCP: -92 dBm, , , , , Chan: 537, , Band: B2 (1900 MHz, PCS), , RAT:

HSDPA, no roam, Temperature: 46, , , Cell-ID: 72428922, , LAC: 11101, MCC: 302, MNC: 220

Oxygen-3:~ #

6.5

Ping

Ping is a standard tool to test whether a certain destination can be reached. Ping can be issued from the

command line with the syntax ping <host> -‐I <source ip>. The -‐I operand is optional.

Example

Using the Command Line 49

Oxygen-3:~ # ping 172.16.100.1 -I 192.168.49.1

PING 172.16.100.1 (172.16.100.1) from 192.168.49.1: 56 data bytes

64 bytes from 172.16.100.1: seq=0 ttl=255 time=202.728 ms

64 bytes from 172.16.100.1: seq=1 ttl=255 time=181.549 ms

64 bytes from 172.16.100.1: seq=2 ttl=255 time=181.030 ms

64 bytes from 172.16.100.1: seq=3 ttl=255 time=194.946 ms

64 bytes from 172.16.100.1: seq=4 ttl=255 time=226.075 ms

6.6

HPing

Hping can be used for more specific testing. There is a vast amount of options for transmitting IP, ICMP,

UDP packets with numerous payload options. This can be used for testing and diagnosis of various network conditions. Some of these conditions could be troubleshooting MTU issues, TCP port specific issues with firewalls, or the need to send non ICMP based pings due to APN or firewall restrictions. The full set of commands and options are listed below. This list can be obtained at command line by issuing the hping -‐h command as shown below.

Oxygen-3:~ # hping -h usage: hping host [options]

-h --help show this help

-v --version show version

-c --count packet count

-i --interval wait (uX for X microseconds, for example -i u1000)

--fast alias for -i u10000 (10 packets for second)

--faster alias for -i u1000 (100 packets for second)

--flood sent packets as fast as possible. Don't show replies.

-n --numeric numeric output

-q --quiet quiet

[... remaining output omitted ...]

The following example shows the hping command being used to send a TCP RST (Reset) packet on TCP port 9000 to destination address 74.198.22.216 for trouble shooting purposes.

Oxygen-3:~ # hping -p 9000 -R 74.198.22.216

HPING 74.198.22.216 (wwan0 74.198.22.216): R set, 40 headers + 0 data bytes

The packet was examined on the outbound wwan0 interface using TCPdump at the same time.

Oxygen-3:~ # tcpdump -i wwan0 host 74.198.22.216 tcpdump: verbose output suppressed, use -v or -vv for full protocol decode listening on wwan0, link-type EN10MB (Ethernet), capture size 96 bytes

10:05:00.677311 IP 74.198.34.133.1700 > 74.198.22.216.9000: R 1840941308:1840941308(0) win 512

10:05:01.681095 IP 74.198.34.133.l2tp > 74.198.22.216.9000: R 1343821945:1343821945(0) win 512

10:05:02.681400 IP 74.198.34.133.1702 > 74.198.22.216.9000: R 400207156:400207156(0) win 512R

In another example below, hping is being used to transmit a UDP packet on port 1611 with a UDP size of

1410 bytes, with the do not fragment bit set to IP address 74.198.22.216.

Oxygen-3:~ # hping -2 -p 1611 -d 1410 -y 74.198.22.216

HPING 74.198.22.216 (wwan0 74.198.22.216): udp mode set, 28 headers + 1410 data bytes

--- 74.198.22.216 hping statistic ---

4 packets tramitted, 0 packets received, 100% packet loss round-trip min/avg/max = 0.0/0.0/0.0 ms

Using the Command Line 50

The packets were examined on the outbound wwan0 interface using TCPdump at the same time.

10:13:44.103214 IP 74.198.34.133.1072 > 74.198.22.216.1611: UDP, length 1410

10:13:45.104221 IP 74.198.34.133.1073 > 74.198.22.216.1611: UDP, length 1410

10:13:46.105381 IP 74.198.34.133.1074 > 74.198.22.216.1611: UDP, length 1410

10:13:47.106510 IP 74.198.34.133.1075 > 74.198.22.216.1611: UDP, length 1410

6.7

iPerf

iPerf is a tool that can be used to measure the speed of a network connection. It is particularly useful in diagnosing speed issues during the design phase of networks, or as a measurement tool to verify speed availability for customers requiring certain minimum speed requirements. iPerf must run with a peer on the network. In most cases, this is a peer on a landline egress from the carrier, either Internet based, or with custom landline access.

iPerf on the Oxygen Gateway can run in client mode or server mode, such that both uplink and downlink directions can be tested for speed. iPerf has command line options, which can be displayed by using the

iperf -‐h help facility. These options are shown below.

Oxygen-3:~ # iperf -h

Usage: iperf [-s|-c host] [options]

iperf [-h|--help] [-v|--version]

Client/Server:

-f, --format [kmKM] format to report: Kbits, Mbits, KBytes, MBytes

-i, --interval # seconds between periodic bandwidth reports

-l, --len #[KM] length of buffer to read or write (default 8 KB)

-m, --print_mss print TCP maximum segment size (MTU - TCP/IP header)

[... remaining output omitted ...]

In the example below, The Oxygen Gateway is being used as an iPerf client (-‐c operand) connecting to an iPerf server at 169.254.0.2, using TCP port 5001 (default), with a bandwidth report every 10 seconds, and using 3 TCP threads (connections) concurrently.

The results show that the aggregate measured bandwidth of the 3 simultaneous connections is

94.6 Mbit/sec, which is expected given that the test was performed across the LAN interface.

Oxygen-3:~ # iperf -c 169.254.0.2 -t 60 -i 10 -P 3

------------------------------------------------------------

Client connecting to 169.254.0.2, TCP port 5001

TCP window size: 64.0 KByte (default)

------------------------------------------------------------

[ 8] local 169.254.0.1 port 54672 connected with 169.254.0.2 port 5001

[ 5] local 169.254.0.1 port 54670 connected with 169.254.0.2 port 5001

[ 7] local 169.254.0.1 port 54671 connected with 169.254.0.2 port 5001

[ ID] Interval Transfer Bandwidth

[ 8] 0.0-10.0 sec 40.1 MBytes 33.7 Mbits/sec

[ 7] 0.0-10.0 sec 34.6 MBytes 29.0 Mbits/sec

[ 5] 0.0-10.0 sec 40.0 MBytes 33.6 Mbits/sec

[SUM] 0.0-10.0 sec 115 MBytes 96.3 Mbits/sec

[ 8] 10.0-20.0 sec 34.9 MBytes 29.3 Mbits/sec

[ 5] 10.0-20.0 sec 41.9 MBytes 35.1 Mbits/sec

[ 7] 10.0-20.0 sec 35.1 MBytes 29.5 Mbits/sec

[SUM] 10.0-20.0 sec 112 MBytes 93.8 Mbits/sec

[ 5] 20.0-30.0 sec 44.6 MBytes 37.4 Mbits/sec

[ 7] 20.0-30.0 sec 44.5 MBytes 37.3 Mbits/sec

Using the Command Line 51

[ 8] 20.0-30.0 sec 23.8 MBytes 19.9 Mbits/sec

[SUM] 20.0-30.0 sec 113 MBytes 94.7 Mbits/sec

[ 7] 30.0-40.0 sec 38.1 MBytes 32.0 Mbits/sec

[ 8] 30.0-40.0 sec 25.4 MBytes 21.3 Mbits/sec

[ 5] 30.0-40.0 sec 48.6 MBytes 40.8 Mbits/sec

[SUM] 30.0-40.0 sec 112 MBytes 94.1 Mbits/sec

[ 5] 40.0-50.0 sec 39.9 MBytes 33.4 Mbits/sec

[ 8] 40.0-50.0 sec 23.3 MBytes 19.5 Mbits/sec

[ 7] 40.0-50.0 sec 49.5 MBytes 41.5 Mbits/sec

[SUM] 40.0-50.0 sec 113 MBytes 94.5 Mbits/sec

[ 7] 50.0-60.0 sec 50.9 MBytes 42.7 Mbits/sec

[ 8] 50.0-60.0 sec 28.9 MBytes 24.2 Mbits/sec

[ 8] 0.0-60.0 sec 176 MBytes 24.6 Mbits/sec

[ 5] 50.0-60.0 sec 32.1 MBytes 26.9 Mbits/sec

[SUM] 50.0-60.0 sec 112 MBytes 93.8 Mbits/sec

[ 5] 0.0-60.0 sec 247 MBytes 34.5 Mbits/sec

[ 7] 0.0-60.0 sec 253 MBytes 35.4 Mbits/sec

[SUM] 0.0-60.0 sec 677 MBytes 94.6 Mbits/sec

Oxygen-3:~ #

Below is another test with the Oxygen Gateway operating in server mode:

Oxygen-3:~ # iperf -s

------------------------------------------------------------

Server listening on TCP port 5001

TCP window size: 85.3 KByte (default)

------------------------------------------------------------

[ 9] local 169.254.0.1 port 5001 connected with 169.254.0.2 port 36125

[ 7] local 169.254.0.1 port 5001 connected with 169.254.0.2 port 36123

[ 8] local 169.254.0.1 port 5001 connected with 169.254.0.2 port 36124

[ ID] Interval Transfer Bandwidth

[ 7] 0.0-60.1 sec 225 MBytes 31.4 Mbits/sec

[ 9] 0.0-60.1 sec 225 MBytes 31.4 Mbits/sec

[ 8] 0.0-60.1 sec 225 MBytes 31.4 Mbits/sec

[SUM] 0.0-60.1 sec 674 MBytes 94.1 Mbits/sec

6.8

Arp Cache

The Arp Cache contains a list of MAC-‐Addresses currently known to the Oxygen Gateway. It can be viewed using the command line. This is useful when diagnosing if devices connected behind the Oxygen

wireless gateway are online. The list can be obtained by issuing the following command:

cat /proc/net/arp

Oxygen-3:~ # cat /proc/net/arp

IP address HW type Flags HW address Mask Device

169.254.0.2 0x1 0x2 00:20:f3:1e:02:25 * eth0

Oxygen-3:~ #

The output will display IP addresses tied to MAC-‐Addresses. If you see multiple IP addresses associated to

a single MAC-‐address, that MAC-‐address is likely a router or switch.

Understanding the Signal Quality Indicator (SQI) 52

Understanding the Signal Quality Indicator (SQI)

The Oxygen Gateway uses an internal Signal Quality Indicator (SQI) to display the current wireless signal quality.

The reason being, that in modern 3G and 4G networks the traditionally used RSSI indicator is no longer

the best measure for signal quality. Instead, the indicators below should be used:

2G (GSM/GPRS/EDGE)

3G (WCDMA/UMTS/HSPA)

RSSI

RSCP

4G (LTE) RSRP

However, this makes it harder for the end user to obtain a good sense of the current signal conditions.

Signal strength values have different meanings, depending on network technology.

To provide a normalized value independent of the currently active network technology, the Oxygen

Gateway then uses the following formulas to translate the current RSSI, RSCP or RSRP value to an SQI

value ranging from 0 to 100%.

• 2G: SQI = (RSSI + 105) * 2.5

• 3G: SQI = (RSCP + 120) * 2

• 4G: SQI = (RSRP + 133) * 1.587

This leads to the following scale:

SQI lower than 20%

SQI between 20% and 40%

SQI between 40% and 80%

SQI above 80%

Note:

Very poor signal quality

Minimally acceptable signal quality

Average signal quality

Good signal quality

The SQI value only reflects current signal strength, but not current signal noise. Noise is represented by the Ec/Io value (WCDMA) or the RSRQ value (LTE). The precise influence of the noise value on network performance is often hard to predict, other than in very general terms. When encountering a situation with high noise values, it is advisable to perform additional longer-‐term tests (for example ping tests and throughput test) to determine network performance.

Reverting to Factory Default Configuration 53

Reverting to Factory Default Configuration

The Oxygen Gateway can be reset to factory default configuration by moving the reset/power switch to the ‘Reset’ position for a certain amount of time. A similar procedure is used to revert to the failsafe

configuration, which is also explained here. See section 4.1 how to locate the reset/power switch.

Move the reset/power switch to the ‘Reset’ position and hold it there. Observe the Oxygen Gateway’s

LED patterns:

For the first 5 seconds after moving the switch to the

‘Reset Position’ all LEDs except the blue power LED will be off. If the switch is released now, nothing will happen and the Oxygen Gateway will resume normal operation.

For the next 5 seconds, the LED pattern to the left will be visible. If the switch is released now, the Oxygen Gateway will reset without any config changes.

For the next 5 seconds, the LED pattern to the left will be visible. If the switch is released now, the Oxygen Gateway will reboot and revert to failsafe configuration.

For the next 5 seconds, the LED pattern to the left will be visible. If the switch is released now, the Oxygen Gateway will reboot and revert to factory default configuration.

The Oxygen Gateway will resume normal operation.

Troubleshooting 54

Troubleshooting

Problem

The Oxygen wireless gateway is not powering on

It is not possible to access the web interface

The modem powers on, and appears to be connecting to the network, but never completes the connection attempt

After the modem connects to the wireless network, it is no longer possible to access the web interface

Answer

• Check that the power connector is firmly seated in the Oxygen wireless gateway and that the switch is in the ‘on’ position.

• If running off the built-‐in battery, consider that the battery may be discharged.

Follow the guide to connect to the device as outlined in section

4.3. If you are still unsuccessful, conduct the following tests:

• Restart the Oxygen wireless gateway by removing power, and adding it again

• Make sure that the Power LED is solid blue, and the Online LED is either solid or flashing red

• Ensure the computer you are connecting from is configured to obtain its IP address via DHCP

• Ensure you are connected via Ethernet cable to the device, and that both your link and activity lights are lit

• Open your network configuration and note the gateway

• Attempt to access the gateway in your web browser

• Perform a reset to factory default configuration on the Oxygen

Gateway as outlined in section 8.

It is most likely that your SIM card is not activated, or the APN is set incorrectly on the Oxygen wireless gateway.

• Check the Oxygen’s system log to obtain additional information

• Contact your carrier to obtain information on your account, including activation state and APN

When the Oxygen wireless gateway operates in Pass-‐Through mode, it adjusts the IP on the Ethernet port to resemble what IP address the carrier assigns.

• In order to find the new Ethernet IP address, open your network settings, note the gateway and attempt to access it via your web browser.

• Alternatively, you can configure a secondary IP address on the

Oxygen Gateway’s LAN port (default: 169.254.0.1) and attempt to reach the Oxygen Gateway at that IP address.

Contact

Phone:

Toll Free:

Local:

Fax:

Email:

1-‐877-‐985-‐2878

1-‐604-‐294-‐4465

1-‐604-‐294-‐4471 [email protected]

Mailing Address:

Cypress Solutions Inc.

3066 Beta Avenue

Burnaby, BC

V5G 4K4

Canada

Contact 55

Key features

LTE, WCDMA, and GSM/GPRS/EDGE supported
Integrated battery
Dual Flash image technology
PoE support
USB device support
Cellular Network Watchdog
Cypress Cloud Manager
Event logging
Traffic counter

Frequently asked questions

The Oxygen 3 supports LTE Bands 2, 4, 5, 13, 17, and 25. However, not all bands are available with all carriers.

The Oxygen 3's battery can provide for 6-8 hours of power under normal operating conditions.

The Oxygen 3 uses two SMA RF antenna ports for MIMO, Diversity. The antenna specifications are: 700/2100 (694-960/1710-2170 MHz), 3dBi peak gain, 2:1 VSWR max over range, 50 Ohm nominal impedance, 5 Watt maximum power, -40 deg.C to +85 deg.C operating temperature.

Yes, the Oxygen 3's Ethernet port supports Power over Ethernet (PoE) and is fully 802.3af compliant.

Oxygen 3 User

Guide

Description

Revision

Date

Regulatory Restrictions

Electromagnetic Interference (EMI) – United States FCC Information

Electromagnetic Interference (EMI) – Canada Information

Li-­‐Ion Battery

Package Contents

General

Wireless

Ports

Note:

Processor and Memory

Power

Integrated Battery Operation

Power over Ethernet

Environmental

Physical Dimensions and Weight

Antennas

Inserting the SIM card

Step 1 -­‐ Remove Mounting Bracket

Step 2 – Remove SIM card cover

Step3 -­‐ Insert SIM Card

Connector Overview

Step 4 -­‐ Reassemble Cover

Installing the Antennas

Supplying the Oxygen Gateway with Power

Physical Installation

Power Up

LEDs

Logging into the Oxygen Gateway

Changing and Saving the Config

Quick Start Configuration

LAN Port page

Router Mode

Pass-­‐Through Mode

LAN Port Speed

Secondary IP Address

DNS Support

Customer Premise Equipment (CPE) Monitoring

WWAN Page

WWAN Connection Settings

Network Technology and LTE Band Selection

WWAN Connection Timeouts

Bandwidth Throttling

Cellular Network Watchdog

Access Control Page

Routing Page

IPsec VPN Page

Dead Peer Detection

NAT Traversal

Secondary IPSec Peer

Dynamic DNS

Name and Password

Hostname

Radius Authentication

Date and Time

Advanced Settings

Flash Upgrade

Automatic Background Ping

Transparent TCP Proxy

Failsafe Configuration

Configuration Download

Event Logging

Traffic Counter

Cypress Cloud Manager

Basic Setup

Advanced Setup

SNMP Settings

Cypress Vendor MIB

SNMP Polling

SNMP Traps

Accessing the Command Line Interface

Configuration Tool Utility (cfgtool)

Packet Tracing (tcpdump)

Wireless Network Information (rssimon)

Ping

HPing

Li-‐Ion Battery

Step 1 -‐ Remove Mounting Bracket

Step3 -‐ Insert SIM Card

Step 4 -‐ Reassemble Cover

Pass-‐Through Mode