Ua5000 Documentation Guide (v100r019c02 - 01)

UA5000 Universal Access Unit
V100R019C02
Documentation Guide
Issue
01
Date
2011-07-30
HUAWEI TECHNOLOGIES CO., LTD.
Copyright Huawei Technologies Co., Ltd. 2011. 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.
Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.
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.
Huawei Technologies Co., Ltd.

Address:
Huawei Industrial Base

Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website:
http://www.huawei.com
Email:
support@huawei.com
Issue 01 (2011-07-30)
Huawei Proprietary and Confidential

Copyright Huawei Technologies Co., Ltd.

Documentation Guide
About This Document
About This Document

Intended Audience
This document describes the documentation set of the UA5000 in terms of:
l
Documentation retrieval
Documentation architecture
Related documents
Documentation development
Documentation release
This document is intended for:

l
Network planning engineers
Hardware installation engineers
Installation and commissioning engineers
Field maintenance engineers
Network monitoring engineers
System maintenance engineers
Configuration engineers
Symbol Conventions
The following symbols may be found in this document. They are defined as follows
Symbol
Description
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.
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 that, if not
avoided, could cause equipment damage, data loss, and
performance degradation, or unexpected results.
Issue 01 (2011-07-30)

ii

Documentation Guide
About This Document
Symbol
Description
Indicates a tip that may help you solve a problem or save
your time.
Provides additional information to emphasize or
supplement important points of the main text.
Update History
Updates between document issues are cumulative. Therefore, the latest document issue contains
all updates made in previous issues.
Updates in Issue 01 (2011-07-30)

This is the first release of UA5000 V100R019C02.
Issue 01 (2011-07-30)

iii

Documentation Guide
Contents
Contents
About This Document.....................................................................................................................ii
1 Version Mapping...........................................................................................................................1
2 How to use Documentation.........................................................................................................2
3 Documentation Details.................................................................................................................4
3.1 Product Documentation......................................................................................................................................5
3.2 Online Help.........................................................................................................................................................8
3.3 Release Documentation......................................................................................................................................9
4 Documentation Conventions....................................................................................................10
5 Standards-Compliant Documentation Development..........................................................12
6 Documentation Access and Feedback.....................................................................................13
6.1 Where to Obtain Documentation......................................................................................................................14
6.2 How to Provide Documentation Feedback.......................................................................................................14
7 Technical Support.......................................................................................................................16
Issue 01 (2011-07-30)

iv

Documentation Guide
1 Version Mapping
Version Mapping
Table 1-1 Version mapping between the UA5000 and the U2000
Product Name
Product Version
UA5000
V100R019C02
U2000
IPM: V100R003C00, V100R005C00

PVM: V100R005C00
Issue 01 (2011-07-30)


Documentation Guide
2 How to use Documentation
How to use Documentation
It is recommended that equipment operators search for the required document according to the
current network operation phase of the equipment. According to different network operation
phases and user roles, Figure 2-1 shows the recommended method of retrieving documents.
Figure 2-1 Role- and scenario-based documentation
Network
phase
Service
provision
Network
maintenance
Network
upgrade
Field
Maintenance
Administrator
Guide
Release
Notes
Product
Description
Hardware
Description
Commissioning
Guide
Command
Reference
Operation
Guide
Alarm
Reference
All other
documents
Parts
Replacement
Product
Description
Upgrade
Instructions
Feature
Description
Configuration
Guide
Product
Description
Product
Description
Performance
Metrics
Reference
Hardware
Description
Feature
Description
Hardware
Description
Command
Reference
Feature
Description
Product
Description
Hardware
Description
Trouble
shooting
Product
Description
System
maintenance
engineer
Troublesho
oting
System
administrator
Routine
Maintenanc
e
Field
maintenance
engineer
Northbound
Interface
User Guide
System
maintenance
engineer
Configuration
Guide
Network
monitoring
engineer
Software
Installation
Guide
Application
development
engineer
Hardware
Installation
Guide
Hardware
installation
engineer
Planning
Guidelines
Network
planning
engineer
Data
configuration
engineer
Network
deployment
Secondary
document
Installation
commissioning
engineer
Network
planning
Primary
document
Audience
Troubleshoo
ting
Product
Description
Performance
Metrics
Reference
Table 2-1 lists the tasks and recommended documents related to network maintenance.
Issue 01 (2011-07-30)


