SpeedTouch 500 CLI Reference Guide

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.
5
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
6
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
7
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
8
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
9
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
10
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
11
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
12
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
13
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
14
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
15
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
16
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
17
About this Document
E-SIT-CTC-20030410-0049 v1.0
About this Document
Introduction
Welcome to the SpeedTouch500Series 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 SpeedTouch500Series CLI command set, to be used by the end-user to
configure the SpeedTouch500Series and PC(s).
For the fastidious user this Reference Guide aims to give a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch500Series via its character based Command Line Interface.
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch
products:
SpeedTouch510 ADSL/POTS
SpeedTouch510i ADSL/ISDN
SpeedTouch530
SpeedTouch570 Wireless
SpeedTouch570i Wireless
Contents
The Reference Guide consists of two main parts:
CLI Navigation
This chapter familiarises the user with the SpeedTouch500Series CLI. It describes general manipulations to navi-
gate through and to perform some operations on the CLI.
CLI Command Description
The other chapters describe all the available CLI commands of the SpeedTouch500Series 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 SpeedTouch500Series
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.
18
About this Document
E-SIT-CTC-20030410-0049 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 upgraded.
For more information on the latest technological innovations, software upgrades, and documents, please visit the
SpeedTouch web site at:
www.speedtouch.com
19
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
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
20
CLI Navigation
E-SIT-CTC-20030410-0049 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 SpeedTouch500Series.
.As soon a session to the CLI is opened, the SpeedTouch500Series banner pops up, followed by the CLI prompt.
In case the SpeedTouch500Series is protected by a System password, authentication will be required before access is
granted.
The following figure shows an example of the SpeedTouch500Series 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
* _______//_______/ \ / _\/______
* / / \ \ / / / /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
* \ \/ / \ \ \ \ /
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/ \ \ /
* \ \ /___\/
* \____\/
*
------------------------------------------------------------------------
=>
21
CLI Navigation
E-SIT-CTC-20030410-0049 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 SpeedTouch510.
The following command groups are specific for certain variants:
usb is only available for the SpeedTouch530
wireless is only available for the SpeedTouch570
To return to top level, or to descend one level (in case of nested command groups) execute .. .
EXAMPLE:
=>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
=>
=>phonebook
[phonebook]=>
[phonebook]=>..
=>
22
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
The Help Command
Execute help or ? from top level to list all available command groups for the SpeedTouch500Series.
EXAMPLE for the SpeedTouch510:
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:
=>help
help : Displays this help information
menu : Displays menu
? : Displays this help information
exit : Exits this shell.
.. : Exits group selection.
saveall : Saves current configuration.
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
=>
=>firewall
[firewall]=>
[firewall]=>?
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.
chain rule
[firewall]=>
23
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
As both help and ? have the exact same functionality in the SpeedTouch500Series 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.
=>firewall help
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.
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.
=>
24
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
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:
Going to the beginning or end of the Command Line
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 =
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]=>"a+TAB"
[firewall]=>assign
To go to ... Press ...
the beginning of the Command Line CTRL+A
the end of the Command Line CTRL+E
[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
25
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
Command Line Interface Top Level Structure
The table below shows the available command groups for the different SpeedTouch500Series variants:
Command group Availability
adsl Only applicable for the SpeedTouch510 and SpeedTouch570 ADSL/POTS, and the Speed-
Touch510i and SpeedTouch570i 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 SpeedTouch530 variant.
wireless Only applicable for the SpeedTouch570 Wireless variant.
26
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
Command Line Interface Commands
All CLI commands are commands that operate on, or configure, the SpeedTouch500Series 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:
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 list
=>firewall
[firewall]=>list
[firewall]=>
=>firewall assign
hook = input
chain = input
=>
27
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
Menu-driven CLI Navigation
To improve the user-friendliness of the SpeedTouch500Series CLI, the CLI features a menu-driven interface.
To enter the menu-driven interface, simply execute menu from the CLI prompt:
EXAMPLE (for the SpeedTouch510):
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).
28
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
Configuration Profile Files and the CLI
Configuration Profile Files
The configuration profile files, used by the Setup wizard, or directly uploaded via the SpeedTouch500Series web
pages, consist of a set of CLI commands. Only CLI commands, which are part of the SpeedTouch500Series CLI
command set may be used in the .ini and .def files. For readability, configuration profile files are partitioned in para-
graphs. These paragraphs reflect a CLI command group selection in the SpeedTouch500Series 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 SpeedTouch500Series CLI commands and the
[<configuration>.ini] paragraphs is given:
[<configuration>.ini] paragraphs Available SpeedTouch500Series 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).
29
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
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 SpeedTouch500Series.
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 SpeedTouch500Series. 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 SpeedTouch500Series, the Setup wizard and the
configuration profile files, please check the SpeedTouch support pages at:
www.speedtouch.com

