Alcatel-Lucent SPEEDTOUCH 546 User Manual 1

SpeedTouch™546

Residential ADSL Gateway

CLI Reference Guide

Release R5.3.1

SpeedTouch™

546

CLI Reference Guide

R5.3.1

Copyright

Copyright ©1999-2005 THOMSON. All rights reserved.

Passing on, and copying of this document, use and communication of its contents is not permitted without written authorization
from THOMSON. The content of this document is furnished for informational use only, may be subject to change without notice,
and should not be construed as a commitment by THOMSON. THOMSON assumes no responsibility or liability for any errors or
inaccuracies that may appear in this document.

Thomson Telecom Belgium
Prins Boudewijnlaan, 47
B-2650 Edegem
Belgium

www.speedtouch.com

Trademarks

The following trademarks are used in this document:

 SpeedTouch™ is a trademark of THOMSON.
 Microsoft®, MS-DOS®, Windows® and Windows NT® are either registered trademarks or trademarks of Microsoft Corpo-

ration in the United States and/or other countries.

 UNIX® is a registered trademark of UNIX System Laboratories, Incorporated.
 Apple® and Mac OS® are registered trademarks of Apple Computer, Incorporated, registered in the United States and

other countries.

 Adobe, the Adobe logo, Acrobat and Acrobat Reader are trademarks or registered trademarks of Adobe Systems, Incorpo-

rated, registered in the United States and/or other countries.

 Netscape® and Netscape Navigator® are registered trademarks of Netscape Communications Corporation.
 Ethernet™ is a trademark of Xerox Corporation.
 UPnP™ is a certification mark of the UPnP™ Implementers Corporation.
 Wi-Fi® and the Wi-Fi logo are registered trademarks of the Wi-Fi Alliance. "Wi-Fi CERTIFIED", "Wi-Fi ZONE", "Wi-Fi Alli-

ance", their respective logos and "Wi-Fi Protected Access" are trademarks of the Wi-Fi Alliance.

Other products may be trademarks or registered trademarks of their respective manufacturers.

Document Information

Status: v1.0 (June 2005)
Reference: E-DOC-CTC-20050531-0055
Short Title: CLI Reference Guide ST546 R5.3.1

Contents

Contents

About this Document ....................................................................................1

ADSL Commands........................................................................................... 3

adsl config.....................................................................................................................................................4

adsl info.........................................................................................................................................................5

ATM Commands ............................................................................................ 7

atm flush ....................................................................................................................................................... 9

atm ifadd..................................................................................................................................................... 10

atm ifattach................................................................................................................................................. 11

atm ifconfig.................................................................................................................................................12

atm ifdelete.................................................................................................................................................14

atm ifdetach................................................................................................................................................15

atm iflist ...................................................................................................................................................... 16

atm bundle add ..........................................................................................................................................17

atm bundle attach ......................................................................................................................................18

atm bundle config ...................................................................................................................................... 19

atm bundle clear.........................................................................................................................................20

atm bundle delete ......................................................................................................................................21

atm bundle detach .....................................................................................................................................22

atm bundle flush ........................................................................................................................................23

atm bundle ifadd ........................................................................................................................................24

atm bundle ifconfig....................................................................................................................................25

atm bundle ifdelete .................................................................................................................................... 26

atm bundle list............................................................................................................................................27

atm cac config ............................................................................................................................................28

atm cac list..................................................................................................................................................29

atm cac overbooking.................................................................................................................................. 30

atm debug aal5stats................................................................................................................................... 31

atm debug gstats........................................................................................................................................ 32

atm debug portstats................................................................................................................................... 33

atm oam config ..........................................................................................................................................34

atm oam list................................................................................................................................................ 35

atm oam modify.........................................................................................................................................36

atm oam ping ............................................................................................................................................. 37

atm oam cc list ...........................................................................................................................................38

atm oam cc modify ....................................................................................................................................39

atm oam cc send ........................................................................................................................................40

E-DOC-CTC-20050531-0055 v1.0

i

Contents

atm oam vclb add....................................................................................................................................... 41

atm oam vclb del........................................................................................................................................42

atm oam vclb list........................................................................................................................................ 43

atm phonebook add...................................................................................................................................44

atm phonebook autolist.............................................................................................................................45

atm phonebook delete...............................................................................................................................46

atm phonebook flush.................................................................................................................................47

atm phonebook list ....................................................................................................................................48

atm qosbook add........................................................................................................................................ 49

atm qosbook config ...................................................................................................................................50

atm qosbook ctdadd ..................................................................................................................................51

atm qosbook ctddelete ..............................................................................................................................53

atm qosbook ctdlist....................................................................................................................................54

atm qosbook delete.................................................................................................................................... 55

atm qosbook flush...................................................................................................................................... 56

atm qosbook list.........................................................................................................................................57

AutoPVC Commands................................................................................... 59

autopvc config............................................................................................................................................60

autopvc list..................................................................................................................................................61

Config Commands .......................................................................................63

config delete ...............................................................................................................................................64

config dump................................................................................................................................................65

config flush .................................................................................................................................................66

config list.....................................................................................................................................................67

config load .................................................................................................................................................. 68

config save..................................................................................................................................................69

Connection Commands............................................................................... 71

connection appconfig ................................................................................................................................72

connection appinfo .................................................................................................................................... 74

connection applist...................................................................................................................................... 75

connection bind..........................................................................................................................................76

connection bindlist.....................................................................................................................................77

connection clean ........................................................................................................................................ 78

connection clear ......................................................................................................................................... 79

connection config.......................................................................................................................................80

connection debug....................................................................................................................................... 81

connection describe...................................................................................................................................82

ii

E-DOC-CTC-20050531-0055 v1.0

Contents

connection flush.........................................................................................................................................83

connection info...........................................................................................................................................84

connection list ............................................................................................................................................ 85

connection refresh .....................................................................................................................................86

connection stats ......................................................................................................................................... 87

connection timerclear ................................................................................................................................ 88

connection timerconfig.............................................................................................................................. 89

connection unbind .....................................................................................................................................90

CWMP Commands....................................................................................... 91

cwmp config ............................................................................................................................................... 92

cwmp traceconfig.......................................................................................................................................94

cwmp server config.................................................................................................................................... 95

Debug Commands ....................................................................................... 97

debug exec.................................................................................................................................................. 98

DHCP Commands......................................................................................... 99

dhcp client flush ....................................................................................................................................... 101

dhcp client ifadd.......................................................................................................................................102

dhcp client ifattach...................................................................................................................................103

dhcp client ifconfig...................................................................................................................................104

dhcp client ifdelete...................................................................................................................................106

dhcp client iflist ........................................................................................................................................107

dhcp client ifrelease ................................................................................................................................. 108

dhcp client ifrenew...................................................................................................................................110

dhcp client debug clear............................................................................................................................112

dhcp client debug stats............................................................................................................................ 113

dhcp client debug traceconfig.................................................................................................................114

dhcp relay add..........................................................................................................................................115

dhcp relay config......................................................................................................................................116

dhcp relay delete......................................................................................................................................117

dhcp relay flush........................................................................................................................................118

dhcp relay ifconfig.................................................................................................................................... 119

dhcp relay iflist ......................................................................................................................................... 120

dhcp relay list ...........................................................................................................................................121

dhcp relay debug stats.............................................................................................................................122

dhcp relay debug traceconfig..................................................................................................................123

dhcp server config.................................................................................................................................... 124

dhcp server flush......................................................................................................................................125

E-DOC-CTC-20050531-0055 v1.0

iii

Contents

dhcp server policy....................................................................................................................................126

dhcp server debug clear ..........................................................................................................................127

dhcp server debug stats ..........................................................................................................................128

dhcp server debug traceconfig ............................................................................................................... 130

dhcp server lease add.............................................................................................................................. 131

dhcp server lease delete.......................................................................................................................... 133

dhcp server lease flush............................................................................................................................ 134

dhcp server lease list ............................................................................................................................... 135

dhcp server option flush.......................................................................................................................... 136

dhcp server option instadd......................................................................................................................137

dhcp server option instdelete..................................................................................................................138

dhcp server option instlist....................................................................................................................... 139

dhcp server option tmpladd....................................................................................................................140

dhcp server option tmpldelete................................................................................................................ 141

dhcp server option tmpllist ..................................................................................................................... 142

dhcp server pool add ...............................................................................................................................143

dhcp server pool config...........................................................................................................................144

dhcp server pool delete ...........................................................................................................................146

dhcp server pool flush .............................................................................................................................147

dhcp server pool list................................................................................................................................. 148

dhcp server pool optadd.......................................................................................................................... 149

dhcp server pool optdelete......................................................................................................................150

dhcp server pool rtadd.............................................................................................................................151

dhcp server pool rtdelete.........................................................................................................................152

dhcp server pool ruleadd.........................................................................................................................153

dhcp server pool ruledelete.....................................................................................................................154

dhcp server rule add ................................................................................................................................ 155

dhcp server rule delete ............................................................................................................................ 156

dhcp server rule flush .............................................................................................................................. 157

dhcp server rule list.................................................................................................................................. 158

DNS Commands......................................................................................... 159

dns client config ....................................................................................................................................... 160

dns client dnsadd ..................................................................................................................................... 161

dns client dnsdelete ................................................................................................................................. 162

dns client dnslist....................................................................................................................................... 163

dns client flush .........................................................................................................................................164

dns client nslookup ..................................................................................................................................165

