User manual ALCATEL-LUCENT SPEEDTOUCH 605S - 1

SpeedTouchTM605s Multi-User SHDSL Gateway CLI Reference Guide Release R4.2.7(.2) 600 SERIES SpeedTouchTM 605s CLI Reference Guide Release R4.2.7(.2) Status Reference Short Title Copyright v3.0 (October 2004) E-DOC-CTC-20040216-0004 CLI ST605s R4.2.7(.2) © 2004 THOMSON Telecom. All rights reserved. Passing on, and copying of this document, use and communication of its contents is not permitted without written authorization from THOMSON Telecom. 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 Telecom. THOMSON Telecom assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. Content About this Document .................................................................................... 15 CLI Navigation ............................................................................................... 17 Accessing the Command Line Interface .................................................................................................................... 18 Basic Navigation and Manipulation.............................................................................................................................. 19 Command Line Interface Top Level Structure ........................................................................................................ 23 Command Line Interface Commands ........................................................................................................................ 24 Menu-driven CLI Navigation ........................................................................................................................................ 25 Service Template Files and the CLI ............................................................................................................................ 28 Direct FTP Access .......................................................................................................................................................... 30 ATM Commands............................................................................................ 33 atm oam ccconfig ............................................................................................................................................................ 34 atm oam cclist.................................................................................................................................................................. 35 atm oam ccsend............................................................................................................................................................... 36 atm oam config ................................................................................................................................................................ 37 atm oam mode................................................................................................................................................................. 38 atm oam ping.................................................................................................................................................................... 39 atm oam status ................................................................................................................................................................ 40 AutoPVC Commands .................................................................................... 41 autopvc config .................................................................................................................................................................. 42 autopvc info...................................................................................................................................................................... 44 Bridge Commands ......................................................................................... 45 bridge config ..................................................................................................................................................................... 46 bridge flush ....................................................................................................................................................................... 47 bridge ifadd ....................................................................................................................................................................... 48 bridge ifattach................................................................................................................................................................... 49 bridge ifconfig................................................................................................................................................................... 50 bridge ifdelete .................................................................................................................................................................. 52 bridge ifdetach ................................................................................................................................................................. 53 bridge iflist ........................................................................................................................................................................ 54 bridge macadd.................................................................................................................................................................. 55 bridge macdelete ............................................................................................................................................................. 56 bridge maclist ................................................................................................................................................................... 57 E-DOC-CTC-20040216-0004 v3.0 3 CIP Commands .............................................................................................. 59 cip flush.............................................................................................................................................................................. 60 cip ifadd ............................................................................................................................................................................. 61 cip ifdelete......................................................................................................................................................................... 62 cip iflist............................................................................................................................................................................... 63 cip pvcadd ......................................................................................................................................................................... 64 cip pvcdelete .................................................................................................................................................................... 65 cip pvclist........................................................................................................................................................................... 66 Config Commands ......................................................................................... 67 config backup.................................................................................................................................................................... 68 config dump ...................................................................................................................................................................... 69 config erase....................................................................................................................................................................... 70 config flush ........................................................................................................................................................................ 71 config list ........................................................................................................................................................................... 72 config load......................................................................................................................................................................... 73 config save......................................................................................................................................................................... 75 4 E-DOC-CTC-20040216-0004 v3.0 DHCP Commands ......................................................................................... 77 dhcp client clear .............................................................................................................................................................. 79 dhcp client config ............................................................................................................................................................ 80 dhcp client flush............................................................................................................................................................... 81 dhcp client ifadd............................................................................................................................................................... 82 dhcp client ifattach.......................................................................................................................................................... 83 dhcp client ifconfig .......................................................................................................................................................... 84 dhcp client ifdelete.......................................................................................................................................................... 86 dhcp client iflist................................................................................................................................................................ 87 dhcp client ifrelease ........................................................................................................................................................ 88 dhcp client ifrenew ......................................................................................................................................................... 91 dhcp client stats............................................................................................................................................................... 94 dhcp relay add.................................................................................................................................................................. 95 dhcp relay config ............................................................................................................................................................. 96 dhcp relay delete............................................................................................................................................................. 97 dhcp relay flush................................................................................................................................................................ 98 dhcp relay ifconfig ........................................................................................................................................................... 99 dhcp relay iflist...............................................................................................................................................................100 dhcp relay list .................................................................................................................................................................101 dhcp relay stats..............................................................................................................................................................102 dhcp server clear...........................................................................................................................................................103 dhcp server config.........................................................................................................................................................104 dhcp server flush ...........................................................................................................................................................105 dhcp server policy.........................................................................................................................................................106 dhcp server stats ...........................................................................................................................................................107 dhcp server lease add...................................................................................................................................................109 dhcp server lease delete..............................................................................................................................................111 dhcp server lease flush.................................................................................................................................................112 dhcp server lease list....................................................................................................................................................113 dhcp server pool add ...................................................................................................................................................114 dhcp server pool config ...............................................................................................................................................115 dhcp server pool delete...............................................................................................................................................117 dhcp server pool flush .................................................................................................................................................118 dhcp server pool list.....................................................................................................................................................119 E-DOC-CTC-20040216-0004 v3.0 5 DNS Commands .......................................................................................... 121 dns add ............................................................................................................................................................................122 dns clear ..........................................................................................................................................................................123 dns clrstats......................................................................................................................................................................124 dns delete........................................................................................................................................................................125 dns domain .....................................................................................................................................................................126 dns flush...........................................................................................................................................................................127 dns fwdadd......................................................................................................................................................................128 dns fwddelete.................................................................................................................................................................129 dns fwdlist .......................................................................................................................................................................130 dns fwdtable ...................................................................................................................................................................131 dns list..............................................................................................................................................................................132 dns nslookup ..................................................................................................................................................................133 dns start...........................................................................................................................................................................134 dns stats...........................................................................................................................................................................135 dns status ........................................................................................................................................................................136 dns stop ...........................................................................................................................................................................137 dns toutfwd ....................................................................................................................................................................138 dns troff...........................................................................................................................................................................139 dns tron...........................................................................................................................................................................140 Env Commands ............................................................................................ 141 env flush ..........................................................................................................................................................................142 env get .............................................................................................................................................................................143 env list..............................................................................................................................................................................144 env set .............................................................................................................................................................................145 env unset.........................................................................................................................................................................146 Eth Commands............................................................................................. 147 eth config.........................................................................................................................................................................148 eth ifconfig ......................................................................................................................................................................149 eth iflist ............................................................................................................................................................................150 6 E-DOC-CTC-20040216-0004 v3.0 ETHoA Commands ..................................................................................... 151 ethoa flush.......................................................................................................................................................................152 ethoa ifadd ......................................................................................................................................................................153 ethoa ifattach..................................................................................................................................................................154 ethoa ifconfig..................................................................................................................................................................155 ethoa ifdelete .................................................................................................................................................................157 ethoa ifdetach.................................................................................................................................................................158 ethoa iflist........................................................................................................................................................................159 Firewall Commands..................................................................................... 161 firewall assign .................................................................................................................................................................162 firewall flush....................................................................................................................................................................164 firewall list.......................................................................................................................................................................165 firewall troff....................................................................................................................................................................166 firewall tron....................................................................................................................................................................167 firewall unassign.............................................................................................................................................................168 firewall chain create......................................................................................................................................................169 firewall chain delete......................................................................................................................................................170 firewall chain flush.........................................................................................................................................................171 firewall chain list ............................................................................................................................................................172 firewall rule clear...........................................................................................................................................................173 firewall rule create........................................................................................................................................................174 firewall rule delete ........................................................................................................................................................178 firewall rule flush ...........................................................................................................................................................179 firewall rule list ..............................................................................................................................................................180 firewall rule stats ...........................................................................................................................................................181 E-DOC-CTC-20040216-0004 v3.0 7 IP Commands ............................................................................................... 183 ip apadd ...........................................................................................................................................................................184 ip apdelete.......................................................................................................................................................................186 ip aplist.............................................................................................................................................................................187 ip arpadd .........................................................................................................................................................................188 ip arpdelete.....................................................................................................................................................................189 ip arplist...........................................................................................................................................................................190 ip config ...........................................................................................................................................................................191 ip flush..............................................................................................................................................................................194 ip ifconfig .........................................................................................................................................................................195 ip iflist...............................................................................................................................................................................196 ip ifwait ............................................................................................................................................................................197 ip mcadd ..........................................................................................................................................................................198 ip mcdelete .....................................................................................................................................................................199 ip mclist ...........................................................................................................................................................................200 ip ping...............................................................................................................................................................................201 ip rtadd ............................................................................................................................................................................202 ip rtdelete .......................................................................................................................................................................203 ip rtlist..............................................................................................................................................................................204 ip sendto..........................................................................................................................................................................205 ip traceroute ..................................................................................................................................................................206 ip auto flush ....................................................................................................................................................................207 ip auto ifadd....................................................................................................................................................................208 ip auto ifattach ...............................................................................................................................................................209 ip auto ifconfig................................................................................................................................................................210 ip auto ifdelete ...............................................................................................................................................................211 ip auto ifdetach ..............................................................................................................................................................212 ip auto iflist .....................................................................................................................................................................213 IPoA Commands.......................................................................................... 215 ipoa flush .........................................................................................................................................................................216 ipoa ifadd.........................................................................................................................................................................217 ipoa ifattach ....................................................................................................................................................................218 ipoa ifconfig.....................................................................................................................................................................219 ipoa ifdelete ....................................................................................................................................................................221 ipoa ifdetach ...................................................................................................................................................................222 ipoa iflist ..........................................................................................................................................................................223 8 E-DOC-CTC-20040216-0004 v3.0 IPQoS Commands ....................................................................................... 225 ipqos config.....................................................................................................................................................................226 ipqos list ..........................................................................................................................................................................228 ipqos queue clear ..........................................................................................................................................................229 ipqos queue config ........................................................................................................................................................230 ipqos queue list..............................................................................................................................................................232 ipqos queue stats...........................................................................................................................................................233 Label Commands ......................................................................................... 235 label add ..........................................................................................................................................................................236 label config ......................................................................................................................................................................237 label delete......................................................................................................................................................................239 label flush.........................................................................................................................................................................240 label list............................................................................................................................................................................241 label troff.........................................................................................................................................................................242 label tron.........................................................................................................................................................................243 label chain create...........................................................................................................................................................244 label chain delete...........................................................................................................................................................245 label chain flush..............................................................................................................................................................246 label chain list.................................................................................................................................................................247 label rule clear................................................................................................................................................................248 label rule create.............................................................................................................................................................249 label rule delete .............................................................................................................................................................252 label rule flush ................................................................................................................................................................253 label rule list ...................................................................................................................................................................254 label rule stats ................................................................................................................................................................255 Language Commands .................................................................................. 257 language config ...............................................................................................................................................................258 language list.....................................................................................................................................................................259 language remove............................................................................................................................................................260 E-DOC-CTC-20040216-0004 v3.0 9 NAT Commands .......................................................................................... 261 nat applist........................................................................................................................................................................262 nat bind............................................................................................................................................................................263 nat bindlist.......................................................................................................................................................................264 nat clear...........................................................................................................................................................................266 nat config.........................................................................................................................................................................267 nat create ........................................................................................................................................................................268 nat defserver ..................................................................................................................................................................270 nat delete ........................................................................................................................................................................271 nat disable .......................................................................................................................................................................273 nat enable........................................................................................................................................................................274 nat flush ...........................................................................................................................................................................276 nat list ..............................................................................................................................................................................277 nat multinatadd ..............................................................................................................................................................278 nat multinatdelete .........................................................................................................................................................279 nat multinatlist ...............................................................................................................................................................280 nat unbind .......................................................................................................................................................................281 Phonebook Commands ............................................................................... 283 phonebook add..............................................................................................................................................................284 phonebook autolist.......................................................................................................................................................286 phonebook delete.........................................................................................................................................................287 phonebook flush............................................................................................................................................................288 phonebook list ...............................................................................................................................................................289 PPPoA Commands ...................................................................................... 291 pppoa flush......................................................................................................................................................................292 pppoa ifadd .....................................................................................................................................................................293 pppoa ifattach.................................................................................................................................................................295 pppoa ifconfig .................................................................................................................................................................296 pppoa ifdelete.................................................................................................................................................................300 pppoa ifdetach................................................................................................................................................................301 pppoa iflist.......................................................................................................................................................................302 pppoa rtadd ....................................................................................................................................................................303 pppoa rtdelete ...............................................................................................................................................................305 10 E-DOC-CTC-20040216-0004 v3.0 PPPoE Commands....................................................................................... 307 pppoe flush .....................................................................................................................................................................308 pppoe ifadd .....................................................................................................................................................................309 pppoe ifattach.................................................................................................................................................................311 pppoe ifconfig.................................................................................................................................................................312 pppoe ifdelete ................................................................................................................................................................316 pppoe ifdetach ...............................................................................................................................................................317 pppoe iflist ......................................................................................................................................................................318 pppoe ifscan....................................................................................................................................................................319 pppoe rtadd....................................................................................................................................................................320 pppoe rtdelete ...............................................................................................................................................................322 pppoe relay add .............................................................................................................................................................323 pppoe relay delete ........................................................................................................................................................324 pppoe relay flush ...........................................................................................................................................................325 pppoe relay portlist ......................................................................................................................................................326 pppoe relay sesslist.......................................................................................................................................................327 PPTP Commands......................................................................................... 329 pptp ifadd ........................................................................................................................................................................330 pptp flush.........................................................................................................................................................................331 pptp list............................................................................................................................................................................332 pptp profadd...................................................................................................................................................................333 pptp profdelete..............................................................................................................................................................335 pptp proflist ....................................................................................................................................................................336 QoSBook Commands .................................................................................. 337 qosbook add...................................................................................................................................................................338 qosbook config ..............................................................................................................................................................340 qosbook delete..............................................................................................................................................................341 qosbook flush.................................................................................................................................................................342 qosbook list ....................................................................................................................................................................343 Script Commands ........................................................................................ 345 script add ........................................................................................................................................................................346 script delete....................................................................................................................................................................347 script flush.......................................................................................................................................................................348 script list..........................................................................................................................................................................349 script run.........................................................................................................................................................................350 E-DOC-CTC-20040216-0004 v3.0 11 SHDSL Commands...................................................................................... 351 shdsl line..........................................................................................................................................................................352 shdsl loopback................................................................................................................................................................353 shdsl stats........................................................................................................................................................................354 shdsl version...................................................................................................................................................................355 shdsl config monitoring................................................................................................................................................356 shdsl config show ..........................................................................................................................................................357 shdsl config side.............................................................................................................................................................358 shdsl config CO annex.................................................................................................................................................359 shdsl config CO margins..............................................................................................................................................360 shdsl config CO rate ....................................................................................................................................................361 shdsl config CO show ..................................................................................................................................................362 shdsl config CPE psd.....................................................................................................................................................363 shdsl config CPE show .................................................................................................................................................364 SNMP Commands........................................................................................ 365 snmp config.....................................................................................................................................................................366 snmp get..........................................................................................................................................................................367 snmp getNext ................................................................................................................................................................368 snmp list ..........................................................................................................................................................................369 snmp walk .......................................................................................................................................................................370 Software Commands ................................................................................... 371 software version............................................................................................................................................................372 software upgrade ..........................................................................................................................................................373 System Commands...................................................................................... 375 system clearpassword ..................................................................................................................................................376 system config..................................................................................................................................................................377 system flush ....................................................................................................................................................................378 system reboot................................................................................................................................................................379 system reset ...................................................................................................................................................................380 system setpassword......................................................................................................................................................381 system stats ....................................................................................................................................................................382 Systemlog Commands................................................................................. 383 systemlog flush...............................................................................................................................................................384 systemlog show .............................................................................................................................................................385 systemlog send...............................................................................................................................................................386 12 E-DOC-CTC-20040216-0004 v3.0 TD Commands ............................................................................................. 387 td call................................................................................................................................................................................388 UPnP Commands......................................................................................... 389 upnp config .....................................................................................................................................................................390 upnp flush........................................................................................................................................................................392 upnp list ...........................................................................................................................................................................393 Abbreviations ............................................................................................... 395 Syslog Messages............................................................................................ 399 Auto-PVC Module ........................................................................................................................................................400 Configuration Module ..................................................................................................................................................400 DHCP CLient Module .................................................................................................................................................401 DHCP Relay Module ....................................................................................................................................................401 DHCP Server Module..................................................................................................................................................402 Firewall Module .............................................................................................................................................................402 HTTP Module ................................................................................................................................................................402 Kernel Module ...............................................................................................................................................................403 Linestate Module...........................................................................................................................................................403 Login Module..................................................................................................................................................................403 NAPT Module................................................................................................................................................................403 PPP Module.....................................................................................................................................................................404 PPTP Module..................................................................................................................................................................404 Routing Module .............................................................................................................................................................404 Software Module ...........................................................................................................................................................405 UPnP Module .................................................................................................................................................................405 Supported Key Names ................................................................................ 407 Supported Internet Protocol (IP) Protocol Names ..............................................................................................407 Supported TCP/UDP Port Names............................................................................................................................408 Supported ICMP Type Names ...................................................................................................................................411 Supported Syslog Facilities ..........................................................................................................................................412 Supported Syslog Severities........................................................................................................................................413 E-DOC-CTC-20040216-0004 v3.0 13 14 E-DOC-CTC-20040216-0004 v3.0 About this Document About this Document Introduction Welcome to the SpeedTouchTM Command Line Interface (CLI) Reference Guide! For the Service Provider, this Reference Guide aims to be a concise and practical document for creating a customized Service Template file, based on the SpeedTouchTM CLI command set, to be used by the end-user to configure the SpeedTouchTM and PC(s). For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and troubleshooting of the SpeedTouchTM via its character based CLI command set. Applicability This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouchTM products: · SpeedTouchTM605s Multi-User SHDSL Gateway (R4.2.7(.2)) For readability, all are referred to as SpeedTouchTM throughout this document unless a specific variant is concerned. Contents The Reference Guide consists of two main parts: · CLI Navigation: This chapter familiarizes the user with the SpeedTouchTM CLI. It describes general manipulations to navigate through the CLI and to perform some operations on the CLI. · CLI Command Description: The other chapters describe all the available CLI commands of the SpeedTouchTM 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 necessary completed by a description of the possible impact on the user and/or the SpeedTouchTM 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-DOC-CTC-20040216-0004 v3.0 15 About this Document Trademarks The following trademarks are used in this document: · · · · · · SpeedTouchTM is a trademark of THOMSON Telecom. Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation. Windows and Internet Explorer are trademarks of Microsoft Corporation. Apple and MacOS are registered trademarks of Apple Computer Inc. UNIX is a registered trademark of UNIX System Laboratories, Inc. Ethernet is a trademark of Xerox Corporation. Other products may be trademarks or registered trademarks of their respective manufacturers. Updates Due to the continuous evolution of SpeedTouchTM technology, existing products are regularly improved. For more information on the latest technological innovations, software upgrades, and documents, please visit the SpeedTouchTM web site at: www.speedtouch.com 16 E-DOC-CTC-20040216-0004 v3.0 CLI Navigation CLI Navigation Introduction This chapter familiarizes the user with the SpeedTouchTM CLI. It describes general manipulations: · · to navigate through the CLI to perform some operations on the CLI. Contents This chapter covers the following topics: Topic Accessing the Command Line Interface Basic Navigation and Manipulation Command Line Interface Top Level Structure Command Line Interface Commands Menu-driven CLI Navigation Service Template Files and the CLI Direct FTP Access Page 18 19 23 24 25 28 30 E-DOC-CTC-20040216-0004 v3.0 17 CLI Navigation Accessing the Command Line Interface Proceed as follows to open a Telnet session: 1 2 Open a Command Prompt window, e.g. by clicking Start > All Programs > Accessories > Command Prompt. At the prompt, type telnet followed by the IP address of the SpeedTouchTM (default is 10.0.0.138). As soon a session to the CLI is opened, the SpeedTouchTM banner pops up, followed by the CLI prompt. If the SpeedTouchTM is protected by a username and a system password, authentication will be required before access is granted. The following figure shows an example of the SpeedTouchTM605s banner after opening a session and authentication. Username : johndoe Password : ******* -----------------------------------------------------------------------* * ______ SpeedTouch 605s * ___/_____/\ * / /\\ Version 4.2.7.29.0 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2004, * // /\ /\ \ THOMSON * _______//_______/ \ / _\/______ * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * -----------------------------------------------------------------------=> 18 E-DOC-CTC-20040216-0004 v3.0