This section discusses the objectives, audience, organization, and conventions of the LightStream 2020 NP O/S Reference Manual. It also lists related Cisco documentation for the LightStream 2020 (LS 2020).
LS2020 node software runs under LynxOS, a real-time UNIX operating system. This manual contains UNIX manual "pages" for LynxOS commands, system utilities, and the GNU bash shell. It also provides a user's guide for the vi text editor.
The LightStream 2020 NP O/S Reference Manual is an operating-system software reference manual. It is intended for system administrators responsible for nodes in an LS2020 network and for anyone who operates an LS2020 network.
Users of the LS2020 document set are expected to have a general understanding of basic data communications concepts and some practical knowledge of the UNIX operating system.
The following table shows the organization of this manual.
- Chapter 1, NP O/S Command Reference, provides manual pages for some of the most frequently used LynxOS commands and system utilities.
- Chapter 2, GNU Bash Shell Reference, provides the manual page for the GNU Bourne-Again Shell (bash), the user interface to LynxOS commands on the LS2020 node.
- Chapter 3, Vi Editor User's Guide, Describes how to use the vi text editor.
- Appendix A, Special Files, describes some files that are used by LS2020 software, and lists some standard UNIX operating system files.
The following conventions distinguish different types of text:
- Commands and keywords are in boldface.
- In interactive examples, user input is in boldface.
- In command syntax statements:
- Parameters (variables for which a specific value is to be typed) are in italics.
- Optional arguments are in square braces.
- Alternative arguments are separated by vertical bars, and are grouped within curly braces.
- Names of keys on the keyboard are in square braces, e.g. the [Tab] key.
- Control keys are indicated by a caret preceding a letter: ^A means Control-A.
The bash prompt has the following format for the root login:
nodename:slot#
The bash prompt has the following format for all other logins:
nodename:slot$
In this prompt format, nodename is the name of the node and slot is the slot number (1 or 2) of the active NP. In examples in this book, LSnode is used as the value of nodename, and 2 is used as the value of slot, as follows for the two types of prompts:
LSnode:2#
LSnode:2$
Note Means
reader take note. Notes contain helpful suggestions or references to material not covered in the manual.
 | Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. |
The following is a list of Cisco LS2020 documents for LS2020 users:
- LightStream 2020 System Overview
- This overview introduces the LS2020 node and the Asynchronous Transfer Mode (ATM) technology on which the LS2020 product is based. It describes the traffic flow through an LS2020 network. In addition, it describes key features, such as traffic and network management.
- LightStream 2020 Site Planning and Cabling Guide
- This guide tells you how to prepare your site to receive LS2020 hardware. It includes space, environmental and electrical requirements, rack selection guidelines, requirements for the management workstation, and information on cables and connectors.
- LightStream 2020 Installation Guide
- This guide tells you how to install and set up LS2020 nodes and how to install LS2020 management software on your network management workstation.
- LightStream 2020 Hardware Troubleshooting Guide
- This guide provides a detailed description of LS2020 hardware and tells you how to diagnose hardware problems and how to replace faulty hardware components.
- LightStream 2020 Configuration Guide
- This guide provides the information you need to configure LS2020 nodes. It provides a functional overview of the configuration programs. It describes the configuration database and gives detailed information on all configurable attributes and their settings. The guide also provides step-by-step configuration procedures.
- LightStream 2020 Network Operations Guide
- This guide is a task-oriented book that tells you how to operate a network of LS2020 switches. The guide presents an overview of network operations tasks, describes the command line interface (CLI), and presents procedures for performing monitor and control tasks such as displaying the status of nodes, cards and ports, viewing statistics, and creating collections of traffic data.
- LightStream 2020 Traps Reference Manual
- This manual presents an overview of LS2020 traps and how they are generated by the LS2020 node. It provides the procedures for managing trap reporting, such as setting trap levels, enabling/disabling individual traps, and determining where the traps are displayed. It also describes the SNMP, operational, and informational traps, including trap name, text, cause and user response.
- LightStream 2020 CLI Reference Manual
- This manual provides detailed descriptions of the syntax and functions of all CLI commands. It also describes the LS2020 private MIB.
- LightStream 2020 Command Line Interface (CLI) Reference Card
- The reference card compactly summarizes the syntax and arguments of CLI commands.
- LightStream 2020 Release Notes
- The release notes provide a software upgrade procedure and describe new features and special considerations, including known software bugs.
Note The release notes contain important information that was not available when the other documents were printed.
- LightStream 2020 Online Help
- The LS2020 command line interface (CLI) and configuration program both support online help facilities.
To order these publications or additional copies of the LightStream 2020 CLI Reference Manual, contact your sales representative. (The Customer Order Number for each manual is located at the bottom of the title page.) Customer Service can provide you with the name of your sales representative if necessary.
Phone: 1-800-553-NETS (6387) or (415) 326-1941
E-mail: customer-service@cisco.com
