Alcatel-Lucent SPEEDTOUCH 500 User Manual
SpeedTouch™
500Series
Multi-User ADSL Gateways
CLI Reference Guide
Release R4.2
500
SERIES
SpeedTouch™
500Series
CLI Reference Guide
Release R4.2
Status Released
Change Note PeckelbeenS
Short Title CLI ST500Series R4.2
Copyright
© 2003 THOMSON. All rights reserved. Passing on, and copying of this document, use and
communication of its contents is not permitted without written authorization from
THOMSON. The content of this document is furnished for informational use only, may be
subject to change without notice, and should not be construed as a commitment by
THOMSON. THOMSON assumes no responsibility or liability for any errors or inaccuracies
that may appear in this document.
Content
About this Document.................................................................................... 17
CLI Navigation ............................................................................................... 19
Accessing the Command Line Interface .................................................................................................................... 20
Basic Navigation and Manipulation..............................................................................................................................21
Command Line Interface Top Level Structure ........................................................................................................ 25
Command Line Interface Commands ........................................................................................................................ 26
Menu-driven CLI Navigation ........................................................................................................................................ 27
Configuration Profile Files and the CLI......................................................................................................................28
ADSL Commands .......................................................................................... 31
adsl config .........................................................................................................................................................................32
adsl info .............................................................................................................................................................................33
ATM Commands............................................................................................ 35
atm aal5stats..................................................................................................................................................................... 36
atm gstats ..........................................................................................................................................................................37
atm portstats.................................................................................................................................................................... 38
atm vcstats........................................................................................................................................................................39
atm oam ccconfig ............................................................................................................................................................ 40
atm oam cclist.................................................................................................................................................................. 42
atm oam ccsend...............................................................................................................................................................43
atm oam config ................................................................................................................................................................ 45
atm oam mode.................................................................................................................................................................46
atm oam ping....................................................................................................................................................................47
atm oam status ................................................................................................................................................................ 48
AutoPVC Commands.................................................................................... 49
autopvc config..................................................................................................................................................................50
autopvc info......................................................................................................................................................................52
5
Bridge Commands......................................................................................... 53
bridge config.....................................................................................................................................................................54
bridge flush ....................................................................................................................................................................... 55
bridge ifadd ....................................................................................................................................................................... 56
bridge ifattach................................................................................................................................................................... 59
bridge ifconfig................................................................................................................................................................... 62
bridge ifdelete .................................................................................................................................................................. 64
bridge ifdetach ................................................................................................................................................................. 65
bridge iflist ........................................................................................................................................................................66
bridge macadd..................................................................................................................................................................68
bridge macdelete............................................................................................................................................................. 69
bridge maclist ...................................................................................................................................................................70
CIP Commands.............................................................................................. 71
cip flush.............................................................................................................................................................................. 72
cip ifadd .............................................................................................................................................................................73
cip ifdelete.........................................................................................................................................................................74
cip iflist...............................................................................................................................................................................75
cip pvcadd .........................................................................................................................................................................76
cip pvcdelete .................................................................................................................................................................... 77
cip pvclist...........................................................................................................................................................................78
Config Commands ......................................................................................... 79
config backup....................................................................................................................................................................80
config dump ......................................................................................................................................................................81
config erase.......................................................................................................................................................................82
config flush ........................................................................................................................................................................83
config list ........................................................................................................................................................................... 84
config load......................................................................................................................................................................... 85
config save.........................................................................................................................................................................87
6
DHCP Commands ......................................................................................... 89
dhcp client clear .............................................................................................................................................................. 91
dhcp client config ............................................................................................................................................................ 92
dhcp client flush............................................................................................................................................................... 93
dhcp client ifadd............................................................................................................................................................... 94
dhcp client ifattach .......................................................................................................................................................... 95
dhcp client ifconfig ..........................................................................................................................................................96
dhcp client ifdelete..........................................................................................................................................................98
dhcp client iflist................................................................................................................................................................ 99
dhcp client ifrelease ......................................................................................................................................................100
dhcp client ifrenew .......................................................................................................................................................102
dhcp client stats.............................................................................................................................................................104
dhcp relay add................................................................................................................................................................105
dhcp relay config ...........................................................................................................................................................106
dhcp relay delete...........................................................................................................................................................107
dhcp relay flush..............................................................................................................................................................108
dhcp relay ifconfig .........................................................................................................................................................109
dhcp relay iflist...............................................................................................................................................................110
dhcp relay list .................................................................................................................................................................111
dhcp relay stats..............................................................................................................................................................112
dhcp server clear...........................................................................................................................................................113
dhcp server config.........................................................................................................................................................114
dhcp server flush ...........................................................................................................................................................115
dhcp server policy.........................................................................................................................................................116
dhcp server stats ...........................................................................................................................................................117
dhcp server lease add...................................................................................................................................................119
dhcp server lease delete..............................................................................................................................................121
dhcp server lease flush.................................................................................................................................................122
dhcp server lease list....................................................................................................................................................123
dhcp server pool add ...................................................................................................................................................124
dhcp server pool config ...............................................................................................................................................125
dhcp server pool delete...............................................................................................................................................127
dhcp server pool flush .................................................................................................................................................128
dhcp server pool list.....................................................................................................................................................129
7
DNS Commands .......................................................................................... 131
dns add ............................................................................................................................................................................132
dns clear ..........................................................................................................................................................................133
dns clrstats......................................................................................................................................................................134
dns delete........................................................................................................................................................................135
dns domain .....................................................................................................................................................................136
dns flush...........................................................................................................................................................................137
dns fwdadd......................................................................................................................................................................138
dns fwddelete.................................................................................................................................................................139
dns fwdlist .......................................................................................................................................................................140
dns fwdtable ...................................................................................................................................................................141
dns list..............................................................................................................................................................................142
dns nslookup ..................................................................................................................................................................143
dns start...........................................................................................................................................................................144
dns stats...........................................................................................................................................................................145
dns status ........................................................................................................................................................................146
dns stop...........................................................................................................................................................................147
dns toutfwd ....................................................................................................................................................................148
dns troff...........................................................................................................................................................................149
dns tron...........................................................................................................................................................................150
Env Commands............................................................................................ 151
env flush ..........................................................................................................................................................................152
env get .............................................................................................................................................................................154
env list..............................................................................................................................................................................156
env set .............................................................................................................................................................................157
env unset.........................................................................................................................................................................158
Eth Commands............................................................................................. 159
eth config.........................................................................................................................................................................160
eth ifconfig ......................................................................................................................................................................161
eth iflist ............................................................................................................................................................................162
8
ETHoA Commands ..................................................................................... 163
ethoa flush.......................................................................................................................................................................164
ethoa ifadd ......................................................................................................................................................................165
ethoa ifattach..................................................................................................................................................................166
ethoa ifconfig..................................................................................................................................................................167
ethoa ifdelete .................................................................................................................................................................169
ethoa ifdetach.................................................................................................................................................................170
ethoa iflist........................................................................................................................................................................171
Firewall Commands..................................................................................... 173
firewall assign .................................................................................................................................................................174
firewall flush....................................................................................................................................................................176
firewall list.......................................................................................................................................................................177
firewall troff....................................................................................................................................................................178
firewall tron....................................................................................................................................................................179
firewall unassign.............................................................................................................................................................180
firewall chain create......................................................................................................................................................181
firewall chain delete......................................................................................................................................................182
firewall chain flush.........................................................................................................................................................183
firewall chain list ............................................................................................................................................................184
firewall rule clear...........................................................................................................................................................185
firewall rule create........................................................................................................................................................186
firewall rule delete ........................................................................................................................................................190
firewall rule flush ...........................................................................................................................................................191
firewall rule list ..............................................................................................................................................................192
firewall rule stats ...........................................................................................................................................................193
9
IP Commands............................................................................................... 195
ip apadd ...........................................................................................................................................................................196
ip apdelete.......................................................................................................................................................................198
ip aplist.............................................................................................................................................................................199
ip arpadd .........................................................................................................................................................................200
ip arpdelete.....................................................................................................................................................................201
ip arplist...........................................................................................................................................................................202
ip config ...........................................................................................................................................................................203
ip flush..............................................................................................................................................................................206
ip ifconfig .........................................................................................................................................................................207
ip iflist...............................................................................................................................................................................208
ip ifwait ............................................................................................................................................................................209
ip ping...............................................................................................................................................................................210
ip rtadd ............................................................................................................................................................................211
ip rtdelete .......................................................................................................................................................................212
ip rtlist..............................................................................................................................................................................213
ip sendto..........................................................................................................................................................................214
ip traceroute ..................................................................................................................................................................215
ip auto flush ....................................................................................................................................................................217
ip auto ifadd....................................................................................................................................................................218
ip auto ifattach ...............................................................................................................................................................219
ip auto ifconfig................................................................................................................................................................220
ip auto ifdelete ...............................................................................................................................................................221
ip auto ifdetach ..............................................................................................................................................................222
ip auto iflist .....................................................................................................................................................................223
IPoA Commands.......................................................................................... 225
ipoa flush .........................................................................................................................................................................226
ipoa ifadd.........................................................................................................................................................................227
ipoa ifattach ....................................................................................................................................................................228
ipoa ifconfig.....................................................................................................................................................................229
ipoa ifdelete ....................................................................................................................................................................231
ipoa ifdetach ...................................................................................................................................................................232
ipoa iflist ..........................................................................................................................................................................233
10
Label Commands......................................................................................... 235
label add ..........................................................................................................................................................................236
label config ......................................................................................................................................................................237
label delete......................................................................................................................................................................238
label flush.........................................................................................................................................................................239
label list............................................................................................................................................................................240
label troff.........................................................................................................................................................................241
label tron.........................................................................................................................................................................242
label chain create...........................................................................................................................................................243
label chain delete...........................................................................................................................................................244
label chain flush..............................................................................................................................................................245
label chain list.................................................................................................................................................................246
label rule clear................................................................................................................................................................247
label rule create.............................................................................................................................................................248
label rule delete .............................................................................................................................................................250
label rule flush ................................................................................................................................................................251
label rule list ...................................................................................................................................................................252
label rule stats ................................................................................................................................................................253
Language Commands.................................................................................. 255
language config...............................................................................................................................................................256
language list.....................................................................................................................................................................257
language remove............................................................................................................................................................258
11
NAT Commands.......................................................................................... 259
nat applist........................................................................................................................................................................260
nat bind............................................................................................................................................................................261
nat bindlist.......................................................................................................................................................................264
nat clear...........................................................................................................................................................................265
nat config.........................................................................................................................................................................266
nat create........................................................................................................................................................................267
nat defserver ..................................................................................................................................................................269
nat delete ........................................................................................................................................................................270
nat disable .......................................................................................................................................................................272
nat enable........................................................................................................................................................................273
nat flush ...........................................................................................................................................................................274
nat list ..............................................................................................................................................................................275
nat multinatadd ..............................................................................................................................................................276
nat multinatdelete .........................................................................................................................................................277
nat multinatlist ...............................................................................................................................................................278
nat unbind .......................................................................................................................................................................279
Phonebook Commands............................................................................... 281
phonebook add..............................................................................................................................................................282
phonebook autolist.......................................................................................................................................................284
phonebook delete.........................................................................................................................................................285
phonebook flush............................................................................................................................................................286
phonebook list ...............................................................................................................................................................287
PPPoA Commands ...................................................................................... 289
pppoa flush......................................................................................................................................................................290
pppoa ifadd .....................................................................................................................................................................291
pppoa ifattach.................................................................................................................................................................293
pppoa ifconfig .................................................................................................................................................................294
pppoa ifdelete.................................................................................................................................................................298
pppoa ifdetach................................................................................................................................................................299
pppoa iflist.......................................................................................................................................................................300
pppoa rtadd ....................................................................................................................................................................301
pppoa rtdelete ...............................................................................................................................................................303
12
PPPoE Commands....................................................................................... 305
pppoe flush .....................................................................................................................................................................306
pppoe ifadd .....................................................................................................................................................................307
pppoe ifattach.................................................................................................................................................................309
pppoe ifconfig.................................................................................................................................................................311
pppoe ifdelete ................................................................................................................................................................316
pppoe ifdetach ...............................................................................................................................................................317
pppoe iflist ......................................................................................................................................................................318
pppoe ifscan....................................................................................................................................................................319
pppoe relay add.............................................................................................................................................................320
pppoe relay delete ........................................................................................................................................................321
pppoe relay flush ...........................................................................................................................................................322
pppoe relay portlist ......................................................................................................................................................323
pppoe relay sesslist.......................................................................................................................................................324
pppoe rtadd....................................................................................................................................................................325
pppoe rtdelete ...............................................................................................................................................................327
PPTP Commands......................................................................................... 329
pptp ifadd ........................................................................................................................................................................330
pptp flush.........................................................................................................................................................................331
pptp list............................................................................................................................................................................332
pptp profadd...................................................................................................................................................................333
pptp profdelete..............................................................................................................................................................334
pptp proflist ....................................................................................................................................................................335
QoSBook Commands.................................................................................. 337
qosbook add...................................................................................................................................................................338
qosbook config ..............................................................................................................................................................340
qosbook delete..............................................................................................................................................................341
qosbook flush.................................................................................................................................................................342
qosbook list ....................................................................................................................................................................343
Script Commands........................................................................................ 345
13
SNMP Commands........................................................................................ 347
snmp config.....................................................................................................................................................................348
snmp get..........................................................................................................................................................................349
snmp getNext ................................................................................................................................................................350
snmp list ..........................................................................................................................................................................351
snmp walk .......................................................................................................................................................................352
Software Commands................................................................................... 353
software version............................................................................................................................................................354
software upgrade ..........................................................................................................................................................355
Switch Commands....................................................................................... 357
switch group flush .........................................................................................................................................................358
switch group list ............................................................................................................................................................359
switch group move .......................................................................................................................................................360
switch mirror capture..................................................................................................................................................361
switch mirror egress ....................................................................................................................................................362
switch mirror ingress ...................................................................................................................................................363
System Commands...................................................................................... 365
system clearpassword ..................................................................................................................................................366
system config..................................................................................................................................................................367
system flush ....................................................................................................................................................................368
system reboot................................................................................................................................................................369
system reset ...................................................................................................................................................................370
system setpassword......................................................................................................................................................371
system stats ....................................................................................................................................................................372
Systemlog Commands................................................................................. 373
systemlog show .............................................................................................................................................................374
systemlog send...............................................................................................................................................................375
TD Commands............................................................................................. 377
td call................................................................................................................................................................................378
14
UPnP Commands......................................................................................... 379
upnp config .....................................................................................................................................................................380
upnp flush........................................................................................................................................................................381
upnp list...........................................................................................................................................................................382
USB Commands........................................................................................... 383
usb add ............................................................................................................................................................................384
usb config ........................................................................................................................................................................385
usb delete........................................................................................................................................................................386
usb info ............................................................................................................................................................................387
usb list..............................................................................................................................................................................388
Wireless Commands ................................................................................... 389
wireless aclconfig...........................................................................................................................................................390
wireless aclentry............................................................................................................................................................391
wireless aclflush .............................................................................................................................................................392
wireless acllist ................................................................................................................................................................393
wireless counters ..........................................................................................................................................................394
wireless flush ..................................................................................................................................................................395
wireless ifconfig .............................................................................................................................................................396
wireless scan ..................................................................................................................................................................397
wireless status................................................................................................................................................................398
wireless wepconfig........................................................................................................................................................399
Abbreviations ............................................................................................... 401
15
Syslog Messages............................................................................................ 405
Auto-PVC Module ........................................................................................................................................................406
Configuration Module ..................................................................................................................................................406
DHCP CLient Module .................................................................................................................................................407
DHCP Relay Module ....................................................................................................................................................407
DHCP Server Module..................................................................................................................................................408
Firewall Module .............................................................................................................................................................408
HTTP Module ................................................................................................................................................................408
Kernel Module ...............................................................................................................................................................409
Linestate Module...........................................................................................................................................................409
Login Module..................................................................................................................................................................409
NAPT Module................................................................................................................................................................409
PPP Module.....................................................................................................................................................................410
PPTP Module..................................................................................................................................................................410
Routing Module .............................................................................................................................................................410
Software Module ...........................................................................................................................................................411
UPnP Module .................................................................................................................................................................411
Supported Key Names ................................................................................ 413
Supported Internet Protocol (IP) Protocol Names ..............................................................................................413
Supported TCP/UDP Port Names............................................................................................................................414
Supported ICMP Type Names ...................................................................................................................................417
Supported Syslog Facilities ..........................................................................................................................................418
Supported Syslog Severities........................................................................................................................................419
16
About this Document
About this Document
Introduction
Welcome to the SpeedTouch™500Series Command Line Interface (CLI) Reference Guide!
For the Service Provider, this Reference Guide aims to give a concise and practical document for creating a customized
configuration profile file, based on the SpeedTouch™500Series CLI command set, to be used by the end-user to
configure the SpeedTouch™500Series and PC(s).
For the fastidious user this Reference Guide aims to give a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch™500Series via its character based Command Line Interface.
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch™
products:
• SpeedTouch™510 ADSL/POTS
• SpeedTouch™510i ADSL/ISDN
• SpeedTouch™530
• SpeedTouch™570 Wireless
• SpeedTouch™570i Wireless
Contents
The Reference Guide consists of two main parts:
• CLI Navigation
This chapter familiarises the user with the SpeedTouch™500Series CLI. It describes general manipulations to navigate through and to perform some operations on the CLI.
• CLI Command Description
The other chapters describe all the available CLI commands of the SpeedTouch™500Series per command group
and in alphabetical order.
Each command is described in a systematic manner:
• The full name of the CLI command (including the group selection)
• A short description of the CLI command, if needed completed by a description of the possible impact on the
user and/or the SpeedTouch™500Series
• The syntax of the command with a description of each parameter
• An example to demonstrate the use of the CLI command
• A list of related CLI commands.
E-SIT-CTC-20030410-0049 v1.0
17
About this Document
Trademarks
The following trademarks are used in this document:
• SpeedTouch™ 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 SpeedTouch™ technology, existing products are regularly upgraded.
For more information on the latest technological innovations, software upgrades, and documents, please visit the
SpeedTouch™ web site at:
www.speedtouch.com
18
E-SIT-CTC-20030410-0049 v1.0
CLI Navigation
CLI Navigation
Contents
This chapter covers the following topics:
Topic Page
Accessing the Command Line Interface 20
Basic Navigation and Manipulation 21
Command Line Interface Top Level Structure 25
Command Line Interface Commands 26
Menu-driven CLI Navigation 27
Configuration Profile Files and the CLI 28
E-SIT-CTC-20030410-0049 v1.0
19
CLI Navigation
Accessing the Command Line Interface
Users can access the Command Line Interface via a Telnet session. This requires that TCP/IP connectivity exists
between the host from which the Telnet session is opened and the SpeedTouch™500Series.
.As soon a session to the CLI is opened, the SpeedTouch™500Series banner pops up, followed by the CLI prompt.
In case the SpeedTouch™500Series is protected by a System password, authentication will be required before access is
granted.
The following figure shows an example of the SpeedTouch™500Series banner after opening a session and
authentication.
/home/doejohn{1}$ telnet 10.0.0.138
Trying 10.0.0.138...
Connected to 10.0.0.138.
Username :
Password : ######
-----------------------------------------------------------------------*
* ______ Speedtouch 510
* ___/_____/\
* / /\\ Version R4.2.0.15.0
* _____/__ / \\
* _/ /\_____/___ \ Copyright (c) 1999-2003,
* // / \ /\ \ THOMSON
* _______//_______/ \ / _\/______
* / /\ \/// /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
*\ \/ /\\\ \/
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/\\/
* \ \ /___\/
* \____\/
*
-----------------------------------------------------------------------=>
20
E-SIT-CTC-20030410-0049 v1.0
CLI Navigation
Basic Navigation and Manipulation
Manipulation commands are commands that manipulate operations on the command line, for example changing the
command group, go to the beginning of the command line, go to the end of the command line, etc.
Command group Navigation
From top level, you can change to a command group by executing the name of the desired command group.
To obtain a list of all available command groups, execute help from the top level.
The example below shows every possible CLI command group for the SpeedTouch™510.
=>help
Following commands are available :
help : Displays this help information
menu : Displays menu
? : Displays this help information
exit : Exits this shell.
.. : Exits group selection.
saveall : Saves current configuration.
Following command groups are available :
adsl atm autopvc bridge cip
config dhcp dns env eth
ethoa firewall ip ipoa label
language nat phonebook pppoa pppoe
pptp qosbook script snmp software
switch system systemlog td upnp
=>
The following command groups are specific for certain variants:
• usb is only available for the SpeedTouch™530
• wireless is only available for the SpeedTouch™570
To return to top level, or to descend one level (in case of nested command groups) execute .. .
EXAMPLE:
=>phonebook
[phonebook]=>
[phonebook]=>..
=>
E-SIT-CTC-20030410-0049 v1.0
21
CLI Navigation
The Help Command
Execute help or ? from top level to list all available command groups for the SpeedTouch™500Series.
EXAMPLE for the SpeedTouch™510:
=>help
Following commands are available :
help : Displays this help information
menu : Displays menu
? : Displays this help information
exit : Exits this shell.
.. : Exits group selection.
saveall : Saves current configuration.
Following command groups are available :
adsl atm autopvc bridge cip
config dhcp dns env eth
ethoa firewall ip ipoa label
language nat password phonebook pppoa
pppoe pptp qosbook script snmp
software system systemlog td upnp
=>
You can execute the help or ? command from each command group selection. This results in a list of the available
commands (and nested command groups, if available) in this particular command group.
EXAMPLE:
=>firewall
[firewall]=>
[firewall]=>?
Following commands are available :
tron : Enables verbose console messaging.
troff : Disables verbose console messaging.
match : Defines an ip packet match.
assign : Assign a chain to an entry point.
list : Shows a list of all the hooks with the chain attached.
flush : Clears all hooks. If a hook is provided, that hook is cleared.
Following command groups are available :
chain rule
[firewall]=>
22
E-SIT-CTC-20030410-0049 v1.0
CLI Navigation
As both help and ? have the exact same functionality in the SpeedTouch™500Series CLI, the help command may always
be equally replaced by the ? command.
Executing e.g. help firewall from top level gives the same result as executing help from the firewall command group
selection.
EXAMPLE:
=>firewall help
Following commands are available :
assign : Assign a chain to an entry point.
unassign : Clear a specific hook
list : Shows a list of all the hooks with the chains attached.
flush : Clears all hooks, chains and rules
tron : Enables verbose console messaging.
troff : Disables verbose console messaging.
Following command groups are available :
chain rule
=>
Entering help followed by a specific command, e.g. help firewall assign (starting from top level) or help assign (executed
from the firewall command group selection) results in a description of the syntax for the command.
EXAMPLE:
=>help firewall assign
Assign a chain to an entry point.
Syntax : assign hook = <{input|sink|forward|source|output}> chain = <string>
Parameters :
hook = <{input|sink|forward|source|output}>
Name of hook to assign chain to.
chain = <string>
Name of chain to use.
=>
Executing help all will generate the complete listing of all available CLI commands with syntax description.
E-SIT-CTC-20030410-0049 v1.0
23
CLI Navigation
Command Completion
The CLI features command completion, which means that when starting to enter a command it can be completed by
pressing the TAB key.
For the completion to be successful, the part to be added must be unique. Completion works for the command groups,
for the commands, for the options, but not for values.
For example, pressing a and TAB at the firewall command group selection results in the full assign command being
completed. Entering firewall a and pressing the TAB key from top level gives the same result.
EXAMPLE:
=>firewall
[firewall]=>"a+TAB"
[firewall]=>assign
Going to the beginning or end of the Command Line
To go to ... Press ...
the beginning of the Command Line CTRL+A
the end of the Command Line CTRL+E
Breaking off Commands
Press CTRL+G to break off a command. This can be useful in a situation where a user is prompted to enter a value
which he does not know and wants to quit the command. Instead of being prompted over and over again for the same
value, this allows to quit the command and return to the command line prompt.
In the example below CTRL+G is pressed after the third prompt chain =
[firewall]=>match
chain =
chain =
chain = “CTRL+G”
[firewall]=>
History of Commands
Use the UP and DOWN ARROW keys to select a previously executed command. Press ENTER to execute the selected
command.
EXAMPLE:
=>firewall
[firewall]=>list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
[firewall]=> “UP ARROW”
[firewall]=>:firewall list
24
E-SIT-CTC-20030410-0049 v1.0
CLI Navigation
Command Line Interface Top Level Structure
The table below shows the available command groups for the different SpeedTouch™500Series variants:
Command group Availability
adsl Only applicable for the SpeedTouch™510 and SpeedTouch™570 ADSL/POTS, and the Speed-
Touch™510i and SpeedTouch™570i ADSL/ISDN variants.
atm Always
autopvc Always
bridge Always
cip Always
config Always
dhcp Always
dns Always
env Always
eth Always
ethoa Always
firewall Always
ip Always
ipoa Always
label Always
language Always
nat Always
phonebook Always
pppoa Always
pppoe Always
pptp Always
qosbook Always
script Always
snmp Always
software Always
switch Only applicable for SpeedTouch™ devices with a four port switch.
system Always
systemlog Always
td Always
upnp Always
usb Only applicable for the SpeedTouch™530 variant.
wireless Only applicable for the SpeedTouch™570 Wireless variant.
E-SIT-CTC-20030410-0049 v1.0
25
CLI Navigation
Command Line Interface Commands
All CLI commands are commands that operate on, or configure, the SpeedTouch™500Series settings.
You can execute these commands from top level, preceded by the name of the command group from which the
command should be executed (e. g. firewall list).
You can also execute the commands from the command group itself, using the reduced form of the command (e.g. list
at the firewall command group selection).
! in a command means ‘NOT‘, e.g. the [!]syn parameter in the firewall rule create command.
EXAMPLE:
=>firewall list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
=>firewall
[firewall]=>list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
[firewall]=>
Instead of entering a completely built-up command with all its parameters, you can also enter just the command itself,
without its parameters. After this you are prompted to complete the command with the required and the optional
parameters. For the optional parameters you can simply press enter without giving a value.
The example below is the equivalent of firewall assign hook=input chain=input. To break of such incomplete command
press CTRL+G.
EXAMPLE:
=>firewall assign
hook = input
chain = input
=>
26
E-SIT-CTC-20030410-0049 v1.0
CLI Navigation
Menu-driven CLI Navigation
To improve the user-friendliness of the SpeedTouch™500Series CLI, the CLI features a menu-driven interface.
To enter the menu-driven interface, simply execute menu from the CLI prompt:
EXAMPLE (for the SpeedTouch™510):
The semi-graphical CLI offers you an attractive and easy-to-use configuration environment for the CLI.
You can browse through the CLI command groups via the ARROW keys. Press ENTER to execute your selection. From
each level you can select '..' to go back one level up.
Use the TAB key to change from the CLI command menu to the control menu and vice versa.
To setup a CLI command, simply press ENTER on its name. You can configure and overview its various parameters at
one time. In case the parameter provides preset values, you can go through these via the ARROW keys.
If you are satisfied, use the TAB key to go to the OK field and press ENTER.
Note Do not forget to save your changes by executing saveall (from any CLI prompt).
E-SIT-CTC-20030410-0049 v1.0
27
CLI Navigation
Configuration Profile Files and the CLI
Configuration Profile Files
The configuration profile files, used by the Setup wizard, or directly uploaded via the SpeedTouch™500Series web
pages, consist of a set of CLI commands. Only CLI commands, which are part of the SpeedTouch™500Series CLI
command set may be used in the .ini and .def files. For readability, configuration profile files are partitioned in paragraphs. These paragraphs reflect a CLI command group selection in the SpeedTouch™500Series CLI. However, due to
internal processing, not all paragraph names are the same as their corresponding CLI command group selection.
In the following overview the relationship between the available SpeedTouch™500Series CLI commands and the
[<configuration>.ini] paragraphs is given:
[<configuration>.ini] paragraphs Available SpeedTouch™500Series CLI commands
[adslisdn.ini] The adsl CLI command group in case of a ADSL/ISDN variant
[adslpots.ini] The adsl CLI command group in case of a ADSL/POTS variant
[autoip.ini] The ip auto CLI command subgroup
[autopvc.ini] The autopvc CLI command subgroup
[bridge.ini] The bridge CLI command group
[cip.ini] The cip CLI command group
[dhcc.ini] The dhcp client CLI command subgroup
[dhcp.ini] The dhcp server CLI command subgroup
[dhcr.ini] The dhcp relay CLI command subgroup
[dnsd.ini] The dns CLI command group
[env.ini] The env CLI command group
[eth.ini] The eth CLI command group
[ethoa.ini] The ethoa CLI command group
[ip.ini] The ip CLI command group
[ipoa.ini] The cip CLI command group
[label.ini] The label CLI command group
[language.ini] The language CLI command group
[nat.ini] The nat CLI command group
[oam.ini] The atm oam CLI command subgroup
[pfilter.ini] • The firewall chain CLI command subgroup
• The firewall rule CLI command subgroup
[pfirewall.ini] The firewall CLI command group (except those part of the firewall chain
and firewall rule CLI command subgroups).
28
E-SIT-CTC-20030410-0049 v1.0
[<configuration>.ini] paragraphs Available SpeedTouch™500Series CLI commands
[phone.ini] The phonebook CLI command group
[ppp.ini] The ppp CLI command group
[pppoa.ini] The pppoa CLI command group
[pppoe.ini] The pppoe CLI command group
[pppoerelay.ini] The pppoe relay CLI command subgroup
[pptp.ini] The pptp CLI command group
[qos.ini] The qosbook CLI command group
[script.ini] The script CLI command group
[snmp.ini] The snmp CLI command group
[system.ini] The system CLI command group
[upnp.ini] The upnp CLI command group
CLI Navigation
[usb.ini] The usb CLI command group
[wireless.ini] The wireless CLI command group
CLI Commands in Configuration Profile Files
CLI commands in a paragraph of a configuration profile file should always be constructed in their complete form.
Uncompleted CLI commands, i.e. commands in which required parameters are not specified, will be discarded by the
CLI commend interpreter. This may result in a wrongly configured SpeedTouch™500Series.
In configuration profile files, the use of customization variables, allow the Setup wizard to invite the end-user to provide
some input regarding the settings of the SpeedTouch™500Series. The declaration of such variables must be done in the
[env.ini] paragraph. Further use of the resulting variable TAG is allowed through all other paragraphs, even multiple
times.
To make sure that a variable always will result in a valid variable TAG, the [env.ini] paragraph also allows to declare a
preset value for the variable.
In case the variable TAG is used in a CLI command, the value of the variable should always be in conformity with the
syntax of the CLI command.
Customizing Configuration Profile Files
For more information on the customization possibilities of the SpeedTouch™500Series, the Setup wizard and the
configuration profile files, please check the SpeedTouch™ support pages at:
www.speedtouch.com
E-SIT-CTC-20030410-0049 v1.0
29
CLI Navigation
30
E-SIT-CTC-20030410-0049 v1.0
Loading...