Alcatel-Lucent SPEDDTOUCH HOME User Manual 1

SPEED TOUCH
Home/Pro
CLI Reference Guide
ADSL Router Series
3EC 16982 AAAA TCZZA Ed. 05
Status
2 / 198
Change Note
Short Title
BD F aa 39813
CD-RG STHome/Pro CLI
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel.
3EC 16982 AAAA TCZZA Ed. 05
Contents
Preface 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 ADSL Commands 21. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2 ATMF Commands 25. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3 Bridge Commands 33. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4 CIP Commands 45. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5 Config Commands 55. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6 DHCP Commands 61. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7 DNS Commands 83. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8 IP Commands 105. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
9 NAT Commands 125. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10 Phonebook Commands 141. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11 PPP Commands 149. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12 PPTP Commands 165. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13 Software Commands 173. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14 System Commands 179. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15 TD Commands 187. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Index 193. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3EC 16982 AAAA TCZZA Ed. 05
3 / 198
Contents
4 / 198
3EC 16982 AAAA TCZZA Ed. 05
Preface
Preface
Welcome to the Alcatel SpeedTouchHome/Pro 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 SpeedTouchHome/Pro via its character based Command Line Interface.
Although the SpeedTouchHome/Pro 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 products:
Alcatel SpeedTouchHome
Alcatel SpeedTouchHome ISDN
Alcatel SpeedTouchPro
Alcatel SpeedTouchPro ISDN
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 SpeedTouchHome/Pro 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 SpeedTouchHome/Pro 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 SpeedTouchHome/Pro
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. 05
5 / 198
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, decompile, 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, resell, 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 / 198
3EC 16982 AAAA TCZZA Ed. 05
Alcatel
SpeedTouchHome/Pro
CLI Navigation
3EC 16982 AAAA TCZZA Ed. 05
7 / 198
8 / 198
3EC 16982 AAAA TCZZA Ed. 05
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 SpeedTouchHome/Pro
The serial 'Console' interface, if equipped.
Access via a Telnet Session or Serial Console
As soon a session to the CLI is opened, the SpeedTouchHome/Pro banner pops up, followed by the CLI prompt.
In case of a Telnet session authentication via the System password might be required before access is granted.
The following figure shows an example of the SpeedTouchHome/Pro banner after opening a Telnet session and authentication.
EXAMPLE:
/home/doejohn{1}$ telnet 10.0.0.138 Trying 10.0.0.138... Connected to 10.0.0.138. Escape character is ’^]’. User : SpeedTouch (00–90–D0–00–01–23–45) Password : ###### ––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– * * ______ * ___/_____/\ * / /\\ Alcatel Speed Touch * _____/__ / \\ ADSL Modem/Router * _/ /\_____/___ \ Version R3.2 * // / \ /\ \ * _______//_______/ \ / _\/____ Copyright (c) 1999–2001 Alcatel * / / \ \ / / / /\ * __/ / \ \ / / / / _\__ * / / / \_______\/ / / / / /\ * /_/______/___________________/ /________/ /___/ \ * \ \ \ ___________ \ \ \ \ \ / * \_\ \ / /\ \ \ \ \___\/ * \ \/ / \ \ \ \ / * \_____/ / \ \ \________\/ * /__________/ \ \ / * \ _____ \ /_____\/ * \ / /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * ––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– =>
3EC 16982 AAAA TCZZA Ed. 05
9 / 198
Navigation and Manipulation
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 (SpeedTouchHome):
=>help
Following command groups are available : config system software ip phonebook adsl pptp bridge atmf td dns dhcp
=>
EXAMPLE (SpeedTouchPro):
=>help
Following command groups are available : config system software ip phonebook adsl nat cip ppp pptp bridge atmf td dns dhcp
=>
To return to top level, execute exit.
EXAMPLE:
=>phonebook [phonebook]=> [phonebook]=>exit =>
10 / 198
3EC 16982 AAAA TCZZA Ed. 05
The Help Command
Execute help from top level to list all available command groups for the SpeedTouchHome/Pro.
EXAMPLE
=>help
Following command groups are available : config system software ip phonebook adsl nat cip ppp pptp bridge atmf td dns dhcp dhcp dns td atmf mer
=>
(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 : list add delete save flush load autolist help exit
[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 : list add delete save flush load autolist help exit
=>
3EC 16982 AAAA TCZZA Ed. 05
11 / 198
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.
EXAMPLE:
=>help phonebook add
add : Adds a phonebook entry
name=<string> addr=<vp*vc> type=<bridge|ppp|cip|pptp>
=>
Command Completion
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.
EXAMPLE:
=>phonebook [phonebook]=>d “Tab“ [phonebook]=>delete
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
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 / 198
3EC 16982 AAAA TCZZA Ed. 05
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 (
EXAMPLE:
=>phonebook [phonebook]=>list Name address type usage Br1 8*35 bridge configured Br2 8*36 bridge free Br3 8*37 bridge free Br4 8*38 bridge free RELAY_PPP1 8*48 pptp configured RELAY_PPP2 8*49 pptp configured RELAY_PPP3 8*50 pptp configured RELAY_PPP4 8*51 pptp configured PPP1 8*64 ppp configured PPP2 8*65 ppp configured PPP3 8*66 ppp free DHCP_SPOOF 8*67 ppp configured CIPPVC1 8*80 cip configured CIPPVC1 8*81 cip free CIPPVC3 8*82 cip free CIPPVC4 8*83 cip free
↵)" to select and execute the retaken command.
[phonebook]=> [phonebook]=>:phonebook list
3EC 16982 AAAA TCZZA Ed. 05
 
13 / 198
Command Line Interface Top Level Structure
The following command groups are available:
adsl (only applicable for the SpeedTouchHome/Pro ADSL/POTS variants) atmf (only applicable for models equipped with an ATMF25.6Mbps port) bridge cip (only applicable for the SpeedTouchPro) config dhcp dns ip nat (only applicable for the SpeedTouchPro) phonebook ppp (only applicable for the SpeedTouchPro) pptp software system td
14 / 198
3EC 16982 AAAA TCZZA Ed. 05
Command Line Interface Commands
All CLI commands are commands that operate on, or configure, the SpeedTouchHome/Pro.
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 builtup 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 AAAA TCZZA Ed. 05
15 / 198
Direct FTP Access
The SpeedTouchHome/Pro File System
The SpeedTouchHome/Pro permanent storage, further referred to as 'file system', exists of
nonvolatile memory responsible for storing, retrieving and maintaining the
SpeedTouchHome/Pro software image(s) and configuration files. The file system of the SpeedTouchHome/Pro is accessible via the FTP transport protocol. This
allows to transfer the SpeedTouchHome/Pro 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 SpeedTouchHome/Pro
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>
SpeedTouchHome/Pro 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
SpeedTouchHome/Pro 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 SpeedTouchHome/Pro.
The 'dl' directory contains the dormant software image, if present.
16 / 198
3EC 16982 AAAA TCZZA Ed. 05
SpeedTouchHome/Pro 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, Backup and Restore of Configuration Files
For more information on the possibilities of the Alcatel SpeedTouchHome/Pro, 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.
3EC 16982 AAAA TCZZA Ed. 05
17 / 198
18 / 198
3EC 16982 AAAA TCZZA Ed. 05
Alcatel
SpeedTouchHome/Pro
CLI Command Description
3EC 16982 AAAA TCZZA Ed. 05
19 / 198
20 / 198
3EC 16982 AAAA TCZZA Ed. 05
1 ADSL Commands
1 ADSL Commands
The adsl command group is only applicable to the SpeedTouchHome/Pro ADSL/POTS variants, NOT to the SpeedTouchHome ISDN and SpeedTouchPro ISDN ADSL/ISDN variants.
adsl (to access the ADSL level) adsl config adsl load adsl save
3EC 16982 AAAA TCZZA Ed. 05
21 / 198
1 ADSL Commands
adsl config
Show/set the ADSL/POTS configuration.
SYNTAX:
adsl config [opermode = <ansi|g.dmt_annex_a|g.lite|multimode>]
[maxbitspertoneUS = <number{1014}>]
[opermode] The operational mode of the SpeedTouchHome/Pro modem.
Choose between:
ansi g.dmt_annex_a g.lite multimode
By default the ADSL modem will start in multimode.
maxbitspertoneUS A number between 10 and 14 (bits per tone).
Represents the maximum number of bits whic hcan be allocated to each ADSL DMT tone in the upstream direction. By default the modem will use up to 13 bits per tone.
EXAMPLE:
=>adsl config ADSL configuration:
opermode = multimode maxbitspertoneUS = 13
=>
RELATED COMMANDS:
adsl load Load saved or default ADSL configuration. adsl save Save current ADSL interface configuration.
OPTIONAL
OPTIONAL
22 / 198
3EC 16982 AAAA TCZZA Ed. 05
adsl load
Load saved or default ADSL configuration.
SYNTAX:
adsl load [{saved|defaults}]
adsl load Load saved ADSL configuration.
adsl load saved Load saved ADSL configuration.
adsl load defaults Load default ADSL configuration.
1 ADSL Commands
3EC 16982 AAAA TCZZA Ed. 05
23 / 198
1 ADSL Commands
adsl save
Save current ADSL configuration.
SYNTAX:
adsl save
24 / 198
3EC 16982 AAAA TCZZA Ed. 05
2 ATMF Commands
2 ATMF Commands
The atmf command group is only applicable to the SpeedTouchHome/Pro ADSL/POTS variants equipped with an ATMF25.6Mbps port.
atmf (to access the ATMF level) atmf add atmf config atmf delete atmf flush atmf list atmf load atmf save
3EC 16982 AAAA TCZZA Ed. 05
25 / 198
2 ATMF Commands
atmf add
Add a crossconnection between the ATMF25 interface and the WAN interface.
SYNTAX:
atmf add vpi = <number {07}>
vci = <number {0511}>
vpi A number between 0 and 7.
Represents the Virtual Path identifier.
vci A number between 0 and 511.
Represents the Virtual Channel identifier. Use VCI=0 for a VP crossconnection.
EXAMPLE:
=>atmf list Current ATM-Forum cross-connections: VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0
=>atmf add vpi=0 vci=35
=>atmf list Current ATM-Forum cross-connections: VPI = 0 VCI = 35 VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0 =>
REQUIRED
REQUIRED
RELATED COMMANDS:
atmf delete Delete a crossconnection on the ATMF25 interface. atmf list Show current ATMF25 interface configuration.
26 / 198
3EC 16982 AAAA TCZZA Ed. 05
atmf config
Show/set the ATMF25 interface configuration.
SYNTAX:
atmf config [status = <line|on>]
2 ATMF Commands
maxbitspertoneUS Let the SpeedTouchHome/Pro assume that the physical link of the
ATMF connection is always enabled (on) or allow to check the pysical link. By default the ATMF25 pysical link status will be assumed always to be enabled (on), in which case the SpeedTouchHome/Pro will not (never) be the source of F4/F5 AIS OAM cells.
EXAMPLE:
=>atmf config ATM-Forum state = ON =>
OPTIONAL
3EC 16982 AAAA TCZZA Ed. 05
27 / 198
2 ATMF Commands
atmf delete
Delete a crossconnection on the ATMF25 interface.
SYNTAX:
atmf delete vpi = <number {07}>
vci = <number {0511}>
vpi A number between 0 and 7.
Represents the Virtual Path identifier.
vci A number between 0 and 511.
Represents the Virtual Channel identifier. Use VCI=0 for a VP crossconnection.
EXAMPLE:
=>atmf list Current ATM-Forum cross-connections: VPI = 0 VCI = 35 VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0
=>atmf delete vpi=0 vci=35
=>atmf list Current ATM-Forum cross-connections: VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0 =>
REQUIRED
REQUIRED
RELATED COMMANDS:
atmf add Add a crossconnection on the ATMF25 interface. atmf list Show current ATMF25 interface configuration.
28 / 198
3EC 16982 AAAA TCZZA Ed. 05
atmf flush
Flush complete ATMF25 interface configuration. The flush command does not impact previously saved configurations.
SYNTAX:
atmf flush
EXAMPLE:
=>atmf list Current ATM-Forum cross-connections: VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0
=>atmf flush
=>atmf list Current ATM-Forum cross-connections: =>
2 ATMF Commands
RELATED COMMANDS:
atmf load Load saved or default ATMF25 interface configuration. atmf save Save current ATMF25 interface configuration.
3EC 16982 AAAA TCZZA Ed. 05
29 / 198
2 ATMF Commands
atmf list
Show all current ATMF25 interface crossconnections .
SYNTAX:
atmf list
EXAMPLE OUTPUT:
=>atmf list
Current ATM-Forum cross-connections: VPI = 0 VCI = 35 VPI = 1 VCI = 0 VPI = 2 VCI = 0 VPI = 3 VCI = 0 VPI = 4 VCI = 0 VPI = 5 VCI = 0 VPI = 6 VCI = 0 VPI = 7 VCI = 0 =>
RELATED COMMANDS:
atmf add atmf delete
Add an ATMF25 interface crossconnection. Delete a crossconnection on the ATMF25 interface.
30 / 198
3EC 16982 AAAA TCZZA Ed. 05
Loading...
+ 168 hidden pages