Page 1
TM
SpeedTouch
516/536/546/510v5/530v5
Multi-User ADSL Gateways
CLI Reference Guide
Release R5.2.7
Page 2
Page 3
SpeedTouch
516/536/546
510v5/530v5
CLI Reference Guide
TM
R5.2.7
Page 4
Copyright
Copyright ©1999-2004 THOMSON. All rights reserved.
Passing on, and copying of this document, use and communication of its contents is not permitted without written authorization
from THOMSON. The content of this document is furnished for informational use only, may be subject to change without notice,
and should not be construed as a commitment by THOMSON. THOMSON assumes no responsibility or liability for any errors or
inaccuracies that may appear in this document.
Thomson Telecom Belgium
Prins Boudewijnlaan, 47
B-2650 Edegem
Belgium
www.speedtouch.com
Trademarks
The following trademarks are used in this document:
SpeedTouch
TM
is a trademark of THOMSON.
Microsoft, MS-DOS, Windows, Windows NT and Internet Explorer are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
UNIX is a registered trademark of UNIX System Laboratories, Incorporated.
Apple and Mac OS are trademarks of Apple Computer, Incorporated, registered in the United States and other countries.
Adobe, the Adobe logo, Acrobat and Acrobat Reader are trademarks or registered trademarks of Adobe Systems, Incorpo-
rated, registered in the United States and/or other countries.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
Ethernet is a trademark of Xerox Corporation.
"Wi-Fi" and the Wi-Fi logo are registered trademarks of the Wi-Fi Alliance. "Wi-Fi CERTIFIED", "Wi-Fi ZONE", "Wi-Fi Alli-
ance", their respective logos and "Wi-Fi Protected Access" are trademarks of the Wi-Fi Alliance.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Document Information
Status: v1.0 (October 2004)
Reference: E-DOC-CTC-20040907-0010
Short Title: CLI Reference Guide ST516/536/546/510v5/530v5 R5.2.7
Page 5
Contents
Contents
About this Document ..................................................................................15
CLI Navigation.............................................................................................. 17
Accessing the Command Line Interface...................................................................................................18
Basic Navigation and Manipulation..........................................................................................................19
Command Line Interface Commands.......................................................................................................22
Menu-driven CLI Navigation ..................................................................................................................... 23
Direct FTP Access....................................................................................................................................... 27
ADSL Commands......................................................................................... 29
adsl config...................................................................................................................................................30
adsl info.......................................................................................................................................................31
ATM Commands ..........................................................................................33
atm oam ccconfig.......................................................................................................................................34
atm oam cclist ............................................................................................................................................35
atm oam ccsend ......................................................................................................................................... 36
atm oam config ..........................................................................................................................................37
atm oam mode ........................................................................................................................................... 38
atm oam ping .............................................................................................................................................39
atm oam status...........................................................................................................................................40
AutoPVC Commands................................................................................... 41
autopvc config............................................................................................................................................ 42
autopvc info................................................................................................................................................ 44
Bridge Commands ....................................................................................... 45
bridge config...............................................................................................................................................46
bridge flush................................................................................................................................................. 47
bridge ifadd.................................................................................................................................................48
bridge ifattach............................................................................................................................................. 49
bridge ifconfig ............................................................................................................................................ 50
bridge ifdelete.............................................................................................................................................52
bridge ifdetach............................................................................................................................................53
bridge iflist.................................................................................................................................................. 54
bridge macadd............................................................................................................................................55
bridge macdelete........................................................................................................................................56
bridge maclist............................................................................................................................................. 57
E-DOC-CTC-20040907-0010 v1.0
3
Page 6
Contents
CIP Commands............................................................................................. 59
Config Commands .......................................................................................67
cip flush....................................................................................................................................................... 60
cip ifadd.......................................................................................................................................................61
cip ifdelete...................................................................................................................................................62
cip iflist........................................................................................................................................................ 63
cip pvcadd...................................................................................................................................................64
cip pvcdelete...............................................................................................................................................65
cip pvclist ....................................................................................................................................................66
config backup ............................................................................................................................................. 68
config dump................................................................................................................................................69
config erase ................................................................................................................................................ 70
config flush .................................................................................................................................................71
config list.....................................................................................................................................................72
config load ..................................................................................................................................................73
config save..................................................................................................................................................74
4
E-DOC-CTC-20040907-0010 v1.0
Page 7
Contents
DHCP Commands......................................................................................... 75
dhcp client clear .........................................................................................................................................76
dhcp client config....................................................................................................................................... 77
dhcp client flush ......................................................................................................................................... 78
dhcp client ifadd.........................................................................................................................................79
dhcp client ifattach.....................................................................................................................................80
dhcp client ifconfig..................................................................................................................................... 81
dhcp client ifdelete..................................................................................................................................... 83
dhcp client iflist ..........................................................................................................................................84
dhcp client ifrelease ................................................................................................................................... 85
dhcp client ifrenew..................................................................................................................................... 87
dhcp client stats.......................................................................................................................................... 89
dhcp relay add............................................................................................................................................90
dhcp relay config........................................................................................................................................91
dhcp relay delete........................................................................................................................................92
dhcp relay flush..........................................................................................................................................93
dhcp relay ifconfig...................................................................................................................................... 94
dhcp relay iflist ........................................................................................................................................... 95
dhcp relay list ............................................................................................................................................. 96
dhcp relay stats ..........................................................................................................................................97
dhcp server clear........................................................................................................................................98
dhcp server config...................................................................................................................................... 99
dhcp server flush...................................................................................................................................... 100
dhcp server policy....................................................................................................................................101
dhcp server stats ...................................................................................................................................... 102
dhcp server lease add.............................................................................................................................. 104
dhcp server lease delete.......................................................................................................................... 105
dhcp server lease flush............................................................................................................................ 106
dhcp server lease list ............................................................................................................................... 107
dhcp server pool add ...............................................................................................................................108
dhcp server pool config...........................................................................................................................109
dhcp server pool delete ...........................................................................................................................111
dhcp server pool flush .............................................................................................................................112
dhcp server pool list................................................................................................................................. 113
E-DOC-CTC-20040907-0010 v1.0
5
Page 8
Contents
DNS Commands......................................................................................... 115
dns add......................................................................................................................................................116
dns clear....................................................................................................................................................117
dns clrstats................................................................................................................................................118
dns delete..................................................................................................................................................119
dns domain............................................................................................................................................... 120
dns flush....................................................................................................................................................121
dns fwdadd ...............................................................................................................................................122
dns fwddelete ........................................................................................................................................... 123
dns fwdlist.................................................................................................................................................124
dns fwdtable ............................................................................................................................................. 125
dns list....................................................................................................................................................... 126
dns nslookup ............................................................................................................................................ 127
dns start .................................................................................................................................................... 128
dns stats.................................................................................................................................................... 129
dns status..................................................................................................................................................130
dns stop.....................................................................................................................................................131
dns toutfwd...............................................................................................................................................132
dns troff.....................................................................................................................................................133
dns tron..................................................................................................................................................... 134
Env Commands .......................................................................................... 135
env flush....................................................................................................................................................136
env get.......................................................................................................................................................137
env list....................................................................................................................................................... 138
env set....................................................................................................................................................... 139
env unset...................................................................................................................................................140
Eth Commands........................................................................................... 141
eth config ..................................................................................................................................................142
eth ifconfig................................................................................................................................................ 143
eth iflist......................................................................................................................................................144
ETHoA Commands..................................................................................... 145
ethoa flush ................................................................................................................................................146
ethoa ifadd................................................................................................................................................ 147
ethoa ifattach............................................................................................................................................ 148
ethoa ifconfig............................................................................................................................................149
ethoa ifdelete............................................................................................................................................150
ethoa ifdetach...........................................................................................................................................151
ethoa iflist ................................................................................................................................................. 152
6
E-DOC-CTC-20040907-0010 v1.0
Page 9
Contents
Firewall Commands................................................................................... 153
firewall assign...........................................................................................................................................154
firewall flush ............................................................................................................................................. 155
firewall list.................................................................................................................................................156
firewall troff ..............................................................................................................................................157
firewall tron...............................................................................................................................................158
firewall unassign ...................................................................................................................................... 159
firewall chain create.................................................................................................................................160
firewall chain delete.................................................................................................................................161
firewall chain flush...................................................................................................................................162
firewall chain list ......................................................................................................................................163
firewall rule clear...................................................................................................................................... 164
firewall rule create.................................................................................................................................... 165
firewall rule delete.................................................................................................................................... 168
firewall rule flush......................................................................................................................................169
firewall rule list.........................................................................................................................................170
firewall rule stats......................................................................................................................................171
E-DOC-CTC-20040907-0010 v1.0
7
Page 10
Contents
IP Commands .............................................................................................173
ip apadd ....................................................................................................................................................174
ip apdelete ................................................................................................................................................ 176
ip aplist......................................................................................................................................................177
ip arpadd................................................................................................................................................... 178
ip arpdelete............................................................................................................................................... 179
ip arplist .................................................................................................................................................... 180
ip config .................................................................................................................................................... 181
ip flush.......................................................................................................................................................184
ip ifconfig ..................................................................................................................................................185
ip iflist........................................................................................................................................................ 186
ip ifwait......................................................................................................................................................187
ip mcadd ................................................................................................................................................... 188
ip mcdelete ............................................................................................................................................... 189
ip mclist.....................................................................................................................................................190
ip ping ....................................................................................................................................................... 191
ip rtadd...................................................................................................................................................... 192
ip rtdelete.................................................................................................................................................. 193
ip rtlist ....................................................................................................................................................... 194
ip sendto ................................................................................................................................................... 195
ip traceroute.............................................................................................................................................. 196
ip auto flush.............................................................................................................................................. 198
ip auto ifadd..............................................................................................................................................199
ip auto ifattach..........................................................................................................................................200
ip auto ifconfig..........................................................................................................................................201
ip auto ifdelete..........................................................................................................................................202
ip auto ifdetach.........................................................................................................................................203
ip auto iflist ............................................................................................................................................... 204
IPoA Commands ........................................................................................205
ipoa flush .................................................................................................................................................. 206
ipoa ifadd ..................................................................................................................................................207
ipoa ifattach .............................................................................................................................................. 208
ipoa ifconfig..............................................................................................................................................209
ipoa ifdelete .............................................................................................................................................. 210
ipoa ifdetach ............................................................................................................................................. 211
ipoa iflist....................................................................................................................................................212
8
E-DOC-CTC-20040907-0010 v1.0
Page 11
Contents
IPQoS Commands...................................................................................... 213
ipqos config ..............................................................................................................................................214
ipqos list....................................................................................................................................................216
ipqos queue clear.....................................................................................................................................217
ipqos queue config................................................................................................................................... 218
ipqos queue list ........................................................................................................................................ 220
ipqos queue stats .....................................................................................................................................221
Label Commands .......................................................................................223
label add....................................................................................................................................................224
label config ............................................................................................................................................... 225
label delete................................................................................................................................................227
label flush..................................................................................................................................................228
label list..................................................................................................................................................... 229
label troff...................................................................................................................................................230
label tron................................................................................................................................................... 231
label chain create .....................................................................................................................................232
label chain delete .....................................................................................................................................233
label chain flush .......................................................................................................................................234
label chain list...........................................................................................................................................235
label rule clear .......................................................................................................................................... 236
label rule create........................................................................................................................................237
label rule delete........................................................................................................................................239
label rule flush.......................................................................................................................................... 240
label rule list .............................................................................................................................................241
label rule stats ..........................................................................................................................................242
Language Commands................................................................................ 243
language config........................................................................................................................................244
language list .............................................................................................................................................245
language remove .....................................................................................................................................246
E-DOC-CTC-20040907-0010 v1.0
9
Page 12
Contents
NAT Commands......................................................................................... 247
nat applist ................................................................................................................................................. 248
nat bind .....................................................................................................................................................249
nat bindlist ................................................................................................................................................ 250
nat clear.....................................................................................................................................................251
nat config .................................................................................................................................................. 252
nat create .................................................................................................................................................. 253
nat defserver.............................................................................................................................................254
nat delete ..................................................................................................................................................255
nat disable.................................................................................................................................................256
nat enable ................................................................................................................................................. 257
nat flush .................................................................................................................................................... 258
nat list........................................................................................................................................................259
nat multinatadd ........................................................................................................................................ 260
nat multinatdelete .................................................................................................................................... 261
nat multinatlist..........................................................................................................................................262
nat unbind.................................................................................................................................................263
Phonebook Commands ............................................................................. 265
phonebook add......................................................................................................................................... 266
phonebook delete..................................................................................................................................... 267
phonebook flush....................................................................................................................................... 268
phonebook list..........................................................................................................................................269
PPPoA Commands ..................................................................................... 271
pppoa flush............................................................................................................................................... 272
pppoa ifadd...............................................................................................................................................273
pppoa ifattach...........................................................................................................................................274
pppoa ifconfig........................................................................................................................................... 275
pppoa ifdelete...........................................................................................................................................279
pppoa ifdetach..........................................................................................................................................280
pppoa iflist ................................................................................................................................................ 281
pppoa rtadd .............................................................................................................................................. 282
pppoa rtdelete ..........................................................................................................................................284
10
E-DOC-CTC-20040907-0010 v1.0
Page 13
Contents
PPPoE Commands .....................................................................................285
pppoe flush............................................................................................................................................... 286
pppoe ifadd...............................................................................................................................................287
pppoe ifattach...........................................................................................................................................288
pppoe ifconfig........................................................................................................................................... 289
pppoe ifdelete...........................................................................................................................................293
pppoe ifdetach..........................................................................................................................................294
pppoe iflist ................................................................................................................................................ 295
pppoe ifscan ............................................................................................................................................. 296
pppoe rtadd .............................................................................................................................................. 297
pppoe rtdelete ..........................................................................................................................................299
pppoe relay add........................................................................................................................................ 300
pppoe relay delete.................................................................................................................................... 301
pppoe relay flush...................................................................................................................................... 302
pppoe relay portlist..................................................................................................................................303
pppoe relay sesslist..................................................................................................................................304
PPTP Commands........................................................................................ 305
pptp flush.................................................................................................................................................. 306
pptp ifadd..................................................................................................................................................307
pptp list ..................................................................................................................................................... 308
pptp profadd.............................................................................................................................................309
pptp profdelete.........................................................................................................................................310
pptp proflist ..............................................................................................................................................311
QoSBook Commands ................................................................................ 313
qosbook add ............................................................................................................................................. 314
qosbook config.........................................................................................................................................316
qosbook delete ......................................................................................................................................... 317
qosbook flush ........................................................................................................................................... 318
qosbook list...............................................................................................................................................319
Script Commands ...................................................................................... 321
script add .................................................................................................................................................. 322
script delete .............................................................................................................................................. 323
script flush ................................................................................................................................................ 324
script list....................................................................................................................................................325
script run................................................................................................................................................... 326
E-DOC-CTC-20040907-0010 v1.0
11
Page 14
Contents
SNMP Commands...................................................................................... 327
Software Commands................................................................................. 333
Switch Commands .................................................................................... 337
snmp config.............................................................................................................................................. 328
snmp get ...................................................................................................................................................329
snmp getNext ...........................................................................................................................................330
snmp list....................................................................................................................................................331
snmp walk.................................................................................................................................................332
software version.......................................................................................................................................334
software upgrade ..................................................................................................................................... 335
switch group flush.................................................................................................................................... 338
switch group list.......................................................................................................................................339
switch group move ..................................................................................................................................340
switch mirror capture............................................................................................................................... 341
switch mirror egress ................................................................................................................................ 342
switch mirror ingress...............................................................................................................................343
System Commands ................................................................................... 345
system clearpassword ............................................................................................................................. 346
system config ........................................................................................................................................... 347
system flush.............................................................................................................................................. 348
system reboot...........................................................................................................................................349
system reset..............................................................................................................................................350
system setpassword ................................................................................................................................351
system stats..............................................................................................................................................352
Systemlog Commands .............................................................................. 353
systemlog flush ........................................................................................................................................ 354
systemlog show .......................................................................................................................................355
systemlog send ........................................................................................................................................356
TD Commands............................................................................................ 357
td call......................................................................................................................................................... 358
UPnP Commands ....................................................................................... 359
upnp config...............................................................................................................................................360
upnp flush................................................................................................................................................. 361
upnp list .................................................................................................................................................... 362
12
E-DOC-CTC-20040907-0010 v1.0
Page 15
Contents
Abbreviations ............................................................................................. 363
Syslog Messages .......................................................................................367
Auto-PVC Module..................................................................................................................................... 368
Configuration Module..............................................................................................................................368
DHCP CLient Module................................................................................................................................ 368
DHCP Relay Module.................................................................................................................................369
DHCP Server Module ...............................................................................................................................369
Firewall Module........................................................................................................................................370
HTTP Module............................................................................................................................................ 370
Kernel Module ..........................................................................................................................................370
Linestate Module......................................................................................................................................370
Login Module............................................................................................................................................ 371
NAPT Module ...........................................................................................................................................371
PPP Module...............................................................................................................................................371
PPTP Module ............................................................................................................................................ 372
Routing Module........................................................................................................................................372
Software Module......................................................................................................................................372
UPnP Module............................................................................................................................................372
Supported Key Names .............................................................................. 373
Supported IP Protocol Names.................................................................................................................374
Supported TCP/UDP Port Names............................................................................................................ 375
Supported ICMP Type Names.................................................................................................................378
Supported Syslog Facilities.....................................................................................................................379
Supported Syslog Severities................................................................................................................... 380
E-DOC-CTC-20040907-0010 v1.0
13
Page 16
Contents
14
E-DOC-CTC-20040907-0010 v1.0
Page 17
About this Document
Introduction
Welcome to the SpeedTouchTM Command Line Interface (CLI) Reference Guide!
For the Service Provider, this Reference Guide aims to be a concise and practical document for creating a
customized Service Template file, based on the SpeedTouch
configure the SpeedTouchTM and PC(s).
For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch
TM
via its character based CLI command set.
Applicability
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouchTM
products:
SpeedTouch
SpeedTouch
SpeedTouch
SpeedTouch
SpeedTouch
For readability, all are referred to as SpeedTouchTM throughout this document unless a specific variant is
concerned.
TM
516(i) Multi-User ADSL Gateway (R5.2.7)
TM
536(i) Multi-User ADSL Gateway (R5.2.7)
TM
546(i) Multi-User ADSL Gateway (R5.2.7)
TM
510v5(i) Multi-User ADSL Gateway (R5.2.7)
TM
530v5(i) Multi-User ADSL Gateway (R5.2.7)
TM
CLI command set, to be used by the end-user to
Contents
The Reference Guide consists of two main parts:
CLI Navigation:
TM
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:
TM
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
TM
.
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-20040907-0010 v1.0
15
Page 18
Trademarks
The following trademarks are used in this document:
SpeedTouch
TM
is a trademark of THOMSON.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
Windows and Internet Explorer are trademarks of Microsoft Corporation.
Apple and MacOS are registered trademarks of Apple Computer Inc.
UNIX is a registered trademark of UNIX System Laboratories, Inc.
Ethernet is a trademark of Xerox Corporation.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Symbols
The following symbols are used in this CLI Reference Guide:
A note provides additional information about a topic.
A tip provides an alternative method or shortcut to perform an action.
A caution warns you about potential problems or specific precautions that need to be taken.
!
Conventions
The following conventions are used to present the CLI commands:
Vertical bars (|) separate alternative, mutually exclusive, elements.
Square brackets [] indicate optional elements.
Braces {} indicate a required choice.
Braces within square brackets [{}] indicate a required choice within an optional element.
<string> indicates that an alphanumerical string without blanks must be used.
<quoted string> indicates that an alphanumerical string with blanks can be used. The string must be
enclosed in quotes “.
Interactive input is shown in a bold font.
Interactive output is shown in this font.
Comments are added in italics. Example:
=>language list
CODE LANGUAGE VERSION FILENAME
en* english 4.2.0.1 <system>
In this example only one language is available
Documentation and software updates
THOMSON continuously develops new solutions, but is also committed to improve its existing products.
For more information on THOMSON's latest technological innovations, documents and software releases, visit us
at:
www.speedtouch.com
16
E-DOC-CTC-20040907-0010 v1.0
Page 19
CLI Navigation
Introduction
This chapter familiarizes the user with the SpeedTouchTM CLI. It describes general manipulations:
to navigate through the CLI
to perform some operations on the CLI.
Contents
This chapter covers the following topics:
Accessing the Command Line Interface 18
Basic Navigation and Manipulation 19
Command Line Interface Commands 22
Menu-driven CLI Navigation 23
Direct FTP Access 27
CLI Navigation
E-DOC-CTC-20040907-0010 v1.0
17
Page 20
CLI Navigation
Accessing the Command Line Interface
Proceed as follows to open a Telnet session:
1 Open a Command Prompt window, for example by clicking Start
Prompt
2 At the prompt, type telnet followed by the Internet Protocol (IP) address of the SpeedTouch
10.0.0.138).
As soon a session to the CLI is opened, the SpeedTouch
If the SpeedTouch
access is granted.
The following figure shows an example of the SpeedTouch
authentication
>
All Programs
>
Accessories
>
Command
.
TM
(default is
TM
banner pops up, followed by the CLI prompt.
TM
is protected by a username and a system password, authentication will be required before
TM
516 banner after opening a session and
.
Username : johndoe
Password : *******
-----------------------------------------------------------------------*
* ______ SpeedTouch 516
* ___/_____/\
* / /\\ Version 5.2.7.5.0
* _____/__ / \\
* _/ /\_____/___ \ Copyright (c) 1999-2004,
* // / \ /\ \ THOMSON
* _______//_______/ \ / _\/______
* / /\ \ / // /\
* __/ / \ \ / / / / _\__
* / / / \_______\/ / / / / /\
* /_/______/___________________/ /________/ /___/ \
* \ \ \ ___________ \ \ \ \ \ /
* \_\ \ / /\ \ \ \ \___\/
* \ \/ /\ \\ \/
* \_____/ / \ \ \________\/
* /__________/ \ \ /
* \ _____ \ /_____\/
* \ / /\ \ /___\/
* /____/\\/
* \ \ /___\/
* \____\/
*
-----------------------------------------------------------------------=>
18
E-DOC-CTC-20040907-0010 v1.0
Page 21
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 and so on.
Command group navigation
From top level, you can change to a command group by executing the name of the desired command group.
TM
The example below shows every possible CLI command group for the SpeedTouch
=>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.
516.
Following command groups are available :
adsl atm autopvc bridge cip
config dhcp dns env eth
ethoa firewall ip ipoa ipqos
label language nat phonebook pppoa
pppoe pptp qosbook script snmp
software system systemlog td upnp
=>
The following command groups are specific for certain variants:
switch is only available for the SpeedTouch
TM
546.
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-20040907-0010 v1.0
19
Page 22
CLI Navigation
The Help Command
Execute help or ? from top level to list all available commands and command groups for the SpeedTouchTM.
Example for the SpeedTouch
=>help
Following commands are available :
help : Displays this help information
menu : Displays menu
? : Displays this help information
exit : Exits this shell.
.. : Exits group selection.
saveall : Saves current configuration.
Following command groups are available :
adsl atm autopvc bridge cip
config dhcp dns env eth
ethoa firewall ip ipoa ipqos
label language nat phonebook pppoa
pppoe pptp qosbook script snmp
software system systemlog td upnp
=>
TM
516:
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 :
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
[firewall]=>
TM
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 for example help firewall from top level gives the same result as executing help from the firewall
command group selection.
Example:
=>firewall help
Following commands are available :
assign : Assign a chain to an entry point.
unassign : Clear a specific hook
list : Shows a list of all the hooks with the chains attached.
flush : Clears all hooks, chains and rules
tron : Enables verbose console messaging.
troff : Disables verbose console messaging.
Following command groups are available :
chain rule
=>
20
E-DOC-CTC-20040907-0010 v1.0
Page 23
CLI Navigation
Entering help followed by a specific command, for example :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.
=>
Entering :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 command
groups, for commands and for 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.
Breaking off Commands
Press CTRL+G to quit a command. This can be useful in a situation where a user is prompted to enter a value
which he does not know and he wants to quit the command.
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
E-DOC-CTC-20040907-0010 v1.0
21
Page 24
CLI Navigation
Command Line Interface Commands
Command Execution
All CLI commands are commands that operate on, or configure, the SpeedTouchTM 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.
For example :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. For example :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]=>
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.
For example the command :firewall assign hook=input chain=input.
=>firewall assign hook=input chain=input
=>
2 Just the command itself without its parameters. After pressing
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
=>
Enter
, you are prompted to complete the
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
value.
This manner of entering a command is not applicable to all the CLI commands. Examples are
:system config, :upnp config, ...
22
Enter
without giving a
E-DOC-CTC-20040907-0010 v1.0
Page 25
Menu-driven CLI Navigation
Introduction
To improve the user-friendliness of the SpeedTouchTM 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.
TM
Example (for the SpeedTouch
546):
CLI Navigation
Leaving the menu
To leave the menu-driven interface, use the TAB key to go to the Cancel field and press ENTER.
This can be done on any level of the menu, in other words 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-20040907-0010 v1.0
23
Page 26
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
Proceed as follows to enter paramter 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:
24
E-DOC-CTC-20040907-0010 v1.0
Page 27
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.
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-20040907-0010 v1.0
25
Page 28
CLI Navigation
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 wrongly 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
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 SpeedTouchTM, the Setup wizard and the
configuration profile files, please check the SpeedTouchTM support pages at:
TM
. The declaration of such customization variables
www.speedtouch.com
TM
.
26
E-DOC-CTC-20040907-0010 v1.0
Page 29
CLI Navigation
Direct FTP Access
The SpeedTouchTM File System
The SpeedTouchTM permanent storage, further referred to as 'file system', exists of nonvolatile memory used for
storing, retrieving and maintaining the SpeedTouchTM software image(s), Service Template files and optionally
default settings files.
TM
The file system of the SpeedTouch
allows to transfer the SpeedTouchTMsoftware 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
/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
Password : ######
330 OK
ftp>
TM
(00-90-D0-01-02-03) User 'doejohn' OK. Password required.
is accessible via the File Transfer Protocol (FTP) transport protocol. This
TM
file system:
SpeedTouchTM 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
TM
to boot correctly.
the active subdirectory always contains the software image in execution, in other words the active software
image.
the dl directory contains the dormant software image (in other words, the passive software image). If you
have made changes to the SpeedTouchTM 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 :saveall or :config save all, the user.ini Service Template file present in the
dl subdirectory reflects the current configuration of the SpeedTouch
TM
.
SpeedTouchTM 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.
!
The 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.
E-DOC-CTC-20040907-0010 v1.0
27
Page 30
CLI Navigation
FTP File Transfer
To allow correct file transfers, set the transfer mode to “binary”.
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
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>
TM
(00-90-D0-01-02-03) User 'doejohn' OK. Password required.
Quote Site Command
All the CLI commands can be executed from within an FTP session.
Only complete CLI commands (in other words, the complete command syntax with all the parameters already
specified) can be executed.
Example:
To execute the command :firewall list, 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>
28
E-DOC-CTC-20040907-0010 v1.0
Page 31
ADSL Commands
ADSL Commands
Introduction
This chapter describes the commands of the adsl command group.
Contents
This chapter covers the following commands:
adsl config Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration. 30
adsl info Show ADSL statistics and information about the SpeedTouchTM DSL line status. 31
E-DOC-CTC-20040907-0010 v1.0
29
Page 32
ADSL Commands
adsl config
Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration.
Although the command is the same for both SpeedTouch
SpeedTouchTM ADSL/Integrated Services Digital Network (ISDN) variants, the command features specific
parameter values per variant:
SYNTAX for ADSL/POTS variants:
adsl config [opermode = <{multimode | multi_adsl2 | multi_readsl2
where:
| multi_adsl2plus}>]
[trace = <{off | on}>]
TM
ADSL/Plain Old Telephone System (POTS) and
opermode The operational mode of the SpeedTouchTM modem.
Choose between:
multimode
multi_adsl2
multi_readsl2
multi_adsl2plus.
The default is multi_adsl2plus.
trace Enable (on) / disable (off) ADSL tracing.
The default is on.
SYNTAX for ADSL/ISDN variants:
adsl config [opermode = <{multimode | multi_adsl2 | multi_readsl2
| multi_adsl2plus}>]
[trace = <{off | on}>]
where:
opermode The operational mode of the SpeedTouchTM modem.
Choose between:
multimode
multi_adsl2
multi_readsl2
multi_adsl2plus.
The default is multi_adsl2plus.
trace Enable (on) / disable (off) ADSL tracing.
The default is on.
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
EXAMPLE (for a SpeedTouchTM ADSL/POTS variant):
=>adsl config
ADSL configuration:
opermode = multi_adsl2plus
trace = on
modemoption = 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
=>
30
E-DOC-CTC-20040907-0010 v1.0
Page 33
adsl info
Show ADSL statistics and information about the SpeedTouchTM DSL line status.
TM
Although the same command is used for both SpeedTouch
the command features specific output parameters and counters per variant.
SYNTAX:
adsl info
ADSL/POTS and SpeedTouchTM ADSL/ISDN variants,
ADSL Commands
EXAMPLE (for a SpeedTouch
=>adsl info
Modemstate : up
Operation Mode : G.DMT Annex A [POTS Overlay Mode]
Channel Mode : fast
Number of resets : 1
Vendor (ITU) Local Remote
Country : 0f 0f
Vendor : ALCB ALCB
VendorSpecific : 0000 0000
StandardRevisionNr : 01 01
Margin [dB] : 25 31
Attenuation [dB] : 26 15
Available Bandwidth Cells/s Kbit/s
Downstream : 7924 3360
Upstream : 452 192
Transfer statistics
Total since power On Cells Kbit
Downstream : 10153 4304
Upstream : 3399 1441
Current Connection
Downstream : 10153 4304
Upstream : 3399 1441
Errors
Received FEC : 0
Received CRC : 0
Received HEC : 0
TM
ADSL/POTS variant):
Downstream Upstream
E-DOC-CTC-20040907-0010 v1.0
31
Page 34
ADSL Commands
32
E-DOC-CTC-20040907-0010 v1.0
Page 35
ATM Commands
Introduction
This chapter describes the commands of the atm command group.
Contents
This chapter covers the following commands:
ATM Commands
atm oam ccconfig Configure Operation and Maintenance (OAM) Continuity Check (CC) on the
connection.
atm oam cclist Show the current OAM CC configuration. 35
atm oam ccsend Send CC activate/deactivate to the connection. 36
atm oam config Configure the OAM settings. 37
atm oam mode Configure the OAM data blocking mode. 38
atm oam ping Send ATM loopback cells. 39
atm oam status Show the OAM settings. 40
34
E-DOC-CTC-20040907-0010 v1.0
33
Page 36
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>
where:
vpi = <number{0-15}>
[vci = <number{0-511}>]
[transmit = <{disabled | enabled}>]
[receive = <{disabled | enabled}>]
[auto = <{disabled | enabled}>]
[span = <{segment | end2end}>]
port The Asynchronous Transfer Mode (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.
auto Enable or disable remote CC activation and deactivation.
The default is disabled.
span Select either:
end2end:monitoring occurs on the entire VC between two ATM end stations.
segment:monitoring occurs on a VC segment between the SpeedTouch
first-hop ATM switch.
TM
and a
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
RELATED COMMANDS:
atm oam cclist Show the current OAM CC configuration.
atm oam ccsend Send CC activate/deactivate to the connection.
34
E-DOC-CTC-20040907-0010 v1.0
Page 37
atm oam cclist
Show the current OAM CC configuration.
SYNTAX:
atm oam cclist
EXAMPLE:
=>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 Operation and Maintenance (OAM) Continuity Check (CC) on the connection.
atm oam ccsend Send CC activate/deactivate to the connection.
E-DOC-CTC-20040907-0010 v1.0
35
Page 38
ATM Commands
atm oam ccsend
Send CC activate/deactivate to the connection.
SYNTAX:
atm oam ccsend port = <{dsl0 | dsl1 | atm2 | atm3 | aal5 | atm5} or number>
where:
vpi = <number{0-15}>
[vci = <number{0-511}>]
[span = <{segment | end2end}>]
[action = <{activate | deactivate}>]
[direction = <{source | sink | both}>]
port The ATM port number.
Choose between:
DSL0
DSL1
ATM2
ATM3
AAL5
ATM5 .
Or specify a port number (dsl0 has port number 0, ..., atm5 has port number 5).
vpi A number between 0 and 15.
Represents the VPI.
vci A number between 0 and 511.
Represents the VCI.
For a VP cross-connection, use VCI=0 or do not specify.
span Send CC action.
Choose between:
end2end
segment.
action Enable or disable CC.
The default is disabled.
direction Indicates the direction of CC activity.
Select either:
source
sink
both.
Note If not specified, CC is activated/deactivated for both directions.
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
RELATED COMMANDS:
atm oam ccconfig Configure Operation and Maintenance (OAM) Continuity Check (CC) on the connection.
atm oam cclist Show the current OAM CC configuration.
36
E-DOC-CTC-20040907-0010 v1.0
Page 39
atm oam config
Configure the OAM settings.
SYNTAX:
atm oam config [clp = <number{0-1}>]
[loopbackid = <string>]
where:
ATM Commands
clp The Cell Loss Priority (CLP) bit value of the OAM cells.
Choose between:
0
1.
The default is 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.
EXAMPLE:
=>atm oam status
OAM config dump
------------------CLP bit value : 1
Loopback id : 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a
OAM data blocking mode
-------------------------Port dsl0: blocking
Port dsl1: blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking
=>
OPTIONAL
OPTIONAL
E-DOC-CTC-20040907-0010 v1.0
37
Page 40
ATM Commands
atm oam mode
Configure the OAM data blocking mode.
SYNTAX:
atm oam mode port = <{dsl0 | dsl1 | atm2 | atm3 | aal5 | atm5} or number>
where:
blocking = <{disabled | enabled}>
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-20040907-0010 v1.0
Page 41
atm oam ping
Send 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.
The destination 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-20040907-0010 v1.0
39
Page 42
ATM Commands
atm oam status
Show the OAM settings.
SYNTAX:
atm oam status
EXAMPLE:
=>atm oam status
OAM config dump
-------------------
--------------------------
=>
CLP bit value : 1
Loopback id : 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a
OAM data blocking mode
Port dsl0: blocking
Port dsl1: blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking
40
E-DOC-CTC-20040907-0010 v1.0
Page 43
AutoPVC Commands
AutoPVC Commands
Introduction
This chapter describes the commands of the autopvc command group.
Contents
This chapter covers the following commands:
autopvc config Configure autopvc. 42
autopvc info Show retrieved information. 44
E-DOC-CTC-20040907-0010 v1.0
41
Page 44
AutoPVC Commands
autopvc config
Configure autopvc.
SYNTAX:
autopvc config [mode = <{pseudo | passive | active}>]
where:
[type = <{bridge | pppoerelay}>]
[opmode = <{partial | full}>]
[overwrite = <{disabled | enabled}>]
[peakrate = <number{0-27786}>]
mode Select the autopvc mode:
pseudo:
enable only pseudo-ILMI (VP/VC 15/16). When connection parameters are
written to the MIB, display this information on CLI or web-interface but do not
use these parameters for configuration.
passive:
enable both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC 15/16). When connection
parameters are written to the MIB, display this information on CLI or webinterface 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 pseudo.
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.
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.
The default is enabled.
peakrate A number between 0 and 27786.
Represents the UBR peak rate (in kilobits per second).
Note 0 indicates the linerate.
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
42
E-DOC-CTC-20040907-0010 v1.0
Page 45
EXAMPLE:
=>autopvc config
Autopvc mode : pseudo
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-20040907-0010 v1.0
43
Page 46
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:
=>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-20040907-0010 v1.0
Page 47
Bridge Commands
Bridge Commands
Introduction
This chapter describes the commands of the bridge command group.
Contents
This chapter covers the following commands:
bridge config Show/set the bridge configuration setings. 46
bridge flush Flush bridge interfaces and parameters. 47
bridge ifadd Create a bridged Ethernet interface. 48
bridge ifattach Attach a bridged Ethernet interface. 49
bridge ifconfig Configure a bridge interface. 50
bridge ifdelete Delete a bridge interface. 52
bridge ifdetach Detach a bridge interface. 53
bridge iflist Show the current state of all or the selected bridge interfaces. 54
bridge macadd Add a static MAC address to the filtering database. 55
bridge macdelete Remove a MAC address from the filtering database. 56
bridge maclist Show the current MAC address filtering database. 57
E-DOC-CTC-20040907-0010 v1.0
45
Page 48
Bridge Commands
bridge config
Show/set the bridge configuration setings.
SYNTAX:
bridge config [age = <number {10 - 100000}>]
where:
[filter = <{no_WAN_broadcast | PPPoE_only | none}>]
age A number between 10 and 100000 (seconds).
Represents the lifetime of a dynamically learned Medium Access Control (MAC) address.
The default is 300.
filter The bridge filter to be applied for all Wide Area Network (WAN) bridge ports.
Choose between:
no_WAN_broadcast:
TM
broadcasts from the SpeedTouch
from the Local Area Network (LAN) to the WAN are still passed through.
itself to the WAN are filtered out, broadcasts
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
46
E-DOC-CTC-20040907-0010 v1.0
Page 49
bridge flush
Flush bridge interfaces and parameters.
The flush command does not impact previously saved configurations.
SYNTAX:
bridge flush
Bridge Commands
E-DOC-CTC-20040907-0010 v1.0
47
Page 50
Bridge Commands
bridge ifadd
Create a bridged Ethernet interface.
SYNTAX:
bridge ifadd [intf = <intfname>]
where:
[dest = <string>]
intf The bridged Ethernet interface name.
Note If not specified, the destination name will double as interface name.
dest The destination address for the new interface.
Typically a phonebook entry.
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 73592 frames: 702
TX bytes: 69549 frames: 1050 dropframes: 0
...
ethport5 : Internal
Connection State: connected
Port: ethport5 PortNr: 5 PortState: forwarding
RX bytes: 2150291312 frames: 2150259736
TX bytes: 2150201352 frames: 2147888072 dropframes: 3
=>bridge ifadd intf=myBridgeIntf
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 73592 frames: 702
TX bytes: 69549 frames: 1050 dropframes: 0
OPTIONAL
OPTIONAL
...
myBridgeIntf: dest : (none)
=>
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
RELATED COMMANDS:
bridge ifdelete Delete a bridge interface.
bridge iflist Show the current state of all or the selected bridge interfaces.
48
E-DOC-CTC-20040907-0010 v1.0
Page 51
bridge ifattach
Attach 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: 81812 frames: 778
TX bytes: 76463 frames: 1161 dropframes: 0
...
myBridgeIntf: dest : ATM1
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
=>bridge ifattach intf=myBridgeIntf
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 85261 frames: 807
TX bytes: 78983 frames: 1203 dropframes: 0
...
myBridgeIntf: dest : ATM1
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 6 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
REQUIRED
=>
RELATED COMMANDS:
bridge ifdetach Detach a bridge interface.
E-DOC-CTC-20040907-0010 v1.0
49
Page 52
Bridge Commands
bridge ifconfig
Configure a bridge interface.
SYNTAX:
bridge ifconfig intf = <intfname>
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. OPTIONAL
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
forwarding.
The default is forwarding.
retry A number between 0 and 65535.
Represents the number of times the SpeedTouch
connection before giving up.
The default is 10.
[dest = <string>]
[qos = <string>]
[encaps = <{llc/snap | vcmux}>]
[fcs = <{off | on}>]
[portstate = <{disabled | learning | forwarding}>]
[retry = <number {0-65535}>]
TM
retries to set up a WAN
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
50
E-DOC-CTC-20040907-0010 v1.0
Page 53
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 73592 frames: 702
TX bytes: 69549 frames: 1050 dropframes: 0
...
Bridge Commands
myBridgeIntf: dest : (none)
=>
=>bridge ifconfig intf=myBridgeIntf dest=ATM1
=>
=>bridge iflist
OBC : Internal
...
myBridgeIntf: dest : ATM1
=>
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 81812 frames: 778
TX bytes: 76463 frames: 1161 dropframes: 0
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: not-connected
Port: (Unassigned) PortNr: (Unknown) PortState: forwarding
E-DOC-CTC-20040907-0010 v1.0
51
Page 54
Bridge Commands
bridge ifdelete
Delete a bridge interface.
SYNTAX:
bridge ifdelete intf = <intfname>
where:
intf The name of the interface name to be deleted. REQUIRED
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 99930 frames: 969
TX bytes: 93572 frames: 1443 dropframes: 0
...
ethport5 : Internal
myBridgeIntf: dest : ATM1
=>bridge ifdelete intf=myBridgeIntf
=>bridge iflist
OBC : Internal
...
ethport5 : Internal
=>
Connection State: connected
Port: ethport5 PortNr: 5 PortState: forwarding
RX bytes: 2150291312 frames: 2150259736
TX bytes: 2150201352 frames: 2147888072 dropframes: 3
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 6 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 99930 frames: 969
TX bytes: 93572 frames: 1443 dropframes: 0
Connection State: connected
Port: ethport5 PortNr: 5 PortState: forwarding
RX bytes: 2150291312 frames: 2150259736
TX bytes: 2150201352 frames: 2147888072 dropframes: 3
RELATED COMMANDS:
bridge ifadd Create a bridged Ethernet interface.
bridge iflist Show the current state of all or the selected bridge interfaces.
52
E-DOC-CTC-20040907-0010 v1.0
Page 55
Bridge Commands
bridge ifdetach
Detach a bridge interface.
SYNTAX:
bridge ifdetach intf = <intfname>
where:
intf The name of the bridge interface to be detached. REQUIRED
EXAMPLE:
=>bridge iflist
OBC : Internal
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 85261 frames: 807
TX bytes: 78983 frames: 1203 dropframes: 0
...
myBridgeIntf: dest : ATM1
=>bridge ifdetach intf=myBridgeIntf
=>bridge iflist
OBC : Internal
...
myBridgeIntf: dest : ATM1
=>
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 6 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 dropframes: 0
Connection State: connected
Port: OBC PortNr: 0 PortState: forwarding
RX bytes: 88882 frames: 837
TX bytes: 81743 frames: 1249 dropframes: 0
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 bridged Ethernet interface.
E-DOC-CTC-20040907-0010 v1.0
53
Page 56
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.
Note 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: 99930 frames: 969
TX bytes: 93572 frames: 1443 dropframes: 0
...
ethport5 : Internal
Connection State: connected
Port: ethport5 PortNr: 5 PortState: forwarding
RX bytes: 2150291312 frames: 2150259736
TX bytes: 2150201352 frames: 2147888072 dropframes: 3
myBridgeIntf: dest : ATM1
Retry : 10 QoS : default Encaps : llc/snap Fcs : off
Connection State: connected
Port: wan0 PortNr: 6 PortState: forwarding
RX bytes: 0 frames: 0
TX bytes: 0 frames: 0 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 ifdelete Delete a bridge interface.
54
E-DOC-CTC-20040907-0010 v1.0
Page 57
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 added. REQUIRED
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 macadd Add a static MAC address to the filtering database.
bridge macdelete Remove a MAC address from the filtering database.
bridge maclist Show the current MAC address filtering database.
E-DOC-CTC-20040907-0010 v1.0
55
Page 58
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
=>
56
E-DOC-CTC-20040907-0010 v1.0
Page 59
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
E-DOC-CTC-20040907-0010 v1.0
57
Page 60
Bridge Commands
58
E-DOC-CTC-20040907-0010 v1.0
Page 61
CIP Commands
CIP Commands
Introduction
This chapter describes the commands of the cip command group.
Contents
This chapter covers the following commands:
cip flush Flush complete Classical IP over ATM (IP oA) configuration. 60
cip ifadd Create a Classical IP oA interface at the local side of the Logical IP Subnet (LIS). 61
cip ifdelete Delete a Classical IP oA interface at the local side of the LIS. 62
cip iflist Show current Classical IP oA configuration. 63
cip pvcadd Create a PVC Address Resolution Protocol (ARP) entry. 64
cip pvcdelete Delete a PVC ARP entry. 65
cip pvclist Show current PVC ARP entries. 66
E-DOC-CTC-20040907-0010 v1.0
59
Page 62
CIP Commands
cip flush
Flush complete Classical IP over ATM (IP oA) configuration.
The flush command does not impact previously saved configurations.
SYNTAX:
cip flush
60
E-DOC-CTC-20040907-0010 v1.0
Page 63
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.
OPTIONAL
EXAMPLE:
=>cip iflist
cip1 addr = 172.16.0.5 mask = 255.255.255.0
=>cip ifadd addr=172.16.1.1 netmask=255.255.255.0
=>cip iflist
cip1 addr = 172.16.0.5 mask = 255.255.255.0
cip0 addr = 172.16.1.1 mask = 255.255.255.0
=>
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
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
RELATED COMMANDS:
cip ifdelete Delete a Classical IP oA interface at the local side of the LIS.
cip iflist Show current Classical IP oA configuration.
E-DOC-CTC-20040907-0010 v1.0
61
Page 64
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 (LIS).
cip iflist Show current Classical IP oA configuration.
62
E-DOC-CTC-20040907-0010 v1.0
Page 65
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:
This exampe shows the 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 (LIS).
cip ifdelete Delete a Classical IP oA interface at the local side of the LIS.
E-DOC-CTC-20040907-0010 v1.0
63
Page 66
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>
where:
[destaddr = <ip-address>]
[mtu = <number {273-20000}>]
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.
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-20040907-0010 v1.0
Page 67
CIP Commands
cip pvcdelete
Delete a PVC ARP entry.
SYNTAX:
cip pvcdelete dest = <phonebook name>
where:
dest The ATM address (hardware address) or name of the entry to be deleted. REQUIRED
EXAMPLE:
=>cip pvclist
CIPPVC1 atmport = 0 vpi = 8 vci = 80 dest_ip = 172.16.1.2
=>cip pvcdelete dest=CIPPVC1
=>cip pvclist
=>
encaps = llc mtu = 546
RELATED COMMANDS:
cip pvcadd Create a PVC Address Resolution Protocol (ARP) entry.
cip pvclist Show current PVC ARP entries.
E-DOC-CTC-20040907-0010 v1.0
65
Page 68
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:
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 Address Resolution Protocol (ARP) entry.
cip pvcdelete Delete a PVC ARP entry.
66
E-DOC-CTC-20040907-0010 v1.0
Page 69
Config Commands
Config Commands
Introduction
This chapter describes the commands of the config command group.
Contents
This chapter covers the following commands:
config backup Store current configuration to backup file. 68
config dump Show the saved configuration file. 69
config erase Erase a user configuration file. 70
config flush Flush the complete current configuration. 71
config list Show the current configuration set. 72
config load Load complete saved (backup) or default configuration file. 73
config save Save the current configuration 74
E-DOC-CTC-20040907-0010 v1.0
67
Page 70
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 Show the current configuration set.
68
E-DOC-CTC-20040907-0010 v1.0
Page 71
config dump
Show the saved configuration file.
SYNTAX:
config dump
RELATED COMMANDS:
config backup Store current configuration to backup file.
config list Show the current configuration set.
Config Commands
E-DOC-CTC-20040907-0010 v1.0
69
Page 72
Config Commands
config erase
Erase a user configuration file.
If no filename is specified, all the user configuration files, saved in the SpeedTouchTM permanent storage,
are deleted.
SYNTAX:
config erase [filename = <string>]
where:
filename Name of the configuration file to erase. OPTIONAL
RELATED COMMANDS:
config flush Flush the complete current configuration.
config load Load complete saved (backup) or default configuration file.
config save Save the current configuration
70
E-DOC-CTC-20040907-0010 v1.0
Page 73
config flush
Flush the complete current configuration.
This command does not affect saved configurations.
SYNTAX:
config flush [flush_ip = <{no | yes}>]
where:
Config Commands
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 ##########
RELATED COMMANDS:
OPTIONAL
config erase Erase a user configuration file.
config load Load complete saved (backup) or default configuration file.
config save Save the current configuration
E-DOC-CTC-20040907-0010 v1.0
71
Page 74
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.
config list Show the current configuration set.
OPTIONAL
72
E-DOC-CTC-20040907-0010 v1.0
Page 75
config load
Load complete saved (backup) or default configuration file.
SYNTAX:
config load [load_ip = <{no | yes}>]
[defaults = <{yes | no}>]
[flush = <{yes | no}>]
[echo = <{no | yes}>]
[filename = <string>]
where:
Config Commands
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) or not (no).
OPTIONAL
Note It is advisable to flush the current configuration before loading the new
configuration.
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 the complete current configuration.
config save Save the current configuration
E-DOC-CTC-20040907-0010 v1.0
73
Page 76
Config Commands
config save
Save the current configuration
All existing configurations and modifications as entered by the user are saved.
The result of executing this command is a user.ini file saved in the SpeedTouch
be downloaded via the SpeedTouchTM web pages or via an FTP session.
SYNTAX:
config save
RELATED COMMANDS:
config erase Erase a user configuration file.
config flush Flush the complete current configuration.
config load Load complete saved (backup) or default configuration file.
TM
permanent storage. This file can
74
E-DOC-CTC-20040907-0010 v1.0
Page 77
DHCP Commands
DHCP Commands
Introduction
This chapter describes the commands of the dhcp command group.
Contents
This chapter covers the following commands:
dhcp client clear Clear Dynamic Host Configuration Protocol (DHCP) client statistics. 76
dhcp client config Show/set DHCP client configuration. 77
dhcp client flush Flush complete DHCP client configuration and dynamic interfaces. 78
dhcp client ifadd Create a DHCP lease for a specific interface. 79
dhcp client ifattach Attach a DHCP lease to a dynamic interface. 80
dhcp client ifconfig Show/set the configuration of DHCP lease created for a specific interface. 81
dhcp client ifdelete Delete a dynamic interface. 83
dhcp client iflist Show all dynamic interfaces. 84
dhcp client ifrelease Release a lease attached to a dynamic interface. 85
dhcp client ifrenew Renew the lease of a dynamic interface. 87
dhcp client stats Show DHCP client statistics. 89
dhcp relay add Add a DHCP server to the DHCP server list. 90
dhcp relay config Set the relay configuration settings. 91
dhcp relay delete Delete a DHCP server from the DHCP server list. 92
dhcp relay flush Flush the DHCP relay settings. 93
dhcp relay ifconfig Configure a relay interface. 94
dhcp relay iflist Show the configuration of the relay interfaces. 95
dhcp relay list Show the DHCP server list. 96
dhcp relay stats Show the DHCP relay statistics. 97
dhcp server clear Clear the DHCP server statistics. 98
dhcp server config Show/set the DHCP server configuration settings. 99
dhcp server flush Flush all the DHCP server pool and lease entries. 100
dhcp server policy Show/set the DHCP server policy. 101
dhcp server stats Show the DHCP server statistics. 102
dhcp server lease add Assign a DHCP server lease to a DHCP host in the local network. 104
dhcp server lease delete Delete a DHCP lease. 105
dhcp server lease flush Flush the complete DHCP server configuration and dynamic leases. 106
dhcp server lease list List the current DHCP leases. 107
dhcp server pool add Add a DHCP server pool. 108
dhcp server pool config Configure an existing DHCP server pool. 109
dhcp server pool delete Delete a DHCP server pool. 111
dhcp server pool flush Flush all the DHCP server pools. 112
dhcp server pool list List the current DHCP server pools. 113
E-DOC-CTC-20040907-0010 v1.0
75
Page 78
DHCP Commands
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 %
=>
RELATED COMMANDS:
dhcp client stats Show DHCP client statistics.
76
E-DOC-CTC-20040907-0010 v1.0
Page 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 Show/set the configuration of DHCP lease created for a specific interface.
E-DOC-CTC-20040907-0010 v1.0
77
Page 80
DHCP Commands
dhcp client flush
Flush complete DHCP client configuration and dynamic interfaces.
The flush command does not impact previously saved configurations.
SYNTAX:
dhcp client flush
EXAMPLE:
=>dhcp client iflist
NewETHoA : [SELECTING]
Number of leases: 1
Total size of table: 19, in use: 1, free: 94 %
=>dhcp client flush
=>dhcp client iflist
No dynamic interfaces defined.
=>
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
78
E-DOC-CTC-20040907-0010 v1.0
Page 81
DHCP Commands
dhcp client ifadd
Create a DHCP lease for a specific interface.
SYNTAX:
dhcp client ifadd intf = <string>
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 ifdelete Delete a dynamic interface.
dhcp client iflist Show all dynamic interfaces.
E-DOC-CTC-20040907-0010 v1.0
79
Page 82
DHCP Commands
dhcp client ifattach
Attach a DHCP lease to a dynamic interface.
SYNTAX:
dhcp client ifattach intf = <string>
where:
intf The name of the dynamic interface to be attached. REQUIRED
EXAMPLE:
=>dhcp client iflist
NewETHoA : [INIT]
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 %
=>
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
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 ifrelease Release a lease attached to a dynamic interface.
dhcp client ifrenew Renew the lease of a dynamic interface.
80
E-DOC-CTC-20040907-0010 v1.0
Page 83
dhcp client ifconfig
Show/set the configuration of DHCP lease created for a specific interface.
SYNTAX:
dhcp client ifconfig intf = <string>
[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:
DHCP Commands
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).
OPTIONAL
OPTIONAL
OPTIONAL
Note Specifying -1 makes the lease permanent.
addrtrans Automatically enable address translation for this dynamic interface (pat) or not
(none).
dns Request (and accept) Domain Name System (DNS) server IP addresses (on) or not
(off).
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.
dnsmetric A number between 0 and 100.
Represents the DNS route metric.
The default is 1.
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
E-DOC-CTC-20040907-0010 v1.0
81
Page 84
DHCP Commands
EXAMPLE:
=>dhcp client iflist
NewETHoA : [INIT]
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]
Number of leases: 1
Total size of table: 19, in use: 1, free: 4 %
=>
flags= uc
IP address : 0.0.0.0
HW address : 00:90:d0:01:47:de
DHCP server : 255.255.255.255
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
82
E-DOC-CTC-20040907-0010 v1.0
Page 85
DHCP Commands
dhcp client ifdelete
Delete a dynamic interface.
SYNTAX:
dhcp client ifdelete intf = <string>
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 iflist Show all dynamic interfaces.
E-DOC-CTC-20040907-0010 v1.0
83
Page 86
DHCP Commands
dhcp client iflist
Show all dynamic interfaces.
SYNTAX:
dhcp client iflist
EXAMPLE 1:
=>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
EXAMPLE 2:
The SpeedTouchTM 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.
84
E-DOC-CTC-20040907-0010 v1.0
Page 87
DHCP Commands
dhcp client ifrelease
Release a lease attached to a dynamic interface.
SYNTAX:
dhcp client ifrelease intf = <string>
where:
intf The name of the dynamic interface. REQUIRED
EXAMPLE 1:
=>dhcp client iflist
NewETHoA : [SELECTING]
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 %
=>
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
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
E-DOC-CTC-20040907-0010 v1.0
85
Page 88
DHCP Commands
EXAMPLE 2:
The SpeedTouchTM 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 a dynamic interface.
dhcp client ifrenew Renew the lease of a dynamic interface.
86
E-DOC-CTC-20040907-0010 v1.0
Page 89
DHCP Commands
dhcp client ifrenew
Renew the lease of a dynamic interface.
SYNTAX:
dhcp client ifrenew intf = <string>
where:
intf The name of the dynamic interface. REQUIRED
EXAMPLE 1:
=>dhcp client iflist
NewETHoA : [BOUND]
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: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
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
E-DOC-CTC-20040907-0010 v1.0
87
Page 90
DHCP Commands
EXAMPLE 2:
The SpeedTouchTM 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)
RELATED COMMANDS:
dhcp client ifattach Attach a DHCP lease to a dynamic interface.
dhcp client ifrelease Release a lease attached to a dynamic interface.
88
E-DOC-CTC-20040907-0010 v1.0
Page 91
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 %
=>
DHCP Commands
RELATED COMMANDS:
dhcp client clear Clear Dynamic Host Configuration Protocol (DHCP) client statistics.
E-DOC-CTC-20040907-0010 v1.0
89
Page 92
DHCP Commands
dhcp relay add
Add a DHCP server to the DHCP server list.
SYNTAX:
dhcp relay add addr = <ip-address>
where:
addr The DHCP server IP address. REQUIRED
intf The name of the relay interface.
Tip Use None to indicate that no interface is specified.
giaddr The
[intf = <none | interface_name>]
[giaddr = <ip-address>]
giaddr
field to be used in relayed DHCP packets. OPTIONAL
OPTIONAL
RELATED COMMANDS:
dhcp relay delete Delete a DHCP server from the DHCP server list.
dhcp relay list Show the DHCP server list.
90
E-DOC-CTC-20040907-0010 v1.0
Page 93
dhcp relay config
Set the relay configuration settings.
SYNTAX:
dhcp server config [agentinfo = <{off | on}>]
[agentmismatch = <{off | on}>]
[trace = <{off | on}>]
where:
DHCP Commands
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 (off) or enable (on) verbose console logging and generation of debug
traces.
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
E-DOC-CTC-20040907-0010 v1.0
91
Page 94
DHCP Commands
dhcp relay delete
Delete a DHCP server from the DHCP server list.
SYNTAX:
dhcp relay delete addr = <ip-address>
where:
addr The DHCP server IP address. REQUIRED
intf The name of the relay interface. OPTIONAL
RELATED COMMANDS:
[intf = <string>]
dhcp relay add Add a DHCP server to the DHCP server list.
dhcp relay list Show the DHCP server list.
92
E-DOC-CTC-20040907-0010 v1.0
Page 95
dhcp relay flush
Flush the DHCP relay settings.
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.
=>
DHCP Commands
E-DOC-CTC-20040907-0010 v1.0
93
Page 96
DHCP Commands
dhcp relay ifconfig
Configure a relay interface.
SYNTAX:
dhcp relay ifconfig intf = <string>
where:
intf The name of the relay interface to be configured. REQUIRED
relay Sets the relay status. OPTIONAL
maxhops A number between 0 and 16.
remoteid Sets the remote id as specified in RFC3046. OPTIONAL
trusted Drop/Forward DHCP request packet when the DHCP Relay Agent Option is enabled
[relay = <{off | on}>]
[maxhops = <number{0-16}>]
[remoteid = <password>]
[trusted = <{no | yes}>]
OPTIONAL
Represents the maximum number of hops allowed in the DHCP packet.
The default is 4.
OPTIONAL
(with the command :dhcp relay config agentinfo=on) and the giaddr field is 0
(RFC3046).
EXAMPLE:
=>dhcp relay ifconfig
intf = pppoa_pppoa
[relay] = off
[maxhops] = 4
[remoteid] =
[trusted] = no
=>
94
E-DOC-CTC-20040907-0010 v1.0
Page 97
dhcp relay iflist
Show the configuration of the relay interfaces.
SYNTAX:
dhcp relay iflist [intf = <string>]
where:
DHCP Commands
intf The name of the relay interface to be shown.
Note If not specified, all the relay interfaces will be shown.
EXAMPLE:
=>dhcp relay iflist
pppoa_pppoa :
admin state = down oper state = down
maxhops=4
trusted = no remote id =
eth0 :
admin state = up oper state = up
maxhops=4
trusted = no remote id =
=>
OPTIONAL
E-DOC-CTC-20040907-0010 v1.0
95
Page 98
DHCP Commands
dhcp relay list
Show the DHCP server list.
SYNTAX:
dhcp relay list
EXAMPLE:
=>dhcp relay list
DHCP server Interface giaddr
-------------------------------------------------------
127.0.0.1 eth0 10.0.0.138
=>
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-20040907-0010 v1.0
Page 99
dhcp relay stats
Show the DHCP relay statistics.
SYNTAX:
dhcp relay stats
EXAMPLE:
=>dhcp relay stats
DHCP relay statistics
------------------------Client packet relayed : 64
Server packet relayed : 0
Bogus relay agent : 0
Bogus giaddr recv : 0
Corrupt agent option : 0
Missing agent option : 0
Bad circuit id : 0
Missing circuit id : 0
=>
DHCP Commands
E-DOC-CTC-20040907-0010 v1.0
97
Page 100
DHCP Commands
dhcp server clear
Clear the DHCP server statistics.
SYNTAX:
dhcp server clear
EXAMPLE:
=>dhcp client stats
Corrupted packet recv : 0
OFFERs recv : 9575
ACKs recv : 121
NAKs recv : 0
Pure BOOTP REPLIES : 0
Other message types : 0
DISCOVERs sent : 9552
REQUESTs sent : 142
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 server 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 %
=>
RELATED COMMANDS:
dhcp server stats Show the DHCP server statistics.
98
E-DOC-CTC-20040907-0010 v1.0
Loading...