Alcatel-lucent SPEEDTOUCH 610 1 User Manual

SpeedTouch™610

Business DSL Routers

CLI Reference Guide

Release R4.2.7(.2)

600 SERIES

SpeedTouch™

610

CLI Reference Guide

Release R4.2.7(.2)

Status v3.0 (October 2004)

Reference E-DOC-CTC-20040210-0028

Short Title CLI ST610(i/s) R4.2.7(.2)

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

Content

About this Document .................................................................................... 19

CLI Navigation ............................................................................................... 21

Accessing the Command Line Interface .................................................................................................................... 22

Basic Navigation and Manipulation..............................................................................................................................24

Command Line Interface Top Level Structure ........................................................................................................28

Command Line Interface Commands ........................................................................................................................ 29

Menu-driven CLI Navigation ........................................................................................................................................ 30

Service Template Files and the CLI ............................................................................................................................ 33

Direct FTP Access .......................................................................................................................................................... 35

ADSL Commands .......................................................................................... 37

adsl config .........................................................................................................................................................................38

adsl info ............................................................................................................................................................................. 39

ATM Commands............................................................................................ 41

atm oam ccconfig ............................................................................................................................................................42

atm oam cclist..................................................................................................................................................................43

atm oam ccsend...............................................................................................................................................................44

atm oam config ................................................................................................................................................................ 45

atm oam mode.................................................................................................................................................................46

atm oam ping.................................................................................................................................................................... 47

atm oam status ................................................................................................................................................................ 48

ATMF Commands.......................................................................................... 49

atmf add............................................................................................................................................................................. 50

atmf ccconfig .................................................................................................................................................................... 51

atmf cclist .......................................................................................................................................................................... 52

atmf ccsend....................................................................................................................................................................... 53

atmf config ........................................................................................................................................................................54

atmf delete........................................................................................................................................................................ 55

atmf flush........................................................................................................................................................................... 56

atmf list ..............................................................................................................................................................................57

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

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

autopvc info...................................................................................................................................................................... 62

E-DOC-CTC-20040210-0028 v3.0

Bridge Commands ......................................................................................... 63

bridge config..................................................................................................................................................................... 64

bridge flush .......................................................................................................................................................................65

bridge ifadd .......................................................................................................................................................................66

bridge ifattach...................................................................................................................................................................67

bridge ifconfig................................................................................................................................................................... 68

bridge ifdelete .................................................................................................................................................................. 70

bridge ifdetach ................................................................................................................................................................. 71

bridge iflist ........................................................................................................................................................................ 72

bridge macadd.................................................................................................................................................................. 73

bridge macdelete.............................................................................................................................................................74

bridge maclist ................................................................................................................................................................... 75

CIP Commands .............................................................................................. 77

cip flush.............................................................................................................................................................................. 78

cip ifadd .............................................................................................................................................................................79

cip ifdelete......................................................................................................................................................................... 80

cip iflist...............................................................................................................................................................................81

cip pvcadd ......................................................................................................................................................................... 82

cip pvcdelete .................................................................................................................................................................... 83

cip pvclist........................................................................................................................................................................... 84

Config Commands ......................................................................................... 85

config backup....................................................................................................................................................................86

config dump ......................................................................................................................................................................87

config erase....................................................................................................................................................................... 88

config flush ........................................................................................................................................................................89

config list ........................................................................................................................................................................... 90

config load......................................................................................................................................................................... 91

config save......................................................................................................................................................................... 93

E-DOC-CTC-20040210-0028 v3.0

DHCP Commands ......................................................................................... 95

dhcp client clear .............................................................................................................................................................. 97

dhcp client config ............................................................................................................................................................ 98

dhcp client flush............................................................................................................................................................... 99

dhcp client ifadd.............................................................................................................................................................100

dhcp client ifattach ........................................................................................................................................................101

dhcp client ifconfig ........................................................................................................................................................102

dhcp client ifdelete........................................................................................................................................................104

dhcp client iflist..............................................................................................................................................................105

dhcp client ifrelease ......................................................................................................................................................106

dhcp client ifrenew .......................................................................................................................................................109

dhcp client stats.............................................................................................................................................................112

dhcp relay add................................................................................................................................................................113

dhcp relay config ...........................................................................................................................................................114

dhcp relay delete...........................................................................................................................................................115