dns server config...................................................................................................................................... 166

dns server flush........................................................................................................................................167

dns server debug clear ............................................................................................................................ 168

iv

E-DOC-CTC-20050531-0055 v1.0

Contents

dns server debug stats.............................................................................................................................169

dns server debug spoof clear..................................................................................................................170

dns server debug spoof getaddress ....................................................................................................... 171

dns server debug spoof getflags ............................................................................................................ 172

dns server debug spoof list..................................................................................................................... 173

dns server debug spoof update ..............................................................................................................174

dns server host add.................................................................................................................................. 175

dns server host delete..............................................................................................................................176

dns server host flush................................................................................................................................ 177

dns server host list...................................................................................................................................178

dns server route add................................................................................................................................ 179

dns server route delete............................................................................................................................ 180

dns server route flush.............................................................................................................................. 181

dns server route list .................................................................................................................................182

DSD Commands......................................................................................... 183

dsd config ................................................................................................................................................. 185

dsd debug connection list .......................................................................................................................186

dsd debug proxy ......................................................................................................................................187

dsd debug recycling................................................................................................................................. 188

dsd debug stats ........................................................................................................................................ 189

dsd intercept config .................................................................................................................................190

dsd intercept stats....................................................................................................................................192

dsd syslog config .....................................................................................................................................193

dsd syslog list...........................................................................................................................................194

dsd urlfilter config....................................................................................................................................195

dsd urlfilter rule add.................................................................................................................................196

dsd urlfilter rule delete.............................................................................................................................197

dsd urlfilter rule flush............................................................................................................................... 198

dsd urlfilter rule list..................................................................................................................................199

dsd urlfilter rule modify........................................................................................................................... 200

dsd webfilter cache flush......................................................................................................................... 201

dsd webfilter cache stats .........................................................................................................................202

dsd webfilter config .................................................................................................................................203

dsd webfilter list.......................................................................................................................................204

dsd webfilter professional category add................................................................................................205

dsd webfilter professional category create ............................................................................................ 206

dsd webfilter professional category delete ............................................................................................ 207

dsd webfilter professional category flush..............................................................................................208

dsd webfilter professional category list................................................................................................. 209

dsd webfilter professional category remove......................................................................................... 210

E-DOC-CTC-20050531-0055 v1.0

v

Contents

dsd webfilter professional config ........................................................................................................... 211

dsd webfilter professional level add.......................................................................................................212

dsd webfilter professional level delete................................................................................................... 213

dsd webfilter professional level flush.....................................................................................................214

dsd webfilter professional level list........................................................................................................ 215

dsd webfilter professional level modify................................................................................................. 216

dsd webfilter professional level set........................................................................................................ 217

dsd webfilter professional rule clear ...................................................................................................... 218

dsd webfilter professional rule list ......................................................................................................... 219

dsd webfilter professional modify.......................................................................................................... 220

dsd webfilter server add.......................................................................................................................... 221

dsd webfilter server config......................................................................................................................222

dsd webfilter server delete...................................................................................................................... 223

dsd webfilter server flush........................................................................................................................ 224

dsd webfilter server list ........................................................................................................................... 225

dsd webfilter server modify .................................................................................................................... 226

dsd webfilter standard category add......................................................................................................227

dsd webfilter standard category create..................................................................................................228

dsd webfilter standard category delete..................................................................................................229

dsd webfilter standard category flush....................................................................................................230

dsd webfilter standard category list ....................................................................................................... 231

dsd webfilter standard category remove ............................................................................................... 232

dsd webfilter standard level add.............................................................................................................233

dsd webfilter standard level delete.........................................................................................................234

dsd webfilter standard level flush........................................................................................................... 235

dsd webfilter standard level list..............................................................................................................236

dsd webfilter standard level modify....................................................................................................... 237

dsd webfilter standard level set...............................................................................................

dsd webfilter standard rule clear ............................................................................................................ 239

dsd webfilter standard rule list ............................................................................................................... 240

dsd webfilter standard rule modify ........................................................................................................ 241

............... 238

DynDNS Commands.................................................................................. 243

dyndns add ...............................................................................................................................................244

dyndns delete ........................................................................................................................................... 245

dyndns flush ............................................................................................................................................. 246

dyndns list.................................................................................................................................................247

dyndns modify..........................................................................................................................................248

dyndns host add.......................................................................................................................................250

dyndns host delete...................................................................................................................................251

dyndns host flush.....................................................................................................................................252

vi

E-DOC-CTC-20050531-0055 v1.0

Contents

dyndns host list ........................................................................................................................................ 253

dyndns service list.................................................................................................................................... 254

dyndns service modify............................................................................................................................. 255

Env Commands .......................................................................................... 257

env flush....................................................................................................................................................258

env get.......................................................................................................................................................259

env list....................................................................................................................................................... 260

env set....................................................................................................................................................... 261

env unset...................................................................................................................................................262

Eth Commands........................................................................................... 263

eth ifadd ....................................................................................................................................................264

eth ifattach ................................................................................................................................................265

eth ifconfig................................................................................................................................................ 266

eth ifdelete ................................................................................................................................................267

eth ifdetach ...............................................................................................................................................268

eth iflist......................................................................................................................................................269

eth flush .................................................................................................................................................... 270

eth bridge clear......................................................................................................................................... 271

eth bridge config ...................................................................................................................................... 272

eth bridge flush ........................................................................................................................................273

eth bridge ifadd ........................................................................................................................................ 274

eth bridge ifattach .................................................................................................................................... 275

eth bridge ifconfig....................................................................................................................................276

eth bridge ifdelete .................................................................................................................................... 278

eth bridge ifdetach ...................................................................................................................................279

eth bridge iflist..........................................................................................................................................280

eth bridge macadd ................................................................................................................................... 281

eth bridge macdelete ............................................................................................................................... 282

eth bridge maclist..................................................................................................................................... 283

eth bridge mcdadd...................................................................................................................................284

eth bridge mcddelete...............................................................................................................................285

eth bridge mcdlist ....................................................................................................................................286

eth device ifconfig....................................................................................................................................287

eth device iflist..........................................................................................................................................288

eth switch group flush ............................................................................................................................. 289

eth switch group list................................................................................................................................. 290

eth switch group move............................................................................................................................ 291

eth switch mirror capture ........................................................................................................................292

E-DOC-CTC-20050531-0055 v1.0

vii

Contents

Expr Commands......................................................................................... 295

Firewall Commands................................................................................... 307

eth switch mirror egress.......................................................................................................................... 293

eth switch mirror ingress.........................................................................................................................294

expr add ....................................................................................................................................................296

expr delete ................................................................................................................................................299

expr flush ..................................................................................................................................................300

expr list......................................................................................................................................................301

expr modify...............................................................................................................................................304

firewall config........................................................................................................................................... 308

firewall clear .............................................................................................................................................310

firewall list.................................................................................................................................................311

firewall chain add.....................................................................................................................................312

firewall chain delete.................................................................................................................................313

firewall chain flush...................................................................................................................................314

firewall chain list ......................................................................................................................................315

firewall debug clear.................................................................................................................................. 316

firewall debug stats..................................................................................................................................317

firewall debug traceconfig....................................................................................................................... 318

firewall level add ...................................................................................................................................... 319

firewall level delete .................................................................................................................................. 320

firewall level flush .................................................................................................................................... 321

firewall level list........................................................................................................................................322

firewall level modify................................................................................................................................. 323

firewall level set........................................................................................................................................324

firewall rule add........................................................................................................................................ 325

firewall rule delete.................................................................................................................................... 327

firewall rule flush......................................................................................................................................328

firewall rule list.........................................................................................................................................329

firewall rule modify..................................................................................................................................331

firewall rule debug clear..........................................................................................................................332

firewall rule debug stats ..........................................................................................................................334

firewall rule debug traceconfig...............................................................................................................335

GRP Commands ......................................................................................... 337

grp config..................................................................................................................................................338

grp flush.................................................................................................................................................... 339

grp rtlist.....................................................................................................................................................340

viii

E-DOC-CTC-20050531-0055 v1.0

Contents

grp rip config ............................................................................................................................................ 341

grp rip flush ..............................................................................................................................................343

grp rip ifconfig..........................................................................................................................................344

grp rip show..............................................................................................................................................346

Hostmgr Commands .................................................................................347

hostmgr add ............................................................................................................................................. 348

hostmgr clear............................................................................................................................................ 350

hostmgr config ......................................................................................................................................... 351

hostmgr delete .........................................................................................................................................352

hostmgr flush ........................................................................................................................................... 353

hostmgr list...............................................................................................................................................354

IDS Commands .......................................................................................... 355

ids clear.....................................................................................................................................................356

ids config...................................................................................................................................................357

ids parser list ............................................................................................................................................358

ids parser modify .....................................................................................................................................359

ids pattern clear........................................................................................................................................ 360

ids pattern list...........................................................................................................................................361

ids pattern stats........................................................................................................................................362

ids signature list ....................................................................................................................................... 363

ids signature modify ................................................................................................................................ 364

ids threshold clear.................................................................................................................................... 365

ids threshold list.......................................................................................................................................366

ids threshold modify................................................................................................................................367

Interface Commands ................................................................................. 369

interface list ..............................................................................................................................................370

IP Commands .............................................................................................371

ip arpadd................................................................................................................................................... 373

ip arpdelete............................................................................................................................................... 374

ip arplist .................................................................................................................................................... 375

