THOMSON SpeedTouch 516 User manual

SpeedTouchTM
516/536/546/510v5/530v5
Multi-User ADSL Gateways
CLI Reference Guide
Release R5.2.7

SpeedTouchTM
516/536/546
510v5/530v5
CLI Reference Guide
R5.2.7

Copyright
Copyright ©1999-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.
Thomson Telecom Belgium
Prins Boudewijnlaan, 47
B-2650 Edegem
Belgium
www.speedtouch.com
Trademarks
The following trademarks are used in this document:
SpeedTouchTM is a trademark of THOMSON.
Microsoft, MS-DOS, Windows, Windows NT and Internet Explorer are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
UNIX is a registered trademark of UNIX System Laboratories, Incorporated.
Apple and Mac OS are trademarks of Apple Computer, Incorporated, registered in the United States and other countries.
Adobe, the Adobe logo, Acrobat and Acrobat Reader are trademarks or registered trademarks of Adobe Systems, Incorpo-
rated, registered in the United States and/or other countries.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
Ethernet is a trademark of Xerox Corporation.
"Wi-Fi" and the Wi-Fi logo are registered trademarks of the Wi-Fi Alliance. "Wi-Fi CERTIFIED", "Wi-Fi ZONE", "Wi-Fi Alli-
ance", their respective logos and "Wi-Fi Protected Access" are trademarks of the Wi-Fi Alliance.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Document Information
Status: v1.0 (October 2004)
Reference: E-DOC-CTC-20040907-0010
Short Title: CLI Reference Guide ST516/536/546/510v5/530v5 R5.2.7

Contents
E-DOC-CTC-20040907-0010 v1.0 3
Contents
About this Document .................................................................................. 15
CLI Navigation.............................................................................................. 17
Accessing the Command Line Interface................................................................................................... 18
Basic Navigation and Manipulation.......................................................................................................... 19
Command Line Interface Commands....................................................................................................... 22
Menu-driven CLI Navigation ..................................................................................................................... 23
Direct FTP Access ....................................................................................................................................... 27
ADSL Commands......................................................................................... 29
adsl config................................................................................................................................................... 30
adsl info....................................................................................................................................................... 31
ATM Commands .......................................................................................... 33
atm oam ccconfig....................................................................................................................................... 34
atm oam cclist ............................................................................................................................................ 35
atm oam ccsend ......................................................................................................................................... 36
atm oam config .......................................................................................................................................... 37
atm oam mode ........................................................................................................................................... 38
atm oam ping ............................................................................................................................................. 39
atm oam status........................................................................................................................................... 40
AutoPVC Commands................................................................................... 41
autopvc config............................................................................................................................................ 42
autopvc info................................................................................................................................................ 44
Bridge Commands ....................................................................................... 45
bridge config............................................................................................................................................... 46
bridge flush................................................................................................................................................. 47
bridge ifadd................................................................................................................................................. 48
bridge ifattach............................................................................................................................................. 49
bridge ifconfig ............................................................................................................................................ 50
bridge ifdelete............................................................................................................................................. 52
bridge ifdetach............................................................................................................................................ 53
bridge iflist.................................................................................................................................................. 54
bridge macadd............................................................................................................................................ 55
bridge macdelete........................................................................................................................................ 56
bridge maclist............................................................................................................................................. 57

Contents
E-DOC-CTC-20040907-0010 v1.0
4
CIP Commands............................................................................................. 59
cip flush....................................................................................................................................................... 60
cip ifadd....................................................................................................................................................... 61
cip ifdelete................................................................................................................................................... 62
cip iflist........................................................................................................................................................ 63
cip pvcadd................................................................................................................................................... 64
cip pvcdelete............................................................................................................................................... 65
cip pvclist .................................................................................................................................................... 66
Config Commands ....................................................................................... 67
config backup ............................................................................................................................................. 68
config dump................................................................................................................................................ 69
config erase ................................................................................................................................................ 70
config flush ................................................................................................................................................. 71
config list..................................................................................................................................................... 72
config load .................................................................................................................................................. 73
config save.................................................................................................................................................. 74

