User manual ALCATEL-LUCENT SPEEDTOUCH 500 - 1

SpeedTouchTM 500Series Multi-User ADSL Gateways CLI Reference Guide Release R4.2 500 SERIES SpeedTouchTM 500Series CLI Reference Guide Release R4.2 Status Change Note Short Title Copyright Released PeckelbeenS CLI ST500Series R4.2 © 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 .................................................................................... 17 CLI Navigation ............................................................................................... 19 Accessing the Command Line Interface .................................................................................................................... 20 Basic Navigation and Manipulation.............................................................................................................................. 21 Command Line Interface Top Level Structure ........................................................................................................ 25 Command Line Interface Commands ........................................................................................................................ 26 Menu-driven CLI Navigation ........................................................................................................................................ 27 Configuration Profile Files and the CLI...................................................................................................................... 28 ADSL Commands .......................................................................................... 31 adsl config ......................................................................................................................................................................... 32 adsl info ............................................................................................................................................................................. 33 ATM Commands............................................................................................ 35 atm aal5stats..................................................................................................................................................................... 36 atm gstats .......................................................................................................................................................................... 37 atm portstats.................................................................................................................................................................... 38 atm vcstats........................................................................................................................................................................ 39 atm oam ccconfig ............................................................................................................................................................ 40 atm oam cclist.................................................................................................................................................................. 42 atm oam ccsend............................................................................................................................................................... 43 atm oam config ................................................................................................................................................................ 45 atm oam mode................................................................................................................................................................. 46 atm oam ping.................................................................................................................................................................... 47 atm oam status ................................................................................................................................................................ 48 AutoPVC Commands .................................................................................... 49 autopvc config .................................................................................................................................................................. 50 autopvc info...................................................................................................................................................................... 52 5 Bridge Commands ......................................................................................... 53 bridge config ..................................................................................................................................................................... 54 bridge flush ....................................................................................................................................................................... 55 bridge ifadd ....................................................................................................................................................................... 56 bridge ifattach................................................................................................................................................................... 59 bridge ifconfig................................................................................................................................................................... 62 bridge ifdelete .................................................................................................................................................................. 64 bridge ifdetach ................................................................................................................................................................. 65 bridge iflist ........................................................................................................................................................................ 66 bridge macadd.................................................................................................................................................................. 68 bridge macdelete ............................................................................................................................................................. 69 bridge maclist ................................................................................................................................................................... 70 CIP Commands .............................................................................................. 71 cip flush.............................................................................................................................................................................. 72 cip ifadd ............................................................................................................................................................................. 73 cip ifdelete......................................................................................................................................................................... 74 cip iflist............................................................................................................................................................................... 75 cip pvcadd ......................................................................................................................................................................... 76 cip pvcdelete .................................................................................................................................................................... 77 cip pvclist........................................................................................................................................................................... 78 Config Commands ......................................................................................... 79 config backup.................................................................................................................................................................... 80 config dump ...................................................................................................................................................................... 81 config erase....................................................................................................................................................................... 82 config flush ........................................................................................................................................................................ 83 config list ........................................................................................................................................................................... 84 config load......................................................................................................................................................................... 85 config save......................................................................................................................................................................... 87 6 DHCP Commands ......................................................................................... 89 dhcp client clear .............................................................................................................................................................. 91 dhcp client config ............................................................................................................................................................ 92 dhcp client flush............................................................................................................................................................... 93 dhcp client ifadd............................................................................................................................................................... 94 dhcp client ifattach.......................................................................................................................................................... 95 dhcp client ifconfig .......................................................................................................................................................... 96 dhcp client ifdelete.......................................................................................................................................................... 98 dhcp client iflist................................................................................................................................................................ 99 dhcp client ifrelease ......................................................................................................................................................100 dhcp client ifrenew .......................................................................................................................................................102 dhcp client stats.............................................................................................................................................................104 dhcp relay add................................................................................................................................................................105 dhcp relay config ...........................................................................................................................................................106 dhcp relay delete...........................................................................................................................................................107 dhcp relay flush..............................................................................................................................................................108 dhcp relay ifconfig .........................................................................................................................................................109 dhcp relay iflist...............................................................................................................................................................110 dhcp relay list .................................................................................................................................................................111 dhcp relay stats..............................................................................................................................................................112 dhcp server clear...........................................................................................................................................................113 dhcp server config.........................................................................................................................................................114 dhcp server flush ...........................................................................................................................................................115 dhcp server policy.........................................................................................................................................................116 dhcp server stats ...........................................................................................................................................................117 dhcp server lease add...................................................................................................................................................119 dhcp server lease delete..............................................................................................................................................121 dhcp server lease flush.................................................................................................................................................122 dhcp server lease list....................................................................................................................................................123 dhcp server pool add ...................................................................................................................................................124 dhcp server pool config ...............................................................................................................................................125 dhcp server pool delete...............................................................................................................................................127 dhcp server pool flush .................................................................................................................................................128 dhcp server pool list.....................................................................................................................................................129 7 DNS Commands .......................................................................................... 131 dns add ............................................................................................................................................................................132 dns clear ..........................................................................................................................................................................133 dns clrstats......................................................................................................................................................................134 dns delete........................................................................................................................................................................135 dns domain .....................................................................................................................................................................136 dns flush...........................................................................................................................................................................137 dns fwdadd......................................................................................................................................................................138 dns fwddelete.................................................................................................................................................................139 dns fwdlist .......................................................................................................................................................................140 dns fwdtable ...................................................................................................................................................................141 dns list..............................................................................................................................................................................142 dns nslookup ..................................................................................................................................................................143 dns start...........................................................................................................................................................................144 dns stats...........................................................................................................................................................................145 dns status ........................................................................................................................................................................146 dns stop ...........................................................................................................................................................................147 dns toutfwd ....................................................................................................................................................................148 dns troff...........................................................................................................................................................................149 dns tron...........................................................................................................................................................................150 Env Commands ............................................................................................ 151 env flush ..........................................................................................................................................................................152 env get .............................................................................................................................................................................154 env list..............................................................................................................................................................................156 env set .............................................................................................................................................................................157 env unset.........................................................................................................................................................................158 Eth Commands............................................................................................. 159 eth config.........................................................................................................................................................................160 eth ifconfig ......................................................................................................................................................................161 eth iflist ............................................................................................................................................................................162 8 ETHoA Commands ..................................................................................... 163 ethoa flush.......................................................................................................................................................................164 ethoa ifadd ......................................................................................................................................................................165 ethoa ifattach..................................................................................................................................................................166 ethoa ifconfig..................................................................................................................................................................167 ethoa ifdelete .................................................................................................................................................................169 ethoa ifdetach.................................................................................................................................................................170 ethoa iflist........................................................................................................................................................................171 Firewall Commands..................................................................................... 173 firewall assign .................................................................................................................................................................174 firewall flush....................................................................................................................................................................176 firewall list.......................................................................................................................................................................177 firewall troff....................................................................................................................................................................178 firewall tron....................................................................................................................................................................179 firewall unassign.............................................................................................................................................................180 firewall chain create......................................................................................................................................................181 firewall chain delete......................................................................................................................................................182 firewall chain flush.........................................................................................................................................................183 firewall chain list ............................................................................................................................................................184 firewall rule clear...........................................................................................................................................................185 firewall rule create........................................................................................................................................................186 firewall rule delete ........................................................................................................................................................190 firewall rule flush ...........................................................................................................................................................191 firewall rule list ..............................................................................................................................................................192 firewall rule stats ...........................................................................................................................................................193 9 IP Commands ............................................................................................... 195 ip apadd ...........................................................................................................................................................................196 ip apdelete.......................................................................................................................................................................198 ip aplist.............................................................................................................................................................................199 ip arpadd .........................................................................................................................................................................200 ip arpdelete.....................................................................................................................................................................201 ip arplist...........................................................................................................................................................................202 ip config ...........................................................................................................................................................................203 ip flush..............................................................................................................................................................................206 ip ifconfig .........................................................................................................................................................................207 ip iflist...............................................................................................................................................................................208 ip ifwait ............................................................................................................................................................................209 ip ping...............................................................................................................................................................................210 ip rtadd ............................................................................................................................................................................211 ip rtdelete .......................................................................................................................................................................212 ip rtlist..............................................................................................................................................................................213 ip sendto..........................................................................................................................................................................214 ip traceroute ..................................................................................................................................................................215 ip auto flush ....................................................................................................................................................................217 ip auto ifadd....................................................................................................................................................................218 ip auto ifattach ...............................................................................................................................................................219 ip auto ifconfig................................................................................................................................................................220 ip auto ifdelete ...............................................................................................................................................................221 ip auto ifdetach ..............................................................................................................................................................222 ip auto iflist .....................................................................................................................................................................223 IPoA Commands.......................................................................................... 225 ipoa flush .........................................................................................................................................................................226 ipoa ifadd.........................................................................................................................................................................227 ipoa ifattach ....................................................................................................................................................................228 ipoa ifconfig.....................................................................................................................................................................229 ipoa ifdelete ....................................................................................................................................................................231 ipoa ifdetach ...................................................................................................................................................................232 ipoa iflist ..........................................................................................................................................................................233 10 Label Commands ......................................................................................... 235 label add ..........................................................................................................................................................................236 label config ......................................................................................................................................................................237 label delete......................................................................................................................................................................238 label flush.........................................................................................................................................................................239 label list............................................................................................................................................................................240 label troff.........................................................................................................................................................................241 label tron.........................................................................................................................................................................242 label chain create...........................................................................................................................................................243 label chain delete...........................................................................................................................................................244 label chain flush..............................................................................................................................................................245 label chain list.................................................................................................................................................................246 label rule clear................................................................................................................................................................247 label rule create.............................................................................................................................................................248 label rule delete .............................................................................................................................................................250 label rule flush ................................................................................................................................................................251 label rule list ...................................................................................................................................................................252 label rule stats ................................................................................................................................................................253 Language Commands .................................................................................. 255 language config ...............................................................................................................................................................256 language list.....................................................................................................................................................................257 language remove............................................................................................................................................................258 11 NAT Commands .......................................................................................... 259 nat applist........................................................................................................................................................................260 nat bind............................................................................................................................................................................261 nat bindlist.......................................................................................................................................................................264 nat clear...........................................................................................................................................................................265 nat config.........................................................................................................................................................................266 nat create ........................................................................................................................................................................267 nat defserver ..................................................................................................................................................................269 nat delete ........................................................................................................................................................................270 nat disable .......................................................................................................................................................................272 nat enable........................................................................................................................................................................273 nat flush ...........................................................................................................................................................................274 nat list ..............................................................................................................................................................................275 nat multinatadd ..............................................................................................................................................................276 nat multinatdelete .........................................................................................................................................................277 nat multinatlist ...............................................................................................................................................................278 nat unbind .......................................................................................................................................................................279 Phonebook Commands ............................................................................... 281 phonebook add..............................................................................................................................................................282 phonebook autolist.......................................................................................................................................................284 phonebook delete.........................................................................................................................................................285 phonebook flush............................................................................................................................................................286 phonebook list ...............................................................................................................................................................287 PPPoA Commands ...................................................................................... 289 pppoa flush......................................................................................................................................................................290 pppoa ifadd .....................................................................................................................................................................291 pppoa ifattach.................................................................................................................................................................293 pppoa ifconfig .................................................................................................................................................................294 pppoa ifdelete.................................................................................................................................................................298 pppoa ifdetach................................................................................................................................................................299 pppoa iflist.......................................................................................................................................................................300 pppoa rtadd ....................................................................................................................................................................301 pppoa rtdelete ...............................................................................................................................................................303 12 PPPoE Commands....................................................................................... 305 pppoe flush .....................................................................................................................................................................306 pppoe ifadd .....................................................................................................................................................................307 pppoe ifattach.................................................................................................................................................................309 pppoe ifconfig.................................................................................................................................................................311 pppoe ifdelete ................................................................................................................................................................316 pppoe ifdetach ...............................................................................................................................................................317 pppoe iflist ......................................................................................................................................................................318 pppoe ifscan....................................................................................................................................................................319 pppoe relay add .............................................................................................................................................................320 pppoe relay delete ........................................................................................................................................................321 pppoe relay flush ...........................................................................................................................................................322 pppoe relay portlist ......................................................................................................................................................323 pppoe relay sesslist.......................................................................................................................................................324 pppoe rtadd....................................................................................................................................................................325 pppoe rtdelete ...............................................................................................................................................................327 PPTP Commands......................................................................................... 329 pptp ifadd ........................................................................................................................................................................330 pptp flush.........................................................................................................................................................................331 pptp list............................................................................................................................................................................332 pptp profadd...................................................................................................................................................................333 pptp profdelete..............................................................................................................................................................334 pptp proflist ....................................................................................................................................................................335 QoSBook Commands .................................................................................. 337 qosbook add...................................................................................................................................................................338 qosbook config ..............................................................................................................................................................340 qosbook delete..............................................................................................................................................................341 qosbook flush.................................................................................................................................................................342 qosbook list ....................................................................................................................................................................343 Script Commands ........................................................................................ 345 13 SNMP Commands........................................................................................ 347 snmp config.....................................................................................................................................................................348 snmp get..........................................................................................................................................................................349 snmp getNext ................................................................................................................................................................350 snmp list ..........................................................................................................................................................................351 snmp walk .......................................................................................................................................................................352 Software Commands ................................................................................... 353 software version............................................................................................................................................................354 software upgrade ..........................................................................................................................................................355 Switch Commands ....................................................................................... 357 switch group flush .........................................................................................................................................................358 switch group list ............................................................................................................................................................359 switch group move .......................................................................................................................................................360 switch mirror capture..................................................................................................................................................361 switch mirror egress ....................................................................................................................................................362 switch mirror ingress ...................................................................................................................................................363 System Commands...................................................................................... 365 system clearpassword ..................................................................................................................................................366 system config..................................................................................................................................................................367 system flush ....................................................................................................................................................................368 system reboot................................................................................................................................................................369 system reset ...................................................................................................................................................................370 system setpassword......................................................................................................................................................371 system stats ....................................................................................................................................................................372 Systemlog Commands................................................................................. 373 systemlog show .............................................................................................................................................................374 systemlog send...............................................................................................................................................................375 TD Commands ............................................................................................. 377 td call................................................................................................................................................................................378 14 UPnP Commands......................................................................................... 379 upnp config .....................................................................................................................................................................380 upnp flush........................................................................................................................................................................381 upnp list ...........................................................................................................................................................................382 USB Commands........................................................................................... 383 usb add ............................................................................................................................................................................384 usb config ........................................................................................................................................................................385 usb delete........................................................................................................................................................................386 usb info ............................................................................................................................................................................387 usb list..............................................................................................................................................................................388 Wireless Commands ................................................................................... 389 wireless aclconfig...........................................................................................................................................................390 wireless aclentry............................................................................................................................................................391 wireless aclflush .............................................................................................................................................................392 wireless acllist ................................................................................................................................................................393 wireless counters ..........................................................................................................................................................394 wireless flush ..................................................................................................................................................................395 wireless ifconfig .............................................................................................................................................................396 wireless scan ..................................................................................................................................................................397 wireless status................................................................................................................................................................398 wireless wepconfig........................................................................................................................................................399 Abbreviations ............................................................................................... 401 15 Syslog Messages............................................................................................ 405 Auto-PVC Module ........................................................................................................................................................406 Configuration Module ..................................................................................................................................................406 DHCP CLient Module .................................................................................................................................................407 DHCP Relay Module ....................................................................................................................................................407 DHCP Server Module..................................................................................................................................................408 Firewall Module .............................................................................................................................................................408 HTTP Module ................................................................................................................................................................408 Kernel Module ...............................................................................................................................................................409 Linestate Module...........................................................................................................................................................409 Login Module..................................................................................................................................................................409 NAPT Module................................................................................................................................................................409 PPP Module.....................................................................................................................................................................410 PPTP Module..................................................................................................................................................................410 Routing Module .............................................................................................................................................................410 Software Module ...........................................................................................................................................................411 UPnP Module .................................................................................................................................................................411 Supported Key Names ................................................................................ 413 Supported Internet Protocol (IP) Protocol Names ..............................................................................................413 Supported TCP/UDP Port Names............................................................................................................................414 Supported ICMP Type Names ...................................................................................................................................417 Supported Syslog Facilities ..........................................................................................................................................418 Supported Syslog Severities........................................................................................................................................419 16 About this Document 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 Digital Subscriber Line (DSL) SpeedTouchTM products: · · · · · SpeedTouchTM510 ADSL/POTS SpeedTouchTM510i ADSL/ISDN SpeedTouchTM530 SpeedTouchTM570 Wireless SpeedTouchTM570i Wireless Contents The Reference Guide consists of two main parts: · CLI Navigation This chapter familiarises the user 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-20030410-0049 v1.0 17 About this Document 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 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 upgraded. For more information on the latest technological innovations, software upgrades, and documents, please visit the SpeedTouchTM web site at: www.speedtouch.com 18 E-SIT-CTC-20030410-0049 v1.0 CLI Navigation CLI Navigation 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 Configuration Profile Files and the CLI Page 20 21 25 26 27 28 E-SIT-CTC-20030410-0049 v1.0 19 CLI Navigation 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.2.0.15.0 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2003, * // /\ /\ \ THOMSON * _______//_______/ \ / _\/______ * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * -----------------------------------------------------------------------=> 20 E-SIT-CTC-20030410-0049 v1.0