ip config .................................................................................................................................................... 376

ip flush.......................................................................................................................................................378

ip ifadd ...................................................................................................................................................... 379

ip ifattach ..................................................................................................................................................380

ip ifconfig ..................................................................................................................................................381

ip ifdelete .................................................................................................................................................. 383

E-DOC-CTC-20050531-0055 v1.0

ix

Contents

ip ifdetach ................................................................................................................................................. 384

ip iflist........................................................................................................................................................ 385

ip ifwait......................................................................................................................................................386

ip ipadd ..................................................................................................................................................... 387

ip ipconfig .................................................................................................................................................388

ip ipdelete ................................................................................................................................................. 389

ip iplist.......................................................................................................................................................390

ip mcadd ................................................................................................................................................... 391

ip mcdelete ............................................................................................................................................... 392

ip mclist.....................................................................................................................................................393

ip rtadd...................................................................................................................................................... 394

ip rtdelete.................................................................................................................................................. 395

ip rtlist ....................................................................................................................................................... 396

ip auto flush.............................................................................................................................................. 397

ip auto ifadd..............................................................................................................................................398

ip auto ifattach..........................................................................................................................................399

ip auto ifconfig.......................................................................................................................................... 400

ip auto ifdelete..........................................................................................................................................402

ip auto ifdetach.........................................................................................................................................403

ip auto iflist ...............................................................................................................................................404

ip debug httpprobe ..................................................................................................................................405

ip debug ping............................................................................................................................................ 406

ip debug sendto........................................................................................................................................ 407

ip debug stats ...........................................................................................................................................409

ip debug traceconfig ................................................................................................................................ 410

ip debug traceroute.................................................................................................................................. 411

IPQoS Commands...................................................................................... 413

ipqos config ..............................................................................................................................................414

ipqos list....................................................................................................................................................416

ipqos ef config..........................................................................................................................................417

ipqos ef list................................................................................................................................................418

ipqos ef stats.............................................................................................................................................419

ipqos queue clear.....................................................................................................................................420

ipqos queue config................................................................................................................................... 421

ipqos queue list ........................................................................................................................................ 423

ipqos queue stats .....................................................................................................................................424

Label Commands .......................................................................................425

label add....................................................................................................................................................426

x

E-DOC-CTC-20050531-0055 v1.0

Contents

label delete................................................................................................................................................427

label flush..................................................................................................................................................428

label list..................................................................................................................................................... 429

label modify.............................................................................................................................................. 430

label chain add .........................................................................................................................................432

label chain delete .....................................................................................................................................433

label chain flush .......................................................................................................................................434

label chain list...........................................................................................................................................435

label rule add............................................................................................................................................ 436

label rule delete........................................................................................................................................438

label rule flush.......................................................................................................................................... 439

label rule list .............................................................................................................................................440

label rule modify ......................................................................................................................................441

label rule debug clear .............................................................................................................................. 442

label rule debug stats............................................................................................................................... 443

label rule debug traceconfig....................................................................................................................444

Language Commands................................................................................ 445

language config........................................................................................................................................446

language delete........................................................................................................................................ 447

language list .............................................................................................................................................448

MLP Commands ........................................................................................ 449

mlp flush ...................................................................................................................................................450

mlp import ................................................................................................................................................ 451

mlp debug export.....................................................................................................................................452

mlp debug stats........................................................................................................................................453

mlp debug traceconfig............................................................................................................................. 454

mlp privilege add .....................................................................................................................................455

mlp privilege addzone .............................................................................................................................456

mlp privilege config ................................................................................................................................. 457

mlp privilege delete .................................................................................................................................458

mlp privilege list.......................................................................................................................................459

mlp privilege removezone....................................................................................................................... 460

mlp role add..............................................................................................................................................461

mlp role addpriv.......................................................................................................................................462

mlp role config ......................................................................................................................................... 463

mlp role delete..........................................................................................................................................464

mlp role list............................................................................................................................................... 465

mlp role removepriv ................................................................................................................................466

E-DOC-CTC-20050531-0055 v1.0

xi

Contents

NAT Commands......................................................................................... 467

PPP Commands.......................................................................................... 483

nat config ..................................................................................................................................................468

nat flush .................................................................................................................................................... 469

nat ifconfig................................................................................................................................................ 470

nat iflist......................................................................................................................................................471

nat mapadd...............................................................................................................................................472

nat mapdelete...........................................................................................................................................475

nat maplist ................................................................................................................................................476

nat tmpladd...............................................................................................................................................477

nat tmpldelete........................................................................................................................................... 480

nat tmpllist................................................................................................................................................ 481

nat tmplinst............................................................................................................................................... 482

ppp flush ...................................................................................................................................................484

ppp ifadd................................................................................................................................................... 485

ppp ifattach............................................................................................................................................... 486

ppp ifconfig............................................................................................................................................... 487

ppp ifdelete............................................................................................................................................... 491

ppp ifdetach.............................................................................................................................................. 492

ppp iflist .................................................................................................................................................... 493

ppp ifscan..................................................................................................................................................494

ppp rtadd...................................................................................................................................................495

ppp rtdelete...............................................................................................................................................497

ppp relay flush..........................................................................................................................................498

ppp relay ifadd..........................................................................................................................................499

ppp relay ifdelete......................................................................................................................................500

ppp relay iflist........................................................................................................................................... 501

ppp relay sesslist......................................................................................................................................502

PPTP Commands........................................................................................ 503

pptp ifadd..................................................................................................................................................504

pptp flush.................................................................................................................................................. 505

pptp list ..................................................................................................................................................... 506

pptp profadd.............................................................................................................................................507

pptp profdelete.........................................................................................................................................508

pptp proflist ..............................................................................................................................................509

Service Commands.................................................................................... 511

service host assign...................................................................................................................................512

xii

E-DOC-CTC-20050531-0055 v1.0

Contents

service host config ...................................................................................................................................513

service host add .......................................................................................................................................514

service host delete ...................................................................................................................................515

service host disable.................................................................................................................................. 516

service host flush .....................................................................................................................................517

service host list.........................................................................................................................................518

service host stats...................................................................................................................................... 519

service host triggerlist .............................................................................................................................520

service host rule add................................................................................................................................ 521

service host rule delete............................................................................................................................ 522

service system ifadd ................................................................................................................................523

service system ifdelete ............................................................................................................................524

service system ipadd ............................................................................................................................... 525

service system ipdelete ...........................................................................................................................526

service system list.................................................................................................................................... 527

service system mapadd........................................................................................................................... 528

service system mapdelete....................................................................................................................... 529

service system modify............................................................................................................................. 530

Script Commands ...................................................................................... 531

script add ..................................................................................................................................................532

script delete .............................................................................................................................................. 533

script flush ................................................................................................................................................ 534

script list....................................................................................................................................................535

script run................................................................................................................................................... 536

SNMP Commands...................................................................................... 537

snmp config.............................................................................................................................................. 538

snmp get ...................................................................................................................................................539

snmp getnext............................................................................................................................................540

snmp walk.................................................................................................................................................541

snmp community add..............................................................................................................................542

snmp community delete.......................................................................................................................... 543

snmp community list ............................................................................................................................... 544

snmp community modify........................................................................................................................ 545

SNTP Commands....................................................................................... 547

sntp add .................................................................................................................................................... 548

sntp config ................................................................................................................................................ 549

sntp delete ................................................................................................................................................ 550

E-DOC-CTC-20050531-0055 v1.0

xiii

Contents

Software Commands................................................................................. 553

System Commands ................................................................................... 561

sntp flush .................................................................................................................................................. 551

sntp list......................................................................................................................................................552

software cleanup......................................................................................................................................554

software deletepassive ............................................................................................................................ 555

software duplicate....................................................................................................................................556

software setpassive.................................................................................................................................. 557

software switch ........................................................................................................................................ 558

software upgrade ..................................................................................................................................... 559

software version.......................................................................................................................................560

system config ........................................................................................................................................... 562

system flush.............................................................................................................................................. 564

system locale............................................................................................................................................565

system reboot...........................................................................................................................................567

system reset..............................................................................................................................................568

system debug autosave........................................................................................................................... 569

system debug stats .................................................................................................................................. 570

system ra config.......................................................................................................................................571

system rtc synchronize ............................................................................................................................572

system rtc settime....................................................................................................................................573

Systemlog Commands .............................................................................. 575

systemlog flush ........................................................................................................................................ 576

systemlog show .......................................................................................................................................577

systemlog send ........................................................................................................................................578

UPnP Commands ....................................................................................... 579

upnp config...............................................................................................................................................580

upnp flush................................................................................................................................................. 581

upnp list .................................................................................................................................................... 582

User Commands ........................................................................................ 583

user add .................................................................................................................................................... 584

user config ................................................................................................................................................586

user delete ................................................................................................................................................ 587

user flush .................................................................................................................................................. 588

user list......................................................................................................................................................589

xiv

E-DOC-CTC-20050531-0055 v1.0

Contents

user rights.................................................................................................................................................591

Abbreviations ............................................................................................. 593

System Logging Messages ....................................................................... 597

Auto-PVC Module..................................................................................................................................... 598

Configuration Module..............................................................................................................................598

DHCP Client Module................................................................................................................................. 598

DHCP Relay Module.................................................................................................................................599

DHCP Server Module ............................................................................................................................... 599

Dyndns Module ........................................................................................................................................ 600

Firewall Module........................................................................................................................................600