Contents
E-DOC-CTC-20040907-0010 v1.0 5
DHCP Commands......................................................................................... 75
dhcp client clear ......................................................................................................................................... 76
dhcp client config....................................................................................................................................... 77
dhcp client flush ......................................................................................................................................... 78
dhcp client ifadd......................................................................................................................................... 79
dhcp client ifattach..................................................................................................................................... 80
dhcp client ifconfig..................................................................................................................................... 81
dhcp client ifdelete ..................................................................................................................................... 83
dhcp client iflist .......................................................................................................................................... 84
dhcp client ifrelease ................................................................................................................................... 85
dhcp client ifrenew..................................................................................................................................... 87
dhcp client stats.......................................................................................................................................... 89
dhcp relay add............................................................................................................................................ 90
dhcp relay config........................................................................................................................................ 91
dhcp relay delete........................................................................................................................................ 92
dhcp relay flush.......................................................................................................................................... 93
dhcp relay ifconfig...................................................................................................................................... 94
dhcp relay iflist ........................................................................................................................................... 95
dhcp relay list ............................................................................................................................................. 96
dhcp relay stats .......................................................................................................................................... 97
dhcp server clear........................................................................................................................................ 98
dhcp server config...................................................................................................................................... 99
dhcp server flush...................................................................................................................................... 100
dhcp server policy.................................................................................................................................... 101
dhcp server stats ...................................................................................................................................... 102
dhcp server lease add.............................................................................................................................. 104
dhcp server lease delete.......................................................................................................................... 105
dhcp server lease flush............................................................................................................................ 106
dhcp server lease list ............................................................................................................................... 107
dhcp server pool add ............................................................................................................................... 108
dhcp server pool config........................................................................................................................... 109
dhcp server pool delete ........................................................................................................................... 111
dhcp server pool flush ............................................................................................................................. 112
dhcp server pool list................................................................................................................................. 113

Contents
E-DOC-CTC-20040907-0010 v1.0
6
DNS Commands......................................................................................... 115
dns add...................................................................................................................................................... 116
dns clear.................................................................................................................................................... 117
dns clrstats................................................................................................................................................ 118
dns delete.................................................................................................................................................. 119
dns domain............................................................................................................................................... 120
dns flush.................................................................................................................................................... 121
dns fwdadd ............................................................................................................................................... 122
dns fwddelete ........................................................................................................................................... 123
dns fwdlist................................................................................................................................................. 124
dns fwdtable ............................................................................................................................................. 125
dns list....................................................................................................................................................... 126
dns nslookup ............................................................................................................................................ 127
dns start .................................................................................................................................................... 128
dns stats.................................................................................................................................................... 129
dns status.................................................................................................................................................. 130
dns stop..................................................................................................................................................... 131
dns toutfwd............................................................................................................................................... 132
dns troff..................................................................................................................................................... 133
dns tron..................................................................................................................................................... 134
Env Commands .......................................................................................... 135
env flush.................................................................................................................................................... 136
env get....................................................................................................................................................... 137
env list....................................................................................................................................................... 138
env set....................................................................................................................................................... 139
env unset................................................................................................................................................... 140
Eth Commands........................................................................................... 141
eth config .................................................................................................................................................. 142
eth ifconfig................................................................................................................................................ 143
eth iflist...................................................................................................................................................... 144
ETHoA Commands..................................................................................... 145
ethoa flush ................................................................................................................................................ 146
ethoa ifadd................................................................................................................................................ 147
ethoa ifattach............................................................................................................................................ 148
ethoa ifconfig............................................................................................................................................ 149
ethoa ifdelete............................................................................................................................................ 150
ethoa ifdetach........................................................................................................................................... 151
ethoa iflist ................................................................................................................................................. 152

Contents
E-DOC-CTC-20040907-0010 v1.0 7
Firewall Commands................................................................................... 153
firewall assign........................................................................................................................................... 154
firewall flush ............................................................................................................................................. 155
firewall list................................................................................................................................................. 156
firewall troff .............................................................................................................................................. 157
firewall tron............................................................................................................................................... 158
firewall unassign ...................................................................................................................................... 159
firewall chain create................................................................................................................................. 160
firewall chain delete................................................................................................................................. 161
firewall chain flush................................................................................................................................... 162
firewall chain list ...................................................................................................................................... 163
firewall rule clear...................................................................................................................................... 164
firewall rule create.................................................................................................................................... 165
firewall rule delete.................................................................................................................................... 168
firewall rule flush...................................................................................................................................... 169
firewall rule list......................................................................................................................................... 170
firewall rule stats...................................................................................................................................... 171

