Speed Touch 580 Cli Reference Manual

SpeedTouch™580
Wireless Residential ADSL Gateway
CLI Reference Guide
Release R4.3.1
SpeedTouch™
580
R4.3.1
Copyright
Copyright ©1999-2005 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™ is a trademark of THOMSON. Microsoft®, MS-DOS®, Windows® and Windows NT® are either registered trademarks or trademarks of Microsoft Corpo-
ration in the United States and/or other countries.
UNIX® is a registered trademark of UNIX System Laboratories, Incorporated. Apple® and Mac OS® are registered 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. UPnP™ is a certification mark of the UPnP™ Implementers 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 (June 2005) Reference: E-DOC-CTC-20050531-0057 Short Title: CLI Reference Guide ST580 R4.3.1
E-DOC-CTC-20050531-0057 v1.0
i
Contents
Contents
About this Document ....................................................................................1
ADSL Commands........................................................................................... 3
adsl config.....................................................................................................................................................4
adsl info.........................................................................................................................................................6
ATM Commands ............................................................................................ 9
atm flush .....................................................................................................................................................11
atm ifadd..................................................................................................................................................... 12
atm ifattach.................................................................................................................................................13
atm ifconfig.................................................................................................................................................14
atm ifdelete.................................................................................................................................................16
atm ifdetach................................................................................................................................................17
atm iflist ...................................................................................................................................................... 18
atm bundle add ..........................................................................................................................................19
atm bundle attach ......................................................................................................................................20
atm bundle config ...................................................................................................................................... 21
atm bundle clear......................................................................................................................................... 22
atm bundle delete ......................................................................................................................................23
atm bundle detach .....................................................................................................................................24
atm bundle flush ........................................................................................................................................25
atm bundle ifadd ........................................................................................................................................ 26
atm bundle ifconfig.................................................................................................................................... 27
atm bundle ifdelete ....................................................................................................................................28
atm bundle list............................................................................................................................................29
atm cac config ............................................................................................................................................30
atm cac list..................................................................................................................................................31
atm cac overbooking..................................................................................................................................32
atm debug aal5stats................................................................................................................................... 33
atm debug gstats........................................................................................................................................ 34
atm debug portstats................................................................................................................................... 35
atm oam config ..........................................................................................................................................36
atm oam list................................................................................................................................................37
atm oam modify.........................................................................................................................................38
atm oam ping .............................................................................................................................................39
atm oam cc list ...........................................................................................................................................40
atm oam cc modify ....................................................................................................................................41
atm oam cc send ........................................................................................................................................ 42
Contents
E-DOC-CTC-20050531-0057 v1.0
ii
atm oam vclb add.......................................................................................................................................43
atm oam vclb del........................................................................................................................................44
atm oam vclb list........................................................................................................................................45
atm phonebook add...................................................................................................................................46
atm phonebook autolist............................................................................................................................. 47
atm phonebook delete...............................................................................................................................48
atm phonebook flush.................................................................................................................................49
atm phonebook list ....................................................................................................................................50
atm qosbook add........................................................................................................................................51
atm qosbook config ................................................................................................................................... 52
atm qosbook ctdadd ..................................................................................................................................53
atm qosbook ctddelete .............................................................................................................................. 55
atm qosbook ctdlist.................................................................................................................................... 56
atm qosbook delete.................................................................................................................................... 57
atm qosbook flush......................................................................................................................................58
atm qosbook list.........................................................................................................................................59
AutoPVC Commands................................................................................... 61
autopvc config............................................................................................................................................62
autopvc list.................................................................................................................................................. 63
Config Commands .......................................................................................65
config delete ............................................................................................................................................... 66
config dump................................................................................................................................................ 67
config flush ................................................................................................................................................. 68
config list..................................................................................................................................................... 69
config load .................................................................................................................................................. 70
config save..................................................................................................................................................71
Connection Commands............................................................................... 73
connection appconfig ................................................................................................................................74
connection appinfo ....................................................................................................................................76
connection applist......................................................................................................................................77
connection bind.......................................................................................................................................... 78
connection bindlist..................................................................................................................................... 79
connection clean ........................................................................................................................................80
connection clear ......................................................................................................................................... 81
connection config....................................................................................................................................... 82
connection debug....................................................................................................................................... 83
connection describe...................................................................................................................................84
E-DOC-CTC-20050531-0057 v1.0
iii
Contents
connection flush.........................................................................................................................................85
connection info...........................................................................................................................................86
connection list ............................................................................................................................................87
connection refresh ..................................................................................................................................... 88
connection stats .........................................................................................................................................89
connection timerclear ................................................................................................................................90
connection timerconfig.............................................................................................................................. 91
connection unbind .....................................................................................................................................92
CWMP Commands....................................................................................... 93
cwmp config ............................................................................................................................................... 94
cwmp traceconfig....................................................................................................................................... 96
cwmp server config....................................................................................................................................97
Debug Commands ....................................................................................... 99
debug exec................................................................................................................................................ 100
DHCP Commands....................................................................................... 101
dhcp client flush ....................................................................................................................................... 103
dhcp client ifadd.......................................................................................................................................104
dhcp client ifattach................................................................................................................................... 105
dhcp client ifconfig................................................................................................................................... 106
dhcp client ifdelete...................................................................................................................................108
dhcp client iflist ........................................................................................................................................109
dhcp client ifrelease .................................................................................................................................110
dhcp client ifrenew................................................................................................................................... 112
dhcp client debug clear............................................................................................................................114
dhcp client debug stats............................................................................................................................115
dhcp client debug traceconfig.................................................................................................................116
dhcp relay add..........................................................................................................................................117
dhcp relay config...................................................................................................................................... 118
dhcp relay delete...................................................................................................................................... 119
dhcp relay flush........................................................................................................................................120
dhcp relay ifconfig....................................................................................................................................121
dhcp relay iflist .........................................................................................................................................122
dhcp relay list ...........................................................................................................................................123
dhcp relay debug stats.............................................................................................................................124
dhcp relay debug traceconfig.................................................................................................................. 125
dhcp server config....................................................................................................................................126
dhcp server flush...................................................................................................................................... 127
Contents
E-DOC-CTC-20050531-0057 v1.0
iv
dhcp server policy....................................................................................................................................128
dhcp server debug clear ..........................................................................................................................129
dhcp server debug stats .......................................................................................................................... 130
dhcp server debug traceconfig ...............................................................................................................132
dhcp server lease add.............................................................................................................................. 133
dhcp server lease delete.......................................................................................................................... 135
dhcp server lease flush............................................................................................................................ 136
dhcp server lease list ............................................................................................................................... 137
dhcp server option flush.......................................................................................................................... 138
dhcp server option instadd......................................................................................................................139
dhcp server option instdelete..................................................................................................................140
dhcp server option instlist....................................................................................................................... 141
dhcp server option tmpladd.................................................................................................................... 142
dhcp server option tmpldelete................................................................................................................ 143
dhcp server option tmpllist ..................................................................................................................... 144
dhcp server pool add ...............................................................................................................................145
dhcp server pool config...........................................................................................................................146
dhcp server pool delete ...........................................................................................................................148
dhcp server pool flush .............................................................................................................................149
dhcp server pool list.................................................................................................................................150
dhcp server pool optadd..........................................................................................................................151
dhcp server pool optdelete......................................................................................................................152
dhcp server pool rtadd.............................................................................................................................153
dhcp server pool rtdelete.........................................................................................................................154
dhcp server pool ruleadd.........................................................................................................................155
dhcp server pool ruledelete.....................................................................................................................156
dhcp server rule add ................................................................................................................................157
dhcp server rule delete ............................................................................................................................158
dhcp server rule flush ..............................................................................................................................159
dhcp server rule list..................................................................................................................................160
DNS Commands......................................................................................... 161
dns client config .......................................................................................................................................162
dns client dnsadd .....................................................................................................................................163
dns client dnsdelete .................................................................................................................................164
dns client dnslist.......................................................................................................................................165
dns client flush .........................................................................................................................................166
dns client nslookup ..................................................................................................................................167
dns server config...................................................................................................................................... 168
dns server flush........................................................................................................................................169
dns server debug clear ............................................................................................................................ 170
E-DOC-CTC-20050531-0057 v1.0
v
Contents
dns server debug stats.............................................................................................................................171
dns server debug spoof clear.................................................................................................................. 172
dns server debug spoof getaddress ....................................................................................................... 173
dns server debug spoof getflags ............................................................................................................174
dns server debug spoof list.....................................................................................................................175
dns server debug spoof update .............................................................................................................. 176
dns server host add..................................................................................................................................177
dns server host delete..............................................................................................................................178
dns server host flush................................................................................................................................179
dns server host list...................................................................................................................................180
dns server route add................................................................................................................................ 181
dns server route delete............................................................................................................................ 182
dns server route flush.............................................................................................................................. 183
dns server route list ................................................................................................................................. 184
DSD Commands......................................................................................... 185
dsd config .................................................................................................................................................187
dsd debug connection list ....................................................................................................................... 188
dsd debug proxy ......................................................................................................................................189
dsd debug recycling................................................................................................................................. 190
dsd debug stats ........................................................................................................................................ 191
dsd intercept config .................................................................................................................................192
dsd intercept stats.................................................................................................................................... 194
dsd syslog config .....................................................................................................................................195
dsd syslog list...........................................................................................................................................196
dsd urlfilter config.................................................................................................................................... 197
dsd urlfilter rule add.................................................................................................................................198
dsd urlfilter rule delete.............................................................................................................................199
dsd urlfilter rule flush...............................................................................................................................200
dsd urlfilter rule list.................................................................................................................................. 201
dsd urlfilter rule modify........................................................................................................................... 202
dsd webfilter cache flush.........................................................................................................................203
dsd webfilter cache stats .........................................................................................................................204
dsd webfilter config ................................................................................................................................. 205
dsd webfilter list.......................................................................................................................................206
dsd webfilter professional category add................................................................................................ 207
dsd webfilter professional category create ............................................................................................ 208
dsd webfilter professional category delete ............................................................................................ 209
dsd webfilter professional category flush..............................................................................................210
dsd webfilter professional category list................................................................................................. 211
dsd webfilter professional category remove......................................................................................... 212
Contents
E-DOC-CTC-20050531-0057 v1.0
vi
dsd webfilter professional config ........................................................................................................... 213
dsd webfilter professional level add.......................................................................................................214
dsd webfilter professional level delete................................................................................................... 215
dsd webfilter professional level flush..................................................................................................... 216
dsd webfilter professional level list........................................................................................................ 217
dsd webfilter professional level modify................................................................................................. 218
dsd webfilter professional level set........................................................................................................ 219
dsd webfilter professional rule clear ...................................................................................................... 220
dsd webfilter professional rule list .........................................................................................................221
dsd webfilter professional modify.......................................................................................................... 222
dsd webfilter server add.......................................................................................................................... 223
dsd webfilter server config......................................................................................................................224
dsd webfilter server delete...................................................................................................................... 225
dsd webfilter server flush........................................................................................................................ 226
dsd webfilter server list ........................................................................................................................... 227
dsd webfilter server modify .................................................................................................................... 228
dsd webfilter standard category add......................................................................................................229
dsd webfilter standard category create..................................................................................................230
dsd webfilter standard category delete..................................................................................................231
dsd webfilter standard category flush....................................................................................................232
dsd webfilter standard category list ....................................................................................................... 233
dsd webfilter standard category remove ............................................................................................... 234
dsd webfilter standard level add.............................................................................................................235
dsd webfilter standard level delete.........................................................................................................236
dsd webfilter standard level flush...........................................................................................................237
dsd webfilter standard level list..............................................................................................................238
dsd webfilter standard level modify....................................................................................................... 239
dsd webfilter standard level set...............................................................................................
............... 240
dsd webfilter standard rule clear ............................................................................................................ 241
dsd webfilter standard rule list ............................................................................................................... 242
dsd webfilter standard rule modify ........................................................................................................243
DynDNS Commands.................................................................................. 245
dyndns add ............................................................................................................................................... 246
dyndns delete ........................................................................................................................................... 247
dyndns flush ............................................................................................................................................. 248
dyndns list................................................................................................................................................. 249
dyndns modify.......................................................................................................................................... 250
dyndns host add.......................................................................................................................................252
dyndns host delete................................................................................................................................... 253
dyndns host flush.....................................................................................................................................254
E-DOC-CTC-20050531-0057 v1.0
vii
Contents
dyndns host list ........................................................................................................................................ 255
dyndns service list....................................................................................................................................256
dyndns service modify.............................................................................................................................257
Env Commands .......................................................................................... 259
env flush.................................................................................................................................................... 260
env get....................................................................................................................................................... 261
env list.......................................................................................................................................................262
env set.......................................................................................................................................................263
env unset................................................................................................................................................... 264
Eth Commands........................................................................................... 265
eth ifadd .................................................................................................................................................... 266
eth ifattach ................................................................................................................................................ 267
eth ifconfig................................................................................................................................................268
eth ifdelete ................................................................................................................................................ 269
eth ifdetach ............................................................................................................................................... 270
eth iflist......................................................................................................................................................271
eth flush ....................................................................................................................................................272
eth bridge clear......................................................................................................................................... 273
eth bridge config ...................................................................................................................................... 274
eth bridge flush ........................................................................................................................................275
eth bridge ifadd ........................................................................................................................................ 276
eth bridge ifattach ....................................................................................................................................277
eth bridge ifconfig....................................................................................................................................278
eth bridge ifdelete .................................................................................................................................... 280
eth bridge ifdetach ...................................................................................................................................281
eth bridge iflist.......................................................................................................................................... 282
eth bridge macadd ...................................................................................................................................283
eth bridge macdelete ............................................................................................................................... 284
eth bridge maclist..................................................................................................................................... 285
eth bridge mcdadd...................................................................................................................................286
eth bridge mcddelete...............................................................................................................................287
eth bridge mcdlist ....................................................................................................................................288
eth device ifconfig....................................................................................................................................289
eth device iflist.......................................................................................................................................... 290
eth switch group flush .............................................................................................................................291
eth switch group list.................................................................................................................................292
eth switch group move............................................................................................................................ 293
eth switch mirror capture ........................................................................................................................294
Contents
E-DOC-CTC-20050531-0057 v1.0
viii
eth switch mirror egress.......................................................................................................................... 295
eth switch mirror ingress.........................................................................................................................296
Expr Commands......................................................................................... 297
expr add .................................................................................................................................................... 298
expr delete ................................................................................................................................................ 301
expr flush .................................................................................................................................................. 302
expr list...................................................................................................................................................... 303
expr modify............................................................................................................................................... 306
Firewall Commands................................................................................... 309
firewall config...........................................................................................................................................310
firewall clear .............................................................................................................................................312
firewall list.................................................................................................................................................313
firewall chain add.....................................................................................................................................314
firewall chain delete.................................................................................................................................315
firewall chain flush...................................................................................................................................316
firewall chain list ......................................................................................................................................317
firewall debug clear.................................................................................................................................. 318
firewall debug stats..................................................................................................................................319
firewall debug traceconfig....................................................................................................................... 320
firewall level add ...................................................................................................................................... 321
firewall level delete ..................................................................................................................................322
firewall level flush .................................................................................................................................... 323
firewall level list........................................................................................................................................ 324
firewall level modify................................................................................................................................. 325
firewall level set........................................................................................................................................ 326
firewall rule add........................................................................................................................................ 327
firewall rule delete....................................................................................................................................329
firewall rule flush...................................................................................................................................... 330
firewall rule list.........................................................................................................................................331
firewall rule modify..................................................................................................................................333
firewall rule debug clear.......................................................................................................................... 334
firewall rule debug stats ..........................................................................................................................336
firewall rule debug traceconfig...............................................................................................................337
GRP Commands ......................................................................................... 339
grp config..................................................................................................................................................340
grp flush.................................................................................................................................................... 341
grp rtlist.....................................................................................................................................................342
E-DOC-CTC-20050531-0057 v1.0
ix
Contents
grp rip config ............................................................................................................................................ 343
grp rip flush ..............................................................................................................................................345
grp rip ifconfig..........................................................................................................................................346
grp rip show.............................................................................................................................................. 348
Hostmgr Commands .................................................................................349
hostmgr add .............................................................................................................................................350
hostmgr clear............................................................................................................................................ 352
hostmgr config ......................................................................................................................................... 353
hostmgr delete .........................................................................................................................................354
hostmgr flush ...........................................................................................................................................355
hostmgr list...............................................................................................................................................356
IDS Commands ..........................................................................................357
ids clear.....................................................................................................................................................358
ids config................................................................................................................................................... 359
ids parser list ............................................................................................................................................360
ids parser modify .....................................................................................................................................361
ids pattern clear........................................................................................................................................ 362
ids pattern list...........................................................................................................................................363
ids pattern stats........................................................................................................................................364
ids signature list .......................................................................................................................................365
ids signature modify ................................................................................................................................366
ids threshold clear....................................................................................................................................367
ids threshold list.......................................................................................................................................368
ids threshold modify................................................................................................................................ 369
Interface Commands ................................................................................. 371
interface list ..............................................................................................................................................372
IP Commands .............................................................................................373
ip arpadd...................................................................................................................................................375
ip arpdelete...............................................................................................................................................376
ip arplist ....................................................................................................................................................377
ip config ....................................................................................................................................................378
ip flush....................................................................................................................................................... 380
ip ifadd ......................................................................................................................................................381
ip ifattach ..................................................................................................................................................382
ip ifconfig .................................................................................................................................................. 383
ip ifdelete ..................................................................................................................................................385
Contents
E-DOC-CTC-20050531-0057 v1.0
x
ip ifdetach .................................................................................................................................................386
ip iflist........................................................................................................................................................387
ip ifwait...................................................................................................................................................... 388
ip ipadd .....................................................................................................................................................389
ip ipconfig ................................................................................................................................................. 390
ip ipdelete .................................................................................................................................................391
ip iplist.......................................................................................................................................................392
ip mcadd ...................................................................................................................................................393
ip mcdelete ...............................................................................................................................................394
ip mclist.....................................................................................................................................................395
ip rtadd......................................................................................................................................................396
ip rtdelete..................................................................................................................................................397
ip rtlist ....................................................................................................................................................... 398
ip auto flush..............................................................................................................................................399
ip auto ifadd..............................................................................................................................................400
ip auto ifattach.......................................................................................................................................... 401
ip auto ifconfig.......................................................................................................................................... 402
ip auto ifdelete..........................................................................................................................................404
ip auto ifdetach.........................................................................................................................................405
ip auto iflist ............................................................................................................................................... 406
ip debug httpprobe ..................................................................................................................................407
ip debug ping............................................................................................................................................ 408
ip debug sendto........................................................................................................................................409
ip debug stats ........................................................................................................................................... 411
ip debug traceconfig ................................................................................................................................412
ip debug traceroute.................................................................................................................................. 413
IPQoS Commands...................................................................................... 415
ipqos config .............................................................................................................................................. 416
ipqos list....................................................................................................................................................418
ipqos ef config..........................................................................................................................................419
ipqos ef list................................................................................................................................................ 420
ipqos ef stats............................................................................................................................................. 421
ipqos queue clear.....................................................................................................................................422
ipqos queue config................................................................................................................................... 423
ipqos queue list ........................................................................................................................................ 425
ipqos queue stats ..................................................................................................................................... 426
Label Commands .......................................................................................427
label add.................................................................................................................................................... 428
E-DOC-CTC-20050531-0057 v1.0
xi
Contents
label delete................................................................................................................................................ 429
label flush.................................................................................................................................................. 430
label list..................................................................................................................................................... 431
label modify..............................................................................................................................................432
label chain add .........................................................................................................................................434
label chain delete .....................................................................................................................................435
label chain flush .......................................................................................................................................436
label chain list...........................................................................................................................................437
label rule add............................................................................................................................................438
label rule delete........................................................................................................................................440
label rule flush..........................................................................................................................................441
label rule list .............................................................................................................................................442
label rule modify ......................................................................................................................................443
label rule debug clear .............................................................................................................................. 444
label rule debug stats...............................................................................................................................445
label rule debug traceconfig....................................................................................................................446
Language Commands................................................................................ 447
language config........................................................................................................................................448
language delete........................................................................................................................................449
language list .............................................................................................................................................450
MLP Commands ........................................................................................ 451
mlp flush ................................................................................................................................................... 452
mlp import ................................................................................................................................................ 453
mlp debug export..................................................................................................................................... 454
mlp debug stats........................................................................................................................................ 455
mlp debug traceconfig............................................................................................................................. 456
mlp privilege add ..................................................................................................................................... 457
mlp privilege addzone ............................................................................................................................. 458
mlp privilege config ................................................................................................................................. 459
mlp privilege delete ................................................................................................................................. 460
mlp privilege list....................................................................................................................................... 461
mlp privilege removezone....................................................................................................................... 462
mlp role add.............................................................................................................................................. 463
mlp role addpriv.......................................................................................................................................464
mlp role config .........................................................................................................................................465
mlp role delete.......................................................................................................................................... 466
mlp role list...............................................................................................................................................467
mlp role removepriv ................................................................................................................................ 468
Contents
E-DOC-CTC-20050531-0057 v1.0
xii
NAT Commands......................................................................................... 469
nat config .................................................................................................................................................. 470
nat flush ....................................................................................................................................................471
nat ifconfig................................................................................................................................................472
nat iflist......................................................................................................................................................473
nat mapadd...............................................................................................................................................474
nat mapdelete...........................................................................................................................................477
nat maplist ................................................................................................................................................ 478
nat tmpladd............................................................................................................................................... 479
nat tmpldelete........................................................................................................................................... 482
nat tmpllist................................................................................................................................................483
nat tmplinst...............................................................................................................................................484
PPP Commands.......................................................................................... 485
ppp flush ................................................................................................................................................... 486
ppp ifadd................................................................................................................................................... 487
ppp ifattach............................................................................................................................................... 488
ppp ifconfig...............................................................................................................................................489
ppp ifdelete...............................................................................................................................................493
ppp ifdetach..............................................................................................................................................494
ppp iflist .................................................................................................................................................... 495
ppp ifscan.................................................................................................................................................. 496
ppp rtadd................................................................................................................................................... 497
ppp rtdelete............................................................................................................................................... 499
ppp relay flush..........................................................................................................................................500
ppp relay ifadd.......................................................................................................................................... 501
ppp relay ifdelete...................................................................................................................................... 502
ppp relay iflist...........................................................................................................................................503
ppp relay sesslist...................................................................................................................................... 504
PPTP Commands........................................................................................ 505
pptp ifadd..................................................................................................................................................506
pptp flush..................................................................................................................................................507
pptp list ..................................................................................................................................................... 508
pptp profadd.............................................................................................................................................509
pptp profdelete.........................................................................................................................................510
pptp proflist ..............................................................................................................................................511
Service Commands.................................................................................... 513
service host assign................................................................................................................................... 514
E-DOC-CTC-20050531-0057 v1.0
xiii
Contents
service host config ...................................................................................................................................515
service host add .......................................................................................................................................516
service host delete ...................................................................................................................................517
service host disable..................................................................................................................................518
service host flush .....................................................................................................................................519
service host list......................................................................................................................................... 520
service host stats...................................................................................................................................... 521
service host triggerlist ............................................................................................................................. 522
service host rule add................................................................................................................................ 523
service host rule delete............................................................................................................................ 524
service system ifadd ................................................................................................................................ 525
service system ifdelete ............................................................................................................................ 526
service system ipadd ............................................................................................................................... 527
service system ipdelete ........................................................................................................................... 528
service system list.................................................................................................................................... 529
service system mapadd........................................................................................................................... 530
service system mapdelete.......................................................................................................................531
service system modify............................................................................................................................. 532
Script Commands ...................................................................................... 533
script add .................................................................................................................................................. 534
script delete ..............................................................................................................................................535
script flush ................................................................................................................................................536
script list....................................................................................................................................................537
script run................................................................................................................................................... 538
SNMP Commands...................................................................................... 539
snmp config..............................................................................................................................................540
snmp get ................................................................................................................................................... 541
snmp getnext............................................................................................................................................542
snmp walk.................................................................................................................................................543
snmp community add..............................................................................................................................544
snmp community delete.......................................................................................................................... 545
snmp community list ............................................................................................................................... 546
snmp community modify........................................................................................................................547
SNTP Commands....................................................................................... 549
sntp add ....................................................................................................................................................550
sntp config ................................................................................................................................................ 551
sntp delete ................................................................................................................................................552
Contents
E-DOC-CTC-20050531-0057 v1.0
xiv
sntp flush .................................................................................................................................................. 553
sntp list......................................................................................................................................................554
Software Commands................................................................................. 555
software cleanup......................................................................................................................................556
software deletepassive ............................................................................................................................ 557
software duplicate....................................................................................................................................558
software setpassive.................................................................................................................................. 559
software switch ........................................................................................................................................560
software upgrade ..................................................................................................................................... 561
software version.......................................................................................................................................562
System Commands ................................................................................... 563
system config ...........................................................................................................................................564
system flush.............................................................................................................................................. 566
system locale............................................................................................................................................567
system reboot........................................................................................................................................... 569
system reset.............................................................................................................................................. 570
system debug autosave........................................................................................................................... 571
system debug stats ..................................................................................................................................572
system ra config.......................................................................................................................................573
system rtc synchronize ............................................................................................................................574
system rtc settime....................................................................................................................................575
Systemlog Commands .............................................................................. 577
systemlog flush ........................................................................................................................................ 578
systemlog show .......................................................................................................................................579
systemlog send ........................................................................................................................................580
UPnP Commands ....................................................................................... 581
upnp config...............................................................................................................................................582
upnp flush.................................................................................................................................................583
upnp list ....................................................................................................................................................584
User Commands ........................................................................................ 585
user add ....................................................................................................................................................586
user config ................................................................................................................................................ 588
user delete ................................................................................................................................................589
user flush ..................................................................................................................................................590
user list......................................................................................................................................................591
E-DOC-CTC-20050531-0057 v1.0
xv
Contents
user rights.................................................................................................................................................593
Wireless Commands.................................................................................. 595
wireless ifconfig .......................................................................................................................................596
wireless reset............................................................................................................................................598
wireless debug stats ................................................................................................................................599
wireless macacl add................................................................................................................................. 600
wireless macacl config.............................................................................................................................601
wireless macacl delete............................................................................................................................. 602
wireless macacl flush............................................................................................................................... 603
wireless macacl list .................................................................................................................................. 604
wireless macacl modify ...........................................................................................................................605
wireless macacl register ..........................................................................................................................606
wireless secmode config .........................................................................................................................607
wireless secmode wep.............................................................................................................................608
wireless secmode wpa-psk......................................................................................................................609
wireless stations list................................................................................................................................. 610
wireless wds add...................................................................................................................................... 611
wireless wds config.................................................................................................................................. 612
wireless wds delete.................................................................................................................................. 613
wireless wds flush.................................................................................................................................... 614
wireless wds list ....................................................................................................................................... 615
wireless wds scanresults.........................................................................................................................616
Abbreviations ............................................................................................. 617
System Logging Messages ....................................................................... 621
Auto-PVC Module..................................................................................................................................... 622
Configuration Module..............................................................................................................................622
DHCP Client Module................................................................................................................................. 622
DHCP Relay Module.................................................................................................................................623
DHCP Server Module ...............................................................................................................................623
Dyndns Module ........................................................................................................................................624
Firewall Module........................................................................................................................................ 624
LOGIN Module..........................................................................................................................................625
Kernel Module ..........................................................................................................................................625
Linestate Module...................................................................................................................................... 625
NAPT Module ...........................................................................................................................................625
PPP Module............................................................................................................................................... 626
PPTP Module ............................................................................................................................................626
Contents
E-DOC-CTC-20050531-0057 v1.0
xvi
RIP Module................................................................................................................................................ 627
Routing Module........................................................................................................................................628
Session Module........................................................................................................................................ 628
SNTP Module............................................................................................................................................ 628
Software Module......................................................................................................................................629
UPnP Module............................................................................................................................................629
Wireless Module....................................................................................................................................... 629
Supported Key Names .............................................................................. 631
Supported IP Protocols............................................................................................................................ 632
Supported TCP/UDP Port Names............................................................................................................633
Supported ICMP Type Names.................................................................................................................636
Supported Facilities ................................................................................................................................ 637
Supported Severities .............................................................................................................................. 638
IP Precedence ...........................................................................................................................................638
Differentiated Services Code Point (DSCP)............................................................................................ 639
About this Document
E-DOC-CTC-20050531-0057 v1.0
1
About this Document
Introduction
Welcome to the SpeedTouch™ Command Line Interface (CLI) Reference Guide!
For the Service Provider, this Reference Guide aims to be a concise and practical document for creating a customized Service Template file, based on the SpeedTouch™ CLI command set, to be used by the end user to configure the SpeedTouch™ and computer(s).
For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and troubleshooting of the SpeedTouch™ via its character based CLI command set.
Applicability
This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch™ products:
SpeedTouch™580(i) Wireless Multi-User ADSL Gateway (R4.3.1)For readability, all are referred to as SpeedTouch™ throughout this document unless a specific variant is concerned.
Contents
The CLI Reference Guide describes all the available CLI commands of the SpeedTouch™ per command group and in alphabetical order.
Each command is described in a systematic manner:
The full name of the CLI command (including the group selection).
A short description of the CLI command, if necessary completed by a description of the possible impact on
the user and/or the SpeedTouch™.
The syntax of the command with a description of each parameter.
An example to demonstrate the use of the CLI command.
A list of related CLI commands.
Other Information
For more information on the SpeedTouch™ CLI, various access methods, general manipilations to navigate through the CLI refer to the SpeedTouch™580 User’s Guide.
For a description on the functional use of the CLI commands see the corresponding SpeedTouch™ configuration guides and application notes.
About this Document
E-DOC-CTC-20050531-0057 v1.0
2
Trademarks
The following trademarks are used in this document:
SpeedTouch™ is a trademark of THOMSON.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
Windows and Internet Explorer are trademarks of Microsoft Corporation.
Apple and MacOS are registered trademarks of Apple Computer Inc.
UNIX is a registered trademark of UNIX System Laboratories, Inc.
Ethernet is a trademark of Xerox Corporation.
Other products may be trademarks or registered trademarks of their respective manufacturers.
Symbols
The following symbols are used in this CLI Reference Guide:
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 “.
Documentation and software updates
THOMSON continuously develops new solutions, but is also committed to improve its existing products.
For suggestions regarding this document, please contact documentation.speedtouch@thomson.net
.
For more information on THOMSON's latest technological innovations, documents and software releases, visit us at:
www.speedtouch.com
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.
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
3
ADSL Commands
Contents
This chapter covers the following commands:
adsl config Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration. 4
adsl info Show ADSL statistics and information about the SpeedTouch™ DSL line
status.
6
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
4
adsl config
Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration.
SYNTAX FOR ADSL/Plain Old Telephone Service (POTS) variants:
where:
Although the command is the same for both SpeedTouch™ ADSL/POTS and SpeedTouch™ ADSL/ISDN variants, the command features specific parameter values per variant:
adsl config [opermode = <{ansi|g.dmt_annex_a|g.lite|multimode}>]
[maxbitspertoneUS = <number{10-14}>][trace = <{off|on}>] [extendedBWmode = <number{0-2}>]
opermode The operational mode of the SpeedTouch™ modem.
Choose between:
ansi
g.dmt_annex_a
g.lite
multimode.
The default is multimode.
OPTIONAL
maxbitspertoneUS A number between 10 and 14 (bits per tone).
Represents the maximum number of bits which can be allocated to each ADSL DMT tone in the upstream direction. The default is 13.
OPTIONAL
trace Enable/disable adsl tracing. OPTIONAL
extendedBWmode Select either 0,1 or2 OPTIONAL
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
5
SYNTAX FOR ADSL/Integrated Services Digital Network (ISDN) variants:
where:
adsl config [opermode = <{etsi|g.dmt_annex_b|multimode}>]
[maxbitspertoneUS = <number{10-14}>][trace = <{off|on}>] [extendedBWmode = <number{0-2}>]
opermode The operational mode of the SpeedTouch™ modem.
Choose between:
ansi
g.dmt_annex_b
multimode.
The default is multimode.
OPTIONAL
maxbitspertoneUS A number between 10 and 14 (bits per tone).
Represents the maximum number of bits which can be allocated to each ADSL DMT tone in the upstream direction. The default is 13.
OPTIONAL
trace Enable/disable adsl tracing. OPTIONAL
extendedBWmode Select either 0,1 or2 OPTIONAL
If the command adsl config is executed and no parameters are specified, then the current ADSL configuration is shown.
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
6
adsl info
Show ADSL statistics and information about the SpeedTouch™ DSL line status.
Although the same command is used for both SpeedTouch™ ADSL/POTS and SpeedTouch™ ADSL/ISDN variants, the command features specific output parameters and counters per variant.
SYNTAX:
EXAMPLE (for a SpeedTouch™ ADSL/POTS variant):
.. Continued output on following page ..
adsl info
=>adsl info Modemstate : up Operation Mode : G.DMT Annex A [POTS Overlay Mode] Channel Mode : fast Number of resets : 1
Vendor (ITU) Local Remote
Country : 0f 0f Vendor : ALCB ALCB VendorSpecific : 0000 0000 StandardRevisionNr : 01 01
Downstream Upstream Margin [dB] : 25 31 Attenuation [dB] : 26 15
Available Bandwidth Cells/s Kbit/s
Downstream : 7924 3360 Upstream : 452 192
Transfer statistics
Total since power On Cells Kbit
Downstream : 10153 4304 Upstream : 3399 1441
Current Connection
Downstream : 10153 4304 Upstream : 3399 1441 Errors
Received FEC : 0 Received CRC : 0 Received HEC : 0
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
7
.. Continued output ..
Far End Failure
No Failure
Near end failure
No failure
Far end failures since reset
Loss of frame: 0 failures Loss of signal: 0 failures Loss of power: 0 failures Loss of link: 0 failures Errored seconds: 0 seconds
Far end failures last 15 minutes
Loss of frame: 0 seconds Loss of signal: 0 seconds Loss of power: 0 seconds Loss of link: 0 seconds Errored seconds: 0 seconds
Far end failures current day
Errored seconds: 0 seconds
Far end failures previous day
Errored seconds: 0 seconds
Near end failures since reset
Loss of frame: 0 failures Loss of signal: 0 failures Loss of power: 0 failures Errored seconds: 0 seconds
Near end failures last 15 minutes
Loss of frame: 0 seconds Loss of signal: 0 seconds Loss of power: 0 seconds Errored seconds: 0 seconds
Near end failures current day
Errored seconds: 0 seconds
Near end failures previous day
Errored seconds: 0 seconds
=>
ADSL Commands
E-DOC-CTC-20050531-0057 v1.0
8
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
9
ATM Commands
Introduction
This chapter describes the commands of the atm command group.
Contents
This chapter covers the following commands:
atm flush Flush all Asynchronous Transfer Mode (ATM) interfaces. 11
atm ifadd Create a new ATM interface. 12
atm ifattach Attach a ATM interface. 13
atm ifconfig Configure an ATM interface. 14
atm ifdelete Delete an ATM interface. 16
atm ifdetach Detach an ATM interface. 17
atm iflist Display the ATM interfaces. 18
atm bundle add Add a new bundle of interfaces. 19
atm bundle attach Attach a bundle of interfaces. 20
atm bundle config Modify a bundle of interfaces. 21
atm bundle clear Clear the bundle statistics. 22
atm bundle delete Delete a bundle of interfaces. 23
atm bundle detach Detach a bundle of interfaces. 24
atm bundle flush Flush all bundles. 25
atm bundle ifadd Add an interface on a bundle. 26
atm bundle ifconfig Configure an interface from a bundle. 27
atm bundle ifdelete Remove an interface from a bundle. 28
atm bundle list Display the current bundles. 29
atm cac config Configure the ATM connection admission control. 30
atm cac list Display all the CAC parameters. 31
atm cac overbooking Configure ATM overbooking parameters. 32
atm debug aal5stats Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics. 33
atm debug gstats Display ATM global statistics. 34
atm debug portstats Display port specific ATM statistics. 35
atm oam config Modify the ATM Operation and Maintenance (OAM) settings. 36
atm oam list Display the ATM OAM settings. 37
atm oam modify Modify the ATM OAM data blocking mode. 38
atm oam ping Send ATM loopback cells. 39
atm oam cc list Display Continuity Check (CC) configuration. 40
atm oam cc modify Modify CC on the connection. 41
atm oam cc send Send CC activate/deactivate to connection. 42
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
10
atm oam vclb add Create a loopback connection for VC. 43
atm oam vclb del Delete a loopback connection for VC. 44
atm oam vclb list List all VC loopback connections. 45
atm phonebook add Add a new phonebook entry. 46
atm phonebook autolist Show the auto PVCs. 47
atm phonebook delete Delete an existing phonebook entry. 48
atm phonebook flush Flush all the phonebook entries. 49
atm phonebook list Display the current phonebook. 50
atm qosbook add Add a new QoS book entry. 51
atm qosbook config Modify the QoS book configuration. 52
atm qosbook ctdadd Add a Connection Traffic Descriptor (CTD). 53
atm qosbook ctddelete Delete a CTD. 55
atm qosbook ctdlist Display all CTDs. 56
atm qosbook delete Delete a QoS book entry. 57
atm qosbook flush Flush all the QoS book entries. 58
atm qosbook list Display the QoS book. 59
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
11
atm flush
Flush all Asynchronous Transfer Mode (ATM) interfaces.
SYNTAX:
atm flush
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
12
atm ifadd
Create a new ATM interface.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm ifadd intf = <string>
intf The name for the new ATM interface.
Note If not specified, the destination parameter must be specified. In this case the
name of the destination will double as interface name.
REQUIRED
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : disabled Ulp : mac Connection State : connected
=> =>atm ifadd intf = RtPPPoA_atm => =>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : disabled Ulp : mac Connection State : connected
RtPPPoA_atm: dest : (none)
Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : ip Connection State : not-connected
=>
atm ifdelete Delete an ATM interface.
atm iflist Display the ATM interfaces.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
13
atm ifattach
Attach a ATM interface.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm ifattach intf = <string>
intf The name of the ATM interface to be attached. REQUIRED
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp Connection State : not-connected
=>atm ifattach intf=RtPPPoA_atm => =>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp Connection State : connected
=>
atm ifdetach Detach an ATM interface.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
14
atm ifconfig
Configure an ATM interface.
SYNTAX:
where:
The interface to be configured must not be connected at the time of configuration. If this should be the case, use the command :atm ifdetach before using the command :atm ifconfig.
atm ifconfig intf = <string>
[dest = <string>] [qos = <string>] [encaps = <{llc | vcmux}>] [retry = <number{0-65535}>] [fcs = <{disabled | enabled | auto}>] [ulp = <{ip | mac | ppp}>]
intf The name of the ATM interface to be configured. REQUIRED
dest The WAN destination for this ATM interface.
Typically, an ATM phonebook entry.
OPTIONAL
qos The name of the Quality of Service (QoS) book entry to apply on this ATM interface.
The default is default.
OPTIONAL
encaps The type of encapsulation to be used for this ATM interface.
Choose between:
llc: Logical Link Control (LLC) / Sub Network Access Protocol (SNAP)
vcmux: Virtual Channel MUltipleXing (VCMUX).
The default is llc.
OPTIONAL
fcs Enable or disable the inclusion of the Ethernet Frame Check Sequence (FCS) in the
packet header on the WAN side (only used for llc encapsulation for mac). The default is disabled.
Note This parameter is normally left disabled.
OPTIONAL
retry A number between 0 and 65535.
Represents the number of times the SpeedTouch™ retries to set up a WAN connection before giving up. The default is 10.
OPTIONAL
ulp Select the Upper Layer Protocol (ULP) for this interface.
Choose between:
ip (for a Routed IPoA interface).
mac (for a Bridged Ethernet, Routed ETHoA, Bridged PPP over Ethernet (PPPoE),
Routed PPPoE or a PPPoE Relay interface).
ppp (for a Routed PPP over ATM (PPPoA) interface).
The default is ip.
OPTIONAL
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
15
EXAMPLE:
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : mac Connection State : connected
atm_8_35 : dest : atm_pvc_8_35
Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : mac
Connection State : not-connected => =>atm ifconfig intf=atm_8_35 dest=atm_pvc_8_35 encaps=vcmux ulp=ppp => =>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : mac
Connection State : connected
atm_8_35 : dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : disabled Ulp : ppp
Connection State : not-connected
=>
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
16
atm ifdelete
Delete an ATM interface.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm ifdelete intf = <string>
intf The name of the ATM interface to be deleted. REQUIRED
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected
=> =>atm ifdelete intf=RtPPPoA_atm => =>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected
=>
atm ifadd Create a new ATM interface.
atm iflist Display the ATM interfaces.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
17
atm ifdetach
Detach an ATM interface.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm ifdetach intf = <string>
intf The name of the ATM interface to be detached. REQUIRED
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected
=> =>atm ifdetach intf=RtPPPoA_atm => =>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : not-connected
=>
atm ifattach Attach a ATM interface.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
18
atm iflist
Display the ATM interfaces.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm iflist [intf = <string>]
intf The name of the ATM interface to be shown.
Note If not specified, all the ATM interfaces are shown.
OPTIONAL
=>atm iflist atm_0_35 : dest : atm_pvc_0_35
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected
RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected
=>atm iflist intf=RtPPPoA_atm RtPPPoA_atm: dest : RtPPPoA
Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected =>
atm ifadd Create a new ATM interface.
atm ifdelete Delete an ATM interface.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
19
atm bundle add
Add a new bundle of interfaces.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm bundle add name = <string>
name The name of the new bundle. REQUIRED
=>atm bundle add name=myBundle =>atm bundle list myBundle: Connection state : not-connected
Retry: 10 Policy: priority Propagate: disabled TX requested bytes: 0 requested frames: 0 TX bytes: 0 frames: 0 RX bytes: 0 frames: 0
=>
atm bundle delete Delete a bundle of interfaces.
atm bundle list Display the current bundles.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
20
atm bundle attach
Attach a bundle of interfaces.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm bundle attach name = <string>
name The name of the bundle to be attached. REQUIRED
=>atm bundle attach name=myBundle =>atm bundle list myBundle: Connection state : connected
Retry: 10 Policy: priority Propagate: disabled TX requested bytes: 0 requested frames: 0 TX bytes: 0 frames: 0 RX bytes: 0 frames: 0
=>
atm bundle detach Detach a bundle of interfaces.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
21
atm bundle config
Modify a bundle of interfaces.
SYNTAX:
where:
EXAMPLE:
The bundle of interfaces to be configured must not be connected at the time of configuration. If this should be the case, use the command :atm bundle detach before using the command :atm bundle config.
atm bundle config name = <string>
[policy = <{priority | connection}>] [propagate = <{disabled | enabled}>] [retry = <number{0-65535}>]
name The name of the bundle to be configured. REQUIRED
policy The traffic handling policy of the bundle.
Choose between:
priority: lower layer ATM interfaces can be configured for a certain priority
range, marked packets will be sent on the corresponding interface.
connection: all the packets of the same connection will be sent via the same
interface.
The default is priority.
OPTIONAL
propagate Enable or disable propagation of packets.
When propagation is enabled, packets are sent via the first interface configured for that traffic. If the interface goes down, the next interface in the bundle will be used. The default is disabled.
OPTIONAL
retry A number between 0 and 65535.
Represents the number of connection setup retries before giving up. The default is 10.
OPTIONAL
=>atm bundle list myBundle: Connection state : not-connected
Retry: 10 Policy: priority Propagate: disabled TX requested bytes: 0 requested frames: 0 TX bytes: 0 frames: 0
RX bytes: 0 frames: 0 =>atm bundle config name=myBundle policy=connection retry=15 =>atm bundle list myBundle: Connection state : not-connected
Retry: 15 Policy: connection Propagate: disabled
TX requested bytes: 0 requested frames: 0
TX bytes: 0 frames: 0
RX bytes: 0 frames: 0 =>
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
22
atm bundle clear
Clear the bundle statistics.
SYNTAX:
where:
atm bundle clear [name = <string>]
name The name of the bundle for which the statistics must be cleared.
Note If not specified, the statistics for all the bundles will be cleared.
OPTIONAL
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
23
atm bundle delete
Delete a bundle of interfaces.
SYNTAX:
where:
RELATED COMMANDS:
atm bundle delete name = <string>
name The name of the bundle to be deleted. REQUIRED
atm bundle add Add a new bundle of interfaces.
atm bundle list Display the current bundles.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
24
atm bundle detach
Detach a bundle of interfaces.
SYNTAX:
where:
RELATED COMMANDS:
atm bundle detach intf = <string>
intf The name of the bundle to be detached. REQUIRED
atm bundle attach Attach a bundle of interfaces.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
25
atm bundle flush
Flush all bundles.
SYNTAX:
atm bundle flush
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
26
atm bundle ifadd
Add an interface on a bundle.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
Up to 8 interfaces or (sub-)bundles can be added to one bundle.
atm bundle ifadd name = <string>
intf = <string> [index = <number{0-6}>]
name The name of the bundle to which an ATM interface must be added. REQUIRED
intf The name of the ATM interface to be added. REQUIRED
index A number between 0 and 6.
Represents the index of the ATM interface.
OPTIONAL
=>atm bundle ifadd name=myBundle intf=myATMintf =>atm bundle list myBundle: Connection state : not-connected
Retry: 15 Policy: connection
TX requested bytes: 0 requested frames: 0
TX bytes: 0 frames: 0
RX bytes: 0 frames: 0
Interface: myATMintf State: enabled Selector: 0-15
TX bytes: 0 frames: 0 RX bytes: 0 frames: 0 RX discarded bytes: 0 discarded frames: 0 Disconnects: 0
=>
atm bundle ifdelete Remove an interface from a bundle.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
27
atm bundle ifconfig
Configure an interface from a bundle.
SYNTAX:
where:
The interface to be configured must not be connected at the time of configuration. If this should be the case, use the command :atm bundle ifdetach before using the command :atm bundle ifconfig.
atm bundle ifconfig name = <string>
intf = <string> [state = <{disabled | enabled}>] [low = <number{0-15}>] [high = <number{0-15}>]
name The name of the bundle from which an ATM interface must be configured. REQUIRED
intf The name of the ATM interface to be configured. REQUIRED
state Enable or disable the ATM interface.
The default is enabled.
OPTIONAL
low A number between 0 and 15.
Represents the low selector value.
Note This parameter must only be configured when the policy of the bundle is set
to priority (see “ atm bundle config” on page 21).
OPTIONAL
high A number between 0 and 15.
Represents the high selector value.
Note This parameter must only be configured when the policy of the bundle is set
to priority (see “ atm bundle config” on page 21).
OPTIONAL
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
28
atm bundle ifdelete
Remove an interface from a bundle.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm bundle ifdelete name = <string>
intf = <string>
name The name of the bundle from which an ATM interface must be removed. REQUIRED
intf The name of the ATM interface to be removed. REQUIRED
=>atm bundle iflist Test : dest : (none)
Retry : 10 QoS : default Encaps : llc Fcs : off Ulp : ip Connection State : not-connected
=>atm bundle ifdelete intf=Test =>atm bundle iflist
=>
atm bundle ifadd Add an interface on a bundle.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
29
atm bundle list
Display the current bundles.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm bundle list
=>atm bundle list Test : Connection state : not-connected
Retry: 10 Policy: priority
TX requested bytes: 0 requested frames: 0
TX bytes: 0 frames: 0
RX bytes: 0 frames: 0
Interface: Test State: enabled Selector: 0-15
TX bytes: 0 frames: 0 RX bytes: 0 frames: 0 RX discarded bytes: 0 discarded frames: 0 Disconnects: 0
=>
atm bundle add Add a new bundle of interfaces.
atm bundle delete Delete a bundle of interfaces.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
30
atm cac config
Configure the ATM connection admission control.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm cac config config port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
state = <{disabled|enabled}>
config port The port for which CAC is configured. REQUIRED
state Enable/disable CAC for an ATM port. REQUIRED
{Administrator}=>atm cac config port = dsl0 state = enabled :atm cac config port=dsl0 state=enabled {Administrator}=>
atm cac list Display all the CAC parameters.
atm cac overbooking Configure ATM overbooking parameters.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
31
atm cac list
Display all the CAC parameters.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm cac list
{Administrator}[atm cac]=>list CAC: port: dsl0 state: enabled CAC: port: dsl1 state: enabled CAC: port: atm2 state: enabled CAC: port: aal5 state: disabled CAC: port: atm5 state: disabled Overbooking: realtime: 0% non-realtime: 0%. {Administrator}[atm cac]=>
atm cac config Configure the ATM connection admission control.
atm cac overbooking Configure ATM overbooking parameters.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
32
atm cac overbooking
Configure ATM overbooking parameters.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm cac overbooking rt = <number{0-1000}>
nrt = <number{0-1000}>
rt A number between 0 and 1000.
The realtime overbooking percentage.
REQUIRED
nrt A number between 0 and 1000.
The non-realtime overbooking percentage.
REQUIRED
{Administrator}[atm cac]=>overbooking rt 20 nrt 500 {Administrator}[atm cac]=>list CAC: port: dsl0 state: enabled CAC: port: dsl1 state: enabled CAC: port: atm2 state: enabled CAC: port: aal5 state: disabled CAC: port: atm5 state: disabled Overbooking: realtime: 20% non-realtime: 500%. {Administrator}[atm cac]=>
atm cac config Configure the ATM connection admission control.
atm cac list Display all the CAC parameters.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
33
atm debug aal5stats
Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.
SYNTAX:
where:
RELATED COMMANDS:
atm debug aal5stats port = <{dsl0} or number>
vpi = <number{0-15}> [vci = <number{0-511}>] [clear = <{disabled | enabled}>]
port The port number for which statistics will be retrieved.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
vpi A number between 0 and 15.
Represents the Virtual Path Identifier (VPI) number for which statistics will be retrieved.
REQUIRED
vci A number between 0 and 511.
Represents the Virtual Channel Identifier (VCI) number for which statistics will be retrieved.
OPTIONAL
clear Enable or disable clearing of the statistics after request. OPTIONAL
atm debug gstats Display ATM global statistics.
atm debug portstats Display port specific ATM statistics.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
34
atm debug gstats
Display ATM global statistics.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm debug gstats [clear = <{disabled | enabled}>]
clear Enable or disable clearing of the statistics after request. OPTIONAL
{admin}[atm debug]=>gstats # of received octets = 1802. # of transmitted octets = 4346. # of received cells = 34. # of transmitted cells = 82. # of unknown cells = 0. # of errors on the input = 0. # of errors on output = 0. {admin}[atm debug]=>
atm debug aal5stats Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.
atm debug portstats Display port specific ATM statistics.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
35
atm debug portstats
Display port specific ATM statistics.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm debug portstats port = <{dsl0} or number>
[clear = <{disabled | enabled}>]
port The port number for which statistics will be retrieved.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
clear Enable or disable clearing of the statistics after request. OPTIONAL
=>atm debug portstats port=dsl0 # of received octets = 1961. # of transmitted octets = 4717. # of received cells = 37. # of transmitted cells = 89. # of unknown cells = 0. # of errors on the input = 0. # of errors on output = 0. =>
atm debug aal5stats Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.
atm debug gstats Display ATM global statistics.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
36
atm oam config
Modify the ATM Operation and Maintenance (OAM) settings.
SYNTAX:
where:
RELATED COMMANDS:
atm oam config [clp = <number{0-1}>]
[loopbackid = <string>]
clp A number (0 or 1).
Represents the Cell Loss Priority (CLP) bit value of the OAM cells. The default is 1.
OPTIONAL
loopbackid A hexadecimal string.
Represents the loopback ID for processing of segment loopback cells. The default is 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a 6a.
OPTIONAL
atm oam list Display the ATM OAM settings.
atm oam modify Modify the ATM OAM data blocking mode.
atm oam ping Send ATM loopback cells.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
37
atm oam list
Display the ATM OAM settings.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm oam list
=>atm oam list
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
=>
atm oam config Modify the ATM Operation and Maintenance (OAM) settings.
atm oam modify Modify the ATM OAM data blocking mode.
atm oam ping Send ATM loopback cells.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
38
atm oam modify
Modify the ATM OAM data blocking mode.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm oam modify port = <{dsl0} or number>
blocking = <{disabled | enabled}>
port The port for which OAM blocking is configured.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
blocking Enable or disable the OAM data blocking mode on this port.
The default is enabled.
REQUIRED
=>atm oam list
OAM config dump
-------------------
CLP bit value : 1 Loopbackid :6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a
OAM data blocking mode
--------------------------
Port dsl0: blocking Port dsl1: blocking Port atm2: blocking Port atm3: blocking Port aal5: blocking
Port atm5: blocking =>atm oam modify port=dsl1 blocking=disabled =>:atm oam list
OAM config dump
-------------------
CLP bit value : 1
Loopbackid :6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a
OAM data blocking mode
--------------------------
Port dsl0: blocking
Port dsl1: non blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking =>
atm oam config Modify the ATM Operation and Maintenance (OAM) settings.
atm oam list Display the ATM OAM settings.
atm oam ping Send ATM loopback cells.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
39
atm oam ping
Send ATM loopback cells.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm oam ping dest = <string>
[count = <number{1-1000000}>] [interval = <number{100-1000000}>]
dest The destination address for the request.
This can be any ATM phonebook entry.
REQUIRED
count A number between 1 and 1000000.
Represents the number of pings to send.
OPTIONAL
interval A number between 100 and 1000000 (milliseconds).
Represents the interval between packets.
OPTIONAL
=>atm oam ping dest=atm_ph_8_35 count=10 interval=1000 loopback: successful, sequence: 1 time: 37890 usec loopback: successful, sequence: 2 time: 39118 usec loopback: successful, sequence: 3 time: 39116 usec loopback: successful, sequence: 4 time: 39187 usec loopback: successful, sequence: 5 time: 38605 usec loopback: successful, sequence: 6 time: 38764 usec loopback: successful, sequence: 7 time: 38752 usec loopback: successful, sequence: 8 time: 38813 usec loopback: successful, sequence: 9 time: 38848 usec loopback: successful, sequence: 10 time: 38941 usec
--- loopback statistics --­10 loopbacks transmitted, 10 successful, 0% loss, time 1390 ms rtt min/avg/max = 37890/38803/39187 =>
atm oam config Modify the ATM Operation and Maintenance (OAM) settings.
atm oam list Display the ATM OAM settings.
atm oam modify Modify the ATM OAM data blocking mode.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
40
atm oam cc list
Display Continuity Check (CC) configuration.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm oam cc list
=>atm oam cclist PORT = 0 VPI = 15 VCI = 16 End2End Mode = Auto Segment Mode = Auto PORT = 0 VPI = 0 VCI = 35 End2End Mode = Auto Segment Mode = Auto PORT = 0 VPI = 8 VCI = 35 End2End Mode = Auto Segment Mode = Auto PORT = 0 VPI = 0 VCI = 16 End2End Mode = Auto Segment Mode = Auto =>
atm oam cc modify Modify CC on the connection.
atm oam cc send Send CC activate/deactivate to connection.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
41
atm oam cc modify
Modify CC on the connection.
SYNTAX:
where:
RELATED COMMANDS:
atm oam modify port = <{dsl0} or number>
vpi = <number{0-15}> [vci = <number{0-511}>] [transmit = <{disabled | enabled}>] [receive = <{disabled | enabled}>] [auto = <{disabled | enabled}>] [span = <{segment | end2end}>]
port The ATM port number.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
vpi A number between 0 and 15.
Represents the VPI.
REQUIRED
vci A number between 0 and 511.
Represents the VCI.
Note For a Virtual Path (VP) cross-connection, use 0 or do not specify.
OPTIONAL
transmit Enable or disable transmission of CC cells. OPTIONAL
receive Enable or disable loss of continuity. OPTIONAL
auto Enable or disable remote CC activation/deactivation. OPTIONAL
span Select the CC span.
Choose between:
end2end: monitoring occurs on the entire VC between two ATM end stations.
segment: monitoring occurs on a VC segment between the SpeedTouch™ and a
first-hop ATM switch.
OPTIONAL
atm oam cc list Display Continuity Check (CC) configuration.
atm oam cc send Send CC activate/deactivate to connection.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
42
atm oam cc send
Send CC activate/deactivate to connection.
SYNTAX:
where:
RELATED COMMANDS:
atm oam cc send port = <{dsl0} or number>
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.
Or specify a port number (dsl0 has port number 0).
REQUIRED
vpi A number between 0 and 15.
Represents the VPI.
REQUIRED
vci A number between 0 and 511.
Represents the VCI.
Note For a VP cross-connection, use 0 or do not specify.
OPTIONAL
span Select the CC span.
Choose between:
end2end: monitoring occurs on the entire VC between two ATM end stations.
segment: monitoring occurs on a VC segment between the SpeedTouch™ and a
first-hop ATM switch.
OPTIONAL
action Activate or deactivate CC.
The default is deactivate.
OPTIONAL
direction Indicates the direction of CC activity.
Choose between:
source
sink
both.
The default is both.
OPTIONAL
atm oam cc list Display Continuity Check (CC) configuration.
atm oam cc modify Modify CC on the connection.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
43
atm oam vclb add
Create a loopback connection for VC.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm oam vclb add port = <{dsl0} or number>
vpi = <number{0-15}> [vci = <number{0-511}>]
port The ATM port number.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
vpi A number between 0 and 15.
Represents the VPI.
REQUIRED
vci A number between 0 and 511.
Represents the VCI.
Note For a VP cross-connection, use 0 or do not specify.
OPTIONAL
=>atm oam vclb add port=dsl0 vpi=0 vci=36 =>atm oam vclb list PORT = 0 VPI=0VCI= 36 =>atm oam vclb add port=dsl1 vpi=0 vci=37 =>atm oam vclb list PORT = 0 VPI=0VCI= 36 PORT = 1 VPI=0VCI= 37 =>
atm oam vclb del Delete a loopback connection for VC.
atm oam vclb list List all VC loopback connections.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
44
atm oam vclb del
Delete a loopback connection for VC.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm oam vclb del port = <{dsl0} or number>
vpi = <number{0-15}> [vci = <number{0-511}>]
port The ATM port number.
Choose between:
DSL0
Or specify a port number (dsl0 has port number 0).
REQUIRED
vpi A number between 0 and 15.
Represents the VPI.
REQUIRED
vci A number between 0 and 511.
Represents the VCI.
Note For a VP cross-connection, use 0 or do not specify.
OPTIONAL
=>atm oam vclb list PORT = 0 VPI=0VCI= 36 PORT = 1 VPI=0VCI= 37 =>atm oam vclb del port=dsl1 vpi=0 vci=37 =>atm oam vclb list PORT = 0 VPI=0VCI= 36 =>
atm oam vclb add Create a loopback connection for VC.
atm oam vclb list List all VC loopback connections.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
45
atm oam vclb list
List all VC loopback connections.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm oam vclb list
=>atm oam vclb list PORT = 0 VPI=0VCI= 36 PORT = 1 VPI=0VCI= 37 =>
atm oam vclb add Create a loopback connection for VC.
atm oam vclb del Delete a loopback connection for VC.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
46
atm phonebook add
Add a new phonebook entry.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm phonebook add name = <string>
addr = <atmchannel : PVC syntax is [port.]vpi.vci
port=dsl0 | ...>
name The name of the new phonebook entry.
This name can be freely chosen, however two limitations apply:
The name of a phonebook entry intended for the Relayed PPPoA (PPPoA-to-PPTP
Relaying) packet service may not start with capital P or capital T
The name of a phonebook entry intended for the PPP-to-DHCP spoofing packet
service must start with DHCP (for example DHCP_Spoof01).
REQUIRED
addr The ATM address for this destination.
It is composed of a VPI and a VCI identifying ATM virtual channels. In most cases the values are provided by the Service Provider. Accepted VPI: a number between 0 and 15. Accepted VCI: a number between 0 and 511.
REQUIRED
=>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 =>atm phonebook add name=RtPPPoA addr=8.35 =>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 RtPPPoA 0 8.35 =>
atm phonebook delete Delete an existing phonebook entry.
atm phonebook list Display the current phonebook.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
47
atm phonebook autolist
Show the auto PVCs.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
Auto PVCs are only shown if they are supported by the Central Office DSLAM.
atm phonebook autolist
=>atm phonebook autolist
8.35 =>
atm phonebook list Display the current phonebook.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
48
atm phonebook delete
Delete an existing phonebook entry.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
This command is only applicable for phonebook entries that are not used (in other words, not configured for any packet service).
atm phonebook delete name = <string>
name The name of the phonebook entry to be deleted.
Tip Use the command :atm phonebook list to check whether the entry is in
use (
Use=1
) or not (
Use=0
).
REQUIRED
=>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 RtPPPoA 0 8.35 =>atm phonebook delete name=RtPPPoA =>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 =>
atm phonebook add Add a new phonebook entry.
atm phonebook list Display the current phonebook.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
49
atm phonebook flush
Flush all the phonebook entries.
SYNTAX:
EXAMPLE:
1. Phonebook entries that are in use, cannot be flushed.
2. This command does not impact previously saved configurations.
atm phonebook flush
=>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 RtPPPoA 0 8.35 => =>atm phonebook flush Some phonebook entries are still in use. Entries that are in use cannot be deleted. => =>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 =>
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
50
atm phonebook list
Display the current phonebook.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm phonebook list
=>atm phonebook list Name Use Address atm_pvc_0_35 1 0.35 RtPPPoA 0 8.35 =>
atm phonebook add Add a new phonebook entry.
atm phonebook autolist Show the auto PVCs.
atm phonebook delete Delete an existing phonebook entry.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
51
atm qosbook add
Add a new QoS book entry.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm qosbook add name = <string>
[txctd = <string>] [rxctd = <string>]
name The name of the new QoS entry. REQUIRED
txctd The name of the Conformance Traffic Descriptor (CTD) for the transmit (upstream)
direction.
OPTIONAL
rxctd The name of the CTD for the receive (downstream) direction. OPTIONAL
=>atm qosbook list Name Ref Tx CTD Rx CTD default 3 default default =>
atm qosbook delete Delete a QoS book entry.
atm qosbook list Display the QoS book.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
52
atm qosbook config
Modify the QoS book configuration.
SYNTAX:
where:
EXAMPLE:
atm qosbook config [format = <{bytes | cells}>]
format The input/output format of the QoS book.
Choose between:
bytes: the output is shown in Kbits or bytes.
cells: the output is shown in cps or cells.
The default is bytes.
OPTIONAL
=>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled =>atm qosbook config format=cells =>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(cps) (cps) (cells) (cps) (cells)
default 2 UBR linerate 0 0 0 0 0 disabled disabled =>
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
53
atm qosbook ctdadd
Add a Connection Traffic Descriptor (CTD).
SYNTAX:
where:
EXAMPLE:
atm qosbook ctdadd name = <string>
conformance = <{UBR | CBR | VBR }> [peakrate = <number{0-27786}>] [sustrate = <number{0-27786} [maxburst = <number{0-12240}>] [realtime = <{enabled | disabled}>]
name The name of the new CTD. REQUIRED
conformance The ATM service conformance definition. REQUIRED
peakrate A number between 0 and 27786.
Represents the peak rate (in kilobits per second). The default is 0 (indicates linerate for UBR).
OPTIONAL
sustrate A number between 0 and 27786.
Represents the sustainable rate (in kilobits per second) (VBR only). The default is 0.
OPTIONAL
maxburst A number between 48 and 12240.
Represents the maximum burst size (in bytes) (VBR or GFR). The default is 0.
OPTIONAL
realtime Enable or disable realtime traffic (VBR only).
The default is disabled.
OPTIONAL
=>atm qosbook ctdadd name=High conformance=CBR peakrate=27786 =>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled High 0 CBR 27786 0 0 0 0 0 disabled disabled =>
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
54
IMPORTANT NOTE:
The SpeedTouch™ always rounds up specified burst sizes to a multiple of 48 bytes (a multiple of ATM cells).
Example:
In the example below a burst size of 100 bytes is specified (maxburst=100). The SpeedTouch™ will round up the burst size to the closest matching multiple of 48 bytes, as can be seen when displaying the profile via the command :atm qosbook ctdlist (burst=144).
RELATED COMMANDS:
=>atm qosbook ctdadd name=Medium conformance=VBR peakrate=27786 sustrate=20000 maxburst=100 =>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled Medium 0 VBR 27786 20000 144 0 0 0 disabled disabled =>
atm qosbook ctddelete Delete a CTD.
atm qosbook ctdlist Display all CTDs.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
55
atm qosbook ctddelete
Delete a CTD.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm qosbook ctddelete name = <string>
[force = <{disabled | enabled}>]
name The name of the CTD entry to be deleted. REQUIRED
force Enable or disable to force delete the entry even when it is still in use.
The default is disabled.
OPTIONAL
=>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled High 0 CBR 27786 0 0 0 0 0 disabled disabled =>atm qosbook ctddelete name=High =>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled =>
atm qosbook ctdadd Add a Connection Traffic Descriptor (CTD).
atm qosbook ctdlist Display all CTDs.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
56
atm qosbook ctdlist
Display all CTDs.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm qosbook ctdlist
=>atm qosbook ctdlist Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2 UBR linerate 0 0 0 0 0 disabled disabled High 0 CBR 27786 0 0 0 0 0 disabled disabled =>
atm qosbook ctdadd Add a Connection Traffic Descriptor (CTD).
atm qosbook ctddelete Delete a CTD.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
57
atm qosbook delete
Delete a QoS book entry.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
atm qosbook delete name = <string>
[force = <{disabled | enabled}>]
name The name of the QoS book entry to be deleted. REQUIRED
force Enable or disable to force delete the entry even when it is still in use.
The default is disabled.
OPTIONAL
=>atm qosbook list Name Ref Type TX peak sust burst RX peak sust burst framediscard
(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes) default 3 ubr linerate 0 0 linerate 0 0 disabled TestVBR 0 vbr-nrt 1500 1000 144 1500 1000 144 enabled =>atm qosbook delete name=TestVBR =>atm qosbook list Name Ref Type TX peak sust burst RX peak sust burst framediscard
(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes) default 3 ubr linerate 0 0 linerate 0 0 disabled =>
atm qosbook add Add a new QoS book entry.
atm qosbook list Display the QoS book.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
58
atm qosbook flush
Flush all the QoS book entries.
SYNTAX:
The flush command does not impact previously saved configurations.
atm qosbook flush
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
59
atm qosbook list
Display the QoS book.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
atm qosbook list
=>atm qosbook list Name Ref Type TX peak sust burst RX peak sust burst framediscard
(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes) default 3 ubr linerate 0 0 linerate 0 0 disabled TestVBR 0 vbr-nrt 1500 1000 144 1500 1000 144 enabled =>
atm qosbook add Add a new QoS book entry.
atm qosbook delete Delete a QoS book entry.
ATM Commands
E-DOC-CTC-20050531-0057 v1.0
60
AutoPVC Commands
E-DOC-CTC-20050531-0057 v1.0
61
AutoPVC Commands
Introduction
This chapter describes the commands of the autopvc command group.
Contents
This chapter covers the following commands:
autopvc config Configure autopvc. 62
autopvc list Show the retrieved information. 63
AutoPVC Commands
E-DOC-CTC-20050531-0057 v1.0
62
autopvc config
Configure autopvc.
SYNTAX:
where:
EXAMPLE:
autopvc config [mode = <{pseudo | passive | active}>]
[type = <{bridge | pppoerelay | ipoa | ethoa | pppoa | pppoe}>] [overwrite = <{disabled | enabled}>] [peakrate = <number{0-27786}>]
mode Select the autopvc mode:
pseudo: only pseudo-ILMI (VP/VC 15/16) is enabled. When the connection
parameters are written to the MIB, this information is displayed on CLI or web interface but these parameters are not used for configuration.
passive: both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC 15/16) are enabled.
When the connection parameters are written to the MIB, this information is displayed on CLI or web interface but these parameters are not used for configuration.
active: both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC 15/16) are enabled.
When the connection parameters are written to the MIB, these parameters are used to configure phonebook entries, qosbook profiles and bind bridge or PPPoE interfaces on top.
The default is passive.
OPTIONAL
type Select the type of autopvc.
Choose between:
bridge
pppoerelay: an ETHoA interface will be created, will be bound to the ILMI
Permanent Virtual Channel (PVC) and will be added to the PPPoE relay as relay port.
ipoa
ethoa
pppoa
pppoe.
OPTIONAL
overwrite Enable or disable UBR peak rate overwrite.
The default is disabled.
OPTIONAL
peakrate A number between 0 and 27786.
Represents the UBR peak rate (in kilobits per second). The default is 0 (indicates the linerate).
OPTIONAL
=>autopvc config Autopvc mode : passive Autopvc type : Autopvc standard: unknown Autopvc pseudo : unknown UBR overwrite : disabled UBR peak rate : linerate =>
AutoPVC Commands
E-DOC-CTC-20050531-0057 v1.0
63
autopvc list
Show the retrieved information.
SYNTAX:
where:
EXAMPLE:
autopvc list [table = <{Port | AtmLayer | Vpc | Vcc | Address
| AddressRegistrationAdmin | AtmServiceType | AtmServiceConnectionInfo | AAL1Profile | | AAL34Profile | AAL5Profile | AAL2CommonProfile | AAL2TrunkingProfile | AAL2LESProfile | AtmServiceConnInfoExtension | | AtmServiceTypeExtension | AAL5ProfileExtension}>]
table Select the autopvc table for which the information must be shown.
Choose between:
Port
AtmLayer
Vpc
Vcc
Address
AddressRegistrationAdmin
AtmServiceType
AtmServiceConnectionInfo
AAL1Profile
AAL34Profile
AAL5Profile
AAL2CommonProfile
AAL2TrunkingProfile
AAL2LESProfile
AtmServiceConnInfoExtension
AtmServiceTypeExtension
AAL5ProfileExtension.
OPTIONAL
=>autopvc list Address Type BestEff Par1 Par2 Par3 Par4 Par5
8.35 ubr Enabled Tx: 451 0 0 0 0
Rx: 7923 0 0 0 0
=>
AutoPVC Commands
E-DOC-CTC-20050531-0057 v1.0
64
Config Commands
E-DOC-CTC-20050531-0057 v1.0
65
Config Commands
Introduction
This chapter describes the commands of the config command group.
Contents
This chapter covers the following commands:
config delete Delete a user configuration file. 66
config dump Show the saved configuration file. 67
config flush Flush the loaded configuration. 68
config list Show the current configuration set. 69
config load Load complete saved (backup) or default configuration file. 70
config save Store the current configuration in a backup file. 71
Config Commands
E-DOC-CTC-20050531-0057 v1.0
66
config delete
Delete a user configuration file.
SYNTAX:
where:
RELATED COMMANDS:
config delete [filename = <string>]
filename Name of the user configuration file to be deleted.
Note If not specified, all the user configuration files that were saved in the
SpeedTouch™ permanent storage will be deleted.
OPTIONAL
config dump Show the saved configuration file.
Config Commands
E-DOC-CTC-20050531-0057 v1.0
67
config dump
Show the saved configuration file.
SYNTAX:
RELATED COMMANDS:
config dump
config delete Delete a user configuration file.
Config Commands
E-DOC-CTC-20050531-0057 v1.0
68
config flush
Flush the loaded configuration.
SYNTAX:
where:
1. This flush command combines all the possible flush commands.
2. This command does not affect saved configurations.
config flush [flush_ip = <{disabled | enabled}>]
flush_ip Flush IP settings (enabled) or not (disabled).
The default is disabled.
Note Not keeping the IP settings could cause lost IP connectivity in the LAN.
OPTIONAL
Config Commands
E-DOC-CTC-20050531-0057 v1.0
69
config list
Show the current configuration set.
SYNTAX:
where:
RELATED COMMANDS:
config list [templates = <{disabled | enabled}>]
templates List the template files (disabled) or not (enabled).
The default is disabled.
OPTIONAL
config load Load complete saved (backup) or default configuration file.
config save Store the current configuration in a backup file.
Config Commands
E-DOC-CTC-20050531-0057 v1.0
70
config load
Load complete saved (backup) or default configuration file.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
Use the command :config flush before loading a configuration file.
config load [load_ip = <{disabled | enabled}>]
[defaults = <{enabled | disabled}>] [flush = <{enabled | disabled}>] [echo = <{disabled | enabled}>] [filename = <string>]
load_ip Load IP settings (enabled) or not (disabled).
Note Not keeping the IP settings could cause lost IP connectivity in the LAN.
OPTIONAL
defaults Load default configuration (enabled) or saved configuration (disabled).
Note If not specified, the saved configuration will be loaded.
OPTIONAL
flush Flush the current configuration before loading a new configuration (enabled) or not
(disabled).
OPTIONAL
echo Echo each command string when loaded (enabled) or not (disabled). OPTIONAL
filename Name of the configuration file to be loaded. OPTIONAL
=>ip rtlist
Destination Source Gateway Intf Mtrc
10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0
172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0
10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0
127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1 =>config load 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 =>
config list Show the current configuration set.
config save Store the current configuration in a backup file.
Config Commands
E-DOC-CTC-20050531-0057 v1.0
71
config save
Store the current configuration in a backup file.
All the existing configurations and modifications entered by the user are saved.
The backup file is saved in the SpeedTouch™ permanent storage. This file can be downloaded via the SpeedTouch™ web pages or via an FTP session.
SYNTAX:
where:
RELATED COMMANDS:
config save filename = <string>
filename The filename for the backup file of the current configuration. REQUIRED
config list Show the current configuration set.
config load Load complete saved (backup) or default configuration file.
Config Commands
E-DOC-CTC-20050531-0057 v1.0
72
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
73
Connection Commands
Introduction
This chapter describes the commands of the connection command group.
Contents
This chapter covers the following commands:
connection appconfig Configure the available CONN/NAT application helpers. 74
connection appinfo Display CONN/NAT application specific info. 76
connection applist List the available CONN/NAT application helpers. 77
connection bind Create a new CONN/NAT application helper/port binding. 78
connection bindlist List the current CONN/NAT application helper/port bindings. 79
connection clean Clean the connection database by forcing timeouts. 80
connection clear Kill all the connections. 81
connection config Configure the connection handling. 82
connection debug The connection debug commands 83
connection describe Describe the streams of a connection. 84
connection flush Flush the current connection configuration. 85
connection info Show all the registered modules with some info. 86
connection list Display the currently known connections. 87
connection refresh Invalidate all the cached decisions. 88
connection stats Display the connection and stream statistics. 89
connection timerclear Clear the connection timeout to default. 90
connection timerconfig Configure the connection timeout handling. 91
connection unbind Delete an existing CONN/NAT application helper/port binding. 92
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
74
connection appconfig
Configure the available CONN/NAT application helpers.
SYNTAX:
where:
EXAMPLE:
connection appconfig application = <string>
[trace = <{disabled | enabled}>] [timeout = <number{0-32000}>] [floating = <{disabled | enabled}>] [tracelevel = <number{1-4}>]
application The name of a CONN/NAT application helper.
Tip Use the command :connection applist to obtain a list of CONN/NAT
application helpers.
REQUIRED
trace Enable or disable CONN/NAT application helper traces.
The default is enabled.
OPTIONAL
timeout A number between 0 and 32000 (seconds).
Represents the maximum timeout to keep predicted child connections around.
OPTIONAL
floating Enable / disabled floating port for IKE helper. OPTIONAL
tracelevel A number between 1 and 4.
Represents the SIP trace level. Choose between:
1: feature errors
2: feature traces
3: all errors
4: all traces.
The default is 1.
OPTIONAL
=>connection applist Application Proto DefaultPort Traces Timeout IP6TO4 6to4 0 enabled unavailable PPTP tcp 1723 enabled unavailable ESP esp 0 unavailable 15' 0" IKE udp 500 disabled 15' 0" FLOATING SIP udp 5060 disabled 6 0" trace level 1 ... LOOSE(UDP) udp 0 enabled 5' 0" FTP tcp 21 enabled unavailable =>connection appconfig application=SIP trace=enabled =>connection applist Application Proto DefaultPort Traces Timeout IP6TO4 6to4 0 enabled unavailable PPTP tcp 1723 enabled unavailable ESP esp 0 unavailable 15' 0" IKE udp 500 disabled 15' 0" FLOAATING SIP udp 5060 enabled 6 0" trace level 1 ... LOOSE(UDP) udp 0 enabled 5' 0" FTP tcp 21 enabled unavailable =>
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
75
RELATED COMMANDS:
connection appinfo Display CONN/NAT application specific info.
connection applist List the available CONN/NAT application helpers.
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
76
connection appinfo
Display CONN/NAT application specific info.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
connection appinfo application = <{string}>
application The name of a CONN/NAT application helper.
Tip Use the command :connection applist to obtain a list of CONN/NAT
application helpers.
REQUIRED
=>connection appinfo application=SIP SIP ALG session SIPALG: pool=138, in use=0, bottom=138
=>
connection appconfig Configure the available CONN/NAT application helpers.
connection applist List the available CONN/NAT application helpers.
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
77
connection applist
List the available CONN/NAT application helpers.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
connection applist
=>connection applist Application Proto DefaultPort Traces Timeout IP6TO4 6to4 0 enabled unavailable PPTP tcp 1723 enabled unavailable ESP esp 0 unavailable 15' 0" IKE udp 500 disabled 15' 0" FLOATING SIP udp 5060 disabled 6 0" trace level 1 JABBER tcp 5222 disabled 2' 0" CU/SeeMe udp 7648 enabled unavailable RAUDIO(PNA) tcp 7070 enabled unavailable RTSP tcp 554 enabled unavailable ILS tcp 389 unavailable 5' 0" H245 tcp 0 unavailable 5' 0" H323 tcp 1720 enabled unavailable IRC tcp 6667 enabled 5' 0" LOOSE(UDP) udp 0 enabled 5' 0" FTP tcp 21 enabled unavailable =>
For some CONN/NAT application helpers, either traces or timeout are unavailable.
connection appconfig Configure the available CONN/NAT application helpers.
connection appinfo Display CONN/NAT application specific info.
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
78
connection bind
Create a new CONN/NAT application helper/port binding.
SYNTAX:
where:
EXAMPLE:
RELATED COMMANDS:
connection bind application = <string>
port = <port-range>
application The name of a CONN/NAT application helper.
Tip Use the command :connection applist to obtain a list of CONN/NAT
application helpers.
REQUIRED
port The port number or port range this application handler should work on. REQUIRED
=>connection bindlist Application Proto Portrange Flags JABBER tcp 15222 JABBER tcp 5222 FTP tcp 21 IRC tcp 6660 ... IP6TO4 6to4 0 =>connection bind application = IRC port = 6750 =>connection bindlist Application Proto Portrange IRC tcp 6750 JABBER tcp 15222 JABBER tcp 5222 FTP tcp 21 IRC tcp 6660 ... IP6TO4 6to4 0 =>
connection bindlist List the current CONN/NAT application helper/port bindings.
connection unbind Delete an existing CONN/NAT application helper/port binding.
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
79
connection bindlist
List the current CONN/NAT application helper/port bindings.
SYNTAX:
EXAMPLE:
RELATED COMMANDS:
connection bindlist
=>connection bindlist Application Proto Portrange Flags LOOSE(UDP) udp 67 JABBER tcp 15222 JABBER tcp 5222 FTP tcp 21 IRC tcp 6660-6669 H323 tcp 1720 ILS tcp 1002 ILS tcp 389 RTSP tcp 554 RAUDIO(PNA) tcp 7070 CU/SeeMe udp 7648 SIP udp 5060 IKE udp 500 ESP esp 0 PPTP tcp 1723 IP6TO4 6to4 0 =>
connection bind Create a new CONN/NAT application helper/port binding.
connection unbind Delete an existing CONN/NAT application helper/port binding.
Connection Commands
E-DOC-CTC-20050531-0057 v1.0
80
connection clean
Clean the connection database by forcing timeouts.
SYNTAX:
where:
EXAMPLE:
connection clean [level = <number{0-9}>]
level A number between 0 and 9.
Represents the desired scrubbing level.
The default is ... .
OPTIONAL
=>connection list ID proto state substate flags timeout
-- ----- ----- -------- ----- -------
8 tcp ACTIVE [TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 15' 7"
INIT: 16 192.168. 1. 64: 1377 192.168. 1.254: 23 [...] LocalNetwork 1390 tcp 0 RESP: 17 192.168. 1.254: 23 192.168. 1. 64: 1377 [R..] loop 951 tcp 0
34 tcp ACTIVE [TCPS_CLOSE_WAIT-TCPS_FIN_WAIT_1] [I.....] 57' 16"
INIT: 68 192.168. 1. 64: 1417 192.168. 1.254: 21 [...] LocalNetwork 11 tcp 0
RESP: 69 192.168. 1.254: 21 192.168. 1. 64: 1417 [R..] loop 10 tcp 0 =>connection clean =>connection list ID proto state substate flags timeout
-- ----- ----- -------- ----- -------
8 tcp ACTIVE [TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 14' 59"
INIT: 16 192.168. 1. 64: 1377 192.168. 1.254: 23 [...] LocalNetwork 1417 tcp 0
RESP: 17 192.168. 1.254: 23 192.168. 1. 64: 1377 [R..] loop 967 tcp 0 =>
Loading...