LOGIN Module..........................................................................................................................................601

Kernel Module ..........................................................................................................................................601

Linestate Module......................................................................................................................................601

NAPT Module ...........................................................................................................................................601

PPP Module...............................................................................................................................................602

PPTP Module ............................................................................................................................................ 602

RIP Module................................................................................................................................................603

Routing Module........................................................................................................................................604

Session Module........................................................................................................................................604

SNTP Module............................................................................................................................................604

Software Module......................................................................................................................................605

UPnP Module............................................................................................................................................605

...................................................................................................................................................................605

Supported Key Names .............................................................................. 607

Supported IP Protocols............................................................................................................................ 608

Supported TCP/UDP Port Names............................................................................................................ 609

Supported ICMP Type Names.................................................................................................................612

Supported Facilities ................................................................................................................................613

Supported Severities .............................................................................................................................. 614

IP Precedence ........................................................................................................................................... 614

Differentiated Services Code Point (DSCP)............................................................................................615

E-DOC-CTC-20050531-0055 v1.0

xv

Contents

xvi

E-DOC-CTC-20050531-0055 v1.0

About this Document

About this Document

Introduction

Welcome to the SpeedTouch™ Command Line Interface (CLI) Reference Guide!

For the Service Provider, this Reference Guide aims to be a concise and practical document for creating a
customized Service Template file, based on the SpeedTouch™ CLI command set, to be used by the end user to
configure the SpeedTouch™ and computer(s).

For the fastidious user, this Reference Guide aims to be a handbook for advanced and detailed configuration and
troubleshooting of the SpeedTouch™ via its character based CLI command set.

Applicability

This CLI Reference Guide covers the CLI commands of the following Digital Subscriber Line (DSL) SpeedTouch™
products:

SpeedTouch™546(i) Multi-User ADSL Gateway (R5.3.1)For readability, all are referred to as SpeedTouch™
throughout this document unless a specific variant is concerned.

Contents

The CLI Reference Guide describes all the available CLI commands of the SpeedTouch™ per command group and
in alphabetical order.

Each command is described in a systematic manner:

 The full name of the CLI command (including the group selection).

 A short description of the CLI command, if necessary completed by a description of the possible impact on

the user and/or the SpeedTouch™.

 The syntax of the command with a description of each parameter.

 An example to demonstrate the use of the CLI command.

 A list of related CLI commands.

Other Information

For more information on the SpeedTouch™ CLI, various access methods, general manipilations to navigate
through the CLI refer to the SpeedTouch™546 User’s Guide.

For a description on the functional use of the CLI commands see the corresponding SpeedTouch™ configuration
guides and application notes.

E-DOC-CTC-20050531-0055 v1.0

1

About this Document

Trademarks

The following trademarks are used in this document:

 SpeedTouch™ is a trademark of THOMSON.

 Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.

 Windows and Internet Explorer are trademarks of Microsoft Corporation.

 Apple and MacOS are registered trademarks of Apple Computer Inc.

 UNIX is a registered trademark of UNIX System Laboratories, Inc.

 Ethernet is a trademark of Xerox Corporation.

Other products may be trademarks or registered trademarks of their respective manufacturers.

Symbols

The following symbols are used in this CLI Reference Guide:

A note provides additional information about a topic.

A tip provides an alternative method or shortcut to perform an action.

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

!

Conventions

The following conventions are used to present the CLI commands:

 Vertical bars (|) separate alternative, mutually exclusive, elements.

 Square brackets [] indicate optional elements.

 Braces {} indicate a required choice.

 Braces within square brackets [{}] indicate a required choice within an optional element.

 <string> indicates that an alphanumerical string without blanks must be used.

 <quoted string> indicates that an alphanumerical string with blanks can be used. The string must be

enclosed in quotes “.

Documentation and software updates

THOMSON continuously develops new solutions, but is also committed to improve its existing products.

For suggestions regarding this document, please contact [e-mail]

For more information on THOMSON's latest technological innovations, documents and software releases, visit us
at:

www.speedtouch.com

.

2

E-DOC-CTC-20050531-0055 v1.0

ADSL Commands

ADSL Commands

Introduction

This chapter describes the commands of the adsl command group.

Contents

This chapter covers the following commands:

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

adsl info Display the ADSL statistics and information about the DSL line status. 5

E-DOC-CTC-20050531-0055 v1.0

3

ADSL Commands

adsl config

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

SYNTAX:

adsl config [opermode = <{multimode | multi_adsl2 | multi_readsl2

where:

| multi_adsl2plus}>]

[trace = <{disabled | enabled}>]

opermode The operational mode of the SpeedTouch™.

Choose between:

 multimode

 multi_adsl2

 multi_readsl2

 multi_adsl2plus

The default is multi_adsl2plus.

trace Enable or disable ADSL tracing.

The default is enabled.

EXAMPLE:

The example below shows the default configuration for a SpeedTouch™ 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
=>

OPTIONAL

OPTIONAL

4

E-DOC-CTC-20050531-0055 v1.0

ADSL Commands

adsl info

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

Although the same command is used for both SpeedTouch™ ADSL/POTS and SpeedTouch™ ADSL/ISDN variants,
the command features specific output parameters and counters per variant.

SYNTAX:

adsl info

EXAMPLE (for a SpeedTouch™ ADSL/POTS variant):

=>adsl info
Modemstate : up
Operation Mode : G.992.1 Annex A
Channel Mode : interleaved
Number of resets : 1

Vendor Local Remote

Country : 0f 00
Vendor : TMMB
VendorSpecific : 0000 0000
StandardRevisionNr : 00 00

Margin [dB] : 26.0 18.0
Attenuation [dB] : 0.0 2.0
OutputPower [dBm] : 4.0 11.5

Available Bandwidth Cells/s Kbit/s

Downstream : 14490 6144
Upstream : 1509 640

Transfer statistics

Errors

Received FEC : 0
Received CRC : 0
Received HEC : 0
Transmitted FEC : 0
Transmitted CRC : 0
Tranmsitted HEC : 0

Near end failures since reset

Loss of frame: 0 failures
Loss of signal: 0 failures
Loss of power: 0 failures
Errored seconds: 0 seconds

Near end failures last 15 minutes

Loss of frame: 0 seconds
Loss of signal: 0 seconds
Loss of power: 0 seconds
Errored seconds: 0 seconds

Near end failures current day

Errored seconds: 0 seconds

Near end failures previous day

Errored seconds: 0 seconds

=>

Downstream Upstream

E-DOC-CTC-20050531-0055 v1.0

5

ADSL Commands

6

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

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

atm ifadd Create a new ATM interface. 10

atm ifattach Attach a ATM interface. 11

atm ifconfig Configure an ATM interface. 12

atm ifdelete Delete an ATM interface. 14

atm ifdetach Detach an ATM interface. 15

atm iflist Display the ATM interfaces. 16

atm bundle add Add a new bundle of interfaces. 17

atm bundle attach Attach a bundle of interfaces. 18

atm bundle config Modify a bundle of interfaces. 19

atm bundle clear Clear the bundle statistics. 20

atm bundle delete Delete a bundle of interfaces. 21

atm bundle detach Detach a bundle of interfaces. 22

atm bundle flush Flush all bundles. 23

atm bundle ifadd Add an interface on a bundle. 24

atm bundle ifconfig Configure an interface from a bundle. 25

atm bundle ifdelete Remove an interface from a bundle. 26

atm bundle list Display the current bundles. 27

atm cac config Configure the ATM connection admission control. 28

atm cac list Display all the CAC parameters. 29

atm cac overbooking Configure ATM overbooking parameters. 30

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

atm debug gstats Display ATM global statistics. 32

atm debug portstats Display port specific ATM statistics. 33

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

atm oam list Display the ATM OAM settings. 35

atm oam modify Modify the ATM OAM data blocking mode. 36

atm oam ping Send ATM loopback cells. 37

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

atm oam cc modify Modify CC on the connection. 39

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

E-DOC-CTC-20050531-0055 v1.0

7

ATM Commands

atm oam vclb add Create a loopback connection for VC. 41

atm oam vclb del Delete a loopback connection for VC. 42

atm oam vclb list List all VC loopback connections. 43

atm phonebook add Add a new phonebook entry. 44

atm phonebook autolist Show the auto PVCs. 45

atm phonebook delete Delete an existing phonebook entry. 46

atm phonebook flush Flush all the phonebook entries. 47

atm phonebook list Display the current phonebook. 48

atm qosbook add Add a new QoS book entry. 49

atm qosbook config Modify the QoS book configuration. 50

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

atm qosbook ctddelete Delete a CTD. 53

atm qosbook ctdlist Display all CTDs. 54

atm qosbook delete Delete a QoS book entry. 55

atm qosbook flush Flush all the QoS book entries. 56

atm qosbook list Display the QoS book. 57

8

E-DOC-CTC-20050531-0055 v1.0

atm flush

Flush all Asynchronous Transfer Mode (ATM) interfaces.

SYNTAX:

atm flush

ATM Commands

E-DOC-CTC-20050531-0055 v1.0

9

ATM Commands

atm ifadd

Create a new ATM interface.

SYNTAX:

atm ifadd intf = <string>

where:

intf The name for the new ATM interface.

Note If not specified, the destination parameter must be specified. In this case the

name of the destination will double as interface name.

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:

REQUIRED

atm ifdelete Delete an ATM interface.

atm iflist Display the ATM interfaces.