dhcp relay flush..............................................................................................................................................................116

dhcp relay ifconfig .........................................................................................................................................................117

dhcp relay iflist...............................................................................................................................................................118

dhcp relay list .................................................................................................................................................................119

dhcp relay stats..............................................................................................................................................................120

dhcp server clear...........................................................................................................................................................121

dhcp server config.........................................................................................................................................................122

dhcp server flush ...........................................................................................................................................................123

dhcp server policy.........................................................................................................................................................124

dhcp server stats ...........................................................................................................................................................125

dhcp server lease add...................................................................................................................................................127

dhcp server lease delete..............................................................................................................................................129

dhcp server lease flush.................................................................................................................................................130

dhcp server lease list....................................................................................................................................................131

dhcp server pool add ...................................................................................................................................................132

dhcp server pool config ...............................................................................................................................................133

dhcp server pool delete...............................................................................................................................................135

dhcp server pool flush .................................................................................................................................................136

dhcp server pool list.....................................................................................................................................................137

E-DOC-CTC-20040210-0028 v3.0

DNS Commands .......................................................................................... 139

dns add ............................................................................................................................................................................140

dns clear ..........................................................................................................................................................................141

dns clrstats......................................................................................................................................................................142

dns delete........................................................................................................................................................................143

dns domain .....................................................................................................................................................................144

dns flush...........................................................................................................................................................................145

dns fwdadd......................................................................................................................................................................146

dns fwddelete.................................................................................................................................................................147

dns fwdlist .......................................................................................................................................................................148

dns fwdtable ...................................................................................................................................................................149

dns list..............................................................................................................................................................................150

dns nslookup ..................................................................................................................................................................151

dns start...........................................................................................................................................................................152

dns stats...........................................................................................................................................................................153

dns status ........................................................................................................................................................................154

dns stop...........................................................................................................................................................................155

dns toutfwd ....................................................................................................................................................................156

dns troff...........................................................................................................................................................................157

dns tron...........................................................................................................................................................................158

Env Commands ............................................................................................ 159

env flush ..........................................................................................................................................................................160

env get .............................................................................................................................................................................161

env list..............................................................................................................................................................................162

env set .............................................................................................................................................................................163

env unset.........................................................................................................................................................................164

Eth Commands............................................................................................. 165

eth config.........................................................................................................................................................................166

eth ifconfig ......................................................................................................................................................................167

eth iflist ............................................................................................................................................................................168

E-DOC-CTC-20040210-0028 v3.0

ETHoA Commands ..................................................................................... 169

ethoa flush.......................................................................................................................................................................170

ethoa ifadd ......................................................................................................................................................................171

ethoa ifattach..................................................................................................................................................................172

ethoa ifconfig..................................................................................................................................................................173

ethoa ifdelete .................................................................................................................................................................175

ethoa ifdetach.................................................................................................................................................................176

ethoa iflist........................................................................................................................................................................177

Firewall Commands..................................................................................... 179

firewall assign .................................................................................................................................................................180

firewall flush....................................................................................................................................................................182

firewall list.......................................................................................................................................................................183

firewall troff....................................................................................................................................................................184

firewall tron....................................................................................................................................................................185

firewall unassign.............................................................................................................................................................186

firewall chain create......................................................................................................................................................187

firewall chain delete......................................................................................................................................................188

firewall chain flush.........................................................................................................................................................189

firewall chain list ............................................................................................................................................................190

firewall rule clear...........................................................................................................................................................191

firewall rule create........................................................................................................................................................192

firewall rule delete ........................................................................................................................................................196

firewall rule flush ...........................................................................................................................................................197

firewall rule list ..............................................................................................................................................................198

firewall rule stats ...........................................................................................................................................................199

E-DOC-CTC-20040210-0028 v3.0

GRP Commands........................................................................................... 201

grp config ........................................................................................................................................................................202

grp flush...........................................................................................................................................................................203

grp ifconfig ......................................................................................................................................................................204

grp iflist............................................................................................................................................................................205

grp rtlist...........................................................................................................................................................................206

grp rip bnadd..................................................................................................................................................................207

grp rip bndelete .............................................................................................................................................................208

grp rip bnlist ...................................................................................................................................................................209

grp rip config ..................................................................................................................................................................210