Contents
E-DOC-CTC-20040907-0010 v1.0
8
IP Commands ............................................................................................. 173
ip apadd .................................................................................................................................................... 174
ip apdelete ................................................................................................................................................ 176
ip aplist...................................................................................................................................................... 177
ip arpadd................................................................................................................................................... 178
ip arpdelete............................................................................................................................................... 179
ip arplist .................................................................................................................................................... 180
ip config .................................................................................................................................................... 181
ip flush....................................................................................................................................................... 184
ip ifconfig .................................................................................................................................................. 185
ip iflist........................................................................................................................................................ 186
ip ifwait...................................................................................................................................................... 187
ip mcadd ................................................................................................................................................... 188
ip mcdelete ............................................................................................................................................... 189
ip mclist..................................................................................................................................................... 190
ip ping ....................................................................................................................................................... 191
ip rtadd...................................................................................................................................................... 192
ip rtdelete.................................................................................................................................................. 193
ip rtlist ....................................................................................................................................................... 194
ip sendto ................................................................................................................................................... 195
ip traceroute.............................................................................................................................................. 196
ip auto flush.............................................................................................................................................. 198
ip auto ifadd.............................................................................................................................................. 199
ip auto ifattach.......................................................................................................................................... 200
ip auto ifconfig.......................................................................................................................................... 201
ip auto ifdelete.......................................................................................................................................... 202
ip auto ifdetach......................................................................................................................................... 203
ip auto iflist ............................................................................................................................................... 204
IPoA Commands ........................................................................................ 205
ipoa flush .................................................................................................................................................. 206
ipoa ifadd .................................................................................................................................................. 207
ipoa ifattach .............................................................................................................................................. 208
ipoa ifconfig.............................................................................................................................................. 209
ipoa ifdelete .............................................................................................................................................. 210
ipoa ifdetach ............................................................................................................................................. 211
ipoa iflist.................................................................................................................................................... 212

Contents
E-DOC-CTC-20040907-0010 v1.0 9
IPQoS Commands...................................................................................... 213
ipqos config .............................................................................................................................................. 214
ipqos list.................................................................................................................................................... 216
ipqos queue clear..................................................................................................................................... 217
ipqos queue config................................................................................................................................... 218
ipqos queue list ........................................................................................................................................ 220
ipqos queue stats ..................................................................................................................................... 221
Label Commands ....................................................................................... 223
label add.................................................................................................................................................... 224
label config ............................................................................................................................................... 225
label delete................................................................................................................................................ 227
label flush.................................................................................................................................................. 228
label list..................................................................................................................................................... 229
label troff................................................................................................................................................... 230
label tron................................................................................................................................................... 231
label chain create ..................................................................................................................................... 232
label chain delete ..................................................................................................................................... 233
label chain flush ....................................................................................................................................... 234
label chain list........................................................................................................................................... 235
label rule clear .......................................................................................................................................... 236
label rule create........................................................................................................................................ 237
label rule delete........................................................................................................................................ 239
label rule flush.......................................................................................................................................... 240
label rule list ............................................................................................................................................. 241
label rule stats .......................................................................................................................................... 242
Language Commands................................................................................ 243
language config........................................................................................................................................ 244
language list ............................................................................................................................................. 245
language remove ..................................................................................................................................... 246