10

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm ifattach

Attach a ATM interface.

SYNTAX:

atm ifattach intf = <string>

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

=>atm ifattach intf=RtPPPoA_atm
=>
=>atm iflist
atm_0_35 : dest : atm_pvc_0_35

RtPPPoA_atm: dest : RtPPPoA

=>

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : not-connected

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected

RELATED COMMANDS:

atm ifdetach Detach an ATM interface.

E-DOC-CTC-20050531-0055 v1.0

11

ATM Commands

atm ifconfig

Configure an ATM interface.

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 = <string>

where:

[dest = <string>]
[qos = <string>]
[encaps = <{llc | vcmux}>]
[retry = <number{0-65535}>]
[fcs = <{disabled | enabled | auto}>]
[ulp = <{ip | mac | ppp}>]

intf The name of the ATM interface to be configured. REQUIRED

dest The WAN destination for this ATM interface.

Typically, an ATM phonebook entry.

qos The name of the Quality of Service (QoS) book entry to apply on this ATM interface.

The default is default.

encaps The type of encapsulation to be used for this ATM interface.

Choose between:

OPTIONAL

OPTIONAL

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.

OPTIONAL

Note This parameter is normally left disabled.

retry A number between 0 and 65535.

Represents the number of times the SpeedTouch™ retries to set up a WAN connection
before giving up.
The default is 10.

ulp Select the Upper Layer Protocol (ULP) for this interface.

Choose between:

OPTIONAL

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.

12

E-DOC-CTC-20050531-0055 v1.0

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 Commands

atm_8_35 : dest : atm_pvc_8_35

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

atm_8_35 : dest : RtPPPoA

=>

Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : mac
Connection State : not-connected

Retry : 10 QoS : default Encaps : llc Fcs : disabled Ulp : mac
Connection State : connected

Retry : 10 QoS : default Encaps : vcmux Fcs : disabled Ulp : ppp
Connection State : not-connected

E-DOC-CTC-20050531-0055 v1.0

13

ATM Commands

atm ifdelete

Delete an ATM interface.

SYNTAX:

atm ifdelete intf = <string>

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

=>
=>atm ifdelete intf=RtPPPoA_atm
=>
=>atm iflist
atm_0_35 : dest : atm_pvc_0_35

=>

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected

RELATED COMMANDS:

atm ifadd Create a new ATM interface.

atm iflist Display the ATM interfaces.

14

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm ifdetach

Detach an ATM interface.

SYNTAX:

atm ifdetach intf = <string>

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

=>
=>atm ifdetach intf=RtPPPoA_atm
=>
=>atm iflist
atm_0_35 : dest : atm_pvc_0_35

RtPPPoA_atm: dest : RtPPPoA

=>

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : connected

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : mac
Connection State : connected

Retry : 10 QoS : default Encaps : vcmux Fcs : off Ulp : ppp
Connection State : not-connected

RELATED COMMANDS:

atm ifattach Attach a ATM interface.

E-DOC-CTC-20050531-0055 v1.0

15

ATM Commands

atm iflist

Display the ATM interfaces.

SYNTAX:

atm iflist [intf = <string>]

where:

intf The name of the ATM interface to be shown.

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

atm ifadd Create a new ATM interface.

atm ifdelete Delete an ATM interface.

OPTIONAL

16

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm bundle add

Add a new bundle of interfaces.

SYNTAX:

atm bundle add name = <string>

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-20050531-0055 v1.0

17

ATM Commands

atm bundle attach

Attach a bundle of interfaces.

SYNTAX:

atm bundle attach name = <string>

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 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 detach Detach a bundle of interfaces.

18

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm bundle config

Modify a bundle of interfaces.

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 = <string>

[policy = <{priority | connection}>]
[propagate = <{disabled | enabled}>]
[retry = <number{0-65535}>]

where:

name The name of the bundle to be configured. REQUIRED

policy The traffic handling policy of the bundle.

Choose between:

 priority: lower layer ATM interfaces can be configured for a certain priority

range, marked packets will be sent on the corresponding interface.

 connection: all the packets of the same connection will be sent via the same

interface.

The default is priority.

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.

retry A number between 0 and 65535.

Represents the number of connection setup retries before giving up.
The default is 10.

OPTIONAL

OPTIONAL

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-20050531-0055 v1.0

19

ATM Commands

atm bundle clear

Clear the bundle statistics.

SYNTAX:

atm bundle clear [name = <string>]

where:

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

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

OPTIONAL

20

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm bundle delete

Delete a bundle of interfaces.

SYNTAX:

atm bundle delete name = <string>

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-20050531-0055 v1.0

21

ATM Commands

atm bundle detach

Detach a bundle of interfaces.

SYNTAX:

atm bundle detach intf = <string>

where:

intf The name of the bundle to be detached. REQUIRED

RELATED COMMANDS:

atm bundle attach Attach a bundle of interfaces.

22

E-DOC-CTC-20050531-0055 v1.0

atm bundle flush

Flush all bundles.

SYNTAX:

atm bundle flush

ATM Commands

E-DOC-CTC-20050531-0055 v1.0

23

ATM Commands

atm bundle ifadd

Add an interface on a bundle.

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

SYNTAX:

atm bundle ifadd name = <string>

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.

intf = <string>
[index = <number{0-6}>]

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 Remove an interface from a bundle.

24

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm bundle ifconfig

Configure an interface from a bundle.

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 = <string>

intf = <string>
[state = <{disabled | enabled}>]
[low = <number{0-15}>]
[high = <number{0-15}>]

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.

low A number between 0 and 15.

Represents the low selector value.

Note This parameter must only be configured when the policy of the bundle is set

to priority (see “ atm bundle config” on page 19).

high A number between 0 and 15.

Represents the high selector value.

Note This parameter must only be configured when the policy of the bundle is set

to priority (see “ atm bundle config” on page 19).

OPTIONAL

OPTIONAL

OPTIONAL

E-DOC-CTC-20050531-0055 v1.0

25

ATM Commands

atm bundle ifdelete

Remove an interface from a bundle.

SYNTAX:

atm bundle ifdelete name = <string>

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:

intf = <string>

=>atm bundle iflist
Test : dest : (none)

=>atm bundle ifdelete intf=Test
=>atm bundle iflist

=>

Retry : 10 QoS : default Encaps : llc Fcs : off Ulp : ip
Connection State : not-connected

RELATED COMMANDS:

atm bundle ifadd Add an interface on a bundle.

26

E-DOC-CTC-20050531-0055 v1.0

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

=>

ATM Commands

RELATED COMMANDS:

atm bundle add Add a new bundle of interfaces.

atm bundle delete Delete a bundle of interfaces.

E-DOC-CTC-20050531-0055 v1.0

27

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>

where:

config port The port for which CAC is configured. REQUIRED

state Enable/disable CAC for an ATM port. REQUIRED

EXAMPLE:

state = <{disabled|enabled}>

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

RELATED COMMANDS:

atm cac list Display all the CAC parameters.

atm cac overbooking Configure ATM overbooking parameters.

28

E-DOC-CTC-20050531-0055 v1.0

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]=>

ATM Commands

RELATED COMMANDS:

atm cac config Configure the ATM connection admission control.

atm cac overbooking Configure ATM overbooking parameters.

E-DOC-CTC-20050531-0055 v1.0

29

ATM Commands

atm cac overbooking

Configure ATM overbooking parameters.

SYNTAX:

atm cac overbooking rt = <number{0-1000}>

where:

nrt = <number{0-1000}>

rt A number between 0 and 1000.

The realtime overbooking percentage.

nrt A number between 0 and 1000.

The non-realtime overbooking percentage.

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:

atm cac config Configure the ATM connection admission control.

atm cac list Display all the CAC parameters.

REQUIRED

REQUIRED

30

E-DOC-CTC-20050531-0055 v1.0

atm debug aal5stats

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

SYNTAX:

atm debug aal5stats port = <{dsl0} or number>

vpi = <number{0-15}>
[vci = <number{0-511}>]
[clear = <{disabled | enabled}>]

where:

ATM Commands

port The port number for which statistics will be retrieved.

Choose between:

REQUIRED

 DSL0

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.

vci A number between 0 and 511.

Represents the Virtual Channel Identifier (VCI) number for which statistics will be
retrieved.

clear Enable or disable clearing of the statistics after request. OPTIONAL

REQUIRED

OPTIONAL

RELATED COMMANDS:

atm debug gstats Display ATM global statistics.

atm debug portstats Display port specific ATM statistics.

E-DOC-CTC-20050531-0055 v1.0

31

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:

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

atm debug portstats Display port specific ATM statistics.

32

E-DOC-CTC-20050531-0055 v1.0

atm debug portstats

Display port specific ATM statistics.

SYNTAX:

atm debug portstats port = <{dsl0} or number>

[clear = <{disabled | enabled}>]

where:

ATM Commands

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-20050531-0055 v1.0

33

ATM Commands

atm oam config

Modify the ATM Operation and Maintenance (OAM) settings.

SYNTAX:

atm oam config [clp = <number{0-1}>]

where:

[loopbackid = <string>]

clp A number (0 or 1).

Represents the Cell Loss Priority (CLP) bit value of the OAM cells.
The default is 1.

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.

RELATED COMMANDS:

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.

OPTIONAL

OPTIONAL

34

E-DOC-CTC-20050531-0055 v1.0

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

=>

ATM Commands

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-20050531-0055 v1.0