grp rip flush.....................................................................................................................................................................212

grp rip ifconfig ................................................................................................................................................................213

grp rip nbadd..................................................................................................................................................................215

grp rip nbdelete .............................................................................................................................................................216

grp rip nblist ...................................................................................................................................................................217

grp rip rtfadd..................................................................................................................................................................218

grp rip rtfdelete .............................................................................................................................................................219

grp rip rtflist ...................................................................................................................................................................220

grp rip show ...................................................................................................................................................................221

E-DOC-CTC-20040210-0028 v3.0

IP Commands ............................................................................................... 223

ip apadd ...........................................................................................................................................................................224

ip apdelete.......................................................................................................................................................................226

ip aplist.............................................................................................................................................................................227

ip arpadd .........................................................................................................................................................................228

ip arpdelete.....................................................................................................................................................................229

ip arplist...........................................................................................................................................................................230

ip config ...........................................................................................................................................................................231

ip flush..............................................................................................................................................................................234

ip httpprobe ...................................................................................................................................................................235

ip ifconfig .........................................................................................................................................................................236

ip iflist...............................................................................................................................................................................237

ip ifwait ............................................................................................................................................................................238

ip mcadd..........................................................................................................................................................................239

ip mcdelete .....................................................................................................................................................................240

ip mclist ...........................................................................................................................................................................241

ip ping...............................................................................................................................................................................242

ip rtadd ............................................................................................................................................................................243

ip rtdelete .......................................................................................................................................................................244

ip rtlist..............................................................................................................................................................................245

ip sendto..........................................................................................................................................................................246

ip traceroute ..................................................................................................................................................................247

ip auto flush ....................................................................................................................................................................248

ip auto ifadd....................................................................................................................................................................249

ip auto ifattach ...............................................................................................................................................................250

ip auto ifconfig................................................................................................................................................................251

ip auto ifdelete ...............................................................................................................................................................252

ip auto ifdetach ..............................................................................................................................................................253

ip auto iflist .....................................................................................................................................................................254

IPoA Commands.......................................................................................... 255

ipoa flush .........................................................................................................................................................................256

ipoa ifadd.........................................................................................................................................................................257

ipoa ifattach ....................................................................................................................................................................258

ipoa ifconfig.....................................................................................................................................................................259

ipoa ifdelete ....................................................................................................................................................................261

ipoa ifdetach ...................................................................................................................................................................262

ipoa iflist ..........................................................................................................................................................................263

E-DOC-CTC-20040210-0028 v3.0

IPQoS Commands ....................................................................................... 265

ipqos config.....................................................................................................................................................................266

ipqos list ..........................................................................................................................................................................269

ipqos queue clear ..........................................................................................................................................................270

ipqos queue config ........................................................................................................................................................271

ipqos queue list..............................................................................................................................................................273

ipqos queue stats...........................................................................................................................................................274

E-DOC-CTC-20040210-0028 v3.0

IPSec Commands......................................................................................... 275

ipsec config .....................................................................................................................................................................277

ipsec flush........................................................................................................................................................................278

ipsec saclear....................................................................................................................................................................279

ipsec salist .......................................................................................................................................................................280

ipsec show ......................................................................................................................................................................281

ipsec cert clearall...........................................................................................................................................................283

ipsec cert crlconfig........................................................................................................................................................285

ipsec cert export...........................................................................................................................................................286

ipsec cert import...........................................................................................................................................................287

ipsec cert list ..................................................................................................................................................................288

ipsec cert refresh ..........................................................................................................................................................289

ipsec cert remove .........................................................................................................................................................290

ipsec cert request .........................................................................................................................................................291

ipsec cert cep cancel ....................................................................................................................................................292

ipsec cert cep config.....................................................................................................................................................293

ipsec cert cep list ..........................................................................................................................................................297

ipsec cert cep request..................................................................................................................................................298

ipsec cert cep resubmit ...............................................................................................................................................299

ipsec connection add....................................................................................................................................................300

ipsec connection config ...............................................................................................................................................301

ipsec connection delete...............................................................................................................................................303

ipsec connection list .....................................................................................................................................................304

ipsec connection start..................................................................................................................................................305

ipsec connection stop ..................................................................................................................................................306

ipsec descriptor add .....................................................................................................................................................307

