Based on the very latest ADSL2+, WiFi and 3G HSPA+ technology, Virtual Access
GW6600 Series routers address the needs of today’ s businesses for managed resilient
broadband connectivity. Point of Sale (POS), retail branch office, security monitor ing and
other key business applications demand managed co nnectivity that is cost-effective, high
performance and resilient to network outage or last mile circuit failure.
Designed for managed network providers, GW6600 Series routers provide secure WAN
connectivity for internet and private networking environments over both ADSL2+ and 3G
broadband paths and incorporate optional 802.11n WiFi connectivity.
1.1 Document scope
This document covers the following GW6600 Series models.
1: Introduction
Model ADSL2+ ETH WiFi 3G/HSPA+ 4G/LTE CDMA
Model VDSL&
Eth WiFi 3G
1.2 Using this documentation
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, se lect Service ->
SNMP.’ followed by a screen grab.
HSPA
4G
LTE
450
CDMA
450
Dual
SIM
Dual
SIM
V.92
Modem
V92
Modem
Analog
Leased
ALL ISDN
ISDN
BRI
BRI
After the screen grab there is an information table that describes each of the screen’s
fields.
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.
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 def ault value is shown in a grey cell.
Values for enabling and disabling a feature are var ied 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 defined 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.
1: Introduction
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.
However the documenta t io n usually assumes that a section label is not configured.
The following table shows fields from a variety of chapters to illustrate the explanations
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 Command Line Interface’.
The GW6600 Series and GW6600V Series routers have four SMA connectors for
connection of up to four antennas for antenna diversity. Antenna diversity helps improve
the quality of a wireless link by mitigating problems associated with multipath
interference.
2.9 Components
To enable and configure connections on your router, it must be correctly installed.
The GW6600 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 connecte d and that your PC has the
correct networking setup.
All GW6600 Series routers come with the following components as standard:
1 x GW6600 Series route r (mo dels vary)
2: GW6600 Series hardware
1 x Ethernet cable RJ45 to RJ45 (yellow).
1 x ADSL cable: RJ11 to RJ11 (purple)
1 x 12V power supply unit (2 parts).
Table 2: GW6600 Series router standard components
Optional components include:
1 x V.90 cable: RJ45 to RJ11 (blue)
(IE/EU customers only)
1 x V.90 cable: RJ45 to 431A BT cable
(UK customers only)
1 x ISDN cable: RJ45 to RJ45 (yellow)
1 x lockable SIM cover.
1 x 3G antenna
1 x WiFi antenna
Extra antennas Virtual Access supplies a wide range of antennas for 3G and
WiFi. Please visit our website: www.virtualaccess.com
contact Virtual Access for more information.
Plug the power cable into an electrical socket suitable for the power supply.
The GW6600 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.16 Reset button
The reset button is used to request a system reset.
When you press the reset button all LEDs turn on simultaneously. The length of time you
hold the reset button will determine its behaviour.
Between 2 and 15 seconds The router resets to factory configur ation.
2: GW6600 Series hardware
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.
You can use recovery mode to manipulate the config files, b ut should only be used if all
other configs files are corrupt. If your router has entered recovery mod e, con t a ct your
local reseller for access information.
Note: LED descriptions apply to all GW6600 Series and GW660 0V Series models.
3.2 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 3: Ethernet LED activity
3: GW6600 Series LED behaviour
Link LED
(green)
Speed LED
(amber)
Off No physical Ethernet link detected.
Flashing Data is being transmitted or received over the link
Off Link operating at 1Gbps
4 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 factory 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 flas h 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 LE D 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 4: 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.
5.3 Accessing the router over Ethernet using 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.
5: Accessing the router
Figure 5: Confirming trust of the routers public key over SSH
Figure 6: SSH CLI logon screen
In the SSH CLI logon screen, enter the default username and password.
Username: root
Password: admin
5.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 router’s SCP server.
No dedicated SPC client is supported; select the SCP client software of you r own ch oice.
Local database is only
checked if TACACS server is
not reachable.
UCI:
system.@pam_auth[0].pammodule.auth
Opt: pammodule
system.@pam_auth[0].type=tacplus
Opt: type
UCI: system.@pam_auth[0].serve r s
Opt: servers
UCI:
system.@pam_auth[1].args=service=ppp
Opt: args
5.11 SSH
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.
Selects which TACACS module this part of configur ation relates
to.
auth auth module provides the actual
authentication and sets credentials
account account module checks to make sure
session session module performs additional
tasks which are needed to allow
access
Specifies the authentication metho d.
Specifies the TACACS servers along with port number and
password. The examp le below explains the syntax .
192.168.0.1:49|secret '
Additional arguments to pass to TACACS serer.
Table7: Information table for TACACS auth entication
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.
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.
Range Configured interface names.
Web: Port
UCI: dropbear.@dropbear[0].Port
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.
5: Accessing the router
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 -> Administration.
The Administration page appears. Scroll down to the Certs & Private Keys section.
Figure 9: 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 SS H Keys
section, for SSH public key authentication.
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.
5: Accessing the router
5.14.1 Configuration packages used
uhttpd
To configure the router’s HTTP server parameters, in the top menu, select Services -> HTTP Server. The HTTP Server page has two sections.
Main Settings Server configurations
Certificate Settings SSL certificates.
Web: Listen Address and Port
UCI: uhttpd.main.listen_http
Opt: list listen_http
Web: Secure Listen Address and Port
UCI: uhttpd.main.listen_https
Opt: list listen_https
Web: Home path
UCI: uhttpd.main.home
Opt: home
Web: Cert file
UCI: uhttpd.main.cert
Opt: cert
Web: Key file
UCI: uhttpd.main.key
Opt: key
Figure 11: HTTP server settings
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
interfaces
Range IP address a n d/or port
Specifies the ports and address to listen on for encrypte d HTTPS
access. The format is the same as listen_http.
0.0.0.0:443 Bind at port 443 only
Defines the server document root.
/www
Range
ASN.1/DER certificate used to serve HTTPS connections. If no
listen_https options are given the key options are ignored.
/etc/uhttpd.crt
ASN.1/DER private key used to serve HTTPS connections . If no
listen_https options are given the key options are ignored.
Web: Script timeout
UCI: uhttpd.main.script_time out
Opt: script_timeout
Web: Network timeout
UCI: uhttpd.main.network_ timeo ut
Opt: network_timeout
Defines the prefix for CGI scripts, relative to the document root.
CGI support is disabled if this option is miss ing.
Range
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.
/luci
Specifies the lua handler script used to initia lis e the lua runtime
on server start.
Range
Sets the maximum wait time for CGI or lua requests in seconds.
Requested executables are terminated if no output w as
generated.
60
Maximum wait time for network activity. Requeste d exec utable s
are terminated and connection is shut down if no networ k activity
occured for the specified number of seconds.
To configure HTTPs server certificate settings, in the top menu, select Services ->
HTTP Server. Scroll down to the Certificate Settings section.
Figure 12: HTTP server certificate settings
5: Accessing the router
Web: Days
UCI: uhttpd.px5g.days
Opt: days
Web: Bits
UCI: uhttpd.px5g.bits
Opt: bits
Web: Country
UCI: uhttpd.px5g.country
Opt: country
Web: State
UCI: uhttpd.px5g.state
Opt: state
Web: Location
UCI: uhttpd.px5g.location
Opt: location
Web: Commonname
UCI: uhttpd.commonname
Opt: commonname
Table 11: Information table for HTTP server certificate settings
Validity time of the generated certifica te s in days.
730
Range
Size of the generated RSA key in bits.
1024
ISO code of the certificate issuer.
State of the certificate issuer.
Location or city of the certificate user.
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.
6: Configuring Dynamic DNS
6.2 Configuration packages used
6.3 Configuring Dynamic DNS using the web interface
In the top menu, select Services -> Dynamic DNS. The Dynamic DNS Configuration
page appears.
Figure 13: 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
Web: Force-time unit
UCI: ddns.<name>.force_unit
Opt: force_unit
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.
Defines the time unit to use for check for an IP change. Used in
conjunction with force_interval.
Web: Listen on
UCI: ddns.<name>.interface
Opt: interface
Table 12: Information table for dynamic DNS settings
6.4Dynamic DNS us ing UCI
Dynamic DNS uses the ddns package /etc/config/ddns
6.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
ddns.ddns1.domain=fqdn_of_interface
ddns.ddns1.username=testusername
ddns.ddns1.password=testpassword
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.
7.1 Configuration package used
system
7: System settings
7.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 14: Information table for the logging section
7.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
7.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 16: 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.
7.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’
7.4 System diagnostics
7.4.1 System events
Events in the system have a class, sub class and severity. All events are written to the
system log.
7.4.1.1 Logread
To view the system log, use:
7: 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.
7.4.2 System events in flash
Since logread is only small in size it can be beneficial to write system events to flash. To
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
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.
8: Upgrading router firmware
Figure 20: 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.
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 /tm p
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:
get GIG-15.00.38.image
Note: this is an example, substitute the correct file name.
When the image has downloaded, to leave TFPT and get back into the co m m a nd line,
enter:
8: Upgrading router firmware
quit
To write the image into the alternative image, enter:
mtd write GIG-15.00.38.image altimage
Note: this is an example, substitute the correct file name.
To set the next image to boot to the alternative image, enter:
vacmd set next image altimage
For your configuration changes to apply, you must reboot your router. Enter:
This section describes the file structure and location of essential directories and files on
Virtual Access routers.
Throughout this document, we use information tables to show the different ways to
configure the router using the router’s web and command line (CLI).
When showing examples of the command line interface we use the host name
‘VA_router’ to indicate the system prompt. For example, the table below displays what
the user should see when entering the command to show the current configura tion in
use on the router:
root@VA_router:~# va_config.sh
9.1 System information
General information about software and configuration used by the router is displaye d on
the Status page. To view the running configuration file status on the web interface, in
the top menu, select Status -> Overview. This page also appears immediately after
you have logged in.
9: Router file structure
Figure 24: The status page
System information is also available from the CLI if you enter the following command:
Two firmware images are supported to enable the system to rollback to a previous
firmware version if the upgrade of one image fails.
9: Router file structure
The image names (image1, image2) themselves are symbols that point to different
partitions in the overall file system. A spe cial image name “altimage” exists which always
points to the image that is not running.
The firmware upgrade system always downloads firmware to “altimage”.
9.3 Directory locations for UCI configuration files
Router configurations files are stored in folders on:
• /etc/factconf,
• /etc/config1, and
• /etc/config2
Multiple configuration files exist in e ach folder. Each configuration file conta ins
configuration parameters for different areas of functionality in the system.
A symbolic link exists at /etc/config, which always points to one of factconf, config1 or
config2 is the active configuration file.
Files that appear to be in /etc/config are actually in /etc /factconf|config1|config2
depending on which configuration is active .
If /etc/config is missing on start-up, for example on first boot, the links and directories
are created with configuration files copied from /rom/etc/config/.
At any given time, only one of the configurations is the active configuration. The UCI
system tool (Unified Configuration Interface) only acts upon the currently active
configuration.
The configuration files consist of sections – or packages - that contain one or more
config statements. These optional statements define actual values.
9: Router file structure
Below is an example of a simple configuration 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.
export [<config>] Exports the configuration in a machine
readable format. It is used internally to
import [<config>] Imports configuration files in UCI sy ntax.
add <config> <section-type> Adds an anonymous section of type-section
type to the given configuration.
add_list <config>.<section>.<option>=<string> Adds the given string to an existing list
show [<config>[.<section>[.<option>]]] Shows the given option, section or
get <config>.<section>[.<option>] Gets the value of the given option or the type
Set <config>.<section>[.<option>]=<value> Sets the v alue of the give n option, o r add s a
delete <config>[.<section[.<option>]] Deletes the given section or option.
Table 1: Common commands, target and their descriptions
9.7.1 Exporting a configuration file using the web interface
The current running configuration file may be exported using the web interface.
In the top menu, select Syste m > Backup/Flash Firmware. The Flash operations
9.8.1 Importing a configuration file using the web interface
You can import a configuration file to the alternate conf iguration segment using the web
interface. This will automatically reboot the ro uter into this configuration file.
In the top menu, select Syste m > Backup/Flash Firmware. The Flash operations
page appears.
9: Router file structure
Figure 26: The flash operations page
Under Backup/Restore, choose Restore Backup: Choose file . Select the appropriate
file and then click Upload archive.
Figure 27: The system – restoring…page
When the ‘waiting for router’ icon disappears, the upgrade is complete, and the login
homepage appears.
This chapter expla ins how to view Virtual Access routers' log files and edit configu ration
files using a Command Line Interface (CLI) and the Unified Configuration Interface (UCI)
system.
10.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:
10: 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
10.2 Using Unified Configuration Interface (UCI)
The system uses Unified Configuration Interface (UCI) for centra l 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.
10: 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
-f <file> use <file> as input instead of stdin
-m when importing, merge data into an existing package
-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>]
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
export [<config>]
import [<config>] Imports configuration files in UCI syntax.
changes [<config>]
add <config> <section-type>
add_list <config>.<section>.<option>=<string> Adds the given string to an existing list option.
show [<config>[.<section>[.<option>]]]
get <config>.<section>[.<option>]
set <config>.<section>[.<option>]=<value>
rename <config>.<section>[.<option>]=<name>
revert <config>[.<section>[.<option>]]
Exports the configuration in a UCI syntax and
does validation.
Lists staged changes to the given configuration
Adds an anonymous section of type section-
Shows the given option, section or
configuration in compressed notation.
Gets the value of the given option or the type
of the given section.
Sets the value of the given option, or add a
new section with the type set to the given
value.
Renames the given option or section to the
Deletes staged changes to the given option,
Table 17: 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.
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.
10.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:
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 use ful when appending new
rules to the end of a list.
root@VA_router:/# uci show va_eventd
va_eventd.main=va_eventd
va_eventd.main.enabled=yes
va_eventd.main.event_queue_file=/tmp/event_buffer
va_eventd.main.event_queue_size=128K
va_eventd.@conn_tester[0]=conn_tester
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.
/etc/config/autoload Boot up Activation behaviour (typically used in factconf)
/etc/config/httpclient Activato r add res ses a nd url s
10: Using the Command Line Interface
Basic
/etc/config/dropbear SSH server options
/etc/config/firewall NAT, packet filter, port forwarding, etc.
/etc/config/network Switch, inte rface, L2TP and route configuration
/etc/config/snmpd SNMPd settings
10.4 Configuration file syntax
The configuration files usually consist of one or more config statements, so-called
sections with one or more option statements defining the actual values.
Below is an example of a simple configuration 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 collect ion in o ur 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 identifier s or values 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 charact er, 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.
11.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 installation. 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.
11: 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.
11.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.
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.
11: Management configuration settings
11.5 Autoload packa g es
11.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.
11.7 HTTP Client: configuring activation us ing 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 module used for
retrieving files from Activator during the activation process.
11.7.1 HTTP Client configuraton packages
11.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 use s por t 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.
You can create different users on the system by defining them in the user management
configuration file. This gives users access to different services.
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
Enables/creates the user.
Specifies the user’s username.
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
Specifies web access permissions for the user. Note:
webuser will only work if linuxuser is set to Enabled .
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.
Web: n/a
UCI: List allowed_pages
Note:
• 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.
ADSL access services typically use the Asynchronous Transfer Mode (ATM) protocol to
provide a low level communications path between the user's access equipment and the
service provider head end. The headend may be a Broadband Access Server (BAS) that
sits, logically, behind the ADSL central office Dig ital Subscriber Line Acc ess Multiplexer
(DSLAM) and is connected using an ATM backbone. ATM is a high-speed switching
technology where data is grouped into cells.
Connection between the user equipment and the BA S is t hen achieved using the Pointto-Point Protocol (PPP) running over the ATM connection path. PPP is a defined industry
standard used widely to allow two devices to communicate across a logical link. It is
extensively deployed by service providers as a mea n s of connecting customer s to
Internet Protocol (IP)-based services, such as the Internet.
The method of running PPP between the user equipment and the BAS may be either
directly over the ATM layer (PPPoA) or over an intermediate Ethernet layer (PPPoE).
12: Configuring an ADSL interface
12.2 ADSL connection options on your router
You can configure two main types of ADSL service on your router:
• ADSL routed PPPoA connection
• ADSL bridged connection
If you select the routed PPP service, you can run the PPP over ATM (PPPoA) or over
Ethernet (PPPOE). The following diagrams illustrate the topology of these co nnections.
Less commonly, you may need to configure a bridged connection over ADSL. In this type
of configuration the router will be receiving Ethernet packets over the ADSL line and can
be configured with an IP address for management.
12.3 Configuration package used
12.4 Creating a new ADSL PPPoA connection
To create a new ADSL PPPoA interface via the web interface, in the top menu, click
Network -> Interfaces. The Interfaces overview page appears.
There are three sections in the Interfaces page.
Interface Ov erview S hows existing interfaces and their status. You can create new, and edit ex is ting
Port Map In this section you can map device ports to Ethernet interf aces . Por ts ar e marked
ATM Bridges ATM bridges expose encapsulated Ether ne t in AAL5 connections as virtual Linux
In the Interface Overview section, click Add new interface. The Create Interface page
appears.
with capital letters starting with 'A'. Typ e in space sepa r a ted port num b er s in the
network interfaces, which can be used in conjunction with DHCP or PPP to dial
Table 23: Information table for PPPoA advanced settings
Presume peer to be dead after given amount of LCP echo failures, use 0
to ignore failures.
Send LCP echo requests at the given interval in seconds, only eff ectiv e in
conjunction with failure threshold .
Close inactive connection after the giv e n amount of seco nds, use 0 to
persist connection.
Lists interfaces that are dependant on this parent inte rface. Dependant
interfaces will go down when parent interf ac e is down and will start or
restart when parent interface starts.
Separate multiple interfaces by a space when using UCI. Example: option dependants ‘PPPADSL MOBILE’
This replaces the following previous options in child interfaces.
12.7 PPPoA: 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.
Figure 35: The PPPoA firewall settings page
Web: Create/Assign firewall zone
UCI: firewall.@zone[2].name
From the top menu select Network -> Interfaces. The Interfa c es Overview page
appears. Scroll down to the bottom of the page until you see the ATM Bridges section.
Click Add.
Use this section to select the firewall zone you want to a ss ign 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.
Click Save & Apply.
12: Configuring an ADSL interface
Figure 41: The interfaces page firewall settings tab
12.10Configuring an ADSL PPPoEoA connection using UCI
The configuration file is stored on : Network file /etc/config/network
To view the configuration file, enter:
12.11 Configuring an ADSL bridge connection with static IP
12.11.1 Bridged connection with static IP: general setup
From the top menu select Network -> Interfaces. The Interfa c es Overview page
appears. Scroll down to the bottom of the page until you see the ATM Bridges section.
Click Add. The ATM Bridges page appears.