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 Speed Touch 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 Speed Touch via its character based Command Line Interface.
Although the Speed Touch 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 all Alcatel's DSL Speed Touch products.
Therefore it is possible that far more commands are described than available on your SpeedTouch product. Please ignore all CLI commands which are not applicable for your product.
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 Speed Touch
CLI. In brief some general manipulations are described 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 all
Speed Touch 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 Speed Touch
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 AAAA TCZZA Ed. 04
5 / 300
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 analyse 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 / 300
3EC 16982 AAAA TCZZA Ed. 04
Alcatel
Speed Touch
CLI Navigation
3EC 16982 AAAA TCZZA Ed. 04
7 / 300
8 / 300
3EC 16982 AAAA TCZZA Ed. 04
Accessing the Command Line Interface
Users can access the Command Line Interface via:
A Telnet session
This requires that TCP/IP connectivity exists between the host from which the Telnet session is
opened and the Speed Touch
The serial 'Console' interface
This requires a Speed Touch product which is equipped with a 'Console' port on its back
panel.
As soon a session to the CLI is opened, the Speed Touch banner pops up, followed by the CLI
prompt.
In case of a Telnet session authentication via the Speed Touch System Password might be required
before access is granted.
The following figure shows an example of the Speed Touch 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 commands are available :
help : Displays this help information
? : Displays this help information
exit : Exits group selection.
.. : Exits group selection.
Following command groups are available :
dhcp dns td atmf mer
bridge pptp ppp cip nat
qosbook phonebook ip software system
config firewall
=>atmf
[atmf]=>
To return to top level, or to descend one level (in case of nested command groups) execute .. or exit
(depending on the Speed Touch product).
EXAMPLE:
=>atmf
[atmf]=>
[atmf]=>..
=>
10 / 300
3EC 16982 AAAA TCZZA Ed. 04
The Help Command
Execute help from top level to list all available command groups for the Speed Touch.
EXAMPLE:
=>help
Following commands are available :
help : Displays this help information
? : Displays this help information
exit : Exits group selection.
.. : Exits group selection.
Following command groups are available :
dhcp dns td atmf mer
bridge pptp ppp cip nat
qosbook phonebook ip software system
config firewall
=>
The available command groups depend on the particular Speed Touch the CLI session is opened
to, e.g. the wireless command group is only present for the SpeedTouch570 product.
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:
=>atmf
[atmf]=>
[atmf]=>help
Following commands are available :
add : Adds a VP or VC cross–connection between the ATMF interface and the WAN
interface.
delete : Deletes a cross–connection on the ATM–Forum interface.
list : Shows all ATM–Forum interface cross–connections.
save : Saves the ATM–Forum interface cross–connections.
flush : Flushes the ATM–Forum interface cross–connections.
load : Loads ATM–Forum interface cross–connections.
[atmf]=>
3EC 16982 AAAA TCZZA Ed. 04
11 / 300
Executing e.g. help atmf from top level gives the same result as executing help from the atmf
command group selection.
EXAMPLE:
=>help atmf
Following commands are available :
add : Adds a VP or VC cross–connection between the ATMF interface and the WAN
interface.
delete : Deletes a cross–connection on the ATM–Forum interface.
list : Shows all ATM–Forum interface cross–connections.
save : Saves the ATM–Forum interface cross–connections.
flush : Flushes the ATM–Forum interface cross–connections.
load : Loads ATM–Forum interface cross–connections.
=>
Entering help followed by a specific command, e.g. help atmf add (starting from top level) or help
add (e.g. on the atmf command group selection) results in a description of the syntax for the
command.
EXAMPLE:
=>help atmf add
add : Adds a VP or VC cross–connection between the ATMF interface and the WAN
interface.
vpi = <number{0–15}>
The Virtual Path Identifier.
vci = <number{0–511}>
The Virtual Channel Identifier. Use 0 for a VP crossconnect.
=>
Command Completion
For some Speed Touch products 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 atmf command group selection, followed by a Tab" stroke results
in the full add command being completed. Entering atmf 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.
EXAMPLE:
=>atmf
[atmf]=>a “Tab“
[atmf]=>add
12 / 300
3EC 16982 AAAA TCZZA Ed. 04
Going to the beginning or end of the Command Line
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
second
the position of the cursor after pressing "Ctrl+E".
indicates the position of the cursor after pressing "Ctrl+A", the
EXAMPLE:
=>list
Breaking off Commands
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 `vpi =`. The command is broken
of and the user returns to the command line.
EXAMPLE:
[atmf]=>add
vpi =
vpi =
vpi =
Ctrl+G" [atmf]=>
History of Commands
To retake previous commands press the up arrow and come back to more recent commands
with the down arrow . Press Enter (
Depending on the Speed Touch product the following command groups are available:
adsl (only applicable for SpeedTouch ADSL variants)
atmf (only applicable for SpeedTouch models equipped with an ATMF25.6Mbps port)
bridge
cip (only applicable for SpeedTouch DSL routers)
config
dhcp
dns
env (only applicable for SpeedTouch510Series)
firewall (only applicable for SpeedTouchPro with Firewall and
SpeedTouch520Series)
ip
mer (only applicable for SpeedTouchPro with Firewall and SpeedTouch520Series)
nat (only applicable for Speed Touch DSL routers)
phonebook
ppp (only applicable for Speed Touch DSL routers)
pptp
qosbook (only applicable for SpeedTouchPro with Firewall and
SpeedTouch520Series)
shdsl (only applicable for SpeedTouch SHDSL variants)
software
system
td
voice (only applicable for the SpeedTouch700/710/720)
wireless (only applicable for the SpeedTouch570)
14 / 300
3EC 16982 AAAA TCZZA Ed. 04
Command Line Interface Commands
All CLI commands are commands that operate on, or configure, the Speed Touch settings.
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. atmf list).
You can also execute the commands from the command group itself, using the reduced form of the
command (e.g. list at the atmf command group selection).
When executing commands with specification of their parameter values, it is not necessary to use
`=`. E.g. `atmf add vpi 0 vci 35` is equal to `atmf add vpi=0 vci=35`.
`!` in a command means `NOT`, e.g. the `[!]syn` parameter in the firewall rule create command.
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 `atmf add vpi 0 vci 35`. To break of such incomplete
command press Ctrl+G".
EXAMPLE:
=>atmf add
vpi = 0
vci = 35
=>
3EC 16982 AAAA TCZZA Ed. 04
15 / 300
16 / 300
3EC 16982 AAAA TCZZA Ed. 04
Alcatel
Speed Touch
CLI Command Description
3EC 16982 AAAA TCZZA Ed. 04
17 / 300
18 / 300
3EC 16982 AAAA TCZZA Ed. 04
1ADSL Commands
adsl (to access the ADSL level)
adsl info
1 ADSL Commands
3EC 16982 AAAA TCZZA Ed. 04
19 / 300
1 ADSL Commands
adsl info
Show ADSL statistics and information about the SpeedTouch status.
SYNTAX:
adsl info
EXAMPLE:
=>adsl info
Modemstate : up
Operation Mode : G.DMT Annex A [ POTS Overlay Mode ]
Channel Mode : fast
Number of resets : 1
Vendor (ITU) Local Remote
Country : 0f 0f
Vendor : ALCB ALCB
VendorSpecific : 0000 0000
StandardRevisionNr : 01 01
Transfer statistics
Total since power On Cells Kbits
Downstream : 185670 71297
Upstream : 10254 3937
Current Connection
Downstream : 185668 71296
Upstream : N/Avail N/Avail
Errors
Received FEC : 0
Received CRC : 0
Received HEC : 0
=>
20 / 300
3EC 16982 AAAA TCZZA Ed. 04
2ATMF Commands
atmf (to access the ATMF level)
atmf add
atmf delete
atmf flush
atmf list
atmf load
atmf save
2 ATMF Commands
3EC 16982 AAAA TCZZA Ed. 04
21 / 300
2 ATMF Commands
atmf add
Add a crossconnection between the ATMF25 interface and the WAN interface.
SYNTAX:
atmf addvpi = <number {07}>
vci = <number {0511}>
vpiA number between 0 and 7.
Represents the Virtual Path identifier.
vciA number between 0 and 511.
Represents the Virtual Channel identifier.
Use VCI=0 for a VP crossconnection.