ipsec descriptor delete ................................................................................................................................................311

ipsec descriptor list ......................................................................................................................................................312

ipsec peer add................................................................................................................................................................313

ipsec peer config............................................................................................................................................................314

ipsec peer delete ...........................................................................................................................................................315

ipsec peer list .................................................................................................................................................................316

ipsec policy assign .........................................................................................................................................................317

ipsec policy flush............................................................................................................................................................318

ipsec policy list...............................................................................................................................................................319

ipsec policy troff............................................................................................................................................................320

ipsec policy tron............................................................................................................................................................321

ipsec policy unassign.....................................................................................................................................................322

ipsec policy chain create..............................................................................................................................................323

E-DOC-CTC-20040210-0028 v3.0

ipsec policy chain delete ..............................................................................................................................................324

ipsec policy chain flush.................................................................................................................................................325

ipsec policy chain list ....................................................................................................................................................326

ipsec policy rule clear...................................................................................................................................................327

ipsec policy rule create................................................................................................................................................328

ipsec policy rule delete ................................................................................................................................................331

ipsec policy rule flush ...................................................................................................................................................332

ipsec policy rule list ......................................................................................................................................................333

ipsec policy rule stats ...................................................................................................................................................334

Label Commands ......................................................................................... 335

label add ..........................................................................................................................................................................336

label config ......................................................................................................................................................................337

label delete......................................................................................................................................................................339

label flush.........................................................................................................................................................................340

label list............................................................................................................................................................................341

label troff.........................................................................................................................................................................342

label tron.........................................................................................................................................................................343

label chain create...........................................................................................................................................................344

label chain delete...........................................................................................................................................................345

label chain flush..............................................................................................................................................................346

label chain list.................................................................................................................................................................347

label rule clear................................................................................................................................................................348

label rule create.............................................................................................................................................................349

label rule delete .............................................................................................................................................................352

label rule flush ................................................................................................................................................................353

label rule list ...................................................................................................................................................................354

label rule stats ................................................................................................................................................................355

Language Commands .................................................................................. 357

language config...............................................................................................................................................................358

language list.....................................................................................................................................................................359

language remove............................................................................................................................................................360

E-DOC-CTC-20040210-0028 v3.0

NAT Commands .......................................................................................... 361

nat applist........................................................................................................................................................................362

nat bind............................................................................................................................................................................363

nat bindlist.......................................................................................................................................................................364

nat clear...........................................................................................................................................................................365

nat config.........................................................................................................................................................................366

nat create........................................................................................................................................................................367

nat defserver ..................................................................................................................................................................369

nat delete ........................................................................................................................................................................370

nat disable .......................................................................................................................................................................372

nat enable........................................................................................................................................................................373

nat flush ...........................................................................................................................................................................375

nat list ..............................................................................................................................................................................376

nat multinatadd ..............................................................................................................................................................377

nat multinatdelete .........................................................................................................................................................378

nat multinatlist ...............................................................................................................................................................379

nat unbind .......................................................................................................................................................................380

Phonebook Commands ............................................................................... 381

phonebook add..............................................................................................................................................................382

phonebook autolist.......................................................................................................................................................384

phonebook delete.........................................................................................................................................................385

phonebook flush............................................................................................................................................................386

phonebook list ...............................................................................................................................................................387

PPPoA Commands ...................................................................................... 389

pppoa flush......................................................................................................................................................................390

pppoa ifadd .....................................................................................................................................................................391

pppoa ifattach.................................................................................................................................................................393

pppoa ifconfig .................................................................................................................................................................394

pppoa ifdelete.................................................................................................................................................................398

pppoa ifdetach................................................................................................................................................................399

pppoa iflist.......................................................................................................................................................................400

pppoa rtadd ....................................................................................................................................................................401

pppoa rtdelete ...............................................................................................................................................................403

E-DOC-CTC-20040210-0028 v3.0

PPPoE Commands....................................................................................... 405

pppoe flush .....................................................................................................................................................................406

pppoe ifadd .....................................................................................................................................................................407

pppoe ifattach.................................................................................................................................................................409

pppoe ifconfig.................................................................................................................................................................410

pppoe ifdelete ................................................................................................................................................................414

pppoe ifdetach ...............................................................................................................................................................415

pppoe iflist ......................................................................................................................................................................416

