2 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485
GW2024P-2:
2 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plasti c c as e
fixed in manufacturing.
1 Introduction
This user manual describes the features and how to configure a Virtual Access GW2020
Series router .
The Virtual Access GW2020 Series routers are arrange of versatile 3G/4G LTE/CDMA450
wireless rout e rs suitable for a variety of business and industrial deployments. The
compact and rugged structure makes a suitable product for deployments in M2M
applications such as CCTV, ATM, telemetry, SCADA, retail (POS), digital signage, and
intelligent traffic systems. The product line suppo rts the following radio access
technologies: HSPA+, HSPA, UMTS, EDGE, CDMA450, GPRS and GSM.
3G is the third generation of mobile phone standards and tec hnology. It is based on the
International Telecommunication Union (I TU) family of standards under the International
Mobile Telecommunications programme, IMT-2000.
4G is a mobile communications standard intended to replace 3G, allowing wireless
internet access at a much higher speed.
3G and 4G technologies enable network operators to offer users a wider range of more
advanced services, w hi l e achieving greater network capacity through improved spectral
efficiency. Services include wide-area wireless voice telephony, video calls, and
broadband wireless data, all in a mobile environment.
1: Introduction
1.1 Document scope
This document covers the following models in the GW2020 Series.
GW2021: 1 x Ethernet and 3G, 4G/LTE
GW2022: 2 x Ethernet and 3G, 4G/LTE
GW2023: 2 x Ethernet, 3G, 4G/LTE and dual RS232
GW2024P-4: 4 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plastic case
GW2024P-8: 8 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plastic case
GW2024P-2: 2 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plastic case
GW2027: 2 x Ethernet, 3G, 4G/LTE, CDMA450, single RS232 and single RS485, Digital I/O
Note: the second input is either RS232 or RS485 and is specified at time of ordering and
fixed in manufacturing.
GW2028: 4 x Ethernet, 3G, 4G/LTE, CDMA450,single RS232 and single RS485, Dig ita l I/O
Note: the second input is either RS232 or RS485 and is specified at time of ordering and
The above hardware models use the GIG branch of firmware. This document was
released with firmware version GIG-15.00.50. The screenshots and commands may
vary slightly if you are using a different firmware version.
You can configure your router using either the router’s web interface or via the command
line using UCI commands. Each chapter explains first the web interface settings,
followed by how to configure the router using UCI. The web interface screens are shown
along with a path to the screen for example, ‘In the top menu, select Service -> SNMP.’ followed by a screen grab.
After the screen grab there is an information table that describes each of the screen’s
fields.
1.2.1 Information tables
We use information tables to show the different ways to configure the router using the
router’s web and command line. The left-hand column shows three options:
• Web: refers the command on the router’s web page,
• UCI: shows the specific UCI command, and
• Opt: shows the package option.
1: Introduction
The right-hand column shows a description field that describes the feature’s field or
command and shows any options for that feature.
Some features have a drop-down menu and the options are described in a table within
the description column. The default value is shown in a grey cell.
Values for enabling and disabling a feature are varied throughout the web interface, for
example, 1/0; Yes/No; True/False; check/unc heck a radio button. In the table
descriptions, we use 0 to denote Disable and 1 to denote Enable.
Some configuration s ections can be define d more than once. An example of this is the
routing table where multiple routes can exist and all are named ‘route’. For these
sections, the UCI command will have a code value [0] or [x] (where x is the section
number) to identify the section.
Web: Metric
UCI: network.@route[0].metric
Specifies the route metric to use.
Note: these sections can be given a label for identification when using UCI or package
options.
Throughout the document, we use the host name ‘VA_router’ to cover all router models.
UCI commands and package option examples are shown in the following format:
Enables CESoPSN services.
Selects the severity used for logging events CESoPS N in syslog .
The following levels are available .
Specifies the address(es) and port(s) on which the agent should
listen.
[(udp|tcp):]port[@address][,…]
Table 1: Example of an information table
root@VA_router:~# vacmd show current config
1.2.3 Diagnostics
Diagnostics are explained at the end of each feature’s chapter.
1.2.4 UCI commands
For detailed information on using UCI commands, read chapters ‘Router File Structure’ and ‘Using
2 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485
GW2024P-2:
2 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plas tic c as e
Note: the second input is either RS232 or RS485 and is software se lectab le .
2 GW2020 hardware specification
2.1.1 GW2020 Series router model variants
GW2022: 2 x Ethernet and 3G, 4G/LTE
GW2023: 2 x Ethernet, 3G, 4G/LTE and dual RS232
GW2024P-4: 4 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plastic case
GW2024P-8: 8 x Ethernet, 3G, 4G/LTE, single RS232 and single RS485, plastic case
GW2027: 2 x Ethernet, 3G, 4G/LTE, CDMA450, single RS232 and single RS485 , Digital I /O
GW2028: 4 x Ethernet, 3G, 4G/LTE, CDMA450,single RS232 and single RS485 , Dig ital I/O
Note: the second input is either RS232 or RS485 and is software se lectab le .
2: GW2020 hardware specification
2.2 Hardware features
• Dual SIM sockets
• Dual antenna SMA connectors
• Up to eight 10/100 Mbps Ethernet ports.
• Optional 1 or 2 RS232 ports
• Optional 4KV isolation ports
• Optional RS485 port
• SIM cover
• GW2024P Series only: optional 2.2 seconds last gasp hold up time
2.3 Serial ports
The asynchronous serial ports are named:
• Port 0: ‘/dev/ttySC0’
• Port 1: ‘/dev/ttySC1’
Each serial port has a number of configurable settings, such as baud rate, word size,
parity, flow control mode, etc.
EN55022 and EN55024 for more speci fic det ai l s plea se read the GW2024P datasheet.
Safety
EN60950
2.5.2 GW2024P Series router
The GW2024P-2 router is powered from a 24V AC input and GW2024P-4/GW2024P-8
use a 36V AC input to achieve 2.2 seconds of power hold-up. This enables a last gasp
message to be reliably sent on power down.
The GW2024P Series router is supplied with a 240 – 24/36V AC DIN-mounted
transformer. Any alternative power supply used should be a limited power supply with a
secondary circuit protection device, such as a PTC.
2.5.3 GW2028 Series router
• DIN rail 100V-240V AC PSU -20°C to +70°C
2.6 Router dimensions
GW2020 Series unit size: 100W 138D 34H mm
GW2020 Series unit weight: 500g
GW2024P Series unit size: 160W 75D 120H
2: GW2020 hardware specification
GW2028 Series unit size: 52W 116D 157H
GW2028 Series unit weight: 500g
2.7 Compliance
2.7.1 GW2020 Series router compliance
The GW2020 Series router is compliant and tested to the follow ing standards:
Environmental ETSI 300 019-1-3 Sinusoidal Vibration and Shock ETSI 300 019-2-3 Random Vibration.
2.7.2 GW2024P Series router compliance
The GW2024P Series router is compliant and tested to the following standards:
Environmental EN60068-2-6: 2008 Sinusoidal Vibration and EN60068-2-48: 2000 Random Vibration.
2.7.3 GW2028 Series router compliance
The GW2028 Series router is compliant and tested to the follow ing standards:
EMC EN55022 and EN5502 4 for more specific details please read the GW2028 datasheet.
Environmental ETSI 300 019-1-3 Sinusoidal Vibration and Shock ETSI 300 019-2-3 Random Vibration.
The operating temperature range depends on the router’s type of power supply.
GW202X 0°C to 40°C Standard AC PSU
GW202X-ET -20°C to 70°C Extend e d tempe rature AC PSU
GW202X-DC -20°C to 70°C DC power cable
GW2024P-8 -20°C to 70°C DIN rail PSU
2.9 Antenna
The GW2020 Series router has two SMA connectors for connection of two antennas for
antenna diversity. Antenna diversity helps improve the quality of a wireless link by
mitigating problems associated with multipath interference.
2: GW2020 hardware specification
2.10 Components
To enable and configure connections on your router, it must be correctly installed.
The GW2020 Series router contains an internal web server that you use for
configurations. Before you can access the internal web server and start the
configuration, ensure the components are correctly connected and that your PC has the
correct networking setup.
2.10.1 GW2020 Series components
The GW2020 Series router comes with the following components as standard.
2. Hold the SIM 1 card with the chip side facing down and the cut corner front left.
3. Gently push the SIM card into SIM slot 1 until it clicks in.
4. If using SIM 2 then hold the SIM with the cut cor ner front right
5. Gently push the SIM card into SIM slot 2 until it clicks in.
2.12 Connecting the SIM lock
Connect the SIM lock using the Allen key provided.
2.12.1 Connecting cables
Connect one end of the Ethernet cable into port A and the other end to your PC or
switch.
2: GW2020 hardware specification
2.13 Connecting the antenna
If you are only connecting one antenna, screw the antenna into the MAIN SMA
connector.
If you are using two antennas, screw the main antenna into the MAIN SMA connect or
and the secondary antenna into the AUX SMA connec tor.
2.14 Powering up the GW2020 Series router
Plug the power cable into an electrical socket suitable for the power supply.
The GW2020 takes approximately 2 minutes to boo t up. During this time, the power LED
flashes.
Other LEDs display different diagnostic patterns during boot up.
Booting is complete when the power LED stops flashing and stays on steady.
2.15 Powering up the GW2024P Series router
The GW2024P Series router is supplied with an external DIN mount AC transformer,
230V AC input and 24/36V AC output. Both the input and output connectors use Philips
head screws in a terminal block.
1. Slide the terminal block covers off using a small amount of pressure.
2. Wire the 230V AC input to the electrical supply in accordance with local regulations.
3. Wire the 24/36V AC output to the supplied 2 pin terminal connector.
4. Replace the covers on the AC transformer terminal block.
5. Connect the 24/36V AC output to the GW2024P router.
The reset button is used to request a system reset.
When you press the reset button all LEDs turn on simultaneously. The length o f time you
hold the reset button will determine its behaviour.
Between 3 and 5 seco nds The router resets to factory configur ation.
Between 20 seconds and 25 seconds Recovery mode.
2.16.1 Recovery mode
Recovery mode is a fail-safe mode where the router can load a default configuration
from the routers firmware. If your router goes into recovery mode, all config files are
kept intact. After the next reboot, the router will revert to the previous config file.
2: GW2020 hardware specification
Table 6: GW2020 Series router reset behaviour
You can use recovery mode to manipulate the config files, but should only be used if all
other configs files are corrupt. If your router has entered recovery mode, contact you r
local reseller for access information.
No data is being transmitted/receiv ed over the link .
3.2 GW2020 Ethernet port LED behaviour
The Ethernet port ha s two LEDs: a LINK LED (green) and an ACT LED (amber). When
looking at the port, the LED on the left hand side is the LINK LED, and the ACT LED is o n
the right hand side.
Figure 6: Ethernet LED activity
3: GW2020 Series LED behaviour
Link LED
(green)
ACT LED
(amber)
Off No physical Ethernet link detected.
Flashing Data is being transmitted/received over the link.
SIM selected and already registered on the networ k.
Off
Not selected or SIM not inserted.
off
on
On
Link is up.
4: GW2024P Series LED behaviour
The possible main LED states are:
• Off
• Flashing slowing
• Flashing quickly
• On
The following table describes the possible LED behaviours and meanings.
The GW2024P takes approximately 2 minutes to boot up . During this tim e , the power LED
Booting
Power
flashes.
Other LEDs display different diagnos tic p atter ns dur ing boot up.
Booting is complete when the power LED stops flashing and stays on steady.
On Power connected.
Off No power.
Config
SIM
Signal*
Flashing slowly Unit running in recovery mode (5 Hz).
Flashing quickly Unit running in factory conf igur ati o n (2.5 Hz).
Flashing SIM selected and in the process of registering on the network.
None PPP not connected or signal strength <= -113dBm.
Bottom on, top
Bottom off, top
Both on Data connection up and signal strength >-69dBm
*Note: When data connection is not up, none of the signal LEDs will light regardless of
signal strength.
4.2 Ethernet LED behaviour
The Ethernet ports have one LED light.
The possible Ethernet LED states are:
Data connection up and signal strength <= -89dBm.
Data connection up and signal strength betwee n -89dBm and -69dBm.
• Off
• Flashing
• On
The following table describes the possible LED behaviours and meanings.
The GW2028 Series router has single colour LEDs for Power, Config, SIM1, SIM2 and
signal strength. When the router is powered on, the LED is green.
5: GW2028 Series LED behaviour
The possible LED states are:
• Off
• Flashing slowing
• Flashing quickly
• On
The G W202 8 tak es appr ox imately 2 minute s to boot up . During
Booting
Power LED
Config LED
On Power connected.
Flashing slowly Unit running in recovery mode (5 Hz).
Figure 10: Example of LED activity
this time, the power LED flashes.
Other LEDs display different diagnos tic p atter ns dur ing boot up.
Booting is complete when the power LED stops flashing and
stays on steady.
SIM LEDs
Signal LEDs
Off Not selected or SIM not inserted.
Flashing SIM selected and not registered on the network.
Bottom on, top off Data co nne c tio n up and signal strength <= -89dBm.
Bottom off, top on D ata co nne c tio n up and signal strength between -89dBm and -
No data is being transmitted/receiv ed over the link
Note: when PPP is not connected, none of the signal LEDs will light regardless of signal
strengt
h.
5.2 Ethernet port LED behaviour
The Ethernet port has two LEDs: a LINK LED (green) and an ACT LED (amber). When
looking at the port, the LED on the top is the LINK LED, and the ACT LED is on the
bottom.
Figure 11: Ethernet LED activity
5: GW2028 Series LED behaviour
Link LED
(green)
ACT LED
(amber)
Off No physical Ethernet link detected
On Physical Ethernet link de tected
Flashing Data is being transmitted/ received over the link
6 Factory configuration extract ion from SIM c a rd
Virtual Access routers have a feature to update the factory configuration from a SIM
card. This allows you to change the factor y configuration of a router when installing the
SIM.
1. Make sure the SIM card you are inserting has the required configuration written on it.
2. Ensure the router is powered off.
3. Hold the SIM 1 card with the chip side facing down and the cut cor ner front left.
4. Gently push the SIM card into SIM slot 1 until it clicks in.
5. Power up the router.
Depending on the model, the power LED and/or the configuration LED flash as usual.
The SIM LED starts flashing. This indicates the application responsible for 3G and
configuration extraction management is running. It also means the update of the
configuration is happening.
When the update is finished, depending on the model, the power LED and/or the
configuration LED blink alternatively and very fast for 20 seconds.
Assuming that the PC is connected to Port A on the router, in your interne t browser, type
in the default local IP address 192.168.100.1, and press Enter. The Authorization page
appears.
Figure 12: The login page
The password may vary depending on the factory configuration the router has been
shipped with. The default settings are shown below. The username and password are
case sensitive.
In the username field, type root.
In the Password field, type admin.
Click Login. The Status page appears.
7.3 Accessing the router over Ethernet usin g an SSH client
You can also access the router over Ethernet, using Secure Shell (SSH) and optionally
over Telnet.
To access CLI over Ethernet start an SSH client and connect to the router’s management
IP address, on port 22: 192.168.100.1/24.
On the first connection, you may be asked to confirm that you trust the host.
7: Accessing the router
Figure 13: Confirming trust of the routers public key over SSH
Figure 14: SSH CLI logon screen
In the SSH CLI logon screen, enter the default username and password.
Username: root
Password: admin
7.3.1 SCP (Secure Copy Protocol)
As part of accessing the router over SSH, you can also use SCP protocol. Use the same
user authentication credentials as for SSH access. You can use SCP protocol to securely
manually transfer files from and to the ro ut er’s SCP server.
No dedicated SPC client is supported; select the SCP client software of your own choice.
SSH allows you to access remote machines over text based shell sessions. SSH uses
public key cryptography to create a secure connection. These connections allow you to
issue commands remotely via a command line.
The router uses a package called Dropbear to configure the SSH server on the box. You
can configure Dropbear via the web interface or through an SSH connection by editing
the file stored on: /etc/config_name/dropbear.
7.11.1 Configuration packages used
dropbear dropbear
7.11.2 SSH access using the web interface
In the top menu, click System -> Administration. The Administration page appears.
Scroll down to the SSH Access section.
Listens only on the selected interface. If uns pec ified is checked,
listens on all interfaces. All configured interfaces will be displayed
via the web GUI.
(unspecified) listens on all interfaces.
Range Configured interface names.
Specifies the listening port of the Dropb e ar ins tanc e .
Certificates are used to prove ownership of a public key. They contain information about
the key, its owner’s ID, and the digital signature of a n individual that has verified the
content of the certificate.
In asymmetric cryptography, public keys are announced to the public, and a different
private key is kept by the receiver. The public key is used to encrypt the message, and
the private key is used to decrypt it.
To access certs and private keys, in the top menu, click System -> Ad ministration.
The Administration page appears. Scroll down to the Certs & Private Keys section.
7: Accessing the router
Figure 17: The certificates & private keys section
This section allows you to upload any certificates and keys that you may have stored.
There is support for IPSec, OpenVPN and VA certificates and keys.
If you have generated your own SSH public keys, you can input them in the SSH Keys
section, for SSH public key authentication.
Figure 18: The SSH-Keys box
7.14Configuring a router’s web server
The router’s web server is configured in package uhttpd. This file defines the behaviour
of the server and default values for certificates generated for SSL operation. uhttpd
supports multiple instances, that is, multiple listen ports, each with its own document
root and other features, as well as cgi and lua. There are two sections defined:
Main: this uHTTPd section contains general server settings.
Cert: this section defines the default values for SSL certificates.
Specifies the ports and addresses to listen on for plain HTTP
access. If only a port number is given, the server will attempt to
serve both IPv4 and IPv6 requests.
0.0.0.0:80 Bind at port 80 only on IPv4
[::]:80 Bind at port 80 only on IPv6
Range IP address an d/or port
Specifies the ports and address to listen on for encrypte d HTTPS
access. The format is the same as listen_http.
ASN.1/DER certificate used to serve HTTPS co nnections. If no
listen_https options are given the key options are ignored.
Opt: cert
Web: Key file
UCI: uhttpd.main.key
Range
ASN.1/DER private key used to serve HTTPS connections . If no
listen_https options are given the key options are ignored.
Opt: key
Web: CGI profile
UCI: uhttpd.main.cgi_pref ix
Opt: cgi_prefix
Web: N/A
UCI: uhttpd.main.lua_prefi x
Opt: lua_prefix
Range
Defines the prefix for CGI scripts, relative to the document root.
CGI support is disabled if this option is missing .
/cgi-bin
Defines the prefix for dispatching reque s ts to the embedd ed lua
interpreter, relative to the document roo t. Lua s uppor t is
disabled if this option is missing.
Web: Script timeout
UCI: uhttpd.main.script_time out
Opt: script_timeout
Specifies the lua handler script used to initia lis e the lua runtime
on server start.
/usr/lib/lua/luci/sgi/uhttpd.lua
Sets the maximum wait time for CGI or lua requests in seconds.
Requested executables are terminated if no output w as
generated.
Range
Web: Network timeout
UCI: uhttpd.main.network_ timeo ut
Opt: network_timeout
Maximum wait time for network activity. Reques te d exec utable s
are terminated and connection is shut down if no networ k activity
occured for the specified number of seconds.
30
Range
Web: N/A
UCI: uhttpd.main.realm
Opt: realm
Web: N/A
UCI: uhttpd.main.config
Opt: config
Web: N/A
UCI: uhttpd.main.index_page
Defines basic authentication realm w he n pro mpting the client f or
credentials (HTTP 400).
OpenWrt
Config file in Busybox httpd format for additional se tti ng s .
Currently only used to specify basic auth ar e as.
/etc/http.conf
Range
Index file to use for directories, for examp le , add index.php when
using php.
Opt: index_page
Web: N/A
UCI: httpd.main.error_pag e
Range
Virtual URL of file of CGI script to handle 404 requests. Must
begin with ‘/’ (forward slash).
Opt: error_page
Web: N/A Does not follow symbolic links if enabled .
Validity time of the generated certifica te s in days.
730
Range
Size of the generated RSA key in bits.
Range
ISO code of the certificate issuer.
Range
State of the certificate issuer.
Location or city of the certificate user.
Range
Common name covered by the certificate. For the purposes of
secure Activation, this must be set to the serial numb er (Eth0
MAC address) of the device.
For backward compatibility reasons, uhttpd uses the file /etc/httpd.conf to define
authentication areas and the associated usernames and passwords. This conf iguration
file is not in UCI format.
Authentication realms are defined in the format prefix:username:password with one
entry and a line break.
Prefix is the URL part covered by the realm, for example, cgi-bin to request basic auth
for any CGI program.
Username specifies the username a client has to login with.
Password defines the secret password required to authenticate.
The password can be either in plain text format, MD5 encoded or in the form $p$user
where the user refers to an account in /etc/shadow or /etc/passwd.
If you use $p$… format, uhttpd will compare the client provided p a ss word against the
one stored in the shadow or passwd database.
By default, uhttpd binds to 0.0.0.0 which also includes the WAN port of your router. To
bind uhttpd to the LAN port only you have to change the listen_http and listen_https
options to your LAN IP address.
To get your current LAN IP address, enter:
uci get network.lan.ipaddr
Then modify the configuration appropriately:
uci set uhttpd.main.listen_http='192.168.1.1:80'
uci set uhttpd.main.listen_https='192.168.1.1:443'
config 'uhttpd' 'main'
list listen_http 192.168.1.1:80
list listen_https 192.168.1.1:443
Dynamic DNS (DDNS) functionality on a Virtual Access router will dynamically perform
DDNS updates to a server so it can associate an IP address with a correc tly associated
DNS name. Users can then c ontact a machine, router, device and so on with a DNS
name rather than a dynamic IP address.
An account is required with the provider, and one or more domain names are associated
with that account. A dynamic DNS client on the router monitors the public IP address
associated with an interface and whenever the IP address changes, the client notifies the
DNS provider to update the corresponding domain name.
When the DNS provider responds to queries for the domain name, it sets a low lifetime,
typically a minute or two at most, on the response so that it is not cached. Updates to
the domain name are thus visible throughout the whole Internet with little delay.
Note: most providers impose restrictions on how updates are handled: updating when
no change of address occurred is considered abusive and may result in an acco un t b eing
blocked. Sometimes, addresses must be refreshed periodically, for example, once a
month, to show that they are still in active use.
8: Configuring Dynamic DNS
8.2 Configuration packages used
8.3 Configuring Dynamic DNS using the web inter face
In the top menu, select Services -> Dynamic DNS. The Dynamic DNS Configuration
page appears.
Figure 21: The Dynamic DNS configuration page
Enter a text name that will be used for the dynamic DNS section in the configuration.
Select Add. The Dynamic DNS configuration options appear.
Web: Check for changed IP every
UCI: ddns.<name>.check_interval
Opt: check_interval
Web: Check-time unit
UCI: ddns.<name>.check_unit
Opt: check_unit
Web: Force update every
UCI: ddns.<name>.force_interval
Opt: force_interval
Defines the type of interface whose IP needs to be updated
Defines the network whose IP needs to be updated.
Displayed when the Source of IP address option is set to
network.
Defines the interface whose IP needs to be updated.
Displayed when the Source of IP address option is set to
interface.
Defines the URL where the IP downloaded from.
Displayed when the Source of IP address option is set to URL.
Defines how often to check for an IP change. Used in conjunction
with check_unit.
Defines the time unit to use for check for an IP change. Used in
conjunction with check_interval.
Defines how often to force an IP update to the provider. Used in
conjunction with force_unit.
Web: Force-time unit
UCI: ddns.<name>.force_unit
Opt: force_unit
Web: Listen on
UCI: ddns.<name>.interface
Opt: interface
Table 13: Information table for dynamic DNS settings
8.4Dynamic DNS us ing UCI
Dynamic DNS uses the ddns package /etc/config/ddns
8.4.1 UCI commands for DDNS
root@VA_router:~# uci show ddns
ddns.ddns1=service
ddns.ddns1.enabled=1
ddns.ddns1.service_name=dyndns.org
Defines the time unit to use for check for an IP change. Used in
conjunction with force_interval.
Defines the interface for ddns monitoring . Typ ic a lly this w i ll be
the same as the interface whose IP is being updated – as defined
ip_network or ip_interface
The system section contains settings that apply to the most basic operation of the
system, such as the host name, time zone, logging details, NTP server, language and
style.
The host name appears in the top left hand corner of the interface menu. It also appears
when you open a Telnet o r S SH session.
Note: this document shows no host name in screen grabs. Throughout the document we
use the host name ‘VA_router’.
The system configurat ion contains a logging section for the configuration of a Syslog
client.
9.1 Configuration package use d
system
9: System settings
9.2 Configuring s ystem properties
To set your system properties, in the top menu, click System. There are four sections in
the System page.
Logging Configure a router to log to a server. You can configure a Syslog client in this
Web: Log output level
UCI: system.main.conloglev e l
Opt: conloglevel
Web: Cron Log Level
UCI: system.main.cronloglev el
Opt: cronloglevel
Sets the maximum log output level severity for system events.
System events are written to the system log. Messages with a
lower level or level equal to the configured level are dis p la yed in
the console using the logread command, or alter native ly wr itten
to flash, if configured to do so.
Debug Information useful to developers for
Info Normal operational messages that
Notice Events that are unusual, b ut not
Warning May indicate that an error will occur
8
7
6
5
Sets the maximum log level for kernel messages to be logged to
the console. Only messages with a level lower, or level equal to
the configured level will be printed to the console.
Web: n/a
UCI: system.main.log_file
Web: n/a
UCI: system.main.log_type
Opt: log_type
Table 15: Information table for the logging section
9.2.3Language and style
Since logread is only small in size it can be beneficial to write
system events to flash. This option define s the file path to write
the events. Set to ‘root/syslog.messages’
Defines whether to write the system events to a file rather than
logread. Set to ‘file’ to write to the file configured under log_file
option.
Web: NTP server candidates
UCI: system.ntp.server
Opt: list server
9.2.5 System reboot
The router can be configured to reboot immediately, or sche duled to reboot a configured
time in the future.
Enables NTP server.
Specifies interval of NTP requests in hours. Default value set to
auto.
Defines the list of NTP servers to poll the time from. If the list is
empty, the built in NTP daemon is not started. Multiple serv e rs
can be configured and are separated by a space if using UCI.
Table 17: Information table for time synchronization section
In the top menu, select System -> Reboot. The System page appears.
Ensure you have saved all yo ur configuration changes before you reboot.
Check the Reboot now check box and then click Reboot.
9.3 System setti n gs using UCI
root@VA_router:~# uci show system
system.main=system
system.main.hostname=VA_router
system.main.timezone=UTC
system.main.log_ip=1.1.1.1
system.main.log_port=514
system.main.conloglevel=8
system.main.cronloglevel=8
system.ntp.interval_hours=auto
system.ntp.server=0.VA_router.pool.ntp.org 10.10.10.10
System settings using package options
root@VA_router:~# uci export system
package 'system'
config 'timeserver' 'ntp'
option interval_hours 'auto'
list server "0.VA_router.pool.ntp.org"
list server ’10.10.10.10’
9.4 System diagnostics
9.4.1 System events
Events in the system have a class, sub class and severity. All events are written to the
system log.
9.4.1.1 Logread
To view the system log, use:
9: System settings
root@VA_router:~# logread
Shows the log.
root@VA_router:~# logread |tail
Shows end of the log.
root@VA_router:~# logread | more
Shows the log page by page.
root@VA_router:~# logread –f
Shows the log on an ongoing basis. To s top this o ption, p ress ctrl-c.
root@VA_router:~# logread –f &
Shows the log on an ongoing basis while in the background. This allows you to run other
commands while still tracing the event logs. To stop this option, type fg to view the
current jobs, then press ctrl-c to kill those jobs.
Since logread is on ly small in size it can be beneficial to wr ite system events to flash. T o
do this you need to modify the system config under the system package. Set the options
‘log_file’, ‘log_size’ and ‘log_type’ as below:
root@VA_router:~# uci export system
package system
config system 'main'
option hostname 'VA_router'
option zonename 'UTC'
option timezone 'GMT0'
option conloglevel '8'
option cronloglevel '8'
option time_save_interval_hour '10'
option log_hostname '%serial'
Copy the new firmware issued by Virtual Access to a PC connected to the router.
In the top menu, select System tab > Backup/Flash Firmware. The Flash operations
page appears.
10: Upgrading router firmware
Figure 28: The flash operations page
Under Flash new firmware image, click Choose File or Browse.
Note: the button will vary depending on the browser you are using.
Select the appropriate image and then click Flash Image . The Flash Firmware – Verify
page appears.
Figure 29: The flash firmware - verify page
Click Proceed. The System – Flashing… page appears.
When the ‘waiting for router’ icon disappears, the upgrade is complete, and the login
homepage appears.
To verify that the router has been upgraded successfully, click Status in the top menu.
The Firmware Version shows in the system list.
Figure 31: The status page
10.2Upgrading firmware using CLI
To upgrade firmware using CLI, you will need a TFTP server on a connected PC.
Open up an SSH or Telnet session to the router.
Enter in the relevant username and password.
To change into the temp folder, enter cd /tmp
To connect to your TFTP server, enter
atftp x.x.x.x
(where x.x.x.x is the IP of your PC).
Press Enter.
While in the TFTP application to get the image, enter:
This chapter expla ins how to view Virtual Access routers' log files and e dit configuration
files using a Command Line Interface (CLI) and the Unified Configuration Interface (UCI)
system.
11.1 Overview of some common commands
Virtual Access routers’ system has an SSH server typically running on port 22.
The factconf default password for the root user is admin.
To change the factconf default password, enter:
root@VA_router:/# uci set system.main.password=”******”
root@VA_router:/# uci commit system
To reboot the system, enter:
11: Using the Command Line Interface
root@VA_router:/# reboot
The system provides a Unix-like command line. Common Unix commands are available
such as ls, cd, cat, top, grep, tail, head, more and less.
Typical pipe and redirect operators are also available, such as: >, >>, <, |
The system log can be viewed using any of the following commands:
root@VA_router:/# logread
root@VA_router:/# logread | tail
root@VA_router:/# logread –f
These commands will sho w the full log, end of the log (tail) and continuously (-f). Enter
Ctrl-C to stop the continuous output from logread -f.
To view and edit configuration files, the system uses the Unified Configuration I nt erface
(UCI) which is described further on in this chapter. This is the preferred method of
editing configuration files. However, you can also view and edit these files using some of
the standard Unix tools.
For example, to view a text or configuration file in the system, enter:
To search for a process, enter: pgrep -fl '<process name or part of name>':
root@VA_router:/# pgrep -fl ‘wifi’
424 root 320 S wifi up
To kill a process, enter the PID:
root@VA_router:~# kill 424
11.2 Using Unified Configuration Interface (UCI)
The system uses Unified Configuration Interface (UCI) for central configuration
management. Most common and useful configuration settings can be accessed and
configured using the UCI system.
UCI consists of a Command Line Utility (CLI), the files containing the actual configuration
data, and scripts that take the configuration data and a pp ly it to the proper parts of the
system, such as the networking interfaces. Entering the command 'uci' on its own will
display the list of valid arguments for the command and their format.
11: Using the Command Line Interface
root@VA_router:/lib/config# uci
Usage: uci [<options>] <command> [<arguments>]
Commands:
export [<config>]
import [<config>]
changes [<config>]
commit [<config>]
add <config> <section-type>
add_list <config>.<section>.<option>=<string>
show [<config>[.<section>[.<option>]]]
get <config>.<section>[.<option>]
set <config>.<section>[.<option>]=<value>
delete <config>[.<section[.<option>]]
rename <config>.<section>[.<option>]=<name>
revert <config>[.<section>[.<option>]]
Options:
-c <path> set the search path for config files (default: /etc/config)
-d <str> set the delimiter for list values in uci show
-m when importing, merge data into an existing package
-n name unnamed sections on export (default)
-N don't name unnamed sections
-p <path> add a search path for config change files
-P <path> add a search path for config change files and use as default
-q quiet mode (don't print error messages)
-s force strict mode (stop on parser errors, default)
-S disable strict mode
-X do not use extended syntax on 'show'
The table below describes commands for the UCI command line and some further
examples of how to use this utility.
Writes changes of the given configuration file,
or if none is given, all configuration files, to
the filesystem. All "uci set", "uci add", "uc i
rename" and "uci delete" commands are
commit [<config>]
export [<config>]
changes [<config>]
add <config> <section-type>
add_list <config>.<section>.<option>=<string> Adds the given str ing to an existing lis t o p tion.
show [<config>[.<section>[.<option>]]]
get <config>.<section>[.<option>]
set <config>.<section>[.<option>]=<value>
staged into a temporary location and written to
flash at once with "uci commit". This is not
needed after editing configuration files with a
text editor, but for scripts, GUIs and other
programs working directly with UCI files .
Exports the configuration in a UCI syntax and
Lists staged changes to the given configuration
file or if none given, all configuration files.
Adds an anonymous section of type sectiontype to the given configuration.
Shows the given option, section or
Gets the value of the given option or the type
Sets the value of the given option, or add a
new section with the type set to the given
delete <config>[.<section[.<option>]] Deletes the given section or option.
rename <config>.<section>[.<option>]=<name>
revert <config>[.<section>[.<option>]]
Table 18: Common commands, target and their descriptions
Note: all operations do not act directly on the configuration files. A commit command is
required after you have finished your configuration.
root@VA_router:~# uci commit
11.2.1 Using uci commit to avoid router reboot
After changing the port, uhttpd listens on from 80 to 8080 in the file /etc/config/uhttpd;
save it, then enter:
root@VA_router:~# uci commit uhttpd
Then enter:
root@VA_router:~# /etc/init.d/uhttpd restart
For this example, the router does not need to reboot as the changes take effect when
the specified process is restarted.
11: Using the Command Line Interface
11.2.2 Export a configuration
Using the uci export command it is possible to view the entire configuration of the router
or a specific package. Using this method to view configurations does not show comments
that are present in the configuration file:
root@VA_router:~# vacmd set next image [image1|image2|altimage]
root@VA_router:~# reboot
11.2.6 Format of multiple rules
When there are multiple rules next to each other, UCI uses array-like references for
them. For example, if there are 8 NTP servers, UCI will let you reference their sections
as timeserver.@timeserver[0] for the first section; or timeserver.@timeserver[7]
for the last section.
You can also use negative indexes, such as timeserver.@timeserver[-1] ‘-1’ means
the last one, and ‘-2’ means the second -to-last one. This is useful whe n appending new
rules to the end of a list.
The table below lists common package configuration files that ca n be edited using uci
commands. Other configuration files may also be present depending on the specific
options available on the Virtual Access router.
Management
/etc/config/httpclient Activator addresses and urls
/etc/config/monitor Monitor details
/etc/config/dropbear SSH server options
/etc/config/dhcp Dnsmasq configuration and DHCP settings
/etc/config/network Switch, interface, L2TP and route configuration
/etc/config/system Misc. sy s tem settings inc l ud ing sy s log
/etc/config/snmpd SNMPd settings
/etc/config/uhttpd Web server options (uHTTPd)
11.4 Configuration file syntax
The configuration files usually consist of one or more config stateme nt s, so-called
sections with one or more option statements defining the actual values.
Below is an example of a simple co nfiguration file.
package 'example'
config 'example' 'test'
option 'string' 'some value'
option 'boolean' '1'
list 'collection' 'first item'
list 'collection' 'second item'
The config 'example' 'test' statement defines the start of a section with the type
example and the name test. There can also be so-called anonymous sections with only a
type, but no name identifier. The type is important for the processing programs to
decide how to treat the enclosed options.
The option 'string' 'some value' and option 'boolean' '1' lines define simple
values within the section.
Note: there are no syntactical differences between text and boolean options. Per
convention, boolean options may have one of the values '0', 'no', 'off' or 'false' to
specify a false value or '1' , 'yes', 'on' or 'true' to specify a true value.
In the lines starting with a list keyword, an option with multiple values is defined. All list
statements that share the same name collection in our example will be combined into a
single list of values with the same order as in the configuration file.
The indentation of the option and list stateme nts is a conv ention to improve the
readability of the configuration file but it is not syntactically required.
Usually you do not need to enclose identifiers or v alues in quotes. Quotes are only
required if the enclosed value contains spaces or tabs. Also it is legal to use doublequotes instead of single-quotes when typing configuration options.
All of the examples below are valid syntax.
option example value
option 'example' value
option example "value"
option "example" 'value'
option 'example' "value"
In contrast, the following examples are not valid syntax.
option 'example" "value'
Quotes are unbalanced.
option example some value with space
Missing quotes around the value.
It is important to note that identifiers and config file names may only contain the
characters a-z, A-Z, 0-9 and _. However, option values ma y contain any character, as
long they are properly quoted.
This chapter contains the configuration sections a nd parameters required to manage and
monitor your device using Activator and Monitor.
12.1 Activator
Activator is a Virtual Access proprietary provisioning system, where specific router
configurations and firmware can be stored to allow central management and
provisioning. Activator has two distinct roles in provisioning firmware and configuration
files to a router.
•Zero touch activation of firmware and configuration files on router boot up
o In this scenario the router will initiate the requesting of firmware and
configuration files on boot and is generally used for router installat io n. The
router will be installed with a factory config that will a l low it to contact
Activator. The autoload feature controls the behaviour of the router in
requesting firmware and configuration files; this includes when to start the
Activation process and the specific files requested. The HTTP Client
(uhttpd) contains information about the Activator server and the protocol
used for activation.
12: Management configuration settings
• Deployment of firmware to routers after installation
o In this scenario, Activator will initiate the process. This process, known as
Active Update, allows for central automatic deplo yment of firmware and
configuration files. It is used when configuration or firmware changes need
to be pushed to live routers.
12.2 Monitor
Monitor is a Virtual Access proprietary tool, based on SNMP protocol, to monitor wide
networks of deployed routers. The router will be configured to send information to
Monitor, which is then stored and viewed centrally via the Monitor application. This
includes features such as traffic light availabi li ty status, syslog and SLA monitoring.
12.3 Configuration packages used
12.4 Autoload: boot up activation
Autoload configurations specify how the device should behave with respect to activation
when it boots up. Autoload entries contain information abo ut the specific files to be
downloaded and the destination for the downloaded file. Standard autoload entry
configurations to download are:
• A firmware file ($$.img)
• A configuration file ($$.ini)
• A .vas file ($$.vas). This file signals the end of the autolaod sequence to Activator
Activator identifies the device using the serial number of the router. $$ syntax is used to
denote the serial number of the router when requesting a file. The requested files are
written to the alternate image or config segment.
You can change the settings either directly in the configuration file or via appropriate UCI
set commands. It is normal procedure for autoload to be enabled in the router’s factory
settings and disabled in running configurations (config 1 and 2).
Autoload may already have been set at factory config level. If you wish to enable
autoload services, proceed through the following steps.
12.5 Autoload packa ge s
12: Management configuration settings
12.5.1 Create a configuration file
In the top menu, select Services ->Autoload. The Autoload page has two sections:
Basic Settings and Entries. Click Add to access configuration settings for each section.
12.7 HTTP Client: configuring activation usi n g the web interface
This section contains the settings for the HTTP Client used during activation and active
updates of the device.
The httpclient core section configures the basic functionality of the mo dule us ed for
retrieving files from Activator during the activation process.
12.7.1 HTTP Client configuraton packages
12.7.2 Web configuration
To configure HTTP Client for Activator, in the top menu, c lick Services -> HTTP Client.
The HTTP Client page has two sections: Basic Settings and Advanced Settings.
Specifies the address of Activator that us es http por t 80. This can
be an IP address or FQDN. The syntax should be x.x.x.x:80 or
FQDN:80. Multiple servers should be sep ara te d by a space using
Specifies the address of Secure Activator that uses port 443. This
can be an IP address or FQDN. The syntax should be x.x.x.x:443
or FQDN:443. Multiple servers should be separate d by a space
Enables Secure Download (port 443).
Specifies the URL on Activator to which the client should se nd
requests.
User management is not currently available using the web interface. You can configure
the feature using UCI or Activator.
12.9.1 User management packages
12.9.2 Configuring user management
You can create different users on the system by defining them in the user mana g ement
configuration file. This gives users access to different services.
Web: n/a
UCI: management_users.@user[x].enabled
Web: n/a
UCI: management_users.@user [x ].us e rname
Specifies the user’s password. When enter ing the user
password enter in plain text using the password option.
After reboot the password is displayed encrypte d v ia the CLI
using the hashpassword option.
UCI: management_users.@user [x ].hashpassword
Opt: hashpassword. Note: a SRP user password will be
Web: n/a
UCI: management_users.@user [x ].w eb us er
Opt: webuser
Web: n/a
UCI: management_users.@user [x ].s rp us er
Opt: srpuser
Web: n/a
UCI: management_users.@user [x ].s m s user
Opt: smsuser
Web: n/a
UCI: linuxuser
Opt: linuxuser
Web: n/a
UCI: List allowed_pages
Table 21: Information table for config user commands
Note:
Specifies CHAP access permissions for the PPP connection.
Note: chapuser will only work if linux user is set to Enabled .
Specifies PAP access permissions for the PPP co nnection.
Specifies SRP access permissions for the PPP co nnectio n.
Specifies SMS access permissions for the user.
Specifies linuxuser access permissions for the user.
Specifies which pages the user can view. Multiple p ages
should be entered using a space to separate if using UCI.
• webuser will only work if linuxuser is set to 'yes'
• chapuser will only work if linuxuser is set to 'no'
When a new user is created on the system and given web access, you will no longer be
able to login to the router web interface with the default root user details. The user must
use their new user login details.
12.10 Configuring the management user password using UCI
The user password is displayed encrypted via the CLI using the hashpassword option.
root@VA_router:~# uci show management_users
management_users.@user[0].username=test
management_users.@user[0].hashpassword=$1$XVzDHHPQ$SKK4geFonctihuffMjS4U0
If you are changing the password via the UCI, enter the new passwor d in plain te xt using
the password option.
root@VA_router:~# uci set management_users.@user[0].username=newpassword
root@VA_router:~# uci commit
The new password will take effect after reboot and will now be displayed in encrypted
format through the hashpassword option.
This section describes how to configure an Ethernet interface including configuring the
interface as a DHCP server, adding the interface to a firewall zone, mapping the physical
switch ports and defining loopback interface.
13.1 Configuration packages used
network
13.2 Configuring an Ethernet interface using the web interface
To create and edit interfaces via the web interface, in the top menu, click Network ->
Interfaces. The Interfaces overview page appears.
Interface Overview Shows existing interfaces and their status. Yo u can crea te new, and edit ex is ting
Port Map In this section you can map device ports to Etherne t inte rf ace s . Por ts are mark ed
ATM Bridges ATM bridges expose encapsulated Ethernet in AAL5 connections as virtual Linux
with capital letters starting with 'A'. Typ e in space -sep arated port character in the
network interfaces, which can be used in conjunction with DHCP or PPP to dial
13.2.1 Interface overview: editing an existing interface
To edit an existing interface, from the interface tabs at the top of the page, select the
interface you wish to configure. Alternatively, click Edit in the interface’s row.
13.2.2 Interface overview: creating a new interface
To create a new interface, in the Interface Overview section, click Add new interface.
The Create Interface page appears.
custom DNS servers, MTU and firewall configuration.
IP-Aliases
Assigning multiple IP addresses to the inte rf ac e
DHCP Server
Configuring DHCP server settings for this inte rface
Section
Description
netmask, custom DNS servers.
and 'Use gateway metric'
Physical Settings
Bridge interfaces, VLAN PCP to SKB priority mapping,
Firewall settings
Assign a firewall zone to the interface
13: Configuring an Ethernet interface
Web: Name of the new interface
UCI: network.<if name>
Opt: config interface
Web: Protocol of the new interface
UCI: network.<if name>.proto
Opt: proto
Web: Create a bridge over multiple
interfaces
UCI: network.<if name>.type
Opt: type
Assigns a logical name to the interface. The network inter f ace
section will assign this name (<if name>).
Type the name of the new interface.
Specifies what protocol the inter f ace will ope rate on. Select
Static.
Static Static config ur a tio n with f ixe d addr ess a nd
IPv6-in-IPv4
IPv6-over-
LTE/UMTS/
Used with tunnel brokers.
Stateless IPv6 over IPv4 transport.
CDMA, UMTS or GPRS connection using an
If you select this option, then the new logica l inte rf ace cr e ated
will act as a bridging interface between the chose n exis ti ng
physical interfaces.
Bridge Configures a bridge over multiple
Web: Cover the following interface
UCI: network.<if name > .ifname
Opt: ifname
Physical interface name to assign to this log ic a l inte rf ac e . If
creating a bridge over multiple interfaces select two interfaces to
bridge. When using uci the interface names should b e separate d
Table 22: Information table for the create new interface page
Click Submit. The Interface configuration page appears. There are three sections:
Common Configuration Configure the interf ac e se ttings s uc h as proto co l, IP addre s s, g ate w ay, ne tma sk,
13.2.3 Interface overview: common configuration
The common configuration section has four sub sections:
General Setup Configure the basic interface settings such as protocol, I P add r ess , gate w ay,
Advanced Settings 'Bring up on boot', 'Monitor interface state', Override MAC addres s , Overr ide MTU
Web: Protocol
UCI: network.<if name>.proto
Opt: proto
Web: IPv4 address
UCI: network.<if name>.ipaddr
Protocol type. The interface protocol may be one of the options s how n
below. The protocol selected in the previous step w ill be displayed as
default but can be changed if required.
Static Static config ur a tio n with f ixe d addr ess a nd
DHCP Client Address and netmask are assigned by
IPv6-in-IPv4
IPv6-over-
LTE/UMTS/
Used with tunnel brokers.
Stateless IPv6 over IPv4 transport.
CDMA, UMTS or GPRS connection using an
The IPv4 address of the interface. This is optional if an IPv6 address is
provided.
Physical interface to assign the logical interface to. If mapping
multiple interfaces for bridging the inte rf a ce names are separ ated
by a space when using UCI and package options.
Example: option ifname ‘eth2 eth3’ or network.<if
13.2.3.4 Loopback interfaces
Loopback interfaces are defined in exactly the same way as ethernet interfaces. Please
see section above.
Note: There is no software limitation as to how many loopback interfaces can exist on
the router.
13.2.3.5 Common configuration: firewall settings
Use this section to select the firewall zone you want to assign to this interface.
Select unspecified to remove the interface from the associated zone or fill out the
create field to define a new zone and attach the interface to it.
13.2.4 Interface overview: IP-aliases
IP aliasing is associating more than one IP address to a network interface. You can
assign multiple aliases.
To use IP-Aliases, enter a name for the alias and click Add. This name will be assigned
to the alias section for this IP-alias. In this example the name ethalias1 is used.
13: Configuring an Ethernet interface
Figure 39: The IP-Aliases section
UCI: network.<alias name>=ifname
UCI: network.<alias name>.inter f a c e
UCI: network.<alias name>.proto
Table 26: Information table for IP-Aliases name assignment
The IP Aliases configuration options page appears. The IP-Alias is divided into two sub
sections – general setup and advanced.
13.5.1 Configuring port map using the web interface
The new logical Ethernet interface needs to be mapped to a phys ical switch po rt. To
configure the Ethernet switch physical port to logical interface mappings, go to the Port
Map section at Network->Interfaces.
Dynamic Host Configuration Protocol (DHCP) server is responsible for assigning IP
addresses to hosts. IP addresses can be given out on different interfaces and different
subnets. You can manual ly configure lease time as well as setting static IP to host
mappings.
Domain Name Server (DNS) is responsible for resolution of IP addresses to domain
names on the internet.
Dnsmasq is the application which controls DHCP and DNS services. Dnsmasq has two
sections; one to specify general DHCP and DNS settings and one or more DHCP pools to
define DHCP operation on the desired network interface.
14.1 Configuration package use d
dhcp
14.2 Configuring DH CP and DNS using the web interface
In the top menu, select Network -> DHCP and DNS. The DHCP and DNS page
appears. There are three sections: Server Settings, Active Leases, and Static Leases.