AvL Technologies AAQ Maintenance Server Manual instruction

AAQ Maintenance Server
Setup & Operations Guide
Revision R11.9.0
Documentation of the interface between the AAQ Maintenance Server and the
AvL Technologies AAQ antenna controller.
Appendix T
AvL Technologies
900-159-019

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
1
Revision History
Contents
1. Introduction ................................................................................................................................................................................................................................3
2. Software version .......................................................................................................................................................................................................................3
2.1 ROM Version Information...................................................................................................................................................................................................3
2.2 Maintenance Server Version Information ...................................................................................................................................................................4
3. Overview.......................................................................................................................................................................................................................................4
4. Commands....................................................................................................................................................................................................................................7
4.1. Networking Information ............................................................................................................................................................................................7
4.2 Networking Configuration .......................................................................................................................................................................................7
4.3 Backup Management ...................................................................................................................................................................................................8
4.4 Miscellaneous Commands .........................................................................................................................................................................................8
5. Software Update Package......................................................................................................................................................................................................9
6. File Transfer Protocol (FTP) Server .................................................................................................................................................................................9
7. Software Update Procedure .............................................................................................................................................................................................. 11
7.1 Using Windows Explorer ................................................................................................................................................................................................. 11
7.2 Using the AAQ GUI............................................................................................................................................................................................................... 13
7.3 Using Other FTP (FileZilla).............................................................................................................................................................................................. 14
7.4 Using Other FTP (WinSCP).............................................................................................................................................................................................. 17
7.5 Format for Splitting the Software Update File........................................................................................................................................................ 19
8. Applying Restore Point Procedure................................................................................................................................................................................. 19
9. Issues and Troubleshooting .............................................................................................................................................................................................. 20
Date
Revision
Revision
By
Approved
By
Revision Description
05/04/16
R11.6.0
WL
Initial Release for 11.6
11/07/16
R11.8.0
VAD
MF
Updated for Current Functionality, added
approved by in revision history
05/01/17
R11.9.0
WL/AY
JF
Updates for version 11.9, Added more
ways to upload software updates

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
2
Figures
Figure 1 –ROM Version Information .........................................................................................................................................................................................3
Figure 2 –AAQ Maintenance Server Version Information ...............................................................................................................................................4
Figure 3 –Maintenance Server > Help (List of Commands) ............................................................................................................................................5
Figure 4 –Maintenance Server > Help (List of Commands) Cont. ................................................................................................................................6
Figure 5 - Update_Log.log Example Entry................................................................................................................................................................................9
Figure 6 - Restore Point Transitions ....................................................................................................................................................................................... 10
Figure 7 - Windows Explorer FTP Access ............................................................................................................................................................................. 11
Figure 8 - Windows Explorer...................................................................................................................................................................................................... 12
Figure 9 - Searching for Antenna Software in Windows Explorer............................................................................................................................. 12
Figure 10 –Upload *.sup File in Windows Explorer ........................................................................................................................................................ 13
Figure 11 - Upload/Download in AAQ GUI ........................................................................................................................................................................... 13
Figure 12 - AAQ GUI Pop up Message ..................................................................................................................................................................................... 14
Figure 13 - New Site FileZilla...................................................................................................................................................................................................... 14
Figure 14 - Login FileZilla ............................................................................................................................................................................................................ 15
Figure 15 - FileZilla Password.................................................................................................................................................................................................... 15
Figure 16 - Software Update Using FileZilla ........................................................................................................................................................................ 16
Figure 17 - Start New Session in WinSCP.............................................................................................................................................................................. 17
Figure 18 - Login Credentials ..................................................................................................................................................................................................... 17
Figure 19 - File Transfer WinSCP.............................................................................................................................................................................................. 18

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
3
1. Introduction
This document describes the concepts required to use the AvL Maintenance Server and the procedure
required to perform a software update for the AvL AAQ Controller. The AvL Maintenance Server allows telnet
and FTP access to the controller for uploading new software, changing IP addresses, and creating restore
points. It is beneficial to use the AvL Maintenance Server because it allows system changes to be applied
remotely across a customer network. Thus, the user has the ability to make changes to multiple antennas at
once. This document also provides a detailed discussion of the associated command items that are accessible
through File Transfer Protocol (FTP) and Telnet sessions to the AvL AAQ Controller.
2. Software version
2.1 ROM Version Information
Version Info
Main Window → Help → Version Info.
Level 0
Verify that the “AAQ.rom” line item is at or above the version shown below:
Figure 1 –ROM Version Information

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
4
2.2 Maintenance Server Version Information
Using a Telnet client, such as Putty, access the AAQ Maintenance Server to verify that the version is at or above the one
below. For more information on how to access the AAQ Maintenance Server, see section 3.
Figure 2 –AAQ Maintenance Server Version Information
3. Overview
The AAQ Maintenance Server is a separate application that allows Telnet access to the antenna system. The
Maintenance server allows users to access some useful networking commands in order to debug and configure
the system. It also watches over the main AAQ process to ensure it continues running and restarts the process
in the event of an error or crash. The server can be accessed through any terminal program that supports
telnet, such as Putty or TeraTerm. The server uses the default telnet port of 23. The Maintenance Server is set to
run whenever the AAQ is powered up.

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
5
The AAQ Maintenance Server includes a software update method through File Transfer Protocol (FTP). The AvL
software update procedure allows for full system updates to be performed by loading an update file or files into
the AvL AAQ Controller, and re-booting the system. This method may be used to update any software
component of the AvL AAQ Controller system. This procedure requires that an appropriate upgrade file has
been provided by AvL, and that the user is familiar with the use of a File Transfer Protocol (FTP) client.
Below is a detailed list of all available commands that can be run on the AAQ Maintenance Server system.
Although many of these commands share names with Linux system commands, they do not currently allow extra
flags or parameters unless specifically mentioned in this list. Command parameters are denoted by “<>”.
Figure 3 –Maintenance Server > Help (List of Commands)

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
6
Figure 4 –Maintenance Server > Help (List of Commands) Cont.

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
7
4. Commands
4.1. Networking Information
These commands do not change any configuration and only provide information to the user.
Command Name
Description
route
Displays the Kernel IP routing table
netstat
Displays network connections, routing tables, interface statistics, masquerade
connections and multicast memberships.
ifconfig
Displays the status of the currently active interfaces.
ping<IP Address>
Sends a set of 4 ping packets from the controller to the requested <IP
Address> and displays the results.
Note –Cannot ping antenna IP in use.
4.2 Networking Configuration
These commands change files or settings on the system, or otherwise alter the system. Most commands will
have a response indicating whether or not the change was successfully applied.
Command Name
Description
setAddr1 <IP Address>
Sets the AAQ customer network 1 IP Address, enter 'clear' instead of an IP
Address to clear this setting
setGateway1 <IP Address>
Sets the AAQ customer network 1 Gateway, enter 'clear' instead of an IP
Address to clear this setting
setSubnet1 <IP Address>
Sets the AAQ customer network 1 Subnet, enter 'clear' instead of an IP
Address to clear this setting
setAddr2 <IP Address>
Sets the AAQ customer network 2 IP Address, enter 'clear' instead of an IP
Address to clear this setting
setGateway2 <IP Address>
Sets the AAQ customer network 2 Gateway, enter 'clear' instead of an IP
Address to clear this setting
setSubnet2 <IP Address>
Sets the AAQ customer network 2 Subnet, enter 'clear' instead of an IP
Address to clear this setting
enableDHCP
Commands the AAQ system to use DHCP to determine its IP address
disableDHCP
Disables the usage of DHCP on the AAQ system

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
8
4.3 Backup Management
These commands allow the user to manage the backups that are stored on the system
Command Name
Description
restoreBackup1
Reverts to the most recent system restore point. Requires a power-
cycle/reboot afterward. This will create a new Restore Point 1, move the old
Restore Point 1 to Restore Point 2, and delete the old Restore Point 2 before
it reverts to the backup.
restoreBackup2
Reverts to the second-most recent system restore point. Requires a power-
cycle/reboot. This will create a new Restore Point 1, move the old Restore
Point 1 to Restore Point 2, and delete the old Restore Point 2 before it reverts
to the backup.
restoreFactory
Reverts to the factory default software. Requires a power-cycle/reboot
afterward. This will create a new Restore Point 1, move the old Restore Point
1 to Restore Point 2, and delete the old Restore Point 2 before it reverts to
the backup.
createRestorePoint
Takes the current set of software on the system and saves it as Restore Point
1. The old Restore Point 1 is moved to restore point 2. The old Restore Point 2
is deleted.
Note: Anytime the system is restored to a backup copy or a software update is performed, a new restore
point is created and saved as Restore Point 1. The previous Restore Point 1 is moved to Restore Point 2. The
previous Restore Point 2 is deleted. If long term storage of a Restore Point is desired, it should be copied
from the controller using a File Transfer Protocol (FTP) client.
4.4 Miscellaneous Commands
These give basic controls over the system
Command Name
Description
help
Displays a list of all commands in the Maintenance Server system, similar to
the list of commands in this document
setTelnetTimeout <integer>
Sets the Telnet session timeout (in seconds). If no messages are received after
this time the session will automatically be closed. Set the timeout to 0 to
disable this feature. The default value is 600 (10 minutes)
version
Displays the build number of this Maintenance Server
reboot
Reboots the AAQ system, this will also close your connection to the system
Note: This is a soft reboot. It is not the same as Power Cycling the antenna
exit
Closes the current Telnet session
enableWatchdog
Enables usage of the AAQ watchdog. The AAQ watchdog automatically
restarts the AAQ software in the event of a crash or error.
disableWatchdog
Disables the AAQ watchdog

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
9
5. Software Update Package
An AvL software update requires that a pre-constructed Software Update Package (extension *.sup) is available
for installation onto the system. This file must be acquired from AvL. A Software Update Package is an
encrypted collection of software and scripts used to apply all required updates to the AvL AAQ Controller
system.
6. File Transfer Protocol (FTP) Server
To facilitate software update actions, the AvL AAQ Controller hosts a File Transfer Protocol (FTP) server on the
standard TCP port 21. This server requires the login credentials detailed in Table 1.
Table 1: FTP Login Credentials
Username:
avlftp
Password:
avlftp
The FTP server supports both active and passive transfer modes, and contains two read only, and one read/write
directory as noted in Table 2.
Table 2: FTP Directory Permissions
Directory Name
Access Level
Logs
Read Only
Restore_Points
Read Only
Software_Updates
Read/Write
The “Logs” directory contains a single log file “Update_Log.log” that summarizes all software update or system
restore activities that have been performed on the controller since it left the factory. It also contains detail logs
for each uniquely named software update package or restore point that has been applied to the controller.
These detail logs will show exactly what was included in the update or restore point. An example of the
Update_Log log is described in Figure 4 and can be used to verify a successful upgrade.
Figure 5 - Update_Log.log Example Entry

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
10
Name
Type
Description
Restore_Points
Directory
May contain up to three separate system restore points,
namely “Factory_Restore.enc,” “Master_Restore_001.enc,” and
“Master_Restore_002.enc” files.
Factory_Restore.enc
File
Contains system settings and software as the antenna left the
factory.
Master_Restore_001.enc
File
Contains system settings and software before*. sup or backup
was applied to the system OR from when the most recent
backup was created. It contains whichever occurred last. See
Figure 6
Master_Restore_002.enc
File
Contains system settings and software prior to the second most
recent software update, restore point creation, or use of
restore point. This is a copy of restore point 1. The old restore
point 2 gets deleted. See Figure 6
Software_Updates
Directory
The only Read/Write directory on the FTP server. It is used to
receive Software Update Package (*.sup) or Restore Point
(*.enc) files. Any properly encoded *.sup or *.enc files may be
uploaded into this directory, and will be applied to the system
upon reboot or power cycle.
Logs
Directory
Contains file “Update_Log.log” that summarizes all software
update or system restore activities that have been performed
on the controller and contains detail logs for each uniquely
named software update package or restore point that has been
applied to the controller.
Figure 6 - Restore Point Transitions

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
11
If the Windows Explorer version being used does not allow for FTP access then an FTP server may be accessed
using a third party client such as FileZilla or WinSCP.
If using Windows Explorer, launch a new Windows Explorer window and enter “ftp://avlftp:avlftp@<Ip Address>”
into the address bar at the top of the window as depicted in Figure 7. The FTP directories may then be used as
typical folders would be used on the local system.
Figure 7 - Windows Explorer FTP Access
7. Software Update Procedure
A software update may be performed with the following steps.
7.1 Using Windows Explorer
Launch a new Windows Explorer window

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
12
Figure 8 - Windows Explorer
Enter “ftp://avlftp:avlftp@<Ip Address>” into the address bar at the top of the window
Figure 9 - Searching for Antenna Software in Windows Explorer
Locate the appropriate *.sup file to load into the system
Copy or drag and drop the *.sup file into the “Software_Updates” Directory

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
13
Figure 10 –Upload *.sup File in Windows Explorer
Re-boot or power cycle the system. The system may take up to 10 minutes to reboot. Do not power off the
system during this time.
Login to the AvL AAQ Controller FTP Server
Read the “Logs\Update_Log.log” document to verify a successful software update
7.2 Using the AAQ GUI
Main Window ->File -> Upload/Download -> Upload SUP
Figure 11 - Upload/Download in AAQ GUI

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
14
Select “Yes” to pop up message.
Figure 12 - AAQ GUI Pop up Message
Locate and select the correct *.sup file to be uploaded.
Power cycle the system. The system may take up to 10 minutes to reboot. Do not power off the system during
this time.
7.3 Using Other FTP (FileZilla)
Open up the FileZilla program.
Login into the AvL AAQ Controller FTP Server
File -> Site Manager -> New Site
Figure 13 - New Site FileZilla

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
15
Login with the following credentials:
Host: <IP Address>
Port: 21
Logon Type: “Ask for password”
User: avlftp
Then select connect.
Figure 14 - Login FileZilla
The user will be prompted to enter the password which is avlftp
Figure 15 - FileZilla Password

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
16
Locate the appropriate *.sup file to load into the system. (Reference Figure 16 below)
Drag and Drop File into Software_Updates Folder. (Reference Figure 16 below)
After upload is complete power cycle the system. The system may take up to 10 minutes to reboot. Do not
power off the system during this time.
Figure 16 - Software Update Using FileZilla

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
17
7.4 Using Other FTP (WinSCP)
Login to the FTP WinSCP Server as shown in Figure 17 and Figure 18 (below)
Select “New” to start a new session in the WinSCP popup window.
Figure 17 - Start New Session in WinSCP
Login credentials:
Host: <IP Address>
Port: 21
File protocol: FTP
User name: avlftp
Password: avlftp
Figure 18 - Login Credentials

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
18
Locate the appropriate *.sup file to load into the system. (Reference Figure 14 below)
Drag and Drop File into Software_Updates Folder. (Reference Figure 14 below)
After upload is complete power cycle the system. The system may take up to 10 minutes to reboot. Do not
power off the system during this time.
Figure 19 - File Transfer WinSCP

