Alcatel-lucent SPEED TOUCH 510, SPEDDTOUCH 510 1, 530, SPEED TOUCH 570, 510I 1 Manual

SpeedTouchTM

510(i)/530/570(i) Multi-User ADSL Gateways CLI Reference Guide

500 SERIES

SpeedTouchTM

500Series

CLI Reference Guide

Release R4.0

Status Released

Change Note PeckelbeenS

Short Title CLI ST500Series R4.0

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

Content
About this Document ......................................................................................................................................................	9
Accessing the Command Line Interface ....................................................................................................................	11
Basic Navigation and Manipulation..............................................................................................................................	12
Command Line Interface Top Level Structure ........................................................................................................	17
Command Line Interface Commands ........................................................................................................................	18
Menu-driven CLI Navigation ........................................................................................................................................	19
Configuration Profile Files and the CLI......................................................................................................................	20
Direct FTP Access ..........................................................................................................................................................	22
ADSL Commands ..........................................................................................	25
adsl config .........................................................................................................................................................................	26
adsl info .............................................................................................................................................................................	27
ATM Commands............................................................................................	29
atm portstats....................................................................................................................................................................	30
atm oam config ................................................................................................................................................................	31
atm oam status ................................................................................................................................................................	32
Bridge Commands .........................................................................................	33
bridge config.....................................................................................................................................................................	34
bridge flush .......................................................................................................................................................................	35
bridge ifadd .......................................................................................................................................................................	36
bridge ifattach...................................................................................................................................................................	39
bridge ifconfig...................................................................................................................................................................	42
bridge ifdelete ..................................................................................................................................................................	44
bridge ifdetach .................................................................................................................................................................	45
bridge iflist ........................................................................................................................................................................	46
bridge macadd..................................................................................................................................................................	48
bridge macdelete.............................................................................................................................................................	49
bridge maclist ...................................................................................................................................................................	50

E-SIT-CTC-20021203-0003 v1.0	1

CIP Commands ..............................................................................................	51
cip flush..............................................................................................................................................................................	52
cip ifadd .............................................................................................................................................................................	53
cip ifdelete.........................................................................................................................................................................	54
cip iflist...............................................................................................................................................................................	55
cip pvcadd .........................................................................................................................................................................	57
cip pvcdelete ....................................................................................................................................................................	58
cip pvclist...........................................................................................................................................................................	59
Config Commands .........................................................................................	61
config erase.......................................................................................................................................................................	62
config flush ........................................................................................................................................................................	63
config load.........................................................................................................................................................................	64
config save.........................................................................................................................................................................	65

2	E-SIT-CTC-20021203-0003 v1.0

DHCP Commands .........................................................................................

67

dhcp client clear ..............................................................................................................................................................	68
dhcp client config ............................................................................................................................................................	69
dhcp client flush...............................................................................................................................................................	70
dhcp client ifadd...............................................................................................................................................................	71
dhcp client ifattach..........................................................................................................................................................	72
dhcp client ifconfig ..........................................................................................................................................................	73
dhcp client ifdelete..........................................................................................................................................................	75
dhcp client iflist................................................................................................................................................................	76
dhcp client ifrelease ........................................................................................................................................................	77
dhcp client ifrenew .........................................................................................................................................................	79
dhcp client stats...............................................................................................................................................................	81
dhcp server clear.............................................................................................................................................................	82
dhcp server config...........................................................................................................................................................	83
dhcp server flush .............................................................................................................................................................	84
dhcp server policy...........................................................................................................................................................	85
dhcp server spoof ...........................................................................................................................................................	86
dhcp server start.............................................................................................................................................................	87
dhcp server stats.............................................................................................................................................................	88
dhcp server stop .............................................................................................................................................................	90
dhcp server lease add.....................................................................................................................................................	91
dhcp server lease delete................................................................................................................................................	93
dhcp server lease flush...................................................................................................................................................	94
dhcp server lease list......................................................................................................................................................	95
dhcp server pool add .....................................................................................................................................................	96
dhcp server pool config .................................................................................................................................................	98
dhcp server pool delete...............................................................................................................................................	100
dhcp server pool flush .................................................................................................................................................	101
dhcp server pool list.....................................................................................................................................................	102

