THOMSON SpeedTouch 580 Cli Reference Manual
SpeedTouch™580
Wireless Multi-User ADSL Gateways
CLI Reference Guide
Release R4.2.7
500
SERIES
SpeedTouch™
580
CLI Reference Guide
Release R4.2.7
Status v1.0
Reference E-DOC-CTC-20040216-0003
Short Title CLI ST580 R4.2.7
Copyright
© 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.
3
E-DOC-CTC-20040216-0003 v1.0
Content
About this Document .................................................................................... 15
CLI Navigation ............................................................................................... 17
Accessing the Command Line Interface .................................................................................................................... 18
Basic Navigation and Manipulation..............................................................................................................................19
Command Line Interface Top Level Structure ........................................................................................................ 23
Command Line Interface Commands ........................................................................................................................24
Menu-driven CLI Navigation ........................................................................................................................................ 25
Service Template Files and the CLI ............................................................................................................................28
Direct FTP Access .......................................................................................................................................................... 30
ADSL Commands .......................................................................................... 33
adsl config ......................................................................................................................................................................... 34
adsl info ............................................................................................................................................................................. 35
ATM Commands............................................................................................ 37
atm oam ccconfig ............................................................................................................................................................38
atm oam cclist.................................................................................................................................................................. 39
atm oam ccsend............................................................................................................................................................... 40
atm oam config ................................................................................................................................................................41
atm oam mode................................................................................................................................................................. 42
atm oam ping....................................................................................................................................................................43
atm oam status ................................................................................................................................................................ 44
AutoPVC Commands.................................................................................... 45
autopvc config.................................................................................................................................................................. 46
autopvc info...................................................................................................................................................................... 48
4
E-DOC-CTC-20040216-0003 v1.0
Bridge Commands ......................................................................................... 49
bridge config.....................................................................................................................................................................50
bridge flush ....................................................................................................................................................................... 51
bridge ifadd ....................................................................................................................................................................... 52
bridge ifattach................................................................................................................................................................... 53
bridge ifconfig................................................................................................................................................................... 54
bridge ifdelete ..................................................................................................................................................................56
bridge ifdetach ................................................................................................................................................................. 57
bridge iflist ........................................................................................................................................................................ 58
bridge macadd..................................................................................................................................................................60
bridge macdelete............................................................................................................................................................. 61
bridge maclist ................................................................................................................................................................... 62
bridge mcdadd .................................................................................................................................................................63
bridge mcddelete............................................................................................................................................................. 64
bridge mcdlist...................................................................................................................................................................65
CIP Commands .............................................................................................. 67
cip flush.............................................................................................................................................................................. 68
cip ifadd ............................................................................................................................................................................. 69
cip ifdelete......................................................................................................................................................................... 70
cip iflist...............................................................................................................................................................................71
cip pvcadd ......................................................................................................................................................................... 72
cip pvcdelete .................................................................................................................................................................... 73
cip pvclist...........................................................................................................................................................................74
Config Commands ......................................................................................... 75
config backup.................................................................................................................................................................... 76
config dump ...................................................................................................................................................................... 77
config erase.......................................................................................................................................................................78
config flush ........................................................................................................................................................................ 79
config list ...........................................................................................................................................................................80
config load......................................................................................................................................................................... 81
config save.........................................................................................................................................................................83
5
E-DOC-CTC-20040216-0003 v1.0
DHCP Commands ......................................................................................... 85
dhcp client clear ..............................................................................................................................................................87
dhcp client config ............................................................................................................................................................88
dhcp client flush............................................................................................................................................................... 89
dhcp client ifadd............................................................................................................................................................... 90
dhcp client ifattach .......................................................................................................................................................... 91
dhcp client ifconfig .......................................................................................................................................................... 92
dhcp client ifdelete..........................................................................................................................................................94
dhcp client iflist................................................................................................................................................................ 95
dhcp client ifrelease ........................................................................................................................................................96
dhcp client ifrenew ......................................................................................................................................................... 98
dhcp client stats.............................................................................................................................................................100
dhcp relay add................................................................................................................................................................101
dhcp relay config ...........................................................................................................................................................102
dhcp relay delete...........................................................................................................................................................103
dhcp relay flush..............................................................................................................................................................104
dhcp relay ifconfig .........................................................................................................................................................105
dhcp relay iflist...............................................................................................................................................................106
dhcp relay list .................................................................................................................................................................107
dhcp relay stats..............................................................................................................................................................108
dhcp server clear...........................................................................................................................................................109
dhcp server config.........................................................................................................................................................110
dhcp server flush ...........................................................................................................................................................111
dhcp server policy.........................................................................................................................................................112
dhcp server stats ...........................................................................................................................................................113
dhcp server lease add...................................................................................................................................................115
dhcp server lease delete..............................................................................................................................................117
dhcp server lease flush.................................................................................................................................................118
dhcp server lease list....................................................................................................................................................119
dhcp server pool add ...................................................................................................................................................120
dhcp server pool config ...............................................................................................................................................121
dhcp server pool delete...............................................................................................................................................123
dhcp server pool flush .................................................................................................................................................124
dhcp server pool list.....................................................................................................................................................125
6
E-DOC-CTC-20040216-0003 v1.0
DNS Commands .......................................................................................... 127
dns add ............................................................................................................................................................................128
dns clear ..........................................................................................................................................................................129
dns clrstats......................................................................................................................................................................130
dns delete........................................................................................................................................................................131
dns domain .....................................................................................................................................................................132
dns flush...........................................................................................................................................................................133
dns fwdadd......................................................................................................................................................................134
dns fwddelete.................................................................................................................................................................135
dns fwdlist .......................................................................................................................................................................136
dns fwdtable ...................................................................................................................................................................137
dns list..............................................................................................................................................................................138
dns nslookup ..................................................................................................................................................................139
dns start...........................................................................................................................................................................140
dns stats...........................................................................................................................................................................141
dns status ........................................................................................................................................................................142
dns stop...........................................................................................................................................................................143
dns toutfwd ....................................................................................................................................................................144
dns troff...........................................................................................................................................................................145
dns tron...........................................................................................................................................................................146
Env Commands ............................................................................................ 147
env flush ..........................................................................................................................................................................148
env get .............................................................................................................................................................................149
env list..............................................................................................................................................................................150
env set .............................................................................................................................................................................151
env unset.........................................................................................................................................................................152
Eth Commands............................................................................................. 153
eth config.........................................................................................................................................................................154
eth ifconfig ......................................................................................................................................................................155
eth iflist ............................................................................................................................................................................156
7
E-DOC-CTC-20040216-0003 v1.0
ETHoA Commands ..................................................................................... 157
ethoa flush.......................................................................................................................................................................158
ethoa ifadd ......................................................................................................................................................................159
ethoa ifattach..................................................................................................................................................................160
ethoa ifconfig..................................................................................................................................................................161
ethoa ifdelete .................................................................................................................................................................163
ethoa ifdetach.................................................................................................................................................................164
ethoa iflist........................................................................................................................................................................165
Firewall Commands..................................................................................... 167
firewall assign .................................................................................................................................................................168
firewall flush....................................................................................................................................................................170
firewall list.......................................................................................................................................................................171
firewall troff....................................................................................................................................................................172
firewall tron....................................................................................................................................................................173
firewall unassign.............................................................................................................................................................174
firewall chain create......................................................................................................................................................175
firewall chain delete......................................................................................................................................................176
firewall chain flush.........................................................................................................................................................177
firewall chain list ............................................................................................................................................................178
firewall rule clear...........................................................................................................................................................179
firewall rule create........................................................................................................................................................180
firewall rule delete ........................................................................................................................................................184
firewall rule flush ...........................................................................................................................................................185
firewall rule list ..............................................................................................................................................................186
firewall rule stats ...........................................................................................................................................................187
8
E-DOC-CTC-20040216-0003 v1.0
IP Commands............................................................................................... 189
ip apadd ...........................................................................................................................................................................190
ip apdelete.......................................................................................................................................................................192
ip aplist.............................................................................................................................................................................193
ip arpadd .........................................................................................................................................................................194
ip arpdelete.....................................................................................................................................................................195
ip arplist...........................................................................................................................................................................196
ip config ...........................................................................................................................................................................197
ip flush..............................................................................................................................................................................200
ip ifconfig .........................................................................................................................................................................201
ip iflist...............................................................................................................................................................................202
ip ifwait ............................................................................................................................................................................203
ip mcadd..........................................................................................................................................................................204
ip mcdelete .....................................................................................................................................................................205
ip mclist ...........................................................................................................................................................................206
ip ping...............................................................................................................................................................................207
ip rtadd ............................................................................................................................................................................208
ip rtdelete .......................................................................................................................................................................209
ip rtlist..............................................................................................................................................................................210
ip sendto..........................................................................................................................................................................211
ip traceroute ..................................................................................................................................................................212
ip auto flush ....................................................................................................................................................................213
ip auto ifadd....................................................................................................................................................................214
ip auto ifattach ...............................................................................................................................................................215
ip auto ifconfig................................................................................................................................................................216
ip auto ifdelete ...............................................................................................................................................................217
ip auto ifdetach ..............................................................................................................................................................218
ip auto iflist .....................................................................................................................................................................219
IPoA Commands.......................................................................................... 221
ipoa flush .........................................................................................................................................................................222
ipoa ifadd.........................................................................................................................................................................223
ipoa ifattach ....................................................................................................................................................................224
ipoa ifconfig.....................................................................................................................................................................225
ipoa ifdelete ....................................................................................................................................................................227
ipoa ifdetach ...................................................................................................................................................................228
ipoa iflist ..........................................................................................................................................................................229
9
E-DOC-CTC-20040216-0003 v1.0
Label Commands ......................................................................................... 231
label add ..........................................................................................................................................................................232
label config ......................................................................................................................................................................233
label delete......................................................................................................................................................................235
label flush.........................................................................................................................................................................236
label list............................................................................................................................................................................237
label troff.........................................................................................................................................................................238
label tron.........................................................................................................................................................................239
label chain create...........................................................................................................................................................240
label chain delete...........................................................................................................................................................241
label chain flush..............................................................................................................................................................242
label chain list.................................................................................................................................................................243
label rule clear................................................................................................................................................................244
label rule create.............................................................................................................................................................245
label rule delete .............................................................................................................................................................248
label rule flush ................................................................................................................................................................249
label rule list ...................................................................................................................................................................250
label rule stats ................................................................................................................................................................251
Language Commands .................................................................................. 253
language config...............................................................................................................................................................254
language list.....................................................................................................................................................................255
language remove............................................................................................................................................................256
10
E-DOC-CTC-20040216-0003 v1.0
NAT Commands.......................................................................................... 257
nat applist........................................................................................................................................................................258
nat bind............................................................................................................................................................................259
nat bindlist.......................................................................................................................................................................260
nat clear...........................................................................................................................................................................262
nat config.........................................................................................................................................................................263
nat create........................................................................................................................................................................264
nat defserver ..................................................................................................................................................................266
nat delete ........................................................................................................................................................................267
nat disable .......................................................................................................................................................................269
nat enable........................................................................................................................................................................270
nat flush ...........................................................................................................................................................................272
nat list ..............................................................................................................................................................................273
nat multinatadd ..............................................................................................................................................................274
nat multinatdelete .........................................................................................................................................................275
nat multinatlist ...............................................................................................................................................................276
nat unbind .......................................................................................................................................................................277
Phonebook Commands ............................................................................... 279
phonebook add..............................................................................................................................................................280
phonebook autolist.......................................................................................................................................................282
phonebook delete.........................................................................................................................................................283
phonebook flush............................................................................................................................................................284
phonebook list ...............................................................................................................................................................285
PPPoA Commands ...................................................................................... 287
pppoa flush......................................................................................................................................................................288
pppoa ifadd .....................................................................................................................................................................289
pppoa ifattach.................................................................................................................................................................291
pppoa ifconfig .................................................................................................................................................................292
pppoa ifdelete.................................................................................................................................................................296
pppoa ifdetach................................................................................................................................................................297
pppoa iflist.......................................................................................................................................................................298
pppoa rtadd ....................................................................................................................................................................299
pppoa rtdelete ...............................................................................................................................................................301
11
E-DOC-CTC-20040216-0003 v1.0
PPPoE Commands....................................................................................... 303
pppoe flush .....................................................................................................................................................................304
pppoe ifadd .....................................................................................................................................................................305
pppoe ifattach.................................................................................................................................................................307
pppoe ifconfig.................................................................................................................................................................308
pppoe ifdelete ................................................................................................................................................................312
pppoe ifdetach ...............................................................................................................................................................313
pppoe iflist ......................................................................................................................................................................314
pppoe ifscan....................................................................................................................................................................315
pppoe rtadd....................................................................................................................................................................316
pppoe rtdelete .................................................................................................................
..............................................318
pppoe relay add.............................................................................................................................................................319
pppoe relay delete ........................................................................................................................................................320
pppoe relay flush ...........................................................................................................................................................321
pppoe relay portlist ......................................................................................................................................................322
pppoe relay sesslist.......................................................................................................................................................323
PPTP Commands......................................................................................... 325
pptp ifadd ........................................................................................................................................................................326
pptp flush.........................................................................................................................................................................327
pptp list............................................................................................................................................................................328
pptp profadd...................................................................................................................................................................329
pptp profdelete..............................................................................................................................................................331
pptp proflist ....................................................................................................................................................................332
QoSBook Commands.................................................................................. 333
qosbook add...................................................................................................................................................................334
qosbook config ..............................................................................................................................................................336
qosbook delete..............................................................................................................................................................337
qosbook flush.................................................................................................................................................................338
qosbook list ....................................................................................................................................................................339
Script Commands ........................................................................................ 341
script add ........................................................................................................................................................................342
script delete....................................................................................................................................................................343
script flush.......................................................................................................................................................................344
script list..........................................................................................................................................................................345
script run.........................................................................................................................................................................346
12
E-DOC-CTC-20040216-0003 v1.0
SNMP Commands........................................................................................ 347
snmp config.....................................................................................................................................................................348
snmp get..........................................................................................................................................................................349
snmp getNext ................................................................................................................................................................350
snmp list ..........................................................................................................................................................................351
snmp walk .......................................................................................................................................................................352
Software Commands ................................................................................... 353
software version............................................................................................................................................................354
software upgrade ..........................................................................................................................................................355
Switch Commands ....................................................................................... 357
switch group flush .........................................................................................................................................................358
switch group list ............................................................................................................................................................359
switch group move .......................................................................................................................................................360
switch mirror capture..................................................................................................................................................361
switch mirror egress ....................................................................................................................................................362
switch mirror ingress ...................................................................................................................................................363
System Commands...................................................................................... 365
system clearpassword ..................................................................................................................................................366
system config..................................................................................................................................................................367
system flush ....................................................................................................................................................................368
system reboot................................................................................................................................................................369
system reset ...................................................................................................................................................................370
system setpassword......................................................................................................................................................371
system stats ....................................................................................................................................................................372
Systemlog Commands................................................................................. 373
systemlog flush...............................................................................................................................................................374
systemlog show .............................................................................................................................................................375
systemlog send...............................................................................................................................................................377
TD Commands ............................................................................................. 379
td call................................................................................................................................................................................380
13
E-DOC-CTC-20040216-0003 v1.0
UPnP Commands......................................................................................... 381
upnp config .....................................................................................................................................................................382
upnp flush........................................................................................................................................................................384
upnp list...........................................................................................................................................................................385
Wireless Commands ................................................................................... 387
wireless debug stats......................................................................................................................................................388
wireless ifconfig .............................................................................................................................................................389
wireless macacl add ......................................................................................................................................................391
wireless macacl config..................................................................................................................................................392
wireless macacl delete .................................................................................................................................................393
wireless macacl flush ....................................................................................................................................................394
wireless macacl list .......................................................................................................................................................395
wireless macacl modify ................................................................................................................................................396
wireless macacl register...............................................................................................................................................397
wireless reset.................................................................................................................................................................398
wireless secmode config..............................................................................................................................................400
wireless secmode wep .................................................................................................................................................401
wireless secmode wpa-psk .........................................................................................................................................402
wireless stations list......................................................................................................................................................403
Abbreviations ............................................................................................... 405
14
E-DOC-CTC-20040216-0003 v1.0
Syslog Messages............................................................................................ 409
Auto-PVC Module ........................................................................................................................................................410
Configuration Module ..................................................................................................................................................410
DHCP CLient Module .................................................................................................................................................411
DHCP Relay Module ....................................................................................................................................................411
DHCP Server Module..................................................................................................................................................412
Firewall Module .............................................................................................................................................................412
HTTP Module ................................................................................................................................................................412
Kernel Module ...............................................................................................................................................................413
Linestate Module...........................................................................................................................................................413
Login Module..................................................................................................................................................................413
NAPT Module................................................................................................................................................................413
PPP Module.....................................................................................................................................................................414
PPTP Module..................................................................................................................................................................414
Routing Module .............................................................................................................................................................414
Software Module ...........................................................................................................................................................415
UPnP Module .................................................................................................................................................................415
Supported Key Names ................................................................................ 417
Supported Internet Protocol (IP) Protocol Names ..............................................................................................417
Supported TCP/UDP Port Names............................................................................................................................418
Supported ICMP Type Names ...................................................................................................................................421
Supported Syslog Facilities ..........................................................................................................................................422
Supported Syslog Severities........................................................................................................................................423
15
About this Document
E-DOC-CTC-20040216-0003 v1.0
About this Document
Introduction
Welcome to the SpeedTouch™ 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 SpeedTouch™ CLI command set, to be used by the end-user to configure the
SpeedTouch™ and PC(s).
For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch™ via its character based CLI command set.
Applicability
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch™
products:
• SpeedTouch™580 Wireless Multi-User ADSL Gateway (R4.2.7)
For readability, all are referred to as SpeedTouch™ throughout this document unless a specific variant is concerned.
Contents
The Reference Guide consists of two main parts:
• CLI Navigation:
This chapter familiarizes the user with the SpeedTouch™ 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 SpeedTouch™ 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 SpeedTouch™
• 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.
16
About this Document
E-DOC-CTC-20040216-0003 v1.0
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 improved.
For more information on the latest technological innovations, software upgrades, and documents, please visit the
SpeedTouch™ web site at:
www.speedtouch.com
17
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
CLI Navigation
Introduction
This chapter familiarizes the user with the SpeedTouch™ CLI. It describes general manipulations:
• to navigate through the CLI
• to perform some operations on the CLI.
Contents
This chapter covers the following topics:
Topi c Pag e
Accessing the Command Line Interface 18
Basic Navigation and Manipulation 19
Command Line Interface Top Level Structure 23
Command Line Interface Commands 24
Menu-driven CLI Navigation 25
Service Template Files and the CLI 28
Direct FTP Access 30
18
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
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™.
Proceed as follows to open a Telnet session:
1 Open a Command Prompt window, e.g. by clicking Start > All Programs > Accessories > Command Prompt.
2 At the prompt, type telnet followed by the IP address of the SpeedTouch™ (default is 10.0.0.138).
As soon a session to the CLI is opened, the SpeedTouch™ banner pops up, followed by the CLI prompt.
If the SpeedTouch™ 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 SpeedTouch™580 banner after opening a session and authentication.
Username : johndoe
Password : *******
-----------------------------------------------------------------------*
* ______ SpeedTouch 580
* ___/_____/\
* / /\\ Version 4.2.7.5.7
* _____/__ / \\
* _/ /\_____/___ \ Copyright (c) 1999-2003,
* // / \ /\ \ THOMSON
* _______//_______/ \ / _\/______
* / /\ \/// /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
*\ \/ /\\\ \/
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/\\/
* \ \ /___\/
* \____\/
*
-----------------------------------------------------------------------=>
19
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
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™580:
To return to top level, or to go up one level (in case of nested command groups), enter .. at the prompt.
Example:
=>?
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 switch system systemlog td
upnp wireless
=>
=>phonebook
[phonebook]=>
[phonebook]=>..
=>
20
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
The Help Command
Execute help or ? from top level to list all available commands and command groups for the SpeedTouch™.
Example for the SpeedTouch™580:
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:
=>?
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 switch system systemlog td
upnp wireless
=>
=>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]=>
21
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
As both help and ? have the exact same functionality in the SpeedTouch™ 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:
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:
Executing help all will generate the complete listing of all available CLI commands with syntax description.
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.
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.
=>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
=>
=>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.
=>
=>firewall
[firewall]=>"a+TAB"
[firewall]=>assign
22
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
Command Line Navigation
• Press CTRL+A to go to the beginning of the command line.
• Press CTRL+L to go to the end of the command line.
Breaking off Commands
You can break off a command by pressing CTRL+G. 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 =
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]=>match
chain =
chain =
chain = “CTRL+G”
[firewall]=>
=>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
23
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
Command Line Interface Top Level Structure
The table below shows the available command groups for the different SpeedTouch™ variants:
Command group Available?
adsl Yes.
atm Yes.
autopvc Yes.
bridge Yes.
cip Yes
config Yes.
dhcp Yes.
dns Yes.
env Yes.
eth Yes.
ethoa Yes.
firewall Yes.
ip Yes.
ipoa Yes.
label Yes.
language Yes.
nat Yes.
phonebook Yes.
pppoa Yes.
pppoe Yes.
pptp Yes.
qosbook Yes.
script Yes.
snmp Yes.
software Yes.
switch Yes.
system Yes.
systemlog Yes.
td Yes.
upnp Yes.
wireless Yes.
24
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
Command Line Interface Commands
Command Execution
All CLI commands are commands that operate on, or configure, the SpeedTouch™ settings.
The CLI commands can be executed:
• from top level, preceded by the name of the command group from which the command should be executed.
E. g. firewall list.
• from within the command group itself, using the reduced form of the command.
E.g. list at the firewall command group selection.
Note ! in a command means ‘NOT‘, e.g. the [!]syn parameter in the firewall rule create command.
Entering a CLI Command
A CLI command can be entered in one of the following ways:
1 As a completely built-up command with all its parameters.
E.g. the command firewall assign hook=input chain=input.
2 Just the command itself without its parameters. After pressing Enter, you are prompted to complete the command
with the required and the optional parameters.
The example below is the equivalent of the command firewall assign hook=input chain=input.
• For required CLI command parameter values, either enter a value or scroll through the possible values with
the arrow keys.
• For optional CLI command parameters, either enter a value or simply press Enter without giving a value.
Note This manner of entering a command is not applicable to all the CLI commands.
E.g. system config, upnp config, ...
=>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]=>
=>firewall assign hook=input chain=input
=>
=>firewall assign
hook = input
chain = input
=>
25
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
Menu-driven CLI Navigation
Introduction
To improve the user-friendliness of the SpeedTouch™ CLI, the CLI features a menu-driven interface.
The semi-graphical menu offers an attractive and easy-to-use configuration environment for the CLI.
Calling the menu
To call the menu-driven interface, type menu at the CLI prompt.
Example (for the SpeedTouch™580):
Leaving the menu
To leave the menu-driven interface, use the TAB key to go to the Cancel field and press ENTER.
Note This can be done on any level of the menu, i.e. there is no need to return to the top level.
Navigating through the menu
Follow the procedure below to navigate through the menu and select CLI commands:
1 Browse through the CLI command groups with the ARROW keys:
26
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
2 Press ENTER to select a command group. The figure below shows the menu after the phonebook command group
has been selected:
3 Browse through the CLI commands with the ARROW keys or select .. to go back up one level:
4 Press ENTER to select the command. The figure below shows the menu after the add command has been
selected:
Entering parameter values
1 Browse through the parameters with the ARROW keys:
2 To enter a value for a parameter, press ENTER:
27
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
3 Fill in the parameter value and press ENTER:
4 Use the ARROW keys to scroll to the next parameter:
5 When all the necessary parameters have been entered, 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).
Preset parameter values
In case preset values are provided for a parameter, they are shown at the bottom of the menu.
You can scroll through these preset values with the ARROW keys or enter the value manually.
28
CLI Navigation
E-DOC-CTC-20040216-0003 v1.0
Service Template Files and the CLI
Service Template Files
The Service Template files, used by the Setup wizard, or directly uploaded via the SpeedTouch™ web pages, consist of
a set of CLI commands. Only CLI commands, which are part of the SpeedTouch™ CLI command set, may be used in
the .ini and .def files.
For readability, Service Template files are partitioned in paragraphs. These paragraphs reflect a CLI command group
selection in the SpeedTouch™ CLI. However, due to internal processing, not all paragraph names are the same as their
corresponding CLI command group selection.
The table below shows the relationship between the [<configuration>.ini] paragraphs and the available
SpeedTouch™ CLI commands:
[<configuration>.ini] paragraphs Available SpeedTouch™ CLI commands
[adslpots.ini] The adsl CLI command group
[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
[diagnostics.ini] The ip ping CLI command
[dnsc.ini] and [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
[pfirewall.ini] The firewall CLI command group
[phone.ini] The phonebook CLI command group
[pppoa.ini] The pppoa CLI command group
[pppoe.ini] The pppoe CLI command group
Loading...