User manual ALCATEL-LUCENT SPEEDTOUCH 610 - 1

SPEEDTOUCH 610 CLI Reference Guide Business DSL Routers 3EC 16982 ACAA TCZZA Edition 01 Status Change Note Released BD F aa 39813 Short Title CD-RG ST610 R4.1 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 / 384 3EC 16982 ACAA TCZZA Edition 01 Contents Contents About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 ADSL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ATM Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ATMF Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bridge Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CIP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Config Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DHCP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DNS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Env Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Eth Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Firewall Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GRP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPoA Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPSec Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MER Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NAT Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phonebook Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PPP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PPTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QoSBook Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SHDSL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SNMP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SNTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 27 31 37 47 61 69 75 109 129 137 141 161 179 199 207 261 269 281 287 305 311 317 323 331 337 3EC 16982 ACAA TCZZA Edition 01 3 / 384 Contents 26 27 28 Syslog Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syslog Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Key Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 353 363 367 371 375 379 Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Appendix A Appendix B Index ................................................................ 4 / 384 3EC 16982 ACAA TCZZA Edition 01 About this Document About this Document Welcome to the SpeedToucht610 Command Line Interface (CLI) Reference Guide ! For the Service Provider this Reference Guide aims to give a concise and practical document for creating a customized configuration profile file, based on the SpeedToucht610 CLI command set, to be used by the end user to configure the SpeedToucht610 and PC(s). For the fastidious user this Reference Guide aims to give a handbook for advanced and detailed configuration and troubleshooting of the SpeedToucht610 via its character based Command Line Interface. This CLI Reference Guide covers the CLI commands of the following Alcatel DSL Speed Touch products: " " " " Alcatel SpeedToucht610 Alcatel SpeedToucht610i Alcatel SpeedToucht610s Alcatel SpeedToucht610v 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 SpeedToucht610 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 the SpeedToucht610 are alphabetically described per command group. 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 SpeedToucht610 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 ACAA TCZZA Edition 01 5 / 384 About this Document " Trademarks The following trademarks are used in this document: D D D D D D SpeedTouchTM is a trademark of THOMSON multimedia 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.speedtouch.com " Directive Unless expressly and unambiguously approved by THOMSON multimedia, 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 THOMSON multimedia, 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 THOMSON multimedia will result in the loss of product warranty and will invalidate the user's authority to operate this equipment. 6 / 384 3EC 16982 ACAA TCZZA Edition 01 SpeedTouchTM610 CLI Navigation 3EC 16982 ACAA TCZZA Edition 01 7 / 384 8 / 384 3EC 16982 ACAA TCZZA Edition 01 Accessing the Command Line Interface Users can access the Command Line Interface via: " The SpeedToucht610 CLI web pages This requires that TCP/IP connectivity exists between the host from which the web browser is opened and the SpeedToucht610 " A Telnet session This requires that TCP/IP connectivity exists between the host from which the Telnet session is opened and the SpeedToucht610 " The serial 'Console' interface. Access via the Web Pages The SpeedToucht610 CLI is accessible via its web interface. Browse to the SpeedToucht610 web pages and click Advanced - CLI in the left frame. As a result the CLI web menu is opened: 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 click Apply to execute the command. . After you configured all 3EC 16982 ACAA TCZZA Edition 01 9 / 384 Access via a Telnet Session or Serial Console As soon a session to the CLI is opened, the SpeedToucht610 banner pops up, followed by the CLI prompt. In case the SpeedToucht610 is protected by a System password, authentication will be required before access is granted. The following figure shows an example of the SpeedToucht610 banner after opening a session and authentication. EXAMPLE: /home/doejohn{1}$ telnet 10.0.0.138 Trying 10.0.0.138... Connected to 10.0.0.138. Username : Password : ###### ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­ * * ______ SpeedTouch 610 * ___/_____/\ * / /\\ Version R4.1.1.0 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999­2002, * // /\ /\ \ THOMSON multimedia * _______//_______/ \ / _\/______ * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­ => 10 / 384 3EC 16982 ACAA TCZZA Edition 01 Basic 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 menu : Displays menu ? : Displays this help information exit : Exits this shell. .. : Exits group selection. Following command groups are available : adsl config firewall mer qosbook syslog => atm dhcp grp nat shdsl system atmf dns ip phonebook snmp td bridge env ipoa ppp sntp vdsl cip eth ipsec pptp software The example above shows every possible CLI command group. However: " ipsec is only available on SpeedToucht610 routers with the IPSEC_VPN software key enabled " atmf is only available on SpeedToucht610 variants equipped with an ATMF 25.6Mb/s port " eth is only available on SpeedToucht610 variants equipped with a single Ethernet port " adsl is only available for the SpeedToucht610 ADSL/POTS and SpeedToucht610i ADSL/ISDN variants " shdsl is only available for the SpeedToucht610s SHDSL variant " vdsl is only available for the SpeedToucht610v VDSL variant. To return to top level, or to descend one level (in case of nested command groups) execute .. . EXAMPLE: =>phonebook [phonebook]=> [phonebook]=>.. => 3EC 16982 ACAA TCZZA Edition 01 11 / 384 The Help Command Execute help or ? from top level to list all available command groups for the SpeedToucht610. EXAMPLE: =>help Following commands are available : help : Displays this help information menu : Displays menu ? : Displays this help information exit : Exits this shell. .. : Exits group selection. Following command groups are available : adsl dhcp grp nat snmp system => atmstats dns ip phonebook sntp td bridge env ipoa ppp software cip eth ipsec pptp stream config firewall mer qosbook syslog You can execute the help or ? 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]=>? 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 As both help and ? have the exact same functionality in the SpeedToucht610 CLI, the help command may always be equally replaced by the ? command. 12 / 384 3EC 16982 ACAA TCZZA Edition 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 (executed from the 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. => Executing help all will generate the complete listing of all available CLI commands with syntax description. 3EC 16982 ACAA TCZZA Edition 01 13 / 384 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 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. For example, pressing a and TAB at the firewall command group selection results in the full assign command being completed. Entering firewall a and pressing the TAB key from top level gives the same result. EXAMPLE: =>firewall [firewall]=>"a+TAB" [firewall]=>assign Going to the beginning or end of the Command Line Go to the beginning of the current Command Line by pressing CTRL+A; to go to the end of the current Command Line press CTRL+E. 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 chain =. The command is broken of and the user returns to the command line prompt. EXAMPLE: [firewall]=>match chain = chain = chain = CTRL+G" [firewall]=> 14 / 384 3EC 16982 ACAA TCZZA Edition 01 History of Commands To retake previous commands press the UP ARROW key and come back to more recent commands with the DOWN ARROW key. 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]=> UP ARROW [firewall]=>:firewall list 3EC 16982 ACAA TCZZA Edition 01 15 / 384 Command Line Interface Top Level Structure The following command groups are always available: " " " " " " " " " " " " " " " " " " " " " " " atm bridge cip config dhcp dns env firewall grp ip ipoa mer nat phonebook ppp pptp qosbook snmp sntp software syslog system td 16 / 384 3EC 16982 ACAA TCZZA Edition 01 Following command groups are optional: " adsl (only applicable for the SpeedToucht610 ADSL/POTS and SpeedToucht610i atmf (only applicable for models equipped with an ATMF 25.6Mb/s port) eth (only applicable for models equipped with a single 10/100Base T Ethernet port) ipsec (only applicable in case a valid IPSec software key is activated) shdsl (only applicable for the SpeedToucht610s SHDSL variant) vdsl (only applicable for the SpeedToucht610v VDSL variant) ADSL/ISDN variants) " " " " " 3EC 16982 ACAA TCZZA Edition 01 17 / 384 Command Line Interface Commands All CLI commands are commands that operate on, or configure, the SpeedToucht610 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. 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 => 18 / 384 3EC 16982 ACAA TCZZA Edition 01 Menu driven CLI Navigation To improve the user friendliness of the SpeedToucht610 CLI, the CLI features a menu driven interface. To enter the menu driven interface, simply execute menu from the CLI prompt: EXAMPLE: The semi graphical CLI offers you an attractive and easy to use configuration environment for the CLI. You can browse through the CLI command groups via the ARROW keys. Pressing ENTER executes your selection. From each level you can execute '..' to go one level up. Use the TAB key to change from the CLI command menu to the control menu and vice versa. To setup a CLI command, simply press ENTER on its name. You can configure and overview its various parameters at one time. In case the parameter provides preset values, you can go through these via the ARROW keys.. If you are satisfied, use the TAB key to go to the OK field and press ENTER. Note: Do not forget to save your changes by executing saveall (from any CLI prompt). 3EC 16982 ACAA TCZZA Edition 01 19 / 384 Configuration Profile Files and the CLI Configuration Profile Files The configuration profile files, used by the Setup wizard, or directly uploaded via the SpeedToucht610 web pages, consist of a set of CLI commands. Only CLI commands, which are part of the SpeedToucht610 CLI command set may be used in the .ini and .def files. For readability, configuration profile files are partitioned in paragraphs. These paragraphs reflect a CLI command group selection in the SpeedToucht610 CLI. However, due to internal processing, not all paragraph names are the same as their corresponding CLI command group selection. In the following overview the relationship between the available SpeedTouchTM610 CLI commands and the [.ini] paragraphs is given: " " " " " " " " " " " " " " [env.ini] Commands present in the env CLI command group. [snmp.ini] Commands present in the snmp CLI command group. [phone.ini] Commands present in the phonebook CLI command group. [qos.ini] Commands present in the qosbook CLI command group. [oam.ini] Commands present in the atm oam CLI command subgroup. [atmf.ini] Commands present in the atmf CLI command group. [bridge.ini] Commands present in the bridge CLI command group. [mer.ini] Commands present in the mer CLI command group. [pptp.ini] Commands present in the pptp CLI command group. [ppp.ini] Commands present in the ppp CLI command group. [ipoa.ini] vommands present in the cip CLI command group. [cip.ini] Commands present in the cip CLI command group. [nat.ini] Commands present in the nat CLI command group. [pfilter.ini] Commands present in the firewall chain CLI command subgroup and present in the firewall rule CLI command subgroup. 20 / 384 3EC 16982 ACAA TCZZA Edition 01