Alcatel-Lucent SPEEDTOUCH 605S User Manual 1

SpeedTouch™605s

Multi-User SHDSL Gateway

CLI Reference Guide

Release R4.2.7(.2)

600 SERIES

SpeedTouch™

605s

CLI Reference Guide

Release R4.2.7(.2)

Status v3.0 (October 2004)

Reference E-DOC-CTC-20040216-0004

Short Title CLI ST605s 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 .................................................................................... 15

CLI Navigation ............................................................................................... 17

Accessing the Command Line Interface .................................................................................................................... 18

Basic Navigation and Manipulation..............................................................................................................................19

Command Line Interface Top Level Structure ........................................................................................................23

Command Line Interface Commands ........................................................................................................................ 24

Menu-driven CLI Navigation ........................................................................................................................................ 25

Service Template Files and the CLI ............................................................................................................................ 28

Direct FTP Access .......................................................................................................................................................... 30

ATM Commands............................................................................................ 33

atm oam ccconfig ............................................................................................................................................................34

atm oam cclist..................................................................................................................................................................35

atm oam ccsend...............................................................................................................................................................36

atm oam config ................................................................................................................................................................ 37

atm oam mode.................................................................................................................................................................38

atm oam ping.................................................................................................................................................................... 39

atm oam status ................................................................................................................................................................ 40

AutoPVC Commands .................................................................................... 41

autopvc config.................................................................................................................................................................. 42

autopvc info...................................................................................................................................................................... 44

Bridge Commands ......................................................................................... 45

bridge config..................................................................................................................................................................... 46

bridge flush .......................................................................................................................................................................47

bridge ifadd .......................................................................................................................................................................48

bridge ifattach...................................................................................................................................................................49

bridge ifconfig................................................................................................................................................................... 50

bridge ifdelete .................................................................................................................................................................. 52

bridge ifdetach ................................................................................................................................................................. 53

bridge iflist ........................................................................................................................................................................ 54

bridge macadd.................................................................................................................................................................. 55

bridge macdelete.............................................................................................................................................................56

bridge maclist ................................................................................................................................................................... 57

E-DOC-CTC-20040216-0004 v3.0

CIP Commands .............................................................................................. 59

cip flush.............................................................................................................................................................................. 60

cip ifadd .............................................................................................................................................................................61

cip ifdelete......................................................................................................................................................................... 62

cip iflist...............................................................................................................................................................................63

cip pvcadd ......................................................................................................................................................................... 64

cip pvcdelete .................................................................................................................................................................... 65

cip pvclist........................................................................................................................................................................... 66

Config Commands ......................................................................................... 67

config backup....................................................................................................................................................................68

config dump ......................................................................................................................................................................69

config erase....................................................................................................................................................................... 70

config flush ........................................................................................................................................................................71

config list ........................................................................................................................................................................... 72

config load......................................................................................................................................................................... 73

config save......................................................................................................................................................................... 75

E-DOC-CTC-20040216-0004 v3.0

DHCP Commands ......................................................................................... 77

dhcp client clear .............................................................................................................................................................. 79

dhcp client config ............................................................................................................................................................ 80

dhcp client flush............................................................................................................................................................... 81

dhcp client ifadd............................................................................................................................................................... 82

dhcp client ifattach ..........................................................................................................................................................83

dhcp client ifconfig ..........................................................................................................................................................84

dhcp client ifdelete.......................................................................................................................................................... 86

dhcp client iflist................................................................................................................................................................87

dhcp client ifrelease ........................................................................................................................................................ 88

dhcp client ifrenew .........................................................................................................................................................91

dhcp client stats............................................................................................................................................................... 94

dhcp relay add.................................................................................................................................................................. 95

dhcp relay config ............................................................................................................................................................. 96

dhcp relay delete............................................................................................................................................................. 97

dhcp relay flush................................................................................................................................................................ 98

dhcp relay ifconfig ...........................................................................................................................................................99

dhcp relay iflist...............................................................................................................................................................100

dhcp relay list .................................................................................................................................................................101

dhcp relay stats..............................................................................................................................................................102

dhcp server clear...........................................................................................................................................................103

dhcp server config.........................................................................................................................................................104

