About This Document - THOMSON SpeedTouch 580 Cli Reference Manual

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™580 Wireless Multi-User ADSL Gateway (R4.2.7)
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-0003 v1.0
About this Document
15