Axel Remote Management V2 User Manual
Axel Remote Management
Version 2
Administration Software for
Axel Terminals and Office
Servers
May 2009 - Ref.: AxRM2E-16
The reproduction of this material, in part or whole, is strictly prohibited. For
additional information, please contact:
Z.A. Courtabœuf
14 Avenue du Québec
Bât. K2 - BP 728
91962 Les Ulis cedex - FRANCE
Tel.: 33 1.69.28.27.27
Fax: 33 1.69.28.82.04
Email: info@axel.com
The information in this document is subject to change without notice. AXEL
assumes no responsibility for any errors that may appear in this document.
All trademarks and registered trademarks are the property of their respective
holders.
© - 2005-2009 - AXEL - All Rights Reserved.
WARNING
This documentation describes the Axel administration software. It is assumed
that the reader is familiar with the Axel hardware. For more information please
consult the User's Manuals. (From www.axel.com)
TABLE of CONTENTS
1 - INTRODUCTION ............................................................................................1
2 - INSTALLATION / REMOVAL OF THE SOFTWARE ....................................3
2.1 - PREREQUISITES.....................................................................................4
2.2 - UPGRADING ............................................................................................4
2.3 - INSTALLATION ........................................................................................4
2.4 - REMOVAL ................................................................................................9
3 - LAUNCHING THE SOFTWARE ..................................................................10
3.1 - CHOOSE LANGUAGE ...........................................................................11
3.2 - NAMING THE DATABASE AND SETTING ITS LOCATION ..................12
3.3 - PASSWORD...........................................................................................12
3.4 - IMPORTING TERMINALS FROM AUTO-CONFIGURATION................ 13
3.5 - WARNING MESSAGE............................................................................14
3.6 - THE CONSOLE WINDOW .....................................................................14
4 - MANAGEMENT OF THE DEVICE DATABASE..........................................17
4.1 - THE DATABASE.....................................................................................18
4.1.1 - Opening the Database.....................................................................18
4.1.2 - Saving the Database .......................................................................18
4.1.3 - Import/Export functions....................................................................18
4.2 - MANAGEMENT OF THE DATABASE....................................................19
4.2.1 - The Directories ................................................................................19
4.2.2 - Terminals .........................................................................................19
4.3 - ADDING AND MODIFYING DATABASE ENTRIES ...............................20
4.3.1 - Automatic Detection of New terminals ............................................20
a) Step 1 - Check the Terminal ...............................................................21
b) Step 2 - Set-Up an IP Address............................................................22
c) Step 3 - Set-Up the Terminal ..............................................................23
4.3.2 - Scanning for Terminals....................................................................23
a) Scan via SNMP ...................................................................................24
b) Scan via Range of IP Addresses ........................................................25
c) Scan via IP Addresses contained in a text file ....................................25
d) Adding terminals to the Database.......................................................26
4.3.3 - Adding Terminals Manually .............................................................27
4.3.4 - Modification......................................................................................28
4.4
- IMPORT/EXPORT FUNCTIONS............................................................29
4.4.1 - Exporting the Database...................................................................29
4.4.2 - Importing "AxRM V2" Database ...................................................... 30
a) Step 1 - Selecting Import File .............................................................30
b) Step 2 - Parsing the file ......................................................................30
c) Step 3 - Importing Devices.................................................................. 31
4.4.3 - Importing "AxRM V1" Database ...................................................... 31
4.4.4 - Importing Devices Discovered with Auto-Configuration..................32
5 - TERMINAL ADMINISTRATION...................................................................33
5.1 - SELECTION OF ONE OR MORE TERMINALS .....................................34
5.2 - EXECUTION OF ADMINISTRATION COMMANDS............................... 36
5.2.1 - Get Terminal Information................................................................. 37
5.2.2 - Terminal Statistics ...........................................................................40
5.2.3 - Get Terminal Configuration ............................................................. 42
5.2.4 - Rebooting the terminal .................................................................... 43
5.2.5 - Configuring the Terminal ................................................................. 44
5.2.6 - Downloading Firmware.................................................................... 46
5.3 - REMOTE ACCESS TO A TERMINAL ....................................................47
5.3.1 - Remote Control ...............................................................................48
5.3.2 - Interactive Set-Up............................................................................ 50
a) Via the Telnet Protocol (AX3000 and AX4000) ..................................50
b) Via a COM Port (AX4000 only)...........................................................51
6 - AUTO-CONFIGURATION............................................................................ 52
6.1 - AUTO-CONFIGURATION SET-UP........................................................ 54
6.1.1 - Use of Groups .................................................................................54
a) Type of model ..................................................................................... 55
b) FK Code.............................................................................................. 55
c) Range of serial numbers..................................................................... 56
d) List of serial numbers.......................................................................... 57
6.1.2 - Priority of the groups ....................................................................... 58
6.1.3 - Manual management of an unknown terminal. ...............................58
6.1.4 - Saving current AxRM settings ......................................................... 59
6.2 - LAUNCHING THE AUTO-CONFIGURATION........................................ 59
6.2.1 - Interactive Mode.............................................................................. 59
a) Unknown terminal ...............................................................................60
b) Downloading firmware ........................................................................ 62
c) Sending a configuration File ...............................................................62
6.2.2 - Service Mode................................................................................... 63
a) Installing the service ...........................................................................63
b) Starting the service .............................................................................64
c) Stopping the service............................................................................65
d) Uninstalling the service ....................................................................... 65
6.3 - OVERVIEW OF ENTIRE PROCESS......................................................66
7 - OTHER FUNCTIONS ...................................................................................67
7.1 - ASSIGNMENT OF AN IP ADDRESS...................................................... 68
7.2 - USING BOOTP TO RELOAD FIRMWARE.............................................70
7.2.1 - Basic Concept .................................................................................70
7.2.2 - Configuring the BOOTP Server.......................................................71
7.2.3 - Launching BOOTP to download firmware.......................................72
7.2.4 - Configuring the BOOTP Server (Advanced) ...................................73
7.3 - AXRM SETTINGS...................................................................................73
7.3.1 - Network Parameters........................................................................74
7.3.2 - General Parameters ........................................................................75
a) Language Selection ............................................................................75
b) Command Options ..............................................................................75
7.3.3 - Default Folder Settings .................................................................... 76
7.3.4 - The Database ..................................................................................77
7.3.5 - Using a password to protect AxRM ................................................. 78
7.3.6 - Remote Access ...............................................................................79
a) Remote Control...................................................................................79
b) Set-up via telnet or COM Port.............................................................79
APPENDIX.........................................................................................................81
A.1 - TCP/IP COMMANDS USED...................................................................82
A.1.1 - Flowchart.........................................................................................82
A.1.2 - RSH-Based Commands.................................................................. 83
A.2 - USING WITH A FIREWALL....................................................................84
A.3 - FORMAT OF THE DATABASE FILE...................................................... 86
A.4 - REGISTRY VARIABLES ........................................................................86
A.5 - TROUBLESHOOTING ........................................................................... 87
A.5.1 - AxRM Terminates After the Splash Screen ....................................87
A.5.2 - AxRM Installation Problem (fraplus1.ocx and btnplus1.ocx) ..........88
- 1 -
INTRODUCTION
Axel Remote Management 1
This chapter introduces the main features of the AxRM software.
The AxRM software allows system administrators to manage and configure
Axel TCP/IP products remotely over a network. The Axel device is selected by
its IP address or network name. (The software can also assign an IP address to
a new terminal that has not had an IP address previously set).
AxRM creates and maintains a database of Axel devices on the network and
lets the administrator perform the following functions:
- Obtain hardware and firmware revision levels,
- Obtain Ethernet and serial line configuration,
- Obtain network and device statistics,
- Obtain set-up configuration,
- Reboot the device,
- Remotely configure the device
- Download firmware,
- Remote access: take the remote control or enter the interactive set-up.
It is also possible:
- To download firmware via BOOTP,
- To set an IP address by using the device’s MAC address.
This document covers:
- Installation / Removal of AxRM,
- Launching the software,
- Management of the device database,
- Terminal administration
- Auto-Configuration function,
- Other functions,
- Appendices.
2 Axel Remote Management
- 2 -
INSTALLATION / REMOVAL
OF THE SOFTWARE
Axel Remote Management 3
This chapter gives details of installation and removal procedures.
2.1 - PREREQUISITES
AxRM is certified for Windows (95, 98, NT, 2000 and XP).
(Certain advanced functions are only supported by Windows NT, 2000 or XP)
It's strongly advised to use a computer supporting 32000 or more colors.
2.2 - UPGRADING
If AxRM V2 is already installed on the Windows machine it is imperative to
remove before loading a newer version. (See chapter 2.4).
Note: AxRM V1 and AxRM V2 can be installed on the same computer.
2.3 - INSTALLATION
To start the installation, double click on the file ‘AxRMsetup.exe’ and follow the
instructions.
4 Axel Remote Management
The first window is a language selection box:
Click on [OK] to continue:
Axel Remote Management 5
To continue the installation click on [Next]. The option to enter a different
location for AxRM is offered:
Click on [Browse] to select a different location. To continue installation, click on
[Next]. The following window shows Start Menu folder where AxRM can be
installed:
6 Axel Remote Management
The default program group is "Axel Tools". Click on [Next] to accept and
continue the installation:
Click on [Next]. The installation summary is displayed:
Axel Remote Management 7
Click on [Install] to start the installation. The installation is completed after the
files have finished copying:
The following programs had been copied onto the installation folder:
- Axel Remote Management
- Axel Viewer
- Uninstall Axel Remote Management
In the event of difficulties: Depending on the configuration and the version of
Windows, it may be necessary to install extra DLL files. These can be found at
http://www.axel.com. The DLL files should be copied into the system folder.
(%SystemRoot%).
8 Axel Remote Management
2.4 - REMOVAL
IMPORTANT: before uninstalling AxRM, stop the background autoconfiguration service. See Chapter 6.2.
To remove AxRM, select "Uninstall Axel Remote Management" in the menu
[Start]-[Programs]-[Axel Tools]-[Axel Remote Management]:
The following Window confirms AxRM has been successfully removed:
Axel Remote Management 9
- 3 -
LAUNCHING THE SOFTWARE
10 Axel Remote Management
This chapter covers AxRM’s setup and startup operation.
Note: To facilitate reading this document will refer to the Axel device (which can
be a terminal or an Office Server) as simply the "terminal"
To launch the administration software, select [START]-[Program Files]-[Axel
tools]-[Axel Remote Management V2].
Before the main program is launched several dialog boxes will require
completing.
3.1 - CHOOSE LANGUAGE
Select the required language as prompted:
Note: the languages available depend on the ‘LNG’ files downloaded with the
AxRM zip package
The language can be changed at a later time (see chapter 7.3.1).
Axel Remote Management 11
3.2 - NAMING THE DATABASE AND SETTING ITS LOCATION
AxRM maintains a database of the Axel terminals. This database is presented
in the form of tree structure.
The database is given a user selected name or the default ‘Axel Network’ will
be used:
Note: the name of the database can be changed at a later date (see Chapter
4.2.1).
3.3 - PASSWORD
If the access to the AxRM is restricted the following dialog box is shown (see
chapter 7.3.5):
12 Axel Remote Management
Enter the password to continue.
3.4 - IMPORTING TERMINALS FROM AUTO-CONFIGURATION
The Auto-Configuration function allows terminal updates to be automatically
processed. (See Chapter 6)
This function may be independently run from AxRM. ("Service Mode”, see
Chapter 6.2.2)
Each time AxRM is run new devices recorded by the Auto-Configuration service
are checked. If new terminal descriptions are found, or the terminal descriptors
have changed, the following dialog box is displayed:
Select terminals to be added to the database.
Note: the terminal database may also be updated later. (See Chapter 4.4.4)
Axel Remote Management 13
3.5 - WARNING MESSAGE
AxRM can be configured to 'listen' for DHCP requests sent by existing and
virgin Axel terminals. If a DHCP server is already running on the Windows
machine the following message is displayed:
To resolve this conflict disable the third party DHCP/BOOTP server or modify
the AxRM settings. (See Chapter 7.3.1)
3.6 - THE CONSOLE WINDOW
The ‘Console Window’ is made up of the following:
- A horizontal menu providing manipulation of the database and certain
terminal functions.
- A 12 button toolbar (short-cuts to the functions in the menus mentioned
above)
- A panel (on the left) representing the tree structure of the network
- A panel (on the right) allowing individual, multiple or groups of terminals
to be selected for access.
- A status bar (below the right panel) displaying miscellaneous information.
14 Axel Remote Management
Example:
Actions possible on the tree structure:
- Left click: selects one or more elements of the tree structure
- Right click: shows a "contextual menu" (commands available for
execution...)
- Double-click from the left panel: editing the device characteristics.
- Double-click from the right panel: depending on the device:
- Terminal with an IP address: run the 'Get Terminal Information'
command.
- Other: editing the device characteristics.
For more information see chapters 4.2 (management of the database) and 5.1
(selection of terminals).
The terminal list of the right panel can be sorted out by clicking the header of a
column.
Axel Remote Management 15
☺: depending on whether a terminal or folder is selected different information
is displayed:
- A folder: terminal type (AX3000 and AX4000) is displayed.
- A single terminal (see screen shot): the location in the tree structure is
displayed. The blue arrow (on the left) allows this terminal to be retrieved
in the tree structure.
When the 'Archive Terminal Set-Ups' function is enabled (see Chapter 7.3.4),
an information bubble is displayed when the mouse moves over the terminal
list. This bubble gives a summary of the terminal configuration (if available)
The 'Display' Menu allows:
- The toolbar to be hidden.
- Some columns to the right panel to be hidden.
- Set-up bubbles to be hidden.
- Status bar to be hidden.
16 Axel Remote Management
- 4 -
MANAGEMENT OF THE DEVICE
DATABASE
Axel Remote Management 17
This chapter describes the creation and the handling of the database.
The terminal database is presented in the form of tree structure. This
presentation makes it possible to logically sort the terminals into groups and to
easily locate any terminal or group of terminals on which an action is to be
performed.
4.1 - THE DATABASE
The database is kept in one file (text format) called
"%systemroot%\AxRM2.axd" by default. The name can be modified (see
Chapter 7.3.4).
4.1.1 - Opening the Database
The database is automatically opened during the launching of the software. It is
possible during use to force re-reading of the database by selecting the
command [File]-[Read Database].
4.1.2 - Saving the Database
On exiting AxRM the user is prompted to save changes. At any point during the
operation of AxRM changes can be saved by selecting the following: [File]-
[Save Database].
4.1.3 - Import/Export functions
Some Import/Export functions are also available. See Chapter 4.4.
18 Axel Remote Management
4.2 - MANAGEMENT OF THE DATABASE
The terminal database can be logically organized by adding directories and
sub-directories to contain terminals.
4.2.1 - The Directories
The creation of a directory is carried out by the horizontal menu [Action]-[Add
folder], by the contextual menu or by the toolbar.
Below is the Icon and corresponding dialog box:
icon
Simply enter the name of the directory, which is then created in the current
database directory. The contextual menu (right click) lets a directory be created
or deleted. A directory (and its contents) can be moved by drag and drop.
Note: the root of the tree structure is regarded as a directory. It can be renamed
but not deleted or moved.
4.2.2 - Terminals
A terminal is an element in the database tree structure. The following icons
represent the following devices.
: AX3000 Terminal
: Newly detected Terminal without IP address (See Chapter 4.3.1)
: AX4000 Office Server
: Unknown IP device (PC, printer, etc)
-
AxRM recognises terminals and Office Servers by their Ethernet MAC address.
If the Ethernet address is not shown or is unknown, the device is represented
by the icon '?' and no further action is possible.
For more information on adding and editing entries see the following chapter.
Axel Remote Management 19
It is possible to move a terminal by dragging and dropping or using the
contextual menu (click right) to delete or rename.
Note: devices with conflicting addresses are highlighted with an exclamation
mark:
: AX3000 Terminal
: AX4000 Office Server
: unknown device.
-
4.3 - ADDING AND MODIFYING DATABASE ENTRIES
A terminal can be added manually or automatically.
4.3.1 - Automatic Detection of New terminals
AxRM can automatically detect new terminals (by default new terminals send
out DHCP requests which AxRM will detect and analyse).
Notes:
- AxRM doesn't act as a DHCP server. It only 'sees' DHCP requests sent
by Axel terminal and will not issue IP addresses.
- This feature can be disabled. (See Chapter 7.3.1)
Detected terminals are added to the AxRM database. (See red terminal icon Chapter 4.2.2). No commands can be performed on such terminals until they
are given an IP address. (See below.) The only information collected is the
MAC address and the terminal’s DNS name.
A new terminal can be entirely configured from AxRM. Double-click the new
terminal icon or click the icon on the toolbar or select the option [Edit this
Device] (from the [action] horizontal menu or from the contextual menu).
20 Axel Remote Management
Here is the icon and dialog box:
icon
a) Step 1 - Check the Terminal
At this stage AxRM has received a DCHP request, but does not know if the
DHCP request is from a new virgin terminal or an existing terminal that is
configured to use DHCP.
Axel Remote Management 21
This step checks to see if the terminal already has an IP address (obtained
either from a DHCP server or has previously been assigned a static IP address
but is not yet recorded in AxRM's database - in both these cases it is assumed
the terminal is not new):
This check may be done by:
- Resolving the terminal’s name (DNS server must be available but works
over a WAN)
- And/or by sending an SNMP request (only works on a LAN).
If the above check indicates the terminal is ‘new’ and has no IP address the
'step 2' is enabled. If the terminal is found to have an IP address the terminal
can be setup (step 3).
b) Step 2 - Set-Up an IP Address
Enter the IP address to assign and click on [Set IP Address].
The IP address is set by sending ping requests to the terminal (this works only
in a LAN).
When the IP address is set, Step 3 is enabled.
22 Axel Remote Management
c) Step 3 - Set-Up the Terminal
This step is optional: the terminal may be configured by the usual AxRM
administration commands.
The terminal can be configured by:
- Downloading a firmware. (See Chapter 5.2.6)
- Sending an existing configuration file. (See Chapter 5.2.5)
- Entering the interactive set-up. (See Chapter 5.3.2 - a)
4.3.2 - Scanning for Terminals
The automatic scan adds all terminals found on the network to the database
The function is invoked from the horizontal menu [Action]-[Discover
Terminals] or from the toolbar.
Axel Remote Management 23
Loading...