Professional Documents
Culture Documents
Documentation Guide
Issue Date 02 2010-12-01
Copyright Huawei Technologies Co., Ltd. 2010. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute the warranty of any kind, express or implied.
Website: Email:
Issue 02 (2010-12-01)
Before using Huawei device and documentation for the first time, read this guide to know Huawei's documentation system so that you can use the package of documents properly.
This document is intended for: l l l l l Network planning engineers Hardware installation engineers Commissioning engineers On-site maintenance engineers System maintenance engineers
Symbol Conventions
The symbols that may be found in this document are defined as follows. Symbol Description
DANGER
Indicates a hazard with a high level of risk, which if not avoided, will result in death or serious injury. Indicates a hazard with a medium or low level of risk, which if not avoided, could result in minor or moderate injury. Indicates a potentially hazardous situation, which if not avoided, could result in equipment damage, data loss, performance degradation, or unexpected results. Indicates a tip that may help you solve a problem or save time.
WARNING
CAUTION
TIP
Issue 02 (2010-12-01)
iii
Symbol
NOTE
Description Provides additional information to emphasize or supplement important points of the main text.
Change History
Updates between document issues are cumulative. Therefore, the latest document issue contains all updates made in previous issues.
iv
Issue 02 (2010-12-01)
Contents
Contents
About This Document...................................................................................................................iii 1 Update History............................................................................................................................1-1 2 Classification and Contents of the Documentation............................................................2-1
2.1 Classification of the Documentation...............................................................................................................2-2 2.2 Contents of the Documentation.......................................................................................................................2-2 2.2.1 Descriptive Documentation....................................................................................................................2-3 2.2.2 Installation Documentation....................................................................................................................2-4 2.2.3 Configuration Documentation................................................................................................................2-4 2.2.4 Maintenance Documentation..................................................................................................................2-5
Issue 02 (2010-12-01)
Tables
Tables
Table 1-1 List of added and updated documents..................................................................................................1-1 Table 1-2 List of added and updated documents..................................................................................................1-5 Table 2-1 Descriptive documentation of the Quidway S2300 Series...................................................................2-3 Table 2-2 Installation documentation of the Quidway S2300 Series...................................................................2-4 Table 2-3 Configuration documentation of the Quidway S2300 Series...............................................................2-4 Table 2-4 Maintenance documentation of the Quidway S2300 Series.................................................................2-5 Table 3-1 Using the documentation according to the roles of users.....................................................................3-2 Table 3-2 Using the documentation according to the life cycle of the product....................................................3-5 Table 4-1 Storage modes of documents...............................................................................................................4-2
Issue 02 (2010-12-01)
vii
1 Update History
1
Changes in Issue 02 (2010-12-01)
The following table lists the released documents. Table 1-1 List of added and updated documents Product Document Name Product Description Documentation Guide
Update History
Updates between document issues are cumulative. Therefore, the latest document version contains all updates made in previous versions.
Description Physical Specifications is added. The following content is modified: l Update History l Descriptive Documentation l Maintenance Documentation
Example for Configuring to Manage the SwitchThrough Telnet is modified. The following content is modified: l Shortcut Keys l Creating a Web Account l Loading a Web Page File
The following content is modified: l Establishing the Configuration Task l Some pictures are optimized.
(Optional) Configuring the IGMP Snooping Proxy for the VLAN is modified. The following content is modified: l (Optional) Configuring Information About the Address Prefix to Be Advertised
Issue 02 (2010-12-01)
1-1
1 Update History
Product Document Name Configuration Guide - IP Routing Configuration Guide - Reliability Configuration Guide - Device Management
Description Minor mistakes are rectified. Example for Configuring Crossed RRPP Rings with a Single Instance is modified. The following content is modified: l Stacking Function Supported by the S2300 l Configuring an IP Address Pool for a Stack l PoE Features Supported by the S2300
Description is added to "Creating Cluster" in HGMP Configuration. The following content is modified: l Applying a Traffic Policy l Traffic Shaping l Configuring the Re-marking Action l Configuring Traffic Policing
Feature Description - Basic Configurations Feature Description - Ethernet Feature Description - Multicast Feature Description - IP Services Feature Description - IP Routing Feature Description - Security
Some pictures are optimized. Minor mistakes are rectified. Minor mistakes are rectified. Minor mistakes are rectified. Minor mistakes are rectified. The following content is modified: l AAA l RADIUS l HWTACACS l Domain-based User Management
Feature Description - Device Management Feature Description - Network Management Feature Description - QoS
Minor mistakes are rectified. Minor mistakes are rectified. The following content is modified: l Traffic Policing l Traffic Shaping
1-2
Issue 02 (2010-12-01)
1 Update History
Network diagrams are optimized. The following content is modified: l Power-on Process of PoE l PSE Cannot Detect Any PD l PSE Cannot Provide Power for PDs
Troubleshooting - Reliability
Troubleshooting Procedure is modified. The following content is modified: l Overview of Class-based QoS l Congestion Management Overview l QoS of the Services with High Priority Cannot Be Guaranteed
Issue 02 (2010-12-01)
1-3
1 Update History
Description The following content is modified: l Device management commands display device display power display poe-power display poe power-state slot display poe power slot display stacking stacking ip-pool l IP service commands display ipv6 fib display tcp ipv6 status l Security commands dhcp snooping arp security enable l QoS commands car l Basic configuration commands http server load http timeout l Ethernet commands garp timer leaveall The following content is added: l IP service commands icmp-reply fast
Alarm Reference
l The alarms of the LSPAGENT module are deleted. l Minor mistakes are rectified.
Log Reference
l Thirteen logs are added to the MSTP module. l The logs of the AAA, RDS, RSA, SEC, and snooping modules are deleted. l Minor mistakes are rectified.
Typical Configuration
Inspection Checklist
1-4
Issue 02 (2010-12-01)
1 Update History
Issue 02 (2010-12-01)
1-5
1 Update History
Product Document Name Feature Description - QoS Troubleshooting - Ethernet Troubleshooting - IP Service Troubleshooting - Device Management Troubleshooting - Network Management Troubleshooting - Reliability Troubleshooting - Security Troubleshooting - QoS Command Reference Alarm Reference Log Reference FAQ Typical Configuration Inspection Checklist Glossary
Description This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release. This is the first release.
1-6
Issue 02 (2010-12-01)
Issue 02 (2010-12-01)
2-1
Product Documentation
The product documentation of the S2300 includes the following contents. Media Description Electronic documentation includes: l Documentation Guide l Product Description l Feature Description l Quick Installation Guide l Configuration Guide l Troubleshooting l Command Reference l Log Reference l Alarm Reference l FAQ l Typical Configuration Paper documentation Quick Installation Guide
2.2.2 Installation Documentation Installation documentation describes the methods of installing the product. 2.2.3 Configuration Documentation Configuration documentation describes the configuration methods, typical networking diagrams, and configuration commands of software features of the product. 2.2.4 Maintenance Documentation Maintenance documentation describes routine maintenance items and operations, emergency operations, operations of replacing parts, troubleshooting methods and cases, and information about logs, and alarms.
Product Descripti on
Describes: l Appearance and architecture of the S2300 l Main functions and services provided by the S2300 l Networking and applications of the S2300 l Hardware and software architecture of the S2300 l Technical specifications of the S2300
Feature Descripti on
Includes: l Basic Configurations l Network Management l Device Management l Ethernet l IP Routing l IP Services l Reliability l Multicast l QoS l Security The documentation, consisting of 10 volumes, describes the functions and features, principles, and applications of the S2300.
Issue 02 (2010-12-01)
2-3
2-4
Issue 02 (2010-12-01)
Issue 02 (2010-12-01)
2-5
Description Describes the alarm information supported by the S2300, including: l Basic information: describes the output, OIDs, meanings, types, classes, parameters, and functions of alarms. l Cause: describes the causes for an alarm. l Advice: analyzes the causes of the alarm and provides suggestions for system recovery according to the causes of the alarm. l Associated alarm: describes information about the alarms that are associated with this alarm.
Release Notes
It focuses on the software version officially released for users and describes the differences between the current version and earlier version with regard to functions, performances, operation, and maintenance. In addition, Release Notes provides the method of upgrading the system.
2-6
Issue 02 (2010-12-01)
3
About This Chapter
This section describes the usage of the documentation of the S2300 so that you can obtain the required documents effectively. 3.1 Using the Documentation According to the Roles of Users Users have different roles according to their responsibilities on a network. Users of different roles can obtain different documents according to their responsibilities. 3.2 Using the Documentation According to the Life Cycle of the Product The tasks of the product performed by the user is related to the life cycle of the product. According to the tasks performed by the user on the product, the life cycle of the S2300 is classified into network planning, network deployment, service commissioning and deployment, network maintenance, and network upgrading. You can select proper references according to the life cycle of the product.
Issue 02 (2010-12-01)
3-1
3-2
Issue 02 (2010-12-01)
Role of a User
Responsibility
Reference Main Document Reference Document l Documentation Guide l Quick Installation Guide l Product Description l Feature Description l Troubleshootin g l Command Reference l Alarm Reference l Log Reference
Commissioning engineer
Is responsible for switching on the device, commissioning the device, commissioning circuits, commissioning and deploying services, and cutting over services according to the service planning of the project and design scheme, and delivering the network to the maintenance department after the acceptance is completed.
Configuration Guide
Is responsible for configuring data and deploying services on the device by using commands of the switch or through the NMS.
Configuration Guide
Is responsible for monitoring the network 24 hours a day according to a provider's strategy, maintaining the network routinely and rectifying minor faults, handling customers' complaints, requesting system maintenance engineers to process complicated faults, taking immediate actions to maintain the device under a system maintenance engineer's instruction or delivering it to a system maintenance engineer when a critical fault occurs, and monitoring the network by using the NMS or the commands of a switch.
l Documentation Guide l Product Description l Configuration Guide l Troubleshootin g l Command Reference l Alarm Reference l Log Reference
Issue 02 (2010-12-01)
3-3
Role of a User
Responsibility
Reference Main Document Reference Document l Documentation Guide l Quick Installation Guide l Product Description l Feature Description l Hardware Description l Configuration Guide l Command Reference l Alarm Reference l Log Reference
Is responsible for maintaining the running devices, especially for troubleshooting of the system of the switch and network management system, and be responsible for coordinating and supervising large-scale upgrading of the software version of the switch, or reviewing the small-scale upgrading of the version of the software of the switch.
Troubleshooting
Network administrator
NOTE
Documents are classified into main documents and reference documents. l A main document is mainly used by a user in a specific scenario. l A reference document, which supplements the main document, instructs users to complete the tasks in a specific scenario. For example, to perform a configuration task, an operator may need to read the Configuration Guide to be familiar with the procedure for performing the configuration task. In addition, the operator needs to read the Command Reference to know about the usage and the value range of the parameters of the related commands. In this scenario, the Configuration Guide is a main document and the Command Reference is a reference document.
3.2 Using the Documentation According to the Life Cycle of the Product
The tasks of the product performed by the user is related to the life cycle of the product. According to the tasks performed by the user on the product, the life cycle of the S2300 is classified into network planning, network deployment, service commissioning and deployment, network maintenance, and network upgrading. You can select proper references according to the life cycle of the product.
3-4
Issue 02 (2010-12-01)
Table 3-2 Using the documentation according to the life cycle of the product Life Cycle Phase Main Task Reference Main Document Determining the network scale, networking, and hardware configuration process of the network elements, and data configuration process according to the network and requirements for building the network l Surveying the project l Preparing the environment l Installing the device l Commissioning the device Service deployment and commissionin g Network maintenance l Setting up a network l Deploying services l Configuring data l Managing and maintaining services l Monitoring the network l Performing routine maintenance and emergency maintenance l Troubleshooting faults Network upgrading l Upgrading the version l Upgrading patches Release Notes l Configuration Guide l Command Reference l Configuration Guide l Command Reference l Documentation Guide l Product Description l Feature Description l Hardware Description l Quick Installation Guide Reference Document -
Network planning
Network deployment
Issue 02 (2010-12-01)
3-5
Issue 02 (2010-12-01)
4-1
Generally, the hard copy of the documents includes only the Quick Installation Guide.
Huawei releases updated documents periodically to ensure that the documentation consists with the product version and rectify the bugs in the documents. You can judge the product version that the documents apply to and whether the document is the latest version according to the document version. 4.2.2 Obtaining Documentation Currently, in addition to the documents delivered with the device, you can obtain the documentation in the following ways:
Before applying for the documentation, you must know its version. Otherwise, the document obtained may be different from the device that you use.
The title page contains the following information: l l Product model: indicates the product model corresponding to the document, the product model is " Ethernet Switches " and the product type is "Quidway S2300 Series." Product version: indicates the version of the document. If this document applies to several versions of a product, the version numbers are separated by ampersand (&). For example, the product version of this document is "V100R005C01". Document version: indicates the number of times the document of this version is released. When the document is released for the first time, the release number is "01". Every time the version of a product document is upgraded, the release number increases by one. Release date: indicates the date when the documents are released in public.
NOTE
The product version is the version of the software of the product to which the document corresponds. You can view the version number of the product by using the display version command after logging in to the device.
4-4
Issue 02 (2010-12-01)