E-SIT-CTC-20021203-0003 v1.0	3

DNS Commands ..........................................................................................	103
dns add ............................................................................................................................................................................	104
dns clear ..........................................................................................................................................................................	105
dns clrstats......................................................................................................................................................................	106
dns delete........................................................................................................................................................................	107
dns domain .....................................................................................................................................................................	108
dns flush...........................................................................................................................................................................	109
dns fwdadd......................................................................................................................................................................	110
dns fwddelete.................................................................................................................................................................	111
dns fwdlist .......................................................................................................................................................................	112
dns fwdtable ...................................................................................................................................................................	113
dns list..............................................................................................................................................................................	114
dns nslookup ..................................................................................................................................................................	115
dns start...........................................................................................................................................................................	116
dns stats...........................................................................................................................................................................	117
dns status ........................................................................................................................................................................	118
dns stop...........................................................................................................................................................................	119
dns toutfwd ....................................................................................................................................................................	120
dns troff...........................................................................................................................................................................	121
dns tron...........................................................................................................................................................................	122
Env Commands ............................................................................................	123
env def .............................................................................................................................................................................	124
env flush ..........................................................................................................................................................................	125
env get .............................................................................................................................................................................	128
env list..............................................................................................................................................................................	129
env set .............................................................................................................................................................................	130
env unset.........................................................................................................................................................................	131
Eth Commands.............................................................................................	133
eth ifconfig ......................................................................................................................................................................	134
eth iflist ............................................................................................................................................................................	135

4	E-SIT-CTC-20021203-0003 v1.0

Firewall Commands.....................................................................................	137
firewall assign .................................................................................................................................................................	138
firewall flush....................................................................................................................................................................	139
firewall list.......................................................................................................................................................................	140
firewall troff....................................................................................................................................................................	141
firewall tron....................................................................................................................................................................	142
firewall unassign.............................................................................................................................................................	143
firewall chain create......................................................................................................................................................	144
firewall chain delete......................................................................................................................................................	145
firewall chain list ............................................................................................................................................................	146
firewall rule clear...........................................................................................................................................................	147
firewall rule create........................................................................................................................................................	148
firewall rule delete ........................................................................................................................................................	152
firewall rule flush ...........................................................................................................................................................	153
firewall rule list ..............................................................................................................................................................	154
firewall rule stats...........................................................................................................................................................	155
IP Commands...............................................................................................	157
ip apadd ...........................................................................................................................................................................	158
ip apdelete.......................................................................................................................................................................	160
ip aplist.............................................................................................................................................................................	161
ip arpadd .........................................................................................................................................................................	162
ip arpdelete.....................................................................................................................................................................	163
ip arplist...........................................................................................................................................................................	164
ip config ...........................................................................................................................................................................	165
ip flush..............................................................................................................................................................................	168
ip ifconfig .........................................................................................................................................................................	169
ip iflist...............................................................................................................................................................................	170
ip ping...............................................................................................................................................................................	171
ip rtadd ............................................................................................................................................................................	172
ip rtdelete .......................................................................................................................................................................	174
ip rtlist..............................................................................................................................................................................	175
ip sendto..........................................................................................................................................................................	176

E-SIT-CTC-20021203-0003 v1.0	5