dhcp server flush ...........................................................................................................................................................105

dhcp server policy.........................................................................................................................................................106

dhcp server stats ...........................................................................................................................................................107

dhcp server lease add...................................................................................................................................................109

dhcp server lease delete..............................................................................................................................................111

dhcp server lease flush.................................................................................................................................................112

dhcp server lease list....................................................................................................................................................113

dhcp server pool add ...................................................................................................................................................114

dhcp server pool config ...............................................................................................................................................115

dhcp server pool delete...............................................................................................................................................117

dhcp server pool flush .................................................................................................................................................118

dhcp server pool list.....................................................................................................................................................119

E-DOC-CTC-20040216-0004 v3.0

DNS Commands .......................................................................................... 121

dns add ............................................................................................................................................................................122

dns clear ..........................................................................................................................................................................123

dns clrstats......................................................................................................................................................................124

dns delete........................................................................................................................................................................125

dns domain .....................................................................................................................................................................126

dns flush...........................................................................................................................................................................127

dns fwdadd......................................................................................................................................................................128

dns fwddelete.................................................................................................................................................................129

dns fwdlist .......................................................................................................................................................................130

dns fwdtable ...................................................................................................................................................................131

dns list..............................................................................................................................................................................132

dns nslookup ..................................................................................................................................................................133

dns start...........................................................................................................................................................................134

dns stats...........................................................................................................................................................................135

dns status ........................................................................................................................................................................136

dns stop...........................................................................................................................................................................137

dns toutfwd ....................................................................................................................................................................138

dns troff...........................................................................................................................................................................139

dns tron...........................................................................................................................................................................140

Env Commands ............................................................................................ 141

env flush ..........................................................................................................................................................................142

env get .............................................................................................................................................................................143

env list..............................................................................................................................................................................144

env set .............................................................................................................................................................................145

env unset.........................................................................................................................................................................146

Eth Commands............................................................................................. 147

eth config.........................................................................................................................................................................148

eth ifconfig ......................................................................................................................................................................149

eth iflist ............................................................................................................................................................................150

E-DOC-CTC-20040216-0004 v3.0

ETHoA Commands ..................................................................................... 151

ethoa flush.......................................................................................................................................................................152

ethoa ifadd ......................................................................................................................................................................153

ethoa ifattach..................................................................................................................................................................154

ethoa ifconfig..................................................................................................................................................................155

ethoa ifdelete .................................................................................................................................................................157

ethoa ifdetach.................................................................................................................................................................158

ethoa iflist........................................................................................................................................................................159

Firewall Commands..................................................................................... 161

firewall assign .................................................................................................................................................................162

firewall flush....................................................................................................................................................................164

firewall list.......................................................................................................................................................................165

firewall troff....................................................................................................................................................................166

firewall tron....................................................................................................................................................................167

firewall unassign.............................................................................................................................................................168

firewall chain create......................................................................................................................................................169

firewall chain delete......................................................................................................................................................170

firewall chain flush.........................................................................................................................................................171

firewall chain list ............................................................................................................................................................172

firewall rule clear...........................................................................................................................................................173

firewall rule create........................................................................................................................................................174

firewall rule delete ........................................................................................................................................................178

firewall rule flush ...........................................................................................................................................................179

firewall rule list ..............................................................................................................................................................180

firewall rule stats ...........................................................................................................................................................181

E-DOC-CTC-20040216-0004 v3.0

IP Commands ............................................................................................... 183

ip apadd ...........................................................................................................................................................................184

ip apdelete.......................................................................................................................................................................186

ip aplist.............................................................................................................................................................................187

ip arpadd .........................................................................................................................................................................188

ip arpdelete.....................................................................................................................................................................189

ip arplist...........................................................................................................................................................................190

ip config ...........................................................................................................................................................................191

ip flush..............................................................................................................................................................................194

ip ifconfig .........................................................................................................................................................................195

ip iflist...............................................................................................................................................................................196

ip ifwait ............................................................................................................................................................................197

ip mcadd..........................................................................................................................................................................198

ip mcdelete .....................................................................................................................................................................199

ip mclist ...........................................................................................................................................................................200

ip ping...............................................................................................................................................................................201

