SpeedTouch™605s
Multi-User SHDSL Gateway
CLI Reference Guide
Release R4.2.7(.2)
600
SERIES
SpeedTouch™
605s
CLI Reference Guide
Release R4.2.7(.2)
Status v3.0 (October 2004)
Reference E-DOC-CTC-20040216-0004
Short Title CLI ST605s R4.2.7(.2)
Copyright
© 2004 THOMSON Telecom. All rights reserved. Passing on, and copying of this document,
use and communication of its contents is not permitted without written authorization from
THOMSON Telecom. 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 Telecom. THOMSON Telecom assumes no responsibility or liability for any
errors or inaccuracies that may appear in this document.
Content
About this Document .................................................................................... 15
CLI Navigation ............................................................................................... 17
Accessing the Command Line Interface .................................................................................................................... 18
Basic Navigation and Manipulation..............................................................................................................................19
Command Line Interface Top Level Structure ........................................................................................................23
Command Line Interface Commands ........................................................................................................................ 24
Menu-driven CLI Navigation ........................................................................................................................................ 25
Service Template Files and the CLI ............................................................................................................................ 28
Direct FTP Access .......................................................................................................................................................... 30
ATM Commands............................................................................................ 33
atm oam ccconfig ............................................................................................................................................................34
atm oam cclist..................................................................................................................................................................35
atm oam ccsend...............................................................................................................................................................36
atm oam config ................................................................................................................................................................ 37
atm oam mode.................................................................................................................................................................38
atm oam ping.................................................................................................................................................................... 39
atm oam status ................................................................................................................................................................ 40
AutoPVC Commands .................................................................................... 41
autopvc config.................................................................................................................................................................. 42
autopvc info...................................................................................................................................................................... 44
Bridge Commands ......................................................................................... 45
bridge config..................................................................................................................................................................... 46
bridge flush .......................................................................................................................................................................47
bridge ifadd .......................................................................................................................................................................48
bridge ifattach...................................................................................................................................................................49
bridge ifconfig................................................................................................................................................................... 50
bridge ifdelete .................................................................................................................................................................. 52
bridge ifdetach ................................................................................................................................................................. 53
bridge iflist ........................................................................................................................................................................ 54
bridge macadd.................................................................................................................................................................. 55
bridge macdelete.............................................................................................................................................................56
bridge maclist ................................................................................................................................................................... 57
E-DOC-CTC-20040216-0004 v3.0
3
CIP Commands .............................................................................................. 59
cip flush.............................................................................................................................................................................. 60
cip ifadd .............................................................................................................................................................................61
cip ifdelete......................................................................................................................................................................... 62
cip iflist...............................................................................................................................................................................63
cip pvcadd ......................................................................................................................................................................... 64
cip pvcdelete .................................................................................................................................................................... 65
cip pvclist........................................................................................................................................................................... 66
Config Commands ......................................................................................... 67
config backup....................................................................................................................................................................68
config dump ......................................................................................................................................................................69
config erase....................................................................................................................................................................... 70
config flush ........................................................................................................................................................................71
config list ........................................................................................................................................................................... 72
config load......................................................................................................................................................................... 73
config save......................................................................................................................................................................... 75
4
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands ......................................................................................... 77
dhcp client clear .............................................................................................................................................................. 79
dhcp client config ............................................................................................................................................................ 80
dhcp client flush............................................................................................................................................................... 81
dhcp client ifadd............................................................................................................................................................... 82
dhcp client ifattach ..........................................................................................................................................................83
dhcp client ifconfig ..........................................................................................................................................................84
dhcp client ifdelete.......................................................................................................................................................... 86
dhcp client iflist................................................................................................................................................................87
dhcp client ifrelease ........................................................................................................................................................ 88
dhcp client ifrenew .........................................................................................................................................................91
dhcp client stats............................................................................................................................................................... 94
dhcp relay add.................................................................................................................................................................. 95
dhcp relay config ............................................................................................................................................................. 96
dhcp relay delete............................................................................................................................................................. 97
dhcp relay flush................................................................................................................................................................ 98
dhcp relay ifconfig ...........................................................................................................................................................99
dhcp relay iflist...............................................................................................................................................................100
dhcp relay list .................................................................................................................................................................101
dhcp relay stats..............................................................................................................................................................102
dhcp server clear...........................................................................................................................................................103
dhcp server config.........................................................................................................................................................104
dhcp server flush ...........................................................................................................................................................105
dhcp server policy.........................................................................................................................................................106
dhcp server stats ...........................................................................................................................................................107
dhcp server lease add...................................................................................................................................................109
dhcp server lease delete..............................................................................................................................................111
dhcp server lease flush.................................................................................................................................................112
dhcp server lease list....................................................................................................................................................113
dhcp server pool add ...................................................................................................................................................114
dhcp server pool config ...............................................................................................................................................115
dhcp server pool delete...............................................................................................................................................117
dhcp server pool flush .................................................................................................................................................118
dhcp server pool list.....................................................................................................................................................119
E-DOC-CTC-20040216-0004 v3.0
5
DNS Commands .......................................................................................... 121
dns add ............................................................................................................................................................................122
dns clear ..........................................................................................................................................................................123
dns clrstats......................................................................................................................................................................124
dns delete........................................................................................................................................................................125
dns domain .....................................................................................................................................................................126
dns flush...........................................................................................................................................................................127
dns fwdadd......................................................................................................................................................................128
dns fwddelete.................................................................................................................................................................129
dns fwdlist .......................................................................................................................................................................130
dns fwdtable ...................................................................................................................................................................131
dns list..............................................................................................................................................................................132
dns nslookup ..................................................................................................................................................................133
dns start...........................................................................................................................................................................134
dns stats...........................................................................................................................................................................135
dns status ........................................................................................................................................................................136
dns stop...........................................................................................................................................................................137
dns toutfwd ....................................................................................................................................................................138
dns troff...........................................................................................................................................................................139
dns tron...........................................................................................................................................................................140
Env Commands ............................................................................................ 141
env flush ..........................................................................................................................................................................142
env get .............................................................................................................................................................................143
env list..............................................................................................................................................................................144
env set .............................................................................................................................................................................145
env unset.........................................................................................................................................................................146
Eth Commands............................................................................................. 147
eth config.........................................................................................................................................................................148
eth ifconfig ......................................................................................................................................................................149
eth iflist ............................................................................................................................................................................150
6
E-DOC-CTC-20040216-0004 v3.0
ETHoA Commands ..................................................................................... 151
ethoa flush.......................................................................................................................................................................152
ethoa ifadd ......................................................................................................................................................................153
ethoa ifattach..................................................................................................................................................................154
ethoa ifconfig..................................................................................................................................................................155
ethoa ifdelete .................................................................................................................................................................157
ethoa ifdetach.................................................................................................................................................................158
ethoa iflist........................................................................................................................................................................159
Firewall Commands..................................................................................... 161
firewall assign .................................................................................................................................................................162
firewall flush....................................................................................................................................................................164
firewall list.......................................................................................................................................................................165
firewall troff....................................................................................................................................................................166
firewall tron....................................................................................................................................................................167
firewall unassign.............................................................................................................................................................168
firewall chain create......................................................................................................................................................169
firewall chain delete......................................................................................................................................................170
firewall chain flush.........................................................................................................................................................171
firewall chain list ............................................................................................................................................................172
firewall rule clear...........................................................................................................................................................173
firewall rule create........................................................................................................................................................174
firewall rule delete ........................................................................................................................................................178
firewall rule flush ...........................................................................................................................................................179
firewall rule list ..............................................................................................................................................................180
firewall rule stats ...........................................................................................................................................................181
E-DOC-CTC-20040216-0004 v3.0
7
IP Commands ............................................................................................... 183
ip apadd ...........................................................................................................................................................................184
ip apdelete.......................................................................................................................................................................186
ip aplist.............................................................................................................................................................................187
ip arpadd .........................................................................................................................................................................188
ip arpdelete.....................................................................................................................................................................189
ip arplist...........................................................................................................................................................................190
ip config ...........................................................................................................................................................................191
ip flush..............................................................................................................................................................................194
ip ifconfig .........................................................................................................................................................................195
ip iflist...............................................................................................................................................................................196
ip ifwait ............................................................................................................................................................................197
ip mcadd..........................................................................................................................................................................198
ip mcdelete .....................................................................................................................................................................199
ip mclist ...........................................................................................................................................................................200
ip ping...............................................................................................................................................................................201
ip rtadd ............................................................................................................................................................................202
ip rtdelete .......................................................................................................................................................................203
ip rtlist..............................................................................................................................................................................204
ip sendto..........................................................................................................................................................................205
ip traceroute ..................................................................................................................................................................206
ip auto flush ....................................................................................................................................................................207
ip auto ifadd....................................................................................................................................................................208
ip auto ifattach ...............................................................................................................................................................209
ip auto ifconfig................................................................................................................................................................210
ip auto ifdelete ...............................................................................................................................................................211
ip auto ifdetach ..............................................................................................................................................................212
ip auto iflist .....................................................................................................................................................................213
IPoA Commands.......................................................................................... 215
ipoa flush .........................................................................................................................................................................216
ipoa ifadd.........................................................................................................................................................................217
ipoa ifattach ....................................................................................................................................................................218
ipoa ifconfig.....................................................................................................................................................................219
ipoa ifdelete ....................................................................................................................................................................221
ipoa ifdetach ...................................................................................................................................................................222
ipoa iflist ..........................................................................................................................................................................223
8
E-DOC-CTC-20040216-0004 v3.0
IPQoS Commands ....................................................................................... 225
ipqos config.....................................................................................................................................................................226
ipqos list ..........................................................................................................................................................................228
ipqos queue clear ..........................................................................................................................................................229
ipqos queue config ........................................................................................................................................................230
ipqos queue list..............................................................................................................................................................232
ipqos queue stats...........................................................................................................................................................233
Label Commands ......................................................................................... 235
label add ..........................................................................................................................................................................236
label config ......................................................................................................................................................................237
label delete......................................................................................................................................................................239
label flush.........................................................................................................................................................................240
label list............................................................................................................................................................................241
label troff.........................................................................................................................................................................242
label tron.........................................................................................................................................................................243
label chain create...........................................................................................................................................................244
label chain delete...........................................................................................................................................................245
label chain flush..............................................................................................................................................................246
label chain list.................................................................................................................................................................247
label rule clear................................................................................................................................................................248
label rule create.............................................................................................................................................................249
label rule delete .............................................................................................................................................................252
label rule flush ................................................................................................................................................................253
label rule list ...................................................................................................................................................................254
label rule stats ................................................................................................................................................................255
Language Commands .................................................................................. 257
language config...............................................................................................................................................................258
language list.....................................................................................................................................................................259
language remove............................................................................................................................................................260
E-DOC-CTC-20040216-0004 v3.0
9
NAT Commands .......................................................................................... 261
nat applist........................................................................................................................................................................262
nat bind............................................................................................................................................................................263
nat bindlist.......................................................................................................................................................................264
nat clear...........................................................................................................................................................................266
nat config.........................................................................................................................................................................267
nat create........................................................................................................................................................................268
nat defserver ..................................................................................................................................................................270
nat delete ........................................................................................................................................................................271
nat disable .......................................................................................................................................................................273
nat enable........................................................................................................................................................................274
nat flush ...........................................................................................................................................................................276
nat list ..............................................................................................................................................................................277
nat multinatadd ..............................................................................................................................................................278
nat multinatdelete .........................................................................................................................................................279
nat multinatlist ...............................................................................................................................................................280
nat unbind .......................................................................................................................................................................281
Phonebook Commands ............................................................................... 283
phonebook add..............................................................................................................................................................284
phonebook autolist.......................................................................................................................................................286
phonebook delete.........................................................................................................................................................287
phonebook flush............................................................................................................................................................288
phonebook list ...............................................................................................................................................................289
PPPoA Commands ...................................................................................... 291
pppoa flush......................................................................................................................................................................292
pppoa ifadd .....................................................................................................................................................................293
pppoa ifattach.................................................................................................................................................................295
pppoa ifconfig .................................................................................................................................................................296
pppoa ifdelete.................................................................................................................................................................300
pppoa ifdetach................................................................................................................................................................301
pppoa iflist.......................................................................................................................................................................302
pppoa rtadd ....................................................................................................................................................................303
pppoa rtdelete ...............................................................................................................................................................305
10
E-DOC-CTC-20040216-0004 v3.0
PPPoE Commands....................................................................................... 307
pppoe flush .....................................................................................................................................................................308
pppoe ifadd .....................................................................................................................................................................309
pppoe ifattach.................................................................................................................................................................311
pppoe ifconfig.................................................................................................................................................................312
pppoe ifdelete ................................................................................................................................................................316
pppoe ifdetach ...............................................................................................................................................................317
pppoe iflist ......................................................................................................................................................................318
pppoe ifscan....................................................................................................................................................................319
pppoe rtadd....................................................................................................................................................................320
pppoe rtdelete .................................................................................................................
pppoe relay add.............................................................................................................................................................323
pppoe relay delete ........................................................................................................................................................324
pppoe relay flush ...........................................................................................................................................................325
pppoe relay portlist ......................................................................................................................................................326
pppoe relay sesslist.......................................................................................................................................................327
..............................................322
PPTP Commands......................................................................................... 329
pptp ifadd ........................................................................................................................................................................330
pptp flush.........................................................................................................................................................................331
pptp list............................................................................................................................................................................332
pptp profadd...................................................................................................................................................................333
pptp profdelete..............................................................................................................................................................335
pptp proflist ....................................................................................................................................................................336
QoSBook Commands .................................................................................. 337
qosbook add...................................................................................................................................................................338
qosbook config ..............................................................................................................................................................340
qosbook delete..............................................................................................................................................................341
qosbook flush.................................................................................................................................................................342
qosbook list ....................................................................................................................................................................343
Script Commands ........................................................................................ 345
script add ........................................................................................................................................................................346
script delete....................................................................................................................................................................347
script flush.......................................................................................................................................................................348
script list..........................................................................................................................................................................349
script run.........................................................................................................................................................................350
E-DOC-CTC-20040216-0004 v3.0
11
SHDSL Commands...................................................................................... 351
shdsl line..........................................................................................................................................................................352
shdsl loopback................................................................................................................................................................353
shdsl stats........................................................................................................................................................................354
shdsl version...................................................................................................................................................................355
shdsl config monitoring................................................................................................................................................356
shdsl config show ..........................................................................................................................................................357
shdsl config side.............................................................................................................................................................358
shdsl config CO annex.................................................................................................................................................359
shdsl config CO margins..............................................................................................................................................360
shdsl config CO rate ....................................................................................................................................................361
shdsl config CO show ..................................................................................................................................................362
shdsl config CPE psd.....................................................................................................................................................363
shdsl config CPE show .................................................................................................................................................364
SNMP Commands........................................................................................ 365
snmp config.....................................................................................................................................................................366
snmp get..........................................................................................................................................................................367
snmp getNext ................................................................................................................................................................368
snmp list ..........................................................................................................................................................................369
snmp walk .......................................................................................................................................................................370
Software Commands ................................................................................... 371
software version............................................................................................................................................................372
software upgrade ..........................................................................................................................................................373
System Commands...................................................................................... 375
system clearpassword ..................................................................................................................................................376
system config..................................................................................................................................................................377
system flush ....................................................................................................................................................................378
system reboot................................................................................................................................................................379
system reset ...................................................................................................................................................................380
system setpassword......................................................................................................................................................381
system stats ....................................................................................................................................................................382
Systemlog Commands................................................................................. 383
12
systemlog flush...............................................................................................................................................................384
systemlog show .............................................................................................................................................................385
systemlog send...............................................................................................................................................................386
E-DOC-CTC-20040216-0004 v3.0
TD Commands ............................................................................................. 387
td call................................................................................................................................................................................388
UPnP Commands......................................................................................... 389
upnp config .....................................................................................................................................................................390
upnp flush........................................................................................................................................................................392
upnp list...........................................................................................................................................................................393
Abbreviations ............................................................................................... 395
Syslog Messages............................................................................................ 399
Auto-PVC Module ........................................................................................................................................................400
Configuration Module ..................................................................................................................................................400
DHCP CLient Module .................................................................................................................................................401
DHCP Relay Module ....................................................................................................................................................401
DHCP Server Module..................................................................................................................................................402
Firewall Module .............................................................................................................................................................402
HTTP Module ................................................................................................................................................................402
Kernel Module ...............................................................................................................................................................403
Linestate Module...........................................................................................................................................................403
Login Module..................................................................................................................................................................403
NAPT Module................................................................................................................................................................403
PPP Module.....................................................................................................................................................................404
PPTP Module..................................................................................................................................................................404
Routing Module .............................................................................................................................................................404
Software Module ...........................................................................................................................................................405
UPnP Module .................................................................................................................................................................405
Supported Key Names ................................................................................ 407
Supported Internet Protocol (IP) Protocol Names ..............................................................................................407
Supported TCP/UDP Port Names............................................................................................................................408
Supported ICMP Type Names ...................................................................................................................................411
Supported Syslog Facilities ..........................................................................................................................................412
Supported Syslog Severities........................................................................................................................................413
E-DOC-CTC-20040216-0004 v3.0
13
14
E-DOC-CTC-20040216-0004 v3.0
About this Document
About this Document
Introduction
Welcome to the SpeedTouch™ Command Line Interface (CLI) Reference Guide!
For the Service Provider, this Reference Guide aims to be a concise and practical document for creating a customized
Service Template file, based on the SpeedTouch™ CLI command set, to be used by the end-user to configure the
SpeedTouch™ and PC(s).
For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch™ via its character based CLI command set.
Applicability
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch™
products:
• SpeedTouch™605s Multi-User SHDSL Gateway (R4.2.7(.2))
For readability, all are referred to as SpeedTouch™ throughout this document unless a specific variant is concerned.
Contents
The Reference Guide consists of two main parts:
• CLI Navigation:
This chapter familiarizes the user with the SpeedTouch™ CLI. It describes general manipulations to navigate
through the CLI and to perform some operations on the CLI.
• CLI Command Description:
The other chapters describe all the available CLI commands of the SpeedTouch™ per command group and in
alphabetical order.
Each command is described in a systematic manner:
• The full name of the CLI command (including the group selection)
• A short description of the CLI command, if necessary completed by a description of the possible impact on
the user and/or the SpeedTouch™
• The syntax of the command with a description of each parameter
• An example to demonstrate the use of the CLI command
• A list of related CLI commands.
E-DOC-CTC-20040216-0004 v3.0
15
About this Document
Trademarks
The following trademarks are used in this document:
• SpeedTouch™ is a trademark of THOMSON Telecom.
• Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
• Windows and Internet Explorer are trademarks of Microsoft Corporation.
• Apple and MacOS are registered trademarks of Apple Computer Inc.
• UNIX is a registered trademark of UNIX System Laboratories, Inc.
• Ethernet is a trademark of Xerox Corporation.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Updates
Due to the continuous evolution of SpeedTouch™ technology, existing products are regularly improved.
For more information on the latest technological innovations, software upgrades, and documents, please visit the
SpeedTouch™ web site at:
www.speedtouch.com
16
E-DOC-CTC-20040216-0004 v3.0
CLI Navigation
CLI Navigation
Introduction
This chapter familiarizes the user with the SpeedTouch™ CLI. It describes general manipulations:
• to navigate through the CLI
• to perform some operations on the CLI.
Contents
This chapter covers the following topics:
Topi c Pag e
Accessing the Command Line Interface 18
Basic Navigation and Manipulation 19
Command Line Interface Top Level Structure 23
Command Line Interface Commands 24
Menu-driven CLI Navigation 25
Service Template Files and the CLI 28
Direct FTP Access 30
E-DOC-CTC-20040216-0004 v3.0
17
CLI Navigation
Accessing the Command Line Interface
Proceed as follows to open a Telnet session:
1 Open a Command Prompt window, e.g. by clicking Start > All Programs > Accessories > Command Prompt.
2 At the prompt, type telnet followed by the IP address of the SpeedTouch™ (default is 10.0.0.138).
As soon a session to the CLI is opened, the SpeedTouch™ banner pops up, followed by the CLI prompt.
If the SpeedTouch™ is protected by a username and a system password, authentication will be required before access is
granted.
The following figure shows an example of the SpeedTouch™605s banner after opening a session and authentication.
Username : johndoe
Password : *******
-----------------------------------------------------------------------*
* ______ SpeedTouch 605s
* ___/_____/\
* / /\\ Version 4.2.7.29.0
* _____/__ / \\
* _/ /\_____/___ \ Copyright (c) 1999-2004,
* // / \ /\ \ THOMSON
* _______//_______/ \ / _\/______
* / /\ \/// /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
*\ \/ /\\\ \/
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/\\/
* \ \ /___\/
* \____\/
*
-----------------------------------------------------------------------=>
18
E-DOC-CTC-20040216-0004 v3.0
CLI Navigation
Basic Navigation and Manipulation
Manipulation commands are commands that manipulate operations on the command line, for example changing the
command group, go to the beginning of the command line, go to the end of the command line, etc.
Command group navigation
From top level, you can change to a command group by executing the name of the desired command group.
To obtain a list of all available command groups, execute help from the top level.
The example below shows every possible CLI command group for the SpeedTouch™605s.
=>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 :
atm autopvc bridge cip config
dhcp dns env eth ethoa
firewall ip ipoa ipqos label
language nat phonebook pppoa pppoe
pptp qosbook script shdsl snmp
software system systemlog td upnp
=>
To return to top level, or to go up one level (in case of nested command groups), enter .. at the prompt.
Example:
=>phonebook
[phonebook]=>
[phonebook]=>..
=>
E-DOC-CTC-20040216-0004 v3.0
19
CLI Navigation
The Help Command
Execute help or ? from top level to list all available commands and command groups for the SpeedTouch™.
Example for the SpeedTouch™605s:
=>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 :
atm autopvc bridge cip config
dhcp dns env eth ethoa
firewall ip ipoa ipqos label
language nat phonebook pppoa pppoe
pptp qosbook script shdsl snmp
software system systemlog td upnp
=>
You can execute the help or ? command from each command group selection. This results in a list of the available
commands (and nested command groups, if available) in this particular command group.
Example:
=>firewall
[firewall]=>
[firewall]=>?
Following commands are available :
tron : Enables verbose console messaging.
troff : Disables verbose console messaging.
match : Defines an ip packet match.
assign : Assign a chain to an entry point.
list : Shows a list of all the hooks with the chain attached.
flush : Clears all hooks. If a hook is provided, that hook is cleared.
Following command groups are available :
chain rule
[firewall]=>
As both help and ? have the exact same functionality in the SpeedTouch™ CLI, the help command may always be equally
replaced by the ? command.
Executing e.g. help firewall from top level gives the same result as executing help from the firewall command group
selection.
20
E-DOC-CTC-20040216-0004 v3.0
CLI Navigation
Example:
=>firewall help
Following commands are available :
assign : Assign a chain to an entry point.
unassign : Clear a specific hook
list : Shows a list of all the hooks with the chains attached.
flush : Clears all hooks, chains and rules
tron : Enables verbose console messaging.
troff : Disables verbose console messaging.
Following command groups are available :
chain rule
=>
Entering help followed by a specific command, e.g. help firewall assign (starting from top level) or help assign (executed
from the firewall command group selection) results in a description of the syntax for the command.
Example:
=>help firewall assign
Assign a chain to an entry point.
Syntax : assign hook = <{input|sink|forward|source|output}> chain = <string>
Parameters :
hook = <{input|sink|forward|source|output}>
Name of hook to assign chain to.
chain = <string>
Name of chain to use.
=>
Executing help all will generate the complete listing of all available CLI commands with syntax description.
Command Completion
The CLI features command completion, which means that when starting to enter a command it can be completed by
pressing the TAB key.
For the completion to be successful, the part to be added must be unique. Completion works for the command groups,
for the commands, for the options, but not for values.
Example:
Pressing a and TAB at the firewall command group selection results in the full assign command being completed. Entering
firewall a and pressing the TAB key from top level gives the same result.
=>firewall
[firewall]=>"a+TAB"
[firewall]=>assign
Command Line Navigation
• Press CTRL+A to go to the beginning of the command line.
• Press CTRL+L to go to the end of the command line.
E-DOC-CTC-20040216-0004 v3.0
21
CLI Navigation
Breaking off Commands
You can break off a command by pressing CTRL+G. This can be useful in a situation where a user is prompted to enter
a value which he does not know and wants to quit the command. Instead of being prompted over and over again for the
same value, this allows to quit the command and return to the command line prompt.
In the example below, CTRL+G is pressed after the third prompt chain =
[firewall]=>match
chain =
chain =
chain = “CTRL+G”
[firewall]=>
History of Commands
Use the UP and DOWN ARROW keys to select a previously executed command. Press ENTER to execute the selected
command.
Example:
=>firewall
[firewall]=>list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
[firewall]=> “UP ARROW”
[firewall]=>:firewall list
22
E-DOC-CTC-20040216-0004 v3.0
Command Line Interface Top Level Structure
The table below shows the available command groups for the different SpeedTouch™ variants:
Command group Available?
atm Yes.
autopvc Yes.
bridge Yes.
cip Yes
config Yes.
dhcp Yes.
dns Yes.
env Yes.
eth Yes.
ethoa Yes.
firewall Yes.
ip Yes.
ipoa Yes.
ipqos Yes.
label Yes.
language Yes.
nat Yes.
phonebook Yes.
pppoa Yes.
pppoe Yes.
pptp Yes.
qosbook Yes.
script Yes.
shdsl Yes.
snmp Yes.
software Yes.
system Yes.
systemlog Yes.
td Yes.
upnp Yes.
CLI Navigation
E-DOC-CTC-20040216-0004 v3.0
23
CLI Navigation
Command Line Interface Commands
Command Execution
All CLI commands are commands that operate on, or configure, the SpeedTouch™ settings.
The CLI commands can be executed:
• from top level, preceded by the name of the command group from which the command should be executed.
E. g. firewall list.
=>firewall list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
=>
• from within the command group itself, using the reduced form of the command.
E.g. list at the firewall command group selection.
=>firewall
[firewall]=>list
assign hook=input chain=input
assign hook=sink chain=sink
assign hook=forward chain=forward
assign hook=source chain=source
[firewall]=>
Note ! in a command means ‘NOT‘, e.g. the [!]syn parameter in the firewall rule create command.
Entering a CLI Command
A CLI command can be entered in one of the following ways:
1 As a completely built-up command with all its parameters.
E.g. the command firewall assign hook=input chain=input.
=>firewall assign hook=input chain=input
=>
2 Just the command itself without its parameters. After pressing Enter, you are prompted to complete the command
with the required and the optional parameters.
The example below is the equivalent of the command firewall assign hook=input chain=input.
=>firewall assign
hook = input
chain = input
=>
• For required CLI command parameter values, either enter a value or scroll through the possible values with
the arrow keys.
• For optional CLI command parameters, either enter a value or simply press Enter without giving a value.
Note This manner of entering a command is not applicable to all the CLI commands.
E.g. system config, upnp config, ...
24
E-DOC-CTC-20040216-0004 v3.0
Menu-driven CLI Navigation
Introduction
To improve the user-friendliness of the SpeedTouch™ CLI, the CLI features a menu-driven interface.
The semi-graphical menu offers an attractive and easy-to-use configuration environment for the CLI.
Calling the menu
To call the menu-driven interface, type menu at the CLI prompt.
Example:
CLI Navigation
Leaving the menu
To leave the menu-driven interface, use the TAB key to go to the Cancel field and press ENTER.
Note This can be done on any level of the menu, i.e. there is no need to return to the top level.
Navigating through the menu
Follow the procedure below to navigate through the menu and select CLI commands:
1 Browse through the CLI command groups with the ARROW keys:
2 Press ENTER to select a command group. The figure below shows the menu after the phonebook command group
has been selected:
E-DOC-CTC-20040216-0004 v3.0
25
CLI Navigation
3 Browse through the CLI commands with the ARROW keys or select .. to go back up one level:
4 Press ENTER to select the command. The figure below shows the menu after the add command has been
selected:
Entering parameter values
1 Browse through the parameters with the ARROW keys:
2 To enter a value for a parameter, press ENTER:
3 Fill in the parameter value and press ENTER:
26
E-DOC-CTC-20040216-0004 v3.0
CLI Navigation
4 Use the ARROW keys to scroll to the next parameter:
5 When all the necessary parameters have been entered, use the TAB key to go to the OK field and press ENTER.
Note Do not forget to save your changes by executing saveall (from any CLI prompt).
Preset parameter values
In case preset values are provided for a parameter, they are shown at the bottom of the menu.
You can scroll through these preset values with the ARROW keys or enter the value manually.
E-DOC-CTC-20040216-0004 v3.0
27
CLI Navigation
Service Template Files and the CLI
Service Template Files
The Service Template files, used by the Setup wizard, or directly uploaded via the SpeedTouch™ web pages, consist of
a set of CLI commands. Only CLI commands, which are part of the SpeedTouch™ CLI command set, may be used in
the .ini and .def files.
For readability, Service Template files are partitioned in paragraphs. These paragraphs reflect a CLI command group
selection in the SpeedTouch™ CLI. However, due to internal processing, not all paragraph names are the same as their
corresponding CLI command group selection, as shown in the table below:
[<configuration>.ini]
paragraphs
[autoip.ini] The ip auto CLI command subgroup
[autopvc.ini] The autopvc CLI command subgroup
[bridge.ini] The bridge CLI command group
[cip.ini] The cip CLI command group
[dhcc.ini] The dhcp client CLI command subgroup
[dhcp.ini] The dhcp server CLI command subgroup
[dhcr.ini] The dhcp relay CLI command subgroup
[diagnostics.ini] The ip ping CLI command
[dnsc.ini] and [dnsd.ini] The dns CLI command group
[env.ini] The env CLI command group
[eth.ini] The eth CLI command group
[ethoa.ini] The ethoa CLI command group
[ip.ini] The ip CLI command group
Available SpeedTouch™ CLI commands
[ipoa.ini] The cip CLI command group
[ipqos.ini] The ipqos CLI command group
[label.ini] The label CLI command group
[language.ini] The language CLI command group
[nat.ini] The nat CLI command group
[oam.ini] The atm oam CLI command subgroup
[pfirewall.ini] The firewall CLI command group
[phone.ini] The phonebook CLI command group
[pppoa.ini] The pppoa CLI command group
[pppoe.ini] The pppoe CLI command group
[pppoerelay.ini] The pppoe relay CLI command subgroup
28
E-DOC-CTC-20040216-0004 v3.0
CLI Navigation
[<configuration>.ini]
Available SpeedTouch™ CLI commands
paragraphs
[pptp.ini] The pptp CLI command group
[qos.ini] The qosbook CLI command group
[script.ini] The script CLI command group
[shdsl.ini] The shdsl CLI command group.
[snmp.ini] The snmp CLI command group
[system.ini] The system CLI command group
[upnp.ini] The upnp CLI command group
CLI Commands in Service Template Files
CLI commands in a paragraph of a Service Template 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 incorrectly configured SpeedTouch™.
In Service Template files, the use of customization variables allow the Setup wizard to invite the end-user to provide
some input regarding the settings of the SpeedTouch™. The declaration of such customization variables must be done
in the [env.ini] paragraph of the Service Template file. A preset (i.e. default) value can be declared for a customization
variable. Further use of these customization variables is allowed through all other paragraphs, even several times.
When a customization variable is used in a CLI command, the value of the variable must always conform to the syntax
of the CLI command.
Customizing Service Template Files
For more information on the customization possibilities of the SpeedTouch™, the Setup wizard and the
configuration profile files, please check the SpeedTouch™ support pages at www.speedtouch.com.
E-DOC-CTC-20040216-0004 v3.0
29
CLI Navigation
Direct FTP Access
The SpeedTouch™ File System
The SpeedTouch™ permanent storage, further referred to as 'file system', exists of nonvolatile memory responsible for
storing, retrieving and maintaining the SpeedTouch™ software image(s), Service Template files and optionally default
settings files.
The file system of the SpeedTouch™ is accessible via the File Transfer Protocol (FTP) transport protocol. This allows to
transfer the SpeedTouch™ software image(s) and/or Service Template files and default settings files.
Proceed as indicated in the example below to open an FTP session to the SpeedTouch™ file system:
/home/doejohn{1}$ftp 10.0.0.138
Connected to 10.0.0.138
220 Inactivity timer = 120 seconds. Use 'site idle <secs>' to change.
Name (10.0.0.138:doejohn):
331 SpeedTouch™ (00-90-D0-01-02-03) User 'doejohn' OK. Password required.
Password : ######
330 OK
ftp>
SpeedTouch™ File System Structure
The files system features a tiny multilevel directory structure with a single root node called 'root' and two leaf nodes
called 'active' and 'dl'. The 'root' contains:
• all the necessary files for the SpeedTouch™ to boot correctly.
• the 'active' subdirectory always contains the software image in execution, i.e. the active software image.
• the 'dl' directory contains the dormant software image, i.e. the passive software image . If you have made changes
to the SpeedTouch™configuration and saved them (be it via a Telnet session, via the web pages or via the Setup
wizard), a user.ini Service Template file is created in the 'dl' subdirectory.
In other words, after each 'Save all', or config save all, the user.ini Service Template file present in the 'dl'
subdirectory reflects the current configuration of the SpeedTouch™.
SpeedTouch™ File System Access Rights
From the ‘root’ directory, you can access the ‘active’ and ‘dl’ subdirectories. No read/write permission is granted for
the ‘root’ directory.
Following access rights apply for the subdirectories:
• for the 'active' subdirectory:
• Listing of 'active' subdirectory files (dir)
• FTP (m)get of (multiple) 'active' subdirectory files
• for the 'dl' subdirectory:
• Listing of 'dl' subdirectory files (dir)
• FTP (m)get of (multiple) 'dl' subdirectory files
• FTP (m)put of (multiple) 'dl' subdirectory files
• FTP (m)delete of (multiple) 'dl' subdirectory files.
30
E-DOC-CTC-20040216-0004 v3.0
FTP File Transfer
To allow correct file transfers, set the transfer mode to “binary”.
Note Turn on the hashing option to see the progression of the file transfer.
Example:
/home/doejohn{1}$ftp 10.0.0.138
Connected to 10.0.0.138
220 Inactivity timer = 120 seconds. Use 'site idle <secs>' to change.
Name (10.0.0.138:doejohn):
331 SpeedTouch™ (00-90-D0-01-02-03) User 'doejohn' OK. Password required.
Password : ######
330 OK
ftp>
ftp>bin
200 TYPE is now 8-bit binary
ftp>
ftp>hash
200Hash mark printing on (8192 bytes/hash mark).
ftp>
CLI Navigation
Quote Site Command
All the CLI commands can be executed from within an FTP session. Only complete CLI commands (i.e. the complete
command syntax with all the parameters already specified) can be executed.
Example:
To execute the ‘firewall list’ command, type the following at the FTP prompt:
ftp> quote site firewall list
200- :firewall assign hook=input chain=None
200- :firewall assign hook=sink chain=sink
200- :firewall assign hook=forward chain=forward
200- :firewall assign hook=source chain=source
200- :firewall assign hook=output chain=None
200200 CLI command "firewall list" executed
ftp>
E-DOC-CTC-20040216-0004 v3.0
31
CLI Navigation
32
E-DOC-CTC-20040216-0004 v3.0
ATM Commands
ATM Commands
Contents
This chapter covers the following commands:
Topi c Pag e
atm oam ccconfig 34
atm oam cclist 35
atm oam ccsend 36
atm oam config 37
atm oam mode 38
atm oam ping 39
atm oam status 40
E-DOC-CTC-20040216-0004 v3.0
33
ATM Commands
atm oam ccconfig
Configure Operation and Maintenance (OAM) Continuity Check (CC) on the connection.
SYNTAX:
atm oam ccconfig port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
vpi = <number{0-15}>
[vci = <number{0-511}>]
[transmit = <{disabled|enabled}>]
[receive = <{disabled|enabled}>]
[auto = <{disabled|enabled}>]
[span = <{segment|end2end}>]
where:
port The ATM port number.
Choose between:
• DSL0
• DSL1
• ATM 2
• ATM 3
• AAL5
• ATM 5.
Or specify a port number (dsl0 has port number 0, ..., atm5 has port
number 5).
vpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI)
vci A number between 0 and 511.
Represents the Virtual Channel identifier (VCI).
For a VP cross-connection, use VCI=0 or do not specify.
transmit Enable or disable transmission of CC cells.
The default is disabled.
receive Enable or disable loss of continuity.
The default is disabled.
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
OPTIONAL
auto Enable or disable remote CC activation and deactivation.
The default is disabled.
span End2end or segment continuity check. OPTIONAL
RELATED COMMANDS:
atm oam cclist Show current CC configuration.
atm oam ccsend Send CC activate/deactivate to connection.
34
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
atm oam cclist
Show current OAM CC configuration.
SYNTAX:
atm oam cclist
EXAMPLE (default configuration):
=>atm oam cclist
PORT = 0 VPI = 15 VCI = 64 End2End Mode = Auto Segment Mode = Auto
PORT = 0 VPI = 15 VCI = 16 End2End Mode = Auto Segment Mode = Auto
PORT = 0 VPI = 0 VCI = 16 End2End Mode = Auto Segment Mode = Auto
=>
ATM Commands
RELATED COMMANDS:
atm oam ccconfig Configure CC on the connection.
atm oam ccsend Send CC activate/deactivate to connection.
E-DOC-CTC-20040216-0004 v3.0
35
ATM Commands
atm oam ccsend
Send CC activate/deactivate to connection.
SYNTAX:
atm oam ccsend port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
vpi = <number{0-15}>
[vci = <number{0-511}>]
[span = <{segment|end2end}>]
[action = <{activate|deactivate}>]
[direction = <{source|sink|both}>]
where:
port The ATM port number.
Choose between:
• DSL0
• DSL1
• ATM 2
• ATM 3
• AAL5
• ATM 5.
Or specify a port number (dsl0 has port number 0, ..., atm5 has port
number 5).
vpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI).
vci A number between 0 and 511.
Represents the Virtual Channel identifier (VCI).
For a VP cross-connection, use VCI=0 or do not specify.
span End2end or segment continuity check. OPTIONAL
action Enable or disable CC.
The default is disabled.
direction Indicates the direction of CC activity. Select either:
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
OPTIONAL
• source
• sink
• both.
If not specified, CC is activated/deactivated for both directions.
RELATED COMMANDS:
atm oam ccconfig Configure CC on the connection.
atm oam cclist Show current CCconfiguration.
36
E-DOC-CTC-20040216-0004 v3.0
atm oam config
Configure OAM cell settings.
SYNTAX:
atm oam config [clp = <number{0-1}>]
[loopbackid = <string>]
where:
ATM Commands
clp The CLP bit value of the OAM cells.
Choose between:
• 0
• 1.
loopbackid The loopback id (hexadecimal string) for processing of segment
loopback cells.
The default is 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a.
OPTIONAL
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
37
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}>
where:
port The port for which OAM blocking is configured.
Choose between:
• DSL0
• DSL1
• ATM 2
• ATM 3
• AAL5
• ATM 5
Or specify a port number (dsl0 has port number 0, ..., atm5 has port
number 5).
blocking Enable or disable the OAM data blocking mode on this port.
The default is enabled.
REQUIRED
REQUIRED
38
E-DOC-CTC-20040216-0004 v3.0
atm oam ping
Sends ATM loopback cells.
SYNTAX:
atm oam ping dest = <string>
[count = <number{1-1000000}>]
[interval = <number{100-1000000}>]
where:
ATM Commands
dest The destination address for the request.
Can be any phonebook entry.
count A number between 1 and 1000000.
Represents the number of pings to send.
interval A number between 100 and 1000000 (milliseconds).
Represents the interval between packets.
EXAMPLE:
=>atm oam ping dest=Sascha count=10 interval=200
loopback: successful, sequence: 1 time: 7762 usec
loopback: successful, sequence: 2 time: 8239 usec
loopback: successful, sequence: 3 time: 11100 usec
loopback: successful, sequence: 4 time: 9384 usec
loopback: successful, sequence: 5 time: 7209 usec
loopback: successful, sequence: 6 time: 20008 usec
loopback: successful, sequence: 7 time: 9651 usec
loopback: successful, sequence: 8 time: 9593 usec
loopback: successful, sequence: 9 time: 8411 usec
loopback: successful, sequence: 10 time: 41656 usec
--- loopback statistics --10 loopbacks transmitted, 10 successful, 0% loss, time 600 ms
rtt min/avg/max = 7209/13301/41656
=>
REQUIRED
OPTIONAL
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
39
ATM Commands
atm oam status
Show OAM data blocking mode of all ports.
SYNTAX:
atm oam status
EXAMPLE:
=>atm oam status
OAM config dump
------------------CLP bit value : 1
Loopbackid :6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a
OAM data blocking mode
--------------------------
=>
Port dsl0: blocking
Port dsl1: blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking
40
E-DOC-CTC-20040216-0004 v3.0
AutoPVC Commands
AutoPVC Commands
Contents
This chapter covers the following commands:
Topi c Pag e
autopvc config 42
autopvc info 44
E-DOC-CTC-20040216-0004 v3.0
41
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}>]
where:
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.
• 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.
The default is passive.
type Type of autopvc:
• bridge
• 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
OPTIONAL
The default is bridge.
opmode Operational autopvc mode:
• partial: only read the ILMI VPC and VCC MIB tables
• full: read all supported MIB tables.
The default is partial.
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.
42
OPTIONAL
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
EXAMPLE:
=>autopvc config
Autopvc mode : passive
Autopvc opmode : partial
Autopvc type : bridge
Autopvc standard: unknown
Autopvc pseudo : unknown
UBR overwrite : enabled
UBR peak rate : linerate
=>
RELATED COMMANDS:
autopvc info Show retrieved information.
AutoPVC Commands
E-DOC-CTC-20040216-0004 v3.0
43
AutoPVC Commands
autopvc info
Show retrieved information.
SYNTAX:
autopvc info [table = <{Vpc|Vcc}>]
where:
table Choose the autopvc table for which the information must be shown.
Choose between:
• Vpc
• Vcc.
EXAMPLE (default configuration):
=>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
=>
RELATED COMMANDS:
autopvc config Configure autopvc.
OPTIONAL
44
E-DOC-CTC-20040216-0004 v3.0
Bridge Commands
Bridge Commands
Contents
This chapter covers the following commands:
Topi c Pag e
bridge config 46
bridge flush 47
bridge ifadd 48
bridge ifattach 49
bridge ifconfig 50
bridge ifdelete 52
bridge ifdetach 53
bridge iflist 54
bridge macadd 55
bridge macdelete 56
bridge maclist 57
E-DOC-CTC-20040216-0004 v3.0
45
Bridge Commands
bridge config
Show/set bridge ageing policy for dynamically learned Medium Access Control (MAC) addresses.
SYNTAX:
bridge config [age = <number {10 - 100000}>]
[filter = <{no_WAN_broadcast|PPPoE_only|none}>]
where:
age A number between 10 and 100000 (seconds).
Represents the lifetime of a dynamically learned MAC address.
The default is 300.
filter The bridge filter to be applied for all WAN bridge ports.
Choose between:
• no_WAN_broadcast:
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.
The default is no_WAN_broadcast.
EXAMPLE:
=>bridge config
Ageing : 300
Filter : no_WAN_broadcast
=>bridge config age=600
=>bridge config
Ageing : 600
Filter : no_WAN_broadcast
=>
OPTIONAL
OPTIONAL
RELATED COMMANDS:
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.
46
E-DOC-CTC-20040216-0004 v3.0
bridge flush
Flush bridge interfaces and parameters.
Note The flush command does not impact previously saved configurations.
SYNTAX:
bridge flush
Bridge Commands
E-DOC-CTC-20040216-0004 v3.0
47
Bridge Commands
bridge ifadd
Create a bridged Ethernet interface.
SYNTAX:
bridge ifadd [intf = <intfname>]
[dest = <string>]
where:
intf The bridged Ethernet interface name.
If not specified, the destination name will double as interface name.
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.
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82843610 frames: 341554 dropframes: 0
ethport1 : Internal
Connection State: connected
Port: ethport1 PortNr: 1 PortState: forwarding
RX bytes: 156472129 frames: 5903256
TX bytes: 75689 frames: 425 dropframes: 5561702
=>bridge ifadd intf=TestBridge
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82843610 frames: 341554 dropframes: 0
OPTIONAL
OPTIONAL
...
TestBridge: dest : (none)
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
=>
RELATED COMMANDS:
bridge ifattach Attach a bridge interface.
bridge ifconfig Configure a bridge interface.
bridge ifdelete Delete a bridge interface.
bridge ifdetach Detach a bridge interface.
bridge iflist Show current bridge configuration.
48
E-DOC-CTC-20040216-0004 v3.0
bridge ifattach
Attach (i.e. connect) a bridged Ethernet interface.
SYNTAX:
bridge ifattach intf = <intfname>
where:
Bridge Commands
intf The name of the interface to attach.
Browse through the available entries via the ARROW UP and
ARROW DOWN keys.
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82843610 frames: 341554 dropframes: 0
ethport1 : Internal
Connection State: connected
Port: ethport1 PortNr: 1 PortState: forwarding
RX bytes: 156472129 frames: 5903256
TX bytes: 75689 frames: 425 dropframes: 5561702
TestBridge: dest : (none)
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
=>bridge ifattach intf=TestBridge
=>bridge iflist
OBC : Internal
Connection State: connected Port: OBC PortState: forwarding
REQUIRED
...
TestBridge: dest : TestBridge
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 5 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
=>
RELATED COMMANDS:
bridge ifadd Create a bridged Ethernet interface.
bridge ifconfig Configure a bridge interface.
bridge ifdelete Delete a bridge interface.
bridge ifdetach Detach a bridge interface.
bridge iflist Show current bridge configuration.
E-DOC-CTC-20040216-0004 v3.0
49
Bridge Commands
bridge ifconfig
Configure a bridge interface.
SYNTAX:
bridge ifconfig intf = <intfname>
[dest = <string>]
[qos = <string>]
[encaps = <{llc/snap|vcmux}>]
[fcs = <{off|on}>]
[portstate = <{disabled|learning|forwarding}>]
[retry = <number {0-65535}>]
where:
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.
qos The name of the Quality Of Service (QoS) book entry to apply on
this bridge interface.
encaps The type of encapsulation to be used for this bridge interface.
Choose between:
• llc/snap
• vcmux.
fcs Whether or not to include the Ethernet FCS in the packet header on
the WAN side. Choose between:
• off
• on.
The default is off.
Note FCS is normally left off.
portstate The bridge portstate for this interface.
Choose between:
• disabled
• learning
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
• forwarding.
retry A number between 0 and 65535.
Represents the number of times the SpeedTouch™ retries to set up
a WAN connection before giving up.
The default is 10.
50
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
EXAMPLE:
=>bridge iflist intf=TestBridge
TestBridge: dest : TestBridge
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 5 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
=>bridge ifconfig intf=TestBridge encaps=vcmux retry=15
=>bridge iflist intf=TestBridge
TestBridge: dest : TestBridge
Retry : 15 QoS : default Encaps : vcmux Fcs : off
Connection State: connected
Port: wan0 PortNr: 5 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
=>
RELATED COMMANDS:
Bridge Commands
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.
E-DOC-CTC-20040216-0004 v3.0
51
Bridge Commands
bridge ifdelete
Delete a bridge interface.
SYNTAX:
bridge ifdelete intf = <intfname>
where:
intf The name of the interface name to be deleted.
Browse through the available entries via the ARROW UP and
ARROW DOWN keys.
EXAMPLE:
=>bridge ifdelete intf=TestBridge
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82843610 frames: 341554 dropframes: 0
ethport1 : Internal
Connection State: connected
Port: ethport1 PortNr: 1 PortState: forwarding
RX bytes: 156472129 frames: 5903256
TX bytes: 75689 frames: 425 dropframes: 5561702
=>
RELATED COMMANDS:
REQUIRED
bridge ifadd Create a bridged Ethernet interface.
bridge ifattach Attach a bridge interface.
bridge ifconfig Configure a bridge interface.
bridge ifdetach Detach a bridge interface.
bridge iflist Show current bridge configuration.
52
E-DOC-CTC-20040216-0004 v3.0
bridge ifdetach
Detach (i.e. disconnect) a bridge interface.
SYNTAX:
bridge ifdetach intf = <intfname>
where:
Bridge Commands
intf The name of the bridge interface to be detached.
Browse through the available entries via the ARROW UP and
ARROW DOWN keys.
EXAMPLE:
=>bridge iflist intf=TestBridge
TestBridge: dest : TestBridge
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 5 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
=>bridge ifdetach intf=TestBridge
=>bridge iflist intf=TestBridge
TestBridge: dest : TestBridge
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
=>
RELATED COMMANDS:
bridge ifadd Create a bridged Ethernet interface.
REQUIRED
bridge ifattach Attach a bridge interface.
bridge ifconfig Configure a bridge interface.
bridge ifdelete Delete a bridge interface.
bridge iflist Show current bridge configuration.
E-DOC-CTC-20040216-0004 v3.0
53
Bridge Commands
bridge iflist
Show the current state of all or the selected bridge interfaces.
SYNTAX:
bridge iflist [intf = <intfname>]
where:
intf The name of the bridge interface for which the configuration must be
shown. Browse through the available entries via the ARROW UP and
ARROW DOWN keys.
If no interface is specified, all bridge interfaces are shown.
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 75783 frames: 572
TX bytes: 82843610 frames: 341554 dropframes: 0
ethport1 : Internal
Connection State: connected
Port: ethport1 PortNr: 1 PortState: forwarding
RX bytes: 156472129 frames: 5903256
TX bytes: 75689 frames: 425 dropframes: 5561702
TestBridge: dest : TestBridge
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 5 PortState: forwarding
RX bytes: 83 frames: 13
TX bytes: 30740 frames: 341554 dropframes: 0
=>
OPTIONAL
DESCRIPTION:
RX bytes The number of Received bytes.
TX bytes The number of Transmitted bytes.
OBC On Board Controller: indicates the physical bridge port.
RELATED COMMANDS:
bridge ifadd Create a bridged Ethernet interface.
bridge ifattach Attach a bridge interface.
bridge ifconfig Configure a bridge interface.
bridge ifdelete Delete a bridge interface.
bridge ifdetach Detach a bridge interface.
54
E-DOC-CTC-20040216-0004 v3.0
Bridge Commands
bridge macadd
Add a static MAC address to the filtering database.
This command allows to manually add static addresses, which should normally be dynamically discovered by the bridge
itself.
SYNTAX:
bridge macadd intf = <intfname>
hwaddr = <hardware-address>
where:
intf The name of the bridge interface for which the MAC address must be
REQUIRED
added.
hwaddr The Ethernet MAC address of the new entry. REQUIRED
EXAMPLE:
=>bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1, 300 seconds
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
...
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>bridge macadd intf=ethport2 hwaddr=00:80:9f:01:23:45
=>bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1, 300 seconds
00:80:9f:01:23:45 -- static
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>
RELATED COMMANDS:
bridge macdelete Delete a MAC address entry.
bridge maclist Show current filtering database.
E-DOC-CTC-20040216-0004 v3.0
55
Bridge Commands
bridge macdelete
Remove a MAC address from the filtering database.
SYNTAX:
bridge macdelete hwaddr = <hardware-address>
where:
hwaddr The Ethernet MAC address of the entry which must be deleted. REQUIRED
EXAMPLE:
=>bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1
00:80:9f:01:23:45 -- static
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
...
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>bridge macdelete hwaddr=00:80:9f:01:23:45
=>bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>
RELATED COMMANDS:
bridge macadd Add a static MAC address to the filtering database.
bridge maclist Show current filtering database.
56
E-DOC-CTC-20040216-0004 v3.0
bridge maclist
Show the current MAC address filtering database.
SYNTAX:
bridge maclist
EXAMPLE:
=>bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1, 300 seconds
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
01:80:c2:00:00:04 -- permanent
01:80:c2:00:00:05 -- permanent
01:80:c2:00:00:06 -- permanent
01:80:c2:00:00:07 -- permanent
01:80:c2:00:00:08 -- permanent
01:80:c2:00:00:09 -- permanent
01:80:c2:00:00:0a -- permanent
01:80:c2:00:00:0b -- permanent
01:80:c2:00:00:0c -- permanent
01:80:c2:00:00:0d -- permanent
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>
Bridge Commands
RELATED COMMANDS:
bridge macadd Add a static MAC address to the filtering database.
bridge macdelete Delete a MAC address entry.
E-DOC-CTC-20040216-0004 v3.0
57
Bridge Commands
58
E-DOC-CTC-20040216-0004 v3.0
CIP Commands
CIP Commands
Contents
This chapter covers the following commands:
Topi c Pag e
cip flush 60
cip ifadd 61
cip ifdelete 62
cip iflist 63
cip pvcadd 64
cip pvcdelete 65
cip pvclist 66
E-DOC-CTC-20040216-0004 v3.0
59
CIP Commands
cip flush
Flush complete Classical IP over ATM (IP oA) configuration.
Note The flush command does not impact previously saved configurations.
SYNTAX:
cip flush
60
E-DOC-CTC-20040216-0004 v3.0
CIP Commands
cip ifadd
Create a Classical IP oA interface at the local side of the Logical IP Subnet (LIS).
SYNTAX:
cip ifadd addr = <ip-address>
[netmask = <ip-mask (dotted or cidr)>]
[uniaddr = <portspec:address[.selector]>]
where:
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.
Note This parameter is 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.
EXAMPLE:
=>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
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
cip0 addr = 172.16.1.1 mask = 255.255.255.0
UNI address = A0:*.03
inarp_reqs_in = 0 inarp_repl_in = 0 inarp_inv_in = 0
inarp_reqs_out = 0 inarp_repl_out = 0 inarp_inv_out = 0
=>
OPTIONAL
RELATED COMMANDS:
cip ifdelete Delete a Classical IP oA interface.
cip iflist Show current Classical IP oA configuration.
E-DOC-CTC-20040216-0004 v3.0
61
CIP Commands
cip ifdelete
Delete a Classical IP oA interface at the local side of the LIS.
SYNTAX:
cip ifdelete addr = <ip-address>
where:
addr The Classical IP oA interface's local IP address in the LIS. REQUIRED
EXAMPLE:
=>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
=>
UNI address = A0:*.03
inarp_reqs_in = 0 inarp_repl_in = 0 inarp_inv_in = 0
inarp_reqs_out = 0 inarp_repl_out = 0 inarp_inv_out = 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
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
RELATED COMMANDS:
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.
62
E-DOC-CTC-20040216-0004 v3.0
cip iflist
Show current Classical IP oA configuration.
SYNTAX:
cip iflist
EXAMPLE:
=>cip iflist
cip0 addr = 172.16.1.1 mask = 255.255.255.0
UNI address = A0:*.03
inarp_reqs_in = 0 inarp_repl_in = 0 inarp_inv_in = 0
inarp_reqs_out = 0 inarp_repl_out = 0 inarp_inv_out = 0
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 Commands
DESCRIPTION:
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.
EXAMPLE INPUT/OUTPUT: EVOLUTION OF ARP REQUESTS IN A NETWORKED ENVIRONMENT:
=>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
=>
UNI address = A0:*.03
inarp_reqs_in = 18 inarp_repl_in = 75 inarp_inv_in = 0
inarp_reqs_out = 18 inarp_repl_out = 75 inarp_inv_out = 0
UNI address = A0:*.03
inarp_reqs_in = 22 inarp_repl_in = 75 inarp_inv_in = 0
inarp_reqs_out = 22 inarp_repl_out = 75 inarp_inv_out = 0
UNI address = A0:*.03
inarp_reqs_in = 22 inarp_repl_in = 76 inarp_inv_in = 0
inarp_reqs_out = 22 inarp_repl_out = 76 inarp_inv_out = 0
RELATED COMMANDS:
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.
E-DOC-CTC-20040216-0004 v3.0
63
CIP Commands
cip pvcadd
Create a PVC Address Resolution Protocol (ARP) entry for destinations which are not RFC1577/RFC2225 compliant.
SYNTAX:
cip pvcadd dest = <phonebook name>
[destaddr = <ip-address>]
[mtu = <number {273-20000}>]
where:
dest The ATM address (hardware address) of the destination host.
Typically a phonebook name.
destaddr The IP address of the destination host
Typically for destinations without Inverse ATMARP support.
mtu A number between 273 and 20000.
Represents the maximum ATM Adaption Layer 5 (AAL5) packet size
(in bytes) for this connection.
The default is 9180 bytes.
EXAMPLE:
=>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
RELAY_PPP2 ppp 0 8.49
RELAY_PPP3 ppp 0 8.50
RELAY_PPP4 ppp 0 8.51
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
=>
REQUIRED
OPTIONAL
OPTIONAL
RELATED COMMANDS:
cip pvcdelete Delete a PVC ARP entry.
cip pvclist Show current PVC ARP entries.
64
E-DOC-CTC-20040216-0004 v3.0
cip pvcdelete
Delete a PVC ARP entry.
SYNTAX:
cip pvcdelete dest = <phonebook name>
where:
CIP Commands
dest Typically a phonebook entry name.
Represents the ATM address (hardware address) or name of the
entry to be deleted.
EXAMPLE:
=>cip pvclist
CIPPVC1 atmport = 0 vpi = 8 vci = 80 dest_ip = 172.16.1.2
encaps = llc mtu = 546
=>cip pvcdelete dest=CIPPVC1
=>cip pvclist
=>
RELATED COMMANDS:
cip pvcadd Create a PVC ARP entry.
cip pvclist Show current PVC ARP entries.
REQUIRED
E-DOC-CTC-20040216-0004 v3.0
65
CIP Commands
cip pvclist
Show current PVC ARP entries.
SYNTAX:
cip pvclist
EXAMPLE:
=>cip pvclist
CIPPVC1 atmport = 0 vpi = 8 vci = 80 dest_ip = 172.16.1.2
=>
EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
encaps = llc mtu = 546
=>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
=>
UNI address = A0:*.03
inarp_reqs_in = 0 inarp_repl_in = 75 inarp_inv_in = 0
inarp_reqs_out = 0 inarp_repl_out = 75 inarp_inv_out = 0
encaps = llc mtu = 9180
encaps = llc mtu = 9180
RELATED COMMANDS:
cip pvcadd Create a PVC ARP entry.
cip pvcdelete Delete a PVC ARP entry.
66
E-DOC-CTC-20040216-0004 v3.0
Config Commands
Config Commands
Contents
This chapter covers the following commands:
Topi c Pag e
config backup 68
config dump 69
config erase 70
config flush 71
config list 72
config load 73
config save 75
E-DOC-CTC-20040216-0004 v3.0
67
Config Commands
config backup
Store current configuration to backup file.
SYNTAX:
config backup filename = <user configuration filename>
where:
filename Filename for backup file of current configuration. REQUIRED
RELATED COMMANDS:
config dump Show the saved configuration file.
config list Save complete runtime configuration.
68
E-DOC-CTC-20040216-0004 v3.0
config dump
Show the saved configuration file.
SYNTAX:
config dump
RELATED COMMANDS:
config backup Store current configuration to backup file.
config list Load complete saved or default configuration.
Config Commands
E-DOC-CTC-20040216-0004 v3.0
69
Config Commands
config erase
Erase a user configuration file.
Note If no filename is specified, all the user configuration files, saved in the SpeedTouch™ permanent storage, are
deleted.
SYNTAX:
config erase [filename = <user configuration filename>]
where:
filename Name of the configuration file to erase. OPTIONAL
RELATED COMMANDS:
config flush Flush complete runtime configuration.
config load Load complete saved or default configuration.
config save Save complete runtime configuration.
70
E-DOC-CTC-20040216-0004 v3.0
Config Commands
config flush
Flush complete current configuration without affecting saved configurations.
This flush command 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, pppoe relay flush, pptp flush, qosbook flush, script flush, system flush, systemlog flush
and upnp flush.
SYNTAX:
config flush [flush_ip = <{no|yes}>]
where:
flush_ip Flush IP settings (yes) or not (no).
The default is no.
Note Not keeping the IP settings could cause lost IP connectivity in
the LAN.
EXAMPLE:
=>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
Destination Source Gateway Intf Mtrc
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 ##########
OPTIONAL
RELATED COMMANDS:
config erase Erase a user configuration file.
config load Load complete saved or default configuration.
config save Save current runtime configuration.
E-DOC-CTC-20040216-0004 v3.0
71
Config Commands
config list
Show the current configuration set.
SYNTAX:
config list [templates = <{no|yes}>]
where:
templates List the template files (yes) or not (no)
The default is no.
EXAMPLE:
=>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
=>
RELATED COMMANDS:
config backup Store current configuration to backup file.
config dump Show the saved configuration file.
OPTIONAL
72
E-DOC-CTC-20040216-0004 v3.0
config load
Load complete saved (backup) or default configuration file.
Note Use the command config flush before using the command config load.
Config Commands
E-DOC-CTC-20040216-0004 v3.0
73
Config Commands
SYNTAX:
config load [load_ip = <{no|yes}>]
[defaults = <{yes|no}>]
[flush = <{yes|no}>]
[echo = <{no|yes}>]
[filename = <string>]
where:
load_ip Load IP settings (yes) or not (no).
OPTIONAL
Note Not keeping the IP settings could cause lost IP connectivity in
the LAN.
defaults Load default configuration (yes) or saved configuration (no).
OPTIONAL
Note If this parameter is not specified, the saved configuration will
be loaded.
flush Flush the current configuration before loading a new configuration (yes)
OPTIONAL
or not (no).
echo Echo each command string when loaded (yes) or not (no). OPTIONAL
filename Configuration filename. OPTIONAL
EXAMPLE:
=>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
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>config flush flush_ip=no
=>ip rtlist
Destination Source Gateway Intf Mtrc
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
=>config load flush=yes
=>ip rtlist
Destination Source Gateway Intf Mtrc
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
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>
RELATED COMMANDS:
config erase Erase a user configuration file.
config flush Flush complete runtime configuration.
config save Save current runtime configuration.
74
E-DOC-CTC-20040216-0004 v3.0
Config Commands
config save
Save the current configuration, i.e. 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:
config save
RELATED COMMANDS:
config erase Erase a user configuration file.
config flush Flush complete runtime configuration.
config load Load complete saved or default configuration.
E-DOC-CTC-20040216-0004 v3.0
75
Config Commands
76
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands
DHCP Commands
Contents
This chapter covers the following commands
Topi c Pag e
dhcp client clear 79
dhcp client config 80
dhcp client flush 81
dhcp client ifadd 82
dhcp client ifattach 83
dhcp client ifconfig 84
dhcp client ifdelete 86
dhcp client iflist 87
dhcp client ifrelease 88
dhcp client ifrenew 91
dhcp client stats 94
dhcp relay add 95
dhcp relay config 96
dhcp relay delete 97
dhcp relay flush 98
dhcp relay ifconfig 99
dhcp relay iflist 100
dhcp relay list 101
dhcp relay stats 102
dhcp server clear 103
dhcp server config 104
dhcp server flush 105
dhcp server policy 106
dhcp server stats 107
dhcp server lease add 109
dhcp server lease delete 111
dhcp server lease flush 112
E-DOC-CTC-20040216-0004 v3.0
77
DHCP Commands
Topi c Pag e
dhcp server lease list 113
dhcp server pool add 114
dhcp server pool config 115
dhcp server pool delete 117
dhcp server pool flush 118
dhcp server pool list 119
78
E-DOC-CTC-20040216-0004 v3.0
dhcp client clear
Clear Dynamic Host Configuration Protocol (DHCP) client statistics.
SYNTAX:
dhcp client clear
EXAMPLE:
=>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
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 : 0
REQUESTs sent : 0
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 Commands
RELATED COMMANDS:
dhcp client stats Show DHCP client statistics.
E-DOC-CTC-20040216-0004 v3.0
79
DHCP Commands
dhcp client config
Show/set DHCP client configuration.
SYNTAX:
dhcp client config [trace = <{off|on}>]
where:
trace Enable tracing (on) or not (off). OPTIONAL
EXAMPLE:
=>dhcp client config
tracing: off
=>dhcp client config trace=on
=>dhcp client config
tracing: on
=>
RELATED COMMANDS:
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
80
E-DOC-CTC-20040216-0004 v3.0
dhcp client flush
Flush complete DHCP client configuration and dynamic interfaces.
Note The flush command does not impact previously saved configurations.
SYNTAX:
dhcp client flush
EXAMPLE:
=>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
=>dhcp client iflist
No dynamic interfaces defined.
=>
DHCP Commands
E-DOC-CTC-20040216-0004 v3.0
81
DHCP Commands
dhcp client ifadd
Create a DHCP lease for a specific interface.
SYNTAX:
dhcp client ifadd intf = <interface name>
where:
intf The name of the dynamic interface to be created. REQUIRED
EXAMPLE:
=>dhcp client iflist
No dynamic interfaces defined.
=>dhcp client ifadd intf=NewEthoa
=>dhcp client iflist
NewETHoA : [INIT]
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
RELATED COMMANDS:
dhcp client ifattach Attach a DHCP lease to an interface.
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
dhcp client ifdelete Delete a dynamic interface.
dhcp client iflist Show all dynamic interfaces.
82
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands
dhcp client ifattach
Attach a DHCP lease to a dynamic interface.
Note Create the interface first with the command dhcp client ifadd.
SYNTAX:
dhcp client ifattach intf = <interface name>
where:
intf The name of the dynamic interface to be attached. REQUIRED
EXAMPLE:
=>dhcp client iflist
NewETHoA : [INIT]
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>dhcp client ifattach intf=NewETHoA
=>dhcp client iflist
NewETHoA : [SELECTING]
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>
DHCP server : 255.255.255.255
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
RELATED COMMANDS:
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
dhcp client ifrelease Release a lease attached to a dynamic interface.
dhcp client iflist Show all dynamic interfaces.
E-DOC-CTC-20040216-0004 v3.0
83
DHCP Commands
dhcp client ifconfig
Show/set the configuration of DHCP lease created for a specific interface.
Note Use the command dhcp client ifrelease 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}>]
where:
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.
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.
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.
The default is 7200 (2 hours).
Note Specifying -1 makes the lease permanent.
addrtrans Automatically enable address translation for this dynamic interface
(pat) or not (none).
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.
The default is 1.
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
dnsmetric A number between 0 and 100.
Represents the DNS route metric.
The default is 1.
84
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
EXAMPLE:
=>dhcp client iflist
NewETHoA : [INIT]
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
Number of leases: 1
Total size of table: 19, in use: 1, free: 4 %
=>dhcp client ifconfig intf=NewETHoA hostname=NewLease addr=10.0.0.10 leasetime=10800
=>dhcp client iflist
NewETHoA : [INIT]
flags= uc
IP address : 10.0.0.10
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime = 10800 s
Number of leases: 1
Total size of table: 19, in use: 1, free: 4 %
=>
DHCP Commands
RELATED COMMANDS:
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifdelete Delete a dynamic interface.
dhcp client iflist Show all dynamic interfaces.
dhcp client ifrelease Release a lease attached to a dynamic interface.
E-DOC-CTC-20040216-0004 v3.0
85
DHCP Commands
dhcp client ifdelete
Delete a dynamic interface.
SYNTAX:
dhcp client ifdelete intf = <interface name>
where:
intf The name of the dynamic interface to be deleted. REQUIRED
EXAMPLE:
=>dhcp client iflist
NewETHoA : [SELECTING]
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>dhcp client ifdelete intf NewETHoA
=>dhcp client iflist
No dynamic interfaces defined.
=>
flags= uc
IP address : 10.0.0.10
HW address : 00: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
RELATED COMMANDS:
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifattach Attach a DHCP lease to an interface.
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
dhcp client iflist Show all dynamic interfaces.
dhcp client ifrelease Release a lease attached to a dynamic interface.
86
E-DOC-CTC-20040216-0004 v3.0
dhcp client iflist
Show all dynamic interfaces.
SYNTAX:
dhcp client iflist
EXAMPLE:
=>dhcp client iflist
NewETHoA : [INIT]
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>
DHCP Commands
EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
The SpeedTouch™ is configured as DHCP client on its Ethernet interface eth0.
=>dhcp client iflist
eth0 : [BOUND]
Number of leases: 1
Total size of table: 18, in use: 1, free: 94 %
=>dhcp client iflist
eth0 : [BOUND]
Number of leases: 1
Total size of table: 18, in use: 1, free: 94 %
=>
flags= uc
IP address : 10.0.0.3
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
flags= uc
IP address : 10.0.0.3
HW address : 00:90:d0:01:47:f1
DHCP server : 10.10.1.1
lease renewal in 5 days, 1 h, 25 min, 27 sec
lease rebinding in 8 days, 20 h, 32 min, 57 sec
lease expires in 10 days, 2 h, 55 min, 27 sec
RELATED COMMANDS:
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifdelete Delete a dynamic interface.
E-DOC-CTC-20040216-0004 v3.0
87
DHCP Commands
dhcp client ifrelease
Release a lease attached to a dynamic interface.
SYNTAX:
dhcp client ifrelease intf = <interface name>
where:
intf The name of the dynamic interface. REQUIRED
88
E-DOC-CTC-20040216-0004 v3.0
EXAMPLE:
=>dhcp client iflist
NewETHoA : [SELECTING]
flags= uc
IP address : 10.0.0.10
HW address : 00: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 ifattach intf=NewETHoA
=>dhcp client iflist
NewETHoA : [SELECTING]
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime = 10800 s
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>
DHCP Commands
EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
E-DOC-CTC-20040216-0004 v3.0
89
DHCP Commands
The SpeedTouch™ is configured as DHCP client on its Ethernet interface eth0.
=>dhcp client iflist
eth0 : [BOUND]
Number of leases: 1
Total size of table: 18, in use: 1, free: 94 %
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv : 0
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 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
DHCP client statistics:
Corrupted packet recv : 0
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 19, in use: 1, free: 94 %
=>
flags= uc
IP address : 10.0.0.3
HW address : 00:90:d0:01:47:f1
DHCP server : 10.10.1.1
lease renewal in 5 days, 58 min, 45 sec
lease rebinding in 8 days, 20 h, 6 min, 18 sec
lease expires in 10 days, 2 h, 28 min, 48 sec
RELATED COMMANDS:
dhcp client ifattach Attach a DHCP lease to an interface.
dhcp client ifconfig Configure a DHCP lease created for a specific interface.
dhcp client ifdelete Delete a dynamic interface.
90
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands
dhcp client ifrenew
Renew the lease of a dynamic interface.
SYNTAX:
dhcp client ifrenew intf = <interface name>
where:
intf The name of the dynamic interface. REQUIRED
E-DOC-CTC-20040216-0004 v3.0
91
DHCP Commands
EXAMPLE:
=>dhcp client iflist
NewETHoA : [BOUND]
flags= uc
IP address : 10.0.0.10
HW address : 00:90:d0:01:47:f1
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime = 10800 s
lease renewal in 5 days, 58 min, 48 sec
lease rebinding in 8 days, 20 h, 6 min, 18 sec
lease expires in 10 days, 2 h, 28 min, 48 sec
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>dhcp client ifrenew intf=NewETHoA
=>dhcp client iflist
NewETHoA : [SELECTING]
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>
flags= uc
IP address : 10.0.0.10
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
hostname : NewLease
req.leasetime = 10800 s
trying to get a lease for 12 sec
transmission of DISCOVER in 24 sec
retransmission timeout: 64
nbr of retransmissions: 11
EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
92
E-DOC-CTC-20040216-0004 v3.0
The SpeedTouch™ is configured as DHCP client on its Ethernet interface eth0.
=>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 : 0
REQUESTs sent : 0
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 18, in use: 1, free: 94 %
=>dhcp client ifrenew intf=eth0
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv : 0
OFFERs recv : 1
ACKs recv : 1
NAKs recv : 0
Pure BOOTP REPLIES : 0
Other message types : 0
DISCOVERs sent : 1
REQUESTs sent : 1
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 18, in use: 1, free: 94 %
=>(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)
DHCP Commands
RELATED COMMANDS:
dhcp client ifadd Create a DHCP lease for a specific interface.
dhcp client ifattach Attach a DHCP lease to an interface.
E-DOC-CTC-20040216-0004 v3.0
93
DHCP Commands
dhcp client stats
Show DHCP client statistics.
SYNTAX:
dhcp client stats
EXAMPLE:
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv : 0
OFFERs recv : 1
ACKs recv : 1
NAKs recv : 0
Pure BOOTP REPLIES : 0
Other message types : 0
DISCOVERs sent : 244
REQUESTs sent : 9
DECLINEs sent : 0
RELEASEs sent : 1
INFORMs sent : 0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 19, in use: 1, free: 94 %
=>
RELATED COMMANDS:
dhcp client clear Clear DHCP client statistics.
94
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands
dhcp relay add
Add a DHCP server to the DHCP server list.
SYNTAX:
dhcp relay add addr = <ip-address>
[intf = <none|interface_name>]
[giaddr = <ip-address>]
where:
addr The DHCP server IP address. REQUIRED
intf The name of the relay interface.
Use None to indicate that no interface is specified.
giaddr The giaddr field to be used in relayed DHCP packets. OPTIONAL
RELATED COMMANDS:
dhcp relay config Set the relay configuration settings.
dhcp relay delete Delete a DHCP server from the DHCP server list.
OPTIONAL
E-DOC-CTC-20040216-0004 v3.0
95
DHCP Commands
dhcp relay config
Set the relay configuration settings.
SYNTAX:
dhcp server config [agentinfo = <{off|on}>]
[agentmismatch = <{off|on}>]
[trace = <{off|on}>]
where:
agentinfo Sets the relay agent info status (RFC3046) off or on.
The default is off.
agentmismatch Forward/Drop DHCP reply packet when a relay agent info mismatch
is detected (RFC3046) (on) or not (off).
The default is off.
trace Disable verbose console logging and generation of debug traces (off)
or enable verbose console logging and generation of debug traces
(on).
The default is off.
EXAMPLE:
=>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
=>
OPTIONAL
OPTIONAL
OPTIONAL
RELATED COMMANDS:
dhcp relay add Add a DHCP server to the DHCP server list.
dhcp relay delete Delete a DHCP server from the DHCP server list.
96
E-DOC-CTC-20040216-0004 v3.0
DHCP Commands
dhcp relay delete
Delete a DHCP server from the DHCP server list.
SYNTAX:
dhcp relay delete addr = <ip-address>
[intf = <interface name>]
where:
addr The DHCP server IP address. REQUIRED
intf The name of the dynamic interface. OPTIONAL
RELATED COMMANDS:
dhcp relay add Add a DHCP server to the DHCP server list.
dhcp relay config Set the relay configuration settings.
E-DOC-CTC-20040216-0004 v3.0
97
DHCP Commands
dhcp relay flush
Flush the DHCP relay settings.
Note The flush command does not impact previously saved configurations.
SYNTAX:
dhcp relay flush
EXAMPLE:
=>dhcp relay list
DHCP server Interface giaddr
-------------------------------------------------------
127.0.0.1
=>dhcp relay flush
=>dhcp relay list
No dynamic interfaces defined.
=>
98
E-DOC-CTC-20040216-0004 v3.0
Loading...