pppoe ifscan....................................................................................................................................................................417

pppoe rtadd....................................................................................................................................................................418

pppoe rtdelete .................................................................................................................

pppoe relay add.............................................................................................................................................................421

pppoe relay delete ........................................................................................................................................................422

pppoe relay flush ...........................................................................................................................................................423

pppoe relay portlist ......................................................................................................................................................424

pppoe relay sesslist.......................................................................................................................................................425

..............................................420

PPTP Commands......................................................................................... 427

pptp ifadd ........................................................................................................................................................................428

pptp flush.........................................................................................................................................................................429

pptp list............................................................................................................................................................................430

pptp profadd...................................................................................................................................................................431

pptp profdelete..............................................................................................................................................................433

pptp proflist ....................................................................................................................................................................434

QoSBook Commands .................................................................................. 435

qosbook add...................................................................................................................................................................436

qosbook config ..............................................................................................................................................................438

qosbook delete..............................................................................................................................................................439

qosbook flush.................................................................................................................................................................440

qosbook list ....................................................................................................................................................................441

Script Commands ........................................................................................ 443

script add ........................................................................................................................................................................444

script delete....................................................................................................................................................................445

script flush.......................................................................................................................................................................446

script list..........................................................................................................................................................................447

script run.........................................................................................................................................................................448

E-DOC-CTC-20040210-0028 v3.0

SHDSL Commands...................................................................................... 449

shdsl line..........................................................................................................................................................................450

shdsl loopback................................................................................................................................................................451

shdsl stats........................................................................................................................................................................452

shdsl version...................................................................................................................................................................453

shdsl config monitoring................................................................................................................................................454

shdsl config show ..........................................................................................................................................................455

shdsl config side.............................................................................................................................................................456

shdsl config CO 4-wire_mode ...................................................................................................................................457

shdsl config CO annex.................................................................................................................................................458

shdsl config CO margins..............................................................................................................................................459

shdsl config CO rate ....................................................................................................................................................460

shdsl config CO show ..................................................................................................................................................461

shdsl config CO wires..................................................................................................................................................462

shdsl config CPE 4-wire_mode ..................................................................................................................................463

shdsl config CPE delay..................................................................................................................................................464

shdsl config CPE psd.....................................................................................................................................................465

shdsl config CPE show .................................................................................................................................................466

shdsl config CPE wires .................................................................................................................................................467

SIP Commands............................................................................................. 469

sip flush............................................................................................................................................................................470

sip logcall.........................................................................................................................................................................471

sip loglocation ................................................................................................................................................................472

sip proxy .........................................................................................................................................................................473

sip regcreate...................................................................................................................................................................474

sip regdelete ...................................................................................................................................................................475

sip reglist .........................................................................................................................................................................476

sip screen increate ........................................................................................................................................................477

sip screen indelete ........................................................................................................................................................478

sip screen inlist ..............................................................................................................................................................479

sip screen outcreate .....................................................................................................................................................480

sip screen outdelete .....................................................................................................................................................481

sip screen outlist ...........................................................................................................................................................482

E-DOC-CTC-20040210-0028 v3.0

SNMP Commands........................................................................................ 483

snmp config.....................................................................................................................................................................484

snmp flush .......................................................................................................................................................................485

snmp get..........................................................................................................................................................................486

snmp getNext ................................................................................................................................................................487

snmp list ..........................................................................................................................................................................488

snmp trapadd .................................................................................................................................................................489

snmp trapdelete.............................................................................................................................................................490

snmp walk .......................................................................................................................................................................491

SNTP Commands ........................................................................................ 493

sntp add...........................................................................................................................................................................494

sntp config.......................................................................................................................................................................495

sntp del ............................................................................................................................................................................496

sntp flush .........................................................................................................................................................................497

sntp list ............................................................................................................................................................................498

Software Commands ................................................................................... 499

software cleanup ...........................................................................................................................................................500

software deletepassive.................................................................................................................................................501

software duplicate.........................................................................................................................................................502

software setpassive.......................................................................................................................................................503

software switch .............................................................................................................................................................504

software version............................................................................................................................................................505

software addon list .......................................................................................................................................................506

Switch Commands ....................................................................................... 507

switch group flush .........................................................................................................................................................508

switch group list ............................................................................................................................................................509

