User manual ALCATEL-LUCENT SPEDDTOUCH DSL ROUTERS - 2

SPEED TOUCH CLI Reference Guide DSL Routers 3EC 16982 AAAA TCZZA Ed. 04 Status Change Note Released BD F aa 34022 Short Title CD-UG STCLI All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel. 2 / 300 3EC 16982 AAAA TCZZA Ed. 04 Contents Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 ADSL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ATMF Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bridge Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CIP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Config Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DHCP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DNS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Firewall Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MER Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NAT Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phonebook Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PPP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PPTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QoSBook Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SHDSL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wireless Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ................................................................ 5 19 21 29 45 55 61 99 121 147 169 181 197 207 225 235 243 249 255 263 267 273 297 Index 3EC 16982 AAAA TCZZA Ed. 04 3 / 300 Contents 4 / 300 3EC 16982 AAAA TCZZA Ed. 04 Preface Preface Welcome to the Alcatel Speed Toucht 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 Toucht via its character based Command Line Interface. Although the Speed Toucht 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 Speed Toucht 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 Toucht 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 Toucht products are alphabetically described per group selection. Each command is described in a systematic manner: D D D D D 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 Toucht 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: D D D D D D Speed TouchTM is a trademark of the Alcatel Company Netscape® and Netscape Navigator® are registered trademarks of Netscape Communications Corporation WindowsTM and Internet ExplorerTM are trademarks of Microsoft Corporation Apple® and Mac®OS are registered trademarks of Apple Computer Inc. UNIX® is a registered trademark of UNIX System Laboratories, Inc. EthernetTM 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: D disassemble, de compile, 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, 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. D D D D 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 TouchTM 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 Toucht " The serial 'Console' interface This requires a Speed Toucht product which is equipped with a 'Console' port on its back panel. As soon a session to the CLI is opened, the Speed Toucht banner pops up, followed by the CLI prompt. In case of a Telnet session authentication via the Speed Toucht System Password might be required before access is granted. The following figure shows an example of the Speed Toucht 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 DSL ROUTER * _____/__ / \\ * _/ /\_____/___ \ * // /\ /\ \ * _______//_______/ \ / _\/______ Copyright 1999­2001. * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­ => 3EC 16982 AAAA TCZZA Ed. 04 9 / 300 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: =>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 bridge pptp ppp qosbook phonebook ip config firewall =>atmf [atmf]=> atmf cip software mer nat system To return to top level, or to descend one level (in case of nested command groups) execute .. or exit (depending on the Speed Toucht 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 Toucht. 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 bridge pptp ppp qosbook phonebook ip config firewall => atmf cip software mer nat system The available command groups depend on the particular Speed TouchTM the CLI session is opened to, e.g. the wireless command group is only present for the SpeedTouchTM570 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 = The vci = The => Virtual Path Identifier. Virtual Channel Identifier. Use 0 for a VP crossconnect. Command Completion For some Speed Toucht 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 ø 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 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 ()" to select and execute the retaken command. EXAMPLE: =>atmf [atmf]=>list VPI = 0 VCI VPI = 1 VCI VPI = 2 VCI VPI = 3 VCI VPI = 4 VCI VPI = 5 VCI VPI = 6 VCI VPI = 7 VCI [atmf]=> ° =>:list = = = = = = = = 0 0 0 0 0 0 0 0 3EC 16982 AAAA TCZZA Ed. 04 13 / 300 Command Line Interface Top Level Structure Depending on the Speed Toucht product the following command groups are available: " " " " " " " " " SpeedToucht520Series) " " " " " " " adsl (only applicable for SpeedToucht ADSL variants) atmf (only applicable for SpeedToucht models equipped with an ATMF 25.6Mbps port) bridge cip (only applicable for SpeedToucht DSL routers) config dhcp dns env (only applicable for SpeedToucht510Series) firewall (only applicable for SpeedTouchtPro with Firewall and ip mer (only applicable for SpeedTouchtPro with Firewall and SpeedToucht520Series) nat (only applicable for Speed Toucht DSL routers) phonebook ppp (only applicable for Speed Toucht DSL routers) pptp qosbook (only applicable for SpeedTouchtPro with Firewall and SpeedToucht520Series) " " " " " " shdsl (only applicable for SpeedToucht SHDSL variants) software system td voice (only applicable for the SpeedToucht700/710/720) wireless (only applicable for the SpeedToucht570) 14 / 300 3EC 16982 AAAA TCZZA Ed. 04 Command Line Interface Commands All CLI commands are commands that operate on, or configure, the Speed Toucht 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. EXAMPLE: =>atmf list VPI = 0 VCI VPI = 1 VCI VPI = 2 VCI VPI = 3 VCI VPI = 4 VCI VPI = 5 VCI VPI = 6 VCI VPI = 7 VCI =>atmf [atmf]=>list VPI = 0 VCI VPI = 1 VCI VPI = 2 VCI VPI = 3 VCI VPI = 4 VCI VPI = 5 VCI VPI = 6 VCI VPI = 7 VCI [atmf]=> = = = = = = = = 0 0 0 0 0 0 0 0 = = = = = = = = 0 0 0 0 0 0 0 0 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 `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 TouchTM CLI Command Description 3EC 16982 AAAA TCZZA Ed. 04 17 / 300 18 / 300 3EC 16982 AAAA TCZZA Ed. 04 1 ADSL Commands 1 ADSL Commands adsl (to access the ADSL level) adsl info 3EC 16982 AAAA TCZZA Ed. 04 19 / 300 1 ADSL Commands adsl info Show ADSL statistics and information about the SpeedToucht status. SYNTAX: adsl info EXAMPLE: =>adsl info Modemstate Operation Mode Channel Mode Number of resets Vendor (ITU) Country Vendor VendorSpecific StandardRevisionNr : : : : up G.DMT Annex A fast 1 [ POTS Overlay Mode ] : : : : Local 0f ALCB 0000 01 Downstream 31 26 Cells 2641 301 Remote 0f ALCB 0000 01 Upstream 31 13 Kbits 1014 115 Margin Attenuation [dB] [dB] : : Available Bandwidth Downstream Upstream : : Transfer statistics Total since power On Downstream : Upstream : Current Connection Downstream : Upstream : Errors Received FEC : Received CRC : Received HEC : => Cells 185670 10254 185668 N/Avail 0 0 0 Kbits 71297 3937 71296 N/Avail 20 / 300 3EC 16982 AAAA TCZZA Ed. 04