Contents
E-DOC-CTC-20040907-0010 v1.0
10
NAT Commands......................................................................................... 247
nat applist ................................................................................................................................................. 248
nat bind ..................................................................................................................................................... 249
nat bindlist ................................................................................................................................................ 250
nat clear..................................................................................................................................................... 251
nat config .................................................................................................................................................. 252
nat create .................................................................................................................................................. 253
nat defserver............................................................................................................................................. 254
nat delete .................................................................................................................................................. 255
nat disable................................................................................................................................................. 256
nat enable ................................................................................................................................................. 257
nat flush .................................................................................................................................................... 258
nat list........................................................................................................................................................ 259
nat multinatadd ........................................................................................................................................ 260
nat multinatdelete .................................................................................................................................... 261
nat multinatlist.......................................................................................................................................... 262
nat unbind................................................................................................................................................. 263
Phonebook Commands ............................................................................. 265
phonebook add......................................................................................................................................... 266
phonebook delete..................................................................................................................................... 267
phonebook flush....................................................................................................................................... 268
phonebook list.......................................................................................................................................... 269
PPPoA Commands ..................................................................................... 271
pppoa flush............................................................................................................................................... 272
pppoa ifadd............................................................................................................................................... 273
pppoa ifattach........................................................................................................................................... 274
pppoa ifconfig........................................................................................................................................... 275
pppoa ifdelete........................................................................................................................................... 279
pppoa ifdetach.......................................................................................................................................... 280
pppoa iflist ................................................................................................................................................ 281
pppoa rtadd .............................................................................................................................................. 282
pppoa rtdelete .......................................................................................................................................... 284

Contents
E-DOC-CTC-20040907-0010 v1.0 11
PPPoE Commands ..................................................................................... 285
pppoe flush............................................................................................................................................... 286
pppoe ifadd............................................................................................................................................... 287
pppoe ifattach........................................................................................................................................... 288
pppoe ifconfig........................................................................................................................................... 289
pppoe ifdelete........................................................................................................................................... 293
pppoe ifdetach.......................................................................................................................................... 294
pppoe iflist ................................................................................................................................................ 295
pppoe ifscan ............................................................................................................................................. 296
pppoe rtadd .............................................................................................................................................. 297
pppoe rtdelete .......................................................................................................................................... 299
pppoe relay add........................................................................................................................................ 300
pppoe relay delete.................................................................................................................................... 301
pppoe relay flush...................................................................................................................................... 302
pppoe relay portlist.................................................................................................................................. 303
pppoe relay sesslist.................................................................................................................................. 304
PPTP Commands........................................................................................ 305
pptp flush.................................................................................................................................................. 306
pptp ifadd.................................................................................................................................................. 307
pptp list ..................................................................................................................................................... 308
pptp profadd............................................................................................................................................. 309
pptp profdelete......................................................................................................................................... 310
pptp proflist .............................................................................................................................................. 311
QoSBook Commands ................................................................................ 313
qosbook add ............................................................................................................................................. 314
qosbook config......................................................................................................................................... 316
qosbook delete ......................................................................................................................................... 317
qosbook flush ........................................................................................................................................... 318
qosbook list............................................................................................................................................... 319
Script Commands ...................................................................................... 321
script add .................................................................................................................................................. 322
script delete .............................................................................................................................................. 323
script flush ................................................................................................................................................ 324
script list.................................................................................................................................................... 325
script run................................................................................................................................................... 326

Contents
E-DOC-CTC-20040907-0010 v1.0
12
SNMP Commands...................................................................................... 327
snmp config.............................................................................................................................................. 328
snmp get ................................................................................................................................................... 329
snmp getNext ........................................................................................................................................... 330
snmp list.................................................................................................................................................... 331
snmp walk................................................................................................................................................. 332
Software Commands................................................................................. 333
software version....................................................................................................................................... 334
software upgrade ..................................................................................................................................... 335
Switch Commands .................................................................................... 337
switch group flush.................................................................................................................................... 338
switch group list....................................................................................................................................... 339
switch group move .................................................................................................................................. 340
switch mirror capture............................................................................................................................... 341
switch mirror egress ................................................................................................................................ 342
switch mirror ingress............................................................................................................................... 343
System Commands ................................................................................... 345
system clearpassword ............................................................................................................................. 346
system config ........................................................................................................................................... 347
system flush.............................................................................................................................................. 348
system reboot........................................................................................................................................... 349
system reset.............................................................................................................................................. 350
system setpassword ................................................................................................................................ 351
system stats.............................................................................................................................................. 352
Systemlog Commands .............................................................................. 353
systemlog flush ........................................................................................................................................ 354
systemlog show ....................................................................................................................................... 355
systemlog send ........................................................................................................................................ 356
TD Commands............................................................................................ 357
td call......................................................................................................................................................... 358
UPnP Commands ....................................................................................... 359
upnp config............................................................................................................................................... 360
upnp flush................................................................................................................................................. 361
upnp list .................................................................................................................................................... 362