switch group move .......................................................................................................................................................510

switch mirror capture..................................................................................................................................................511

switch mirror egress ....................................................................................................................................................512

switch mirror ingress ...................................................................................................................................................513

E-DOC-CTC-20040210-0028 v3.0

Syslog Commands........................................................................................ 515

syslog config....................................................................................................................................................................516

syslog flush......................................................................................................................................................................517

syslog list .........................................................................................................................................................................518

syslog ruleadd.................................................................................................................................................................519

syslog ruledelete............................................................................................................................................................520

syslog msgbuf show ......................................................................................................................................................521

syslog msgbuf send........................................................................................................................................................522

System Commands...................................................................................... 523

system clearpassword ..................................................................................................................................................524

system config..................................................................................................................................................................525

system flush ....................................................................................................................................................................526

system reboot................................................................................................................................................................527

system reset ...................................................................................................................................................................528

system setpassword......................................................................................................................................................529

system settime ...............................................................................................................................................................530

system stats ....................................................................................................................................................................531

TD Commands ............................................................................................. 533

td call................................................................................................................................................................................534

UPnP Commands......................................................................................... 535

upnp config .....................................................................................................................................................................536

upnp flush........................................................................................................................................................................537

upnp list...........................................................................................................................................................................538

Abbreviations ............................................................................................... 539

E-DOC-CTC-20040210-0028 v3.0

Syslog Messages............................................................................................ 543

Auto-PVC Module ........................................................................................................................................................544

Configuration Module ..................................................................................................................................................544

DHCP CLient Module .................................................................................................................................................545

DHCP Relay Module ....................................................................................................................................................545

DHCP Server Module..................................................................................................................................................546

Firewall Module .............................................................................................................................................................546

HTTP Module ................................................................................................................................................................546

IPSec Module..................................................................................................................................................................547

Kernel Module ...............................................................................................................................................................548

Linestate Module...........................................................................................................................................................548

Login Module..................................................................................................................................................................548

NAPT Module................................................................................................................................................................548

PPP Module.....................................................................................................................................................................549

PPTP Module..................................................................................................................................................................549

RIP Module .....................................................................................................................................................................550

Routing Module .............................................................................................................................................................551

SIP Multi-media PBX Module .....................................................................................................................................551

SNTP Module.................................................................................................................................................................552

Software Module ...........................................................................................................................................................552

UPnP Module .................................................................................................................................................................552

Supported Key Names ................................................................................ 553

Supported Internet Protocol (IP) Protocol Names ..............................................................................................553

Supported TCP/UDP Port Names............................................................................................................................554

Supported ICMP Type Names ...................................................................................................................................557

Supported Syslog Facilities ..........................................................................................................................................558

Supported Syslog Severities........................................................................................................................................559

E-DOC-CTC-20040210-0028 v3.0

About this Document

Introduction

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

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

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

Applicability

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

• SpeedTouch™610 (i/s) Business DSL Router (R4.2.7(.2))

For readability, all are referred to as SpeedTouch™ throughout this document unless a specific variant is concerned.

Contents

The Reference Guide consists of two main parts:

• CLI Navigation:

This chapter familiarizes the user with the SpeedTouch™ CLI. It describes general manipulations to navigate through the CLI and to perform some operations on the CLI.

• CLI Command Description:

The other chapters describe all the available CLI commands of the SpeedTouch™ per command group and in alphabetical order.

Each command is described in a systematic manner:

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

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

the user and/or the SpeedTouch™

• The syntax of the command with a description of each parameter

• An example to demonstrate the use of the CLI command

• A list of related CLI commands.

E-DOC-CTC-20040210-0028 v3.0

About this Document

Trademarks

The following trademarks are used in this document:

• SpeedTouch™ is a trademark of THOMSON Telecom.

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

• Windows and Internet Explorer are trademarks of Microsoft Corporation.

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

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

• Ethernet is a trademark of Xerox Corporation.

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

Updates

Due to the continuous evolution of SpeedTouch™ technology, existing products are regularly improved.

For more information on the latest technological innovations, software upgrades, and documents, please visit the SpeedTouch™ web site at:

www.speedtouch.com

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Introduction

This chapter familiarizes the user with the SpeedTouch™ CLI. It describes general manipulations:

• to navigate through the CLI

• to perform some operations on the CLI.