IPoA Commands..........................................................................................	177
ipoa flush .........................................................................................................................................................................	178
ipoa ifadd.........................................................................................................................................................................	179
ipoa ifattach ....................................................................................................................................................................	180
ipoa ifconfig.....................................................................................................................................................................	181
ipoa ifdelete ....................................................................................................................................................................	183
ipoa ifdetach ...................................................................................................................................................................	184
ipoa iflist ..........................................................................................................................................................................	185
MER Commands ..........................................................................................	187
mer flush .........................................................................................................................................................................	188
mer ifadd .........................................................................................................................................................................	189
mer ifattach.....................................................................................................................................................................	190
mer ifconfig.....................................................................................................................................................................	191
mer ifdelete ....................................................................................................................................................................	193
mer ifdetach....................................................................................................................................................................	194
mer iflist ..........................................................................................................................................................................	195
NAT Commands..........................................................................................	197
nat applist........................................................................................................................................................................	198
nat bind............................................................................................................................................................................	199
nat bindlist.......................................................................................................................................................................	200
nat create ........................................................................................................................................................................	201
nat defserver ..................................................................................................................................................................	203
nat delete ........................................................................................................................................................................	204
nat disable .......................................................................................................................................................................	206
nat enable........................................................................................................................................................................	207
nat flush ...........................................................................................................................................................................	208
nat list ..............................................................................................................................................................................	209
nat unbind .......................................................................................................................................................................	210
Phonebook Commands ...............................................................................	211
phonebook add..............................................................................................................................................................	212
phonebook autolist.......................................................................................................................................................	214
phonebook delete.........................................................................................................................................................	215
phonebook flush............................................................................................................................................................	216
phonebook list ...............................................................................................................................................................	217

6	E-SIT-CTC-20021203-0003 v1.0

PPP Commands ...........................................................................................	219
ppp flush ..........................................................................................................................................................................	220
ppp ifadd..........................................................................................................................................................................	221
ppp ifattach .....................................................................................................................................................................	223
ppp ifconfig......................................................................................................................................................................	225
ppp ifdelete .....................................................................................................................................................................	230
ppp ifdetach ....................................................................................................................................................................	232
ppp iflist ...........................................................................................................................................................................	233
ppp ifscan ........................................................................................................................................................................	234
ppp rtadd.........................................................................................................................................................................	235
ppp rtdelete....................................................................................................................................................................	237
PPTP Commands.........................................................................................	239
pptp flush.........................................................................................................................................................................	240
pptp list............................................................................................................................................................................	241
pptp profadd...................................................................................................................................................................	242
pptp profdelete..............................................................................................................................................................	243
pptp proflist ....................................................................................................................................................................	244
QoSBook Commands..................................................................................	245
qosbook add...................................................................................................................................................................	246
qosbook delete..............................................................................................................................................................	248
qosbook flush.................................................................................................................................................................	249
qosbook list ....................................................................................................................................................................	250
Software Commands ...................................................................................	251
software cleanup ...........................................................................................................................................................	252
software deletepassive.................................................................................................................................................	253
software duplicate.........................................................................................................................................................	254
software setpassive.......................................................................................................................................................	255
software switch .............................................................................................................................................................	256
software version............................................................................................................................................................	257

E-SIT-CTC-20021203-0003 v1.0	7

System Commands......................................................................................	259
system clearpassword ..................................................................................................................................................	260
system config..................................................................................................................................................................	261
system flush ....................................................................................................................................................................	262
system reboot................................................................................................................................................................	263
system reset ...................................................................................................................................................................	264
system setpassword......................................................................................................................................................	265
TD Commands .............................................................................................	267
td call................................................................................................................................................................................	268
UPnP Commands.........................................................................................	269
upnp config .....................................................................................................................................................................	270
upnp flush........................................................................................................................................................................	271
upnp list ...........................................................................................................................................................................	272
Wireless Commands ...................................................................................	273
wireless wepconfig........................................................................................................................................................	274
wireless aclconfig...........................................................................................................................................................	275
wireless acllist ................................................................................................................................................................	276
wireless aclflush .............................................................................................................................................................	277
wireless aclentry............................................................................................................................................................	278
wireless ifconfig .............................................................................................................................................................	279
wireless status................................................................................................................................................................	281
wireless counters ..........................................................................................................................................................	282
wireless scan ..................................................................................................................................................................	283
wireless flush..................................................................................................................................................................	284
Abbreviations ...............................................................................................	285
Supported Key Names ................................................................................	289
Supported Internet Protocol (IP) Protocol Names ..............................................................................................	289
Supported TCP/UDP Port Names............................................................................................................................	290
Supported ICMP Type Names ...................................................................................................................................	293