Documentation Guide
2 How to use Documentation
Table 2-1 Network maintenance tasks and relevant documents

Network Maintenance Task
Recommended Document
Network monitoring
Alarm Reference
Routine Maintenance
Issue 01 (2011-07-30)
Preventive maintenance
Routine Maintenance
Troubleshooting
Routine Maintenance
Emergency maintenance
Routine Maintenance


Documentation Guide
3 Documentation Details
Documentation Details
About This Chapter

The after-sales customer documentation of the UA5000 consists of the product documents,
online help and version release documents.
3.1 Product Documentation
3.2 Online Help
3.3 Release Documentation
Issue 01 (2011-07-30)


Documentation Guide
3.1 Product Documentation

The after-sales documentation CD-ROM contains all product documentation except the
Installation Pocket Guide.
Table 3-1 Product Documentation of the UA5000
Issue 01 (2011-07-30)
Document
Description
Location in the After-Sales

Documentation CD-ROM
Documentation
Guide
This document describes the aftersales customer documentation and

how to obtain the documentation.
Library Overview
Product
Description
This document describes the

product positioning and features,
architecture, ports, protocols,
network applications, device
management, and technical
specifications of the UA5000.
Description > Product Description
Hardware
Description

hardware of the UA5000, including
hardware configuration, and boards
and cables supported.
Description > Hardware

Description
Feature
Description

features supported by the UA5000
in terms of definition, purpose,
specifications, reference standards
and protocols, availability,
principles, and networking
applications.
Description > Feature Description
Environment
Monitoring

environment monitoring of the
UA5000 in terms of monitoring
principles, monitoring matching
configuration, monitoring
functions, sensors, and FAQs.
Description > Environment

Monitoring
Installation
Guide
This document describes how to

install the UA5000 in terms of
installation preparation and
regulations, equipment installation,
cable routing, power-on check, and
environment requirements.
Installation

Description > Hardware

Description (ONU-F02AF with
H612HABD/HABF)
../node/Installation.pdf

Documentation Guide
Issue 01 (2011-07-30)
Document
Description

Commissioning
and
Configuration
Guide

commissioning of the basic
functions provided by the UA5000
in terms of hardware, software,
interconnection, and maintenance
and management to ensure that the
UA5000 operates stably and
reliably on the network.
Commissioning

configure services of the UA5000
in terms of the configuration
procedure and example.
Configuration
Routine
Maintenance

routine maintenance tasks for the
UA5000 and how to perform the
tasks to maintain the UA5000.
Maintenance and Trouble

Management > Routine
Maintenance
Handling Alarms
and Events

handle alarms to troubleshoot
corresponding faults.

Management > Alarms and Events
Handling
Troubleshooting

troubleshoot common faults and
deal with emergencies in services
and functions provided by the
UA5000. In addition, this
document provides typical fault
cases and common operations for
troubleshooting.

Management > Troubleshooting
Parts
Replacement

precautions, preparation,
procedure, and postrequisites, and
lists the recommended tools for
parts replacement of the UA5000.

Management > Parts Replacement
Compliance and
Safety Manual
This document describes the safety Description > Regulatory

precautions for installing and
Compliance Information
operating the UA5000.
Safety Information
Command
Reference

commands supported by the
UA5000 in terms of function,
format, parameters, usage
guidelines, examples, and system
response.

Commands

Documentation Guide
Document
Description

Glossary
This document describes the terms,

acronyms, and abbreviations used
in the documents of the UA5000 for
reference.
Glossary
Table 3-2 U2000 after-sales customer documentation associated with the UA5000
Document
Description
iManager U2000 Product Description
This document describes the system

architecture, basic features, service features,
networking application, reliability design,
performance indexes, and specifications of
the U2000.
iManager U2000 Installation Guide
This document describes how to install and

configure the U2000 server and client,
including the operating system (OS),
database, server software, and client
software.
This document is applicable to the singleserver configuration.
iManager U2000 Administrator Guide
This document describes how to perform

routine maintenance, troubleshooting, and
emergency maintenance on the U2000 server
and system, including the user management,
log management, service process
management, database management, disk file
management, and NTP configuration.
This document is applicable to the singleserver configuration.
iManager U2000 High Availability System

Installation Guide
This document describes how to install and

