User manual ALCATEL-LUCENT SPEEDTOUCH 570 - 1

SPEED TOUCH 570 CLI Reference Guide Wireless ADSL Router 3EC 16982 ADAA TCZZA Ed. 01 Status Change Note Released BD F aa 39813 Short Title CD-RG AST570 CLI All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel. 2 / 268 3EC 16982 ADAA TCZZA Ed. 01 Contents Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 ADSL 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wireless Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ................................................................ 5 21 23 39 49 55 93 115 141 163 173 189 199 217 225 231 239 241 265 Index 3EC 16982 ADAA TCZZA Ed. 01 3 / 268 Contents 4 / 268 3EC 16982 ADAA TCZZA Ed. 01 Preface Preface Welcome to the Alcatel SpeedToucht570 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 SpeedToucht570 via its character based Command Line Interface. Although the SpeedToucht570 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 SpeedToucht570 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 SpeedToucht570 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 SpeedToucht570 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 SpeedToucht570 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 ADAA TCZZA Ed. 01 5 / 268 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 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. 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 / 268 3EC 16982 ADAA TCZZA Ed. 01 Alcatel SpeedTouchTM570 CLI Navigation 3EC 16982 ADAA TCZZA Ed. 01 7 / 268 8 / 268 3EC 16982 ADAA TCZZA Ed. 01 Accessing the Command Line Interface Users can access the Command Line Interface via: " The SpeedToucht570 CLI web pages This requires that TCP/IP connectivity exists between the host from which the web browser is opened and the SpeedToucht570 " A Telnet session This requires that TCP/IP connectivity exists between the host from which the Telnet session is opened and the SpeedToucht570. Access via the Web Pages The SpeedToucht570 CLI is accessible via its web interface. Browse to the SpeedToucht570 web pages and click in the left frame. As a result the CLI web menu is opened in a new browser window: You can open the CLI web pages directly by pointing the browser to the following URL: http://10.0.0.138/cli.htm (in which the 10.0.0.138 IP address should be replaced by the actual SpeedToucht570 IP address if needed). All CLI groups and commands are placed in a menu. You can open a group by clicking the mark next to a group name, or clicking the group name. Clicking on a command name will execute it. Commands without parameters are indicated with and are executed immediately. Commands which require additional parameters are indicated with parameters you must click to execute the command. . After you configured all 3EC 16982 ADAA TCZZA Ed. 01 9 / 268 Access via a Telnet Session As soon a session to the CLI is opened, the SpeedToucht570 banner pops up, followed by the CLI prompt. In case the SpeedToucht570 is protected by a System password authentication will be required before access is granted. The following figure shows an example of the SpeedToucht570 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 570 * _____/__ / \\ Wireless ADSL Router * _/ /\_____/___ \ Version R1.0 * // /\ /\ \ * _______//_______/ \ / _\/____ Copyright (c) 1999­2001 Alcatel * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­ => 10 / 268 3EC 16982 ADAA TCZZA Ed. 01 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 this shell. .. : Exits group selection. Following command groups are available : wireless dhcp dns td bridge pptp ppp cip adsl qosbook phonebook ip system config firewall => mer nat software To return to top level, or to descend one level (in case of nested command groups) execute .. . EXAMPLE: =>phonebook [phonebook]=> [phonebook]=>.. => 3EC 16982 ADAA TCZZA Ed. 01 11 / 268 The Help Command Execute help from top level to list all available command groups for the SpeedToucht570. EXAMPLE: =>help Following commands are available : help : Displays this help information ? : Displays this help information exit : Exits this shell. .. : Exits group selection. Following command groups are available : wireless dhcp dns td bridge pptp ppp cip adsl qosbook phonebook ip system config firewall => mer nat software 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: =>firewall [firewall]=> [firewall]=>help Following commands are available : tron troff match assign list flush : : : : : : Enables verbose console messaging. Disables verbose console messaging. Defines an ip packet match. Assign a chain to an entry point. Shows a list of all the hooks with the chain attached. Clears all hooks. If a hook is provided, that hook is cleared. Following command groups are available : chain [firewall]=> rule 12 / 268 3EC 16982 ADAA TCZZA Ed. 01 Executing e.g. help firewall from top level gives the same result as executing help from the firewall command group selection. EXAMPLE: =>firewall help Following commands are available : tron troff match assign list flush : : : : : : Enables verbose console messaging. Disables verbose console messaging. Defines an ip packet match. Assign a chain to an entry point. Shows a list of all the hooks with the chain attached. Clears all hooks. If a hook is provided, that hook is cleared. Following command groups are available : chain => rule Entering help followed by a specific command, e.g. help firewall assign (starting from top level) or help assign (e.g. on the firewall command group selection) results in a description of the syntax for the command. EXAMPLE: =>help firewall assign Assign a chain to an entry point. Syntax : assign hook = <{input|sink|forward|source|output}> chain = parameters : hook = <{input|sink|forward|source|output}> Name of hook to assign chain to. chain = Name of chain to use. => 3EC 16982 ADAA TCZZA Ed. 01 13 / 268 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: =>firewall [firewall]=>a "Tab" [firewall]=>assign 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: [firewall]=>match chain = chain = chain = Ctrl+G" [firewall]=> 14 / 268 3EC 16982 ADAA TCZZA Ed. 01 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: =>firewall [firewall]=>list assign hook=input chain=input assign hook=sink chain=sink assign hook=forward chain=forward assign hook=source chain=source [firewall]=> ° [firewall]=>:firewall list 3EC 16982 ADAA TCZZA Ed. 01 15 / 268 Command Line Interface Top Level Structure The following command groups are available: " " " " " " " " " " " " " " " " " adsl bridge cip config dhcp dns firewall ip mer nat phonebook ppp pptp software system td wireless 16 / 268 3EC 16982 ADAA TCZZA Ed. 01 Command Line Interface Commands All CLI commands are commands that operate on, or configure, the SpeedToucht570. 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. firewall list). You can also execute the commands from the command group itself, using the reduced form of the command (e.g. list at the firewall command group selection). `!` in a command means `NOT`, e.g. the `[!]syn` parameter in the firewall rule create command. EXAMPLE: =>firewall list assign hook=input assign hook=sink assign hook=forward assign hook=source =>firewall [firewall]=>list assign hook=input assign hook=sink assign hook=forward assign hook=source [firewall]=> chain=input chain=sink chain=forward chain=source chain=input chain=sink chain=forward chain=source 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 `firewall assign hook=input chain=input`. To break of such incomplete command press Ctrl+G". EXAMPLE: =>firewall assign hook = input chain = input => 3EC 16982 ADAA TCZZA Ed. 01 17 / 268 18 / 268 3EC 16982 ADAA TCZZA Ed. 01 Alcatel SpeedTouchTM570 CLI Command Description 3EC 16982 ADAA TCZZA Ed. 01 19 / 268 20 / 268 3EC 16982 ADAA TCZZA Ed. 01