8	E-SIT-CTC-20021203-0003 v1.0

About this Document

Introduction

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

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

For the fastidious user this Reference Guide aims to give a handbook for advanced and detailed configuration and troubleshooting of the SpeedTouchTM500Series via its character based Command Line Interface.

This CLI Reference Guide covers the CLI commands of the following DSL SpeedTouchTM products:

•SpeedTouchTM510

•SpeedTouchTM510i

•SpeedTouchTM530

•SpeedTouchTM570

•SpeedTouchTM570i

Contents

The Reference Guide consists of two main parts:

•CLI Navigation

The CLI navigation is decribed in this chapter. Here the user is familiarised with the SpeedTouchTM500Series CLI. It describes general manipulations to navigate through and to perform some operations on the CLI.

•CLI Command Description

The other chapters describe all the available CLI commands of the SpeedTouchTM500Series 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 needed completed by a description of the possible impact on the user and/or the SpeedTouchTM500Series

•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-SIT-CTC-20021203-0003 v1.0	9

Trademarks

The following trademarks are used in this document:

•SpeedTouchTM is a trademark of THOMSON

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

•Windows and Internet Explorer are trademarks of Microsoft Corporation

•Apple‚ and Mac‚OS 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 DSL technology, existing products are regularly upgraded.

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

http://www.speedtouch.com

Directive

Unless expressly and unambiguously approved by THOMSON, you may not:

•disassemble, de-compile, reverse engineer, trace or otherwise analyze the equipment, its content, operation, or functionality, or otherwise attempt to derive source code (or the underlying ideas, algorithms, structure or organization) from the equipment or from any other information provided by THOMSON, except to the extent that this restriction is expressly prohibited by local law;

•copy, rent, loan, re-sell, sublicense, or otherwise transfer or distribute the equipment to others;

•modify, adapt or create a derivative work of the equipment;

•remove from any copies of the equipment any product identification, copyright or other notices;

•disseminate performance information or analysis (including, without limitation, benchmarks) from any source relating to the equipment.

•Such acts not expressly approved by THOMSON will result in the loss of product warranty and will invalidate the user's authority to operate this equipment.

10	E-SIT-CTC-20021203-0003 v1.0

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

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

In case the SpeedTouchTM500Series is protected by a System password, authentication will be required before access is granted.

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

/home/doejohn{1}$ telnet 10.0.0.138 Trying 10.0.0.138...

Connected to 10.0.0.138. Username :

Password : ######

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

*

*

______

Speedtouch

510

*

___/_____/\

*

/

/\\

Version R4.0.0.9.0

*

_____/__

/

\\

*

_/

/\_____/___ \

Copyright (c) 1999-2002,

*

//

/

\

/\ \

THOMSON multimedia

*

_______//_______/

\

/ _\/______

*

/

/ \

\

/

/ /

/\

*

__/

/

\

\ /

/ /

/ _\__

*

/ /

/

\_______\/

/ /

/ /

/\

* /_/______/___________________/ /________/ /___/

\

* \ \

\

___________

\ \

\ \

\

/

*

\_\

\

/

/\

\ \

\ \___\/

*

\

\/

/

\

\ \

\

/

*

\_____/

/

\

\ \________\/

*

/__________/

\

\

/

*

\

_____

\

/_____\/

*

\ /

/\

\

/___\/

*

/____/

\ \

/

*

\

\

/___\/

*

\____\/

*

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

=>

E-SIT-CTC-20021203-0003 v1.0	11

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

=>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		bridge	cip	config
dhcp	dns		env	eth	firewall
ip	ipoa		mer	nat	password
phonebook	ppp		pptp	qosbook	software
system	td		upnp

=>

However:

•eth is only available on SpeedTouchTM510 variants equipped with a single Ethernet port and the SpeedTouchTM530

•upnp is only available for the SpeedTouchTM510 variants and the SpeedTouchTM530

•wireless is only available for the SpeedTouchTM570