ip rtadd ............................................................................................................................................................................202

ip rtdelete .......................................................................................................................................................................203

ip rtlist..............................................................................................................................................................................204

ip sendto..........................................................................................................................................................................205

ip traceroute ..................................................................................................................................................................206

ip auto flush ....................................................................................................................................................................207

ip auto ifadd....................................................................................................................................................................208

ip auto ifattach ...............................................................................................................................................................209

ip auto ifconfig................................................................................................................................................................210

ip auto ifdelete ...............................................................................................................................................................211

ip auto ifdetach ..............................................................................................................................................................212

ip auto iflist .....................................................................................................................................................................213

IPoA Commands.......................................................................................... 215

ipoa flush .........................................................................................................................................................................216

ipoa ifadd.........................................................................................................................................................................217

ipoa ifattach ....................................................................................................................................................................218

ipoa ifconfig.....................................................................................................................................................................219

ipoa ifdelete ....................................................................................................................................................................221

ipoa ifdetach ...................................................................................................................................................................222

ipoa iflist ..........................................................................................................................................................................223

E-DOC-CTC-20040216-0004 v3.0

IPQoS Commands ....................................................................................... 225

ipqos config.....................................................................................................................................................................226

ipqos list ..........................................................................................................................................................................228

ipqos queue clear ..........................................................................................................................................................229

ipqos queue config ........................................................................................................................................................230

ipqos queue list..............................................................................................................................................................232

ipqos queue stats...........................................................................................................................................................233

Label Commands ......................................................................................... 235

label add ..........................................................................................................................................................................236

label config ......................................................................................................................................................................237

label delete......................................................................................................................................................................239

label flush.........................................................................................................................................................................240

label list............................................................................................................................................................................241

label troff.........................................................................................................................................................................242

label tron.........................................................................................................................................................................243

label chain create...........................................................................................................................................................244

label chain delete...........................................................................................................................................................245

label chain flush..............................................................................................................................................................246

label chain list.................................................................................................................................................................247

label rule clear................................................................................................................................................................248

label rule create.............................................................................................................................................................249

label rule delete .............................................................................................................................................................252

label rule flush ................................................................................................................................................................253

label rule list ...................................................................................................................................................................254

label rule stats ................................................................................................................................................................255

Language Commands .................................................................................. 257

language config...............................................................................................................................................................258

language list.....................................................................................................................................................................259

language remove............................................................................................................................................................260

E-DOC-CTC-20040216-0004 v3.0

NAT Commands .......................................................................................... 261

nat applist........................................................................................................................................................................262

nat bind............................................................................................................................................................................263

nat bindlist.......................................................................................................................................................................264

nat clear...........................................................................................................................................................................266

nat config.........................................................................................................................................................................267

nat create........................................................................................................................................................................268

nat defserver ..................................................................................................................................................................270

nat delete ........................................................................................................................................................................271

nat disable .......................................................................................................................................................................273

nat enable........................................................................................................................................................................274

nat flush ...........................................................................................................................................................................276

nat list ..............................................................................................................................................................................277

nat multinatadd ..............................................................................................................................................................278

nat multinatdelete .........................................................................................................................................................279

nat multinatlist ...............................................................................................................................................................280

nat unbind .......................................................................................................................................................................281

Phonebook Commands ............................................................................... 283

phonebook add..............................................................................................................................................................284

phonebook autolist.......................................................................................................................................................286

phonebook delete.........................................................................................................................................................287

phonebook flush............................................................................................................................................................288

phonebook list ...............................................................................................................................................................289

PPPoA Commands ...................................................................................... 291

pppoa flush......................................................................................................................................................................292

pppoa ifadd .....................................................................................................................................................................293

pppoa ifattach.................................................................................................................................................................295

pppoa ifconfig .................................................................................................................................................................296

pppoa ifdelete.................................................................................................................................................................300

pppoa ifdetach................................................................................................................................................................301

pppoa iflist.......................................................................................................................................................................302

pppoa rtadd ....................................................................................................................................................................303

pppoa rtdelete ...............................................................................................................................................................305

E-DOC-CTC-20040216-0004 v3.0

PPPoE Commands....................................................................................... 307

