Nortel 2500 s, 2500 Documentation Roadmap

Page 1
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
Release: 4.2 Document Revision: 01.01
www.nortel.com
NN47215-103
.
Page 2
Nortel Ethernet Routing Switch 2500 Series Release: 4.2 Publication: NN47215-103 Document release date: 27 October 2008
Copyright © 2008 Nortel Networks All Rights Reserved.
Printed in Canada and the United States of America LEGAL NOTICE
While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to change without notice.
Nortel, the Nortel logo, and the Globemark are trademarks of Nortel Networks.
All other trademarks are the property of their respective owners.
.
Page 3
3
.
Contents
Software license 5 New in this release 9
Features 9 Other changes 9
New documents 9
Introduction 11 Roadmap 13
Customer documentation packaging 13 Product Fundamentals 14 Installation and Commissioning 15 Upgrades and Patches 16 Operations 16 Administration and Security 17 Fault and Performance Management 18 Documentation file formats 18
Information quality 19 Text conventions 21
Angle brackets 21 Bold or Bold Courier text 21 Braces 22 Brackets 22 Ellipses 22 Italic text 22 Plain Courier text 22 Separator 22 Vertical bar 23 cr convention 23
Modular, task-based information 25
Task-based documentation 25 How to use task-based documentation 26 Task flow overview 26
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 4
4
Work flows, task flows, and procedures 27
Purpose statements 27 Prerequisites 27 Work flows or task flows 27 Procedure steps 28 Example procedures 28 Variable definitions 28 Job aid 28
Task-based documentation terms 28
Customer service 29
Updated versions of documentation 29 How to get help 29 Express Routing Codes 29 Additional information 30
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 5
5
.
Software license
This section contains the Nortel Networks software license.
Nortel Networks Inc. software license agreement
This Software License Agreement ("License Agreement") is between you, the end-user ("Customer") and Nortel Networks Corporation and its subsidiaries and affiliates ("Nortel Networks"). PLEASE READ THE FOLLOWING CAREFULLY. YOU MUST ACCEPT THESE LICENSE TERMS IN ORDER TO DOWNLOAD AND/OR USE THE SOFTWARE. USE OF THE SOFTWARE CONSTITUTES YOUR ACCEPTANCE OF THIS LICENSE AGREEMENT. If you do not accept these terms and conditions, return the Software, unused and in the original shipping container, within 30 days of purchase to obtain a credit for the full purchase price.
"Software" is owned or licensed by Nortel Networks, its parent or one of its subsidiaries or affiliates, and is copyrighted and licensed, not sold. Software consists of machine-readable instructions, its components, data, audio-visual content (such as images, text, recordings or pictures) and related licensed materials including all whole or partial copies. Nortel Networks grants you a license to use the Software only in the country where you acquired the Software. You obtain no rights other than those granted to you under this License Agreement. You are responsible for the selection of the Software and for the installation of, use of, and results obtained from the Software.
1. Licensed Use of Software. Nortel Networks grants Customer a nonexclusive license to use a copy of the Software on only one machine at any one time or to the extent of the activation or authorized usage level, whichever is applicable. To the extent Software is furnished for use with designated hardware or Customer furnished equipment ("CFE"), Customer is granted a nonexclusive license to use Software only on such hardware or CFE, as applicable. Software contains trade secrets and Customer agrees to treat Software as confidential information using the same care and discretion Customer uses with its own similar information that it does not wish to disclose, publish or disseminate. Customer will ensure that anyone who uses the Software does so only in compliance with the terms
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 6
6 Software license
of this Agreement. Customer shall not a) use, copy, modify, transfer or distribute the Software except as expressly authorized; b) reverse assemble, reverse compile, reverse engineer or otherwise translate the Software; c) create derivative works or modifications unless expressly authorized; or d) sublicense, rent or lease the Software. Licensors of intellectual property to Nortel Networks are beneficiaries of this provision. Upon termination or breach of the license by Customer or in the event designated hardware or CFE is no longer in use, Customer will promptly return the Software to Nortel Networks or certify its destruction. Nortel Networks may audit by remote polling or other reasonable means to determine Customer’s Software activation or usage levels. If suppliers of third party software included in Software require Nortel Networks to include additional or different terms, Customer agrees to abide by such terms provided by Nortel Networks with respect to such third party software.
2. Warranty. Except as may be otherwise expressly agreed to in writing between Nortel Networks and Customer, Software is provided "AS IS" without any warranties (conditions) of any kind. NORTEL NETWORKS DISCLAIMS ALL WARRANTIES (CONDITIONS) FOR THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT. Nortel Networks is not obligated to provide support of any kind for the Software. Some jurisdictions do not allow exclusion of implied warranties, and, in such event, the above exclusions may not apply.
3. Limitation of Remedies. IN NO EVENT SHALL NORTEL NETWORKS OR ITS AGENTS OR SUPPLIERS BE LIABLE FOR ANY OF THE FOLLOWING: a) DAMAGES BASED ON ANY THIRD PARTY CLAIM; b) LOSS OF, OR DAMAGE TO, CUSTOMER’S RECORDS, FILES OR DATA; OR c) DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS OR SAVINGS), WHETHER IN CONTRACT, TORT OR OTHERWISE (INCLUDING NEGLIGENCE) ARISING OUT OF YOUR USE OF THE SOFTWARE, EVEN IF NORTEL NETWORKS, ITS AGENTS OR SUPPLIERS HAVE BEEN ADVISED OF THEIR POSSIBILITY. The forgoing limitations of remedies also apply to any developer and/or supplier of the Software. Such developer and/or supplier is an intended beneficiary of this Section. Some jurisdictions do not allow these limitations or exclusions and, in such event, they may not apply.
4. General
1. If Customer is the United States Government, the following paragraph
shall apply: All Nortel Networks Software available under this License Agreement is commercial computer software and commercial computer
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 7
Nortel Networks Inc. software license agreement 7
software documentation and, in the event Software is licensed for or on behalf of the United States Government, the respective rights to the software and software documentation are governed by Nortel Networks standard commercial license in accordance with U.S. Federal Regulations at 48 C.F.R. Sections 12.212 (for non-DoD entities) and 48 C.F.R. 227.7202 (for DoD entities).
2.
Customer may terminate the license at any time. Nortel Networks may terminate the license if Customer fails to comply with the terms and conditions of this license. In either event, upon termination, Customer must either return the Software to Nortel Networks or certify its destruction.
3.
Customer is responsible for payment of any taxes, including personal property taxes, resulting from Customer’s use of the Software. Customer agrees to comply with all applicable laws including all applicable export and import laws and regulations.
4.
Neither party may bring an action, regardless of form, more than two years after the cause of the action arose.
5.
The terms and conditions of this License Agreement form the complete and exclusive agreement between Customer and Nortel Networks.
6.
This License Agreement is governed by the laws of the country in which Customer acquires the Software. If the Software is acquired in the United States, then this License Agreement is governed by the laws of the state of New York.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 8
8 Software license
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 9
9
.
New in this release
The following section details what’s new in Nortel Ethernet Routing Switch 2500 Series Documentation Roadmap (NN47215-103) for Release 4.2:
•
“Features” (page 9)
•
“Other changes” (page 9)
Features
This document describes no new features.
Other changes
See the following sections for information about changes that are not feature-related:
• “New documents” (page 9)
New documents
Release 4.2 includes the following new documents:
•
Nortel Ethernet Routing Switch 2500 Series Terminology
(NN47215-101 )
•
Nortel Ethernet Routing Switch 2500 Series Fundamentals
(NN47215-102)
• Nortel Ethernet Routing Switch 2500 Series Documentation Roadmap
(NN47215-103)
• Nortel Ethernet Routing Switch 2500 Series Configuration — IP
Routing and Multicast (NN47215-503)
For more information about new documents, see “Roadmap” (page 13).
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 10
10 New in this release
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 11
11
.
Introduction
This document explains the organization of the technical documentation for the Nortel Ethernet Routing Switch 2500 Series Release 4.2. Use this document to understand where you can find specific types of information in the customer documentation suite.
Navigation
•
“Roadmap” (page 13)
• “Information quality” (page 19)
•
“Text conventions” (page 21)
• “Modular, task-based information” (page 25)
•
“Customer service” (page 29)
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 12
12 Introduction
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 13
13
.
Roadmap
This section is a roadmap for the Nortel Ethernet Routing Switch 2500 Series documentation. Use this section to find the correct document for the task you need to perform.
Nortel Ethernet Routing Switch 2500 Series technical documents are structured with an emphasis on the tasks you perform.
Navigation
•
“Customer documentation packaging” (page 13)
•
“Product Fundamentals” (page 14)
•
“Installation and Commissioning” (page 15)
•
“Upgrades and Patches” (page 16)
•
“Administration and Security” (page 17)
•
“Operations” (page 16)
• “Fault and Performance Management” (page 18)
•
“Documentation file formats” (page 18)
Customer documentation packaging
Nortel technical documents are organized according to job functions. For information about how the Nortel Ethernet Routing Switch 2500 Series NTP suite is organized, see the following figure.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 14
14 Roadmap
Figure 1 Nortel Ethernet Routing Switch 2500 Series documentation packaging
Product Fundamentals
Product Fundamentals documentation includes product overview and information that applies to all areas of the product.
Table 1 Nortel Ethernet Routing Switch 2500 Series product fundamentals documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series — Regulatory Information
(NN47215-100)
This document provides regulatory and precautionary messages applicable to the Nortel Ethernet Routing Switch 2500 Series.
Nortel Ethernet Routing Switch 2500 Series — Terminology (NN47215-101)
This document contains common terms and acronyms used in the Nortel Ethernet Routing Switch 2500 Series documentation suite.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 15
Installation and Commissioning 15
Table 1 Nortel Ethernet Routing Switch 2500 Series product fundamentals documents (cont’d.)
Document title Description
Nortel Ethernet Routing Switch 2500 Series — Fundamentals
(NN47215-102)
This document provides instructions to use the Nortel Ethernet Routing Switch 2500 Series user interfaces, including Nortel Networks command line interface (NNCLI), Web-based management interface, and Device Manager, and includes procedures to use configuration files.
Nortel Ethernet Routing Switch 2500 Series — Documentation Roadmap
(NN47215-103)
This document contains an overview of the documentation suite and explains how to use task-based documentation.
Installation and Commissioning
Installation and Commissioning documentation includes information that supports initial installation and commissioning (initial configuration) activities, including preparation, processes, safety requirements, and instructions for rollback procedures.
The following table describes Nortel Ethernet Routing Switch 2500 Series installation and commissioning documents.
Table 2 Nortel Ethernet Routing Switch 2500 Series installation and commissioning documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series — Quick Install Guide
(323170-B)
This document provides instructions to install the Nortel Ethernet Routing Switch 2500 Series in an equipment rack or on a shelf. It also provides instructions to perform the initial IP configuration on the switch using the CLI Quickstart.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 16
16 Roadmap
Table 2 Nortel Ethernet Routing Switch 2500 Series installation and commissioning documents (cont’d.)
Document title Description
Nortel Ethernet Routing Switch 2500 Series Installation — SFPs
(NN47215-301)
This document provides instructions to install small form factor pluggable transceivers, 10 Gigabit small form factor pluggable transceivers, and includes specifications for these hardware components.
Nortel Ethernet Routing Switch 2500 Series Configuration — System
(NN47215-500)
This document provides instructions to perform basic configuration of the Nortel Ethernet Routing Switch 2500 Series including procedures to configure the switch IP address after hardware installation. It also provides instructions to configure system-level features such as stacking, feature licensing, Simple Network Time Protocol, BootP, Domain Name System, PoE, and LLDP.
Upgrades and Patches
Upgrades and Patches documentation includes information to upgrade software and hardware components.
The following table describes Nortel Ethernet Routing Switch 2500 Series upgrades and patches documents.
Table 3 Nortel Ethernet Routing Switch 2500 Series upgrades and patches documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series Release Notes — Software Release 4.2 (NN47215-400)
This document describes new features and important information about the latest release. Release Notes includes a list of known issues (including workarounds where appropriate) and a list of fixed issues.
Operations
Operations documents include information that supports tasks related to configuration (post-commissioning) of services or applications, routine maintenance of hardware or software, and accounting or billing activities.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 17
Administration and Security 17
The following table describes Nortel Ethernet Routing Switch 2500 Series operations documents.
Table 4 Nortel Ethernet Routing Switch 2500 Series operations documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series Configuration — VLANs, Spanning Tree, and Multi-Link Trunking (NN47215-501)
This document describes procedures and conceptual information to configure VLANs, Spanning Tree, Link Aggregation Control Protocol, and Multi-Link Trunking on the Nortel Ethernet Routing Switch 2500 Series.
Nortel Ethernet Routing Switch 2500 Series Configuration — IP Routing and Multicast (NN47215-503)
This document provides procedures and conceptual information to configure IP routing features on the Nortel Ethernet Routing Switch 2500 Series, including static routes, Proxy ARP, DHCP Relay, and UDP forwarding. It also provides procedures and conceptual information to manage multicast traffic using IGMP snooping.
Nortel Ethernet Routing Switch 2500 Series Configuration — Quality of Service (NN47215-504)
This document provides procedures and conceptual information to configure Quality of Service on the Nortel Ethernet Routing Switch 2500 Series.
Administration and Security
Administration and Security documentation includes information that supports tasks that operations personnel perform that relate to network administration or product security, including the configuration and management of systems data and users. The documentation also includes the management and protection of resources from unauthorized or detrimental access and use.
The following table describes Nortel Ethernet Routing Switch 2500 Series administration and security documents.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 18
18 Roadmap
Table 5 Nortel Ethernet Routing Switch 2500 Series administration and security documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series Configuration — Security
(NN47215-505)
This document provides procedures and conceptual information to administer and configure security features for the Nortel Ethernet Routing Switch 2500 Series, including MAC-based security, RADIUS, EAPOL, and SSH.
Fault and Performance Management
Fault and Performance Management documents include information that supports the tasks that operations personnel perform that relate to managing or preventing faults, troubleshooting, and monitoring and improving the performance of the network or product
The following table describes Nortel Ethernet Routing Switch 2500 Series fault and performance management documents.
Table 6 Nortel Ethernet Routing Switch 2500 Series fault and performance management documents
Document title Description
Nortel Ethernet Routing Switch 2500 Series Configuration — System Monitoring (NN47215-502)
This document provides information about system diagnostics tools including syslog, Remote Monitoring, port mirroring, and displaying port and chassis statistics.
Nortel Ethernet Routing Switch 2500 Series Troubleshooting
(NN47215-700)
This document describes common problems and error messages and the techniques to resolve them.
Documentation file formats
To locate the Nortel Ethernet Routing Switch 2500 Series software Release 4.2 documentation on the Nortel Web site, see “Customer
service” (page 29), or the documentation CD. The following documents are
also available in print format:
• Nortel Ethernet Routing Switch 2500 Series — Quick Install Guide
(323170-B)
• Nortel Ethernet Routing Switch 2500 Series — Regulatory Information
(NN47215-100)
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 19
19
.
Information quality
Nortel technical documents are tested by subject matter experts (SMEs) throughout the product development lifecycle. SMEs from Design, Product Verification (PV), Product Line Management (PLM), Verification Office (VO), and Global Network Product Support (GNPS), all contribute to document quality.
Nortel releases technical documents in the early stages of development that have not completed all testing milestones, on a limited basis. Documents that have not completed testing bear a Draft watermark on every page to indicate that the content they contain may change as the product is refined and document testing is completed. Draft documents are not widely available.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 20
20 Information quality
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 21
21
.
Text conventions
This chapter describes the text conventions used in the Nortel Ethernet Routing Switch 2500 Series documentation.
Navigation
•
“Angle brackets” (page 21)
•
“Bold or Bold Courier text” (page 21)
• “Braces” (page 22)
•
“Brackets” (page 22)
• “Ellipses” (page 22)
•
“Italic text” (page 22)
•
“Plain Courier text” (page 22)
•
“Separator” (page 22)
• “Vertical bar” (page 23)
•
“cr convention” (page 23)
Angle brackets
Indicates that you choose the text to enter based on the description inside the brackets. Do not type the brackets when entering the command.
Example: If the command syntax isping <ip_address>, you enter ping
192.32.10.12
Bold or Bold Courier text
Bold or Bold Courier text indicates command names, options, and text
that you must enter. Example: Use the info command. Example: Enter show ip {alerts|routes}.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 22
22 Text conventions
Example: Protocols, IP identifies the IP command on the Protocols menu.
Braces
Braces ({ }) indicate required elements in syntax descriptions where more than one option is available. You must choose only one option. Do not type the braces when you enter the command.
Example: If the command syntax is
show ip {alerts|routes}, you must enter either show ip alerts or show ip routes, but not both.
Brackets
Brackets ([ ]) indicate optional elements in syntax descriptions. Do not type the brackets when you enter the command.
Example: If the command syntax is
show ip interfaces [-alerts], you can enter either show ip interfaces orshow ip interfaces -alerts.
Ellipses
An ellipsis (...) indicates that you repeat the last element of the command as needed.
Example: If the command syntax is ethernet/2/1 [ <parameter> <value> ]..., you enter ethernet/2/1 and as many parameter-value pairs as you need.
Italic text
Italic text indicates book titles or new terms followed by a definition. Example: Nortel Ethernet Routing Switch 2500 Series Release Notes
(NN47215-400) .
Plain Courier text
Plain Courier text indicates system output, for example, prompts and system messages.
Example: Set Trap Monitor Filters
Separator
A separator ( , ) shows menu paths. Example: Protocols , IP identifies the IP command on the Protocols
menu.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 23
cr convention 23
Vertical bar
A vertical bar ( | ) separates choices for command keywords and arguments. Enter only one choice. Do not type the vertical line when you enter the command.
Example: If the command syntax is
show ip {alerts|routes}, you enter either show ip alerts or show ip routes, but not both.
cr convention
In NNCLI procedures, when you see <cr> as an option for a command, you can press the Enter key on your keyboard to execute the command.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 24
24 Text conventions
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 25
25
.
Modular, task-based information
Modular, task-based information (MTBI) is a quick reference for using the Nortel Ethernet Routing Switch 2500 Series task-based documentation. MTBI describes the structure of task-based information and how it can be used most effectively.
Navigation
•
“Task-based documentation” (page 25)
• “How to use task-based documentation” (page 26)
•
“Task flow overview” (page 26)
• “Work flows, task flows, and procedures” (page 27)
•
“Task-based documentation terms” (page 28)
Task-based documentation
Task-based documentation is a new way of packaging customer information in a structured, modular, task-centric format.
Task-based documentation focuses on what the user must do and the sequence in which to perform tasks.
The goal is to make Nortel documentation easy to find, easy to use, timely, and accurate.
The following figure describes the relationship between work flows, task flows, and procedures.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 26
26 Modular, task-based information
How to use task-based documentation
In task-based documentation, procedural information is included in the document. Conceptual and reference information is provided, and the user is guided on how to use conceptual and reference material by identified prerequisites or direct links and references.
The user navigates the information by following the flows that are provided for tasks and procedures.
Task flow overview
Task flows are flowcharts that illustrate which procedures and decisions are involved to complete an activity.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 27
Work flows, task flows, and procedures 27
The task flows guide you through activities to use the Nortel Ethernet Routing Switch 2500 Series, whether it is configuration, upgrading, installation, maintenance, or troubleshooting.
Each flow provides the prerequisites and links to the tasks or procedures. To perform or refer to a procedure, always follow the task flow. Following
the task flows ensures that you meet all the requirements for successful completion of the task.
Work flows, task flows, and procedures
Work flows, task flows, and procedures have similar elements to maintain consistency and usability. Each of the following sections have a specific function:
•
“Purpose statements” (page 27)
• “Prerequisites” (page 27)
• “Work flows or task flows” (page 27)
•
“Procedure steps” (page 28)
• “Example procedures” (page 28)
•
“Variable definitions” (page 28)
•
“Job aid” (page 28)
To understand the relationship between work flows, task flows, and procedures, see Work flows, task flows, and procedures in task-based documentation.
Purpose statements
Purpose statements explain why or when you would perform a work flow, task, or procedure and impact.
Prerequisites
Prerequisites list everything you must do or understand before you start the workflow, task, or procedure. Prerequisites can include tasks that should already be completed, risks, confirmation of system status, required knowledge, time estimates or limitations, and links to supporting information.
The prerequisite section is omitted if no required prerequisites exist.
Work flows or task flows
This section is the flow chart diagram that represents the task flow with navigational links to the tasks or procedures in the flow.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 28
28 Modular, task-based information
Procedure steps
Procedures provide numerical steps that help you perform the procedure. Each step is a single action.
Example procedures
Some procedures use examples to show how to correctly perform the procedure with realistic settings.
Variable definitions
Variable definitions provide the possible values, ranges, or definitions of variables used in the procedure steps.
If variables are not used in the procedure, then the variables definition section is omitted.
Job aid
Job aids provide information help to successfully perform the procedure. The job aid is only used when required.
Task-based documentation terms
The following table describes task-based documentation terms.
Term Description
Work flow A high or top-level group of tasks. Task or task flow A logical group of procedures
represented as a single action in a flowchart diagram. Complex tasks can be divided into simpler tasks or subtasks.
Procedure A logical group of single action steps
in a task.
Step A single action performed in a
procedure.
Variable A placeholder in procedure steps
representing a value or definition.
Restructuring Nortel technical documents into a task-based format is an ongoing initiative. The documentation for some Nortel products is already converted to the new format.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 29
29
.
Customer service
Visit the Nortel Web site to access the complete range of services and support that Nortel provides. Go to w
ww.nortel.com
or go to one of the
pages listed in the following sections.
Navigation
•
“Updated versions of documentation” (page 29)
•
“How to get help” (page 29)
•
“Express Routing Codes” (page 29)
•
“Additional information” (page 30)
Updated versions of documentation
You can download and print the latest versions of Nortel Ethernet Routing Switch 2500 Series technical documentation and Release Notes directly from the Internet at h
ttp://nortel.com/documentation.
How to get help
If you purchased a service contract for your Nortel product from a distributor or authorized reseller, contact the technical support staff for that distributor or reseller for assistance.
If you purchased a Nortel service program, you can get help by contacting one of the Nortel Technical Solutions Centers found at
h
ttp://www.nortel.com/callus; or visit our Technical Support site at
http://www.nortel.com/support.
Express Routing Codes
An Express Routing Code (ERC) is available for many Nortel products and services.
When you use an ERC, your call is routed to a technical support person who specializes in supporting that particular product or service. To locate an ERC for any product or service, go to h
ttp://www.nortel.com/erc.
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 30
30 Customer service
Additional information
Use the information in the following table to access other areas of the Nortel Web site.
For information about
Contact
Contact Us h
ttp://www.nortel.com/contactus
Documentation feedback h
ttp://www.nortel.com/documentfeedback
Products (marketing) h
ttp://www.nortel.com/product
Partner Information Center (PIC) http://www.nortel.com/pic Register h
ttp://www.nortel.com/register
Search h
ttp://nortel.com/search
Services h
ttp://nortel.com/services
Training h
ttp://nortel.com/trainings
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
NN47215-103 01.01
27 October 2008
Copyright © 2008 Nortel Networks
.
Page 31
Page 32
Nortel Ethernet Routing Switch 2500 Series
Documentation Roadmap
Copyright © 2008 Nortel Networks All Rights Reserved.
Printed in Canada and the United States of America Release: 4.2 Publication: NN47215-103 Document revision: 01.01 Document release date: 27 October 2008
To provide feedback or to report a problem in this document, go to www.nortel.com/documentfeedback.
www.nortel.com LEGAL NOTICE
While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to change without notice.
Nortel, the Nortel logo, and the Globemark are trademarks of Nortel Networks.
All other trademarks are the property of their respective owners.
Loading...