To return to top level, or to descend one level (in case of nested command groups) execute .. .

EXAMPLE:

=>phonebook

[phonebook]=>

[phonebook]=>..

=>

12	E-SIT-CTC-20021203-0003 v1.0

The Help Command

Execute help or ? from top level to list all available command groups for the SpeedTouchTM500Series. EXAMPLE for the SpeedTouchTM570:

=>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	atmstats	bridge	cip	config
dhcp	dns	env	eth	firewall
ip	mer	nat	password	phonebook
ppp	pptp	qosbook	software	system
td	wireless
=>

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 SpeedTouchTM500Series 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-SIT-CTC-20021203-0003 v1.0	13

EXAMPLE:

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

=>

14	E-SIT-CTC-20021203-0003 v1.0

Entering help followed by a specific command, e.g. help firewall assign (starting from top level) or help assign (executed from the 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.

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

EXAMPLE:

=>firewall

[firewall]=>"a+TAB"

[firewall]=>assign

Going to the beginning or end of the Command Line

To go to ...	Press ...
the beginning of the Command Line	CTRL+A
the end of the Command Line	CTRL+E

E-SIT-CTC-20021203-0003 v1.0	15

Breaking off Commands

Press CTRL+G to break off a command. 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

To select previously executed 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

16	E-SIT-CTC-20021203-0003 v1.0

Command Line Interface Top Level Structure

The following command groups are always available:

•atm

•bridge

•cip

•config

•dhcp

•dns

•env

•firewall

•ip

•ipoa

•mer

•nat

•phonebook

•ppp

•pptp

•qosbook

•software

•system

•td

Following command groups are optional:

•adsl (only applicable for the SpeedTouchTM510, SpeedTouchTM570 ADSL/POTS, and the SpeedTouchTM510i and SpeedTouchTM570i ADSL/ISDN variants)

•eth (only applicable for models equipped with a single 10/100Base-T Ethernet port)

•upnp (only applicable for the SpeedTouchTM510 and SpeedTouchTM530 variants)

•wireless (only applicable for the SpeedTouchTM570 variants)

E-SIT-CTC-20021203-0003 v1.0	17

Command Line Interface Commands

All CLI commands are commands that operate on, or configure, the SpeedTouchTM500Series settings.

You can execute these commands from top level, preceded by the name of the command group from which the command should be executed (e. g. firewall list).

You can also execute the commands from the command group itself, using the reduced form of the command (e.g. list at the firewall command group selection).

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

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

[firewall]=>

Instead of entering a completely built-up command with all its parameters, you can also enter just the command itself, without its parameters. After this you are prompted to complete the command with the required and the optional parameters. For the optional parameters you can simply press enter without giving a value.

The example below is the equivalent of firewall assign hook=input chain=input. To break of such incomplete command press CTRL+G.

EXAMPLE:

=>firewall assign hook = input chain = input

=>

18	E-SIT-CTC-20021203-0003 v1.0

Menu-driven CLI Navigation

To improve the user-friendliness of the SpeedTouchTM500Series CLI, the CLI features a menu-driven interface. To enter the menu-driven interface, simply execute menu from the CLI prompt:

EXAMPLE (for the SpeedTouchTM510):

The semi-graphical CLI offers you an attractive and easy-to-use configuration environment for the CLI.

You can browse through the CLI command groups via the ARROW keys. Press ENTER to execute your selection. From each level you can select '..' to go back one level up.

Use the TAB key to change from the CLI command menu to the control menu and vice versa.

To setup a CLI command, simply press ENTER on its name. You can configure and overview its various parameters at one time. In case the parameter provides preset values, you can go through these via the ARROW keys. If you are satisfied, 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).

E-SIT-CTC-20021203-0003 v1.0	19

Configuration Profile Files and the CLI

Configuration Profile Files500Series

The configuration profile files, used by the Setup wizard, or directly uploaded via the SpeedTouchTM500Series web pages, consist of a set of CLI commands. Only CLI commands, which are part of the SpeedTouchTM500Series CLI command set may be used in the .ini and .def files. For readability, configuration profile files are partitioned in paragraphs. These paragraphs reflect a CLI command group selection in the SpeedTouchTM500Series CLI. However, due to internal processing, not all paragraph names are the same as their corresponding CLI command group selection.