Contents
E-DOC-CTC-20040907-0010 v1.0 13
Abbreviations ............................................................................................. 363
Syslog Messages ....................................................................................... 367
Auto-PVC Module..................................................................................................................................... 368
Configuration Module.............................................................................................................................. 368
DHCP CLient Module................................................................................................................................ 368
DHCP Relay Module................................................................................................................................. 369
DHCP Server Module ............................................................................................................................... 369
Firewall Module........................................................................................................................................ 370
HTTP Module............................................................................................................................................ 370
Kernel Module .......................................................................................................................................... 370
Linestate Module...................................................................................................................................... 370
Login Module............................................................................................................................................ 371
NAPT Module ........................................................................................................................................... 371
PPP Module............................................................................................................................................... 371
PPTP Module ............................................................................................................................................ 372
Routing Module........................................................................................................................................ 372
Software Module...................................................................................................................................... 372
UPnP Module............................................................................................................................................ 372
Supported Key Names .............................................................................. 373
Supported IP Protocol Names................................................................................................................. 374
Supported TCP/UDP Port Names............................................................................................................ 375
Supported ICMP Type Names................................................................................................................. 378
Supported Syslog Facilities..................................................................................................................... 379
Supported Syslog Severities................................................................................................................... 380

Contents
E-DOC-CTC-20040907-0010 v1.0
14

E-DOC-CTC-20040907-0010 v1.0 15
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:
SpeedTouchTM516(i) Multi-User ADSL Gateway (R5.2.7)
SpeedTouchTM536(i) Multi-User ADSL Gateway (R5.2.7)
SpeedTouchTM546(i) Multi-User ADSL Gateway (R5.2.7)
SpeedTouchTM510v5(i) Multi-User ADSL Gateway (R5.2.7)
SpeedTouchTM530v5(i) Multi-User ADSL Gateway (R5.2.7)
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.
For readability, all are referred to as SpeedTouchTM throughout this document unless a specific variant is
concerned.

E-DOC-CTC-20040907-0010 v1.0
16
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.
Symbols
The following symbols are used in this CLI Reference Guide:
Conventions
The following conventions are used to present the CLI commands:
Vertical bars (|) separate alternative, mutually exclusive, elements.
Square brackets [] indicate optional elements.
Braces {} indicate a required choice.
Braces within square brackets [{}] indicate a required choice within an optional element.
<string> indicates that an alphanumerical string without blanks must be used.
<quoted string> indicates that an alphanumerical string with blanks can be used. The string must be
enclosed in quotes “.
Interactive input is shown in a bold font.
Interactive output is shown in this font.
Comments are added in italics. Example:
Documentation and software updates
THOMSON continuously develops new solutions, but is also committed to improve its existing products.
For more information on THOMSON's latest technological innovations, documents and software releases, visit us
at:
www.speedtouch.com
A note provides additional information about a topic.
A tip provides an alternative method or shortcut to perform an action.
!A caution warns you about potential problems or specific precautions that need to be taken.
=>language list
CODE LANGUAGE VERSION FILENAME
en* english 4.2.0.1 <system> In this example only one language is available

CLI Navigation
E-DOC-CTC-20040907-0010 v1.0 17
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:
Accessing the Command Line Interface 18
Basic Navigation and Manipulation 19
Command Line Interface Commands 22
Menu-driven CLI Navigation 23
Direct FTP Access 27

CLI Navigation
E-DOC-CTC-20040907-0010 v1.0
18
Accessing the Command Line Interface
Proceed as follows to open a Telnet session:
1Open a Command Prompt window, for example by clicking Start > All Programs > Accessories > Command
Prompt .
2At the prompt, type telnet followed by the Internet Protocol (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 SpeedTouchTM516 banner after opening a session and
authentication.
Username : johndoe
Password : *******
------------------------------------------------------------------------
*
* ______ SpeedTouch 516
* ___/_____/\
* / /\\ Version 5.2.7.5.0
* _____/__ / \\
* _/ /\_____/___ \ Copyright (c) 1999-2004,
* // / \ /\ \ THOMSON
* _______//_______/ \ / _\/______
* / /\ \ / // /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
* \ \/ /\ \\ \/
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/\\/
* \ \ /___\/
* \____\/
*
------------------------------------------------------------------------
=>