All rights reserved. Passing on and copying of this
document, use and communication of its contents
not permitted without written authorization from Alcatel.
Welcome to the Alcatel SpeedTouch350i Command Line Interface Reference Guide !
This Reference Guide aims to give the fastidious user a concise, practical and easy to use document
for configuring the SpeedTouch350i via its character based Command Line Interface.
Although the SpeedTouch350i Web interface is adequate enough for most users, access via the
CLI may be still important for advanced and detailed configuration and troubleshooting.
This CLI Reference Guide covers the CLI commands of the following Alcatel DSL SpeedTouch
product:
Alcatel SpeedTouch350i
The Reference Guide consists of three main parts:
Part 1 : CLI Navigation
This part is meant to make the user familiar with the use and operation of the
SpeedTouch350i CLI. Next to describing the various access methods to the CLI, this part will
describe in brief some general manipulations to navigate through and to perform some
operations on the CLI.
Part 2 : CLI Command Description
This part forms the main part of this Reference Guide. Here all available CLI commands of the
SpeedTouch350i products are alphabetically described per group selection.
Each command is described in a systematic manner:
The full name of the CLI command (including the group selection)
A short description of the CLI command, if needed completed by a description of the
possible impact on the user and/or the SpeedTouch350i
The syntax of the command with a description of each parameter
An example to demonstrate the use of the CLI command
A list of related CLI commands.
Part 3 : CLI Command Index
This part allows the user to look up a command alphabetically in its incomplete form.
3EC 16982 AGAA TCZZA Ed. 01
5 / 138
Preface
Trademarks
The following trademarks are used in this document:
Speed Touch is a trademark of the Alcatel Company
Netscape and Netscape Navigator are registered trademarks of Netscape
Communications Corporation
Windows and Internet Explorer are trademarks of Microsoft Corporation
Apple and MacOS are registered trademarks of Apple Computer Inc.
UNIX is a registered trademark of UNIX System Laboratories, Inc.
Ethernet is a trademark of Xerox Corporation.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Updates
Due to the continuous evolution of the Alcatel DSL technology, existing products are regularly
upgraded. Alcatel documentation changes accordingly.
For more information on the newest technological changes and documents, please consult the
Alcatel web site at following URL:
http://www.alcatel.com
http://www.alcateldsl.com
Directive
Unless expressly and unambiguously approved by Alcatel, you may not:
disassemble, decompile, reverse engineer, trace or otherwise analyze the equipment, its
content, operation, or functionality, or otherwise attempt to derive source code (or the
underlying ideas, algorithms, structure or organization) from the equipment or from any
other information provided by Alcatel, except to the extent that this restriction is expressly
prohibited by local law;
copy, rent, loan, resell, sublicense, or otherwise transfer or distribute the equipment to
others;
modify, adapt or create a derivative work of the equipment;
remove from any copies of the equipment any product identification, copyright or other
notices;
disseminate performance information or analysis (including, without limitation,
benchmarks) from any source relating to the equipment.
Such acts not expressly approved by Alcatel will result in the loss of product warranty and will
invalidate the user's authority to operate this equipment.
6 / 138
3EC 16982 AGAA TCZZA Ed. 01
Alcatel
SpeedTouch350i
CLI Navigation
3EC 16982 AGAA TCZZA Ed. 01
7 / 138
8 / 138
3EC 16982 AGAA TCZZA Ed. 01
Accessing the Command Line Interface
Endusers can access the Command Line Interface via a Telnet session. However, this requires that
TCP/IP connectivity exists between the host from which the Telnet session is opened and the
SpeedTouch350i.
Access via a Telnet Session
As soon a session to the CLI is opened, the SpeedTouch350i banner pops up, followed by the
CLI prompt.
In case the SpeedTouch350i is protected by a System password authentication will be required
before access is granted.
The following figure shows an example of the SpeedTouch350i banner after opening a Telnet
session and authentication.
Manipulation commands are commands that manipulate operations on the command line, for
example changing the command group, go to the beginning of the command line, go to the end of
the command line, etc.
Command group Navigation
From top level, you can change to a command group by executing the name of the desired
command group.
To obtain a list of all available command groups, execute help from the top level.
EXAMPLE:
=>help
Following command groups are available :
configsystemsoftwareipphonebook
pptpbridgeatmftddns
dhcp
=>
To return to top level, execute exit.
EXAMPLE:
=>phonebook
[phonebook]=>
[phonebook]=>exit
=>
10 / 138
3EC 16982 AGAA TCZZA Ed. 01
The Help Command
Execute help from top level to list all available command groups for the SpeedTouch350i.
EXAMPLE
=>help
Following command groups are available :
configsystemsoftwareipphonebook
pptpbridgeatmftddns
dhcp
=>
(SpeedTouchPro):
You can execute the help command from each command group selection. This results in a list of
the available commands (and nested command groups, if available) in this particular command
group.
EXAMPLE:
=>phonebook
[phonebook]=>
[phonebook]=>help
Following commands are available :
listadddeletesaveflush
loadautolisthelpexit
[phonebook]=>
Executing e.g. help phonebook from top level gives the same result as executing help from the
phonebook command group selection.
EXAMPLE:
=>phonebook help
Following commands are available :
listadddeletesaveflush
loadautolisthelpexit
=>
3EC 16982 AGAA TCZZA Ed. 01
11 / 138
Entering help followed by a specific command, e.g. help phonebook add (starting from top level)
or help add (e.g. on the phonebook command group selection) results in a description of the
syntax for the command.
The CLI features command completion, which means that when starting to enter a command it can
be completed by pressing the Tab" key.
For example, entering a at the firewall command group selection, followed by a Tab" stroke
results in the full assign command being completed. Entering firewall a from top level gives the
same result.
For the completion to be successful, the part to be added must be unique. Completion works for the
command groups, for the commands, for the options, but not for values.
Go to the beginning of the Command Line by pressing "Ctrl+A"; to go to the end of the
Command Line press "Ctrl+E".
In the following example, the first
indicates the position of the cursor after pressing "Ctrl+A", the
second the position of the cursor after pressing "Ctrl+E".
EXAMPLE:
=>list
Breaking off Commands
12 / 138
3EC 16982 AGAA TCZZA Ed. 01
You can break off a command by pressing Ctrl+G". This can be useful in a situation where a user
is prompted to enter a value which it does not know and wants to abort the command. Instead of
being prompted over and over again for the same value, this allows to break of the command.
In the example below Ctrl+G" is pressed after the third prompt `name =`. The command is
broken of and the user returns to the command line.
EXAMPLE:
[phonebook]=>add
name =
name =
name =
[phonebook]=>
Ctrl+G"
History of Commands
To retake previous commands press the up arrow and come back to more recent commands
with the down arrow . Press Enter (
All CLI commands are commands that operate on, or configure, the SpeedTouch350i.
You can execute these commands from top level, preceded by the name of the command group
from which the command should be executed (e. g. phonebook list).
You can also execute the commands from the command group itself, using the reduced form of the
command (e.g. list at the phonebooke command group selection).
EXAMPLE:
=>phonebook autolist
8.35
8.36
=>phonebook
[phonebook]=>autolist
8.35
8.36
[firewall]=>
Instead of entering a completely builtup command with all its parameters, you can also enter just
the command itself, without its parameters. After this you are prompted to complete the command
with the required and the optional parameters. For the optional parameters you can simply press
enter without giving a value.
The example below is the equivalent of `phonebook add name=Test addr=8*33 type=pptp`.
To break of such incomplete command press Ctrl+G".
EXAMPLE:
=>phonebook add
name=Test
addr=8*33
type=pptp
=>
3EC 16982 AGAA TCZZA Ed. 01
15 / 138
Direct FTP Access
The SpeedTouch350i File System
The SpeedTouch350i permanent storage, further referred to as 'file system', exists of nonvolatile
memory responsible for storing, retrieving and maintaining the SpeedTouch350i software
image(s) and configuration files.
The file system of the SpeedTouch350i is accessible via the FTP transport protocol. This allows to
transfer the SpeedTouch350i software image(s) and/or configuration profile files.
Moreover, via FTP's quote site command you can execute CLI commands from the FTP prompt.
Proceed as indicated in the exmaple below to open an FTP session to the SpeedTouch350i file
system:
EXAMPLE:
/home/doejohn{1}$ftp 10.0.0.138
Connected to 10.0.0.138
220 Inactivity timer = 120 seconds. Use ’site idle <secs>’ to change.
Name (10.0.0.138:doejohn):
331 SpeedTouch (00-90-D0-01-02-03) User ’doejohn’ OK. Password required.
Password : ######
330 OK
ftp>
SpeedTouch350i File System Structure
The files system features a tiny multilevel directory structure with a single root node called 'root' and
two leaf nodes called 'active' and 'dl'.
The 'root' contains next to the two subdirectories 'active' and 'dl' all necessary files for the
SpeedTouch350i to boot correctly.
The 'active' subdirectory always contains the software image in execution. The 'active' subdirectory
may also contain one or more .ini configuration files. These files are created seperately via the CLI
save command (per command group) or as a complete set of configuration files via the web page
'Save all' button or the CLI :config save command.
In other words, after each 'Save all', or config save call, the configuration files present in the 'active'
subdirectory reflect the current configuration of the SpeedTouch350i.
The 'dl' directory contains the dormant software image, if present.
16 / 138
3EC 16982 AGAA TCZZA Ed. 01
SpeedTouch350i File System Access Rights
Following access rights apply on the file system:
'root' Directory
Listing of 'root' directory files (dir)
'active' Subdirectory
Listing of 'active' subdirectory files (dir)
FTP (m)get of (multiple) 'active' subdirectory files
'dl' Subdirectory
Listing of 'dl' subdirectory files (dir)
FTP (m)get of (multiple) 'dl' subdirectory files
FTP (m)put of (multiple) 'dl' subdirectory files
FTP (m)delete of (multiple) 'dl' subdirectory files..
FTP File Transfer
To allow correct file transfers the transfer mode must be set to binary". Moreover, it is suggested to
turn on the hashing option to be able to see how the file transfer proceeds:
EXAMPLE:
/home/doejohn{1}$ftp 10.0.0.138
Connected to 10.0.0.138
220 Inactivity timer = 120 seconds. Use ’site idle <secs>’ to change.
Name (10.0.0.138:doejohn):
331 SpeedTouch (00-90-D0-01-02-03) User ’doejohn’ OK. Password required.
Password : ######
330 OK
ftp>
ftp>bin
200 TYPE is now 8-bit binary
ftp>
ftp>hash
200Hash mark printing on (8192 byts/hash mark).
ftp>
Customization, Backup and Restore of Configuration Files
For more information on the possibilities of the Alcatel SpeedTouch350i, configuration files and
file system, please check the Alcatel support pages at:
http://www.alcatel.com
http://www.alcateldsl.com
Or contact your local Alcatel Sales representative.
bridge flushFlush complete bridge configuration.
bridge saveSave current bridge configuration.
24 / 138
3EC 16982 AGAA TCZZA Ed. 01
1 Bridge Commands
bridge macadd
Add a static MAC address to the filtering database. Allows to manually add static addresses, which
should normally be dynamically discovered by the bridge itself.
SYNTAX:
bridge macaddport = <name>
hwaddr = <hardwareaddress>
intfThe name of the bridge interface to add the MAC address for.REQUIRED