pppoe flush .....................................................................................................................................................................308

pppoe ifadd .....................................................................................................................................................................309

pppoe ifattach.................................................................................................................................................................311

pppoe ifconfig.................................................................................................................................................................312

pppoe ifdelete ................................................................................................................................................................316

pppoe ifdetach ...............................................................................................................................................................317

pppoe iflist ......................................................................................................................................................................318

pppoe ifscan....................................................................................................................................................................319

pppoe rtadd....................................................................................................................................................................320

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

pppoe relay add.............................................................................................................................................................323

pppoe relay delete ........................................................................................................................................................324

pppoe relay flush ...........................................................................................................................................................325

pppoe relay portlist ......................................................................................................................................................326

pppoe relay sesslist.......................................................................................................................................................327

..............................................322

PPTP Commands......................................................................................... 329

pptp ifadd ........................................................................................................................................................................330

pptp flush.........................................................................................................................................................................331

pptp list............................................................................................................................................................................332

pptp profadd...................................................................................................................................................................333

pptp profdelete..............................................................................................................................................................335

pptp proflist ....................................................................................................................................................................336

QoSBook Commands .................................................................................. 337

qosbook add...................................................................................................................................................................338

qosbook config ..............................................................................................................................................................340

qosbook delete..............................................................................................................................................................341

qosbook flush.................................................................................................................................................................342

qosbook list ....................................................................................................................................................................343

Script Commands ........................................................................................ 345

script add ........................................................................................................................................................................346

script delete....................................................................................................................................................................347

script flush.......................................................................................................................................................................348

script list..........................................................................................................................................................................349

script run.........................................................................................................................................................................350

E-DOC-CTC-20040216-0004 v3.0

SHDSL Commands...................................................................................... 351

shdsl line..........................................................................................................................................................................352

shdsl loopback................................................................................................................................................................353

shdsl stats........................................................................................................................................................................354

shdsl version...................................................................................................................................................................355

shdsl config monitoring................................................................................................................................................356

shdsl config show ..........................................................................................................................................................357

shdsl config side.............................................................................................................................................................358

shdsl config CO annex.................................................................................................................................................359

shdsl config CO margins..............................................................................................................................................360

shdsl config CO rate ....................................................................................................................................................361

shdsl config CO show ..................................................................................................................................................362

shdsl config CPE psd.....................................................................................................................................................363

shdsl config CPE show .................................................................................................................................................364

SNMP Commands........................................................................................ 365

snmp config.....................................................................................................................................................................366

snmp get..........................................................................................................................................................................367

snmp getNext ................................................................................................................................................................368

snmp list ..........................................................................................................................................................................369

snmp walk .......................................................................................................................................................................370

Software Commands ................................................................................... 371

software version............................................................................................................................................................372

software upgrade ..........................................................................................................................................................373

System Commands...................................................................................... 375

system clearpassword ..................................................................................................................................................376

system config..................................................................................................................................................................377

system flush ....................................................................................................................................................................378

system reboot................................................................................................................................................................379

system reset ...................................................................................................................................................................380

system setpassword......................................................................................................................................................381

system stats ....................................................................................................................................................................382

Systemlog Commands................................................................................. 383

systemlog flush...............................................................................................................................................................384

systemlog show .............................................................................................................................................................385

systemlog send...............................................................................................................................................................386

E-DOC-CTC-20040216-0004 v3.0

TD Commands ............................................................................................. 387

td call................................................................................................................................................................................388

UPnP Commands......................................................................................... 389

upnp config .....................................................................................................................................................................390

upnp flush........................................................................................................................................................................392

upnp list...........................................................................................................................................................................393

Abbreviations ............................................................................................... 395

Syslog Messages............................................................................................ 399

Auto-PVC Module ........................................................................................................................................................400

Configuration Module ..................................................................................................................................................400

DHCP CLient Module .................................................................................................................................................401

DHCP Relay Module ....................................................................................................................................................401

DHCP Server Module..................................................................................................................................................402

Firewall Module .............................................................................................................................................................402

HTTP Module ................................................................................................................................................................402

Kernel Module ...............................................................................................................................................................403

Linestate Module...........................................................................................................................................................403