35

ATM Commands

atm oam modify

Modify the ATM OAM data blocking mode.

SYNTAX:

atm oam modify port = <{dsl0} or number>

where:

blocking = <{disabled | enabled}>

port The port for which OAM blocking is configured.

Choose between:

 DSL0

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

blocking Enable or disable the OAM data blocking mode on this port.

The default is enabled.

EXAMPLE:

=>atm oam list

OAM config dump

-------------------

--------------------------

=>atm oam modify port=dsl1 blocking=disabled
=>:atm oam list

-------------------

--------------------------

=>

CLP bit value : 1
Loopbackid :6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a

OAM data blocking mode

Port dsl0: blocking
Port dsl1: blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking

OAM config dump

CLP bit value : 1
Loopbackid :6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a6a

OAM data blocking mode

Port dsl0: blocking
Port dsl1: non blocking
Port atm2: blocking
Port atm3: blocking
Port aal5: blocking
Port atm5: blocking

REQUIRED

REQUIRED

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.

36

E-DOC-CTC-20050531-0055 v1.0

atm oam ping

Send ATM loopback cells.

SYNTAX:

atm oam ping dest = <string>

[count = <number{1-1000000}>]
[interval = <number{100-1000000}>]

where:

ATM Commands

dest The destination address for the request.

This can be any ATM phonebook entry.

count A number between 1 and 1000000.

Represents the number of pings to send.

interval A number between 100 and 1000000 (milliseconds).

Represents the interval between packets.

EXAMPLE:

=>atm oam ping dest=atm_ph_8_35 count=10 interval=1000
loopback: successful, sequence: 1 time: 37890 usec
loopback: successful, sequence: 2 time: 39118 usec
loopback: successful, sequence: 3 time: 39116 usec
loopback: successful, sequence: 4 time: 39187 usec
loopback: successful, sequence: 5 time: 38605 usec
loopback: successful, sequence: 6 time: 38764 usec
loopback: successful, sequence: 7 time: 38752 usec
loopback: successful, sequence: 8 time: 38813 usec
loopback: successful, sequence: 9 time: 38848 usec
loopback: successful, sequence: 10 time: 38941 usec

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

REQUIRED

OPTIONAL

OPTIONAL

RELATED COMMANDS:

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-20050531-0055 v1.0

37

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.

38

E-DOC-CTC-20050531-0055 v1.0

atm oam cc modify

Modify CC on the connection.

SYNTAX:

atm oam modify port = <{dsl0} or number>

vpi = <number{0-15}>
[vci = <number{0-511}>]
[transmit = <{disabled | enabled}>]
[receive = <{disabled | enabled}>]
[auto = <{disabled | enabled}>]
[span = <{segment | end2end}>]

where:

ATM Commands

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.

vci A number between 0 and 511.

Represents the VCI.

REQUIRED

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 SpeedTouch™ and a

first-hop ATM switch.

RELATED COMMANDS:

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

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

E-DOC-CTC-20050531-0055 v1.0

39

ATM Commands

atm oam cc send

Send CC activate/deactivate to connection.

SYNTAX:

atm oam cc send port = <{dsl0} or number>

where:

vpi = <number{0-15}>
[vci = <number{0-511}>]
[span = <{segment | end2end}>]
[action = <{activate | deactivate}>]
[direction = <{source | sink | both}>]

port The ATM port number.

Choose between:

 DSL0.

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

vpi A number between 0 and 15.

Represents the VPI.

vci A number between 0 and 511.

Represents the VCI.

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

span Select the CC span.

Choose between:

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

 segment: monitoring occurs on a VC segment between the SpeedTouch™ and a

first-hop ATM switch.

action Activate or deactivate CC.

The default is deactivate.

direction Indicates the direction of CC activity.

Choose between:

 source

 sink

 both.

The default is both.

REQUIRED

REQUIRED

OPTIONAL

OPTIONAL

OPTIONAL

OPTIONAL

RELATED COMMANDS:

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

atm oam cc modify Modify CC on the connection.

40

E-DOC-CTC-20050531-0055 v1.0

atm oam vclb add

Create a loopback connection for VC.

SYNTAX:

atm oam vclb add port = <{dsl0} or number>

vpi = <number{0-15}>
[vci = <number{0-511}>]

where:

ATM Commands

port The ATM port number.

Choose between:

 DSL0

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

vpi A number between 0 and 15.

Represents the VPI.

vci A number between 0 and 511.

Represents the VCI.

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

EXAMPLE:

=>atm oam vclb add port=dsl0 vpi=0 vci=36
=>atm oam vclb list
PORT = 0 VPI=0VCI= 36
=>atm oam vclb add port=dsl1 vpi=0 vci=37
=>atm oam vclb list
PORT = 0 VPI=0VCI= 36
PORT = 1 VPI=0VCI= 37
=>

RELATED COMMANDS:

REQUIRED

REQUIRED

OPTIONAL

atm oam vclb del Delete a loopback connection for VC.

atm oam vclb list List all VC loopback connections.

E-DOC-CTC-20050531-0055 v1.0

41

ATM Commands

atm oam vclb del

Delete a loopback connection for VC.

SYNTAX:

atm oam vclb del port = <{dsl0} or number>

where:

vpi = <number{0-15}>
[vci = <number{0-511}>]

port The ATM port number.

Choose between:

 DSL0

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

vpi A number between 0 and 15.

Represents the VPI.

vci A number between 0 and 511.

Represents the VCI.

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

EXAMPLE:

=>atm oam vclb list
PORT = 0 VPI=0VCI= 36
PORT = 1 VPI=0VCI= 37
=>atm oam vclb del port=dsl1 vpi=0 vci=37
=>atm oam vclb list
PORT = 0 VPI=0VCI= 36
=>

RELATED COMMANDS:

atm oam vclb add Create a loopback connection for VC.

atm oam vclb list List all VC loopback connections.

REQUIRED

REQUIRED

OPTIONAL

42

E-DOC-CTC-20050531-0055 v1.0

atm oam vclb list

List all VC loopback connections.

SYNTAX:

atm oam vclb list

EXAMPLE:

=>atm oam vclb list
PORT = 0 VPI=0VCI= 36
PORT = 1 VPI=0VCI= 37
=>

RELATED COMMANDS:

ATM Commands

atm oam vclb add Create a loopback connection for VC.

atm oam vclb del Delete a loopback connection for VC.

E-DOC-CTC-20050531-0055 v1.0

43

ATM Commands

atm phonebook add

Add a new phonebook entry.

SYNTAX:

atm phonebook add name = <string>

where:

addr = <atmchannel : PVC syntax is [port.]vpi.vci

port=dsl0 | ...>

name The name of the new phonebook entry.

This name can be freely chosen, however two limitations apply:

 The name of a phonebook entry intended for the Relayed PPPoA (PPPoA-to-PPTP

Relaying) packet service may not start with capital P or capital T

 The name of a phonebook entry intended for the PPP-to-DHCP spoofing packet

service must start with DHCP (for example DHCP_Spoof01).

addr The ATM address for this destination.

It is composed of a VPI and a VCI identifying ATM virtual channels. In most cases the
values are provided by the Service Provider.
Accepted VPI: a number between 0 and 15.
Accepted VCI: a number between 0 and 511.

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

REQUIRED

REQUIRED

RELATED COMMANDS:

atm phonebook delete Delete an existing phonebook entry.

atm phonebook list Display the current phonebook.

44

E-DOC-CTC-20050531-0055 v1.0

atm phonebook autolist

Show the auto PVCs.

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

SYNTAX:

atm phonebook autolist

EXAMPLE:

=>atm phonebook autolist

8.35
=>

ATM Commands

RELATED COMMANDS:

atm phonebook list Display the current phonebook.

E-DOC-CTC-20050531-0055 v1.0

45

ATM Commands

atm phonebook delete

Delete an existing phonebook entry.

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 = <string>

where:

name The name of the phonebook entry to be deleted.

Tip Use the command :atm phonebook li st to check whether the entry is in

Use=1

