Technicolor Thomson Network Router St516 Users Manual 536 546_CLI_beyond62

Technicolor-Thomson-Network-Router-St516-Users-Manual-463464 technicolor-thomson-network-router-st516-users-manual-463464

ST546 to the manual 27d91a7a-62b9-4701-95ed-0944d64eaf1a

2015-02-04

: Technicolor Technicolor-Technicolor-Thomson-Network-Router-St516-Users-Manual-390147 technicolor-technicolor-thomson-network-router-st516-users-manual-390147 technicolor pdf

Open the PDF directly: View PDF .
Page Count: 792

Download
Open PDF In Browser	View PDF

P

o

E

w

e

r

th

D
rn SL
e
t

e

In

te

rn

e

t

Thomson ST516/536/546
CLI Reference Guide

Thomson ST516/536/546
CLI Reference Guide
R6.2

Copyright
Copyright ©1999-2007 THOMSON. All rights reserved.
Distribution 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
http://www.thomson-broadband.com

Trademarks
The following trademarks are used in this document:

>
>
>
>

DECT is a trademark of ETSI.

>
>

UPnP™ is a certification mark of the UPnP™ Implementers Corporation.

>

Apple® and Mac OS® are registered trademarks of Apple Computer, Incorporated, registered in the United States and
other countries.

>
>

UNIX® is a registered trademark of UNIX System Laboratories, Incorporated.

Bluetooth® word mark and logos are owned by the Bluetooth SIG, Inc.
Ethernet™ is a trademark of Xerox Corporation.
Wi-Fi® and the Wi-Fi logo are registered trademarks of the Wi-Fi Alliance. "Wi-Fi CERTIFIED", "Wi-Fi ZONE", "Wi-Fi Alliance", their respective logos and "Wi-Fi Protected Access" are trademarks of the Wi-Fi Alliance.
Microsoft®, MS-DOS®, Windows® and Windows NT® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Adobe®, the Adobe logo, Acrobat and Acrobat Reader are trademarks or registered trademarks of Adobe Systems, Incorporated, registered in the United States and/or other countries.

Other brands and product names may be trademarks or registered trademarks of their respective holders.

Document Information
Status: v2.0 (May 2007)
Reference: E-DOC-CTC-20061027-0003
Short Title: CLI Reference Guide ST516/536/546 R6.2
Software Build: R 6.2.H.5

Contents

About this CLI Reference Guide ................................................ 1
1

Root Commands .......................................................................... 3
ping.......................................................................................................................................................... 4
traceroute ................................................................................................................................................ 5

2

ADSL Commands......................................................................... 7
adsl config ............................................................................................................................................... 8
adsl info ................................................................................................................................................... 9
adsl debug bitloadinginfo .................................................................................................................... 11
adsl debug deltconfig........................................................................................................................... 12
adsl debug deltinfo............................................................................................................................... 13
adsl debug modemoptioninfo ............................................................................................................. 14
adsl debug modemoption ................................................................................................................... 15
adsl debug traceconfig......................................................................................................................... 16

3

ATM Commands ........................................................................ 17
atm flush ............................................................................................................................................... 19
atm ifadd ............................................................................................................................................... 20
atm ifattach ........................................................................................................................................... 21
atm ifconfig ........................................................................................................................................... 22
atm ifdelete ........................................................................................................................................... 24
atm ifdetach .......................................................................................................................................... 25
atm iflist................................................................................................................................................. 26
atm bundle add..................................................................................................................................... 27
atm bundle attach................................................................................................................................. 28
atm bundle config ................................................................................................................................ 29
atm bundle clear ................................................................................................................................... 30
atm bundle delete................................................................................................................................. 31
atm bundle detach................................................................................................................................ 32
atm bundle flush................................................................................................................................... 33
atm bundle ifadd .................................................................................................................................. 34
atm bundle ifconfig .............................................................................................................................. 35
atm bundle ifdelete .............................................................................................................................. 36
atm bundle list ...................................................................................................................................... 37
atm cac config....................................................................................................................................... 38
atm cac list ............................................................................................................................................ 39
atm cac overbooking ............................................................................................................................ 40

E-DOC-CTC-20061027-0003 v2.0

i

Contents

atm debug aal5stats ............................................................................................................................. 41
atm debug gstats.................................................................................................................................. 42
atm debug portstats ............................................................................................................................. 43
atm oam config..................................................................................................................................... 44
atm oam list .......................................................................................................................................... 45
atm oam modify ................................................................................................................................... 46
atm oam ping........................................................................................................................................ 48
atm oam cc list...................................................................................................................................... 49
atm oam cc modify............................................................................................................................... 50
atm oam cc send .................................................................................................................................. 51
atm oam vclb add ................................................................................................................................. 52
atm oam vclb del .................................................................................................................................. 53
atm oam vclb list .................................................................................................................................. 54
atm phonebook add ............................................................................................................................. 55
atm phonebook autolist ....................................................................................................................... 56
atm phonebook delete ......................................................................................................................... 57
atm phonebook flush ........................................................................................................................... 58
atm phonebook list............................................................................................................................... 59
atm qosbook add .................................................................................................................................. 60
atm qosbook config.............................................................................................................................. 61
atm qosbook ctdadd............................................................................................................................. 62
atm qosbook ctddelete......................................................................................................................... 64
atm qosbook ctdlist .............................................................................................................................. 65
atm qosbook delete .............................................................................................................................. 66
atm qosbook flush ................................................................................................................................ 67
atm qosbook list ................................................................................................................................... 68

4

AutoPVC Commands................................................................. 69
autopvc config ...................................................................................................................................... 70
autopvc list............................................................................................................................................ 72

5

Config Commands ..................................................................... 73
config delete ......................................................................................................................................... 74
config dump .......................................................................................................................................... 75
config flush ........................................................................................................................................... 76
config list............................................................................................................................................... 77
config load ............................................................................................................................................ 78
config save ............................................................................................................................................ 80

ii

E-DOC-CTC-20061027-0003 v2.0

Contents

6

Connection Commands............................................................. 81
connection appconfig........................................................................................................................... 82
connection appinfo............................................................................................................................... 84
connection applist ................................................................................................................................ 85
connection bind .................................................................................................................................... 86
connection bindlist ............................................................................................................................... 87
connection clean................................................................................................................................... 88
connection clear ................................................................................................................................... 89
connection config ................................................................................................................................. 90
connection debug ................................................................................................................................. 91
connection describe ............................................................................................................................. 92
connection flush ................................................................................................................................... 93
connection info ..................................................................................................................................... 94
connection list....................................................................................................................................... 95
connection refresh................................................................................................................................ 96
connection stats.................................................................................................................................... 97
connection timerclear .......................................................................................................................... 98
connection timerconfig ........................................................................................................................ 99
connection unbind.............................................................................................................................. 100

7

CWMP Commands................................................................... 101
cwmp config ....................................................................................................................................... 102
cwmp server config ............................................................................................................................ 104

8

Debug Commands ................................................................... 105
debug exec.......................................................................................................................................... 106

9

DHCP Commands .................................................................... 107
dhcp client flush ................................................................................................................................. 109
dhcp client ifadd ................................................................................................................................. 110
dhcp client ifattach ............................................................................................................................. 111
dhcp client ifconfig ............................................................................................................................. 112
dhcp client ifdelete ............................................................................................................................. 113
dhcp client ifdetach ............................................................................................................................ 114
dhcp client iflist................................................................................................................................... 115
dhcp client ifrenew ............................................................................................................................. 117
dhcp client debug clear ...................................................................................................................... 119
dhcp client debug stats ...................................................................................................................... 120

E-DOC-CTC-20061027-0003 v2.0

iii

Contents

dhcp client debug traceconfig ........................................................................................................... 121
dhcp client rqoptions add .................................................................................................................. 122
dhcp client rqoptions delete .............................................................................................................. 123
dhcp client rqoptions list ................................................................................................................... 124
dhcp client rqoptions optionlist ........................................................................................................ 125
dhcp client txoptions add .................................................................................................................. 126
dhcp client txoptions delete .............................................................................................................. 127
dhcp client txoptions list .................................................................................................................... 128
dhcp client txoptions optionlist ......................................................................................................... 129
dhcp relay add .................................................................................................................................... 130
dhcp relay debug stats ....................................................................................................................... 131
dhcp relay debug traceconfig ............................................................................................................ 132
dhcp relay config ................................................................................................................................ 133
dhcp relay delete ................................................................................................................................ 134
dhcp relay flush .................................................................................................................................. 135
dhcp relay ifconfig .............................................................................................................................. 136
dhcp relay iflist ................................................................................................................................... 138
dhcp relay list...................................................................................................................................... 139
dhcp relay modify............................................................................................................................... 140
dhcp relay ruleadd.............................................................................................................................. 141
dhcp relay ruledelete.......................................................................................................................... 142
dhcp rule add ...................................................................................................................................... 143
dhcp rule debug traceconfig.............................................................................................................. 144
dhcp rule delete .................................................................................................................................. 145
dhcp rule flush .................................................................................................................................... 146
dhcp rule list ....................................................................................................................................... 147
dhcp server config .............................................................................................................................. 148
dhcp server flush ................................................................................................................................ 149
dhcp server policy .............................................................................................................................. 150
dhcp server debug clear .................................................................................................................... 151
dhcp server debug stats..................................................................................................................... 152
dhcp server debug traceconfig.......................................................................................................... 154
dhcp server lease add ........................................................................................................................ 155
dhcp server lease delete .................................................................................................................... 157
dhcp server lease flush ...................................................................................................................... 158
dhcp server lease list.......................................................................................................................... 159
dhcp server option flush .................................................................................................................... 160
dhcp server option instadd ................................................................................................................ 161

iv

E-DOC-CTC-20061027-0003 v2.0

Contents

dhcp server option instdelete ............................................................................................................ 163
dhcp server option instlist ................................................................................................................. 164
dhcp server option tmpladd .............................................................................................................. 165
dhcp server option tmpldelete .......................................................................................................... 166
dhcp server option tmpllist................................................................................................................ 167
dhcp server pool add ......................................................................................................................... 168
dhcp server pool config ..................................................................................................................... 170
dhcp server pool delete ..................................................................................................................... 172
dhcp server pool flush ....................................................................................................................... 173
dhcp server pool list ........................................................................................................................... 174
dhcp server pool optadd .................................................................................................................... 175
dhcp server pool optdelete ................................................................................................................ 176
dhcp server pool rtadd ....................................................................................................................... 178
dhcp server pool rtdelete ................................................................................................................... 179
dhcp server pool ruleadd ................................................................................................................... 180
dhcp server pool ruledelete ............................................................................................................... 181

10

DNS Commands ...................................................................... 183
dns client config ................................................................................................................................. 184
dns client dnsadd ............................................................................................................................... 185
dns client dnsdelete ........................................................................................................................... 186
dns client dnslist ................................................................................................................................. 187
dns client flush.................................................................................................................................... 188
dns client nslookup ............................................................................................................................ 189
dns server config ................................................................................................................................ 190
dns server flush .................................................................................................................................. 191
dns server debug clear....................................................................................................................... 192
dns server debug stats ....................................................................................................................... 193
dns server debug spoof clear ............................................................................................................ 194
dns server debug spoof getaddress ................................................................................................. 195
dns server debug spoof getflags....................................................................................................... 196
dns server debug spoof list ............................................................................................................... 197
dns server debug spoof update ........................................................................................................ 198
dns server host add ............................................................................................................................ 199
dns server host delete ........................................................................................................................ 200
dns server host flush .......................................................................................................................... 201
dns server host list ............................................................................................................................. 202
dns server route add .......................................................................................................................... 203

E-DOC-CTC-20061027-0003 v2.0

v

Contents

dns server route delete ...................................................................................................................... 205
dns server route flush ........................................................................................................................ 206
dns server route list............................................................................................................................ 207

11

DSD Commands....................................................................... 209
dsd config............................................................................................................................................ 210
dsd debug config ................................................................................................................................ 211
dsd debug connection list.................................................................................................................. 212
dsd debug proxy................................................................................................................................. 213
dsd debug recycling ........................................................................................................................... 214
dsd debug stats .................................................................................................................................. 215
dsd intercept config............................................................................................................................ 216
dsd syslog config................................................................................................................................ 217
dsd syslog list ..................................................................................................................................... 218
dsd urlfilter config .............................................................................................................................. 219
dsd urlfilter rule add ........................................................................................................................... 220
dsd urlfilter rule delete ....................................................................................................................... 221
dsd urlfilter rule flush ......................................................................................................................... 222
dsd urlfilter rule list ............................................................................................................................ 223
dsd urlfilter rule modify ..................................................................................................................... 224

12

DynDNS Commands................................................................ 227
dyndns add ......................................................................................................................................... 228
dyndns delete ..................................................................................................................................... 229
dyndns flush ....................................................................................................................................... 230
dyndns list........................................................................................................................................... 231
dyndns modify .................................................................................................................................... 232
dyndns host add ................................................................................................................................. 234
dyndns host delete ............................................................................................................................. 235
dyndns host flush ............................................................................................................................... 236
dyndns host list .................................................................................................................................. 237
dyndns service list .............................................................................................................................. 238
dyndns service modify ....................................................................................................................... 240

13

Env Commands........................................................................ 243
env flush.............................................................................................................................................. 244
env get................................................................................................................................................. 245
env list ................................................................................................................................................. 246

vi

E-DOC-CTC-20061027-0003 v2.0

Contents

env set ................................................................................................................................................. 247
env unset............................................................................................................................................. 248

14

Eth Commands ........................................................................ 249
eth ifadd .............................................................................................................................................. 252
eth ifattach .......................................................................................................................................... 253
eth ifconfig .......................................................................................................................................... 254
eth ifdelete .......................................................................................................................................... 255
eth ifdetach ......................................................................................................................................... 256
eth iflist................................................................................................................................................ 257
eth flush............................................................................................................................................... 258
eth bridge clear................................................................................................................................... 259
eth bridge list ...................................................................................................................................... 260
eth bridge add..................................................................................................................................... 261
eth bridge delete................................................................................................................................. 262
eth bridge select ................................................................................................................................. 263
eth bridge config ................................................................................................................................ 264
eth bridge dynvlan actlist .................................................................................................................. 265
eth bridge dynvlan add ...................................................................................................................... 266
eth bridge dynvlan config .................................................................................................................. 267
eth bridge dynvlan delete .................................................................................................................. 268
eth bridge dynvlan flush .................................................................................................................... 269
eth bridge dynvlan list ....................................................................................................................... 270
eth bridge flush................................................................................................................................... 271
eth bridge ifadd .................................................................................................................................. 272
eth bridge ifattach .............................................................................................................................. 273
eth bridge ifconfig .............................................................................................................................. 274
eth bridge ifdelete .............................................................................................................................. 276
eth bridge ifdetach ............................................................................................................................. 277
eth bridge iflist .................................................................................................................................... 278
eth bridge ifflush ................................................................................................................................ 279
eth bridge igmpsnooping config....................................................................................................... 280
eth bridge igmpsnooping list ............................................................................................................ 281
eth bridge igmpsnooping ifconfig .................................................................................................... 282
eth bridge igmpsnooping iflist .......................................................................................................... 283
eth bridge igmpsnooping clear ......................................................................................................... 284
eth bridge macadd ............................................................................................................................. 285
eth bridge macdelete ......................................................................................................................... 287

E-DOC-CTC-20061027-0003 v2.0

vii

Contents

eth bridge maclist ............................................................................................................................... 289
eth bridge mcdadd ............................................................................................................................. 290
eth bridge mcddelete ......................................................................................................................... 291
eth bridge mcdlist............................................................................................................................... 292
eth bridge rule add ............................................................................................................................. 293
eth bridge rule delete ......................................................................................................................... 294
eth bridge rule flush ........................................................................................................................... 295
eth bridge rule list .............................................................................................................................. 296
eth bridge vlan ifadd .......................................................................................................................... 297
eth bridge vlan ifconfig ...................................................................................................................... 298
eth bridge vlan ifdelete ...................................................................................................................... 299
eth bridge vlan iflist............................................................................................................................ 300
eth device ifconfig .............................................................................................................................. 301
eth device iflist .................................................................................................................................... 303
eth switch group flush ....................................................................................................................... 304
eth switch group list ........................................................................................................................... 305
eth switch group move ...................................................................................................................... 306
eth switch mirror capture .................................................................................................................. 307
eth switch mirror egress .................................................................................................................... 308
eth switch mirror ingress ................................................................................................................... 309
eth switch share add .......................................................................................................................... 310
eth switch share delete ...................................................................................................................... 311
eth switch share list............................................................................................................................ 312
eth switch info .................................................................................................................................... 313
eth switch qos config ......................................................................................................................... 314
eth switch qos ifconfig ....................................................................................................................... 315
eth switch qos list ............................................................................................................................... 316
eth switch qos weights ...................................................................................................................... 317
eth switch shaper config .................................................................................................................... 318
eth switch shaper ifconfig.................................................................................................................. 319
eth switch shaper iflist ....................................................................................................................... 320
eth switch storm ifconfig ................................................................................................................... 321
eth switch storm iflist ......................................................................................................................... 322
eth vlan add ........................................................................................................................................ 323
eth vlan delete .................................................................................................................................... 324
eth vlan flush ...................................................................................................................................... 325
eth vlan list.......................................................................................................................................... 326

viii

E-DOC-CTC-20061027-0003 v2.0

Contents

15

Expr Commands ...................................................................... 327
expr add .............................................................................................................................................. 328
expr delete .......................................................................................................................................... 332
expr flush ............................................................................................................................................ 334
expr list................................................................................................................................................ 335
expr modify......................................................................................................................................... 339

16

Firewall Commands................................................................. 343
firewall config ..................................................................................................................................... 344
firewall clear........................................................................................................................................ 346
firewall list........................................................................................................................................... 347
firewall chain add ............................................................................................................................... 349
firewall chain delete ........................................................................................................................... 351
firewall chain flush ............................................................................................................................. 353
firewall chain list................................................................................................................................. 354
firewall debug clear ............................................................................................................................ 355
firewall debug stats ............................................................................................................................ 356
firewall debug traceconfig ................................................................................................................. 357
firewall level add ................................................................................................................................ 358
firewall level delete ............................................................................................................................ 359
firewall level flush .............................................................................................................................. 360
firewall level list .................................................................................................................................. 361
firewall level modify ........................................................................................................................... 362
firewall level set .................................................................................................................................. 363
firewall rule add .................................................................................................................................. 364
firewall rule delete .............................................................................................................................. 365
firewall rule flush ................................................................................................................................ 366
firewall rule list ................................................................................................................................... 367
firewall rule modify ............................................................................................................................ 369
firewall rule debug clear .................................................................................................................... 370
firewall rule debug stats .................................................................................................................... 372
firewall rule debug traceconfig ......................................................................................................... 374

17

GRP Commands....................................................................... 375
grp config ............................................................................................................................................ 376
grp flush .............................................................................................................................................. 377
grp rtlist ............................................................................................................................................... 378
grp rip config ...................................................................................................................................... 379

E-DOC-CTC-20061027-0003 v2.0

ix

Contents

grp rip flush......................................................................................................................................... 382
grp rip ifconfig .................................................................................................................................... 383
grp rip show........................................................................................................................................ 385

18

Hostmgr Commands ............................................................... 387
hostmgr add........................................................................................................................................ 388
hostmgr clear...................................................................................................................................... 390
hostmgr config ................................................................................................................................... 391
hostmgr delete.................................................................................................................................... 392
hostmgr flush...................................................................................................................................... 393
hostmgr list ......................................................................................................................................... 394

19

IDS Commands ........................................................................ 395
ids clear ............................................................................................................................................... 396
ids config ............................................................................................................................................. 397
ids parser list....................................................................................................................................... 398
ids parser modify................................................................................................................................ 399
ids pattern clear .................................................................................................................................. 401
ids pattern list ..................................................................................................................................... 402
ids pattern stats .................................................................................................................................. 403
ids signature list ................................................................................................................................. 404
ids signature modify .......................................................................................................................... 405
ids threshold clear .............................................................................................................................. 406
ids threshold list ................................................................................................................................. 407
ids threshold modify .......................................................................................................................... 408

20

IGMP Commands..................................................................... 409
igmp host config................................................................................................................................. 410
igmp host flush ................................................................................................................................... 411
igmp host list ...................................................................................................................................... 412
igmp host ifconfig .............................................................................................................................. 413
igmp host iflist .................................................................................................................................... 414
igmp host debug clear ....................................................................................................................... 415
igmp host debug stats ....................................................................................................................... 416
igmp proxy config .............................................................................................................................. 417
igmp proxy flush ................................................................................................................................ 419
igmp proxy grouplist.......................................................................................................................... 420
igmp proxy ifconfig ............................................................................................................................ 421

x

E-DOC-CTC-20061027-0003 v2.0

Contents

igmp proxy iflist.................................................................................................................................. 422
igmp proxy mbslist ............................................................................................................................ 423
igmp proxy debug clear ..................................................................................................................... 424
igmp proxy debug stats ..................................................................................................................... 425
igmp proxy debug traceconfig .......................................................................................................... 426

21

Interface Commands ............................................................... 427
interface list......................................................................................................................................... 428

22

IP Commands ........................................................................... 431
ip arpadd ............................................................................................................................................. 433
ip arpdelete ......................................................................................................................................... 434
ip arplist............................................................................................................................................... 435
ip config............................................................................................................................................... 436
ip flush................................................................................................................................................. 438
ip ifadd................................................................................................................................................. 439
ip ifattach............................................................................................................................................. 440
ip ifconfig ............................................................................................................................................ 441
ip ifdelete............................................................................................................................................. 443
ip ifdetach............................................................................................................................................ 444
ip iflist .................................................................................................................................................. 445
ip ifwait................................................................................................................................................ 446
ip ipadd................................................................................................................................................ 447
ip ipconfig ........................................................................................................................................... 448
ip ipdelete............................................................................................................................................ 449
ip iplist ................................................................................................................................................. 450
ip mcast rtadd ..................................................................................................................................... 451
ip mcast rtdelete ................................................................................................................................. 452
ip mcast rtlist ...................................................................................................................................... 453
ip mcast flush...................................................................................................................................... 454
ip rtadd ................................................................................................................................................ 455
ip rtdelete ............................................................................................................................................ 457
ip rtlist.................................................................................................................................................. 458
ip auto flush ........................................................................................................................................ 459
ip auto ifadd ........................................................................................................................................ 460
ip auto ifattach .................................................................................................................................... 461
ip auto ifconfig .................................................................................................................................... 462
ip auto ifdelete .................................................................................................................................... 464

E-DOC-CTC-20061027-0003 v2.0

xi

Contents

ip auto ifdetach ................................................................................................................................... 465
ip auto iflist ......................................................................................................................................... 466
ip debug httpprobe............................................................................................................................. 467
ip debug sendto .................................................................................................................................. 468
ip debug stats ..................................................................................................................................... 470
ip debug traceconfig .......................................................................................................................... 471

23

IPQoS Commands.................................................................... 473
ipqos config ........................................................................................................................................ 474
ipqos list .............................................................................................................................................. 477
ipqos ef config .................................................................................................................................... 478
ipqos ef list.......................................................................................................................................... 479
ipqos ef stats ....................................................................................................................................... 480
ipqos queue clear ............................................................................................................................... 481
ipqos queue config ............................................................................................................................. 482
ipqos queue list .................................................................................................................................. 484
ipqos queue stats ............................................................................................................................... 485

24

Label Commands ..................................................................... 487
label add.............................................................................................................................................. 488
label delete .......................................................................................................................................... 489
label flush ............................................................................................................................................ 490
label list ............................................................................................................................................... 491
label modify ........................................................................................................................................ 492
label chain add.................................................................................................................................... 495
label chain delete................................................................................................................................ 496
label chain flush.................................................................................................................................. 497
label chain list ..................................................................................................................................... 498
label rule add ...................................................................................................................................... 499
label rule delete .................................................................................................................................. 502
label rule flush .................................................................................................................................... 504
label rule list........................................................................................................................................ 505
label rule modify................................................................................................................................. 507
label rule debug clear......................................................................................................................... 508
label rule debug stats ......................................................................................................................... 510
label rule debug traceconfig .............................................................................................................. 511

25

xii

Language Commands ............................................................. 513

E-DOC-CTC-20061027-0003 v2.0

Contents

language config .................................................................................................................................. 514
language delete .................................................................................................................................. 515
language list........................................................................................................................................ 516

26

MBUS Commands ................................................................... 517
mbus client config .............................................................................................................................. 518
mbus client exec ................................................................................................................................. 519
mbus client register............................................................................................................................ 521
mbus debug stats ............................................................................................................................... 522
mbus debug clearstats ....................................................................................................................... 523
mbus debug traceconfig .................................................................................................................... 524
mbus listobjects.................................................................................................................................. 525
mbus listtypes..................................................................................................................................... 526
mbus listenums .................................................................................................................................. 527
mbus listcontexts ............................................................................................................................... 528
mbus listsubscriptions ....................................................................................................................... 529
mbus debug loadobjects ................................................................................................................... 530
mbus debug unloadobjects .............................................................................................................. 531
mbus pluginevent............................................................................................................................... 532
mbus unregister ................................................................................................................................. 533
mbus client unregister ....................................................................................................................... 534

27

MEMM Commands.................................................................. 535
memm debug lock traceconfig.......................................................................................................... 536
memm debug traceconfig ................................................................................................................. 537
memm debug clearstats .................................................................................................................... 538
memm debug lock stats..................................................................................................................... 539
memm listobjects ............................................................................................................................... 540
memm stats ........................................................................................................................................ 541

28

MLP Commands ...................................................................... 543
mlp flush ............................................................................................................................................. 544
mlp import .......................................................................................................................................... 545
mlp debug export ............................................................................................................................... 546
mlp debug stats .................................................................................................................................. 547
mlp debug traceconfig ....................................................................................................................... 548
mlp privilege add................................................................................................................................ 549
mlp privilege addzone........................................................................................................................ 551

E-DOC-CTC-20061027-0003 v2.0

xiii

Contents

mlp privilege config ........................................................................................................................... 552
mlp privilege delete............................................................................................................................ 553
mlp privilege list ................................................................................................................................. 555
mlp privilege removezone ................................................................................................................. 557
mlp role add ........................................................................................................................................ 558
mlp role addpriv ................................................................................................................................. 560
mlp role config.................................................................................................................................... 561
mlp role delete .................................................................................................................................... 562
mlp role list ......................................................................................................................................... 563
mlp role removepriv........................................................................................................................... 564

29

NAT Commands....................................................................... 565
nat config ............................................................................................................................................ 566
nat flush............................................................................................................................................... 567
nat ifconfig .......................................................................................................................................... 568
nat iflist................................................................................................................................................ 569
nat mapadd ......................................................................................................................................... 570
nat mapdelete ..................................................................................................................................... 574
nat maplist .......................................................................................................................................... 575
nat tmpladd ......................................................................................................................................... 576
nat tmpldelete ..................................................................................................................................... 580
nat tmpllist .......................................................................................................................................... 581
nat tmplinst ......................................................................................................................................... 582

30

PPP Commands........................................................................ 583
ppp flush ............................................................................................................................................. 584
ppp ifadd ............................................................................................................................................. 585
ppp ifattach ......................................................................................................................................... 587
ppp ifconfig ......................................................................................................................................... 589
ppp ifdelete ......................................................................................................................................... 594
ppp ifdetach ........................................................................................................................................ 596
ppp iflist............................................................................................................................................... 598
ppp ifscan ............................................................................................................................................ 599
ppp rtadd ............................................................................................................................................. 600
ppp rtdelete......................................................................................................................................... 602
ppp relay flush .................................................................................................................................... 604
ppp relay ifadd .................................................................................................................................... 605
ppp relay ifconfig................................................................................................................................ 606

xiv

E-DOC-CTC-20061027-0003 v2.0

Contents

ppp relay ifdelete................................................................................................................................ 607
ppp relay iflist ..................................................................................................................................... 608
ppp relay sesslist ................................................................................................................................ 609

31

PPTP Commands ..................................................................... 611
pptp ifadd ............................................................................................................................................ 612
pptp flush ............................................................................................................................................ 613
pptp list................................................................................................................................................ 614
pptp profadd ....................................................................................................................................... 615
pptp profdelete ................................................................................................................................... 617
pptp proflist......................................................................................................................................... 618

32

Script Commands .................................................................... 619
script add............................................................................................................................................. 620
script delete......................................................................................................................................... 621
script flush........................................................................................................................................... 622
script list .............................................................................................................................................. 623
script run ............................................................................................................................................. 625

33

Service Commands.................................................................. 627
service host assign ............................................................................................................................. 628
service host config ............................................................................................................................. 629
service host add.................................................................................................................................. 630
service host delete.............................................................................................................................. 631
service host disable ............................................................................................................................ 632
service host flush................................................................................................................................ 633
service host list ................................................................................................................................... 634
service host stats ................................................................................................................................ 635
service host triggerlist........................................................................................................................ 636
service host rule add .......................................................................................................................... 637
service host rule delete ...................................................................................................................... 638
service system ifadd........................................................................................................................... 639
service system ifdelete....................................................................................................................... 640
service system ipadd.......................................................................................................................... 641
service system ipdelete...................................................................................................................... 642
service system list .............................................................................................................................. 643
service system mapadd ..................................................................................................................... 645
service system mapdelete ................................................................................................................. 646

E-DOC-CTC-20061027-0003 v2.0

xv

Contents

service system modify ....................................................................................................................... 647

34

SNMP Commands ................................................................... 649
snmp config ........................................................................................................................................ 650
snmp get ............................................................................................................................................. 651
snmp getnext ...................................................................................................................................... 652
snmp walk ........................................................................................................................................... 653
snmp community add ........................................................................................................................ 654
snmp community delete .................................................................................................................... 655
snmp community list ......................................................................................................................... 656
snmp community modify .................................................................................................................. 657
snmp ifadd .......................................................................................................................................... 658
snmp ifdelete ...................................................................................................................................... 659
snmp ifattach ...................................................................................................................................... 660
snmp ifdetach ..................................................................................................................................... 661
snmp ifconfig ...................................................................................................................................... 662
snmp iflist............................................................................................................................................ 663

35

SNTP Commands..................................................................... 665
sntp add............................................................................................................................................... 666
sntp config .......................................................................................................................................... 667
sntp delete........................................................................................................................................... 668
sntp flush............................................................................................................................................. 669
sntp list ................................................................................................................................................ 670

36

Software Commands .............................................................. 671
software upgrade ............................................................................................................................... 672
software version ................................................................................................................................. 673

37

System Commands ................................................................. 675
system config...................................................................................................................................... 676
system flush ........................................................................................................................................ 678
system locale ...................................................................................................................................... 679
system reboot ..................................................................................................................................... 681
system reset........................................................................................................................................ 682
system timedreboot ........................................................................................................................... 684
system debug autosave ..................................................................................................................... 685
system debug stats ............................................................................................................................ 686

xvi

E-DOC-CTC-20061027-0003 v2.0

Contents

system ra config ................................................................................................................................. 687
system rtc synchronize ...................................................................................................................... 688
system rtc settime .............................................................................................................................. 689

38

Systemlog Commands............................................................ 691
systemlog flush .................................................................................................................................. 692
systemlog show.................................................................................................................................. 693
systemlog send................................................................................................................................... 695
systemlog DBG dbg_syslog............................................................................................................... 696
systemlog DBG dbg_long_mess ....................................................................................................... 697
systemlog DBG dbg_burst ................................................................................................................. 698
systemlog DBG dbg_contents ........................................................................................................... 699

39

Upgrade Commands ............................................................... 701
upgrade config.................................................................................................................................... 702
upgrade start....................................................................................................................................... 703
upgrade debug traceconfig ............................................................................................................... 704
upgrade debug sesslist ...................................................................................................................... 705
upgrade profile add ............................................................................................................................ 706
upgrade profile modify ...................................................................................................................... 707
upgrade profile delete ........................................................................................................................ 708
upgrade profile list ............................................................................................................................. 709
upgrade ifadd...................................................................................................................................... 710
upgrade ifattach.................................................................................................................................. 711
upgrade ifconfig ................................................................................................................................. 712
upgrade ifdelete.................................................................................................................................. 713
upgrade ifdetach................................................................................................................................. 714
upgrade iflist ....................................................................................................................................... 715

40

UPnP Commands..................................................................... 717
upnp config ......................................................................................................................................... 718
upnp flush ........................................................................................................................................... 719
upnp list............................................................................................................................................... 720

41

User Commands ...................................................................... 721
user add............................................................................................................................................... 722
user config .......................................................................................................................................... 724
user delete........................................................................................................................................... 726

E-DOC-CTC-20061027-0003 v2.0

xvii

Contents

user flush............................................................................................................................................. 727
user list ................................................................................................................................................ 728
user rights ........................................................................................................................................... 730

42

Abbreviations........................................................................... 731

43

System Logging Messages..................................................... 735
Auto-PVC Module ............................................................................................................................... 736
Configuration Module ........................................................................................................................ 736
DHCP Client Module ........................................................................................................................... 736
DHCP Relay Module ........................................................................................................................... 737
DHCP Server Module ......................................................................................................................... 737
Dyndns Module .................................................................................................................................. 738
Firewall Module .................................................................................................................................. 738
LOGIN Module .................................................................................................................................... 739
Kernel Module .................................................................................................................................... 739
Linestate Module ................................................................................................................................ 739
NAPT Module...................................................................................................................................... 739
PPP Module......................................................................................................................................... 740
PPTP Module....................................................................................................................................... 740
RIP Module .......................................................................................................................................... 741
Routing Module .................................................................................................................................. 742
Session Module .................................................................................................................................. 742
SNTP Module...................................................................................................................................... 742
Software Module ................................................................................................................................ 743
UPnP Module ...................................................................................................................................... 743
............................................................................................................................................................. 743

44

Supported Key Names ............................................................ 745
Supported IP Protocols ...................................................................................................................... 746
Supported TCP/UDP Port Names ...................................................................................................... 747
Supported ICMP Type Names ........................................................................................................... 750
Supported Facilities........................................................................................................................... 751
Supported Severities......................................................................................................................... 752
IP Precedence...................................................................................................................................... 752
Differentiated Services Code Point (DSCP) ...................................................................................... 753

xviii

E-DOC-CTC-20061027-0003 v2.0

About this CLI Reference Guide

About this CLI Reference Guide
Used Symbols

i

A note provides additional information about a topic.

!

A caution warns you about potential problems or specific precautions that need to be taken.

Terminology
Generally, the Thomson ST516/536/546 will be referred to as Thomson ST in this CLI Reference Guide.

Typographical Conventions
Following typographical convention is used throughout this manual:

>

Sample text indicates a hyperlink to a Web site.
Example: For more information, visit us at www.thomson-broadband.com.

>

Sample text indicates an internal cross-reference.
Example: If you want to know more about guide, see “1 Introduction” on page 7”.

>

Sample text indicates an important content-related word.
Example: To enter the network, you must authenticate yourself.

> Sample text indicates a CLI command to be input after the CLI prompt.
Example: To obtain a list of all available command groups, type help at the top level.

>
>

Sample text indicates input in the CLI interface.
Sample text indicates comment explaining output in the CLI interface.

Documentation and software updates
THOMSON continuously develops new solutions, but is also committed to improving 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 http://www.thomson-broadband.com.

E-DOC-CTC-20061027-0003 v2.0

1

About this CLI Reference Guide

2

E-DOC-CTC-20061027-0003 v2.0

Root Commands

1

Root Commands
From the root prompt, you can choose one of the following commands:

Command

Description

help

Displays the help information.

?
menu

Displays the menu.

exit

Exits the shell.

..

Exits group selection.

saveall

Saves current configuration.

ping

Send ICMP ECHO_REQUEST packets.

traceroute

Send ICMP/UDP packets to trace the ip path.

i

To obtain help on a specific command group:

>
>

type help, followed by the name of the command group, and then press ENTER, or
type the name of the command group, press ENTER, and then type help.

EXAMPLE:
=>help firewall
Following commands are available :
config
list
clear

: Display/Modify firewall configuration.
: Display firewall configuration.
: Clear firewall configuration.

Following command groups are available :
chain

debug

level

rule

=>

E-DOC-CTC-20061027-0003 v2.0

3

Root Commands

ping
Send ICMP ECHO_REQUEST packets.

SYNTAX:
ping

proto = <{ip|atm}>
addr = 
dest = 
[count = ]
[size = ]
[interval(ms) = ]
[DF-bit = <{disabled|enabled}>] [srcaddr = ]

where:
proto

The interface type to be used.
Choose between:

>
>

REQUIRED

ip
atm

addr

The destination IP address.

REQUIRED

dest

The destination address for the request.

REQUIRED

count

A number between 1 and 1000000.
Represents the number of pings to send.
The default is 5.

OPTIONAL

size

A number between 0 and 20000.
Represents the size of the ping payload(s).

OPTIONAL

interval

A number between 100 and 1000000.
Represents the interval in milliseconds between packets.
The default is 100.

OPTIONAL

DF-bit

Set the Don't Fragment bit (or leave unset) in the IP header of ping.
The default is disabled.

OPTIONAL

scraddr

The IP source address to use.

OPTIONAL

EXAMPLE:
=>:ping proto=ip addr=192.168.1.70
Legend : Ping successful(!)
Ping Timeout(.)
Hit ctrl-g to abort...
!!!!!
--- ping statistics --5 packet(s) transmitted, 5 successful, 0% loss
rtt min/avg/max = 1 / 2 / 4 ms
=>

4

E-DOC-CTC-20061027-0003 v2.0

Root Commands

traceroute
Send ICMP/UDP packets to trace the IP path.

SYNTAX:
traceroute

addr = 
[count = ]
[size = ]
[interval = ]
[maxhops = ]
[dstport = ]
[maxfail = ]
[type = <{icmp | udp}>]
[utime = <{disabled | enabled}>]

where:
addr

The destination IP address.

REQUIRED

count

A number between 1 and 10.
Represents the number of times to reissue a traceroute request with the
same TTL.
The default is 3.

OPTIONAL

size

A number between 1 and 20000 (bytes).
Represents the size of the traceroute packet(s).
The default is 1.

OPTIONAL

interval

A number between 1000 and 60000 (milliseconds).
Represents the intermediate interval between two packets.
The default is 1000.

OPTIONAL

maxhops

A number between 1 and 255.
Represents the maximum number of routers through which a packet can
pass.
The default is 30.

OPTIONAL

dstport

A number between 1 and 65535.
Represents the UDP destination port number to send to.

OPTIONAL

maxfail

A number between 0 and 255.
Represents the maximum number of consecutive timeouts allowed
before terminating a traceroute request.
The default is 5.

OPTIONAL

type

The type of traceroute packet(s).
Choose between:

OPTIONAL

>
>

icmp
udp.

The default is icmp.
utime

E-DOC-CTC-20061027-0003 v2.0

Display time in useconds (enabled) or not (disabled).
The default is enabled.

OPTIONAL

5

Root Commands

EXAMPLE:
=>traceroute addr = 192.193.195.250 count=3 size=1 interval=1000 maxhops=30 dstport=33433
maxfail=5 type=icmp utime=yes
:traceroute addr=192.193.195.250
ttl=1
192.193.195.250 676 us 1351 us 648 us
=>

6

E-DOC-CTC-20061027-0003 v2.0

ADSL Commands

2

ADSL Commands

Introduction
This chapter describes the commands of the adsl command group.

Contents
This chapter covers the following commands:
adsl config

Show/set the Asymmetric Digital Subscriber Line (ADSL)
configuration.

8

adsl info

Display the ADSL statistics and information about the DSL line
status.

9

adsl debug bitloadinginfo

Displays the number of bits per tone.

11

adsl debug deltconfig

Enable/disable the Dual Ended Line Testing Interface (DELT)

12

adsl debug deltinfo

Display Dual Ended Line Testing Interface (DELT) results

12

adsl debug
modemoptioninfo

Displays the modem options bitmap

14

adsl debug
modemoption

Configure the modem options bitmap

15

adsl debug traceconfig

Configure the ADSL tracelevel.

16

E-DOC-CTC-20061027-0003 v2.0

7

ADSL Commands

adsl config
Show/set the Asymmetric Digital Subscriber Line (ADSL) configuration.

SYNTAX:
adsl config

[opermode = <{multimode | multi_adsl2 | multi_readsl2
| multi_adsl2plus}>]
[trace = <{disabled | enabled}>]

where:
opermode

The operational mode of the Thomson ST.
Choose between:

>
>
>
>

OPTIONAL

multimode
multi_adsl2
multi_readsl2
multi_adsl2plus

The default is multi_adsl2plus.
trace

Enable or disable ADSL tracing.
The default is enabled.

OPTIONAL

EXAMPLE:
The example below shows the default configuration for a Thomson ST ADSL/POTS variant:
=>adsl config
ADSL configuration:
opermode = multi_adsl2plus
trace = on
modemoption = 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
=>

8

E-DOC-CTC-20061027-0003 v2.0

ADSL Commands

adsl info
Display the ADSL statistics and information about the DSL line status.
Although the same command is used for both Thomson ST ADSL/POTS and Thomson ST ADSL/ISDN
variants, the command features specific output parameters and counters per variant.

SYNTAX:
adsl info

E-DOC-CTC-20061027-0003 v2.0

9

ADSL Commands

EXAMPLE (for a Thomson ST ADSL/POTS variant):
=>adsl info
Modemstate
Operation Mode
Channel Mode
Number of resets

:
:
:
:

Vendor
Country
Vendor
VendorSpecific
StandardRevisionNr

:
:
:
:

Local
0f
TMMB
0000
00

Margin
Attenuation
OutputPower

:
:
:

Downstream
26.0
0.0
4.0

Available Bandwidth
Downstream
Upstream

:
:

Cells/s
14490
1509

Transfer statistics
Errors
Received FEC
Received CRC
Received HEC
Transmitted FEC
Transmitted CRC
Tranmsitted HEC

:
:
:
:
:
:

Near end
Loss of
Loss of
Loss of
Errored
Near end
Loss of
Loss of
Loss of
Errored
Near end
Errored
Near end
Errored

[dB]
[dB]
[dBm]

failures
frame:
signal:
power:
seconds:
failures
frame:
signal:
power:
seconds:
failures
seconds:
failures
seconds:

up
G.992.1 Annex A
interleaved
1
Remote
00
0000
00
Upstream
18.0
2.0
11.5
Kbit/s
6144
640

0
0
0
0
0
0

since reset
0 failures
0 failures
0 failures
0 seconds
last 15 minutes
0 seconds
0 seconds
0 seconds
0 seconds
current day
0 seconds
previous day
0 seconds

=>

10

E-DOC-CTC-20061027-0003 v2.0

ADSL Commands

adsl debug bitloadinginfo
Displays the number of bits per tone.

Syntax
adsl debug bitloadinginfo

E-DOC-CTC-20061027-0003 v2.0

11

ADSL Commands

adsl debug deltconfig
Enable/disable the Dual Ended Line Testing Interface (DELT)

Syntax
adsl debug deltconfig

[state = <{disabled|enabled}>]

where:
state

12

enable or disable DELT

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

ADSL Commands

adsl debug deltinfo
Display Dual Ended Line Testing Interface (DELT) results

Syntax
adsl debug deltinfo

E-DOC-CTC-20061027-0003 v2.0

13

ADSL Commands

adsl debug modemoptioninfo
Displays the modem options bitmap

Syntax
adsl debug modemoptioninfo

14

E-DOC-CTC-20061027-0003 v2.0

ADSL Commands

adsl debug modemoption
Configure the modem options bitmap

Syntax
adsl debug modemoption

[config = ]

where:
config

E-DOC-CTC-20061027-0003 v2.0

The modem options bitmap

REQUIRED

15

ADSL Commands

adsl debug traceconfig
Configure the ADSL tracelevel.

Syntax
adsl debug traceconfig

[level = ]

where:
level

Trace Level:

>
>
>

16

REQUIRED

0=disable tracing;
1=enable dsl manager tracing;
2=enable dsl driver tracing)

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

3

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.

19

atm ifadd

Create a new ATM interface.

20

atm ifattach

Attach a ATM interface.

21

atm ifconfig

Configure an ATM interface.

22

atm ifdelete

Delete an ATM interface.

24

atm ifdetach

Detach an ATM interface.

25

atm iflist

Display the ATM interfaces.

26

atm bundle add

Add a new bundle of interfaces.

27

atm bundle attach

Attach a bundle of interfaces.

28

atm bundle config

Modify a bundle of interfaces.

29

atm bundle clear

Clear the bundle statistics.

30

atm bundle delete

Delete a bundle of interfaces.

31

atm bundle detach

Detach a bundle of interfaces.

32

atm bundle flush

Flush all bundles.

33

atm bundle ifadd

Add an interface on a bundle.

34

atm bundle ifconfig

Configure an interface from a bundle.

35

atm bundle ifdelete

Remove an interface from a bundle.

36

atm bundle list

Display the current bundles.

37

atm cac config

Configure the ATM connection admission control.

38

atm cac list

Display all the CAC parameters.

39

atm cac overbooking

Configure ATM overbooking parameters.

40

atm debug aal5stats

Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.

41

atm debug gstats

Display ATM global statistics.

42

atm debug portstats

Display port specific ATM statistics.

43

atm oam config

Modify the ATM Operation and Maintenance (OAM) settings.

44

atm oam list

Display the ATM OAM settings.

45

atm oam modify

Modify the ATM OAM data blocking mode.

46

atm oam ping

Send ATM loopback cells.

48

atm oam cc list

Display Continuity Check (CC) configuration.

49

atm oam cc modify

Modify CC on the connection.

50

atm oam cc send

Send CC activate/deactivate to connection.

51

E-DOC-CTC-20061027-0003 v2.0

17

ATM Commands

18

atm oam vclb add

Create a loopback connection for VC.

52

atm oam vclb del

Delete a loopback connection for VC.

53

atm oam vclb list

List all VC loopback connections.

54

atm phonebook add

Add a new phonebook entry.

55

atm phonebook
autolist

Show the auto PVCs.

56

atm phonebook delete

Delete an existing phonebook entry.

57

atm phonebook flush

Flush all the phonebook entries.

58

atm phonebook list

Display the current phonebook.

59

atm qosbook add

Add a new QoS book entry.

60

atm qosbook config

Modify the QoS book configuration.

61

atm qosbook ctdadd

Add a Connection Traffic Descriptor (CTD).

62

atm qosbook ctddelete

Delete a CTD.

64

atm qosbook ctdlist

Display all CTDs.

65

atm qosbook delete

Delete a QoS book entry.

66

atm qosbook flush

Flush all the QoS book entries.

67

atm qosbook list

Display the QoS book.

68

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm flush
Flush all Asynchronous Transfer Mode (ATM) interfaces.

SYNTAX:
atm flush

E-DOC-CTC-20061027-0003 v2.0

19

ATM Commands

atm ifadd
Create a new ATM interface.

SYNTAX:
atm ifadd

intf = 

where:
intf

The name for the new ATM interface.
Note

REQUIRED

If not specified, the destination parameter must be specified. In this
case the name of the destination will double as interface name.

EXAMPLE:
=>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
=>

RELATED COMMANDS:

20

atm ifdelete

Delete an ATM interface.

atm iflist

Display the ATM interfaces.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm ifattach
Attach a ATM interface.

SYNTAX:
atm ifattach

intf = 

where:
intf

The name of the ATM interface to be attached.

REQUIRED

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm ifdetach

E-DOC-CTC-20061027-0003 v2.0

Detach an ATM interface.

21

ATM Commands

atm ifconfig
Configure an ATM interface.

i

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.

SYNTAX:
atm ifconfig

intf = 
[dest = ]
[qos = ]
[clp = <{0|1|classification}>]
[clpthresh = ]
[encaps = <{llc | vcmux}>]
[retry = ]
[fcs = <{disabled | enabled | auto}>]
[ulp = <{ip | mac | ppp}>]

where:
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

clp

The mode used to determine the CLP bit value

OPTIONAL

clpthresh

Priority class threshold where CLP becomes 0 (for all classes >= threshold)

OPTIONAL

encaps

The type of encapsulation to be used for this ATM interface.
Choose between:

OPTIONAL

>
>

llc: Logical Link Control (LLC) / Sub Network Access Protocol (SNAP)
vcmux: Virtual Channel MUltipleXing (VCMUX).

The default is llc.
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

retry

22

OPTIONAL

This parameter is normally left disabled.

A number between 0 and 65535.
Represents the number of times the Thomson ST retries to set up a WAN
connection before giving up.
The default is 10.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

ulp

Select the Upper Layer Protocol (ULP) for this interface.
Choose between:

>
>
>

OPTIONAL

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.

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

=>

E-DOC-CTC-20061027-0003 v2.0

23

ATM Commands

atm ifdelete
Delete an ATM interface.

SYNTAX:
atm ifdelete

intf = 

where:
intf

The name of the ATM interface to be deleted.

REQUIRED

EXAMPLE:
=>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
=>

RELATED COMMANDS:

24

atm ifadd

Create a new ATM interface.

atm iflist

Display the ATM interfaces.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm ifdetach
Detach an ATM interface.

SYNTAX:
atm ifdetach

intf = 

where:
intf

The name of the ATM interface to be detached.

REQUIRED

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm ifattach

E-DOC-CTC-20061027-0003 v2.0

Attach a ATM interface.

25

ATM Commands

atm iflist
Display the ATM interfaces.

SYNTAX:
atm iflist

[intf = ]

where:
intf

The name of the ATM interface to be shown.
Note

OPTIONAL

If not specified, all the ATM interfaces are shown.

EXAMPLE:
=>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
=>

RELATED COMMANDS:

26

atm ifadd

Create a new ATM interface.

atm ifdelete

Delete an ATM interface.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle add
Add a new bundle of interfaces.

SYNTAX:
atm bundle add

name = 

where:
name

The name of the new bundle.

REQUIRED

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm bundle delete

Delete a bundle of interfaces.

atm bundle list

Display the current bundles.

E-DOC-CTC-20061027-0003 v2.0

27

ATM Commands

atm bundle attach
Attach a bundle of interfaces.

SYNTAX:
atm bundle attach

name = 

where:
name

The name of the bundle to be attached.

REQUIRED

EXAMPLE:
=>atm bundle attach name=myBundle
=>atm bundle list
myBundle: Connection state : connected
Retry: 10
TX requested bytes: 0
TX bytes: 0
RX bytes: 0
=>

Policy: priority Propagate: disabled
requested frames: 0
frames: 0
frames: 0

RELATED COMMANDS:
atm bundle detach

28

Detach a bundle of interfaces.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle config
Modify a bundle of interfaces.

i

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.

SYNTAX:
atm bundle config

name = 
[policy = <{priority | connection}>]
[propagate = <{disabled | enabled}>]
[retry = ]

where:
name

The name of the bundle to be configured.

REQUIRED

policy

The traffic handling policy of the bundle.
Choose between:

OPTIONAL

>

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.
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

EXAMPLE:
=>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
=>

E-DOC-CTC-20061027-0003 v2.0

29

ATM Commands

atm bundle clear
Clear the bundle statistics.

SYNTAX:
atm bundle clear

[name = ]

where:
name

The name of the bundle for which the statistics must be cleared.
Note

30

OPTIONAL

If not specified, the statistics for all the bundles will be cleared.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle delete
Delete a bundle of interfaces.

SYNTAX:
atm bundle delete

name = 

where:
name

The name of the bundle to be deleted.

REQUIRED

RELATED COMMANDS:
atm bundle add

Add a new bundle of interfaces.

atm bundle list

Display the current bundles.

E-DOC-CTC-20061027-0003 v2.0

31

ATM Commands

atm bundle detach
Detach a bundle of interfaces.

SYNTAX:
atm bundle detach

intf = 

where:
intf

The name of the bundle to be detached.

REQUIRED

RELATED COMMANDS:
atm bundle attach

32

Attach a bundle of interfaces.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle flush
Flush all bundles.

SYNTAX:
atm bundle flush

E-DOC-CTC-20061027-0003 v2.0

33

ATM Commands

atm bundle ifadd
Add an interface on a bundle.

i

Up to 8 interfaces or (sub-)bundles can be added to one bundle.

SYNTAX:
atm bundle ifadd

name = 
intf = 
[index = ]

where:
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

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm bundle ifdelete

34

Remove an interface from a bundle.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle ifconfig
Configure an interface from a bundle.

i

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.

SYNTAX:
atm bundle ifconfig

name = 
intf = 
[state = <{disabled | enabled}>]
[low = ]
[high = ]

where:
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.

OPTIONAL

Note
high

This parameter must only be configured when the policy of the
bundle is set to priority (see “ atm bundle config” on page 29).

A number between 0 and 15.
Represents the high selector value.
Note

E-DOC-CTC-20061027-0003 v2.0

OPTIONAL

This parameter must only be configured when the policy of the
bundle is set to priority (see “ atm bundle config” on page 29).

35

ATM Commands

atm bundle ifdelete
Remove an interface from a bundle.

SYNTAX:
atm bundle ifdelete

name = 
intf = 

where:
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

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm bundle ifadd

36

Add an interface on a bundle.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm bundle list
Display the current bundles.

SYNTAX:
atm bundle list

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm bundle add

Add a new bundle of interfaces.

atm bundle delete

Delete a bundle of interfaces.

E-DOC-CTC-20061027-0003 v2.0

37

ATM Commands

atm cac config
Configure the ATM connection admission control.

SYNTAX:
atm cac config

config port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or
number>
state = <{disabled|enabled}>

where:
config
port

The port for which CAC is configured.

REQUIRED

state

Enable/disable CAC for an ATM port.

REQUIRED

EXAMPLE:
{Administrator}=>atm cac config
port = dsl0
state = enabled
:atm cac config port=dsl0 state=enabled
{Administrator}=>

RELATED COMMANDS:

38

atm cac list

Display all the CAC parameters.

atm cac overbooking

Configure ATM overbooking parameters.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm cac list
Display all the CAC parameters.

SYNTAX:
atm cac list

EXAMPLE:
{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]=>

RELATED COMMANDS:
atm cac config

Configure the ATM connection admission control.

atm cac overbooking

Configure ATM overbooking parameters.

E-DOC-CTC-20061027-0003 v2.0

39

ATM Commands

atm cac overbooking
Configure ATM overbooking parameters.

SYNTAX:
atm cac overbooking

rt = 
nrt = 

where:
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

EXAMPLE:
{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]=>

RELATED COMMANDS:

40

atm cac config

Configure the ATM connection admission control.

atm cac list

Display all the CAC parameters.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm debug aal5stats
Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.

SYNTAX:
atm debug aal5stats

port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
vpi = 
[vci = ]
[clear = <{disabled | enabled}>]

where:
port

The port number for which statistics will be retrieved.
Choose between:

>
>
>
>
>
>

REQUIRED

DSL0
DSL1
ATM2
ATM3
AAL5
ATM5

Or specify a port number (dsl0 has port number 0).
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

RELATED COMMANDS:
atm debug gstats

Display ATM global statistics.

atm debug portstats

Display port specific ATM statistics.

E-DOC-CTC-20061027-0003 v2.0

41

ATM Commands

atm debug gstats
Display ATM global statistics.

SYNTAX:
atm debug gstats

[clear = <{disabled | enabled}>]

where:
clear

Enable or disable clearing of the statistics after request.

OPTIONAL

EXAMPLE:
{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]=>

RELATED COMMANDS:

42

atm debug aal5stats

Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.

atm debug portstats

Display port specific ATM statistics.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm debug portstats
Display port specific ATM statistics.

SYNTAX:
atm debug portstats

port = <{dsl0} or number>
[clear = <{disabled | enabled}>]

where:
port

The port number for which statistics will be retrieved.
Choose between:

>

REQUIRED

DSL0

Or specify a port number (dsl0 has port number 0).
clear

Enable or disable clearing of the statistics after request.

OPTIONAL

EXAMPLE:
=>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.
=>

RELATED COMMANDS:
atm debug aal5stats

Display ATM Adaptation Layer 5 (AAL5) port specific ATM statistics.

atm debug gstats

Display ATM global statistics.

E-DOC-CTC-20061027-0003 v2.0

43

ATM Commands

atm oam config
Modify the ATM Operation and Maintenance (OAM) settings.

SYNTAX:
atm oam config

[clp = ]
[loopbackid = ]

where:
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

RELATED COMMANDS:

44

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.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm oam list
Display the ATM OAM settings.

SYNTAX:
atm oam list

EXAMPLE:
=>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
=>

RELATED COMMANDS:
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.

E-DOC-CTC-20061027-0003 v2.0

45

ATM Commands

atm oam modify
Modify the ATM OAM data blocking mode.

SYNTAX:
atm oam modify

port = <{dsl0} or number>
blocking = <{disabled | enabled}>

where:
port

The port for which OAM blocking is configured.
Choose between:

>

REQUIRED

DSL0

Or specify a port number (dsl0 has port number 0).
blocking

46

Enable or disable the OAM data blocking mode on this port.
The default is enabled.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

EXAMPLE:
=>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 modify port=dsl1 blocking=disabled
=>: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: non blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking
=>

RELATED COMMANDS:
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.

E-DOC-CTC-20061027-0003 v2.0

47

ATM Commands

atm oam ping
Send ATM loopback cells.

SYNTAX:
atm oam ping

dest = 
[count = ]
[interval = ]

where:
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

EXAMPLE:
=>atm oam
loopback:
loopback:
loopback:
loopback:
loopback:
loopback:
loopback:
loopback:
loopback:
loopback:

ping dest=atm_ph_8_35
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:
successful, sequence:

count=10 interval=1000
1 time: 37890 usec
2 time: 39118 usec
3 time: 39116 usec
4 time: 39187 usec
5 time: 38605 usec
6 time: 38764 usec
7 time: 38752 usec
8 time: 38813 usec
9 time: 38848 usec
10 time: 38941 usec

--- loopback statistics --10 loopbacks transmitted, 10 successful, 0% loss, time 1390 ms
rtt min/avg/max = 37890/38803/39187
=>

RELATED COMMANDS:

48

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.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm oam cc list
Display Continuity Check (CC) configuration.

SYNTAX:
atm oam cc list

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm oam cc modify

Modify CC on the connection.

atm oam cc send

Send CC activate/deactivate to connection.

E-DOC-CTC-20061027-0003 v2.0

49

ATM Commands

atm oam cc modify
Modify CC on the connection.

SYNTAX:
atm oam modify

port = <{dsl0|dsl1|atm2|atm3|aal5|atm5} or number>
vpi = 
[vci = ]
[transmit = <{disabled | enabled}>]
[receive = <{disabled | enabled}>]
[auto = <{disabled | enabled}>]
[span = <{segment | end2end}>]

where:
port

The ATM port number.
Choose between:

>
>
>
>
>
>

REQUIRED

DSL0
DSL1
ATM2
ATM3
AAL5
ATM5

Or specify a port number (dsl0 has port number 0).
vpi

A number between 0 and 15.
Represents the VPI.

REQUIRED

vci

A number between 0 and 511.
Represents the VCI.

OPTIONAL

Note

For a Virtual Path (VP) cross-connection, use 0 or do not specify.

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:

OPTIONAL

>

end2end: monitoring occurs on the entire VC between two ATM end
stations.

>

segment: monitoring occurs on a VC segment between the Thomson
ST and a first-hop ATM switch.

RELATED COMMANDS:

50

atm oam cc list

Display Continuity Check (CC) configuration.

atm oam cc send

Send CC activate/deactivate to connection.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm oam cc send
Send CC activate/deactivate to connection.

SYNTAX:
atm oam cc send

port = <{dsl0} or number>
vpi = 
[vci = ]
[span = <{segment | end2end}>]
[action = <{activate | deactivate}>]
[direction = <{source | sink | both}>]

where:
port

The ATM port number.
Choose between:

>

REQUIRED

DSL0.

Or specify a port number (dsl0 has port number 0).
vpi

A number between 0 and 15.
Represents the VPI.

REQUIRED

vci

A number between 0 and 511.
Represents the VCI.

OPTIONAL

Note
span

For a VP cross-connection, use 0 or do not specify.

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 Thomson
ST 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:

OPTIONAL

>
>
>

source
sink
both.

The default is both.

RELATED COMMANDS:
atm oam cc list

Display Continuity Check (CC) configuration.

atm oam cc modify

Modify CC on the connection.

E-DOC-CTC-20061027-0003 v2.0

51

ATM Commands

atm oam vclb add
Create a loopback connection for VC.

SYNTAX:
atm oam vclb add

port = <{dsl0} or number>
vpi = 
[vci = ]

where:
port

The ATM port number.
Choose between:

>

REQUIRED

DSL0

Or specify a port number (dsl0 has port number 0).
vpi

A number between 0 and 15.
Represents the VPI.

REQUIRED

vci

A number between 0 and 511.
Represents the VCI.

OPTIONAL

Note

For a VP cross-connection, use 0 or do not specify.

EXAMPLE:
=>atm oam vclb
=>atm oam vclb
PORT = 0 VPI =
=>atm oam vclb
=>atm oam vclb
PORT = 0 VPI =
PORT = 1 VPI =
=>

add port=dsl0 vpi=0 vci=36
list
0 VCI = 36
add port=dsl1 vpi=0 vci=37
list
0 VCI = 36
0 VCI = 37

RELATED COMMANDS:

52

atm oam vclb del

Delete a loopback connection for VC.

atm oam vclb list

List all VC loopback connections.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm oam vclb del
Delete a loopback connection for VC.

SYNTAX:
atm oam vclb del

port = <{dsl0} or number>
vpi = 
[vci = ]

where:
port

The ATM port number.
Choose between:

>

REQUIRED

DSL0

Or specify a port number (dsl0 has port number 0).
vpi

A number between 0 and 15.
Represents the VPI.

REQUIRED

vci

A number between 0 and 511.
Represents the VCI.

OPTIONAL

Note

For a VP cross-connection, use 0 or do not specify.

EXAMPLE:
=>atm oam vclb
PORT = 0 VPI =
PORT = 1 VPI =
=>atm oam vclb
=>atm oam vclb
PORT = 0 VPI =
=>

list
0 VCI = 36
0 VCI = 37
del port=dsl1 vpi=0 vci=37
list
0 VCI = 36

RELATED COMMANDS:
atm oam vclb add

Create a loopback connection for VC.

atm oam vclb list

List all VC loopback connections.

E-DOC-CTC-20061027-0003 v2.0

53

ATM Commands

atm oam vclb list
List all VC loopback connections.

SYNTAX:
atm oam vclb list

EXAMPLE:
=>atm oam vclb list
PORT = 0 VPI = 0 VCI =
PORT = 1 VPI = 0 VCI =
=>

36
37

RELATED COMMANDS:

54

atm oam vclb add

Create a loopback connection for VC.

atm oam vclb del

Delete a loopback connection for VC.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm phonebook add
Add a new phonebook entry.

SYNTAX:
atm phonebook add

name = 
addr = 

where:
name

addr

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).

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

REQUIRED

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm phonebook delete

Delete an existing phonebook entry.

atm phonebook list

Display the current phonebook.

E-DOC-CTC-20061027-0003 v2.0

55

ATM Commands

atm phonebook autolist
Show the auto PVCs.

i

Auto PVCs are only shown if they are supported by the Central Office DSLAM.

SYNTAX:
atm phonebook autolist

EXAMPLE:
=>atm phonebook autolist
8.35
=>

RELATED COMMANDS:
atm phonebook list

56

Display the current phonebook.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm phonebook delete
Delete an existing phonebook entry.

i

This command is only applicable for phonebook entries that are not used (in other words, not
configured for any packet service).

SYNTAX:
atm phonebook delete

name = 

where:
name

The name of the phonebook entry to be deleted.
Tip

REQUIRED

Use the command :atm phonebook list to check whether the
entry is in use (Use=1) or not (Use=0).

EXAMPLE:
=>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
=>

RELATED COMMANDS:
atm phonebook add

Add a new phonebook entry.

atm phonebook list

Display the current phonebook.

E-DOC-CTC-20061027-0003 v2.0

57

ATM Commands

atm phonebook flush
Flush all the phonebook entries.

i

1. Phonebook entries that are in use, cannot be flushed.
2. This command does not impact previously saved configurations.

SYNTAX:
atm phonebook flush

EXAMPLE:
=>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
=>

58

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm phonebook list
Display the current phonebook.

SYNTAX:
atm phonebook list

EXAMPLE:
=>atm phonebook list
Name
Use Address
atm_pvc_0_35 1
0.35
RtPPPoA
0
8.35
=>

RELATED COMMANDS:
atm phonebook add

Add a new phonebook entry.

atm phonebook autolist

Show the auto PVCs.

atm phonebook delete

Delete an existing phonebook entry.

E-DOC-CTC-20061027-0003 v2.0

59

ATM Commands

atm qosbook add
Add a new QoS book entry.

SYNTAX:
atm qosbook add

name = 
[txctd = ]
[rxctd = ]

where:
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

EXAMPLE:
=>atm qosbook list
Name
Ref Tx CTD
default
3
default
=>

Rx CTD
default

RELATED COMMANDS:

60

atm qosbook delete

Delete a QoS book entry.

atm qosbook list

Display the QoS book.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm qosbook config
Modify the QoS book configuration.

SYNTAX:
atm qosbook config

[format = <{bytes | cells}>]

where:
format

The input/output format of the QoS book.
Choose between:

>
>

OPTIONAL

bytes: the output is shown in Kbits or bytes.
cells: the output is shown in cps or cells.

The default is bytes.

EXAMPLE:
=>atm qosbook ctdlist
Name
Ref Conf
Peak
(Kbits)

Sust
(Kbits)

default 2
UBR
linerate 0
led
=>atm qosbook config format=cells
=>atm qosbook ctdlist
Name
Ref Conf
Peak
Sust
(cps)
(cps)
default 2
led
=>

UBR

E-DOC-CTC-20061027-0003 v2.0

linerate 0

Burst
(bytes)

Minrate
(Kbits)

Frame
(bytes)

Cdvt

RT

FD

0

0

0

0

disabled

disab

Burst
(cells)

Minrate
(cps)

Frame
(cells)

Cdvt

RT

FD

0

0

0

0

disabled

disab

61

ATM Commands

atm qosbook ctdadd
Add a Connection Traffic Descriptor (CTD).

SYNTAX:
atm qosbook ctdadd

name = 
conformance = <{UBR | CBR | VBR }>
[peakrate = ]
[sustrate = ]
[realtime = <{enabled | disabled}>]

where:
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

EXAMPLE:
=>atm qosbook ctdadd name=High conformance=CBR peakrate=27786
=>atm qosbook ctdlist
Name
Ref Conf
Peak
Sust
Burst
Minrate Frame
(Kbits) (Kbits) (bytes) (Kbits) (bytes)
default 2
led
High
0
led
=>

62

Cdvt

RT

FD

UBR

linerate 0

0

0

0

0

disabled

disab

CBR

27786

0

0

0

0

disabled

disab

0

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

IMPORTANT NOTE:
The Thomson ST 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 Thomson ST 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).
=>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
Medium 0
=>

UBR
VBR

linerate 0
27786
20000

0
144

0
0

0
0

0
0

disabled disabled
disabled disabled

RELATED COMMANDS:
atm qosbook ctddelete

Delete a CTD.

atm qosbook ctdlist

Display all CTDs.

E-DOC-CTC-20061027-0003 v2.0

63

ATM Commands

atm qosbook ctddelete
Delete a CTD.

SYNTAX:
atm qosbook ctddelete

name = 
[force = <{disabled | enabled}>]

where:
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

EXAMPLE:
=>atm qosbook ctdlist
Name
Ref Conf
Peak
(Kbits)

Sust
(Kbits)

default 2
UBR
linerate 0
led
High
0
CBR
27786
0
led
=>atm qosbook ctddelete name=High
=>atm qosbook ctdlist
Name
Ref Conf
Peak
Sust
(Kbits) (Kbits)
default 2
led
=>

UBR

linerate 0

Burst
(bytes)

Minrate
(Kbits)

Frame
(bytes)

Cdvt

RT

FD

0

0

0

0

disabled

disab

0

0

0

0

disabled

disab

Burst
(bytes)

Minrate
(Kbits)

Frame
(bytes)

Cdvt

RT

FD

0

0

0

0

disabled

disab

RELATED COMMANDS:

64

atm qosbook ctdadd

Add a Connection Traffic Descriptor (CTD).

atm qosbook ctdlist

Display all CTDs.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm qosbook ctdlist
Display all CTDs.

SYNTAX:
atm qosbook ctdlist

EXAMPLE:
=>atm qosbook ctdlist
Name
Ref Conf
Peak
(Kbits)
default 2
led
High
0
led
=>

Sust
(Kbits)

Burst
(bytes)

Minrate
(Kbits)

Frame
(bytes)

Cdvt

RT

FD

UBR

linerate 0

0

0

0

0

disabled

disab

CBR

27786

0

0

0

0

disabled

disab

0

RELATED COMMANDS:
atm qosbook ctdadd

Add a Connection Traffic Descriptor (CTD).

atm qosbook ctddelete

Delete a CTD.

E-DOC-CTC-20061027-0003 v2.0

65

ATM Commands

atm qosbook delete
Delete a QoS book entry.

SYNTAX:
atm qosbook delete

name = 
[force = <{disabled | enabled}>]

where:
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

EXAMPLE:
=>atm qosbook list
Name
Ref Type

TX peak sust
(Kbits) (Kbits)
default 3
ubr
linerate 0
TestVBR 0
vbr-nrt 1500
1000
=>atm qosbook delete name=TestVBR
=>atm qosbook list
Name
Ref Type
TX peak sust
(Kbits) (Kbits)
default 3
ubr
linerate 0
=>

burst
(bytes)
0
144

RX peak
(Kbits)
linerate
1500

sust
(Kbits)
0
1000

burst
(bytes)
0
144

burst
(bytes)
0

RX peak sust
(Kbits) (Kbits)
linerate 0

burst
(bytes)
0

framediscard
disabled
enabled

framediscard
disabled

RELATED COMMANDS:

66

atm qosbook add

Add a new QoS book entry.

atm qosbook list

Display the QoS book.

E-DOC-CTC-20061027-0003 v2.0

ATM Commands

atm qosbook flush
Flush all the QoS book entries.

i

The flush command does not impact previously saved configurations.

SYNTAX:
atm qosbook flush

E-DOC-CTC-20061027-0003 v2.0

67

ATM Commands

atm qosbook list
Display the QoS book.

SYNTAX:
atm qosbook list

EXAMPLE:
=>atm qosbook list
Name
Ref Type
default 3
TestVBR 0
=>

TX peak
(Kbits)
ubr
linerate
vbr-nrt 1500

sust
(Kbits)
0
1000

burst
(bytes)
0
144

RX peak
(Kbits)
linerate
1500

sust
(Kbits)
0
1000

burst
(bytes)
0
144

framediscard
disabled
enabled

RELATED COMMANDS:

68

atm qosbook add

Add a new QoS book entry.

atm qosbook delete

Delete a QoS book entry.

E-DOC-CTC-20061027-0003 v2.0

AutoPVC Commands

4

AutoPVC Commands

Introduction
This chapter describes the commands of the autopvc command group.

Contents
This chapter covers the following commands:
autopvc config

Configure autopvc.

70

autopvc list

Show the retrieved information.

72

E-DOC-CTC-20061027-0003 v2.0

69

AutoPVC Commands

autopvc config
Configure autopvc.

SYNTAX:
autopvc config

[mode = <{pseudo | passive | active}>]
[type = <{bridge | pppoerelay | ipoa | ethoa | pppoa | pppoe
}>]
[overwrite = <{disabled | enabled}>]
[peakrate = ]

where:
mode

Select the autopvc mode:

OPTIONAL

>

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.
type

70

OPTIONAL

Select the type of autopvc.
Choose between:

>
>

bridge

>
>
>
>

ipoa

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.
ethoa
pppoa
pppoe.

overwrit
e

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

E-DOC-CTC-20061027-0003 v2.0

AutoPVC Commands

EXAMPLE:
=>autopvc config
Autopvc mode
:
Autopvc type
:
Autopvc standard:
Autopvc pseudo :
UBR overwrite
:
UBR peak rate
:
=>

E-DOC-CTC-20061027-0003 v2.0

passive
unknown
unknown
disabled
linerate

71

AutoPVC Commands

autopvc list
Show the retrieved information.

SYNTAX:
autopvc list

[table = <{Port | AtmLayer | Vpc | Vcc | Address
| AddressRegistrationAdmin | AtmServiceType
| AtmServiceConnectionInfo | AAL1Profile |
| AAL34Profile | AAL5Profile | AAL2CommonProfile
| AAL2TrunkingProfile | AAL2LESProfile
| AtmServiceConnInfoExtension |
| AtmServiceTypeExtension |
AAL5ProfileExtension}>]

where:
table

Select the autopvc table for which the information must be shown.
Choose between:

>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

OPTIONAL

Port
AtmLayer
Vpc
Vcc
Address
AddressRegistrationAdmin
AtmServiceType
AtmServiceConnectionInfo
AAL1Profile
AAL34Profile
AAL5Profile
AAL2CommonProfile
AAL2TrunkingProfile
AAL2LESProfile
AtmServiceConnInfoExtension
AtmServiceTypeExtension
AAL5ProfileExtension.

EXAMPLE:
=>autopvc list
Address Type
8.35
ubr

BestEff
Enabled

Par1
Tx: 451
Rx: 7923

Par2
0
0

Par3
0
0

Par4
0
0

Par5
0
0

=>

72

E-DOC-CTC-20061027-0003 v2.0

Config Commands

5

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.

74

config dump

Show the saved configuration file.

75

config flush

Flush the loaded configuration.

76

config list

Show the current configuration set.

77

config load

Load complete saved (backup) or default configuration file.

78

config save

Store the current configuration in a backup file.

80

E-DOC-CTC-20061027-0003 v2.0

73

Config Commands

config delete
Delete a user configuration file.

SYNTAX:
config delete

[filename = ]

where:
filename

Name of the user configuration file to be deleted.
Note

OPTIONAL

If not specified, all the user configuration files that were saved in
the Thomson ST permanent storage will be deleted.

RELATED COMMANDS:
config dump

74

Show the saved configuration file.

E-DOC-CTC-20061027-0003 v2.0

Config Commands

config dump
Show the saved configuration file.

SYNTAX:
config dump

[sections = ]

where:
sections

Sections to be dumped

OPTIONAL

RELATED COMMANDS:
config delete

E-DOC-CTC-20061027-0003 v2.0

Delete a user configuration file.

75

Config Commands

config flush
Flush the loaded configuration.

i

1. This flush command combines all the possible flush commands.
2. This command does not affect saved configurations.

SYNTAX:
config flush

[flush_ip = <{enabled | disabled}>]

where:
flush_ip

Flush IP settings (enabled) or not (disabled).
The default is enabled.
Note

76

OPTIONAL

Not keeping the IP settings could cause lost IP connectivity in the
LAN.

E-DOC-CTC-20061027-0003 v2.0

Config Commands

config list
Show the current configuration set.

SYNTAX:
config list

[templates = <{disabled | enabled}>]

where:
templates

List the template files (disabled) or not (enabled).
The default is disabled.

OPTIONAL

RELATED COMMANDS:
config load

Load complete saved (backup) or default configuration file.

config save

Store the current configuration in a backup file.

E-DOC-CTC-20061027-0003 v2.0

77

Config Commands

config load
Load complete saved (backup) or default configuration file.

i

Use the command :config flush before loading a configuration file.

SYNTAX:
config load

[load_ip = <{enabled | disabled}>]
[defaults = <{enabled | disabled}>]
[flush = <{enabled | disabled}>]
[echo = <{disabled | enabled}>]
[filename = ]

where:
load_ip

Load IP settings (enabled) or not (disabled).
Note

defaults

Not keeping the IP settings could cause lost IP connectivity in the
LAN.

Load default configuration (enabled) or saved configuration (disabled).
Note

78

OPTIONAL

OPTIONAL

If not specified, the saved configuration will be loaded.

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

E-DOC-CTC-20061027-0003 v2.0

Config Commands

EXAMPLE:
=>ip rtlist
Destination
Source
10.0.0.0/24
10.0.0.0/24
172.16.0.5/32
0.0.0.0/0
10.0.0.140/32
0.0.0.0/0
127.0.0.1/32
0.0.0.0/0
172.16.0.0/24
0.0.0.0/0
=>config load flush_ip=no
=>ip rtlist
Destination
Source
10.0.0.0/24
10.0.0.0/24
10.0.0.140/32
0.0.0.0/0
127.0.0.1/32
0.0.0.0/0
=>config load flush=yes
=>ip rtlist
Destination
Source
10.0.0.0/24
10.0.0.0/24
10.0.0.140/32
0.0.0.0/0
172.16.0.5/32
0.0.0.0/0
127.0.0.1/32
0.0.0.0/0
172.16.0.0/24
0.0.0.0/0
=>

Gateway
10.0.0.140
172.16.0.5
10.0.0.140
127.0.0.1
172.16.0.5

Intf
eth0
cip1
eth0
loop
cip1

Mtrc
0
0
0
0
1

Gateway
10.0.0.140
10.0.0.140
127.0.0.1

Intf
eth0
eth0
loop

Mtrc
0
0
0

Gateway
10.0.0.140
10.0.0.140
172.16.0.5
127.0.0.1
172.16.0.5

Intf
eth0
eth0
cip1
loop
cip1

Mtrc
0
0
0
0
1

RELATED COMMANDS:
config list

Show the current configuration set.

config save

Store the current configuration in a backup file.

E-DOC-CTC-20061027-0003 v2.0

79

Config Commands

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 Thomson ST permanent storage. This file can be downloaded via the Thomson
ST web pages or via an FTP session.

SYNTAX:
config save

filename = 

where:
filename

The filename for the backup file of the current configuration.

REQUIRED

RELATED COMMANDS:

80

config list

Show the current configuration set.

config load

Load complete saved (backup) or default configuration file.

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

6

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.

82

connection appinfo

Display CONN/NAT application specific info.

84

connection applist

List the available CONN/NAT application helpers.

85

connection bind

Create a new CONN/NAT application helper/port binding.

86

connection bindlist

List the current CONN/NAT application helper/port bindings.

87

connection clean

Clean the connection database by forcing timeouts.

88

connection clear

Kill all the connections.

89

connection config

Configure the connection handling.

90

connection debug

The connection debug commands

91

connection describe

Describe the streams of a connection.

92

connection flush

Flush the current connection configuration.

93

connection info

Show all the registered modules with some info.

94

connection list

Display the currently known connections.

95

connection refresh

Invalidate all the cached decisions.

96

connection stats

Display the connection and stream statistics.

97

connection timerclear

Clear the connection timeout to default.

98

connection timerconfig

Configure the connection timeout handling.

99

connection unbind

Delete an existing CONN/NAT application helper/port binding.

100

E-DOC-CTC-20061027-0003 v2.0

81

Connection Commands

connection appconfig
Configure the available CONN/NAT application helpers.

SYNTAX:
connection appconfig

application = 
[trace = <{disabled | enabled}>]
[timeout = ]
[floating = <{disabled | enabled}>]
[childqos = <{DSCP|Interactive|
Management|Video|VoIP|default}>]
[tracelevel = ]
[SIP_ALG = <{disabled|enabled}>]
[RTP_predict_for_term_SIP_ALG =
<{disabled|enabled}>]

where:
application

The name of a CONN/NAT application helper.
Tip

REQUIRED

Use the command :connection
applist to obtain a list of CONN/NAT
application helpers.

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

childqos

Used QOS label for the predicted child connections.

OPTIONAL

tracelevel

A number between 1 and 4.
Represents the SIP trace level.
Choose between:

OPTIONAL

>
>
>
>

1: feature errors
2: feature traces
3: all errors
4: all traces.

The default is 1.

82

SIP_ALG

SIP only: enable/disable traditional sip alg
behaviour

OPTIONAL

RTP_predict_for_term_SIP_ALG

Enable/disable RTP connection prediction for
terminated SIP

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

EXAMPLE:
=>connection
Application
IP6TO4
PPTP
ESP
IKE
SIP
...
LOOSE(UDP)
FTP
=>connection
=>connection
Application
IP6TO4
PPTP
ESP
IKE
SIP
...
LOOSE(UDP)
FTP
=>

applist
Proto DefaultPort
6to4 0
tcp
1723
esp
0
udp
500
udp
5060

Traces
enabled
enabled
unavailable
disabled
disabled

Timeout
unavailable
unavailable
15' 0"
15' 0"
6 0"

FLOATING
trace level 1

udp
0
enabled
5' 0"
tcp
21
enabled
unavailable
appconfig application=SIP trace=enabled
applist
Proto DefaultPort Traces
Timeout
6to4 0
enabled
unavailable
tcp
1723
enabled
unavailable
esp
0
unavailable 15' 0"
udp
500
disabled
15' 0"
FLOAATING
udp
5060
enabled
6 0"
trace level 1
udp
tcp

0
21

enabled
enabled

5' 0"
unavailable

RELATED COMMANDS:
connection appinfo

Display CONN/NAT application specific info.

connection applist

List the available CONN/NAT application helpers.

E-DOC-CTC-20061027-0003 v2.0

83

Connection Commands

connection appinfo
Display CONN/NAT application specific info.

SYNTAX:
connection appinfo

application = <{string}>

where:
application

The name of a CONN/NAT application helper.
Tip

REQUIRED

Use the command :connection
applist to obtain a list of CONN/NAT
application helpers.

EXAMPLE:
=>connection appinfo application=SIP
SIP ALG session SIPALG: pool=138, in use=0, bottom=138
=>

RELATED COMMANDS:

84

connection appconfig

Configure the available CONN/NAT application helpers.

connection applist

List the available CONN/NAT application helpers.

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection applist
List the available CONN/NAT application helpers.

SYNTAX:
connection applist

EXAMPLE:
=>connection
Application
IP6TO4
PPTP
ESP
IKE
SIP
JABBER
CU/SeeMe
RAUDIO(PNA)
RTSP
ILS
H245
H323
IRC
LOOSE(UDP)
FTP
=>

i

applist
Proto DefaultPort
6to4 0
tcp
1723
esp
0
udp
500
udp
5060
tcp
5222
udp
7648
tcp
7070
tcp
554
tcp
389
tcp
0
tcp
1720
tcp
6667
udp
0
tcp
21

Traces
enabled
enabled
unavailable
disabled
disabled
disabled
enabled
enabled
enabled
unavailable
unavailable
enabled
enabled
enabled
enabled

Timeout
unavailable
unavailable
15' 0"
15' 0"
6 0"
2' 0"
unavailable
unavailable
unavailable
5' 0"
5' 0"
unavailable
5' 0"
5' 0"
unavailable

FLOATING
trace level 1

For some CONN/NAT application helpers, either traces or timeout are unavailable.

RELATED COMMANDS:
connection appconfig

Configure the available CONN/NAT application helpers.

connection appinfo

Display CONN/NAT application specific info.

E-DOC-CTC-20061027-0003 v2.0

85

Connection Commands

connection bind
Create a new CONN/NAT application helper/port binding.

SYNTAX:
connection bind

application = 
port = 

where:
application

The name of a CONN/NAT application helper.
Tip

port

REQUIRED

Use the command :connection
applist to obtain a list of CONN/NAT
application helpers.

The port number or port range this application
handler should work on.

REQUIRED

EXAMPLE:
=>connection
Application
JABBER
JABBER
FTP
IRC
...
IP6TO4
=>connection
=>connection
Application
IRC
JABBER
JABBER
FTP
IRC
...
IP6TO4
=>

bindlist
Proto Portrange
tcp
15222
tcp
5222
tcp
21
tcp
6660

Flags

6to4 0
bind application = IRC port = 6750
bindlist
Proto Portrange
tcp
6750
tcp
15222
tcp
5222
tcp
21
tcp
6660
6to4

0

RELATED COMMANDS:

86

connection bindlist

List the current CONN/NAT application helper/port bindings.

connection unbind

Delete an existing CONN/NAT application helper/port binding.

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection bindlist
List the current CONN/NAT application helper/port bindings.

SYNTAX:
connection bindlist

EXAMPLE:
=>connection
Application
LOOSE(UDP)
JABBER
JABBER
FTP
IRC
H323
ILS
ILS
RTSP
RAUDIO(PNA)
CU/SeeMe
SIP
IKE
ESP
PPTP
IP6TO4
=>

bindlist
Proto Portrange
udp
67
tcp
15222
tcp
5222
tcp
21
tcp
6660-6669
tcp
1720
tcp
1002
tcp
389
tcp
554
tcp
7070
udp
7648
udp
5060
udp
500
esp
0
tcp
1723
6to4 0

Flags

RELATED COMMANDS:
connection bind

Create a new CONN/NAT application helper/port binding.

connection unbind

Delete an existing CONN/NAT application helper/port binding.

E-DOC-CTC-20061027-0003 v2.0

87

Connection Commands

connection clean
Clean the connection database by forcing timeouts.

SYNTAX:
connection clean

[level = ]

where:
level

A number between 0 and 9.
Represents the desired scrubbing level.

OPTIONAL

EXAMPLE:
=>connection list
ID
proto state
------ ----8
tcp
ACTIVE
INIT: 16
192.168.
RESP: 17
192.168.
34
tcp
ACTIVE
INIT: 68
192.168.
RESP: 69
192.168.
=>connection clean
=>connection list
ID
proto state
------ ----8
tcp
ACTIVE
INIT: 16
192.168.
RESP: 17
192.168.
=>

88

substate
flags timeout
------------ ------[TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 15' 7"
1. 64: 1377 192.168. 1.254:
23 [...] LocalNetwork
1390 tcp
1.254:
23 192.168. 1. 64: 1377 [R..]
loop
951 tcp
0
[TCPS_CLOSE_WAIT-TCPS_FIN_WAIT_1] [I.....] 57' 16"
1. 64: 1417 192.168. 1.254:
21 [...] LocalNetwork
11 tcp
1.254:
21 192.168. 1. 64: 1417 [R..]
loop
10 tcp
0

substate
flags timeout
------------ ------[TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 14' 59"
1. 64: 1377 192.168. 1.254:
23 [...] LocalNetwork
1417 tcp
1.254:
23 192.168. 1. 64: 1377 [R..]
loop
967 tcp
0

E-DOC-CTC-20061027-0003 v2.0

0

0

0

Connection Commands

connection clear
Kill all the connections.

SYNTAX:
connection clear

EXAMPLE:
=>connection clear

Connection to host lost.

E-DOC-CTC-20061027-0003 v2.0

89

Connection Commands

connection config
Configure the connection handling.

SYNTAX:
connection config

[configchangemode = <{immediate | delayed}>]
[probes = <{disabled | enabled}>]
[udptrackmode = <{strict | loose}>]

where:
configchangemode

Select how configuration changes are handled.
Choose between:

>
>

OPTIONAL

immediate
delayed.

The default is immediate.
probes

Enable or disable live probes on idle connections.
The default is disabled.

OPTIONAL

udptrackmode

Select the User Datagram Protocol (UDP)
connection tracking mode.
Choose between:

OPTIONAL

>

strict: replies to a request from a client must be
in a specific window to the client.

>

loose: inbound packets are allowed on the port
that was first used to start the communication
with the server (for example to allow a client of
an online game to obtain peer-to-peer
information from other clients of that same
online game).

The default is strict.

EXAMPLE:
=>connection config
config change mode : immediate
alive probes
: disabled
udp tracking mode : loose
=>

90

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection debug
The connection debug commands

SYNTAX:
connection debug

[trace = <{disabled|enabled}>]

where:
trace

Enable or disable traces.
The default is disabled.

OPTIONAL

EXAMPLE:
=>connection debug
connection traces : disabled
=>
=>connection debug trace enabled
=>
=>connection debug
connection traces : enabled
=>

E-DOC-CTC-20061027-0003 v2.0

91

Connection Commands

connection describe
Describe the streams of a connection.

SYNTAX:
connection describe

[id = ]

where:
id

A number between 0 and 2048.
Represents the ID of the connection to be
described.
Note
Tip

OPTIONAL

If not specified, the connection with ID 0
will be described.
Use the command :connection list
to obtain the IDs of the
different connections.

EXAMPLE:
=>connection list
ID
proto state
substate
flags timeout
------ ---------------- ------62
tcp
ACTIVE
[TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 15' 8"
INIT: 124 192.168. 1. 64: 1979 192.168. 1.254:
23 [...] LocalNetwork
548 tcp
RESP: 125 192.168. 1.254:
23 192.168. 1. 64: 1979 [R..]
loop
396 tcp
0
=>connection describe id=62
ID
proto state
substate
flags timeout
------ ---------------- ------62
tcp
ACTIVE
[TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 14' 59"
FW
: cache = valid; FP
IDS
: ...
NAT
: cache = valid; No translation
INIT: 124 192.168. 1. 64: 1979 192.168. 1.254:
23 [...] LocalNetwork
576 tcp
ROUTING
: cache = valid; FP (gateway 127.0.0.1)
LABEL
: cache = valid; FP (no route label); FP (QoS label Interactive)
IPQOS
: cache = valid; FP (label , intf )
TRIGGER
: cache = valid; FP (no trigger)
RESP: 125 192.168. 1.254:
23 192.168. 1. 64: 1979 [R..]
loop
412 tcp
0
ROUTING
: cache = valid; FP (gateway 192.168.1.254)
LABEL
: cache = valid; FP (no route label); FP (QoS label default)
IPQOS
: cache = valid; FP (label , intf )
TRIGGER
: cache = valid; FP (no trigger)
=>

92

0

0

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection flush
Flush the current connection configuration.

SYNTAX:
connection flush

E-DOC-CTC-20061027-0003 v2.0

93

Connection Commands

connection info
Show all the registered modules with some info.

SYNTAX:
connection info

EXAMPLE:
=>connection info
Registered connection modules :
- Module : FW, holds private data (F:10264 S:6592).
- Module : IDS, holds private data (F:0 S:0).
- Module : NAT, holds private data (F:0 S:0).
Registered stream modules :
- Module : ROUTING, holds private data (F:10199 S:6657).
- Module : LABEL, holds private data (F:22546 S:19870).
- Module : IPQOS, holds private data (F:10202 S:6653).
- Module : TRIGGER, holds private data (F:10202 S:6659).
=>

94

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection list
Display the currently known connections.

SYNTAX:
connection list

[nr = ][string = ]
[beginstring = ]

where:
nr

A number between 1 and 2048.
Represents the number of connections to be
displayed.
Note

OPTIONAL

If not specified, all the connections will be
displayed.

string

string matching condition

OPTIONAL

beginstring

beginstring matching condition

OPTIIONAL

EXAMPLE:
=>connection list
ID
proto state
------ ----58
tcp
ACTIVE
INIT: 116
10.
RESP: 117
10.
=>

E-DOC-CTC-20061027-0003 v2.0

0.
0.

substate
flags timeout
------------ ------[TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 15' 7"
0. 1: 1106 10. 0. 0.138:
23 [.]
eth0
331 tcp
0.138:
23 10. 0. 0. 1: 1106 [R]
loop
229 tcp

0
0

95

Connection Commands

connection refresh
Invalidate all the cached decisions.

SYNTAX:
connection refresh

96

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection stats
Display the connection and stream statistics.

SYNTAX:
connection stats

EXAMPLE:
=>connection stats
Connection statistics:
------------------------------------------Maximum number of connections
:
Maximum number of halfopen connections
:
------------------------------------------Number of active connections
:
Number of halfopen connections
:
Number of expected connections
:
Number of closing connections
:
Number of idle connections
:
------------------------------------------Number of TCP connections
:
Number of UDP connections
:
Number of ICMP connections
:
Number of non TCP/UDP/ICMP connections
:
------------------------------------------Number of TCP open connections
:
Number of TCP established connections
:
Number of TCP closing connections
:

1024
1024
3
0
0
0
1
2
1
0
0
0
1
1

Stream cache statistics:
------------------------------------------Maximum number of hash collisions
: 0
% of hash entries with collisions
: 0.00
% of hash entries unused
: 0.00
CONN/NAT application helper statistics:
------------------------------------------Maximum number of helper bindings
:
Maximum number of connections with helper :
------------------------------------------Number of helper bindings
:
Number of connections with active helper :
=>

E-DOC-CTC-20061027-0003 v2.0

24
128
16
0

97

Connection Commands

connection timerclear
Clear the connection timeout to default.

SYNTAX:
connection timerclear

[timer = <{tcpidle|tcpneg|tcpkill|udpidle|udpkill|
icmpkill|ipidle|ipkill}>]

where:
timer

The name of the connection idle timer to be reset.
Note

REQUIRED

If not specified, all the timers will be reset
to their default values.

EXAMPLE:
=>connection timerconfig
tcpidle
: 10' 30"
tcpneg
: 3' 0"
udp
: 1' 19"
icmp
: 2' 0"
ip
: 1' 0"
=>connection timerclear
=>connection timerconfig
tcpidle
: 15' 0"
tcpneg
: 2' 0"
udp
: 1' 0"
icmp
: 1' 0"
ip
: 1' 0"
=>

RELATED COMMANDS:
connection timerconfig

98

Configure the connection timeout handling.

E-DOC-CTC-20061027-0003 v2.0

Connection Commands

connection timerconfig
Configure the connection timeout handling.

SYNTAX:
connection timerconfig

[timer =
<{tcpidle|tcpneg|tcpkill|udpidle|udpkill|
icmpkill|ipidle|ipkill}>]
[value = ]

where:
timer

The name of the connection idle timer to be
configured.
Choose between:

>
>
>
>
>
>
>
>
value

OPTIONAL

tcpidle
tcpneg
tcpkill
udpidle
udpkill
icmpkill
ipidle
ipkill

A number between 0 and 86400 (seconds).
Represents the timer expire value.

OPTIONAL

EXAMPLE:
=>connection timerconfig
tcpidle
: 15' 0"
tcpneg
: 2' 0"
udp
: 1' 0"
icmp
: 1' 0"
ip
: 1' 0"
=>connection timerconfig timer=tcpidle value=360
=>connection timerconfig
tcpidle
: 6' 0"
tcpneg
: 2' 0"
udp
: 1' 0"
icmp
: 1' 0"
ip
: 1' 0"
=>

RELATED COMMANDS:
connection timerclear

E-DOC-CTC-20061027-0003 v2.0

Clear the connection timeout to default.

99

Connection Commands

connection unbind
Delete an existing CONN/NAT application helper/port binding.

SYNTAX:
connection unbind

application = 
port = 

where:
application

The name of a CONN/NAT application helper.
Tip

port

REQUIRED

Use the command :connection
applist to obtain a list of CONN/NAT
application helpers.

The port number or port range this application
handler should work on.

REQUIRED

EXAMPLE:
=>connection
Application
IRC
JABBER
JABBER
FTP
IRC
...
IP6TO4
=>connection
=>connection
Application
JABBER
JABBER
FTP
IRC
...
IP6TO4
=>

bindlist
Proto Portrange
tcp
6750
tcp
15222
tcp
5222
tcp
21
tcp
6660
6to4 0
unbind application=IRC port=6750
bindlist
Proto Portrange
tcp
15222
tcp
5222
tcp
21
tcp
6660
6to4

0

RELATED COMMANDS:

100

connection bind

Create a new CONN/NAT application helper/port binding.

connection bindlist

List the current CONN/NAT application helper/port bindings.

E-DOC-CTC-20061027-0003 v2.0

CWMP Commands

7

CWMP Commands

Introduction
This chapter describes the commands of the cwmp (CPE WAN Management Protocol) command group.

Contents
This chapter covers the following commands:
cwmp config

Configure the cwmpd as seen from the ACS.

102

cwmp server config

Configure the cwmpd towards the ACS.

104

E-DOC-CTC-20061027-0003 v2.0

101

CWMP Commands

cwmp config
Configure the cwmpd as seen from the ACS.

SYNTAX:
cwmp config

[state = <{disabled|enabled}>]
[mode = <{readonly|full}>]
[periodicInform = <{disabled|enabled}>]
[periodicInfInt = ]
[sessionTimeout = ]
[noIpTimeout = ]
[maxEnvelopes = ]
[connectionRequest = <{disabled|enabled}>]
[connectionReqPath = ]
[connectionReqUserName = ]
[connectionReqPsswd = ]
[connectionReqAuth = <{none|basic|digest}>]

where:
state

The state of the cwmp daemon.
Choose between:

>
>

OPTIONAL

enabled
disabled.

The default is disabled.
mode

Set the operation mode of the cwmp daemon.
Choose between:

>
>

OPTIONAL

readonly
full.

The default is readonly.
periodicInform

Set the periodicInform flag of the cwmp daemon.
Choose between:

>
>

OPTIONAL

enabled
disabled.

The default is enabled.

102

periodicInfInt

A number (of seconds).
Represents the interval between two periodicInform
messages.
The default is 3600.

OPTIONAL

sessionTimeout

Set HTTP session-timeout in seconds.
The default is 60.

OPTIONAL

noIpTimeout

Set time (in seconds) ip may be 0 after uploading new
config file.
The default is 10.

OPTIONAL

maxEnvelopes

Set the maximum number of SOAP envelopes sent
within one HTTP message.
The default is 2.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

CWMP Commands

connectionRequest

Set the connection request flag of the cwmp daemon.
Choose between:

>
>

OPTIONAL

enabled
disabled.

The default is enabled.
connectionReqPath

Set the path where the cwmp daemon can be reached.

OPTIONAL

connectionReqUserName

Set the username the ACS must use to log in.

OPTIONAL

connectionReqPsswd

Set the password the ACS must use to log in.

OPTIONAL

connectionReqAuth

Set the digest authentication flag of the cwmp
daemon.
Choose between:

OPTIONAL

>
>

enabled
disabled.

The default is enabled.

EXAMPLE:
=>cwmp config
State
Mode
Max Envelopes
Session Timeout
No Ip Timeout
Connection Request Port
Periodic Inform
Periodic Inform Interval
Connection Request
Connection Request UserName
Connection Request PassWord
Connection Request Path
Connection Request Authentication
Qos class
Boot delay range between 0 and
=>

E-DOC-CTC-20061027-0003 v2.0

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

disabled
readonly
2
60
10
80
enabled
20000 ms
enabled

enabled
12
0s

103

CWMP Commands

cwmp server config
Configure the cwmpd towards the ACS.

SYNTAX:
cwmp server config

[url = ]
[username = ]
[password = ]

where:
url

Set the HTTP URL used to contact the ACS server.

OPTIONAL

username

Set the username for ACS Digest Authentication.

OPTIONAL

password

Set the password for ACS Digest Authentication.

OPTIONAL

EXAMPLE:
=>cwmp server config
ACS url
: 10.11.10.248
ACS username
:
ACS password
:
=>

104

E-DOC-CTC-20061027-0003 v2.0

Debug Commands

8

Debug Commands

Introduction
This chapter describes the commands of the debug command group.

Contents
This chapter covers the following commands:
debug exec

E-DOC-CTC-20061027-0003 v2.0

Execute a 'Trace & Debug' command.

106

105

Debug Commands

debug exec
Execute a 'Trace & Debug' command.

!

This command is for qualified personnel only.

SYNTAX:
debug exec

cmd = 

where:
cmd

106

A quoted 'Trace & Debug' command string.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

9

DHCP Commands

Introduction
This chapter describes the commands of the Dynamic Host Configuration Protocol (DHCP) command group.

Contents
This chapter covers the following commands:
dhcp client flush

Delete all the DHCP leases.

109

dhcp client ifadd

Create a DHCP client.

110

dhcp client ifattach

Activate a DHCP client.

111

dhcp client ifconfig

Configure a DHCP client.

112

dhcp client ifdelete

Delete a DHCP client.

113

dhcp client ifdetach

De-activate a DHCP client and releases its lease.

114

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

115

dhcp client ifrenew

Renew the DHCP lease.

117

dhcp client debug clear

Clear the DHCP client statistics.

119

dhcp client debug stats

Print the DHCP client statistics.

120

dhcp client debug traceconfig

Modify the DHCP client trace configuration.

121

dhcp client rqoptions add

Add a DHCP Option Code to the Parameter Request List.

122

dhcp client rqoptions delete

Delete a DHCP Option Code from the Parameter Request
List.

123

dhcp client rqoptions list

List all DHCP Option Codes in the Parameter Request List.

124

dhcp client rqoptions optionlist

List all DHCP Option Codes that can be used in the
Parameter Request List.

125

dhcp client txoptions add

Add an option.

126

dhcp client txoptions delete

Delete an option.

127

dhcp client txoptions list

List all options.

128

dhcp client txoptions optionlist

Lists all DHCP Option Codes that can be used.

129

dhcp relay add

Add an entry to the DHCP forward list.

130

dhcp relay debug stats

Show the DHCP relay statistics.

131

dhcp relay debug traceconfig

Modify the DHCP relay trace configuration.

132

dhcp relay config

Set the DHCP relay configuration settings.

133

dhcp relay delete

Delete an entry from the DHCP forward list.

134

dhcp relay flush

Flush the DHCP relay settings.

135

dhcp relay ifconfig

Configure a DHCP relay interface.

136

dhcp relay iflist

Show the configuration of the relay interfaces.

138

dhcp relay list

List the DHCP forward list.

139

dhcp relay modify

Modify an entry from the DHCP forward list.

140

dhcp relay ruleadd

Add a selection rule to a DHCP forward entry.

141

E-DOC-CTC-20061027-0003 v2.0

107

DHCP Commands

108

dhcp relay ruledelete

Delete a selection rule from a DHCP forward entry.

142

dhcp rule add

Add a rule for DHCP conditional selection.

143

dhcp rule debug traceconfig

Modify DHCP rule trace configuration.

144

dhcp rule delete

Delete a DHCP rule.

145

dhcp rule flush

Flush all DHCP rules.

146

dhcp rule list

List all DHCP rules.

147

dhcp server config

Print the DHCP server configuration settings.

148

dhcp server flush

Flush all DHCP server pool and lease entries.

149

dhcp server policy

Print the DHCP server policy settings.

150

dhcp server debug clear

Clear the DHCP server statistics.

151

dhcp server debug stats

Show the DHCP server statistics.

152

dhcp server debug traceconfig

Modify the DHCP server trace configuration.

154

dhcp server lease add

Add a DHCP server lease.

155

dhcp server lease delete

Delete a DHCP server lease.

157

dhcp server lease flush

Flush all the DHCP server leases.

158

dhcp server lease list

List all the DHCP server leases.

159

dhcp server option flush

Flush all DHCP server option templates and instances.

160

dhcp server option instadd

Add a DHCP server option instance.

161

dhcp server option instdelete

Delete a DHCP server option instance.

163

dhcp server option instlist

List all the DHCP server option instances.

164

dhcp server option tmpladd

Add a DHCP server option template.

165

dhcp server option tmpldelete

Delete a DHCP server option template.

166

dhcp server option tmpllist

List all the DHCP server option templates.

167

dhcp server pool add

Add a DHCP server pool.

168

dhcp server pool config

Configure a DHCP server pool.

170

dhcp server pool delete

Delete a DHCP server pool.

172

dhcp server pool flush

Flush all DHCP server pools.

173

dhcp server pool list

List all DHCP server pools.

174

dhcp server pool optadd

Add an option instance to the DHCP server pool.

175

dhcp server pool optdelete

Delete an option instance from the DHCP server pool.

176

dhcp server pool rtadd

Add a route to the DHCP server pool.

178

dhcp server pool rtdelete

Delete a route from the DHCP server pool.

179

dhcp server pool ruleadd

Add a selection rule to the DHCP server pool.

180

dhcp server pool ruledelete

Delete a selection rule from the DHCP server pool.

181

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client flush
Delete all the DHCP leases.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp client flush

E-DOC-CTC-20061027-0003 v2.0

109

DHCP Commands

dhcp client ifadd
Create a DHCP client.

SYNTAX:
dhcp client ifadd

intf = 
[defrqoptions = <{disabled|enabled}>]

where:
intf

The name of the dynamic interface for which a DHCP lease
must be created.

REQUIRED

defrqoptions

Enable/Disable the creation of the default Parameter Request
List.

OPTIONAL

EXAMPLE:
=>dhcp client iflist
No dynamic interfaces defined.
=>dhcp client ifadd intf=myPPP_ppp
[dhcp client]=>iflist
DHCP Client Info :
Interface
DHCP Client State
HW address
Client ID

:
:
:
:

myPPP_ppp
[INIT]
00:0e:50:91:26:5a

IP Address
p-t-p IP
Default Gateway

:
:
:

0.0.0.0
0.0.0.0

Number of leases: 1
Total size of table: 68, in use: 1, free: 98 %=>

RELATED COMMANDS:

110

dhcp client ifdelete

Delete a DHCP client.

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

interface list

Display interfaces.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client ifattach
Activate a DHCP client.

SYNTAX:
dhcp client ifattach

intf = 

where:
intf

The name of the dynamic interface for which a DHCP client
was created.

REQUIRED

EXAMPLE:
=>dhcp client iflist
myPPP_ppp : [INIT]
flags = bc dns rt
IP address : 0.0.0.0
HW address [SpeedTouch] : 00
DHCP server: 255.255.255.255
metric : rt = 1, DNS = 1
Number of leases: 1
Total size of table: 36, in use: 1, free: 97 %
=>dhcp client ifattach intf=myPPP_ppp
=>dhcp client iflist
myPPP_ppp : [SELECTING]
flags = bc dns rt
IP address : 0.0.0.0
HW address [SpeedTouch] : 00
DHCP server: 255.255.255.255
metric : rt = 1, DNS = 1
trying to get a lease for 1 sec
transmission of DISCOVER in 0 sec
retransmission timeout: 4
nbr of retransmissions: 2
Number of leases: 1
Total size of table: 36, in use: 1, free: 97 %
=>

RELATED COMMANDS:
dhcp client ifadd

Create a DHCP client.

dhcp client ifdetach

De-activate a DHCP client and releases its lease.

dhcp client ifrenew

Renew the DHCP lease.

interface list

Display interfaces.

E-DOC-CTC-20061027-0003 v2.0

111

DHCP Commands

dhcp client ifconfig
Configure a DHCP client.

i

Use the command :dhcp client ifrelease before configuring the dhcp client.

SYNTAX:
dhcp client ifconfig

intf = 
[label = ]
[metric = ]
[dnsmetric = ]
[broadcast = <{disabled|enabled}>]
[serverroute = ]

where:
intf

The name of the dynamic interface to be configured.

REQUIRED

label

Label for default gateway and static routes.

OPTIONAL

metric

A number between 0 and 255.
Represents the route metric for default gateway and static
routes.
The default is 1.

OPTIONAL

dnsmetric

A number between 0 and 100.
Represents the DNS route metric.
The default is 1.

OPTIONAL

broadcast

Operate client in unicast/broadcast mode.
The default is enabled.

OPTIONAL

serverroute

Insert a route for the DHCP server IP.
The default is enabled.

OPTIONAL

RELATED COMMANDS
label add

112

Create a new label.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client ifdelete
Delete a DHCP client.

SYNTAX:
dhcp client ifdelete

intf = 

where:
intf

The name of the dynamic interface for which the DHCP lease
must be deleted.

REQUIRED

EXAMPLE:
=>dhcp client iflist
myPPP_ppp : [INIT]
flags = bc dns rt
IP address : 10.0.0.1
HW address [SpeedTouch] : 00:90:d0:01:47:f1
DHCP server: 10.10.1.1
hostname : myHostName
client identifier : [00] myClientID
user class identifier : myUserID
metric : rt = 1, DNS = 1
Number of leases: 1
Total size of table: 36, in use: 1, free: 97 %
=>dhcp client ifdelete intf=myPPP_ppp
=>dhcp client iflist
No dynamic interfaces defined.
=>

RELATED COMMANDS:
dhcp client ifadd

Create a DHCP client.

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

E-DOC-CTC-20061027-0003 v2.0

113

DHCP Commands

dhcp client ifdetach
De-activate a DHCP client and releases its lease.

SYNTAX:
ifdetach

intf = 

where:

intf

The name of the dynamic interface.

REQUIRED

RELATED COMMANDS:

114

dhcp client ifattach

Activate a DHCP client.

dhcp client ifrenew

Renew the DHCP lease.

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client iflist
List all the DHCP leases attached to dynamic interfaces.

SYNTAX:
dhcp client iflist

[intf = ]
[expand = <{disabled|enabled}>]

where:
intf

The name of the dynamic interface.

OPTIONAL

expand

Expand enabled/disabled.

OPTIONAL

EXAMPLE:
=>dhcp client iflist
myPPP_ppp : [INIT]
flags = bc dns rt
IP address : 10.0.0.1
HW address [SpeedTouch] : 00:90:d0:01:47:f1
DHCP server: 10.10.1.1
hostname : myHostName
client identifier : [00] myClientID
user class identifier : myUserID
metric : rt = 1, DNS = 1
Number of leases: 1
Total size of table: 36, in use: 1, free: 97 %
=>

EXAMPLE INPUT/OUTPUT IN A NETWORKED ENVIRONMENT:
The Thomson ST is configured as DHCP client disabled its Ethernet interface eth0.
=>dhcp client iflist
myPPP_ppp : [INIT]
flags = bc dns rt
IP address : 10.0.0.1
HW address [SpeedTouch] : 00:90:d0:01:47:f1
DHCP server: 10.10.1.1
hostname : myHostName
client identifier : [00] myClientID
user class identifier : myUserID
metric : rt = 1, DNS = 1
lease renewal in
5 days, 1 h, 26 min, 45 sec
lease rebinding in
8 days, 20 h, 34 min, 15 sec
lease expires in
10 days, 2 h, 56 min, 45 sec
Number of leases: 1
Total size of table: 36, in use: 1, free: 97 %
=>

E-DOC-CTC-20061027-0003 v2.0

115

DHCP Commands

RELATED COMMANDS:

116

dhcp client ifadd

Create a DHCP client.

dhcp client ifdelete

Delete a DHCP client.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client ifrenew
Renew the DHCP lease.

SYNTAX:
dhcp client ifrenew

intf = 

where:
intf

The name of the dynamic interface for which the DHCP lease
must be renewed.

REQUIRED

EXAMPLE 1:
=>dhcp client iflist
NewETHoA
: [BOUND]
flags= uc
IP address
: 10.0.0.10
HW address
: 00:90:d0:01:47:f1
DHCP server
: 255.255.255.255
hostname
: NewLease
req.leasetime = 10800 s
lease renewal in
5 days, 58 min, 48 sec
lease rebinding in
8 days, 20 h, 6 min, 18 sec
lease expires in
10 days, 2 h, 28 min, 48 sec
Number of leases: 1
Total size of table: 19,
in use: 1,
free: 94 %
=>dhcp client ifrenew intf=NewETHoA
=>dhcp client iflist
NewETHoA
: [SELECTING]
flags= uc
IP address
: 10.0.0.10
HW address
: 00:90:d0:01:47:de
DHCP server
: 255.255.255.255
hostname
: NewLease
req.leasetime
= 10800 s
trying to get a lease for 12 sec
transmission of DISCOVER in 24 sec
retransmission timeout: 64
nbr of retransmissions: 11
Number of leases: 1
Total size of table: 19,
in use: 1,
free: 94 %
=>

E-DOC-CTC-20061027-0003 v2.0

117

DHCP Commands

EXAMPLE 2:
The Thomson ST is configured as DHCP client disabled its Ethernet interface eth0.
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv
:
0
OFFERs
recv
:
0
ACKs
recv
:
0
NAKs
recv
:
0
Pure BOOTP REPLIES
:
0
Other message types
:
0
DISCOVERs sent
:
0
REQUESTs sent
:
0
DECLINEs sent
:
0
RELEASEs sent
:
1
INFORMs
sent
:
0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 18,
in use: 1,
free: 94 %
=>dhcp client ifrenew intf=eth0
=>dhcp client stats
DHCP client statistics:
Corrupted packet recv
:
0
OFFERs
recv
:
1
ACKs
recv
:
1
NAKs
recv
:
0
Pure BOOTP REPLIES
:
0
Other message types
:
0
DISCOVERs sent
:
1
REQUESTs sent
:
1
DECLINEs sent
:
0
RELEASEs sent
:
1
INFORMs
sent
:
0
Number of dynamic interfaces: 1
Memory usage:
Table size of dyn leases: 18,
in use: 1,
free: 94 %
=>(CTRL + Q)
..................
STATE IDLE !
STATE ACTIVATE !
dhcc: intf 1 renews lease 10.0.0.3.
dhcc: intf 1 requests 10.0.0.3 from 10.10.1.1
dhcc: 10.10.1.1 acks 10.0.0.3 to intf 1.
dhcc: lease 10.0.0.3 bound to intf 1.
STATE IDLE !
STATE ACTIVATE !
...........
=>(CTRL + S)

RELATED COMMANDS:
dhcp client ifattach

118

Activate a DHCP client.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client debug clear
Clear the DHCP client statistics.

SYNTAX:
dhcp client debug clear

EXAMPLE:
=>dhcp client debug stats
DHCP client statistics:
Corrupted packet recv
: 0
OFFERs
recv
: 0
ACKs
recv
: 0
NAKs
recv
: 0
Pure BOOTP REPLIES
: 0
Other message types
: 0
DISCOVERs sent
: 253
REQUESTs sent
: 9
DECLINEs sent
: 0
RELEASEs sent
: 0
INFORMs
sent
: 0
Number of dynamic interfaces:
Memory usage:
Table size of dyn leases: 19,
=>dhcp client debug clear
=>dhcp client debug stats
DHCP client statistics:
Corrupted packet recv
: 0
OFFERs
recv
: 0
ACKs
recv
: 0
NAKs
recv
: 0
Pure BOOTP REPLIES
: 0
Other message types
: 0
DISCOVERs sent
: 0
REQUESTs sent
: 0
DECLINEs sent
: 0
RELEASEs sent
: 0
INFORMs
sent
:
0
Number of dynamic interfaces:
Memory usage:
Table size of dyn leases: 19,
=>

1
in use: 1,

free: 94 %

1
in use: 1,

free: 94 %

RELATED COMMANDS:
dhcp client debug stats

E-DOC-CTC-20061027-0003 v2.0

Print the DHCP client statistics.

119

DHCP Commands

dhcp client debug stats
Print the DHCP client statistics.

SYNTAX:
dhcp client debug stats

EXAMPLE:
=>dhcp client debug stats
DHCP client statistics:
Corrupted packet recv
:
OFFERs
recv
:
ACKs
recv
:
NAKs
recv
:
Pure BOOTP REPLIES
:
Other message types
:
DISCOVERs sent
:
REQUESTs sent
:
DECLINEs sent
:
RELEASEs sent
:
INFORMs
sent
:
Number of dynamic interfaces:
Memory usage:
Table size of dyn leases: 19,
=>

0
1
1
0
0
0
244
9
0
1
0
1
in use: 1,

free: 94 %

RELATED COMMANDS:
dhcp client debug clear

120

Clear the DHCP client statistics.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client debug traceconfig
Modify the DHCP client trace configuration.

SYNTAX:
dhcp client debug traceconfig

[state = <{disabled | enabled}>]

where:
state

Enable or disable tracing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>dhcp client debug traceconfig
tracing: disabled
=>dhcp client debug traceconfig trace=enabled
=>dhcp client debug traceconfig
tracing: enabled
=>

E-DOC-CTC-20061027-0003 v2.0

121

DHCP Commands

dhcp client rqoptions add
Add a DHCP Option Code to the Parameter Request List.

SYNTAX:
dhcp client rqoptions add

intf = 
option = 
[index = ]

where:

intf

The name of the dynamic interface.

REQUIRED

option

The name or number of the option.

OPTIONAL

index

The index of the option.

OPTIONAL

RELATED COMMANDS:

122

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

dhcp client rqoptions
optionlist

List all DHCP Option Codes that can be used in the Parameter Request List.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client rqoptions delete
Delete a DHCP Option Code from the Parameter Request List.

SYNTAX:
dhcp client rqoptions delete

intf = 
option = 

where:

intf

The name of the dynamic interface.

REQUIRED

option

The name or number of the option.

OPTIONAL

RELATED COMMANDS:
dhcp client rqoptions
list

E-DOC-CTC-20061027-0003 v2.0

List all DHCP Option Codes in the Parameter Request List.

123

DHCP Commands

dhcp client rqoptions list
List all DHCP Option Codes in the Parameter Request List.

SYNTAX:
dhcp client rqoptions list

[intf = ]

where:
intf

The name of the dynamic interface.

OPTIONAL

RELATED COMMANDS:
dhcp client rqoptions
delete

124

Delete a DHCP Option Code from the Parameter Request List.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client rqoptions optionlist
List all DHCP Option Codes that can be used in the Parameter Request List.

SYNTAX:
dhcp client rqoptions optionlist

RELATED COMMANDS:
dhcp client rqoptions
add

Add a DHCP Option Code to the Parameter Request List.

dhcp client rqoptions
list

List all DHCP Option Codes in the Parameter Request List.

E-DOC-CTC-20061027-0003 v2.0

125

DHCP Commands

dhcp client txoptions add
Add an option.

SYNTAX:
dhcp client txoptions add

intf = 
option = 
value = 
[index = ]

where:
intf

The name of the dynamic interface.

REQUIRED

option

The name or number of the option.

REQUIRED

value

The value of the option.

REQUIRED

index

The index of the option.

OPTIONAL

EXAMPLE:
=>:dhcp client txoptions add intf=wan1 option=ien116-name-servers value=(8-bit)5

RELATED COMMANDS:

126

dhcp client iflist

List all the DHCP leases attached to dynamic interfaces.

dhcp client txoptions
optionlist

Lists all DHCP Option Codes that can be used.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client txoptions delete
Delete an option.

SYNTAX:
dhcp client txoptions delete

intf = 
option = 

where:
intf

The name of the dynamic interface.

REQUIRED

option

The name or number of the option.

REQUIRED

RELATED COMMANDS:
dhcp client txoptions list

E-DOC-CTC-20061027-0003 v2.0

List all options.

127

DHCP Commands

dhcp client txoptions list
List all options.

SYNTAX:
dhcp client txoptions list

RELATED COMMANDS:
dhcp client txoptions
delete

128

Delete an option.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp client txoptions optionlist
Lists all DHCP Option Codes that can be used.

SYNTAX:
dhcp client txoptions optionlist

RELATED COMMANDS:
dhcp client txoptions
add

Add an option.

dhcp client txoptions list

List all options.

E-DOC-CTC-20061027-0003 v2.0

129

DHCP Commands

dhcp relay add
Add an entry to the DHCP forward list.

SYNTAX:
dhcp relay add

name = 

where:
name

The forward entry name.

REQUIRED

RELATED COMMANDS:

130

dhcp relay delete

Delete an entry from the DHCP forward list.

dhcp relay list

List the DHCP forward list.

dhcp relay modify

Modify an entry from the DHCP forward list.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp relay debug stats
Show the DHCP relay statistics.

SYNTAX:
dhcp relay debug stats

EXAMPLE:
=>dhcp relay debug stats
DHCP relay statistics
------------------------Client packet relayed
:
Server packet relayed
:
Bogus relay agent
:
Bogus giaddr recv
:
Corrupt agent option
:
Missing agent option
:
Bad circuit id
:
Missing circuit id
:
=>

64
0
0
0
0
0
0
0

RELATED COMMANDS:
dhcp relay debug
traceconfig

E-DOC-CTC-20061027-0003 v2.0

Modify the DHCP relay trace configuration.

131

DHCP Commands

dhcp relay debug traceconfig
Modify the DHCP relay trace configuration.

SYNTAX:
dhcp relay debug traceconfig

[state = <{disabled | enabled}>]

where:
state

Enable or disable tracing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>dhcp relay debug traceconfig
Tracing: disabled
=>

RELATED COMMANDS:
dhcp relay debug stats

132

Show the DHCP relay statistics.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp relay config
Set the DHCP relay configuration settings.

SYNTAX:
dhcp relay config

[agentinfo = <{disabled | enabled}>]
[agentmismatch = <{disabled | enabled}>]

where:
agentinfo

Set the relay agent info status (RFC3046) enabled or disabled.
The default is disabled.

OPTIONAL

agentmismatch

Forward/drop DHCP reply packet when a relay agent info
mismatch is detected (RFC3046) (enabled) or not (disabled).
The default is disabled.

OPTIONAL

EXAMPLE:
=>dhcp relay config
Agent info status : disabled
Drop agent info mismatch status : disabled
=>dhcp relay config agentinfo=enabled
=>dhcp relay config
Agent info status : enabled
Drop agent info mismatch status : disabled
=>

E-DOC-CTC-20061027-0003 v2.0

133

DHCP Commands

dhcp relay delete
Delete an entry from the DHCP forward list.

SYNTAX:
dhcp relay delete

name = 

where:
name

The forward entry name.

REQUIRED

EXAMPLE:
=>dhcp relay delete
name = lan1_to_127.0.0.1
:dhcp relay delete name=lan1_to_127.0.0.1
=>

RELATED COMMANDS:

134

dhcp relay add

Add an entry to the DHCP forward list.

dhcp relay list

List the DHCP forward list.

dhcp relay modify

Modify an entry from the DHCP forward list.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp relay flush
Flush the DHCP relay settings.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp relay flush

EXAMPLE:
=>dhcp relay list
DHCP server
Interface
giaddr
------------------------------------------------------127.0.0.1
eth0
192.168.1.254
=>dhcp relay flush
=>dhcp relay list
No dynamic interfaces defined.
=>

E-DOC-CTC-20061027-0003 v2.0

135

DHCP Commands

dhcp relay ifconfig
Configure a DHCP relay interface.

SYNTAX:
dhcp relay ifconfig

intf = 
[relay = <{disabled | enabled}>]
[maxhops = ]
[remoteid = ]
[trusted = <{disabled | enabled}>]

where:

136

intf

The name of the dynamic interface to be configured.

REQUIRED

relay

Set the relay status to enabled or disabled.
The default is disabled.

OPTIONAL

maxhops

A number between 0 and 16.
Represents the maximum number of hops allowed in the
DHCP packet.
The default is 4.

OPTIONAL

remoteid

Set the remote ID as specified in RFC3046.

OPTIONAL

trusted

Drop/forward DHCP request packet when the DHCP Relay
Agent Option is enabled (with the command :dhcp relay
config agentinfo=enabled) and the giaddr field is 0
(RFC3046)) (enabled) or not (disabled).
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

EXAMPLE:
=>dhcp relay iflist
eth0 :
admin state = up
max hops = 4
trusted = disabled
Internet_trigger :
admin state = down
max hops = 4
trusted = disabled
Internet :
admin state = down
max hops = 4
trusted = disabled

oper state = up
remote id =

oper state = down
remote id =

oper state = down
remote id =

=>dhcp relay ifconfig intf=Internet_trigger relay=enabled trusted=enabled
=>dhcp relay iflist
eth0 :
admin state = up
oper state = up
max hops = 4
trusted = disabled
remote id =
Internet_trigger :
admin state = up
max hops = 4
trusted = enabled
Internet :
admin state = down
max hops = 4
trusted = disabled

oper state = up
remote id =

oper state = down
remote id =

=>

E-DOC-CTC-20061027-0003 v2.0

137

DHCP Commands

dhcp relay iflist
Show the configuration of the relay interfaces.

SYNTAX:
dhcp relay iflist

[intf = ]

where:
intf

The name of the dynamic interface to be listed.
Note

OPTIONAL

If not specified, all the relay interfaces will be shown.

EXAMPLE:
=>dhcp relay iflist
eth0 :
admin state = up
max hops = 4
trusted = disabled
Internet_trigger :
admin state = up
max hops = 4
trusted = enabled
Internet :
admin state = down
max hops = 4
trusted = disabled

oper state = up
remote id =

oper state = up
remote id =

oper state = down
remote id =

=>

138

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp relay list
List the DHCP forward list.

SYNTAX:
dhcp relay list

[name = ]

where:
name

The forward entry name.

OPTIONAL

EXAMPLE:
=>dhcp relay list
DHCP server
Interface
giaddr
------------------------------------------------------127.0.0.1
eth0
10.0.0.138
=>

RELATED COMMANDS:
dhcp relay add

Add an entry to the DHCP forward list.

dhcp relay delete

Delete an entry from the DHCP forward list.

dhcp relay modify

Modify an entry from the DHCP forward list.

E-DOC-CTC-20061027-0003 v2.0

139

DHCP Commands

dhcp relay modify
Modify an entry from the DHCP forward list.

SYNTAX:
dhcp relay modify

name = 
[addr = ]
[intf = <{None | guest1 | dmz1 | wan1 |
lan1 | Internet}>]
[giaddr = ]
[script = <>]

where:
name

The forward entry name.

REQUIRED

addr

The DHCP server IP address.

OPTIONAL

intf

The name of the relay interface, ‘None’ to indicate no interface
is specified.
The standard is None.

OPTIONAL

giaddr

The giaddr field to be used in relayed DHCP packets.

OPTIONAL

script

Script to be run when the forward entry is hit.

OPTIONAL

RELATED COMMANDS:

140

dhcp relay add

Add an entry to the DHCP forward list.

dhcp relay delete

Delete an entry from the DHCP forward list.

dhcp relay list

List the DHCP forward list.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp relay ruleadd
Add a selection rule to a DHCP forward entry.

SYNTAX:
dhcp relay ruleadd

name = 
[key = <{or | and}>]
rulename = 

where:
name

The name of the forward entry.

REQUIRED

key

The logical key of the selection rule.
The default is or.

OPTIONAL

rulename

The name of the DHCP selection rule.

REQUIRED

RELATED COMMANDS:
dhcp relay ruledelete

E-DOC-CTC-20061027-0003 v2.0

Delete a selection rule from a DHCP forward entry.

141

DHCP Commands

dhcp relay ruledelete
Delete a selection rule from a DHCP forward entry.

SYNTAX:
dhcp relay ruledelete

name = 
rulename = 

where:
name

The name of the forward entry.

REQUIRED

rulename

The name of the DHCP selection rule.

REQUIRED

RELATED COMMANDS:
dhcp relay ruleadd

142

Add a selection rule to a DHCP forward entry.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp rule add
Add a rule for DHCP conditional selection.

SYNTAX:
dhcp rule add

i

name = 
type = <{vci | uci | mac}>
vci [!]= 
uci [!]= 
[match = <{exactly|as_substring}>]
mac [!]= 

If a value is preceded by a “!”, it means NOT.
For example “mac=!00:9f:aa:bb:cc:dd” means “for MAC address different from 00:9f:aa:bb:cc:dd”.
where:
name

The name of the new DHCP rule.

REQUIRED

type

Specify the DHCP rule type.
Choose between:

REQUIRED

>
>
>
vci

vci: vendor class identifier
uci: user class identifier
mac: MAC address.

The vendor class identifier string.
Note

uci

Only required when type=vci.

The user class identifier string.
Note

REQUIRED

REQUIRED

Only required when type=uci.

match

The vendor or user class identifier string matching.

OPTIONAL

mac

The MAC address.

REQUIRED

Note

Only required when type=mac.

RELATED COMMANDS:
dhcp rule delete

Delete a DHCP rule.

dhcp rule flush

Flush all DHCP rules.

dhcp rule list

List all DHCP rules.

E-DOC-CTC-20061027-0003 v2.0

143

DHCP Commands

dhcp rule debug traceconfig
Modify DHCP rule trace configuration.

SYNTAX:
dhcp rule debug traceconfig

[state = {disabled | enabled}]

where:
state

144

Set tracing to disabled or enabled.
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp rule delete
Delete a DHCP rule.

SYNTAX:
dhcp rule delete

name = 

where:
name

The name of the DHCP rule.

REQUIRED

EXAMPLE:
=>dhcp rule delete
name = new
:dhcp rule delete name=new
=>

RELATED COMMANDS:
dhcp rule add

Add a rule for DHCP conditional selection.

dhcp rule flush

Flush all DHCP rules.

dhcp rule list

List all DHCP rules.

E-DOC-CTC-20061027-0003 v2.0

145

DHCP Commands

dhcp rule flush
Flush all DHCP rules.

SYNTAX:
dhcp rule flush

EXAMPLE:
=>dhcp rule list
Name
new
=>dhcp rule flush
=>dhcp rule list
Name
=>

Use
0

Value
vci=test

Use

Value

RELATED COMMANDS:

146

dhcp rule add

Add a rule for DHCP conditional selection.

dhcp rule delete

Delete a DHCP rule.

dhcp rule list

List all DHCP rules.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp rule list
List all DHCP rules.

SYNTAX:
dhcp rule list

EXAMPLE:
=>dhcp rule list
Name
new
=>

Use
0

Value
vci=test

RELATED COMMANDS:
dhcp rule add

Add a rule for DHCP conditional selection.

dhcp rule delete

Delete a DHCP rule.

dhcp rule flush

Flush all DHCP rules.

E-DOC-CTC-20061027-0003 v2.0

147

DHCP Commands

dhcp server config
Print the DHCP server configuration settings.

SYNTAX:
dhcp server config

[state = <{disabled | enabled}>]

where:

148

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server flush
Flush all DHCP server pool and lease entries.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp server flush

E-DOC-CTC-20061027-0003 v2.0

149

DHCP Commands

dhcp server policy
Print the DHCP server policy settings.

SYNTAX:
dhcp server policy

[verifyfirst = ]
[trustclient = ]
[rtbehaviour = ]

where:

150

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server debug clear
Clear the DHCP server statistics.

SYNTAX:
dhcp server debug clear

EXAMPLE:
=>dhcp server debug stats
DHCP server state: Running
DHCP server statistics:
Corrupted packet recv
:
0
DISCOVER
:
2451
REQUEST
:
28
DECLINE
:
0
RELEASE
:
22
INFORM
:
1
Pure BOOTP REQUESTS
:
2
Other message types
:
0
OFFERs sent
:
2451
ACKs sent
:
19
NAKs sent
:
0
Relay agent options dropped
:
0
Lease table got full
: no
Ping table got full
: no
Second dhcp server seen : no
Total size of lease table: 32, in use: 0 free: 100 %
=>dhcp server debug clear
=>dhcp server debug stats
DHCP server state: Running
DHCP server statistics:
Corrupted packet recv
:
0
DISCOVER
:
0
REQUEST
:
0
DECLINE
:
0
RELEASE
:
0
INFORM
:
0
Pure BOOTP REQUESTS
:
0
Other message types
:
0
OFFERs sent
:
0
ACKs sent
:
0
NAKs sent
:
0
Relay agent options dropped
:
0
Lease table got full
: no
Ping table got full
: no
Second dhcp server seen : no
Total size of lease table: 32, in use: 0 free: 100 %
=>

RELATED COMMANDS:
dhcp server debug stats

E-DOC-CTC-20061027-0003 v2.0

Show the DHCP server statistics.

151

DHCP Commands

dhcp server debug stats
Show the DHCP server statistics.

SYNTAX:
dhcp server debug stats

EXAMPLE:
=>dhcp server stats
DHCP Server State:
Stopped
DHCP server statistics:
Corrupted packet recv
:
0
DISCOVER
:
2451
REQUEST
:
28
DECLINE
:
0
RELEASE
:
22
INFORM
:
1
Pure BOOTP REQUESTS
:
2
Other message types
:
0
OFFERs sent
:
2451
ACKs sent
:
19
NAKs sent
:
0
Relay agent options dropped
:
0
Lease table got full
: no
Ping table got full
: no
Second dhcp server seen : no
Total size of lease table: 32, in use: 16, free: 50 %
=>

DESCRIPTION:
> DHCP server state: the state of the DHCP server.
> Corrupted packet recv: the number of corrupted packets (not complaint to RFC2131) received from the
LAN.

>

DISCOVER: the number of DHCP server discovery packets received from the LAN. These broadcasts are
sent by potential DHCP clients to locate available DHCP servers.

>
>
>
>
>
>
>
>
>
>
>

REQUEST: the number of DHCP address lease requests received from the Local Area Network (LAN).

152

DECLINE: the number of DHCP address lease requests declined.
RELEASE: the number of DHCP address release requests received from DHCP clients.
INFORM: the number of information requests received from DHCP clients.
Pure BOOTP requests: the number of BOOTP requests received from the LAN.
Other message types: the number of other messages received from the LAN.
OFFERs sent: the number of IP address offers sent in reply to DHCP requests.
ACKs sent: the number of ACKnowledgement replies sent to successfully configured DHCP clients.
NAKs sent: the number of Not-AcKnowledgement replies sent to wrongly configured DHCP clients.
Relay agent options dropped
Lease table got full: whether the maximum number of DHCP leases is reached or not.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

>

Ping table got full: whether the history list of IP address pings got full or not. These pings are sent by the
DHCP server to verify whether the IP address is already in use disabled the LAN or not (:dhcp server
policy verifyfirst=yes).

>

Second DHCP server seen: whether a concurrent DHCP server was found disabled the LAN or not.

RELATED COMMANDS:
dhcp server debug clear

E-DOC-CTC-20061027-0003 v2.0

Clear the DHCP server statistics.

153

DHCP Commands

dhcp server debug traceconfig
Modify the DHCP server trace configuration.

SYNTAX:
dhcp server debug traceconfig

[state = <{disabled | enabled}>]

where:
state

Enable or disable tracing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>dhcp server debug traceconfig
Tracing: disabled
=>

154

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server lease add
Add a DHCP server lease.

SYNTAX:
dhcp server lease add

clientid = 
pool = 
[addr = ]
[offset = ]
[leasetime = ]
[expirytime = ]
[gateway = ]
[macaddr = ]

where:
clientid

The DHCP client identification string of the booting host.

REQUIRED

pool

The name of the DHCP server pool from which the DHCP lease
should be taken.

REQUIRED

Tip

Use the command :dhcp server pool list to
obtain a list of available DHCP server pools.

addr

The favoured IP address for this DHCP host.
This IP address, if specified, must be in the range of the
specified DHCP server pool.

OPTIONAL

offset

A number between 0 and the integer number defined by the
number of available IP addresses in the DHCP server pool.
Represents the IP address offset in the DHCP server pool
preserved for this host.

OPTIONAL

Note
leasetime

A number (of seconds).
Represents the time the host is allowed to use this address.
Note

expiretime

Not specifying this parameter does not preserve an IP
address for the host.
OPTIONAL

0 means infinite leasetime.

The time in seconds the DHCP server keeps the lease reserved
Tip

0 means infinite expirytime.

gateway

The IP address of the default router for this client.

OPTIONAL

macaddr

The MAC address of the host.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

155

DHCP Commands

EXAMPLE:
=>dhcp server
Lease
0 0.0.0.0
=>dhcp server
=>dhcp server
Lease
0 0.0.0.0
1 10.0.0.1
=>

lease list
Pool
TTL
State
dhcp_pool_1 00:26:40
FREE
lease add clientid=01:23:55:67:89:ab
lease list
Pool
TTL
State
dhcp_pool_1 00:26:40
FREE
local_pool
00:59:22
USED

Clientid
00:90:D0:12:34:56
pool=Local_pool leasetime=3600
Clientid
00:90:D0:12:34:56
01:23:45:67:89:AB

RELATED COMMANDS:

156

dhcp server lease delete

Delete a DHCP server lease.

dhcp server lease list

List all the DHCP server leases.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server lease delete
Delete a DHCP server lease.

SYNTAX:
dhcp server lease delete

[clientid = ]
[index = ]

where:
clientid

The DHCP client identification string of the DHCP lease.
Note

index

OPTIONAL

If not specified, all DHCP clients are deleted.

The DHCP server lease table index.

OPTIONAL

Use the command :dhcp server lease list to
obtain a list of the index numbers of all current
DHCP leases.

Tip

EXAMPLE:
=>dhcp server
Lease
0 0.0.0.0
1 10.0.0.1
=>dhcp server
=>dhcp server
Lease
1 10.0.0.1
=>

lease list
Pool
dhcp_pool_1
local_pool
lease delete
lease list
Pool
local_pool

TTL
00:26:40
00:59:22
index=0

State
FREE
USED

Clientid
00:90:D0:12:34:56
01:23:45:67:89:AB

TTL
00:59:22

State
USED

Clientid
01:23:45:67:89:AB

RELATED COMMANDS:
dhcp server lease add

Add a DHCP server lease.

dhcp server lease list

List all the DHCP server leases.

E-DOC-CTC-20061027-0003 v2.0

157

DHCP Commands

dhcp server lease flush
Flush all the DHCP server leases.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp server lease flush

[pool = ]

where:
pool

The name of the DHCP server pool to be flushed.
Only the leases belonging to this pool will be deleted.
Note

OPTIONAL

If not specified, all the DHCP server leases will be
flushed.

EXAMPLE:
=>dhcp server
Lease
0 0.0.0.0
1 10.0.0.1
2 10.0.0.101
3 10.0.0.132
5 10.0.0.5
4 10.0.0.6
8 10.0.0.8
9 10.0.0.15
=>dhcp server
=>dhcp server
=>

158

lease list
Pool
dhcp_pool_1
local_pool
local_pool
local_pool
local_pool
local_pool
local_pool
local_pool
lease flush
lease list

TTL
00:26:40
00:59:22
00:21:01
00:45:37
00:21:11
00:59:01
00:01:00
00:00:23

State
FREE
USED
USED
USED
USED
USED
USED
USED

Clientid
00:90:D0:12:34:56
01:23:45:67:89:AB
01:23:89:AB:80:CD
09:D0:25:CE:F1:31
AB:33:A1:7C:89:DD
E3:81:9F:11:11:11
08:80:09:90:AB:DC
08:93:DA:AE:01:AF

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server lease list
List all the DHCP server leases.

SYNTAX:
dhcp server lease list

[clientid = ]
[index = ]

where:
clientid

The DHCP client identification string of the DHCP lease.
Note

index

If not specified, the DSHCP server leases for all the
DHCP clients are listed.

The DHCP server lease table index.
Note

OPTIONAL

OPTIONAL

If not specified, the complete DHCP server lease table
will be shown.

EXAMPLE:
=>dhcp server
Lease
0 0.0.0.0
1 10.0.0.1
2 10.0.0.101
3 10.0.0.132
5 10.0.0.5
4 10.0.0.6
8 10.0.0.8
9 10.0.0.15
=>

lease list
Pool
dhcp_pool_1
local_pool
local_pool
local_pool
local_pool
local_pool
local_pool
local_pool

TTL
00:26:40
00:59:22
00:21:01
00:45:37
00:21:11
00:59:01
00:01:00
00:00:23

State
FREE
USED
USED
USED
USED
USED
USED
USED

Clientid
00:90:D0:12:34:56
01:23:45:67:89:AB
01:23:89:AB:80:CD
09:D0:25:CE:F1:31
AB:33:A1:7C:89:DD
E3:81:9F:11:11:11
08:80:09:90:AB:DC
08:93:DA:AE:01:AF

RELATED COMMANDS:
dhcp server lease add

Add a DHCP server lease.

dhcp server lease delete

Delete a DHCP server lease.

E-DOC-CTC-20061027-0003 v2.0

159

DHCP Commands

dhcp server option flush
Flush all DHCP server option templates and instances.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp server option flush

160

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server option instadd
Add a DHCP server option instance.

SYNTAX:
dhcp server option instadd

name = 
tmplname = 
value = 

where:
name

The name of the DHCP server option instance.

REQUIRED

tmplname

The name of the DHCP server option template.

REQUIRED

Tip

value

The value of the DHCP server option instance.
Format is (type)value where type is 8-bit, 16-bit, 32-bit, addr,
ascii or byte_array.
Note

E-DOC-CTC-20061027-0003 v2.0

Use the command :dhcp server option
tmpllist to obtain a list of DHCP server option
templates.
REQUIRED

The type must be identical to the type of the DHCP
server option template. Use the command :dhcp
server option tmpllist to obtain a list of DHCP
server option templates.

161

DHCP Commands

EXAMPLE:
=>dhcp server option instlist
myInstance
Tmpl name : myTmpl
Use
: 0
Value
: (32-bit)64

(1)

=>dhcp server option instadd name=yourInstance tmplname=yourTmpl value=(ascii)!
{root}[dhcp server option]=>instlist
yourInstance
Tmpl name : yourTmpl
(2)
Use
: 0
Value
: (ascii)!
myInstance
Tmpl name : myTmpl
Use
: 0
Value
: (32-bit)64

(1)

=>

RELATED COMMANDS:

162

dhcp server option
instdelete

Delete a DHCP server option instance.

dhcp server option
instlist

List all the DHCP server option instances.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server option instdelete
Delete a DHCP server option instance.

SYNTAX:
dhcp server option instdelete

name = 

where:
name

The name of the DHCP server option instance to be deleted.

REQUIRED

EXAMPLE:
=>dhcp server option instlist
yourInstance
Tmpl name : yourTmpl
Use
: 0
Value
: (ascii)!
myInstance
Tmpl name : myTmpl
Use
: 0
Value
: (32-bit)64

(2)

(1)

=>dhcp server option instdelete name=yourInstance
=>dhcp server option instlist
myInstance
Tmpl name : myTmpl
(1)
Use
: 0
Value
: (32-bit)64
=>

RELATED COMMANDS:
dhcp server option
instadd

Add a DHCP server option instance.

dhcp server option
instlist

List all the DHCP server option instances.

E-DOC-CTC-20061027-0003 v2.0

163

DHCP Commands

dhcp server option instlist
List all the DHCP server option instances.

SYNTAX:
dhcp server option instlist

EXAMPLE:
=>dhcp server option instlist
yourInstance
Tmpl name : yourTmpl
Use
: 0
Value
: (ascii)!
myInstance
Tmpl name : myTmpl
Use
: 0
Value
: (32-bit)64

(2)

(1)

=>

RELATED COMMANDS:

164

dhcp server option
instadd

Add a DHCP server option instance.

dhcp server option
instdelete

Delete a DHCP server option instance.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server option tmpladd
Add a DHCP server option template.

SYNTAX:
dhcp server option tmpladd

name = 
optionid = 
type = <{8-bit | 16-bit | 32-bit | addr |
ascii | byte_array}>

where:
name

The name of the DHCP server option template.

REQUIRED

optionid

A number between 1 and 254.
Specifies the DHCP server option code.

REQUIRED

type

Specifies the DHCP server option type.
Choose between:

REQUIRED

>
>
>
>
>
>

8-bit
16-bit
32-bit
addr
ascii
byte_array.

EXAMPLE:
=>dhcp server option tmpllist
Name
Option Type
Use
myTmpl
1
32-bit
0
=>dhcp server option tmpladd name=yourTmpl optionid=2 type=ascii
=>dhcp server option tmpllist
Name
Option Type
Use
yourTmpl
2
ascii
0
myTmpl
1
32-bit
0
=>

RELATED COMMANDS:
dhcp server option
tmpldelete

Delete a DHCP server option template.

dhcp server option
tmpllist

List all the DHCP server option templates.

E-DOC-CTC-20061027-0003 v2.0

165

DHCP Commands

dhcp server option tmpldelete
Delete a DHCP server option template.

SYNTAX:
dhcp server option tmpldelete

name = 

where:
name

The name of the DHCP server option template to be deleted.

REQUIRED

EXAMPLE:
=>dhcp server option tmpllist
Name
Option Type
Use
yourTmpl
2
ascii
0
myTmpl
1
32-bit
0
=>dhcp server option tmpldelete name=yourTmpl
=>dhcp server option tmpllist
Name
Option Type
Use
myTmpl
1
32-bit
0
=>

RELATED COMMANDS:

166

dhcp server option
tmpladd

Add a DHCP server option template.

dhcp server option
tmpllist

List all the DHCP server option templates.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server option tmpllist
List all the DHCP server option templates.

SYNTAX:
dhcp server option tmpllist

EXAMPLE:
=>dhcp server option tmpllist
Name
Option Type
yourTmpl
2
ascii
myTmpl
1
32-bit
=>

Use
0
0

RELATED COMMANDS:
dhcp server option
tmpladd

Add a DHCP server option template.

dhcp server option
tmpldelete

Delete a DHCP server option template.

E-DOC-CTC-20061027-0003 v2.0

167

DHCP Commands

dhcp server pool add
Add a DHCP server pool.

SYNTAX:
dhcp server pool add

name = 
[index = ]

where:
name

The name of the DHCP server pool.
Note

index

If not specified, the name is “dhcp_pool_x”, where x is
a subsequent number.

The number of the pool before which you want the new pool to
be added.
Note

168

REQUIRED

OPTIONAL

If not specified, the DHCP server pool will be added at
the bottom of the DHCP server lease table.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

EXAMPLE:
=>dhcp server pool list
Pool
Start
End
0 dhcp_pool_1
0.0.0.0
0.0.0.0
1 My_LAN_Pool
10.0.0.1
10.0.0.254
2 dhcp_pool_2
0.0.0.0
0.0.0.0
=>dhcp server pool add
=>dhcp server pool list
Pool
Start
End
0 dhcp_pool_1
0.0.0.0
0.0.0.0
1 My_LAN_Pool
10.0.0.1
10.0.0.254
2 dhcp_pool_2
0.0.0.0
0.0.0.0
3 dhcp_pool_3
0.0.0.0
0.0.0.0
=>dhcp server pool add name=POOL_EXTRA1
=>dhcp server pool list
Pool
Start
End
0 dhcp_pool_1
0.0.0.0
0.0.0.0
1 My_LAN_Pool
10.0.0.1
10.0.0.254
2 dhcp_pool_2
0.0.0.0
0.0.0.0
3 dhcp_pool_3
0.0.0.0
0.0.0.0
4 POOL_EXTRA1
0.0.0.0
0.0.0.0
=>ppp ifconfig name=PPP_Test pool=POOL_EXTRA1
=>dhcp server pool list
Pool
Start
End
0 dhcp_pool_1
0.0.0.0
0.0.0.0
1 My_LAN_Pool
10.0.0.1
10.0.0.254
2 dhcp_pool_2
0.0.0.0
0.0.0.0
3 dhcp_pool_3
0.0.0.0
0.0.0.0
4 POOL_EXTRA1
0.0.0.0
0.0.0.0
=>

State
FREE
USED
FREE

PPP

State
FREE
USED
FREE
FREE

PPP

State
FREE
USED
FREE
FREE
FREE

PPP

State
FREE
USED
FREE
FREE
FREE

PPP

PPP_Test

RELATED COMMANDS:
dhcp server pool delete

Delete a DHCP server pool.

dhcp server pool list

List all DHCP server pools.

E-DOC-CTC-20061027-0003 v2.0

169

DHCP Commands

dhcp server pool config
Configure a DHCP server pool.

SYNTAX:
dhcp server pool config

name = 
intf = 
[index = ]
[poolstart = ]
[poolend = ]
[netmask = ]
[gateway = ]
[server = ]
[primdns = ]
[secdns = ]
[dnsmetric = ]
[primwins = ]
[secwins = ]
[leasetime = ]
[unnumbered = <{disabled | enabled}>]
[localgw = <{disabled | enabled}>]

where:
name

The name of the DHCP server pool to configure.

REQUIRED

intf

The interface for which the pool is allowed to lease IP
addresses.

REQUIRED

index

A number between 0 (highest priority) and the highest number
(lowest priority) found in the list of existing DHCP server pools.
Represents a (higher) priority for the DHCP server pool.

OPTIONAL

Tip

170

Use the command :dhcp server pool list to
obtain a list of the index numbers of all current
DHCP server pools.

poolstart

The lowest IP address in the DHCP address range to use for
leasing.
The default value of this parameter is 0.0.0.0 (not specified),
which means that the lowest IP address of the pool will be
defined by the remote server via Internet Protocol Control
Protocol (IPCP) as soon as the Point-to-Point Protocol (PPP)
IPCP subnetmasking connection is established.

OPTIONAL

poolend

The highest IP address in the DHCP address range to use for
leasing.
The default value of this parameter is 0.0.0.0 (not specified),
which means that the highest IP address of the pool will be
defined by the remote server via IPCP as soon as the PPP IPCP
subnetmasking connection is established.

OPTIONAL

netmask

The applicable netmask for the DHCP leases.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

gateway

The IP address of the default gateway for the DHCP clients.
The default value of this parameter is 0 (not specified), which
means that the gateway IP address will be communicated by
the remote server as soon as the PPP IPCP subnetmasking
connection is established or that the Thomson ST acts as the
LAN default gateway.

OPTIONAL

server

The IP address of the DHCP server for DHCP clients.

OPTIONAL

primdns

The IP address of the primary DNS server for the DHCP clients.
The default value of this parameter is 0 (not specified), which
means that the IP address of the DNS server will be
communicated by the remote server as soon as the PPP IPCP
subnetmasking connection is established or that the Thomson
ST acts as the LAN DNS server.

OPTIONAL

secdns

The IP address of the optional secondary DNS server for DHCP
clients.
The default value of this parameter is 0 (not specified), which
means that the gateway IP address will be communicated by
the remote server as soon as the PPP IPCP subnetmasking
connection is established.

OPTIONAL

dnsmetric

The DHCP server pool DNS route metric.

OPTIONAL

primwins

The IP address of the primary Windows Internet Naming
Service (WINS) server for DHCP clients.

OPTIONAL

secwins

The IP address of the secondary WINS server for DHCP clients.

OPTIONAL

leasetime

A number (of seconds).
Represents the time in seconds a client is allowed to use an
address.

OPTIONAL

Note
unnumbered

Assign an IP address from this pool to the DHCP server
(enabled) or not (disabled).
Note

localgw

Specifying 0 makes the lease permanent.
OPTIONAL

For dynamic pools only.

Proxy for a virtual default gateway residing in same subnet of
DHCP client instead of the remote peer address.

OPTIONAL

EXAMPLE:
=>dhcp server pool list
Pool
Start
End
Intf
State
0 LAN_Private
10.0.0.1
10.0.0.254
eth0
USED
=>dhcp server pool config name=My_Pool poolstart=192.6.11.101
| poolend=192.6.11.254 netmask=255.255.255 gateway=192.6.11.100 leasetime=21600
=>dhcp server pool list
Pool
Start
End
Intf
State
0 LAN_Private
10.0.0.1
10.0.0.254
eth0
USED
1 My_Pool
192.6.11.101
192.6.11.254
eth0
USED
=>

E-DOC-CTC-20061027-0003 v2.0

171

DHCP Commands

dhcp server pool delete
Delete a DHCP server pool.

SYNTAX:
dhcp server pool delete

name = 

where:
name

The name of the DHCP server pool to be deleted.
Tip

REQUIRED

Use the command :dhcp server pool list to
obtain a list of all current DHCP leases.

EXAMPLE:
=>dhcp server pool list
Pool
Start
End
0 LAN_Private
10.0.0.1
10.0.0.254
1 My_Pool
192.6.11.101
192.6.11.254
=>dhcp server pool delete name=My_Pool
=>dhcp server pool list
Pool
Start
End
0 LAN_Private
10.0.0.1
10.0.0.254
=>

Intf
eth0
eth0

State
USED
USED

Intf
eth0

State
USED

RELATED COMMANDS:

172

dhcp server pool add

Add a DHCP server pool.

dhcp server pool list

List all DHCP server pools.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server pool flush
Flush all DHCP server pools.

i

The flush command does not impact previously saved configurations.

SYNTAX:
dhcp server pool flush

EXAMPLE:
=>dhcp server pool list
Pool
Start
0 LAN_Private
10.0.0.1
1 My_Pool
192.6.11.101
=>dhcp server pool flush
=>dhcp server pool list
=>

E-DOC-CTC-20061027-0003 v2.0

End
10.0.0.254
192.6.11.254

Intf
eth0
eth0

State
USED
USED

173

DHCP Commands

dhcp server pool list
List all DHCP server pools.

SYNTAX:
dhcp server pool list

[name = ]

where:
name

The name of the DHCP server pool to be shown.
Note

OPTIONAL

If not specified, all the DHCP server pools are shown.

EXAMPLE:
=>dhcp server pool list
Pool
Start
0 LAN_Private
10.0.0.1
1 My_Pool
192.6.11.101
=>

End
10.0.0.254
192.6.11.254

Intf
eth0
eth0

State
USED
USED

RELATED COMMANDS:

174

dhcp server pool add

Add a DHCP server pool.

dhcp server pool delete

Delete a DHCP server pool.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server pool optadd
Add an option instance to the DHCP server pool.

SYNTAX:
dhcp server pool optadd

name = 
instname = 

where:
name

The name of the DHCP server pool to which an option instance
must be added.

REQUIRED

instname

The name of the DHCP server option instance.

REQUIRED

Tip

Use the command :dhcp server option
instlist to obtain a list of DHCP server option
instances.

EXAMPLE:
=>dhcp server pool
=>dhcp server pool
Pool
1 dhcp_pool_1
DHCP server
Netmask
Leasetime
Gateway
DNS domain
DNS metric

=
=
=
=
=
=

optadd name=dhcp_pool_1 instname=yourInstance
list name=dhcp_pool_1
Start
End
Intf
State
0.0.0.0
0.0.0.0
lan1
FREE

0.0.0.0 [unnumbered]
0.0.0.0
infinite
0.0.0.0
lan
0

DNS address list:
0.0.0.0 (local DNS)
Option instance list:
Name
Option
yourInstance
2
(yourTmpl)
=>

RELATED COMMANDS:
dhcp server pool optdelete

E-DOC-CTC-20061027-0003 v2.0

Delete an option instance from the DHCP server pool.

175

DHCP Commands

dhcp server pool optdelete
Delete an option instance from the DHCP server pool.

SYNTAX:
dhcp server pool optdelete

name = 
instname = 

where:
name

The name of the DHCP server pool from which an option
instance must be deleted.

REQUIRED

instname

The name of the DHCP server option instance to be deleted.

REQUIRED

Tip

176

Use the command :dhcp server option list to
obtain a list of DHCP server option instances.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

EXAMPLE:
=>dhcp server pool list name=dhcp_pool_1
Pool
Start
End
1 dhcp_pool_1
0.0.0.0
0.0.0.0
DHCP server
Netmask
Leasetime
Gateway
DNS domain
DNS metric

=
=
=
=
=
=

Intf
lan1

State
FREE

0.0.0.0 [unnumbered]
0.0.0.0
infinite
0.0.0.0
lan
0

DNS address list:
0.0.0.0 (local DNS)
Option instance list:
Name
Option
yourInstance
2
(yourTmpl)
=>dhcp server pool optdelete name=dhcp_pool_1 instname=yourInstance
=>dhcp server pool list name=dhcp_pool_1
Pool
Start
End
Intf
State
1 dhcp_pool_1
0.0.0.0
0.0.0.0
lan1
FREE
DHCP server
Netmask
Leasetime
Gateway
DNS domain
DNS metric

=
=
=
=
=
=

0.0.0.0 [unnumbered]
0.0.0.0
infinite
0.0.0.0
lan
0

DNS address list:
0.0.0.0 (local DNS)
=>

RELATED COMMANDS:
dhcp server pool optadd

E-DOC-CTC-20061027-0003 v2.0

Add an option instance to the DHCP server pool.

177

DHCP Commands

dhcp server pool rtadd
Add a route to the DHCP server pool.

SYNTAX:
dhcp server pool rtadd

name = 
dst = 
[dstmsk = ]
[gateway = ]

where:
name

The name of the DHCP server pool to which a route must be
added.

REQUIRED

dst

The IP destination address of the route for DHCP clients.

REQUIRED

dstmsk

The destination IP address mask.

OPTIONAL

gateway

The IP address of the next hop. Must be directly connected to
the DHCP client

OPTIONAL

RELATED COMMANDS:
dhcp server pool rtdelete

178

Delete a route from the DHCP server pool.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server pool rtdelete
Delete a route from the DHCP server pool.

SYNTAX:
dhcp server pool rtdelete

name = 
dst = 
[dstmsk = ]
[gateway = ]

where:
name

The name of the DHCP server pool from which a route must be
deleted.

REQUIRED

dst

The IP destination address of the route for DHCP clients.

REQUIRED

dstmsk

The destination IP address mask.

OPTIONAL

gateway

The IP address of the next hop. Must be directly connected to
the DHCP client

OPTIONAL

RELATED COMMANDS:
dhcp server pool rtadd

E-DOC-CTC-20061027-0003 v2.0

Add a route to the DHCP server pool.

179

DHCP Commands

dhcp server pool ruleadd
Add a selection rule to the DHCP server pool.

SYNTAX:
dhcp server pool ruleadd

name = 
[key = {or | and}]
rulename = 

where:
name

The name of the DHCP server pool to which a selection rule
must be added.

REQUIRED

key

The logical key of the selection rule.
The default is or.

OPTIONAL

The name of the DHCP selection rule.

REQUIRED

rulename

Tip

Use the command :dhcp server rule list to
obtain a list of DHCP server rules.

RELATED COMMANDS:
dhcp server pool ruledelete

180

Delete a selection rule from the DHCP server pool.

E-DOC-CTC-20061027-0003 v2.0

DHCP Commands

dhcp server pool ruledelete
Delete a selection rule from the DHCP server pool.

SYNTAX:
dhcp server pool ruleadd

name = 
rulename = 

where:
name

The name of the DHCP server pool from which a selection rule
must be deleted.

REQUIRED

rulename

The name of the DHCP selection rule to be deleted.

REQUIRED

Tip

Use the command :dhcp server rule list to
obtain a list of DHCP server rules.

RELATED COMMANDS:
dhcp server pool
ruleadd

E-DOC-CTC-20061027-0003 v2.0

Add a selection rule to the DHCP server pool.

181

DHCP Commands

182

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

10 DNS Commands
Introduction
This chapter describes the commands of the dns command group.

Contents
This chapter covers the following commands:
dns client config

Modify the Domain Name System (DNS) resolver
configuration.

184

dns client dnsadd

Add a DNS server.

185

dns client dnsdelete

Delete a DNS server.

186

dns client dnslist

List all DNS servers.

187

dns client flush

Remove all DNS servers.

188

dns client nslookup

DNS lookup for a domain name or an address.

189

dns server config

Modify the DNS resolver configuration.

190

dns server flush

Flush all local DNS hosts and routes.

191

dns server debug clear

Clear the DNS server/forwarder statistics.

192

dns server debug stats

Print the DNS server/forwarder statistics.

193

dns server debug spoof clear

Clear the intercept cache table

194

dns server debug spoof getaddress

Get the real ip for the given spoofed ip

195

dns server debug spoof getflags

Get the error flags for the given spoofed ip

196

dns server debug spoof list

List the intercept cache table.

197

dns server debug spoof update

Update the intercept cache table.

198

dns server host add

Add a local DNS host.

199

dns server host delete

Delete a local DNS host.

200

dns server host flush

Flush all the local DNS hosts.

201

dns server host list

List all the local DNS hosts.

202

dns server route add

Creates a DNS forwarding entry or template.

203

dns server route delete

Deletes a DNS forwarding entry or template

205

dns server route flush

Removes all DNS forwarding entries and templates.

206

dns server route list

List all the DNS forwarding entries or templates.

207

E-DOC-CTC-20061027-0003 v2.0

183

DNS Commands

dns client config
Modify the Domain Name System (DNS) resolver configuration.

SYNTAX:
dns client config

[timeout = ]
[retry = ]
[search = <{disabled | enabled}>]
[list = ]
[trace = <{disabled | enabled}>]

where:
timeout

A number between 1 and 900 (seconds).
Represents the query timeout.
The default is 5.

OPTIONAL

retry

A number between 0 and 10.
Represents the number of query retries before giving up.
The default is 3.

OPTIONAL

search

Use the search list to construct fully qualified domain names.
The default is disabled.

OPTIONAL

list

Specify a search list.
This is a slash separated list of domain name suffixes.

OPTIONAL

trace

Enable or disable verbose logging.
The default is disabled.

OPTIONAL

EXAMPLE:
=>dns client config
timeout : 5s
retry
: 3
search
: on
srchlist : 
trace
: off
=>

184

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns client dnsadd
Add a DNS server.

SYNTAX:
dns client dnsadd

addr = 
[port = ]

where:
addr

The IP address of the DNS server to be added.

REQUIRED

port

The DNS server port number.
The default is 53.

OPTIONAL

EXAMPLE:
=>dns client dnsadd addr=150.150.150.150
=>dns client dnslist
Entry
1
2

State
CONNECTED
CONNECTED

Family
IP
IP

Server
[port] 53 - [addr] 127.0.0.1
[port] 53 - [addr] 150.150.150.150

=>

RELATED COMMANDS:
dns client dnsdelete

Delete a DNS server.

dns client dnslist

List all DNS servers.

E-DOC-CTC-20061027-0003 v2.0

185

DNS Commands

dns client dnsdelete
Delete a DNS server.

SYNTAX:
dns client dnsdelete

index = 

where:
index

A number between 1 and 99.
Represents the index number of the DNS server to be deleted.
Tip

REQUIRED

Use the command :dns client dnslist to obtain a list of
DNS servers.

EXAMPLE:
=>dns client dnslist
Entry
1
2

State
CONNECTED
CONNECTED

Family
IP
IP

Server
[port] 53 - [addr] 127.0.0.1
[port] 53 - [addr] 150.150.150.150

=>dns client dnsdelete index=2
=>dns client dnslist
Entry
1

State
CONNECTED

Family
IP

Server
[port] 53 - [addr] 127.0.0.1

=>

RELATED COMMANDS:

186

dns client dnsadd

Add a DNS server.

dns client dnslist

List all DNS servers.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns client dnslist
List all DNS servers.

SYNTAX:
dns client dnslist

EXAMPLE:
=>dns client dnslist
Entry
1
2

State
CONNECTED
CONNECTED

Family
IP
IP

Server
[port] 53 - [addr] 127.0.0.1
[port] 53 - [addr] 150.150.150.150

=>

RELATED COMMANDS:
dns client dnsadd

Add a DNS server.

dns client dnsdelete

Delete a DNS server.

E-DOC-CTC-20061027-0003 v2.0

187

DNS Commands

dns client flush
Remove all DNS servers.

SYNTAX:
dns client flush

188

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns client nslookup
DNS lookup for a domain name or an address.

SYNTAX:
dns client nslookup

host = 

where:
host

E-DOC-CTC-20061027-0003 v2.0

The DNS domain name string for which to query.

REQUIRED

189

DNS Commands

dns server config
Modify the DNS resolver configuration.

SYNTAX:
dns server config

[domain = ]
[timeout = ]
[suppress = ]
[state = <{disabled | enabled}>]
[trace = <{disabled | enabled}>]
[WANDownSpoofing = <{disabled | enabled}>]
[WDSpoofedIP = ]

where:
domain

The DNS server domain name.

OPTIONAL

timeout

A number between 0 and 2147483647 (seconds).
Represents the forwarded DNS query timeout.
The default is 15.

OPTIONAL

suppress

Suppress not more than the specified amount of remote DNS
server errors.
The default is 0.

OPTIONAL

state

Enable or disable the local DNS server/forwarder.
The default is enabled.

OPTIONAL

trace

Enable or disable verbose logging.
The default is disabled.

OPTIONAL

WANDownSpoofing

Enable or disable DNS spoofing when no applicable forwarding
route present.
The default is disabled.

OPTIONAL

WDSpoofedIP

The IP address to be used for spoofing when WANDownSpoofing
is enabled.

OPTIONAL

EXAMPLE:
=>dns server config
domain
: lan
timeout : 15s
suppress : 0
state
: enabled
trace
: off
spoofing : off
spoof ip : 0.0.0.0
=>

190

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server flush
Flush all local DNS hosts and routes.

SYNTAX:
dns server flush

E-DOC-CTC-20061027-0003 v2.0

191

DNS Commands

dns server debug clear
Clear the DNS server/forwarder statistics.

SYNTAX:
dns server debug clear

EXAMPLE:
=>dns server debug stats
Corrupted packets received
Local questions resolved
Local negative answers sent
Total DNS packets forwarded
External answers received
Spoofed responses
Forward table full, discard
Spurious answers
Unknown query types
=>dns server debug clear
=>dns server debug stats
Corrupted packets received
Local questions resolved
Local negative answers sent
Total DNS packets forwarded
External answers received
Spoofed responses
Forward table full, discard
Spurious answers
Unknown query types
=>

:
:
:
:
:
:
:
:
:

100
3
1
0
0
0
0
0
0

:
:
:
:
:
:
:
:
:

0
0
0
0
0
0
0
0
0

RELATED COMMANDS:
dns server debug stats

192

Print the DNS server/forwarder statistics.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server debug stats
Print the DNS server/forwarder statistics.

SYNTAX:
dns server debug stats

EXAMPLE:
=>dns server debug stats
Corrupted packets received
Local questions resolved
Local negative answers sent
Total DNS packets forwarded
External answers received
Spoofed responses
Forward table full, discard
Spurious answers
Unknown query types
=>

:
:
:
:
:
:
:
:
:

100
3
1
0
0
0
0
0
0

RELATED COMMANDS:
dns server debug clear

E-DOC-CTC-20061027-0003 v2.0

Clear the DNS server/forwarder statistics.

193

DNS Commands

dns server debug spoof clear
Clear the intercept cache table

SYNTAX:
dns server debug spoof clear

RELATED COMMANDS:

194

dns server debug spoof getaddress

Get the real ip for the given spoofed ip

dns server debug spoof getflags

Get the error flags for the given spoofed ip

dns server debug spoof list

List the intercept cache table.

dns server debug spoof update

Update the intercept cache table.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server debug spoof getaddress
Get the real ip for the given spoofed ip

SYNTAX:
dns server debug spoof getaddress

addr = 

where:
addr

The IP address of the spoofed server.

REQUIRED

EXAMPLE:
{Administrator}=>dns server debug spoof getaddress addr=198.18.1.1
:dns server debug spoof getaddress addr=198.18.1.1
Resolved ip = 0.0.0.0.
{Administrator}=>

RELATED COMMANDS:
dns server debug spoof clear

Clear the intercept cache table

dns server debug spoof getflags

Get the error flags for the given spoofed ip

dns server debug spoof list

List the intercept cache table.

dns server debug spoof update

Update the intercept cache table.

E-DOC-CTC-20061027-0003 v2.0

195

DNS Commands

dns server debug spoof getflags
Get the error flags for the given spoofed ip

SYNTAX:
dns server debug spoof getflags

addr = 

where:
addr

The IP address of the spoofed server.

REQUIRED

EXAMPLE:
{Administrator}[dns server debug spoof]=>:dns server debug spoof getflags
addr = 192.168.1.254
:dns server debug spoof getflags addr=192.168.1.254
Invalid spoofed ip.
{Administrator}[dns server debug spoof]=>

RELATED COMMANDS:

196

dns server debug spoof clear

Clear the intercept cache table

dns server debug spoof getaddress

Get the real ip for the given spoofed ip

dns server debug spoof list

List the intercept cache table.

dns server debug spoof update

Update the intercept cache table.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server debug spoof list
List the intercept cache table.

SYNTAX:
dsn server debug spoof list

EXAMPLE:
{Administrator}[dns server debug spoof]=>list
Spoof IP
FQDN
198.18.1.1
eu.thmulti.com
198.18.1.2
thmulti.com
198.18.1.3
com
198.18.1.4
edgmd588.eu.thmulti.com
198.18.1.5
edgmssus01.eu.thmulti.com
198.18.1.6
BOULSDCEU02.eu.thmulti.com
198.18.1.7
juleke.nit

Real IP
0.0.0.0
0.0.0.0
0.0.0.0
0.0.0.0
0.0.0.0
0.0.0.0
0.0.0.0

Flags
Not resolved
Not resolved
Not resolved
Not resolved
Not resolved
Not resolved
Not resolved

RELATED COMMANDS:
dns server debug spoof clear

Clear the intercept cache table

dns server debug spoof getaddress

Get the real ip for the given spoofed ip

dns server debug spoof getflags

Get the error flags for the given spoofed ip

dns server debug spoof update

Update the intercept cache table.

E-DOC-CTC-20061027-0003 v2.0

197

DNS Commands

dns server debug spoof update
Update the intercept cache table.

SYNTAX:
dns server debug spoof update
EXAMPLE:
{Administrator}=>dns server debug spoof update
{Administrator}=>

RELATED COMMANDS:

198

dns server debug spoof clear

Clear the intercept cache table

dns server debug spoof getaddress

Get the real ip for the given spoofed ip

dns server debug spoof getflags

Get the error flags for the given spoofed ip

dns server debug spoof list

List the intercept cache table.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server host add
Add a local DNS host.

SYNTAX:
dns server host add

name = 
[addr = ]
[ttl = ]

where:
name

The name of the IP host to be added.

REQUIRED

addr

The IP address of the host.

OPTIONAL

ttl

A number between 0 and 2147483647 (seconds).
Represents the lifetime of the host.
The default is 0 (in other words, no limit on the lifetime).

OPTIONAL

EXAMPLE:
=>dns server host add name=myDNS addr=150.150.150.150 ttl=3600
=>dns server host list
Address
Hostname
TTL (s)
150.150.150.150 myDNS
3600

speedtouch
0

dsldevice
0
=>

RELATED COMMANDS:
dns server host delete

Delete a local DNS host.

dns server host list

List all the local DNS hosts.

E-DOC-CTC-20061027-0003 v2.0

199

DNS Commands

dns server host delete
Delete a local DNS host.

SYNTAX:
dns server host delete

name = 

where:
name

The name of the DNS host to be deleted.

REQUIRED

EXAMPLE:
=>dns server host list
Address
Hostname
150.150.150.150 myDNS

speedtouch

dsldevice
=>dns server host delete name=myDNS
=>dns server host list
Address
Hostname

speedtouch

dsldevice
=>

TTL (s)
3600
0
0

TTL (s)
0
0

RELATED COMMANDS:

200

dns server host add

Add a local DNS host.

dns server host list

List all the local DNS hosts.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server host flush
Flush all the local DNS hosts.

SYNTAX:
dns server host flush

EXAMPLE:
=>dns server host list
Address
Hostname
192.168.1.64
* Unknown-00-10-a4-ad-32-cf

dsldevice

speedtouch
=>dns server host flush
=>dns server host list
=>

E-DOC-CTC-20061027-0003 v2.0

TTL (s)
60
1200
1200

201

DNS Commands

dns server host list
List all the local DNS hosts.

SYNTAX:
dns server host list

EXAMPLE:
=>dns server host list
Address
Hostname
192.168.1.64
* Unknown-00-10-a4-ad-32-cf

dsldevice

speedtouch
=>

TTL (s)
60
1200
1200

RELATED COMMANDS:

202

dns server host add

Add a local DNS host.

dns server host delete

Delete a local DNS host.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server route add
Creates a DNS forwarding entry or template.

SYNTAX:
dns server route add

dns = 
[src = ]
[srcmask = ]
[domain = ]
[metric = ]
[intf = ]

where:
dns

The IP address of a DNS server. If 0.0.0.0 is used, the entry becomes a
DNS-Template which is instantiated if DNS Server IPs are configured
on an IP interface.

REQUIRED

src

The source IP address(es) using this remote DNS server. If specified,
only DNS queries from machines of which the source IP address
matches the source prefix of the DNS entry will be forwarded to the
corresponding DNS server.

OPTIONAL

Note

Supports IP/mask notation.

srcmask

The source IP address mask.

OPTIONAL

domain

The DNS Domain matching string. If configured, only those DNS
queries of which
the domain name in the query matches with the
string configured for the entry will be forwarded to the corresponding
DNS Server. Maximum string length: 62 characters.

OPTIONAL

metric

A number between 0 and 100. Represents the metric (weight factor) for
this DNS route. The DNS Entry List is sorted on DNS Metric: the lower
the metric, the higher the priority of the entry.

OPTIONAL

intf

An interface name.
The interface associated with the DNS entry or DNS Template. DNS
queries will only be forwarded on the specified interface.

OPTIONAL

Note

E-DOC-CTC-20061027-0003 v2.0

In no interface is specified, DNS queries will be forwarded on
all interfaces.

203

DNS Commands

EXAMPLE:
=>dns server route add dns=150.150.150.150 src=10.0.0.0/8 domain=myDNS intf=eth0
=>dns server route list
DNS Server
Source
Domain
Metric Intf
State
150.150.150.150 10.0.0.0/8
myDNS
0
eth0
UP
=>

RELATED COMMANDS:

204

dns server route delete

Delete a DNS forwarding route.

dns server route list

List all the DNS forwarding routes.

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server route delete
Deletes a DNS forwarding entry or template

SYNTAX:
dns server route delete

dns = 
[domain = ]
[intf = <{loop|Internet|LocalNetwork}>]

where:
dns

The IP address of the DNS server for which the forwarding route must
be deleted.

REQUIRED

domain

The DNS domain string.

OPTIONAL

intf

The interface associated with the DNS entry or DNS Template.

OPTIONAL

EXAMPLE:
=>dns server route list
DNS Server
Source
Domain
150.150.150.150 10.0.0.0/8
myDNS
=>dns server route delete dns=150.150.150.150
=>dns server route list
=>

Metric
0

Intf
eth0

State
UP

RELATED COMMANDS:
dns server route add

Adds a DNS forwarding route.

dns server route list

List all the DNS forwarding routes.

E-DOC-CTC-20061027-0003 v2.0

205

DNS Commands

dns server route flush
Removes all DNS forwarding entries and templates.

SYNTAX:
dns server route flush

EXAMPLE:
=>dns server route list
DNS Server
Source
150.150.150.150 10.0.0.0/8
=>dns server route flush
=>dns server route list
=>

206

Domain
myDNS

Metric
0

Intf
eth0

State
UP

E-DOC-CTC-20061027-0003 v2.0

DNS Commands

dns server route list
List all the DNS forwarding entries or templates.

SYNTAX:
dns server route list

EXAMPLE:
=>dns server route list
DNS Server
Source
150.150.150.150 10.0.0.0/8
=>

Domain
myDNS

Metric
0

Intf
eth0

State
UP

RELATED COMMANDS:
dns server route add

Adds a DNS forwarding route.

dns server route delete

Delete a DNS forwarding route.

E-DOC-CTC-20061027-0003 v2.0

207

DNS Commands

208

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

11 DSD Commands
Introduction
This chapter describes the commands of the dsd command group.

Contents
This chapter covers the following commands:
dsd config

Display/modify the Differentiated Service Delivery (DSD)
framework configuration.

210

dsd debug config

Display/modify DSD debug settings

211

dsd debug connection list

Display the internal connection pool usage.

212

dsd debug proxy

Display/modify the HyperText Transfer Protocol (HTTP)
Intercept fixed proxy configuration.

213

dsd debug recycling

Display/modify HTTPI recycling settings

214

dsd debug stats

Display/clear DSD framework and module statistics

215

dsd intercept config

Display/modify the HTTP Intercept configuration.

216

dsd syslog config

Display/modify the HTTP Intercept logging configuration.

217

dsd syslog list

Display the HTTP Intercept log file.

218

dsd urlfilter config

Display/modify the URL filtering configuration.

219

dsd urlfilter rule add

Add a rule.

220

dsd urlfilter rule delete

Delete a rule.

221

dsd urlfilter rule flush

Remove all current rules.

222

dsd urlfilter rule list

Display the list of current rules.

223

dsd urlfilter rule modify

Modify an existing rule.

224

E-DOC-CTC-20061027-0003 v2.0

209

DSD Commands

dsd config
Display/modify the Differentiated Service Delivery (DSD) framework configuration.

SYNTAX:
dsd config

[state = <{disabled | enabled | automatic}>]

where:
state

i

Choose between:

OPTIONAL

>

automatic (default):
By default (DSD config state is automatic), the DSD framework is
not active, for example no URL filtering or web site filtering is
applied. Only in case the state of the default WAN IP interface goes
down, DSD framework will be activated, for example in case the
PPP link goes down (implying HTTP intercept active).

>

enabled:
If DSD config state is enabled the DSD framework is always active.

>

disabled

If you do not provide any parameters, the current configuration will be shown.

EXAMPLE:
=>dsd config
State
: automatic
=>

210

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd debug config
Display/modify DSD debug settings

SYNTAX:
config

[turbomode = <{disabled|enabled}>]

where:
turbomode

E-DOC-CTC-20061027-0003 v2.0

Enable/disable turbomode

OPTIONAL

211

DSD Commands

dsd debug connection list
Display the internal connection pool usage.

SYNTAX:
dsd debug connection list

[expand = <{disabled|enabled}>]

where:
expand

212

Enable or disable the expanded listing.
The default is disabled.

optional

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd debug proxy
Display/modify the HyperText Transfer Protocol (HTTP) Intercept fixed proxy configuration.

SYNTAX:
dsd debug proxy

[state = <{disabled | enabled}>]
[dest = ]
[port = <{supported TCP/UDP port} or number>]

where:
state

Enable or disable fixed proxy redirecting.
The default is disabled.

OPTIONAL

dest

The destination IP address to which requests will be forwarded.

OPTIONAL

port

The port to be used for connecting to proxy.
Select one of the supported Transmission Control Protocol (TCP)/UDP
port names (see “ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

EXAMPLE:
=>dsd debug proxy
State
: off
Dest.IP : 0.0.0.0
Port
: 0
=>

E-DOC-CTC-20061027-0003 v2.0

213

DSD Commands

dsd debug recycling
Display/modify HTTPI recycling settings

SYNTAX:
dsd debug recycling

state = |
interval = 
httpidle = 
otheridle = 

where:

214

state

Enable/disable stream recycling

OPTIONAL

interval

Time between successive activity checks

OPTIONAL

httpidle

Minimal idle count for recycling (filtered) http streams

OPTIONAL

otheridle

Minimal idle count for recycling other streams

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd debug stats
Display/clear DSD framework and module statistics

SYNTAX:
dsd debug stats

name = <{intercept|urlfilter|recycling|syslog|all}
clear = <{no|yes}>

where:
name

Specify the name of a module

REQUIRED

clear

Clear the specified statistics

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

215

DSD Commands

dsd intercept config
Display/modify the HTTP Intercept configuration.

SYNTAX:
dsd intercept config

[WDSpoofedIP = ]
[servertimeout = ]
[servererrorurl = ]
[categoryerrorurl = ]
[monitorintercepturl = ]
[urlblockedurl = ]
[imageredirect = <{disabled | enabled}>]
[imageredirecturl = ]
[alwaysuseip = <{disabled | enabled}>]

where:
WDSpoofedIP

The IP address indicating unavailable WAN connection.
The default is 198.18.1.1.

OPTIONAL

servertimeout

A number of seconds.
Represents the server timeout for redirect action.
The default is 10.

OPTIONAL

servererrorurl

The destination URL when the connection to the server failed.

OPTIONAL

categoryerrorurl

The destination URL when the connection to the category server
failed.

OPTIONAL

monitorintercept
url

The destination URL when the request is intercepted by the
monitor thread.

OPTIONAL

urlblockedurl

The destination URL when the requested URL is blocked.

OPTIONAL

imageredirect

Enable or disable substitution of blocked images.
The default is enabled.

OPTIONAL

imageredirecturl

The URL of the image used when substituting blocked images.

OPTIONAL

alwaysuseip

Always use IP address when redirecting to a local page (enabled)
or not (disabled).
The default is enabled.

OPTIONAL

EXAMPLE:
=>dsd intercept config
WAN down spoofed IP
:
Servertimeout
:
Connection failure
:
Category server error :
Monitor intercept
:
Unauthorized request :
Image redirecting
:
Image redirect url
:
Always use IP
:
=>

216

198.18.1.1
10 sec
/cgi/b/ic/connect/
/cgi/b/ic/connect/
/cgi/b/ic/connect/
/cgi/b/sfltr/blocked/
enabled
/images/spacer.gif
enabled

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd syslog config
Display/modify the HTTP Intercept logging configuration.

SYNTAX:
dsd syslog config

[syslog = <{none | unauthorized | errors | intercepted | all}>]

where:
syslog

Define the type of events to log.
Choose between:

>
>

none: nothing is logged to syslog.

>

errors: only the HTTP requests that are blocked because of Server
errors, Category errors, Monitor intercept, loop detection, bad
requests or redirects by local policy rules.

>

intercepted: only the HTTP requests that are blocked because of
URLBlocked, Server errors, Category errors, Monitor intercept, loop
detection, bad requests or redirects by local policy rules.

>

all: every received request is logged to syslog.

OPTIONAL

unauthorized: only the HTTP requests that are blocked because of a
LocalRule, BlockCategory, BlockIPAddress or BlockObscure event,
are logged.

The default is intercepted.

EXAMPLE:
=>dsd syslog config
syslog
: errors
=>

RELATED COMMANDS:
dsd syslog list

E-DOC-CTC-20061027-0003 v2.0

Display the HTTP Intercept log file.

217

DSD Commands

dsd syslog list
Display the HTTP Intercept log file.

SYNTAX:
dsd syslog list

EXAMPLE:
=>dsd syslog list
<86> SysUpTime: 00:22:37 [HTTPI] src=10.0.0.1 src_port=1965 dst=141.11.196.35 dst_port=80 eve
nt=ServerConnect dst_name=aWebsite.com/icons/Button_Document.gif
<86> SysUpTime: 00:22:59 [HTTPI] src=10.0.0.1 src_port=1968 dst=141.11.234.60 dst_port=80 eve
nt=ServerConnect dst_name=anotherWebsite.com/rawgen.asp
=>

RELATED COMMANDS:
dsd syslog config

218

Display/modify the HTTP Intercept logging configuration.

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd urlfilter config
Display/modify the URL filtering configuration.

SYNTAX:
dsd urlfilter config

[state = <{disabled | enabled}>]
[blockproxy = <{disabled | enabled}>]
[blockipaddress = <{disabled | enabled}>]
[blockobscuredip = <{disabled | enabled}>]
[defaultaction = <{block | accept}>]

where:
state

Enable or disable URL filtering.
The default is enabled.

OPTIONAL

blockproxy

Enable or disable blocking of HTTP requests via a proxy server.
The default is disabled.

OPTIONAL

blockipaddr
ess

Enable or disable blocking of HTTP requests if host name is IP address.
The default is disabled.

OPTIONAL

blockobscur
edip

Enable or disable blocking of HTTP requests if host name is believed to
be an IP address.
The default is disabled.

OPTIONAL

defaultactio
n

Select the action to be performed when no filter is applicable.
Choose between:

OPTIONAL

>
>

block
accept.

The default is accept.

EXAMPLE:
=>dsd urlfilter config
Filter state
Block proxy traffic
Block IP addr
Block obscured IP addr
Default action
=>

E-DOC-CTC-20061027-0003 v2.0

:
:
:
:
:

enabled
disabled
disabled
disabled
accept

219

DSD Commands

dsd urlfilter rule add
Add a rule.

SYNTAX:
dsd urlfilter rule add

url = 
action = <{block | accept | redirect}>
redirect = 

where:
url

Definition of the URL filter.

REQUIRED

action

The action to perform when URL matches URL.
Choose between:

REQUIRED

>
>
>
redirect

block
accept
redirect.

The redirection URL.
Note

REQUIRED

This parameter is only required when the action is redirect.

EXAMPLE:
=>dsd urlfilter rule add url=www.speedtouch.com action=redirect redirect=www.speedtouch.be
=>dsd urlfilter rule list
Index Action
Url
Redirect
-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

Rule list statistics : 1 present, 128 total (0.0% used)
=>

RELATED COMMANDS:

220

dsd urlfilter rule delete

Delete a rule.

dsd urlfilter rule list

Display the list of current rules.

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd urlfilter rule delete
Delete a rule.

SYNTAX:
dsd urlfilter rule delete

index = 
[url = ]

where:
index

Insertion position in the list.
Tip

url

REQUIRED

Use the command :dsd urlfilter rule list to obtain
the index number of the rule to be deleted.

Definition of the URL filter.

OPTIONAL

EXAMPLE:
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

1

accept

www.baen.com

Rule list statistics : 2 present, 128 total (0.0% used)
=>dsd urlfilter rule delete index=1
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

Rule list statistics : 1 present, 128 total (0.0% used)
=>

RELATED COMMANDS:
dsd urlfilter rule add

Add a rule.

dsd urlfilter rule list

Display the list of current rules.

E-DOC-CTC-20061027-0003 v2.0

221

DSD Commands

dsd urlfilter rule flush
Remove all current rules.

SYNTAX:
dsd urlfilter rule flush

EXAMPLE:
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

1

accept

www.baen.com

Rule list statistics : 2 present, 128 total (0.0% used)
=>dsd urlfilter rule flush
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

--------

------

---

Rule list statistics : 0 present, 128 total (0.0% used)
=>

222

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

dsd urlfilter rule list
Display the list of current rules.

SYNTAX:
dsd urlfilter rule list

EXAMPLE:
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

1

accept

www.baen.com

Rule list statistics : 2 present, 128 total (0.0% used)
=>

RELATED COMMANDS:
dsd urlfilter rule add

Add a rule.

dsd urlfilter rule delete

Delete a rule.

E-DOC-CTC-20061027-0003 v2.0

223

DSD Commands

dsd urlfilter rule modify
Modify an existing rule.

SYNTAX:
dsd urlfilter rule modify

index = 
[newurl = ]
action = <{block | accept | redirect}>
redirect = 

where:
index

Insertion position in the list.

REQUIRED

newurl

Definition of the new URL filter.

OPTIONAL

action

Action to perform when URL matches URL.
Choose between:

REQUIRED

>
>
>
redirect

block
accept
redirect.

The redirection URL.
Note

224

REQUIRED

This parameter is only required when the action is redirect.

E-DOC-CTC-20061027-0003 v2.0

DSD Commands

EXAMPLE:
=>dsd urlfilter rule list
Index Action
Url

Redirect

-----

------

---

--------

0

redirect

www.speedtouch.com

www.speedtouch.be

1

accept

www.baen.com

Rule list statistics : 2 present, 128 total (0.0% used)
=>dsd urlfilter rule modify index=0 newurl=www.speed*.* action=redirect redirect=www.speedtou
ch.be
=>dsd urlfilter rule list
Index Action
Url
Redirect
-----

------

---

--------

0

redirect

www.speed*.*

www.speedtouch.be

1

accept

www.baen.com

Rule list statistics : 2 present, 128 total (0.0% used)
=>

RELATED COMMANDS:
dsd urlfilter rule add

Add a rule.

dsd urlfilter rule delete

Delete a rule.

dsd urlfilter rule list

Display the list of current rules.

E-DOC-CTC-20061027-0003 v2.0

225

DSD Commands

226

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

12 DynDNS Commands
Introduction
Dynamic DNS is a service that allows to bind a host name to an IP address. In contrast to classical DNS, this
service allows regular updates of the IP address related to a host name. In this way, hosts of which the IP
address regularly changes (for example due to a limited DHCP lease time) can be identified by a static host
name that is unique throughout the Internet.
This chapter describes the commands of the dyndns commnd group.

Contents
This chapter covers the following commands:
dyndns add

Add a dynamic DNS client.

228

dyndns delete

Delete a dynamic DNS client.

229

dyndns flush

Delete all the dynamic DNS clients.

230

dyndns list

List all the dynamic DNS clients.

231

dyndns modify

Modify a dynamic DNS client.

232

dyndns host add

Add a fully qualified host name.

234

dyndns host delete

Delete a host name.

235

dyndns host flush

Delete all hosts.

236

dyndns host list

List all host names.

237

dyndns service list

List all dynamic DNS services.

238

dyndns service modify

Modify specific dynamic DNS service settings.

240

E-DOC-CTC-20061027-0003 v2.0

227

DynDNS Commands

dyndns add
Add a dynamic DNS client.

SYNTAX:
dyndns add

name = 

where:
name

The name of the new dynamic DNS client.
Note

REQUIRED

A maximum of 5 clients can be configured.

EXAMPLE:
=>dyndns add name=WAN
=>dyndns list
WAN
: [INIT]
user =
password =
addr = 0.0.0.0
=>

RELATED COMMANDS:

228

dyndns delete

Delete a dynamic DNS client.

dyndns list

List all dynamic DNS clients.

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

dyndns delete
Delete a dynamic DNS client.

SYNTAX:
dyndns delete

name = 

where:
name

The name of the dynamic DNS client to be deleted.

REQUIRED

EXAMPLE:
=>dyndns list
WAN
: [INIT]
user =
password =
addr = 0.0.0.0
=>dyndns delete name=WAN
=>dyndns list
=>

RELATED COMMANDS:
dyndns add

Add a dynamic DNS client.

dyndns list

List all dynamic DNS clients.

E-DOC-CTC-20061027-0003 v2.0

229

DynDNS Commands

dyndns flush
Delete all the dynamic DNS clients.

SYNTAX:
dyndns flush

230

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

dyndns list
List all the dynamic DNS clients.

SYNTAX:
dyndns list

EXAMPLE:
=>dyndns list
WAN
: [INIT]
user =
password =
addr = 0.0.0.0
=>

RELATED COMMANDS:
dyndns add

Add a dynamic DNS client.

dyndns delete

Delete a dynamic DNS client.

E-DOC-CTC-20061027-0003 v2.0

231

DynDNS Commands

dyndns modify
Modify a dynamic DNS client.

SYNTAX:
dyndns modify

name = 
[intf = ]
[user = ]
[password = ]
[group = ]
[mx = ]
[backmx = <{disabled | enabled}>]
[wildcard = <{disabled | enabled}>]
[offline = <{disabled | enabled}>]
[service = <{dyndns | statdns | custom | No-IP |
DtDNS
| gnudip}>]
[status = <{disabled | enabled}>]
[trace = <{disabled | enabled}>]

where:
name

The name of the dynamic DNS client to be modified.

REQUIRED

intf

The dynamic DNS client interface.

OPTIONAL

Note
user

The username for dynamic DNS authentication.

OPTIONAL

password

The password for dynamic DNS authentication.

OPTIONAL

group

The dynamic DNS host group.

OPTIONAL

mx

The mail exchanger.

OPTIONAL

backmx

Set up the mail exchanger as a backup mail exchanger (enabled) or
not (disabled).
The default is disabled.

OPTIONAL

wildcard

Allow the use of hostname wildcards (enabled) or not (disabled).
The default is disabled.

OPTIONAL

offline

Set the host to offline mode (enabled) or not (disabled).
The default is disabled.

OPTIONAL

service

The dynamic DNS service. Choose between:

OPTIONAL

>
>
>
>
>
>

232

This parameter must be defined to enable the dynamic DNS
client.

dyndns
statdns
custom
No-IP
DtDNS
gnudip.

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

status

Enable or disable the dynamic DNS client.
The default is disabled.

OPTIONAL

trace

Enable or disable the verbose console logging for the dynamic DNS
client.
The default is disabled.

OPTIONAL

EXAMPLE:
=>dyndns list
WAN
: [INIT]
user =
password =
addr = 0.0.0.0
=>dyndns modify name=WAN intf=RtPPPoE user=DNSuser password=_DEV_BA8C0C963BD84130 service=gnu
dip
=>dyndns list
WAN
: RtPPPoE_ppp [INIT]
options = gnudip
user = my_DNS_user password = ********
addr = 0.0.0.0
=>

E-DOC-CTC-20061027-0003 v2.0

233

DynDNS Commands

dyndns host add
Add a fully qualified host name.

SYNTAX:
dyndns host add

group = 
name = 

where:
group

The dynamic DNS host group.
Note

name

A maximum of 4 different groups can be created.

The name of an IP host to add.
Note

REQUIRED

REQUIRED

A maximum of 20 hosts can be configured.

EXAMPLE:
=>dyndns host add group=local name=localhost.com
=>dyndns host list
local :
[ ] localhost.com
legend :
[ ] not initialised
[v] update successful
=>

[o]
[x]

update in progress
error

RELATED COMMANDS:

234

dyndns host delete

Delete a host name.

dyndns host list

List all host names.

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

dyndns host delete
Delete a host name.

SYNTAX:
dyndns host delete

name = 

where:
name

The name of the IP host to be deleted.

REQUIRED

EXAMPLE:
=>dyndns host list
local :
[ ] localhost.com
public :
[ ] publichost.com
legend :
[ ] not initialised
[o] update in progress
[v] update successful
[x] error
=>dyndns host delete name=publichost.com
=>dyndns host list
local :
[ ] localhost.com
legend :
[ ] not initialised
[v] update successful
=>

[o]
[x]

update in progress
error

RELATED COMMANDS:
dyndns host add

Add a fully qualified host name.

dyndns host list

List all host names.

E-DOC-CTC-20061027-0003 v2.0

235

DynDNS Commands

dyndns host flush
Delete all hosts.

i

The hosts cannot be flushed, if there is still a group referenced to the hosts.

SYNTAX:
dyndns host flush

236

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

dyndns host list
List all host names.

SYNTAX:
dyndns host list

EXAMPLE:
=>dyndns host list
local :
[ ] localhost.com
public :
[ ] publichost.com
legend :
[ ] not initialised
[v] update successful
=>

[o]
[x]

update in progress
error

RELATED COMMANDS:
dyndns host add

Add a fully qualified host name.

dyndns host delete

Delete a host name.

E-DOC-CTC-20061027-0003 v2.0

237

DynDNS Commands

dyndns service list
List all dynamic DNS services.

SYNTAX:
dyndns service list

EXAMPLE:
=>dyndns service list
dyndns
:
server
=
port
=
request
=
update interval =
retry interval =
max retry
=

members.dyndns.org
80
/nic/update
2097120
30
3

statdns
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

members.dyndns.org
80
/nic/update
0
30
3

custom
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

members.dyndns.org
80
/nic/update
0
30
3

No-IP
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

dynupdate.no-ip.com
80
/ducupdate.php
86400
30
3

=
=
=
=
=
=

dtdns.com
80
/api/autodns.cfm
86400
30
3

DtDNS
:
server
port
request
update interval
retry interval
max retry
=>

238

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

RELATED COMMANDS:
dyndns service modify

E-DOC-CTC-20061027-0003 v2.0

Modify specific dynamic DNS service settings.

239

DynDNS Commands

dyndns service modify
Modify specific dynamic DNS service settings.

SYNTAX:
dyndns service modify

name = 
[server = ]
[port = <{supported TCP/UDP port name} or number>]
[request = ]
[updateinterval = ]
[retryinterval = ]

where:
name

>
>
>
>
>
>

dyndns
statdns
custom
No-IP
DtDNS
gnudip.

server

The hostname of the dynamic DNS server.

OPTIONAL

port

The port of the dynamic DNS server.
Select one of the supported TCP/UDP port names (see “ Supported
TCP/UDP Port Names” on page 747) or, alternatively, specify the port
number.

OPTIONAL

request

The dynamic DNS request string.

OPTIONAL

updateinterval

A number between 0 and 2097120 (seconds).
Represents the time interval before a dynamic update is sent to the
dynamic DNS server.

OPTIONAL

Note
retryinterval

max_retry

The value 0 means disabled.

A number between 0 and 600 (seconds).
Represents the interval between retries if communication with the
dynamic DNS server fails.
The default is 30.
Note

240

REQUIRED

The name of the dynamic DNS service.
Choose between:

OPTIONAL

The value 0 means disabled.

A number between 1 and 5.
Represents the maximum number of retries if communication with
the dynamic DNS server fails.
The default is 3.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

DynDNS Commands

EXAMPLE:
=>dyndns service modify name=custom server=mydyndns.org port=www-http request=hereiam
| updateinterval=2000000 retryinterval=15 max_retry=5
=>dyndns service list
dyndns
:
server
= members.dyndns.org
port
= 80
request
= /nic/update
update interval = 2097120
retry interval = 30
max retry
= 3

statdns
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

members.dyndns.org
80
/nic/update
0
30
3

custom
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

mydyndns.org
80
hereiam
2000000
15
5

No-IP
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

dynupdate.no-ip.com
80
/ducupdate.php
86400
30
3

DtDNS
:
server
port
request
update interval
retry interval
max retry

=
=
=
=
=
=

dtdns.com
80
/api/autodns.cfm
86400
30
3

=>

RELATED COMMANDS:
dyndns service list

E-DOC-CTC-20061027-0003 v2.0

List all dynamic DNS services.

241

DynDNS Commands

242

E-DOC-CTC-20061027-0003 v2.0

Env Commands

13 Env Commands
Introduction
This chapter describes the commands of the env command group.

Contents
This chapter covers the following commands:
env flush

Flush all the non-system environment variables.

244

env get

Get the current value of an environment variable.

245

env list

Show all the currently available environment variables.

246

env set

Set an environment variable.

247

env unset

Delete a environment variable.

248

E-DOC-CTC-20061027-0003 v2.0

243

Env Commands
env flush
Flush all the non-system environment variables.

SYNTAX:
env flush

244

E-DOC-CTC-20061027-0003 v2.0

Env Commands
env get
Get the current value of an environment variable.

SYNTAX:
env get

var = 

where:
var

The name of the environment variable.
Tip

REQUIRED

Use the command :env list to obtain a list of all environment variables.

RELATED COMMANDS:
env list

E-DOC-CTC-20061027-0003 v2.0

List all current environment variables.

245

Env Commands

env list
Show all the currently available environment variables.

SYNTAX:
env list

RELATED COMMANDS:
env get

246

Get the current value of an environment variable.

E-DOC-CTC-20061027-0003 v2.0

Env Commands

env set
Set an environment variable.

SYNTAX:
env set

var = 
value = 

where:
var

The name of the environment variable.
Tip

REQUIRED

When creating an environment variable, any name is
allowed.
However spaces are NOT allowed and the name may NOT
start with:

>
>
>
>
value

“CONF”
“HOST”
an underscore “_”
the dollar sign “$”.

A quoted translated string which defines the value of the environment
variable.
Note

REQUIRED

The value of system variables (built-in variables with names
starting with an underscore “_”, “CONF” or “HOST”) cannot
be changed.

EXAMPLE:
For infinite TELNET time out, set the value of the variable SESSIONTIMEOUT to “0”:
=>env set var=SESSIONTIMEOUT value=0
=>

RELATED COMMANDS:
env unset

E-DOC-CTC-20061027-0003 v2.0

Delete a non-system environment variable.

247

Env Commands

env unset
Delete a environment variable.

SYNTAX:
env unset

var = 

where:
var

The name of the environment variable to be deleted.
Note

REQUIRED

System variables (built-in variables with names starting with
an underscore “_”, “CONF” or “HOST”) cannot be unset,
changed or deleted.

EXAMPLE:
=>env list
_COMPANY_NAME=THOMSON multimedia
_COMPANY_URL=http://www.speedtouch.com
_PROD_NAME=SpeedTouch
.....
CONF_DATE=March 2004
CONF_REGION=World
HOST_SETUP=user
=>env unset var=CONF_REGION
=>env list
_COMPANY_NAME=THOMSON multimedia
_COMPANY_URL=http://www.speedtouch.com
_PROD_NAME=SpeedTouch
.....
CONF_DATE=March 2004
HOST_SETUP=user
=>

RELATED COMMANDS:
env set

248

Create and set a non-system environment variable.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

14 Eth Commands
Introduction
This chapter describes the commands of the eth command group.

Contents
This chapter covers the following commands:
eth ifadd

Create a new ETH interface.

252

eth ifattach

Attach an ETH interface.

253

eth ifconfig

Modify an ETH interface.

254

eth ifdelete

Delete an ETH interface.

255

eth ifdetach

Detach an ETH interface.

256

eth iflist

Display the ETH interfaces.

257

eth flush

Flush all the ETH interfaces.

258

eth bridge clear

Clear the bridge statistics.

259

eth bridge list

Display the current bridge instances.

260

eth bridge add

Add a new bridge instance.

261

eth bridge delete

Delete a bridge instance.

262

eth bridge select

Select the default bridge to configure interfaces .

263

eth bridge config

Modify/display the bridge configuration settings.

264

eth bridge dynvlan actlist

Display the active MAC entries for the dynamic
VLAN membership.

265

eth bridge dynvlan add

Add a dynamic VLAN membership entry.

266

eth bridge dynvlan config

Modify the dynamic VLAN membership
configuration.

267

eth bridge dynvlan delete

Delete a dynamic VLAN membership entry.

268

eth bridge dynvlan flush

Flush all dynamic VLAN membership entries.

269

eth bridge dynvlan list

Delete a dynamic VLAN membership entry.

268

eth bridge flush

Flush bridge interfaces and parameters.

271

eth bridge ifadd

Add a new bridge interface.

272

eth bridge ifattach

Attach a bridge interface.

273

eth bridge ifconfig

Modify a bridge interface configuration.

274

eth bridge ifdelete

Delete a bridge interface.

276

eth bridge ifdetach

Detach a bridge interface.

277

eth bridge iflist

Display the current bridge interfaces.

278

eth bridge ifflush

Flush the bridge interfaces

279

eth bridge igmpsnooping config

Configure the bridge instance‘s IGMP Snooping
flags

280

eth bridge igmpsnooping list

Display a bridge instance‘s snooped groups

281

E-DOC-CTC-20061027-0003 v2.0

249

Eth Commands

250

eth bridge igmpsnooping ifconfig

Configure the bridge interface‘s IGMP snooping
flags and mode

282

eth bridge igmpsnooping iflist

Display a bridge interface‘s IGMP status

283

eth bridge igmpsnooping clear

Clear the snooping statistics

284

eth bridge macadd

Add a static MAC address to a bridge interface.

285

eth bridge macdelete

Remove a MAC address from the filtering database.

287

eth bridge maclist

Display the MAC address database.

289

eth bridge rule add

Add a new constraint to the VLAN learning system.

293

eth bridge rule delete

Delete a constraint from the VLAN learning system.

294

eth bridge rule flush

Flush all constraints from the VLAN learning system.

295

eth bridge rule list

Display all constraints from the VLAN learning
system.

296

eth bridge vlan ifadd

Add a bridge interface to a VLAN.

297

eth bridge vlan ifconfig

Modify a bridge interface from a VLAN.

298

eth bridge vlan ifdelete

Delete a bridge interface from a VLAN.

299

eth bridge vlan iflist

Display all VLANs.

300

eth device ifconfig

Configure an Ethernet interface.

301

eth device iflist

Show status of Ethernet interfaces.

303

eth switch group flush

Set all the ports to the default settings.

304

eth switch group list

List all the configured switch groups.

305

eth switch group move

Move a specified port to a specified switch group.

306

eth switch mirror capture

Define the specified port to be the Mirror Capture
Port.

307

eth switch mirror egress

Enable or disable the specified port to be the Mirror
Egress Port.

308

eth switch mirror ingress

Enable or disable the specified port to be the Mirror
Ingress Port.

309

eth switch share add

Add a port to be shared.

310

eth switch share delete

Delete a shared port.

311

eth switch share list

Display shared ports.

312

eth switch info

Display switch capabilities.

313

eth switch qos config

Configure common qos parameters.

314

eth switch qos ifconfig

Configure per port QoS parameters.

315

eth switch qos list

Display QoS configuration.

316

eth switch qos weights

Configure the queue weights.

317

eth switch shaper config

Configure common ingress shaper parameters.

318

eth switch shaper ifconfig

Configure per port shaper parameters.

319

eth switch shaper iflist

Display shaper configuration per port.

320

eth switch storm ifconfig

Configure per port storm control parameters.

321

eth switch storm iflist

Display storm control configuration per port.

322

eth vlan add

Add a new VLAN.

323

eth vlan delete

Delete a VLAN.

324

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth vlan flush

Flush all VLANs.

325

eth vlan list

Display all VLANs.

326

E-DOC-CTC-20061027-0003 v2.0

251

Eth Commands

eth ifadd
Create a new ETH interface.

SYNTAX:
eth ifadd

intf = 

where:
intf

The name of the new ETH interface.

REQUIRED

RELATED COMMANDS:

252

eth ifdelete

Delete an ETH interface.

eth iflist

Display the ETH interfaces.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth ifattach
Attach an ETH interface.

SYNTAX:
eth ifattach

intf = 

where:
intf

The name of the ETH interface to be attached.

REQUIRED

RELATED COMMANDS:
eth ifdetach

E-DOC-CTC-20061027-0003 v2.0

Detach an ETH interface.

253

Eth Commands

eth ifconfig
Modify an ETH interface.

SYNTAX:
eth ifconfig

intf = 
[dest = ]
[retry = ]
[vlan = ]

where:

254

intf

The name of the ETH interface to be configured.

REQUIRED

dest

The destination interface for this ETH interface.

OPTIONAL

retry

A number between 0 and 65535.
Represents the number of times the ETH connection setup
should retry before giving up.
The default is 10.

OPTIONAL

vlan

The Virtual Local Area Network (VLAN) for this ETH interface.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth ifdelete
Delete an ETH interface.

SYNTAX:
eth ifdelete

intf = 

where:
intf

The name of the ETH interface name to be deleted.

REQUIRED

RELATED COMMANDS:
eth ifadd

Create a new ETH interface.

eth iflist

Display the ETH interfaces.

E-DOC-CTC-20061027-0003 v2.0

255

Eth Commands

eth ifdetach
Detach an ETH interface.

SYNTAX:
eth ifdetach

intf = 

where:
intf

The name of the ETH interface to be detached.

REQUIRED

RELATED COMMANDS:
eth ifattach

256

Attach an ETH interface.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth iflist
Display the ETH interfaces.

SYNTAX:
eth iflist

[intf = ]
[string = ]
[beginstring = ]

where:
intf

The name of the ETH interface to be displayed.
Note

OPTIONAL

If not specified, all the ETH interfaces will be displayed.

string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

RELATED COMMANDS:
eth ifadd

Create a new ETH interface.

eth ifdelete

Delete an ETH interface.

E-DOC-CTC-20061027-0003 v2.0

257

Eth Commands

eth flush
Flush all the ETH interfaces.

i

The flush command does not impact previously saved configurations.

SYNTAX:
eth flush

258

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge clear
Clear the bridge statistics.

SYNTAX:
eth bridge clear

E-DOC-CTC-20061027-0003 v2.0

259

Eth Commands

eth bridge list
Display the current bridge instances

Syntax
eth bridge list

[brname = <{bridge}>]
[string = ]
[beginstring = ]

where

260

brname

The name of a bridge instance

OPTIONAL

string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge add
Add a new bridge instance

Syntax
eth bridge add

brname=

where
brname

E-DOC-CTC-20061027-0003 v2.0

The name of the new bridge instance

REQUIRED

261

Eth Commands

eth bridge delete
Delete a bridge instance

Syntax
eth bridge delete

brname = <{bridge}>

where
brname

262

The name of the bridge instance to be deleted

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge select
Select the default bridge to configure interfaces (when not setting a bridge name, for legacy purposes).

Syntax
eth bridge select

brname = <{bridge}>

where
brname

E-DOC-CTC-20061027-0003 v2.0

The name of a bridge instance

REQUIRED

263

Eth Commands

eth bridge config
Modify/display the bridge configuration settings.

SYNTAX:
eth bridge config

[brname = <{bridge}>]
[age = ]
[filter = <{no_WAN_broadcast | none}>]
[vlan = <{disabled | enabled}>]
[precedencemap = ]

where:
brname

The name of a bridge instance

age

A number between 10 and 100000 (seconds).
Represents the lifetime of a dynamically learned Medium Access
Control (MAC) address.
The default is 300.

OPTIONAL

filter

The bridge filter to be applied for all Wide Area Network (WAN)
bridge ports.
Choose between:

OPTIONAL

>

no_WAN_broadcast: broadcasts from the Thomson ST itself
to the WAN are filtered out, broadcasts from the LAN to the
WAN are still passed through

>

none: no broadcasts are filtered out.

The default is no_WAN_broadcast.

264

vlan

Enable or disable the use of the VLAN ID of the received VLAN
packets.
The default is enabled.

OPTIONAL

precedencemap

The IP QoS precedence mapping table

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge dynvlan actlist
Display the active MAC entries for the dynamic VLAN membership.

SYNTAX:
eth bridge dynvlan actlist

RELATED COMMANDS:
eth bridge dynvlan add

Add a dynamic VLAN membership entry.

eth bridge dynvlan config

Modify the dynamic VLAN membership configuration.

eth bridge dynvlan delete

Delete a dynamic VLAN membership entry.

eth bridge dynvlan list

Display a dynamic VLAN membership entry.

E-DOC-CTC-20061027-0003 v2.0

265

Eth Commands

eth bridge dynvlan add
Add a dynamic VLAN membership entry.

SYNTAX:
eth bridge dynvlan add

[id = ]
hwaddr = 
vlan = 
[remvlan = <{default}>]

where:
id

A number between 0 and 100000.
Represents the id of the dynamic VLAN membership entry.

OPTIONAL

hwaddr

The (masked) ethernet MAC address of the dynamic VLAN
membership entry.

REQUIRED

vlan

The VLAN for the dynamic VLAN membership entry.

REQUIRED

remvlan

The VLAN that will be removed from the bridge interface.

OPTIONAL

RELATED COMMANDS:

266

eth bridge dynvlan actlist

Display the active MAC entries for the dynamic VLAN membership.

eth bridge dynvlan config

Modify the dynamic VLAN membership configuration.

eth bridge dynvlan delete

Delete a dynamic VLAN membership entry.

eth bridge dynvlan list

Display a dynamic VLAN membership entry.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge dynvlan config
Modify the dynamic VLAN membership configuration.

SYNTAX:
eth bridge dynvlan config

[timeout = ]

where:
timeout

A number between 0 and 100000 (seconds).
Represents timeout for the dynamic entries.

OPTIONAL

RELATED COMMANDS:
eth bridge dynvlan actlist

Display the active MAC entries for the dynamic VLAN membership.

eth bridge dynvlan add

Add a dynamic VLAN membership entry.

eth bridge dynvlan delete

Delete a dynamic VLAN membership entry.

eth bridge dynvlan list

Display a dynamic VLAN membership entry.

E-DOC-CTC-20061027-0003 v2.0

267

Eth Commands

eth bridge dynvlan delete
Delete a dynamic VLAN membership entry.

SYNTAX:
eth bridge dynvlan delete

id = 

where:
id

A number between 0 and 100000.
Represents the id of a dynamic VLAN membership.

REQUIRED

RELATED COMMANDS:

268

eth bridge dynvlan actlist

Display the active MAC entries for the dynamic VLAN membership.

eth bridge dynvlan add

Add a dynamic VLAN membership entry.

eth bridge dynvlan config

Modify the dynamic VLAN membership configuration.

eth bridge dynvlan list

Display a dynamic VLAN membership entry.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge dynvlan flush
Flush all dynamic VLAN membership entries.

SYNTAX:
eth bridge dynvlan flush

E-DOC-CTC-20061027-0003 v2.0

269

Eth Commands

eth bridge dynvlan list
Display a dynamic VLAN membership entry.

SYNTAX:
eth bridge dynvlan list

RELATED COMMANDS:

270

eth bridge dynvlan actlist

Display the active MAC entries for the dynamic VLAN membership.

eth bridge dynvlan add

Add a dynamic VLAN membership entry.

eth bridge dynvlan config

Modify the dynamic VLAN membership configuration.

eth bridge dynvlan delete

Delete a dynamic VLAN membership entry.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge flush
Flush bridge interfaces and parameters.

i

The flush command does not impact previously saved configurations.

SYNTAX:
eth bridge flush

E-DOC-CTC-20061027-0003 v2.0

271

Eth Commands

eth bridge ifadd
Add a new bridge interface.

SYNTAX:
eth bridge ifadd

[brname = <{bridge}>] intf = 

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the new bridge interface.

REQUIRED

RELATED COMMANDS:

272

eth bridge ifdelete

Delete a bridge interface.

eth bridge iflist

Display the current bridge interfaces.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge ifattach
Attach a bridge interface.

SYNTAX:
eth bridge ifattach

[brname = <{bridge}>] intf = 

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface to be attached.

REQUIRED

RELATED COMMANDS:
eth bridge ifdetach

E-DOC-CTC-20061027-0003 v2.0

Detach a bridge interface.

273

Eth Commands

eth bridge ifconfig
Modify a bridge interface configuration.

SYNTAX:
eth bridge ifconfig

[brname = <{bridge}>]
intf = 
[dest = ]
[portstate = <{disabled | learning |
forwarding}>]
[retry = ]
[prioconfig = <{disabled|overwrite|increase}>]
[vlan = ]
[ipprec = <{disabled|precedence|dscp}>]
[priority = ]
[regenprio = ]
[ingressfiltering = <{disabled |
enabled}>]
[acceptvlanonly = <{disabled | enabled}>]
[mcastfilter = <{disabled|enabled}>]
[dynvlan = <{disabled|enabled}>]
[igmpsnooping = <{disabled|enabled}>]

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface to be configured.

REQUIRED

dest

The destination for this interface.
Typically an ATM or a physical interface name.

OPTIONAL

portstate

The bridge portstate for this interface.
Choose between:

OPTIONAL

>
>
>

disabled
learning
forwarding.

The default is forwarding.

274

retry

A number between 0 and 65535.
Represents the number of times the Thomson ST retries to set
up a WAN connection before giving up.
The default is 10.

OPTIONAL

vlan

Select the default VLAN.

OPTIONAL

prioconfig

The priority configuration for this interface.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

ipprec

The IP precedence for this interface.
Choose between:

>
>
>

OPTIONAL

disabled
precedence
dscp.

The default is disabled.
priority

A number between 0 and 7.
Represents the default priority for tagging egress packets.
The default is 0.

OPTIONAL

regenprio

The priority regeneration table for tagged ingress packets.
The default is 01234567.

OPTIONAL

ingressfiltering

Enable/disable discard of tagged ingress packets if the interface
is not part of the VLAN.
The default is disabled.

OPTIONAL

acceptvlanonly

Enable or disable receipt of tagged ingress packets.
The default is disabled.

OPTIONAL

mcastfilter

Enable or disable the discard of multicast packets on this port
The default is disabled.

OPTIONAL

dynvlan

Enable or disable dynamic VLAN membership checking for this
interface.
The default is disabled.

OPTIONAL

igmpsnooping

Enable or disable IGMP snooping for this interface.
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

275

Eth Commands

eth bridge ifdelete
Delete a bridge interface.

SYNTAX:
eth bridge ifdelete

[brname = <{bridge}>] intf = 

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface name to be deleted.

REQUIRED

RELATED COMMANDS:

276

eth bridge ifadd

Add a new bridge interface.

eth bridge iflist

Display the current bridge interfaces.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge ifdetach
Detach a bridge interface.

SYNTAX:
eth bridge ifdetach

[brname = <{bridge}>]
intf = 

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface to be detached.

REQUIRED

RELATED COMMANDS:
eth bridge ifattach

E-DOC-CTC-20061027-0003 v2.0

Attach a bridge interface.

277

Eth Commands

eth bridge iflist
Display the current bridge interfaces.

SYNTAX:
eth bridge iflist

[brname = <{bridge}>]
[intf = ]
[string = ]
[beginstring = ]

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface to be displayed.

OPTIONAL

Note

If not specified, all bridge interfaces are shown.

string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

RELATED COMMANDS:

278

eth bridge ifadd

Add a new bridge interface.

eth bridge ifdelete

Delete a bridge interface.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge ifflush
Flush the bridge interfaces: detach/delete all interfaces.

SYNTAX:
eth bridge ifflush

[brname = <{bridge}>]

where:
brname

E-DOC-CTC-20061027-0003 v2.0

The name of a bridge instance.

OPTIONAL

279

Eth Commands

eth bridge igmpsnooping config
Configure the bridge instance‘s IGMP Snooping flags

Syntax
eth bridge igmpsnooping config

[brname = <{bridge}>]
[state = <{enabled|disabled}>]
[floodrp = <{disabled|enabled}>]
[floodmcast = <{disabled|enabled}>]

where:

280

brname

The name of a bridge instance

OPTIONAL

state

Enable/Disable the IGMP Snooping
The default is enabled

OPTIONAL

floodrp

Enable/Disable flooding reports to all ports
The default is disabled

OPTIONAL

floodmcast

Enable/Disable flooding unregistered multicasts
The default is disabled

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge igmpsnooping list
Display a bridge instance‘s snooped groups.

Syntax
eth bridge igmpsnooping list

[brname = <{bridge}>]

where:
brname

E-DOC-CTC-20061027-0003 v2.0

The name of a bridge instance

OPTIONAL

281

Eth Commands

eth bridge igmpsnooping ifconfig
Configure the bridge interface‘s IGMP snooping flags and mode.

Syntax
eth bridge igmpsnooping ifconfig

[brname = <{bridge}>]
intf = <{interface}>
[portmode = <{Host|Router|Auto}>]
[fastleave = <{disabled|enabled}>]
[exptrack = <{disabled|enabled}>]
[mrdp = <{disabled|enabled}>]
[rgmp = <{disabled|enabled}>]

where:

282

brname

The bridge instance currently to be configured

OPTIONAL

intf

The bridge interface currently to be configured

REQUIRED

portmode

Mode of the bridge port

OPTIONAL

fastleave

Enable/Disable Fast Immediate Leave

OPTIONAL

exptrack

Enable/Disable Explicit Host Tracking

OPTIONAL

mrdp

Enable/Disable MRDP support

OPTIONAL

rgmp

Enable/Disable RGMP support

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge igmpsnooping iflist
Display a bridge interface‘s IGMP status

Syntax
Display bridge interface IGMP status

[brname = <{bridge}>]
[intf = <{interface}>]

where:
brname

The name of a bridge instance

OPTIONAL

intf

The name of the bridge interface

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

283

Eth Commands

eth bridge igmpsnooping clear
Clear the snooping statistics.

Syntax
eth bridge igmpsnooping clear

[brname = <{bridge}>]
[intf = <{interface}>]

where:

284

brname

The name of a bridge instance

OPTIONAL

intf

The name of the bridge interface

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge macadd
Add a static MAC address to a bridge interface.
This command allows to manually add static MAC addresses, which should normally be dynamically
discovered by the bridge itself.

SYNTAX:
eth bridge macadd

[brname = <{bridge}>]
intf = 
hwaddr = 
[vlan = ]

where:
brname

The name of a bridge instance.

OPTIONAL

intf

The name of the bridge interface to which the MAC address must
be added.

REQUIRED

hwaddr

The Ethernet MAC address of the new entry.

REQUIRED

vlan

The VLAN.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

285

Eth Commands

EXAMPLE:
=>eth bridge maclist
00:10:a4:ad:32:cf -- dynamic, ethport1, 300 seconds
00:90:d0:8b:fc:2c -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
...
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>eth bridge macadd intf=ethport2 hwaddr=00:80:9f:01:23:45
=>eth bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1, 300 seconds
00:80:9f:01:23:45 -- static
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>

RELATED COMMANDS:

286

eth bridge macdelete

Remove a MAC address from the filtering database.

eth bridge maclist

Display the MAC address database.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge macdelete
Remove a MAC address from the filtering database.

SYNTAX:
eth bridge macdelete

[brname = <{bridge}>]
hwaddr = 
[vlan = ]

where:
brname

The name of a bridge instance.

OPTIONAL

hwaddr

The Ethernet MAC address of the entry to be deleted.

REQUIRED

vlan

The VLAN.

OPTIONAL

EXAMPLE:
=>eth bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1
00:80:9f:01:23:45 -- static
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
...
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>eth bridge macdelete hwaddr=00:80:9f:01:23:45
=>eth bridge maclist
00:0d:9d:47:dd:aa -- dynamic, ethport1
00:90:d0:72:88:64 -- permanent
01:00:5e:00:00:67 -- static
01:00:5e:7f:ff:fa -- static
01:80:c2:00:00:00 -- permanent
01:80:c2:00:00:01 -- permanent
01:80:c2:00:00:02 -- permanent
01:80:c2:00:00:03 -- permanent
01:80:c2:00:00:0e -- permanent
01:80:c2:00:00:0f -- permanent
01:80:c2:00:00:10 -- permanent
ff:ff:ff:ff:ff:ff -- permanent
=>

E-DOC-CTC-20061027-0003 v2.0

287

Eth Commands

RELATED COMMANDS:

288

eth bridge macadd

Add a static MAC address to a bridge interface.

eth bridge maclist

Display the MAC address database.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge maclist
Display the MAC address database.

SYNTAX:
eth bridge maclist

[brname = <{bridge}>]

where:
brname

The name of a bridge instance.

OPTIONAL

EXAMPLE:
=>eth bridge maclist
00:0d:9d:47:dd:aa -00:90:d0:72:88:64 -01:00:5e:00:00:67 -01:00:5e:7f:ff:fa -01:80:c2:00:00:00 -01:80:c2:00:00:01 -01:80:c2:00:00:02 -01:80:c2:00:00:03 -01:80:c2:00:00:04 -01:80:c2:00:00:05 -01:80:c2:00:00:06 -01:80:c2:00:00:07 -01:80:c2:00:00:08 -01:80:c2:00:00:09 -01:80:c2:00:00:0a -01:80:c2:00:00:0b -01:80:c2:00:00:0c -01:80:c2:00:00:0d -01:80:c2:00:00:0e -01:80:c2:00:00:0f -01:80:c2:00:00:10 -ff:ff:ff:ff:ff:ff -=>

dynamic, ethport1, 300 seconds
permanent
static
static
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent
permanent

RELATED COMMANDS:
eth bridge macadd

Add a static MAC address to a bridge interface.

eth bridge macdelete

Remove a MAC address from the filtering database.

E-DOC-CTC-20061027-0003 v2.0

289

Eth Commands

eth bridge mcdadd
Add a multicast group to be dropped to the database.

SYNTAX:
eth bridge mcdadd

[brname = <{bridge}>]
srcintfs = 
dstintfs = 

where:
brname

The name of a bridge instance.

OPTIONAL

srcports

The source bridge interfaces from which multicast packets must
be dropped.

REQUIRED

dstports

The destination bridge interfaces for which the multicast packets
must be dropped.

REQUIRED

RELATED COMMANDS:

290

eth bridge mcddelete

Delete a multicast group to be dropped from the database.

eth bridge mcdlist

Display the multicast group to be dropped from the database.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge mcddelete
Delete a multicast group to be dropped from the database.

SYNTAX:
eth bridge mcddelete

[brname = <{bridge}>]

where:
brname

The name of a bridge instance.

OPTIONAL

RELATED COMMANDS:
eth bridge mcdadd

Add a multicast group to be dropped to the database.

eth bridge mcdlist

Display the multicast group to be dropped from the database.

E-DOC-CTC-20061027-0003 v2.0

291

Eth Commands

eth bridge mcdlist
Display the multicast group to be dropped from the database.

SYNTAX:
eth bridge mcdlist

RELATED COMMANDS:

292

eth bridge mcdadd

Add a multicast group to be dropped to the database.

eth bridge mcddelete

Delete a multicast group to be dropped from the database.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge rule add
Add a new constraint to the VLAN learning system.

SYNTAX:
eth bridge rule add

type =
vlan =
[vlan2
[isi =

<{shared | independent}>

= ]
]

where:
type

Type of constraint.
Choose between:

>
>

REQUIRED

shared
independent.

vlan

The VLAN to which the constraint belongs.

REQUIRED

vlan2

The second VLAN for a shared constraint.

OPTIONAL

Note
isi

This parameter is required when type is shared.

A number between 0 and 32.
Represents the Independent Set ID (ISI) for an independent
constraint.
Note

OPTIONAL

This parameter is required when type is independent.

EXAMPLE:
=>eth bridge rule add type=independant vlan=default isi=1
=>eth bridge rule list
Index
Type
VLAN
Parameter
------------------1
independant default
Independent set identifier: 1
=>

RELATED COMMANDS:
eth bridge rule delete

Delete a constraint from the VLAN learning system.

eth bridge rule list

Display all constraints from the VLAN learning system.

E-DOC-CTC-20061027-0003 v2.0

293

Eth Commands

eth bridge rule delete
Delete a constraint from the VLAN learning system.

SYNTAX:
eth bridge rule delete

index = 

where:
index

Index of the constraint to be deleted.
Tip

REQUIRED

Use the command :eth bridge rule list to
obtain a list of the indexes of the constraints.

EXAMPLE:
=>eth bridge rule list
Index
Type
VLAN
----------1
independant default
=>eth bridge rule delete index=1
=>eth bridge rule list
Index
Type
VLAN
----------=>

Parameter
--------Independent set identifier: 1

Parameter
---------

RELATED COMMANDS:

294

eth bridge rule add

Add a new constraint to the VLAN learning system.

eth bridge rule list

Display all constraints from the VLAN learning system.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge rule flush
Flush all constraints from the VLAN learning system.

SYNTAX:
eth bridge rule flush

E-DOC-CTC-20061027-0003 v2.0

295

Eth Commands

eth bridge rule list
Display all constraints from the VLAN learning system.

SYNTAX:
eth bridge rule list

EXAMPLE:
=>eth bridge rule list
Index
Type
VLAN
----------1
independant default
=>

Parameter
--------Independent set identifier: 1

RELATED COMMANDS:

296

eth bridge rule add

Add a new constraint to the VLAN learning system.

eth bridge rule delete

Delete a constraint from the VLAN learning system.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge vlan ifadd
Add a bridge interface to a VLAN.

SYNTAX:
eth bridge vlan ifadd

name = 
intf = 
[untagged = <{disabled | enabled}>]

where:
name

The VLAN name to which a bridge interface must be added.

REQUIRED

intf

The name of the bridge interface to be added to the VLAN.

REQUIRED

untagged

Enable or disable the interface as untagged for this VLAN.
The default is disabled.

OPTIONAL

RELATED COMMANDS:
eth bridge vlan ifconfig

Modify a bridge interface from a VLAN.

eth bridge vlan ifdelete

Delete a bridge interface from a VLAN.

eth bridge vlan iflist

Display all VLANs.

E-DOC-CTC-20061027-0003 v2.0

297

Eth Commands

eth bridge vlan ifconfig
Modify a bridge interface from a VLAN.

SYNTAX:
eth bridge vlan ifconfig

name = 
intf = 
untagged = <{disabled | enabled}>

where:
name

The VLAN name for which a bridge interface must be modified.

REQUIRED

intf

The name of the bridge interface to be modified.

REQUIRED

untagged

Enable or disable the interface as untagged for this VLAN.

REQUIRED

RELATED COMMANDS:

298

eth bridge vlan ifadd

Add a bridge interface to a VLAN.

eth bridge vlan ifdelete

Delete a bridge interface from a VLAN.

eth bridge vlan iflist

Display all VLANs.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth bridge vlan ifdelete
Delete a bridge interface from a VLAN.

SYNTAX:
eth bridge vlan ifdelete

name = 
intf = 

where:
name

The VLAN name for which a bridge interface must be deleted.

REQUIRED

intf

The name of the bridge interface to be deleted.

REQUIRED

RELATED COMMANDS:
eth bridge vlan ifadd

Add a bridge interface to a VLAN.

eth bridge vlan ifconfig

Modify a bridge interface from a VLAN.

eth bridge vlan iflist

Display all VLANs.

E-DOC-CTC-20061027-0003 v2.0

299

Eth Commands

eth bridge vlan iflist
Display all VLANs.

SYNTAX:
eth bridge vlan iflist

RELATED COMMANDS:

300

eth bridge vlan ifadd

Add a bridge interface to a VLAN.

eth bridge vlan ifconfig

Modify a bridge interface from a VLAN.

eth bridge vlan ifdelete

Delete a bridge interface from a VLAN.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth device ifconfig
Configure an Ethernet interface.

SYNTAX:
eth device ifconfig

intf = 
[type = <{auto | 10BaseTHD | 10BaseTFD |
100BaseTHD| 100BaseTFD} or number>]
[state = <{enabled | disabled}>]

where:
intf

The name of a physical interface.

REQUIRED

type

The Ethernet type.
Select either:

OPTIONAL

>

auto: Auto negotiation of Ethernet communication speed
(10Mb/s or 100Mb/s) and Duplex mode (half duplex or full
duplex).

>

10BaseTHD: 10Mb/s communication speed in half duplex
mode.

>

10BaseTFD: 10Mb/s communication speed in full duplex
mode.

>

100BaseTHD: 100Mb/s communication speed in half duplex
mode.

>

100BaseTFD: 100Mb/s communication speed in full duplex
mode.

or enter a number between 0 (auto) and 5 (100BaseTFD).
The default is auto.
Note
state

E-DOC-CTC-20061027-0003 v2.0

This value should never be changed, except in case of
communication problems.

Enable or disable the interface.
The default is enabled.

OPTIONAL

301

Eth Commands

EXAMPLE:
=>eth device iflist
Interface
Type
Result
State
ethif1
auto
100BaseTFD
UP [forwarding]
ethif2
auto
100BaseTFD
UP [forwarding]
ethif3
auto
100BaseTFD
UP [forwarding]
ethif4
auto
100BaseTFD
UP [forwarding]
usbif1
UP [forwarding]
=>eth device ifconfig intf=ethif4 state=disabled
=>eth device iflist
Interface
Type
Result
State
ethif1
auto
100BaseTFD
UP [forwarding]
ethif2
auto
100BaseTFD
UP [forwarding]
ethif3
auto
100BaseTFD
UP [forwarding]
ethif4
auto
100BaseTFD
DOWN [disabled]
usbif1
UP [forwarding]
=>

RELATED COMMANDS:
eth device iflist

302

Show status of Ethernet interfaces.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth device iflist
Show status of Ethernet interfaces.

SYNTAX:
eth device iflist

EXAMPLE:
=>eth device iflist
Interface
Type
ethif1
auto
ethif2
auto
ethif3
auto
ethif4
auto
usbif1
wlif1
wlif2
wlif3
wlif4
wlif5
=>

Result
100BaseTFD
100BaseTFD
100BaseTFD
100BaseTFD

State
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]
UP [forwarding]

DESCRIPTION:
> Type: Indicates the configured Ethernet communication speed and duplex mode.
> Result : Indicates the effective operating status if Type equals “auto”. In other cases, when the Ethernet
types do NOT match, Result Type will equal “unknown” and no Ethernet connectivity will exist.

RELATED COMMANDS:
eth device ifconfig

E-DOC-CTC-20061027-0003 v2.0

Configure an Ethernet interface.

303

Eth Commands

eth switch group flush
Set all the ports to the default settings.
All the ports are placed in group 0.

SYNTAX:
eth switch group flush

EXAMPLE:
=>eth
Group
Group
Group
=>eth
=>eth
Group
=>

switch group
0 Ports: 4
1 Ports: 1
2 Ports: 2 3
switch group
switch group
0 Ports: 1 2

list

flush
list
3 4

RELATED COMMANDS:
eth switch group list

List all the configured switch groups.

eth switch group move

Move a specified port to a specified switch group.

304

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch group list
List all the configured switch groups.

SYNTAX:
eth switch group list

EXAMPLE:
=>eth
Group
Group
Group
=>

switch group list
0 Ports: 4
1 Ports: 1
2 Ports: 2 3

RELATED COMMANDS:
eth switch group flush

Set all the ports to the default settings.

eth switch group move

Move a specified port to a specified switch group.

E-DOC-CTC-20061027-0003 v2.0

305

Eth Commands

eth switch group move
Move a specified port to a specified switch group.

SYNTAX:
eth switch group move

group = 
port = 

where:
group

A number between 0 and 4.
Represents the group ID to which the port must be moved.

REQUIRED

port

A number between 01 and 4.
Represents the port to be moved.

REQUIRED

EXAMPLE:
=>eth
Group
=>eth
=>eth
Group
Group
=>

switch group
0 Ports: 1 2
switch group
switch group
0 Ports: 2 3
3 Ports: 1

list
3 4
move group=3 port=1
list
4

RELATED COMMANDS:

306

eth switch group flush

Set all the ports to the default settings.

eth switch group list

List all the configured switch groups.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch mirror capture
Define the specified port to be the Mirror Capture Port.

i

Only one port can be the Mirror Capture Port at any one time.

SYNTAX:
eth switch mirror capture

port = 

where:
port

The port to be the Mirror Capture Port.
Note

REQUIRED

If no port number is specified, then the port number of
the Mirror Capture Port is shown.

EXAMPLE:
=>eth switch mirror capture port=2
=>eth switch mirror capture
Mirror capture port = 2
=>

RELATED COMMANDS:
eth switch mirror egress

Enable or disable the specified port to be the Mirror Egress Port.

eth switch mirror ingress

Enable or disable the specified port to be the Mirror Ingress Port.

E-DOC-CTC-20061027-0003 v2.0

307

Eth Commands

eth switch mirror egress
Enable or disable the specified port to be the Mirror Egress Port.
Only one port can be the Mirror Egress Port at any one time.
But a port can be the Mirror Egress Port and the
Mirror Ingress Port at the same time.

i

SYNTAX:
eth switch mirror egress

port = 
[state = <{enabled | disabled}>]

where:
port

The port to be the Mirror Egress Port.
Note

state

REQUIRED

If no port number is specified, then the port number of
the current Mirror Egress Port is shown.

Enable or disable the port as Mirror Egress Port.
The default is enabled.

OPTIONAL

EXAMPLE:
Here port 1 is enabled as Mirror Egress Port
=>eth switch mirror egress port=1
=>eth switch mirror egress
Egress mirror port = 1
=>

Here port 1 is disabled as Mirror Egress Port
=>eth switch mirror egress
Egress mirror port = 1
=>eth switch mirror egress port=1 state=disabled
=>eth switch mirror egress
=>

RELATED COMMANDS:

308

eth switch mirror capture

Define the specified port to be the Mirror Capture Port.

eth switch mirror ingress

Enable or disable the specified port to be the Mirror Ingress Port.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch mirror ingress
Enable or disable the specified port to be the Mirror Ingress Port.
Only one port can be the Mirror Ingress Port at any one time.
But a port can be the Mirror Egress Port and the
Mirror Ingress Port at the same time.

i

SYNTAX:
eth switch mirror ingress

port = 
[state = <{enabled | disabled}>]

where:
port

The port to be the Mirror Ingress Port.
Note

state

REQUIRED

If no port number is specified, then the port number of
the current Mirror Ingress Port is shown.

Enable or disable the port as Mirror Ingress Port.
The default is enabled.

OPTIONAL

EXAMPLE:
Here port 2 is enabled as Mirror Ingress Port
=>eth switch mirror ingress port=2
=>eth switch mirror ingress
Ingress mirror port = 2
=>

Here port 2 is disabled as Mirror Ingress Port
=>eth switch mirror
Ingress mirror port
=>eth switch mirror
=>eth switch mirror
=>

ingress
= 2
ingress port=2 state=disabled
ingress

RELATED COMMANDS:
eth switch mirror capture

Define the specified port to be the Mirror Capture Port.

eth switch mirror egress

Enable or disable the specified port to be the Mirror Egress Port.

E-DOC-CTC-20061027-0003 v2.0

309

Eth Commands

eth switch share add
Add a port to be shared.

SYNTAX:
eth switch share add

port = 
shared = 

where:
port

A number between 1 and 4.
Represents the port.

REQUIRED

shared

A number between 1 and 4.
Represents the shared port.

REQUIRED

RELATED COMMANDS:

310

eth switch share delete

Delete a shared port.

eth switch share list

Display shared ports.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch share delete
Delete a shared port.

SYNTAX:
eth switch share delete

port = 
shared = 

where:
port

A number between 1 and 4.
Represents the port.

REQUIRED

shared

A number between 1 and 4.
Represents the shared port.

REQUIRED

RELATED COMMANDS:
eth switch share add

Add a port to be shared.

eth switch share list

Display shared ports.

E-DOC-CTC-20061027-0003 v2.0

311

Eth Commands

eth switch share list
Display shared ports.

SYNTAX:
eth switch share list

RELATED COMMANDS:

312

eth switch share add

Add a port to be shared.

eth switch share delete

Delete a shared port.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch info
Display switch capabilities.

SYNTAX:
eth switch info

RELATED COMMANDS:
Not applicable

E-DOC-CTC-20061027-0003 v2.0

313

Eth Commands

eth switch qos config
Configure common qos parameters.

SYNTAX:
eth switch qos config

state = 
[nbrOfQueues = ]
[realtime = ]

where:
state

Enable or disable QoS

REQUIRED

nbrOfQueues

Number of QoS queues

OPTIONAL

realtime

Enable or disable real time

OPTIONAL

RELATED COMMANDS:

314

eth switch qos ifconfig

Configure per port QoS parameters.

eth switch qos list

Display QoS configuration.

eth switch qos weights

Configure the queue weights.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch qos ifconfig
Configure per port QoS parameters.

SYNTAX:
eth switch qos ifconfig

port = 
mode = <802.1p|diffserv|high|none|tos>
[flowcontrol = ]

where:
Port

Port to be configured

REQUIRED

Mode

QoS Classifier for the port

REQUIRED

Fowcontrol

Enable or disable flow control

OPTIONAL

RELATED COMMANDS:
eth switch qos config

Configure common qos parameters.

eth switch qos list

Display QoS configuration.

eth switch qos weights

Configure the queue weights.

E-DOC-CTC-20061027-0003 v2.0

315

Eth Commands

eth switch qos list
Display QoS configuration.

SYNTAX:
eth switch qos list

RELATED COMMANDS:

316

eth switch qos config

Configure common qos parameters.

eth switch qos ifconfig

Configure per port QoS parameters.

eth switch qos weights

Configure the queue weights.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch qos weights
Configure the queue weights.

SYNTAX:
eth switch qos weights

queue0
queue1
queue2
queue3

=
=
=
=






where:
QueueX

The weight of queue X in WFQ (percentage)
X=1 through 4

REQUIRED

RELATED COMMANDS:
eth switch qos config

Configure common qos parameters.

eth switch qos ifconfig

Configure per port QoS parameters.

eth switch qos list

Display QoS configuration.

E-DOC-CTC-20061027-0003 v2.0

317

Eth Commands

eth switch shaper config
Configure common ingress shaper parameters.

SYNTAX:
eth switch shaper config

shaper = 
[unicast = ]
[multicast = ]
[broadcast = ]
[control = ]
[unknown = ]
[discard = ]

where:
shaper

The shaper instance

REQUIRED

unicast

Shape unicast traffic.

OPTIONAL

multicast

Shape multicast traffic.

OPTIONAL

broadcast

Shape broadcast traffic.

OPTIONAL

control

Shape MAC control traffic.

OPTIONAL

unknown

Shape traffic with unknown destination address.

OPTIONAL

discard

Discard frame at overflow (else attempt for flow control)

OPTIONAL

RELATED COMMANDS:

318

eth switch shaper ifconfig

Configure per port shaper parameters.

eth switch shaper iflist

Display shaper configuration per port.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch shaper ifconfig
Configure per port shaper parameters.

SYNTAX:
eth switch shaper ifconfig

port = 
ingress = 
shaper = 
[state = ]
[speed = ]
[burstsize = ]

where:
port

Port number

REQUIRED

ingress

Enabled: port is ingress port
Disabled: port is egress port

REQUIRED

shaper

Shaper instance

REQUIRED

state

Enable/disable shaping

OPTIONAL

speed

Speed in bits/sec.

OPTIONAL

burstsize

Burst size in KBytes

OPTIONAL

RELATED COMMANDS:
eth switch shaper config

Configure common ingress shaper parameters.

eth switch shaper iflist

Display shaper configuration per port.

E-DOC-CTC-20061027-0003 v2.0

319

Eth Commands

eth switch shaper iflist
Display shaper configuration per port.

SYNTAX:
eth switch shaper iflist

RELATED COMMANDS:

320

eth switch shaper config

Configure common ingress shaper parameters.

eth switch shaper ifconfig

Configure per port shaper parameters.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth switch storm ifconfig
Configure per port storm control parameters.

SYNTAX:
eth switch storm ifconfig

port = 
[state = ]
[rate = <{33|50|100|200}>]
[burstsize = ]
[broadcast = 
[multicast = ]
[unknown = ]

where:
port

Port number

REQUIRED

state

Enable/disable storm control

OPTIONAL

rate

Rate in 10ths of percent

OPTIONAL

burstsize

Burst size in KBytes

OPTIONAL

broadcast

Storm control for broadcast traffic

OPTIONAL

multicast

Storm control for multicast traffic

OPTIONAL

unknown

Storm control for traffic with unknown destination address

OPTIONAL

RELATED COMMANDS:
eth switch storm iflist

E-DOC-CTC-20061027-0003 v2.0

Display storm control configuration per port.

321

Eth Commands

eth switch storm iflist
Display storm control configuration per port.

SYNTAX:
eth switch storm iflist

RELATED COMMANDS:
eth switch storm ifconfig

322

Configure per port storm control parameters.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth vlan add
Add a new VLAN.

SYNTAX:
eth vlan add

name = 
vid = 
[addrule = <{disabled | enabled}>]

where:
name

The new VLAN name.

REQUIRED

vid

A number representing the new VLAN ID.

REQUIRED

Note
addrule

The ID 1 is reserved for the default VLAN.

Add (enabled) the default bridge constraint or not (disabled).
The default is enabled.

OPTIONAL

EXAMPLE:
=>eth vlan list
Vid
Name
-----1
default
=>eth vlan add name=myVLAN vid=2
=>eth vlan list
Vid
Name
-----1
default
2
myVLAN
=>

RELATED COMMANDS:
eth vlan delete

Delete a VLAN.

eth vlan list

Display all VLANs.

E-DOC-CTC-20061027-0003 v2.0

323

Eth Commands

eth vlan delete
Delete a VLAN.

SYNTAX:
eth vlan delete

name = 

where:
name

The name of the VLAN to be deleted.

REQUIRED

EXAMPLE:
=>eth vlan list
Vid
Name
-----1
default
2
myVLAN
=>eth vlan delete name=myVLAN vid=2
=>eth vlan list
Vid
Name
-----1
default
=>

RELATED COMMANDS:

324

eth vlan add

Add a new VLAN.

eth vlan list

Display all VLANs.

E-DOC-CTC-20061027-0003 v2.0

Eth Commands

eth vlan flush
Flush all VLANs.

i

All the VLANs, except the default VLAN will be flushed.

SYNTAX:
eth vlan flush

EXAMPLE:
=>eth vlan list
Vid
Name
-----1
default
2
myVLAN
3
yourVLAN
=>eth vlan flush
=>eth vlan list
Vid
Name
-----1
default
=>

E-DOC-CTC-20061027-0003 v2.0

325

Eth Commands

eth vlan list
Display all VLANs.

SYNTAX:
eth vlan list

EXAMPLE:
=>eth vlan list
Vid
Name
-----1
default
2
myVLAN
=>

RELATED COMMANDS:

326

eth vlan add

Add a new VLAN.

eth vlan delete

Delete a VLAN.

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

15 Expr Commands
Introduction
This chapter describes the commands of the expr command group.

Contents
This chapter covers the following commands:
expr add

Add a subexpression to an expression.

328

expr delete

Delete an expression.

332

expr flush

Flush all the expressions.

334

expr list

List the expressions.

335

expr modify

Modify an expression.

339

E-DOC-CTC-20061027-0003 v2.0

327

Expr Commands

expr add
Add a subexpression to an expression.

SYNTAX:
expr add

i

name = 
type = <{intf | ip | serv}>
addr [!]= 
[intf [!]= ]
[intfgroup [!]= <{wan|local|lan|tunnel|dmz|guest} or number>]
[tos [!]= ]
[precedence [!]=  or ]
[dscp [!]=  or ]
[proto =  or ]
[srcport [!]=  or ]
[srcportend =  or ]
[dstport [!]=  or ]
[dstportend =  or ]
[icmptype [!]=  or ]
[icmpcode [!]= ]
[icmpcodeend = ]

If a value is preceded by a “!”, it means NOT.
For example “intfgroup=!wan” means “if the interface group is different from WAN”.

where:
name

The name of an existing expression.

REQUIRED

type

The expression type.
Choose between:

REQUIRED

>
>
>
addr

intf
ip
serv.

The IP address (or range). Supports ip/mask notation.
Note

intf

The IP interface name.
Note

328

REQUIRED

Only for expression type ip.
OPTIONAL

Only for expression type intf.

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

intfgroup

The IP interface group.
Choose between:

>
>
>
>
>
>

wan
local
lan
tunnel
dmz
guest.

Note
tos

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

The Differentiated Services Code Point (DSCP) in the IP packet
(part of tos).
Select a DSCP (see “ Differentiated Services Code Point (DSCP)”
on page 753) or, alternatively, specify the number.
Note

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

The precedence in the IP packet (part of tos).
Select an IP precedence (see “ IP Precedence” on page 752) or,
alternatively, specify the number.
Note

dscp

Only for expression type intf.

A number between 0 and 255.
Represents the Type of Service (ToS) specification in the IP
packet.
Note

precedence

OPTIONAL

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

proto

The protocol (name or number) expected in the IP packet.
Select one of the following protocols: icmp, igmp, ipinip, tcp,
udp, ah, esp, ipcomp or, alternatively, specify the protocol
number.

OPTIONAL

srcport

The TCP/UDP port (or beginning of range) the packet is coming
from.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

srcportend

The source TCP/UDP port range end (inclusive).
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

dstport

The TCP/UDP port (or beginning of range) the packet is going to.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

dstportend

The destination TCP/UDP port range end. (inclusive).
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

icmptype

The Internet Control Message Protocol (ICMP) type (name or
number) of the packet.
Select one of the supported ICMP types (see “ Supported ICMP
Type Names” on page 750) or, alternatively, specify the type
number.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

329

Expr Commands

330

icmpcode

A number between 0 and 15.
Represents the ICMP code (or beginning of range) of the packet.

OPTIONAL

icmpcodeend

A number between 0 and 15.
Represents the ICMP code range end (inclusive).

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

EXAMPLE:
=>expr list
name

type

use flags expression

-----------------------------------------------------------------------------------------_myPPP_ppp
intf
0 D
1. intf=myPPP_ppp
_eth0
intf
0 D
1. intf=eth0
wan
intf
0
1. intfgroup=0
lan
intf
28
1. intfgroup=2
local
intf
0
1. intfgroup=1
notwan
intf
1
1. intfgroup=2
2. intfgroup=1
_10.0.0.138
ip
0 D
1. addr=10.0.0.138
_192.168.1.254
ip
0 D
1. addr=192.168.1.254
...
DiffServ
sip

serv
serv

0
1

h323

serv

1

1.
1.
2.
1.
2.
3.

dscp=!0
proto=17 dst-prt=5060
proto=6 dst-prt=5060
proto=6 dst-prt=1720
proto=17 dst-prt=1718
proto=17 dst-prt=1719

=>expr add name=myEXPR type=intf intf=Internet intfgroup=lan
=>expr list
name
type
use flags expression
-----------------------------------------------------------------------------------------_myPPP_ppp
intf
0 D
1. intf=myPPP_ppp
_eth0
intf
0 D
1. intf=eth0
wan
intf
0
1. intfgroup=0
lan
intf
28
1. intfgroup=2
local
intf
0
1. intfgroup=1
notwan
intf
1
1. intfgroup=2
2. intfgroup=1
myEXPR
intf
0
1. intf=Internet intfgroup=2
_10.0.0.138
ip
0 D
1. addr=10.0.0.138
_192.168.1.254
ip
0 D
1. addr=192.168.1.254
...
DiffServ
sip

serv
serv

0
1

h323

serv

1

1.
1.
2.
1.
2.
3.

dscp=!0
proto=17 dst-prt=5060
proto=6 dst-prt=5060
proto=6 dst-prt=1720
proto=17 dst-prt=1718
proto=17 dst-prt=1719

=>

RELATED COMMANDS:
expr delete

Delete an expression.

expr list

List the expressions.

E-DOC-CTC-20061027-0003 v2.0

331

Expr Commands

expr delete
Delete an expression.

SYNTAX:
expr delete

name = 
[index = ]

where:
name

The name of the expression to be deleted.

REQUIRED

index

The index of the subexpression to be deleted.

OPTIONAL

Note

332

If not specified, all the subexpressions wil be deleted.

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

EXAMPLE:
=>expr list
name

type

use flags expression

-----------------------------------------------------------------------------------------_myPPP_ppp
intf
0 D
1. intf=myPPP_ppp
_eth0
intf
0 D
1. intf=eth0
wan
intf
0
1. intfgroup=0
lan
intf
28
1. intfgroup=2
local
intf
0
1. intfgroup=1
notwan
intf
1
1. intfgroup=2
2. intfgroup=1
myEXPR
intf
0
1. intf=Internet intfgroup=2
_10.0.0.138
ip
0 D
1. addr=10.0.0.138
_192.168.1.254
ip
0 D
1. addr=192.168.1.254
...
DiffServ
sip

serv
serv

0
1

h323

serv

1

=>expr delete name=myEXPR
=>expr list
name

type

1.
1.
2.
1.
2.
3.

dscp=!0
proto=17 dst-prt=5060
proto=6 dst-prt=5060
proto=6 dst-prt=1720
proto=17 dst-prt=1718
proto=17 dst-prt=1719

use flags expression

-----------------------------------------------------------------------------------------_myPPP_ppp
intf
0 D
1. intf=myPPP_ppp
_eth0
intf
0 D
1. intf=eth0
wan
intf
0
1. intfgroup=0
lan
intf
28
1. intfgroup=2
local
intf
0
1. intfgroup=1
notwan
intf
1
1. intfgroup=2
2. intfgroup=1
_10.0.0.138
ip
0 D
1. addr=10.0.0.138
_192.168.1.254
ip
0 D
1. addr=192.168.1.254
...
DiffServ
sip

serv
serv

0
1

h323

serv

1

1.
1.
2.
1.
2.
3.

dscp=!0
proto=17 dst-prt=5060
proto=6 dst-prt=5060
proto=6 dst-prt=1720
proto=17 dst-prt=1718
proto=17 dst-prt=1719

=>

RELATED COMMANDS:
expr add

Add a subexpression to an expression.

expr list

List the expressions.

E-DOC-CTC-20061027-0003 v2.0

333

Expr Commands

expr flush
Flush all the expressions.

SYNTAX:
expr flush

334

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

expr list
List the expressions.

SYNTAX:
expr list

[name = ]
[type = <{intf | ip | serv}>]
[format = <{pretty | cli}>]
[string = ]
[beginstring = ]

where:
name

The name of an existing expression.
Note

type

OPTIONAL

intf
ip
serv.

Note
format

If not specified, all the expressions will be listed.

The expression type.
Choose between:

>
>
>

OPTIONAL

If not specified, the expressions of all types will be
shown.

Select the output format of the list.
Choose between:

>

pretty: the expressions are shown as intuitive output in clear
text.

>

cli: the expressions are shown via the CLI commands
configuration.

OPTIONAL

The default is pretty.
string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

335

Expr Commands

EXAMPLE 1:
=>expr list
name
type
use flags expression
-----------------------------------------------------------------------------------------_Internet
intf
0 D
1. intf=Internet
_LocalNetwork
intf
0 D
1. intf=LocalNetwork
HTTPI_if_0
intf
1 D
1. intf=LocalNetwork
2. intf=LocalNetwork
3. intf=LocalNetwork
HTTP_if_0
intf
1 D
1. intfgroup=2
HTTPs_if_0
intf
1 D
1. intfgroup=2
FTP_if_0
intf
1 D
1. intfgroup=2
TELNET_if_0
intf
1 D
1. intfgroup=2
DNS-S_if_0
intf
1 D
1. intfgroup=2
SNMP_AGENT_if_0
intf
1 D
1. intfgroup=2
PING_RESPONDER_if_0
intf
1 D
1. intfgroup=2
wan
intf
1
1. intfgroup=0
lan
intf
2
1. intfgroup=2
local
intf
0
1. intfgroup=1
_10.0.0.138
ip
0 D
1. addr=10.0.0.138
_192.168.1.254
ip
0 D
1. addr=192.168.1.254
private
ip
0
1. addr=10.0.0.0/8
2. addr=172.[16-31].*.*
3. addr=192.168.1.0/24
ssdp_ip
ip
1
1. addr=239.255.255.250
mdap_ip
ip
1
1. addr=224.0.0.103
HTTP_sv_0
serv
1 D
1. proto=6 dst-prt=80
HTTPs_sv_0
serv
1 D
1. proto=6 dst-prt=443
FTP_sv_0
serv
1 D
1. proto=6 dst-prt=21
TELNET_sv_0
serv
1 D
1. proto=6 dst-prt=23
RIP_sv_0
serv
1 D
1. proto=17 src-prt=520 dst-prt=520
RIP-Query_sv_0
serv
1 D
1. proto=17 dst-prt=520
DNS-S_sv_0
serv
1 D
1. proto=17 dst-prt=53
SNMP_AGENT_sv_0
serv
1 D
1. proto=17 dst-prt=161
RAS_sv_0
serv
1 D
1. proto=6 dst-prt=80
SRAS_sv_0
serv
1 D
1. proto=6 dst-prt=443
ICMP_LISTEN_sv_0
serv
1 D
1. proto=1
SENDTO_LISTEN_sv_0
serv
1 D
1. proto=17
PING_RESPONDER_sv_0
serv
1 D
1. proto=1 icmp-type=8
HTTPI_sv_0
serv
1 D
1. proto=6 dst-prt=8080
icmp
serv
1
1. proto=1
igmp
serv
2
1. proto=2
ftp
serv
0
1. proto=6 dst-prt=21
telnet
serv
1
1. proto=6 dst-prt=23
http
serv
1
1. proto=6 dst-prt=80
httpproxy
serv
1
1. proto=6 dst-prt=8080
https
serv
1
1. proto=6 dst-prt=443
RPC
serv
0
1. proto=6 dst-prt=135
NBT
serv
0
1. proto=17 dst-prt=137
2. proto=17 dst-prt=138
3. proto=6 dst-prt=139
SMB
serv
0
1. proto=6 dst-prt=445
imap
serv
1
1. proto=6 dst-prt=143
imap3
serv
1
1. proto=6 dst-prt=220
imap4-ssl
serv
1
1. proto=6 dst-prt=585
imaps
serv
1
1. proto=6 dst-prt=993
pop2
serv
1
1. proto=6 dst-prt=109
pop3
serv
1
1. proto=6 dst-prt=110
pop3s
serv
1
1. proto=6 dst-prt=995
smtp
serv
1
1. proto=6 dst-prt=25
ssh
serv
0
1. proto=6 dst-prt=22
dns
serv
1
1. proto=6 dst-prt=53
2. proto=17 dst-prt=53
nntp
serv
0
1. proto=6 dst-prt=119
ipsec
serv
0
1. proto=51
2. proto=50
3. proto=17 src-prt=500 dst-prt=500
esp
serv
1
1. proto=50
ah
serv
1
1. proto=51
ike
serv
1
1. proto=17 dst-prt=500
DiffServ
serv
0
1. dscp=!0
sip
serv
1
1. proto=17 dst-prt=5060
2. proto=6 dst-prt=5060
h323
serv
1
1. proto=6 dst-prt=1720
2. proto=17 dst-prt=1718
3. proto=17 dst-prt=1719
dhcp
serv
1
1. proto=17 dst-prt=68
2. proto=17 dst-prt=67
rtsp
serv
1
1. proto=17 dst-prt=554
2. proto=6 dst-prt=554
ssdp_serv
serv
1
1. proto=17 dst-prt=1900
mdap_serv
serv
1
1. proto=17 dst-prt=3235
=>

336

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

EXAMPLE 2:
=>expr list format=cli
:expr add name=_Internet type=intf intf=Internet
:expr add name=_LocalNetwork type=intf intf=LocalNetwork
:expr add name=HTTPI_if_0 type=intf intf=LocalNetwork
:expr add name=HTTPI_if_0 type=intf intf=LocalNetwork
:expr add name=HTTPI_if_0 type=intf intf=LocalNetwork
:expr add name=HTTP_if_0 type=intf intfgroup=lan
:expr add name=HTTPs_if_0 type=intf intfgroup=lan
:expr add name=FTP_if_0 type=intf intfgroup=lan
:expr add name=TELNET_if_0 type=intf intfgroup=lan
:expr add name=DNS-S_if_0 type=intf intfgroup=lan
:expr add name=SNMP_AGENT_if_0 type=intf intfgroup=lan
:expr add name=PING_RESPONDER_if_0 type=intf intfgroup=lan
:expr add name=wan type=intf intfgroup=wan
:expr add name=lan type=intf intfgroup=lan
:expr add name=local type=intf intfgroup=local
:expr add name=_10.0.0.138 type=ip addr=10.0.0.138
:expr add name=_192.168.1.254 type=ip addr=192.168.1.254
:expr add name=private type=ip addr=10.0.0.0/8
:expr add name=private type=ip addr=172.[16-31].*.*
:expr add name=private type=ip addr=192.168.1.0/24
:expr add name=ssdp_ip type=ip addr=239.255.255.250
:expr add name=mdap_ip type=ip addr=224.0.0.103
:expr add name=HTTP_sv_0 type=serv proto=tcp dstport=www-http
:expr add name=HTTPs_sv_0 type=serv proto=tcp dstport=443
:expr add name=FTP_sv_0 type=serv proto=tcp dstport=ftp
:expr add name=TELNET_sv_0 type=serv proto=tcp dstport=telnet
:expr add name=RIP_sv_0 type=serv proto=udp srcport=rip dstport=rip
:expr add name=RIP-Query_sv_0 type=serv proto=udp dstport=rip
:expr add name=DNS-S_sv_0 type=serv proto=udp dstport=dns
:expr add name=SNMP_AGENT_sv_0 type=serv proto=udp dstport=snmp
:expr add name=RAS_sv_0 type=serv proto=tcp dstport=www-http
:expr add name=SRAS_sv_0 type=serv proto=tcp dstport=443
:expr add name=ICMP_LISTEN_sv_0 type=serv proto=icmp
:expr add name=SENDTO_LISTEN_sv_0 type=serv proto=udp
:expr add name=PING_RESPONDER_sv_0 type=serv proto=icmp icmptype=echo-request
:expr add name=HTTPI_sv_0 type=serv proto=tcp dstport=httpproxy
:expr add name=icmp type=serv proto=icmp
:expr add name=igmp type=serv proto=igmp
:expr add name=ftp type=serv proto=tcp dstport=ftp
:expr add name=telnet type=serv proto=tcp dstport=telnet
:expr add name=http type=serv proto=tcp dstport=www-http
:expr add name=httpproxy type=serv proto=tcp dstport=httpproxy
:expr add name=https type=serv proto=tcp dstport=443
:expr add name=RPC type=serv proto=tcp dstport=135
:expr add name=NBT type=serv proto=udp dstport=netbios-ns
:expr add name=NBT type=serv proto=udp dstport=netbios-dgm
:expr add name=NBT type=serv proto=tcp dstport=netbios-ssn
:expr add name=SMB type=serv proto=tcp dstport=445
:expr add name=imap type=serv proto=tcp dstport=imap2
:expr add name=imap3 type=serv proto=tcp dstport=imap3
:expr add name=imap4-ssl type=serv proto=tcp dstport=585
:expr add name=imaps type=serv proto=tcp dstport=993
:expr add name=pop2 type=serv proto=tcp dstport=pop2
:expr add name=pop3 type=serv proto=tcp dstport=pop3
:expr add name=pop3s type=serv proto=tcp dstport=995
:expr add name=smtp type=serv proto=tcp dstport=smtp
:expr add name=ssh type=serv proto=tcp dstport=22
:expr add name=dns type=serv proto=tcp dstport=dns
:expr add name=dns type=serv proto=udp dstport=dns
:expr add name=nntp type=serv proto=tcp dstport=nntp
:expr add name=ipsec type=serv proto=ah
:expr add name=ipsec type=serv proto=esp
:expr add name=ipsec type=serv proto=udp srcport=ike dstport=ike
:expr add name=esp type=serv proto=esp
:expr add name=ah type=serv proto=ah
:expr add name=ike type=serv proto=udp dstport=ike
:expr add name=DiffServ type=serv dscp=!cs0
:expr add name=sip type=serv proto=udp dstport=sip
:expr add name=sip type=serv proto=tcp dstport=sip
:expr add name=h323 type=serv proto=tcp dstport=h323
:expr add name=h323 type=serv proto=udp dstport=1718
:expr add name=h323 type=serv proto=udp dstport=1719
:expr add name=dhcp type=serv proto=udp dstport=bootpc
:expr add name=dhcp type=serv proto=udp dstport=bootps
:expr add name=rtsp type=serv proto=udp dstport=rtsp
:expr add name=rtsp type=serv proto=tcp dstport=rtsp
:expr add name=ssdp_serv type=serv proto=udp dstport=1900
:expr add name=mdap_serv type=serv proto=udp dstport=3235=>

E-DOC-CTC-20061027-0003 v2.0

337

Expr Commands

RELATED COMMANDS:

338

expr add

Add a subexpression to an expression.

expr delete

Delete an expression.

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

expr modify
Modify an expression.

SYN TAX:
expr modify

i

name = 
type = <{intf | ip | serv}>
index = 
addr [!]= 
[intf [!]= ]
[intfgroup [!]= <{wan|local|lan|tunnel|dmz|guest} or
number>]
[bridgeport [!]= ]
[tos [!]= ]
[precedence [!]=  or ]
[dscp [!]=  or ]
[proto =  or ]
[srcport [!]=  or ]
[srcportend =  or ]
[dstport [!]=  or ]
[dstportend =  or ]
[icmptype [!]=  or ]
[icmpcode [!]= ]
[icmpcodeend = ]

If a value is preceded by a “!”, it means NOT.
For example “intfgroup=!wan” means “if the interface group is different from WAN”.

where:
name

The name of the expression to be modified.

REQUIRED

type

The expression type.
Choose between:

REQUIRED

>
>
>
number

intf
ip
serv.

The index of the subexpression to be modified.
Tip

addr

The IP address (or range). Supports ip/mask notation.
Note

intf

E-DOC-CTC-20061027-0003 v2.0

REQUIRED

Only for expression type ip.

The IP interface name.
Note

REQUIRED

Use the command :expr list to obtain the indexes
of the subexpressions.

OPTIONAL

Only for expression type intf.

339

Expr Commands

intfgroup

The IP interface group.
Choose between:

>
>
>
>
>
>

wan
local
lan
tunnel
dmz
guest.

Note
bridgeport

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.
OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

The DSCP in the IP packet (part of tos).
Select a DSCP (see “ Differentiated Services Code Point (DSCP)”
on page 753).
Note

340

Only for expression type intf.

The precedence in the IP packet (part of tos).
Select an IP precedence (see “ IP Precedence” on page 752) or,
alternatively, specify the number.
Note

dscp

OPTIONAL

A number between 0 and 255.
Represents the ToS specification in the IP packet.
Note

precedence

Only for expression type intf.

The bridge port number.
Note

tos

OPTIONAL

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

proto

The protocol (name or number) expected in the IP packet.
Select one of the following protocols: icmp, igmp, ipinip, tcp,
udp, ah, esp, ipcomp or, alternatively, specify the protocol
number.

OPTIONAL

srcport

The TCP/UDP port (or beginning of range) the packet is coming
from.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the protocol number.

OPTIONAL

srcportend

The source TCP/UDP port range end (inclusive).
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the protocol number.

OPTIONAL

dstport

The TCP/UDP port (or beginning of range) the packet is going to.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the protocol number.

OPTIONAL

dstportend

The destination TCP/UDP port range end (inclusive).
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the protocol number.

OPTIONAL

icmptype

The ICMP type (name or number) of the packet.
Select one of the supported ICMP types (see “ Supported ICMP
Type Names” on page 750) or, alternatively, specify the type
number.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Expr Commands

icmpcode

A number between 0 and 15.
Represents the ICMP code (or beginning of range) of the packet.

OPTIONAL

icmpcodeend

A number between 0 and 15.
Represents the ICMP code range end (inclusive).

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

341

Expr Commands

342

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

16 Firewall Commands
Introduction
This chapter describes the commands of the firewall command group.

Contents
This chapter covers the following commands:
firewall config

Configure the firewall options.

344

firewall clear

Flush the firewall configuration.

346

firewall list

List the firewall configuration.

347

firewall chain add

Add a chain.

349

firewall chain delete

Delete a chain.

351

firewall chain flush

Flush all chains.

353

firewall chain list

List all chains.

354

firewall debug clear

Clear the firewall statistics.

355

firewall debug stats

Display the firewall statistics.

356

firewall debug traceconfig

Configure the firewall trace options.

357

firewall level add

Add a security level.

358

firewall level delete

Delete a security level.

359

firewall level flush

Flush the security level configuration.

360

firewall level list

List all the security levels.

361

firewall level modify

Configure a security level.

362

firewall level set

Set the security level or display the current security level.

363

firewall rule add

Add a firewall rule.

364

firewall rule delete

Delete a firewall rule.

365

firewall rule flush

Flush all firewall rules.

366

firewall rule list

Show a list of the firewall rules in a chain.

367

firewall rule modify

Modify a firewall rule.

369

firewall rule debug clear

Clear the firewall rule statistics.

370

firewall rule debug stats

Show the firewall rule statistics.

372

firewall rule debug
traceconfig

Display or modify the rule trace configuration.

374

E-DOC-CTC-20061027-0003 v2.0

343

Firewall Commands

firewall config
Configure the firewall options.

SYNTAX:
firewall config

[state = <{disabled | enabled}>]
[keep = <{disabled | enabled}>]
[tcpchecks = <{none | fast | exact}>]
[udpchecks = <{disabled|enabled}>]
[icmpchecks = <{disabled | enabled}>]
[logdefault = <{disabled | enabled}>]
[logthreshold = <{disabled | enabled}>]
[tcpwindow = ]

where:
state

Enable or disable the firewall.
The default is enabled.

OPTIONAL

keep

The firewall keeps active connections (enabled) or not
(disabled) when the firewall rules change.
The default is disabled.

OPTIONAL

tcpchecks

Select the level of TCP sequence number checks. Choose
between:

OPTIONAL

>
>

>

none: no TCP checks are done.
fast: check all the combinations of flag and disallow all the
possible illegal combinations shown below:


SYN PSH (SYN PSH URG,...)



SYN FIN (SYN FIN PSH, SYN FIN RST PSH,...)



FIN flag set without ACK



All flags set



No flags set.

exact: check and permit only combinations of flag with the
TCP state of a connection:


SYN: request to open connection



SYN ACK: agree to open connection



A, PA, AU, PAU: acknowledgement of receipt



FA, FAP, FAU, FAP, FAPU, FAU, FPAU: request to close
connection



R, RA, RP, RU, RPA, RPU, RAU, RPAU: tear down
connection.

The default is none.

344

udpchecks

Disable or enable keeping UDP checks.
The default is enabled.

OPTIONAL

icmpchecks

Disable or enable keeping ICMP checks.
The default is enabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

logdefault

Disable or enable logging of default firewall rule.
The default is disabled.

OPTIONAL

logthreshold

Disable or enable log thresholding.
The default is enabled.

OPTIONAL

tcpwindow

A number between 0 and 1073725440.
This parameter permits to modify the TCP window for fast TCP
checks.
The default is 65536.

OPTIONAL

EXAMPLE:
=>firewall config
:firewall config state=enabled keep=disabled tcpchecks=none udpchecks=enabled
icmpchecks=enabled logdefault=disabled logthreshold=enabled tcpwindow=65536
=>

E-DOC-CTC-20061027-0003 v2.0

345

Firewall Commands

firewall clear
Flush the firewall configuration.

SYNTAX:
firewall clear

346

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall list
List the firewall configuration.

SYNTAX:
firewall list

[format = <{pretty | cli}>]

where:
format

Select the output format in which the configuration must be
shown.
Choose between:

>

pretty: the configuration is shown as intuitive output in
clear text.

>

cli: the configuration is shown via the CLI commands
configuration.

OPTIONAL

The default is pretty.

E-DOC-CTC-20061027-0003 v2.0

347

Firewall Commands

EXAMPLE of output in text mode:
=>firewall list
Config
======
State
Keep
TcpChecks
TcpWindow
IcmpChecks
LogDefault
LogThreshold

:
:
:
:
:
:
:

Modules
=======
Module

State

enabled
disabled
exact
65536
enabled
disabled
enabled

Text

Hooks

------------------------------------------------------------------------------------------------fire
enabled Firewall Administration Module
sink, forward, source
host_service
enabled Firewall Host Service Module
forward
level
enabled Firewall Level Module
forward
system_service
enabled Firewall System Service Module
sink
=>

EXAMPLE of output in CLI mode:
=>firewall list format=cli
:firewall config state=enabled keep=disabled tcpchecks=exact icmpchecks=enabled logdefault=di
sabled
| logthreshold=enabled tcpwindow=65536
:firewall debug traceconfig tcpchecks=disabled icmpchecks=disabled sink=none forward=none
| source=none
=>

348

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall chain add
Add a chain.

SYNTAX:
firewall chain add

chain = 

where:
chain

E-DOC-CTC-20061027-0003 v2.0

The name of the chain to be added.

REQUIRED

349

Firewall Commands

EXAMPLE:
=>firewall chain list
Chains
======
Name
Description
----------------------------------------------------------------sink
system
forward
system
source
system
sink_fire
system
forward_fire
system
source_fire
system
forward_host_service
system
forward_level
system
sink_system_service
system
forward_level_BlockAll
system
forward_level_Standard
system
forward_level_Disabled
system
=>firewall chain add chain=myCHAIN
=>firewall chain list
Chains
======
Name
Description
----------------------------------------------------------------sink
system
forward
system
source
system
sink_fire
system
forward_fire
system
source_fire
system
forward_host_service
system
forward_level
system
sink_system_service
system
forward_level_BlockAll
system
forward_level_Standard
system
forward_level_Disabled
system
myCHAIN
user
=>

RELATED COMMANDS:

350

firewall chain delete

Delete a chain.

firewall chain list

List all chains.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall chain delete
Delete a chain.

SYNTAX:
firewall chain delete

chain = 

where:
chain

E-DOC-CTC-20061027-0003 v2.0

The name of the chain to be deleted.

REQUIRED

351

Firewall Commands

EXAMPLE:
=>firewall chain list
Chains
======
Name
Description
----------------------------------------------------------------sink
system
forward
system
source
system
sink_fire
system
forward_fire
system
source_fire
system
forward_host_service
system
forward_level
system
sink_system_service
system
forward_level_BlockAll
system
forward_level_Standard
system
forward_level_Disabled
system
myCHAIN
user
=>firewall chain delete chain=myCHAIN
=>firewall chain list
Chains
======
Name
Description
----------------------------------------------------------------sink
system
forward
system
source
system
sink_fire
system
forward_fire
system
source_fire
system
forward_host_service
system
forward_level
system
sink_system_service
system
forward_level_BlockAll
system
forward_level_Standard
system
forward_level_Disabled
system
=>

RELATED COMMANDS:

352

firewall chain add

Add a chain.

firewall chain list

List all chains.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall chain flush
Flush all chains.

SYNTAX:
firewall chain flush

E-DOC-CTC-20061027-0003 v2.0

353

Firewall Commands

firewall chain list
List all chains.

SYNTAX:
firewall chain list

[format = <{pretty | cli}>]

where:
format

Select the output format in which the chains must be shown.
Choose between:

>

pretty: the chains are shown as intuitive output in clear
text.

>

cli: the chains are shown via the CLI commands
configuration.

OPTIONAL

The default is pretty.

EXAMPLE:
=>firewall chain list
Chains
======
Name
Description
----------------------------------------------------------------sink
system
forward
system
source
system
sink_fire
system
forward_fire
system
source_fire
system
forward_host_service
system
forward_level
system
sink_system_service
system
forward_level_BlockAll
system
forward_level_Standard
system
forward_level_Disabled
system
=>

RELATED COMMANDS:

354

firewall chain add

Add a chain.

firewall chain delete

Delete a chain.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall debug clear
Clear the firewall statistics.

SYNTAX:
firewall debug clear

EXAMPLE:
=>firewall debug stats
Statistics
==========
Used rule contexts
Total rule contexts
Total packets parsed
Packets parsed in hook sink
Packets parsed in hook forward
Packets parsed in hook source
Packets dropped in hook sink
Packets dropped in hook forward
Packets dropped in hook source
TCP flag errors detected
TCP seq/ack/win errors detected
ICMP errors with partial info
ICMP errors without cause
ICMP replies without request
Packet replay errors
: 0
=>firewall debug clear
=>firewall debug stats
Statistics
==========
Used rule contexts
Total rule contexts
Total packets parsed
Packets parsed in hook sink
Packets parsed in hook forward
Packets parsed in hook source
Packets dropped in hook sink
Packets dropped in hook forward
Packets dropped in hook source
TCP flag errors detected
TCP seq/ack/win errors detected
ICMP errors with partial info
ICMP errors without cause
ICMP replies without request
Packet replay errors
: 0
=>

:
:
:
:
:
:
:
:
:
:
:
:
:
:

0
256
2554
1461
12
1041
0
0
0
14
5
0
0
0

:
:
:
:
:
:
:
:
:
:
:
:
:
:

0
256
26
16
0
10
0
0
0
0
0
0
0
0

RELATED COMMANDS:
firewall debug stats

E-DOC-CTC-20061027-0003 v2.0

Display the firewall statistics.

355

Firewall Commands

firewall debug stats
Display the firewall statistics.

SYNTAX:
firewall debug stats

EXAMPLE:
=>firewall debug stats
Statistics
==========
Used rule contexts
Total rule contexts
Total packets parsed
Packets parsed in hook sink
Packets parsed in hook forward
Packets parsed in hook source
Packets dropped in hook sink
Packets dropped in hook forward
Packets dropped in hook source
TCP flag errors detected
TCP seq/ack/win errors detected
ICMP errors with partial info
ICMP errors without cause
ICMP replies without request
Packet replay errors
: 0

:
:
:
:
:
:
:
:
:
:
:
:
:
:

0
256
2554
1461
12
1041
0
0
0
14
5
0
0
0

=>

RELATED COMMANDS:
firewall debug clear

356

Clear the firewall statistics.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall debug traceconfig
Configure the firewall trace options.

SYNTAX:
firewall debug traceconfig

[tcpchecks = <{disabled | enabled}>]
[udpchecks = <{disabled|enabled}>]
[icmpchecks = <{disabled | enabled}>]
[sink = <{none | all | accept | deny | drop
| reset} or number>]
[forward = <{none | all | accept | deny | drop
reset} or number>]
[source = <{none | all | accept | deny | drop
| reset} or number>]

where:
tcpchecks

Disable or enable tcpchecks traces.
The default is disabled.

OPTIONAL

udpchecks

Disable or enable udpchecks traces.
The default is disabled.

OPTIONAL

icmpchecks

Disable or enable icmpchecks traces.
The default is disabled.

OPTIONAL

sink

Specify the action traced by the firewall for sink traffic.
The default is none.

OPTIONAL

forward

Specify the action traced by the firewall for forward traffic.
The default is none.

OPTIONAL

source

Specify the action traced by the firewall for source traffic.
The default is none.

OPTIONAL

EXAMPLE:
=>firewall debug traceconfig
Trace Config
============
tcpchecks
icmpchecks
sink
forward
source
=>

E-DOC-CTC-20061027-0003 v2.0

:
:
:
:
:

disabled
disabled
none
none
none

357

Firewall Commands

firewall level add
Add a security level.

SYNTAX:
firewall level add

name = 
[index = ]
[readonly = <{disabled | enabled}>]
[udptrackmode = <{strict | loose}>]
[service = <{disabled | enabled}>]
[proxy = <{disabled|enabled}>]
[text = ]

where:
name

The name of the security level to be added.

REQUIRED

index

The index of the security level.

OPTIONAL

Use the command :firewall level list to
obtain a list of indexes.

Tip
Note

If not specified, the new security level will be added at
the bottom of the list.

readonly

Select whether the security level is readonly (enabled) or not
(disabled).
The default is enabled.

OPTIONAL

udptrackmode

Select the UDP connection tracking mode.
Choose between:

OPTIONAL

>

strict: replies to a request from a client must be in a specific
window to the client.

>

loose: inbound packets are allowed on the port that was
first used to start the communication with the server (for
example to allow a client of an online game to obtin peerto-peer information from other clients of that same online
game).

The default is strict.
proxy

Enable or disable proxy system services for this security level.

OPTIONAL

service

Disable or enable host service definitions.
The default is disabled.

OPTIONAL

text

Description of the security level.

OPTIONAL

Note

The maximum length is 39 characters.

RELATED COMMANDS:

358

firewall level delete

Delete a security level.

firewall level list

List all the security levels.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall level delete
Delete a security level.

SYNTAX:
firewall level delete

name = 

where:
name

The name of the security level to be deleted.

REQUIRED

RELATED COMMANDS:
firewall level add

Add a security level.

firewall level list

List all the security levels.

E-DOC-CTC-20061027-0003 v2.0

359

Firewall Commands

firewall level flush
Flush the security level configuration.

SYNTAX:
firewall level flush

360

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall level list
List all the security levels.

SYNTAX:
firewall level list

[format = <{pretty | cli}>]
[string = ]
[beginstring = ]

where:
format

Select the output format in which the security levels must be
shown.
Choose between:

>

pretty: the security levels are shown as intuitive output in
clear text.

>

cli: the security levels are shown via the CLI commands
configuration.

OPTIONAL

The default is pretty.
string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

RELATED COMMANDS:
firewall level add

Add a security level.

firewall level delete

Delete a security level.

E-DOC-CTC-20061027-0003 v2.0

361

Firewall Commands

firewall level modify
Configure a security level.

SYNTAX:
firewall level modify

name = 
[index = ]
[readonly = <{disabled | enabled}>]
[udptrackmode = <{strict | loose}>]
[service = <{disabled | enabled}>]
[proxy = <{disabled|enabled}>]
[text = ]

where:
name

The name of the security level to be added.

REQUIRED

index

The index of the security level.

OPTIONAL

Use the command :firewall level list to
obtain a list of indexes.

Tip
readonly

Select whether the security level is readonly (enabled) or not
(disabled).

OPTIONAL

udptrackmode

Select the UDP connection tracking mode.
Choose between:

OPTIONAL

>

strict: replies to a request from a client must be in a specific
window to the client.

>

loose: inbound packets are allowed on the port that was
first used to start the communication with the server (for
example to allow a client of an online game to obtin peerto-peer information from other clients of that same online
game).

The default is strict.
proxy

Enable or disable proxy system services for this security level.

OPTIONAL

service

Disable or enable service definitions for this security level.

OPTIONAL

text

Description of the security level.

OPTIONAL

Note

362

The maximum length is 39 characters.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall level set
Set the security level or display the current security level.

SYNTAX:
firewall level set

[name = ]

where:
name

The name of the security level to be set.
Note

E-DOC-CTC-20061027-0003 v2.0

OPTIONAL

If no security level is specified, the current security
level will be shown.

363

Firewall Commands

firewall rule add
Add a firewall rule.

SYNTAX:
firewall rule add

i

chain = 
[index = ]
[name = ]
[clink = ]
[srcintf [!]= ]
[srcip [!]= ]
[dstip [!]= ]
[serv [!]= ]
[log = <{disabled | enabled}>]
[state = <{disabled | enabled}>]
action = <{accept|deny|drop|reset|count|link}>

If a value is preceded by a “!”, it means NOT.
For example “srcintf=!wan” means “if the source interface is different from WAN”.

where:
chain

The name of the chain which contains the rule.

REQUIRED

index

The number of the rule in the chain.

OPTIONAL

name

The name of the new rule.

OPTIONAL

clink

The name of the chain to be parsed when this rule applies.

OPTIONAL

srcintf

The name of the source interface expression.

OPTIONAL

srcip

The name of the source IP expression.

OPTIONAL

dstintf

The name of the destination interface expression.

OPTIONAL

dstip

The name of the destination IP expression.

OPTIONAL

serv

The name of the service expression.

OPTIONAL

log

Disable or enable logging is done when this rule applies.

OPTIONAL

state

Enable or disable this rule.

OPTIONAL

action

The action to be taken when this rule applies ('link' when clink is used).

REQUIRED

RELATED COMMANDS:

364

firewall rule delete

Delete a firewall rule.

expr list

List the expressions.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall rule delete
Delete a firewall rule.

SYNTAX:
firewall rule delete

chain = 
index = 

where:
chain

The name of the chain in which a rule must be deleted.

REQUIRED

index

The number of the rule in the chain.

REQUIRED

RELATED COMMANDS:
firewall rule add

E-DOC-CTC-20061027-0003 v2.0

Add a firewall rule.

365

Firewall Commands

firewall rule flush
Flush all firewall rules.

SYNTAX:
firewall rule flush

[chain = ]

where:
chain

The name of the chain for which the rules must be flushed.
Note

366

OPTIONAL

If not specified, the rules of all the chains will be
flushed.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall rule list
Show a list of the firewall rules in a chain.

SYNTAX:
firewall rule list

[chain = ]
[format = <{pretty | cli}>]
[string = ]
[beginstring = ]

where:
chain

The name of the chain for which the rules must be listed.
Note

format

If not specified, the rules of all the chains are shown.

Select the output format in which the list must be shown.
Choose between:

>
>

OPTIONAL

OPTIONAL

pretty: the list is shown as intuitive output in clear text.
cli: the list is shown via the CLI commands configuration.

The default is pretty.
string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

367

Firewall Commands

EXAMPLE:
=>firewall rule list
Rules (flags: C=Constant, D=Dynamic, E=Enable, L=Log)
=====
Chain
Nr. Flags Rule
--------------------------------------------------------------------------------------sink
1
CDE
: link
sink_fire
2
CDE
: link
sink_system_service
sink_fire
1
C E
SSDP
: accept ssdp_serv lan.* > *.ssdp_ip
sink_system_service
1
CDE
HTTPI
: accept HTTPI_sv_0 HTTPI_if_0.* > *.*
2
DE
PING_RESPONDER : accept PING_RESPONDER_sv_0 PING_RESPON
DER_
if_0.* > *.*
3
CD
SENDTO_LISTEN
: accept SENDTO_LISTEN_sv_0 *.* > *.*
4
D
ICMP_LISTEN
: accept ICMP_LISTEN_sv_0 *.* > *.*
5
CD
SRAS
: accept SRAS_sv_0 *.* > *.*
6
CD
RAS
: accept RAS_sv_0 *.* > *.*
7
CDE
MDAP
: accept MDAP_sv_0 *.* > *.*
8
CDE
SNMP_AGENT
: accept SNMP_AGENT_sv_0 SNMP_AGENT_
if_0.* > *.*
9
CD
DHCP-S
: accept DHCP-S_sv_0 *.* > *.*
10
CDE
DHCP-R
: accept DHCP-R_sv_0 DHCP-R_if_0.* > *.*
11
CDE
DNS-S
: accept DNS-S_sv_0 DNS-S_if_0.* > *.*
12
CD
RIP-Query
: accept RIP-Query_sv_0 *.* > *.*
13
CDE
RIP
: accept RIP_sv_0 *.* > *.*
14
CDE
TELNET
: accept TELNET_sv_0 TELNET_if_0.* > *.*
15
CDE
FTP
: accept FTP_sv_0 FTP_if_0.* > *.*
16
CDE
HTTPs
: accept HTTPs_sv_0 HTTPs_if_0.* > *.*
17
CDE
HTTP
: accept HTTP_sv_0 HTTP_if_0.* > *.*
forward
1
CDE
: link
forward_fire
2
CDE
: link
forward_host_service
3
CDE
: link
forward_level
forward_level
1
CDE
: link
forward_level_Disabled
forward_level_Disabled 1
C E
AnyTraffic
: accept *.* > *.*
source
1
CDE
: link
source_fire
source_fire
1
C E
AnyTraffic
: accept *.* > *.*
=>
=>firewall rule list format=cli
:firewall rule add chain=sink_fire index=1 name=SSDP srcintf=lan dstip=ssdp_ip serv=ssdp_serv
| log=disabled state=enabled action=accept
:firewall rule add chain=source_fire index=1 name=AnyTraffic log=disabled state=enabled
| action=accept
:firewall rule add chain=forward_level_BlockAll index=1 name=AnyTraffic log=disabled state=en
abled
| action=drop
:firewall rule add chain=forward_level_Standard index=1 name=FromLAN srcintf=lan log=disabled
| state=enabled action=accept
:firewall rule add chain=forward_level_Disabled index=1 name=AnyTraffic log=disabled state=en
abled
| action=accept
=>

368

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

firewall rule modify
Modify a firewall rule.

SYNTAX:
firewall rule modify

i

chain = 
index = 
[newindex = ]
[name = ]
[clink = ]
[srcintf [!]= ]
[srcip [!]= ]
[dstintf [!]= ]
[dstip [!]= ]
[serv [!]= ]
[log = <{disabled | enabled}>]
[state = <{disabled | enabled}>]
[action = ]

If a value is preceded by a “!”, it means NOT.
For example “srcintf=!wan” means “if the source interface is different from WAN”.
where:
chain

The name of the chain which contains the rule.

REQUIRED

index

The number of the rule in the chain.

REQUIRED

newindex

The number of the rule in the chain.

OPTIONAL

name

The name of the new rule.

OPTIONAL

clink

The name of the chain to be parsed when this rule applies.

OPTIONAL

srcintf

The name of the source interface expression.

OPTIONAL

srcip

The name of the source IP expression.

OPTIONAL

dstintf

The name of the destination interface expression.

OPTIONAL

dstip

The name of the destination IP expression.

OPTIONAL

serv

The name of the service expression.

OPTIONAL

log

Disable or enable logging when this rule applies.

OPTIONAL

state

Disable or enable this rule.

OPTIONAL

action

The action to be taken when this rule applies ('link' when clink
is used).

OPTIONAL

RELATED COMMANDS:
firewall rule delete

Delete a firewall rule.

expr list

List the expressions.

E-DOC-CTC-20061027-0003 v2.0

369

Firewall Commands

firewall rule debug clear
Clear the firewall rule statistics.

SYNTAX:
firewall rule debug clear

[chain = ]
[index = ]

where:
chain

The name of the chain which contains the rule.

OPTIONAL

index

The number of the rule in the chain.

OPTIONAL

Note

370

If not specified, the statistics for all the rules in the
chain will be cleared.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

EXAMPLE:
=>firewall rule debug stats
chain
index
packets
bytes
---------------------------------------------------------------------------sink
1
0
0
2
4
192
forward
1
0
0
2
0
0
3
10
480
source
1
0
0
sink_fire
1
0
0
source_fire
1
0
0
forward_level
1
10
480
sink_system_service
1
1
48
2
0
0
...
16
0
0
17
2
96
forward_level_BlockAll
1
0
0
forward_level_Standard
1
0
0
forward_level_Disabled
1
10
480
=>firewall rule debug clear
=>firewall rule debug stats
chain
index
packets
bytes
---------------------------------------------------------------------------sink
1
0
0
2
0
0
forward
1
0
0
2
0
0
3
0
0
source
1
0
0
sink_fire
1
0
0
source_fire
1
0
0
forward_level
1
0
0
sink_system_service
1
0
0
2
0
0
...
16
0
0
17
0
0
forward_level_BlockAll
1
0
0
forward_level_Standard
1
0
0
forward_level_Disabled
1
0
0
=>

RELATED COMMANDS:
firewall rule debug
stats

E-DOC-CTC-20061027-0003 v2.0

Show the firewall rule statistics.

371

Firewall Commands

firewall rule debug stats
Show the firewall rule statistics.

SYNTAX:
firewall rule debug stats

[chain = ]
[index = ]

where:
chain

The name of the chain for which the statistics must be shown.
Note

index

372

If not specified, the statistics for all the chains will be
shown.

The number of the rule in the chain.
Note

OPTIONAL

OPTIONAL

If not specified, the statistics for all the rules in the
chain are shown.

E-DOC-CTC-20061027-0003 v2.0

Firewall Commands

EXAMPLE:
=>firewall rule debug stats
chain
index
packets
bytes
---------------------------------------------------------------------------sink
1
0
0
2
4
192
forward
1
0
0
2
0
0
3
10
480
source
1
0
0
sink_fire
1
0
0
source_fire
1
0
0
forward_level
1
10
480
sink_system_service
1
1
48
2
0
0
3
0
0
4
0
0
5
0
0
6
0
0
7
0
0
8
0
0
9
0
0
10
0
0
11
0
0
12
0
0
13
0
0
14
1
48
15
0
0
16
0
0
17
2
96
forward_level_BlockAll
1
0
0
forward_level_Standard
1
0
0
forward_level_Disabled
1
10
480
=>

RELATED COMMANDS:
firewall rule debug clear

E-DOC-CTC-20061027-0003 v2.0

Clear the firewall rule statistics.

373

Firewall Commands

firewall rule debug traceconfig
Display or modify the rule trace configuration.

SYNTAX:
firewall rule debug traceconfig

[trace = <{disabled | enabled}>]

where:
trace

Enable or disable rule traces.
The default is disabled.

OPTIONAL

EXAMPLE:
=>firewall rule debug traceconfig
:firewall rule debug traceconfig state=disabled
=>

374

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

17 GRP Commands
Introduction
This chapter describes the commands of the grp command group.

Contents
This chapter covers the following commands:
grp config

Set the Generic Routing Protocol (GRP) configuration settings.

376

grp flush

Flush the GRP interface settings and parameters.

377

grp rtlist

Show the current routes in the GRP interfaces routing table.

378

grp rip config

Configure the RIP settings.

379

grp rip flush

Flush the RIP interface settings and global parameters.

382

grp rip ifconfig

Configure a RIP interface.

383

grp rip show

Show the RIP settings and the routes in the RIP database.

385

E-DOC-CTC-20061027-0003 v2.0

375

GRP Commands

grp config
Set the Generic Routing Protocol (GRP) configuration settings.

SYNTAX:
grp config

[cdistance = ]
[kdistance = ]
[rdistance = ]
[trace = <{disabled | enabled}>]

where:
cdistance

A number between 0 and 255.
Sets the distance of the connected route type.
The default is 0.

OPTIONAL

kdistance

A number between 0 and 255.
Sets the distance of the kernel route type.
The default is 1.

OPTIONAL

rdistance

A number between 0 and 255.
Sets the distance of the RIP route type.
The default is 120.

OPTIONAL

trace

Enable or disable verbose console messaging.
The default is disabled.

OPTIONAL

EXAMPLE:
=>grp config
Distance of the connected route type : 0
Distance of the kernel route type : 1
Distance of the RIP route type : 120
Tracing : disabled
=>

376

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

grp flush
Flush the GRP interface settings and parameters.

SYNTAX:
grp flush

E-DOC-CTC-20061027-0003 v2.0

377

GRP Commands

grp rtlist
Show the current routes in the GRP interfaces routing table.

SYNTAX:
grp rtlist

[dst = ]
[dstmask = ]

where:
dst

The destination IP address of the route.
Supports IP/mask notation.
Note

dstmask

OPTIONAL

If no destination IP address is specified, all the current routes
will be shown.

The destination IP address mask, either in dotted or in numerical cidr
notation.

OPTIONAL

EXAMPLE:
=>grp rtlist
Codes : K - kernel, C - connected, S - static, R - rip, * - FIB route
destination : 10.0.0.0/24 *
Route type : "C"
distance : 0
Nexthop : LocalNetwork
destination : 10.0.0.0/24
Route type : "K"
distance : 1
Nexthop : 10.0.0.138
destination : 127.0.0.0/8 *
Route type : "C"
distance : 0
Nexthop : loop
destination : 192.168.1.0/24 *
Route type : "C"
distance : 0
Nexthop : LocalNetwork
destination : 192.168.1.0/24
Route type : "K"
distance : 1
Nexthop : 192.168.1.254
destination : 255.255.255.255/32 *
Route type : "K"
distance : 1
Nexthop : 127.0.0.1
=>

378

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

grp rip config
Configure the RIP settings.

SYNTAX:
grp rip config

state = <{disabled | enabled}>
[version = <{rip_unspec | rip_v1 | rip_v2}>]
[defmetric = ]
[updatetime = ]
[timeouttime = ]
[garbagetime = ]
[impcrt = <{disabled | enabled}>]
[impkrt = <{disabled | enabled}>]
[impsrt = <{disabled | enabled}>]
[impdefkrt = <{disabled | enabled}>]
[impdefsrt = <{disabled | enabled}>]
[exprt = <{disabled | enabled}>]
[expdefrt = <{disabled | enabled}>]
[txdefrt = <{disabled | enabled}>]
[trace = <{disabled | enabled}>]

where:
state

Enable or disable the RIP daemon.
The default is enabled.

REQUIRED

version

Configure the RIP version to be applied.
Choose between:

OPTIONAL

>

rip_unspec: No RIP version is specified as such. The actual RIP
version to be used is negotiated with the remote side.

>
>

rip_v1: RIP version 1 is used.
rip_v2: RIP version 2 is used.

The default is rip_v2.
defmetric

A number between 1 and 16 (hops).
Represents the default RIP metric for imported routes.
The default is 1.

OPTIONAL

updatetime

A number between 1 and 3600 (seconds).
Represents the update timer value of the RIP routing table.
The default is 30.

OPTIONAL

timeouttime

A number between 1 and 3600 (seconds).
Represents the timeout timer value of the RIP routing info.
The default is 180.

OPTIONAL

garbagetime

A number between 1 and 3600 (seconds).
Represents the garbage collection timer value.
The default is 120.

OPTIONAL

impcrt

Enable or disable the import of connected routes.
The default is enabled.

OPTIONAL

impkrt

Enable or disable the import of kernel routes.
The default is enabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

379

GRP Commands

380

impsrt

Enable or disable the import of static routes.
The default is enabled.

OPTIONAL

impdefkrt

Enable or disable the import of the default kernel route.
The default is enabled.

OPTIONAL

impdefsrt

Enable or disable the import of the default static route.
The default is enabled.

OPTIONAL

exprt

Enable or disable the export of received RIP routes.
The default is enabled.

OPTIONAL

expdefrt

Enable or disable the export of the received RIP default route.
The default is enabled.

OPTIONAL

txrt

Enable or disable the transmission of the RIP default route.
The default is enabled.

OPTIONAL

trace

Enable or disable verbose console messaging.
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

EXAMPLE:
=>grp rip show
RIP routing protocol config dump
-----------------------------------RIP daemon is enabled
Global RIP queries received : 0
Global RIP route changes : 0
Default version : send rip_v2, receive rip_v2
Default redistribution metric is 1
Sending routing table updates every 30 seconds with +/-5%
Route timeout after 180 seconds
Route garbage collect after 120 seconds
Import of connected routes is enabled
Import of kernel routes is enabled
Import of static routes is enabled
Import of default kernel route is enabled
Import of default static route is enabled
Export of RIP routes is enabled
Export of default RIP route is enabled
Transmission of default RIP route is enabled
Interface
Send
Recv
AuthMode
Passive SplitHorizon BadPackets
BadRoutes SentUpdates
--------------------------------------------------------------------------------------------------------------lan1
rip_unspec
rip_unspec
none
enabled enabled
0
0
0
Internet
rip_unspec
rip_unspec
none
enabled enabled
0
0
0
RIP routing table dump
-------------------------Codes : K - Kernel, C - connected, S - Static, R - RIP, * - FIB route
Network
Next Hop
Metric From
Flags
---------------------------------------------------------------------C 10.0.0.0/24
1
<> *
C 192.168.1.0/24
1
<> *
=>

RELATED COMMANDS:
grp rip show

E-DOC-CTC-20061027-0003 v2.0

Show the RIP settings and the routes in the RIP database.

381

GRP Commands

grp rip flush
Flush the RIP interface settings and global parameters.

SYNTAX:
grp rip flush

382

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

grp rip ifconfig
Configure a RIP interface.

SYNTAX:
grp rip ifconfig

intf = 
[rip = <{disabled | enabled}>]
[rxversion = <{rip_unspec | rip_v1 | rip_v2 | rip_v1-2}>]
[authmode = <{none | cleartext}>]
[authstring = ]
[splithorizon = <{disable | enable}>]

where:
intf

The name of the RIP interface to be configured.

REQUIRED

Use the command :grp iflist to obtain a list of available interfaces.

Tip
rip

Enabled or disabled RIP on this interface.
The default is disabled.

OPTIONAL

rxversion

Configure the RIP receive version to be applied.
Choose between:

OPTIONAL

>

rip_unspec: No RIP version is specified as such. The actual RIP
version to be used is negotiated with the remote side.

>
>
>

rip_v1: RIP version 1 is used.
rip_v2: RIP version 2 is used.
rip_v1-2: RIP version 1 and RIP version 2 are used.

The default is rip_unspec.
authmode

Configure the RIP authentication mode.
Enter the mode in cleartext or specify none in case no authentication
mode is required.
The default is none.

OPTIONAL

authstring

Configure the authentication string for the RIP authentication
password.

OPTIONAL

Note
splithorizon

E-DOC-CTC-20061027-0003 v2.0

Leave authstring unspecified in case authmode is none.

Enable or disable the split horizon status for this interface.
The default is enabled.

OPTIONAL

383

GRP Commands

EXAMPLE:
=>grp rip ifconfig
intf = myPPP_ppp
[rip] = disabled
[rxversion] = rip_unspec
[authmode] = none
[authstr] =
[passive] = disabled
[splithorizon] = enabled
:grp rip ifconfig intf=myPPP_ppp
=>

384

E-DOC-CTC-20061027-0003 v2.0

GRP Commands

grp rip show
Show the RIP settings and the routes in the RIP database.

SYNTAX:
grp rip show

EXAMPLE:
=>grp rip show
RIP routing protocol config dump
-----------------------------------RIP daemon is enabled
Global RIP queries received : 0
Global RIP route changes : 3
Default version : send rip_v2, receive rip_v2
Default redistribution metric is 1
Sending routing table updates every 30 seconds with +/-5%
Route timeout after 180 seconds
Route garbage collect after 120 seconds
Import of connected routes is enabled
Import of kernel routes is enabled
Import of static routes is enabled
Import of default kernel route is enabled
Import of default static route is enabled
Export of RIP routes is enabled
Export of default RIP route is enabled
Transmission of default RIP route is enabled
Intf
Send
Recv
AuthMode Passive
SplitHorizon BadPackets BadRoutes SentUpd
ates
-----------------------------------------------------------------------------------------------eth0
rip_unspec rip_unspec none
off
on
0
58
62
RIP route table dump
---------------------Codes : K - Kernel, C - connected, S - Static, R - RIP, * - FIB route
Network
Next Hop
Metric
From
Flags
--------------------------------------------------------------------R 0.0.0.0/0
192.6.11.150
3
192.6.11.150
<> *
C 10.0.0.0/8
1
<> *
K 129.132.2.21/32
138.203.7.146
1
<> *
C 138.203.4.0/22
1
<> *
C 172.16.1.0/24
1
<> *
=>

E-DOC-CTC-20061027-0003 v2.0

385

GRP Commands

386

E-DOC-CTC-20061027-0003 v2.0

Hostmgr Commands

18 Hostmgr Commands
Introduction
This chapter describes the commands of the hostmgr command group.

Contents
This chapter covers the following commands:
hostmgr add

Add host device info to the host manager.

388

hostmgr clear

Remove all the hosts from the list.

390

hostmgr config

Configure the host manager parameters.

391

hostmgr delete

Delete the host device info from the host manager.

392

hostmgr flush

Flush the host manager configuration.

393

hostmgr list

List all the host devices.

394

E-DOC-CTC-20061027-0003 v2.0

387

Hostmgr Commands

hostmgr add
Add host device info to the host manager.

SYNTAX:
hostmgr add

mac_addr = 
[ip_addr = ]
[name = ]
[type = <{generic_device|desktop_computer|laptop_computer|
set_top_box|pda|gaming_console|phone|mobile_phone|
printer|mass_storage_device}>]
[ipintf = ]
[ethintf = ]
[physintf = ]

where:
mac_addr

The MAC address of the host to be added.

REQUIRED

ip_addr

The host IP address.

OPTIONAL

name

The host name.

OPTIONAL

type

The host type.
Choose between:

OPTIONAL

>
>
>
>
>
>
>
>
>
>

generic_device
desktop_computer
laptop_computer
set_top_box
pda
gaming_console
phone
mobile_phone
printer
mass_storage_device

The default is Generic Device.

388

ipintf

The IP interface name.

OPTIONAL

ethintf

The Ethernet interface name.

OPTIONAL

physintf

The physical interface name.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Hostmgr Commands

EXAMPLE:
=>hostmgr list
MAC-address
IP-address
-------------------00:10:a4:ad:32:cf 192.168.1.64

Flags Type
----- ---C
Generic Device

Intf
---LocalNetwork

Hw Intf
------ethif4

Hostname
-------MyComputer

=>hostmgr add mac_addr=00:10:a4:33:56:53 name=Play type=Playstation
=>hostmgr list
MAC-address
IP-address
Flags Type
Intf
------------------------ ------00:10:a4:33:56:53 0.0.0.0
Playstation
ethif1
00:10:a4:ad:32:cf 192.168.1.64
C
Generic Device LocalNetwork

Hw Intf
------ethif1
ethif4

Hostname
-------Play
MyComputer

=>

RELATED COMMANDS:
hostmgr delete

Delete the host device info from the host manager.

hostmgr list

List all the host devices.

E-DOC-CTC-20061027-0003 v2.0

389

Hostmgr Commands

hostmgr clear
Remove all the hosts from the list.

SYNTAX:
hostmgr clear

EXAMPLE:
=>hostmgr list
MAC-address
----------00:10:a4:33:56:53
00:10:a4:ad:32:cf
er

IP-address
---------0.0.0.0
192.168.1.64

Flags
----C

Type
---Playstation
Generic Device

Intf
---ethif1
LocalNetwork

Hw Intf
------ethif1
ethif4

Hostname
-------Play
MyComput

=>hostmgr clear
=>hostmgr list
No hosts found.
=>

RELATED COMMANDS:
hostmgr delete

390

Delete the host device info from the host manager.

E-DOC-CTC-20061027-0003 v2.0

Hostmgr Commands

hostmgr config
Configure the host manager parameters.

SYNTAX:
hostmgr config

[state = <{disabled | enabled}>]
[scantime = ]
[autosave = <{disabled | enabled}>]
[trace = <{disabled | enabled}>]

where:
state

Enable or disable the host manager daemon.
The default is enabled.

OPTIONAL

scantime

A number between 10 an 600 (seconds).
Represents the time between two scans.
The default is 30 (seconds).

OPTIONAL

autosave

Enable or disable automatic saves to flash memory.
The default is enabled.

OPTIONAL

trace

Enable or disable the host manager traces.
The default is disabled.

OPTIONAL

EXAMPLE:
=>hostmgr config
state
: enabled
scantime : 30 sec.
autosave : enabled
trace
: disabled
=>

E-DOC-CTC-20061027-0003 v2.0

391

Hostmgr Commands

hostmgr delete
Delete the host device info from the host manager.

SYNTAX:
hostmgr delete

mac_addr = 

where:
mac_addr

The MAC address of the host to be removed.

REQUIRED

EXAMPLE:
=>hostmgr list
MAC-address
----------00:10:a4:33:56:53
00:10:a4:ad:32:cf
er

IP-address
---------0.0.0.0
192.168.1.64

Flags
----C

Type
---Playstation
Generic Device

=>hostmgr delete mac_addr=00:10:a4:fa:33:56
=>hostmgr list
MAC-address
IP-address
Flags
Type
--------------------------00:10:a4:ad:32:cf 192.168.1.64
C
Generic Device
er

Intf
---ethif1
LocalNetwork

Hw Intf
------ethif1
ethif4

Hostname
-------Play
MyComput

Intf
---LocalNetwork

Hw Intf
------ethif4

Hostname
-------MyComput

=>

RELATED COMMANDS:

392

hostmgr add

Add host device info to the host manager.

hostmgr clear

Remove all the hosts from the list.

hostmgr list

List all the host devices.

E-DOC-CTC-20061027-0003 v2.0

Hostmgr Commands

hostmgr flush
Flush the host manager configuration.
The host manager configuration is cleaned and returned to default values.

SYNTAX:
hostmgr flush

E-DOC-CTC-20061027-0003 v2.0

393

Hostmgr Commands

hostmgr list
List all the host devices.

SYNTAX:
hostmgr list

EXAMPLE:
=>hostmgr list
MAC-address
----------00:10:a4:33:56:53
00:10:a4:ad:32:cf
er

IP-address
---------0.0.0.0
192.168.1.64

Flags
----C

Type
---Playstation
Generic Device

Intf
---ethif1
LocalNetwork

Hw Intf
------ethif1
ethif4

Hostname
-------Play
MyComput

=>

RELATED COMMANDS:

394

hostmgr add

Add host device info to the host manager.

hostmgr delete

Delete the host device info from the host manager.

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

19 IDS Commands
Introduction
This chapter describes the commands of the ids command group.

Contents
This chapter covers the following commands:
ids clear

Reset the IDS statistics.

396

ids config

Display/modify the Intrusion Detection System (IDS) configuration.

397

ids parser list

Display the IDS parser configuration.

398

ids parser modify

Modify the IDS parser configuration.

399

ids pattern clear

Reset the pattern tracker.

401

ids pattern list

Display the patterns in the pattern tracker.

402

ids pattern stats

Display the pattern tracker statistics.

403

ids signature list

Displays the ids signature configuration

404

ids signature
modify

Modify the states of the signatures.

405

ids threshold clear

Reset the IDS thresholds to their default values.

406

ids threshold list

Display the IDS thresholds.

407

ids threshold
modify

Modify the IDS thresholds.

408

E-DOC-CTC-20061027-0003 v2.0

395

IDS Commands

ids clear
Reset the IDS statistics.

SYNTAX:
ids clear

RELATED COMMANDS:
ids parser list

396

Display the IDS parser configuration.

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids config
Display/modify the Intrusion Detection System (IDS) configuration.

SYNTAX:
ids config

[state = <{disabled | enabled}>]
[trace = <{disabled|enabled}>]

where:
state

Enable or disable IDS checks.
The default is enabled.

OPTIONAL

trace

Enable or disable tracing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>ids config
IDS configuration:
=================
state : enabled
traces ::disabled
=>

E-DOC-CTC-20061027-0003 v2.0

397

IDS Commands

ids parser list
Display the IDS parser configuration.

SYNTAX:
ids parser list

[parser = ]

where:
parser

The name of the parser

REQUIRED

EXAMPLE:
=>ids parser list
parser
state
----------------------------------------fragment
enabled
scan
enabled
dos
enabled
proto
enabled
rate
enabled
=>

398

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids parser modify
Modify the IDS parser configuration.

SYNTAX:
ids parser modify

parser = 
state = <{disabled | enabled}>

where:
parser

The name of the IDS parser of which the configuration must be modifi
ed.

REQUIRED

state

Disable or enable the parser.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

399

IDS Commands

EXAMPLE:
=>ids list
Resources:
==========
resource
total maximum
--------------------------------parsers
5
10
signatures
38
50
Signatures:
==========
parser
signature
hits action
state
--------------------------------------------------------------------------------------fragment
fragment sweep
0 log, drop
enabled
fragment
zero-length fragment size
0 log, drop
enabled
fragment
small fragment size
0 log, drop
enabled
fragment
fragment size overrun
0 log, drop
enabled
fragment
fragment overlap
0 log, drop
enabled
fragment
fragment out-of-order
0 log
enabled
...
=>ids parser modify parser=fragment state=disabled
=>ids list
Resources:
==========
resource
total maximum
--------------------------------parsers
5
10
signatures
38
50
Signatures:
==========
parser
signature
hits action
state
--------------------------------------------------------------------------------------fragment
fragment sweep
0 log, drop
disabled
fragment
zero-length fragment size
0 log, drop
disabled
fragment
small fragment size
0 log, drop
disabled
fragment
fragment size overrun
0 log, drop
disabled
fragment
fragment overlap
0 log, drop
disabled
fragment
fragment out-of-order
0 log
disabled
...
=>

400

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids pattern clear
Reset the pattern tracker.

SYNTAX:
ids pattern clear

EXAMPLE:
=>ids pattern stats
Pattern tracker statistics:
--------------------------memory
maximum number of patterns
number of active patterns
number of recycled patterns
number of pattern searches
number of new patterns
maximum number of hash collisions
% of hash entries with collisions
% of hash entries unused
=>ids pattern clear
=>ids pattern stats
Pattern tracker statistics:
--------------------------memory
maximum number of patterns
number of active patterns
number of recycled patterns
number of pattern searches
number of new patterns
maximum number of hash collisions
% of hash entries with collisions
% of hash entries unused
=>

:
:
:
:
:
:
:
:
:

32768 bytes
512
8
0
9
8
1
0.09
99.31

:
:
:
:
:
:
:
:
:

32768 bytes
512
0
0
0
0
0
0.00
100.00

RELATED COMMANDS:
ids pattern list

Display the patterns in the pattern tracker.

ids pattern stats

Display the pattern tracker statistics.

E-DOC-CTC-20061027-0003 v2.0

401

IDS Commands

ids pattern list
Display the patterns in the pattern tracker.

SYNTAX:
ids pattern list

[size = <{10 | 100 | full} or number>]

where:
size

The size of the IDS pattern list that will be shown.
Choose between:

>
>
>

OPTIONAL

10
100
full

or, alternatively, specify a number.
The default is full.

EXAMPLE:
=>ids pattern list
1. #
40002# UDP
period: [00001564..00001565]
2. #
30002# UDP
period: [00001564..00001566]
3. #
5000a# UDP
period: [00001411..00001425]
=>

*.*.*.*:*

->

*.*.*.*:*

count:1

*.*.*.*:*

-> 255.255.255.255:67

count:1

*.*.*.*:*

-> 255.255.255.255:*

count:1

RELATED COMMANDS:

402

ids pattern clear

Reset the pattern tracker.

ids pattern stats

Display the pattern tracker statistics.

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids pattern stats
Display the pattern tracker statistics.

SYNTAX:
ids pattern stats

EXAMPLE:
=>ids pattern stats
Pattern tracker statistics:
--------------------------memory
maximum number of patterns
number of active patterns
number of recycled patterns
number of pattern searches
number of new patterns
maximum number of hash collisions
% of hash entries with collisions
% of hash entries unused
=>

:
:
:
:
:
:
:
:
:

32768 bytes
512
8
0
9
8
1
0.09
99.31

RELATED COMMANDS:
ids pattern clear

Reset the pattern tracker.

ids pattern list

Display the patterns in the pattern tracker.

E-DOC-CTC-20061027-0003 v2.0

403

IDS Commands

ids signature list
Displays the ids signature configuration

SYNTAX
ids signature list

[signature = ]

where
signature

The name of the signature

OPTIONAL

EXAMPLE:
=>ids signature list signature fragment_sweep
signature
parser
hits action
state
------------------------------------------------------------------------------------fragment_sweep
fragment
0 log
enabled
=>

404

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids signature modify
Modify the states of the signatures.

SYNTAX
ids signature modify

[signature = ]
state = <{disabled|enabled}>

where
signature

The name of the signature

REQUIRED

state

The desired state of the signature.

REQUIRED

EXAMPLE:
=>ids signature modify
[signature] = ip_protocol_scan
state = disabled
:ids signature modify signature=ip_protocol_scan state=disabled
=>

E-DOC-CTC-20061027-0003 v2.0

405

IDS Commands

ids threshold clear
Reset the IDS thresholds to their default values.

SYNTAX:
ids threshold clear

EXAMPLE:
=>ids threshold list
index name
window
limit scaling
----------------------------------------------------------------1. ids scan
20
20 enabled
2. ids flood
2
100 disabled
3. ids tcp rate
10
300 enabled
4. ids udp rate
1
200 disabled
5. ids icmp rate
1
200 disabled
6. ids ip rate
1
200 disable
=>ids threshold clear
=>ids threshold list
index name
window
limit scaling
----------------------------------------------------------------1. ids scan
20
20 enabled
2. ids flood
2
100 disabled
3. ids tcp rate
1
200 disabled
4. ids udp rate
1
200 disabled
5. ids icmp rate
1
200 disabled
6. ids ip rate
1
200 disabled
=>

RELATED COMMANDS:

406

ids threshold list

Display the IDS thresholds.

ids threshold modify

Modify the IDS thresholds.

E-DOC-CTC-20061027-0003 v2.0

IDS Commands

ids threshold list
Display the IDS thresholds.

SYNTAX:
ids threshold list

EXAMPLE:
=>ids threshold list
index name
window
limit scaling
----------------------------------------------------------------1. ids scan
20
20 enabled
2. ids flood
2
100 disabled
3. ids tcp rate
1
200 disabled
4. ids udp rate
1
200 disabled
5. ids icmp rate
1
200 disabled
6. ids ip rate
1
200 disabled
=>

RELATED COMMANDS:
ids threshold clear

Reset the IDS thresholds to their default values.

ids threshold modify

Modify the IDS thresholds.

E-DOC-CTC-20061027-0003 v2.0

407

IDS Commands

ids threshold modify
Modify the IDS thresholds.

SYNTAX:
ids threshold modify

index = 
[window = ]
[limit = ]
[scaling = <{disabled | enabled}>]

where:
index

The index of the IDS threshold to be modified.
Tip

REQUIRED

Use the command :ids threshold list to obtain the indexes.

window

A number (of seconds).
Represents the time window of the threshold.

OPTIONAL

limit

A number.
Represents the limit of the threshold.

OPTIONAL

scaling

Enable or disable scaling of the threshold window.

OPTIONAL

EXAMPLE:
=>ids threshold list
index name
window
limit scaling
----------------------------------------------------------------1. ids scan
20
20 enabled
2. ids flood
2
100 disabled
3. ids tcp rate
1
200 disabled
4. ids udp rate
1
200 disabled
5. ids icmp rate
1
200 disabled
6. ids ip rate
1
200 disabled
=>ids threshold modify index=3 window=10 limit=300 scaling=enabled
=>ids threshold list
index name
window
limit scaling
----------------------------------------------------------------1. ids scan
20
20 enabled
2. ids flood
2
100 disabled
3. ids tcp rate
10
300 enabled
4. ids udp rate
1
200 disabled
5. ids icmp rate
1
200 disabled
6. ids ip rate
1
200 disable
=>

RELATED COMMANDS:

408

ids threshold clear

Reset the IDS thresholds to their default values.

ids threshold list

Display the IDS thresholds.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

20 IGMP Commands
Introduction
This chapter describes the commands of the IGMP command group.

Contents
This chapter covers the following commands:
igmp host config

Display or modify global IGMP configuration.

410

igmp host flush

Flush the IGMP settings.

411

igmp host list

Show the IGMP groups.

412

igmp host debug clear

Show the IGMP groups.

412

igmp host ifconfig

Configure an IGMP interface.

413

igmp host iflist

Show the configuration of the IGMP interfaces.

414

igmp host debug clear

Clear IGMP statistics.

415

igmp host debug stats

Print IGMP statistics.

416

igmp proxy config

Configure the IGMP proxy.

417

igmp proxy flush

Flush all IGMP proxy settings and learned groups.

419

igmp proxy grouplist

Show the learned groups on an IGMP proxy interface.

420

igmp proxy ifconfig

Configure an IGMP proxy interface.

421

igmp proxy iflist

Show the configuration of an IGMP proxy interface.

422

igmp proxy mbslist

Show the IGMP proxy membership database (merge of all
learned groups.

423

igmp proxy config

Clear IGMP proxy statistics.

424

igmp proxy debug stats

Print IGMP proxy statistics.

425

igmp proxy debug
traceconfig

Modify IGMP proxy trace configuration.

426

E-DOC-CTC-20061027-0003 v2.0

409

IGMP Commands

igmp host config
Display or modify global IGMP configuration.

SYNTAX:
igmp host config

[requirera = <{disabled | enabled}>]

where:
requirera

Enable or disable the router alert IP option check.
The default is disabled.

OPTIONAL

EXAMPLE:
=>igmp host confighostmgr list
Router alert IP option check : disabled
=>

RELATED COMMANDS:
igmp host debug
clear

410

Show the IGMP groups.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp host flush
Flush the IGMP settings.

SYNTAX:
igmp host flush

E-DOC-CTC-20061027-0003 v2.0

411

IGMP Commands

igmp host list
Show the IGMP groups.

SYNTAX:
igmp host list

[intf = ]
[expand = <{disabled | enabled}>]

where:
intf

The IP interface name.

OPTIONAL

expand

Enable or disable expanded listing of IGMP groups.
The default is disabled.

OPTIONAL

EXAMPLE:
=>igmp host list
Interface
4
lan1
4
lan1
=>

412

Group
224.0.0.103
239.255.255.250

Filter-Mode
EXCLUDE
EXCLUDE

Source
none
none

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp host ifconfig
Configure an IGMP interface.

SYNTAX:
igmp host ifconfig

intf = 
version = <{none |IGMPv1 |IGMPv2 |IGMPv3}>

where:
intf

The IP interface name.

REQUIRED

version

The IGMP version of the IP interface.
Choose between:

REQUIRED

>
>
>
>

IGMPv1
IGMPv2
IGMPv3
none

EXAMPLE:
=>igmp host ifconfig
intf = lan1
version = IGMPv1
:igmp host ifconfig intf=lan1 version=IGMPv1
=>

RELATED COMMANDS:
igmp proxy iflist

E-DOC-CTC-20061027-0003 v2.0

Show the configuration of the IGMP interfaces.

413

IGMP Commands

igmp host iflist
Show the configuration of the IGMP interfaces.

SYNTAX:
igmp host iflist

[expand = <{disabled | enabled}>]

where:
expand

Enable or disable expanded listing of IGMP interfaces
configuration.
The default is disabled.

OPTIONAL

EXAMPLE:
=>igmp host iflist
Interface
0
loop
1
Internet
2
ISDN_backup
3
ISDN_backup_trigger
4
lan1
5
wan1
6
dmz1
7
guest1
=>

Version
IGMPv3
IGMPv3
IGMPv3
IGMPv3
IGMPv3
IGMPv3
IGMPv3
IGMPv3

RELATED COMMANDS:
igmp proxy ifconfig

414

Configure an IGMP interface.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp host debug clear
Clear IGMP statistics.

SYNTAX:
igmp host debug clear

RELATED COMMANDS:
igmp host debug
stats

E-DOC-CTC-20061027-0003 v2.0

Print IGMP statistics.

415

IGMP Commands

igmp host debug stats
Print IGMP statistics.

SYNTAX:
igmp host debug stats

EXAMPLE:
=>igmp host debug stats
Total IGMP messages received
Too small IGMP messages received
Too long IGMP messages received
IGMP messages with bad checksum received
IGMP messages with bad TTL received
IGMP messages with no router alert IP option received
IGMPv1 membership queries received
IGMPv2 membership queries received
IGMPv3 membership queries received
IGMP bad queries received
IGMP failing membership queries
IGMPv1/v2 membership reports received
IGMPv1/v2 invalid membership reports received
IGMPv1/v2 membership reports received for our groups
IGMPv1/v2 membership reports transmitted
IGMPv3 membership reports transmitted
=>

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

RELATED COMMANDS:
igmp host debug clear

416

Clear IGMP statistics.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp proxy config
Configure the IGMP proxy.

SYNTAX:
igmp proxy config

[state = <{disabled | enabled}>]
[qi = ]
[qri = ]
[lmqi = ]
[rv = ]
[requirera = <{disabled | enabled}>]
[localgroup = <{disabled | enabled}>]

where:
state

Enable or disable the IGMP proxy.
The default is enabled.

OPTIONAL

qi

A number between 1 and 86400.
Represents the interval in seconds between general queries sent
by the querier.

OPTIONAL

qri

A number between 1 and 86400.
Represents the maximum response time in seconds for an IGMP
client in reply to general queries.

OPTIONAL

lmqi

A number between 1 and 86400.
Represents the maximum response time in seconds for an IGMP
client in reply to group specific queries.

OPTIONAL

rv

A number between 2 and 10.
Represents the robustness variable, which allows tuning for
expected IGMP packet loss.

OPTIONAL

requirera

Enable or disable the router alert IP option check.
The default is disabled.

OPTIONAL

localgroup

Enable or disable the processing of a local multicast group in an
IGMP packet.
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

417

IGMP Commands

EXAMPLE:
=>igmp proxy config
IGMP proxy state
Query Interval
Query Response Interval
Last Member Query Interval
Robustness variable
Router alert IP option check
Process local multicast group
=>

:
:
:
:
:
:
:

disabled
0 days, 0:02:05
0 days, 0:00:10
0 days, 0:00:01
2
disabled
disabled

RELATED COMMANDS:
igmp proxy grouplist

418

Show the learned groups on an IGMP proxy interface.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp proxy flush
Flush all IGMP proxy settings and learned groups.

SYNTAX:
igmp proxy flush

E-DOC-CTC-20061027-0003 v2.0

419

IGMP Commands

igmp proxy grouplist
Show the learned groups on an IGMP proxy interface.

SYNTAX:
igmp proxy grouplist

[intf = ]
[expand = <{disabled | enabled}>]

where:
intf

The name of the IGMP proxy interface to be listed.

OPTIONAL

expand

Enable or disable expanded listing of the learned groups on an
IGMP proxy interface.
The default is disabled.

OPTIONAL

RELATED COMMANDS:
igmp proxy config

420

Configure the IGMP proxy.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp proxy ifconfig
Configure an IGMP proxy interface.

SYNTAX:
igmp proxy ifconfig

intf = 
[state = <{inactive | downstream | upstream}>]
[version = <{IGMPv1 | IGMPv2 | IGMPv3}>]
[fastleave = <{disabled | enabled}>]

where:
intf

The name of the IGMP proxy interface to be configured.

REQUIRED

state

The state of the IGMP proxy interface.
Choose between:

OPTIONAL

>
>
>
version

downstream
upstream

The IGMP version of the IGMP proxy interface.
Choose between:

>
>
>
>
fastleave

inactive

OPTIONAL

IGMPv1
IGMPv2
IGMPv3
none

Enable or disable the immediate deletion of a group when a
leave is received.
The default is disabled.

OPTIONAL

EXAMPLE:
=>igmp proxy ifconfig
intf = lan1
[state] = downstream
[version] = IGMPv3
[fastleave] = disabled
=>

RELATED COMMANDS:
igmp proxy iflist

E-DOC-CTC-20061027-0003 v2.0

Show the configuration of an IGMP proxy interface.

421

IGMP Commands

igmp proxy iflist
Show the configuration of an IGMP proxy interface.

SYNTAX:
igmp proxy iflist

[expand = <{disabled | enabled}>]

where:
expand

Enable or disable expanded listing of IGMP proxy interface
configuration.
The default is disabled.

OPTIONAL

EXAMPLE:
=>igmp proxy iflist
Interface
7
guest1
6
dmz1
5
wan1
4
lan1
3
ISDN_backup_trigger
2
ISDN_backup
1
Internet
=>

State
inactive
inactive
inactive
downstream
inactive
inactive
inactive

Version
-

Querier
-

RELATED COMMANDS:
igmp proxy ifconfig

422

Configure an IGMP proxy interface.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp proxy mbslist
Show the IGMP proxy membership database (merge of all learned groups.

SYNTAX:
igmp proxy mbslist

E-DOC-CTC-20061027-0003 v2.0

423

IGMP Commands

igmp proxy debug clear
Clear IGMP proxy statistics.

SYNTAX:
igmp proxy debug clear

RELATED COMMANDS:

424

igmp proxy debug stats

Print IGMP proxy statistics.

igmp proxy debug traceconfig

Modify IGMP proxy trace configuration.

E-DOC-CTC-20061027-0003 v2.0

IGMP Commands

igmp proxy debug stats
Print IGMP proxy statistics.

SYNTAX:
igmp proxy debug stats

EXAMPLE:
=>igmp proxy debug stats
IGMP proxy statistics:
Total IGMP packets recv
Too short IGMP packets recv
IGMP packets with bad checksum recv
IGMP packets with bad ttl recv
IGMP packets with no route alert option recv
IGMPv1 queries recv
IGMPv2 queries recv
IGMPv3 queries recv
IGMP bad queries recv
IGMP queries fail
IGMPv1 reports recv
IGMPv2 reports recv
IGMPv3 reports recv
IGMP bad reports recv
IGMP leave reports recv
IGMP bad leave reports recv
IGMPv1 queries sent
IGMPv2 queries sent
IGMPv3 queries sent
IGMP query election switch
=>

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

RELATED COMMANDS:
igmp proxy debug
clear

Clear IGMP proxy statistics.

igmp proxy debug
traceconfig

Modify IGMP proxy trace configuration.

E-DOC-CTC-20061027-0003 v2.0

425

IGMP Commands

igmp proxy debug traceconfig
Modify IGMP proxy trace configuration.

SYNTAX:
igmp proxy debug traceconfig

[state = <{disabled | enabled}>]

where:
state

Enable or disable tracing.
The default is disabled.

OPTIONAL

RELATED COMMANDS:

426

igmp proxy debug
clear

Clear IGMP proxy statistics.

igmp proxy debug
stats

Print IGMP proxy statistics.

E-DOC-CTC-20061027-0003 v2.0

Interface Commands

21 Interface Commands
Introduction
This chapter describes the commands of the interface command group.

Contents
This chapter covers the following commands:
interface list

E-DOC-CTC-20061027-0003 v2.0

Display interfaces.

428

427

Interface Commands

interface list
Display interfaces.

SYNTAX:
interface list

[expand = <{disabled | enabled}>]
[reverse = <{disabled | enabled}>]

where:

428

expand

Enable or disable expanded listing of interfaces.
The default is disabled.

OPTIONAL

reverse

Enable or disable reverse listing (lower layer first instead of upper layer
first).
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

Interface Commands

EXAMPLE:
=>interface list
Name
Type
State
Use UL Interfaces
ethif1
physical
connected
1
bridge
ethif4
physical
connected
1
bridge
usbif1
physical
connected
1
bridge
RELAY
eth
connected
1
Internet_ppp
bridge
eth
connected
1
eth0
atm_0_35
atm
connected
1
ethoa_0_35
atm_8_35
atm
connected
1
ethoa_8_35
ethoa_0_35
eth
connected
0
ethoa_8_35
eth
connected
0
Internet_ppp ppp
not-connected
1
Internet
Internet
ip
not-connected
0
eth0
ip
connected
0
=>
=>interface list expand=enabled
Name
Type
State
Use UL Interfaces
ethif1
physical
connected
1
bridge
Flags....: INTERNAL
Phys.....: intf: 0 type eth speed: 100 Mbps
ethif4
physical
connected
1
bridge
Flags....: INTERNAL
Phys.....: intf: 3 type eth speed: 100 Mbps
usbif1
physical
connected
1
bridge
Flags....: INTERNAL
Phys.....: intf: 4 type usb speed: 12 Mbps
RELAY
eth
connected
1
Internet_ppp
Flags....: INTERNAL DYNAMIC RELAY
Eth......: port: 65535 ip_cid: 200 arp_cid: 0
bridge
eth
connected
1
eth0
Flags....: DYNAMIC
Eth......: port: 0 ip_cid: 16385 arp_cid: 16386
atm_0_35
atm
connected
1
ethoa_0_35
Flags....:
Atm......: cid: 8196 atm_cid: 8196 llc_cid: 0 ppp_cid: 0
atm_8_35
atm
connected
1
ethoa_8_35
Flags....:
Atm......: cid: 8198 atm_cid: 8198 llc_cid: 0 ppp_cid: 0
ethoa_0_35
eth
connected
0
Flags....:
Eth......: port: 1 ip_cid: 16387 arp_cid: 16388
ethoa_8_35
eth
connected
0
Flags....:
Eth......: port: 2 ip_cid: 16389 arp_cid: 16390
Internet_ppp ppp
not-connected
1
Internet
Flags....:
Ppp......: cid: 0 ip_cid: 0
Internet
ip
not-connected
0
Flags....: DYNAMIC
Ip.......: dest: Internet_ppp
eth0
ip
connected
0
Flags....:
Ip.......: dest: bridge
=>

E-DOC-CTC-20061027-0003 v2.0

429

Interface Commands

430

E-DOC-CTC-20061027-0003 v2.0

IP Commands

22 IP Commands
Introduction
This chapter describes the commands of the ip command group.

Contents
This chapter covers the following commands:
ip arpadd

Add an entry to the ARP cache of a broadcast Internet Protocol
(IP) interface.

433

ip arpdelete

Delete an entry from the ARP cache.

434

ip arplist

Display the ARP cache.

435

ip config

Show/set global IP stack configuration options.

436

ip flush

Flush all the static IP parameters.

438

ip ifadd

Create an IP interface.

439

ip ifattach

Attach an IP interface.

440

ip ifconfig

Configure the parameters of an IP interface.

441

ip ifdelete

Delete an IP interface.

443

ip ifdetach

Detach an IP interface.

444

ip iflist

Display all the IP interfaces.

445

ip ifwait

Wait for a status change of an IP interface.

446

ip ipadd

Assign an IP address to an IP interface.

447

ip ipconfig

Modify an IP address configuration.

448

ip ipdelete

Remove an IP address from an IP interface.

449

ip iplist

Display all the configured IP addresses.

450

ip mcast rtadd

Add a multicast route to the multicast routing table.

451

ip mcast rtdelete

Delete a multicast route from the multicast routing table.

452

ip mcast rtlist

Display the multicast routing table.

453

ip mcast flush

Flush the multicast routing table.

454

ip rtadd

Add a route to the routing table.

455

ip rtdelete

Delete a route from the routing table.

457

ip rtlist

Display the routing table.

458

ip auto flush

Flush the autoIP interfaces.

459

ip auto ifadd

Create an autoIP interface.

460

ip auto ifattach

Select and assign a link-local address to an autoIP interface.

461

ip auto ifconfig

Configure an autoIP interface.

462

ip auto ifdelete

Delete an existing autoIP interface.

464

ip auto ifdetach

Release the link-local address for the given autoIP interface.

465

ip auto iflist

Display the autoIP interfaces.

466

ip debug httpprobe

Send a HTTP probe.

467

E-DOC-CTC-20061027-0003 v2.0

431

IP Commands

432

ip debug sendto

Send UDP packets.

468

ip debug stats

Display IP statistics.

470

ip debug traceconfig

Display/modify the IP stack trace configuration.

471

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip arpadd
Add an entry to the ARP cache of a broadcast Internet Protocol (IP) interface.

SYNTAX:
ip arpadd

intf = 
ip = 
[hwaddr = ]

where:
intf

The IP interface name.

REQUIRED

ip

The IP address (or range) of the entry to be added to the Address
Resolution Protocol (ARP) cache.

REQUIRED

hwaddr

The hardware address (for example the Ethernet MAC address) of the
entry to be added.

OPTIONAL

EXAMPLE:
=>ip arplist
Interface
IP-address
HW-address
Type
2
eth0
10.0.0.1
00:10:a4:ad:32:cf STATIC
=>ip arpadd intf=eth0 ip=10.0.0.2
=>ip arplist
Interface
IP-address
HW-address
Type
2
eth0
10.0.0.1
00:10:a4:ad:32:cf STATIC
2
eth0
10.0.0.2
00:00:00:00:00:00 DYNAMIC
=>ip arpadd intf=eth0 ip=10.0.0.3 hwaddr=00:a0:24:ae:66:e1
=>ip arplist
Interface
IP-address
HW-address
Type
2
eth0
10.0.0.1
00:10:a4:ad:32:cf STATIC
2
eth0
10.0.0.2
00:00:00:00:00:00 DYNAMIC
2
eth0
10.0.0.3
00:a0:24:ae:66:e1 STATIC
=>

RELATED COMMANDS:
ip arpdelete

Delete an entry from the ARP cache.

ip arplist

Display the ARP cache.

E-DOC-CTC-20061027-0003 v2.0

433

IP Commands

ip arpdelete
Delete an entry from the ARP cache.

SYNTAX:
ip arpdelete

intf = 
ip = 
[hwaddr = ]

where:
intf

The IP interface name.

REQUIRED

ip

The IP address (or range) of the entry to be deleted.

REQUIRED

hwaddr

The hardware address (for example the Ethernet MAC address) of the
entry to be deleted.

OPTIONAL

EXAMPLE:
=>ip arplist
Interface
IP-address
HW-address
Type
2
eth0
10.0.0.1
00:10:a4:ad:32:cf STATIC
2
eth0
10.0.0.2
00:00:00:00:00:00 DYNAMIC
2
eth0
10.0.0.3
00:a0:24:ae:66:e1 STATIC
=>ip arpdelete intf=eth0 ip=10.0.0.3 hwaddr=00:a0:24:ae:66:e1
=>ip arplist
Interface
IP-address
HW-address
Type
2
eth0
10.0.0.1
00:10:a4:ad:32:cf STATIC
2
eth0
10.0.0.2
00:00:00:00:00:00 DYNAMIC
=>

RELATED COMMANDS:

434

ip arpadd

Add an entry to the ARP cache of a broadcast Internet Protocol (IP) interface.

ip arplist

Display the ARP cache.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip arplist
Display the ARP cache.

SYNTAX:
ip arplist

EXAMPLE:
=>ip arplist
Interface
2
eth0
2
eth0
2
eth0
=>

IP-address
10.0.0.1
10.0.0.2
10.0.0.3

HW-address
00:10:a4:ad:32:cf
00:00:00:00:00:00
00:a0:24:ae:66:e1

Type
STATIC
DYNAMIC
STATIC

RELATED COMMANDS:
ip arpadd

Add an entry to the ARP cache of a broadcast Internet Protocol (IP) interface.

ip arpdelete

Delete an entry from the ARP cache.

E-DOC-CTC-20061027-0003 v2.0

435

IP Commands

ip config
Show/set global IP stack configuration options.

SYNTAX:
ip config

[forwarding = <{disabled | enabled}>]
[redirects = <{disabled | enabled}>]
[checkoptions = <{disabled|enabled|transparent}>]
[netbroadcasts = <{disabled | enabled}>]
[ttl = ]
[defragmode = <{disabled | enabled}>]
[addrcheck = <{off | own | static | dynamic}>]
[mssclamping = <{disabled | enabled}>]
[natloopback = <{disabled|enabled}>]
[loadbalancing = <{disabled|roundrobin}>]
[bitrate-window(sec) = ]
[acceleration = <{disabled|enabled}>]

where:

436

forwarding

Disable or enable the IP routing functionality.
The default is enabled.

OPTIONAL

redirects

Disable or enable the sending of ICMP redirect messages.
A router can send a redirect message in case a shorter path than the
path followed is discovered.
The default is enabled (for security reasons).

OPTIONAL

checkoptions

Disallow/Allow packets with IP options.
The default is enabled.

OPTIONAL

netbroadcasts

Disable or enable net directed broadcasts.
The default is disabled.
In case netbroadcasts are allowed, no traces of netbroadcasts are
generated.

OPTIONAL

ttl

A number between 0 and 255.
Represents the default Time To Live (TTL) for locally generated IP
packets. This parameter determines the number of hop counts the IP
packet may pass before it is dropped.
By limiting the TTL, continuous circulation of IP packets on the
network without ever reaching a destination is avoided.
The default is 64.

OPTIONAL

defragmode

Disallow (disabled) or allow (enabled) defragmenting IP fragments.
The default is enabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

IP Commands

addrcheck

Set the level of IP address checks.
Choose between:

>

off: No address checking is performed. For advanced users only;
in normal circumstances there should always be some kind of
address checking.

>

own: Minimum level of checking.

OPTIONAL

Only the address configuration on the Thomson ST is checked.

>

static: Checking of the address configuration of the Thomson ST
and also of traffic: addresses of incoming packets; this checking
is related to constants (for example an address may not be
entirely composed of one‘s or zero‘s).

>

dynamic: Besides the address configuration of the Thomson ST
itself, and besides the checking of traffic on a constants level,
additional checking is performed on the IP addresses that are
determined by the configuration, more specifically by the
network.

The default is dynamic.
mssclamping

Disable or enable mss clamping for low MTU interfaces.
Enabling mss clamping assures that the size of a TCP packet never
exceeds the available Maximum Transmission Unit (MTU) of the
outgoing interface.
The default is on.
Note

OPTIONAL

It is recommended not to disable this parameter.

natloopback

Disable/Enable NAT loopback.
The default is enabled.

OPTIONAL

loadbalancing

Select loadbalancing mechanism

OPTIONAL

bitratewindow(sec)

A number between 10 and 3600.
Set the window to calculate the bitrate (multiple of 10).
The default is 30.

OPTIONAL

acceleration

Disable/Enable IP acceleration

OPTIONAL

EXAMPLE:
=>ip config
Forwarding enabled
Sendredirects enabled
IP options enabled
NetBroadcasts disabled
Default TTL 64
Fraglimit 64 fragments
Fragcount currently 0 fragments
Defragment mode : enabled
Address checks : dynamic
Mss Clamping : enabled
NAT Loopback : enabled
Bitrate window (sec), multiple of 10 : 30
=>

E-DOC-CTC-20061027-0003 v2.0

437

IP Commands

ip flush
Flush all the static IP parameters.
Dynamic configurations (for example from PPP or CIP links) remain.

i

The flush command does not impact previously saved configurations.

!

The command :ip flush deletes all local IP connectivity.
Do not use this command during an IP based local connection, for example a Telnet CLI session, or
web based CLI access.

SYNTAX:
ip flush

438

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip ifadd
Create an IP interface.

SYNTAX:
ip ifadd

intf = 
dest = 

where:
intf

The name of the IP interface to be created.

REQUIRED

dest

An network interface name.

REQUIRED

EXAMPLE:
=>ip iflist
Interface
Group MTU
RX
0
loop
local 65535 122062
1
Internet
wan
1500 0
2
RtPPPoE_ppp
wan
1500 0
3
LocalNetwork
lan
1500 84105
=>ip ifadd intf=myIPintf dest=RtPPPoE_eth
=>ip iflist
Interface
Group MTU
RX
0
loop
local 65535 123966
1
Internet
wan
1500 0
2
RtPPPoE_ppp
wan
1500 0
3
LocalNetwork
lan
1500 86589
4
myIPintf
wan
1500 0
=>

TX
72987
0
0
123358

TX-Drop
0
0
0
0

Status HW-address
[UP]
00:0e:50:0f:fc:2c
DOWN
DOWN
[UP]
00:0e:50:0f:fc:2c

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
DOWN

HW-address
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

RELATED COMMANDS:
ip ifdelete

Delete an IP interface.

ip iflist

Display all the IP interfaces.

ip ifwait

Wait for a status change of an IP interface.

E-DOC-CTC-20061027-0003 v2.0

439

IP Commands

ip ifattach
Attach an IP interface.

SYNTAX:
ip ifattach

intf = 

where:
intf

The name of the IP interface to be attached.

REQUIRED

EXAMPLE:
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
4
myIPintf
wan
1500
=>ip ifattach intf=myIPintf
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
4
myIPintf
wan
1500
=>

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
DOWN

HW-address
00:0e:50:0f:fc:2c

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
[UP]

HW-address
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

RELATED COMMANDS:
ip ifdetach

440

Detach an IP interface.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip ifconfig
Configure the parameters of an IP interface.

SYNTAX:
ip ifconfig

intf = 
[mtu = ]
[status = <{down | up}>]
[hwaddr = ]
[group =  or number]
[linksensing = <{disabled | enabled}>]
[primary = <{disabled | enabled}>]
[mcastpromisc = <{disabled|enabled}>]

where:
intf

The name of the IP interface to be configured.

REQUIRED

mtu

A number between 68 and 65535.
Represents the MTU (the maximum packet size (including IP
header)) to be used on this interface.

OPTIONAL

Note
status

The default value depends on the connection and packet
service for which the interface was created.

The administrative state of the interface.
Choose between:

>
>

OPTIONAL

down
up.

hwaddr

The hardware address (for example the Ethernet MAC address) of
this IP interface.

OPTIONAL

group

The group to which this interface belongs. Can be used for
firewalling, for example.

OPTIONAL

linksensing

The IP interface's awareness of link state transitions.
The default is enabled.

OPTIONAL

primary

Make the IP interface the primary interface (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

mcastpromisc

Make the IP interface multicast promiscuous.
Choose between:

OPTIONAL

>
>

disabled
enabled

The default is disabled.

E-DOC-CTC-20061027-0003 v2.0

441

IP Commands

EXAMPLE:
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
4
myIPintf
wan
1500
=>ip ifconfig
intf = myIPintf
[mtu] = 1500
[status] = up
[hwaddr] = 00:0e:50:0f:fc:2c
[group] = wan
[linksensing] = enabled
[primary] = enabled
:ip ifconfig intf=myIPintf
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
4
myIPintf
wan
1500
=>

i

442

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
DOWN

HW-address
00:0e:50:0f:fc:2c

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
[UP]

HW-address
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

If the STATUS is shown between square brackets, then linksensing is disabled for that particular
interface.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip ifdelete
Delete an IP interface.

SYNTAX:
ip ifdelete

intf = 

where:
intf

The name of the IP interface to be deleted.

REQUIRED

EXAMPLE:
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
4
myIPintf
wan
1500
=>ip ifdelete intf=myIPintf
=>ip iflist
Interface
Group MTU
0
loop
local 65535
1
Internet
wan
1500
2
RtPPPoE_ppp
wan
1500
3
LocalNetwork
lan
1500
=>

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
[UP]

HW-address
00:0e:50:0f:fc:2c

RX
123966
0
0
86589

TX
75177
0
0
125262

TX-Drop
0
0
0
0

Status HW-address
[UP]
00:0e:50:0f:fc:2c
DOWN
DOWN
[UP]
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

RELATED COMMANDS:
ip ifadd

Create an IP interface.

ip iflist

Display all the IP interfaces.

ip ifwait

Wait for a status change of an IP interface.

E-DOC-CTC-20061027-0003 v2.0

443

IP Commands

ip ifdetach
Detach an IP interface.

SYNTAX:
ip ifdetach

intf = 

where:
intf

The name of the IP interface to be detached.

REQUIRED

EXAMPLE:
=>ip iflist expand=enabled
Interface
Group MTU
RX
TX
TX-Drop Status HW-address
0
loop
local 65535 130597
82240
0
[UP]
00:0e:50:0f:fc:2c
BRHW-address : ff:ff:ff:ff:ff:ff
RX unicastpkts: 1304
brcastpkts : 0
TX unicastpkts: 1994
brcastpkts : 0
droppkts:0
Oper state
: UP
Admin State: UP
Flags
: ARP BROADCAST ARPTABLE LOOP MULTICAST INTERNAL
...
4

myIPintf
wan
1500 0
0
0
DOWN
BRHW-address : ff:ff:ff:ff:ff:ff
RX unicastpkts: 0
brcastpkts : 0
TX unicastpkts: 0
brcastpkts : 0
droppkts:0
Oper state
: DOWN
Admin State: UP
Flags
: PRIMARY ARP BROADCAST BOUND ARPTABLE MULTICAST
=>ip ifdetach intf=myIPintf
=>ip iflist expand=enabled
Interface
Group MTU
RX
TX
TX-Drop Status
0
loop
local 65535 133683
83949
0
[UP]
BRHW-address : ff:ff:ff:ff:ff:ff
RX unicastpkts: 1332
brcastpkts : 0
TX unicastpkts: 2036
brcastpkts : 0
droppkts:0
Oper state
: UP
Admin State: UP
Flags
: ARP BROADCAST ARPTABLE LOOP MULTICAST INTERNAL

00:0e:50:0f:fc:2c

LINKSENSING STATIC

HW-address
00:0e:50:0f:fc:2c

...
4

myIPintf
BRHW-address :
RX unicastpkts:
TX unicastpkts:
Oper state
:
Flags
:

wan
1500 0
0
0
DOWN
00:0e:50:0f:fc:2c
ff:ff:ff:ff:ff:ff
0
brcastpkts : 0
0
brcastpkts : 0
droppkts:0
DOWN
Admin State: DOWN
PRIMARY ARP BROADCAST ARPTABLE MULTICAST LINKSENSING STATIC

=>

RELATED COMMANDS:
ip ifattach

444

Attach an IP interface.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip iflist
Display all the IP interfaces.

SYNTAX:
ip iflist

[expand = <{disabled | enabled}>]
[string = ]
[beginstring = ]

where:
expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

string

String matching conditions

OPTIONAL

beginstring

Bginstring matching conditions

OPTIONAL

EXAMPLE:
=>ip iflist
Interface
0
loop
1
Internet
2
RtPPPoE_ppp
3
LocalNetwork
4
myIPintf
=>

Group
local
wan
wan
lan
wan

MTU
65535
1500
1500
1500
1500

RX
123966
0
0
86589
0

TX
75177
0
0
125262
0

TX-Drop
0
0
0
0
0

Status
[UP]
DOWN
DOWN
[UP]
[UP]

HW-address
00:0e:50:0f:fc:2c

00:0e:50:0f:fc:2c
00:0e:50:0f:fc:2c

RELATED COMMANDS:
ip ifadd

Create an IP interface.

ip ifdelete

Delete an IP interface.

ip ifwait

Wait for a status change of an IP interface.

E-DOC-CTC-20061027-0003 v2.0

445

IP Commands

ip ifwait
Wait for a status change of an IP interface.

SYNTAX:
ip ifwait

intf = 
[timeout = ]
[adminstatus = <{down | up}>]
[operstatus = <{down | up}>]
[linkstatus = <{down | up}>]

where:
intf

The IP interface name.

REQUIRED

timeout

A number between 1 and 600000 (seconds).
Represents the timeout.

OPTIONAL

adminstatus

The administrative state of the interface.
Choose between:

OPTIONAL

>
>
operstatus

up.

The operational state of the interface.
Choose between:

>
>
linkstatus

down

down
up.

The link state of the interface.
Choose between:

>
>

OPTIONAL

OPTIONAL

down
up.

RELATED COMMANDS:

446

ip ifadd

Create an IP interface.

ip ifdelete

Delete an IP interface.

ip iflist

Display all the IP interfaces.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip ipadd
Assign an IP address to an IP interface.

SYNTAX:
ip ipadd

intf = 
addr = 
[netmask = ]
[pointopoint = ]
[addroute = <{disabled | enabled}>]

where:
intf

The IP interface name.

REQUIRED

addr

The new IP address to be added.

REQUIRED

netmask

The subnetmask associated with this address.

OPTIONAL

pointopoi
nt

The remote IP address in case of a dedicated point-to-point link.

OPTIONAL

addroute

Add typical net/subnet routes automatically according to the default (or
specified) subnet mask (enabled) or not (disabled).
The default is disabled.

OPTIONAL

EXAMPLE:
=>ip iplist
Interface
1
eth0
1
eth0
0
loop

Type
Ethernet
Ethernet
Ethernet

IP-address
10.0.0.138
169.254.141.11
127.0.0.1

Point-to-point/Mask
255.255.255.0
255.255.0.0
255.0.0.0

=>ip ipadd intf=eth0 addr=10.0.0.2/24 addroute=enabled
=>ip iplist
Interface
Type
IP-address
Point-to-point/Mask
1
eth0
Ethernet
10.0.0.2
255.255.255.0
1
eth0
Ethernet
10.0.0.138
255.255.255.0
1
eth0
Ethernet
169.254.141.11
255.255.0.0
0
loop
Ethernet
127.0.0.1
255.0.0.0
=>

RELATED COMMANDS:
ip ipdelete

Remove an IP address from an IP interface.

ip iplist

Display all the configured IP addresses.

E-DOC-CTC-20061027-0003 v2.0

447

IP Commands

ip ipconfig
Modify an IP address configuration.

SYNTAX:
ip ipconfig

addr = 
[preferred = <{disabled | enabled}>]
[primary = <{disabled | enabled}>]

where:
addr

The IP address to be configured.

REQUIRED

preferred

Make this IP address the preferred address for that subnet (enabled) or
not (disabled).
The default is disabled.

OPTIONAL

primary

Make this IP address the primary address for the interface (enabled) or
not (disabled).
The default is disabled.

OPTIONAL

EXAMPLE:
=>ip iplist
Interface
Type
IP-address
Point-to-point/Mask
1
eth0
Ethernet
10.0.0.138
255.255.255.0
1
eth0
Ethernet
169.254.141.11
255.255.0.0
0
loop
Ethernet
127.0.0.1
255.0.0.0
=>ip ipconfig addr=169.254.141.11 preferred=enabled primary=enabled
=>ip iplist
Interface
Type
IP-address
Point-to-point/Mask
1
eth0
Ethernet
10.0.0.138
255.255.255.0
1
eth0
Ethernet
*169.254.141.11
255.255.0.0
0
loop
Ethernet
127.0.0.1
255.0.0.0
=>

i

448

The primary IP address is marked with “*” in the list.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip ipdelete
Remove an IP address from an IP interface.

SYNTAX:
ip ipdelete

addr = 

where:
addr

The IP address to be deleted.

REQUIRED

EXAMPLE:
=>ip iplist
Interface
1
eth0
1
eth0
1
eth0
0
loop

Type
Ethernet
Ethernet
Ethernet
Ethernet

=>ip ipdelete addr=10.0.0.2
=>ip iplist
Interface
Type
1
eth0
Ethernet
1
eth0
Ethernet
0
loop
Ethernet

IP-address
10.0.0.2
10.0.0.138
169.254.141.11
127.0.0.1

Point-to-point/Mask
255.255.255.0
255.255.255.0
255.255.0.0
255.0.0.0

IP-address
10.0.0.138
169.254.141.11
127.0.0.1

Point-to-point/Mask
255.255.255.0
255.255.0.0
255.0.0.0

=>

RELATED COMMANDS:
ip ipadd

Assign an IP address to an IP interface.

ip iplist

Display all the configured IP addresses.

E-DOC-CTC-20061027-0003 v2.0

449

IP Commands

ip iplist
Display all the configured IP addresses.

SYNTAX:
ip iplist

EXAMPLE:
=>ip iplist
Interface
2
LocalNetwork
2
LocalNetwork
0
loop
=>

Type
Ethernet
Ethernet
Ethernet

IP-address
10.0.0.138
*192.168.1.254
127.0.0.1

Point-to-point/Mask
255.255.255.0
255.255.255.0
255.255.255.255

RELATED COMMANDS:

450

ip ipadd

Assign an IP address to an IP interface.

ip ipdelete

Remove an IP address from an IP interface.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip mcast rtadd
Add a multicast route to the multicast routing table.

SYNTAX:
ip mcast rtadd

srcintf = 
[src = ]
grp = 
dstintf = 
[ttl = ]
[ttlincr = {disabled | enabled}]

where:
srcintf

The source IP interface.

REQUIRED

src

The source IP address.

OPTIONAL

grp

The multicast group IP address.

REQUIRED

dstintf

The destination IP interface.

REQUIRED

ttl

The time-to-live for that destination IP interface.

OPTIONAL

ttlincr

Increment TTL before packet is send.

OPTIONAL

RELATED COMMANDS:
ip mcast rtdelete

Delete a multicast route from the multicast routing table.

ip mcast rtlist

Display the multicast routing table.

ip mcast flush

Flush the multicast routing table.

E-DOC-CTC-20061027-0003 v2.0

451

IP Commands

ip mcast rtdelete
Delete a multicast route from the multicast routing table.

SYNTAX:
ip mcast rtdelete

srcintf = 
[src = ]
grp = 
dstintf = 

where:
srcintf

The source IP interface.

REQUIRED

src

The source IP address.

OPTIONAL

grp

The multicast group IP address.

REQUIRED

dstintf

The destination IP interface.

REQUIRED

RELATED COMMANDS:

452

ip mcast rtadd

Add a multicast route to the multicast routing table.

ip mcast rtlist

Display the multicast routing table.

ip mcast flush

Flush the multicast routing table.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip mcast rtlist
Display the multicast routing table.

SYNTAX:
ip mcast rtlist

[expand = <{disabled | enabled}>}]

where:
expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

RELATED COMMANDS:
ip mcast rtadd

Add a multicast route to the multicast routing table.

ip mcast rtdelete

Delete a multicast route from the multicast routing table.

ip mcast flush

Flush the multicast routing table.

E-DOC-CTC-20061027-0003 v2.0

453

IP Commands

ip mcast flush
Flush the multicast routing table.

SYNTAX:
ip mcast flush

RELATED COMMANDS:

454

ip mcast rtadd

Add a multicast route to the multicast routing table.

ip mcast rtdelete

Delete a multicast route from the multicast routing table.

ip mcast rtlist

Display the multicast routing table.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip rtadd
Add a route to the routing table.

SYNTAX:
ip rtadd

dst = 
[dstmsk = ]
[label = ]
[gateway = ]
[intf = ]
[srcintf = ]
[metric = ]

where:
dst

The destination IP address(es) for this route.
Note

REQUIRED

Supports ip/mask notation.

dstmsk

The destination IP address mask.

OPTIONAL

label

The name of the label.

OPTIONAL

gateway

The IP address of the next hop (direct connected gateway or extended
route).

OPTIONAL

Note
intf

The parameters gateway and intf are mutually exclusive.

Only for special interface routes: the outgoing IP interface name.
Note

OPTIONAL

The parameters gateway and intf are mutually exclusive.

srcintf

Use this interface for source address selection.

OPTIONAL

metric

The metric for this route (weight factor).
The lower the metric, the higher the weight.
The default is 0.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

455

IP Commands

EXAMPLE:
=>ip rtlist
Destination Label
Gateway
Intf Mtrc Status
10.0.0.0/24
10.0.0.140
eth0
0 [UP]
10.0.0.140/32
10.0.0.140
eth0
0 [UP]
127.0.0.1/32
127.0.0.1
loop
0 [UP]
=>ip rtadd dst=10.10.0.0/24 label=Interactive gateway=10.0.0.140
=>ip rtlist
Destination Label
Gateway
Intf Mtrc Status
10.0.0.0/24
10.0.0.140
eth0
0 [UP]
10.10.0.0/24 Interactive
10.0.0.140
eth0
0 [UP]
10.0.0.140/32
10.0.0.140
eth0
0 [UP]
127.0.0.1/32
127.0.0.1
loop
0 [UP]
=>

RELATED COMMANDS:

456

ip rtdelete

Delete a route from the routing table.

ip rtlist

Display the routing table.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip rtdelete
Delete a route from the routing table.

SYNTAX:
ip rtdelete

dst = 
[dstmsk = ]
[label = ]
[gateway = ]
[intf = ]

where:
dst

The destination IP address(es) for this route.
Note

REQUIRED

Supports cidr notation.

dstmsk

The destination IP address mask.

OPTIONAL

label

The name of the label.

OPTIONAL

gateway

The IP address of the next hop. The next hop must be directly connected.

OPTIONAL

Note
intf

The parameters gateway and intf are mutually exclusive.

Only for special interface routes: the outgoing IP interface name.
Note

OPTIONAL

The parameters gateway and intf are mutually exclusive.

EXAMPLE:
=>ip rtlist
Destination Label
Gateway
Intf Mtrc Status
10.0.0.0/24
10.0.0.140
eth0
0 [UP]
10.10.0.0/24 Interactive
10.0.0.140
eth0
0 [UP]
10.0.0.140/32
10.0.0.140
eth0
0 [UP]
127.0.0.1/32
127.0.0.1
loop
0 [UP]
=>ip rtdelete dst=10.10.0.0/24 label=Interactive gateway=10.0.0.140
=>ip rtlist
Destination Label
Gateway
Intf Mtrc Status
10.0.0.0/24
10.0.0.140
eth0
0 [UP]
10.0.0.140/32
10.0.0.140
eth0
0 [UP]
127.0.0.1/32
127.0.0.1
loop
0 [UP]
=>

RELATED COMMANDS:
ip rtadd

Add a route to the routing table.

ip rtlist

Display the routing table.

E-DOC-CTC-20061027-0003 v2.0

457

IP Commands

ip rtlist
Display the routing table.

SYNTAX:
ip rtlist

[expand = <{disabled | enabled}>]

where:
expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>ip rtlist
Destination Label
10.0.0.138/32
127.0.0.1/32
10.0.0.0/24
=>ip rtlist expand=enabled
Destination Label
10.0.0.138/
32
127.0.0.1
127.0.0.1/
32
127.0.0.1
10.0.0.0/
24
10.0.0.138
=>

Gateway
127.0.0.1
127.0.0.1
10.0.0.138

Interface
loop
loop
eth0

Metric
0
0
0

Status
[UP]
[UP]
[UP]

Gateway

Interface

Metric Status Source-selection

loop

0

[UP]

default

127.0.0.1

loop

0

[UP]

default

127.0.0.1

eth0

0

[UP]

default

10.0.0.138

RELATED COMMANDS:

458

ip rtadd

Add a route to the routing table.

ip rtdelete

Delete a route from the routing table.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip auto flush
Flush the autoIP interfaces.

SYNTAX:
ip auto flush

E-DOC-CTC-20061027-0003 v2.0

459

IP Commands

ip auto ifadd
Create an autoIP interface.

SYNTAX:
ip auto ifadd

intf = 
[addr = ]

where:
intf

The name of the IP interface for which a link-local address has to be
allocated.

REQUIRED

dest

The preferred link-local IP address.

OPTIONAL

EXAMPLE:
=>ip auto ifadd intf=eth0
=> ip auto iflist
eth0
: [INIT] 0.0.0.0
poolstart = 169.254.1.1
claim : 10 defence : 5
probes sent = 0
collisions = 0

poolend = 169.254.254.254 netmask = 255.255.0.0
probe : 4 interval : 2 (sec)

=>

RELATED COMMANDS:

460

ip auto ifdelete

Delete an existing autoIP interface.

ip auto iflist

Display the autoIP interfaces.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip auto ifattach
Select and assign a link-local address to an autoIP interface.

SYNTAX:
ip auto ifattach

intf = 

where:
intf

The name of the autoIP interface for which a link-local address has to be
attached.

REQUIRED

EXAMPLE:
=> ip auto iflist
ipsec0
: [INIT] 0.0.0.0
poolstart = 169.254.1.1
claim : 10 defence : 5
probes sent = 0
collisions = 0

poolend = 169.254.254.254 netmask = 255.255.0.0
probe : 4 interval : 2 (sec)

=>ip auto ifattach intf=ipsec0
=> ip auto iflist
ipsec0
: [SELECTING] 169.254.80.236
poolstart = 169.254.1.1 poolend = 169.254.254.254 netmask = 255.255.0.0
claim : 10 defence : 5 probe : 4 interval : 2 (sec)
probes sent = 2
collisions = 0
=>

RELATED COMMANDS:
ip auto ifdetach

E-DOC-CTC-20061027-0003 v2.0

Release the link-local address for the given autoIP interface.

461

IP Commands

ip auto ifconfig
Configure an autoIP interface.

SYNTAX:
ip auto ifconfig

intf = 
[addr = ]
[poolstart = ]
[poolend = ]
[netmask = ]
[claim = ]
[defence = ]
[probe = ]
[interval = ]

where:

462

intf

The name of the autoIP interface to be configured.

REQUIRED

addr

The preferred link-local IP address.

OPTIONAL

poolstart

The start IP address of the link-local address pool.
The default is 169.254.1.1.

OPTIONAL

poolend

The end IP address of the link-local address pool.
The default is 169.254.254.254.

OPTIONAL

netmask

The netmask of the link-local IP address pool.
The default is 16.

OPTIONAL

claim

A number between 0 and 65535.
Represents the number of link-local address selection retries before
giving up.
The default is 10.

OPTIONAL

defence

A number between 0 and 65535.
Represents the number of times the link-local address is defended before
releasing the address.
The default is 5.

OPTIONAL

probe

A number between 0 and 65535.
Represents the number of ARP probes to be sent before accepting a linklocal address.
The default is 4.

OPTIONAL

interval

A number between 1 and 65535 (seconds).
Represents the time interval between two ARP probe transmissions.
The default is 2.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

IP Commands

EXAMPLE:
=> ip auto iflist
eth0
: [INIT] 0.0.0.0
poolstart = 169.254.1.1
claim : 10 defence : 5
probes sent = 0
collisions = 0

poolend = 169.254.254.254 netmask = 255.255.0.0
probe : 4 interval : 2 (sec)

=>ip auto ifconfig intf=ipsec0 claim=5 probe=5
=> ip auto iflist
ipsec0
: [INIT] 0.0.0.0
poolstart = 169.254.1.1 poolend = 169.254.254.254 netmask = 255.255.0.0
claim : 5 defence : 5 probe : 5 interval : 2 (sec)
probes sent = 0
collisions = 0
=>

E-DOC-CTC-20061027-0003 v2.0

463

IP Commands

ip auto ifdelete
Delete an existing autoIP interface.

SYNTAX:
ip auto ifdelete

intf = 

where:
intf

The name of the IP interface to be deleted.

REQUIRED

EXAMPLE:
=>ip auto iflist
ipsec0
: [SELECTING]
poolstart =
claim : 10
probes sent
collisions

169.254.80.236
169.254.1.1 poolend = 169.254.254.254 netmask = 255.255.0.0
defence : 5 probe : 4 interval : 2 (sec)
= 2
= 0

=>ip auto ifdelete intf=ipsec0
=>ip auto iflist
=>

RELATED COMMANDS:

464

ip auto ifadd

Create an autoIP interface.

ip auto iflist

Display the autoIP interfaces.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip auto ifdetach
Release the link-local address for the given autoIP interface.

SYNTAX:
ip auto ifdetach

intf = 

where:
intf

The name of the autoIP interface for which a link-local address has to be
detached.

REQUIRED

EXAMPLE:
=>ip auto iflist
ipsec0
: [SELECTING]
poolstart =
claim : 10
probes sent
collisions

169.254.80.236
169.254.1.1 poolend = 169.254.254.254 netmask = 255.255.0.0
defence : 5 probe : 4 interval : 2 (sec)
= 2
= 0

=>ip auto ifdetach intf=ipsec0
=>ip auto iflist
ipsec0
: [INIT] 169.254.80.236
poolstart = 169.254.1.1
claim : 10 defence : 5
probes sent = 0
collisions = 0

poolend = 169.254.254.254 netmask = 255.255.0.0
probe : 4 interval : 2 (sec)

=>

RELATED COMMANDS:
ip auto ifattach

E-DOC-CTC-20061027-0003 v2.0

Select and assign a link-local address to an autoIP interface.

465

IP Commands

ip auto iflist
Display the autoIP interfaces.

SYNTAX:
ip auto iflist

[intf = ]

where:
intf

The name of the autoIP interface to be listed.
Note

OPTIONAL

If not specified, all the autoIP interfaces are shown.

EXAMPLE:
=>ip auto iflist
eth0
: [CLAIMED] 169.254.138.1
poolstart = 169.254.1.1
claim : 10 defence : 5
probes sent = 2
collisions = 0

poolend = 169.254.254.254 netmask = 255.255.0.0
probe : 4 interval : 2 (sec)

=>

RELATED COMMANDS:

466

ip auto ifadd

Create an autoIP interface.

ip auto ifdelete

Delete an existing autoIP interface.

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip debug httpprobe
Send a HTTP probe.
This HTTP probe will measure the Round Trip Time (RTT) taken to connect and access data from a HTTP
server.

SYNTAX:
ip debug httpprobe

url = 
[version = <{1.0 | 1.1}>]

where:
url

The Uniform Resource Locator (URL) identifying the HTTP server.

REQUIRED

version

The version of the HTTP server.
The default is 1.0.

OPTIONAL

EXAMPLE:
The first example shows the measured time for a file that was downloaded:
=>ip httpprobe url=http://download.winzip.com/wzipse22.exe
DNS Lookup-RTT
= 19 ms
TCP Connect-RTT
= 20 ms
HTTP transaction-RTT = 18772 ms
Total RTT
= 18811 ms
PageSize
= 385712 Bytes
Download speed
= 20.54 KByte/s
=>

If the URL of a normal HTML page is used the figures are not so relevant, as shown in the example below:
=>ip httpprobe url=http://www.google.be
DNS Lookup-RTT
= 19 ms
TCP Connect-RTT
= 75 ms
HTTP transaction-RTT = 401 ms
Total RTT
= 495 ms
PageSize
= 3448 Bytes
=>

DESCRIPTION:
> RTT taken to perform domain name lookup.
> RTT taken to perform a TCP connect to the HTTP Server.
> RTT taken to send a request and get a response back from the HTTP Server (the probe retrieves the base
HTML page only as body, and does not request hyperlinks within this page).
The SpeedTouch will send the HTTP request, receive the reply, and report the RTT statistics (including the size
of the page returned).

E-DOC-CTC-20061027-0003 v2.0

467

IP Commands

ip debug sendto
Send UDP packets.

SYNTAX:
ip debug sendto

addr = 
[count = ]
[size = ]
[interval = ]
[listen = <{disabled | enabled}>]
[dffield = <{disabled | enabled}>]
[srcaddr = ]
[srcport = ]
dstport = 
[dstintf = ]

where:

468

addr

The destination IP address.

REQUIRED

count

A number between 1 and 1000000.
Represents the number of UDP packets to send.
The default is 1.

OPTIONAL

size

A number between 0 and 20000 (bytes).
Represents the size of the ping packet(s).
The default is 1.

OPTIONAL

interval

A number between 1 and 10000000 (milliseconds).
Represents the intermediate interval between two sent UDP packets.
The default is 100.

OPTIONAL

listen

Listen for incoming ICMP packets (enabled) or only send ICMP packets
(disabled).
The default is disabled.

OPTIONAL

dffield

Enable or disable setting of the don’t fragment flag in the IP headers of
the ping.

OPTIONAL

srcaddr

The IP source address to use.

OPTIONAL

srcport

The UDP source port number to use.

OPTIONAL

dstport

The UDP destination port number to send to.

REQUIRED

dstintf

The IP interface name.
By specifying the destination interface with the dstintf parameter, a direct
send is performed instead of a routed send. This means that the statefull
firewall will be bypassed for the outbound packet. As a result, the
returning icmp packet can not be associated with an existing udp
connection (because there isn’t any) and is legally dropped by the
firewall. To prevent this packet from being dropped, disable the
ICMPchecks and UDPchecks in the firewall configuration.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

IP Commands

EXAMPLE:
=>ip debug sendto addr=10.0.0.148 listen=on srcport=19 dstport=1025
=>ip debug sendto addr=10.0.0.148 listen=on srcport=19 dstport=1025
1 bytes from 10.0.0.148:1025
41
A
=>ip debug sendto addr=10.0.0.148 count=3 listen=on srcport=19 dstport=1025
1 bytes from 10.0.0.148:1025
41
A
1 bytes from 10.0.0.148:1025
41
A
1 bytes from 10.0.0.148:1025
41
A
=>

E-DOC-CTC-20061027-0003 v2.0

469

IP Commands

ip debug stats
Display IP statistics.

SYNTAX:
ip debug stats

EXAMPLE:
=>ip debug stats
Total datagrams received
IP header errors
Datagrams forwarded
Datagram forwarding errors
Datagram forwarding resource errors
Total Fragments received
Fragments dropped due to resources or timeouts
Datagrams reassembled
Datagrams fragmented successfully
Datagram fragmentation errors
Total Datagram fragments created successfully
=>

470

:
:
:
:
:
:
:
:
:
:
:

8599
0
23
3
0
0
0
0
0
0
0

E-DOC-CTC-20061027-0003 v2.0

IP Commands

ip debug traceconfig
Display/modify the IP stack trace configuration.

SYNTAX:
ip debug traceconfig

[input = <{none | label | -telnet | -host |
-broadcast | all}>]
[forward = <{none | label | -telnet | -host |
-broadcast | all}>]
[output = <{none | label | -telnet | -host |
-broadcast | all}>]
[drop = <{none | label | -telnet | -host |
-broadcast | all}>]
[path = <{none | label | -telnet | -host |
-broadcast | all}>]
[mode = <{line | dump}>]
[arp = <{none | all}>]

where:
input

Define the input packets that will be traced.
The default is none.

OPTIONAL

forward

Define the forward packets that will be traced.
The default is none.

OPTIONAL

output

Define the output packets that will be traced.
The default is none.

OPTIONAL

drop

Define the packet drops that will be traced.
The default is all.

OPTIONAL

path

Define the packet that will be path-traced.
The default is none.

OPTIONAL

mode

Select the packet dump method.
Choose between:

OPTIONAL

>
>

line:
dump: .

The default is line.
arp

E-DOC-CTC-20061027-0003 v2.0

Define the ARP packets that will be traced.
The default is none.

OPTIONAL

471

IP Commands

EXAMPLE:
=>ip debug traceconfig
Input traces
: none
Forward traces : none
Output traces : none
Drop traces
: all
Path traces
: none
Trace mode
: line
ARP traces
: none
=>

EXAMPLE:
=>ip debug traceroute addr = 192.193.195.250 count=3 size=1 interval=1000 maxhops=30 dstport=
33433
maxfail=5 type=icmp utime=yes
:ip debug traceroute addr=192.193.195.250
ttl=1
192.193.195.250 676 us 1351 us 648 us
=>

472

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

23 IPQoS Commands
Introduction
This chapter describes the commands of the ipqos command group.

Contents
This chapter covers the following commands:
ipqos config

Configure IPQoS for a given destination interface for the IPQoS
queues instantiation.

474

ipqos list

Display the IPQoS configuration.

477

ipqos ef config

Configure the IPQoS Expedited Forwarding (EF) timer for an
interface.

478

ipqos ef list

Display the IPQoS EF timers.

479

ipqos ef stats

Display the IPQoS EF timer statistics.

480

ipqos queue clear

Clear the IPQoS statistics.

481

ipqos queue config

Modify the IPQoS subqueue configuration.

482

ipqos queue list

Display the IPQoS subqueue configuration.

484

ipqos queue stats

Show the IPQoS subqueue statistics.

485

E-DOC-CTC-20061027-0003 v2.0

473

IPQoS Commands

ipqos config
Configure IPQoS for a given destination interface for the IPQoS queues instantiation.
When enabling or disabling IPQoS, take the following into account:

i

>

if the WAN interface (for example PPPoA, IP oA,...) is detached at the time of enabling/disabling
IPQoS, then the WAN interface has to be attached in order for the enabling/disabling of IPQoS to
take effect.

>

if the WAN interface is attached at the time of enabling/disabling IPQoS, then the WAN interface
has to be detached and then re-attached in order for the enabling/disabling of IPQoS to take
effect.

SYNTAX:
ipqos config

dest = 
[state = <{disabled | enabled}>]
[discard = <{tail | early}>]
[priority = <{wfq | strict | wrr}>]
[realtimerate = ]
[burstsize = ]
[weight1 = ]
[weight2 = ]
[weight3 = ]
[weight4 = ]
[maxpackets = ]
[maxbytes = ]

where:
dest

The destination interface for the IPQoS queues instantiation.
This is an ATM phonebook entry.

REQUIRED

state

Disable or enable IPQoS for the interface.
The default is disabled.

OPTIONAL

discard

Determines the packet discard strategy in case of congestion.
Choose between:

OPTIONAL

>

tail: Tail Drop: arriving packets will be dropped as soon as the
destination queue is in an overflow state.

>

early: Early Packet discard: arriving packets will be dropped early
according to the BLUE active queue management algorithm.

The default is early.

474

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

priority

Select the subqueue priority algorithm.
Choose between:

>

wfq: Weighted Fair Queuing (WFQ) is used for the four AF queues.
The realtime queue has priority over the WFQ queues, which have
priority over the best-effort queue.

>

strict: Priority queuing is used. Strict Priority scheduling is used
between all queues. The higher the queue number, the higher the
priority.

>

wrr: Weighted Round Robin (WRR) is used for the four AF queues.
Each queue is scheduled in turn, with a circular “round”
wrapping.

OPTIONAL

The default is wfq.
realtimerate

A number between 1 and 100.
Represents a percentage of the interface bandwidth for rate-limiting of
the Real Time queue.
In case of congestion, the Real Time queue will only use this
percentage of the interface bandwidth when there is also traffic on the
other queues.
The default is 80.

OPTIONAL

burstsize

A number between 1 and 64.
Represents the Real Time queue burstsize (in kilobytes) for rate
limiting.
The default is 2.

OPTIONAL

weight1

A number between 1 and 97.
Represents the weight of queue 1 used for WFQ or WRR.
The default is 25 (%).

OPTIONAL

weight2

A number between 1 and 97.
Represents the weight of queue 2 used for WFQ or WRR.
The default is 25 (%).

OPTIONAL

weight3

A number between 1 and 97.
Represents the weight of queue 3 used for WFQ or WRR.
The default is 25 (%).

OPTIONAL

weight4

A number between 1 and 97.
Represents the weight of queue 4 used for WFQ or WRR.
The default is 25 (%).

OPTIONAL

maxpackets

A number between 0 and 250.
Represents the maximum number of packets in all IPQoS queues
instantiated for one interface.
The default is 250.

OPTIONAL

maxbytes

A number between 0 and 128.
Represents the maximum size in kilobytes in all IPQoS queues
instantiated for one interface.
The default is 56.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

475

IPQoS Commands

EXAMPLE:
=>ipqos config dest=atm_pvc_8_35 state=enabled
=>ipqos list
Name
State
Discard Priority Size
(Packets)
atm_pvc_0_35 disabled early
wfq
250
atm_pvc_8_35 enabled
early
wfq
250
=>

Size
(KBytes)
56
56

Rate
(%)
80%
80%

Burst
(KBytes)
2
2

Weights
Weights
25% 25% 25% 25%
25% 25% 25% 25%

RELATED COMMANDS:
ipqos list

476

Display the IPQoS configuration.

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

ipqos list
Display the IPQoS configuration.

SYNTAX:
ipqos list

EXAMPLE:
=>ipqos list
Name
State
atm_pvc_0_35 disabled
%
atm_pvc_8_35 enabled
%
=>

Discard

Priority
wfq

Size
Size
(Packets) (KBytes)
250
56

Rate
(%)
80%

Burst
(KBytes)
2

Weights
Weights
25% 25% 25% 25

early
early

wfq

250

80%

2

25% 25% 25% 25

56

RELATED COMMANDS:
ipqos config

E-DOC-CTC-20061027-0003 v2.0

Configure IPQoS for a given destination interface for the IPQoS queues
instantiation.

477

IPQoS Commands

ipqos ef config
Configure the IPQoS Expedited Forwarding (EF) timer for an interface.

SYNTAX:
ipqos ef config

intf = 
[state = <{disabled | enabled}>]
[timeout = ]
[mtu = ]

where:
intf

The name of the IP interface.

REQUIRED

state

Enable or disable the IPQoS EF timer for the interface.
The default is disabled.

OPTIONAL

timeout

A number between 100 and 10000 milliseconds.
Represents the timeout.
The default is 1000.

OPTIONAL

mtu

A number between 68 and 65535.
Represents the MTU of the IP interface in case of EF data.
The default is 1500.

OPTIONAL

EXAMPLE:
The example below shows the default configuration:
=>ipqos ef list
Interface State

Timeout
(ms)
loop
disabled
1000
Rt_PPPoA2 disabled
1000
eth0
disabled
1000
=>ipqos ef config intf=Rt_PPPoA2
=>ipqos ef list
Interface State
Timeout
(ms)
loop
disabled
1000
Rt_PPPoA2 enabled
1000
eth0
disabled
1000
=>

MTU
(bytes)
65535
1500
1500
state=enabled
MTU
(bytes)
65535
1500
1500

RELATED COMMANDS:

478

ipqos ef list

Display the IPQoS EF timers.

ipqos ef stats

Display the IPQoS EF timer statistics.

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

ipqos ef list
Display the IPQoS EF timers.

SYNTAX:
ipqos ef list

EXAMPLE:
=>ipqos ef list
Interface State
loop
Rt_PPPoA2
eth0
=>

disabled
enabled
disabled

Timeout
(ms)
1000
1000
1000

MTU
(bytes)
65535
1500
1500

RELATED COMMANDS:
ipqos ef config

Configure the IPQoS Expedited Forwarding (EF) timer for an interface.

ipqos ef stats

Display the IPQoS EF timer statistics.

E-DOC-CTC-20061027-0003 v2.0

479

IPQoS Commands

ipqos ef stats
Display the IPQoS EF timer statistics.

SYNTAX:
ipqos ef stats

EXAMPLE:
=>ipqos ef stats
Interface State
loop
Rt_PPPoA2
eth0
=>

active
active
disabled

Remain
(ms)
900
900
0

RELATED COMMANDS:

480

ipqos ef config

Configure the IPQoS Expedited Forwarding (EF) timer for an interface.

ipqos ef list

Display the IPQoS EF timers.

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

ipqos queue clear
Clear the IPQoS statistics.

SYNTAX:
ipqos queue clear

EXAMPLE:
=>ipqos queue stats
Name Queue
# packets
added
PVC_1 0
1240
1
0
2
0
3
234
4
0
5
1345
=>ipqos queue clear
=>ipqos queue stats
Name Queue
# packets
added
PVC_1 0
0
1
0
2
0
3
0
4
0
5
0
=>

# packets
marked
0
0
0
0
0
0

# packets
removed
1240
0
0
234
0
1345

# packets
dropped
0
0
0
0
0
0

# packets
replaced
0
0
0
0
0
0

Marking

# packets
marked
0
0
0
0
0
0

# packets
removed
0
0
0
0
0
0

# packets
dropped
0
0
0
0
0
0

# packets
replaced
0
0
0
0
0
0

Marking

0
0
0
0
0
0

0
0
0
0
0
0

RELATED COMMANDS:
ipqos queue stats

E-DOC-CTC-20061027-0003 v2.0

Show the IPQoS subqueue statistics.

481

IPQoS Commands

ipqos queue config
Modify the IPQoS subqueue configuration.

SYNTAX:
ipqos queue config

dest = 
queue = 
[propagate = <{disabled | enabled}>]
[ecnmarking = <{disabled | enabled}>]
[ackfiltering = <{disabled | enabled}>]
[maxpackets = ]
[maxbytes = ]
[respackets = ]
[resbytes = ]
[hold = ]
[markprob = ]

where:
dest

The destination interface for the IPQoS queues instantiation.
Typically, an ATM phonebook entry.

REQUIRED

queue

A number between 0 and 5.
Represents the number of the queue, where:

OPTIONAL

>
>
>
>
>
>
propagate

5 is the Real time queue
4 is the Assured Forwarding (AF) queue 4
3 is the AF queue 3
2 is the AF queue 2
1 is the AF queue 1
0 is the Best Effort queue.

Higher priority packets will be queued in a lower priority queue,
instead of being dropped, as soon as the destination queue is in
overflow state.
The packet will be put in a lower priority queue only once.
Choose between disabled or enabled.
The default is disabled.
Note

The propagate flag for the lowest priority subqueue (the Best
Effort queue) has no meaning.

ecnmarking

Enable Explicit Congestion Notification (ECN) for IP packets in this
subqueue (enabled) or not (disabled).
The default is disabled.

OPTIONAL

ackfiltering

Enable filtering of TCP ACK packets (enabled) or not (disabled).
The default is disabled.

OPTIONAL

maxpackets

A number between 0 and 250.
Represents the maximum number of packets in this queue.
The default is 0 for the Real time queue and 100 for the other queues.

OPTIONAL

Note

482

OPTIONAL

0 means that a maximum size is not enforced.

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

maxbytes

A number between 0 and 128.
Represents the maximum size in kilobytes of this queue.
The default is 0 for the Real time queue and 20 for the other queues.
Note

OPTIONAL

0 means that a maximum size is not enforced.

respackets

A number between 0 and 250.
Represents the reserved number of packets in this queue.
The default is 30 for the Real time queue and 13 for the other queues.

OPTIONAL

resbytes

A number between 0 and 128
Represents the reserved size in kilobytes of this queue.
The default is 12 for the Real time queue and 4 for the other queues.

OPTIONAL

hold

A number (of microseconds).
Represents the hold time in microseconds for early discard strategy.
The default is 50000.

OPTIONAL

markprob

A number between 1 and 1000.
Represents the maximum packet marking probability in parts per
mille for early discard strategy.
The default is 1000.

OPTIONAL

EXAMPLE:
=>ipqos queue list
Name
Queue
Holdtime Markprob
(usecs)
atm_pvc_0_35 0
50000
1000
1
50000
1000
2
50000
1000
3
50000
1000
4
50000
1000
5
50000
1000
atm_pvc_8_35 0
50000
1000
1
50000
1000
2
50000
1000
3
50000
1000
4
50000
1000
5
50000
1000
=>

Propagate ECN

AckFilter Size

Size

Reserved

Reserved

(Packets) (KBytes)

(Packets) (KBytes)

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

0

0

30

12

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

100

20

13

4

disabled

disabled

disabled

0

0

30

12

RELATED COMMANDS:
ipqos queue list

E-DOC-CTC-20061027-0003 v2.0

Display the IPQoS subqueue configuration.

483

IPQoS Commands

ipqos queue list
Display the IPQoS subqueue configuration.

SYNTAX:
ipqos queue list

[dest = ]

where:
dest

The destination interface for the IPQoS queues instantiation.
This is an ATM phonebook entry.
Note

OPTIONAL

If not specified, the IPQoS subqueue configuration for all the
interfaces will be shown.

EXAMPLE:
=>ipqos queue list
Name
Queue
time Markprob

Propagate ECN

AckFilter Size

Size

(Packets) (KBytes)
cs)
atm_pvc_0_35 0
0
1000
1
0
1000
2
0
1000
3
0
1000
4
0
1000
5
0
1000
atm_pvc_8_35 0
0
1000
1
0
1000
2
0
1000
3
0
1000
4
0
1000
5
0
1000
=>

Reserved

Reserved

Hold

(Packets) (KBytes)

(use

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

0

0

30

12

5000

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

100

20

13

4

5000

disabled

disabled

disabled

0

0

30

12

5000

RELATED COMMANDS:
ipqos queue config

484

Modify the IPQoS subqueue configuration.

E-DOC-CTC-20061027-0003 v2.0

IPQoS Commands

ipqos queue stats
Show the IPQoS subqueue statistics.

SYNTAX:
ipqos queue stats

[dest = ]

where:
dest

The destination interface for the IPQoS queues instantiation.
This is an ATM phonebook entry.
Note

OPTIONAL

If not specified, the IPQoS subqueue statistics for all the
interfaces will be shown.

EXAMPLE:
=>ipqos queue stats
Name Queue
# packets
added
PVC_1 0
1240
1
0
2
0
3
234
4
0
5
145
=>

# packets
marked
0
0
0
0
0
0

# packets
removed
1240
0
0
234
0
145

# packets
dropped
0
0
0
0
0
0

# packets
replaced
0
0
0
0
0
0

Marking
0%
0%
0%
0%
0%
0%

RELATED COMMANDS:
ipqos queue clear

E-DOC-CTC-20061027-0003 v2.0

Clear the IPQoS statistics.

485

IPQoS Commands

486

E-DOC-CTC-20061027-0003 v2.0

Label Commands

24 Label Commands
Introduction
This chapter describes the commands of the label command group.

Contents
This chapter covers the following commands:
label add

Create a new label.

488

label delete

Delete a label.

489

label flush

Flush all labels.

490

label list

Display the labels.

491

label modify

Modify a label configuration.

492

label chain add

Add a new label chain.

495

label chain delete

Delete a label chain.

496

label chain flush

Flush all label chains.

497

label chain list

Display a list of chains.

498

label rule add

Add a label rule.

499

label rule delete

Delete a label rule.

502

label rule flush

Flush all label rules.

504

label rule list

Display a list of label rules.

505

label rule modify

Modify a label rule.

507

label rule debug clear

Clear the label rule statistics.

508

label rule debug stats

Display the label rule statistics.

510

label rule debug
traceconfig

Display or modify the rule trace configuration.

511

E-DOC-CTC-20061027-0003 v2.0

487

Label Commands

label add
Create a new label.

SYNTAX:
label add

name = 

where:
name

The name of the label to be added.

REQUIRED

EXAMPLE:
=>label list
Name
Class
Def
DSCP
overwrite dscp
Interactive increase
8
Management increase
12
Video
increase
10
VoIP
overwrite 14
default
increase
default
=>label add name=myLABEL
=>label list
Name
Class
Def
DSCP
overwrite dscp
Interactive increase
8
Management increase
12
Video
increase
10
VoIP
overwrite 14
default
increase
default
myLABEL
ignore
0
=>

Ack
defclass
8
12
10
14
prioritize

Bidirect
disabled
disabled
disabled
disabled
enabled
disabled

Inherit
disabled
disabled
disabled
disabled
enabled
disabled

Tosmark
disabled
disabled
disabled
disabled
disabled
disabled

Type
tos
tos
tos
tos
tos
tos

Value
0
0
0
0
0
0

Ttlover
disabled
disabled
disabled
disabled
disabled
disabled

Ttl
0
0
0
0
0
0

Use
0
0
0
0
0
0

Trace
disabled
disabled
disabled
disabled
disabled
disabled

Ack
defclass
8
12
10
14
prioritize
0

Bidirect
disabled
disabled
disabled
disabled
enabled
disabled
disabled

Inherit
disabled
disabled
disabled
disabled
enabled
disabled
disabled

Tosmark
disabled
disabled
disabled
disabled
disabled
disabled
disabled

Type
tos
tos
tos
tos
tos
tos
tos

Value
0
0
0
0
0
0
0

Ttlover
disabled
disabled
disabled
disabled
disabled
disabled
disabled

Ttl
0
0
0
0
0
0
0

Use
0
0
0
0
0
0
0

Trace
disabled
disabled
disabled
disabled
disabled
disabled
disabled

RELATED COMMANDS:

488

label delete

Delete a label.

label list

Display the labels.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label delete
Delete a label.

SYNTAX:
label delete

name = 
[force = <{disabled | enabled}>]

where:
name

The name of the label to be deleted.

REQUIRED

force

Force delete and cleanup references even when the label is still
in use (enabled) or not (disabled).
The default is disabled.

OPTIONAL

EXAMPLE:
=>label list
Name
Class
Def
Ack
DSCP
overwrite dscp
defclass
Interactive increase
8
8
Management increase
12
12
Video
increase
10
10
VoIP
overwrite 14
14
default
increase
default prioritize
myLABEL
ignore
0
0
=>label delete name=myLABEL force=yes
=>label list
Name
Class
Def
Ack
DSCP
overwrite dscp
defclass
Interactive increase
8
8
Management increase
12
12
Video
increase
10
10
VoIP
overwrite 14
14
default
increase
default prioritize
=>

Bidirect
disabled
disabled
disabled
disabled
enabled
disabled
disabled

Inherit
disabled
disabled
disabled
disabled
enabled
disabled
disabled

Tosmark
disabled
disabled
disabled
disabled
disabled
disabled
disabled

Type
tos
tos
tos
tos
tos
tos
tos

Value
0
0
0
0
0
0
0

Ttlover
disabled
disabled
disabled
disabled
disabled
disabled
disabled

Ttl
0
0
0
0
0
0
0

Use
0
0
0
0
0
0
0

Trace
disabled
disabled
disabled
disabled
disabled
disabled
disabled

Bidirect
disabled
disabled
disabled
disabled
enabled
disabled

Inherit
disabled
disabled
disabled
disabled
enabled
disabled

Tosmark
disabled
disabled
disabled
disabled
disabled
disabled

Type
tos
tos
tos
tos
tos
tos

Value
0
0
0
0
0
0

Ttlover
disabled
disabled
disabled
disabled
disabled
disabled

Ttl
0
0
0
0
0
0

Use
0
0
0
0
0
0

Trace
disabled
disabled
disabled
disabled
disabled
disabled

RELATED COMMANDS:
label add

Create a new label.

label list

Display the labels.

E-DOC-CTC-20061027-0003 v2.0

489

Label Commands

label flush
Flush all labels.

i

The flush command does not impact previously saved configurations.

SYNTAX:
label flush

490

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label list
Display the labels.

SYNTAX:
label list

[name = ]

where:
name

The name of the label to be displayed.
Note

OPTIONAL

If not specified, all the labels will be displayed.

EXAMPLE:
=>label list
Name
Class
Def
DSCP
overwrite dscp
Interactive increase
8
Management increase
12
Video
increase
10
VoIP
overwrite 14
default
increase
default
=>
=>label list name=Interactive
Name
Class
Def
Interactive increase
8
=>

Ack
defclass
8
12
10
14
prioritize

Bidirect
disabled
disabled
disabled
disabled
enabled
disabled

Inherit
disabled
disabled
disabled
disabled
enabled
disabled

Tosmark
disabled
disabled
disabled
disabled
disabled
disabled

Type
tos
tos
tos
tos
tos
tos

Ack
8

Bidirect Inherit Tosmark Type
disabled disabled disabled tos

Value
0
0
0
0
0
0

Ttlover
disabled
disabled
disabled
disabled
disabled
disabled

Ttl
0
0
0
0
0
0

Value Ttlover Ttl
0
disabled 0

Use
0
0
0
0
0
0

Trace
disabled
disabled
disabled
disabled
disabled
disabled

Use Trace
0
disabled

RELATED COMMANDS:
label add

Create a new label.

label delete

Delete a label.

E-DOC-CTC-20061027-0003 v2.0

491

Label Commands

label modify
Modify a label configuration.

SYNTAX:
label modify

name = 
[classification = <{ignore | overwrite | increase}>]
[defclass = ]
[ackclass = ]
[bidirectional = <{disabled | enabled}>]
[inheritance = <{disabled | enabled}>]
[tosmarking = <{disabled | enabled}>]
[tos = ]
[dscp = <{DSCP name> | }]
[precedence = <{IP precedence type> | }]
[trace = <{disabled | enabled}>]

where:
name

The name of the label to be configured.

REQUIRED

classification

Select the method of classification, in other words, determine
what the Layer 3 class assignment must do with the priority of
the data packet (as set by Layer 2).
Choose between:

OPTIONAL

>

ignore: Ignore the class parameters defclass and ackclass,
but use the class as set by Layer 2 (VLAN user priority, ATM
QoS).

>

overwrite: Change the class to defclass and ackclass,
overwriting the value set by Layer 2 (VLAN user priority,
ATM QoS).

>

increase: Change the class according to defclass and
ackclass, but only if the defclass value is higher than the
class value already set by Layer 2.

The default is ignore.
Note

The class as set by Layer 2 is derived from:

>

the VLAN user priority (in case of VLAN or priority
tagged frames)

>

the ATM PVC QoS class (in case the packet is
received from an ATM PVC).

For non-VLAN frames or non-PVC received data, Layer
2 sets the internal class (priority) to 4 by default.
defclass

The default priority class of the assigned connection.
Choose between:

>
>
>

OPTIONAL

A number between 0 and 15
dscp
default.

The default is 0.

492

E-DOC-CTC-20061027-0003 v2.0

Label Commands

ackclass

The priority class of the ACK segments of the TCP connection.
Choose between:

>
>
>

OPTIONAL

A number between 0 and 15
prioritize
defclass.

The default is 0.
bidirectional

The label applies to the initiator stream, the returning stream
(the current connection) as well as to the child connections
(enabled) or not (disabled).
The default is disabled.

OPTIONAL

inheritance

The label will be copied to all child connection streams in the
same direction (enabled) or not (disabled).
The default is disabled.

OPTIONAL

tosmarking

Enable or disable tos marking.
The default is disabled.

OPTIONAL

tos

A number between 0 and 255.
Represents the ToS specification in the IP packet (used for
tosmarking).
The default is 0.

OPTIONAL

Note
dscp

The DSCP in the IP packet (part of tos).
Select a DSCP (see “ Differentiated Services Code Point
(DSCP)” on page 753) or, alternatively, specify the number.
Note

precedence

E-DOC-CTC-20061027-0003 v2.0

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

The precedence in the IP packet (part of tos).
Select an IP precedence (see “ IP Precedence” on page 752) or,
alternatively, specify the number.
Note

trace

The parameters tos, precedence and dscp are mutually
exclusive.

OPTIONAL

The parameters tos, precedence and dscp are mutually
exclusive.

Enable or disable IP tracing for this label.
The default is disabled.

OPTIONAL

493

Label Commands

EXAMPLE:
=>label list
Name
Class
Def
Ack
Bidirect Inherit Tosmark Type Value
Use Trace
DSCP
overwrite dscp
defclass
disabled disabled disabled tos
0
0
0
disabled
Interactive increase
8
8
disabled disabled disabled tos
0
0
0
disabled
Management increase
12
12
disabled disabled disabled tos
0
0
0
disabled
Video
increase
10
10
disabled disabled disabled tos
0
0
0
disabled
VoIP
overwrite 14
14
enabled enabled disabled tos
0
0
0
disabled
default
increase
default prioritize disabled disabled disabled tos
0
0
0
disabled
myLABEL
ignore
0
0
disabled disabled disabled tos
0
0
0
disabled
=>label modify name=myLABEL classification=increase defclass=7 ackclass=7 bidirectional=enabled
inheritance=enabled tosmarking=enabled tos=234 trace=enabled
=>label list
Name
Class
Def
Ack
Bidirect Inherit Tosmark Type Value
Use Trace
DSCP
overwrite dscp
defclass
disabled disabled disabled tos
0
0
0
disabled
Interactive increase
8
8
disabled disabled disabled tos
0
0
0
disabled
Management increase
12
12
disabled disabled disabled tos
0
0
0
disabled
Video
increase
10
10
disabled disabled disabled tos
0
0
0
disabled
VoIP
overwrite 14
14
enabled enabled disabled tos
0
0
0
disabled
default
increase
default prioritize disabled disabled disabled tos
0
0
0
disabled
myLABEL
increase
7
7
enabled enabled enabled tos
234
0
0
enabled
=>

494

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label chain add
Add a new label chain.

SYNTAX:
label chain add

chain = 

where:
chain

The name of the chain to be added.

REQUIRED

EXAMPLE:
=>label chain list
Chains
======
Name
Description
------------------------------------------------routing_labels
system
rt_user_labels
user
rt_default_labels
user
qos_labels
system
qos_user_labels
user
qos_default_labels
user
=>label chain add chain=myChain
=>label chain list
Chains
======
Name
Description
------------------------------------------------routing_labels
system
rt_user_labels
user
rt_default_labels
user
qos_labels
system
qos_user_labels
user
qos_default_labels
user
myChain
user
=>

RELATED COMMANDS:
label chain delete

Delete a label chain.

label chain list

Display a list of chains.

E-DOC-CTC-20061027-0003 v2.0

495

Label Commands

label chain delete
Delete a label chain.

SYNTAX:
label chain delete

chain = 

where:
chain

The name of the chain to be deleted.

REQUIRED

EXAMPLE:
=>label chain list
Chains
======
Name
Description
------------------------------------------------routing_labels
system
rt_user_labels
user
rt_default_labels
user
qos_labels
system
qos_user_labels
user
qos_default_labels
user
myChain
user
=>label chain delete chain=myChain
=>label chain list
Chains
======
Name

Description

------------------------------------------------routing_labels
rt_user_labels
rt_default_labels
qos_labels
qos_user_labels
qos_default_labels
=>

system
user
user
system
user
user

RELATED COMMANDS:

496

label chain add

Add a new label chain.

label chain list

Display a list of chains.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label chain flush
Flush all label chains.

SYNTAX:
label chain flush

E-DOC-CTC-20061027-0003 v2.0

497

Label Commands

label chain list
Display a list of chains.

SYNTAX:
label chain list

[format = <{pretty | cli}>]

where:
format

OPTIONAL

Select the output format of the list.
Choose between:

>

pretty: the configuration is shown as intuitive output in
clear text.

>

cli: the configuration is shown via the CLI commands
configuration.

The default is pretty.

EXAMPLE:
=>label chain list
Chains
======
Name
Description
------------------------------------------------routing_labels
system
rt_user_labels
user
rt_default_labels
user
qos_labels
system
qos_user_labels
user
qos_default_labels
user
=>label chain list format=cli
:label
:label
:label
:label
=>

chain
chain
chain
chain

add
add
add
add

chain=rt_user_labels
chain=rt_default_labels
chain=qos_user_labels
chain=qos_default_labels

RELATED COMMANDS:

498

label chain add

Add a new label chain.

label chain delete

Delete a label chain.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label rule add
Add a label rule.

SYNTAX:
label rule add

i

chain = 
[index = ]
[name = ]
[clink = ]
[srcintf [!]= ]
[srcip [!]= <{ip address | private}>]
[dstip [!]= <{ip address | private}>]
[serv [!]= <{service name}>]
[log = <{disabled | enabled}>]
[state = <{disabled | enabled}>]
label = 

If a value is preceded by a “!”, it means NOT.
For example “srcintf=!wan” means “if srcintf is different from WAN”.
where:
chain

The name of the chain in which the rule must be inserted.

REQUIRED

index

The index number of the rule before which the new rule must
be added.

OPTIONAL

Use the command :label rule list to obtain the
index number of the applicable rule.

Tip
name

The name of the new rule.

OPTIONAL

clink

The name of the chain to be parsed when this rule applies.

OPTIONAL

srcintf

The name of the source interface expression.

OPTIONAL

srcip

The name of the source IP expression.

OPTIONAL

dstip

The name of the destination IP expression.

OPTIONAL

serv

The name of the service expression.

OPTIONAL

log

Disable or enable logging when this rule applies.
The default is disabled.

OPTIONAL

state

Disable or enable this rule.
The default is enabled.

OPTIONAL

label

Choose between:

REQUIRED

>
>
>

E-DOC-CTC-20061027-0003 v2.0

None
link (when clink is used)
label name.

499

Label Commands

EXAMPLE:
=>label rule list
Rules (flags: C=Constant, D=Dynamic, E=Enable, L=Log)
=====
Chain
Nr. Flags Rule
--------------------------------------------------------------------------------------------routing_labels
1
CDE
: link
rt_user_labels
2
CDE
: link
rt_default_labels
qos_labels
1
CDE
: link
qos_user_labels
2
CDE
: link
qos_default_labels
qos_default_labels
1
C E
: VoIP
sip *.* > *.*
2
C E
: VoIP
h323 *.* > *.*
3
C E
: Interactive
telnet *.* > *.*
4
C E
: Interactive
smtp *.* > *.*
5
C E
: Interactive
imap4-ssl *.* > *.*
6
C E
: Interactive
imap3 *.* > *.*
7
C E
: Interactive
imap *.* > *.*
8
C E
: Interactive
imaps *.* > *.*
9
C E
: Interactive
pop3s *.* > *.*
10
C E
: Interactive
pop3 *.* > *.*
11
C E
: Interactive
pop2 *.* > *.*
12
C E
: Interactive
httpproxy *.* > *.*
13
C E
: Interactive
http *.* > *.*
14
C E
: Interactive
https *.* > *.*
15
C E
: Interactive
esp *.* > *.*
16
C E
: Interactive
ah *.* > *.*
17
C E
: Management
dns *.* > *.*
18
C E
: Management
ike *.* > *.*
19
E
: Management
icmp *.* > *.*
20
C E
: Video
rtsp *.* > *.*
21
C E
: Video
igmp *.* > *.*
22
C E
default
: default
!wan.* > *.*
=>label rule add chain=myChain name=myRule dstip=150.150.150.150 serv=DiffServ log=enabled state=enabled
| label=myLABEL
=>label rule list
Rules (flags: C=Constant, D=Dynamic, E=Enable, L=Log)
=====
Chain
Nr. Flags Rule
-------------------------------------------------------------------------------------------------routing_labels
1
CDE
: link
rt_user_labels
2
CDE
: link
rt_default_labels
qos_labels
1
CDE
: link
qos_user_labels
2
CDE
: link
qos_default_labels
qos_default_labels
1
C E
: VoIP
sip *.* > *.*
2
C E
: VoIP
h323 *.* > *.*
3
C E
: Interactive
telnet *.* > *.*
4
C E
: Interactive
smtp *.* > *.*
5
C E
: Interactive
imap4-ssl *.* > *.*
6
C E
: Interactive
imap3 *.* > *.*
7
C E
: Interactive
imap *.* > *.*
8
C E
: Interactive
imaps *.* > *.*
9
C E
: Interactive
pop3s *.* > *.*
10
C E
: Interactive
pop3 *.* > *.*
11
C E
: Interactive
pop2 *.* > *.*
12
C E
: Interactive
httpproxy *.* > *.*
13
C E
: Interactive
http *.* > *.*
14
C E
: Interactive
https *.* > *.*
15
C E
: Interactive
esp *.* > *.*
16
C E
: Interactive
ah *.* > *.*
17
C E
: Management
dns *.* > *.*
18
C E
: Management
ike *.* > *.*
19
E
: Management
icmp *.* > *.*
20
C E
: Video
rtsp *.* > *.*
21
C E
: Video
igmp *.* > *.*
22
C E
default
: default
!wan.* > *.*
myChain
1
C EL
myRule
: myLABEL DiffServ *.* > *.150.150.150.150
=>

RELATED COMMANDS:
label rule delete

500

Delete a label rule.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label rule list

E-DOC-CTC-20061027-0003 v2.0

Display a list of label rules.

501

Label Commands

label rule delete
Delete a label rule.

SYNTAX:
label rule delete

chain = 
index = 

where:
chain

The name of the chain in which a rule must be deleted.

REQUIRED

index

The index number of the rule in the chain.

REQUIRED

Tip

Use the command :label rule list to obtain the
index number of the applicable rule.

EXAMPLE:
=>label rule list
Rules (flags: C=Constant, D=Dynamic, E=Enable, L=Log)
=====
Chain
Nr. Flags Rule
-------------------------------------------------------------------------------------------------routing_labels
1
CDE
: link
rt_user_labels
2
CDE
: link
rt_default_labels
qos_labels
1
CDE
: link
qos_user_labels
2
CDE
: link
qos_default_labels
qos_default_labels
1
C E
: VoIP
sip *.* > *.*
2
C E
: VoIP
h323 *.* > *.*
3
C E
: Interactive
telnet *.* > *.*
...
19
E
: Management
icmp *.* > *.*
20
C E
: Video
rtsp *.* > *.*
21
C E
: Video
igmp *.* > *.*
22
C E
default
: default
!wan.* > *.*
myChain
1
C EL
myRule
: myLABEL DiffServ *.* > *.150.150.150.150
=>label rule delete chain=myChain index=1
=>label rule list
Rules (flags: C=Constant, D=Dynamic, E=Enable, L=Log)
=====
Chain
Nr. Flags Rule
-------------------------------------------------------------------------------------------------routing_labels
1
CDE
: link
rt_user_labels
2
CDE
: link
rt_default_labels
qos_labels
1
CDE
: link
qos_user_labels
2
CDE
: link
qos_default_labels
qos_default_labels
1
C E
: VoIP
sip *.* > *.*
2
C E
: VoIP
h323 *.* > *.*
3
C E
: Interactive
telnet *.* > *.*
...
19
E
: Management
icmp *.* > *.*
20
C E
: Video
rtsp *.* > *.*
21
C E
: Video
igmp *.* > *.*
22
C E
default
: default
!wan.* > *.*
=>

502

E-DOC-CTC-20061027-0003 v2.0

Label Commands

RELATED COMMANDS:
label rule add

Add a label rule.

label rule list

Display a list of label rules.

E-DOC-CTC-20061027-0003 v2.0

503

Label Commands

label rule flush
Flush all label rules.
The chains themselves are not removed.

i

The flush command does not impact previously saved configurations.

SYNTAX:
label rule flush

[chain = ]

where:
chain

The name of the chain to be flushed.
Note

504

OPTIONAL

If not specified, all the rules for all the chains are
flushed.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label rule list
Display a list of label rules.

SYNTAX:
label rule list

[chain = ]
[format = <{pretty | cli}>]
[string = ]
[beginstring = ]

where:
chain

The name of the chain for which the rules must be listed.
Note

format

OPTIONAL

If not specified, all rules for all chains are shown.

Select the output format of the list.
Choose between:

>

pretty: the configuration is shown as intuitive output in
clear text.

>

cli: the configuration is shown via the CLI commands
configuration.

OPTIONAL

The default is pretty.
string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

505

Label Commands

EXAMPLE:
=>label rule list format=cli
:label rule add chain=qos_default_labels
label=VoIP
:label rule add chain=qos_default_labels
label=VoIP
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Interactive
:label rule add chain=qos_default_labels
label=Management
:label rule add chain=qos_default_labels
label=Management
:label rule add chain=qos_default_labels
label=Management
:label rule add chain=qos_default_labels
label=Video
:label rule add chain=qos_default_labels
label=Video
:label rule add chain=qos_default_labels
state=enabled
| label=default
=>

index=1 serv=sip log=disabled state=enabled
index=2 serv=h323 log=disabled state=enabled
index=3 serv=telnet log=disabled state=enabled
index=4 serv=smtp log=disabled state=enabled
index=5 serv=imap4-ssl log=disabled state=enabled
index=6 serv=imap3 log=disabled state=enabled
index=7 serv=imap log=disabled state=enabled
index=8 serv=imaps log=disabled state=enabled
index=9 serv=pop3s log=disabled state=enabled
index=10 serv=pop3 log=disabled state=enabled
index=11 serv=pop2 log=disabled state=enabled
index=12 serv=httpproxy log=disabled state=enabled
index=13 serv=http log=disabled state=enabled
index=14 serv=https log=disabled state=enabled
index=15 serv=esp log=disabled state=enabled
index=16 serv=ah log=disabled state=enabled
index=17 serv=dns log=disabled state=enabled
index=18 serv=ike log=disabled state=enabled
index=19 serv=icmp log=disabled state=enabled
index=20 serv=rtsp log=disabled state=enabled
index=21 serv=igmp log=disabled state=enabled
index=22 name=default srcintf=!wan log=disabled

RELATED COMMANDS:

506

label rule add

Add a label rule.

label rule delete

Delete a label rule.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label rule modify
Modify a label rule.

SYNTAX:
label rule modify

i

chain = 
index = 
[newindex = ]
[name = ]
[clink = ]
[srcintf [!]= ]
[srcip [!]= <{ip address | private}>]
[dstip [!]= <{ip address | private}>]
[serv [!]= <{service name}>]
[log = <{disabled | enabled}>]
[state = <{disabled | enabled}>]
[label = ]

If a value is preceded by a “!”, it means “NOT”.
For example “srcintf=!wan” means “if srcintf is different from WAN”.
where:
chain

The name of the chain which contains the rule.

REQUIRED

index

The number of the rule in the chain.

REQUIRED

newindex

The new number of the rule in the chain.

OPTIONAL

name

The name of the new rule.

OPTIONAL

clink

The name of the chain to be parsed when this rule applies.

OPTIONAL

srcintf

The name of the source interface expression.

OPTIONAL

srcip

The name of the source IP expression.

OPTIONAL

dstip

The name of the destination IP expression.

OPTIONAL

serv

The name of the device expression.

OPTIONAL

log

Disable or enable logging when this rule applies.

OPTIONAL

state

Disable or enable this rule.

OPTIONAL

label

Choose between:

OPTIONAL

>
>
>

E-DOC-CTC-20061027-0003 v2.0

None
link (when clink is used)
label name.

507

Label Commands

label rule debug clear
Clear the label rule statistics.

SYNTAX:
label rule debug clea
r

[chain = ]
[index = ]

where:
chain

The name of the chain in which the rule is to be found.
Note

index

If not specified, the statistics for all the rules in all
chains will be cleared.

The index number (determined by the position) of the rule in
the chain.
Note

508

OPTIONAL

OPTIONAL

If not specified, the statistics for all the rules in a chain
will be cleared.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

EXAMPLE:
=>label rule debug stats chain=qos_labels
chain
index
packets
bytes
-----------------------------------------------------------qos_labels
1
0
0
2
203
19146
=>label rule debug clear chain=qos_labels
=>label rule debug stats
chain
index
packets
bytes
-----------------------------------------------------------routing_labels
1
0
0
2
0
0
qos_labels
1
0
0
2
0
0
qos_default_labels
1
0
0
2
0
0
3
4
168
4
0
0
5
0
0
6
0
0
7
0
0
8
0
0
9
0
0
10
0
0
11
0
0
12
0
0
13
10
480
14
3
144
15
0
0
16
0
0
17
5
329
18
0
0
19
4
452
20
177
17573
=>

RELATED COMMANDS:
label rule debug stats

E-DOC-CTC-20061027-0003 v2.0

Display the label rule statistics.

509

Label Commands

label rule debug stats
Display the label rule statistics.

SYNTAX:
label rule debug stat
s

[chain = ]
[index = ]

where:
chain

The name of the chain for which the statistics must be shown.
Note

index

If not specified, the statistics for the rules applicable to
all chains are shown.

The index number of the rule for which the statistics must be
shown.
Tip
Note

OPTIONAL

OPTIONAL

Use the command :label rule list to obtain the
index number of the applicable rule.
If not specified, the statistics for all rules applicable to
the specified chain are shown.

EXAMPLE:
=>label rule debug stats chain=qos_labels
chain
index
packets
bytes
-----------------------------------------------------------qos_labels
1
0
0
2
167
15690
=>
=>label rule debug stats chain=qos_default_labels index=20
chain
index
packets
bytes
-----------------------------------------------------------qos_default_labels
19
165
16421
=>

RELATED COMMANDS:
label rule debug clear

510

Clear the label rule statistics.

E-DOC-CTC-20061027-0003 v2.0

Label Commands

label rule debug traceconfig
Display or modify the rule trace configuration.

SYNTAX:
label rule debug trac
econfig

[trace = <{disabled | enabled}>]

where:
trace

Disable or enable rule traces.
The default is disabled.

OPTIONAL

EXAMPLE:
=>label rule debug traceconfig
:label rule debug traceconfig state=disabled
=>

E-DOC-CTC-20061027-0003 v2.0

511

Label Commands

512

E-DOC-CTC-20061027-0003 v2.0

Language Commands

25 Language Commands
Introduction
This chapter describes the commands of the language command group.

Contents
This chapter covers the following commands:
language config

Select a language.

514

language delete

Delete one or all language archives.

515

language list

List the available language archives.

516

E-DOC-CTC-20061027-0003 v2.0

513

Language Commands

language config
Select a language.

SYNTAX:
language config

[language = ]
[complete = <{yes | no}>]

where:
language

Language code: OSI language code (2 chars) for language.
Example: en for english.

OPTIONAL

complete

Enable translation for expert pages.
The default is yes.

OPTIONAL

EXAMPLE:
=>language config
language
: en
complete
: no
=>

RELATED COMMANDS:

514

language delete

Delete one or all language archives.

language list

List the available language archives.

E-DOC-CTC-20061027-0003 v2.0

Language Commands

language delete
Delete one or all language archives.

SYNTAX:
language delete

[file = ]
[all = <{yes | no}>]

where:
file

The filename of the language archive to be removed.

OPTIONAL

all

Remove all languages archives (yes) or not (no).
The default is no.

OPTIONAL

RELATED COMMANDS:
language config

Select a language.

language list

List the available language archives.

E-DOC-CTC-20061027-0003 v2.0

515

Language Commands
language list
List the available language archives.

SYNTAX:
language list

EXAMPLE:
=>language list
CODE LANGUAGE
en* English
=>

i

VERSION
5.3.0.10.0

FILENAME


The currently selected language is indicated by a “*” next to the OSI language code.

RELATED COMMANDS:

516

language config

Select a language.

language delete

Delete one or all language archives.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

26 MBUS Commands
Introduction
This chapter describes the commands of the mbus command group.

Contents
This chapter covers the following commands:
mbus client config

Modify client parameters.

518

mbus client exec

Execute mbus command.

519

mbus client register

Register cli client to mbus.

521

mbus debug stats

Display mbus statistics.

522

mbus debug clearstats

Reset MBUS statistics .

523

mbus debug traceconfig

Modify mbus trace settings.

524

mbus listobjects

Display the object instances.

525

mbus listtypes

Display the registered objecttypes.

526

mbus listenums

Display the registered enumtypes.

527

mbus listcontexts

Display the context instances .

528

mbus listsubscriptions

Display the subscription instances .

529

mbus debug loadobjects

Load object instances of registered objecttypes.

530

mbus debug unloadobjects

Unload object instances.

531

mbus pluginevent

Simulate event from plugin .

532

mbus unregister

Unregister a client/plugin context .

533

mbus client unregister

Unregister cli client from mbus .

534

E-DOC-CTC-20061027-0003 v2.0

517

MBUS Commands

mbus client config
Modify client parameters.

SYNTAX:
mbus client config

[writelock = <{enabled | disabled}>]
[wlgetimeout = ]
[wlidletimeout = ]
[path = ]
[type = ]

where:
writelock

Enable or disable mbus writelock.
The default is enabled.

OPTIONAL

wlgetimeout

Writelock get timeout in seconds.


OPTIONAL

wlidletimeout

Writelock idle timeout in seconds.


OPTIONAL

path

Fully qualified mbus path.

OPTIONAL

type

Path type.
The default is idpath.

OPTIONAL

RELATED COMMANDS:

518

mbus client exec

Execute mbus command.

mbus client register

Register cli client to mbus.

mbus debug stats

Display mbus statistics.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus client exec
Execute mbus command.

SYNTAX:
mbus client exec

cmd = <{addobject | deleteobject | getparamattributes
| getparamcount | getparamnames | getparamvalues |
getpath | setparamvalue}>
[param = ]
[value = ]
[gettype = <{object | parameter | path}>]
[depth = ]
[processcmd = <{disabled | enabled}>]
[readcommitted = <{disabled | enabled}>]
[onerrorrollback = <{disabled | enabled}>]

where:
cmd

Mbus command name.
Choose between:

>
>
>
>
>
>
>
>

REQUIRED

addobject
deleteobject
getparamattributes
getparamcount
getparamnames
getparamvalues
getpath
setparamvalue

param

Parameter name.

OPTIONAL

value

Parameter value to set.

OPTIONAL

gettype

Get type elements.
Choose between:

OPTIONAL

>
>
>

object
parameter
path

The default is parameter.
depth

Number of levels to recurse, default=-1 (all).

OPTIONAL

processcmd

Enable or disable the process SET_PARAMVALUE
command flag.
The default is enabled.

OPTIONAL

readcommitted

Enable or disable the read committed data only
(MBUS_CMD_GET_PARAMVALUES) flag.
The default is enabled.

OPTIONAL

onerrorrollback

Enable or disable the on error rollback flag.
The default is enabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

519

MBUS Commands

RELATED COMMANDS:

520

mbus client config

Modify client parameters.

mbus client register

Register cli client to mbus.

mbus debug stats

Display mbus statistics.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus client register
Register cli client to mbus.

SYNTAX:
mbus client register

RELATED COMMANDS:
mbus client config

Modify client parameters.

mbus client exec

Execute mbus command.

mbus debug stats

Display mbus statistics.

E-DOC-CTC-20061027-0003 v2.0

521

MBUS Commands

mbus debug stats
Display mbus statistics.

SYNTAX:
mbus debug stats

RELATED COMMANDS:
mbus debug
traceconfig

522

Modify mbus trace settings.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus debug clearstats
Reset MBUS statistics .

SYNTAX:
mbus debug clearstats

RELATED COMMANDS:
mbus debug stats

Display mbus statistics.

mbus debug traceconfig

Modify mbus trace settings.

E-DOC-CTC-20061027-0003 v2.0

523

MBUS Commands

mbus debug traceconfig
Modify mbus trace settings.

SYNTAX:
mbus debug traceconfig

[level = ]

where:
level

A number between 0 and 4.
Represents the mbus trace level.

OPTIONAL

RELATED COMMANDS:
mbus debug stats

524

Display mbus statistics.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus listobjects
Display the object instances.

SYNTAX:
mbus listobjects

[path =
[type =
[output
[expand

]
<{idpath | keypath}>]
= <{list | tree}>]
= <{disabled | enabled}>]

where:
path

Fully qualified mbus path to list.

OPTIONAL

type

Path type.
Choose between:

OPTIONAL

>
>

idpath
keypath.

The default is idpath.
output

List output type.
Choose between:

>
>

OPTIONAL

list
tree.

The default is tree.
expand

Enable or disable details.
The default is disabled.

OPTIONAL

RELATED COMMANDS:
mbus listtypes

Display the registered objecttypes.

mbus listenums

Display the registered enumtypes.

E-DOC-CTC-20061027-0003 v2.0

525

MBUS Commands

mbus listtypes
Display the registered objecttypes.

SYNTAX:
mbus listtypes

[path = ]
[expand = <{disabled | enabled}>]

where:
path

Fully qualified mbus path to list.

OPTIONAL

expand

Enable or disable details.
The default is disabled.

OPTIONAL

EXAMPLE:
=>mbus listtypes
- root
+ InternetGatewayDevice
* DeviceInfo
* Layer3Forwarding
* LANDevice
- WLANConfiguration
+ WEPKey
+ PreSharedKey
* WANDevice
- WANCommonInterfaceConfig
- WANDSLInterfaceConfig
- WANConnectionDevice
+ WANDSLLinkConfig
+ WANIPConnection
* PortMapping
+ WANPPPConnection
* PortMapping
* Services
* ManagementServer
=>

RELATED COMMANDS:

526

mbus listobjects

Display the object instances.

mbus listenums

Display the registered enumtypes.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus listenums
Display the registered enumtypes.

SYNTAX:
mbus listenumss

[dmtree = <{igd|atomic|system}>]
[name = ]
[expand = <{disabled|enabled}>]

where:
dmtree

Select mbusd datamodel tree.

OPTIONAL

name

Filter enumtypes by (part of) the name

OPTIONAL

expand

Enable or disable details.
The default is disabled.

OPTIONAL

EXAMPLE:
=>mbus listtypes
- root
+ InternetGatewayDevice
* DeviceInfo
* Layer3Forwarding
* LANDevice
- WLANConfiguration
+ WEPKey
+ PreSharedKey
* WANDevice
- WANCommonInterfaceConfig
- WANDSLInterfaceConfig
- WANConnectionDevice
+ WANDSLLinkConfig
+ WANIPConnection
* PortMapping
+ WANPPPConnection
* PortMapping
* Services
* ManagementServer
=>

RELATED COMMANDS:
mbus listobjects

Display the object instances.

mbus listtypes

Display the registered objecttypes.

mbus listcontexts

Display the context instances .

E-DOC-CTC-20061027-0003 v2.0

527

MBUS Commands

mbus listcontexts
Display the context instances .

SYNTAX:
listcontexts

[dmtree = <{igd|atomic|system}>]

where:
dmtree

Select mbusd datamodel tree.

OPTIONAL

RELATED COMMANDS:

528

mbus listobjects

Display the object instances.

mbus listtypes

Display the registered objecttypes.

mbus listenums

Display the registered enumtypes.

mbus listsubscriptions

Display the subscription instances .

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus listsubscriptions
Display the subscription instances .

SYNTAX:
listsubscriptions

[dmtree = <{igd|atomic|system}>]

where:
dmtree

Select mbusd datamodel tree.

OPTIONAL

RELATED COMMANDS:
mbus listobjects

Display the object instances.

mbus listtypes

Display the registered objecttypes.

mbus listenums

Display the registered enumtypes.

mbus listcontexts

Display the context instances .

E-DOC-CTC-20061027-0003 v2.0

529

MBUS Commands

mbus debug loadobjects
Load object instances of registered objecttypes.

SYNTAX:
mbus debug loadobjects

[dmtree = <{igd|atomic|system}>]
[path = ]
[type = <{indexpath|objidpath|keystrpath}>]
[flush = <{disabled|enabled}>]

where:
dmtree

mbus data model tree

OPTIONAL

path

Fully qualified mbus path.

OPTIONAL

type

Path type.
The default is indexpath.

OPTIONAL

flush

Flush objects before load
The default is disabled)

OPTIONAL

RELATED COMMANDS:
mbus debug unloadobjects

530

Unload object instances.

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus debug unloadobjects
Unload object instances.

SYNTAX:
mbus unloadobjects

[path = ]
[type = <{idpath | keypath}>]

where:
path

Fully qualified mbus path.

OPTIONAL

type

Path type.
Choose between:

OPTIONAL

>
>

idpath
keypath.

The default is idpath.

RELATED COMMANDS:
mbus debug loadobjects

E-DOC-CTC-20061027-0003 v2.0

Load object instances of registered objecttypes.

531

MBUS Commands

mbus pluginevent
Simulate event from plugin .

SYNTAX:
mbus pluginevent

ctxid = 
type = <{addobj|delobj|updobj}>
path = 
[name = ]
[value = ]
[orivalue = ]

where:

532

ctxid

Plugin context id

type

Event type

path

Plugin event subpath

name

Plugin event name

value

Plugin event value

orivalue

Plugin event orivalue

E-DOC-CTC-20061027-0003 v2.0

MBUS Commands

mbus unregister
Unregister a client/plugin context .

SYNTAX:
unregister

id = 

where:
id

E-DOC-CTC-20061027-0003 v2.0

message-based client/plugin context id.

533

MBUS Commands

mbus client unregister
Unregister cli client from mbus .

SYNTAX:
unregister

534

E-DOC-CTC-20061027-0003 v2.0

MEMM Commands

27 MEMM Commands
Introduction
This chapter describes the commands of the memm command group.

Contents
This chapter covers the following commands:
memm debug lock traceconfig

Modify lock trace settings.

536

memm debug traceconfig

Modify memm trace settings.

537

memm debug clearstats

Display memm statistics.

541

memm debug lock stats

Display memm statistics.

541

memm listobjects

Display objects.

540

memm stats

Display memm statistics.

541

E-DOC-CTC-20061027-0003 v2.0

535

MEMM Commands

memm debug lock traceconfig
Modify lock trace settings.

SYNTAX:
memm debug lock traceconfig

[level = ]
[name = ]

where:

536

level

A number between 0 and 4.
Represents the memm trace level.

OPTIONAL

name

Application name filter for lock traces (empty displays all
lock traces).

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

MEMM Commands

memm debug traceconfig
Modify memm trace settings.

SYNTAX:
memm debug traceconfig

[level = ]

where:
level

E-DOC-CTC-20061027-0003 v2.0

A number between 0 and 4.
Represents the memm trace level.

OPTIONAL

537

MEMM Commands

memm debug clearstats
Clear time statistics

SYNTAX:
memm debug clearstats

538

E-DOC-CTC-20061027-0003 v2.0

MEMM Commands

memm debug lock stats
Display lock statistics

SYNTAX:
memm debug lock stats

E-DOC-CTC-20061027-0003 v2.0

539

MEMM Commands

memm listobjects
Display objects.

SYNTAX:
memm listobjects

[name = ]

where:
name

540

Select typename(s) to list (supports partial typename).

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

MEMM Commands

memm stats
Display memm statistics.

SYNTAX:
memm stats

[name = ]

where:
name

Select typename(s) to list (supports partial typename).

OPTIONAL

EXAMPLE:
=>memm stats
pool name
--------memm_pooldesc
dynstr_pool
mbus_llist
mbus_dynstr
- strings buffer
mbus_client
mbus_cmddata
mbus_objecttype
mbus_paramtype
mbus_object
mbus_objectindex
upnp_dynstr
-strings buffer
upnp_handles
upnp_devices
upnp_services
upnp_subscriptions
upnp_firstdeviceevents
mbus_cliclient
cwmp_elem_pool
cwmp_attr_pool
cwmp_llist_pool
cwmp_dynstr_pool
-strings buffer
cwmp_event_pool
cwmp_cmddata_pool
--------Total usage
=>

E-DOC-CTC-20061027-0003 v2.0

bytes cur,max,avail (max.%)
---------------------------1196, 1196, 1300
(92%)
72,
72,
120
(60%)
2904, 2904, 4920
(59%)
2928, 2964, 4920
(60%)
3545, 3563, 8192
(43%)
12,
12,
120
(10%)
0,
88, 3520
( 2%)
744,
744,
960
(77%)
5908, 5908, 7000
(84%)
28,
28, 1960
( 1%)
0,
0,
840
( 0%)
36,
60,
600
(10%)
138,
151, 2048
( 7%)
332,
332,
996
(33%)
816,
816, 8160
(10%)
2560, 2560, 19200
(13%)
0,
0, 30400
( 0%)
0,
0, 4000
( 0%)
0,
0,
240
( 0%)
0,
0,
560
( 0%)
0,
0,
400
( 0%)
0,
24,
480
( 5%)
0,
0,
240
( 0%)
0,
0, 8192
( 0%)
0,
0,
64
( 0%)
0,
0, 1320
( 0%)
---------------------------21219, 21422,110752
(19%)

count cur,max,avail
------------------23,
23,
25
3,
3,
5
242,
242,
410
244,
247,
410

ref cur,max,avail
----------------obj:
0, 255
0,
0,
0,
0,
0,
0,
-

1,
0,
31,
211,
1,
0,
3,

1,
2,
31,
211,
1,
0,
5,

10
80
40
250
70
70
50

0,
0,
0,
0,
0,
0,
0,

0,
0,
0,
0,
0,
0,
0,

-

1,
3,
4,
0,
0,
0,
0,
0,
0,
0,

1,
3,
4,
0,
0,
0,
0,
0,
2,
0,

3
30
30
50
50
5
20
20
40
20

0,
0,
0,
0,
0,
0,
0,
0,
0,
0,

0,
0,
0,
0,
0,
0,
0,
0,
0,
0,

-

0,
0,

0,
0,

4
30

0,
0,

0,
0,

-

541

MEMM Commands

EXAMPLE:
=>memm stats
pool name
cur,max,avail
------------memm_pooldesc
j:
0,
255
dynstr_pool
0,
0,
mbus_llist
0,
0,
mbus_dynstr
0,
0,
- strings buffer
mbus_client
0,
0,
mbus_cmddata
0,
0,
mbus_objecttype
0,
0,
mbus_paramtype
0,
0,
mbus_object
0,
0,
mbus_objectindex
0,
0,
upnp_dynstr
0,
0,
- strings buffer
upnp_handles
0,
0,
upnp_devices
0,
0,
upnp_services
0,
0,
upnp_subscriptions
0,
0,
upnp_firstdeviceevents
0,
0,
mbus_cliclient
0,
0,
cwmp_elem_pool
0,
0,
cwmp_attr_pool
0,
0,
cwmp_llist_pool
0,
0,
cwmp_dynstr_pool
0,
0,
- strings buffer
cwmp_event_pool
0,
0,
cwmp_cmddata_pool
0,
0,
------------Total usage
=>

542

bytes cur,max,avail (max.%)

count cur,max,avail

ref

--------------------------1196,
1196,
1300 ( 92%)

------------------23,
23,
25

--ob

72,

72,

120 ( 60%)

3,

3,

5

2460,

2532,

4920 ( 51%)

205,

211,

410

2316,

2424,

4920 ( 49%)

193,

202,

410

2761,
12,

2839,
12,

8192 ( 34%)
120 ( 10%)

1,

1,

10

0,

88,

3520 (

2%)

0,

2,

80

480,

480,

960 ( 50%)

20,

20,

40

3976,

3976,

7000 ( 56%)

142,

142,

250

840,

840,

1960 ( 42%)

30,

30,

70

168,

168,

840 ( 20%)

14,

14,

70

36,

72,

600 ( 12%)

3,

6,

50

132,
332,

152,
332,

2048 ( 7%)
996 ( 33%)

14,
1,

14,
1,

70
3

816,

816,

8160 ( 10%)

3,

3,

30

2560,

2560,

19200 ( 13%)

4,

4,

30

1216,

2432,

30400 (

8%)

2,

4,

50

0,

320,

4000 (

8%)

0,

4,

50

0,

0,

240 (

0%)

0,

0,

5

0,

0,

560 (

0%)

0,

0,

20

0,

0,

400 (

0%)

0,

0,

20

0,

24,

480 (

5%)

0,

2,

40

0,

0,

240 (

0%)

0,

0,

20

0,
0,

0,
0,

8192 (
64 (

0%)
0%)

0,

0,

4

0,

0,

13202 (

0%)

0,

0,

30

--------------------------19373, 21335,110752 ( 19%)

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

28 MLP Commands
Introduction
This chapter describes the commands of the mlp command group.

Contents
This chapter covers the following commands:
mlp flush

Flush all the Multi-Level access Policies (MLP)
structures.

544

mlp import

Import all the scores.

545

mlp debug export

Export all the scores.

546

mlp debug stats

Display MLP statistics.

547

mlp debug traceconfig

Modify the MLP trace settings.

548

mlp privilege add

Add a privilege.

549

mlp privilege addzone

Add a zone to a privilege.

551

mlp privilege config

Modify a privilege.

552

mlp privilege delete

Delete a privilege.

553

mlp privilege list

Display the privileges.

555

mlp privilege removezone

Remove a zone from a privilege.

557

mlp role add

Add a role.

558

mlp role addpriv

Add a privilege to a role.

560

mlp role config

Modify the role.

561

mlp role delete

Delete a role.

562

mlp role list

Display the roles.

563

mlp role removepriv

Remove a privilege from a role.

564

E-DOC-CTC-20061027-0003 v2.0

543

MLP Commands

mlp flush
Flush all the Multi-Level access Policies (MLP) structures.

SYNTAX:
mlp flush

544

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp import
Import all the scores.

SYNTAX:
mlp import

[trace = <{disabled | enabled | full}>]

where:
trace

Select the import trace level.
Choose between:

>
>
>

OPTIONAL

disabled
enabled
full.

The default is disabled.

RELATED COMMANDS:
mlp debug export

E-DOC-CTC-20061027-0003 v2.0

Export all the scores.

545

MLP Commands

mlp debug export
Export all the scores.

SYNTAX:
mlp debug export

RELATED COMMANDS:
mlp import

546

Import all the scores.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp debug stats
Display MLP statistics.

SYNTAX:
mlp debug stats

EXAMPLE:
=>mlp debug stats
Roles (cur/free/max)
: 8/7/15
Privileges (cur/free/max) : 35/25/60
ListItems (cur/free/max) : 31/119/150
=>

E-DOC-CTC-20061027-0003 v2.0

547

MLP Commands

mlp debug traceconfig
Modify the MLP trace settings.

SYNTAX:
mlp debug traceconfig

[trace = <{disabled | enabled | full}>]

where:
trace

Select the trace level.
Choose between:

>
>
>

OPTIONAL

disabled
enabled
full.

The default is disabled.

EXAMPLE:
=>mlp debug traceconfig
mlp trace: disabled
=>

548

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp privilege add
Add a privilege.

SYNTAX:
mlp privilege add

name = 
type = <{access | service}>
[descr = ]

where:
name

The name of the new privilege.
Note

type

descr

REQUIRED

access: the privilege is an access privilege.
service: the privilege is a service privilege.

A description of the privilege.
Note

E-DOC-CTC-20061027-0003 v2.0

The maximum number of privileges is 60.

Select the privilege type.
Choose between:

>
>

REQUIRED

OPTIONAL

The maximum length is 63 characters.

549

MLP Commands

EXAMPLE:
=>mlp privilege list type=access
Privilege (type) Description
---------------------------anyaccess (access) All access privileges granted
AP1 (access) LAN_Local_all
AP2 (access) LAN_Local with all secured channels
AP3 (access) LAN_Local with all channels & access to sensitive files
...
AP15 (access) WAN from all channels
AP16 (access) LAN from HTTP/HTTPs
=>mlp privilege add name=myPrivilege type=access descr="My access privilege"
=>mlp privilege list type=access
Privilege (type) Description
---------------------------anyaccess (access) All access privileges granted
AP1 (access) LAN_Local_all
AP2 (access) LAN_Local with all secured channels
AP3 (access) LAN_Local with all channels & access to sensitive files
...
AP15 (access) WAN from all channels
AP16 (access) LAN from HTTP/HTTPs
myPrivilege (access) My access privilege
=>

RELATED COMMANDS:

550

mlp privilege delete

Delete a privilege.

mlp privilege list

Display the privileges.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp privilege addzone
Add a zone to a privilege.

i

Only one zone can be added at a time to a privilege. If multiple zones need to be added, the
command :mlp privilege addzone must be executed for each zone to be added.

SYNTAX:
mlp privilege addzone

name = 
zone = 

where:
name

The name of the privilege in which a zone must be added.

REQUIRED

zone

The name of the new zone.

REQUIRED

EXAMPLE:
=>mlp privilege list type=access name=myPrivilege verbose=all
myPrivilege (access) My access privilege
=>mlp privilege addzone name=myPrivilege zone=channel_http
=>mlp privilege list type=access name=myPrivilege verbose=all
myPrivilege (access) My access privilege
channel_http
=>

RELATED COMMANDS:
mlp privilege
removezone

E-DOC-CTC-20061027-0003 v2.0

Remove a zone from a privilege.

551

MLP Commands

mlp privilege config
Modify a privilege.

SYNTAX:
mlp privilege config

name = 
[descr = ]
[score = <{hex-word}[:{hex-word}] ex:
'a12:c30f'>]

where:
name

The name of the privilege to be modified.

REQUIRED

descr

Set the privilege description.

OPTIONAL

Note
score

The maximum length is 63 characters.

Set the score of the privilege.
Note

OPTIONAL

This is a hexadecimal value, for example “a12:c30f”.

EXAMPLE:
=>mlp privilege config name=myPrivilege descr="My test privilege" score=a12:def4
=>mlp privilege list verbose=all
anyaccess (access) All access privileges granted
unsecure_connection, channel_ftp, channel_telnet, channel_http,
channel_mdap, channel_serial, origin_lan, origin_wan, origin_local
anyservice (service) All service privileges granted
...
AP15 (access) WAN from all channels
unsecure_connection, channel_ftp, channel_telnet, channel_http,
channel_mdap, channel_serial, origin_wan
AP16 (access) LAN from HTTP/HTTPs
unsecure_connection, channel_http, origin_lan
myPrivilege (service) My test privilege
r_lan, r_fs_view, r_fs_retrieve, r_rtg, r_fwdg, r_frwl, r_ipsec_norm,
r_ipsec_adv, r_certificates, r_local, r_qos, and_lan, and_local, cli,
ftp
=>

552

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp privilege delete
Delete a privilege.

SYNTAX:
mlp privilege delete

name = 

where:
name

The name of the privilege to be deleted.

REQUIRED

EXAMPLE:
=>mlp privilege list type=access
Privilege (type) Description
---------------------------anyaccess (access) All access privileges granted
AP1 (access) LAN _Local_all
AP2 (access) LAN_Local with all secured channels
AP3 (access) LAN_Local with all channels & access to sensitive files
AP4 (access) LAN_Local with all secured channels & access to sensitive files
AP5 (access) WAN from a secure HTTP
AP6 (access) WAN from a secure HTTP & access to sensitive files
AP7 (access) LAN from all channels except telnet
AP8 (access) LAN from all secured channels except telnet
AP9 (access) LAN from all channels except telnet & access to sensitive file
AP10 (access) LAN access to sensitive file & secured channels except telnet
AP11 (access) All origins_noHTTP
AP12 (access) All origins_from all secured channels no http
AP13 (access) All origins_noHTTP & access to sensitive files
AP14 (access) All origins_secured channels &access to sensitive files no http
AP15 (access) WAN from all channels
AP16 (access) LAN from HTTP/HTTPs
myPrivilege (access) My access privilege
=>mlp privilege delete name=myPrivilege
=>mlp privilege list type=access
Privilege (type) Description
---------------------------anyaccess (access) All access privileges granted
AP1 (access) LAN _Local_all
AP2 (access) LAN_Local with all secured channels
AP3 (access) LAN_Local with all channels & access to sensitive files
...
AP13
AP14
AP15
AP16

(access)
(access)
(access)
(access)

All
All
WAN
LAN

origins_noHTTP & access to sensitive files
origins_secured channels &access to sensitive files no http
from all channels
from HTTP/HTTPs

=>

E-DOC-CTC-20061027-0003 v2.0

553

MLP Commands

RELATED COMMANDS:

554

mlp privilege delete

Add a privilege.

mlp privilege list

Display the privileges.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp privilege list
Display the privileges.

SYNTAX:
mlp privilege list

[name = ]
[type = <{access | service}>]
[verbose = <{minimal | medium | all}>]

where:
name

The name of the privilege to be listed.
Note

type

service: only the service privileges will be shown.
If not specified, all the privilege types will be shown.

Limit the output list. Choose between:

>
>
>

OPTIONAL

access: only the access privileges will be shown

Note
verbose

If not specified, all the privileges will be shown.

Select the privilege type to be shown. Choose between:

>
>

OPTIONAL

OPTIONAL

minimal
medium
all.

The default is minimal.

E-DOC-CTC-20061027-0003 v2.0

555

MLP Commands

EXAMPLE:
=>mlp privilege list type=service
Privilege (type) Description
---------------------------anyservice (service) All service privileges granted
SP1 (service) Limited_Read
SP2 (service) detailed_Read
SP3 (service) Write_to_LAN
SP4 (service) Write_FWD_RT_normal_FW_cfgs
SP5 (service) cooperative_cfgs
SP6 (service) Remote Configurations
SP7 (service) Advanced sink & source FW
SP8 (service) Write_to_U_Connection
SP9 (service) Write_to_Local
SP10 (service) Simple_network_debugging
SP11 (service) Advance_Network_debugging
SP12 (service) User_admin
SP13 (service) MLP_Admin
SP14 (service) Backup & Restore
SP15 (service) CLI mngt Interface only
SP16 (service) CGI mngt Interface only
SP17 (service) FTP mngt Interface only
=>mlp privilege list name=SP5 verbose=all
SP5 (service) cooperative_cfgs
r_ipsec_norm, r_ipsec_adv, r_certificates, w_frwl_norm, w_frwl_adv,
w_ipsec, w_certificates
=>

RELATED COMMANDS:

556

mlp privilege delete

Add a privilege.

mlp privilege delete

Delete a privilege.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp privilege removezone
Remove a zone from a privilege.

i

Only one zone can be removed at a time from a privilege. If multiple zones need to be removed, the
command :mlp privilege removezone must be executed for each zone to be removed.

SYNTAX:
mlp privilege removezone

name = 
zone = 

where:
name

The name of the privilege in which a zone must be removed.

REQUIRED

zone

The name of the zone to be removed.

REQUIRED

EXAMPLE:
=>mlp privilege list name=myPrivilege verbose=all
myPrivilege (access) My access privilege
channel_http, channel_serial
=>mlp privilege removezone name=myPrivilege zone=channel_serial
=>mlp privilege list name=myPrivilege verbose=all
myPrivilege (access) My access privilege
channel_http
=>

RELATED COMMANDS:
mlp privilege addzone

E-DOC-CTC-20061027-0003 v2.0

Add a zone to a privilege.

557

MLP Commands

mlp role add
Add a role.

SYNTAX:
mlp role add

name = 
parent = 
[descr = ]

where:
name

The name of the new role.
Note

REQUIRED

The maximum number of roles is 15.

parent

The name of the parent role.

REQUIRED

descr

The role description.

OPTIONAL

Note

The maximum length is 63 characters.

EXAMPLE:
=>mlp role list
Role (parent) Description
------------------------root (-) The superuser
SuperUser (root) Any service and any access from LAN/WAN/LOCAL
TechnicalSupport (SuperUser) Any service and any channels from WAN
Administrator (TechnicalSupport) Any service and any access from LAN/Local origin only
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
User (PowerUser) GUI(Overview pages, remote assistance) via HTTP/HTTPS from LAN
LAN_Admin (Administrator) Only LAN related configurations from any Channel/Origin
WAN_Admin (Administrator) Only WAN related configurations from any Channels/Origin
=>mlp role create name=myRole parent=User descr="My user access"
=>mlp role list
Role (parent) Description
------------------------root (-) The superuser
SuperUser (root) Any service and any access from LAN/WAN/LOCAL
TechnicalSupport (SuperUser) Any service and any channels from WAN
Administrator (TechnicalSupport) Any service and any access from LAN/Local origin only
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
User (PowerUser) GUI(Overview pages, remote assistance) via HTTP/HTTPS from LAN
LAN_Admin (Administrator) Only LAN related configurations from any Channel/Origin
WAN_Admin (Administrator) Only WAN related configurations from any Channels/Origin
myRole (User) My user access
=>

RELATED COMMANDS:
mlp role delete

558

Delete a role.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp role list

E-DOC-CTC-20061027-0003 v2.0

Display the roles.

559

MLP Commands

mlp role addpriv
Add a privilege to a role.

SYNTAX:
mlp role addpriv

name = 
access = 
service = 

where:
name

The name of the role.

REQUIRED

access

The name of the access privilege to be added.

REQUIRED

service

The name of the service privilege to be added.

REQUIRED

EXAMPLE:
=>mlp role list name=myRole verbose=all
myRole (User) My user access

=>mlp role addpriv name=myRole access=myPrivilege service=SP7
=>mlp role list name=myRole verbose=all
myRole (User) My user access
myPrivilege & SP7

=>

RELATED COMMANDS:
mlp role removepriv

560

Remove a privilege from a role.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp role config
Modify the role.

SYNTAX:
mlp role config

name = 
[parent = ]
[descr = ]

where:
name

The name of the role to be configured.

REQUIRED

parent

The name of the parent role.

OPTIONAL

descr

The role description.

OPTIONAL

Note

The maximum length is 63 characters.

EXAMPLE:
=>mlp role list name=myRole verbose=all
myRole (User) My user access
myPrivilege & SP7

=>mlp role config name=myRole parent=Guest descr="My user access"
=>mlp role list name=myRole verbose=all
myRole (Guest) My user access
myPrivilege & SP7

=>

E-DOC-CTC-20061027-0003 v2.0

561

MLP Commands

mlp role delete
Delete a role.

SYNTAX:
mlp role delete

name = 

where:
name

The name of the role to be deleted.

REQUIRED

EXAMPLE:
=>mlp role list
Role (parent) Description
------------------------root (-) The superuser
SuperUser (root) Any service and any access from LAN/WAN/LOCAL
TechnicalSupport (SuperUser) Any service and any channels from WAN
Administrator (TechnicalSupport) Any service and any access from LAN/Local origin only
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
User (PowerUser) GUI(Overview pages, remote assistance) via HTTP/HTTPS from LAN
LAN_Admin (Administrator) Only LAN related configurations from any Channel/Origin
WAN_Admin (Administrator) Only WAN related configurations from any Channels/Origin
myRole (Guest) My user access
=>mlp role delete name=myRole
=>mlp role list
Role (parent) Description
------------------------root (-) The superuser
SuperUser (root) Any service and any access from LAN/WAN/LOCAL
TechnicalSupport (SuperUser) Any service and any channels from WAN
Administrator (TechnicalSupport) Any service and any access from LAN/Local origin only
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
User (PowerUser) GUI(Overview pages, remote assistance) via HTTP/HTTPS from LAN
LAN_Admin (Administrator) Only LAN related configurations from any Channel/Origin
WAN_Admin (Administrator) Only WAN related configurations from any Channels/Origin
=>

RELATED COMMANDS:

562

mlp role delete

Add a role.

mlp role list

Display the roles.

E-DOC-CTC-20061027-0003 v2.0

MLP Commands

mlp role list
Display the roles.

SYNTAX:
mlp role list

[name = ]
[verbose = <{minimal | medium | all}>]

where:
name

The name of the role to be listed.
Note

verbose

If not specified, all the roles will be listed.

Limit the output list.
Choose between:

>
>
>

OPTIONAL

OPTIONAL

minimal
medium
all.

The default is minimal.

EXAMPLE:
=>mlp role list
Role (parent) Description
------------------------root (-) The superuser
SuperUser (root) Any service and any access from LAN/WAN/LOCAL
TechnicalSupport (SuperUser) Any service and any channels from WAN
Administrator (TechnicalSupport) Any service and any access from LAN/Local origin only
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
User (PowerUser) GUI(Overview pages, remote assistance) via HTTP/HTTPS from LAN
LAN_Admin (Administrator) Only LAN related configurations from any Channel/Origin
WAN_Admin (Administrator) Only WAN related configurations from any Channels/Origin
myRole (Guest) My user access
=>mlp role list name=PowerUser verbose=all
PowerUser (Administrator) GUI(Service/overview page)via http/https from LAN origin
AP16 & SP1
AP16 & SP2
AP16 & SP10
AP16 & SP16
AP16 & SP8
=>

RELATED COMMANDS:
mlp role delete

Add a role.

mlp role delete

Delete a role.

E-DOC-CTC-20061027-0003 v2.0

563

MLP Commands

mlp role removepriv
Remove a privilege from a role.

SYNTAX:
mlp role removepriv

name = 
access = 
[service = ]

where:
name

The name of the role.

REQUIRED

access

The name of the access privilege to be deleted.

REQUIRED

service

The name of the service privilege to be deleted.

OPTIONAL

EXAMPLE:
=>mlp role list name=myRole verbose=all
myRole (Guest) My user access
myPrivilege & SP7

=>mlp role removepriv name=myRole access=myPrivilege
=>mlp role list name=myRole verbose=all
myRole (Guest) My user access

=>

RELATED COMMANDS:
mlp role addpriv

564

Add a privilege to a role.

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

29 NAT Commands
Introduction
This chapter describes the commands of the nat command group.

Contents
This chapter covers the following commands:
nat config

Display/modify global NAT configuration options.

566

nat flush

Flush the current NAT configuration.

567

nat ifconfig

Modify address translation on an IP interface.

568

nat iflist

Display the address translation configuration on all the interfaces.

569

nat mapadd

Add an address mapping to a Network Address Translation (NAT)
enabled interface.

570

nat mapdelete

Delete an address mapping from a NAT enabled interface.

574

nat maplist

Display the address mapping for a NAT enabled interface.

575

nat tmpladd

Add an address mapping template.

576

nat tmpldelete

Delete an address mapping template.

580

nat tmpllist

Display the address mapping templates.

581

nat tmplinst

Instantiate address mapping templates for a given dynamic address.

582

E-DOC-CTC-20061027-0003 v2.0

565

NAT Commands

nat config
Display/modify global NAT configuration options.

SYNTAX:
nat config

[trace = <{disabled | enabled}>]

where:
trace

Enable or disable traces.
The default is disabled.

REQUIRED

EXAMPLE:
=>nat config
NAT traces : disabled
=>nat config trace=enabled
=>nat config
NAT traces : enabled
=>

566

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

nat flush
Flush the current NAT configuration.

SYNTAX:
nat flush

E-DOC-CTC-20061027-0003 v2.0

567

NAT Commands

nat ifconfig
Modify address translation on an IP interface.

SYNTAX:
nat ifconfig

intf = 
translation = <{disabled | enabled | transparent}>

where:
intf

The IP interface name.

REQUIRED

translation

Enable or disable address translation.
Choose between:

REQUIRED

>
>
>

disabled: Address translation is disabled.
enabled: Address translation is enabled.
transparent: An inside address is translated into the same
outside IP address. In fact, no translation happens and the
IP packets passing through the Thomson ST remain
untouched.

The default is disabled.

EXAMPLE:
=>nat iflist
Interface
NAT
loop
disabled
myPPP_ppp
disabled
eth0
transparent
=>nat ifconfig intf=myPPP_ppp translation=enabled
=>nat iflist
Interface
NAT
loop
disabled
myPPP_ppp
enabled
eth0
transparent
=>

RELATED COMMANDS:
nat iflist

568

Display the address translation configuration on all the interfaces.

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

nat iflist
Display the address translation configuration on all the interfaces.

SYNTAX:
nat iflist

EXAMPLE:
=>nat iflist
Interface
loop
Internet
RtPPPoE_ppp
LocalNetwork
=>

NAT
disabled
enabled
enabled
transparent

RELATED COMMANDS:
nat ifconfig

E-DOC-CTC-20061027-0003 v2.0

Modify address translation on an IP interface.

569

NAT Commands

nat mapadd
Add an address mapping to a Network Address Translation (NAT) enabled interface.

SYNTAX:
nat mapadd

intf = 
[type = <{napt | nat}>]
[outside_addr = ]
[inside_addr = ]
[access_list = ]
[foreign_addr = ]
[protocol = <{supported IP protocol} or number>]
[outside_port = ]
[inside_port = ]
[mode = <{auto | inbound | outbound}>]

where:
intf

The IP interface name.
Note

type

outside_addr

The specified interface must be an existing NAT enabled
interface.
OPTIONAL

The type of NAT map to be used.
Choose between:

>

napt: The map is a Network Address Port Translation (NAPT)
map or a port-shifting NAT map.

>

nat: The map is a basic NAT map or a two-way NAT map.

The outside (typically public) IP address.

>

Inbound: This map will only apply if the destination IP address is
part of the outside address(es).

>

Outbound: Represents the address(es) to be used as source
address after translation.

Allowed values are:

>
>
>

570

REQUIRED

An IP address (A.B.C.D or A.D, meaning A.0.0.D).

REQUIRED
for NAT maps
and NAPT
maps.
OPTIONAL
for portshifting
maps.

A range of IP addresses (A.B.C.[D-E]) (only for NAT).
An IP subnet (A.B.C.D/M) (only for NAT).

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

inside_addr

The inside (typically private) IP address.

>

Inbound: Represents the address(es) to be used as destination
address after translation.

>

Outbound: This map will only apply if the source IP address is
part of the inside address(es).

Allowed values are:

>
>
>

An IP address (A.B.C.D or A.D, meaning A.0.0.D).

OPTIONAL
for NAT maps
and NAPT
maps.
REQUIRED
for portshifting
maps.

A range of IP addresses (A.B.C.[D-E]) (only for NAT).
An IP subnet (A.B.C.D/M (only for NAT)).

The default is ““ (unmapped).
Note
access_list

If specified, the number of inside addresses must be equal
to the number of outside addresses.

The range of inside addresses to which the mapping is restricted.
This parameter is used for outbound traffic only. Represents the list
of inside IP addresses (LAN devices) allowed to make use of this
map.
Allowed values are:

>
>
>
>

OPTIONAL

An IP address (A.B.C.D or A.D, meaning A.0.0.D).
A range of IP addresses (A.B.C.[D-E]).
An IP subnet (A.B.C.D/M).
* (all addresses).

The default is the inside_addr.
foreign_addr

The range of destination addresses to which the mapping is
restricted.
This parameter is used as filter for inbound/outbound traffic.

>

Inbound: This map only applies if the source IP address is part
of the foreign address(es).

>

Outbound: This map only applies if the destination IP address is
part of the foreign address(es).

OPTIONAL

Allowed values are:

>
>
>
>

An IP address (A.B.C.D or A.D, meaning A.0.0.D).
A range of IP addresses (A.B.C.[D-E]).
An IP subnet (A.B.C.D/M).
* (all addresses).

The default is * (meaning all addresses).
protocol

E-DOC-CTC-20061027-0003 v2.0

The IP protocol to be used as filter for inbound/outbound traffic. The
NAT map only applies if the protocol of the IP packet matches the
map protocol.
Select an IP protocol (see “ Supported IP Protocols” on page 746) or,
alternatively, type the protocol number.
The default is 0 (meaning any protocol).

OPTIONAL

571

NAT Commands

outside_port

The outside port number or range (only for maps of type napt).

>

For a NAPT map: Represents the range of TCP/UDP ports to be
used as dynamic port range during the NAPT process.

>

For a port-shifting map: Represents the source port(s) to be
translated (shifted) into inside_port.

Allowed values are:

>
>
inside_port

TCP/UDP port number (only for port-shifting maps).

TCP/UDP port number (only for port-shifting maps).
The size of inside_port must be identical to the size of
outside_port.

The mode to create the portmap.
Choose between:

>
>
>

REQUIRED
for portshifting map

TCP/UDP port range [P-Q] (with Q > P)

Note
mode

REQUIRED
for portshifting map.

TCP/UDP port range [P-Q] (with Q > P)

The inside port number or range (only for maps of type napt).
If this parameter is specified for a map of type napt, then this map is
a port-shifting map.
Represents the target TCP/UDP ports to which the traffic has to be
shifted.
Allowed values are:

>
>

OPTIONAL
for NAPT
map.

OPTIONAL

auto
inbound
outbound.

The standard is auto.

572

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

EXAMPLE:
=>nat maplist
Idx Type Interface
Outside Address
Inside Address
Use
1 NAPT eth0
any:80
127.0.0.1:8080
0
2 NAPT eth0
any:1080
127.0.0.1:8080
0
3 NAPT eth0
any:8080
127.0.0.1:8080
0
=>nat mapadd intf=myPPP_ppp type=napt outside_addr=100.100.100.1 access_list=10.0.0.0/24
=>nat maplist
Idx Type Interface
Outside Address
Inside Address
Use
1 NAPT myPPP_ppp
100.100.100.1
unmapped
0
1 NAPT eth0
any:80
127.0.0.1:8080
0
2 NAPT eth0
any:1080
127.0.0.1:8080
0
3 NAPT eth0
any:8080
127.0.0.1:8080
0
=>maplist intf=myPPP_ppp expand=enabled
Idx Type Interface
Outside Address
Inside Address
Use
1 NAPT myPPP_ppp
100.100.100.1
unmapped
0
Access List................... 10.0.0.0/24
Foreign Address............... any
Protocol...................... any
Flags......................... Static
Description................... Outbound NAPT without defserver
=>

RELATED COMMANDS:
nat mapdelete

Delete an address mapping from a NAT enabled interface.

nat maplist

Display the address mapping for a NAT enabled interface.

E-DOC-CTC-20061027-0003 v2.0

573

NAT Commands

nat mapdelete
Delete an address mapping from a NAT enabled interface.

SYNTAX:
nat mapdelete

intf = 
index = 

where:
intf

The IP interface name.

REQUIRED

index

The map index.

REQUIRED

Tip

Use the command :nat maplist to obtain a list
of the mapindexes.

EXAMPLE:
=>nat maplist
Idx Type Interface
Outside Address
1 NAPT myPPP_ppp
100.100.100.1
1 NAPT eth0
any:80
2 NAPT eth0
any:1080
3 NAPT eth0
any:8080
=>nat mapdelete intf=myPPP_ppp index=1
=>nat maplist
Idx Type Interface
Outside Address
1 NAPT eth0
any:80
2 NAPT eth0
any:1080
3 NAPT eth0
any:8080
=>

Inside Address
unmapped
127.0.0.1:8080
127.0.0.1:8080
127.0.0.1:8080

Use
0
0
0
0

Inside Address
127.0.0.1:8080
127.0.0.1:8080
127.0.0.1:8080

Use
0
0
0

RELATED COMMANDS:

574

nat mapadd

Add an address mapping to a Network Address Translation (NAT) enabled
interface.

nat maplist

Display the address mapping for a NAT enabled interface.

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

nat maplist
Display the address mapping for a NAT enabled interface.

SYNTAX:
nat maplist

[intf = ]
[expand = <{disabled | enabled}>]
[string = ]
[beginstring = ]

where:
intf

The IP interface name.
Note

OPTIONAL

If not specified, the address mapping for all the NAT
enabled interfaces will be shown.

expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

string

string matching condition

OPTIONAL

beginstring

beginstring matching condition

OPTIONAL

EXAMPLE:
=>nat maplist
Idx Type Interface
1 NAPT myPPP_ppp
1 NAPT eth0
2 NAPT eth0
3 NAPT eth0
=>maplist intf=myPPP_ppp
Idx Type Interface
1 NAPT myPPP_ppp

Outside Address
100.100.100.1
any:80
any:1080
any:8080
expand=enabled
Outside Address
100.100.100.1
Access List...................
Foreign Address...............
Protocol......................
Flags.........................
Description...................

Inside Address
unmapped
127.0.0.1:8080
127.0.0.1:8080
127.0.0.1:8080

Use
0
0
0
0

Inside Address
Use
unmapped
0
10.0.0.0/24
any
any
Static
Outbound NAPT without defserver

=>

RELATED COMMANDS:
nat mapadd

Add an address mapping to a Network Address Translation (NAT) enabled
interface.

nat mapdelete

Delete an address mapping from a NAT enabled interface.

E-DOC-CTC-20061027-0003 v2.0

575

NAT Commands

nat tmpladd
Add an address mapping template.

SYNTAX:
nat tmpladd

[intf = ]
[group = <{wan|local|lan|tunnel|dmz|guest} or
number>]
[timeout = ]
[type = <{napt | nat}>]
outside_addr = 
[inside_addr = ]
[access_list = ]
[foreign_addr = ]
[protocol = <{supported IP protocol} or number>]
[outside_port = ]
[inside_port = ]
[mode = <{auto | inbound | outbound}>]

where:
intf

The IP interface name.

OPTIONAL

group

The IP interface group scope for this template.
Choose between:

OPTIONAL

>
>
>
>
>
>

wan
local
lan
tunnel
dmz
guest.

Note
timeout

A number between 0 and 6553 (seconds).
Represents the lifetime for this template.

OPTIONAL

type

The type of NAT map to be used.
Choose between:

OPTIONAL

>
>

576

If an interface has been defined with the parameter intf,
then the setting for this parameter is ignored.

napt: The map is a NAPT map or a port-shifting NAT map.
nat: The map is a basic NAT map or a two-way NAT map.

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

outside_addr

The outside (typically public) IP address.

>

Inbound: This map will only apply if the destination IP
address is part of the outside address(es).

>

Outbound: Represents the address(es) to be used as source
address after translation.

Allowed values are:

>
>
>
inside_addr

An IP address (A.B.C.D or A.D, meaning A.0.0.D).

OPTIONAL
for portshifting
maps.

A range of IP addresses (A.B.C.[D-E]) (only for NAT).
An IP subnet (A.B.C.D/M) (only for NAT).

The inside (typically private) IP address.

>

Inbound: Represents the address(es) to be used as
destination address after translation.

>

Outbound: This map will only apply if the source IP address is
part of the inside address(es).

Allowed values are:

>
>
>

REQUIRED
for NAT maps
and NAPT
maps.

An IP address (A.B.C.D or A.D, meaning A.0.0.D).

OPTIONAL
for NAT maps
and NAPT
maps.
REQUIRED
for portshifting
maps.

A range of IP addresses (A.B.C.[D-E]) (only for NAT).
An IP subnet (A.B.C.D/M (only for NAT)).

Default value is ““ (meaning unmapped).
Note
access_list

If specified, the number of inside addresses must be equal
to the number of outside addresses.

The range of inside addresses to which the mapping is restricted.
This parameter is used for outbound traffic only. Represents the
list of inside IP addresses (LAN devices) allowed to make use of
this map.
Allowed values are:

>
>
>
>

OPTIONAL

An IP address (A.B.C.D or A.D, meaning A.0.0.D).
A range of IP addresses (A.B.C.[D-E]).
An IP subnet (A.B.C.D/M).
* (all addresses).

The default is the inside_addr.
foreign_addr

The range of destination addresses to which the mapping is
restricted.
This parameter is used as filter for inbound/outbound traffic.

>

Inbound: This map only applies if the source IP address is part
of the foreign address(es).

>

Outbound: This map only applies if the destination IP address
is part of the foreign address(es).

OPTIONAL

Allowed values are:

>
>
>
>

An IP address (A.B.C.D or A.D, meaning A.0.0.D).
A range of IP addresses (A.B.C.[D-E]).
An IP subnet (A.B.C.D/M).
* (all addresses).

The default is * (meaning all addresses).

E-DOC-CTC-20061027-0003 v2.0

577

NAT Commands

protocol

The IP protocol to be used as filter for inbound/outbound traffic.
The NAT map only applies if the protocol of the IP packet matches
the map protocol.
Select an IP protocol (see “ Supported IP Protocols” on page 746)
or, alternatively, type the protocol number.
The default is 0 (meaning any protocol).

OPTIONAL

outside_port

The outside port number or range (only for maps of type napt).

OPTIONAL
for NAPT
map.

>

For a NAPT map:
Represents the range of TCP/UDP ports to be used as dynamic
port range during the NAPT process.

>

For a port-shifting map:
Represents the source port(s) to be translated (shifted) into
inside_port.

REQUIRED
for portshifting map.

Allowed values are:

>
>
inside_port

TCP/UDP port range [P-Q] (with Q > P)
TCP/UDP port number (only for port-shifting maps).

The inside port number or range (only for maps of type napt).
If this parameter is specified for a map of type napt, then this map
is a port-shifting map.
Represents the target TCP/UDP ports to which the traffic has to be
shifted.
Allowed values are:

>
>

TCP/UDP port range [P-Q] (with Q > P)
TCP/UDP port number (only for port-shifting maps).

Note
mode

The size of inside_port must be identical to the size of
outside_port.

The mode to create the portmap.
Choose between:

>
>
>

REQUIRED
for portshifting map

OPTIONAL

auto
inbound
outbound.

The standard is auto.

578

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

EXAMPLE:
=>nat tmpladd intf=myPPP_ppp type=napt outside_addr=100.100.100.1
=>nat tmpllist
Idx Type Interface
Ifgroup Outside Address
Inside Address
Use
1 NAPT myPPP_ppp
any
100.100.100.1
unmapped
0
=>nat tmpladd group=lan type=napt outside_addr=100.200.100.1
=>nat tmpllist
Idx Type Interface
Ifgroup Outside Address
Inside Address
Use
1 NAPT any
lan
100.200.100.1
unmapped
0
2 NAPT myPPP_ppp
any
100.100.100.1
unmapped
0
=>

RELATED COMMANDS:
nat tmpldelete

Delete an address mapping template.

nat tmpllist

Display the address mapping templates.

nat tmplinst

Instantiate address mapping templates for a given dynamic address.

E-DOC-CTC-20061027-0003 v2.0

579

NAT Commands

nat tmpldelete
Delete an address mapping template.

SYNTAX:
nat tmpldelete

index = 

where:
index

The index of the address mapping template to be deleted.
Tip

REQUIRED

Use the command :nat tmpllist to view the
address mapping templates.

EXAMPLE:
=>nat tmpllist
Idx Type Interface
Use
1 NAPT any
0
2 NAPT myPPP_ppp
0
=>nat tmpldelete index=1
=>nat tmpllist
Idx Type Interface
Use
1 NAPT myPPP_ppp
0
=>

Ifgroup

Outside Address

Inside Address

lan

100.200.100.1

unmapped

any

100.100.100.1

unmapped

Ifgroup

Outside Address

Inside Address

any

100.100.100.1

unmapped

RELATED COMMANDS:

580

nat tmpladd

Add an address mapping template.

nat tmpllist

Display the address mapping templates.

nat tmplinst

Instantiate address mapping templates for a given dynamic address.

E-DOC-CTC-20061027-0003 v2.0

NAT Commands

nat tmpllist
Display the address mapping templates.

SYNTAX:
nat tmpllist

[expand = <{disabled | enabled}>]

where:
expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

EXAMPLE:
=>nat tmpllist
Idx Type Interface
Use
1 NAPT any
0
2 NAPT myPPP_ppp
0
=>

Ifgroup

Outside Address

Inside Address

lan

100.200.100.1

unmapped

any

100.100.100.1

unmapped

RELATED COMMANDS:
nat tmpladd

Add an address mapping template.

nat tmpldelete

Delete an address mapping template.

nat tmplinst

Instantiate address mapping templates for a given dynamic address.

E-DOC-CTC-20061027-0003 v2.0

581

NAT Commands

nat tmplinst
Instantiate address mapping templates for a given dynamic address.

SYNTAX:
nat tmplinst

intf = 
addr_index = 
dynamic_addr = 

where:
intf

The IP interface name.

REQUIRED

addr_index

The outside IP address index/key to instantiate for.

REQUIRED

dynamic_addr

The dynamic address to substitute the index/key with.

REQUIRED

EXAMPLE:
=>nat tmplinst intf=myPPP_ppp addr_index=100.100.100.1 dynamic_addr=200.200.200.1
=>nat tmpllist
Idx Type Interface
Ifgroup Outside Address
Inside Address
Use
1 NAPT myPPP_ppp
any
100.100.100.1
unmapped
1
=>

RELATED COMMANDS:

582

nat tmpladd

Add an address mapping template.

nat tmpldelete

Delete an address mapping template.

nat tmpllist

Display the address mapping templates.

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

30 PPP Commands
Introduction
This chapter describes the commands of the ppp command group.

Contents
This chapter covers the following commands:
ppp flush

Flush all PPP interfaces.

584

ppp ifadd

Create a new PPP interface.

585

ppp ifattach

Attach a PPP interface.

587

ppp ifconfig

Configure a PPP interface.

589

ppp ifdelete

Delete a PPP interface.

594

ppp ifdetach

Detach a PPP interface.

596

ppp iflist

Display the PPP interfaces.

598

ppp ifscan

Scan a PPPoE interface for available Access Concentrator and
Service names.

599

ppp rtadd

Add a route to the routing table when the PPP link comes up.

600

ppp rtdelete

Delete the route for a PPP link.

602

ppp relay flush

Remove all Ethernet interfaces from the PPP relay agent list and
terminate all sessions.

604

ppp relay ifadd

Add an Ethernet interface to the PPP relay list.

605

ppp relay ifconfig

Modify an ethernet interface from the PPP relay agent list.

606

ppp relay ifdelete

Delete an Ethernet interface from the PPP relay agent list.

607

ppp relay iflist

Display all Ethernet interfaces added to the PPP relay agent list.

608

ppp relay sesslist

Add an Ethernet interface to the PPP relay list.

609

E-DOC-CTC-20061027-0003 v2.0

583

PPP Commands

ppp flush
Flush all PPP interfaces.

i

The flush command does not impact previously saved configurations.

SYNTAX:
ppp flush

584

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp ifadd
Create a new PPP interface.

SYNTAX:
ppp ifadd

intf = 

where:
intf

The name for the new PPP interface.
Note

REQUIRED

If not specified, the destination parameter must be specified.
In this case the name of the destination will double as
interface name.

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --=>ppp ifadd intf=Rt_PPPoA
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest :
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>

E-DOC-CTC-20061027-0003 v2.0

585

PPP Commands

RELATED COMMANDS:

586

ppp ifdelete

Delete a PPP interface.

ppp iflist

Display the PPP interfaces.

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp ifattach
Attach a PPP interface.

SYNTAX:
ppp ifattach

intf = 

where:
intf

E-DOC-CTC-20061027-0003 v2.0

The name of the PPP interface to be attached.

REQUIRED

587

PPP Commands

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>ppp ifattach intf=Rt_PPPoA
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = up
oper state = down
link state = connected
LCP : state = reqsent retransm = 1 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>

RELATED COMMANDS:
ppp ifdetach

588

Detach a PPP interface.

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp ifconfig
Configure a PPP interface.

i

The interface to be configured must not be connected at the time of configuration. If this should be
the case, use the command :ppp ifdetach before using the command :ppp ifconfig.

SYNTAX:
ppp ifconfig

intf = 
[dest = ]
[user = ]
[password = 
[acname = 
[servicename = 
[pcomp = <{disabled | enabled}>
[accomp = <{enabled | disabled | negotiate}>]
[trace = <{disabled | enabled}>]
[concentrator = <{disabled | enabled}>]
[auth = <{pap | chap | auto}>]
[restart = <{disabled | enabled}>]
[retryinterval = ]
[passive = <{disabled | enabled}>]
[silent = <{disabled | enabled}>]
[echo = <{disabled | enabled}>]
[mru = ]
[laddr = ]
[raddr = ]
[netmask = ]
[format = <{cidr | dotted | none}>]
[pool = ]
[savepwd = <{disabled | enabled}>]
[demanddial = <{disabled | enabled}>]
[doddelay = ]
[primdns = ]
[secdns = ]
[dnsmetric = ]
[idletime = ]
[idletrigger = <{RxTx | Rx | Tx}>]
[unnumbered = <{disabled | enabled}>]

where:
intf

The name of the PPP interface to be configured.

REQUIRED

dest

The destination for this PPP interface.
Typically, a phonebook entry.
If an Ethernet interface is given as destination, then the connection
will be a PPPoE connection.
If an ATM interface is given as destination, then the connection will
be a PPPoA connection.

OPTIONAL

user

The user name for remote PAP/CHAP authentication.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

589

PPP Commands

password

The password for remote PAP/CHAP authentication.

OPTIONAL

acname

The Access Concentrator name for a PPPoE session.

OPTIONAL

Use the command :ppp ifscan to obtain the names of
available access concentrators, if any.

Tip
servicename

The Service Name for a PPPoE session.

OPTIONAL

Use the command :ppp ifscan to obtain the available
service names, if any.

Tip
pcomp

Try (enabled) or do not try (disabled) to negotiate PPP protocol
compression (LCP PCOMP).
The default is disabled.

OPTIONAL

accomp

Try (enabled), do never try (disabled) or negotiate (negotiate) to
negotiate PPP address & control field compression (LCP ACCOMP).
In most cases, LCP ACCOMP should not be disabled nor negotiated,
in other words, the address field FF-03 should not be sent over ATM.
The default is enabled.

OPTIONAL

Note

If the accomp parameter is set to “negotiate”, the local side
of the PPP connection demands to do ACCOMP and adapts
itself to the result of this negotiation.

trace

Enable or disable verbose console logging.
The default is disabled.

OPTIONAL

concentrator

The access concentrator is on this side of the PPPoE connection.
Choose between:

OPTIONAL

>

enabled: the PPP connection is terminated on the Access
Concentrator (here the Thomson ST itself)

>

disabled: the Thomson ST is PPP client.

The default is disabled.
auth

Select the authentication protocol.
Choose between:

OPTIONAL

>

pap: Password Authentication Protocol (PAP) authentication will
be forced.

>

chap: Challenge Handshake Authentication Protocol (CHAP)
authentication will be forced.

>

auto: CHAP authentication will be used. If CHAP authentication is
not successful, PAP authentication will be used instead.

The default is auto.

590

restart

Automatically restart the connection when Link Control
Protocol (LCP) link goes down (enabled) or not (disabled).
The default is disabled.

OPTIONAL

retryinterval

A number between 0 and 65535 (seconds).
Represents the intermediate interval between two retries to establish
the connection on ATM level.
The default is 10.

OPTIONAL

passive

Put the link in listening state in case LCP times out (enabled) or not
(disabled).
This parameter allows to determine whether the link should be left
open to wait for incoming messages from the remote side after 10
unsuccessful tries to establish the connection or not.
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

silent

Do not send anything at startup and just listen for incoming LCP
messages (enabled) or retry up to 10 times to establish the
connection (disabled).
The default is disabled.

OPTIONAL

echo

Send LCP echo requests at regular intervals (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

mru

A number between 293 and 8192.
Represents the maximum packet size the Thomson ST should
negotiate to be able to receive.
The default is 1492.

OPTIONAL

laddr

The local IP address of the peer-to-peer connection.
Specifying a local IP address forces the remote side of the PPP link (if
it allows to) to accept this IP address as the Thomson ST PPP session
IP address.
If not specified, the Thomson ST will accept any IP address.
Typically the local IP address parameter is not specified.

OPTIONAL

raddr

The remote IP address of the peer-to-peer connection.
Specifying a remote IP address forces the remote side of the PPP link
(if it allows to) to accept this IP address as its PPP session IP address.
If not specified, the Thomson ST will accept any IP address.
Typically the remote IP address parameter is not specified.

OPTIONAL

netmask

The subnetmask associated with this address.
Specifying a subnetmask forces the remote side (if it allows to) to
accept this subnetmask as the PPP session subnetmask.
If not specified, the Thomson ST will accept any subnetmask.
The Thomson ST will only request/accept a subnetmask if a DHCP
server pool is associated, in other words, if the [pool] parameter is
specified.

OPTIONAL

format

The negotiated subnetmask specified in the netmask parameter is
specified in the dotted format (dotted) or in Classless Inter Domain
Routing (CIDR) format (cidr).
The default is cidr.

OPTIONAL

pool

The name of the free DHCP server pool to which the acquired IP
subnet must be assigned.

OPTIONAL

savepwd

Save password (enabled), if supplied, or do not save the password
(disabled).
The default is disabled.

OPTIONAL

demanddial

Enable or disable the dial-on-demand feature.
The default is disabled.

OPTIONAL

doddelay

A number between 0 and 3600 (seconds).
During this initial interval, packets do not trigger the PPP interface.

OPTIONAL

primdns

The IP address of the primary DNS server.
In case a primary DNS server is specified, the Thomson ST will
negotiate this IP address with the remote side.

OPTIONAL

Note
secdns

The IP address of the (optional) secondary DNS server.
In case a secondary DNS server is specified, the Thomson ST will
negotiate this IP address with the remote side.
Note

E-DOC-CTC-20061027-0003 v2.0

If not specified, the Thomson ST will accept any IP address.
OPTIONAL

If not specified, the Thomson ST will accept any IP address.

591

PPP Commands

dnsmetric

A number between 1 and 100.
Represents the DNS route metric to be used for the negotiated DNS
servers.
The default is 1.

OPTIONAL

idletime

A number between 0 and 1000000 (seconds).
Represents the maximum time the link may be idle.
The default is 0.

OPTIONAL

idletrigger

Consider the link being idle if no traffic is sent and/or received during
the idle time. Choose between:

OPTIONAL

>

RxTx: The idle time period restarts when a packet is transmitted
or received.

>

Rx: The idle time period restarts when a packet is received.
Transmitted packets are ignored.

>

Tx: The idle time period restarts when a packet is transmitted.
Received packets are ignored.

The default is RxTx.
unnumbered

592

Takes the local IP address from the laddr field and remote IP address
from the IP address pool assigned to the incoming PPP link.
In case the unnumbered parameter is disabled, the same IP address
is used for each connection on the server side, thus reducing the
number of used IP addresses.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest :
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=> ppp ifconfig intf=Rt_PPPoA dest=RtPPPoA_atm user=johndoe@ISP password=johndoe
[ppp]=>iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>

E-DOC-CTC-20061027-0003 v2.0

593

PPP Commands

ppp ifdelete
Delete a PPP interface.

SYNTAX:
ppp ifdelete

intf = 

where:
intf

The name of the PPP interface to be deleted.

REQUIRED

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm [local disconnect]
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 9 term. reason = User kill
IPCP: state = initial retransm = 0 term. reason =
=>ppp ifdelete intf=Rt_PPPoA
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --=>

594

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

RELATED COMMANDS:
ppp ifadd

Create a new PPP interface.

ppp iflist

Display the PPP interfaces.

E-DOC-CTC-20061027-0003 v2.0

595

PPP Commands

ppp ifdetach
Detach a PPP interface.

SYNTAX:
ppp ifdetach

intf = 

where:
intf

596

The name of the PPP interface to be detached.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = up
oper state = down
link state = connected
LCP : state = reqsent retransm = 5 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>ppp ppp ifdetach intf=Rt_PPPoA
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm [local disconnect]
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 9 term. reason = User kill
IPCP: state = initial retransm = 0 term. reason =
=>

RELATED COMMANDS:
ppp ifattach

E-DOC-CTC-20061027-0003 v2.0

Attach a PPP interface.

597

PPP Commands

ppp iflist
Display the PPP interfaces.

SYNTAX:
ppp iflist

[intf = ]
[string = ]
[beginstring = ]

where:
intf

The name of the PPP interface.
Note

OPTIONAL

If not specified, all PPP interfaces are shown.

string

string matching condition

OPTIONAL

beginstring

beginstring matching condition

OPTIONAL

EXAMPLE INPUT/OUTPUT :
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = up
oper state = down
link state = connected
LCP : state = reqsent retransm = 1 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>

RELATED COMMANDS:

598

ppp ifadd

Create a new PPP interface.

ppp ifdelete

Delete a PPP interface.

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp ifscan
Scan a PPPoE interface for available Access Concentrator and Service names.

i

Use the command :ppp ifdetach for this interface before performing a scan on it.

SYNTAX:
ppp ifscan

intf = 
[time = ]

where:
intf

The name of the PPPoE interface to be scanned.

REQUIRED

time

A number between 0 and 36000 (seconds).
Represents the time to scan for services.

OPTIONAL

EXAMPLE:
=>ppp iflist
myRtPPPoE: dest : RtPPPoE_eth
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1492
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 9 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --=>ppp ifscan intf=myRtPPPoE time=45
Service Name
Access Concentrator
Done !
=>

E-DOC-CTC-20061027-0003 v2.0

599

PPP Commands

ppp rtadd
Add a route to the routing table when the PPP link comes up.
This route configuration will determine which local hosts are allowed to use this link and/or which remote
destinations should be or should not be reachable.

i

The interface must not be connected when a route configuration is added. If this should be the case,
use the command :ppp ifdetach for this interface prior to configuring routes.

SYNTAX:
ppp rtadd

intf = 
dst = 
[dstmsk = ]
[label = ]
[src = ]
[srcmsk = ]
[metric = ]

where:

600

intf

The name of the PPP interface.

REQUIRED

dst

The IP destination address specification for the route to be added
when the link comes up.

REQUIRED

dstmsk

The destination IP mask.
Depending on the destination netmask:

OPTIONAL

>

Any remote destination is reachable, in other words, the PPP
connection acts as default route (dstmsk=0)

>
>

Only the remote (sub)net is reachable (dstmsk=1)

>
>

Only the single remote host is reachable (dstmsk=32)

The actual destination mask will be the default netmask
applicable for destination IP address
Any valid (contiguous) netmask in case of Variable Length
Subnet Masking (VLSM).

label

The name of the label.

OPTIONAL

src

The IP source address specification for the route (in other words,
who can use this link).

OPTIONAL

srcmsk

The source IP mask.
Depending on the source netmask:

OPTIONAL

>
>

Everybody is allowed to use this PPP connection (dstmsk=0)

>

The actual destination mask will be the netmask applicable for
the IP address of the host which opened the PPP connection

>

Only the host which opened the PPP connection is allowed to
use the PPP connection (dstmsk=32)

>

Any valid (contiguous) netmask in case of VLSM.

Only members of the same subnet as the host which opened the
PPP connection are allowed to use the PPP connection
(dstmsk=1)

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

metric

The route metric, in other words, the cost factor of the route.
Practically, the cost is determined by the hop count.

OPTIONAL

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>ppp rtadd intf=Rt_PPPoA dst=0.0.0.0/0 src=10.0.0.0/1
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
=>

RELATED COMMANDS:
ppp rtdelete

E-DOC-CTC-20061027-0003 v2.0

Delete the route for a PPP link.

601

PPP Commands

ppp rtdelete
Delete the route for a PPP link.

i

The interface must not be connected when a route configuration must be deleted. If the interface is
connected, use the command :ppp ifdetach for this interface.

SYNTAX:
ppp rtdelete

intf = 

where:
intf

602

The PPP interface name for which to delete the route settings.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

EXAMPLE:
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm [local disconnect]
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr route savepwd
dns metric = 0 mru = 1500
route : dst=0.0.0.0/0 - src=10.0.0.0/1 (metric 1)
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 9 term. reason = User kill
IPCP: state = initial retransm = 0 term. reason =
=>ppp ppp rtdelete intf=Rt_PPPoA
=>ppp iflist
Internet: dest : RELAY
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd demanddial
dns metric = 0 mru = 1492 Tx inactivity = 1200s left = 0s
auth = auto user =
password =
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 10 term. reason =
IPCP: state = initial retransm = 0 term. reason =
acname : --- service : --Rt_PPPoA: dest : RtPPPoA_atm [local disconnect]
[00:00:00]
Retry : 10
mode = IP routing
flags = echo magic accomp restart mru addr savepwd
dns metric = 0 mru = 1500
auth = auto user = johndoe@ISP password = ********
admin state = down
oper state = down
link state = not-connected
LCP : state = initial retransm = 9 term. reason = User kill
IPCP: state = initial retransm = 0 term. reason =
=>

RELATED COMMANDS:
ppp rtadd

E-DOC-CTC-20061027-0003 v2.0

Add a route to the routing table when the PPP link comes up.

603

PPP Commands

ppp relay flush
Remove all Ethernet interfaces from the PPP relay agent list and terminate all sessions.

i

The flush command does not impact previously saved configurations.

SYNTAX:
ppp relay flush

604

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp relay ifadd
Add an Ethernet interface to the PPP relay list.

SYNTAX:
ppp relay ifadd

intf = 

where:
intf

The Ethernet interface to be added to the PPP relay agent list.

REQUIRED

EXAMPLE:
=>ppp relay iflist
# Interface
HWaddr
1 ethoa_0_35
00-0e-50-0f-fc-2d
=>ppp relay ifadd intf=ethoa_8_35
=>ppp relay iflist
# Interface
HWaddr
1 ethoa_0_35
00-0e-50-0f-fc-2d
2 ethoa_8_35
00-0e-50-0f-fc-2d
=>

Status
connected

Status
connected
connected

RELATED COMMANDS:
ppp relay ifdelete

Delete an Ethernet interface from the PPP relay agent list.

ppp relay iflist

Display all Ethernet interfaces added to the PPP relay agent list.

E-DOC-CTC-20061027-0003 v2.0

605

PPP Commands

ppp relay ifconfig
Modify an ethernet interface from the PPP relay agent list.

SYNTAX:
ppp relay ifconfig

intf = 
hwaddr = 

where:

606

inft

The ethernet intf to be added to the PPP relay agent list.

REQUIRED

hwaddr

The hardware address (e.g. Ethernet MAC address) of this interface.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp relay ifdelete
Delete an Ethernet interface from the PPP relay agent list.

SYNTAX:
ppp relay ifdelete

intf = 

where:
intf

The Ethernet interface to be deleted from the PPP relay agent list.

REQUIRED

EXAMPLE:
=>ppp relay iflist
# Interface
HWaddr
1 ethoa_0_35
00-0e-50-0f-fc-2d
2 ethoa_8_35
00-0e-50-0f-fc-2d
=>ppp relay ifdelete intf=ethoa_8_35
=>ppp relay iflist
# Interface
HWaddr
1 ethoa_0_35
00-0e-50-0f-fc-2d
=>

Status
connected
connected

Status
connected

RELATED COMMANDS:
ppp relay ifadd

Add an Ethernet interface to the PPP relay list.

ppp relay iflist

Display all Ethernet interfaces added to the PPP relay agent list.

E-DOC-CTC-20061027-0003 v2.0

607

PPP Commands

ppp relay iflist
Display all Ethernet interfaces added to the PPP relay agent list.

SYNTAX:
ppp relay iflist
where:
intf

The Ethernet interface to be added to the PPP relay agent list.

REQUIRED

EXAMPLE:
=>ppp relay iflist
# Interface
1 ethoa_0_35
2 ethoa_8_35
=>

HWaddr
Status
00-0e-50-0f-fc-2d connected
00-0e-50-0f-fc-2d connected

RELATED COMMANDS:

608

ppp relay ifadd

Add an Ethernet interface to the PPP relay list.

ppp relay ifdelete

Delete an Ethernet interface from the PPP relay agent list.

E-DOC-CTC-20061027-0003 v2.0

PPP Commands

ppp relay sesslist
Add an Ethernet interface to the PPP relay list.

SYNTAX:
ppp relay ifadd

intf = 

where:
intf

E-DOC-CTC-20061027-0003 v2.0

The Ethernet interface to be added to the PPP relay agent list.

REQUIRED

609

PPP Commands

610

E-DOC-CTC-20061027-0003 v2.0

PPTP Commands

31 PPTP Commands
Introduction
This chapter describes the commands of the pptp command group.

Contents
This chapter covers the following commands:
pptp ifadd

Add a Point-to-Point Tunneling Protocol (PPTP) profile.

612

pptp flush

Flush the complete PPTP configuration.

613

pptp list

Show the current PPTP configuration.

614

pptp profadd

Define a new PPTP profile.

615

pptp profdelete

Delete a PPTP profile.

617

pptp proflist

Display all the current PPTP profiles.

618

E-DOC-CTC-20061027-0003 v2.0

611

PPTP Commands

pptp ifadd
Add a Point-to-Point Tunneling Protocol (PPTP) profile.

i

Backwards compatible with previous release, use profiles instead.

SYNTAX:
pptp ifadd

dest = 
[rate = ]
[encaps = <{vcmux | nlpid}>]
[ac = <{never | always | keep}>]

where:
dest

The WAN destination for this PPTP tunnel.
Typically a phonebook entry.

REQUIRED

rate

A number between 10 and 10000.
Represents the transmission speed (in bits/s) for the WAN link.

OPTIONAL

encaps

The type of WAN encapsulation to be used with this PPTP profile.
Choose between:

OPTIONAL

>
>

VC_MUX
Network Layer Protocol IDentifiers (NLPID).

The default is vcmux.
ac

The High-level Data Link Control (HDLC) framing option applicable
to PPTP interfaces using this PPTP profile.
Choose between:

>

always: Before relaying the encapsulated PPP frames over the
PPPoA link, make sure that the address and control field
(0xFF03) is always in front of the frames.

>

never: Before relaying the encapsulated PPP frames over the
PPPoA link, make sure the address and control field will never
be found in front of the frames.

>

keep: Do not change the frames arriving via the PPTP tunnel.

OPTIONAL

The default is never.
Note

612

The default setting is compliant to RFC2364, therefore it is
recommended to keep this setting.

E-DOC-CTC-20061027-0003 v2.0

PPTP Commands

pptp flush
Flush the complete PPTP configuration.

i

The flush command does not impact previously saved configurations.

SYNTAX:
pptp flush

E-DOC-CTC-20061027-0003 v2.0

613

PPTP Commands

pptp list
Show the current PPTP configuration.

SYNTAX:
pptp list

EXAMPLE:
=>pptp list
Dialstr
Destination
DIALUP_PPP3
=>

614

QoS
default

Encaps
vcmux

AC
never

State
CONNECTED

User
(10.0.0.2)

E-DOC-CTC-20061027-0003 v2.0

PPTP Commands

pptp profadd
Define a new PPTP profile.

SYNTAX:
pptp profadd

name = 
[qos = ]
[encaps = <{vcmux | nlpid}>]
[ac = <{never | always | keep}>]

where:
name

The name of the new PPTP profile.

REQUIRED

qos

The name of the qosbook entry, containing the settings for this
profile.

OPTIONAL

Note
encaps

This parameter never needs to be specified.

The type of WAN protocol encapsulation to be used with this PPTP
profile.
Choose between:

>
>

OPTIONAL

VC-MUX
NLPID.

The default is vcmux.
ac

The HDLC framing option applicable to PPTP interfaces using this
PPTP profile.
Choose between:

>

always: Before relaying the encapsulated PPP frames over the
PPPoA link, make sure that the address and control field
(0xFF03) is always in front of the frames.

>

never: Before relaying the encapsulated PPP frames over the
PPPoA link, make sure the address and control field will never
be found in front of the frames.

>

keep: Do not change the frames arriving via the PPTP tunnel.

OPTIONAL

The default is never.
Note

The default setting is compliant to RFC2364, therefore it is
recommended to keep this setting.

EXAMPLE:
=>pptp proflist
Profile
QoS
Encaps
AC
Relay_PPP1
default nlpid
always
=>pptp profadd name=PPTPLink encaps=vcmux ac=never
=>pptp proflist
Profile
QoS
Encaps
AC
Relay_PPP1
default nlpid
always
PPTPLink
default vcmux
never
=>

E-DOC-CTC-20061027-0003 v2.0

615

PPTP Commands

RELATED COMMANDS:

616

pptp profdelete

Define a new PPTP profile.

pptp proflist

Display all the current PPTP profiles.

E-DOC-CTC-20061027-0003 v2.0

PPTP Commands

pptp profdelete
Delete a PPTP profile.

SYNTAX:
pptp profdelete

name 

where:
name

The name of the PPTP profile to be deleted.

REQUIRED

EXAMPLE:
=>pptp proflist
Profile
QoS
Encaps
Relay_PPP1
default nlpid
PPTPLink
default vcmux
=>pptp profdelete name=PPTPLink
=>pptp proflist
Profile
QoS
Encaps
Relay_PPP1
default nlpid
=>

AC
always
never

AC
always

RELATED COMMANDS:
pptp profadd

Define a new PPTP profile.

pptp proflist

Display all the current PPTP profiles.

E-DOC-CTC-20061027-0003 v2.0

617

PPTP Commands

pptp proflist
Display all the current PPTP profiles.

SYNTAX:
pptp proflist

EXAMPLE:
=>pptp proflist
Profile
QoS
Relay_PPP1
default
PPTPLink
default
=>

Encaps
nlpid
vcmux

AC
always
never

RELATED COMMANDS:

618

pptp profadd

Define a new PPTP profile.

pptp profdelete

Delete a PPTP profile.

E-DOC-CTC-20061027-0003 v2.0

Script Commands

32 Script Commands
Introduction
This chapter describes the commands of the script command group.
Scripting is not a general purpose mechanism but is only used in the autoPVC/ILMI mechanism.

!

It is recommended not to change the default scripts.

Contents
This chapter covers the following commands:
script add

Add a line to a script.

620

script delete

Delete a complete script or a line from a script.

621

script flush

Flush all scripts.

622

script list

Display a script or all scripts.

623

script run

Run a script.

625

E-DOC-CTC-20061027-0003 v2.0

619

Script Commands

script add
Add a line to a script.

SYNTAX:
script add

name = 
[index = ]
command = 

where:
name

Name of the script in which a line must be added.

REQUIRED

index

Line number

OPTIONAL

Note
command

Use 0 to add a line.

Command.

REQUIRED

RELATED COMMANDS:

620

script delete

Delete a complete script or a line from a script.

script list

Display a script or all scripts.

E-DOC-CTC-20061027-0003 v2.0

Script Commands

script delete
Delete a complete script or a line from a script.

SYNTAX:
script delete

name = 
[index = ]

where:
name

Name of the script to be deleted.

REQUIRED

index

Line number to be deleted.

OPTIONAL

Tip
Note

Use the command :script list to view the line
numbers.
If not specified, the complete script will be deleted.

RELATED COMMANDS:
script add

Add a line to a script.

script list

Display a script or all scripts.

E-DOC-CTC-20061027-0003 v2.0

621

Script Commands

script flush
Flush all scripts.

i

The flush command does not impact previously saved configurations.

SYNTAX:
script flush

622

E-DOC-CTC-20061027-0003 v2.0

Script Commands

script list
Display a script or all scripts.

SYNTAX:
script list

[name = ]

where:
name

Name of the script to be listed.
Note

OPTIONAL

If not specified, all the scripts are displayed.

EXAMPLE
Some of the default scripts are shown below:
=>script list
Script: autopvc_add_qos
0: qosbook add name _auto_$1_$2 class $3 tx_peakrate $4 tx_sustrate $5 tx_maxburst $
6
rx_peakrate $4 rx_sustrate $5 rx_maxburst $6 dynamic yes
...
Script: autopvc_add_bridge
0: qosbook add name _auto_$1_$2 class $3 tx_peakrate $4 tx_sustrate $5 tx_maxburst $
6
rx_peakrate $4 rx_sustrate $5 rx_maxburst $6 dynamic yes
1: phonebook add name _auto_$1_$2 addr $1.$2 type any dynamic yes
2: bridge ifadd intf _auto_$1_$2 dest _auto_$1_$2
3: bridge ifconfig intf _auto_$1_$2 qos _auto_$1_$2
4: bridge ifattach intf _auto_$1_$2
Script:
0:
1:
2:
3:

autopvc_delete_bridge
bridge ifdetach intf _auto_$1_$2
bridge ifdelete intf _auto_$1_$2
phonebook delete name _auto_$1_$2
qosbook delete name _auto_$1_$2

Script: autopvc_add_pppoerelay
0: qosbook add name _auto_$1_$2 class $3 tx_peakrate $4 tx_sustrate $5 tx_maxburst $
6
rx_peakrate $4 rx_sustrate $5 rx_maxburst $6 dynamic yes
1: phonebook add name _auto_$1_$2 addr $1.$2 type any dynamic yes
2: ethoa ifadd intf _auto_$1_$2 dest _auto_$1_$2
3: ethoa ifconfig intf _auto_$1_$2 qos _auto_$1_$2
4: ethoa ifattach intf _auto_$1_$2
5: ip ifwait intf _auto_$1_$2 timeout 15 adminstatus up
6: pppoe relay add port _auto_$1_$2

E-DOC-CTC-20061027-0003 v2.0

623

Script Commands

RELATED COMMANDS:

624

script add

Add a line to a script.

script delete

Delete a complete script or a line from a script.

E-DOC-CTC-20061027-0003 v2.0

Script Commands

script run
Run a script.

SYNTAX:
script run

name = 
pars = 

where:
name

Name of the script to be run.
Tip

pars

E-DOC-CTC-20061027-0003 v2.0

REQUIRED

Use the command :script list to obtain the names
of the different scripts.

Parameters separated with comma.
For example a,b,c.

REQUIRED

625

Script Commands

626

E-DOC-CTC-20061027-0003 v2.0

Service Commands

33 Service Commands
Introduction
This chapter describes the commands of the service command group.

Contents
This chapter covers the following commands:
service host assign

Assign a service to a host device.

628

service host config

Modify and/or display global service configuration options.

629

service host add

Add a host service.

630

service host delete

Delete a host service.

631

service host disable

Disable a host service.

632

service host flush

Flush all host services.

633

service host list

Display a list of host services.

634

service host stats

Show the host service statistics.

635

service host
triggerlist

List all triggers.

636

service host rule add

Create/define a host service portmap.

637

service host rule
delete

Delete a host service portmap.

638

service system ifadd

Add an interface group to the access list.

639

service system
ifdelete

Delete an interface group from the access list.

640

service system ipadd

Add an IP address (range) to the access list.

641

service system
ipdelete

Delete an IP address (range) from the access list.

642

service system list

Display the system services.

643

service system
mapadd

Add a port map for a system service.

645

service system
mapdelete

Delete a port map for a system service.

646

service system
modify

Modify a system service.

647

E-DOC-CTC-20061027-0003 v2.0

627

Service Commands

service host assign
Assign a service to a host device.

SYNTAX:
service host assign

name = 
[host = ]
[log = <{disabled|enabled}>]

where:
name

The name of an existing host service.

REQUIRED

host

The IP address of the host.

OPTIONAL

log

Enable or disable logging.

OPTIONAL

EXAMPLE:
=>service host assign name="MSN Messenger" host=192.168.1.64
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
Aliens vs. Predator
unassigned
server
..
MSN Messenger
192.168.1.64
server
...
=>

RELATED COMMANDS:
service host disable

628

Disable a host service.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service host config
Modify and/or display global service configuration options.

SYNTAX:
service host config

[trace = <{disabled | enabled}>]

where:
trace

Enable or disable traces.
The default is disabled.

REQUIRED

EXAMPLE:
=>service host config
Service traces : disabled
l=>

E-DOC-CTC-20061027-0003 v2.0

629

Service Commands

service host add
Add a host service.

SYNTAX:
service host add

name = 
[mode = <{server | client | custom}>]

where:
name

The name of the new host service.

REQUIRED

mode

The service mode.
Choose between:

OPTIONAL

>
>
>

server: The service is defined for server purposes.
client: The service is defined for client purposes.
custom: The service is a user created service (in other
words, a customized service).

The default is custom.

EXAMPLE:
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
...
MSN Messenger
unassigned
server
=>service host add name=myService
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
...
MSN Messenger
unassigned
server
myService
unassigned
yes
=>

RELATED COMMANDS:

630

service host delete

Delete a host service.

service host list

Display a list of host services.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service host delete
Delete a host service.

SYNTAX:
service host delete

name = 

where:
name

The name of the host service to be deleted.

REQUIRED

EXAMPLE:
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
...
MSN Messenger
unassigned
server
myService
unassigned
yes
=>service host delete name=myService
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
...
MSN Messenger
unassigned
server
=>

RELATED COMMANDS:
service host add

Add a host service.

service host list

Display a list of host services.

E-DOC-CTC-20061027-0003 v2.0

631

Service Commands

service host disable
Disable a host service.

SYNTAX:
service host disable

[name = ]

where:
name

The name of the host service to be disabled.
Note

OPTIONAL

If not specified, all the host services will be disabled.

EXAMPLE:
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
Aliens vs. Predator
unassigned
server
..
MSN Messenger
192.168.1.64
server
...
=>service host disable name="MSN Messenger"
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Age of Empires
unassigned
server
AIM Talk
unassigned
client
Aliens vs. Predator
unassigned
server
..
MSN Messenger
unassigned
server
...
=>

RELATED COMMANDS:
service host assign

632

Assign a service to a host device.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service host flush
Flush all host services.

SYNTAX:
service host flush

E-DOC-CTC-20061027-0003 v2.0

633

Service Commands

service host list
Display a list of host services.

SYNTAX:
service host list

[name = ]
[string = ]
[beginstring = ]

where:
name

The name of the host service to be listed.
Note

REQUIRED

If not specified, all the host services will be listed.

string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

EXAMPLE:
=>service host list
Service Name
Host
User-Defined Mode
--------------------------------------------------------------------------Aliens vs. Predator
unassigned
server
Asheron's Call
unassigned
client
Battlecom
unassigned
server
Black and White
unassigned
server
Buddy Phone
unassigned
client
Bungie.net
unassigned
server
Citrix Metaframe
unassigned
client
CU-SeeMe
unassigned
client
Dark Reign 2
unassigned
server
...
Westwood Online
unassigned
client
Yahoo Messenger Chat
unassigned
server
=>
=>service host list name="MSN Messenger"
Service Name:"MSN Messenger" Host:unassigned User-Defined:no Mode:server
------------------------------------------------------------------Port 1863 for protocol tcp will be forwarded to host port 1863
Portrange 6891 - 6900 for protocol tcp will be forwarded to host portrange 6891 - 6900
Port 6901 for protocol tcp or udp will be forwarded to host port 6901
=>

RELATED COMMANDS:

634

service host add

Add a host service.

service host delete

Delete a host service.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service host stats
Show the host service statistics.

SYNTAX:
service host stats

EXAMPLE:
=>service host
Services
:
Service maps :
Trigger ports:
=>

E-DOC-CTC-20061027-0003 v2.0

stats
113 of 150 in use.
225 of 300 in use.
0 of 25 in use.

635

Service Commands

service host triggerlist
List all triggers.

SYNTAX:
service host triggerlist

EXAMPLE:
=>service triggerlist
Ip
Triggerport
-----------=>

636

Portrange
---------

Timeout
-------

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service host rule add
Create/define a host service portmap.

SYNTAX:
service host rule add

name = 
[protocol = <{any|tcp|udp} or number>]
[baseport = ]
portrange = 
[triggerport = ]
[triggerprotocol = <{any|tcp|udp} or number>]

where:
name

The name of the host service.

REQUIRED

protocol

The IP protocol type.
Choose between:

OPTIONAL

>
>
>
>
baseport

any
tcp
udp
a number.

The inbound base port.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.
Note

OPTIONAL

If not specified, baseport is equal to the first port of
portrange.

portrange

The outbound port range.

REQUIRED

triggerport

The outbound trigger port.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

triggerprotocol

Protocol of the trigger port.
Choose between:

OPTIONAL

>
>
>
>

any
tcp
udp
a number.

Note

If not specified, triggerprotocol is equal to protocol.

RELATED COMMANDS:
service host rule delete

E-DOC-CTC-20061027-0003 v2.0

Delete a host service portmap.

637

Service Commands

service host rule delete
Delete a host service portmap.

SYNTAX:
service host rule delete

name = 
[protocol = <{any|tcp|udp} or number>]
[baseport = ]
portrange = 
[triggerport = ]
[triggerprotocol = <{any|tcp|udp} or number>]

where:
name

The name of the host service.

REQUIRED

protocol

The IP protocol type.
Choose between:

OPTIONAL

>
>
>
>
baseport

any
tcp
udp
a number.

The inbound base port.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.
Note

OPTIONAL

If not specified, baseport is equal to the first port of
portrange.

portrange

The outbound port range.

REQUIRED

triggerport

The outbound trigger port.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

triggerprotocol

Protocol of the trigger port.
Choose between:

OPTIONAL

>
>
>
>

any
tcp
udp
a number.

Note

If not specified, triggerprotocol is equal to protocol.

RELATED COMMANDS:
service host rule add

638

Create/define a host service portmap.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service system ifadd
Add an interface group to the access list.

SYNTAX:
service system ifadd

name = 
group = <{wan|local|lan|tunnel|dmz|guest} or
number>

where:
name

The name of the system service for this access list.

REQUIRED

group

The interface group for this access list.

REQUIRED

EXAMPLE:
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. any
NAT Port List.............. 5060
=>service system ifadd name=SIPPBX group=lan
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... lan
Ip Access List............. any
NAT Port List.............. 5060
=>

RELATED COMMANDS:
service system ifdelete

E-DOC-CTC-20061027-0003 v2.0

Delete an interface group from the access list.

639

Service Commands

service system ifdelete
Delete an interface group from the access list.

SYNTAX:
service system ifdelete

name = 
group = <{wan|local|lan|tunnel|dmz|guest} or
number>

where:
name

The name of the system service for this access list.

REQUIRED

group

The interface group for this access list.

REQUIRED

EXAMPLE:
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... lan
Ip Access List............. any
NAT Port List.............. 5060
=>service system ifdelete name=SIPPBX group=lan
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. any
NAT Port List.............. 5060
=>

RELATED COMMANDS:
service system ifadd

640

Add an interface group to the access list.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service system ipadd
Add an IP address (range) to the access list.

SYNTAX:
service system ipadd

name = 
ip = 

where:
name

The name of the system service for this access list.

REQUIRED

ip

The IP address (range) for this access list.

REQUIRED

EXAMPLE:
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. any
NAT Port List.............. 5060
=>service system ipadd name=SIPPBX ip=192.168.1.64
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. 192.168.1.64
NAT Port List.............. 5060
=>

RELATED COMMANDS:
service system ipdelete

E-DOC-CTC-20061027-0003 v2.0

Delete an IP address (range) from the access list.

641

Service Commands

service system ipdelete
Delete an IP address (range) from the access list.

SYNTAX:
service system ipdelete

name = 
ip = 

where:
name

The name of the system service for this access list.

REQUIRED

ip

The IP address (range) for this access list.

REQUIRED

EXAMPLE:
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. 192.168.1.64
NAT Port List.............. 5060
=>service system ipdelete name=SIPPBX ip=192.168.1.64
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. any
NAT Port List.............. 5060
=>

RELATED COMMANDS:
service system ipadd

642

Add an IP address (range) to the access list.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service system list
Display the system services.

SYNTAX:
service system list

[name = ]
[expand = <{disabled | enabled}>]
[dynamics = <{disabled | enabled}>]
[members = <{disabled | enabled}>]
[string = ]
[beginstring = ]

where:
name

The name of the system service to be displayed.
Note

OPTIONAL

If not specified, all the system services will be
displayed.

expand

Enable or disable expanded listing.
The default is disabled.

OPTIONAL

dynamics

Display dynamic sevices.
The default is disabled.

OPTIONAL

members

Display service group members.
The default is disabled.

OPTIONAL

string

String matching condition

OPTIONAL

beginstring

Beginstring matching condition

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

643

Service Commands

EXAMPLE:
=>service system list
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 DNS-C
udp
53
enabled
2 SNTP
udp
123
123
enabled
3 SLA_ICMP_PING
icmp
8
enabled
4 SLA_UDP_PING
udp
7
enabled
5 SLA_ICMP_TRRT
icmp
8
enabled
6 SLA_UDP_TRRT
udp
33434
enabled
7 SYSLOG
udp
514
enabled
8 HTTP
tcp
80
enabled
9 HTTPs
tcp
443
enabled
10 HTTPI
tcp
8080
enabled
11 FTP
tcp
21
enabled
12 TELNET
tcp
23
enabled
13 RIP
udp
520
520
enabled
14 RIP-Query
udp
520
enabled
15 DNS-S
udp
53
enabled
16 Dynamic DNS
enabled
17 DHCP-S
udp
49152
disabled
18 SNMP_AGENT
udp
161
enabled
19 SNMP_TRAPS
udp
enabled
20 MDAP
udp
3235
enabled
21 SIPPBX
udp
5060
disabled
22 IKE
udp
500
enabled
23 IP_COMMANDS
enabled
24 PING_RESPONDER
icmp
8
enabled
=>
=>service system list name=SIPPBX expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 SIPPBX
udp
5060
disabled
Description................ SIP PBX, registrar and proxy
Properties................. server
Managed parameters......... state port acl map log
Source Ip Selection........ auto
Interface Access List...... any
Ip Access List............. any
NAT Port List.............. 5060
=>

RELATED COMMANDS:
service system modify

644

Modify a system service.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service system mapadd
Add a port map for a system service.

SYNTAX:
service system mapadd

name = <{string}>
intf = <{auto|loop|Internet|LocalNetwork}>
port = 

where:
name

The name of the system service for this map.

REQUIRED

intf

The interface for this map.

REQUIRED

port

The port for this map.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

REQUIRED

RELATED COMMANDS:
service system
mapdelete

E-DOC-CTC-20061027-0003 v2.0

Delete a port map for a system service.

645

Service Commands

service system mapdelete
Delete a port map for a system service.

SYNTAX:
service system mapdelete

name = 
intf = <{auto|loop|Internet|LocalNetwork}>
port = 

where:
name

The name of the system service for this map.

REQUIRED

intf

The interface for this map.

REQUIRED

port

The port for this map.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

REQUIRED

RELATED COMMANDS:
service system mapadd

646

Add a port map for a system service.

E-DOC-CTC-20061027-0003 v2.0

Service Commands

service system modify
Modify a system service.

SYNTAX:
service system modify

name = 
[state = <{disabled | enabled}>]
[port = ]
[srcintf = ]
[log = <{disabled|enabled}>]
[qoslabel = <{None|DSCP|Interactive|
Management|Video|VoIP|default}>]
[routelabel = <{None|DSCP|Interactive|
Management|Video|VoIP|default}>]
[natpmweight = ]
[forward = <{disabled|enabled}>]

where:
name

The name of the system service for this map.

REQUIRED

state

Disable or enable this system service.

OPTIONAL

port

The port for this map.
Select one of the supported TCP/UDP port names (see
“ Supported TCP/UDP Port Names” on page 747) or,
alternatively, specify the port number.

OPTIONAL

srcintf

The primary IP interface for this system service.

OPTIONAL

log

Disable or enable service logging

OPTIONAL

qoslabel

QoS label for service data

OPTIONAL

routelabel

Route label for service data

OPTIONAL

natpmweight

NAT portmap weight for this service

OPTIONAL

forward

Disable or enable service forwarding

OPTIONAL

RELATED COMMANDS:
service system list

E-DOC-CTC-20061027-0003 v2.0

Display the system services.

647

Service Commands

648

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

34 SNMP Commands
Introduction
This chapter describes the commands of the snmp command group.

Contents
This chapter covers the following commands:
snmp config

Show/set global Simple Network Management
Protocol (SNMP) parameters.

650

snmp get

Get from the supplied SNMP Object IDentifier (OID).

651

snmp getnext

GetNext from the supplied SNMP OID.

652

snmp walk

Walk from the supplied SNMP OID.

653

snmp community add

Configure an SNMP community string to allow SNMP access
over IP.

654

snmp community delete

Delete an SNMP community string to prevent SNMP access
over IP.

655

snmp community list

List all SNMP community strings in use for SNMP access over
IP.

656

snmp community modify

Modify an SNMP community string to allow SNMP access over
IP.

657

snmp ifadd

Create a new SNMP interface.

658

snmp ifdelete

Delete an SNMP interface.

659

snmp ifattach

Attach an SNMP interface.

660

snmp ifdetach

Detach an SNMP interface.

661

snmp ifconfig

Modify an SNMP interface.

662

snmp iflist

Display the SNMP interfaces.

663

E-DOC-CTC-20061027-0003 v2.0

649

SNMP Commands

snmp config
Show/set global Simple Network Management Protocol (SNMP) parameters.

SYNTAX:
snmp config

[sysContact = ]
[sysName = ]
[sysLocation = ]

where:
sysContact

The SNMP system contact.
The default is Service Provider.

OPTIONAL

sysName

The SNMP system name.

OPTIONAL

sysLocation

The SNMP system location.
The default is Customer Premises.

OPTIONAL

EXAMPLE:
=>snmp config
SNMP System Contact
: Service Provider
SNMP System Name
: SpeedTouch 620
SNMP System Location
: Customer Premises
All SNMP traps : ENABLED
Delay, in secs before first trap is sent
=>

650

: 90

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp get
Get from the supplied SNMP Object IDentifier (OID).
For example: get ObjectId=.1.3.6.1.2.1.1.1.0.

SYNTAX:
snmp get

[ObjectId = ]

where:
ObjectID

The Object Identifier. Object ID to get from ... must include the
instance which is 0 for scalar objects, for example
.1.3.6.1.2.1.1.1.0 sysDescription.
Note

OPTIONAL

If not specified, the sysDescription OID .1.3.6.1.2.1.1.1.0
is assumed. Its value is Thomson ST.

EXAMPLE:
=>snmp get
VB_octetStr
=>

.1.3.6.1.2.1.1.1.0

Thomson ST 620

RELATED COMMANDS:
snmp getnext

GetNext from the supplied SNMP OID.

snmp walk

Walk from the supplied SNMP OID.

E-DOC-CTC-20061027-0003 v2.0

651

SNMP Commands

snmp getnext
GetNext from the supplied SNMP OID.

SYNTAX:
snmp getnext

[ObjectId = ]

where:
ObjectID

The Object Identifier.
Object ID to getnext from for example .1.3.6.1.2.1.1 system
returns sysDescription.

OPTIONAL

EXAMPLE:
=>snmp getnext ObjectId=.1.3.6.1.2.1.1.4.0
VB_octetStr
.1.3.6.1.2.1.1.5.0
=>

Sascha

RELATED COMMANDS:

652

snmp get

Get from the supplied SNMP Object IDentifier (OID).

snmp walk

Walk from the supplied SNMP OID.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp walk
Walk from the supplied SNMP OID.

SYNTAX:
snmp walk

[ObjectId = ]

where:
ObjectID

The Object Identifier.
Object ID to walk from for example .1.3.6.1.2.1.1 system walks
the system group.

OPTIONAL

EXAMPLE:
=>snmp walk ObjectId=.1.3.6.1.2.1.1
VB_octetStr
.1.3.6.1.2.1.1.1.0
VB_objId
.1.3.6.1.2.1.1.2.0
VB_timeTicks .1.3.6.1.2.1.1.3.0
VB_octetStr
.1.3.6.1.2.1.1.4.0
VB_octetStr
.1.3.6.1.2.1.1.5.0
VB_octetStr
.1.3.6.1.2.1.1.6.0
VB_integer
.1.3.6.1.2.1.1.7.0
=>

Thomson ST 620
.1.3.6.1.4.1.637.61.2
2927636
Service Provider
Sascha
Customer Premises
72

RELATED COMMANDS:
snmp get

Get from the supplied SNMP Object IDentifier (OID).

snmp getnext

GetNext from the supplied SNMP OID.

E-DOC-CTC-20061027-0003 v2.0

653

SNMP Commands

snmp community add
Configure an SNMP community string to allow SNMP access over IP.

SYNTAX:
snmp community add

securityname = <{RWCommunity | ROCommunity}>
communityname = 

where:
securityname

Configure access rights/restrictions control for the community
name.
Choose between:

>
>
communityname

REQUIRED

RWCommunity: read/write access rights
ROCommunity: read only access rights.

Configure the SNMP community name.

REQUIRED

EXAMPLE:
=>snmp community add
securityname = RWCommunity
communityname = *******
Please retype communityname for verification.
communityname = *******
:snmp community add securityname=RWCommunity communityname=_DEV_2C6A78E1C41E7B01
=>snmp community add
securityname = ROCommunity
communityname = ******
Please retype communityname for verification.
communityname = ******
:snmp community add securityname=ROCommunity communityname=_DEV_184B05F89719A74E
=>

RELATED COMMANDS:

654

snmp community delete

Delete an SNMP community string to prevent SNMP access over IP.

snmp community list

List all SNMP community strings in use for SNMP access over IP.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp community delete
Delete an SNMP community string to prevent SNMP access over IP.

SYNTAX:
snmp community delete

securityname = <{RWCommunity | ROCommunity}>

where:
securityname

Select the access rights/restrictions control for the community
name to be deleted.
Choose between:

>
>

REQUIRED

RWCommunity: read/write access rights
ROCommunity: read only access rights.

EXAMPLE:
=>snmp community list
Read-write SNMP community name : *****
Read-only SNMP community name : *****
=>snmp community delete securityname=ROCommunity
=>snmp community list
Read-write SNMP community name
Read-only SNMP community name
=>

:
:

*****
not specified

RELATED COMMANDS:
snmp community add

Configure an SNMP community string to allow SNMP access over IP.

snmp community list

List all SNMP community strings in use for SNMP access over IP.

E-DOC-CTC-20061027-0003 v2.0

655

SNMP Commands

snmp community list
List all SNMP community strings in use for SNMP access over IP.

SYNTAX:
snmp community list

EXAMPLE:
=>snmp community list
Read-write SNMP community name
Read-only SNMP community name
=>

:
:

*****
*****

RELATED COMMANDS:

656

snmp community add

Configure an SNMP community string to allow SNMP access over IP.

snmp community delete

Delete an SNMP community string to prevent SNMP access over IP.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp community modify
Modify an SNMP community string to allow SNMP access over IP.

SYNTAX:
snmp community modify

securityname = <{RWCommunity | ROCommunity}>
communityname = 

where:
securityname

Configure access rights/restrictions control for the community
name.
Choose between:

>
>
communityname

E-DOC-CTC-20061027-0003 v2.0

REQUIRED

RWCommunity: read/write access rights
ROCommunity: read only access rights.

Configure the SNMP community name.

REQUIRED

657

SNMP Commands

snmp ifadd
Create a new SNMP interface.

SYNTAX:
snmp ifadd

intf = 
dest = 

where:
intf

The name for the new SNMP interface.

REQUIRED

dest

The destination interface for this SNMP interface.

REQUIRED

EXAMPLE:
=>snmp ifadd
intf = new
dest = Internet
:snmp ifadd intf=new dest=Internet
=>

RELATED COMMANDS:

658

snmp ifdelete

Delete an SNMP interface.

snmp ifattach

Attach an SNMP interface.

snmp ifdetach

Detach an SNMP interface.

snmp ifconfig

Modify an SNMP interface.

snmp iflist

Display the SNMP interfaces.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp ifdelete
Delete an SNMP interface.

SYNTAX:
snmp ifdelete

intf = 

where:
intf

The name of the SNMP interface.

REQUIRED

EXAMPLE:
=>snmp ifdelete
intf = new
:snmp ifdelete intf=new
=>

RELATED COMMANDS:
snmp ifadd

Create a new SNMP interface.

snmp ifattach

Attach an SNMP interface.

snmp ifdetach

Detach an SNMP interface.

snmp ifconfig

Modify an SNMP interface.

snmp iflist

Display the SNMP interfaces.

E-DOC-CTC-20061027-0003 v2.0

659

SNMP Commands

snmp ifattach
Attach an SNMP interface.

SYNTAX:
snmp ifattach

intf = 

where:
intf

The name of the SNMP interface.

REQUIRED

EXAMPLE:
=>snmp ifattach
intf = Internet
:snmp ifattach intf=Internet
=>

RELATED COMMANDS:

660

snmp ifadd

Create a new SNMP interface.

snmp ifdelete

Delete an SNMP interface.

snmp ifdetach

Detach an SNMP interface.

snmp ifconfig

Modify an SNMP interface.

snmp iflist

Display the SNMP interfaces.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp ifdetach
Detach an SNMP interface.

SYNTAX:
snmp ifdetach

intf = 

where:
intf

The name of the SNMP interface.

REQUIRED

EXAMPLE:
=>snmp ifdetach
intf = Internet
:snmp ifdetach intf=Internet
=>

RELATED COMMANDS:
snmp ifadd

Create a new SNMP interface.

snmp ifdelete

Delete an SNMP interface.

snmp ifattach

Attach an SNMP interface.

snmp ifconfig

Modify an SNMP interface.

snmp iflist

Display the SNMP interfaces.

E-DOC-CTC-20061027-0003 v2.0

661

SNMP Commands

snmp ifconfig
Modify an SNMP interface.

SYNTAX:
snmp ifconfig

intf = 
[securityname = <{RWCommunity | ROCommunity}>]
[communityname = ]

where:
intf

The name of the SNMP interface to configure.

REQUIRED

securityname

Configure access rights/restrictions control for the community
name.
Choose between:

OPTIONAL

>
>

RWCommunity
ROCommunity.

The default is RWCommunity.
communityname

Configure SNMP community name.

OPTIONAL

EXAMPLE:
=>snmp ifconfig
intf = Internet
[securityname] =
[communityname] =
:snmp ifconfig intf=Internet
=>

RELATED COMMANDS:

662

snmp ifadd

Create a new SNMP interface.

snmp ifdelete

Delete an SNMP interface.

snmp ifattach

Attach an SNMP interface.

snmp ifdetach

Detach an SNMP interface.

snmp iflist

Display the SNMP interfaces.

E-DOC-CTC-20061027-0003 v2.0

SNMP Commands

snmp iflist
Display the SNMP interfaces.

SYNTAX:
snmp iflist

[intf = ]

where:
intf

E-DOC-CTC-20061027-0003 v2.0

The name of an SNMP interface to configure.

OPTIONAL

663

SNMP Commands

664

E-DOC-CTC-20061027-0003 v2.0

SNTP Commands

35 SNTP Commands
Introduction
This chapter describes the commands of the Simple Network Time Protocol (SNTP) command group.

Contents
This chapter covers the following commands:
sntp add

Add a Network Time Protocol (NTP) server to the NTP server list.

666

sntp config

Modify/display the SNTP client configuration.

667

sntp delete

Delete an NTP server from the NTP server list.

668

sntp flush

Flush the NTP server list and the SNTP client configuration.

669

sntp list

List the NTP servers.

670

E-DOC-CTC-20061027-0003 v2.0

665

SNTP Commands

sntp add
Add a Network Time Protocol (NTP) server to the NTP server list.
The internal Thomson ST real time clock (SNTP client) will be synchronized with the NTP server.

SYNTAX:
sntp add

[addr = ]
[name = ]
[version = ]

where:
addr

The IP address of the NTP server to add to the list.
Note

name

This parameter is optional in this respect that either an IP
address or the name of an NTP server must be specified.

The DNS name of NTP server to be added to list. If both the IP address
and the DNS name are provided, the IP address is ignored.
Note

version

OPTIONAL

OPTIONAL

This parameter is optional in this respect that either an IP
address or the name of an NTP server must be specified

The SNTP version of the NTP server.
Select either 1, 2, 3, or 4 following NTP server supported versions.
The default is 4.

OPTIONAL

EXAMPLE:
=>sntp list
IP Address
Version
Status
100.101.110.113
4
Synchronized
=>sntp add addr=100.101.110.111
=>sntp list
IP Address
Version
Status
100.101.110.111
4
contacting ...
100.101.110.113
4
Synchronized
=>

RELATED COMMANDS:

666

sntp delete

Delete an NTP server from the NTP server list.

sntp list

List the NTP servers.

E-DOC-CTC-20061027-0003 v2.0

SNTP Commands

sntp config
Modify/display the SNTP client configuration.

SYNTAX:
sntp config

[state = <{enabled | disabled}>]
[poll = ]
[pollpresync = ]

where:
state

Enable or disable the Thomson ST SNTP client.
The default is enabled.

OPTIONAL

poll

A number between 1 and 60 (minutes).
Represents the time interval for the SNTP client to poll the configured
NTP server and, if needed, (re-)synchronize its internal clock.
The default is 60.

OPTIONAL

pollpresync

polling interval before first sync (1 min, ... ,60min)

OPTIONAL

EXAMPLE:
=>sntp config
SNTP configuration:
state = enabled
poll interval = 60 minute(s)
poll interval (before first sync) = 60 minute(s)
=>

E-DOC-CTC-20061027-0003 v2.0

667

SNTP Commands

sntp delete
Delete an NTP server from the NTP server list.

SYNTAX:
sntp delete

[addr = ]
[name = ]

where:
addr

The IP address of the NTP server to be removed from the list.
Note

name

OPTIONAL

This parameter is optional in this respect that either an IP
address or the name of an NTP server must be specified.

The DNS name of the NTP server to be removed to the list.
Note

OPTIONAL

This parameter is optional in this respect that either an IP
address or the name of an NTP server must be specified.

EXAMPLE:
=>sntp list
IP Address
Version
Status
100.101.110.111
4
contacting ...
100.101.110.113
4
Synchronized
=>sntp del addr=100.101.110.111
=>sntp list
IP Address
Version
Status
100.101.110.113
4
Synchronized
=>

RELATED COMMANDS:

668

sntp add

Add a Network Time Protocol (NTP) server to the NTP server list.

sntp list

List the NTP servers.

E-DOC-CTC-20061027-0003 v2.0

SNTP Commands

sntp flush
Flush the NTP server list and the SNTP client configuration.

SYNTAX:
sntp flush

E-DOC-CTC-20061027-0003 v2.0

669

SNTP Commands

sntp list
List the NTP servers.

SYNTAX:
sntp list

EXAMPLE:
=>sntp list
IP Address
100.101.110.111
100.101.110.112
100.101.110.113
=>

Version
4
4
4

Status
Name
contacting ...
Unable to contact
Synchronized

DESCRIPTION:
The status of an NTP server can be:

>
>
>

Not used: The Thomson ST SNTP client is disabled. As a consequence, none of the NTP servers are used.

>

Synchronized: The Thomson ST SNTP client was able to contact this NTP server. If required the internal
clock has been synchronized with this NTP server.

Contacting...: The Thomson ST SNTP client is trying to contact this NTP server.
Unable to contact: The Thomson ST SNTP client is unable to contact this NTP server. It may be down, or
no end-to-end connectivity exists (no connection, no DSL,...).

RELATED COMMANDS:

670

sntp add

Add a Network Time Protocol (NTP) server to the NTP server list.

sntp delete

Delete an NTP server from the NTP server list.

E-DOC-CTC-20061027-0003 v2.0

Software Commands

36 Software Commands
Introduction
This chapter describes the commands of the software command group.

Contents
This chapter covers the following commands:
software upgrade

Reboot the modem to initiate the SW upgrade.

672

software version

Display the software version.

673

E-DOC-CTC-20061027-0003 v2.0

671

Software Commands

software upgrade
Reboot the modem to initiate the SW upgrade.
New software available on a remote LAN host will be uploaded to the modem.

SYNTAX:
software upgrade

672

E-DOC-CTC-20061027-0003 v2.0

Software Commands

software version
Display the software version.

SYNTAX:
software version

E-DOC-CTC-20061027-0003 v2.0

673

Software Commands

674

E-DOC-CTC-20061027-0003 v2.0

System Commands

37 System Commands
Introduction
This chapter describes the commands of the system command group.

Contents
This chapter covers the following commands:
system config

Set/change the system configuration parameters.

676

system flush

Flush the current system configuration.

678

system locale

Set/get the regional settings.

679

system reboot

Reboot the Thomson ST.

681

system reset

Reset the Thomson ST to its factory or ISP defaults and reboot the
device.

682

system timedreboot

Set or change a timed reboot for the Thomson ST.

684

system debug
autosave

Autosave debugging commands

685

system debug stats

Show the Thomson ST CPU and memory statistics.

686

system ra config

Configure Remote management access parameters.

687

system rtc
synchronize

Do a SNTP update and synchronize the realtime clock.

688

system rtc settime

Set/get date, time, timezone, daylight savings time, uptime.

689

E-DOC-CTC-20061027-0003 v2.0

675

System Commands

system config
Set/change the system configuration parameters.

!

For a good operation of UPnP and the discovery mechanism, it is highly recommended not to
change the system configuration settings.

SYNTAX:
system config

[upnp = <{disabled | enabled}>]
[tr64 = <{disabled | enabled}>]
[mdap = <{disabled | enabled}>]
[drst = <{disabled | enabled}>]
[led = <{green | red | orange | flash | off}>]
[resetbutton = <{disabled | enabled}>]
[digestauth = <{disabled | enabled}>]
[defaultconnection = ]
[rtc = <{disabled|enabled}>]
[autosave = <{disabled | enabled}>]
[autosavedelay = ]

where:
upnp

Enable or disable UPnP discovery.
The default is enabled.

OPTIONAL

tr64

Enable or disable TR-64 discovery.
The default is disabled.

OPTIONAL

mdap

Enable or disable proprietary discovery protocol.
The default is enabled.

OPTIONAL

drst

Enable or disable DrSpeedTouch access.
The default is disabled.

OPTIONAL

led

Set the system LED colour.
Choose between:

OPTIONAL

>
>
>
>
>

green: solid green
red: solid red
orange: solid orange
flash: toggle between green and orange
off: LED is off.

The default is green.

676

resetbutton

Enable or disable reset-to-factory-defaults pushbutton.
The default is enabled.

OPTIONAL

digestauth

Enable or disable HTTP digest authentication.
The default is enabled.

OPTIONAL

defaultconnection

The name of the default internet connection.

OPTIONAL

rtc

Enable or disable RTC.
The default is disabled

OPTIONAL

autosave

Enable or disable autosaves.
The default is enabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

System Commands

autosavedelay

A number between 0 and 600.
Represents the autosave delay in seconds (0 for immediate save).

OPTIONAL

EXAMPLE:
=>system config
upnp discovery
TR-64 discovery
mdap discovery
drst support
reset button
digest authentication
rtc
defaultconnection
autosave
autosave delay
=>

E-DOC-CTC-20061027-0003 v2.0

:
:
:
:
:
:
:
:
:
:

enabled
disabled
enabled
disabled
enabled
enabled
enabled
Internet
enabled
10s

677

System Commands

system flush
Flush the current system configuration.
The system password and the system config settings (dcache excluded) are flushed.

i

The flush command does not impact previously saved configurations.

SYNTAX:
system flush

EXAMPLE:
=>system flush
Security notification: Password changed, use 'saveall' to make it permanent.
=>

678

E-DOC-CTC-20061027-0003 v2.0

System Commands

system locale
Set/get the regional settings.

SYNTAX:
system locale

[dec_symbol = <{, | .}>]
[group_symbol = <{. | ,}>]
[date_separator = <{/ | - | .}>]
[date_format = <{iso | ddmmyyyy | ddmmyy | mmddyyyy |
mmddyy}>]
[time_format = <{iso | hmmss}>]
[datetime_format = <{iso | date+time | time+date}>]
[duration_format = <{dhmmss | hmmss}>]

where:
dec_symbol

Set the decimal symbol.
Choose between:

>
>

OPTIONAL

.
,

The default is “,”.
group_symbol

Set the group symbol.
Choose between:

>
>

OPTIONAL

.
,

The default is “.”.
date_separator

Set the date separator.
Choose between:

>
>
>

OPTIONAL

/
.

The default is “-”.
date_format

Set the date format.
Choose between:

>
>
>
>
>

OPTIONAL

iso
ddmmyyyy
ddmmyy
mmddyyyy
mmddyy

The default is ddmmyyyy.
Note

E-DOC-CTC-20061027-0003 v2.0

dd = day; mm = month; yyyy or yy = year.

679

System Commands

time_format

Set the time format.
Choose between:

>
>

OPTIONAL

iso
hmmss.

The default is iso.
Note
datetime_format

h = hours; mm = minutes; ss = seconds.

Set the date-time format.
Choose between:

>
>
>

OPTIONAL

iso
date+time
time+date.

The default is date+time.
duration_format

Set the duration format.
Choose between:

>
>

OPTIONAL

dhmmss
hmmss.

The default is dhmmss.
Note

d = days; h = hours; mm = minutes; ss = seconds.

EXAMPLE:
=>system locale
Decimal symbol
Digit grouping symbol
Date separator
Date format
Time format
Date-time format
Duration format
=>

680

=
=
=
=
=
=
=

,
.
ddmmyyyy
iso
date+time
dhmmss

E-DOC-CTC-20061027-0003 v2.0

System Commands

system reboot
Reboot the Thomson ST.

!

Non-saved configuration settings will be lost after reboot.

SYNTAX:
system reboot

EXAMPLE:
=>system reboot
.....
(lost session connectivity due to reboot)
.....

RELATED COMMANDS:
system timedreboot

E-DOC-CTC-20061027-0003 v2.0

Set or change a timed reboot for the Thomson ST..

681

System Commands

system reset
Reset the Thomson ST to its factory or ISP defaults and reboot the device.

!

All user specific settings and all saved configuration changes are lost after reboot.

SYNTAX:
system reset

factory yes/no = <{yes | no}>
proceed no/yes = <{no | yes}>

where:
factory yes/no

Choose between:

>
>
proceed no/yes

REQUIRED

yes: delete user and ISP specific settings.
no: delete user specific settins only.

Confirmation for resetting the modem.
If no confirmation is given, the Thomson ST will not be reset.

REQUIRED

EXAMPLE:
=>system reset
--------------!! WARNING !!
--------------The modem will be reset to (factory) defaults clearing all user (and ISP) settings.
Specifying  deletes user and ISP specific settings.
Connectivity with the ISP network might be lost.
 deletes user specific settings only.
factory yes/no = no
proceed no/yes = no
:system reset factory yes/no=no proceed no/yes=no
=>
=>system reset
--------------!! WARNING !!
--------------The modem will be reset to (factory) defaults clearing all user (and ISP) settings.
Specifying  deletes user and ISP specific settings.
Connectivity with the ISP network might be lost.
 deletes user specific settings only.
factory yes/no = yes
proceed no/yes = yes
:system reset factory yes/no=yes proceed no/yes=yes
.....
(lost session connectivity due to reboot)
.....

682

E-DOC-CTC-20061027-0003 v2.0

System Commands

RELATED COMMANDS:
sntp config

E-DOC-CTC-20061027-0003 v2.0

Modify/display the SNTP client configuration.

683

System Commands

system timedreboot
Set or change a timed reboot for the Thomson ST.

SYNTAX

timedreboot

[state = <{disabled|enabled}>]
[time = ]
[date = ]

where:
state

Enable/Disable timed reboot.
The default is disabled.

OPTIONAL

time

Change default countdown time (Min).
A number between 0 and 16384.
The default is 60.

OPTIONAL

date

Set date/time to reboot (DD/MM/YYYY/HH:MM).
The default is the current day and time

OPTIONAL

EXAMPLE:
=>:system timedreboot state=enabled time=60
input timeout (min): 60
=>

RELATED COMMANDS:
system reboot

684

Reboot the Thomson ST.

E-DOC-CTC-20061027-0003 v2.0

System Commands

system debug autosave
Autosave debugging commands

SYNTAX:
system debug
autosave

[trace = <{disabled|enabled}>]

where:
trace

E-DOC-CTC-20061027-0003 v2.0

Enable or disable autosave traces

OPTIONAL

685

System Commands

system debug stats
Show the Thomson ST CPU and memory statistics.

SYNTAX:
system debug stats

[reset = <{disabled | enabled}>]

where:
reset

Reset the CPU statistics.
The default is disabled.

OPTIONAL

DESCRIPTION:
> CHIP memory: Memory used by the CPU (first MB from the RAM) – not cached since it has to be realtime.
> Application memory: Memory used by the applications.
> min: The least amount of free memory detected during the uptime of the Thomson ST.

686

E-DOC-CTC-20061027-0003 v2.0

System Commands

system ra config
Configure Remote management access parameters.

SYNTAX:
system ra config

[secure = <{disabled | enabled}>]
[port = ]
[timeout = ]

where:
secure

Enable or disable https.
The default is enabled.

OPTIONAL

port

Set the destination port for remote access.
The default is 51003.

OPTIONAL

timeout

Set the connection timeout in minutes.

OPTIONAL

EXAMPLE:
=>system ra config
Remote management access configuration
Remote access port
: 51003
Secure remote access : enabled
=>

E-DOC-CTC-20061027-0003 v2.0

687

System Commands

system rtc synchronize
Do a SNTP update and synchronize the realtime clock.

SYNTAX:
system rtc synchronize

688

E-DOC-CTC-20061027-0003 v2.0

System Commands

system rtc settime
Set/get date, time, timezone, daylight savings time, uptime.
When synchronization with an external NTP server via the Thomson ST SNTP client fails, this command
allows to manually configure its internal clock.

i

In cases without regular synchronization, accurate realtime clock settings can not be guaranteed.

SYNTAX:
system rtc settime

[date = ]
[time = ]
[timezone = <(+ or -)hh:mm>]
[daylightsaving = <{disabled | enabled}>]

where:
date

The system date formatted as dd/mm/yyyy.
Note

time

timezone

OPTIONAL

If not specified, the current timezone is preserved.

Enable or disable daylight saving.
The default is disabled.
Note

OPTIONAL

If not specified, the current time is preserved.

The system timezone formatted as (+ or -)hh:mm.
Valid timezones are possible from -12:00 to +14:00 with a resolution
of 15 minutes.
Note

daylightsaving

If not specified, the current date is preserved.

The system time formatted as hh:mm:ss.
Note

OPTIONAL

OPTIONAL

If not specified, the current daylight saving setting is
preserved.

EXAMPLE:
=>system settime
date = 31/01/2005
time = 18:05:16
timezone = +00:00
daylightsaving = off
=>

E-DOC-CTC-20061027-0003 v2.0

689

System Commands

690

E-DOC-CTC-20061027-0003 v2.0

Systemlog Commands

38 Systemlog Commands
Introduction
This chapter describes the commands of the systemlog command group.

Contents
This chapter covers the following commands:
systemlog flush

Flush all messages in the internal Syslog message buffer.

692

systemlog show

Show messages in the internal Syslog message buffer.

693

systemlog send

Send messages from the internal Syslog message buffer to a specified
local or remote syslog server host.

695

E-DOC-CTC-20061027-0003 v2.0

691

Systemlog Commands

systemlog flush
Flush all messages in the internal Syslog message buffer.

SYNTAX:
systemlog flush

692

E-DOC-CTC-20061027-0003 v2.0

Systemlog Commands

systemlog show
Show messages in the internal Syslog message buffer.

SYNTAX:
systemlog show

[fac = ]
[sev = ]
[hist = <{disabled | enabled}>]

where:
fac

Specify the facility name of the syslog messages to be shown.
Use one of the supported facility names (see “ Supported Facilities”
on page 751).
Note

sev

hist

OPTIONAL

If not specified, the messages of all the severities will be
shown.

Show messages over several Thomson ST reboots (enabled) or show
only messages since latest startup (disabled).
Note

E-DOC-CTC-20061027-0003 v2.0

If not specified, the messages of all the facilities will be
shown.

Specify the lowest priority severity of the syslog messages to be
shown.
All the syslog messages with severity as specified or higher will be
shown.
Use one of the supported severity names (see “ Supported
Severities” on page 752).
Note

OPTIONAL

OPTIONAL

If not specified, only the recent messages will be shown.

693

Systemlog Commands

EXAMPLE:
=>syslog msgbuf show fac=kern sev=emerg hist=enabled
<0> SysUpTime: 14:45:43 KERNEL Controlled restart (after internal error or explicit system re
boot)
<0> SysUpTime: 02:58:18 KERNEL Controlled restart (after internal error or explicit system re
boot)
<0> SysUpTime: 04 days 04:52:37 KERNEL Controlled restart (after internal error or explicit s
ystem reboot)
<0> SysUpTime: 00:00:41 KERNEL Controlled restart (after internal error or explicit system re
boot)
=>syslog msgbuf show fac=kern sev=warning hist=enabled
<4> SysUpTime: 00:00:00 KERNEL Cold restart
<0> SysUpTime: 14:45:43 KERNEL Controlled restart (after internal error or explicit system re
boot)
<4> SysUpTime: 00:00:00 KERNEL Warm restart
<0> SysUpTime: 02:58:18 KERNEL Controlled restart (after internal error or explicit system re
boot)
<4> SysUpTime: 00:00:00 KERNEL Warm restart
<0> SysUpTime: 04 days 04:52:37 KERNEL Controlled restart (after internal error or explicit s
ystem reboot)
<4> SysUpTime: 00:00:00 KERNEL Warm restart
<0> SysUpTime: 00:00:41 KERNEL Controlled restart (after internal error or explicit system re
boot)
=>

694

E-DOC-CTC-20061027-0003 v2.0

Systemlog Commands

systemlog send
Send messages from the internal Syslog message buffer to a specified local or remote syslog server host.

i

There will be no notification on whether the host has received the messages or not.

SYNTAX:
systemlog send

[fac = ]
[sev = ]
[hist = <{disabled | enabled}>]
dest = 

where:
fac

Specify the facility name of the syslog messages to show.
Use one of the supported facility names (see “ Supported Facilities”
on page 751).
Note

sev

hist

E-DOC-CTC-20061027-0003 v2.0

OPTIONAL

If not specified, the messages of all the severities will be
shown.

Show messages over several Thomson ST reboots (disabled) or show
only messages since latest startup (enabled).
Note

dest

If not specified, the messages of all the facilities will be
shown.

Specify the lowest priority severity of the syslog messages to be
shown.
All the syslog messages with severity as specified or higher will be
shown.
Use one of the supported severity names (see “ Supported
Severities” on page 752).
Note

OPTIONAL

OPTIONAL

If not specified, only the recent messages will be shown.

The IP address of the remote host on the local or remote network, in
other words, the collector's IP address, to send the syslog messages
to.

REQUIRED

695

Systemlog Commands

systemlog DBG dbg_syslog
Perform a syslog call.

SYNTAX:
systemlog DBG dbg_syslog

priority = 
msgstring = 

where:

696

priority

priority number

msgstring

message content

E-DOC-CTC-20061027-0003 v2.0

Systemlog Commands

systemlog DBG dbg_long_mess
Generate a long syslog message call.

SYNTAX:
systemlog DBG dbg_long_mess

E-DOC-CTC-20061027-0003 v2.0

697

Systemlog Commands

systemlog DBG dbg_burst
Perform a syslog message burst.

SYNTAX:
systemlog DBG dbg_burst

698

E-DOC-CTC-20061027-0003 v2.0

Systemlog Commands

systemlog DBG dbg_contents
Show the contents of the message buffer.

SYNTAX:
systemlog DBG dbg_contents

E-DOC-CTC-20061027-0003 v2.0

699

Systemlog Commands

700

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

39 Upgrade Commands
Introduction
This chapter describes the commands of the upgrade command group.

Contents
This chapter covers the following commands:
upgrade config

Change the upgrade daemon configuration.

702

upgrade start

Start a new upgrade.

703

upgrade debug traceconfig

Enable/disable upgrade daemon tracing.

704

upgrade debug sesslist

Display the list of sessions.

705

upgrade profile add

Add a new file profile description.

706

upgrade profile modify

Modify a file profile description.

707

upgrade profile delete

Delete a file profile description.

708

upgrade profile list

Display a list of the file profile descriptions.

708

E-DOC-CTC-20061027-0003 v2.0

701

Upgrade Commands

upgrade config
Change the upgrade daemon configuration.

SYNTAX:
upgrade config

[state = <{disabled|enabled}>]
[protocol = <{tftp|ftp|http|https}>]

where:
state

Set the upgrade daemon state to enabled or disabled.

OPTIONAL

The default is disabled.
protocol

The transfer protocol to be used for file download.

OPTIONAL

Choose between:

>
>
>
>

tftp
ftp
http
https

The default is tftp.

EXAMPLE:
=>:upgrade config
Upgrade daemon state: disabled
Upgrade daemon transfer protocol: tftp
Upgrade daemon option 66:
Upgrade daemon option 67:
=>

702

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade start
Start a new upgrade.

SYNTAX:
upgrade start

protocol = <{tftp|ftp|http|https}>
[server = ]
[filename = ]

where:
protocol

The protocol to be used for the download.

REQUIRED

Choose between:

>
>
>
>

tftp
ftp
http
https

The default is disabled.
server

The server name or IP address

OPTIONAL

filename

The file to be downloaded

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

703

Upgrade Commands

upgrade debug traceconfig
Enable/disable upgrade daemon tracing.

SYNTAX:
upgrade debug traceconfig

state = <{disabled|enabled}>

where:
state

704

Set the upgared daemon state to enabled or disabled.

REQUIRED

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade debug sesslist
Display the list of sessions.

SYNTAX:
upgrade debug sesslist

EXAMPLE:
=>:upgrade debug sesslist
Session 0:
--------------------------------------------------------------SessionId : 0x80c25850
State
: IDLE
Protocol : TFTP
ServerName:
FileName :
DestFile :
ServerIP : 0.0.0.0
Error
:
Session 1:
--------------------------------------------------------------SessionId : 0x80c25c20
State
: IDLE
Protocol : TFTP
ServerName:
FileName :
DestFile :
ServerIP : 0.0.0.0
Error
:
=>

E-DOC-CTC-20061027-0003 v2.0

705

Upgrade Commands

upgrade profile add
Add a new file profile description.

SYNTAX:
upgrade profile add

extension = <{sts|ini}>
[maxsize(KBytes) = ]
action = <{none|config_load|script_load|reboot}>

where:
extension

The extension of the new file profile.
Choose between:

>
>

REQUIRED

sts
ini

maxsize

The maximum filesize (in KBytes) allowed for files with the
extension of this profile.
The default is 100.

OPTIONAL

action

The action to be done when the file with the extension of this
profile is downloaded.
Choose between:

REQUIRED

>
>
>
>

none
config_load
script_load
reboot

RELATED COMMANDS:

706

upgrade profile delete

Delete a file profile description.

upgrade profile list

Display a list of the file profile descriptions.

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade profile modify
Modify a file profile description.

SYNTAX:
upgrade profile modify

extension = <{sts|ini}>
[maxsize(KBytes) = ]
action = <{none|config_load|script_load|reboot}>

where:
extension

The extension of the new file profile.
Choose between:

>
>

REQUIRED

sts
ini

maxsize

The maximum filesize (in KBytes) allowed for files with the
extension of this profile.
The default is 100.

OPTIONAL

action

The action to be done when the file with the extension of this
profile is downloaded.
Choose between:

REQUIRED

>
>
>
>

none
config_load
script_load
reboot

RELATED COMMANDS:
upgrade profile delete

Delete a file profile description.

upgrade profile list

Display a list of the file profile descriptions.

E-DOC-CTC-20061027-0003 v2.0

707

Upgrade Commands

upgrade profile delete
Delete a file profile description.

SYNTAX:
upgrade profile delete

extension = <{sts|ini}>

where:
extension

The extension of the profile to be deleted.
Choose between:

>
>

REQUIRED

sts
ini

RELATED COMMANDS:

708

upgrade profile add

Add a new file profile description.

upgrade profile list

Display a list of the file profile descriptions.

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade profile list
Display a list of the file profile descriptions.

SYNTAX:
upgrade profile list

RELATED COMMANDS:
upgrade profile delete

Delete a file profile description.

upgrade profile modify

Modify a file profile description.

E-DOC-CTC-20061027-0003 v2.0

709

Upgrade Commands

upgrade ifadd
Add a download interface.

SYNTAX:
upgrade ifadd

intf = 

where:
intf

A download interface

REQUIRED

RELATED COMMANDS:

710

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade ifattach
Attach a download interface.

SYNTAX:
upgrade ifattach

intf = 

where:
intf

A download interface

REQUIRED

RELATED COMMANDS:

E-DOC-CTC-20061027-0003 v2.0

711

Upgrade Commands

upgrade ifconfig
Configure a download interface.

SYNTAX:
upgrade ifconfig

intf = 
[protocol = <{tftp|ftp|http|https}>]
[dest = <{loop|Internet|ISDN_backup| ISDN_backup_trigger|
lan1|wan1|dmz1|guest1}>]
[server = ]
[file = ]
[time = ]

where:
Intf

A download interface

REQUIRED

protocol

The transfer protocol

OPTIONAL

dest

The destination network interface name

OPTIONAL

server

The server name

OPTIONAL

file

The file name

OPTIONAL

time

download cycle time in s

OPTIONAL

RELATED COMMANDS:

712

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade ifdelete
Delete a download interface.

SYNTAX:
upgrade ifdelete

intf = 

where:
intf

A download interface

REQUIRED

RELATED COMMANDS:

E-DOC-CTC-20061027-0003 v2.0

713

Upgrade Commands

upgrade ifdetach
Detach a download interface.

SYNTAX:
upgrade ifdetach

intf = 

where:
intf

A download interface

REQUIRED

RELATED COMMANDS:

714

E-DOC-CTC-20061027-0003 v2.0

Upgrade Commands

upgrade iflist
List all download interfaces.

SYNTAX:
upgrade iflist

RELATED COMMANDS:

E-DOC-CTC-20061027-0003 v2.0

715

Upgrade Commands

716

E-DOC-CTC-20061027-0003 v2.0

UPnP Commands

40 UPnP Commands
Introduction
This chapter describes the commands of the upnp command group.

Contents
This chapter covers the following commands:
upnp config

Configure the UPnP™ parameter(s).

718

upnp flush

Flush the UPnP™ configuration. The UPnP configuration will be reset to the
default configuration.

719

upnp list

List all registered devices.

720

E-DOC-CTC-20061027-0003 v2.0

717

UPnP Commands

upnp config
Configure the UPnP™ parameter(s).

SYNTAX:
upnp config

[maxage = ]
[writemode = <{full | natonly | readonly}>]
[safenat = <{disabled | enabled}>]
[preferredaddress = ]
[httpport = ]

where:
maxage

A number between 60 and 999999.
This parameter allows to configure how often the Thomson ST sends a
notification message to advertise its presence as an Internet Gateway
Device (IGD) on the network.
The default is 1800.
Note

writemode

OPTIONAL

Setting this parameter to a low value will increase the number of
packets sent over time on the network, but will make the state of
the device more up to date.
OPTIONAL

Choose the set of rules to limit remote access from UPnP.
Choose between:

>
>

full: the host will accept all the UPnP SET and GET actions.

>

readonly: the UPnP control point will only be able to retrieve
information, all the SET actions are ignored.

natonly: GET and NAT related SET actions will be accepted, all other
actions will be ignored.

The default is natonly.
safenat

Enable or disable check on safe NAT entries.
If this check is enabled, all NAT create/delete requests for a LAN side IP
address different from the source IP address of the UPnP message will be
discarded.
The default is enabled.

OPTIONAL

preferreda
ddress

CSV list of preferred IP address for UPnP advertisements (1 per LAN IP
interface).

OPTIONAL

Note
httpport

718

Enter “0.0.0.0” for none.

A number between 1 and 65535.
Represents the web server port.
The default is 80.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

UPnP Commands

upnp flush
Flush the UPnP™ configuration. The UPnP configuration will be reset to the default configuration.

SYNTAX:
upnp flush

E-DOC-CTC-20061027-0003 v2.0

719

UPnP Commands

upnp list
List all registered devices.

i

Use this command to check whether a PPP connection is properly configured and thus advertised
as a PPP service.

SYNTAX:
upnp list

[verbose = ]

where:
verbose

Verbose level.
The default is 1.

OPTIONAL

EXAMPLE:
=>upnp list
---------------- device: IGD.xml -----------Advertised on: LocalNetwork (10.0.0.138)
-------------- devices/services -----------++ Root Device: urn:schemas-upnp-org:device:InternetGatewayDevice:1
-- Service 1: urn:upnp-org:serviceId:layer3f
-- Service 2: urn:upnp-org:serviceId:lanhcm
-- Service 3: urn:upnp-org:serviceId:wancic
-- Service 4: urn:upnp-org:serviceId:wandsllc:RELAY
-- Service 5: urn:upnp-org:serviceId:wanpppc:Internet
---------------------- end ----------------=>

720

E-DOC-CTC-20061027-0003 v2.0

User Commands

41 User Commands
Introduction
This chapter describes the commands of the user command group.

Contents
This chapter covers the following commands:
user add

Add a user.

722

user config

Modify a user.

724

user delete

Delete a user.

726

user flush

Flush the users.

727

user list

Display the users.

728

user rights

Display the session rights.

730

E-DOC-CTC-20061027-0003 v2.0

721

User Commands

user add
Add a user.

i

You can only add a user whose privileges are the same or lower than your own privileges.

SYNTAX:
user add

name = 
password = 
role = 
[hash2 = ]
[descr = ]
[defuser = <{disabled | enabled}>]
[defremadmin = <{disabled | enabled}>]
[deflocadmin = <{disabled | enabled}>]

where:
name

The new user name.
Note

REQUIRED

1. The maximum number of users is 10.
2. The maximum length is 32 characters.

password

The password.
Note

role

Use the command :mlp role list to obtain the role
name (see “ mlp role list” on page 563 for more information).
OPTIONAL

The maximum length is 32 characters.

A user description.
Note

defuser

REQUIRED

The MD5 hash.
Note

descr

The maximum length is 32 characters.

The role name.
Tip

hash2

REQUIRED

OPTIONAL

The maximum length is 63 characters.

Set this user as the default user (enabled) or not (disabled).
Note

OPTIONAL

When the Web interface is accessed, the account of this user
will be used by default. The user will not need to
authenticate himself with user name or password.

The default is disabled.

722

defremadmin

Set this user as the default remote administrator (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

deflocadmin

Set this user as the default local administrator (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

User Commands

EXAMPLE:
In the example below, the user Administrator creates a new user JohnDoe. This user has lower access rights
than the user “Poweruser”.
{Administrator}=>user list
User
Flags Role
-------- ---Administrator
U
Administrator
tech
R
TechnicalSupport
{Administrator}[user]=>add
name = JohnDoe
password = ****
Please retype password for verification.
password = ****
role = Administrator
[hash2] =
[descr] =
[defuser] =
[defremadmin] =
:user add name=JohnDoe password=_CYP_x9O/lhxuRyMME role=Administrator
{Administrator}=>user list
User
Flags Role
-------- ---Administrator
U
Administrator
tech
R
TechnicalSupport
JohnDoe
Administrator
{Administrator}=>

DESCRIPTION:
> U: indicates the default user.
> R: indicates the default remote administrator.

RELATED COMMANDS:
user delete

Delete a user.

user list

Display the users.

E-DOC-CTC-20061027-0003 v2.0

723

User Commands

user config
Modify a user.

i

You can only modify a user whose privileges are the same or lower than your own privileges.

SYNTAX:
user config

name = 
[password = ]
[role = ]
[descr = ]
[defuser = <{disabled | enabled}>]
[defremadmin = <{disabled | enabled}>]
[deflocadmin = <{disabled | enabled}>]

where:
name

The user name.

REQUIRED

password

The password.

OPTIONAL

Note
role

The role name.
Tip

descr

OPTIONAL

Use the command :mlp role list to obtain the role
names (see “ mlp role list” on page 563 for more information).

A user description.
Note

defuser

The maximum length is 32 characters.

OPTIONAL

The maximum length is 63 characters.

Set this user as the default user (enabled) or not (disabled).
Note

OPTIONAL

When the Web interface is accessed, the account of this user
will be used by default. The user will not need to
authenticate himself with user name or password.

The default is disabled.

724

defremadmin

Set this user as the default remote administrator (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

deflocadmin

Set this user as the default local administrator (enabled) or not
(disabled).
The default is disabled.

OPTIONAL

E-DOC-CTC-20061027-0003 v2.0

User Commands

EXAMPLE:
{Superuser}=>user list
User
====
Superuser
aPoweruser

Role
====
root
Poweruser

{Superuser}=>user config name=aPoweruser role=LAN_admin
{Superuser}=>user list
User
Role
====
====
Superuser
root
aPoweruser
LAN_admin
{Superuser}=>

E-DOC-CTC-20061027-0003 v2.0

725

User Commands

user delete
Delete a user.

i

You can only delete a user whose privileges are the same or lower than your own privileges.

SYNTAX:
user delete

name = 

where:
name

The name of the user to be deleted.

REQUIRED

EXAMPLE:
{Administrator}=>user list
User
---Administrator
tech
JohnDoe

Flags
----U
R

Role
---Administrator
TechnicalSupport
Administrator

{Administrator}=>user delete name = JohnDoe
{Administrator}=>user list
User
Flags Role
-------- ---Administrator
U
Administrator
tech
R
TechnicalSupport
{Administrator}=>

RELATED COMMANDS:

726

user add

Add a user.

user list

Display the users.

E-DOC-CTC-20061027-0003 v2.0

User Commands

user flush
Flush the users.
After execution of this command, the access to the Thomson ST will no longer be protected by a
password. The first user that logs on, after initiating a new Telnet session, will have the same
administrative rights as a user with the role root.

!

SYNTAX:
user flush

EXAMPLE:
{Administrator}=>user list
User
---Administrator
tech
JohnDoe

Flags
----U
R

Role
---Administrator
TechnicalSupport
Administrator

{Administrator}=>user flush
{Administrator}=>user list
{Administrator}=>

When this Telnet session is terminated and a new Telnet session is initiated, the following welcome screen
will appear:
Username :
-----------------------------------------------------------------------*
*
______ SpeedTouch 620
*
___/_____/\
*
/
/\\ Version 5.3.0.10
*
_____/__
/ \\
*
_/
/\_____/___ \ Copyright (c) 1999-2004,
*
//
/ \
/\ \
THOMSON
*
_______//_______/
\
/ _\/______
*
/
/ \
\
/
/ /
/\
*
__/
/
\
\ /
/ /
/ _\__
* / /
/
\_______\/
/ /
/ /
/\
* /_/______/___________________/ /________/ /___/ \
* \ \
\
___________
\ \
\ \
\ /
* \_\
\ /
/\
\ \
\ \___\/
*
\
\/
/ \
\ \
\ /
*
\_____/
/
\
\ \________\/
*
/__________/
\
\ /
*
\
_____ \
/_____\/
*
\ /
/\ \
/___\/
*
/____/ \ \ /
*
\
\ /___\/
*
\____\/
*
-----------------------------------------------------------------------=>

The user will not have to authenticate himself to gain access to the Thomson ST.

E-DOC-CTC-20061027-0003 v2.0

727

User Commands

user list
Display the users.

SYNTAX:
user list

[name = ]
[channel = <{ftp | telnet | http | mdap | serial}>]
[origin = <{lan | wan | local}>]
[secure = <{disabled | enabled}>]

where:
name

The user name.
Note

channel

telnet
http
mdap
serial.

wan
local.

OPTIONAL

disabled
enabled.

Note

728

If not specified, all the origins will be listed.

The selected security level.
Choose between:

>
>

OPTIONAL

lan

Note
secure

If not specified, all the channels will be listed.

The selected origin.
Choose between:

>
>
>

OPTIONAL

ftp

Note
origin

If not specified, all the users will be listed.

The selected channel.
Choose between:

>
>
>
>
>

OPTIONAL

If not specified, all the security levels will be listed.

E-DOC-CTC-20061027-0003 v2.0

User Commands

EXAMPLE:
{Administrator}=>user list
User
---Administrator
tech

Flags
----U
R

Role
---Administrator
TechnicalSupport

{Administrator}=>user list name=tech channel=http origin=wan
service(s): r_lan, r_wan, r_fs_view, r_fs_retrieve, r_rtg, r_fwdg, r_nat, r_frwl,
r_ipsec_norm, r_ipsec_adv, r_certificates, r_remote_mgnt, r_local, r_qos,
w_lan, w_wan, w_fs_passive, w_rtg, w_fwdg, w_nat, w_frwl_norm, w_frwl_adv,
w_frwe_mgnt, w_ipsec, w_certificates, w_remote_mgnt, w_local, w_qos,
snd_lan, snd_wan, snd_local, and_lan, and_wan, and_frwl, and_local,
user_admin, mlp_admin, secure_ipsec_term, secure_br, cli, cgi, ftp, mdap,
zone_45, zone_46, zone_47, zone_48, zone_49, zone_50, zone_51, zone_52,
zone_53, zone_54, zone_55, zone_56, zone_57, zone_58, zone_59, zone_60,
zone_61, zone_62, swk_activation, sensitve_file, zone_71, zone_72, zone_73,
zone_74, zone_75, zone_76, zone_77, zone_78, zone_79, zone_83, zone_84,
zone_85, zone_86, zone_87, zone_88, zone_89, zone_90, zone_91, zone_92,
traces
{Administrator}=>

RELATED COMMANDS:
user add

Add a user.

user delete

Delete a user.

E-DOC-CTC-20061027-0003 v2.0

729

User Commands

user rights
Display the session rights.

i

The user rights of the currently logged-in user are shown.

SYNTAX:
user rights

EXAMPLE:
{Administrator}=>user rights
Current session info:
user:
name='Administrator', role='Administrator'
access:
lan (origin_lan), telnet (channel_telnet), unsecure (unsecure_connection)
service(s): r_lan, r_wan, r_fs_view, r_fs_retrieve, r_rtg, r_fwdg, r_nat, r_frwl,
r_ipsec_norm, r_ipsec_adv, r_certificates, r_remote_mgnt, r_local, r_qos,
w_lan, w_wan, w_fs_passive, w_rtg, w_fwdg, w_nat, w_frwl_norm, w_frwl_adv,
w_frwe_mgnt, w_ipsec, w_certificates, w_remote_mgnt, w_local, w_qos,
snd_lan, snd_wan, snd_local, and_lan, and_wan, and_frwl, and_local,
user_admin, mlp_admin, secure_ipsec_term, secure_br, cli, cgi, ftp, mdap,
zone_45, zone_46, zone_47, zone_48, zone_49, zone_50, zone_51, zone_52,
zone_53, zone_54, zone_55, zone_56, zone_57, zone_58, zone_59, zone_60,
zone_61, zone_62, swk_activation, sensitve_file, zone_71, zone_72, zone_73,
zone_74, zone_75, zone_76, zone_77, zone_78, zone_79, zone_83, zone_84,
zone_85, zone_86, zone_87, zone_88, zone_89, zone_90, zone_91, zone_92,
traces
{Administrator}=>

730

E-DOC-CTC-20061027-0003 v2.0

Abbreviations

42 Abbreviations
The table below lists all the abbreviations used in the CLI Reference Guide.

Abbreviation

Description

AAL5

ATM Adaption Layer 5

ACL

Access Control List

ADSL

Asymmetric Digital Subscriber Line

AES

Advanced Encryption System

AF

Assured Forwarding

AP

Access Point

ARP

Address Resolution Protocol

ATM

Asynchronous Transfer Mode

BSSID

Base Service Set IDentifier

CA

Certificate Authority

CAPI

Common ISDN Application Interface

CC

Continuity Check

CEP

Certificate Enrollment Protocol

CHAP

Challenge Handshake Authentication Protocol

CIDR

Classless Inter Domain Routing

CLI

Command Line Interface

CLP

Cell Loss Priority

CO

Central Office

CPE

Customer Premises Equipment

CRL

Certificate Revocation List

CTD

Conformance Traffic Descriptor

CWMP

CPE WAN Management Protocol

DHCP

Dynamic Host Configuration Protocol

DN

Distinguished Name

DNS

Domain Name System

DPD

Dead Peer Detection

DSCP

Differentiated Services Code Point

DSD

Differentiated Service Delivery

DSL

Digital Subscriber Line

ECN

Explicit Congestion Notification

EF

Expedited Forwarding

FCS

Frame Check Sequence

FTP

File Transfer Protocol

GRE

General Routing Encapsulation

GRP

Gateway Routing Protocol

HDLC

High-level Data Link Control

E-DOC-CTC-20061027-0003 v2.0

731

Abbreviations

732

Abbreviation

Description

HTTP

HyperText Transfer Protocol

ICMP

Internet Control Message Protocol

IDS

Intrusion Detection System

IGD

Internet Gateway Device

IGMP

Internet Group Management Protocol

IKE

Internet Key Exchange

IP

Internet Protocol

IP oA

IP over ATM

IPCP

Internet Protocol Control Protocol

IPSec

IP Security

ISDN

Integrated Services Digital Network

ISI

Independent Set ID

KB

Kilobytes

Kbps

Kilobits per second

LAN

Local Area Network

LCP

Link Control Protocol

LDAP

Light-weight Directory Access Protocol

LLC

Logical Link Control

MAC

Medium Access Control

MC

MultiCast

MD5

Message Digest 5

MGCP

Media Gateway Control Protocol

MLP

Multi-Level access Policy

MPLS

Multiprotocol Label Switching

MTU

Maximum Transmission Unit

NAPT

Network Address and Port Translation

NAT

Network Address Translation

NLPID

Network Layer Protocol IDentifiers

NTP

Network Time Protocol

OAM

Operation and Maintenance

OBC

On Board Controller

OID

Object IDentifier

PAP

Password Authentication Protocol

PBX

Private Branch Exchange

PFS

Perfect Forward Secrecy

PKCS

Public Key Cryptography Standard

PKI

Public Key Infrastructure

POTS

Plain Old Telephone Service

PPP

Point-to-Point Protocol

E-DOC-CTC-20061027-0003 v2.0

Abbreviations

Abbreviation

Description

PPPoA

PPP over ATM

PPPoE

PPP over Ethernet

PPTP

Point-to-Point Tunneling Protocol

PSD

Power Spectral Density

PSK

Pre-Shared Key

PVC

Permanent Virtual Channel

QoS

Quality of Service

RIP

Routing Information Protocol

RTC

Real Time Clock

RTT

Round Trip Time

SAs

Security Associations

SFTP

Secure File Transfer Protocol

SHDSL

Single Pair High-speed Digital Subscriber Line

SIP

Session Initiation Protocol

SLA

Service Level Agreement

SMTP

Simple Mail Transfer Protocol

SNAP

Sub Network Access Protocol

SNMP

Simple Network Management Protocol

SNR

Signal-to-Noise Ratio

SNTP

Simple Network Time Protocol

SSH

Secure SHell

SSID

Service Set IDentifier

TCP

Transmission Control Protocol

TFTP

Trivial File Transfer Protocol

TKIP

Temporal Key Integrity Protocol

ToS

Type of Service

TTL

Time To Live

UA

User Agent

UDP

User Datagram Protocol

ULP

Upper Layer Protocol

UPnP

Universal Plug and Play

URI

Uniform Resource Identifier

URL

Uniform Resource Locator

USB

Universal Serial Bus

VC

Virtual Channel

VCI

Virtual Channel Identifier

VCMUX

Virtual Channel MUltipleXing

VDSL

Very high speed Digital Subscriber Line

VLAN

Virtual Local Area Network

E-DOC-CTC-20061027-0003 v2.0

733

Abbreviations

734

Abbreviation

Description

VLSM

Variable Length Subnet Masking

VP

Virtual Path

VPI

Virtual Path Identifier

VPN

Virtual Private Networking

WAN

Wide Area Network

WDS

Wireless Distribution System

WEP

Wired Equivalent Privacy

WFQ

Weighted Fair Queueing

WINS

Windows Internet Naming Service

WLAN

Wireless LAN

WPA

Wi-Fi Protected Access

WRR

Weighted Round Robin

E-DOC-CTC-20061027-0003 v2.0

System Logging Messages

43 System Logging Messages
Introduction
This chapter lists the different System Logging messages.

Contents
This chapter lists the different System Logging messages of the following modules:
Auto-PVC Module

736

Configuration Module

736

DHCP Client Module

736

DHCP Relay Module

737

DHCP Server Module

737

Dyndns Module

738

Firewall Module

738

LOGIN Module

739

Kernel Module

739

Linestate Module

739

NAPT Module

739

PPP Module

740

PPTP Module

740

RIP Module

741

Routing Module

742

Session Module

742

SNTP Module

742

Software Module

743

UPnP Module

743

E-DOC-CTC-20061027-0003 v2.0

735

System Logging Messages

Auto-PVC Module
Facility

Severity

Contents

LOCAL5

WARNING

AUTOPVC script  failed

LOCAL5

WARNING

AUTOPVC script  failed

LOCAL5

WARNING

AUTOPVC script  (name1, qosb_name) failed

LOCAL5

WARNING

AUTOPVC script  (name1, qosb_name, name2) failed

LOCAL5

WARNING

AUTOPVC script 'autopvc_change_qos (itable[i].intf, name1, qosb_name)
failed

LOCAL5

WARNING

AUTOPVC script  (name1, name2) failed

Configuration Module
Facility

Severity

Contents

USER

INFO

CONFIGURATION saved after running Embedded Setup Wizard

USER

INFO

CONFIGURATION saved by user 

USER

INFO

CONFIGURATION backup by user to file 

USER

INFO

CONFIGURATION  upgraded to version )

KERN

INFO

SYSTEM reset by user  to factory defaults: user settings deleted

DHCP Client Module

736

Facility

Severity

Contents

LOCAL2

WARNING

DHCC lease ip-address  bound to intf 

LOCAL2

WARNING

DHCC intf  renews lease ip-address 

LOCAL2

WARNING

DHCC intf  rebinds lease ip-address  from
server<$paratext>()

LOCAL2

WARNING

DHCC offer received from  (can be relay agent) for intf 

LOCAL2

WARNING

DHCC server () offers  to intf 

LOCAL2

WARNING

DHCC unable to configure ip address:  (bootp-reply)

LOCAL2

WARNING

DHCC bootp lease ip-address  bound to intf  from
server ()

LOCAL2

WARNING

DHCC  already configured on intf : failure

LOCAL2

WARNING

DHCC  () set on intf : {faillure||ok}

LOCAL2

WARNING

DHCC  deleted: {faillure||ok}

E-DOC-CTC-20061027-0003 v2.0

System Logging Messages

DHCP Relay Module
Facility

Severity

Contents

LOCAL2

WARNING

DHCR relay: Dropping boot rqs on interface  due to invalid giaddr
for server ()

LOCAL2

WARNING

DHCR relay: Dropping boot reply with invalid relay agent option from


LOCAL2

WARNING

DHCR relay: Dropping boot request containing the relay agent option from


LOCAL2

WARNING

DHCR relay: Dropping boot reply to unknown interface from 

LOCAL2

WARNING

DHCR relay: Dropping boot reply to inactive interface 

LOCAL2

WARNING

DHCR relay: Dropping boot reply to inactive interface 

LOCAL2

WARNING

DHCR relay: Dropping boot request packet with spoofed giaddr field from


LOCAL2

WARNING

DHCR relay: Dropping boot request received on unknown interface from


LOCAL2

WARNING

DHCR relay: Dropping boot request on inactive interface 

LOCAL2

WARNING

DHCR relay: Dropping boot request with invalid hops field on interface


LOCAL2

WARNING

DHCR relay: Dropping boot request with invalid giaddr on interface 

DHCP Server Module
Facility

Severity

Contents

LOCAL2

WARNING

DHCS server:  cannot be send due to invalid
server identifier

LOCAL2

WARNING

DHCS server: DHCPACK cannot be send due to invalid server identifier

LOCAL2

WARNING

DHCS server: DHCPNAK cannot be send due to invalid server identifier

LOCAL2

WARNING

DHCS server up

LOCAL2

WARNING

DHCS server went down

E-DOC-CTC-20061027-0003 v2.0

737

System Logging Messages

Dyndns Module
Facility

Severity

Contents

DYNDNS

WARNING

 Connection failed to  for client


DYNDNS

WARNING

 Failed to resolve host name  for
client 

DYNDNS

WARNING

 Server Timeout() for client


DYNDNS

WARNING

 Update failed to server  for client


DYNDNS

NOTICE

 client  <"started"||"stopped">

DYNDNS

WARNING

 Update failed for client , incomplete
configuration

DYNDNS

WARNING

 Update failed for client  (),
host  has not been updated

DYNDNS

WARNING

 Update failed for client 

DYNDNS

NOTICE

 Host  has been updated successfully by


DYNDNS

WARNING

 Authentication failed to server 

Firewall Module

738

Facility

Severity

Contents

AUTH

WARNING

FIREWALL Hook:  Rule ID: Protocol: ICMP
Src_ip:  Dst_ip: 
ICMP message type:  Action:


AUTH

WARNING

FIREWALL Hook:  Rule ID: Protocol: 
Src_ip_port:  Dst_ip_port: 
Action: 

E-DOC-CTC-20061027-0003 v2.0

System Logging Messages

LOGIN Module
Facility

Severity

Contents

AUTH

NOTICE

LOGOUT User  logged out on  ()

AUTH

NOTICE

LOGOUT User  logged out on 

AUTH

NOTICE

LOGOUT  session of user  killed ()

AUTH

NOTICE

LOGOUT  session of user  killed

AUTH

NOTICE

LOGIN User  tried to login on  (from )

AUTH

NOTICE

LOGIN User  logged in on  (from )

AUTH

NOTICE

LOGIN User logged in on  ()

AUTH

NOTICE

LOGIN User  tried to log in on 

Kernel Module
Facility

Severity

Contents

KERN

WARNING

KERNEL cold reset

KERN

WARNING

KERNEL warm reset

KERN

EMERG

KERNEL Controlled restart (after internal error or explicit system reboot)

Linestate Module
Facility

Severity

Contents

LOCAL5

NOTICE

xDSL linestate up (downstream:  kbit/s, upstream: 
kbit/s)

LOCAL5

NOTICE

xDSL linestate up
(downstream:  kbit/s, upstream:  kbit/s;
output Power Down:  dBm, Up:  dBm;
line Attenuation Down:  dB, Up: 
dB;
snr Margin Down:  dB, Up:  dB)"

NAPT Module
Facility

Severity

Contents

LOCAL4

INFO

NAPT Protocol:  Open port:  Helper: 
=> <"failed" | "ok">

E-DOC-CTC-20061027-0003 v2.0

739

System Logging Messages

PPP Module
Facility

Severity

Contents

LOCAL0

WARNING

PPP Link up ()

LOCAL0

WARNING

PPP Link down ()

AUTH

ERROR

PPP PAP authentication failed () [protocol reject]

AUTH

INFO

PPP PAP on intf  no response to authenticate-request

AUTH

NOTICE

PPP PAP remote user  successful authenticated

AUTH

ERROR

PPP PAP authentication for remote user  failed

AUTH

INFO

PPP PAP Authenticate Ack received

AUTH

INFO

PPP PAP Authenticate Nack received

AUTH

INFO

PPP PAP Authenticate Request sent

AUTH

ERROR

PPP PAP authentication failed ()

AUTH

ERROR

PPP CHAP authentication failed ()

AUTH

INFO

PPP CHAP authentication failed [protocol reject(server)]

AUTH

INFO

PPP CHAP authentication failed [protocol reject(client)]

AUTH

DEBUG

PPP CHAP Receive challenge (rhost = )

AUTH

INFO

PPP CHAP Chap receive success : authentication ok

AUTH

DEBUG

PPP CHAP Challenge Send (Id = )

AUTH

DEBUG

PPP CHAP Send status response: {ack || nack}

LOCAL0

ERROR

PPP IPCP cannot determine remote IP address ()

LOCAL0

ERROR

PPP IPCP cannot determine locale IP address ()

PPTP Module

740

Facility

Severity

Contents

LOCAL0

WARNING

PPTP tunnel () up:()

LOCAL0

WARNING

PPTP tunnel () down:()

E-DOC-CTC-20061027-0003 v2.0

System Logging Messages

RIP Module
Facility

Severity

Contents

LOCAL1

INFO

RIP Packet received from unknown interface

LOCAL1

INFO

RIP Packet size is smaller than minimum size

LOCAL1

INFO

RIP Packet size is greater than maximum size

LOCAL1

INFO

RIP Wrong RIP packet alignment

LOCAL1

INFO

RIP RIP version 0 with command  received

LOCAL1

INFO

RIP Reserved field not zero in RIP header

LOCAL1

INFO

RIP RIP is not enabled for network address 

LOCAL1

INFO

RIP Packet's v does not match to RIP v

LOCAL1

INFO

RIP Packet's v does not match to RIP v on interface


LOCAL1

INFO

RIP Packet v is dropped because authentication is disabled on
interface 

LOCAL1

INFO

RIP Simple password authentication failed on interface

LOCAL1

INFO

RIP No authentication in RIP packet

LOCAL1

INFO

RIP Obsolete command  received

LOCAL1

INFO

RIP Unknown RIP command received

LOCAL1

INFO

RIP Response does not come from default RIP port

LOCAL1

INFO

RIP Datagram doesn't come from a valid neighbor: 

LOCAL1

INFO

RIP Unsupported family from 

LOCAL1

INFO

RIP Network is net 127, class D or class E network

LOCAL1

INFO

RIP Address  is my own address, net 0 or not unicast

LOCAL1

INFO

RIP RIPv1 packet with incorrect must be zero fields

LOCAL1

INFO

RIP Route metric is not in the 1-16 range

LOCAL1

INFO

RIP Nexthop address is not directly reachable 

LOCAL1

INFO

RIP RIPv2 address  is not correct mask / applied

LOCAL1

INFO

RIP Not configured for sending RIPv1 packet on interface 

LOCAL1

INFO

RIP RIP routing table is full

LOCAL1

INFO

RIP Neighbor  is not connected to direct network

LOCAL1

INFO

RIP Interface  has not any valid local IP address for sending RIPv2
packets

LOCAL1

INFO

RIP Interface  has not any valid %s address for sending
RIPv packets

E-DOC-CTC-20061027-0003 v2.0

741

System Logging Messages

Facility

Severity

Contents

LOCAL1

INFO

RIP IP Address  not found in RIP table

Routing Module
Facility

Severity

Contents

LOCAL1

INFO

GRP Default destination is routed via gateway 

LOCAL1

INFO

GRP Default destination is not routed anymore via gateway 

SECURITY

INFO

LABEL Rule Id: Protocol: ICMP Src_ip:  Dst_ip:
 ICMP message type: 
Label: 

SECURITY

INFO

LABEL Rule Id: Protocol:  Src_ip: 
Dst_ip:  Label: 

Session Module
Facility

Severity

Contents

AUTH

NOTICE

SESSION TIMEOUT Timeout! (after  sec)

SNTP Module

742

Facility

Severity

Contents

NTP

WARNING

SNTP Unable to contact server: 

NTP

WARNING

SNTP Server not synchronized: 

NTP

WARNING

SNTP Invalid response from server: 

NTP

INFO

SNTP Synchronized to server: 

NTP

INFO

SNTP Synchronized again to server: 

NTP

WARNING

SNTP Roundtrip exceeds limits

NTP

ERROR

SNTP No server(s) configured, check configuration

NTP

ERROR

SNTP Systemtime update: time setting  > new time setting:


E-DOC-CTC-20061027-0003 v2.0

System Logging Messages

Software Module
Facility

Severity

Contents

KERN

INFO

SOFTWARE File   initiated

KERN

INFO

SOFTWARE File  <““ || not>
successful terminated"

UPnP Module
Facility

Severity

Contents

WARNING

SECURITY

UPnP refused for ip=

NOTICE

SECURITY

UPnP  () for ip=

NOTICE

SECURITY

UPnP action  from ip= ()

E-DOC-CTC-20061027-0003 v2.0

743

System Logging Messages

744

E-DOC-CTC-20061027-0003 v2.0

Supported Key Names

44 Supported Key Names
Contents
This chapter lists all the key names supported by the Thomson ST, that can be used for completing CLI
command parameters:
Supported IP Protocols

746

Supported TCP/UDP Port Names

747

Supported ICMP Type Names

750

Supported Facilities

751

Supported Severities

752

IP Precedence

752

Differentiated Services Code Point (DSCP)

753

E-DOC-CTC-20061027-0003 v2.0

745

Supported Key Names

Supported IP Protocols
For more information on the listed IP protocols, see RFC1340 or www.iana.org.

Protocol name

Number

Description

ah

51

Authentication Header (AH)

egp

8

Exterior Gateway Protocol (EGP)

esp

50

Encapsulating Security Payload (ESP)

ggp

3

Gateway Gateway Protocol (GGP)

gre

47

General Routing Encapsulation (GRE)

hmp

20

Host Monitoring Protocol (HMP)

icmp

1

Internet Control Message Protocol (ICMP)

igmp

2

Internet Group Management Protocol (IGMP)

pup

12

PUP Protocol

rdp

27

Reliable Data Protocol (RDP)

rsvp

46

Resource Reservation Protocol (RSVP)

tcp

6

Transmission Control Protocol (TCP)

udp

17

User Datagram Protocol (UDP)

vines

83

Vines

xns-idp

22

Xerox NS IDP

6to4

746

E-DOC-CTC-20061027-0003 v2.0

Supported Key Names

Supported TCP/UDP Port Names
For more information on the listed TCP/UDP port assignments, see RFC1340 or www.iana.org.

Port name

Number

TCP

UDP

Description

echo

7

Y

Y

Echo

discard

9

Y

Y

Discard

systat

11

Y

Y

Active Users

daytime

13

Y

Y

Daytime

qotd

17

Y

Y

Quote of the Day

chargen

19

Y

Y

Character Generator

ftp-data

20

Y

Y

File Transfer (Default data)

ftp

21

Y

Y

File Transfer (Control)

telnet

23

Y

Y

Telnet

smtp

25

Y

Y

Simple Mail Transfer Protocol (SMTP)

time

37

Y

Y

Time

nicname

43

Y

Y

Who Is

dns

53

Y

Y

Domain Name System (DNS)

domain

53

Y

Y

Domain Name System (DNS)

sql*net

66

Y

Y

Oracle SQL*NET

bootps

67

Y

Y

Bootstrap Protocol Server

bootpc

68

Y

Y

Bootstrap Protocol Client

tftp

69

Y

Y

Trivial File Transfer Protocol (TFTP)

gopher

70

Y

Y

Gopher

finger

79

Y

Y

Finger

www-http

80

Y

Y

World Wide Web (WWW) HTTP

kerberos

88

Y

Y

Kerberos

rtelnet

107

Y

Y

Remote Telnet Service

pop2

109

Y

Y

Post Office Protocol (POP) - Version 2

pop3

110

Y

Y

Post Office Protocol (POP) - Version 3

sunrpc

111

Y

Y

SUN Remote Procedure Call

auth

113

Y

Y

Authentication Service

sqlserver

118

Y

Y

SQL Services

nntp

119

Y

Y

Network News Transfer Protocol (NNTP)

ntp

123

Y

Y

Network Time Protocol (NTP)

E-DOC-CTC-20061027-0003 v2.0

747

Supported Key Names

748

Port name

Number

TCP

UDP

Description

sntp

123

Y

Y

Simple Network Time Protocol (SNTP)

ingres-net

134

Y

Y

INGRES-NET Service

netbios-ns

137

Y

Y

NETBIOS Naming System

netbios-dgm

138

Y

Y

NETBIOS Datagram Service

netbios-ssn

139

Y

Y

NETBIOS Session Service

imap2

143

Y

Y

Internet Message Access Protocol (IMAP) v2

sql-net

150

Y

Y

SQL-NET

pcmail-srv

158

Y

Y

PCMail Server

snmp

161

Y

Y

Simple Network Management Protocol (SNMP)

snmptrap

162

Y

Y

SNMP Trap

bgp

179

Y

Y

Border Gateway Protocol (BGP)

irc-o

194

Y

Y

Internet Relay Chat (IRC) - o

at-rtmp

201

Y

Y

AppleTalk RouTing Maintenance Protocol (RTMP)

at-nbp

202

Y

Y

AppleTalk Name Binding Protocol (NBP)

at-echo

204

Y

Y

AppleTalk Echo

at-zis

206

Y

Y

AppleTalk Zone Information System (ZIS)

ipx

213

Y

Y

Novell

imap3

220

Y

Y

Internet Message Access Protocol (IMAP) v3

clearcase

371

Y

Y

ClearCase

ulistserv

372

Y

Y

UNIX Listserv

ldap

389

Y

Y

Lightweight Directory Access Protocol (LDAP)

netware-ip

396

Y

Y

Novell Netware over IP

snpp

444

Y

Y

Simple Network Paging Protocol (SNPP)

ike

500

Y

Y

ISAKMP

biff

512

-

Y

Used by mail system to notify users of new mail
received

exec

512

Y

-

Remote process execution

login

513

Y

-

Remote login a la telnet

who

513

-

Y

Maintains data bases showing who's logged in to
machines on a local net and the load average of the
machine

syslog

514

-

Y

Syslog

printer

515

Y

Y

Spooler

talk

517

Y

Y

Like Tenex link, but across machine

E-DOC-CTC-20061027-0003 v2.0

Supported Key Names

Port name

Number

TCP

UDP

Description

ntalk

518

Y

Y

NTalk

utime

519

Y

Y

UNIX Time

rip

520

-

Y

Local routing process (on site); uses variant of Xerox
NS Routing Information Protocol (RIP)

timed

525

Y

Y

Timeserver

netwall

533

Y

Y

For emergency broadcasts

new-rwho

540

Y

Y

uucpd remote who is

uucp

540

Y

Y

uucpd

uucp-rlogin

540

Y

Y

uucpd remote login

rtsp

554

Y

Y

Real Time Streaming Protocol (RTSP)

whoami

565

Y

Y

whoami

ipcserver

600

Y

Y

SUN IPC Server

doom

666

Y

Y

Doom ID Software

ils

1002

Y

Y

Internet Locator Service (ILS)

h323

1720

Y

Y

H323 Host Call Secure

nfsd

2049

Y

Y

NFS deamon

sip

5060

Y

Y

Session Initiation Protocol (SIP)

xwindows

6000

Y

Y

X windows

irc-u

6667

Y

Y

Internet Relay Chat (IRC) Protocol

realaudio

7070

Y

Y

realaudio

httpproxy

8080

Y

Y

HTTP Proxy

E-DOC-CTC-20061027-0003 v2.0

749

Supported Key Names

Supported ICMP Type Names
For more information on the listed ICMP type names, see RFC1340 or www.iana.org.

750

ICMP Type name

Number

Description

echo-reply

0

Echo Reply

destination-unreachable

3

Destination Unreachable

source-quench

4

Source Quench

redirect

5

Redirect

echo-request

8

Echo

router-advertisement

9

Router Advertisement

router-solicitation

10

Router Solicitation

time-exceeded

11

Time Exceeded

parameter-problems

12

Parameter problems

timestamp-request

13

Timestamp

timestamp-reply

14

Timestamp Reply

information-request

15

Information Request

information-reply

16

Information Reply

address-mask-request

17

Address Mask Request

address-mask-reply

18

Address Mask Reply

E-DOC-CTC-20061027-0003 v2.0

Supported Key Names

Supported Facilities
For more information on the listed facilities, see RFC3164.

Facilty Name

Hierarchy
Code

Syslog facility
(listed according descending importance)

kern

0

Kernel messages

user

8

User-level messages

mail

16

Mail system

daemon

24

System daemons

auth

32

Authorization messages

syslog

40

Syslog daemon messages

lpr

48

Line printer subsystem

news

56

Network news subsystem

uucp

64

UUCP subsystem

cron

72

Clock daemon

security

80

Security messages

ftp

88

FTP daemon

ntp

96

NTP subsystem

audit

104

Log audit

logalert

112

Log alert

clock

120

Clock daemon

local0
local1
local2
local3
local4
local5
local6
local7

128
136
144
152
160
168
176
184

Local use messages

all

-

All facilities (Thomson ST specific facility parameter value.

E-DOC-CTC-20061027-0003 v2.0

751

Supported Key Names

Supported Severities
For more information on the listed severities, see RFC3164.

Severity Name

Hierarchy
Code

Syslog severity
(listed according descending importance)

emerg

0

Emergency conditions, system unusable

alert

1

Alert conditions, immediate action is required

crit

2

Critical conditions

err

3

Error conditions

warning

4

Warning conditions

notice

5

Normal but significant conditions

info

6

Informational messages

debug

7

Debug-level messages

IP Precedence

752

Precedence

Numbe
r

Routine

0

Priority

1

Immediate

2

Flash

3

Flash-Override

4

CRITIC-ECP

5

Internetwork-Control

6

Network-Control

7

E-DOC-CTC-20061027-0003 v2.0

Supported Key Names

Differentiated Services Code Point (DSCP)
For more information on DSCP, see RFC3260.

PHB

PHB Name

Binary value

ef

Expedited Forwarding

101110

af41

Assured Forwarding 41

100110

af42

Assured Forwarding 42

100100

af43

Assured Forwarding 43

100010

af31

Assured Forwarding 31

011110

af32

Assured Forwarding 32

011100

af33

Assured Forwarding 33

011010

af21

Assured Forwarding 21

010110

af22

Assured Forwarding 22

010110

af23

Assured Forwarding 23

010010

af11

Assured Forwarding 11

001110

af12

Assured Forwarding 12

001100

af13

Assured Forwarding 13

001010

cs7

Class Selector 7

111000

cs6

Class Selector 6

110000

cs5

Class Selector 5

101000

cs4

Class Selector 4

100000

cs3

Class Selector 3

011000

cs2

Class Selector 2

010000

cs1

Class Selector 1

001000

cs0

Class Selector 0

000000

E-DOC-CTC-20061027-0003 v2.0

753

Supported Key Names

754

E-DOC-CTC-20061027-0003 v2.0

Index

A

appinfo

aal5stats

applist

connection appinfo 84
atm debug aal5stats 41

actlist

connection applist 85
arpadd

eth bridge dynvlan actlist 265
add

ip arpadd 433
arpdelete

atm bundle add 27
atm oam vclb add 52
atm phonebook add 55
atm qosbook add 60
dhcp client rqoptions add 122
dhcp client txoptions add 126
dhcp relay add 130
dhcp rule add 143
dhcp server lease add 155
dhcp server pool add 168
dns server host add 199
dns server route add 203
dsd urlfilter rule add 220
dyndns add 228
dyndns host add 234
eth bridge add 261
eth bridge dynvlan add 266
eth bridge rule add 293
eth switch share add 310
eth vlan add 323
expr add 328
firewall chain add 349
firewall level add 358
firewall rule add 364
hostmgr add 388
label add 488
label chain add 495
label rule add 499
mlp privilege add 549
mlp role add 558
script add 620
service host add 630
service host rule add 637
snmp community add 654
sntp add 666
upgrade profile add 706
user add 722
addpriv
mlp role addpriv 560
addzone
mlp privilege addzone 551
adsl
config 8
info 9
appconfig
connection appconfig 82

E-DOC-CTC-20061027-0003 v2.0

ip arpdelete 434
arplist
ip arplist 435
assign
service host assign 628
atm
bundle
add 27
attach 28
clear 30
config 29
delete 31
detach 32
flush 33
ifadd 34
ifconfig 35
ifdelete 36
list 37
cac
config 38
list 39
overbooking 40
debug
aal5stats 41
gstats 42
portstats 43
flush 19
ifadd 20
ifattach 21
ifconfig 22
ifdelete 24
ifdetach 25
iflist 26
oam
cc
list 49
modify 50
send 51
config 44
list 45
modify 46
ping 48
vclb
add 52
del 53
list 54
phonebook

755

Index

add 55
autolist 56
delete 57
flush 58
list 59
qosbook
add 60
config 61
ctdadd 62
ctddelete 64
ctdlist 65
delete 66
flush 67
list 68
attach
atm bundle attach 28
autolist
atm phonebook autolist 56
autopvc
config 70
info 72
autosave
system debug autosave 685

B
bind
connection bind 86
bindlist
connection bindlist 87

C
capture
eth switch mirror capture 307
clean
connection clean 88
clear
atm bundle clear 30
connection clear 89
dhcp client debug clear 119
dhcp server debug clear 151
dns server debug clear 192
dns server debug spoof clear 194
eth bridge clear 259
eth bridge igmpsnooping clear 284

756

firewall debug clear 355
firewall rule debug clear 370
hostmgr clear 390
ids clear 396
ids pattern clear 401
ids threshold clear 406
igmp host debug clear 415
igmp proxy debug clear 424
ipqos queue clear 481
label rule debug clear 508
config
adsl config 8
atm bundle config 29
atm cac config 38
atm oam config 44
atm qosbook config 61
autopvc config 70
connection config 90
cwmp config 102
cwmp server config 104
delete 74
dhcp relay config 133
dhcp server config 148
dhcp server pool config 170
dns client config 184
dns server config 190
dsd config 210
dsd intercept config 216
dsd syslog config 217
dsd urlfilter config 219
dump 75
eth bridge config 264
eth bridge dynvlan config 267
eth bridge igmpsnooping config 280
eth switch qos config 314
eth switch qos weights 317
eth switch shaper config 318
firewall config 344
flush 76
grp config 376
grp rip config 379
hostmgr config 391
ids config 397
ids parser config 399
igmp host config 410
igmp proxy config 417
ip config 436
ipqos config 474
ipqos ef config 478
ipqos queue config 482
language config 514
list 77
load 78
mbus client config 518
mlp privilege config 552
mlp role config 561
nat config 566
save 80

E-DOC-CTC-20061027-0003 v2.0

Index

service host config 629
snmp config 650
sntp config 667
system config 676
system ra config 687
upgrade
config 702
upnp config 718
user config 724
connection
appconfig 82
appinfo 84
applist 85
bind 86
bindlist 87
clean 88
clear 89
config 90
debug 91
describe 92
flush 93
info 94
list 95
refresh 96
stats 97
timerclear 98
timerconfig 99
unbind 100
ctdadd
atm qosbook ctdadd 62
ctddelete
atm qosbook ctddelete 64
ctdlist
atm qosbook ctdlist 65
cwmp
config 102
server
config 104

D
debug
connection debug 91
exec 106
del
atm oam vclb del 53
delete
atm bundle delete 31
atm phonebook delete 57
atm qosbook delete 66

E-DOC-CTC-20061027-0003 v2.0

config delete 74
dhcp client rqoptions delete 123
dhcp client txoptions delete 127
dhcp relay delete 134
dhcp rule delete 145
dhcp server lease delete 157
dhcp server pool delete 172
dns server host delete 200
dns server route delete 205
dsd urlfilter rule delete 221
dyndns delete 229
dyndns host delete 235
eth bridge delete 262
eth bridge dynvlan delete 268
eth bridge rule delete 294
eth switch share delete 311
eth vlan delete 324
expr delete 332
firewall chain delete 351
firewall level delete 359
firewall rule delete 365
hostmgr delete 392
label chain delete 496
label delete 489
label rule delete 502
language delete 515
mlp privilege delete 553
mlp role delete 562
script delete 621
service host delete 631
service host rule delete 638
snmp community delete 655
sntp delete 668
upgrade profile delete 708
user delete 726
describe
connection describe 92
detach
atm bundle detach 32
dhcp
client
debug
clear 119
stats 120
traceconfig 121
flush 109
ifadd 110
ifattach 111
ifconfig 112
ifdelete 113
ifdetach 114
iflist 115
ifrenew 117
rqoptions
add 122
delete 123
list 124

757

Index

optionlist 125
txoptions
add 126
delete 127
list 128
relay
add 130
config 133
debug
stats 131
traceconfig 132
delete 134
flush 135
ifconfig 136
iflist 138
list 139
modify 140
ruleadd 141
ruledelete 142
rule
add 143
debug
traceconfig 144
delete 145
flush 146
list 147
server
config 148
debug
clear 151
stats 152
traceconfig 154
flush 149
lease
add 155
delete 157
flush 158
list 159
option
flush 160
instadd 161
instdelete 163
instlist 164
tmpladd 165
tmpldelete 166
tmpllist 167
policy 150
pool
add 168
config 170
delete 172
flush 173
list 174
optadd 175
optdelete 176
rtadd 178
rtdelete 179
ruleadd 180
ruledelete 181

758

disable
service host disable 632
dns
client
config 184
dnsadd 185
dnsdelete 186
dnslist 187
flush 188
nslookup 189
server
config 190
debug
clear 192
spoof
clear 194
getaddress 195
getflags 196
list 197
update 198
stats 193
flush 191
host
add 199
delete 200
flush 201
list 202
route
add 203
delete 205
flush 206
list 207
dnsadd
dns client dnsadd 185
dnsdelete
dns client dnsdelete 186
dnslist
dns client dnslist 187
dsd
config 210
debug
connection
list 212
proxy 213
recycling 214
stats 215
intercept
config 216
syslog
config 217
list 218
urlfilter
config 219
rule
add 220

E-DOC-CTC-20061027-0003 v2.0

Index

delete 221
flush 222
list 223
modify 224
dump
config dump 75
dyndns
add 228
delete 229
flush 230
host
add 234
delete 235
flush 236
list 237
list 231
modify 232
service
list 238
modify 240

E
egress
eth switch mirror egress 308
env
flush 244
get 245
list 246
set 247
unset 248
eth
bridge
add 261
clear 259
config 264
delete 262
dynvlan
actlist 265
add 266
config 267
delete 268
flush 269
list 270
flush 271
ifadd 272
ifattach 273
ifconfig 274
ifdelete 276
ifdetach 277
ifflush 279
iflist 278

E-DOC-CTC-20061027-0003 v2.0

igmpsnooping
clear 284
config 280
ifconfig 282
iflist 283
list 281
list 260
macadd 285
macdelete 287
maclist 289
mcdadd 290
mcddelete 291
mcdlist 292
rule
add 293
delete 294
flush 295
list 296
select 263
vlan
ifadd 297
ifconfig 298
ifdelete 299
iflist 300
device
ifconfig 301
iflist 303
flush 258
ifadd 252
ifattach 253
ifconfig 254
ifdelete 255
ifdetach 256
iflist 257
switch
group
flush 304
list 305
move 306
info 313
mirror
capture 307
egress 308
ingress 309
qos
config 314
ifconfig 315
list 316
weights 317
shaper
config 318
ifconfig 319
iflist 320
share
add 310
delete 311
list 312
storm
ifconfig 321

759

Index

iflist 322
vlan
add 323
delete 324
flush 325
list 326
exec
debug exec 106
mbus client exec 519
export
mlp debug export 546
expr
add 328
delete 332
flush 334
list 335
modify 339

F
firewall
chain
add 349
delete 351
flush 353
list 354
config 344
debug
clear 355
stats 356
traceconfig 357
flush 346
level
add 358
delete 359
flush 360
list 361
modify 362
set 363
list 347
rule
add 364
debug
clear 370
stats 372
traceconfig 374
delete 365
flush 366
list 367
modify 369

760

flush
atm bundle flush 33
atm flush 19
atm phonebook flush 58
atm qosbook flush 67
config flush 76
connection flush 93
dhcp client flush 109
dhcp relay flush 135
dhcp rule flush 146
dhcp server flush 149
dhcp server lease flush 158
dhcp server option flush 160
dhcp server pool flush 173
dns client flush 188
dns server flush 191
dns server host flush 201
dns server route flush 206
dsd urlfilter rule flush 222
dyndns flush 230
dyndns host flush 236
env flush 244
eth bridge dynvlan flush 269
eth bridge flush 271
eth bridge rule flush 295
eth flush 258
eth switch group flush 304
eth vlan flush 325
expr flush 334
firewall chain flush 353
firewall flush 346
firewall level flush 360
firewall rule flush 366
grp flush 377
grp rip flush 382
hostmgr flush 393
igmp host flush 411
igmp proxy flush 419
ip auto flush 459
ip flush 438
ip mcast flush 454
label chain flush 497
label flush 490
label rule flush 504
mlp flush 544
nat flush 567
ppp flush 584
ppp relay flush 604
pptp flush 613
script flush 622
service host flush 633
sntp flush 669
system flush 678
systemlog flush 692
upnp flush 719
user flush 727

E-DOC-CTC-20061027-0003 v2.0

Index

G
get
env get 245
snmp get 651
snmp getnext 652
getaddress
dns server debug spoof getaddress 195
getflags
dns server debug spoof getflags 196
grouplist
igmp proxy grouplist 420
grp
config 376
flush 377
rip
config 379
flush 382
ifconfig 383
show 385
rtlist 378
gstats
atm debug gstats 42

H
hostmgr
add 388
clear 390
config 391
delete 392
flush 393
list 394
httpprobe
ip debug httpprobe 467

I
ids
clear 396
config 397
list 398
parser
config 399
pattern
clear 401

E-DOC-CTC-20061027-0003 v2.0

list 402
stats 403
signature
list 404
modify 405
threshold
clear 406
list 407
modify 408
ifadd
atm bundle ifadd 34
atm ifadd 20
dhcp client ifadd 110
eth bridge ifadd 272
eth bridge vlan ifadd 297
eth ifadd 252
ip auto ifadd 460
ip ifadd 439
ppp ifadd 585
ppp relay ifadd 605
pptp ifadd 612
service system ifadd 639
snmp ifadd 658
ifattach
atm ifattach 21
dhcp client ifattach 111
eth bridge ifattach 273
eth ifattach 253
ip auto ifattach 461
ip ifattach 440
ppp ifattach 587
snmp ifattach 660
ifconfig
atm bundle ifconfig 35
atm ifconfig 22
dhcp client ifconfig 112
dhcp relay ifconfig 136
eth bridge ifconfig 274
eth bridge igmpsnooping ifconfig 282
eth bridge vlan ifconfig 298
eth device ifconfig 301
eth ifconfig 254
eth switch qos ifconfig 315
eth switch shaper ifconfig 319
eth switch storm ifconfig 321
grp rip ifconfig 383
igmp host ifconfig 413
igmp proxy ifconfig 421
ip auto ifconfig 462
ip ifconfig 441
nat ifconfig 568
ppp ifconfig 589
ppp relay ifconfig 606
snmp ifconfig 662
ifdelete
atm bundle ifdelete 36

761

Index

atm ifdelete 24
dhcp client ifdelete 113
eth bridge ifdelete 276
eth bridge vlan ifdelete 299
eth ifdelete 255
ip auto ifdelete 464
ip ifdelete 443
ppp ifdelete 594
ppp relay ifdelete 607
service system ifdelete 640
snmp ifdelete 659

ifconfig 413
iflist 414
list 412
proxy
config 417
debug
clear 424
flush 419
grouplist 420
ifconfig 421
iflist 422
mbslist 423

ifdetach
atm ifdetach 25
dhcp client ifdetach 114
eth bridge ifdetach 277
eth ifdetach 256
ip auto ifdetach 465
ip ifdetach 444
ppp ifdetach 596
snmp ifdetach 661
ifflush

import
mlp import 545
info
adsl info 9
autopvc info 72
connection info 94
eth switch info 313
ingress
eth switch mirror ingress 309

eth bridge ifflush 279

instadd

iflist
atm iflist 26
dhcp client iflist 115
dhcp relay iflist 138
eth bridge iflist 278
eth bridge igmpsnooping iflist 283
eth bridge vlan iflist 300
eth device iflist 303
eth iflist 257
eth switch shaper iflist 320
eth switch storm iflist 322
igmp host iflist 414
igmp proxy iflist 422
ip auto iflist 466
ip iflist 445
nat iflist 569
ppp iflist 598
ppp relay iflist 608
snmp iflist 663
ifrenew
dhcp client ifrenew 117
ifscan
ppp ifscan 599
ifwait
ip ifwait 446
igmp
host
config 410
debug
clear 415
stats 416
flush 411

762

dhcp server option instadd 161
instdelete
dhcp server option instdelete 163
instlist
dhcp server option instlist 164
interface
list 428
ip
arpadd 433
arpdelete 434
arplist 435
auto
flush 459
ifadd 460
ifattach 461
ifconfig 462
ifdelete 464
ifdetach 465
iflist 466
config 436
debug
httpprobe 467
sendto 468
stats 470
traceconfig 471
flush 438
ifadd 439
ifattach 440
ifconfig 441
ifdelete 443
ifdetach 444

E-DOC-CTC-20061027-0003 v2.0

Index

iflist 445
ifwait 446
ipadd 447
ipconfig 448
ipdelete 449
iplist 450
mcast
flush 454
rtadd 451
rtdelete 452
rtlist 453
rtadd 455
rtdelete 457
rtlist 458

L
label
add 488
chain
add 495
delete 496
flush 497
list 498
delete 489
flush 490
list 491
modify 492
rule
add 499
debug
clear 508
stats 510
traceconfig 511
delete 502
flush 504
list 505
modify 507

ipadd
ip ipadd 447
service system ipadd 641
ipconfig
ip ipconfig 448
ipdelete
ip ipdelete 449
service system ipdelete 642
iplist

language
config 514
delete 515
list 516

ip iplist 450
ipqos
config 474
ef
config 478
list 479
stats 480
list 477
queue
clear 481
config 482
list 484
stats 485

K
Key names
DSCP 753
ICMP type 750
IP precedence 752
IP protocols 746
Syslog facilities 751
Syslog severities 752
TCP/UDP port 747

E-DOC-CTC-20061027-0003 v2.0

list
atm bundle list 37
atm cac list 39
atm oam cc config 49
atm oam list 45
atm oam vclb list 54
atm phonebook list 59
atm qosbook list 68
config list 77
connection list 95
dhcp client rqoptions list 124
dhcp client txoptions list 128
dhcp relay list 139
dhcp rule list 147
dhcp server lease list 159
dhcp server pool list 174
dns server debug spoof list 197
dns server host list 202
dns server route list 207
dsd syslog list 218
dsd urlfilter rule list 223
dyndns host list 237
dyndns list 231
dyndns service list 238
env list 246
eth bridge dynvlan list 270
eth bridge igmpsnooping list 281
eth bridge list 260
eth bridge rule list 296
eth switch group list 305

763

Index

eth switch qos list 316
eth switch share list 312
eth vlan list 326
expr list 335
firewall chain list 354
firewall level list 361
firewall list 347
firewall rule list 367
hostmgr list 394
ids list 398
ids pattern list 402
ids signature list 404
ids threshold list 407
igmp host list 412
interface list 428
ipqos ef list 479
ipqos list 477
ipqos queue list 484
label chain list 498
label list 491
label rule list 505
language list 516
mlp privilege list 555
mlp role list 563
pptp list 614
script list 623
service host list 634
service system list 643
snmp community list 656
sntp list 670
upnp list 720
user list 728

macdelete
eth bridge macdelete 287
maclist
eth bridge maclist 289
mapadd
nat mapadd 570
service system mapadd 645
mapdelete
nat mapdelete 574
service system mapdelete 646
maplist
nat maplist 575
mbslist
igmp proxy mbslist 423
mbus
client
config 518
exec 519
register 521
debug
stats 522
traceconfig 524
listobjects 525
listtypes 526
loadobjects 530
unloadobjects 531
mcdadd

list dsd debug connection list 212
listobjects
mbus listobjects 525
memm listobjects 540

eth bridge mcdadd 290
mcddelete
eth bridge mcddelete 291
mcdlist

listtypes
mbus listtypes 526

eth bridge mcdlist 292
memm

load

debug
lock

config load 78

traceconfig 536
traceconfig 537
listobjects 540
stats 541

loadobjects
mbus loadobjects 530
locale
system locale 679

M
macadd
eth bridge macadd 285

764

mlp
debug
export 546
stats 547
traceconfig 548
flush 544
import 545
privilege
add 549
addzone 551
config 552
delete 553

E-DOC-CTC-20061027-0003 v2.0

Index

list 555
removezone 557
role
add 558
addpriv 560
config 561
delete 562
list 563
removepriv 564

O
optadd
dhcp server pool optadd 175
optdelete
dhcp server pool optdelete 176
optionlist
dhcp client rqoptions optionlist 125

modify
atm oam cc modify 50
atm oam modify 46
dhcp relay modify 140
dsd urlfilter rule modify 224
dyndns modify 232
dyndns service modify 240
expr modify 339
firewall level modify 362
firewall rule modify 369
ids signature modify 405
ids threshold modify 408
label modify 492
label rule modify 507
service system modify 647
snmp community modify 657
upgrade profile modify 707

overbooking
atm cac overbooking 40

P
ping
atm oam ping 48
ping root command 4
policy
dhcp server policy 150
portstats

move
eth switch group move 306

N
nat
config 566
flush 567
ifconfig 568
iflist 569
mapadd 570
mapdelete 574
maplist 575
tmpladd 576
tmpldelete 580
tmplinst 582
tmpllist 581
nslookup
dns client nslookup 189

atm debug portstats 43
ppp
flush 584
ifadd 585
ifattach 587
ifconfig 589
ifdelete 594
ifdetach 596
iflist 598
ifscan 599
relay
flush 604
ifadd 605
ifconfig 606
ifdelete 607
iflist 608
sesslist 609
rtadd 600
rtdelete 602
pptp
flush 613
ifadd 612
list 614
profadd 615
profdelete 617
proflist 618
profadd
pptp profadd 615

E-DOC-CTC-20061027-0003 v2.0

765

Index

profdelete

ruledelete

pptp profdelete 617

dhcp relay ruledelete 142
dhcp server pool ruledelete 181

proflist
pptp proflist 618

run
script run 625

proxy
dsd debug proxy 213

S
R

save

reboot
system reboot 681
recycling
dsd debug recycling 214
refresh
connection refresh 96
register
mbus client register 521
removepriv
mlp role removepriv 564
removezone
mlp privilege removezone 557
reset
system reset 682
rights
user rights 730
root commands
ping 4
traceroute 5
rtadd
dhcp server pool rtadd 178
ip mcast rtadd 451
ip rtadd 455
ppp rtadd 600
rtdelete
dhcp server pool rtdelete 179
ip mcast rtdelete 452
ip rtdelete 457
ppp rtdelete 602
rtlist
grp rtlist 378
ip mcast rtlist 453
ip rtlist 458
ruleadd
dhcp relay ruleadd 141
dhcp server pool ruleadd 180

766

config save 80
script
add 620
delete 621
flush 622
list 623
run 625
select
eth bridge select 263
send
atm oam cc send 51
systemlog send 695
sendto
ip debug sendto 468
service
host
add 630
assign 628
config 629
delete 631
disable 632
flush 633
list 634
rule
add 637
delete 638
stats 635
triggerlist 636
system
ifadd 639
ifdelete 640
ipadd 641
ipdelete 642
list 643
mapadd 645
mapdelete 646
modify 647
sesslist
ppp relay sesslist 609
upgrade debug sesslist 705

E-DOC-CTC-20061027-0003 v2.0

Index

set
env set 247
firewall level set 363

service host stats 635
system debug stats 686
synchronize

settime
system rtc settime 689

system rtc synchronize 688
Syslog messages

show

Auto-PVC 736
Configuration 736
DHCP client 736
DHCP relay 737
DHCP server 737
Dyndns 738
Firewall 738
Kernel 739
Linestate 739
LOGIN 739
NAPT 739
PPP 740
PPTP 740
RIP 741
Routing 742
Session 742
SNTP 742
Software 743
UPnP 743

grp rip show 385
systemlog show 693
snmp
community
add 654
delete 655
list 656
modify 657
config 650
get 651
getnext 652
ifadd 658
ifattach 660
ifconfig 662
ifdelete 659
ifdetach 661
iflist 663
walk 653

system

sntp

config 676
debug
autosave 685
stats 686
flush 678
locale 679
ra
config 687
reboot 681
reset 682
rtc
settime 689
synchronize 688

add 666
config 667
delete 668
flush 669
list 670
software
upgrade 672
version 673
start
upgrade start 703
stats
connection stats 97
dhcp client debug stats 120
dhcp relay debug stats 131
dhcp server debug stats 152
dns server debug stats 193
dsd debug stats 215
firewall debug stats 356
firewall rule debug stats 372
ids pattern stats 403
igmp host debug stats 416
ip debug stats 470
ipqos ef stats 480
ipqos queue stats 485
label rule debug stats 510
mbus debug stats 522
memm stats 541
mlp debug stats 547

E-DOC-CTC-20061027-0003 v2.0

systemlog
flush 692
send 695
show 693

T
timerclear
connection timerclear 98
timerconfig
connection timerconfig 99
tmpladd
dhcp server option tmpladd 165

767

Index

nat tmpladd 576

update

tmpldelete
dhcp server option tmpldelete 166
nat tmpldelete 580

dns server debug spoof update 198
upgrade
config 702
debug
sesslist 705
traceconfig 704
profile
add 706
delete 708
modify 707
software upgrade 672
start 703

tmplinst
nat tmplinst 582
tmpllist
dhcp server option tmpllist 167
nat tmpllist 581
traceconfig
dhcp client debug traceconfig 121
dhcp relay debug traceconfig 132
dhcp rule debug traceconfig 144
dhcp server debug traceconfig 154
firewall debug traceconfig 357
firewall rule debug traceconfig 374
ip debug traceconfig 471
label rule debug traceconfig 511
mbus debug traceconfig 524
memm debug lock traceconfig 536
memm debug traceconfig 537
mlp debug traceconfig 548
upgrade debug traceconfig 704

upnp
config 718
flush 719
list 720
user
add 722
config 724
delete 726
flush 727
list 728
rights 730

traceroute
traceroute root command 5
triggerlist
service host triggerlist 636

V
version
software version 673

U
unbind
connection unbind 100
unloadobjects
mbus unloadobjects 531
unset

W
walk
snmp walk 653

env unset 248

768

E-DOC-CTC-20061027-0003 v2.0

THOMSON Telecom Belgium
Prins Boudewijnlaan 47
2650 Edegem

www.thomson-broadband.com
© THOMSON . All rights reserved.
E-DOC-CTC-20061027-0003 v2.0.

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.6
Linearized                      : Yes
Page Mode                       : UseOutlines
XMP Toolkit                     : 3.1-702
Producer                        : Acrobat Distiller 7.0.5 (Windows)
Creator Tool                    : FrameMaker 7.1
Modify Date                     : 2007:05:30 10:23:26+02:00
Create Date                     : 2007:05:11 10:12:49Z
Metadata Date                   : 2007:05:30 10:23:26+02:00
Format                          : application/pdf
Title                           : ST516-536-546_CLI_beyond62.book
Creator                         : lissensj
Document ID                     : uuid:68b1758e-8bcc-40ed-aa8b-a943a4dc52c6
Instance ID                     : uuid:3523a514-a856-481f-8376-6d12c36f91d9
Page Count                      : 792
Author                          : lissensj

EXIF Metadata provided by EXIF.tools

Technicolor Thomson Network Router St516 Users Manual 536 546_CLI_beyond62

Technicolor-Thomson-Network-Router-St516-Users-Manual-463464 technicolor-thomson-network-router-st516-users-manual-463464

ST546 to the manual 27d91a7a-62b9-4701-95ed-0944d64eaf1a

Navigation menu

Versions of this User Manual:

Views

Navigation