AAQ Maintenance Server
AvL Technologies | Proprietary –Content is Subject to Change without Notice
19
7.5 Format for Splitting the Software Update File
If a system has particular bandwidth constraints for transport of software update files, an individual software
update file may be split into multiple files for transport to the AAQ. If the Software Update Package is split, each
file must be named with two additional extensions following the (*.sup) as indicated in Table 3.
Table 3: Split Software Update Package Naming
Filename.sup.003.000
Filename.sup.003.001
Filename.sup.003.002
Filename.sup.003.003
The first of the two extensions is a three number digit code representing the end of the last required filename
(number of files minus one). The second extension is a three digit number code representing the sequential re-
construction order of the parts, beginning with a zero-index. Any split file must abide by this formatting
guideline to be properly processed. These split files are provided by AvL upon request.
8. Applying Restore Point Procedure
Manually applying restore points can be performed with the following steps
Locate the appropriate *.enc file to load into the system
Login into the AvL AAQ Controller FTP Server, as shown in section 7.3 of this document.
a. Username: avlftp
b. Password: avlftp
Upload the *.enc file into the “Software_Updates” Directory
Re-boot or power cycle the system. The system may take up to 10 minutes to reboot. Do not power off
the system during this time.
Login to the AvL AAQ Controller FTP Server
Read the “Logs\Update_Log.log” document to verify a successful software update
Using Maintenance Server to apply restore points can be performed with the following steps If the restore points
were created by the Maintenance Server and have not been removed from the system refer to section 6 of this
document for more detail.
Open the Maintenance Server
restoreBackup1 command will revert to the most recent restore point and reboots the system
restoreBackup2 command will revert to the second most recent restore point and reboots the
system
Table of contents
Other AvL Technologies Controllers manuals