use (

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

REQUIRED

46

E-DOC-CTC-20050531-0055 v1.0

atm phonebook flush

Flush all the phonebook entries.

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

ATM Commands

E-DOC-CTC-20050531-0055 v1.0

47

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.

48

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm qosbook add

Add a new QoS book entry.

SYNTAX:

atm qosbook add name = <string>

[txctd = <string>]
[rxctd = <string>]

where:

name The name of the new QoS entry. REQUIRED

txctd The name of the Conformance Traffic Descriptor (CTD) for the transmit (upstream)

direction.

rxctd The name of the CTD for the receive (downstream) direction. OPTIONAL

OPTIONAL

EXAMPLE:

=>atm qosbook list
Name Ref Tx CTD Rx CTD
default 3 default default
=>

RELATED COMMANDS:

atm qosbook delete Delete a QoS book entry.

atm qosbook list Display the QoS book.

E-DOC-CTC-20050531-0055 v1.0

49

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 Sust Burst Minrate Frame Cdvt RT FD

default 2 UBR linerate 0 0 0 0 0 disabled disabled
=>atm qosbook config format=cells
=>atm qosbook ctdlist
Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD

default 2 UBR linerate 0 0 0 0 0 disabled disabled
=>

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

(cps) (cps) (cells) (cps) (cells)

50

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm qosbook ctdadd

Add a Connection Traffic Descriptor (CTD).

SYNTAX:

atm qosbook ctdadd name = <string>

conformance = <{UBR | CBR | VBR }>
[peakrate = <number{0-27786}>]
[sustrate = <number{0-27786}
[maxburst = <number{0-12240}>]
[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).

sustrate A number between 0 and 27786.

Represents the sustainable rate (in kilobits per second) (VBR only).
The default is 0.

maxburst A number between 48 and 12240.

Represents the maximum burst size (in bytes) (VBR or GFR).
The default is 0.

realtime Enable or disable realtime traffic (VBR only).

The default is disabled.

OPTIONAL

OPTIONAL

OPTIONAL

OPTIONAL

EXAMPLE:

=>atm qosbook ctdadd name=High conformance=CBR peakrate=27786
=>atm qosbook ctdlist
Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

default 2 UBR linerate 0 0 0 0 0 disabled disabled
High 0 CBR 27786 0 0 0 0 0 disabled disabled
=>

E-DOC-CTC-20050531-0055 v1.0

51

ATM Commands

IMPORTANT NOTE:

The SpeedTouch™ always rounds up specified burst sizes to a multiple of 48 bytes (a multiple of ATM cells).

Example:

In the example below a burst size of 100 bytes is specified (maxburst=100). The SpeedTouch™ will round up the
burst size to the closest matching multiple of 48 bytes, as can be seen when displaying the profile via the

command :atm qosbook ctdlist (burst=144).

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

default 2 UBR linerate 0 0 0 0 0 disabled disabled
Medium 0 VBR 27786 20000 144 0 0 0 disabled disabled
=>

RELATED COMMANDS:

atm qosbook ctddelete Delete a CTD.

atm qosbook ctdlist Display all CTDs.

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

52

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm qosbook ctddelete

Delete a CTD.

SYNTAX:

atm qosbook ctddelete name = <string>

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

EXAMPLE:

OPTIONAL

=>atm qosbook ctdlist
Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD

default 2 UBR linerate 0 0 0 0 0 disabled disabled
High 0 CBR 27786 0 0 0 0 0 disabled disabled
=>atm qosbook ctddelete name=High
=>atm qosbook ctdlist
Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD

default 2 UBR linerate 0 0 0 0 0 disabled disabled
=>

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

RELATED COMMANDS:

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

atm qosbook ctdlist Display all CTDs.

E-DOC-CTC-20050531-0055 v1.0

53

ATM Commands

atm qosbook ctdlist

Display all CTDs.

SYNTAX:

atm qosbook ctdlist

EXAMPLE:

=>atm qosbook ctdlist
Name Ref Conf Peak Sust Burst Minrate Frame Cdvt RT FD

default 2 UBR linerate 0 0 0 0 0 disabled disabled
High 0 CBR 27786 0 0 0 0 0 disabled disabled
=>

(Kbits) (Kbits) (bytes) (Kbits) (bytes)

RELATED COMMANDS:

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

atm qosbook ctddelete Delete a CTD.

54

E-DOC-CTC-20050531-0055 v1.0

ATM Commands

atm qosbook delete

Delete a QoS book entry.

SYNTAX:

atm qosbook delete name = <string>

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

EXAMPLE:

OPTIONAL

=>atm qosbook list
Name Ref Type TX peak sust burst RX peak sust burst framediscard

default 3 ubr linerate 0 0 linerate 0 0 disabled
TestVBR 0 vbr-nrt 1500 1000 144 1500 1000 144 enabled
=>atm qosbook delete name=TestVBR
=>atm qosbook list
Name Ref Type TX peak sust burst RX peak sust burst framediscard

default 3 ubr linerate 0 0 linerate 0 0 disabled
=>

(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes)

(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes)

RELATED COMMANDS:

atm qosbook add Add a new QoS book entry.

atm qosbook list Display the QoS book.

E-DOC-CTC-20050531-0055 v1.0

55

ATM Commands

atm qosbook flush

Flush all the QoS book entries.

The flush command does not impact previously saved configurations.

SYNTAX:

atm qosbook flush

56

E-DOC-CTC-20050531-0055 v1.0

atm qosbook list

Display the QoS book.

SYNTAX:

atm qosbook list

EXAMPLE:

=>atm qosbook list
Name Ref Type TX peak sust burst RX peak sust burst framediscard

(Kbits) (Kbits) (bytes) (Kbits) (Kbits) (bytes)
default 3 ubr linerate 0 0 linerate 0 0 disabled
TestVBR 0 vbr-nrt 1500 1000 144 1500 1000 144 enabled
=>

ATM Commands

RELATED COMMANDS:

atm qosbook add Add a new QoS book entry.

atm qosbook delete Delete a QoS book entry.

E-DOC-CTC-20050531-0055 v1.0

57

ATM Commands

58

E-DOC-CTC-20050531-0055 v1.0

AutoPVC Commands

AutoPVC Commands

Introduction

This chapter describes the commands of the autopvc command group.

Contents

This chapter covers the following commands:

autopvc config Configure autopvc. 60

autopvc list Show the retrieved information. 61

E-DOC-CTC-20050531-0055 v1.0

59

AutoPVC Commands

autopvc config

Configure autopvc.

SYNTAX:

autopvc config [mode = <{pseudo | passive | active}>]

where:

[type = <{bridge | pppoerelay | ipoa | ethoa | pppoa | pppoe}>]
[overwrite = <{disabled | enabled}>]
[peakrate = <number{0-27786}>]

mode Select the autopvc mode:

 pseudo: only pseudo-ILMI (VP/VC 15/16) is enabled. When the connection

parameters are written to the MIB, this information is displayed on CLI or web
interface but these parameters are not used for configuration.

 passive: both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC 15/16) are enabled.

When the connection parameters are written to the MIB, this information is
displayed on CLI or web interface but these parameters are not used for
configuration.

 active: both ILMI (VP/VC 0/16) and pseudo-ILMI (VP/VC 15/16) are enabled.

When the connection parameters are written to the MIB, these parameters are
used to configure phonebook entries, qosbook profiles and bind bridge or
PPPoE interfaces on top.

The default is passive.

type Select the type of autopvc.

Choose between:

 bridge

 pppoerelay: an ETHoA interface will be created, will be bound to the ILMI

Permanent Virtual Channel (PVC) and will be added to the PPPoE relay as relay
port.

 ipoa

 ethoa

 pppoa

 pppoe.

overwrite Enable or disable UBR peak rate overwrite.

The default is disabled.

peakrate A number between 0 and 27786.

Represents the UBR peak rate (in kilobits per second).
The default is 0 (indicates the linerate).

OPTIONAL

OPTIONAL

OPTIONAL

OPTIONAL

EXAMPLE:

=>autopvc config
Autopvc mode : passive
Autopvc type :
Autopvc standard: unknown
Autopvc pseudo : unknown
UBR overwrite : disabled
UBR peak rate : linerate
=>

60

E-DOC-CTC-20050531-0055 v1.0

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:

AutoPVC Commands

table Select the autopvc table for which the information must be shown.

Choose between:

 Port

 AtmLayer

 Vpc

 Vcc

 Address

 AddressRegistrationAdmin

 AtmServiceType

 AtmServiceConnectionInfo

 AAL1Profile

 AAL34Profile

 AAL5Profile

 AAL2CommonProfile

 AAL2TrunkingProfile

 AAL2LESProfile

 AtmServiceConnInfoExtension

 AtmServiceTypeExtension

 AAL5ProfileExtension.

OPTIONAL

EXAMPLE:

=>autopvc list
Address Type BestEff Par1 Par2 Par3 Par4 Par5

8.35 ubr Enabled Tx: 451 0 0 0 0

Rx: 7923 0 0 0 0

=>

E-DOC-CTC-20050531-0055 v1.0

61

AutoPVC Commands

62

E-DOC-CTC-20050531-0055 v1.0

Config Commands

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

config dump Show the saved configuration file. 65

config flush Flush the loaded configuration. 66

config list Show the current configuration set. 67

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

config save Store the current configuration in a backup file. 69

E-DOC-CTC-20050531-0055 v1.0

63

Config Commands

config delete

Delete a user configuration file.

SYNTAX:

config delete [filename = <string>]

where:

filename Name of the user configuration file to be deleted.

Note If not specified, all the user configuration files that were saved in the

SpeedTouch™ permanent storage will be deleted.

RELATED COMMANDS:

config dump Show the saved configuration file.

OPTIONAL

64

E-DOC-CTC-20050531-0055 v1.0

config dump

Show the saved configuration file.

SYNTAX:

config dump

RELATED COMMANDS:

config delete Delete a user configuration file.

Config Commands

E-DOC-CTC-20050531-0055 v1.0

65

Config Commands

config flush

Flush the loaded configuration.

1. This flush command combines all the possible flush commands.

2. This command does not affect saved configurations.

SYNTAX:

config flush [flush_ip = <{disabled | enabled}>]

where:

flush_ip Flush IP settings (enabled) or not (disabled).

The default is disabled.

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

OPTIONAL

66

E-DOC-CTC-20050531-0055 v1.0

config list

Show the current configuration set.

SYNTAX:

config list [templates = <{disabled | enabled}>]

where:

Config Commands

templates List the template files (disabled) or not (enabled).

The default is disabled.

RELATED COMMANDS:

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

config save Store the current configuration in a backup file.

OPTIONAL

E-DOC-CTC-20050531-0055 v1.0

67

Config Commands

config load

Load complete saved (backup) or default configuration file.

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

SYNTAX:

config load [load_ip = <{disabled | enabled}>]

where:

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

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

OPTIONAL

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

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

OPTIONAL

Note If not specified, the saved configuration will be loaded.

flush Flush the current configuration before loading a new configuration (enabled) or not

(disabled).

echo Echo each command string when loaded (enabled) or not (disabled). OPTIONAL

filename Name of the configuration file to be loaded. OPTIONAL

OPTIONAL

EXAMPLE:

=>ip rtlist

Destination Source Gateway Intf Mtrc

10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0

172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0

10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0

127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0

172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>config load flush_ip=no
=>ip rtlist

Destination Source Gateway Intf Mtrc

10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0

10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0

127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0
=>config load flush=yes
=>ip rtlist

Destination Source Gateway Intf Mtrc

10.0.0.0/24 10.0.0.0/24 10.0.0.140 eth0 0

10.0.0.140/32 0.0.0.0/0 10.0.0.140 eth0 0

172.16.0.5/32 0.0.0.0/0 172.16.0.5 cip1 0

127.0.0.1/32 0.0.0.0/0 127.0.0.1 loop 0

172.16.0.0/24 0.0.0.0/0 172.16.0.5 cip1 1
=>

RELATED COMMANDS:

config list Show the current configuration set.

config save Store the current configuration in a backup file.

68

E-DOC-CTC-20050531-0055 v1.0

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

SYNTAX:

config save filename = <string>

where:

filename The filename for the backup file of the current configuration. REQUIRED

RELATED COMMANDS:

config list Show the current configuration set.

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

E-DOC-CTC-20050531-0055 v1.0

69

Config Commands

70

E-DOC-CTC-20050531-0055 v1.0

Connection Commands

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

connection appinfo Display CONN/NAT application specific info. 74

connection applist List the available CONN/NAT application helpers. 75

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

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

connection clean Clean the connection database by forcing timeouts. 78

connection clear Kill all the connections. 79

connection config Configure the connection handling. 80

connection debug The connection debug commands 81

connection describe Describe the streams of a connection. 82

connection flush Flush the current connection configuration. 83

connection info Show all the registered modules with some info. 84

connection list Display the currently known connections. 85

connection refresh Invalidate all the cached decisions. 86

connection stats Display the connection and stream statistics. 87

connection timerclear Clear the connection timeout to default. 88

connection timerconfig Configure the connection timeout handling. 89

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

E-DOC-CTC-20050531-0055 v1.0

71

Connection Commands

connection appconfig

Configure the available CONN/NAT application helpers.

SYNTAX:

connection appconfig application = <string>

where:

[trace = <{disabled | enabled}>]
[timeout = <number{0-32000}>]
[floating = <{disabled | enabled}>]
[tracelevel = <number{1-4}>]

application The name of a CONN/NAT application helper.

REQUIRED

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

timeout A number between 0 and 32000 (seconds).

Represents the maximum timeout to keep predicted child connections around.

floating Enable / disabled floating port for IKE helper. OPTIONAL

tracelevel A number between 1 and 4.

Represents the SIP trace level.
Choose between:

OPTIONAL

OPTIONAL

OPTIONAL

 1: feature errors

 2: feature traces

 3: all errors

 4: all traces.

The default is 1.

EXAMPLE:

=>connection applist
Application Proto DefaultPort Traces Timeout
IP6TO4 6to4 0 enabled unavailable
PPTP tcp 1723 enabled unavailable
ESP esp 0 unavailable 15' 0"
IKE udp 500 disabled 15' 0" FLOATING
SIP udp 5060 disabled 6 0" trace level 1
...
LOOSE(UDP) udp 0 enabled 5' 0"
FTP tcp 21 enabled unavailable
=>connection appconfig application=SIP trace=enabled
=>connection applist
Application Proto DefaultPort Traces Timeout
IP6TO4 6to4 0 enabled unavailable
PPTP tcp 1723 enabled unavailable
ESP esp 0 unavailable 15' 0"
IKE udp 500 disabled 15' 0" FLOAATING
SIP udp 5060 enabled 6 0" trace level 1
...
LOOSE(UDP) udp 0 enabled 5' 0"
FTP tcp 21 enabled unavailable
=>

72

E-DOC-CTC-20050531-0055 v1.0

RELATED COMMANDS:

connection appinfo Display CONN/NAT application specific info.

connection applist List the available CONN/NAT application helpers.

Connection Commands

E-DOC-CTC-20050531-0055 v1.0

73

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

connection appconfig Configure the available CONN/NAT application helpers.

connection applist List the available CONN/NAT application helpers.

REQUIRED

74

E-DOC-CTC-20050531-0055 v1.0

connection applist

List the available CONN/NAT application helpers.

SYNTAX:

connection applist

EXAMPLE:

=>connection applist
Application Proto DefaultPort Traces Timeout
IP6TO4 6to4 0 enabled unavailable
PPTP tcp 1723 enabled unavailable
ESP esp 0 unavailable 15' 0"
IKE udp 500 disabled 15' 0" FLOATING
SIP udp 5060 disabled 6 0" trace level 1
JABBER tcp 5222 disabled 2' 0"
CU/SeeMe udp 7648 enabled unavailable
RAUDIO(PNA) tcp 7070 enabled unavailable
RTSP tcp 554 enabled unavailable
ILS tcp 389 unavailable 5' 0"
H245 tcp 0 unavailable 5' 0"
H323 tcp 1720 enabled unavailable
IRC tcp 6667 enabled 5' 0"
LOOSE(UDP) udp 0 enabled 5' 0"
FTP tcp 21 enabled unavailable
=>

Connection Commands

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-20050531-0055 v1.0

75

Connection Commands

connection bind

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

SYNTAX:

connection bind application = <string>

where:

port = <port-range>

application The name of a CONN/NAT application helper.

REQUIRED

Tip Use the command :connection applist to obtain a list of CONN/NAT

application helpers.

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

EXAMPLE:

=>connection bindlist
Application Proto Portrange Flags
JABBER tcp 15222
JABBER tcp 5222
FTP tcp 21
IRC tcp 6660
...
IP6TO4 6to4 0
=>connection bind application = IRC port = 6750
=>connection bindlist
Application Proto Portrange
IRC tcp 6750
JABBER tcp 15222
JABBER tcp 5222
FTP tcp 21
IRC tcp 6660
...
IP6TO4 6to4 0
=>

RELATED COMMANDS:

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

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

76

E-DOC-CTC-20050531-0055 v1.0

connection bindlist

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

SYNTAX:

connection bindlist

EXAMPLE:

=>connection bindlist
Application Proto Portrange Flags
LOOSE(UDP) udp 67
JABBER tcp 15222
JABBER tcp 5222
FTP tcp 21
IRC tcp 6660-6669
H323 tcp 1720
ILS tcp 1002
ILS tcp 389
RTSP tcp 554
RAUDIO(PNA) tcp 7070
CU/SeeMe udp 7648
SIP udp 5060
IKE udp 500
ESP esp 0
PPTP tcp 1723
IP6TO4 6to4 0
=>

Connection Commands

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-20050531-0055 v1.0

77

Connection Commands

connection clean

Clean the connection database by forcing timeouts.

SYNTAX:

connection clean [level = <number{0-9}>]

where:

level A number between 0 and 9.

Represents the desired scrubbing level.

The default is ... .

EXAMPLE:

=>connection list
ID proto state substate flags timeout

-- ----- ----- -------- ----- -------

8 tcp ACTIVE [TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 15' 7"

INIT: 16 192.168. 1. 64: 1377 192.168. 1.254: 23 [...] LocalNetwork 1390 tcp 0
RESP: 17 192.168. 1.254: 23 192.168. 1. 64: 1377 [R..] loop 951 tcp 0

34 tcp ACTIVE [TCPS_CLOSE_WAIT-TCPS_FIN_WAIT_1] [I.....] 57' 16"

INIT: 68 192.168. 1. 64: 1417 192.168. 1.254: 21 [...] LocalNetwork 11 tcp 0

RESP: 69 192.168. 1.254: 21 192.168. 1. 64: 1417 [R..] loop 10 tcp 0
=>connection clean
=>connection list
ID proto state substate flags timeout

-- ----- ----- -------- ----- -------

8 tcp ACTIVE [TCPS_ESTABLISHED-TCPS_ESTABLISHED] [......] 14' 59"

INIT: 16 192.168. 1. 64: 1377 192.168. 1.254: 23 [...] LocalNetwork 1417 tcp 0

RESP: 17 192.168. 1.254: 23 192.168. 1. 64: 1377 [R..] loop 967 tcp 0
=>

OPTIONAL

78

E-DOC-CTC-20050531-0055 v1.0

connection clear

Kill all the connections.

SYNTAX:

connection clear

EXAMPLE:

=>connection clear

Connection to host lost.

Connection Commands

E-DOC-CTC-20050531-0055 v1.0

79

Connection Commands

connection config

Configure the connection handling.

SYNTAX:

connection config [configchangemode = <{immediate | delayed}>]

where:

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

configchangemode Select how configuration changes are handled.

Choose between:

 immediate

 delayed.

The default is immediate.

probes Enable or disable live probes on idle connections.

The default is disabled.

udptrackmode Select the User Datagram Protocol (UDP) connection tracking mode.

Choose between:

 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
=>

OPTIONAL

OPTIONAL

OPTIONAL

80

E-DOC-CTC-20050531-0055 v1.0