User manual ALCATEL-LUCENT SPEEDTOUCH 580 - 3

SpeedTouchTM580 Wireless Multi-User ADSL Gateways CLI Reference Guide Release R4.2.7 500 SERIES SpeedTouchTM 580 CLI Reference Guide Release R4.2.7 Status Reference Short Title Copyright v1.0 E-DOC-CTC-20040216-0003 CLI ST580 R4.2.7 © 2004 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 .................................................................................... 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 ADSL Commands .......................................................................................... 33 adsl config ......................................................................................................................................................................... 34 adsl info ............................................................................................................................................................................. 35 ATM Commands............................................................................................ 37 atm oam ccconfig ............................................................................................................................................................ 38 atm oam cclist.................................................................................................................................................................. 39 atm oam ccsend............................................................................................................................................................... 40 atm oam config ................................................................................................................................................................ 41 atm oam mode................................................................................................................................................................. 42 atm oam ping.................................................................................................................................................................... 43 atm oam status ................................................................................................................................................................ 44 AutoPVC Commands .................................................................................... 45 autopvc config .................................................................................................................................................................. 46 autopvc info...................................................................................................................................................................... 48 E-DOC-CTC-20040216-0003 v1.0 3 Bridge Commands ......................................................................................... 49 bridge config ..................................................................................................................................................................... 50 bridge flush ....................................................................................................................................................................... 51 bridge ifadd ....................................................................................................................................................................... 52 bridge ifattach................................................................................................................................................................... 53 bridge ifconfig................................................................................................................................................................... 54 bridge ifdelete .................................................................................................................................................................. 56 bridge ifdetach ................................................................................................................................................................. 57 bridge iflist ........................................................................................................................................................................ 58 bridge macadd.................................................................................................................................................................. 60 bridge macdelete ............................................................................................................................................................. 61 bridge maclist ................................................................................................................................................................... 62 bridge mcdadd ................................................................................................................................................................. 63 bridge mcddelete............................................................................................................................................................. 64 bridge mcdlist................................................................................................................................................................... 65 CIP Commands .............................................................................................. 67 cip flush.............................................................................................................................................................................. 68 cip ifadd ............................................................................................................................................................................. 69 cip ifdelete......................................................................................................................................................................... 70 cip iflist............................................................................................................................................................................... 71 cip pvcadd ......................................................................................................................................................................... 72 cip pvcdelete .................................................................................................................................................................... 73 cip pvclist........................................................................................................................................................................... 74 Config Commands ......................................................................................... 75 config backup.................................................................................................................................................................... 76 config dump ...................................................................................................................................................................... 77 config erase....................................................................................................................................................................... 78 config flush ........................................................................................................................................................................ 79 config list ........................................................................................................................................................................... 80 config load......................................................................................................................................................................... 81 config save......................................................................................................................................................................... 83 4 E-DOC-CTC-20040216-0003 v1.0 DHCP Commands ......................................................................................... 85 dhcp client clear .............................................................................................................................................................. 87 dhcp client config ............................................................................................................................................................ 88 dhcp client flush............................................................................................................................................................... 89 dhcp client ifadd............................................................................................................................................................... 90 dhcp client ifattach.......................................................................................................................................................... 91 dhcp client ifconfig .......................................................................................................................................................... 92 dhcp client ifdelete.......................................................................................................................................................... 94 dhcp client iflist................................................................................................................................................................ 95 dhcp client ifrelease ........................................................................................................................................................ 96 dhcp client ifrenew ......................................................................................................................................................... 98 dhcp client stats.............................................................................................................................................................100 dhcp relay add................................................................................................................................................................101 dhcp relay config ...........................................................................................................................................................102 dhcp relay delete...........................................................................................................................................................103 dhcp relay flush..............................................................................................................................................................104 dhcp relay ifconfig .........................................................................................................................................................105 dhcp relay iflist...............................................................................................................................................................106 dhcp relay list .................................................................................................................................................................107 dhcp relay stats..............................................................................................................................................................108 dhcp server clear...........................................................................................................................................................109 dhcp server config.........................................................................................................................................................110 dhcp server flush ...........................................................................................................................................................111 dhcp server policy.........................................................................................................................................................112 dhcp server stats ...........................................................................................................................................................113 dhcp server lease add...................................................................................................................................................115 dhcp server lease delete..............................................................................................................................................117 dhcp server lease flush.................................................................................................................................................118 dhcp server lease list....................................................................................................................................................119 dhcp server pool add ...................................................................................................................................................120 dhcp server pool config ...............................................................................................................................................121 dhcp server pool delete...............................................................................................................................................123 dhcp server pool flush .................................................................................................................................................124 dhcp server pool list.....................................................................................................................................................125 E-DOC-CTC-20040216-0003 v1.0 5 DNS Commands .......................................................................................... 127 dns add ............................................................................................................................................................................128 dns clear ..........................................................................................................................................................................129 dns clrstats......................................................................................................................................................................130 dns delete........................................................................................................................................................................131 dns domain .....................................................................................................................................................................132 dns flush...........................................................................................................................................................................133 dns fwdadd......................................................................................................................................................................134 dns fwddelete.................................................................................................................................................................135 dns fwdlist .......................................................................................................................................................................136 dns fwdtable ...................................................................................................................................................................137 dns list..............................................................................................................................................................................138 dns nslookup ..................................................................................................................................................................139 dns start...........................................................................................................................................................................140 dns stats...........................................................................................................................................................................141 dns status ........................................................................................................................................................................142 dns stop ...........................................................................................................................................................................143 dns toutfwd ....................................................................................................................................................................144 dns troff...........................................................................................................................................................................145 dns tron...........................................................................................................................................................................146 Env Commands ............................................................................................ 147 env flush ..........................................................................................................................................................................148 env get .............................................................................................................................................................................149 env list..............................................................................................................................................................................150 env set .............................................................................................................................................................................151 env unset.........................................................................................................................................................................152 Eth Commands............................................................................................. 153 eth config.........................................................................................................................................................................154 eth ifconfig ......................................................................................................................................................................155 eth iflist ............................................................................................................................................................................156 6 E-DOC-CTC-20040216-0003 v1.0 ETHoA Commands ..................................................................................... 157 ethoa flush.......................................................................................................................................................................158 ethoa ifadd ......................................................................................................................................................................159 ethoa ifattach..................................................................................................................................................................160 ethoa ifconfig..................................................................................................................................................................161 ethoa ifdelete .................................................................................................................................................................163 ethoa ifdetach.................................................................................................................................................................164 ethoa iflist........................................................................................................................................................................165 Firewall Commands..................................................................................... 167 firewall assign .................................................................................................................................................................168 firewall flush....................................................................................................................................................................170 firewall list.......................................................................................................................................................................171 firewall troff....................................................................................................................................................................172 firewall tron....................................................................................................................................................................173 firewall unassign.............................................................................................................................................................174 firewall chain create......................................................................................................................................................175 firewall chain delete......................................................................................................................................................176 firewall chain flush.........................................................................................................................................................177 firewall chain list ............................................................................................................................................................178 firewall rule clear...........................................................................................................................................................179 firewall rule create........................................................................................................................................................180 firewall rule delete ........................................................................................................................................................184 firewall rule flush ...........................................................................................................................................................185 firewall rule list ..............................................................................................................................................................186 firewall rule stats ...........................................................................................................................................................187 E-DOC-CTC-20040216-0003 v1.0 7 IP Commands ............................................................................................... 189 ip apadd ...........................................................................................................................................................................190 ip apdelete.......................................................................................................................................................................192 ip aplist.............................................................................................................................................................................193 ip arpadd .........................................................................................................................................................................194 ip arpdelete.....................................................................................................................................................................195 ip arplist...........................................................................................................................................................................196 ip config ...........................................................................................................................................................................197 ip flush..............................................................................................................................................................................200 ip ifconfig .........................................................................................................................................................................201 ip iflist...............................................................................................................................................................................202 ip ifwait ............................................................................................................................................................................203 ip mcadd ..........................................................................................................................................................................204 ip mcdelete .....................................................................................................................................................................205 ip mclist ...........................................................................................................................................................................206 ip ping...............................................................................................................................................................................207 ip rtadd ............................................................................................................................................................................208 ip rtdelete .......................................................................................................................................................................209 ip rtlist..............................................................................................................................................................................210 ip sendto..........................................................................................................................................................................211 ip traceroute ..................................................................................................................................................................212 ip auto flush ....................................................................................................................................................................213 ip auto ifadd....................................................................................................................................................................214 ip auto ifattach ...............................................................................................................................................................215 ip auto ifconfig................................................................................................................................................................216 ip auto ifdelete ...............................................................................................................................................................217 ip auto ifdetach ..............................................................................................................................................................218 ip auto iflist .....................................................................................................................................................................219 IPoA Commands.......................................................................................... 221 ipoa flush .........................................................................................................................................................................222 ipoa ifadd.........................................................................................................................................................................223 ipoa ifattach ....................................................................................................................................................................224 ipoa ifconfig.....................................................................................................................................................................225 ipoa ifdelete ....................................................................................................................................................................227 ipoa ifdetach ...................................................................................................................................................................228 ipoa iflist ..........................................................................................................................................................................229 8 E-DOC-CTC-20040216-0003 v1.0 Label Commands ......................................................................................... 231 label add ..........................................................................................................................................................................232 label config ......................................................................................................................................................................233 label delete......................................................................................................................................................................235 label flush.........................................................................................................................................................................236 label list............................................................................................................................................................................237 label troff.........................................................................................................................................................................238 label tron.........................................................................................................................................................................239 label chain create...........................................................................................................................................................240 label chain delete...........................................................................................................................................................241 label chain flush..............................................................................................................................................................242 label chain list.................................................................................................................................................................243 label rule clear................................................................................................................................................................244 label rule create.............................................................................................................................................................245 label rule delete .............................................................................................................................................................248 label rule flush ................................................................................................................................................................249 label rule list ...................................................................................................................................................................250 label rule stats ................................................................................................................................................................251 Language Commands .................................................................................. 253 language config ...............................................................................................................................................................254 language list.....................................................................................................................................................................255 language remove............................................................................................................................................................256 E-DOC-CTC-20040216-0003 v1.0 9 NAT Commands .......................................................................................... 257 nat applist........................................................................................................................................................................258 nat bind............................................................................................................................................................................259 nat bindlist.......................................................................................................................................................................260 nat clear...........................................................................................................................................................................262 nat config.........................................................................................................................................................................263 nat create ........................................................................................................................................................................264 nat defserver ..................................................................................................................................................................266 nat delete ........................................................................................................................................................................267 nat disable .......................................................................................................................................................................269 nat enable........................................................................................................................................................................270 nat flush ...........................................................................................................................................................................272 nat list ..............................................................................................................................................................................273 nat multinatadd ..............................................................................................................................................................274 nat multinatdelete .........................................................................................................................................................275 nat multinatlist ...............................................................................................................................................................276 nat unbind .......................................................................................................................................................................277 Phonebook Commands ............................................................................... 279 phonebook add..............................................................................................................................................................280 phonebook autolist.......................................................................................................................................................282 phonebook delete.........................................................................................................................................................283 phonebook flush............................................................................................................................................................284 phonebook list ...............................................................................................................................................................285 PPPoA Commands ...................................................................................... 287 pppoa flush......................................................................................................................................................................288 pppoa ifadd .....................................................................................................................................................................289 pppoa ifattach.................................................................................................................................................................291 pppoa ifconfig .................................................................................................................................................................292 pppoa ifdelete.................................................................................................................................................................296 pppoa ifdetach................................................................................................................................................................297 pppoa iflist.......................................................................................................................................................................298 pppoa rtadd ....................................................................................................................................................................299 pppoa rtdelete ...............................................................................................................................................................301 10 E-DOC-CTC-20040216-0003 v1.0 PPPoE Commands....................................................................................... 303 pppoe flush .....................................................................................................................................................................304 pppoe ifadd .....................................................................................................................................................................305 pppoe ifattach.................................................................................................................................................................307 pppoe ifconfig.................................................................................................................................................................308 pppoe ifdelete ................................................................................................................................................................312 pppoe ifdetach ...............................................................................................................................................................313 pppoe iflist ......................................................................................................................................................................314 pppoe ifscan....................................................................................................................................................................315 pppoe rtadd....................................................................................................................................................................316 pppoe rtdelete ...............................................................................................................................................................318 pppoe relay add .............................................................................................................................................................319 pppoe relay delete ........................................................................................................................................................320 pppoe relay flush ...........................................................................................................................................................321 pppoe relay portlist ......................................................................................................................................................322 pppoe relay sesslist.......................................................................................................................................................323 PPTP Commands......................................................................................... 325 pptp ifadd ........................................................................................................................................................................326 pptp flush.........................................................................................................................................................................327 pptp list............................................................................................................................................................................328 pptp profadd...................................................................................................................................................................329 pptp profdelete..............................................................................................................................................................331 pptp proflist ....................................................................................................................................................................332 QoSBook Commands .................................................................................. 333 qosbook add...................................................................................................................................................................334 qosbook config ..............................................................................................................................................................336 qosbook delete..............................................................................................................................................................337 qosbook flush.................................................................................................................................................................338 qosbook list ....................................................................................................................................................................339 Script Commands ........................................................................................ 341 script add ........................................................................................................................................................................342 script delete....................................................................................................................................................................343 script flush.......................................................................................................................................................................344 script list..........................................................................................................................................................................345 script run.........................................................................................................................................................................346 E-DOC-CTC-20040216-0003 v1.0 11 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 flush...............................................................................................................................................................374 systemlog show .............................................................................................................................................................375 systemlog send...............................................................................................................................................................377 TD Commands ............................................................................................. 379 td call................................................................................................................................................................................380 12 E-DOC-CTC-20040216-0003 v1.0 UPnP Commands......................................................................................... 381 upnp config .....................................................................................................................................................................382 upnp flush........................................................................................................................................................................384 upnp list ...........................................................................................................................................................................385 Wireless Commands ................................................................................... 387 wireless debug stats......................................................................................................................................................388 wireless ifconfig .............................................................................................................................................................389 wireless macacl add ......................................................................................................................................................391 wireless macacl config..................................................................................................................................................392 wireless macacl delete .................................................................................................................................................393 wireless macacl flush ....................................................................................................................................................394 wireless macacl list .......................................................................................................................................................395 wireless macacl modify ................................................................................................................................................396 wireless macacl register...............................................................................................................................................397 wireless reset .................................................................................................................................................................398 wireless secmode config..............................................................................................................................................400 wireless secmode wep.................................................................................................................................................401 wireless secmode wpa-psk .........................................................................................................................................402 wireless stations list......................................................................................................................................................403 Abbreviations ............................................................................................... 405 E-DOC-CTC-20040216-0003 v1.0 13 Syslog Messages............................................................................................ 409 Auto-PVC Module ........................................................................................................................................................410 Configuration Module ..................................................................................................................................................410 DHCP CLient Module .................................................................................................................................................411 DHCP Relay Module ....................................................................................................................................................411 DHCP Server Module..................................................................................................................................................412 Firewall Module .............................................................................................................................................................412 HTTP Module ................................................................................................................................................................412 Kernel Module ...............................................................................................................................................................413 Linestate Module...........................................................................................................................................................413 Login Module..................................................................................................................................................................413 NAPT Module................................................................................................................................................................413 PPP Module.....................................................................................................................................................................414 PPTP Module..................................................................................................................................................................414 Routing Module .............................................................................................................................................................414 Software Module ...........................................................................................................................................................415 UPnP Module .................................................................................................................................................................415 Supported Key Names ................................................................................ 417 Supported Internet Protocol (IP) Protocol Names ..............................................................................................417 Supported TCP/UDP Port Names............................................................................................................................418 Supported ICMP Type Names ...................................................................................................................................421 Supported Syslog Facilities ..........................................................................................................................................422 Supported Syslog Severities........................................................................................................................................423 14 E-DOC-CTC-20040216-0003 v1.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: · SpeedTouchTM580 Wireless Multi-User ADSL Gateway (R4.2.7) 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-0003 v1.0 15 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 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-0003 v1.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-0003 v1.0 17 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 SpeedTouchTM. 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 SpeedTouchTM580 banner after opening a session and authentication. Username : johndoe Password : ******* -----------------------------------------------------------------------* * ______ SpeedTouch 580 * ___/_____/\ * / /\\ Version 4.2.7.5.7 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2003, * // /\ /\ \ THOMSON * _______//_______/ \ / _\/______ * / /\ \ / // /\ * __/ / \ \/ // / _\__ * // / \_______\/ // // /\ * /_/______/___________________/ /________/ /___/ \ *\\ \ ___________ \\ \\ \/ * \_\ \/ /\ \\ \ \___\/ * \ \/ /\ \\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \/ * \ _____ \ /_____\/ * \/ /\ \ /___\/ * /____/ \ \ / * \ \ /___\/ * \____\/ * -----------------------------------------------------------------------=> 18 E-DOC-CTC-20040216-0003 v1.0