SpeedTouch TM 510(i)/530/570(i) Multi-User ADSL Gateways CLI Reference Guide 500 SERIES SpeedTouch TM 500Series CLI Reference Guide Release R4.0 Status Change Note Short Title Copyright Released PeckelbeenS CLI ST500Series R4.0 © 2003 THOMSON. All rights reserved. Passing on, and copying of this document, use and communication of its contents is not permitted without written authorization from THOMSON. The content of this document is furnished for informational use only, may be subject to change without notice, and should not be construed as a commitment by THOMSON. THOMSON assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. Content About this Document ...................................................................................................................................................... 9 Accessing the Command Line Interface .................................................................................................................... 11 Basic Navigation and Manipulation.............................................................................................................................. 12 Command Line Interface Top Level Structure ........................................................................................................ 17 Command Line Interface Commands ........................................................................................................................ 18 Menu-driven CLI Navigation ........................................................................................................................................ 19 Configuration Profile Files and the CLI...................................................................................................................... 20 Direct FTP Access .......................................................................................................................................................... 22 ADSL Commands .......................................................................................... 25 adsl config ......................................................................................................................................................................... 26 adsl info ............................................................................................................................................................................. 27 ATM Commands............................................................................................ 29 atm portstats.................................................................................................................................................................... 30 atm oam config ................................................................................................................................................................ 31 atm oam status ................................................................................................................................................................ 32 Bridge Commands ......................................................................................... 33 bridge config ..................................................................................................................................................................... 34 bridge flush ....................................................................................................................................................................... 35 bridge ifadd ....................................................................................................................................................................... 36 bridge ifattach................................................................................................................................................................... 39 bridge ifconfig................................................................................................................................................................... 42 bridge ifdelete .................................................................................................................................................................. 44 bridge ifdetach ................................................................................................................................................................. 45 bridge iflist ........................................................................................................................................................................ 46 bridge macadd.................................................................................................................................................................. 48 bridge macdelete ............................................................................................................................................................. 49 bridge maclist ................................................................................................................................................................... 50 E-SIT-CTC-20021203-0003 v1.0 1 CIP Commands .............................................................................................. 51 cip flush.............................................................................................................................................................................. 52 cip ifadd ............................................................................................................................................................................. 53 cip ifdelete......................................................................................................................................................................... 54 cip iflist............................................................................................................................................................................... 55 cip pvcadd ......................................................................................................................................................................... 57 cip pvcdelete .................................................................................................................................................................... 58 cip pvclist........................................................................................................................................................................... 59 Config Commands ......................................................................................... 61 config erase....................................................................................................................................................................... 62 config flush ........................................................................................................................................................................ 63 config load......................................................................................................................................................................... 64 config save......................................................................................................................................................................... 65 2 E-SIT-CTC-20021203-0003 v1.0 DHCP Commands ......................................................................................... 67 dhcp client clear .............................................................................................................................................................. 68 dhcp client config ............................................................................................................................................................ 69 dhcp client flush............................................................................................................................................................... 70 dhcp client ifadd............................................................................................................................................................... 71 dhcp client ifattach.......................................................................................................................................................... 72 dhcp client ifconfig .......................................................................................................................................................... 73 dhcp client ifdelete.......................................................................................................................................................... 75 dhcp client iflist................................................................................................................................................................ 76 dhcp client ifrelease ........................................................................................................................................................ 77 dhcp client ifrenew ......................................................................................................................................................... 79 dhcp client stats............................................................................................................................................................... 81 dhcp server clear............................................................................................................................................................. 82 dhcp server config........................................................................................................................................................... 83 dhcp server flush ............................................................................................................................................................. 84 dhcp server policy........................................................................................................................................................... 85 dhcp server spoof ........................................................................................................................................................... 86 dhcp server start ............................................................................................................................................................. 87 dhcp server stats ............................................................................................................................................................. 88 dhcp server stop ............................................................................................................................................................. 90 dhcp server lease add..................................................................................................................................................... 91 dhcp server lease delete................................................................................................................................................ 93 dhcp server lease flush................................................................................................................................................... 94 dhcp server lease list...................................................................................................................................................... 95 dhcp server pool add ..................................................................................................................................................... 96 dhcp server pool config ................................................................................................................................................. 98 dhcp server pool delete...............................................................................................................................................100 dhcp server pool flush .................................................................................................................................................101 dhcp server pool list.....................................................................................................................................................102 E-SIT-CTC-20021203-0003 v1.0 3 DNS Commands .......................................................................................... 103 dns add ............................................................................................................................................................................104 dns clear ..........................................................................................................................................................................105 dns clrstats......................................................................................................................................................................106 dns delete........................................................................................................................................................................107 dns domain .....................................................................................................................................................................108 dns flush...........................................................................................................................................................................109 dns fwdadd......................................................................................................................................................................110 dns fwddelete.................................................................................................................................................................111 dns fwdlist .......................................................................................................................................................................112 dns fwdtable ...................................................................................................................................................................113 dns list..............................................................................................................................................................................114 dns nslookup ..................................................................................................................................................................115 dns start...........................................................................................................................................................................116 dns stats...........................................................................................................................................................................117 dns status ........................................................................................................................................................................118 dns stop ...........................................................................................................................................................................119 dns toutfwd ....................................................................................................................................................................120 dns troff...........................................................................................................................................................................121 dns tron...........................................................................................................................................................................122 Env Commands ............................................................................................ 123 env def .............................................................................................................................................................................124 env flush ..........................................................................................................................................................................125 env get .............................................................................................................................................................................128 env list..............................................................................................................................................................................129 env set .............................................................................................................................................................................130 env unset.........................................................................................................................................................................131 Eth Commands............................................................................................. 133 eth ifconfig ......................................................................................................................................................................134 eth iflist ............................................................................................................................................................................135 4 E-SIT-CTC-20021203-0003 v1.0 Firewall Commands..................................................................................... 137 firewall assign .................................................................................................................................................................138 firewall flush....................................................................................................................................................................139 firewall list.......................................................................................................................................................................140 firewall troff....................................................................................................................................................................141 firewall tron....................................................................................................................................................................142 firewall unassign.............................................................................................................................................................143 firewall chain create......................................................................................................................................................144 firewall chain delete......................................................................................................................................................145 firewall chain list ............................................................................................................................................................146 firewall rule clear...........................................................................................................................................................147 firewall rule create........................................................................................................................................................148 firewall rule delete ........................................................................................................................................................152 firewall rule flush ...........................................................................................................................................................153 firewall rule list ..............................................................................................................................................................154 firewall rule stats ...........................................................................................................................................................155 IP Commands ............................................................................................... 157 ip apadd ...........................................................................................................................................................................158 ip apdelete.......................................................................................................................................................................160 ip aplist.............................................................................................................................................................................161 ip arpadd .........................................................................................................................................................................162 ip arpdelete.....................................................................................................................................................................163 ip arplist...........................................................................................................................................................................164 ip config ...........................................................................................................................................................................165 ip flush..............................................................................................................................................................................168 ip ifconfig .........................................................................................................................................................................169 ip iflist...............................................................................................................................................................................170 ip ping...............................................................................................................................................................................171 ip rtadd ............................................................................................................................................................................172 ip rtdelete .......................................................................................................................................................................174 ip rtlist..............................................................................................................................................................................175 ip sendto..........................................................................................................................................................................176 E-SIT-CTC-20021203-0003 v1.0 5 IPoA Commands.......................................................................................... 177 ipoa flush .........................................................................................................................................................................178 ipoa ifadd.........................................................................................................................................................................179 ipoa ifattach ....................................................................................................................................................................180 ipoa ifconfig.....................................................................................................................................................................181 ipoa ifdelete ....................................................................................................................................................................183 ipoa ifdetach ...................................................................................................................................................................184 ipoa iflist ..........................................................................................................................................................................185 MER Commands .......................................................................................... 187 mer flush .........................................................................................................................................................................188 mer ifadd .........................................................................................................................................................................189 mer ifattach.....................................................................................................................................................................190 mer ifconfig.....................................................................................................................................................................191 mer ifdelete ....................................................................................................................................................................193 mer ifdetach....................................................................................................................................................................194 mer iflist ..........................................................................................................................................................................195 NAT Commands .......................................................................................... 197 nat applist........................................................................................................................................................................198 nat bind............................................................................................................................................................................199 nat bindlist.......................................................................................................................................................................200 nat create ........................................................................................................................................................................201 nat defserver ..................................................................................................................................................................203 nat delete ........................................................................................................................................................................204 nat disable .......................................................................................................................................................................206 nat enable........................................................................................................................................................................207 nat flush ...........................................................................................................................................................................208 nat list ..............................................................................................................................................................................209 nat unbind .......................................................................................................................................................................210 Phonebook Commands ............................................................................... 211 phonebook add..............................................................................................................................................................212 phonebook autolist.......................................................................................................................................................214 phonebook delete.........................................................................................................................................................215 phonebook flush............................................................................................................................................................216 phonebook list ...............................................................................................................................................................217 6 E-SIT-CTC-20021203-0003 v1.0 PPP Commands ........................................................................................... 219 ppp flush ..........................................................................................................................................................................220 ppp ifadd..........................................................................................................................................................................221 ppp ifattach .....................................................................................................................................................................223 ppp ifconfig......................................................................................................................................................................225 ppp ifdelete .....................................................................................................................................................................230 ppp ifdetach ....................................................................................................................................................................232 ppp iflist ...........................................................................................................................................................................233 ppp ifscan ........................................................................................................................................................................234 ppp rtadd.........................................................................................................................................................................235 ppp rtdelete....................................................................................................................................................................237 PPTP Commands......................................................................................... 239 pptp flush.........................................................................................................................................................................240 pptp list............................................................................................................................................................................241 pptp profadd...................................................................................................................................................................242 pptp profdelete..............................................................................................................................................................243 pptp proflist ....................................................................................................................................................................244 QoSBook Commands .................................................................................. 245 qosbook add...................................................................................................................................................................246 qosbook delete..............................................................................................................................................................248 qosbook flush.................................................................................................................................................................249 qosbook list ....................................................................................................................................................................250 Software Commands ................................................................................... 251 software cleanup ...........................................................................................................................................................252 software deletepassive.................................................................................................................................................253 software duplicate.........................................................................................................................................................254 software setpassive.......................................................................................................................................................255 software switch .............................................................................................................................................................256 software version............................................................................................................................................................257 E-SIT-CTC-20021203-0003 v1.0 7 System Commands...................................................................................... 259 system clearpassword ..................................................................................................................................................260 system config..................................................................................................................................................................261 system flush ....................................................................................................................................................................262 system reboot................................................................................................................................................................263 system reset ...................................................................................................................................................................264 system setpassword......................................................................................................................................................265 TD Commands ............................................................................................. 267 td call................................................................................................................................................................................268 UPnP Commands......................................................................................... 269 upnp config .....................................................................................................................................................................270 upnp flush........................................................................................................................................................................271 upnp list ...........................................................................................................................................................................272 Wireless Commands ................................................................................... 273 wireless wepconfig........................................................................................................................................................274 wireless aclconfig...........................................................................................................................................................275 wireless acllist ................................................................................................................................................................276 wireless aclflush .............................................................................................................................................................277 wireless aclentry............................................................................................................................................................278 wireless ifconfig .............................................................................................................................................................279 wireless status................................................................................................................................................................281 wireless counters ..........................................................................................................................................................282 wireless scan ..................................................................................................................................................................283 wireless flush ..................................................................................................................................................................284 Abbreviations ............................................................................................... 285 Supported Key Names ................................................................................ 289 Supported Internet Protocol (IP) Protocol Names ..............................................................................................289 Supported TCP/UDP Port Names............................................................................................................................290 Supported ICMP Type Names ...................................................................................................................................293 8 E-SIT-CTC-20021203-0003 v1.0 About this Document Introduction Welcome to the SpeedTouchTM500Series 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 SpeedTouchTM500Series CLI command set, to be used by the end-user to configure the SpeedTouchTM500Series and PC(s). For the fastidious user this Reference Guide aims to give a handbook for advanced and detailed configuration and troubleshooting of the SpeedTouchTM500Series via its character based Command Line Interface. This CLI Reference Guide covers the CLI commands of the following DSL SpeedTouchTM products: · · · · · SpeedTouchTM510 SpeedTouchTM510i SpeedTouchTM530 SpeedTouchTM570 SpeedTouchTM570i Contents The Reference Guide consists of two main parts: · CLI Navigation The CLI navigation is decribed in this chapter. Here the user is familiarised with the SpeedTouchTM500Series CLI. It describes general manipulations to navigate through and to perform some operations on the CLI. CLI Command Description The other chapters describe all the available CLI commands of the SpeedTouchTM500Series per command group and in alphabetical order. 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 SpeedTouchTM500Series 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. · E-SIT-CTC-20021203-0003 v1.0 9 Trademarks The following trademarks are used in this document: · · · · · · SpeedTouchTM is a trademark of THOMSON Netscape, and Netscape Navigator, are registered trademarks of Netscape Communications Corporation Windows and Internet Explorer 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. 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 DSL technology, existing products are regularly upgraded. For more information on the latest technological innovations, software upgrades, and documents, please visit the SpeedTouchTM web site at: http://www.speedtouch.com Directive Unless expressly and unambiguously approved by THOMSON, 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 THOMSON, 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 THOMSON will result in the loss of product warranty and will invalidate the user's authority to operate this equipment. · · · · · 10 E-SIT-CTC-20021203-0003 v1.0 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 SpeedTouchTM500Series. As soon a session to the CLI is opened, the SpeedTouchTM500Series banner pops up, followed by the CLI prompt. In case the SpeedTouchTM500Series is protected by a System password, authentication will be required before access is granted. The following figure shows an example of the SpeedTouchTM500Series banner after opening a session and authentication. /home/doejohn{1}$ telnet 10.0.0.138 Trying 10.0.0.138... Connected to 10.0.0.138. Username : Password : ###### -----------------------------------------------------------------------* * ______ Speedtouch 510 * ___/_____/\ * / /\\ Version R4.0.0.9.0 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2002, * // /\ /\ \ THOMSON multimedia * _______//_______/ \ / _\/______ * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * -----------------------------------------------------------------------=> E-SIT-CTC-20021203-0003 v1.0 11 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. The example below shows every possible CLI command group for the SpeedTouchTM510. =>help Following commands are available : help : Displays this help information menu : Displays menu ? : Displays this help information exit : Exits this shell. .. : Exits group selection. saveall : Saves current configuration. Following command groups are available : adsl dhcp ip phonebook system => atm dns ipoa ppp td bridge env mer pptp upnp cip eth nat qosbook config firewall password software However: · · · eth is only available on SpeedTouchTM510 variants equipped with a single Ethernet port and the SpeedTouchTM530 upnp is only available for the SpeedTouchTM510 variants and the SpeedTouchTM530 wireless is only available for the SpeedTouchTM570 To return to top level, or to descend one level (in case of nested command groups) execute .. . EXAMPLE: =>phonebook [phonebook]=> [phonebook]=>.. => 12 E-SIT-CTC-20021203-0003 v1.0 The Help Command Execute help or ? from top level to list all available command groups for the SpeedTouchTM500Series. EXAMPLE for the SpeedTouchTM570: =>help Following commands are available : help : Displays this help information menu : Displays menu ? : Displays this help information exit : Exits this shell. .. : Exits group selection. saveall : Saves current configuration. Following command groups are available : adsl dhcp ip ppp td => atmstats dns mer pptp wireless bridge env nat qosbook cip eth password software config firewall phonebook system 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 SpeedTouchTM500Series CLI, the help command may always be equally replaced by the ? command. Executing e.g. help firewall from top level gives the same result as executing help from the firewall command group selection. E-SIT-CTC-20021203-0003 v1.0 13 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 14 E-SIT-CTC-20021203-0003 v1.0 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. 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 To go to ... the beginning of the Command Line the end of the Command Line Press ... CTRL+A CTRL+E E-SIT-CTC-20021203-0003 v1.0 15 Breaking off Commands Press CTRL+G to break off a command. This can be useful in a situation where a user is prompted to enter a value which he does not know and wants to quit the command. Instead of being prompted over and over again for the same value, this allows to quit the command and return to the command line prompt. In the example below CTRL+G is pressed after the third prompt chain = [firewall]=>match chain = chain = chain = "CTRL+G" [firewall]=> History of Commands To select previously executed commands, use the UP and DOWN ARROW keys to select a previously executed command. Press ENTER to execute the selected 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 16 E-SIT-CTC-20021203-0003 v1.0