Contents

This chapter covers the following topics:

Topi c Pag e

Accessing the Command Line Interface 22

Basic Navigation and Manipulation 24

Command Line Interface Top Level Structure 28

Command Line Interface Commands 29

Menu-driven CLI Navigation 30

Service Template Files and the CLI 33

Direct FTP Access 35

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Accessing the Command Line Interface

Users can access the Command Line Interface via a Telnet session. This requires that TCP/IP connectivity exists between the host from which the Telnet session is opened and the SpeedTouch™.

Users can access the Command Line Interface via:

• The SpeedTouch™ CLI web pages:

This requires that TCP/IP connectivity exists between the host from which the web browser is opened and the SpeedTouch™.

• A Telnet session:

This requires that TCP/IP connectivity exists between the host from which the Telnet session is opened and the SpeedTouch™.

• The serial 'Console' interface.

• Quote site commands (over FTP).

Access via the CLI Web Pages

Proceed as follows to access the SpeedTouch™ CLI via its web interface:

• Browse to the SpeedTouch™ web pages.

• Click Advanced > CLI in the left frame. The CLI web menu opens:

All CLI groups and commands are placed in a menu:

• To open a command group, do one of the following:

• click the mark next to a group name.

• click the group name.

• Click on a command name to open the command:

• Commands without parameters are indicated with and are executed immediately.

• Commands which require additional parameters are indicated with .

• After you have configured all parameters, click Apply to execute the command.

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Access via a Telnet Session or Serial Console

Proceed as follows to open a Telnet session:

1 Open a Command Prompt window, e.g. by clicking Start > All Programs > Accessories > Command Prompt.

2 At the prompt, type telnet followed by the IP address of the SpeedTouch™ (default is 10.0.0.138).

As soon a session to the CLI is opened, the SpeedTouch™ banner pops up, followed by the CLI prompt.

If the SpeedTouch™ is protected by a username and a system password, authentication will be required before access is granted.

The following figure shows an example of the SpeedTouch™610 banner after opening a session and authentication.

Username : johndoe Password : *******

-----------------------------------------------------------------------* * ______ SpeedTouch 610 * ___/_____/\ * / /\\ Version 4.2.7.29 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2003, * // / \ /\ \ THOMSON * _______//_______/ \ / _\/______ * / /\ \/// /\ * __/ / \ \ / / / / _\__ * / / / \_______\/ / / / / /\ * /_/______/___________________/ /________/ /___/ \ * \ \ \ ___________ \ \ \ \ \ / * \_\ \ / /\ \ \ \ \___\/ *\ \/ /\\\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \ / * \ _____ \ /_____\/ * \ / /\ \ /___\/ * /____/\\/ * \ \ /___\/ * \____\/ *

-----------------------------------------------------------------------=>

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Basic Navigation and Manipulation

Manipulation commands are commands that manipulate operations on the command line, for example changing the command group, go to the beginning of the command line, go to the end of the command line, etc.

Command group navigation

From top level, you can change to a command group by executing the name of the desired command group.

To obtain a list of all available command groups, execute help from the top level.

The example below shows every possible CLI command group for the SpeedTouch™610 ADSL/POTS variant:

=>help Following commands are available : help : Displays this help information menu : Displays menu ? : Displays this help information exit : Exits this shell. .. : Exits group selection. saveall : Saves current configuration.

Following command groups are available :

adsl atm autopvc bridge cip config dhcp dns env eth ethoa firewall grp ip ipoa ipqos ipsec label language nat phonebook pppoa pppoe pptp qosbook script sip snmp sntp software switch syslog system td upnp =>

The following command groups are specific for certain variants:

• adsl is only available for the SpeedTouch™610 ADSL/POTS and SpeedTouch™610i ADSL/ISDN variants

• atmf is only applicable for models equipped with an ATMF-25.6Mb/s port

• ipsec is only available on SpeedTouch™610 routers with the IPSEC_VPN software key enabled

• shdsl is only available for the SpeedTouch™610 SHDSL variant

• sip is only available on SpeedTouch™610 routers with the SIP software key enabled

To return to top level, or to go up one level (in case of nested command groups), enter .. at the prompt.

Example:

=>phonebook [phonebook]=> [phonebook]=>.. =>

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

The Help Command