configure the U2000 server and client,
including the OS, database, high availability
(HA) management software, server software,
and client software.
This document is applicable to the HA
system.
Issue 01 (2011-07-30)


Documentation Guide
Document
Description
iManager U2000 High Availability System

Administrator Guide
This document describes how to perform

routine maintenance, troubleshooting, and
emergency maintenance on the U2000 server
and system, including the user management,
log management, service process
management, database management, disk file
management, and NTP configuration.
This document is applicable to the HA
system.
iManager U2000 Operation Guide
This document describes the basic operations

of the U2000, including logging in to the
U2000, managing topological objects,
monitoring equipment alarms, monitoring
equipment performance, monitoring the
environment and power supply, backing up
device data, and upgrading equipment
software.
iManager U2000 NBI User Guide
This document describes the functions and

configuration procedures of various
northbound interfaces (NBIs) supported by
the U2000.
UA5000 Configuration Guide-GUI
This document describes how to configure

the UA5000 through the U2000.
UA5000 Performance Index Reference
This document describes the functions of and

indexes included in the performance
measurement profiles supported by the
UA5000 in the U2000 system, including the
index indication, index unit, index statistical
method, calculation formula, sample point,
and reference value.
3.2 Online Help

Integrated in the NMS operation and maintenance interface, the Online Help describes the
operation and maintenance interface and operation tasks. It is released with software.
Relationship between the product documentation and the Online Help are as follows:
l
Based on the product utilization and users' operation habits, the focuses of the product
documentation and Online Help are different. Online Help describes operation and
maintenance tasks based on the GUI, while the product documentation describes operation
and maintenance scenarios based on the product utilization.
Both the product documentation and Online Help describe major tasks pertaining to
operation and maintenance tasks.
Issue 01 (2011-07-30)


Documentation Guide
3.3 Release Documentation

The version release documents are released with the corresponding software.
Table 3-3 Version release documents of the UA5000
Issue 01 (2011-07-30)
Document
Description
Release Notes
This document provides the information about a newly released

version, including version mapping, version compatibility, updates
on software features, hardware features, commands, alarms, and
MIBs in each version, bugs fixed and known anomalies, precautions,
and upgrade impact.
Upgrade Guide
This document describes the version requirements before the

upgrade, upgrade precautions, and upgrade scenarios, and also
describes how to upgrade the UA5000s in batches through the U2000
DC, how to upgrade a single UA5000 through the CLI, and how to
roll back the system to the original version when the upgrade fails.
Patch Release Notes
This document describes the patch file, version mapping, and

problems solved by the patch of a version of the UA5000, and also
describes how to install the patch through the U2000 DC and the CLI
and how to roll back the system to the version before patch loading.


Documentation Guide
4 Documentation Conventions
Documentation Conventions
This topic describes the conventions for the after-sales customer documentation of the
UA5000. The symbols that may be found in this document are defined as follows:
Symbol Conventions
Symbol
Description
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 device damage, data
loss, performance deterioration, or unexpected
results.
Indicates a tip that may help you solve a problem or
save time.
Provides additional information to emphasize or
supplement important points of the main text.
Command Conventions
Issue 01 (2011-07-30)
Convention
Description
Boldface
The keywords of a command are in Boldface.
Italic
Command arguments (replaced by specific values in an actual

command) are in italics.
[]
Items (keywords or arguments) in brackets [ ] are optional.

10

Documentation Guide
4 Documentation Conventions
Convention
Description
{ x | y | ... }
Optional items are grouped in braces and separated by vertical

bars. One item is selected.
[ x | y | ... ]
Optional items are grouped in brackets and separated by vertical

bars. One item is selected or no item is selected.
{ x | y | ... } *
Optional items are grouped in braces and separated by vertical

bars. A minimum of one item or a maximum of all items can be
selected.
[ x | y | ... ] *
Optional items are grouped in brackets and separated by vertical

bars. Several items or no item can be selected.
GUI Conventions
Issue 01 (2011-07-30)
Convention
Description
Boldface
Buttons, menus, parameters, tabs, window, and dialog titles are

in boldface. For example, click OK.
>
Multi-level menus are in boldface and separated by the ">" signs.

For example, choose File > Create > Folder.

11

Documentation Guide
5 Standards-Compliant Documentation Development
Standards-Compliant Documentation
Development
The development of product documents is an engineering process by which the document