In the following overview the relationship between the available SpeedTouchTM500Series CLI commands and the [<configuration>.ini] paragraphs is given:

[<configuration>.ini] paragraphs	Available SpeedTouchTM500Series CLI commands
[adslisdn.ini]	The adsl CLI command group in case of a ADSL/ISDN variant.
[adslpots.ini]	The adsl CLI command group in case of a ADSL/POTS variant.
[brfilter.ini]	The hidden brfilter CLI command group.
[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.
[dnsd.ini]	The dns CLI command group.
[env.ini]	The env CLI command group.
[eth.ini]	The eth CLI command group.
[ip.ini]	The ip CLI command group.
[ipoa.ini]	The cip CLI command group.
[mer.ini]	The mer CLI command group.
[nat.ini]	The nat CLI command group.
[oam.ini]	The atm oam CLI command subgroup.
[pfilter.ini]	•	The firewall chain CLI command subgroup
	•	The firewall rule CLI command subgroup.
[pfirewall.ini]	The firewall CLI command group (except those part of the firewall chain
	and firewall rule CLI command subgroups).
[phone.ini]	The phonebook CLI command group.
[ppp.ini]	The ppp CLI command group.
[pptp.ini]	The pptp CLI command group.
[qos.ini]	The qosbook CLI command group.

20	E-SIT-CTC-20021203-0003 v1.0

[<configuration>.ini] paragraphs	Available SpeedTouchTM500Series CLI commands
[snmp.ini]	The snmp CLI command group.
[system.ini]	The system CLI command group.
[wireless.ini]	The wireless CLI command group.

CLI Commands in Configuration Profile Files

CLI commands in a paragraph of a configuration profile file should always be constructed in their complete form. Uncompleted CLI commands, i.e. commands in which required parameters are not specified, used in a configuration profile file will be discarded by the CLI commend interpreter. This may result in a wrongly configured SpeedTouchTM500Series.

In configuration profile files, the use of customization variables, allow the Setup wizard to invite the end-user to provide some input regarding the settings of the SpeedTouchTM500Series. The declaration of such variables must be done in the [env.ini] paragraph. Further use of the resulting variable TAG is allowed through all other paragraphs, even multiple times.

To make sure that a variable always will result in a valid variable TAG, the [env.ini] paragraph also allows to declare a preset value for the variable.

In case the variable TAG is used in a CLI command, the value of the variable should always be in conformity with the syntax of the CLI command.

Customizing Configuration Profile Files

For more information on the customization possibilities of the SpeedTouchTM500Series, the Setup wizard and the configuration profile files, please check the SpeedTouchTM support pages at:

http://www.speedtouch.com

E-SIT-CTC-20021203-0003 v1.0	21

Direct FTP Access

The SpeedTouchTM500Series File System

The SpeedTouchTM500Series permanent storage, further referred to as 'file system', exists of nonvolatile memory responsible for storing, retrieving and maintaining the SpeedTouchTM500Series software image(s), configuration profile files and optionally default settings files.

The file system of the SpeedTouchTM500Series is accessible via the FTP transport protocol. This allows to transfer the SpeedTouchTM500Series software image(s) and/or configuration profile files and default settings files.

Moreover, via FTP's quote site command you can execute CLI commands from the FTP prompt.

Proceed as indicated in the example below to open an FTP session to the SpeedTouchTM500Series file system:

/home/doejohn{1}$ftp 10.0.0.138 Connected to 10.0.0.138

220 Inactivity timer = 120 seconds. Use 'site idle <secs>' to change. Name (10.0.0.138:doejohn):

331 SpeedTouchTM (00-90-D0-01-02-03) User 'doejohn' OK. Password required. Password : ######

330 OK ftp>

SpeedTouchTM500Series File System Structure

The files system features a tiny multilevel directory structure with a single root node called 'root' and two leaf nodes called 'active' and 'dl'.

The 'root' contains next to the two subdirectories 'active' and 'dl' all necessary files for the SpeedTouchTM500Series to boot correctly.

The 'active' subdirectory always contains the software image in execution.

The 'dl' directory contains dormant software image. In case you have made changes to the SpeedTouchTM500Series configuration and saved them, be it via a Telnet session, via the web pages or via the Setup wizard, a user.ini configuration profile file is created in the 'dl' subdirectory.

In other words, after each 'Save all', or config save call, the user.ini configuration profile file present in the 'dl' subdirectory reflects the current configuration of the SpeedTouchTM500Series.

22	E-SIT-CTC-20021203-0003 v1.0

SpeedTouchTM500Series File System Access Rights

Following access rights apply on the file system:

•'root' Directory

Listing of 'root' directory files (dir)

•'active' Subdirectory

Listing of 'active' subdirectory files (dir)

FTP (m)get of (multiple) 'active' subdirectory files

•'dl' Subdirectory

Listing of 'dl' subdirectory files (dir)

FTP (m)get of (multiple) 'dl' subdirectory files FTP (m)put of (multiple) 'dl' subdirectory files FTP (m)delete of (multiple) 'dl' subdirectory files.

FTP File Transfer

To allow correct file transfers, set the transfer mode to “binary”.

Note Turn on the hashing option to see the progression of the file transfer. EXAMPLE:

/home/doejohn{1}$ftp 10.0.0.138 Connected to 10.0.0.138

220 Inactivity timer = 120 seconds. Use 'site idle <secs>' to change. Name (10.0.0.138:doejohn):

331 SpeedTouchTM (00-90-D0-01-02-03) User 'doejohn' OK. Password required. Password : ######

330 OK ftp> ftp>bin

200 TYPE is now 8-bit binary ftp>

ftp>hash

200Hash mark printing on (8192 bytes/hash mark). ftp>

E-SIT-CTC-20021203-0003 v1.0	23

24	E-SIT-CTC-20021203-0003 v1.0

	ADSL Commands
ADSL Commands
Contents
This chapter covers the following commands:
Topic		Page
adsl config		26
adsl info		27

E-SIT-CTC-20021203-0003 v1.0	25

ADSL Commands

adsl config

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

Although the same command for both SpeedTouchTM ADSL/POTS and SpeedTouchTM ADSL/ISDN variants, the command features specific parameter values per variant:

SYNTAX FOR ADSL/Plain Old Telephone Service (POTS) variants:

adsl config	[opermode = <{ansi|g.dmt_annex_a|g.lite|multimode}>]
	[maxbitspertoneUS = <number{10-14}>]
[opermode]	The operational mode of the SpeedTouchTM modem.		OPTIONAL
	Choose between:
	•	ansi
	•	g.dmt_annex_a
	•	g.lite
	•	multimode
	By default the SpeedTouchTM will start in multimode.
maxbitspertoneUS	A number between 10 and 14 (bits per tone).		OPTIONAL
	Represents the maximum number of bits which can be allocated to

each ADSL DMT tone in the upstream direction.

By default the modem will use up to 13 bits per tone.

SYNTAX FOR ADSL/Integrated Services Digital Network (ISDN) variants:

adsl config		[opermode = <{etsi|g.dmt_annex_b|multimode}>]
		[maxbitspertoneUS = <number{10-14}>]
[opermode]		The operational mode of the SpeedTouchTM modem.		OPTIONAL
		Choose between:
		•	ansi
		•	g.dmt_annex_b
		•	multimode
		By default the SpeedTouchTM will start in multimode.
maxbitspertoneUS		A number between 10 and 14 (bits per tone).		OPTIONAL
		Represents the maximum number of bits whic hcan be allocated to
		each ADSL DMT tone in the upstream direction.
		By default the modem will use up to 13 bits per tone.
Note	Executing the :adsl config without specifying parameters, shows the current ADSL configuration.

26	E-SIT-CTC-20021203-0003 v1.0