Login Module..................................................................................................................................................................403

NAPT Module................................................................................................................................................................403

PPP Module.....................................................................................................................................................................404

PPTP Module..................................................................................................................................................................404

Routing Module .............................................................................................................................................................404

Software Module ...........................................................................................................................................................405

UPnP Module .................................................................................................................................................................405

Supported Key Names ................................................................................ 407

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

Supported TCP/UDP Port Names............................................................................................................................408

Supported ICMP Type Names ...................................................................................................................................411

Supported Syslog Facilities ..........................................................................................................................................412

Supported Syslog Severities........................................................................................................................................413

E-DOC-CTC-20040216-0004 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™605s Multi-User SHDSL Gateway (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-20040216-0004 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-20040216-0004 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 18

Basic Navigation and Manipulation 19

Command Line Interface Top Level Structure 23

Command Line Interface Commands 24

Menu-driven CLI Navigation 25

Service Template Files and the CLI 28

Direct FTP Access 30

E-DOC-CTC-20040216-0004 v3.0

CLI Navigation

Accessing the Command Line Interface

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™605s banner after opening a session and authentication.

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

-----------------------------------------------------------------------* * ______ SpeedTouch 605s * ___/_____/\ * / /\\ Version 4.2.7.29.0 * _____/__ / \\ * _/ /\_____/___ \ Copyright (c) 1999-2004, * // / \ /\ \ THOMSON * _______//_______/ \ / _\/______ * / /\ \/// /\ * __/ / \ \ / / / / _\__ * / / / \_______\/ / / / / /\ * /_/______/___________________/ /________/ /___/ \ * \ \ \ ___________ \ \ \ \ \ / * \_\ \ / /\ \ \ \ \___\/ *\ \/ /\\\ \/ * \_____/ / \ \ \________\/ * /__________/ \ \ / * \ _____ \ /_____\/ * \ / /\ \ /___\/ * /____/\\/ * \ \ /___\/ * \____\/ *

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

E-DOC-CTC-20040216-0004 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™605s.

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

atm autopvc bridge cip config dhcp dns env eth ethoa firewall ip ipoa ipqos label language nat phonebook pppoa pppoe pptp qosbook script shdsl snmp software system systemlog td upnp

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-20040216-0004 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™605s:

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

atm autopvc bridge cip config dhcp dns env eth ethoa firewall ip ipoa ipqos label language nat phonebook pppoa pppoe pptp qosbook script shdsl snmp software system systemlog td upnp

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-20040216-0004 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-20040216-0004 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-20040216-0004 v3.0

Command Line Interface Top Level Structure

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

Command group Available?

atm Yes.

autopvc Yes.

bridge Yes.

cip Yes

config Yes.

dhcp Yes.

dns Yes.

env Yes.

eth Yes.

ethoa Yes.

firewall Yes.

ip Yes.

ipoa Yes.

ipqos Yes.

label Yes.

language Yes.

nat Yes.

phonebook Yes.

pppoa Yes.

pppoe Yes.

pptp Yes.

qosbook Yes.

script Yes.

shdsl Yes.

snmp Yes.

software Yes.

system Yes.

systemlog Yes.

td Yes.

upnp Yes.

CLI Navigation

E-DOC-CTC-20040216-0004 v3.0

CLI Navigation

Command Line Interface Commands

Command Execution

All CLI commands are commands that operate on, or configure, the SpeedTouch™ settings. The CLI commands can be executed:

• from top level, preceded by the name of the command group from which the command should be executed.

E. g. firewall list.

=>firewall list assign hook=input chain=input assign hook=sink chain=sink assign hook=forward chain=forward assign hook=source chain=source =>

• from within the command group itself, using the reduced form of the command.

E.g. list at the firewall command group selection.

=>firewall [firewall]=>list assign hook=input chain=input assign hook=sink chain=sink assign hook=forward chain=forward assign hook=source chain=source [firewall]=>

Note ! in a command means ‘NOT‘, e.g. the [!]syn parameter in the firewall rule create command.

Entering a CLI Command

A CLI command can be entered in one of the following ways:

1 As a completely built-up command with all its parameters.

E.g. the command firewall assign hook=input chain=input.

=>firewall assign hook=input chain=input =>

2 Just the command itself without its parameters. After pressing Enter, you are prompted to complete the command

with the required and the optional parameters. The example below is the equivalent of the command firewall assign hook=input chain=input.

=>firewall assign hook = input chain = input =>

• For required CLI command parameter values, either enter a value or scroll through the possible values with

the arrow keys.

• For optional CLI command parameters, either enter a value or simply press Enter without giving a value.

Note This manner of entering a command is not applicable to all the CLI commands.

E.g. system config, upnp config, ...

E-DOC-CTC-20040216-0004 v3.0

Menu-driven CLI Navigation

Introduction

To improve the user-friendliness of the SpeedTouch™ CLI, the CLI features a menu-driven interface. The semi-graphical menu offers an attractive and easy-to-use configuration environment for the CLI.

Calling the menu

To call the menu-driven interface, type menu at the CLI prompt.

Example:

CLI Navigation

Leaving the menu

To leave the menu-driven interface, use the TAB key to go to the Cancel field and press ENTER.

Note This can be done on any level of the menu, i.e. there is no need to return to the top level.

Navigating through the menu

Follow the procedure below to navigate through the menu and select CLI commands:

1 Browse through the CLI command groups with the ARROW keys:

2 Press ENTER to select a command group. The figure below shows the menu after the phonebook command group

has been selected:

E-DOC-CTC-20040216-0004 v3.0

CLI Navigation

3 Browse through the CLI commands with the ARROW keys or select .. to go back up one level:

4 Press ENTER to select the command. The figure below shows the menu after the add command has been

selected:

Entering parameter values

1 Browse through the parameters with the ARROW keys:

2 To enter a value for a parameter, press ENTER:

3 Fill in the parameter value and press ENTER:

E-DOC-CTC-20040216-0004 v3.0

CLI Navigation

4 Use the ARROW keys to scroll to the next parameter:

5 When all the necessary parameters have been entered, use the TAB key to go to the OK field and press ENTER.

Note Do not forget to save your changes by executing saveall (from any CLI prompt).

Preset parameter values

In case preset values are provided for a parameter, they are shown at the bottom of the menu.

You can scroll through these preset values with the ARROW keys or enter the value manually.

E-DOC-CTC-20040216-0004 v3.0

CLI Navigation

Service Template Files and the CLI

Service Template Files

The Service Template files, used by the Setup wizard, or directly uploaded via the SpeedTouch™ web pages, consist of a set of CLI commands. Only CLI commands, which are part of the SpeedTouch™ CLI command set, may be used in the .ini and .def files.

For readability, Service Template files are partitioned in paragraphs. These paragraphs reflect a CLI command group selection in the SpeedTouch™ CLI. However, due to internal processing, not all paragraph names are the same as their corresponding CLI command group selection, as shown in the table below:

[<configuration>.ini] paragraphs

[autoip.ini] The ip auto CLI command subgroup

[autopvc.ini] The autopvc CLI command subgroup

[bridge.ini] The bridge CLI command group

[cip.ini] The cip CLI command group

[dhcc.ini] The dhcp client CLI command subgroup

[dhcp.ini] The dhcp server CLI command subgroup

[dhcr.ini] The dhcp relay CLI command subgroup

[diagnostics.ini] The ip ping CLI command

[dnsc.ini] and [dnsd.ini] The dns CLI command group

[env.ini] The env CLI command group

[eth.ini] The eth CLI command group

[ethoa.ini] The ethoa CLI command group

[ip.ini] The ip CLI command group

Available SpeedTouch™ CLI commands

[ipoa.ini] The cip CLI command group

[ipqos.ini] The ipqos CLI command group

[label.ini] The label CLI command group

[language.ini] The language CLI command group

[nat.ini] The nat CLI command group

[oam.ini] The atm oam CLI command subgroup

[pfirewall.ini] The firewall CLI command group

[phone.ini] The phonebook CLI command group

[pppoa.ini] The pppoa CLI command group

[pppoe.ini] The pppoe CLI command group

[pppoerelay.ini] The pppoe relay CLI command subgroup

E-DOC-CTC-20040216-0004 v3.0

+ 388 hidden pages