Execute help or ? from top level to list all available commands and command groups for the SpeedTouch™.

Example for the SpeedTouch™610 ADSL/POTS variant:

Following command groups are available :

You can execute the help or ? command from each command group selection. This results in a list of the available commands (and nested command groups, if available) in this particular command group.

Example:

=>firewall [firewall]=> [firewall]=>? Following commands are available :

tron : Enables verbose console messaging. troff : Disables verbose console messaging. match : Defines an ip packet match. assign : Assign a chain to an entry point. list : Shows a list of all the hooks with the chain attached. flush : Clears all hooks. If a hook is provided, that hook is cleared.

Following command groups are available :

chain rule

[firewall]=>

As both help and ? have the exact same functionality in the SpeedTouch™ CLI, the help command may always be equally replaced by the ? command.

Executing e.g. help firewall from top level gives the same result as executing help from the firewall command group selection.

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Example:

=>firewall help Following commands are available :

assign : Assign a chain to an entry point. unassign : Clear a specific hook list : Shows a list of all the hooks with the chains attached. flush : Clears all hooks, chains and rules tron : Enables verbose console messaging. troff : Disables verbose console messaging.

Following command groups are available :

chain rule

Entering help followed by a specific command, e.g. help firewall assign (starting from top level) or help assign (executed from the firewall command group selection) results in a description of the syntax for the command.

Example:

=>help firewall assign Assign a chain to an entry point. Syntax : assign hook = <{input|sink|forward|source|output}> chain = <string>

Parameters :

hook = <{input|sink|forward|source|output}>

Name of hook to assign chain to.

chain = <string>

Name of chain to use.

Executing help all will generate the complete listing of all available CLI commands with syntax description.

Command Completion

The CLI features command completion, which means that when starting to enter a command it can be completed by pressing the TAB key.

For the completion to be successful, the part to be added must be unique. Completion works for the command groups, for the commands, for the options, but not for values.

Example:

Pressing a and TAB at the firewall command group selection results in the full assign command being completed. Entering firewall a and pressing the TAB key from top level gives the same result.

=>firewall [firewall]=>"a+TAB" [firewall]=>assign

Command Line Navigation

• Press CTRL+A to go to the beginning of the command line.

• Press CTRL+L to go to the end of the command line.

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Breaking off Commands

You can break off a command by pressing CTRL+G. This can be useful in a situation where a user is prompted to enter a value which he does not know and wants to quit the command. Instead of being prompted over and over again for the same value, this allows to quit the command and return to the command line prompt.

In the example below, CTRL+G is pressed after the third prompt chain =

[firewall]=>match chain = chain = chain = “CTRL+G” [firewall]=>

History of Commands

Use the UP and DOWN ARROW keys to select a previously executed command. Press ENTER to execute the selected command.

Example:

=>firewall [firewall]=>list assign hook=input chain=input assign hook=sink chain=sink assign hook=forward chain=forward assign hook=source chain=source [firewall]=> “UP ARROW” [firewall]=>:firewall list

E-DOC-CTC-20040210-0028 v3.0

CLI Navigation

Command Line Interface Top Level Structure

The table below shows the available command groups for the different SpeedTouch™ variants:

Command group Available?

adsl Only for the SpeedTouch™610 ADSL/POTS and SpeedTouch™610i ADSL/ISDN variants.

atm Yes.

atmf Only for variants equipped with an ATMF-25.6Mb/s port.

autopvc Yes.

bridge Yes.

cip Yes

config Yes.

dhcp Yes.

dns Yes.

env Yes.

eth Yes.

ethoa Yes.

firewall Yes.

grp Yes.

ip Yes.

ipoa Yes.

ipqos Yes.

ipsec Only when a valid IPSEC_VPN software key has been enabled.

label Yes.

language Yes.

nat Yes.

phonebook Yes.

pppoa Yes.

pppoe Yes.

pptp Yes.

qosbook Yes.

script Yes.

shdsl Only for the SpeedTouch™610 SHDSL variant.

sip Only when a valid SIP software key has been enabled.

snmp Yes.

sntp Yes.

software Yes.

switch Only for SpeedTouch™ devices with a four port switch.

syslog Yes.

system Yes.

td Yes.

upnp Yes.

E-DOC-CTC-20040210-0028 v3.0

+ 534 hidden pages