[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
[usb.ini] The usb CLI command group
[wireless.ini] The wireless CLI command group
[<configuration>.ini] paragraphs Available SpeedTouch500Series CLI commands
30
CLI Navigation
E-SIT-CTC-20030410-0049 v1.0
31
ADSL Commands
ADSL Commands
Contents
This chapter covers the following commands:
Topic Page
adsl config 32
adsl info 33
32
ADSL Commands
adsl config
Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration.
Although the same command for both SpeedTouch ADSL/POTS and SpeedTouch ADSL/ISDN variants, the
command features specific parameter values per variant:
SYNTAX for ADSL/Plain Old Telephone Service (POTS) variants:
SYNTAX for ADSL/Integrated Services Digital Network (ISDN) variants:
Note Executing the :adsl config without specifying parameters, shows the current ADSL configuration.
adsl config [opermode = <{ansi|g.dmt_annex_a|g.lite|multimode}>]
[maxbitspertoneUS = <number{10-14}>]
[trace = <{off|on}>]
opermode The operational mode of the SpeedTouch modem.
Choose between:
ansi
g.dmt_annex_a
g.lite
multimode
By default the SpeedTouch will start in multimode.
OPTIONAL
maxbitspertoneUS A number between 10 and 14 (bits per tone).
Represents the maximum number of bits which can be allocated to
each ADSL DMT tone in the upstream direction.
By default the modem will use up to 13 bits per tone.
OPTIONAL
trace Enable/Disable adsl tracing OPTIONAL
adsl config [opermode = <{etsi|g.dmt_annex_b|multimode}>]
[maxbitspertoneUS = <number{10-14}>][trace = <{off|on}>]
opermode The operational mode of the SpeedTouch modem.
Choose between:
etsi
g.dmt_annex_b
multimode
By default the SpeedTouch will start in multimode.
OPTIONAL
maxbitspertoneUS A number between 10 and 14 (bits per tone).
Represents the maximum number of bits which can be allocated to
each ADSL DMT tone in the upstream direction.
By default the modem will use up to 13 bits per tone.
OPTIONAL
trace Enable/Disable adsl tracing OPTIONAL
33
ADSL Commands
adsl info
Show ADSL statistics and information about the SpeedTouch DSL line status.
Although the same command for both SpeedTouch ADSL/POTS and SpeedTouch ADSL/ISDN variants, the
command features specific output parameters and counters per variant:
SYNTAX:
EXAMPLE (for a SpeedTouch500Series ADSL/POTS variant):
.. Continued output on following page ..
adsl info
=>adsl info
Modemstate : up
Operation Mode : G.DMT Annex A [POTS Overlay Mode]
Channel Mode : fast
Number of resets : 1
Vendor (ITU) Local Remote
Country : 0f 0f
Vendor : ALCB ALCB
VendorSpecific : 0000 0000
StandardRevisionNr : 01 01
Downstream Upstream
Margin [dB] : 25 31
Attenuation [dB] : 26 15
Available Bandwidth Cells/s Kbit/s
Downstream : 7924 3360
Upstream : 452 192
Transfer statistics
Total since power On Cells Kbit
Upstream : 3399 1441
Current Connection
Upstream : 3399 1441
Errors
Received FEC : 0
Received CRC : 0
Received HEC : 0
34
ADSL Commands
.. Continued output ..
Far End Failure
No Failure
Near end failure
No failure
Far end failures since reset
Loss of frame: 0 failures
Loss of signal: 0 failures
Loss of power: 0 failures
Loss of link: 0 failures
Errored seconds: 0 seconds
Far end failures last 15 minutes
Loss of frame: 0 seconds
Loss of signal: 0 seconds
Loss of power: 0 seconds
Loss of link: 0 seconds
Far end failures current day
Far end failures previous day
Near end failures since reset
Loss of frame: 0 failures
Loss of signal: 0 failures
Loss of power: 0 failures
Near end failures last 15 minutes
Loss of frame: 0 seconds
Loss of signal: 0 seconds
Loss of power: 0 seconds
Near end failures current day
Near end failures previous day
=>
35
ATM Commands
ATM Commands
Contents
Topic Page
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
36
ATM Commands
atm aal5stats
Display AAL5 port specific Asynchronous Transfer Mode (ATM) statistics
SYNTAX:
atm aal5stats port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
vpi = <number{0-15}>
[vci = <number{0-511}>]
[reset = <{no|yes}>]
port Port for which statistics will be retrieved.
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
Or specify a port number (dsl0 has port number 0, ..., atm5 has port
number 5).
The parameter DSL0 is replaced by the parameter ADSL0 for the
SpeedTouch570.
REQUIRED
vpi A number between 0 and 15.
Represents the VPI number for which statistics will be retrieved.
REQUIRED
vci A number between 0 and 511.
Represents the VCI number for which statistics will be retrieved.
OPTIONAL
reset Reset the statistics after request OPTIONAL
37
ATM Commands
atm gstats
Display ATM global statistics.
SYNTAX:
Note The command :atm portstats is replaced by the command :atmstats portstats for the SpeedTouch570. The
command :atmstats portstats is the only ATM command for the SpeedTouch570.
EXAMPLE:
atm gstats [reset = <{no|yes}>]
reset Reset the statistics after request OPTIONAL
=>atm gstats
# of received octets = 170554.
# of transmitted octets = 519665.
# of received cells = 3218.
# of transmitted cells = 9805.
# of unknown cells = 0.
# of errors on the input = 0.
# of errors on output = 0.
=>
38
ATM Commands
atm portstats
Show port specific ATM statistics.
SYNTAX:
EXAMPLE:
atm portstats port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
number 5).
SpeedTouch570.
REQUIRED
reset Reset the statistics after request. OPTIONAL
=>atm portstats port=DSL0
# of received octets = 547649.
# of transmitted octets = 191648.
# of received cells = 10333.
# of transmitted cells = 3616.
# of unknown cells = 0.
# of errors on the input = 0.
# of errors on output = 0.
=>
39
ATM Commands
atm vcstats
Display VC specific atm statistics
SYNTAX:
atm vcstats port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
[vci = <number{0-511}>]
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
number 5).
SpeedTouch570.
REQUIRED
Represents the VPI number for which statistics will be retrieved.
REQUIRED
Represents the VCI number for which statistics will be retrieved.
OPTIONAL
reset Reset the statistics after request. OPTIONAL
40
ATM Commands
atm oam ccconfig
Configure Operation and Maintenance (OAM) Continuity Check (CC) on the connection.
SYNTAX:
RELATED COMMANDS:
atm oam ccconfig port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
[vci = <number{0-511}>]
[transmit = <{disabled|enabled}>]
[receive = <{disabled|enabled}>]
[auto = <{disabled|enabled}>]
[span = <{segment|end2end}>]
port ATM port number.
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
number 5).
SpeedTouch570.
REQUIRED
Represents the Virtual Path Identifier (VPI)
REQUIRED
Represents the Virtual Channel identifier (VCI).
Use VCI=0, or do not specify for a VP cross-connection.
OPTIONAL
transmit Enable (enabled) or disable (disabled) transmission of CC cells.
By default transmission of CC cells is disabled.
OPTIONAL
receive Enable (enabled) or disable (disabled) loss of continuity.
By default loss of continuity is disabled.
OPTIONAL
auto Enable (enabled) or disable (disabled) remote CC activation and
deactivation.
By default remote CC activation/deactivation is disabled.
OPTIONAL
span End2end or segment continuity check OPTIONAL
atm oam cclist Show current CC configuration.
41
ATM Commands
atm oam ccsend Send CC activate/deactivate to connection.
42
ATM Commands
atm oam cclist
Show current OAM CC configuration
SYNTAX:
EXAMPLE (default configuration):
RELATED COMMANDS:
atm oam cclist
=>atm oam cclist
PORT = 0 VPI = 15 VCI = 64 End2End Mode = Auto Segment Mode = Auto
=>
atm oam ccconfig Configure CC on the connection.
atm oam ccsend Send CC activate/deactivate to connection.
43
ATM Commands
atm oam ccsend
Send CC activate/deactivate to connection.
SYNTAX:
RELATED COMMANDS:
atm oam ccsend port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
[vci = <number{0-511}>]
[span = <{segment|end2end}>]
[action = <{activate|deactivate}>]
[direction = <{source|sink|both}>]
port ATM port number.
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
number 5).
SpeedTouch570.
REQUIRED
Represents the Virtual Path Identifier (VPI)
REQUIRED
Represents the Virtual Channel identifier (VCI).
Use VCI=0, or do not specify for a VP cross-connection.
OPTIONAL
span End2end or segment continuity check OPTIONAL
action Enable or disable (default) CC. OPTIONAL
direction Indicates the direction of CC activity
Select either:
source
sink
both.
If not specified, CC is activated/deactivated for both directions.
OPTIONAL
atm oam ccconfig Configure CC on the connection.
44
ATM Commands
atm oam cclist Show current CC configuration.
45
ATM Commands
atm oam config
Configure OAM cell settings.
SYNTAX:
atm oam config [clp = <number{0-1}>]
[loopbackid = <string>]
clp The CLP bit value of the OAM cells.
Select either:
0
1
OPTIONAL
loopbackid The loopback id (hexadecimal string) for processing of segment
loopback cells.
Default is 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a.
OPTIONAL
46
ATM Commands
atm oam mode
Configure the OAM data blocking mode.
SYNTAX:
atm oam mode port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
blocking = <{disabled|enabled}>
port Port for which OAM blocking is configured.
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5
number 5).
REQUIRED
blocking Enable (enabled) or disable (disabled) the OAM data blocking mode
on this port.
By default OAM data blocking is enabled on all ports.
REQUIRED
47
ATM Commands
atm oam ping
Sends ATM loopback cells.
SYNTAX:
EXAMPLE:
atm oam ping dest = <string>
[count = <number{1-1000000}>]
[interval = <number{100-1000000}>]
dest The destination address for the request.
Can be any phonebook entry.
REQUIRED
count A number between 1 and 1000000.
Represents the number of pings to send.
OPTIONAL
interval A number between 1 and 1000000.
Represents the interval in milliseconds between packets.
OPTIONAL
=>atm oam ping dest=Sascha count=10 interval=200
loopback: successful, sequence: 1 time: 7762 usec
--- loopback statistics ---
10 loopbacks transmitted, 10 successful, 0% loss, time 600 ms
rtt min/avg/max = 7209/13301/41656
=>
48
ATM Commands
atm oam status
Show OAM data blocking mode of all ports.
SYNTAX:
EXAMPLE:
atm oam status
=>atm oam status
OAM config dump
-------------------
CLP bit value : 1
Loopback id : 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a
OAM data blocking mode
--------------------------
Port dsl0: blocking
Port dsl1: blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking
=>
49
AutoPVC Commands
AutoPVC Commands
Contents
Topic Page
autopvc config 50
autopvc info 52
50
AutoPVC Commands
autopvc config
Configure autopvc
SYNTAX:
autopvc config [mode = <{pseudo|passive|active}>]
[type = <{bridge|pppoerelay}>]
[opmode = <{partial|full}>]
[overwrite = <{disabled|enabled}>]
[peakrate = <number{0-27786}>]
mode Select the autopvc mode:
pseudo: enable only pseudo-ILMI (VP/VC 15/16). When
connection parameters are written to the MIB, display this
information on CLI or web-interface but do not use these
parameters for configuration.
passive: enable both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/
VC 15/16). When connection parameters are written to the
MIB, display this information on CLI or web-interface but do
not use these parameters for configuration. (default)
active: enable both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC
15/16). When connection parameters are written to the MIB,
use these parameters to configure phonebook entries,
qosbook profiles and bind bridge or PPPoE interfaces on top.
OPTIONAL
type Type of autopvc:
bridge (default)
pppoerelay: an ETHoA interface will be created, will be bound
to the ILMI PVC and will be added to the PPPoE relay as relay
port.
OPTIONAL
opmode Operational autopvc mode:
partial: only read the ILMI VPC and VCC MIB tables (default)
full: read all supported MIB tables
OPTIONAL
overwrite Enable/disable UBR peak rate overwrite. OPTIONAL
peakrate A number between 0 and 27786.
Represents the UBR peak rate (in kilobits per second).
Note 0 indicates the linerate
OPTIONAL
51
AutoPVC Commands
RELATED COMMANDS:
=>autopvc config
Autopvc mode : pseudo
Autopvc opmode : partial
Autopvc type : bridge
Autopvc standard: down
Autopvc pseudo : up
UBR overwrite : disabled
UBR peak rate : linerate
=>
autopvc info Show retrieved information.
52
AutoPVC Commands
autopvc info
Show retrieved information.
SYNTAX:
RELATED COMMANDS:
autopvc info [table = <{Port|AtmLayer|Vpc|Vcc|Address|
AddressRegistrationAdmin|AtmServiceType|
AtmServiceConnectionInfo|AAL1Profile|
AAL34Profile|AAL5Profile|AAL2CommonProfile|
AAL2TrunkingProfile|AAL2LESProfile}>]
table Choose the autopvc table for which the information must be shown.
Choose between:
Port
AtmLayer
Vpc
Vcc
Address
AddressRegistrationAdmin
AtmServiceType
AtmServiceConnectionInfo
AAL1Profile
AAL34Profile
AAL5Profile
AAL2CommonProfile
AAL2TrunkingProfile
AAL2LESProfile
OPTIONAL
=>autopvc info
Address Type BestEff Par1 Par2 Par3 Par4 Par5
8.35 ubr Enabled Tx: 451 0 0 0 0
Rx: 7923 0 0 0 0
=>
autopvc config Configure autopvc
53
Bridge Commands
Bridge Commands
Contents
Topic Page
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
54
Bridge Commands
bridge config
Show/set bridge ageing policy for dynamically learned Medium Access Control (MAC) addresses.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge config [age = <number {10 - 100000}>]
[filter = <{no_WAN_broadcast|PPPoE_only|none}>]
age A number between 10 and 100000 (seconds).
Represents the lifetime of a dynamically learned MAC address.
By default the ageing timer is 300 seconds.
OPTIONAL
filter The bridge filter to be applied for all WAN bridge ports.
Choose between:
no_WAN_broadcast (default):
broadcasts from the SpeedTouch itself to the WAN are
filtered out, broadcasts from the LAN to the WAN are still
passed through.
PPPoE_only:
only PPPoE broadcasts are passed through, all others are
filtered out
none:
no broadcasts are filtered out.
OPTIONAL
=>bridge config
Ageing : 300
Filter : no_WAN_broadcast
=>bridge config age=600
=>bridge config
Ageing : 600
Filter : no_WAN_broadcast
=>
bridge ifadd Create a bridged Ethernet interface.
bridge ifattach Attach a bridge interface.
bridge ifdelete Delete a bridge interface.
bridge ifdetach Detach a bridge interface.
bridge iflist Show current bridge configuration.
55
Bridge Commands
bridge flush
Flush bridge interfaces and parameters.
Note The flush command does not impact previously saved configurations.
SYNTAX:
bridge flush
56
Bridge Commands
bridge ifadd
Create a bridged Ethernet interface.
57
Bridge Commands
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge ifadd [intf = <intfname>]
[dest = <string>]
intf The bridged Ethernet interface name.
If not specified, the destination name will double as interface name.
OPTIONAL
dest The destination address for the new interface.
Typically a phonebook entry. Browse through the available entries via
the ARROW UP and ARROW DOWN keys.
OPTIONAL
=>bridge iflist
OBC : Internal
Connection State: connected Port: OBC PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82768372 frames: 341221 dropframes: 0
eth0 : Internal
Connection State: connected Port: eth0 PortState: forwarding
RX bytes: 156344216 frames: 5899238
usb_bridge : dest : usb_port
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan2 PortNr: 4 PortState: forwarding
=>bridge ifadd intf=TestBridge dest=Br1
=>bridge iflist
OBC : Internal
eth0 : Internal
RX bytes: 156472129 frames: 5903256
TestBridge : dest : Br1
Retry: 10 QoS: default Encaps: llc/snap Fcs: off
Connection State: not-connected Port: (Unassigned) PortState: forwarding
=>
bridge ifconfig Configure a bridge interface.
58
Bridge Commands
59
Bridge Commands
bridge ifattach
Attach (i.e. connect) a bridged Ethernet interface.
60
Bridge Commands
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge ifattach intf = <intfname>
intf The name of the interface to attach.
Browse through the available entries via the ARROW UP and
ARROW DOWN keys.
REQUIRED
=>bridge iflist
OBC : Internal
eth0 : Internal
RX bytes: 156472129 frames: 5903256
Connection State: not-connected Port: (Unassigned) PortState: forwarding
=>bridge ifattach intf=TestBridge
=>bridge iflist
OBC : Internal
eth0 : Internal
RX bytes: 156472129 frames: 5903256
Connection State: connected Port: wan0 PortState: forwarding
=>
61
Bridge Commands
62
Bridge Commands
bridge ifconfig
Configure a bridge interface.
SYNTAX:
Note In case of a SpeedTouch530 device, never change, or delete the usb_bridge interface!
bridge ifconfig intf = <intfname>
[dest = <string>]
[qos = <string>]
[encaps = <{llc/snap|vcmux}>]
[fcs = <{off|on}>]
[portstate = <{disabled|learning|forwarding}>]
[retry = <number {0-65535}>]
intf The name of the bridge interface to configure. REQUIRED
dest The destination for this interface. Typically a phonebook entry.
This parameter only needs to be specified when an interface has
been created without specified destination.
OPTIONAL
qos The name of the Quality Of Service (QoS) book entry to apply on
this bridge interface.
OPTIONAL
encaps The type of encapsulation to be used for this bridge interface.
Choose between:
llc/snap
vcmux
OPTIONAL
fcs Whether or not to include the Ethernet FCS in the packet header on
the WAN side. Choose between:
off (default)
on
Note FCS is normally left off.
OPTIONAL
portstate The bridge portstate for this interface. Choose between:
disabled
learning
forwarding
OPTIONAL
retry A number between 0 and 65535.
Represents the number of times the SpeedTouch retries to set up
a WAN connection before giving up.
By default the retry value is 10.
OPTIONAL
63
Bridge Commands
EXAMPLE:
RELATED COMMANDS:
=>bridge iflist intf=TestBridge
=>bridge ifconfig intf=TestBridge encaps=vcmux retry=15
Retry: 15 QoS: default Encaps: vcmux Fcs: off
=>
64
Bridge Commands
bridge ifdelete
Delete a bridge interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge ifdelete intf = <intfname>
intf The name of the interface name to delete.
ARROW DOWN keys.
REQUIRED
=>bridge ifdelete intf=TestBridge
=>bridge iflist
OBC : Internal
eth0 : Internal
RX bytes: 156472129 frames: 5903256
=>
65
Bridge Commands
bridge ifdetach
Detach (i.e. disconnect) a bridge interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge ifdetach intf = <intfname>
intf The name of the bridge interface to detach.
ARROW DOWN keys.
REQUIRED
=>bridge ifdetach intf=TestBridge
Connection State: not-connected Port: (unassigned) PortState: forwarding
=>
66
Bridge Commands
bridge iflist
Show the current state of all or the selected bridge interfaces.
SYNTAX:
EXAMPLE:
DESCRIPTION:
RELATED COMMANDS:
bridge iflist [intf = <intfname>]
intf The name of the bridge interface for which the configuration must be
shown.
ARROW DOWN keys.
If no interface is specified, all bridge interfaces are shown.
OPTIONAL
=>bridge iflist
OBC : Internal
eth0 : Internal
RX bytes: 156344216 frames: 5899238
Retry: 15 QoS: default Encaps: vcmux Fcs: off
=>
RX bytes The number of Received bytes
TX bytes The number of Transmitted bytes
OBC On Board Controller: indicates the physical bridge port.
67
Bridge Commands
68
Bridge Commands
bridge macadd
Add a static MAC address to the filtering database. Allows to manually add static addresses, which should normally be
dynamically discovered by the bridge itself.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge macadd intf = <intfname>
hwaddr = <hardware-address>
intf The name of the bridge interface to add the MAC address for. REQUIRED
hwaddr The Ethernet MAC address of the new entry. REQUIRED
=>bridge maclist
00:90:d0:01:02:03 -- static, OBC
ff:ff:ff:ff:ff:ff -- static, OBC
01:80:c2:00:00:00 -- static, OBC
01:80:c2:00:00:01 -- static, OBC
...
01:80:c2:00:00:10 -- static, OBC
00:01:42:5f:7d:81 -- dynamic, eth0, 597 seconds
00:50:8b:31:cc:aa -- dynamic, eth0, 513 seconds
08:00:20:c1:9a:12 -- dynamic, eth0, 600 seconds
...
=>bridge macadd intf=eth0 hwaddr=00:80:9f:01:23:45
=>bridge maclist
00:90:d0:01:02:03 -- static, OBC
01:80:c2:00:00:00 -- static, OBC
01:80:c2:00:00:01 -- static, OBC
...
01:80:c2:00:00:10 -- static, OBC
00:80:9f:01:23:45 -- permanent, eth0
00:08:c7:c3:5f:fc -- dynamic, eth0, 215 seconds
...
=>
bridge macdelete Delete a MAC address entry.
bridge maclist Show current filtering database.
69
Bridge Commands
bridge macdelete
Remove a MAC address from the filtering database.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge macdelete hwaddr = <hardware-address>
hwaddr The Ethernet MAC address of the entry to delete. REQUIRED
=>bridge maclist
00:90:d0:01:02:03 -- static, OBC
01:80:c2:00:00:00 -- static, OBC
01:80:c2:00:00:01 -- static, OBC
...
01:80:c2:00:00:10 -- static, OBC
00:80:9f:01:23:45 -- permanent, OBC
...
=>bridge macdelete hwaddr=00:80:9f:01:23:45
=>bridge maclist
00:90:d0:01:02:03 -- static, OBC
01:80:c2:00:00:00 -- static, OBC
01:80:c2:00:00:01 -- static, OBC
...
01:80:c2:00:00:10 -- static, OBC
...
=>
bridge macadd Add a static MAC address to the filtering database.
bridge maclist Show current filtering database.
70
Bridge Commands
bridge maclist
Shows the current MAC address filtering database.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
bridge maclist
=>bridge maclist
=>bridge maclist
00:90:d0:01:02:03 -- static, OBC
01:80:c2:00:00:00 -- static, OBC
01:80:c2:00:00:01 -- static, OBC
...
01:80:c2:00:00:10 -- static, OBC
00:80:9f:24:ab:cf -- static, OBC
08:00:20:a8:f4:34 -- dynamic, eth0, 600 seconds
08:00:20:83:b7:26 -- dynamic, eth0, 600 seconds
00:10:83:1b:13:18 -- dynamic, eth0, 599 seconds
...
=>
bridge macadd Add a static MAC address to the filtering database.
bridge macdelete Delete a MAC address entry.
71
CIP Commands
CIP Commands
Contents
Topic Page
cip flush 72
cip ifadd 73
cip ifdelete 74
cip iflist 75
cip pvcadd 76
cip pvcdelete 77
cip pvclist 78
72
CIP Commands
cip flush
Flush complete Classical IP over ATM (IP oA) configuration.
SYNTAX:
cip flush
73
CIP Commands
cip ifadd
Create a Classical IP oA interface at the local side of the Logical IP Subnet (LIS).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
cip ifadd addr = <ip-address>
[netmask = <ip-mask (dotted or cidr)>]
[uniaddr = <portspec:address[.selector]>]
addr The Classical IP oA interface's local IP address in the LIS. REQUIRED
netmask The LIS's subnetmask. OPTIONAL
uniaddr The UNI-address/port specification for incoming connections, e.g.
A0:*.03: ADSL port, any address, selector 3.
Only applicable in an Switched Virtual Channel (SVC) environment.
In most cases the Classical IP oA LIS is built in a Permanent Virtual
Channel (PVC) environment.
OPTIONAL
=>cip iflist
cip1 addr = 172.16.0.5 mask = 255.255.255.0
UNI address = A0:*.04
inarp_reqs_in = 0 inarp_repl_in = 0 inarp_inv_in = 0
inarp_reqs_out = 0 inarp_repl_out = 0 inarp_inv_out = 0
=>cip ifadd addr=172.16.1.1 netmask=255.255.255.0
=>cip iflist
cip1 addr = 172.16.0.5 mask = 255.255.255.0
cip0 addr = 172.16.1.1 mask = 255.255.255.0
=>
cip ifdelete Delete a Classical IP oA interface.
cip iflist Show current Classical IP oA configuration.
74
CIP Commands
cip ifdelete
Delete a Classical IP oA interface at the local side of the LIS.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
cip ifdelete addr = <ip-address>
addr The Classical IP oA interface's local IP address in the LIS. REQUIRED
=>cip iflist
cip0 addr = 172.16.1.1 mask = 255.255.255.0
cip1 addr = 172.16.0.5 mask = 255.255.255.0
=>cip ifdelete addr=172.16.1.1
=>cip iflist
cip1 addr = 172.16.0.5 mask = 255.255.255.0
=>
cip ifadd Create a Classical IP oA interface at the local side of the Logical IP Subnet.
cip iflist Show current Classical IP oA configuration.
75
CIP Commands
cip iflist
Show current Classical IP oA configuration.
SYNTAX:
EXAMPLE:
DESCRIPTION:
EXAMPLE INPUT/OUTPUT: EVOLUTION OF ARP REQUESTS IN A NETWORKED ENVIRONMENT:
RELATED COMMANDS:
cip iflist
=>cip iflist
cip0 addr = 172.16.1.1 mask = 255.255.255.0
cip1 addr = 172.16.0.5 mask = 255.255.255.0
=>
inarp_reqs_in/inarp_reqs_out Incoming/outgoing inverse ARP requests
inarp_repl_in/inarp_repl_out Incoming/outgoing inverse ARP replies
inarp_inv_in/inarp_inv_out Incoming/outgoing invalid inverse ARP messages
=>cip iflist
cip0 addr = 200.200.200.138 mask = 255.255.255.0
=>cip iflist
cip0 addr = 200.200.200.138 mask = 255.255.255.0
=>cip iflist
cip0 addr = 200.200.200.138 mask = 255.255.255.0
=>
cip ifadd Create a Classical IP oA interface at the local side of the Logical IP Subnet.
cip ifdelete Delete a Classical IP oA interface.
76
CIP Commands
cip pvcadd
Create a PVC Address Resolution Protocol (ARP) entry for destinations which are not RFC1577/RFC2225 compliant.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
cip pvcadd dest = <phonebookname>
[destaddr = <ip-address>]
[mtu = <number {273-20000}>]
dest The ATM address (hardware address) of the destination host.
Typically a phonebook name.
REQUIRED
destaddr The IP address of the destination host. OPTIONAL
mtu A number between 273 and 20000 (bytes).
Represents the maximum ATM Adaption Layer 5 (AAL5) packet size
for this connection.
By default the mtu is 9180 bytes.
OPTIONAL
=>phonebook list
Name Type Use Address
Br1 bridge 1 8.35
Br2 bridge 1 8.36
Br3 bridge 1 8.37
Br4 bridge 0 8.38
RELAY_PPP1 ppp 0 8.48
PPP1 ppp 1 8.64
PPP2 ppp 1 8.65
PPP3 ppp 1 8.66
DHCP_SPOOF ppp 1 8.67
CIPPVC1 cip 0 8.80
CIPPVC2 cip 0 8.81
CIPPVC3 cip 0 8.82
CIPPVC4 cip 0 8.83
=>cip pvclist
=>cip pvcadd dest CIPPVC1 destaddr 172.16.1.2 mtu 546
=>cip pvclist
CIPPVC1 atmport = 0 vpi = 8 vci = 80 dest_ip = 172.16.1.2
encaps = llc mtu = 546
=>
cip pvcdelete Delete a PVC ARP entry.
cip pvclist Show current PVC ARP entries.
77
CIP Commands
cip pvcdelete
Delete a PVC ARP entry.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
cip pvcdelete dest = <phonebookname>
dest Typically a phonebook entry name.
Represents the ATM address (hardware address) or name of the
entry to delete.
REQUIRED
=>cip pvclist
=>cip pvcdelete dest=CIPPVC1
=>cip pvclist
=>
cip pvcadd Creates a PVC ARP entry.
cip pvclist Show current PVC ARP entries.
78
CIP Commands
cip pvclist
Show current PVC ARP entries.
SYNTAX:
EXAMPLE:
EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
RELATED COMMANDS:
cip pvclist
=>cip pvclist
=>
=>cip iflist
cip0 addr = 200.200.200.138 mask = 255.255.255.0
=>cip pvclist
699 atmport = 0 vpi = 6 vci = 99 dest_ip = 172.16.1.3
8.50 atmport = 0 vpi = 8 vci = 50 dest_ip = 200.200.200.14
=>
cip pvcadd Creates a PVC ARP entry.
cip pvcdelete Delete a PVC ARP entry.
79
Config Commands
Config Commands
Contents
Topic Page
config backup 80
config dump 81
config erase 82
config flush 83
config list 84
config load 85
config save 87
80
Config Commands
config backup
Store current configuration to backup file.
SYNTAX:
RELATED COMMANDS:
config backup filename = <user configuration filename>
filename Filename for backup file of current configuration REQUIRED
config dump Shows the saved configuration file
config list Shows the current configuration set.
81
Config Commands
config dump
Shows the saved configuration file.
SYNTAX:
RELATED COMMANDS:
config dump
config backup Store current configuration to backup file.
config list Shows the current configuration set.
82
Config Commands
config erase
Physically remove all saved configurations, i.e. the user configuration file, saved in the SpeedTouch permanent storage,
is deleted.
SYNTAX:
RELATED COMMANDS:
config erase [filename = <user configuration filename>]
filename Name of the configuration file to erase. OPTIONAL
config flush Flush complete runtime configuration.
config load Load complete saved or default configuration.
config save Save complete runtime configuration.
83
Config Commands
config flush
Flush complete current configuration without affecting saved configurations.
This combines all flush commands: bridge flush, cip flush, dhcp client flush, dhcp relay flush, dhcp server flush,
dhcp server lease flush, dhcp server pool flush, dns flush, env flush, ethoa flush, firewall flush, firewall chain flush,
firewall rule flush, ip flush, ip auto flush, ipoa flush, label flush, label chain flush, label rule flush, nat flush,
phonebook flush, pppoa flush, pppoe flush, pptp flush, qosbook flush, script flush, snmp flush, system flush, upnp flush
and wireless flush.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
config flush [flush_ip = <{no|yes}>]
flush_ip Flush current IP configuration (yes) or keep current IP configuration
(no).
Not keeping the IP settings could cause lost IP connectivity in the
LAN. By default IP settings are preserved.
OPTIONAL
=>ip rtlist
Destination Source Gateway Intf Mtrc
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
10.0.0.0/24 0.0.0.0/0 10.0.0.140 eth0 0
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>config flush flush_ip=no
=>ip rtlist
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
10.0.0.0/24 0.0.0.0/0 10.0.0.140 eth0 0
=>config flush flush_ip=yes
######### ALL TCP/IP CONNECTIVITY IS LOST ##########
config erase Physically remove all saved configurations.
config save Save current runtime configuration.
84
Config Commands
config list
Shows the current configuration set.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
config list [templates = <{no|yes}>]
templates Select yes to include the template configuration files in the list. OPTIONAL
=>config list templates=yes
Configurations file(s):
user.ini
Template file(s)
No template files present
Factory template file(s) :
pppoe.tpl
pppoa.tpl
br.tpl
=>
config backup Store current configuration to backup file.
config dump Shows the saved configuration file
85
Config Commands
config load
Load complete saved (backup) or default configuration file.
Note Execute config flush prior to config load.
SYNTAX:
EXAMPLE:
config load [load_ip = <{no|yes}>]
[defaults = <{yes|no}>]
[flush = <{yes|no}>]
[echo = <{no|yes}>]
[filename = <string>]
load_ip Load IP settings (yes) or not (no).
Not keeping the IP settings could cause lost IP connectivity in the
LAN.
OPTIONAL
defaults Load default configuration (yes) or saved configuration (no).
Not specifying this parameter loads the saved configuration
OPTIONAL
flush Flush current configuration before loading new one. OPTIONAL
echo Echo each command string when loaded. OPTIONAL
filename Configuration filename. OPTIONAL
=>ip rtlist
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
10.0.0.0/24 0.0.0.0/0 10.0.0.140 eth0 0
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>config flush flush_ip=no
=>ip rtlist
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
10.0.0.0/24 0.0.0.0/0 10.0.0.140 eth0 0
=>config load load_ip=yes
=>ip rtlist
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
10.0.0.0/24 0.0.0.0/0 10.0.0.140 eth0 0
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>
86
Config Commands
RELATED COMMANDS:
config save Save current runtime configuration.
87
Config Commands
config save
Save all existing configurations and modifications entered by the user.
The result of executing this command is a user.ini file saved in the SpeedTouch permanent storage. This file can be
downloaded via the SpeedTouch web pages or via an FTP session.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
config save
=>config save
=>
88
Config Commands
89
DHCP Commands
DHCP Commands
Contents
This chapter covers the following commands
Topic Page
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
90
DHCP Commands
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
Topic Page
91
DHCP Commands
dhcp client clear
Clear Dynamic Host Configuration Protocol (DHCP) client statistics.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client clear
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv : 0
OFFERs recv : 0
ACKs recv : 0
NAKs recv : 0
Pure BOOTP REPLIES : 0
Other message types : 0
DISCOVERs sent : 253
REQUESTs sent : 9
DECLINEs sent : 0
RELEASEs sent : 0
INFORMs sent : 0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 19, in use: 1, free: 94 %
=>dhcp client clear
=>dhcp client stats
OFFERs recv : 0
ACKs recv : 0
NAKs recv : 0
DISCOVERs sent : 0
REQUESTs sent : 0
DECLINEs sent : 0
RELEASEs sent : 0
INFORMs sent : 0
Memory usage:
=>
dhcp client stats Show DHCP client statistics.
92
DHCP Commands
dhcp client config
Show/set DHCP client configuration.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client config [trace = <{off|on}>]
trace Enable tracing (on) or not (off). OPTIONAL
=>dhcp client config
tracing: off
=>dhcp client config trace=on
=>dhcp client config
tracing: on
=>
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
93
DHCP Commands
dhcp client flush
Flush complete DHCP client configuration and dynamic interfaces.
SYNTAX:
EXAMPLE:
dhcp client flush
=>dhcp client iflist
NewETHoA : [SELECTING]
flags= uc
IP address : 10.0.0.10
HW address : 0:90:d0:01:47:de
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime= 10800 s
trying to get a lease for 8 min, 32 sec
transmission of DISCOVER in 57 sec
retransmission timeout: 64
nbr of retransmissions: 14
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>dhcp client flush
No dynamic interfaces defined.
=>
94
DHCP Commands
dhcp client ifadd
Create a DHCP lease for a specific interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client ifadd intf = <interface name>
intf The name of an existing interface, e.g. created via :mer ifadd. REQUIRED
=>dhcp client ifadd intf=NewEthoa
NewETHoA : [INIT]
flags= uc
DHCP server : 255.255.255.255
Number of leases: 1
=>
dhcp client ifattach Attach a DHCP lease to an interface.
dhcp client ifdelete Delete a dynamic interface.
dhcp client iflist Show all dynamic interfaces.
95
DHCP Commands
dhcp client ifattach
Attach a DHCP lease to a dynamic interface.
Note Create the interface first with :dhcp client ifadd.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client ifattach intf = <interface name>
intf The name of the dynamic interface. REQUIRED
NewETHoA : [INIT]
flags= uc
DHCP server : 255.255.255.255
Number of leases: 1
=>dhcp client ifattach intf=NewETHoA
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime = 10800 s
Number of leases: 1
=>
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifrelease Release a lease attached to a dynamic interface.
96
DHCP Commands
dhcp client ifconfig
Show/set the configuration of DHCP lease created for a specific interface.
Note Execute the dhcp client ifrelease command before configuring the dhcp client.
SYNTAX:
dhcp client ifconfig intf = <interface name>
[clientid = <{client-id|none}>]
[hostname = <hostname|"">]
[addr = <ip-address>]
[leasetime = <number>]
[addrtrans = <{none|pat}>]
[dns = <{off|on}>]
[gateway = <{off|on}>]
[metric = <number{0-100}>]
[dnsmetric = <number{0-100}>]
intf The name of the dynamic interface to be configured. REQUIRED
clientid The client identity to be associated with the lease. Use none in case
no clientid should be associated with this lease.
OPTIONAL
hostname The host name of the client to be associated with the lease. Use in
case no hostname should not be associated with this lease.
OPTIONAL
addr The preferred dynamic IP address. OPTIONAL
leasetime A number between 0 and 1814400 (seconds).
Represents the preferred time the client wants to use an address.
By default the leasetime is 7200 seconds (2 hours).
Specifying -1 makes the lease permanent.
OPTIONAL
addrtrans Automatically enable address translation for this dynamic interface
(pat) or not (none).
OPTIONAL
dns Request (and accept) DNS server IP addresses (on) or not (off). OPTIONAL
gateway Request (and accept) gateway IP addresses (on) or not (off). OPTIONAL
metric A number between 0 and 100.
Represents the gateway route metric
By default the gateway route metric is 1.
OPTIONAL
dnsmetric A number between 0 and 100.
Represents the DNS route metric
By default the DNS route metric is 1.
OPTIONAL
97
DHCP Commands
EXAMPLE:
RELATED COMMANDS:
NewETHoA : [INIT]
flags= uc
DHCP server : 255.255.255.255
Number of leases: 1
Total size of table: 36, in use: 1, free: 97%
=>dhcp client ifconfig intf=NewETHoA hostname=NewLease addr=10.0.0.10 leasetime=10800
NewETHoA : [INIT]
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
Number of leases: 1
Total size of table: 36, in use: 1, free: 97%
=>
98
DHCP Commands
dhcp client ifdelete
Delete a dynamic interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client ifdelete intf = <interface name>
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
Number of leases: 1
=>dhcp client ifdelete intf NewETHoA
=>
99
DHCP Commands
dhcp client iflist
Show all dynamic interfaces.
SYNTAX:
EXAMPLE:
The SpeedTouch is configured as DHCP client on its Ethernet interface eth0.
RELATED COMMANDS:
dhcp client iflist
NewETHoA : [INIT]
flags= uc
DHCP server : 255.255.255.255
Number of leases: 1
=>
eth0 : [BOUND]
flags= uc
HW address : 00:90:d0:01:47:f1
DHCP server : 10.10.1.1
lease renewal in 5 days, 1 h, 26 min, 45 sec
lease rebinding in 8 days, 20 h, 34 min, 15 sec
lease expires in 10 days, 2 h, 56 min, 45 sec
Number of leases: 1
eth0 : [BOUND]
flags= uc
HW address : 00:90:d0:01:47:f1
lease renewal in 5 days, 1 h, 25 min, 27 sec
Number of leases: 1
=>
100
DHCP Commands
dhcp client ifrelease
Release a lease attached to a dynamic interface.
SYNTAX:
EXAMPLE:
dhcp client ifrelease intf = <interface name>
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
Number of leases: 1
=>dhcp client ifattach intf=NewETHoA
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
Number of leases: 1
=>
101
DHCP Commands
RELATED COMMANDS:
eth0 : [BOUND]
flags= uc
HW address : 00:90:d0:01:47:f1
lease renewal in 5 days, 58 min, 45 sec
Number of leases: 1
=>dhcp client stats
DECLINEs sent : 0
RELEASEs sent : 0
INFORMs sent : 0
Memory usage:
=>dhcp client ifrelease intf=eth0
=>(CTRL + Q)
=>STATE ACTIVATE !
STATE IDLE !
STATE ACTIVATE !
dhcc: intf 1 releases 10.0.0.3 to server 10.10.1.1.
dhcc: 10.0.0.3 deleted: ok.
STATE IDLE !
STATE ACTIVATE !
.............
dhcc: intf 1 in init state.
n_send() broadcast triggered; To be verified
dhcc: broadcast discover on intf 1.
=>(CTRL + S)
=>dhcp client stats
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Memory usage:
=>
102
DHCP Commands
dhcp client ifrenew
Renew the lease of a dynamic interface.
SYNTAX:
EXAMPLE:
dhcp client ifrenew intf = <interface name>
NewETHoA : [BOUND]
flags= uc
HW address : 00:90:d0:01:47:f1
DHCP server : 255.255.255.255
hostname : NewLease
lease renewal in 5 days, 58 min, 48 sec
Number of leases: 1
=>dhcp client ifrenew intf=NewETHoA
flags= uc
DHCP server : 255.255.255.255
hostname : NewLease
trying to get a lease for 12 sec
Number of leases: 1
=>
103
DHCP Commands
RELATED COMMANDS:
=>dhcp client stats
OFFERs recv : 0
ACKs recv : 0
NAKs recv : 0
DISCOVERs sent : 0
REQUESTs sent : 0
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Memory usage:
=>dhcp client ifrenew intf=eth0
=>dhcp client stats
OFFERs recv : 1
ACKs recv : 1
NAKs recv : 0
DISCOVERs sent : 1
REQUESTs sent : 1
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Memory usage:
=>(CTRL + Q)
..................
STATE IDLE !
STATE ACTIVATE !
dhcc: intf 1 renews lease 10.0.0.3.
dhcc: intf 1 requests 10.0.0.3 from 10.10.1.1
dhcc: 10.10.1.1 acks 10.0.0.3 to intf 1.
dhcc: lease 10.0.0.3 bound to intf 1.
STATE IDLE !
STATE ACTIVATE !
...........
=>(CTRL + S)
104
DHCP Commands
dhcp client stats
Show DHCP client statistics.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp client stats
=>dhcp client stats
OFFERs recv : 1
ACKs recv : 1
NAKs recv : 0
REQUESTs sent : 9
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Memory usage:
=>
dhcp client clear Clear DHCP client statistics.
105
DHCP Commands
dhcp relay add
Adds a DHCP server to the DHCP server list.
SYNTAX:
RELATED COMMANDS:
dhcp relay add addr = <ip-address>
[intf = <none|interface_name>]
[giaddr = <ip-address>]
addr The DHCP server IP address. REQUIRED
intf The name of the relay interface, 'None' to indicate no interface is
specified.
OPTIONAL
giaddr The giaddr field to be used in relayed DHCP packets. OPTIONAL
dhcp relay config Sets the relay configuration settings.
dhcp relay delete Deletes a DHCP server from the DHCP server list.
106
DHCP Commands
dhcp relay config
Sets the relay configuration settings.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server config [agentinfo = <{off|on}>]
[agentmismatch = <{off|on}>]
agentinfo Sets the relay agent info status (RFC3046) off or on.
Default is off.
OPTIONAL
agentmismatch Forward/Drop DHCP reply packet when a relay agent info mismatch
is detected (RFC3046).
Default is off
OPTIONAL
trace Disable verbose console logging and generation of debug traces (off)
or enable verbose console logging and generation of debug traces
(on).
By default tracing is disabled.
OPTIONAL
=>dhcp relay config
Agent info status : off
Drop agent info mismatch status : off
Verbose console logging : off
=>dhcp relay config agentinfo=on
=>dhcp relay config
Agent info status : on
Drop agent info mismatch status : off
Verbose console logging : off
=>
dhcp relay add Adds a DHCP server to the DHCP server list.
107
DHCP Commands
dhcp relay delete
Deletes a DHCP server from the DHCP server list.
SYNTAX:
RELATED COMMANDS:
dhcp relay delete addr = <ip-address>
[intf = <interface name>]
addr The DHCP server IP address. REQUIRED
intf The name of the dynamic interface. OPTIONAL
108
DHCP Commands
dhcp relay flush
Flushes the DHCP relay settings.
SYNTAX:
EXAMPLE:
dhcp relay flush
=>dhcp relay list
DHCP server Interface giaddr
-------------------------------------------------------
127.0.0.1
=>dhcp relay flush
=>dhcp relay list
=>
109
DHCP Commands
dhcp relay ifconfig
Configures a relay interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp relay ifconfig intf = <interface name>
[relay = <{off|on}>]
[maxhops = <number{0-16}>]
[remoteid = <password>]
[trusted = <{no|yes}>]
intf The name of the dynamic interface to be configured. REQUIRED
relay Sets the relay status. OPTIONAL
maxhops A number between 0 and 16.
Represents the maximum number of hops allowed in the DHCP
packet.
Default is 4.
OPTIONAL
remoteid Sets the remote id as specified in RFC3046. OPTIONAL
trusted Drop/Forward DHCP request packet when the DHCP Relay Agent
Option is enabled (with the command :dhcp relay config
agentinfo=on) and the giaddr field is 0 (RFC3046).
OPTIONAL
=>dhcp relay ifconfig
intf = pppoa_pppoa
[relay] = off
[maxhops] = 4
[remoteid] =
[trusted] = no
=>
dhcp relay iflist Show all dynamic interfaces.
110
DHCP Commands
dhcp relay iflist
Show all dynamic interfaces.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp relay iflist [intf = <interface name>]
intf The name of the dynamic interface to be configured. OPTIONAL
=>dhcp relay iflist
pppoa_pppoa :
admin state = down oper state = down
max hops = 4
trusted = no remote id =
eth0 :
admin state = up oper state = up
max hops = 4
trusted = no remote id =
=>
dhcp relay ifconfig Configures a relay interface.
111
DHCP Commands
dhcp relay list
Lists the DHCP server list.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp relay list
=>dhcp relay list
DHCP server Interface giaddr
-------------------------------------------------------
127.0.0.1
=>
112
DHCP Commands
dhcp relay stats
Shows DHCP relay statistics.
SYNTAX:
EXAMPLE:
dhcp relay stats
=>dhcp relay stats
DHCP relay statistics
-------------------------
Client packet relayed : 64
Server packet relayed : 0
Bogus relay agent : 0
Bogus giaddr recv : 0
Corrupt agent option : 0
Missing agent option : 0
Bad circuit id : 0
Missing circuit id : 0
=>
113
DHCP Commands
dhcp server clear
Clear SpeedTouch DHCP server statistics.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server clear
=>dhcp client stats
OFFERs recv : 9575
ACKs recv : 121
NAKs recv : 0
REQUESTs sent : 142
DECLINEs sent : 0
RELEASEs sent : 0
INFORMs sent : 0
Memory usage:
=>dhcp server clear
=>dhcp client stats
OFFERs recv : 0
ACKs recv : 0
NAKs recv : 0
DISCOVERs sent : 0
REQUESTs sent : 0
DECLINEs sent : 0
RELEASEs sent : 0
INFORMs sent : 0
Memory usage:
=>
dhcp server stats Show DHCP server statistics.
114
DHCP Commands
dhcp server config
Show/set SpeedTouch DHCP server configuration settings.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server config [autodhcp = <{off|on}>]
[scantime = <number>]
[state = <{disabled|enabled}>]
autodhcp Allow the SpeedTouch to present itself as DHCP client
(AutoDHCP mode) at boot time and probe for another DHCP
server on the network for some time before starting its own DHCP
server (yes) or immediately start the DHCP server (no).
OPTIONAL
scantime A number between 0 and 1814400 (seconds).
Represents the time the SpeedTouch scans for another DHCP
server to be active in the network.
By default the scantime is 20 seconds.
OPTIONAL
state State of the DHCP server (enabled/disabled). OPTIONAL
trace Disable verbose console logging and generation of debug traces (off)
or enable verbose console logging and generation of debug traces
(on).
By default tracing is disabled.
OPTIONAL
=>dhcp server config
autodhcp: on
scantime: 20s
state: disabled
tracing: off
=>dhcp server config scantime=30 tracing=on
=>dhcp server config
autodhcp: on
scantime:30s
state: disabled
tracing: on
=>
dhcp server stats Show current DHCP server state and statistics.
115
DHCP Commands
dhcp server flush
Flushes all DHCP server pool and lease entries.
SYNTAX:
RELATED COMMANDS:
dhcp server flush
dhcp server config Show/set current DHCP server configuration.
116
DHCP Commands
dhcp server policy
Show/set SpeedTouch DHCP server policy.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server policy [verifyfirst = <off|on>]
[trustclient = <off|on>]
verifyfirst Probe the network for conflicting IP addresses before giving a
suggested IP address to the requesting DHCP client (on) or not (off).
OPTIONAL
trustclient Take the IP address suggested by a DHCP client into account (on) or
not (off).
OPTIONAL
=>dhcp server policy
Verify first: off
Trust client: on
=>dhcp server policy verifyfirst=on trustclient=off
=>dhcp server policy
Verify first: on
Trust client: off
=>
dhcp server config Show/set current DHCP server configuration.
117
DHCP Commands
dhcp server stats
Show SpeedTouch DHCP server statistics.
SYNTAX:
EXAMPLE:
dhcp server stats
=>dhcp server stats
DHCP Server State: Stopped
DHCP server statistics:
DISCOVER : 2451
REQUEST : 28
DECLINE : 0
RELEASE : 22
INFORM : 1
Pure BOOTP REQUESTS : 2
OFFERs sent : 2451
ACKs sent : 19
NAKs sent : 0
Relay agent options dropped : 0
Lease table got full : no
Ping table got full : no
Second dhcp server seen : no
Total size of lease table: 32, in use: 16, free: 50 %
=>
118
DHCP Commands
DESCRIPTION:
RELATED COMMANDS:
DHCP server state Indicates the state of the SpeedTouch DHCP server.
Corrupted packet recv Indicates the number of corrupted packets (not compliant to RFC2131)
received from the LAN.
DISCOVER Indicates the number of DHCP server discovery packets received from the
Local Area Network (LAN). These broadcasts are sent by potential DHCP
clients to locate available DHCP servers.
REQUEST Indicates the number of DHCP address lease requests received from the LAN.
DECLINE Indicates the number of DHCP address lease requests declined.
RELEASE Indicates the number of DHCP address release requests received from DHCP
clients.
INFORM Indicates the number of information requests received from DHCP clients.
Pure BOOTP requests Indicates the number of BOOTP requests received from the LAN.
Other message types Indicates the number of other messages received from the LAN.
OFFERs sent Indicates the number of IP address offers sent in reply to DHCP requests.
ACKs sent Indicates the number of ACKnowledgement replies sent to successfully
configured DHCP clients.
NAKs sent Indicates the number of Not-AcKnowledgement replies sent to wrongly
configured DHCP clients.
Relay agent options dropped
Lease table got full Indicates whether the maximum number of DHCP leases is reached or not.
Ping table got full Indicates whether the history list of IP address pings got full or not. These pings
are sent by the SpeedTouch DHCP server to verify whether the IP address is
already in use on the LAN or not. (dhcp server policy verifyfirst=yes)
Second DHCP server seen Indicates whether a concurrent DHCP server was found on the LAN or not.
dhcp server clear Clear DHCP server statistics.
119
DHCP Commands
dhcp server lease add
Assign a DHCP server lease to a DHCP host in the local network.
SYNTAX:
dhcp server lease add clientid = <client-id>
pool = <string>
[offset = <number>]
[hostname = <{hostname|""}>]
clientid The DHCP client identification string of the booting host. REQUIRED
pool The name of the DHCP server pool from which the DHCP lease
should be taken from. Use :dhcp server pool list for a list of available
DHCP server pools.
REQUIRED
addr The favoured IP address for this DHCP host. This IP address, if
specified, must be in the range of the DHCP pool specified.
OPTIONAL
offset A number between 0 and the integer number defined by the number
of available IP addresses in the DHCP server pool.
Represents the IP address offset in the DHCP server pool preserved
for this host.
Not specifying this parameter does not preserve an IP address for
the host.
OPTIONAL
Represents the time the host is allowed to use this address, before
renewing.
OPTIONAL
hostname The hostname to add to the local Domain Name System (DNS) table
for this host. Use if no hostname is associated with this lease.
OPTIONAL
120
DHCP Commands
EXAMPLE:
RELATED COMMANDS:
=>dhcp server lease list
Lease Pool TTL State Clientid
0 0.0.0.0 dhcp_pool_1 00:26:40 FREE 00:90:D0:12:34:56
=>dhcp server lease add clientid=01:23:55:67:89:ab pool=Local_pool leasetime=3600
0 0.0.0.0 dhcp_pool_1 00:26:40 FREE 00:90:D0:12:34:56
1 10.0.0.1 local_pool 00:59:22 USED 01:23:45:67:89:AB
=>
dhcp server lease delete Delete a DHCP lease.
dhcp server lease flush Delete all DHCP leases.
dhcp server lease list Show current DHCP leases.
121
DHCP Commands
dhcp server lease delete
Delete a DHCP lease.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server lease delete [clientid = <clientid|none>]
[index = <number>]
clientid The DHCP client identification string of the DHCP lease.
If no DHCP client is specified, all DHCP clients are deleted.
OPTIONAL
index The index number of the entry to be deleted.
Use :dhcp server lease list to see a list of the index numbers of all
current DHCP leases.
OPTIONAL
0 0.0.0.0 dhcp_pool_1 00:26:40 FREE 00:90:D0:12:34:56
=>dhcp server lease delete index=0
=>
dhcp server lease add Add a DHCP lease manually.
dhcp server lease flush Delete all DHCP leases.
122
DHCP Commands
dhcp server lease flush
Flush all DHCP server leases.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server lease flush [pool = <string>]
pool The name of the DHCP server pool. Only the leases belonging to
this pool will be deleted.
OPTIONAL
0 0.0.0.0 dhcp_pool_1 00:26:40 FREE 00:90:D0:12:34:56
2 10.0.0.101 local_pool 00:21:01 USED 01:23:89:AB:80:CD
3 10.0.0.132 local_pool 00:45:37 USED 09:D0:25:CE:F1:31
5 10.0.0.5 local_pool 00:21:11 USED AB:33:A1:7C:89:DD
4 10.0.0.6 local_pool 00:59:01 USED E3:81:9F:11:11:11
8 10.0.0.8 local_pool 00:01:00 USED 08:80:09:90:AB:DC
9 10.0.0.15 local_pool 00:00:23 USED 08:93:DA:AE:01:AF
=>dhcp server lease flush
=>
123
DHCP Commands
dhcp server lease list
List current DHCP leases, indicated by their index number.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server lease list [clientid = <clientid|none>]
[index = <number>]
clientid The DHCP client identification string of the DHCP lease.
If no DHCP client is specified, all DHCP clients are listed.
OPTIONAL
index The index number of the entry to be deleted. OPTIONAL
0 0.0.0.0 dhcp_pool_1 00:26:40 FREE 00:90:D0:12:34:56
2 10.0.0.101 local_pool 00:21:01 USED 01:23:89:AB:80:CD
3 10.0.0.132 local_pool 00:45:37 USED 09:D0:25:CE:F1:31
5 10.0.0.5 local_pool 00:21:11 USED AB:33:A1:7C:89:DD
4 10.0.0.6 local_pool 00:59:01 USED E3:81:9F:11:11:11
8 10.0.0.8 local_pool 00:01:00 USED 08:80:09:90:AB:DC
9 10.0.0.15 local_pool 00:00:23 USED 08:93:DA:AE:01:AF
=>
dhcp server lease flush Delete complete DHCP server configuration and dynamic leases.
124
DHCP Commands
dhcp server pool add
Add a DHCP server pool.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server pool add [name = <string>]
[index = <number>]
name A name for the DHCP server pool. If not specified, the name is
dhcp_pool_x, where x is a subsequent number.
OPTIONAL
index The number of the pool before which you want the new pool to be
added.
OPTIONAL
=>dhcp server pool list
Pool Start End State PPP
0 dhcp_pool_1 0.0.0.0 0.0.0.0 FREE
1 My_LAN_Pool 10.0.0.1 10.0.0.254 USED
2 dhcp_pool_2 0.0.0.0 0.0.0.0 FREE
=>dhcp server pool add
0 dhcp_pool_1 0.0.0.0 0.0.0.0 FREE
1 My_LAN_Pool 10.0.0.1 10.0.0.254 USED
2 dhcp_pool_2 0.0.0.0 0.0.0.0 FREE
3 dhcp_pool_3 0.0.0.0 0.0.0.0 FREE
=>dhcp server pool add name=POOL_EXTRA1
0 dhcp_pool_1 0.0.0.0 0.0.0.0 FREE
1 My_LAN_Pool 10.0.0.1 10.0.0.254 USED
2 dhcp_pool_2 0.0.0.0 0.0.0.0 FREE
3 dhcp_pool_3 0.0.0.0 0.0.0.0 FREE
4 POOL_EXTRA1 0.0.0.0 0.0.0.0 FREE
=>ppp ifconfig name=PPP_Test pool=POOL_EXTRA1
0 dhcp_pool_1 0.0.0.0 0.0.0.0 FREE
1 My_LAN_Pool 10.0.0.1 10.0.0.254 USED
2 dhcp_pool_2 0.0.0.0 0.0.0.0 FREE
3 dhcp_pool_3 0.0.0.0 0.0.0.0 FREE
4 POOL_EXTRA1 0.0.0.0 0.0.0.0 FREE PPP_Test
=>
dhcp server pool delete Delete a DHCP pool.
dhcp server pool flush Delete all DHCP pools.
dhcp server pool list Show current DHCP pools.
125
DHCP Commands
dhcp server pool config
Configure an existing DHCP pool. Before you are able to configure the DHCP pool, you must create it via :dhcp server
pool add.
SYNTAX:
dhcp server pool config name = <string>
[index = <number>]
[intf = <string>]
[poolstart = <ip-address>]
[poolend = <ip-address>]
[netmask = <ip-mask(dotted or cidr)>]
[gateway = <ipaddress | 0>]
[server = <ipaddress | 0>]
[primdns = <ipaddress | 0>]
[secdns = <ipaddress | 0>]
[primwins = <ipaddress | 0>]
[secwins = <ipaddress | 0>]
[unnumbered = <{no|yes}>]
[localgw = <{off|on}>]
name The name of the DHCP server pool to configure. REQUIRED
index A number between 0 (highest priority) and the highest number
(lowest priority) found in the list of existing DHCP server pools.
Represents a (higher) priority for the DHCP server pool.
OPTIONAL
intf The interface for which the pool is allowed to lease IP addresses. OPTIONAL
poolstart The lowest IP address in the DHCP address range to use for leasing.
Default value of this parameter is 0.0.0.0 (not specified), which
means that the lowest IP address of the pool will be defined by the
remote server via Internet Protocol Control Protocol (IPCP) as
soon as the Point-to-Point Protocol (PPP) IPCP subnetmasking
connection is established.
OPTIONAL
poolend The highest IP address in the DHCP address range to use for leasing.
Default value of this parameter is 0.0.0.0 (not specified), which
means that the highest IP address of the pool will be defined by the
remote server via IPCP as soon as the PPP IPCP subnetmasking
connection is established.
OPTIONAL
netmask The applicable netmask for the DHCP leases. OPTIONAL
126
DHCP Commands
EXAMPLE:
RELATED COMMANDS:
gateway The IP address of the default gateway for the DHCP clients.
Default value of this parameter is 0 (not specified), which means that
the gateway IP address will be communicated by the remote server
as soon as the PPP IPCP subnetmasking connection is established or
that the SpeedTouch acts as the LAN default gateway.
OPTIONAL
server The IP address of the DHCP server for DHCP clients. OPTIONAL
primdns The IP address of the primary DNS server for the DHCP clients.
the IP address of the DNS server will be communicated by the
remote server as soon as the PPP IPCP subnetmasking connection is
established or that the SpeedTouch acts as the LAN DNS server.
OPTIONAL
secdns The IP address of the optional secondary DNS server for DHCP
clients.
the gateway IP address will be communicated by the remote server
as soon as the PPP IPCP subnetmasking connection is established.
OPTIONAL
dnsmetric The DHCP server pool DNS route metric. OPTIONAL
primwins The IP address of the primary WINS server for DHCP clients. OPTIONAL
secwins The IP address of the secondary WINS server for DHCP clients. OPTIONAL
Represents the time for which a client can use its dynamically
allocated IP address.
By default the leasetime is 2 hours (7200 seconds).
OPTIONAL
unnumbered Assign an IP address from this pool to the DHCP server or not
(dynamic pools only).
OPTIONAL
localgw Proxy for a virtual default gateway residing in same subnet of DHCP
client instead of the remote peer address.
OPTIONAL
Pool Start End Intf State
0 LAN_Private 10.0.0.1 10.0.0.254 eth0 USED
=>dhcp server pool config name=My_Pool poolstart=192.6.11.101 |
poolend=192.6.11.254 netmask=255.255.255 gateway=192.6.11.100 leasetime=21600
1 My_Pool 192.6.11.101 192.6.11.254 eth0 USED
=>
127
DHCP Commands
dhcp server pool delete
Delete a DHCP pool.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server pool delete name = <string>
name The name of the DHCP server pool to delete.
Use :dhcp server pool list to see a list of all current DHCP leases.
REQUIRED
1 My_Pool 192.6.11.101 192.6.11.254 eth0 USED
=>dhcp server pool delete name=My_Pool
=>
dhcp server pool add Add a DHCP pool.
128
DHCP Commands
dhcp server pool flush
Flush all DHCP pools
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server pool flush
1 My_Pool 192.6.11.101 192.6.11.254 eth0 USED
=>dhcp server pool flush
=>
129
DHCP Commands
dhcp server pool list
List current DHCP pools.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dhcp server pool list
1 My_Pool 192.6.11.101 192.6.11.254 eth0 USED
=>
130
DHCP Commands
131
DNS Commands
DNS Commands
Contents
Topic Page
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
132
DNS Commands
dns add
Adds an entry to the local Domain Name System (DNS) table.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns add hostname = <string>
hostname The name of the IP host to add (without the (sub)domain name). REQUIRED
addr The IP address of the host (without mask).
Note If this parameter is not specified, the hostname applies to
the SpeedTouch itself.
OPTIONAL
=>dns list
Domain: business.lan
Nr. Hostname IP Address
0 SpeedTouch *.*.*.*
1 TestHost 10.0.0.140
2 HTTP_Server 10.0.0.8
Total Table Size: 73 entries
Amount used: 3 (4%)
=>dns add hostname=FTP_Server addr=10.0.0.7
=>dns list
1 TestHost 10.0.0.140
3 FTP_Server 10.0.0.7
Amount used: 4 (5%)
=>
dns list Lists the contents of the local DNS table.
dns delete Deletes an entry from the local DNS table by index.
133
DNS Commands
dns clear
Clears the local DNS table.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns clear
=>dns list
1 TestHost 10.0.0.140
Amount used: 4 (5%)
=>dns clear
=>dns list
Amount used: 0 (0%)
=>
134
DNS Commands
dns clrstats
Clears the DNS statistics.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns clrstats
=>dns stats
DNS Statistics:
Corrupted packets recv : 0
Local questions resolved : 0
Local neg answers sent : 4
Total DNS packets fwd : 0
External answers recv : 0
Fwd table full, discard : 0
Spurious answers : 0
Unknown query types : 0
Total number of packets received : 4
=>dns clrstats
DNS statistics cleared.
=>dns stats
DNS Statistics:
=>
dns stats Prints the DNS server/forwarder statistics.
135
DNS Commands
dns delete
Deletes an entry from the local DNS table by index.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns delete index = <number>
index The index of the entry to be deleted.
Use dns list to see a list of the index numbers of all current DNS
entries.
REQUIRED
=>dns list
1 TestHost 10.0.0.140
Amount used: 4 (5%)
=>dns delete index=2
=>dns list
1 TestHost 10.0.0.140
Amount used: 3 (4%)
=>
dns add Adds an entry to the local DNS table.
dns list List current DNS entries.
136
DNS Commands
dns domain
Set the local DNS domain name.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns domain domain = <string>
domain The local DNS domain name. REQUIRED
=>dns list
1 TestHost 10.0.0.140
Amount used: 4 (5%)
=>dns domain domain=office.home.lan
=>dns list
Domain: office.home.lan
1 TestHost 10.0.0.140
Amount used: 4 (5%)
137
DNS Commands
dns flush
Flush the complete SpeedTouch DNS server/forwarder configuration and static entries.
SYNTAX:
EXAMPLE:
dns flush
=>dns list
4* Z7V1D8 10.0.0.29
1 TestHost 10.0.0.140
2 Default 10.0.0.8
3 ftpserver 172.16.0.1
Amount used: 5 (6%)
=>dns flush
=>dns list
Domain: lan
3* Z7V1D8 10.0.0.29
Amount used: 1 (1%)
=>
138
DNS Commands
dns fwdadd
Add a DNS forwarding entry. The entries in the forwarding list determine which DNS server should be used for which
PC. If an identification cannot be established within the local LAN, the request is forwarded to another DNS server, on
another network (Internet/LAN to LAN connection). The connection is negotiated within a PPP link.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns fwdadd dns = <ip-address>
src = <ip-address>
mask = <ip-mask (dotted or cidr)>
[direct = <no/yes>]
dns The IP address of the (remote) DNS server. REQUIRED
src The source IP address (pool) of the host(s) using this DNS server. REQUIRED
mask The appropriate source IP (sub)netmask. REQUIRED
metric A number between 0 and 100
Represents the metric (weight factor) for this DNS route.
OPTIONAL
direct Selects whether DNS replies are sent directly back to the client versus
being relayed by the DNS forwarder.
OPTIONAL
=>dns fwdlist
DNS SRC Metric Direct Permanent
10.0.0.138 10.0.0.2 1 no yes
=>dns fwdadd dns=10.0.0.138 src=10.0.0.3 mask=24 direct=1
Dns forwarding server added.
=>dns fwdlist
10.0.0.138 10.0.0.2 1 no yes
10.0.0.138 10.0.0.3 1 yes yes
=>
dns fwddelete Deletes a DNS forwarding entry.
dns fwdlist Lists all forwarding entries.
139
DNS Commands
dns fwddelete
Delete a DNS forwarding entry.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns fwddelete src = <ip-address>
mask = <ip-mask (dotted or cidr)>
[dns = <ip-address>]
src The source IP address (pool) of the hosts to remove the entry for. REQUIRED
mask The source IP (sub)netmask. REQUIRED
dns The IP address of the (remote) DNS server (in case of multiple DNS
server entries).
OPTIONAL
=>dns fwdlist
10.0.0.138 10.0.0.2 1 no yes
10.0.0.138 10.0.0.3 1 yes yes
=>dns fwddelete dns=10.0.0.138 src=10.0.0.3 mask=24 direct=1
Dns forwarding server deleted.
=>dns fwdlist
10.0.0.138 10.0.0.2 1 no yes
=>
dns fwdadd Add a DNS forwarding entry.
dns fwdlist Lists all forwarding entries.
140
DNS Commands
dns fwdlist
Lists all forwarding entries.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns fwdlist
=>dns fwdlist
DNS forwarding servers:
DNS SRC MASK Direct
10.0.0.138 10.0.0.0 255.255.255.0 yes
192.6.11.150 192.6.11.0 255.255.255.0 yes
=>
dns fwdadd Add a DNS forwarding entry.
dns fwddelete Delete a DNS forwarding entry.
dns fwdtable Show DNS forwarding table.
141
DNS Commands
dns fwdtable
Show DNS forwarding table, i.e. list all currently unresolved DNS requests.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns fwdtable
=>dns fwdtable
Forwarding table:
Nr. Ip Address (port#):id(hex) (expiry) dns server tries
0 10.10.10.12 (54751):8331 (13 sec) 10.10.10.112 1
Timeout: 15 seconds
Table size: 10
amount of table used: 1 (10%)
=>
dns fwdlist Show current DNS forwarding entries.
142
DNS Commands
dns list
Lists the contents of the local DNS table.
SYNTAX:
EXAMPLE:
The SpeedTouch is configured as DNS server.
RELATED COMMANDS:
dns list
=>dns list
4* Z7V1D8 10.0.0.29
1 TestHost 10.0.0.140
2 Default 10.0.0.8
Amount used: 5 (6%)
=>
=>dns list
Domain: SpeedLAN.local
1 Server 10.10.1.1
2 Client 10.0.0.3
Amount used: 3 (4%)
=>
dns add Adds an entry to the local DNS table.
dns delete Deletes an entry from the local DNS table by index.
143
DNS Commands
dns nslookup
Looks up a name or an IP address via local DNS.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns nslookup lookup = <string>
lookup The DNS hostname or IP address to query. REQUIRED
=>dns list
4* Z7V1D8 10.0.0.29
1 TestHost 10.0.0.140
2 Default 10.0.0.8
Amount used: 5 (6%)
=>dns nslookup lookup=TestHost
Name: TestHost
Address: 10.0.0.140
=>dns nslookup lookup=10.0.0.29
Name: Z7V1D8
Address: 10.0.0.29
=>
144
DNS Commands
dns start
Starts the local DNS server and forwarder.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns start
=>dns status
DNS server status: Stopped
DNS table size : 73, in use: 4, free: 94 %
DNS forwarding table size : 10, in use: 0, free: 100 %
DNS forwarding dns servers table size : 25, in use: 4, free: 84 %
No dns cache.
Tracing: off
=>dns start
DNS server started.
=>dns status
DNS server status: Started
No dns cache.
Tracing: off
=>
dns status Shows the current status of the DNS server/forwarder.
dns stop Stops the local DNS server/forwarder.
145
DNS Commands
dns stats
Show SpeedTouch DNS server/forwarder statistics.
SYNTAX:
The SpeedTouch is configured as DNS server.
RELATED COMMANDS:
dns stats
=>dns list
Domain: SpeedLAN.local
1 Server 10.10.1.1
2 Client 10.0.0.3
Amount used: 3 (4%)
=>dns stats
DNS Statistics:
=>(Ping Client.SpeedLAN.local)
=>(CTRL + Q)
dnsd: Internet class type A request received from 10.10.1.1.
dnsd: Client.SpeedLAN.local found in local database.
dnsd: Client.SpeedLAN.local resolved into 10.0.0.3.
=>(Ping Server.SpeedLAN.local)
dnsd: Server.SpeedLAN.local found in local database.
dnsd: Server.SpeedLAN.local resolved into 10.0.0.3.
=>(CTRL + S)
=>dns stats
DNS Statistics:
=>
dns clrstats Clear the DNS server/forwarder statistics.
146
DNS Commands
dns status
Shows the current status of the DNS server/forwarder.
SYNTAX:
EXAMPLE:
dns status
=>dns status
No dns cache.
Tracing: off
=>
147
DNS Commands
dns stop
Stops the local DNS server/forwarder.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns stop
=>dns status
No dns cache.
Tracing: off
=>dns stop
DNS server stopped.
=>dns status
No dns cache.
Tracing: off
=>
dns start Starts the local DNS server and forwarder.
148
DNS Commands
dns toutfwd
Sets the DNS forwarding timeout.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns toutfwd timeout = <number>
timeout A number (seconds).
Represents the query forwarding timeout.
This parameter determines how long the SpeedTouch DNS server
should try to contact a (remote) DNS server before (temporarily)
declaring the DNS requests unresolved.
By default the timeout is 15 seconds.
REQUIRED
=>dns fwdtable
Forwarding table:
0 10.10.10.12 (54751):8331 (13 sec) 10.10.10.112 1
Timeout: 15 seconds
Table size: 10
=>dns toutfwd timeout=20
Current timeout: 15 seconds
Timeout set to: 20 seconds
=>dns fwdtable
Forwarding table:
0 10.10.10.12 (54751):8331 (13 sec) 10.10.10.112 1
Timeout: 20 seconds
Table size: 10
=>
dns fwdadd Adds a DNS forwarding entry.
dns fwddelete Deletes a DNS forwarding entry.
dns fwdlist Shows the current DNS forwarding entries.
dns fwdtable Shows the DNS forwarding table.
149
DNS Commands
dns troff
Disable verbose console messaging. No debug traces are generated.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns troff
=>dns status
No dns cache.
Tracing: on
=>dns troff
=>dns status
No dns cache.
Tracing: off
=>
dns tron Enable verbose console messaging.
150
DNS Commands
dns tron
Enable verbose console messaging. Debug traces are generated.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
dns tron
=>dns status
No dns cache.
Tracing: off
=>dns tron
Tracing on.
=>dns status
No dns cache.
Tracing: on
=>(CTRL + Q)
dnsd: aa.aa.be is outside our domain: forward.
dnsd: forwarding request from 10.0.0.10 (1318,0x0001) to 138.203.68.61
(try=1): 'reply to ant' mode.
dnsd: aa.aa.be is outside our domain: forward.
dnsd: forwarding request from 10.0.0.10 (1318,0x0001) to 138.203.68.11
(try=2): 'reply to ant' mode.
dnsd: forward answer from 138.203.68.11 to 10.0.0.10 (1318,0001).
dnsd: aa.aa.be.lan unknown: return error.
......
=>(CTRL + S)
dns troff Disable verbose console messaging.
151
Env Commands
Env Commands
Contents
This chapter covers the following commands
Topic Page
env flush 152
env get 154
env list 156
env set 157
env unset 158
152
Env Commands
env flush
Flush all non-system environment variables.
SYNTAX:
env flush
153
Env Commands
EXAMPLE:
RELATED COMMANDS:
=>env list
_COMPANY_NAME=THOMSON multimedia
_COMPANY_URL=http://www.thomson-multimedia.com
_PROD_NAME=SpeedTouch
_PROD_URL=http://www.speedtouch.com
_PROD_FRIENDLY_NAME=SpeedTouch 510
_PROD_DESCRIPTION=DSL Internet Gateway
_PROD_NUMBER=510
_BOARD_SERIAL_NBR=0238J1035
_BUILD=4.0.0.9.0
_BUILDNAME=Sascha4.0090
_PRL=3EC36939AAAA
_FIA=ND
_BOARD_NAME=ADNT-Q
_COMPANY_ID=ALCL
_COPYRIGHT=Copyright (c) 1999-2002, THOMSON multimedia
_TPVERSION=1.1.0
_MACADDR=00-90-D0-03-02-01
_UDN=uuid:UPnP-SpeedTouch510-1_00-90-D0-03-02-01
CONF_REGION=World
CONF_PROVIDER=Generic ISP
CONF_DESCRIPTION=Relayed PPPoA Packet Service configuration
CONF_SERVICE=Relayed PPPoA
CONF_VERSION=4.1.1.0
HOST_SETUP=auto
UPGRADE_URL=http://www.speedtouch.com/upgrade500.htm
COLUMNS=80
ROWS=24
SESSIONTIMEOUT=0
DSL_ADDR=8*35
CONF_DATE=January 2003
=>env flush
=>env list
_COMPANY_URL=http://www.thomson-multimedia.com
_PROD_DESCRIPTION=DSL Internet Gateway
_PROD_NUMBER=510
_BOARD_SERIAL_NBR=0238J1035
_BUILD=4.0.0.9.0
_BUILDNAME=LLT6AA4.0090
_PRL=3EC36939AAAA
_FIA=ND
_BOARD_NAME=ADNT-Q
_COMPANY_ID=ALCL
_COPYRIGHT=Copyright (c) 1999-2002, THOMSON multimedia
_TPVERSION=1.1.0
_MACADDR=00-90-D0-03-02-01
=>
env list List all environment variables.
154
Env Commands
env get
Get the current value of a environment variable.
SYNTAX:
env get var = <string>
var The name of the environment variable.
Execute env list to see a list of all environment variables.
REQUIRED
155
Env Commands
EXAMPLE:
RELATED COMMANDS:
=>env list
_COMPANY_NAME=THOMSON
_COMPANY_URL=http://www.thomson.net
_PROD_DESCRIPTION=Business DSL Router
_PROD_NUMBER=610
_BOARD_SERIAL_NBR=0238L1949
_BUILD=4.2.0.10
_MODEMLABEL=MOD_SACHEM_SEA_CPE_V2.11.27
_PHYSLAYERTYPE=POTS
_BUILDNAME=LLT5AA4.20A
_PRL=3EC18603GCAA
_FIA=NE
_BOARD_NAME=ADNT-R
_COMPANY_ID=ALCL
_COPYRIGHT=Copyright (c) 1999-2003, THOMSON
_TPVERSION=1.2.0
_ETHERNET=SWITCH
_MACADDR=00-90-D0-72-88-64
_IGDX_VERSION=1.1
CONF_REGION=World
CONF_PROVIDER=Any
CONF_DESCRIPTION=Routed PPPoA Packet Service configuration using always-on session connectivity.
CONF_SERVICE=Routed PPPoA - DHCP - NAPT
CONF_DATE=Configuration set by Embedded Wizard
CONF_TPVERSION=1.2.0
HOST_SETUP=auto
HOST_LANGUAGE=en
ATM_addr=8.35
SNMP_public=public
SNMP_private=private
PPP_user=johndoe@ISP
CONF_TEMPLATE=pppoa.tpl
CONF_USR_COMMENT=Configuration created by Embedded Wizard (profile:active/pppoe.tpl
COLUMNS=80
ROWS=24
SESSIONTIMEOUT=0
=>env get var=ATM_addr
8*35
=>
env list List all current environment variables.
env set Create and set a non-system environment variable.
156
Env Commands
env list
Show all currently available environment variables.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
env list
=>env list
_COMPANY_NAME=THOMSON
_COMPANY_URL=http://www.thomson.net
_PROD_DESCRIPTION=Business DSL Router
_PROD_NUMBER=610
_BOARD_SERIAL_NBR=0238L1949
_BUILD=4.2.0.10
_MODEMLABEL=MOD_SACHEM_SEA_CPE_V2.11.27
_PHYSLAYERTYPE=POTS
_BUILDNAME=LLT5AA4.20A
_PRL=3EC18603GCAA
_FIA=NE
_BOARD_NAME=ADNT-R
_COMPANY_ID=ALCL
_COPYRIGHT=Copyright (c) 1999-2003, THOMSON
_TPVERSION=1.2.0
_ETHERNET=SWITCH
_MACADDR=00-90-D0-72-88-64
_IGDX_VERSION=1.1
CONF_REGION=World
CONF_PROVIDER=Any
CONF_DESCRIPTION=Routed PPPoA Packet Service configuration using always-on session connectivity.
CONF_SERVICE=Routed PPPoA - DHCP - NAPT
CONF_DATE=Configuration set by Embedded Wizard
CONF_TPVERSION=1.2.0
HOST_SETUP=auto
HOST_LANGUAGE=en
ATM_addr=8.35
SNMP_public=public
SNMP_private=private
PPP_user=johndoe@ISP
CONF_TEMPLATE=pppoa.tpl
CONF_USR_COMMENT=Configuration created by Embedded Wizard (profile:active/pppoe.tpl
COLUMNS=80
ROWS=24
SESSIONTIMEOUT=0
=>
env unset Delete a non-system environment variable.
157
Env Commands
env set
Create and set a non-system environment variable or change the value of a non-system environment variable.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
env set var = <string>
value = <translated string>
var The name of the environment variable.
When creating an environment variable, any name is allowed,
however spaces are not allowed and the name may not start with
CONF, HOST, an underscore _ or the dollar sign $.
REQUIRED
value A quoted translated string which defines the value of the
environment variable.
The value of system variables (built-in variables with names starting
with an underscore _, CONF or HOST) can not be changed.
REQUIRED
=>env list
_COMPANY_URL=http://www.speedtouch.com
_PROD_FRIENDLY_NAME=SpeedTouch 610 Business DSL Router
.....
CONF_DESCRIPTION=Default Bridging configuration
CONF_SERVICE=Bridging on 0/35 and 8/35
CONF_DATE=May 2002
HOST_SETUP=user
=>env set ATM_addr value="8*35"
8*35
=>env set var=ATM_addr value="11*35"
11*35
=>
env get Show the value of an environment variable.
env unset Delete a non-system environment variable.
158
Env Commands
env unset
Delete a non-system environment variable.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
env unset var = <string>
var The name of the environment variable to delete.
System variables (built-in variables with names starting with an under-
score _, CONF or HOST) can not be unset, nor changed or
deleted.
REQUIRED
=>env list
.....
CONF_DATE=May 2002
HOST_SETUP=user
ATM_addr=8*35
=>env unset var=ATM_addr
=>env list
.....
CONF_DATE=May 2002
HOST_SETUP=user
=>
159
Eth Commands
Eth Commands
Contents
Topic Page
eth config 160
eth ifconfig 161
eth iflist 162
160
Eth Commands
eth config
Enable/disable the Ethernet interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
eth config intf = <number {1-4}>
[state = <{enabled|disabled}>]
intf The Ethernet interface to configure. REQUIRED
state Enable or disable the Ethernet interface.
By default, all Ethernet interfaces are enabled.
OPTIONAL
=>eth config
ETH Intf 1 port state = UP [forwarding]
=>eth config intf=4 state=disabled
=>eth config
ETH Intf 4 port state = DOWN [disabled]
=>
eth iflist Show Ethernet port configuration and current operating mode
161
Eth Commands
eth ifconfig
Configure the Ethernet port.
SYNTAX:
RELATED COMMANDS:
eth ifconfig intf = <number {1-4}>
type = <{auto|10BaseTHD|10BaseTFD|100BaseTHD|100BaseTFD}
or number>
intf The Ethernet interface to configure. REQUIRED
type The Ethernet type.
Select either:
auto
Auto negotiation of Ethernet communication speed (10Mb/s or
100Mb/s) and Duplex mode (half duplex or full duplex).
10BaseTHD
10Mb/s communication speed in half duplex mode.
10BaseTFD
10Mb/s communication speed in full duplex mode.
100BaseTHD
100Mb/s communication speed in half duplex mode.
100BaseTFD
100Mb/s communication speed in full duplex mode.
or enter a number between 0 (auto) and 5 (100BaseTFD).
Note By default, the Ethernet type is set to auto and should
never be changed, except in case of communication
problems.
REQUIRED
eth iflist Show Ethernet port configuration and current operating mode
162
Eth Commands
eth iflist
Show the Ethernet port configuration and current operating status.
SYNTAX:
EXAMPLE:
DESCRIPTION:
RELATED COMMANDS:
eth iflist
=>eth iflist
Intf Type Result Type
1 auto 100BaseTFD
2 auto 100BaseTFD
3 auto 100BaseTFD
4 auto 100BaseTFD
=>
Type Indicates the configured Ethernet communication speed and duplex mode.
Result type Indicates the effective operating status in case Type=auto. In other cases, when the
Ethernet types do NOT match, Result type=unknown and no Ethernet connectivity will
exist.
eth ifconfig Configure the Ethernet port.
163
ETHoA Commands
ETHoA Commands
Contents
Topic Page
ethoa flush 164
ethoa ifadd 165
ethoa ifattach 166
ethoa ifconfig 167
ethoa ifdelete 169
ethoa ifdetach 170
ethoa iflist 171
164
ETHoA Commands
ethoa flush
Flushes ETHoA interfaces.
SYNTAX:
EXAMPLE:
ethoa flush
=>ethoa iflist
Newethoa : dest : Br3
Connection State : connected
=>ethoa flush
=>ethoa iflist
=>
165
ETHoA Commands
ethoa ifadd
Create a new ETHoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ethoa ifadd [intf = <string>]
[dest = <phonebook entry>]
intf The name for the new ETHoA interface.
If not specified, the destination will double as interface name.
OPTIONAL
dest The destination for the new ETHoA interface.
Typically, a phonebook entry.
OPTIONAL
=>ethoa iflist
=>phonebook list
Br1 bridge 1 8.35
Br2 bridge 1 8.36
CIPPVC3 cip 1 8.82
CIPPVC4 cip 1 8.83
=>ethoa ifadd intf=Moreethoa dest=Br4
=>ethoa iflist
Moreethoa : dest : Br4
Connection State : not-connected
=>
ethoa ifattach Attach an ETHoA interface.
ethoa ifconfig Configure an ETHoA interface.
ethoa ifdelete Delete an ETHoA interface.
ethoa ifdetach Detach an ETHoA interface.
ethoa iflist Show current ETHoA interfaces.
166
ETHoA Commands
ethoa ifattach
Attach (i.e. connect) an ETHoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ethoa ifattach intf = <intfname>
intf The name of the ETHoA interface to attach. REQUIRED
=>ethoa iflist
=>ethoa ifattach intf=Moreethoa
=>ethoa iflist
=>
ethoa ifadd Create a new ETHoA interface.
167
ETHoA Commands
ethoa ifconfig
Configure an ETHoA interface.
SYNTAX:
EXAMPLE:
ethoa ifconfig intf = <intfname>
[dest = <intfname>]
[qos = <string>]
[retry = <number {0-65535}>]
intf The name of the ETHoA interface to configure. REQUIRED
This parameter needs only to be specified in case of an interface created
without specified destination.
OPTIONAL
qos The name of a qosbook entry defining the QoS parameters for the WAN
link.
OPTIONAL
encaps The type of encapsulation to be used for this ETHoA interface.
Choose between:
llc/snap
vcmux
OPTIONAL
Represents the number of WAN connection setup retries before giving
up.
OPTIONAL
=>ethoa iflist
Retry : 10 QoS : default Encaps : vcmux Fcs : off
=>ethoa ifconfig intf=Moreethoa encaps=llc/snap retry=15
=>ethoa iflist
=>
168
ETHoA Commands
RELATED COMMANDS:
169
ETHoA Commands
ethoa ifdelete
Delete an ETHoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ethoa ifdelete intf = <intfname>
intf The name of the ETHoA interface. REQUIRED
=>ethoa iflist
=>ethoa ifdelete intf=Moreethoa
=>ethoa iflist
=>
170
ETHoA Commands
ethoa ifdetach
Detach an ETHoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ethoa ifdetach intf = <intfname>
intf The name of the ETHoA interface. REQUIRED
=>ethoa iflist
=>ethoa ifdetach intf=Moreethoa
=>ethoa iflist
=>
171
ETHoA Commands
ethoa iflist
Show all or a specified ETHoA interface(s).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ethoa iflist [intf = <intfname>]
intf The name of the ETHoA interface.
Note If not specified, all ETHoA interfaces are listed.
OPTIONAL
=>ethoa iflist
=>
172
ETHoA Commands
173
Firewall Commands
Firewall Commands
Contents
Topic Page
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
174
Firewall Commands
firewall assign
Assign a chain to an entry point. An entry point, also referred to as hook or a Packet Interception Point (PIP), is the
location where packets are intercepted to be compared against a chain of rules
SYNTAX:
EXAMPLE:
firewall assign hook = <{input|sink|forward|source|output}>
chain = <string>
hook The name of the entry point to which a chain must be assigned.
Choose between:
input: The point off all incoming traffic.
At this point it can be determined whether the packet is
allowed to reach the SpeedTouch IP router or local host.
sink: The point off all traffic destined to the SpeedTouch IP
router itself.
allowed to address the local host.
forward: The point off all traffic to be forwarded by the Speed-
Touch IP router.
allowed to be handled, i.e. routed.
source: The point off all traffic sourced by the SpeedTouch IP
router.
allowed to leave the local host.
output: The point off all outgoing traffic.
allowed to leave the SpeedTouch IP router or local host.
REQUIRED
chain The name of the chain to use. REQUIRED
=>firewall list
=>firewall chain create chain Telnet
=>firewall assign hook=sink chain=Telnet
=>firewall list
assign hook=sink chain=Telnet
=>
175
Firewall Commands
RELATED COMMANDS:
firewall flush Clear all hooks.
firewall list Show a list of all chain assignments.
firewall unassign Clear a specific hook.
176
Firewall Commands
firewall flush
Clears all hooks, chains and rules.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall flush
=>firewall load
=>firewall list
=>firewall flush hook=sink
=>firewall list
=>firewall flush
=>firewall list
=>
firewall assign Assign a chain to an entry point.
177
Firewall Commands
firewall list
Show the association(s) between all hooks or a specified hook and their chain(s).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall list [hook = <{input|sink|forward|source|output}>]
hook The name of the hook for which the associations must be shown.
Choose between:
input
sink
forward
source
output.
Note If this parameter is not specified, the associations for all
hooks are shown.
OPTIONAL
=>firewall list
firewall assign hook=input chain=None
firewall assign hook=sink chain=sink
firewall assign hook=forward chain=forward
firewall assign hook=source chain=source
firewall assign hook=output chain=None
=>firewall list hook=input
firewall assign hook=input chain=None
=>firewall list hook=forward
firewall assign hook=forward chain=forward
=>
firewall flush Clear associations for all or a selected entry point(s).
178
Firewall Commands
firewall troff
Disable verbose console messaging.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall troff
=>firewall troff
firewall tron Enable verbose console messaging.
179
Firewall Commands
firewall tron
Enable verbose console messaging.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall tron
=>firewall tron
firewall troff Disable verbose console messaging.
180
Firewall Commands
firewall unassign
Clear a specific hook.
SYNTAX:
RELATED COMMANDS:
firewall unassign hook = <{input|sink|forward|source|output}>
hook The name of the hook to be cleared.
Choose between:
input
sink
forward
source
output.
REQUIRED
firewall assign Assign a chain to a hook.
firewall flush Clear all hooks.
firewall list Show a list of all chain assignments.
181
Firewall Commands
firewall chain create
Create a new chain.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall chain create chain = <string>
chain The name of the chain to create. REQUIRED
=>firewall chain list
Tempo, source, forward, sink
=>firewall chain create chain=Telnet
Telnet, Tempo, source, forward, sink
=>
firewall chain delete Delete a chain.
firewall chain list Show a list of all current chains.
182
Firewall Commands
firewall chain delete
Delete a chain.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall chain delete chain = <string>
chain The name of the chain to be deleted. REQUIRED
=>firewall chain delete chain=Tempo
Telnet, source, forward, sink
=>
firewall chain create Create a chain.
firewall chain list Show a list of all chains.
183
Firewall Commands
firewall chain flush
Flush all chains.
SYNTAX:
EXAMPLE:
firewall chain flush
=>firewall rule list chain=Telnet
:firewall rule create chain=Telnet index=0 srcintfgrp=lan src=10.0.0.0/8 |
dst=200.200.200.1/32 prot=tcp srcport=1024 srcportend=65535 dstport=telnet |
action=accept
:firewall rule create chain=Telnet index=1 srcintfgrp=wan |
src=200.200.200.1/32 dst=10.0.0.0/8 prot=tcp srcport=telnet dstport=1024 |
dstportend=65535 action=accept
:firewall rule create chain=Telnet index=2 action=drop
=>firewall rule flush chain=Telnet
=>
184
Firewall Commands
firewall chain list
Show a list of all current chains.
SYNTAX:
EXAMPLE INPUT/OUTPUT:
RELATED COMMANDS:
firewall chain list
source, forward, sink
=>firewall chain create chain Telnet
=>
firewall chain create Create a chain.
firewall chain delete Delete a chain.
185
Firewall Commands
firewall rule clear
Clear statistics for a given rule.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall rule clear [chain = <string>]
[index = <number>]
chain The name of the chain in which the rule is to be found. OPTIONAL
index The index number (determined by the position) of the rule in the
chain.
OPTIONAL
=>firewall rule stats
Chain Telnet, index 0, packets 0, bytes 0
Chain source, index 0, packets 203, bytes 15229
Chain forward, index 0, packets 0, bytes 0
Chain sink, index 0, packets 202, bytes 10159
=>firewall rule clear chain=source index=0
=>
firewall rule create Create a rule.
firewall rule delete Delete a specified rule in a chain.
firewall rule flush Delete all rules in a chain.
firewall rule list Show a list of all (or a specified) chains' rules.
firewall rule stats Show statistics for all (or a specified) chains' rules.
186
Firewall Commands
firewall rule create
Create a rule.
SYNTAX:
firewall rule create chain = <string>
[index = <number>]
[srcintf [!]= <string>]
[srcintfgrp [!]= <{wan|local|lan}>]
[srcbridgeport [!]= <number>]
[src [!]= <ip-address>]
[dstintf [!]= <string>]
[dstintfgrp [!]= <{wan|local|lan}>]
[dst [!]= <ip-address>]
[tos [!]= <number{1-255}>]
[precedence [!]= <number{0-7}>]
[dscp [!]= <number{0-63}>]
[prot [!]= <{<supported IP protocol name>|<number>}>]
[syn = <yes|no>]
[urg = <yes|no>]
[ack = <yes|no>]
[srcport [!]= <{<supported TCP/UDP port name>|<number>}>]
[srcportend = <{<supported TCP/UDP port name>|<number>}>]
[dstport [!]= <{<supported TCP/UDP port name>|<number>}>]
[dstportend = <{<supported TCP/UDP port name>|<number>}>]
[icmptype [!]= <{<supported ICMP type name>|<number>}>]
[icmpcode [!]= <number{0-15}>]
[icmpcodeend = <number{0-15}>]
[clink = <string>]
[log = <{no|yes}>]
action = <{accept|deny|drop|count}>
chain The name of the chain to insert the rule in. REQUIRED
index The number of the rule before which the new rule must be added. OPTIONAL
srcintf The name of the interface the packet should [or should NOT] arrive
on to make this rule apply.
(NOT applicable if used in a chain assigned to the output hook)
OPTIONAL
srcintfgrp The interface group the packet should [or should NOT] arrive on.
Choose between:
wan
local
lan
OPTIONAL
187
Firewall Commands
srcbridgeport A number between 0 and 6.
Represents the bridge port the virtual packet should [or should
NOT] arrive on.
Use :bridge iflist for a list of available bridge ports.
OPTIONAL
src The source IP address (range) the packet should [or should NOT]
come from. (Supports cidr notation).
OPTIONAL
dstintf The name of the interface the packet should [or should NOT] be
going to.
(NOT applicable if used in a chain assigned to the input hook)
OPTIONAL
dstintfgrp The interface group the packet should [or should NOT] be going to.
Choose between:
wan
local
lan
(NOT applicable if used in a chain assigned to the input hook)
OPTIONAL
dst The destination IP address (range) the packet should [or should
NOT] be going to. (supports cidr notation).
OPTIONAL
precedence A number between 0 and 7.
Represents the precedence in the IP packet (part of tos).
OPTIONAL
dscp A number between 0 and 63
Represents the DSCP in the IP packet (part of tos).
OPTIONAL
tos A number between 0 and 255.
Represents the Type Of Service specification which should be
expected [or NOT expected] in the IP packet. The Type of Service
numbering specification is in accordance to the latest version of
RFC1700: Assigned numbers.
OPTIONAL
prot The protocol (name or number) expected [or NOT expected] in
the IP packet.
Select one of the supported protocol names (See Supported
Internet Protocol (IP) Protocol Names on page 413 for a listing of
protocol names supported by the SpeedTouch).
Alternatively, specify the protocol number.
OPTIONAL
syn Expect TCP SYN flag set (yes) or not (no).
In combination with TCP ACK this allows selection of incoming
versus outgoing TCP connections.
OPTIONAL
urg Expect TCP URG flag set (yes) or not (no). OPTIONAL
ack Expect TCP ACK flag set (yes) or not (no). OPTIONAL
srcport The TCP/UDP port (or beginning of range) the packet should [or
should NOT] be from.
Select one of the supported TCP/UDP port names (See
Supported TCP/UDP Port Names on page 414 for a listing of
TCP/UDP port names supported by the SpeedTouch).
OPTIONAL
188
Firewall Commands
srcportend The source TCP/UDP port range end (inclusive).
(Only applicable for ranges)
OPTIONAL
dstport The TCP/UDP port (or beginning of range) the packet should [or
should NOT] be going to.
OPTIONAL
dstportend The destination TCP/UDP port range end (inclusive).
OPTIONAL
icmptype The expected [or NOT expected] ICMP type (name or number) of
the packet.
Select one of the supported ICMP type names (See Supported
ICMP Type Names on page 417 for a listing of ICMP type names
supported by the SpeedTouch).
OPTIONAL
icmpcode A number between 0 and 15.
Represents the expected [or NOT expected] ICMP code (or begin-
ning of range) of the packet as specified in the latest version of
RFC1700: Assigned number.
OPTIONAL
icmpcodeend A number between 0 and 15.
Represents the ICMP code range end.
Only applicable for ranges.
OPTIONAL
clink The name of the chain to be parsed when this rule applies. (action is
ignored).
OPTIONAL
log Logging is done when this rule applies. OPTIONAL
action Action to be taken when this rule applies. Choose between:
accept: the packet may pass.
deny: ICMP error destination unreachable. An error message
is sent back to the sender.
drop: packet disappears. It is silently dropped, that is, without
sending an error message to the sender.
count: update of statistics. Has no influence on the packet.
REQUIRED
189
Firewall Commands
RELATED COMMANDS:
firewall rule clear Clear statistics for a given rule.
190
Firewall Commands
firewall rule delete
Delete a rule.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall rule delete chain = <string>
index = <number>
chain The name of the chain in which to delete the rule. REQUIRED
index The index number of the rule in the chain.
Note Use :firewall rule list first to determine the index number
of the applicable rule.
REQUIRED
:firewall rule create chain=Telnet index=0 srcintfgrp=lan src=10.0.0.0/8
dst=200.200.200.1/32 prot=tcp srcport=1024 srcportend=65535 dstport=telnet
action=accept
:firewall rule create chain=Telnet index=1 srcintfgrp=wan
src=200.200.200.1/32 dst=10.0.0.0/8 prot=tcp srcport=telnet dstport=1024
=>firewall rule delete chain=Telnet index=1
:firewall rule create chain=Telnet index=0 srcintfgrp=lan src=10.0.0.0/8
dst=200.200.200.1/32 prot=tcp srcport=1024 srcportend=65535 dstport=telnet
action=accept
=>
191
Firewall Commands
firewall rule flush
Flush all rules created for a chain(s). The chain itself is not removed.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall rule flush [chain = <string>]
chain The name of the chain to empty.
Note If this parameter is not specified, all rules for all chains
are deleted.
OPTIONAL
action=accept
=>firewall rule flush chain=Telnet
=>
192
Firewall Commands
firewall rule list
Show a list of rules.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
firewall rule list [chain = <string>]
chain The name of the chain to list the rules of.
are shown.
OPTIONAL
action=accept
=>firewall rule list
:firewall rule create chain=source index=0 dstintfgrp=!wan action=accept
:firewall rule create chain=source index=1 prot=udp dstport=dns |
action=accept
:firewall rule create chain=source index=2 prot=udp dstport=67 action=accept
:firewall rule create chain=source index=3 action=drop
:firewall rule create chain=forward index=0 srcintfgrp=wan dstintfgrp=wan |
action=drop
:firewall rule create chain=sink index=0 srcintf=eth0 srcbridgeport=1 |
action=accept
:firewall rule create chain=sink index=1 srcintfgrp=!wan action=accept
:firewall rule create chain=sink index=2 prot=udp dstport=dns action=accept
:firewall rule create chain=sink index=3 prot=udp dstport=68 action=accept
:firewall rule create chain=sink index=4 action=drop
action=accept
=>
193
Firewall Commands
firewall rule stats
Show statistics, i.e. the number of packets and bytes which have passed the hooks.
SYNTAX:
EXAMPLE:
DESCRIPTION:
The statistics for the Test chain are the result of sending udp packets to the SpeedTouch. The chain Test is assigned
to the hook input and prohibits the sending of udp packets from one host to another.
firewall rule stats [chain = <string>]
[index = <number>]
chain The name of the chain of which the statistics must be listed.
In case this parameter is not specified the statistics for the rules
applicable to all chains are shown.
OPTIONAL
index The index number of the chain's rule of which the statistics must be
listed. Execute firewall rule list first to determine the index number
of the applicable rule.
In case this parameter is not specified the statistics for all rules
applicable to the specified chain are shown.
OPTIONAL
=>firewall rule list chain=Test
:firewall rule create chain=Test index=0 srcintfgrp=lan src=200.200.0.1/32
dst=200.200.0.2/32 prot=udp srcport=0 srcportend=65535 dstport=telnet
action=deny
=>firewall rule clear
Chain Test, index 0, packets 0, bytes 0
Chain Test, index 0, packets 44, bytes 21032
=>
194
Firewall Commands
RELATED COMMANDS:
=>firewall rule list chain=Sending
:firewall rule create chain=Sending index=0 srcintfgrp=lan src=10.0.0.3/32
dst=10.10.1.1/32 prot=icmp action=count
:firewall rule create chain=Sending index=1 srcintfgrp=lan src=10.10.1.1/32
dst=10.0.0.3/32 prot=icmp action=count
Chain sending, index 0, packets 0, bytes 0
=>firewall rule clear
=>(Ping from server 10.10.1.1 to client 10.0.0.3)
=>
195
IP Commands
IP Commands
Contents
Topic Page
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
196
IP Commands
ip apadd
Assign an Internet Protocol (IP) address to an interface.
SYNTAX:
ip apadd addr = <ip-address>
[netmask = <ip-mask (dotted or cidr)>]
intf = <interface name>
[pointopoint = <ip-address>]
[addroute = <{no|yes}>]
addr The new IP address to add. REQUIRED
netmask The subnetmask associated with this address. OPTIONAL
intf The IP interface name. REQUIRED
pointopoint The remote IP address in case of a dedicated point-to-point link. OPTIONAL
addrtrans Indicates whether network address translation mode is allowed
(pat) for this IP address or not (none).
OPTIONAL
addroute Add typical net/subnet routes automatically according to the default
(or specified) subnet mask (yes) or not (no).
OPTIONAL
197
IP Commands
EXAMPLE:
RELATED COMMANDS:
=>ip aplist
1 eth0 Type:Ethernet HWaddr 00:80:9f:24:ab:cf BRHWaddr ff:ff:ff:ff:ff:ff
inet addr:10.10.10.147 Bcast:10.10.10.255 Mask:255.0.0.0
UP RUNNING pat MTU:1500 ReasmMAX:65535 Group:2
IPRX bytes:19791886 unicastpkts:11341 brcastpkts:290555
IPTX bytes:839550 unicastpkts:11477 brcastpkts:0 droppkts:0
HWRX bytes:0 unicastpkts:0 brcastpkts:0
HWTX bytes:0 unicastpkts:0 brcastpkts:0 droppkts:0
0 loop Type:0
UP RUNNING MTU:1500 ReasmMAX:65535 Group:1
=>ip apadd addr=10.0.0.2 netmask=255.255.255.0 intf=eth0 addrtrans=pat
addroute=yes
=>ip aplist
inet addr: 10.0.0.2 Bcast:10.0.0.255 Mask:255.255.255.0
inet addr: 10.10.10.147 Bcast: 10.10.10.255 Mask: 255.0.0.0
0 loop Type:0
=>
ip apdelete Remove an IP address from an interface.
ip aplist Show current IP addresses.
198
IP Commands
ip apdelete
Remove an IP address from an interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip apdelete addr = <ip-address>
addr The IP address to delete. REQUIRED
=>ip aplist
inet addr:10.10.10.147 Bcast: 10.10.10.255 Mask: 255.0.0.0
0 loop Type:0
=>ip apdelete addr=10.0.0.2
=>ip aplist
inet addr:10.10.10.147 Bcast: 10.10.10.255 Mask: 255.0.0.0
0 loop Type:0
=>
ip apadd Add an IP address to an interface.
ip aplist Show current IP addresses.
199
IP Commands
ip aplist
Show a list of all configured IP addresses.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip aplist
=>ip aplist
0 loop Type:0
=>
ip apadd Add an IP address to an interface.
ip apdelete Remove an IP address from an interface.
200
IP Commands
ip arpadd
Adds an entry to the ARP cache of a broadcast IP interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip arpadd intf = <interface name>
ip = <ip-address>
[hwaddr = <hardware-address>]
intf The interface name. REQUIRED
ip The IP address. REQUIRED
hwaddr The hardware address (e.g. the Ethernet MAC address). OPTIONAL
=>ip arplist
Intf IP-address HW-address Type
eth0 10.0.0.1 00:01:42:5f:7d:81 DYNAMIC
eth0 10.0.0.8 00:a0:24:ae:66:e1 DYNAMIC
eth0 10.0.1.99 52:41:53:20:20:4d STATIC
eth0 10.0.1.100 52:41:53:20:f0:90 STATIC
=>ip arpadd intf=eth0 ip=10.0.0.2 hwaddr=00:10:a4:d0:9a:db
=>ip arplist
eth0 10.0.0.1 00:01:42:5f:7d:81 DYNAMIC
eth0 10.0.0.8 00:a0:24:ae:66:e1 DYNAMIC
eth0 10.0.1.99 52:41:53:20:20:4d STATIC
eth0 10.0.1.100 52:41:53:20:f0:90 STATIC
eth0 10.0.0.2 00:10:a4:d0:9a:db STATIC
=>
ip arpdelete Delete an ARP entry.
ip arplist Show current ARP cache.
201
IP Commands
ip arpdelete
Remove an entry from the SpeedTouch ARP cache.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip arpdelete intf = <interface name>
ip = <ip-address>
intf The interface name. REQUIRED
ip The IP address. REQUIRED
hwaddr The hardware address (e.g. the Ethernet MAC address). OPTIONAL
=>ip arplist
eth0 10.0.0.1 00:01:42:5f:7d:81 DYNAMIC
eth0 10.0.0.8 00:a0:24:ae:66:e1 DYNAMIC
eth0 10.0.1.99 52:41:53:20:20:4d STATIC
eth0 10.0.1.100 52:41:53:20:f0:90 STATIC
eth0 10.0.0.2 00:10:a4:d0:9a:db STATIC
=>ip arpdelete intf=eth0 ip=10.0.0.2 hwaddr=00:10:a4:d0:9a:db
=>ip arplist
eth0 10.0.0.1 00:01:42:5f:7d:81 DYNAMIC
eth0 10.0.0.8 00:a0:24:ae:66:e1 DYNAMIC
eth0 10.0.1.99 52:41:53:20:20:4d STATIC
eth0 10.0.1.100 52:41:53:20:f0:90 STATIC
eth0 10.0.0.2 00:10:a4:d0:9a:db STATIC
=>
ip arpadd Add a static ARP entry.
ip arplist Show current ARP cache.
202
IP Commands
ip arplist
Show the SpeedTouch ARP cache.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip arplist
=>ip arplist
eth0 10.0.0.1 00:01:42:5f:7d:81 DYNAMIC
eth0 10.0.0.8 00:a0:24:ae:66:e1 DYNAMIC
eth0 10.0.1.99 52:41:53:20:20:4d STATIC
eth0 10.0.1.100 52:41:53:20:f0:90 STATIC
eth0 10.0.0.2 00:10:a4:d0:9a:db STATIC
=>
ip arpadd Add a static entry to the ARP cache.
ip arpdelete Delete an entry from the ARP cache.
203
IP Commands
ip config
Show/set global IP stack configuration options.
SYNTAX:
ip config [forwarding = <{off|on}>]
[firewalling = <{off|on}>]
[redirects = <{off|on}>]
[sourcerouting = <{off|on}>]
[netbroadcasts = <{off|on}>]
[ttl = <number{0-255}>]
[fraglimit = <number{1-1024}>]
[defragmode = <{normal|always|nat}>]
[addrcheck = <{off|own|static|dynamic}>]
[mssclamping = <{off|on}>]
forwarding Disable (off) or enable (on) the IP routing functionality. OPTIONAL
firewalling Enable (on) or disable (off) IP firewalling (master switch).
If applicable the CLI firewall level allows configuration of the Speed-
Touch firewall.
For security reasons this parameter is enabled per default.
It is strongly recommended never to disable the SpeedTouch fire-
wall.
OPTIONAL
redirects Disable (off) or enable (on) the sending of ICMP redirect messages.
A router can send a redirect message in case a shorter path than
the path followed is discovered.
For security reasons this parameter is disabled per default.
OPTIONAL
sourcerouting Disallow (off) or allow (on) IP source routed packets.
IP source routed packets are packets with the route to follow speci-
fied in the header.
For security reasons this parameter is disabled per default.
OPTIONAL
netbroadcasts Disallow (off) or allow (on) net directed broadcasts.
This parameter is per default disabled.
In case netbroadcasts are allowed no traces of netbroadcasts are
generated.
OPTIONAL
ttl A number between 0 and 255.
Represents the default time-to-live (ttl) for locally generated IP
packets. This parameter determines the number of hop-counts the
IP packet may pass before it is dropped.
Generally the time-to-live is 64 hop-counts.
By limiting the time-to-live continuous circulation of IP packets on
the network without ever reaching a destination is avoided.
OPTIONAL
204
IP Commands
fraglimit A number between 1 and 1024.
Represents the maximum number of IP packet fragments waiting for
completion.
Generally the fragmentation limit is 64.
By limiting the fragmentation limit the depletion of the buffer is
avoided.
OPTIONAL
defragmode Define which packets are reassembled under which circumstances.
Choose between:
normal
Packets to be forwarded will not be reassembled.
Packets with local destination, i.e. destined for the Speed-
Touch, are reassembled.
always
Packets are always reassembled.
nat
Same behaviour as normal except for packets to be forwarded
through the Network Address Translation (NAT) engine.
Packets on which address translation is performed are reas-
sembled as the NAT engine requires the entire packet.
OPTIONAL
addrcheck Set the level of IP address checks.
Choose between:
off
No address checking is performed.
For advanced users only; in normal circumstances there
should always be some kind of address checking.
own
Minimum level of checking.
Only the address configuration on the SpeedTouch is
checked.
static
Checking of the address configuration of the SpeedTouch
and also of traffic: addresses of incoming packets; this checking
is related to constants (e.g. an address may not be entirely
composed of ones or zeros).
dynamic
Besides the address configuration of the SpeedTouch itself,
and besides the checking of traffic on a constants level, addi-
tional checking is performed on the IP addresses that are
determined by the configuration, more specifically by the
network.
OPTIONAL
mssclamping Disable (off) or enable (on) mss clamping for low mtu interfaces.
Mss clamping assures that the size of a TCP packet never exceeds
the available mtu of the outgoing interface.
It is recommended not to disable this parameter.
OPTIONAL
205
IP Commands
EXAMPLE:
RELATED COMMANDS:
=>ip config
Forwarding on
Firewalling off
Sendredirects off
Sourcerouting on
NetBroadcasts off
Default TTL 128
Fraglimit 32 fragments
Fragcount currently 0 fragments
Defragment mode : always
Address checks : static
Mss clamping : on
=>ip config firewalling=on ttl=64 fraglimit=64 defragmode=nat
=>ip config
Forwarding on
Firewalling on
Sendredirects off
Sourcerouting on
NetBroadcasts off
Default TTL 64
Fraglimit 64 fragments
Fragcount currently 0 fragments
Defragment mode : nat
Address checks : static
Mss clamping : on
=>
ip ifconfig Configure interface parameters.
206
IP Commands
ip flush
Flush complete IP configuration. Dynamic configurations (e.g. from PPP or CIP links) remain.
Note As an ip flush causes all local IP connectivity to be deleted, do not execute this command during an IP based
local connection, e.g. a Telnet CLI session, or web based CLI access.
SYNTAX:
EXAMPLE:
ip flush
=>ip aplist
3 cip1 Type:ATM
2 eth0 Type:EthernetHWaddr 00:80:9f:24:ab:cf BRHWaddr ff:ff:ff:ff:ff:ff
0 loop Type:0
=>ip flush
=>ip aplist
3 cip1 Type:ATM
0 loop Type:0
inet addr: 127.0.0.1 Bcast:127.255.255.255 Mask:255.0.0.0
=>
207
IP Commands
ip ifconfig
Configure IP interface parameters.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip ifconfig intf = <interface name>
[mtu = <number{68-20000}>]
[status = <{down|up}>]
[group = <{wan|local|lan}>]
[linksensing = <{off|on}>]
mtu A number between 68 and 20000.
Represents the maximum transmission unit, i.e. the maximum
packet size (including IP header) to use on this interface.
The default value depends on the connection and packet service for
which the interface was created.
OPTIONAL
status The administrative status of the interface.
Choose between:
down
up
OPTIONAL
hwaddr The hardware address (e.g. the Ethernet MAC address) of this inter-
face.
OPTIONAL
group The group this interface belongs to (e.g. for oriented firewalling). OPTIONAL
linksensing The IP interface's awareness of link state transitions. OPTIONAL
=>ip iflist
Interface GRP MTU RX TX TX-DROP STATUS HWADDR
0 loop 1 1500 116 0 0 UP
1 eth0 2 3000 21045795 1019664 0 UP 00:80:9f:24:ab:cf
2 NewETHoA 0 1500 0 0 0 UP 00:80:9f:24:ab:cf
5 cip0 0 9180 0 0 0 UP
=>ip ifconfig intf=eth0 mtu=1500
=>ip iflist
0 loop 1 1500 116 0 0 UP
1 eth0 2 1500 21054963 1025417 0 UP 00:80:9f:24:ab:cf
5 cip0 0 9180 0 0 0 UP
=>
ip config Show/set global IP stack configuration options.
208
IP Commands
ip iflist
Show all current interfaces.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip iflist
=>ip iflist
0 loop 1 1500 116 0 0 UP
1 eth0 2 3000 21045795 1019664 0 UP 00:80:9f:24:ab:cf
5 cip0 0 9180 0 0 0 UP
=>
ip ifconfig Configure interface parameters.
209
IP Commands
ip ifwait
Wait for a status change of an IP interface.
SYNTAX:
ip ifwait intf = <interface name>
[timeout = <number{1-600000}>]
[adminstatus = <{down|up}>]
[operstatus = <{down|up}>]
[linkstatus = <{down|up}>]
timeout A number between 1 and 600000.
Represents the timeout in seconds.
OPTIONAL
adminstatus The administrative state of the interface.
Choose between:
down
up
OPTIONAL
operstatus The operational state of the interface.
Choose between:
down
up
OPTIONAL
linkstatus The link state of the interface.
Choose between:
down
up
OPTIONAL
210
IP Commands
ip ping
Send ICMP ECHO_REQUEST packets.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip ping addr = <ip-address>
[count = <number{1-1000000}>]
[size = <number{1-20000}>]
[listen = <{off|on}>]
addr The destination IP address. REQUIRED
Represents the number of pings to send.
OPTIONAL
size A number between 1 and 20000 (bytes).
Represents the size of the ping packet(s).
OPTIONAL
interval A number between 100 and 10000000 (milliseconds).
Represents the intermediate interval between two sent ICMP
packets.
OPTIONAL
listen Listen for incoming ICMP packets (on) or only send ICMP packets
(off).
OPTIONAL
=>ip ping addr=10.0.0.148 listen=off
=>ip ping addr=10.0.0.148 listen=on
9 bytes from 10.0.0.148: Echo Request
=>ip ping addr=10.0.0.148 count=15 listen=on
=>
ip sendto Send UDP packets.
211
IP Commands
ip rtadd
Add a route to the SpeedTouch routing table.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip rtadd dst = <ip-address>
[dstmsk = <ip-mask(dotted or cidr)>]
[label = <{}>]
[gateway = <ip-address>]
dst The destination IP address(es) for this route.
Supports cidr notation.
REQUIRED
dstmsk The destination IP address mask. OPTIONAL
label The name of the label. OPTIONAL
gateway The IP address of the next hop. Must be directly connected.
The parameters gateway and intf are mutually exclusive.
OPTIONAL
intf Only for special interface routes: the outgoing IP interface name.
OPTIONAL
metric The metric for this route (weight factor). OPTIONAL
=>ip rtlist
Destination Label Gateway Intf Mtrc Status
10.0.0.0/24 10.0.0.140 eth0 0 [UP]
10.0.0.140/32 10.0.0.140 eth0 0 [UP]
127.0.0.1/32 127.0.0.1 loop 0 [UP]
=>ip rtadd dst=10.10.0.0/24 src=10.0.0.0/24 gateway=10.0.0.140
=>ip rtlist
10.0.0.0/24 10.0.0.140 eth0 0 [UP]
10.10.0.0/24 10.0.0.140 eth0 0 [UP]
10.0.0.140/32 10.0.0.140 eth0 0 [UP]
127.0.0.1/32 127.0.0.1 loop 0 [UP]
=>
ip rtdelete Remove a route from the routing table.
ip rtlist Show current routing table.
212
IP Commands
ip rtdelete
Delete a route from the SpeedTouch routing table.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip rtdelete dst = <ip-address>
[label = <{}>]
[gateway = <ip-address>]
dst The destination IP address(es) for this route.
Supports cidr notation.
REQUIRED
dstmsk The destination IP address mask. OPTIONAL
gateway The IP address of the next hop. Must be directly connected.
OPTIONAL
intf Only for special interface routes: the outgoing IP interface name.
OPTIONAL
=>ip rtlist
10.0.0.0/24 10.0.0.140 eth0 0 [UP]
10.10.0.0/24 10.0.0.140 eth0 0 [UP]
10.0.0.140/32 10.0.0.140 eth0 0 [UP]
127.0.0.1/32 127.0.0.1 loop 0 [UP]
=>ip rtdelete dst=10.10.0.0/24 src=10.0.0.0/24 gateway=10.0.0.140
=>ip rtlist
10.0.0.0/24 10.0.0.140 eth0 0 [UP]
10.0.0.140/32 10.0.0.140 eth0 0 [UP]
127.0.0.1/32 127.0.0.1 loop 0 [UP]
=>
ip rtadd Add a route to the routing table.
ip rtlist Show current routing table.
213
IP Commands
ip rtlist
Show current SpeedTouch routing table.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip rtlist
=>ip rtlist
10.0.0.0/24 10.0.0.140 eth0 0 [UP]
10.0.0.140/32 10.0.0.140 eth0 0 [UP]
127.0.0.1/32 127.0.0.1 loop 0 [UP]
=>
ip rtadd Add a route to the routing table.
ip rtdelete Remove a route from the routing table.
214
IP Commands
ip sendto
Send UDP packets.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip sendto addr = <ip-address>
[count = <number{1-1000000}>]
[size = <number{1-20000}>]
[listen = <{off|on}>]
[srcport = <number{1-65535}>]
dstport = <number{1-65535}>
count A number between 1 (default) and 1000000.
Represents the number of UDP packets to send.
OPTIONAL
size A number between 1 (default) and 20000 (bytes).
Represents the size of the ping packet(s).
OPTIONAL
interval A number between 100 (default) and 10000000 (milliseconds).
Represents the intermediate interval between two sent UDP
packets.
OPTIONAL
listen Listen for incoming UDP packets (on) or only send UDP packets
(off). Default is off.
OPTIONAL
srcport The UDP source port number to use. OPTIONAL
dstport The UDP destination port number to send to. REQUIRED
=>ip sendto addr=10.0.0.148 listen=on srcport=19 dstport=1025
=>ip sendto addr=10.0.0.148 listen=on srcport=19 dstport=1025
1 bytes from 10.0.0.148:1025
41 A
=>ip sendto addr=10.0.0.148 count=3 listen=on srcport=19 dstport=1025
1 bytes from 10.0.0.148:1025
41 A
1 bytes from 10.0.0.148:1025
41 A
1 bytes from 10.0.0.148:1025
41 A
=>
ip ping Send ICMP ECHO_REQUEST packets.
215
IP Commands
ip traceroute
Sends ICMP/UDP packets to trace the ip path.
SYNTAX:
ip traceroute addr = <ip-address>
[count = <number{1-10}>]
[size = <number{1-20000}>]
[maxhops = <number{1-255}>]
[dstport = <number{1-65535}>]
[maxfail = <number{0-255}>]
[type = <{icmp|udp}>]
[utime = <{no|yes}>]
Represents the number of times to reissue a traceroute request
with the same time to live. Default is 3.
OPTIONAL
size A number between 1 and 20000 (bytes).
Represents the size of the traceroute packet(s). Default is 1.
OPTIONAL
interval A number between 100 and 10000000 (milliseconds).
Represents the intermediate interval between two packets.
Default is 1000.
OPTIONAL
maxhops A number between 1 and 255.
Represents the upper limit on the number of routers through which
a packet can pass.
Default is 30.
OPTIONAL
dstport A number between 1 and 65535.
Represents the UDP destination port number to send to.
OPTIONAL
maxfail A number between 0 and 255.
Represents the max number of consecutive time-outs allowed
before
terminating a traceroute request.
Default is 5
OPTIONAL
type The type of traceroute packet(s).
Choose between:
icmp (default)
udp
OPTIONAL
utime Display time in useconds (yes) or not (no). Default is yes. OPTIONAL
216
IP Commands
EXAMPLE:
=>ip traceroute addr = 192.193.195.250 count=3 size=1 interval=1000 maxhops=30 dstport=33433
maxfail=5 type=icmp utime=yes
:ip traceroute addr=192.193.195.250
ttl=1 192.193.195.250 676 us 1351 us 648 us
=>
217
IP Commands
ip auto flush
Flush the autoIP interfaces.
SYNTAX:
RELATED COMMANDS:
ip auto flush
ip auto ifadd Create a new autoIP interface.
ip auto ifdelete Delete an existing autoIP interface.
ip auto iflist Show the autoIP interfaces.
218
IP Commands
ip auto ifadd
Create a new autoIP interface.
SYNTAX:
RELATED COMMANDS:
ip auto ifadd intf = <interface name>
intf The name of the IP interface for which a link-local address has to be
allocated.
REQUIRED
addr The preferred link-local IP address. OPTIONAL
ip auto flush Flush the autoIP interfaces.
219
IP Commands
ip auto ifattach
Select and assign a link-local address to an autoIP interface.
SYNTAX:
RELATED COMMANDS:
ip auto ifattach intf = <interface name>
attached.
REQUIRED
ip auto ifdetach Release the link-local address for the given autoIP interface.
220
IP Commands
ip auto ifconfig
Configure an autoIP interface.
SYNTAX:
ip auto ifconfig intf = <interface name>
[poolstart = <ip-address>]
[poolend = <ip-address>]
[claim = <number{0-65535}>]
[defence = <number{0-65535}>]
[probe = <number{0-65535}>]
intf The name of the autoIP interface to configure. REQUIRED
addr The preferred link-local IP address. OPTIONAL
poolstart The start IP address of the link-local address pool. OPTIONAL
poolend The end IP address of the link-local address pool. OPTIONAL
netmask The netmask of the link-local IP address pool. OPTIONAL
claim A number between 0 and 65535.
Represents the number of link-local address selection retries before
giving up. Default is 10.
OPTIONAL
defence A number between 0 and 65535.
Represents the number of times the link-local address is defended
before releasing the address. Default is 5.
OPTIONAL
probe A number between 0 and 65535.
Represents the number of ARP probes to be sent before accepting a
link-local address. Default is 4.
OPTIONAL
interval A number between 1 and 65535 (seconds).
Represents the time interval between two ARP probe
transmissions. Default is 2.
OPTIONAL
221
IP Commands
ip auto ifdelete
Delete an existing autoIP interface.
SYNTAX:
RELATED COMMANDS:
ip auto ifdelete intf = <interface name>
intf The name of the IP interface to be deleted. REQUIRED
ip auto flush Flush the autoIP interfaces.
222
IP Commands
ip auto ifdetach
Release the link-local address for the given autoIP interface.
SYNTAX:
RELATED COMMANDS:
ip auto ifdetach intf = <interface name>
detached.
REQUIRED
ip auto ifattach Select and assign a link-local address to an autoIP interface.
223
IP Commands
ip auto iflist
Shows the autoIP interfaces.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ip auto iflist [intf = <interface name>]
intf The name of the interface to be listed. If no name is specified, all the
autoIP interfaces are shown.
OPTIONAL
=>ip auto iflist
eth0 : [CLAIMED] 169.254.138.1
poolstart = 169.254.1.1 poolend = 169.254.254.254 netmask = 255.255.0.0
claim : 10 defence : 5 probe : 4 interval : 2 (sec)
probes sent = 2
collisions = 0
=>
224
IP Commands
225
IPoA Commands
IPoA Commands
Contents
Topic Page
ipoa flush 226
ipoa ifadd 227
ipoa ifattach 228
ipoa ifconfig 229
ipoa ifdelete 231
ipoa ifdetach 232
ipoa iflist 233
226
IPoA Commands
ipoa flush
Flush complete Routed IPoA configuration.
SYNTAX:
RELATED COMMANDS:
ipoa flush
ipoa ifadd Create a new Routed IPoA interface.
ipoa ifattach Attach (i.e. connect) an Routed IPoA interface.
ipoa ifconfig Configure a Routed IPoA interface.
ipoa ifdelete Delete a Routed IPoA interface.
ipoa ifdetach Detach a Routed IPoA interface.
ipoa iflist Show current Routed IPoA interfaces.
227
IPoA Commands
ipoa ifadd
Create a new Routed IPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ipoa ifadd [intf = <string>]
intf The name for the new Routed IPoA interface.
OPTIONAL
dest The destination for the new Routed IPoA interface.
OPTIONAL
=>ipoa iflist
IPoA_1 : dest : IPoA_1
=>phonebook list
IPoA_1 ipoa 1 8.35
IPoA_2 ipoa 0 8.36
=>ipoa ifadd dest=IPoA_2
=>ipoa iflist
=>
ipoa flush Flush complete Routed IPoA configuration.
228
IPoA Commands
ipoa ifattach
Attach (i.e. connect) an Routed IPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ipoa ifattach intf = <intfname>
intf The name of the Routed IPoA interface to attach. REQUIRED
=>ipoa iflist
IPoA_PVC1 : dest : Br4
Br3 : dest : Br3
=>ipoa ifattach intf=Br3
Br3 : dest : Br3
=>
229
IPoA Commands
ipoa ifconfig
Configure an IPoA interface.
SYNTAX:
EXAMPLE:
ipoa ifconfig intf = <string>
[dest = <intfname>]
[qos = <string>]
[retry = <number {0-65535}>]
intf The name of the Routed IPoA interface to configure. REQUIRED
This parameter needs only to be specified in case of an interface created
without specified destination.
OPTIONAL
qos The name of a configured Quality Of Service book entry.
If not specified, the default Quality Of Service book entry will be used.
OPTIONAL
encaps The type of encapsulation to be used for this bridge interface.
Choose between:
llc/snap
vcmux
OPTIONAL
Represents the number of Wide Area Network (WAN) connection setup
retries before giving up.
OPTIONAL
=>ipoa iflist
=>ipoa ifconfig intf=IPoA_PVC1 encaps=llc/snap retry=15
=>ipoa iflist
Moreipoa : dest : Br4
=>
230
IPoA Commands
RELATED COMMANDS:
231
IPoA Commands
ipoa ifdelete
Delete a Routed IPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ipoa ifdelete intf = <intfname>
intf The name of the Routed IPoA interface. REQUIRED
=>ipoa iflist
Newipoa : dest : Br3
Moreipoa dest : Br4
=>ipoa ifdelete intf=Moreipoa
=>ipoa iflist
=>
232
IPoA Commands
ipoa ifdetach
Detach a Routed IPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ipoa ifdetach intf = <intfname>
intf The name of the Routed IPoA interface. REQUIRED
=>ipoa iflist
Moreipoa dest : Br4
=>ipoa ifdetach intf=Moreipoa
=>ipoa iflist
Moreipoa dest : Br4
=>
233
IPoA Commands
ipoa iflist
Show all or a specified Routed IPoA interface(s).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ipoa iflist [intf = <intfname>]
intf The name of the Routed IPoA interface.
If not specified all Routed IPoA interfaces are listed.
OPTIONAL
=>ipoa iflist
Moreipoa dest : Br4
=>
234
IPoA Commands
235
Label Commands
Label Commands
Contents
Topic Page
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
236
Label Commands
label add
Create a new label.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
label add name = <string>
name The name of the label to add. REQUIRED
=>label add name=Label1
=>label list
Name Tosmark Tos Use Trace
Label1 disabled 0 0 disabled
=>
label config Configure a label.
label delete Delete a label.
237
Label Commands
label config
Configure a label.
SYNTAX:
EXAMPLE:
Note A ToS value of 184 decimal is used for DiffServ Expedited Forwarding data.
RELATED COMMANDS:
label config name = <string>
[tosmarking = <{disabled|enabled}>]
[tos = <number{0-255}>]
[trace = <{disabled|enabled}>]
name The name of the label to configure. REQUIRED
tosmarking Enable/disable tos marking.
Choose between
disabled (default).
enabled.
OPTIONAL
Represents the Type of Service (ToS) specification in the IP packet
(used for tosmarking).
Default is 0.
OPTIONAL
trace Enable/disable tracing for this label.
Choose between
disabled (default).
enabled.
OPTIONAL
=>label list
=>label config name=fromconference tosmarking=enabled tos=184
=>label list
fromconference enabled 184 0 disabled
=>
label add Add a label.
label delete Delete a label.
238
Label Commands
label delete
Delete a label
SYNTAX:
RELATED COMMANDS:
label delete name = <string>
[force = <{no|yes}>]
name The name of the label to delete. REQUIRED
force Force delete and cleanup references even when the label is still in
use.
Choose between
no (default).
yes.
OPTIONAL
label add Add a label.
label config Configure a label.
239
Label Commands
label flush
Flushes all labels.
SYNTAX:
EXAMPLE:
label flush
=>label list
Label1 enabled 25 0 enabled
=>label flush
=>label list
=>
240
Label Commands
label list
Show the association(s) between all hooks or a specified hook and their chain(s).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
label list [name = <string>]
name The name of the label to be shown.
If no name is specified, all labels will be shown
OPTIONAL
=>label list
Label1 enabled 25 0 enabled
=>label list name=Label2
=>
label flush Flushes all labels.
241
Label Commands
label troff
Disable verbose console messaging.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
label troff
=>label troff
label tron Enable verbose console messaging.
242
Label Commands
label tron
Enable verbose console messaging.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
label tron
=>label tron
label troff Disable verbose console messaging.
243
Label Commands
label chain create
Create a new chain.
SYNTAX:
RELATED COMMANDS:
label chain create chain = <string>
chain The name of the chain to create. REQUIRED
label chain delete Delete a chain.
label chain list Show a list of all current chains.
244
Label Commands
label chain delete
Delete a chain.
SYNTAX:
RELATED COMMANDS:
label chain delete chain = <string>
chain The name of the chain to be deleted. REQUIRED
label chain create Create a chain.
label chain list Show a list of all chains.
245
Label Commands
label chain flush
Flush all chains.
SYNTAX:
RELATED COMMANDS:
label chain flush
label chain list Show a list of all chains.
246
Label Commands
label chain list
Show a list of all current chains.
SYNTAX:
RELATED COMMANDS:
label chain list
247
Label Commands
label rule clear
Clear statistics for a given rule.
SYNTAX:
RELATED COMMANDS:
label rule clear [chain = <string>]
[index = <number>]
chain The name of the chain in which the rule is to be found. OPTIONAL
index The index number (determined by the position) of the rule in the
chain.
OPTIONAL
label rule create Create a rule.
label rule delete Delete a specified rule in a chain.
label rule flush Delete all rules in a chain.
label rule list Show a list of all (or a specified) chains' rules.
label rule stats Show statistics for all (or a specified) chains' rules.
248
Label Commands
label rule create
Create a rule.
SYNTAX:
label rule create chain = <string>
[index = <number>]
[srcintf [!]= <string>]
[srcintfgrp [!]= <{wan|local|lan} or number>]
[srcbridgeport [!]= <number>]
[src [!]= <ip-range>]
[dst [!]= <ip-address>]
[tos [!]= <number{0-255}>]
[precedence [!]= <number{0-7}>]
[dscp [!]= <number{0-63}>]
[prot [!]= <{<supported IP protocol name>|<number>}>]
[srcport [!]= <{<supported TCP/UDP port name>|<number>}>]
[srcportend = <{<supported TCP/UDP port name>|<number>}>]
[dstport [!]= <{<supported TCP/UDP port name>|<number>}>]
[dstportend = <{<supported TCP/UDP port name>|<number>}>]
[clink = <string>]
[log = <{no|yes}>]
label = <{None|link|<labels}>
chain The name of the chain to insert the rule in. REQUIRED
index The number of the rule before which the new rule must be added. OPTIONAL
srcintf The name of the interface the packet should arrive on to make this
rule apply.
OPTIONAL
srcintfgrp The interface group the packet should arrive on. OPTIONAL
srcbridgeport A number between 0 and 6.
Represents the bridge port the virtual packet should arrive on.
Use :bridge iflist for a list of available bridge ports.
OPTIONAL
src The source IP address (range) the packet should come from.
(Supports ip/mask notation).
OPTIONAL
dst The destination IP address (range) the packet should be going to.
(Supports ip/mask notation).
OPTIONAL
Represents the Type Of Service specification which should be
expected in the IP packet. The Type of Service numbering
specification is in accordance to the latest version of RFC1700:
Assigned numbers.
OPTIONAL
249
Label Commands
RELATED COMMANDS:
precedence A number between 0 and 7.
Represents the precedence in the IP packet (is part of tos)
OPTIONAL
dscp The DSCP in the IP packet (part of tos). OPTIONAL
prot The protocol (name or number) expected in the IP packet.
OPTIONAL
srcport The TCP/UDP port (or beginning of range) the packet is coming
from.
OPTIONAL
srcportend The source TCP/UDP port range end (inclusive).
OPTIONAL
dstport The TCP/UDP port (or beginning of range) the packet is going to.
OPTIONAL
dstportend The destination TCP/UDP port range end (inclusive).
OPTIONAL
clink The name of the chain to be parsed when this rule applies. (action is
ignored).
OPTIONAL
log Logging is done when this rule applies.
Choose between: no or yes
OPTIONAL
label None, link (when clink is used) or label name. REQUIRED
label rule clear Clear statistics for a given rule.
250
Label Commands
label rule delete
Delete a rule.
SYNTAX:
RELATED COMMANDS:
label rule delete chain = <string>
index = <number>
chain The name of the chain in which to delete the rule. REQUIRED
index The index number of the rule in the chain.
Note Use :label rule list first to determine the index number of
the applicable rule.
REQUIRED
251
Label Commands
label rule flush
Flush all rules created for a chain(s). The chain itself is not removed.
SYNTAX:
RELATED COMMANDS:
label rule flush [chain = <string>]
chain The name of the chain to empty.
are deleted.
OPTIONAL
252
Label Commands
label rule list
Show a list of rules.
SYNTAX:
EXAMPLE INPUT AND OUTPUT:
RELATED COMMANDS:
label rule list [chain = <string>]
chain The name of the chain to list the rules of.
are shown.
OPTIONAL
=>label rule list
label rule create chain=_auto_labels index=0 clink=user_labels label=link
=>
253
Label Commands
label rule stats
Show statistics, i.e. the number of packets and bytes which have passed the hooks.
SYNTAX:
RELATED COMMANDS:
label rule stats [chain = <string>]
[index = <number>]
chain The name of the chain of which the statistics must be listed.
In case this parameter is not specified the statistics for the rules
applicable to all chains are shown.
OPTIONAL
index The index number of the chain's rule of which the statistics must be
listed. Execute label rule list first to determine the index number of
the applicable rule.
In case this parameter is not specified the statistics for all rules
applicable to the specified chain are shown.
OPTIONAL
254
Label Commands
255
Language Commands
Language Commands
Contents
Topic Page
language config 256
language list 257
language remove 258
256
Language Commands
language config
Select a language.
SYNTAX:
RELATED COMMANDS:
language config [language = <string>]
language Language code: OSI language code (2 chars) for language
(en=english)
OPTIONAL
language list List available languages archives.
language remove Remove one or all language archives.
257
Language Commands
language list
List available languages archives.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
language list
=>language list
CODE LANGUAGE VERSION FILENAME
en* english 4.2.0.1 <system>
language config Select a language.
258
Language Commands
language remove
Remove one or all language archives.
SYNTAX:
RELATED COMMANDS:
language remove [file = <string>]
[all <{yes|no}>]
file Filename: name of language archive to remove OPTIONAL
all Removes all languages archives.
Choose between:
yes
no
OPTIONAL
language config Select a language.
259
NAT Commands
NAT Commands
Contents
Topic Page
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
260
NAT Commands
nat applist
List available Network Address Translation / Port Address Translation (NAT/PAT) protocol helpers.
Certain protocols are sensitive to NAT/PAT in that they do not function properly when dealing with it. This list shows
which NAT/PAT-sensitive applications are supported on the SpeedTouch, i.e. the inherent knowledge of the
SpeedTouchon this matter.
SYNTAX:
EXAMPLE OUTPUT:
RELATED COMMANDS:
nat applist
=>nat applist
Application Proto DefaultPort
GRE gre 1 INCOMING
PPTP tcp 1723 OUTGOING INCOMING
ESP 50 1 OUTGOING INCOMING
IKE udp 500 OUTGOING INCOMING
SIP udp 5060 OUTGOING INCOMING
ILS tcp 0 OUTGOING
H245 tcp 0 OUTGOING INCOMING
H323 tcp 1720 OUTGOING INCOMING
RAUDIO(PNA) tcp 7070 OUTGOING
RTSP tcp 554 OUTGOING
IRC tcp 6667 OUTGOING
FTP tcp 21 OUTGOING
=>
nat bind Create a new helper/port binding.
nat bindlist List current NAT/PAT helper/port bindings.
nat unbind Delete an existing helper/port binding.
261
NAT Commands
nat bind
Create a new helper/port binding.
SYNTAX:
nat bind application = <string>
port = <{<supported TCP/UDP port name>|<number>}>
[port_end = <{<supported TCP/UDP port name>|<number>}>]
application The name of a NAT/PAT application helper. The name must be
spelled exactly as listed in the application list (:nat applist).
REQUIRED
port The TCP/UDP port this application handler should work on.
REQUIRED
port_end The TCP/UDP end port of the range of ports this application
handler should work on.
OPTIONAL
262
NAT Commands
EXAMPLE:
EXAMPLE:
=>nat bindlist
Application Proto Port
SIP udp 5060
GRE gre 1
PPTP tcp 1723
ILS tcp 1002
ILS tcp 389
H323 tcp 1720
FTP tcp 21
IRC tcp 6667
RAUDIO(PNA) tcp 7070
=>nat bind application=RAUDIO(PNA) port=7071
=>nat bindlist
SIP udp 5060
GRE gre 1
PPTP tcp 1723
ILS tcp 1002
ILS tcp 389
H323 tcp 1720
FTP tcp 21
IRC tcp 6667
=>
=>nat bindlist
FTP tcp 21
GRE gre 1
H323 tcp 1720
ILS tcp 389
ILS tcp 1002
IRC tcp 6667
PPTP tcp 1723
RTSP tcp 554
SIP udp 5060
=>nat bind application=RAUDIO(PNA) port=7072 port_end=7075
=>nat bindlist
FTP tcp 21
GRE gre 1
H323 tcp 1720
ILS tcp 389
ILS tcp 1002
IRC tcp 6667
PPTP tcp 1723
RAUDIO(PNA) tcp 7072-7075
RTSP tcp 554
SIP udp 5060
=>
263
NAT Commands
RELATED COMMANDS:
nat applist List available NAT/PAT protocol helpers.
nat unbind Delete an existing helper/port binding
264
NAT Commands
nat bindlist
List current NAT/PAT helper/port bindings.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
nat bindlist
=>nat bindlist
SIP udp 5060
GRE gre 1
PPTP tcp 1723
ILS tcp 1002
ILS tcp 389
H323 tcp 1720
FTP tcp 21
RTSP tcp 554
IRC tcp 6667
=>
nat unbind Delete an existing helper/port binding
265
NAT Commands
nat clear
Clear NAT/PAT connection database.
SYNTAX:
nat clear [addr = <ip-address>]
addr An address-translation enabled IP address.
If no IP address is specified, all IP addresses are cleared.
OPTIONAL
266
NAT Commands
nat config
Configure NAT parameters for IP session.
SYNTAX:
EXAMPLE:
nat config [timeout_ICMP = <string>]
[timeout_UDP = <string>]
[timeout_TCP = <string>]
[timeout_TCP_nego = <string>]
[timeout_other = <string>]
[ike_port = <{fixed|floated}>]
timeout_ICMP The interval of time for which an ICMP protocol session is allowed
to remain valid without any activity.
Syntax: <HH:MM> or <MM>.
OPTIONAL
timeout_UDP The interval of time for which an UDP protocol session is allowed
to remain valid without any activity.
OPTIONAL
timeout_TCP The interval of time for which an TCP protocol session is allowed
to remain valid without any activity. This time-out value applies to a
TCP session during its data transfer phase.
OPTIONAL
timeout_TCP_nego The interval of time for which an TCP protocol session is allowed
to remain valid without any activity. This time-out value applies to a
TCP session during its establishment and termination phases.
Syntax:<HH:MM> or <MM>.
OPTIONAL
timeout_other The interval of time for which an IP session for a protocol other
than ICMP, UDP and TCP is allowed to remain valid without any
activity.
OPTIONAL
ike_port The IKE outside port number. This is the translation port number
for IKEv1 (fixed to 500 or floated).
OPTIONAL
=>nat config
Timeout ICMP idle : 00h01m
Timeout UDP idle : 00h05m
Timeout TCP idle : 00h15m
Timeout TCP negotiation idle : 00h02m
Timeout Other idle : 00h01m
IKE outside port number : Floated
=>
267
NAT Commands
nat create
Create a static NAT/PAT entry. Typically used to install specific servers behind the SpeedTouch NAT/PAT device.
SYNTAX:
nat create protocol = <{<supported IP protocol name>|<number>}>
inside_addr = <ip-address>
[inside_port = <{<supported TCP/UDP port name>|<number>}>]
outside_addr = <ip-address>
[outside_port = <{<supported TCP/UDP port name>|<number>}>]
[foreign_addr = <ip-address>]
[foreign_port = <{<supported TCP/UDP port name>|<number>}>]
protocol The IP protocol name (or number) of the incoming stream.
REQUIRED
inside_addr The IP address of the local host (intended to receive the incoming
traffic) behind the SpeedTouch 's NAT/PAT device.
Typically, a private IP address.
REQUIRED
inside_port The port of the application on the local host.
Applicable for TCP and UDP protocols only. Other protocols do
not need a port to be specified.
OPTIONAL
outside_addr The apparent host IP address this application is running on, i.e. the
NAT/PAT enabled WAN IP address of the SpeedTouch.
Use '0' to create a template. Such template will then be valid for any
of SpeedTouch 's NAT/PAT enabled IP addresses, e.g. also dynam-
ically assigned/negotiated IP addresses.
REQUIRED
outside_port The apparent port number this application is running on.
OPTIONAL
foreign_addr The IP address of the in-front-of-NAT/PAT routable address.
Use '0' to match all foreign addresses.
OPTIONAL
268
NAT Commands
RELATED COMMANDS:
foreign_port The port of the routable host.
Alternatively, specify the protocol number. Do not use '0' in case a
foreign IP address is specified.
OPTIONAL
nat delete Delete a static NAT/PAT entry.
nat disable Disable NAT/PAT on a SpeedTouch IP address.
nat enable Enable NAT/PAT on one of the SpeedTouch IP addresses.
nat list List NAT/PAT connection database.
269
NAT Commands
nat defserver
Define the default server behind the SpeedTouch NAT/PAT device that receives all (unknown) incoming packets.
In typical LAN configurations one local 'default' server will be responsible for all WAN-LAN mail, http, ftp, ... connec-
tivity. This command allows to specify this server. For specific services, use :nat create.
SYNTAX:
nat defserver [addr = <ip-address>]
addr The IP address of the server (on the inside) that will receive all
(unknown) incoming packets.
If not specified, the current default server is shown.
OPTIONAL
=>nat defserver
Default server is undefined
=>nat defserver addr=10.0.0.1
=>nat defserver
Default server is 10.0.0.1
=>
270
NAT Commands
nat delete
Delete a static NAT/PAT entry.
SYNTAX:
nat delete protocol = <{<supported IP protocol name>|<number>}>
inside_addr = <ip-address>
[inside_port = <{<supported TCP/UDP port name>|<number>}>]
outside_addr = <ip-address>
[outside_port = <{<supported TCP/UDP port name>|<number>}>]
[foreign_addr = <ip-address>]
[foreign_port = <{<supported TCP/UDP port name>|<number>}>]
protocol The IP protocol name (or number) of the incoming stream.
REQUIRED
inside_addr The IP address of the local host (intended to receive the incoming
traffic) behind the SpeedTouch 's NAT/PAT device.
Typically, a private IP address.
REQUIRED
inside_port The port of the application on the local host.
OPTIONAL
outside_addr The apparent host IP address this application is running on, i.e. the
NAT/PAT enabled WAN IP address of the SpeedTouch.
Use '0' to delete an entry valid for any of SpeedTouch 's NAT/PAT
enabled IP addresses, e.g. also dynamically assigned/negotiated IP
addresses.
REQUIRED
outside_port The apparent port number this application is running on.
OPTIONAL
foreign_addr The IP address of the in-front-of-NAT/PAT routable address. REQUIRED
271
NAT Commands
RELATED COMMANDS:
foreign_port The port of the routable host.
OPTIONAL
nat create Create a static NAT/PAT entry.
272
NAT Commands
nat disable
Disable NAT or PAT on the specified SpeedTouch IP address.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
nat disable addr = <ip-address>
addr The SpeedTouch IP address for which NAT/PAT must be disabled. REQUIRED
=>nat list
Indx Prot Inside-addr:Port Outside-addr:Port Foreign-addr:Port Flgs Expir State Control
1 6 10.0.0.138:80 172.16.0.5:1080 0.0.0.0:0 19 8 9
2 17 10.0.0.138:138 10.0.0.140:138 10.0.0.20:138 11 20 10
3 17 10.0.0.138:137 10.0.0.140:137 10.0.0.254:137 11 20 10
4 17 10.0.0.138:7938 10.0.0.140:7938 10.0.0.96:4756 11 20 10
5 17 10.0.0.138:513 10.0.0.140:513 10.0.0.109:513 11 20 10
6 17 10.0.0.138:111 10.0.0.140:111 10.0.0.96:4756 11 20 10
=>nat disable addr 172.16.0.5
=>nat list
1 17 10.0.0.138:138 10.0.0.140:138 10.0.0.20:138 11 20 10
2 17 10.0.0.138:137 10.0.0.140:137 10.0.0.254:137 11 20 10
3 17 10.0.0.138:7938 10.0.0.140:7938 10.0.0.96:4756 11 20 10
4 17 10.0.0.138:513 10.0.0.140:513 10.0.0.109:513 11 20 10
5 17 10.0.0.138:111 10.0.0.140:111 10.0.0.96:4756 11 20 10
=>
273
NAT Commands
nat enable
Enable NAT/PAT on a SpeedTouch IP address.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
nat enable addr = <ip-address>
[type = <{none|pat}>]
addr The IP address to use for outgoing address translation. Must be one of
the own IP addresses of the SpeedTouch (see 'ip aplist').
REQUIRED
type Enable port translation (pat) or not (none). OPTIONAL
=>ip aplist
0 loop Type:0
=>nat enable addr=10.10.10.147 type=pat
=>ip aplist
0 loop Type:0
=>
274
NAT Commands
nat flush
Flush complete NAT/PAT configuration.
SYNTAX:
RELATED COMMANDS:
nat flush
275
NAT Commands
nat list
Lists NAT/PAT connection database.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
nat list [addr = <ip-address>]
addr An address-translation enabled IP address.
If no address is specified, all IP addresses are shown.
OPTIONAL
=>nat list
1 6 10.0.0.138:80 172.16.0.5:1080 0.0.0.0:0 19 8 9
2 17 10.0.0.138:138 10.0.0.140:138 10.0.0.20:138 11 20 10
3 17 10.0.0.138:137 10.0.0.140:137 10.0.0.254:137 11 20 10
4 17 10.0.0.138:7938 10.0.0.140:7938 10.0.0.96:4756 11 20 10
5 17 10.0.0.138:513 10.0.0.140:513 10.0.0.109:513 11 20 10
6 17 10.0.0.138:111 10.0.0.140:111 10.0.0.96:4756 11 20 10
=>
276
NAT Commands
nat multinatadd
Add a MultiNAT configuration.
SYNTAX:
RELATED COMMANDS:
nat multinatadd intf = <string>
inside_addr = <ip-range>
outside_addr = <ip-range>
intf The IP interface name where MultiNAT has to be applied. REQUIRED
inside_addr The IP address of the host behind the address translation device that will
receive the incoming traffic. Typically, a private IP address.
REQUIRED
outside_addr The apparent host IP address this application will running on. Use '0' to
create a template.
REQUIRED
nat multinatdelete Delete a MultiNAT configuration.
nat multinatlist List MultiNAT configurations.
277
NAT Commands
nat multinatdelete
Delete a MultiNAT configuration.
SYNTAX:
RELATED COMMANDS:
nat multinatdelete index = <number>
index The MultiNAT index as listed by maplist. REQUIRED
nat multinatadd Add a MultiNAT configuration.
nat multinatlist List MultiNAT configurations.
278
NAT Commands
nat multinatlist
List MultiNAT configurations.
SYNTAX:
RELATED COMMANDS:
nat multinatlist [intf = <string>]
addr The IP interface name for which the MultiNAT configuration must be
listed. If no name is specified, all MultiNAT configurations are listed.
OPTIONAL
nat multinatadd Add a MultiNAT configuration.
nat multinatdelete Delete a MultiNAT configuration.
279
NAT Commands
nat unbind
Delete an existing helper/port binding.
SYNTAX:
EXAMPLE:
nat unbind application = <string>
port = <{<supported TCP/UDP port name>|<number>}>
[port_end = <{<supported TCP/UDP port name>|<number>}>]
application The name of a NAT/PAT application helper.
The name must be spelled exactly as listed in the application list
(:nat applist).
REQUIRED
port The TCP/UDP port this application handler is working on.
REQUIRED
port_end The TCP/UDP end port of the range of ports this application
handler should work on.
OPTIONAL
=>nat bindlist
FTP tcp 21
GRE gre 1
H323 tcp 1720
ILS tcp 389
ILS tcp 1002
IRC tcp 6667
PPTP tcp 1723
RAUDIO(PNA) tcp 7072-7075
RTSP tcp 554
SIP udp 5060
=>nat unbind application=RAUDIO(PNA) port=7072 port_end=7075
=>nat bindlist
FTP tcp 21
GRE gre 1
H323 tcp 1720
ILS tcp 389
ILS tcp 1002
IRC tcp 6667
PPTP tcp 1723
RTSP tcp 554
SIP udp 5060
=>
280
NAT Commands
RELATED COMMANDS:
281
Phonebook Commands
Phonebook Commands
Contents
Topic Page
phonebook add 282
phonebook autolist 284
phonebook delete 285
phonebook flush 286
phonebook list 287
282
Phonebook Commands
phonebook add
Add a phonebook entry.
SYNTAX:
phonebook add name = <string>
addr = <atmchannel : PVC syntax is [port.]vpi.vci
port=dsl0|dsl1|...>
type = <{any|ethoa|pppoa|ipoa}>
name A free to choose phonebook name for the destination.
Two limitations apply:
The name of a phonebook entry intended for the Relayed PPPoA
(PPPoA-to-PPTP Relaying) packet service may not start with capital
P or capital T
The name of a phonebook entry intended for the PPP-to-DHCP
spoofing packet service must start with DHCP, e.g.
DHCP_Spoof01.
REQUIRED
addr The ATM address for this destination.
It is composed of a Virtual Path Identifier (VPI) and a Virtual Channel
Identifier (VCI) identifying ATM virtual channels.
In most cases the values are provided by the Service Provider.
Accepted VPI: a number between 0 and 15
Accepted VCI: a number between 0 and 511.
REQUIRED
type The Connection Service supported by the destination.
Choose between:
any (All Packet Services)
ethoa (Bridged Ethernet, Routed Ethernet, Bridged PPPoE, Routed
PPPoE)
pppoa (Routed PPPoA and Relayed PPPoA)
ipoa (Classical IPoA and Routed IPoA).
REQUIRED
283
Phonebook Commands
EXAMPLE:
Note The usb_port phonebook entry is only applicable in case of a SpeedTouch530 variant. Do not change this
phonebook entry in any way, or delete it from the phonebook!
RELATED COMMANDS:
=>phonebook list
usb_port any 1 usb.0.35
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
=>phonebook add name=PVC_Test addr=8.68 type=pppoa
=>phonebook list
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
PVC_Test pppoa 0 8.68
=>
phonebook delete Remove a phonebook entry.
phonebook list Show current phonebook.
284
Phonebook Commands
phonebook autolist
Show auto PVCs, if supported by the Central Office DSLAM.
SYNTAX:
RELATED COMMANDS:
phonebook autolist
=>phonebook autolist
8.35
=>
285
Phonebook Commands
phonebook delete
Remove an unused phonebook entry.
SYNTAX:
EXAMPLE:
Note In case of a SpeedTouch530 variant, never delete the usb_port phonebook entry!
RELATED COMMANDS:
phonebook delete name = <string>
name The name of the phonebook entry to delete.
Only applicable for phonebook entries that are not used, i.e. not config-
ured for any packet service.
Execute phonebook list to check whether the entry is used (Use=1) or
not (Use=0).
REQUIRED
=>phonebook list
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
=>phonebook delete name=PVC_Test
=>phonebook list
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
=>
phonebook add Add a phonebook entry.
286
Phonebook Commands
phonebook flush
Flush complete phonebook.
SYNTAX:
EXAMPLE:
Note In case of a SpeedTouch530 variant, flushing the Phonebook may cause the device to become inaccessible
from its USB interface.
phonebook flush
=>phonebook list
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
=>phonebook flush
=>phonebook list
=>
287
Phonebook Commands
phonebook list
Show current phonebook.
SYNTAX:
Note The usb_port phonebook entry is only applicable in case of a SpeedTouch530 variant. Do not change this
phonebook entry in any way, or delete it from the phonebook!
RELATED COMMANDS:
phonebook list
=>phonebook list
PVC1 any 1 8.35
PVC2 ethoa 0 8.36
Br4 ethoa 0 8.38
CIPPVC3 ipoa 1 8.82
=>
phonebook add Add a phonebook entry.
phonebook autolist Show auto PVCs.
phonebook delete Remove a phonebook entry.
288
Phonebook Commands
289
PPPoA Commands
PPPoA Commands
Contents
Topic Page
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
290
PPPoA Commands
pppoa flush
Flushes the current PPPoA configuration.
SYNTAX:
EXAMPLE:
pppoa flush
=>pppoa iflist
pppoa1: dest : pppoa1
Retry: 10 QoS default encaps VC-MUX
mode = IP Routing
flags = echo magic accomp mru addr route savepwd pppoaOA
trans addr = pat mru = 1500
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
user name = guest password = ********
admin state = down oper state = down link state = not-connected
LCP: state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>pppoa flush
=>pppoa iflist
=>
291
PPPoA Commands
pppoa ifadd
Create a new PPPoA interface.
SYNTAX:
EXAMPLE:
pppoa ifadd [intf = <string>]
intf The name for the new PPPoA interface.
OPTIONAL
dest The ATM channel to be used for this PPPoA interface.
Typically, an phonebook entry.
OPTIONAL
=>pppoa iflist
pppoa_pppoa: dest : pppoa [00:00:00]
Retry : 10 QoS default encaps VC-MUX
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 trans addr = pat mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = up oper state = down link state = retrying
LCP : state = starting retransm = 1 term. reason =
=>pppoa ifadd intf=pppoa2 dest=pppoa2
=>pppoa iflist
mode = IP routing
pppoa2: dest : pppoa2 [00:00:00]
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user = password =
LCP : state = initial retransm = 10 term. reason =
=>
292
PPPoA Commands
RELATED COMMANDS:
pppoa ifattach Attach a PPPoA interface.
pppoa ifconfig Configure a PPPoA interface.
pppoa ifdelete Delete a PPPoA interface.
pppoa ifdetach Detach a PPPoA interface.
pppoa iflist Show current PPPoA configuration.
293
PPPoA Commands
pppoa ifattach
Attach (i.e. connect) a PPPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoa ifattach intf = <intfname>
intf The name of the PPPoA interface to attach. REQUIRED
=>pppoa iflist
mode = IP routing
=>pppoa ifattach intf=pppoa1
=>pppoa iflist
mode = IP routing
admin state = up oper state = up link state = connected
=>
pppoa ifadd Create a new PPPoA interface.
294
PPPoA Commands
pppoa ifconfig
Configure a PPPoA interface.
Note The interface to be configured may not be connected at the time of configuration.
Execute PPPoA ifdetach prior to executing the PPPoA ifconfig command.
SYNTAX:
pppoa ifconfig intf = <intfname>
[user = <string>]
[password = <password>]
[qos = <{default}>]
[encaps = <{vcmux|llc}>]
[pcomp = <{off|on}>]
[accomp = <{on|off|negotiate}>]
[auth = <{pap|chap|auto}>]
[restart = <{off|on}>]
[retryinterval = <number{0-65535}>]
[passive = <{off|on}>]
[silent = <{off|on}>]
[echo = <{off|on}>]
[mru = <number{293-8192}>]
[laddr = <ip-address>]
[raddr = <ip-address>]
[format = <{cidr|dotted|none}>]
[pool = <{none}>]
[savepwd = <{off|on}>]
[demanddial = <{off|on}>]
[primdns = <ip-address>]
[secdns = <ip-address>]
[idle = <number{0-1000000}>]
[idletrigger = <{RxTx|Rx|Tx}>]
[unnumbered = <{off|on}>]
intf The name of the PPPoA interface to configure. REQUIRED
dest The destination for this PPPoA interface.
OPTIONAL
user The user name for remote PAP/CHAP authentication. OPTIONAL
password The password for remote PAP/CHAP authentication. OPTIONAL
qos The name of a qosbook entry defining the QoS parameters for the WAN
link.
OPTIONAL
295
PPPoA Commands
encaps The WAN protocol encapsulation to be used on this interface.
Choose between:
vcmux
llc
OPTIONAL
pcomp Try (on) or do not try (off) to negotiate PPPoA protocol compression
(LCP PCOMP). By default the negotiation is disabled (off).
OPTIONAL
accomp Try (on), do never try (off) or negotiate (negotiate) to negotiate PPPoA
address & control field compression (LCP ACCOMP).
In most cases, LCP ACCOMP should not be disabled nor negotiated, i.e.
the address field FF-03 should not be sent over ATM. Therefore by default
this parameter is enabled (on).
If the accomp parameter is set to 'negotiate', the local side of the PPPoA
connection demands to do ACCOMP and adapts itself to the result of this
negotiation.
OPTIONAL
trace Enable (on) or disable (off) verbose console logging.
By default tracing is disabled (off).
OPTIONAL
auth Select the authentication protocol. Choose between:
pap: Password Authentication Protocol (PAP) authentication will be
forced.
chap: Challenge Handshake Authentication Protocol (CHAP)
authentication will be forced.
auto: CHAP authentication will be used. If CHAP authentication is
not successful, PAP authentication will be used instead.
Auto is the default setting.
OPTIONAL
restart Automatically restart the connection when Link Control Protocol (LCP)
link goes down (on) or do not restart automatically (off).
By default restart is disabled (off).
OPTIONAL
retryinterval A number between 0 and 65535 (seconds).
Represents the intermediate interval between two retries to establish the
connection on PPP level (LCP) (default=10).
OPTIONAL
passive Put the link in listening state in case LCP times out (on) or not (off).
This parameter allows to determine whether the link should be left open
to wait for incoming messages from the remote side after 10 unsuccessful
tries to establish the connection or not.
By default, the listening state is disabled.
OPTIONAL
silent Do not send anything at startup and just listen for incoming LCP messages
(on) or retry up to 10 times to establish the connection (off).
By default, the silent state is disabled.
OPTIONAL
echo Send LCP echo requests at regular intervals (on) or not (off).
By default, the sending of LCP echo requests is enabled.
OPTIONAL
mru A number between 293 and 8192.
Represents the maximum packet size the SpeedTouch should negotiate
to be able to receive (default=1492).
OPTIONAL
296
PPPoA Commands
laddr The local IP address of the peer-to-peer connection.
Specifying a local IP address forces the remote side of the PPPoA link (if it
allows to) to accept this IP address as the SpeedTouch PPPoA session
IP address.
If not specified, the SpeedTouch will accept any IP address.
Typically the local IP address parameter is not specified.
OPTIONAL
raddr The remote IP address of the peer-to-peer connection.
Specifying a remote IP address forces the remote side of the PPPoA link (if
it allows to) to accept this IP address as its PPPoA session IP address.
Typically the remote IP address parameter is not specified.
OPTIONAL
netmask The subnetmask associated with this address.
Specifying a subnetmask forces the remote side (if it allows to) to accept
this subnetmask as the PPPoA session subnetmask.
If not specified, the SpeedTouch will accept any subnetmask.
The SpeedTouch will only request/accept a subnetmask if a DHCP
server pool is associated, i.e. if the [pool] parameter is specified.
OPTIONAL
format The negotiated subnetmask specified in the netmask parameter is speci-
fied in the dotted format (dotted) or in Classles Inter Domain
Routing (CIDR) format (cidr).
By default, the format is CIDR.
OPTIONAL
pool The name of the free DHCP server pool to which the acquired IP subnet
must be assigned to.
OPTIONAL
savepwd Save password (on), if supplied, or do not save the password (off).
By default, the saving of the password is disabled.
OPTIONAL
demanddial Enable (on) or disable (off) the dial-on-demand feature. OPTIONAL
primdns The IP address of the primary DNS server.
In case a primary DNS server is specified the SpeedTouch will negotiate
this IP address with the remote side.
OPTIONAL
secdns The IP address of the (optional) secondary DNS server.
In case a secondary DNS server is specified the SpeedTouch will nego-
tiate this IP address with the remote side.
OPTIONAL
Represents the DNS route metric to be used for the negotiated DNS
servers (default=1).
OPTIONAL
idle A number between 0 and 1000000 (seconds).
Represents after how many seconds an idle link goes down (default is 0).
OPTIONAL
297
PPPoA Commands
EXAMPLE:
RELATED COMMANDS:
idletrigger Consider the link being idle if no traffic is sent and/or received during the
idle time. Choose between:
RxTx The idle time period restarts when a packet is transmitted or
received (default value).
Rx: The idle time period restarts when a packet is received.
Transmitted packets are ignored.
Tx The idle time period restarts when a packet is transmitted.
Received packets are ignored.
OPTIONAL
addrtrans Automatically enable address translation for the IP address of this link
(pat) or do not use address translation (none) (default is none).
OPTIONAL
unnumbered Takes the local IP address from 'laddr' field and remote IP address from
the IP address pool assigned to the incoming PPPoE link.
In case the unnumbered parameter is disabled, the same IP address is
used for each connection on the server side, thus reducing the number of
used IP addresses.
OPTIONAL
=>pppoa iflist
Retry: 10 QoS default encaps LLC
mode = IP Routing
flags = echo magic accomp restart mru addr route savepwd pppoaOA
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
user name = My_Connection@MY_ISP password = ********
=>pppoa ifconfig intf=pppoa1 prot=pppoa encaps=vcmux
=>pppoa iflist
mode = IP Routing
flags = echo magic accomp restart mru addr route savepwd pppoaOA
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>
298
PPPoA Commands
pppoa ifdelete
Delete a PPPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoa ifdelete intf = <intfname>
intf The name of the PPPoA interface to delete. REQUIRED
=>pppoa iflist
mode = IP routing
mode = IP routing
=>pppoa ifdelete intf=pppoa2
=>pppoa iflist
mode = IP routing
=>
299
PPPoA Commands
pppoa ifdetach
Detach a PPPoA interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoa ifdetach intf = <intfname>
intf The name of the PPPoA interface. REQUIRED
=>pppoa iflist
mode = IP routing
=>pppoa ifdetach =intf=pppoa1
=>pppoa iflist
mode = IP routing
=>
300
PPPoA Commands
pppoa iflist
Show current configuration of all or a specified PPPoA interface(s).
SYNTAX:
RELATED COMMANDS:
pppoa iflist [intf = <intfname>]
intf The name of the PPPoA interface.
If this parameter is not specified, all PPPoA interfaces are shown.
OPTIONAL
=>pppoa iflist
mode = IP routing
mode = IP routing
=>
301
PPPoA Commands
pppoa rtadd
Automatically add a route configuration to the routing table in case the specified PPPoA interface link comes up.
This route configuration will determine which local hosts are allowed to use this link and/or which remote destinations
should be or should not be reachable.
Note Execute the PPPoA ifdetach command for this interface prior to configuring routes.
SYNTAX:
PPPoA rtadd intf = <intfname>
dst = <ip-address>
[label = <labelname>]
[src = <ip-address>]
[srcmsk = <ip-mask(dotted or cidr)>]
intf The name of the PPPoA interface. REQUIRED
dst The destination IP address for the route to be added when the link comes
up.
REQUIRED
dstmsk The destination IP mask.
Depending on the destination netmask:
Any remote destination is reachable, i.e. the PPPoA connection acts
as default route (dstmsk=0)
Only the remote (sub)net is reachable (dstmsk=1)
The actual destination mask will be the default netmask applicable
for destination IP address
Only the single remote host is reachable (dstmsk=32)
Any valid (contiguous) netmask in case of Variable Length Subnet
Masking (VLSM).
OPTIONAL
src The source IP address specification for the route to be added when the
link comes up.
OPTIONAL
302
PPPoA Commands
EXAMPLE:
RELATED COMMANDS:
srcmsk The source IP mask.
Depending on the source netmask:
Everybody is allowed to use this PPPoA connection (dstmsk=0)
Only members of the same subnet as the host which opened the
PPPoA connection are allowed to use the PPPoA connection
(dstmsk=1)
The actual destination mask will be the netmask applicable for the IP
address of the host which opened the PPPoA connection.
Only the host which opened the PPPoA connection is allowed to
use the PPPoA connection. (dstmsk=32)
Any valid (contiguous) netmask in case of VLSM.
OPTIONAL
metric The route metric, i.e. the cost factor of the route.
Practically, the cost is determined by the hop count.
OPTIONAL
=>pppoa iflist
pppoa1: dest : pppoa [00:00:00]
mode = IP routing
=>pppoa rtadd intf=pppoa1 dst=172.16.0.5 dstmsk=24 src=10.0.0.2 srcmask=24
=>pppoa iflist
pppoa1: dest : pppoa [00:00:00]
mode = IP routing
route = 10.0.0.2/24 - 172.16.0.5/24 (metric 1)
=>
pppoa rtdelete Delete the route specification for an upcoming PPPoA link.
303
PPPoA Commands
pppoa rtdelete
Delete the route specification for a PPPoA link.
Note Execute the PPPoA ifdetach command for this interface prior to deleting route configurations.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoa rtdelete intf = <intfname>
intf The PPPoA interface name for which to delete the route settings. REQUIRED
=>pppoa iflist
mode = IP routing
route = 10.0.0.2/24 - 172.16.0.5/24 (metric 1)
=>pppoa rtdelete intf=pppoa1
=>pppoa iflist
mode = IP routing
=>
pppoa rtadd Configure a route specification for an upcoming PPPoA link.
304
PPPoA Commands
305
PPPoE Commands
PPPoE Commands
Contents
Topic Page
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
306
PPPoE Commands
pppoe flush
Flush the current PPPoE configuration.
SYNTAX:
EXAMPLE:
pppoe flush
=>pppoe iflist
PPPoE1: dest : PPPoE1
mode = IP Routing
flags = echo magic accomp mru addr route savepwd PPPoEOA
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>pppoe flush
=>pppoe iflist
=>
307
PPPoE Commands
pppoe ifadd
Create a new PPPoE interface.
SYNTAX:
EXAMPLE:
pppoe ifadd [intf = <string>]
[dest = <RELAY|phonebook entry>]
intf The name for the new PPPoE interface.
If not specified, the destination parameter must be specified. In this case
the name of the destination will double as interface name.
OPTIONAL
dest The ethernet port to be used for this PPPoE interface
(e.g. an ETHoA name).
OPTIONAL
=>pppoe iflist
PPPoE1: dest : pppoe1 [00:00:00]
Retry : 10
mode = IP routing
acname : --- service : ---
=>pppoe ifadd intf=PPPoE2 dest=pppoe2
=>pppoe iflist
Retry : 10
mode = IP routing
Retry : 10
mode = IP routing
=>
308
PPPoE Commands
RELATED COMMANDS:
pppoe ifattach Attach a PPPoE interface.
pppoe ifconfig Configure a PPPoE interface.
pppoe ifdelete Delete a PPPoE interface.
pppoe ifdetach Detach a PPPoE interface.
pppoe iflist Show current PPPoE configuration.
309
PPPoE Commands
pppoe ifattach
Attach (i.e. connect) a PPPoE interface.
SYNTAX:
EXAMPLE:
pppoe ifattach intf = <intfname>
intf The name of the PPPoE interface to attach. REQUIRED
=>pppoe iflist
mode = IP Routing
flags = echo magic accomp restart mru addr route savepwd PPPoEOA
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>pppoe ifattach =intf=PPPoE1
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
admin state = up oper state = down link state = connected
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>
310
PPPoE Commands
RELATED COMMANDS:
pppoe ifadd Create a new PPPoE interface.
311
PPPoE Commands
pppoe ifconfig
Configure a PPPoE interface.
Note The interface to be configured may not be connected at the time of configuration. Execute pppoe ifdetach
prior to executing the pppoe ifconfig command.
SYNTAX:
pppoe ifconfig intf = <>
[dest = <{RELAY|eth0}>]
[user = <string>]
[password = <password>]
[acname = <quoted string>]
[servicename = <quoted string>]
[pcomp = <{off|on}>]
[accomp = <{on|off|negotiate}>]
[concentrator = <{off|on}>]
[auth = <{pap|chap|auto}>]
[restart = <{off|on}>]
[retryinterval = <number{0-65535}>]
[passive = <{off|on}>]
[silent = <{off|on}>]
[echo = <{off|on}>]
[mru = <number{293-8192}>]
[laddr = <ip-address>]
[raddr = <ip-address>]
[format = <{cidr|dotted|none}>]
[pool = <{none}>]
[savepwd = <{off|on}>]
[demanddial = <{off|on}>]
[primdns = <ip-address>]
[secdns = <ip-address>]
[idle = <number{0-1000000}>]
[idletrigger = <{RxTx|Rx|Tx}>]
[unnumbered = <{off|on}>]
intf The name of the PPPoE interface to configure. REQUIRED
dest The ethernet port to be used for this PPPoE interface
(e.g. an ETHoA name).
OPTIONAL
user The user name for remote PAP/CHAP authentication. OPTIONAL
password The password for remote PAP/CHAP authentication. OPTIONAL
312
PPPoE Commands
acname The Access Concentrator name for a PPPoE connection.
Execute the pppoe ifscan command to see the names of available access
concentrators, if any.
OPTIONAL
servicename The Service Name for a PPPoE connection.
Execute the pppoe ifscan command to see the available service names, if
any.
OPTIONAL
pcomp Try (on) or do not try (off) to negotiate PPPoE protocol compression
(LCP PCOMP). By default the negotiation is disabled (off).
OPTIONAL
accomp Try (on), do never try (off) or negotiate (negotiate) to negotiate PPPoE
address & control field compression (LCP ACCOMP).
In most cases, LCP ACCOMP should not be disabled nor negotiated, i.e.
the address field FF-03 should not be sent over ATM. Therefore by default
this parameter is enabled (on).
If the accomp parameter is set to 'negotiate', the local side of the PPPoE
connection demands to do ACCOMP and adapts itself to the result of this
negotiation.
OPTIONAL
trace Enable (on) or disable (off) verbose console logging.
By default tracing is disabled (off).
OPTIONAL
concentrator The access concentrator is on this side of the PPPoE connection.
Choose between:
on: the PPPoE connection is terminated on the Access
Concentrator (here the SpeedTouch itself)
off: the SpeedTouch is PPPoE client (default)
OPTIONAL
auth Select the authentication protocol.
Choose between:
pap: Password Authentication Protocol (PAP) authentication will be
forced.
chap: Challenge Handshake Authentication Protocol (CHAP)
authentication will be forced.
auto: CHAP authentication will be used. If CHAP authentication is
not successful, PAP authentication will be used instead.
Auto is the default setting.
OPTIONAL
restart Automatically restart the connection when Link Control Protocol (LCP)
link goes down (on) or do not restart automatically (off).
By default restart is disabled (off).
OPTIONAL
retryinterval A number between 0 and 65535 (seconds).
Represents the intermediate interval between two retries to establish the
connection on PPP level (LCP) (default=10).
OPTIONAL
passive Put the link in listening state in case LCP times out (on) or not (off).
This parameter allows to determine whether the link should be left open
to wait for incoming messages from the remote side after 10 unsuccessful
tries to establish the connection or not.
By default, the listening state is disabled.
OPTIONAL
313
PPPoE Commands
silent Do not send anything at startup and just listen for incoming LCP messages
(on) or retry up to 10 times to establish the connection (off).
By default, the silent state is disabled.
OPTIONAL
echo Send LCP echo requests at regular intervals (on) or not (off).
By default the sending of LCP echo requests is enabled.
OPTIONAL
mru A number between 293 and 8192.
Represents the maximum packet size the SpeedTouch should negotiate
to be able to receive (default=1492).
OPTIONAL
laddr The local IP address of the peer-to-peer connection.
Specifying a local IP address forces the remote side of the PPPoE link (if it
allows to) to accept this IP address as the SpeedTouch PPPoE session IP
address.
Typically the local IP address parameter is not specified.
OPTIONAL
raddr The remote IP address of the peer-to-peer connection.
Specifying a remote IP address forces the remote side of the PPPoE link (if
it allows to) to accept this IP address as its PPPoE session IP address.
Typically the remote IP address parameter is not specified.
OPTIONAL
netmask The subnetmask associated with this address.
Specifying a subnetmask forces the remote side (if it allows to) to accept
this subnetmask as the PPPoE session subnetmask.
If not specified, the SpeedTouch will accept any subnetmask.
The SpeedTouch will only request/accept a subnetmask if a DHCP
server pool is associated, i.e. if the [pool] parameter is specified.
OPTIONAL
format The negotiated subnetmask specified in the netmask parameter is speci-
fied in the dotted format (dotted) or in Classles Inter Domain
Routing (CIDR) format (cidr).
By default, the format is CIDR.
OPTIONAL
pool The name of the free DHCP server pool to which the acquired IP subnet
must be assigned to.
OPTIONAL
savepwd Save password (on), if supplied, or do not save the password (off).
By default, the saving of the password is disabled.
OPTIONAL
demanddial Enable (on) or disable (off) the dial-on-demand feature. OPTIONAL
primdns The IP address of the primary DNS server.
In case a primary DNS server is specified the SpeedTouch will negotiate
this IP address with the remote side.
OPTIONAL
secdns The IP address of the (optional) secondary DNS server.
In case a secondary DNS server is specified the SpeedTouch will nego-
tiate this IP address with the remote side.
OPTIONAL
Represents the DNS route metric to be used for the negotiated DNS
servers (default=1).
OPTIONAL
314
PPPoE Commands
EXAMPLE:
idle A number between 0 and 1000000 (seconds).
Represents after how many seconds an idle link goes down (default is 0).
OPTIONAL
idletrigger Consider the link being idle if no traffic is sent and/or received during the
idle time. Choose between:
RxTx
The idle time period restarts when a packet is transmitted or
received (default value).
Rx:
The idle time period restarts when a packet is received.
Transmitted packets are ignored.
Tx
The idle time period restarts when a packet is transmitted.
Received packets are ignored.
OPTIONAL
addrtrans Automatically enable address translation for the IP address of this link
(pat) or do not use address translation (none) (default is none).
OPTIONAL
unnumbered Takes the local IP address from 'laddr' field and remote IP address from
the IP address pool assigned to the incoming PPPoE link.
In case the unnumbered parameter is disabled, the same IP address is
used for each connection on the server side, thus reducing the number of
used IP addresses.
OPTIONAL
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 1)
=>pppoe ifconfig intf=PPPoE1 prot=pppoeoa encaps=vcmux
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 1)
=>
315
PPPoE Commands
RELATED COMMANDS:
316
PPPoE Commands
pppoe ifdelete
Delete a PPPoE interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoe ifdelete intf = <intfname>
intf The name of the PPPoE interface to delete.
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
PPPoE2: dest : PVC2
mode = IP Routing
flags = echo magic accomp restart mru addr savepwd PPPoEOA
mru = 1500
user name = password =
=>pppoe ifdelete intf=PPPoE2
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>
317
PPPoE Commands
pppoe ifdetach
Detach a PPPoE interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoe ifdetach intf = <intfname>
intf The name of the PPPoE interface. REQUIRED
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>pppoe ifdetach =intf=PPPoE1
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>
318
PPPoE Commands
pppoe iflist
Show current configuration of all or a specified PPPoE interface(s).
SYNTAX:
RELATED COMMANDS:
pppoe iflist [intf = <intfname>]
intf The name of the PPPoE interface.
If this parameter is not specified, all PPPoE interfaces are shown.
OPTIONAL
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
PPPoE2: dest : PVC2
mode = IP Routing
flags = echo magic accomp restart mru addr savepwd PPPoEOA
mru = 1500
user name = password =
=>
319
PPPoE Commands
pppoe ifscan
Scan a PPPoE interface (proto=pppoe) for available Access Concentrator names and Service Names.
Note Execute the pppoe ifdetach command for this interface before performing a scan on it.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoe ifscan intf = <intfname>
[time = <number{0-36000}>]
intf The name of the Routed PPPoE interface to scan. REQUIRED
time A number between 0 and 36000 (seconds).
Represents the time to scan for services.
OPTIONAL
=>pppoe iflist
mode = IP Routing
route = 0.0.0.0/0 - 0.0.0.0/0 (metric 0)
=>pppoe ifscan intf=PPPoE1 time=45
Service Name Access Concentrator
Done !
=>
320
PPPoE Commands
pppoe relay add
Add an ethernet port to the PPPoE relay list.
SYNTAX:
RELATED COMMANDS:
pppoe relay add port = <port name>
port The ethernet port to be added to the PPPoE relay agent list. REQUIRED
pppoe relay delete Delete an ethernet port from the PPPoE relay agent list.
pppoe relay flush Remove all ethernet ports from the PPPoE relay agent list and terminate all
sessions.
pppoe relay portlist List all ethernet ports added to the PPPoE relay agent list.
pppoe relay sesslist List all active PPPoE relay sessions.
321
PPPoE Commands
pppoe relay delete
Delete an ethernet port from the PPPoE relay agent list.
SYNTAX:
RELATED COMMANDS:
pppoe relay delete port = <port name>
port The ethernet port to be deleted from the PPPoE relay agent list. REQUIRED
pppoe relay add Add an ethernet port to the PPPoE relay list.
sessions.
322
PPPoE Commands
pppoe relay flush
Remove all ethernet ports from the PPPoE relay agent list and terminate all sessions.
SYNTAX:
RELATED COMMANDS:
pppoe relay flush
323
PPPoE Commands
pppoe relay portlist
List all ethernet ports added to the PPPoE relay agent list.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoe relay portlist
=>pppoe relay portlist
# Port HWaddr Status
1 ETHoA_1 00-90-d0-72-88-64 UP
=>
sessions.
324
PPPoE Commands
pppoe relay sesslist
List all active PPPoE relay sessions.
SYNTAX:
RELATED COMMANDS:
pppoe relay sesslist
sessions.
325
PPPoE Commands
pppoe rtadd
Automatically add a route configuration to the routing table in case the specified PPPoE interface link comes up.
This route configuration will determine which local hosts are allowed to use this link and/or which remote destinations
should be or should not be reachable.
Note Execute the pppoe ifdetach command for this interface prior to configuring routes.
SYNTAX:
pppoe rtadd intf = <intfname>
dst = <ip-address>
[label = <{}>]
[src = <ip-address>]
[srcmsk = <ip-mask(dotted or cidr)>]
intf The name of the PPPoE interface. REQUIRED
dst The destination IP address for the route to be added when the link comes
up.
REQUIRED
dstmsk The destination IP mask.
Depending on the destination netmask:
Any remote destination is reachable, i.e. the PPPoE connection acts
as default route (dstmsk=0)
Only the remote (sub)net is reachable (dstmsk=1)
The actual destination mask will be the default netmask applicable
for destination IP address
Only the single remote host is reachable (dstmsk=32)
Any valid (contiguous) netmask in case of Variable Length Subnet
Masking (VLSM).
OPTIONAL
label The name of the label OPTIONAL
src The source IP address specification for the route to be added when the
link comes up.
OPTIONAL
326
PPPoE Commands
EXAMPLE:
RELATED COMMANDS:
srcmsk The source IP mask.
Depending on the source netmask:
Everybody is allowed to use this PPPoE connection (dstmsk=0)
Only members of the same subnet as the host which opened the
PPPoE connection are allowed to use the PPPoE connection
(dstmsk=1)
The actual destination mask will be the netmask applicable for the IP
address of the host which opened the PPPoE connection.
Only the host which opened the PPPoE connection is allowed to use
the PPPoE connection. (dstmsk=32)
Any valid (contiguous) netmask in case of VLSM.
OPTIONAL
metric The route metric, i.e. the cost factor of the route.
Practically, the cost is determined by the hop count.
OPTIONAL
=>pppoe iflist
PPPoE1: dest : PVC3
mode = IP Routing
flags = echo magic accomp restart mru addr route savepwd PPPoE
=>pppoe rtadd intf=PPPoE1 dst=172.16.0.5 dstmsk=24 src=10.0.0.2 srcmask=24
=>pppoe iflist
PPPoE1: dest : PVC3
mode = IP Routing
route = 10.0.0.2/24 - 172.16.0.5/24 (metric 1)
=>
pppoe rtdelete Delete the route specification for an upcoming PPPoE link.
327
PPPoE Commands
pppoe rtdelete
Delete the route specification for a PPPoE link.
Note Execute the pppoe ifdetach command for this interface prior to deleting route configurations.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pppoe rtdelete intf = <intfname>
intf The PPPoE interface name for which to delete the route settings. REQUIRED
=>pppoe iflist
PPPoE1: dest : PVC3
mode = IP Routing
route = 10.0.0.2/24 - 172.16.0.5/24 (metric 1)
=>pppoe rtdelete intf=PPPoE1
=>pppoe iflist
PPPoE1: dest : PVC3
mode = IP Routing
=>
pppoe rtadd Configure a route specification for an upcoming PPPoE link.
328
PPPoE Commands
329
PPTP Commands
PPTP Commands
Contents
Topic Page
pptp ifadd 330
pptp flush 331
pptp list 332
pptp profadd 333
pptp profdelete 334
pptp proflist 335
330
PPTP Commands
pptp ifadd
Adds a Point-to-Point Tunneling Protocol (PPTP) profile (backwards compatible with previous release, use profiles
instead).
SYNTAX:
pptp ifadd dest = <string>
[rate = <number{10-10000}>]
[encaps = <{vcmux|nlpid}>]
[ac = <{never|always|keep}>]
dest The WAN destination for this PPTP tunnel. Typically a phonebook entry. REQUIRED
rate A number between 10 and 10000.
Represents the transmit speed in bits/s for the WAN link.
OPTIONAL
encaps The type of WAN encapsulation.
Choose between:
vcmux
nlpid - Network Layer Protocol IDentifiers (NLPID)
OPTIONAL
ac The High-level Data Link Control (HDLC) framing option applicable to
PPTP interfaces using this PPTP profile.
Before relaying the encapsulated PPP frames over the PPPoA link, make
sure that the address and control field (0xFF03) is always in front of the
frames (always), make sure the address and control field will never be
found in front of the frames (never) or do not change the frames arriving
via the PPTP tunnel (keep).
By default the address and control field is never sent (compliant to
RFC2364). It is recommended to keep this setting.
OPTIONAL
331
PPTP Commands
pptp flush
Flush complete PPTP configuration.
SYNTAX:
EXAMPLE:
pptp flush
=>pptp profadd name=Relay_PPP1 encaps=nlpid ac=always
=>pptp proflist
Profile QoS Encaps AC
Relay_PPP1 default nlpid always
=>pptp flush
=>pptp proflist
=>
332
PPTP Commands
pptp list
Show current PPTP configuration.
SYNTAX:
pptp list
=>pptp list
Dialstr Destination QoS Encaps AC State User
DIALUP_PPP3 default vcmux never CONNECTED (10.0.0.2)
=>
333
PPTP Commands
pptp profadd
Define a new PPTP profile.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pptp profadd name = <string>
[qos = <string>]
[encaps = <{vcmux|nlpid}>]
[ac = <{never|always|keep}>]
name The name for the PPTP profile. REQUIRED
qos The name of the qosbook entry, containing the settings for this profile.
This parameter never needs to be specified.
OPTIONAL
encaps The type of WAN encapsulation applicable to PPTP interfaces using this
PPTP profile.
Choose between:
vcmux
nlpid - Network Layer Protocol IDentifiers (NLPID)
OPTIONAL
ac The High-level Data Link Control (HDLC) framing option applicable to
PPTP interfaces using this PPTP profile.
Before relaying the encapsulated PPP frames over the PPPoA link, make
sure that the address and control field (0xFF03) is always in front of the
frames (always), make sure the address and control field will never be
found in front of the frames (never) or do not change the frames arriving
via the PPTP tunnel (keep).
By default the address and control field is never sent (compliant to
RFC2364). It is recommended to keep this setting.
OPTIONAL
=>pptp proflist
=>pptp profadd name=PPTPLink encaps=vcmux ac=never
=>pptp proflist
PPTPLink default vcmux never
=>
pptp profdelete Delete a PPTP profile.
pptp proflist Show current PPTP profiles.
334
PPTP Commands
pptp profdelete
Delete a PPTP profile.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pptp profdelete name <string>
name The name for the PPTP profile. REQUIRED
=>pptp proflist
=>pptp profdelete name=PPTPLink
=>pptp proflist
=>
pptp profadd Define a new PPTP profile.
pptp proflist Show current PPTP profiles.
335
PPTP Commands
pptp proflist
Show all current PPTP profiles.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
pptp proflist
=>pptp proflist
=>
pptp profadd Define a new PPTP profile.
pptp profdelete Delete a PPTP profile.
336
PPTP Commands
337
QoSBook Commands
QoSBook Commands
Contents
Topic Page
qosbook add 338
qosbook config 340
qosbook delete 341
qosbook flush 342
qosbook list 343
338
QoSBook Commands
qosbook add
Add a Quality of Service (QoS) book entry.
SYNTAX:
qosbook add name = <string>
class = <{ubr|cbr|vbr-rt|vbr-nrt}>
[tx_peakrate = <number{0-27786}>]
[tx_sustrate = <number{0-27786}>]
[tx_maxburst = <number{0-12240}>]
[rx_peakrate = <number{0-27786}>]
[rx_sustrate = <number{0-27786}>]
[rx_maxburst = <number{0-12240}>]
[framediscard = <{enabled|disabled}>]
name The name for the new QoS entry. REQUIRED
class The ATM service category. Choose between:
ubr: unspecified bit rate
cbr: constant bit rate
vbr-rt: variable bit rate - real time
vbr-nrt: variable bit rate - non real time
REQUIRED
tx_peakrate A number between 0 and 27786 (Kilobits per second).
Indicates the peak rate (in kilobits per second) in the transmit
(upstream) direction. Use '0' to indicate linerate for UBR.
OPTIONAL
tx_sustrate A number between 0 and 27786 (Kilobits per second).
Indicates the sustainable rate (in kilobits per second) in the transmit
(upstream) direction. (VBR only)
OPTIONAL
tx_maxburst A number between 0 and 12240 (bytes per second).
Indicates the maximum burst size (in bytes) in the transmit
(upstream) direction. (VBR only)
OPTIONAL
rx_peakrate A number between 0 and 27786 (Kilobits per second).
Indicates the peak rate (in kilobits per second) in the receive (down-
stream) direction. Use '0' to indicate linerate for UBR. If not speci-
fied, copy of the transmit peak rate. (ATMF only)
OPTIONAL
rx_sustrate A number between 0 and 27786 (Kilobits per second).
Indicates the sustainable rate (in kilobits per second) in the receive
(downstream) direction. If not specified, copy of the transmit
sustainable rate. (VBR ATMF only)
OPTIONAL
rx_maxburst A number between 0 and 12240 (bytes per second).
Indicates the maximum burst size (in bytes) in the receive (down-
stream) direction. If not specified, copy of the transmit maximum
burst size. (VBR ATMF only)
OPTIONAL
framediscard Enable/disable frame discard. OPTIONAL
339
QoSBook Commands
EXAMPLE:
IMPORTANT NOTE:
The SpeedTouch always rounds up specified burst sizes to a multiple of 48 bytes, i.e. a multiple of ATM cells.
Example
In the example above a burst size of 100 bytes is specified (tx_maxburst=100). The SpeedTouch will round up the
burst size to the closest matching multiple of 48 bytes, as can be seen when displaying the profile via :qosbook list
(burst=144).
RELATED COMMANDS:
=>qosbook list
Name Ref Type TX peak sust burst RX peak sust burst framediscard
(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes)
default 3 ubr linerate 0 0 linerate 0 0 disabled
=>qosbook add name=TestVBR class=vbr-nrt tx_peakrate=1500 tx_sustrate=1000 tx_maxburst=100
rx_sustrate=1000 rx_maxburst=100 framediscard=enabled
=>qosbook list
TestVBR 0 vbr-nrt 1500 1000 144 1500 1000 144 enabled
=>
qosbook delete Remove a QoS book entry.
qosbook list Show current QoS book.
340
QoSBook Commands
qosbook config
Sets or changes qosbook config parameters.
SYNTAX:
EXAMPLE:
qosbook config [format = <{bytes|cells}>]
format The input, output format of the qosbook.
Choose between:
bytes (default)
cells
OPTIONAL
=>qosbook list
=>qosbook config
qosbook format in bytes
=>qosbook config format=cells
=>qosbook config
qosbook format in cells
=>qosbook list
(cps) (cps) (cells) (cps) (cps) (cells)
=>
341
QoSBook Commands
qosbook delete
Remove a Quality of Service book entry.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
qosbook delete name = <string>
[force = <{no|yes}>]
name The name of the QoS book entry to delete. REQUIRED
force Force deletion of the entry even if it is still in use (yes) or do not
force the deletion (no).
By default forced deletion is disabled.
OPTIONAL
=>qosbook list
=>qosbook delete name=TestVBR
=>qosbook list
=>
qosbook add Add a QoS book entry.
qosbook list Show current QoS book.
342
QoSBook Commands
qosbook flush
Flush complete Quality of Service book.
SYNTAX:
qosbook flush
343
QoSBook Commands
qosbook list
Show current Quality of Service book.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
qosbook list
=>qosbook list
=>
qosbook add Add a QoS book entry.
qosbook delete Remove a QoS book entry.
344
QoSBook Commands
345
Script Commands
Script Commands
WARNING
Scripting is not a general purpose mechanism but is only used in the autoPVC/ILMI mechanism.
Do not use any commands of the Script CLI command group.
346
Script Commands
347
SNMP Commands
SNMP Commands
Contents
Topic Page
snmp config 348
snmp get 349
snmp getNext 350
snmp list 351
snmp walk 352
348
SNMP Commands
snmp config
Show/set global Simple Network Management Protocol (SNMP) parameters.
SYNTAX:
snmp config [RWCommunity = <string>]
[ROCommunity = <string>]
[sysContact = <quoted string>]
[sysName = <quoted string>]
[sysLocation = <quoted string>]
RWCommunity The read-write community name.
By default the read-write community name is private.
OPTIONAL
ROCommunity The read-only community name.
By default the read-only community name is public.
OPTIONAL
sysContact The SNMP system contact.
By default the system contact is Service Provider.
OPTIONAL
sysName The SNMP system name.
By default the system name is SpeedTouch 610.
OPTIONAL
sysLocation The SNMP system location.
By default the system location is Customer Premises.
OPTIONAL
=>snmp config
Read-write SNMP community name : private
Read-only SNMP community name : public
SNMP System Contact : Service Provider
SNMP System Name : SpeedTouch 610
SNMP System Location : Customer Premises
=>
349
SNMP Commands
snmp get
Get from the supplied SNMP Object IDentifier (OID), e.g. get ObjectId=.1.3.6.1.2.1.1.1.0.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
snmp get [ObjectId = <string>]
ObjectID The Object Identifier. Object id to get from ... must include the
instance which is 0 for scalar objects e.g. .1.3.6.1.2.1.1.1.0 sysDe-
scription
If not specified, the sysdescription OID .1.3.6.1.2.1.1.1.0 is assumed.
Its value is SpeedTouch.
OPTIONAL
=>snmp get
VB_octetStr .1.3.6.1.2.1.1.1.0 SpeedTouch 610
=>
snmp getNext GetNext from the supplied SNMP OID.
snmp walk Walk from the supplied SNMP OID.
350
SNMP Commands
snmp getNext
GetNext from the supplied SNMP OID.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
[ObjectID] The Object Identifier.
Object id to getNext from e.g. .1.3.6.1.2.1.1 system returns
sysDescription
OPTIONAL
=>snmp getNext ObjectId=.1.3.6.1.2.1.1.4.0
VB_octetStr .1.3.6.1.2.1.1.5.0 Sascha
=>
snmp get Get from the supplied SNMP OID.
snmp walk Walk from the supplied SNMP OID.
351
SNMP Commands
snmp list
List all SNMP global parameters.
SYNTAX:
EXAMPLE:
snmp list
=>snmp list
Read-write SNMP community name : private
Read-only SNMP community name : public
SNMP System Contact : Service Provider
SNMP System Name : Sascha
SNMP System Location : Customer Premises
=>
352
SNMP Commands
snmp walk
Walk from the supplied SNMP Object IDentifier (OID).
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
ObjectID The Object Identifier.
Object id to walk from e.g. .1.3.6.1.2.1.1 system walks the system
group
OPTIONAL
=>snmp walk ObjectId=.1.3.6.1.2.1.1
VB_octetStr .1.3.6.1.2.1.1.1.0 SpeedTouch 610
VB_objId .1.3.6.1.2.1.1.2.0 .1.3.6.1.4.1.637.61.2
VB_timeTicks .1.3.6.1.2.1.1.3.0 2927636
VB_octetStr .1.3.6.1.2.1.1.4.0 Service Provider
VB_octetStr .1.3.6.1.2.1.1.5.0 Sascha
VB_octetStr .1.3.6.1.2.1.1.6.0 Customer Premises
VB_integer .1.3.6.1.2.1.1.7.0 72
=>
snmp get Get from the supplied SNMP OID.
snmp getNext GetNext from the supplied SNMP OID.
353
Software Commands
Software Commands
Contents
Topic Page
software version 354
software upgrade 355
354
Software Commands
software version
Show the software version.
SYNTAX:
EXAMPLE:
software version
=>software version
Flash image : 4.2.1.15.0
Build name : LLT5AA4.20E
=>
355
Software Commands
software upgrade
Reboots the modem to initiate the SW upgrade. New software available on a remote LAN host will be uploaded to the
modem.
SYNTAX:
software upgrade
356
Software Commands
357
Switch Commands
Switch Commands
Introduction
These commands are only applicable to the SpeedTouch510 four port switch version.
Contents
Topic Page
switch group flush 358
switch group list 359
switch group move 360
switch mirror capture 361
switch mirror egress 362
switch mirror ingress 363
358
Switch Commands
switch group flush
To set all ports to the default settings, i.e. all ports in group 0.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
switch group flush
=>switch group list
Group 0 Ports: 4
Group 1 Ports: 1
Group 2 Ports: 2 3
=>switch group flush
=>switch group list
Group 0 Ports: 1 2 3 4
=>
switch group list List all configured groups.
switch group move Move a specified port to a specified group.
359
Switch Commands
switch group list
List all configured groups.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
switch group list
=>switch group list
Group 0 Ports: 4
Group 1 Ports: 1
Group 2 Ports: 2 3
switch group flush To set all ports to the default settings (all ports in group 0).
switch group move Move a specified port to a specified group.
360
Switch Commands
switch group move
Move a specified port to a specified group.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
switch group move group = <number{0-4}>
port = <number{1-4}>
group The group id. REQUIRED
port The port. REQUIRED
=>switch group list
Group 0 Ports: 1 2 3 4
=>switch group move group=3 port=1
=>switch group list
Group 0 Ports: 2 3 4
Group 3 Ports: 1
switch group flush To set all ports to the default settings (all ports in group 0).
switch group list List all configured groups.
361
Switch Commands
switch mirror capture
Define the specified port to be the Mirror Capture Port.
Note Only one port can be the Mirror Capture Port at any one time.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
switch mirror capture port = <number{1-4}>
port The port to be the Mirror Capture Port. REQUIRED
=>switch mirror capture port=2
=>switch mirror capture
Mirror capture port = 2
switch mirror egress Enable or disable the specified port to be a Transmitted Port Mirroring.
switch mirror ingress Enable or disable the specified port to be a Received Port Mirroring.
362
Switch Commands
switch mirror egress
Enable or disable the specified port to be the Mirror Egress Port.
Note Only one port can be the Mirror Egress Port at any one time.
But a port can be the Mirror Egress Port and the Mirror Ingress Port at the same time.
SYNTAX:
EXAMPLE:
Here port 1 is enabled as Mirror Egress Port
Here port 1 is disabled as Mirror Egress Port
RELATED COMMANDS:
switch mirror egress port = <number{1-4}>
port The port to be the Mirror Egress Port. REQUIRED
state This parameter permits to enable/disable a port as Mirror Egress
Port.
OPTIONAL
=>switch mirror egress port=1
=>switch mirror egress
Egress mirror port = 1
Egress mirror port = 1
=>switch mirror egress port=1 state=disabled
=>
switch mirror capture Define the specified port to be the Mirror Capture Port.
switch mirror ingress Enable or disable the specified port to be a Received Port Mirroring.
363
Switch Commands
switch mirror ingress
Enable or disable the specified port to be the Mirror Ingress Port.
Note Only one port can be the Mirror Ingress Port at any one time.
But a port can be the Mirror Egress Port and the Mirror Ingress Port at the same time.
SYNTAX:
EXAMPLE:
Here port 2 is enabled as Mirror Ingress Port
Here port 2 is disabled as Mirror Ingress Port
RELATED COMMANDS:
switch mirror egress port = <number{1-4}>
port The port to be the Mirror Ingress Port. REQUIRED
state This parameter permits to enable/disable a port as Mirror Ingress
Port.
OPTIONAL
=>switch mirror ingress port=2
=>switch mirror ingress
Ingress mirror port = 2
Ingress mirror port = 2
=>switch mirror ingress port=2 state=disabled
=>
switch mirror capture Define the specified port to be the Mirror Capture Port.
switch mirror egress Enable or disable the specified port to be a Transmitted Port Mirroring.
364
Switch Commands
365
System Commands
System Commands
Contents
Topic Page
system clearpassword 366
system config 367
system flush 368
system reboot 369
system reset 370
system setpassword 371
system stats 372
366
System Commands
system clearpassword
Clear current SpeedTouch system password.
Note To avoid unrestricted and unauthorized access to the SpeedTouch, it is highly recommended to make sure
it is protected by a SpeedTouch system password (via :system setpassword) and to change the password
on a regular basis.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
system clearpassword
=>system clearpassword
Security notification: Password changed, use 'saveall' to make it permanent.
=>
system setpassword Set/change current system password.
367
System Commands
system config
Show/set SpeedTouch system configuration parameters.
Note For a good operation of Universal Plug and Play (UPnP) and the discovery mechanism, it is highly recom-
mended not to change the System config settings.
SYNTAX:
EXAMPLE:
system config [upnp = <{disabled|enabled}>]
[mdap = <{disabled|enabled}>]
[drst = <{disabled|enabled}>]
[digestauth = <{disabled|enabled}>]
[strictusername = <{disabled|enabled}>]
[dcache = <{disabled|enabled}>]
upnp Enable (enabled) or disable (disabled) Universal Plug and Play (UPnP)
discovery.
By default UPnP discovery is enabled.
OPTIONAL
mdap Enable (enabled) or disable (disabled) proprietary discovery
protocol.
By default MDAP discovery is enabled.
OPTIONAL
drst Enable / disable DRST access.
By default DRST access is disabled.
OPTIONAL
digestauth Enable / disable HTTP digest authentication.
By default HTTP digest authentication is disabled.
OPTIONAL
strictusername Enable / disable strict username check.
By default strict username check is disabled.
OPTIONAL
dcache Enable (enabled) or disable (disabled) data cache.
By default data cache is enabled.
For internal use only. Do not alter in any way.
OPTIONAL
=>system config
upnp discovery : enabled
mdap discovery : enabled
drst support : disabled
digest authentication : disabled
strict username : disabled
dcache : enabled
=>
368
System Commands
system flush
Flush current SpeedTouch system configuration, i.e. the System password and the system config settings (dcache
excluded).
on a regular basis.
SYNTAX:
EXAMPLE:
system flush
=>system flush
=>
369
System Commands
system reboot
Reboot the SpeedTouch. Non-saved configuration settings are lost after reboot.
SYNTAX:
EXAMPLE:
system reboot
=>system reboot
.....
(lost session connectivity due to reboot)
.....
370
System Commands
system reset
Reset the SpeedTouch to its factory default settings and reboot the device. All user and Service Provider specific
settings and all saved configuration changes are lost after reboot.
SYNTAX:
EXAMPLE:
system reset factory yes/no = <{yes|no}>
proceed no/yes = <{no|yes}>
factory yes/no Proceed with resetting the SpeedTouch device to its factory
default settings (yes) or not (no).
By default the system reboot command is discarded if no explicit
positive confirmation is given.
REQUIRED
proceed no/yes Confirmation for resetting the modem. REQUIRED
=>system reset
---------------
!! WARNING !!
---------------
The modem will be reset to (factory) defaults clearing all user (and ISP) settings.
Specifying <factory=yes> deletes user and ISP specific settings.
Connectivity with the ISP network might be lost.
<factory=no> deletes user specific settings only.
factory yes/no = no
proceed no/yes = no
:system reset factory yes/no=no proceed no/yes=no
=>
=>system reset
---------------
!! WARNING !!
---------------
The modem will be reset to (factory) defaults clearing all user (and ISP) settings.
Specifying <factory=yes> deletes user and ISP specific settings.
Connectivity with the ISP network might be lost.
<factory=no> deletes user specific settings only.
factory yes/no = yes
proceed no/yes = yes
:system reset factory yes/no=yes proceed no/yes=yes
.....
(lost session connectivity due to reboot)
.....
371
System Commands
system setpassword
Set/change the current SpeedTouch system password.
on a regular basis
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
system setpassword [userid = <string>]
password = <password>
userid The new access userid. OPTIONAL
password The new access password. REQUIRED
=>system setpassword password=Sascha
=>saveall
=>
system clearpassword Clear current system password.
372
System Commands
system stats
Show/set the SpeedTouch cpu and memory statistics.
SYNTAX:
EXAMPLE:
system stats [reset = <{no|yes}>]
reset Reset cpu statistics. OPTIONAL
=>system stats
Cpu statistics:
---------------
Maximum cpu load: 75%
Minimum cpu load: 4%
Average cpu load: 13%
Current cpu load: 10%
Memory statistics:
------------------
CHIP memory total/used/free (in KB): 891/750/141
Application memory total/used/free (in KB): 1519/1388/131
=>
373
Systemlog Commands
Systemlog Commands
Contents
Topic Page
systemlog show 374
systemlog send 375
374
Systemlog Commands
systemlog show
Show syslog messages in the internal SpeedTouch Syslog message buffer.
SYNTAX:
EXAMPLE:
systemlog show [fac = <supported facility name>]
[sev = <supported severity name>]
[hist = <{no|yes}>]
fac Optionally, Specify the facility name of the syslog messages to show.
Use one of the supported facility names (See Supported Syslog
Facilities on page 418 for a listing of syslog facility names supported
by the SpeedTouch).
Do not specify to show messages of any facility.
OPTIONAL
sev Specify the lowest priority severity of the syslog messages to show.
Specifying a severity actually means specifying to show the syslog
messages with a severity as specified, and all messages with a higher
severity.
Use one of the supported severity names (See Supported Syslog
Severities on page 419 for a listing of syslog facility names
OPTIONAL
hist The show messages over several SpeedTouch reboots (yes) or
show only messages since latest startup (no).
Do not specify to only show the recent messages.
OPTIONAL
=>syslog msgbuf show fac=kern sev=emerg hist=yes
<0> SysUpTime: 14:45:43 KERNEL Controlled restart (after internal error or
explicit system reboot)
<0> SysUpTime: 04 days 04:52:37 KERNEL Controlled restart (after internal
error or explicit system reboot)
=>syslog msgbuf show fac=kern sev=warning hist=yes
<4> SysUpTime: 00:00:00 KERNEL Cold restart
<4> SysUpTime: 00:00:00 KERNEL Warm restart
<0> SysUpTime: 04 days 04:52:37 KERNEL Controlled restart (after internal
error or explicit system reboot)
=>
375
Systemlog Commands
systemlog send
Send syslog messages from the internal SpeedTouch Syslog message buffer to a specified local or remote syslog
server host.
SYNTAX:
Note There will be no notification on whether the host has received the messages or not.
systemlog send [fac = <supported facility name>]
[sev = <supported severity name>]
[hist = <{no|yes}>]
dest = <ip-address>
fac Optionally, Specify the facility name of the syslog messages to show.
Use one of the supported facility names (See Supported Syslog
Facilities on page 418 for a listing of syslog facility names supported
by the SpeedTouch).
OPTIONAL
sev Specify the lowest priority severity of the syslog messages to show.
Specifying a severity actually means specifying to show the syslog
messages with a severity as specified, and all messages with a higher
severity.
Use one of the supported severity names (See Supported Syslog
Severities on page 419 for a listing of syslog facility names
OPTIONAL
hist The show messages over several SpeedTouch reboots (yes) or
show only messages since latest startup (no).
OPTIONAL
dest The IP address of the remote host on the local or remote network,
i.e. the collector's IP address, to send the syslog messages to.
REQUIRED
376
Systemlog Commands
377
TD Commands
TD Commands
Contents
Topic Page
td call 378
378
TD Commands
td call
Call a Trace & Debug command.
Note For qualified personnel only.
SYNTAX:
td call cmd = <string>
cmd Quoted 'Trace & Debug' command string. REQUIRED
379
UPnP Commands
UPnP Commands
Contents
Topic Page
upnp config 380
upnp flush 381
upnp list 382
380
UPnP Commands
upnp config
Configure UPnP parameter(s).
SYNTAX:
EXAMPLE:
upnp config [maxage = <number{60-999999}>]
[defcservice = <interface_name>]
[writemode = <{full|natonly|readonly}>]
[safenat = <{disabled|enabled}>]
[preferredaddress = <ip-address>]
maxage This parameter allows to configure how often the SpeedTouch
sends a notification message to advertise its presence as an Internet
Gateway Device IGD) on the network.
Setting this parameter to a low value will increase the number of
packets sent over time on the network, but will make the state of
the device more up to date.
Default is 1800 seconds.
OPTIONAL
defcservice This parameter allows to configure the connection service to be
used by the DrSpeedTouch application during the troubleshooting
process (only when several connection services are configured on
the SpeedTouch, else only the default connection service).
OPTIONAL
writemode Choose the set of rules to limit remote access from UPnP. Choose
between:
full: the host will accept all the UPnP SET and GET actions.
natonly: GET and NAT related SET actions will be accepted, all
other actions will be ignored.
readonly: the UPnP control point will only be able to retrieve
information, all the SET actions are ignored.
OPTIONAL
safenat Enable / disable check on safe NAT entries.
If this check is enabled, all NAT create/delete requests for a LAN
side IP address different from the source IP address of the UPnP
message will be discarded.
OPTIONAL
preferredaddress Preferred ip address for UPnP advertisements (enter 0.0.0.0 for
none)
OPTIONAL
=>upnp config
ssdp max-age : 1800
default connection service : PPPoA_1
write mode : full
safe nat entries : disabled
preferred address :
=>
381
UPnP Commands
upnp flush
Flushes the UPnP configuration (i.e. reset to default configuration).
SYNTAX:
EXAMPLE:
upnp flush
=>upnp config
ssdp max-age : 4200
default connection service : pppoa
write mode : natonly
safe nat entries : enabled
preferred address :
=>upnp flush
=>upnp config
ssdp max-age : 1800
default connection service : pppoa
write mode : full
safe nat entries : disabled
preferred address :
=>
382
UPnP Commands
upnp list
This command lists the devices and services currently offered by the SpeedTouch.
Use this command to check whether a PPP connection is properly configured and thus advertised as a PPP service.
SYNTAX:
EXAMPLE:
upnp list [verbose = <number{0-2}>]
verbose Verbose level. Default is 1. OPTIONAL
=>upnp list
Advertising UPnP devices on address: 10.0.0.138
---------------- device: IGD.xml ------------
++ Root Device: urn:schemas-upnp-org:device:InternetGatewayDevice:1
-- Service 1: urn:upnp-org:serviceId:layer3f
-- Service 2: urn:upnp-org:serviceId:lanhcm
-- Service 3: urn:upnp-org:serviceId:wancic
-- Service 4: urn:upnp-org:serviceId:wandsllc:PVC_1
-- Service 5: urn:upnp-org:serviceId:wanpppc:PPPoA_1
---------------------- end -----------------
---------------- device: DRST.xml ------------
++ Root Device: urn:schemas-upnp-org:device:DRST_Device:1
-- Service 1: urn:upnp-org:serviceId:layer3f_DRST
-- Service 2: urn:upnp-org:serviceId:devinfo_DRST
-- Service 3: urn:upnp-org:serviceId:lanhcm_DRST
-- Service 4: urn:upnp-org:serviceId:lanelc_DRST
-- Service 5: urn:upnp-org:serviceId:wancic_DRST
-- Service 6: urn:upnp-org:serviceId:wandsllc_DRST:PVC_1
-- Service 7: urn:upnp-org:serviceId:wanpppc_DRST:PPPoA_1
---------------------- end -----------------
=>
383
USB Commands
USB Commands
Introduction
These commands are valid only for the SpeedTouch530.
Contents
Topic Page
usb add 384
usb config 385
usb delete 386
usb info 387
usb list 388
384
USB Commands
usb add
Adds a VP or VC cross-connection between the USB interface and the WAN interface.
SYNTAX:
RELATED COMMANDS:
usb add wanvpi = <number{0-15}>
wanvci = <number{0-511}>
usbvpi = <number{0-15}>
usbvci = <number{0-511}>
[qos = <{default}>]
wanvpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI) of WAN interface.
REQUIRED
wanvci A number between 0 and 511.
Represents the Virtual Channel Identifier (VCI) of WAN interface.
REQUIRED
usbvpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI) of USB interface.
REQUIRED
usbvci A number between 0 and 511.
Represents the Virtual Channel Identifier (VCI) of USB interface.
REQUIRED
qos The name of a qosbook entry. OPTIONAL
usb delete Deletes a cross-connection on the USB interface.
usb list Shows all cross-connections on the USB interface.
385
USB Commands
usb config
Enable/disable the USB interface.
SYNTAX:
EXAMPLE:
usb config [state = <{enabled|disabled}>]
state Enable or disable the USB interface. OPTIONAL
=>usb config
USB port state = UP [configured]
=>
386
USB Commands
usb delete
Deletes a cross-connection on the USB interface.
SYNTAX:
RELATED COMMANDS:
usb delete wanvpi = <number{0-15}>
[wanvci = <number{0-511}>]
wanvpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI) of WAN interface.
REQUIRED
wanvci A number between 0 and 511.
Represents the Virtual Channel Identifier (VCI) of WAN interface.
OPTIONAL
usb add Adds a VP or VC cross-connection between the USB interface and the WAN interface
usb list Shows all cross-connections on the USB interface.
387
USB Commands
usb info
Show USB properties/statistics
SYNTAX:
EXAMPLE:
usb info
=>usb info
MACaddr = 00-90-d0-02-8a-a3
Type = Device
Rate = FullSpeed
Power = SelfPowered
Properties
DataTransferType = Bulk
DataAlternateSetting = 1
MajorRelease = 1
MinorRelease = 10
NumberOfConfigurations = 1
DeviceClass = Vendor Specific
DeviceSubclass = 0
Protocol = 0
Ep0MaxPacketSize = 64 Bytes
Statistics :
ReservedBandwidth = Not Applicable
Bytes tx = 406245
Bytes rx = 238341
Blocks tx = 6697
Blocks rx = 4256
=>
388
USB Commands
usb list
Shows all cross-connections on the USB interface.
SYNTAX:
usb list
389
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
Wireless Commands
Introduction
The commands covered in this chapter can only be used with the SpeedTouch570.
Contents
This chapter covers the following commands:I
Topic Page
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
390
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless aclconfig
Configures the Access Control List (ACL) mode.
SYNTAX:
DESCRIPTION:
EXAMPLE:
wireless aclconfig [control = <{register|lock|unlock}>]
control Select the Access Control List mode.
Choose between:
register button mode
lock/unlock mode
Default setting is Register Button mode.
OPTIONAL
Register A wireless client is only added to the ACL after using the Register Button.
Lock The ACL is locked. No new entries are allowed in the ACL.
Unlock Every wireless client is unconditionally added to the ACL.
=>wireless aclconfig
Access control list : Register Button mode
=>wireless aclconfig control=lock
=>wireless aclconfig
Access control list : ACL locked (lock/unlock mode)
=>
391
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless aclentry
Adds or deletes an entry in the ACL.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless aclentry hwaddr = <hardware-address>
action = <{allow|deny|delete}>
[name = <quoted string>]
hwaddr The Ethernet MAC address of the ACL entry REQUIRED
action The action to be performed on ACL entry.
Choose between:
allow
deny
delete
REQUIRED
name The name of the station OPTIONAL
=>wireless acllist
Station Name MAC address Allowed
Test 00:90:D0:01:47:DE : yes
=>wireless aclentry hwaddr=01:67:d0:23:56:cd action=allow name="Test2"
=>wireless acllist
Test 00:90:D0:01:47:DE : yes
Test2 01:67:D0:23:56:CD : yes
=>wireless aclentry hwaddr=01:67:d0:23:56:cd action=deny name="Test2"
=>wireless acllist
Test 00:90:D0:01:47:DE : yes
Test2 01:67:D0:23:56:CD : no
=>wireless aclentry hwaddr=01:67:d0:23:56:cd action=delete name="Test2"
=>wireless acllist
Test 00:90:D0:01:47:DE : yes
=>
wireless aclflush Flushes the ACL.
wireless acllist Lists the ACL.
392
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless aclflush
Flushes the ACL.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless aclflush
=>wireless acllist
Test 00:90:D0:01:47:DE : yes
Test2 01:67:D0:23:56:CD : yes
=>wireless aclflush
=>wireless acllist
The access control list is empty.
=>
wireless aclentry Adds or deletes an entry in the ACL.
wireless acllist Lists the ACL.
393
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless acllist
Lists the ACL.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless acllist
=>wireless acllist
Test 00:02:2d:42:E5:2D : yes
Test2 01:67:D0:23:56:CD : yes
=>
wireless aclentry Adds or deletes an entry in the ACL.
wireless aclflush Flushes the ACL.
394
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless counters
Displays the value of the SpeedTouch570 WLAN counters.
SYNTAX:
EXAMPLE:
wireless counters [clear <{no|yes}>]
clear Clear the wireless counters OPTIONAL
=>wireless counters
Tx Frames Count : 497
Rx Frames Count : 0
Station Not Allowed Count : 0
Station Unknown Count : 0
WEPICV Error Count : 0
WEP Excluded Count : 0
=>wireless counters clear=yes
=>wireless counters
Tx Frames Count : 0
Rx Frames Count : 0
Station Not Allowed Count : 0
Station Unknown Count : 0
WEPICV Error Count : 0
WEP Excluded Count : 0
=>
395
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless flush
Flush the SpeedTouch570 WLAN parameters, i.e. reset to the factory defaults.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless flush
=>wireless ifconfig
Wireless SSID : Schozach
Accept any SSID : yes
Communication channel : 3 (selected)
RTS Threshold : 1000
Short Retry Limit : 4
Long Retry Limit : 4
Beacon Period : 100
=>wireless flush
=>wireless ifconfig
Accept any SSID : no
Communication channel : 6 (auto)
Beacon Period : 100
=>
wireless ifconfig Configures and shows the wireless interface parameters.
wireless scan Scans for other APs in the area.
wireless status Shows the status of the wireless interface.
396
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless ifconfig
Configures and shows the SpeedTouch570 Wireless LAN (WLAN) interface parameters.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless ifconfig [ssid = <quoted string>]
[any = <{off|on}>]
[channel = <{auto|1|2|3|4|5|6|7|8|9|10|11}>]
[rts = <number{0-2347}>]
ssid The Service Set Identifier (SSID) OPTIONAL
any Accept stations with SSID any or blank SSID. Default is no. OPTIONAL
channel The communication channel number. Choose between:
auto: the best communication channel is automatically selected
by the SpeedTouch (default).
a number between 1 and 11.
OPTIONAL
rts A number between 0 and 2347.
Represents the value of the RTS threshold. Setting this parameter to
a small value causes RTS messages to be send more often, consuming
more of the available bandwidth, therefore reducing the apparent
throughput of other network packets. However, the more often RTS
packets are sent, the quicker the system can recover from interfer-
ence or collisions. Default is 2347.
OPTIONAL
=>wireless ifconfig
Accept any SSID : no
Communication channel : 6 (auto)
Beacon Period : 100
=>wireless ifconfig any=on channel=3 rts=1000
=>wireless ifconfig
Accept any SSID : yes
Communication channel : 3 (selected)
Beacon Period : 100
=>
397
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless scan
Scans for other APs in the area. An overview of all the radio channels and their respective ratings is shown.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless scan
=>wireless scan
Channel rating
1 : Good
2 : Good
3 : Good
4 : Good
5 : Good
6 : Recommended
7 : Good
8 : Good
9 : Good
10 : Good
11 : Good
Recommended channel : 6
=>
398
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless status
Shows the status of the SpeedTouch570 WLAN interface.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
wireless status
=>wireless status
Wireless interface is running on channel 3 in clear-text
=>wireless ifconfig channel=auto
=>wireless status
Wireless interface is running on channel 6 in clear-text
399
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
wireless wepconfig
Configures Wired Equivalent Privacy (WEP) secure access.
SYNTAX:
EXAMPLE:
wireless wepconfig [key = <password>]
[encryption = <{off|on}>]
key The WEP key.
In case of 64 bit encryption, the 40-bits WEPkey must consist of 10
hexadecimal digits.
In case of 128 bit encryption, the 104-bits WEPkey must consist of
26 hexadecimal digits.
OPTIONAL
encryption Encryption is turned on/off OPTIONAL
=>wireless wepconfig key=O123456789abcdef0123456789 encryption=on
=>wireless wepconfig
WEP encryption : enabled
WEP key : 128-bit
=>
400
Wireless Commands
E-SIT-CTC-20030410-0050 Ed. 03
401
Abbreviations
Abbreviations
The table below lists all the abbreviations used in the CLI Guide.
Abbreviation Description
AAL5 ATM Adaption Layer 5
ACL Access Control List
ADSL Asymmetric Digital Subscriber Line
AH Authentication Header
ARP Address Resolution Protocol
ATM Asynchronous Transfer Mode
ATMF ATM Forum
BGP Border Gateway Protocol
CA Certificate Authority
CC Continuity Check
CEP Certificate Enrollment Protocol
CHAP Challenge Handshake Authentication Protocol
CIDR Classles Inter Domain Routing
CLI Command Line Interface
CRL Certificate Revocation List
DHCP Dynamic Host Configuration Protocol
DN Distinguished Name
DNS Domain Name System
DSL Digital Subscriber Line
EGP Exterior Gateway Protocol
ESP Encapsulating Security Payload
FTP File Transfer Protocol
GRE General Routing Encapsulation
GRP Gateway Routing Protocol
HDLC High-level Data Link Control
HTTP HyperText Transfer Protocol
ICMP Internet Control Message Protocol
402
Abbreviations
IGD Internet Gateway Device
IGMP Internet Group Management Protocol
IKE Internet Key Exchange
IMAP Interim Mail Access Protocol
IMAP Interactive Mail Access Protocol
IP Internet Protocol
IPCP Internet Protocol Control Protocol
IPCP IP Payload Compression Protocol
IP oA IP over ATM
IPSec IP Security
IRC Internet Relay Chat
ISDN Integrated Services Digital Network
LAN Local Area Network
LCP Link Control Protocol
LDAP Light-weight Directory Access Protocol
LIS Logical IP Subnet
LLC Logical Link Control
MAC Medium Access Control
MD5 Message Digest 5
MER MAC Encapsulated Routing
NAPT Network Address and Port Translation
NAT Network Address Translation
NBP Name Binding Protocol
NLPID Network Layer Protocol IDentifiers
NNTP Network News Transfer Protocol
NTP Network Time Protocol
OAM Operation and Maintenance
OBC On Board Controller
OID Object IDentifier
PAP Password Authentication Protocol
PBX Private Branch Exchange
403
Abbreviations
PIP Packet Interception Point
PKCS Public Key Cryptography Standard
PKI Public Key Infrastructure
POP Post Office Protocol
POTS Plain Old Telephone Service
PPP Point-to-Point Protocol
PPPoA PPP over ATM
PPPoE PPP over Ethernet
PPTP Point-to-Point Tunneling Protocol
PSD Power Spectral Density
PVC Permanent Virtual Channel
QoS Quality of Service
RIP Routing Information Protocol
RTMP RouTing Maintenance Protocol
RTSP Real Time Stream Control Protocol
SAs Security Associations
SHDSL Symmetric High speed Digital Subscriber Line
SIP Session Initiation Protocol
SMTP Simple Mail Transfer Protocol
SNAP Sub Network Access Protocol
SNMP Simple Network Management Protocol
SNPP Simple Network Paging Protocol
SNR Signal-to-Noise Ratio
SNTP Simple Network Time Protocol
SVC Switched Virtual Channel
TCP Transmission Control Protocol
TFTP Trivial File Transfer Protocol
ToS Type of Service
UDP User Datagram Protocol
UPnP Universal Plug and Play
URI Uniform Resource Identifier
404
Abbreviations
URL Uniform Resource Locator
VC Virtual Channel
VCMUX Virtual Channel MUltipleXing
VDSL Very high speed Digital Subscriber Line
VLSM Variable Length Subnet Masking
VP Virtual Path
VPN Virtual Private Networking
WAN Wide Area Network
WCD WAN Connection Device
WEP Wired Equivalent Privacy
WINS Windows Internet Naming Service
WLAN Wireless LAN
WWW World Wide Web
ZIS Zone Information System
405
Syslog Messages
Syslog Messages
Introduction
This chapter lists the different Syslog messages.
Contents
Topic Page
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
406
Syslog Messages
Auto-PVC Module
Configuration Module
Facility Severity Contents
LOCAL5 WARNING AUTOPVC script <script_name> failed
LOCAL5 WARNING AUTOPVC script <script_name> failed
LOCAL5 WARNING AUTOPVC script <script_name> (name1, qosb_name) failed
LOCAL5 WARNING AUTOPVC script <script_name> (name1, qosb_name, name2) failed
LOCAL5 WARNING AUTOPVC script 'autopvc_change_qos (itable[i].intf, name1, qosb_name) failed
LOCAL5 WARNING AUTOPVC script <script_name> (name1, name2) failed
USER INFO CONFIGURATION saved after running Embedded Setup Wizard
USER INFO CONFIGURATION saved by user <user_id>
USER INFO CONFIGURATION backup by user to file <filename>
USER INFO CONFIGURATION <conf_version> upgraded to version <version>)
KERN INFO SYSTEM reset by user <user_id> to factory defaults: user settings deleted
407
Syslog Messages
DHCP CLient Module
DHCP Relay Module
LOCAL2 WARNING DHCP lease ip-address <ip-address> bound to intf <intf_id>
LOCAL2 WARNING DHCP intf <intf_id> renews lease ip-address <ip-address>
LOCAL2 WARNING DHCP intf <intf_id> rebinds lease ip-address <ip-address> from server
(<ip-address>)
LOCAL2 WARNING DHCP offer received from <ip-address> (can be relay agent) for intf <intf_id>
LOCAL2 WARNING DHCP server (<ip-address>) offers <ip-address> to intf <intf_id>
LOCAL2 WARNING DHCP unable to configure ip address: <ip-address> (bootp-reply)
LOCAL2 WARNING DHCP bootp lease ip-address <ip-address> bound to intf <intf_id> from server
(<ip-address>)
LOCAL2 WARNING DHCP <ip-address> already configured on intf <intf_id>: failure
LOCAL2 WARNING DHCP <ip-address> (<ip-address>) set on intf <intf_id>: {faillure||ok}
LOCAL2 WARNING DHCP <ip-address> deleted: {faillure||ok}
LOCAL2 WARNING DHCP relay: Dropping boot rqs on interface <intf_id> due to invalid giaddr for
server (<ip-address>)
LOCAL2 WARNING DHCP relay: Dropping boot reply with invalid relay agent option from <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request containing the relay agent option from
<intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot reply to unknown interface from <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot reply to inactive interface <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot reply to inactive interface <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request packet with spoofed giaddr field from
<intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request received on unknown interface from <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request on inactive interface <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request with invalid hops field on interface <intf_id>
LOCAL2 WARNING DHCP relay: Dropping boot request with invalid giaddr on interface <intf_id>
408
Syslog Messages
DHCP Server Module
Firewall Module
HTTP Module
LOCAL2 WARNING DHCP server: DHCPOFFER || DHCPACK cannot be send due to invalid server
identifier
LOCAL2 WARNING DHCP server: DHCPACK cannot be send due to invalid server identifier
LOCAL2 WARNING DHCP server: DHCPNAK cannot be send due to invalid server identifier
LOCAL2 WARNING DHCP Auto DHCP: server detected on LAN, own dhcp server disabled
LOCAL2 WARNING DHCP Auto DHCP: no server detected on LAN, SpeedTouch server started
LOCAL2 WARNING DHCP Auto DHCP: search for DHCP server stopped
LOCAL2 WARNING DHCP server up
LOCAL2 WARNING DHCP server went down
AUTH WARNING FIREWALL Hook: <hookname> Rule ID:<rule_id> Protocol: ICMP
Src_ip: <ip_address> Dst_ip: <ip_address>
ICMP message type: <message_type_name || message_type_id > Action: <action>
AUTH WARNING FIREWALL Hook: <hookname> Rule ID:<rule_id> Protocol: <protocol_name>
Src_ip_port: <ip-address:ip_port> Dst_ip_port: <ip-address:ip_port>
Action: <action>
AUTH NOTICE LOGOUT User <user_id> logged out on <connection_type> (<ip-address>)
AUTH NOTICE LOGOUT User <user_id> logged out on <connection_type>
AUTH NOTICE LOGOUT <session_name> session of user <user_id> killed (<ip-address>)
AUTH NOTICE LOGOUT <session_name> session of user <user_id> killed
AUTH NOTICE LOGIN User <user_id> tried to login on <connection_type> (from <ip-address>)
AUTH NOTICE LOGIN User <user_id> logged in on <connection_type> (from <ip-address>)
AUTH NOTICE LOGIN User logged in on <connection_type> (<ip-address>)
AUTH NOTICE LOGIN User <user_id> tried to log in on <connection_type>
409
Syslog Messages
Kernel Module
Linestate Module
Login Module
NAPT Module
KERN WARNING KERNEL cold reset
KERN WARNING KERNEL warm reset
KERN EMERG KERNEL Controlled restart (after internal error or explicit system reboot)
LOCAL5 NOTICE xDSL linestate up (downstream: <bitrate_in> kbit/s, upstream: <bitrate_out> kbit/s)
LOCAL5 NOTICE xDSL linestate down
AUTH NOTICE LOGIN User <username> logged <in||out> on telnet (<ip address>)
AUTH NOTICE LOGIN User <username> logged in on http (<ip-address>)
LOCAL4 INFO NAPT Protocol: <TCP | UDP | ICMP> Open port: <port>
Helper: <app_name> => <""failed"" | ""ok"">"
410
Syslog Messages
PPP Module
PPTP Module
Routing Module
LOCAL0 WARNING PPP Link up (<intf name>)
LOCAL0 WARNING PPP Link down (<intf name>)
AUTH ERROR PPP PAP authentication failed (<intf name>) [protocol reject]
AUTH INFO PPP PAP on intf <intf_id> no response to PAP authenticate-request
AUTH NOTICE PPP PAP remote user <remote_user_name> succesfull authenticated
AUTH ERROR PPP PAP authentication for remote user <remote_user> failed
AUTH DEBUG PPP PAP Authenticate Ack received
AUTH DEBUG PPP PAP Authenticate Nack received
AUTH DEBUG PPP PAP Authenticate Request sent
AUTH ERROR PPP CHAP authentication failed (<intf name>)
AUTH ERROR PPP CHAP autentication failed [protocol reject(server)]
AUTH ERROR PPP CHAP autentication failed [protocol reject(client)]
AUTH DEBUG PPP CHAP Receive challenge (rhost = <hostname>)
AUTH INFO PPP CHAP Chap receive success: authentication ok
AUTH DEBUG PPP CHAP Challenge Send (Id = <challenge_id>)
AUTH DEBUG PPP CHAP Send status response: {ack || nack}
LOCAL0 WARNING PPTP tunnel (<Pbname>) up:(<ip addr>)
LOCAL0 WARNING PPTP tunnel (<Pbname>) down:(<ip addr>)
SECURITY INFO LABEL Rule Id:<rule_id> Protocol: ICMP Src_ip: <ip_address> Dst_ip: <ip_address>
ICMP message type: <message_type_name || message_type_id > Label: <label_name>
SECURITY INFO LABEL Rule Id:<rule_id> Protocol: <protocol_name> Src_ip: <ip_address>
Dst_ip: <ip_address> Label: <label_name>
411
Syslog Messages
Software Module
UPnP Module
KERN INFO SOFTWARE Copying all data files from <file_location> to <file_location>
KERN INFO SOFTWARE Switchover going down in <number> seconds
KERN INFO SOFTWARE No passive software found, duplicating active software
KERN INFO SOFTWARE Duplication of active software failed
WARNING SECURITY UPnP<ActionName> refused for ip=<ip_address>
NOTICE SECURITY UPnP <ActionName> (<Error_string>) for ip=<ip_address>
412
Syslog Messages
413
Supported Key Names
Supported Key Names
Contents
This chapter lists all the key names supported by the SpeedTouch, that can be used for completing CLI command
parameters.
Supported Internet Protocol (IP) Protocol Names
For more information on the listed IP protocols, see RFC1340 or www.iana.org.
Protocol name Number Description
icmp 1 Internet Control Message Protocol (ICMP)
igmp 2 Internet Group Management Protocol (IGMP)
ipinip 4 IP in IP (encapsulation)
tcp 6 Transmission Control Protocol (TCP)
egp 8 Exterior Gateway Protocol (EGP)
udp 17 User Datagram Protocol (UDP)
rsvp 46 Reservation Protocol
gre 47 General Routing Encapsulation (GRE)
ah 51 Authentication Header (AH)
esp 50 Encapsulating Security Payload (ESP)
vines 83 Vines
ipcomp 108 IP Payload Compression Protocol (IPCP)
414
Supported Key Names
Supported TCP/UDP Port Names
For more information on the listed TCP/UDP port assignments, see RFC1340 or www.iana.org.
Port name Number TCP UDP Description
echo 7 Y Y Echo
discard 9 Y Y Discard
systat 11 Y Y Active Users
daytime 13 Y Y Daytime
qotd 17 Y Y Quote of the Day
chargen 19 Y Y Character Generator
ftp-data 20 Y Y File Transfer (Default data)
ftp 21 Y Y File Transfer (Control)
telnet 23 Y Y Telnet
smtp 25 Y Y Simple Mail Transfer Protocol (SMTP)
time 37 Y Y Time
nicname 43 Y Y Who Is
dns 53 Y Y Domain Name System (DNS)
domain 53 Y Y Domain Name System (DNS)
sql*net 66 Y Y Oracle SQL*NET
bootps 67 Y Y Bootstrap Protocol Server
bootpc 68 Y Y Bootstrap Protocol Client
tftp 69 Y Y Trivial File Transfer Protocol (TFTP)
gopher 70 Y Y Gopher
finger 79 Y Y Finger
www-http 80 Y Y World Wide Web (WWW) HTTP
kerberos 88 Y Y Kerberos
rtelnet 107 Y Y Remote Telnet Service
pop2 109 Y Y Post Office Protocol (POP) - Version 2
pop3 110 Y Y Post Office Protocol (POP) - Version 3
sunrpc 111 Y Y SUN Remote Procedure Call
auth 113 Y Y Authentication Service
sqlserver 118 Y Y SQL Services
415
Supported Key Names
nntp 119 Y Y Network News Transfer Protocol (NNTP)
sntp 123 Y Y Simple Network Time Protocol (SNTP)
ntp 123 Y Y Network Time Protocol (NTP)
ingres-net 134 Y Y INGRES-NET Service
netbios-ns 137 Y Y NETBIOS Naming System
netbios-dgm 138 Y Y NETBIOS Datagram Service
netbios-ssn 139 Y Y NETBIOS Session Service
imap2 143 Y Y Interim Mail Access Protocol (IMAP) v2
sql-net 150 Y Y SQL-NET
pcmail-srv 158 Y Y PCMail Server
snmp 161 Y Y Simple Network Management Protocol (SNMP)
snmptrap 162 Y Y SNMP Trap
bgp 179 Y Y Border Gateway Protocol (BGP)
irc-o 194 Y Y Internet Relay Chat (IRC) - o
at-rtmp 201 Y Y AppleTalk RouTing Maintenance Protocol (RTMP)
at-nbp 202 Y Y AppleTalk Name Binding Protocol (NBP)
at-echo 204 Y Y AppleTalk Echo
at-zis 206 Y Y AppleTalk Zone Information System (ZIS)
ipx 213 Y Y
imap3 220 Y Y Interactive Mail Access Protocol (IMAP) v3
clearcase 371 Y Y ClearCase
ulistserv 372 Y Y UNIX Listserv
ldap 389 Y Y Light-weight Directory Access Protocol (LDAP)
netware-ip 396 Y Y Novell Netware over IP
snpp 444 Y Y Simple Network Paging Protocol (SNPP)
ike 500 Y Y ISAKMP
exec 512 Y - Remote process execution
biff 512 - Y Used by mail system to notify users of new mail received
login 513 Y - Remote login a la telnet
who 513 - Y Maintains data bases showing who's logged in to machines on a
local net and the load average of the machine
416
Supported Key Names
syslog 514 - Y Syslog
printer 515 Y Y Spooler
talk 517 Y Y Like Tenex link, but across machine
ntalk 518 Y Y NTalk
utime 519 Y Y UNIX Time
rip 520 - Y Local routing process (on site); uses variant of Xerox NS
Routing Information Protocol (RIP)
timed 525 Y Y Timeserver
netwall 533 Y Y For emergency broadcasts
uucp 540 Y Y uucpd
uucp-rlogin 540 Y Y uucpd remote login
new-rwho 540 Y Y uucpd remote who is
rtsp 554 Y Y Real Time Stream Control Protocol (RTSP)
417
Supported Key Names
Supported ICMP Type Names
For more information on the listed ICMP type names, see RFC1340 or www.iana.org.
ICMP Type name Number Description
echo-reply 0 Echo Reply
destination-unreachable 3 Destination Unreachable
source-quench 4 Source Quench
redirect 5 Redirect
echo-request 8 Echo
router-advertisement 9 Router Advertisement
router-solicitation 10 Router Solicitation
time-exceeded 11 Time Exceeded
parameter-problems 12 Parameter problems
timestamp-request 13 Timestamp
timestamp-reply 14 Timestamp Reply
information-request 15 Information Request
information-reply 16 Information Reply
address-mask-request 17 Address Mask Request
address-mask-reply 18 Address Mask Reply
418
Supported Key Names
Supported Syslog Facilities
For more information on the listed Syslog facilities, see RFC3164.
Facilty Name Hierarchy
Code
Syslog facility
(listed according descending importance)
kern 0 Kernel messages
user 8 User-level messages
mail 16 Mail system
daemon 24 System daemons
auth 32 Authorization messages
syslog 40 Syslog daemon messages
lpr 48 Line printer subsystem
news 56 Network news subsystem
uucp 64 UUCP subsystem
cron 72 Clock daemon
security 80 Security messages
ftp 88 FTP daemon
ntp 96 NTP subsystem
audit 104 Log audit
logalert 112 Log alert
clock 120 Clock daemon
local0
local1
local2
local3
local4
local5
local6
local7
128
136
144
152
160
168
176
184
Local use messages
all - All facilities (SpeedTouch specific facility parameter value.
419
Supported Key Names
Supported Syslog Severities
For more information on the listed Syslog severities, see RFC3164.
Severity Name Hierarchy
Code
Syslog severity
(listed according descending importance)
emerg 0 Emergency conditions, system unusable
alert 1 Alert conditions, immediate action is required
crit 2 Critical conditions
err 3 Error conditions
warning 4 Warning conditions
notice 5 Normal but significant conditions
info 6 Informational messages
debug 7 Debug-level messages
420
Supported Key Names
2
0
0
3

T
H
O
M
S
O
N
.

A
l
l

r
i
g
h
t
s

r
e
s
e
r
v
e
d
.

E
-
S
I
T
-
C
T
C
-
2
0
0
3
0
4
1
0
-
0
0
5
0
v
1
.
0

500
SERIES
www.speedtouch.com
Built for excellence

SpeedTouch 500 CLI Reference Guide

Uploaded by

Copyright:

Available Formats

SpeedTouch 500 CLI Reference Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SpeedTouch 500 CLI Reference Guide

Uploaded by

Copyright:

Available Formats

SpeedTouch

You might also like