deliverables are provided for users. The process involves several phases such as planning,
development, and commercialization. The product documents are developed along with the
product software and hardware, which involves requirements analysis, design, development,
and test.
Development Process
The product documents are developed by the documentation department of Huawei. The
development of product documents includes the following phases:
1.
Analyzing customer requirements
2.
Mapping out the document development roadmap
3.
Developing prototypes of document deliverables
4.
Testing and verifying document deliverables
5.
Releasing documents
By implementing each development stage and conducting reviews at the end of each stage,
documentation is of consistently high quality.
Standard Compliance
The documentation development process complies with the TL9000 standard of Quality
Excellence for Suppliers of Telecommunications (QuEST) Forum.
Issue 01 (2011-07-30)

12

Documentation Guide
6 Documentation Access and Feedback
Documentation Access and Feedback
About This Chapter

6.1 Where to Obtain Documentation
6.2 How to Provide Documentation Feedback
Issue 01 (2011-07-30)

13

Documentation Guide
6.1 Where to Obtain Documentation

Product documentation
Table 6-1 describes how to obtain the product documentation.
Table 6-1 Obtaining the product documentation
Method of Obtaining Documentation
Phase
First installation
CD-ROM
Single Electronic
Document
l From the equipment

delivery
From Huawei support

website
l From Huawei support

website
l From local Huawei
representation offices
Version upgrade
l From Huawei support

website
l From local Huawei
representation offices
NOTE
l Obtain the product documentation from http://support.huawei.com as follows: Homepage > Documentation
> Access Network ...
l It is recommended that you use your work email to register as an equipment customer for login to Huawei
support website. For any help, contact Huawei technical support engineers.
Online Help
The Online Help is integrated and released with software. You can access the Online Help by:
l
Selecting Help on the NMS interface
Pressing F1 on any interface of the NMS
Release Documents
Release documents are released with the software package. You can apply to Huawei technical
support engineers for the documents.
6.2 How to Provide Documentation Feedback

Huawei welcomes your suggestions and comments. Please send your feedback about the product
documentation by:
l
Issue 01 (2011-07-30)
Sending an email to docHotline@huawei.com.

14

Documentation Guide
Issue 01 (2011-07-30)
Contacting the local Huawei technical support center.

15

Documentation Guide
7 Technical Support
Technical Support
During the equipment operation and maintenance, if a fault occurs and is difficult to locate or
rectify, or if you cannot rectify the fault by referring to the after-sales customer documentation,
contact Huawei for assistance (Huawei engineers will provide guidance remotely or on site on
troubleshooting).
Call local Huawei branches or representative offices or contact Huawei Customer Service
Center.
1.
Call local Huawei branches or representative offices or contact Huawei Customer Service
Center.
2.
Contact Huawei Customer Service Center: support@huawei.com.
Issue 01 (2011-07-30)

16

Ua5000 Documentation Guide (v100r019c02 - 01)

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Ua5000 Documentation Guide (v100r019c02 - 01)

Enviado por

Direitos autorais:

Formatos disponíveis

UA5000 Universal Access Unit

HUAWEI TECHNOLOGIES CO., LTD.

Copyright Huawei Technologies Co., Ltd. 2011. All rights reserved.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Huawei Industrial Base

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

About This Document

About This Document

This document is intended for:

Network planning engineers

Hardware installation engineers

Installation and commissioning engineers

Field maintenance engineers

Network monitoring engineers

System maintenance engineers

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

About This Document

Updates in Issue 01 (2011-07-30)

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

IPM: V100R003C00, V100R005C00

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

2 How to use Documentation

How to use Documentation

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

2 How to use Documentation

Table 2-1 Network maintenance tasks and relevant documents

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

About This Chapter

Huawei Proprietary and Confidential

UA5000 Universal Access Unit

3.1 Product Documentation

Location in the After-Sales

This document describes the aftersales customer documentation and

This document describes the

Description > Product Description

This document describes the

Description > Hardware

This document describes the

Description > Feature Description

This document describes the

Description > Environment

This document describes how to

Huawei Proprietary and Confidential

Description > Hardware

UA5000 Universal Access Unit

Location in the After-Sales

This document describes the

This document describes how to

This document describes the

Maintenance and Trouble

This document describes how to

Maintenance and Trouble

This document describes how to

Maintenance and Trouble