Imanager U2000 V200R016C50 XML NBI User Guide PDF

iManager U2000 Unified Network Management
System
V100R002C01
Northbound XML Interface User

Guide
Issue 05
Date 2010-11-19
HUAWEI TECHNOLOGIES CO., LTD.

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.
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 05 (2010-11-19) Huawei Proprietary and Confidential i

Copyright © Huawei Technologies Co., Ltd.
iManager U2000 Unified Network Management System
Northbound XML Interface User Guide About This Document
About This Document
Related Versions
The following table lists the product versions related to this document.
Product Name Version
iManager U2000 V100R002C01
Intended Audience
The iManager U2000 Northbound XML Interface User Guide describes the basic concept and
principles of U2000 northbound XML interface. And it is also describes how to deploying and
maintaining the XML NBI. This document also provides the relationship between the XML NBI
and license, service port description, supported equipments, the object naming rule, layer rate
description, the glossary, and the acronyms and abbreviations.
This document guides the user to understand basic operations of the U2000 XML NBI.
This document is intended for:
l Installation and Commissioning Engineer
l Data Configuration Engineer
l Application Developer
Symbol Conventions
The symbols that may be found in this document 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.
DANGER
Indicates a hazard with a medium or low level of risk, which

if not avoided, could result in minor or moderate injury.
WARNING
Issue 05 (2010-11-19) Huawei Proprietary and Confidential iii

About This Document Northbound XML Interface User Guide
Symbol Description
Indicates a potentially hazardous situation, which if not

avoided, could result in equipment damage, data loss,
CAUTION
performance degradation, or unexpected results.
TIP Indicates a tip that may help you solve a problem or save
time.
NOTE Provides additional information to emphasize or supplement

important points of the main text.
Command Conventions
The command conventions that may be found in this document are defined as follows.
Convention Description
Boldface The keywords of a command line are in boldface.
Italic Command arguments are in italics.
[] Items (keywords or arguments) in brackets [ ] are optional.
{ 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
The GUI conventions that may be found in this document are defined as follows.
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.
iv Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide About This Document
Change History
Updates between document issues are cumulative. Therefore, the latest document issue contains
all updates made in previous issues.
Changes in Issue 05 (2010-11-19) Based on Product Version V100R002C01

Errors are corrected.




Initial release.
Issue 05 (2010-11-19) Huawei Proprietary and Confidential v

Northbound XML Interface User Guide Contents
Contents
About This Document...................................................................................................................iii

1 System Overview.......................................................................................................................1-1
1.1 Introduction.....................................................................................................................................................1-2
1.2 Standards and Protocols Compliance..............................................................................................................1-2
1.3 Position of the XML NBI in the Integrated NMS...........................................................................................1-2
1.4 Supported Domains and Functions.................................................................................................................1-3
1.4.1 Alarm Function of the XML NBI..........................................................................................................1-3
1.4.2 Functions of the XML NBI (Configuration)..........................................................................................1-4
1.4.3 Performance Function of the XML NBI................................................................................................1-6
1.4.4 Functions of the XML NBI (Resource)..................................................................................................1-6
1.5 System Structure...........................................................................................................................................1-10
1.6 Technical Specifications...............................................................................................................................1-11
2 Principles.....................................................................................................................................2-1
2.1 Description of Involved Technology...............................................................................................................2-2
2.2 Working Principles of an XML NBI...............................................................................................................2-3
2.3 Sample Flow....................................................................................................................................................2-8
3 Deploying and Configuring the XML NBI...........................................................................3-1

3.1 Overview.........................................................................................................................................................3-2
3.2 Configuration Requirements...........................................................................................................................3-3
3.3 Logging in to the Client of the NMS Maintenance Suite................................................................................3-3
3.4 Checking the XML NBI Status.......................................................................................................................3-5
3.5 Deploying the XML NBI for the First Time...................................................................................................3-6
3.5.1 Adding XML NBI Component..............................................................................................................3-6
3.5.2 Adding the XML NBI Instance..............................................................................................................3-7
3.6 Configuring the XML NBI............................................................................................................................3-13
4 Maintaining the XML NBI.......................................................................................................4-1

4.1 Requirements for Maintenance Staff...............................................................................................................4-3
4.2 Routine Maintenance.......................................................................................................................................4-3
4.3 Logging In to the System Monitor Client.......................................................................................................4-4
4.4 Stopping the XML NBI...................................................................................................................................4-5
4.5 Disabling the XML NBI..................................................................................................................................4-7
4.6 Restarting the XML NBI.................................................................................................................................4-8
Issue 05 (2010-11-19) Huawei Proprietary and Confidential vii

Contents Northbound XML Interface User Guide
4.7 Deleting the XML Interface Instance............................................................................................................4-10

4.8 Deleting the XML NBI Component..............................................................................................................4-11
4.9 FAQ...............................................................................................................................................................4-12
4.9.1 Failure in Starting the U2000 XML Interface......................................................................................4-12
4.9.2 Whether the U2000 Successfully Enables the XML Interface.............................................................4-12
4.9.3 Whether the U2000 XML Interface is Licensed..................................................................................4-13
A Relations Between License and XML Interface.................................................................A-1

B Service Port Description..........................................................................................................B-1
B.1 Service Ports Used by the XML Interface.....................................................................................................B-2
B.2 Notes and Precautions....................................................................................................................................B-3
C Product List................................................................................................................................C-1
D Object Naming Rules..............................................................................................................D-1
D.1 MD.................................................................................................................................................................D-2
D.2 OS..................................................................................................................................................................D-2
D.3 ME.................................................................................................................................................................D-3
D.4 TL..................................................................................................................................................................D-4
D.5 EH..................................................................................................................................................................D-5
D.6 EQ..................................................................................................................................................................D-6
D.7 PTP................................................................................................................................................................D-8
D.8 FTP................................................................................................................................................................D-9
D.9 CTP..............................................................................................................................................................D-11
D.10 RESOURCESITE......................................................................................................................................D-12
D.11 TUNNELPOLICY.....................................................................................................................................D-13
D.12 TMD..........................................................................................................................................................D-14
D.13 CC..............................................................................................................................................................D-15
D.14 PG..............................................................................................................................................................D-16
D.15 SNC...........................................................................................................................................................D-17
D.16 EPG............................................................................................................................................................D-18
D.17 EXPLICITPATH.......................................................................................................................................D-19
D.18 FDFR.........................................................................................................................................................D-20
D.19 VRRP.........................................................................................................................................................D-21
D.20 TCPROFILE..............................................................................................................................................D-22
E Layer Rate Description.............................................................................................................E-1

F Glossary.......................................................................................................................................F-1
G Acronyms and Abbreviations...............................................................................................G-1
viii Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide Figures
Figures
Figure 1-1 Position of the XML interface of the U2000 in the integrated NMS................................................. 1-3
Figure 1-2 Software structure.............................................................................................................................1-11
Figure 2-1 SOAP message................................................................................................................................... 2-4
Figure 2-2 Principles of HTTP request response................................................................................................. 2-5
Figure 2-3 JMS.....................................................................................................................................................2-6
Figure 2-4 Interconnection process of the XML NBI..........................................................................................2-7
Figure A-1 Main dimensions...............................................................................................................................A-1
Issue 05 (2010-11-19) Huawei Proprietary and Confidential ix

Northbound XML Interface User Guide Tables
Tables
Table 1-1 Functions supported by the XML NBI (configuration)....................................................................... 1-4

Table 1-2 Functions supported by the XML NBI (resource)............................................................................... 1-6
Table 1-3 XML component................................................................................................................................1-11
Table 1-4 Performance indicators of an XML NBI............................................................................................1-12
Table 3-1 Parameters for the JMS server............................................................................................................. 3-8
Table 3-2 Parameters for the JMS server............................................................................................................. 3-9
Table 3-3 Parameters for the Advanced Items...................................................................................................3-10
Table 3-4 Parameters for the JMS server...........................................................................................................3-14
Table 3-5 Parameters for the JMS server...........................................................................................................3-15
Table 3-6 Parameters for the Advanced Items...................................................................................................3-16
Table 4-1 Meanings of license items..................................................................................................................4-13
Table A-1 Dimension description........................................................................................................................A-2
Table A-2 Description for License Item..............................................................................................................A-2
Table E-1 List of layer rates supported by the U2000 XML NBI.......................................................................E-1
Issue 05 (2010-11-19) Huawei Proprietary and Confidential xi

Northbound XML Interface User Guide 1 System Overview
1 System Overview
About This Chapter
This chapter describes the technology features of XML NBI.
1.1 Introduction
By bringing together modern software technologies and state-of-the-art technology models, the
TM Forum has enabled the birth of a new interface standard, the Multi-Technology Operations
Systems Interface (MTOSI). MTOSI will facilitate application-to-application inter-working,
reduce time of deployment, and lower the cost of ownership of Operations Software and Systems
(OSS). Service providers will gain leverage by being able to integrate systems from multiple
vendors with a minimum of "integration tax."
1.2 Standards and Protocols Compliance
The upper-level integrated NMS and OSS can communicate with the iManager U2000 that is
compliant with the MTOSI standards by using the MTOSI. In this way, the upper-level integrated
NMS and OSS can manage Huawei transport equipment, routers equipment, security equipment
and metro ethernet equipment) in a centralized manner.
1.3 Position of the XML NBI in the Integrated NMS
This section describes the position of XML NBI in the integrated NMS.
1.4 Supported Domains and Functions
The U2000 XML NBI provide alarm management, service provisioning, inventory management,
and performance management and can be integrated with the upper-layer OSS easily.
1.5 System Structure
This topic describes the system structure of the U2000 XML NBI.
1.6 Technical Specifications
This topic describes the performance indicators of the U2000 XML NBIs to provide a reference
for the interconnection with the OSS.
Issue 05 (2010-11-19) Huawei Proprietary and Confidential 1-1

1 System Overview Northbound XML Interface User Guide
1.1 Introduction
By bringing together modern software technologies and state-of-the-art technology models, the
TM Forum has enabled the birth of a new interface standard, the Multi-Technology Operations
Systems Interface (MTOSI). MTOSI will facilitate application-to-application inter-working,
reduce time of deployment, and lower the cost of ownership of Operations Software and Systems
(OSS). Service providers will gain leverage by being able to integrate systems from multiple
vendors with a minimum of "integration tax."
With reference to the MTOSI recommendations, the XML interface of the U2000 is developed
for iManager U2000. Network management systems of different levels can communicate with
one another by using the MTOSI. The application of the MTOSI can meet the trends of the
integration of network management systems and the development of cross-domain network
management systems.
1.2 Standards and Protocols Compliance

The upper-level integrated NMS and OSS can communicate with the iManager U2000 that is
compliant with the MTOSI standards by using the MTOSI. In this way, the upper-level integrated
NMS and OSS can manage Huawei transport equipment, routers equipment, security equipment
and metro ethernet equipment) in a centralized manner.
The MTOSI is compliant with the TMF standards as follows:

l TMF518
l TMF612
l TMF864
The MTOSI can realize the standard interface functions as follows:
l Query and notification of the physical inventory
l Alarm reporting
l Alarm query
l Acknowledgement and unacknowledgement of alarms
1.3 Position of the XML NBI in the Integrated NMS

This section describes the position of XML NBI in the integrated NMS.
Figure 1-1 shows the position of the XML interface of the U2000 in the integrated NMS.
1-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Figure 1-1 Position of the XML interface of the U2000 in the integrated NMS
OSS
Northbound XML Interface
U2000 U2000 Other EMS
Security IP Network
Equipment Router/Switch
/PTN/BRAS other
Equipments
Transport Network
Transport Network SDH/WDM
SDH/WDM /OTN/MW
/OTN/MW
1.4 Supported Domains and Functions

The U2000 XML NBI provide alarm management, service provisioning, inventory management,
and performance management and can be integrated with the upper-layer OSS easily.
1.4.1 Alarm Function of the XML NBI

1.4.2 Functions of the XML NBI (Configuration)
1.4.3 Performance Function of the XML NBI
1.4.4 Functions of the XML NBI (Resource)
1.4.1 Alarm Function of the XML NBI

The northbound XML alarm interface provides the following functions:
l Query of the alarm.

l Measurement of the alarm quantity.
l Acknowledgment and unacknowledgment of the alarm.
l Reporting of the alarm.

l Query of the performance threshold-crossing event.
1.4.2 Functions of the XML NBI (Configuration)

Table 1-1 Functions supported by the XML NBI (configuration)
Function Description Domain
Per-NE-based VPN Creating, deleting, modifying, activating, and Routing

service provisioning deactivating a per-NE-based service, a PWE3 service and PTN
(AES, CES, or EES service), or an L3VPN service, and domains
reporting notifications accordingly
Adding, deleting, activating, and deactivating a per-
NE-based VPLS service site, and reporting
notifications accordingly
Adding, deleting, activating, and deactivating a per-
NE-based L3VPN service site, and reporting
Creating, deleting, activating, and deactivating a per-
NE-based PW switch, and reporting notifications
accordingly
Configuring the QoS feature for the PWE3, VPLS, and
L3VPN services in the routing domain, the multicast
feature for VPLS and L3VPN services, and the BRAS
feature for L3VPN services
Per-NE-based tunnel Creating, deleting, modifying, activating, and Routing

management deactivating a per-NE-based tunnel (RSVP-TE, static, and PTN
or IP tunnel), and reporting notifications accordingly domains
QoS template Creating, deleting, modifying, applying, and Routing

management unapplying a QoS template, and reporting the creation and PTN
and deletion notifications of a QoS template domains
accordingly
Applying and unapplying a QoS template to and from
a port
Attribute Configuring the attributes of physical ports (POS, Routing,

configuration of ATM, Ethernet, or PDH ports) in the IP domain and PTN,
physical ports reporting notifications accordingly switch, and
Configuring the attributes of physical ports in the transport
transport domain and reporting notifications domains
accordingly

Management of Creating, deleting, and modifying a logical port Routing,

logical ports (Ethernet trunk, IP trunk, MP group, IMA, logical serial PTN, and
port, MFR group, VLAN IF, or tunnel IF) and reporting switch
notifications accordingly domains
Configuring a member port for a logical port of the
aggregation type, including adding, modifying, and
deleting a member port and reporting notifications
accordingly
Configuring an Ethernet trunk port of the aggregation
type in the switch domain, including creating and
deleting an Ethernet trunk logical port, and configuring
member ports for the Ethernet trunk logical port
Subinterface Creating and deleting a subinterface, configuring the Routing

management attributes of a subinterface, and reporting notifications domain
accordingly
VLAN management Configuring the working mode of a port Routing

of ports Configuring the default VLAN, allowed VLANs, and and switch
VLAN removal attributes domains
Configuring the VLAN stacking, VLAN mapping, and
VLAN multicast feature for a port
Global VLAN Creating, deleting, and modifying a VLAN in the Access,

management access domain, and configuring the multicast feature switch, and
for the VLAN routing
Creating, deleting, and modifying a global VLAN in domains
the switch domain, and configuring the multicast
feature for the global VLAN
Creating, deleting, and modifying a global VLAN in
the routing domain
NE attribute Configuring the basic attributes of an NE, deleting an All

configuration NE, and reporting notifications accordingly domains
GPON service Provisioning GPON services, and creating, deleting, Access

provisioning modifying, activating, and deactivating the GPON domain
services
ONT management Creating and deleting an ONT, and configuring the Access
attributes of the ONT and ONT ports domain
Transmission Creating and deleting a transmission descriptor, and Routing

descriptor reporting notifications accordingly and PTN
management domains
Tunnel policy Creating, deleting, and modifying a tunnel policy, and Routing
management reporting notifications accordingly domain

VRRP management Creating, modifying, and deleting a VR interface and a Routing

VR monitoring interface, configuring the global domain
attributes of the VR interface, and reporting
ANCP management Configuring the global ANCP attributes, creating and Routing
deleting a global ANCP template, applying an ANCP domain
neighbor template to ports, and setting ANCP line
parameters
1.4.3 Performance Function of the XML NBI

The XML NBI provides the following functions:
l Querying the current performance data.
l Querying the history performance data.
l Reporting performance threshold-crossing events.
1.4.4 Functions of the XML NBI (Resource)

Table 1-2 Functions supported by the XML NBI (resource)
Query for the Querying the management domains of the U2000 and -
management OS information
domains and OS
Resource site query Querying information about all optical NEs in the Transport
transport domain domain
Querying the names of all optical NEs in the transport
domain
Querying the details of a single optical NE by optical
NE name
Querying information about resources (such as card
and slot information) of an optical NE by optical NE
name
Reporting the creation and deletion notifications of an
optical NE
Reporting the status change notifications of resources
of an optical NE

NE information Querying the names of all NEs in the management All

query domain domains
Querying the details of all NEs in the management
domain
Querying the details of a single NE by NE name
Querying information about NEs in the routing and
switch domains by IP address
Reporting the creation, deletion, and attribute change
notifications of an NE
Fiber/Cable query Querying information about fibers in the transport Transport

domain and routing
Querying information about IP links and Layer 2 links domains
in the routing domain
Querying fibers, IP links, and Layer 2 links, and
reporting the creation and deletion notifications
accordingly
Query for Querying information about shelves, slots, cards, and All
information about subslots of an NE by NE name domains
the resources of an Querying information about cards, subslots, and others
NE of an equipment holder by equipment holder name
Reporting addition and deletion notifications of a shelf,
slot, or card
Query for physical Querying the names of all physical ports (including All
port information POS, ATM, Ethernet, and PDH ports) on an NE by NE domains
name
Querying the details of all physical ports on an NE by
NE name
Querying the details of a single physical port by
physical port name
Reporting the change notifications of important
attributes of a physical port
Query for logical port Querying the names of all logical ports (including Transport,
information Ethernet trunk, IP trunk, MP group, IMA, logical serial routing,
port, MFR group, and VLAN IF) on an NE by NE name PTN, and
Querying the details of all logical ports on an NE by switch
NE name domains
Querying the details of a single logical port by logical
port name
notifications of a logical port
Reporting the notifications of adding and deleting a
member port to and from a logical port of the
aggregation type

Subinterface query Querying the names of all subinterfaces of a physical Transport

port or logical port by physical port name or logical port and routing
name domains
Querying the details of all subinterfaces of a physical
port or logical port by physical port name or logical port
name
Querying the details of a single subinterface by
subinterface name
notifications of a subinterface
VPN service query Querying the names of all VPN services (including Routing
PWE3, VPLS, and L3VPN services) on an NE by NE and PTN
name domains
Querying the details of all VPN services (including
PWE3, VPLS, and L3VPN services) on an NE by NE
name
Querying the details of a single VPN service (PWE3,
VPLS, or L3VPN service) by VPN service name
Reporting the creation, deletion, status change, and
attribute change notifications of a VPN service
QoS template query Querying the names of all global QoS templates in the Routing
management domain and PTN
Querying the details of all global QoS templates in the domains
management domain
Querying the details of a single QoS template by QoS
template name
Querying resources where a QoS template is applied by
QoS template name
Reporting the creation and deletion notifications of a
QoS template
Tunnel query Querying the names of all dynamic tunnels, static Routing
tunnels, and IP tunnels of an NE by NE name and PTN
Querying the details of all dynamic tunnels, static domains
tunnels, and IP tunnels of an NE by NE name
Querying the details of a single tunnel by tunnel name
attribute change notifications of a tunnel
Tunnel policy query Querying the names of all tunnel policies of an NE Routing
Querying the details of all tunnel policies of an NE domain
tunnel policy

Transmission Querying the names of all transmission descriptors of Routing

descriptor query an NE and PTN
Querying the details of all transmission descriptors of domains
an NE
transmission descriptor
Query for trails and Querying the names of network-wide SDH, WDM, Transport
cross-connections OTN, and RTN trails domain
Querying the details of network-wide SDH, WDM,
OTN, and RTN trails
Querying the details of a single SDH, WDM, OTN, or
RTN trail by trail name
Querying all cross-connections of an NE
Querying the routes of a trail by trail name
Querying the routes and optical fibers of a trail by trail
name
attribute change notifications of a trail
cross-connection
Reporting the notification of route attribute changes of
a trail
Protection group Querying all SDH, WDM, and equipment protection Transport
query groups of an NE domain
Querying the details of a single SDH, WDM, or
equipment protection group by protection group name
Querying the protection switching data of a single
SDH, WDM, or equipment protection group by
protection group name
GPON service query Querying the names of all PON services on an NE by Access
NE name domain
Querying the details of all PON services on an NE by
NE name
Querying the details of a single PON service by PON
service name
Querying the routes of a PON service by PON service
name
ONT query Querying information about ONTs associated with an Access

OLT or a PON port by OLT name or PON port name, domain
and querying ONT information by ONT name

Query for service Querying service virtual ports of an NE by NE name Access

virtual ports and Querying ADSL line profiles, G.SHDSL line profiles, domain
profiles and MEF IP traffic profiles of an NE by NE name
ANCP information Querying all ANCP neighbor templates on an NE by Routing

query NE name domain
Querying all ANCP line information of an NE by NE
name
Querying ports where an ANCP neighbor template is
applied by ANCP neighbor template name
VRRP information Querying the names of all VR interfaces of an NE by Routing

query NE name domain
Querying the details of all VR interfaces of an NE by
NE name
Querying information about the VR monitoring
interface of a VR interface by VR interface name
Querying the global attributes of a VR interface by VR
interface name
Query for physical Querying the management domain, OS, cables, and All
inventories by using NEs by using the getInventory interface domains
a coarse granularity Querying the shelves, slots, cards, physical ports of the
interface entire network or a single NE by using the getInventory
interface
Querying the names, attributes, or details of inventory
objects by specifying filter criteria
The getInventory interface supports multiple MEP
modes such as SRR, SIT, and AFB.
1.5 System Structure

This topic describes the system structure of the U2000 XML NBI.
1.5 System Structure shows the software structure of the U2000 XML NBI.

Figure 1-2 Software structure
Inventory Provisioning
Performance
Alarm Inventory Update
(get/set/create/delete/edit/
(Notify events)
active/deactive operations)
OSS
Applications
SOAP/HTTP/
HTTPS/FTP/ JMS
SFTP
ASN.1
TCP/
ODBC/ U2000
Database JDBC
Qx/SNMP GUI Client
Managed Networks
Table 1-3 XML component
Component Function
U2000 Indicates the U2000 server. It is used for managing network and
providing NBIs.
GUI client Indicates the U2000 client. It provides a GUI for performing
operations on network. The client communicates with the
U2000 server through the Asn.1 protocol.
OSS applications Indicates the upper layer OSS. It performs operations on network
through the XML NBI provided by the U2000.
Database Indicates the U2000 database. It is used for saving and providing
U2000 data.
1.6 Technical Specifications

This topic describes the performance indicators of the U2000 XML NBIs to provide a reference
for the interconnection with the OSS.

Table 1-4 shows the performance indicators of each XML NBI.
Table 1-4 Performance indicators of an XML NBI

Item Indicator
Number of NMS connections received 10

concurrently
Delay of response to XML request Shorter than 3s when the CPU usage is
lower than 50%
Alarm notification processing capability More than 60 records per second when 3
NMSs are connected
Alarm notification transmission delay Shorter than 10s when 3 NMSs are
connected
CAUTION
The alarm handling capability of the CORBA NBI depends on many factors, such as alarm
quantity on the live network, and CPU performance and memory size of the server. If an alarm
storm occurs, the CORBA NBI will possibly reach its handling limit. The CORBA NBI can
report a maximum of 1,000,000 alarms within one hour. To ensure the stability of the system,
the CORBA NBI will discard some alarms if the alarm quantity exceeds 1,000,000. You are
recommended to handle network faults instantly if an alarm storm occurs. Also, the OSS is
suggested to synchronize alarms actively at proper times, for example, when the system is idle.

Northbound XML Interface User Guide 2 Principles
2 Principles
About This Chapter
2.1 Description of Involved Technology

This section describes the related technology and concept involved in this document.
2.2 Working Principles of an XML NBI
The U2000 XML NBI adopts the Web Service technology. Web Service is a technology for
accessing network services. It defines services through WSDL or XSD and implements the
communication through the SOAP message. In addition, it supports various transmission
protocols, such as HTTP, HTTPS, and JMS. The following describes the principles of the XML
NBI based on the key scenarios supported by the U2000 XML NBI and the preceding features.
2.3 Sample Flow
The following section describes how to query all the current alarms on the NMS.

2 Principles Northbound XML Interface User Guide
2.1 Description of Involved Technology

This section describes the related technology and concept involved in this document.
MTOSI
Multi-Technology Operations System Interface (MTOSI) is a standard for implementing
interfaces between OSSs. Service providers (carriers) use multiple Operational Support Systems
(OSS) to manage complex networks. Since the various parts of the network must interact with
the OSSs. It is standardized by the Tele-management Forum (TM Forum). The TMF NGOSS
provides a set of reference models that aid in analyzing and designing next generation BSS and
OSS solutions that may utilize the MTOSI interface specifications.
JMS
The Java Message Service (JMS) API is a Java Message Oriented Middleware (MOM) API for
sending messages between two or more clients. JMS is a specification developed under the Java
Community Process as JSR 914. The JMS API supports the following models:
l Point-to-point or queuing model.
l Publish and subscribe model.
In the point-to-point or queuing model, a producer posts messages to a particular queue and a
consumer reads messages from the queue. Here, the producer knows the destination of the
message and posts the message directly to the consumer's queue. It is characterized by the
following rule:
l Only one consumer gets the message.
l The producer does not have to be running at the time the receiver consumes the message,
nor does the receiver need to be running at the time the message is sent.
l Every message successfully processed is acknowledged by the receiver.
The publish/subscribe model supports publishing messages to a particular message topic. Zero
or more subscribers may register interest in receiving messages on a particular message topic.
In this model, neither the publisher nor the subscribers know about each other. A good metaphor
for it is anonymous bulletin board. The following is the characteristics of this model.
l Multiple consumers obtain the message.
l There is a timing dependency between publishers and subscribers. The publisher has to
create a subscription in order for clients to be able to subscribe. The subscriber has to remain
continuously active to receive messages, unless it has established a durable subscription.
In that case, messages published while the subscriber is not connected are redistributed
whenever it reconnect.
l Using Java, JMS provides a way of separating the application from the transport layer of
providing data. The same Java classes are used to communicate with different JMS
providers by using the JNDI information for the desired provider. The classes first use a
connection factory to connect to the queue or topic, and then use populate and send or
publish the messages. On the receiving side, the clients then receive or subscribe to the
messages.
Web Service
The W3C defines a Web Service as a software system designed to support interoperable Machine
to Machine interaction over a network. Web Service is frequently just Web APIs that are accessed

over a network, such as the Internet, and executed on a remote system hosting the requested
services. The W3C Web Service definition encompasses many different systems, but in common
usage the term refers to clients and servers that communicate using XML messages that follow
the SOAP standard. Common in both the field and the terminology is the assumption that there
is also a machine readable description of the operations supported by the server, a description
in the Web Service Description Language (WSDL). The latter is not a requirement of a SOAP
endpoint, but it is a prerequisite for automated client-side code generation in the mainstream
Java and .NET SOAP Frameworks. Some industry organizations, such as the WS-I, mandate
both SOAP and WSDL in their definition of a Web Service.
HTTP(S)
Hypertext Transfer Protocol (HTTP) is a communications protocol used to transfer or convey
information on the World Wide Web. HTTP is a request/response protocol between clients and
servers. The client making an HTTP request, such as a web browser, spider, or other end-user
tool - is referred to as the user agent. The responding server, which stores or creates resources
such as HTML files and images, is called the origin server.
WSDL
The Web Service Description Language (WSDL) is a XML-based language that provides a
model for describing Web Service. The WSDL defines services as collections of network
endpoints, or ports. WSDL specification provides an XML format for documents for this
purpose. The abstract definition of ports and messages is separated from their concrete use or
instance, allowing the reuse of these definitions. A port is defined by associating a network
address with a reusable binding, and a collection of ports define a service. Messages are abstract
descriptions of the data being exchanged, and port types are abstract collections of supported
operations. The concrete protocol and data format specifications for a particular port type
constitutes a reusable binding, where the messages and operations are then bound to a concrete
network protocol and message format. In this way, WSDL describes the public interface to the
Web Service.
SOAP
Simple Object Access Protocol (SOAP) is a protocol for exchanging XML-based messages over
computer networks, normally using HTTP/HTTPS. SOAP forms the foundation layer of the
Web Service stack, providing a basic messaging framework upon which abstract layers can be
built.
XML
The eXtensible Markup Language (XML) is a general-purpose markup language. It is classified
as an extensible language, because it allows its users to define their own tags. Its primary purpose
is to facilitate the sharing of structured data across different information systems, particularly
through internet. It is used both to encode documents and serialize data.
2.2 Working Principles of an XML NBI

The U2000 XML NBI adopts the Web Service technology. Web Service is a technology for
accessing network services. It defines services through WSDL or XSD and implements the
communication through the SOAP message. In addition, it supports various transmission
protocols, such as HTTP, HTTPS, and JMS. The following describes the principles of the XML
NBI based on the key scenarios supported by the U2000 XML NBI and the preceding features.

Defining Services Through WSDL or XSD

l The WSDL or XSD is a type of XML document.
l The XSD describes the data type and message format.
l The WSDL describes the external services and interface, and the bound transmission
protocols, such as HTTP, HTTPS, and JMS.
Implementing the Communication Through the SOAP Message

l SOAP defines the data format that is irrelevant to the transmission protocol.
l The SOAP message can be enveloped as the message of any protocol for transmission.
Figure 2-1 SOAP message
Adopting the HTTP as the Key Protocol for Request Response of an Interface
l The cost of developing the client and server by using HTTP is lower than that by using
other protocols.
l The HTTP protocol is relatively mature and is supported by most of systems.
l Usually, a firewall does not block the HTTP-based communication. Therefore, HTTP can
penetrate a firewall.
l Messages are transmitted in HTTPS encryption mode.

l Figure 2-2 Principles of HTTP request response
Adopting the JMS as the Notification Bus

l Subscription and unsubscription of various notification resources, such as inventory and
alarms
– You can subscribe to one type of notifications or multiple types of notifications.
l One to many notification sending
– Multiple users can subscribe to the same type of notifications. That is, the notifications
can be sent to multiple users at the same time.
l Saving of notifications as a file
– The message middleware can save notification messages in a physical medium. After
an OSS subscribes to a type of notifications, if the OSS goes offline due to a fault, the
OSS can receive the notifications sent during the offline period when the OSS goes
online.
l Flexible setting of filter criteria
– When subscribing to a type of notifications, you can specify the filter criteria. Currently,
you can set filter criteria only for alarms. In this way, only the notifications that meet
the filter criteria are sent to you.

Figure 2-3 JMS

Interconnection Process
Figure 2-4 Interconnection process of the XML NBI
Step Description
1 Start the JMS message middleware.
2 Start the Web Service middleware.
3 Establish a connection.
4 Connect to the JMS message middleware.
5 Sent a request message.
6 Return a response message.
7 Report an alarm.
l Scenario 1: System startup process

1. Start the JMS message middleware.
2. Start the Web Service middleware.
3. Connect the JMS message middleware to the U2000.
l Scenario 2: User's subscription to a notification
1. Connect the OSS to the JMS message middleware.
2. The OSS subscribes the desired notification.
l Scenario 3: Alarm reporting

1. The U2000 reports an alarm to the JMS message middleware.

2. The OSS receives the alarm that is forwarded by the JMS message middleware.
l Scenario 4: Call of common interfaces
1. The OSS sends a request message.
2. The U2000 returns a response message.
l Scenario 5: Call of coarse granularity interfaces
1. The OSS sends a request message.
2. The U2000 returns a message to the FTP server and upload the progress information.
3. After the file transfer is complete, the U2000 sends a completion notification to the
OSS.
2.3 Sample Flow

The following section describes how to query all the current alarms on the NMS.
Context
NOTE
When integrating with the XML NBI, you can compile the WSDL file to an API interface file, which
simplifies the operation of code integration.
Procedure
1 Find the interface definition corresponding to the current alarms in the AlarmRetrievalHttp.wsdl
file, as shown below.
<wsdl:operation name="getActiveAlarms">
<soap:operation soapAction="getActiveAlarms" style="document"/>
<wsdl:input>
<soap:header message="tns:getActiveAlarmsRequest" part="mtopHeader"
use="literal"/>
<soap:body parts="mtopBody" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:header message="tns:getActiveAlarmsResponse" part="mtopHeader"
use="literal"/>
<soap:body parts="mtopBody" use="literal"/>
</wsdl:output>
<wsdl:fault name="getActiveAlarmsException">
<soap:fault name="getActiveAlarmsException" use="literal"/>
</wsdl:fault>
</wsdl:operation>
2 Find the data type definition of the request message in the AlarmRetrievalMessages.xsd file, as
shown below.
<xsd:element name="getActiveAlarmsRequest">
<xsd:annotation>
<xsd:documentation>
Request message structure of the getActiveAlarms operation
This operation returns (to the requesting OS) a specified subset of the
active alarms known to the target OS. The target OS returns all alarms satisfying
the filter constraints of the requesting OS. This operation can only be directed to
a top-level OS and not to a subordinate OS.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>

<xsd:element name="filter" type="tns:ActiveAlarmFilterType" minOccurs="0">

<xsd:annotation>
<xsd:documentation>
Defines the subset of the set of active alarms known to the target
OS that are to be returned to the requesting OS.
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
3 Find the definition of the response message in the AlarmRetrievalMessages.xsd file, as shown
below.
<xsd:element name="getActiveAlarmsResponse" type="alm:AlarmListType">
<xsd:annotation>
<xsd:documentation>
Response message structure of the getActiveAlarms operation
</xsd:annotation>
</xsd:element>
4 Construct the following XML message according to the data type definition of the request and
send the XML message to the XML NBI through HTTP.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://
www.tmforum.org/mtop/rtm/xsd/ar/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/
xsd/nam/v1" xmlns:v13="http://www.tmforum.org/mtop/nra/xsd/com/v1"
xmlns:v14="http://www.tmforum.org/mtop/nra/xsd/prc/v1">
<soapenv:Header>
<v1:header>
<v1:security>admin:u2000u2000</v1:security>
<v1:communicationPattern>MultipleBatchResponse</v1:communicationPattern>
<v1:communicationStyle>RPC</v1:communicationStyle>
<v1:requestedBatchSize>20</v1:requestedBatchSize>
<v1:batchSequenceNumber>1</v1:batchSequenceNumber>
</v1:header>
</soapenv:Header>
<soapenv:Body>
<v11:getActiveAlarmsRequest>
</v11:getActiveAlarmsRequest>
</soapenv:Body>
</soapenv:Envelope>
5 Receive the following XML message from the XML NBI and parse the message according to
the data type definition of the response message.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://
www.tmforum.org/mtop/rtm/xsd/ar/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/
xsd/nam/v1" xmlns:v13="http://www.tmforum.org/mtop/nra/xsd/com/v1"
xmlns:v14="http://www.tmforum.org/mtop/nra/xsd/prc/v1">
<soapenv:Header>
<v1:header>
<v1:security>admin:u2000u2000</v1:security>
<v1:communicationPattern>MultipleBatchResponse</v1:communicationPattern>
<v1:communicationStyle>RPC</v1:communicationStyle>
<v1:requestedBatchSize>20</v1:requestedBatchSize>
<v1:batchSequenceNumber>1</v1:batchSequenceNumber>
</v1:header>
</soapenv:Header>
<soapenv:Body>
<v11:getActiveAlarmsRequest>
</v11:getActiveAlarmsRequest>
</soapenv:Body>
</soapenv:Envelope>
----End

Northbound XML Interface User Guide 3 Deploying and Configuring the XML NBI
3 Deploying and Configuring the XML NBI
About This Chapter
This chapter describes how to deploy and configure the U2000 XML NBI. It includes the
following information:
3.1 Overview
This topic describes the background information and the terms involved in the process of
deploying and configuring the northbound interface.
3.2 Configuration Requirements
U2000 XML NBI and the U2000 server run on the same PC or Sun workstation, any additional
configuration is not required. But to enable the XML NBI, you must purchase the license for
the corresponding functions.
3.3 Logging in to the Client of the NMS Maintenance Suite
After you log in to the client of the NMS Maintenance Suite, you can maintain the U2000 by
using the NMS Maintenance Suite, including deploying the U2000 and configuring the instance
of the northbound interface.
3.4 Checking the XML NBI Status
After check the license and ensure it is support XML functions, you need to check the current
status of XML NBI, and deploy the XML NBI according the status.
3.5 Deploying the XML NBI for the First Time
By default, the XML NBI is not installed during the installation of U2000 server. To enable the
XML NBI, you need to add the XML NBI the XML NBI component first, then add the XML
NBI instance.
3.6 Configuring the XML NBI
In order to enable the XML NBI, even though you have installed XML NBI component, you
need configure the XML parameters accord to NMS planning. Also, you can modify the
parameters by configuring XML NBI again. Generally, general parameters are mandatory and
advanced items are optional but the default values are recommended. Every advanced item is
independent and you need not set the parameters.

3 Deploying and Configuring the XML NBI Northbound XML Interface User Guide
3.1 Overview
This topic describes the background information and the terms involved in the process of
deploying and configuring the northbound interface.
Attention Item
l Northbound interface is an optional component of the U2000. A license is required for
using this function.
l If you do not install the northbound interface component during the installation of the
U2000, you need to add it manually.
l The northbound interface is a System single-instance deployment package. Therefore, only
one instance can be deployed.
CAUTION
l After the northbound interface component is installed or added, you need to add a
corresponding instance and configure parameters. Then, the U2000 can start the NBI-related
process.
l After initializing the database of the U2000, you need to configure the northbound interface
instance again.
l After the northbound interface instance is configured, you need to restart all the NMS
services.
Terms
The following explains certain confusable terms:
l Component: It is the software function unit that can be selected for installation. A
component can consist of multiple deployment packages.
l Deployment package: It is the software unit that is deployed on a PC. In a distributed system,
the deployment packages of a component may be deployed on different PCs.
Deployment packages are classified into the following types:
– System single-instance: Such deployment packages can be installed on only one server
and the server can be deployed with only one instance.
– Single-server single-instance: Such deployment packages can be installed on multiple
servers and each server can be deployed with only one instance.
– Single-server multi-instance: Such deployment packages can be installed on multiple
servers and each server can be deployed with multiple instances.
NOTE
The type of northbound interface deployment package is System single-instance.
NMS Maintenance Suite

Through the GUI of the NMS maintenance tool, you can conveniently deploy the northbound
interface.

The NMS Maintenance Suite is a graphical system maintenance tool that is developed for the
iManager U2000. The NMS Maintenance Suite is used to deploy the instances and distributed
system of the U2000.
Refer to the NMS Maintenance Suite part of the iManager U2000 Administrator Guide for the
details about the NMS Maintenance Suite.
3.2 Configuration Requirements

U2000 XML NBI and the U2000 server run on the same PC or Sun workstation, any additional
configuration is not required. But to enable the XML NBI, you must purchase the license for
the corresponding functions.
NOTE
For different operation system, the configuration requirements of U2000 is different, refer to the
corresponding Software Installation Guide for more information.
Hardware Configuration
In practice, the U2000 XML interface and the U2000 server run on the same PC or SUN
workstation. The hardware should be well configured enough to ensure the proper installation
and running of the U2000 server. Any additional hardware configuration is not required the
U2000 XML interface.
For details of hardware requirements of U2000 Server, refer to section "Configuration

Requirements" in the iManager U2000 Software Installation Guide.
Software Configuration
Since the XML interface is integrated into the U2000 installation software, no additional
software configuration is required for the installation of the U2000 XML interface.
For details of software requirements U2000 Server, refer to section "Configuration

Requirements" in the iManager U2000 Software Installation Guide.
License
The U2000 controls the functions and available resources of the XML NBI through a license.
If you want to enable the XML interface, you need to purchase the U2000 license. Ensure the
license support XML interface function before deploying the XML NBI.
For details, see A Relations Between License and XML Interface. If the license does not
support the functions or resources needed, contact Huawei engineers to apply for the license.
For the license introduction and information on how to apply for a license, see section Applying
for and Updating the License in the iManager U2000 Administrator Guide.
3.3 Logging in to the Client of the NMS Maintenance Suite

After you log in to the client of the NMS Maintenance Suite, you can maintain the U2000 by
using the NMS Maintenance Suite, including deploying the U2000 and configuring the instance
of the northbound interface.

Prerequisite
l The server of the NMS Maintenance Suite must be started.
l The client and the server of the NMS Maintenance Suite must communicate with each other
normally.
Context
In normal cases, the NMS Maintenance Suite server starts along with the OS. You can do as
follows to check whether the NMS Maintenance Suite server is started:
l In the Windows OS, check whether the msdaemon.exe and msserver.exe processes are
started in the Task Manager window. If you can find the two processes in the process list,
it indicates that the NMS Maintenance Suite server is started. Otherwise, open the DOS
window and run the following command to start the NMS Maintenance Suite server:
> net start nodemgr
l In the Solaris or SUSE Linux OS, run the following command as the root user to check
whether the NMS Maintenance Suite server is started:
# ps -ef | grep java
If ./engineering/jre/jre_unix/bin/java is displayed, it indicates that the NMS Maintenance

Suite server is started. Otherwise, run the following commands to start the NMS
Maintenance Suite server:
# cd /opt/HWENGR/engineering
# ./startserver.sh
Procedure
1 On a computer installed with the NMS Maintenance Suite client, double-click the U2000
MSuite shortcut icon on the desktop and then wait about one minute. The Login dialog box is
displayed.
NOTE
l In the Solaris OS, you must log in to the Java desktop system as the root user. Otherwise, the U2000
MSuite shortcut icon is not displayed on the desktop.
l In the SUSE Linux OS, you cannot log in to the NMS Maintenance Suite client through the shortcut
icon. You need to run the following commands as the root user to start the NMS Maintenance Suite
client:
# cd /opt/HWENGR/engineering
# ./startclient.sh
2 Set the related login parameters.

The login parameters are described as follows:
l IP Address: It refers to the system IP address of the computer where the NMS Maintenance
Suite server resides. In a distributed system, you need to enter the system IP address of the
master server.
l Port No.: The default port number is 12212. You do not need to change the default value
during login.
l User Name: The default user name is admin.
l Password: The initial password is admin.
3 Click OK.

NOTE
l When you log in to the client of the NMS Maintenance Suite, a progress bar showing the progress of querying
components and instances is displayed. In this case, wait until the operation is complete.
l The NMS Maintenance Suite works in single-user mode. That is, only one NMS Maintenance Suite client
can log in to the NMS Maintenance Suite server at one time. In a high availability system, only one site can
be logged in at one time.
----End
Result
If a dialog box is displayed during the login, indicating that network configuration information
is inconsistent and re-synchronization is required after login, read through the message to learn
the server that needs to be synchronized. Then, do as follows:
1. On the NMS Maintenance Suite client, click the Server tab.

2. Right-click the server whose network configuration needs to be synchronized, and choose
Synchronize the network configuration from the shortcut menu. A dialog box is
displayed for you to confirm the operation.
NOTE
Before synchronizing network configuration, you need to stop NMS services. For details, see the U2000
Administrator Guide.
3. Click OK.
3.4 Checking the XML NBI Status

After check the license and ensure it is support XML functions, you need to check the current
status of XML NBI, and deploy the XML NBI according the status.
Context
The XML NBI is one of the components of U2000. The installation of the XML NBI is integrated
in the process of installing the U2000 server. There are two cases of the installation.
l If the XML NBI is not installed during the installation of the U2000 server, to enable the
interface, you need to add the component first and then add the instance. For details, see
3.5 Deploying the XML NBI for the First Time.
l If the XML NBI is installed during the installation of the U2000 server, to enable the
interface, you need to configure the instance. For details, see 3.6 Configuring the XML
NBI.
The details for how to install the U2000 Server, refer to iManager U2000 Software Installation
Guide. If you want to install XML NBI, ensure you have select Northbound XML Interface
component during the installation of the U2000 server.
Procedure
1 Log in to the client of the NMS Maintenance Suite. For details, see 3.3 Logging in to the Client
of the NMS Maintenance Suite.
2 Click Instance tab, check whether the AgentXML exist in the instance list.

l If the AgentXML instance exist, refer the steps in 3.6 Configuring the XML NBI enable
the XML NBI.
l If the AgentXML instance not exist, you need to check whether the XML NBI
deployment package exist according the Step 3.
3 Click Deployment Package tabs, check whether the XML NBI exist in the deployment package
list.
l If the XML NBI deployment package exist, refer the steps in 3.5.2 Adding the XML NBI
Instance enable the XML NBI.
l If the XML NBI deployment package not exist, refer the steps in 3.5 Deploying the XML
NBI for the First Time enable the XML NBI.
----End
3.5 Deploying the XML NBI for the First Time

By default, the XML NBI is not installed during the installation of U2000 server. To enable the
XML NBI, you need to add the XML NBI the XML NBI component first, then add the XML
NBI instance.
3.5.1 Adding XML NBI Component

The XML NBI is one component of the U2000. If you have not installed the XML NBI by
default, you need to add the XML NBI component.
3.5.2 Adding the XML NBI Instance
The type of XML NBI deployment package is system single-instance, you can deploy one
instance only. After adding the XML NBI component, you need to adding XML NBI instance
to enable the XML interface. You need set the general parameters, and it is recommended you
set the advanced parameters to default value.
3.5.1 Adding XML NBI Component

The XML NBI is one component of the U2000. If you have not installed the XML NBI by
default, you need to add the XML NBI component.
Prerequisite
l The NMS Maintenance Suite server installed on the master and slave servers must be
started.
l The System Monitor server of the U2000 must be started.
l The Database server process must be in the Running state.
l The NMS Maintenance Suite client communicates with the NMS Maintenance Suite server
in the normal state.
Context
l In a distributed system, you only need to log in to the NMS maintenance tool server of the
master server to perform this operation.
l In a high availability system, you only need to log in to the NMS maintenance tool server
of the primary site to perform this operation.

Procedure
2 On the NMS Maintenance Suite client, choose Deploy > Add Component. The Add
Component dialog box is displayed.
CAUTION
l In the distributed system, the XML NBI could be deployed in master server only.
l You can add one XML NBI component only.
3 Choose the Northbound XML Interface component and click OK, the progress bar is
displayed.
4 Wait until the dialog box is displayed to prompt the message The component is successfully
added.
5 Click OK, completed the operation.
----End
Follow-up Procedure
After the component is added, you need to add the XML NBI instance, then you can enable
the XML interface.
3.5.2 Adding the XML NBI Instance

The type of XML NBI deployment package is system single-instance, you can deploy one
instance only. After adding the XML NBI component, you need to adding XML NBI instance
to enable the XML interface. You need set the general parameters, and it is recommended you
set the advanced parameters to default value.
Prerequisite
started.
l Database Server Process must be in the Running state.
l The NMS Maintenance Suite client must communicate with the NMS Maintenance Suite
server in the normal state.
l The component to which the instance is added must be installed. If the component is not
installed, you must add XML NBI component first.
Context

Procedure
2 On the NMS Maintenance Suitel client, click the Deployment Package tab. Right-click the
northbound XML interface deployment package and choose Add Instance. The dialog box is
displayed.
3 In the General tab, set the parameters for basic items.
4 Configure the JMS server.

1. Enter the IP and JMS Server Port, the default IP is the IP address of NMS server and the
default port is 61616.
2. Optional: Select Base on SSL, set SSL Port, the default port is 61617.
NOTE
l The JMS server is a message server located between the upper layer OSS and the interfaces for JMS
communication.
l JMS Server and U2000 server could run in different PC or workstation, but you must ensure it is valid.
It is recommended you use the default value, depoly the JMS server and U2000 server in the same PC
or workstation.
Table 3-1 provides the parameters for JMS Server.
Table 3-1 Parameters for the JMS server
Parameter Description Default Value
IP Indicates the IP address of the JMS The IP address of U2000 server.

server.

JMS Server Port Indicate the port ID used for the 61616
JMS server.
l Port 61616 is used for non-SSL
JMS server.
l Port 61617 is used for SSL JMS
server.
JMS User Name The user name to access the JMS admin
server.
JMS Password The password to access the JMS test1234

server.
5 Configure the Web service.

1. Choose IP from the drop-list, the default IP is the IP address of NMS server.
2. Optional: Select Register JMS Service, enable the JMS Service.
NOTE
If you have not select the check box, the JMS service is disabled.
3. Select the protocol, Base on HTTP or Base on HTTPS, set the Port, it is 9997 by default.
NOTE
You cannot select both of the Base on HTTP and Base on HTTPS. It is recommended that you select Base on
HTTP only by default.
Table 3-2 provides the parameters for Web Service.

WebSerivice IP Displays the IP address of the The IP of U2000 server

Web server.
HTTP Port Set the port. 9997
Register JMS Service Sets whether to use JMS. Enable
Base on HTTP/Base on Choose the protocol to be HTTP

HTTPS used.
6 Click the Advanced tab, set the parameters for advanced items.

7 Choose the item in the left object tree, set the parameters in the right windows. Refer Table
3-3 for details.
Table 3-3 Parameters for the Advanced Items
Parameter Value Description
iView Log Switch Open, Close Enables or disables iView

Default Value: Open internal logs for the XML
Framework.
iView Log Level All, Trace, Warning, Error Sets the iView Debug Level.
Default Value: Warning Namely, the system will
record the selected level
iView log in the log files.
Max Debug Folder Size 100-1024 MB When the debug folder

Default Value: 100MB reaches the maximum size,
the five oldest debug file will
be deleted.
Framework Log Switch Open, Close Enables or disables the logs

Default Value: Open of the XML Framework.
Product Log Switch Debug, Info, Warn, Error, Specifies the level of the
Fatal product log. Namely, the
Default Value: Info system will record the
selected level product log in
the log files.
Framework Log Level Debug, Warn, Error Specifies the Level of Trace
Default Value: Warn Information to be placed in
Log File. Namely, the system
will record the selected level
log in the log files.

Log Queue Size 10 to 2147483647 Indicates the queue size for

Default Value: 10000 asynchronous logs.
Product Log Max Backup 1 to 100 Specifies the maximum

Index Default Value: 40 number of the product log
files. When the parameter
value reaches a specified
value, the system will
generate new file to displace
the older log file.
Product Log Max File Size 1 to 100 M The size of the product log
Default Value: 5 M file. When the size of the file
is greater than the maximum
size, the system will generate
the new log file.
Encoding Format UTF-8, GBK Specifies the encoding

Default Value: UTF-8 format of the files.
Configure Domain Name Default Value: Huawei/ Indicates the name of a

U2000 managed domain.
8 Click OK to complete the configuration.

9 Optional: In the case of a distribute HA system with multiple NICs, if you enter the IP address
of the master server to deploy XML NBI, and this IP address is not in the relevant address drop-
list, the Address for Standby Server dialog box is displayed.
1. You must enter the IP address of the XML NBI on the standby server.

CAUTION
l You can enter any IP address of the standby server (except 127.0.0.1).
l You can set the same IP address or different IP addresses for the JMS Server IP and
Web Server IP fields.
l Ensure that the input IP address is correct. That is, the standby server should be able to
communicate with the upper-layer NMS successfully with the input IP address.
l The XML NBI searches for the IP configuration list (hosts file) of the computer
automatically. Additionally, the first IP address in the configuration list is bound to the
JMS Server IP. In the case of a single IP address, you need not set the JMS Server
IP. In the case of multiple IP addresses, you need to set the JMS Server IP because the
bound IP address is unknown. When setting the JMS Server IP field, you need to set
it to an IP address that the upper-layer NMS can have access to. The same as the Web
Server IP.
2. Click OK.
10 Wait until the dialog box is displayed to prompt the success message.
11 Click OK, complete add the instance.
12 The dialog box is displayed, prompt that restart all of the NMS service.
13 Click OK, close the dialog box.
14 Log in to the System Monitor. Restart all services of the U2000.
15 In the System Monitor client, check the Status of the XML service and JMS service. If all the
processes are running, the XML NBI is enabled successfully.
----End

3.6 Configuring the XML NBI

In order to enable the XML NBI, even though you have installed XML NBI component, you
need configure the XML parameters accord to NMS planning. Also, you can modify the
parameters by configuring XML NBI again. Generally, general parameters are mandatory and
advanced items are optional but the default values are recommended. Every advanced item is
independent and you need not set the parameters.
Prerequisite
l Log in to the Solaris or SUSE Linux OS as the root user.
l Log in to the Windows OS as the Administrator user.
l In a HA system, configure the XML interface on the active server.
started.
l The Database server process must be in the Running state.
l The XML NBI instance must be added. Otherwise, add the related XML NBI instance
first.
Context
Procedure
2 On the NMS Maintenance Suite client, choose NBI > Configure the XML interface
instance from the Main Menu. The dialog box is displayed.
3 In the General tab, set the parameters for basic items.

4 Configure the JMS server.

1. Enter the IP and JMS Server Port, the default IP is the IP address of NMS server and the
default port is 61616.
2. Optional: Select Base on SSL, set SSL Port, the default port is 61617.
NOTE
l The JMS server is a message server located between the upper layer OSS and the interfaces for JMS
communication.
l JMS Server and U2000 server could run in different PC or workstation, but you must ensure it is valid.
It is recommended you use the default value, depoly the JMS server and U2000 server in the same PC
or workstation.
Table 3-4 provides the parameters for JMS Server.
IP Indicates the IP address of the JMS The IP address of U2000 server.

server.
JMS Server Port Indicate the port ID used for the 61616
JMS server.
l Port 61616 is used for non-SSL
JMS server.
l Port 61617 is used for SSL JMS
server.
JMS User Name The user name to access the JMS admin
server.
JMS Password The password to access the JMS test1234

server.

5 Configure the Web service.

1. Choose IP from the drop-list, the default IP is the IP address of NMS server.
2. Optional: Select Register JMS Service, enable the JMS Service.
NOTE
If you have not select the check box, the JMS service is disabled.
3. Select the protocol, Base on HTTP or Base on HTTPS, set the Port, it is 9997 by default.
NOTE
You cannot select both of the Base on HTTP and Base on HTTPS. It is recommended that you select Base on
HTTP only by default.
Table 3-5 provides the parameters for Web Service.

WebSerivice IP Displays the IP address of the The IP of U2000 server

Web server.
HTTP Port Set the port. 9997
Register JMS Service Sets whether to use JMS. Enable
Base on HTTP/Base on Choose the protocol to be HTTP

HTTPS used.
6 Click the Advanced tab, set the parameters for advanced items.
7 Choose the item in the left object tree, set the parameters in the right windows. Refer Table
3-6 for details.

Table 3-6 Parameters for the Advanced Items

iView Log Switch Open, Close Enables or disables iView

Default Value: Open internal logs for the XML
Framework.
iView Log Level All, Trace, Warning, Error Sets the iView Debug Level.
Default Value: Warning Namely, the system will
record the selected level
iView log in the log files.
Max Debug Folder Size 100-1024 MB When the debug folder

Default Value: 100MB reaches the maximum size,
the five oldest debug file will
be deleted.
Framework Log Switch Open, Close Enables or disables the logs

Default Value: Open of the XML Framework.
Product Log Switch Debug, Info, Warn, Error, Specifies the level of the
Fatal product log. Namely, the
Default Value: Info system will record the
selected level product log in
the log files.
Framework Log Level Debug, Warn, Error Specifies the Level of Trace
Default Value: Warn Information to be placed in
Log File. Namely, the system
will record the selected level
log in the log files.
Log Queue Size 10 to 2147483647 Indicates the queue size for

Default Value: 10000 asynchronous logs.
Product Log Max Backup 1 to 100 Specifies the maximum

Index Default Value: 40 number of the product log
files. When the parameter
value reaches a specified
value, the system will
generate new file to displace
the older log file.
Product Log Max File Size 1 to 100 M The size of the product log
Default Value: 5 M file. When the size of the file
is greater than the maximum
size, the system will generate
the new log file.
Encoding Format UTF-8, GBK Specifies the encoding

Default Value: UTF-8 format of the files.
Configure Domain Name Default Value: Huawei/ Indicates the name of a

U2000 managed domain.

8 Click OK to complete the configuration.

9 Optional: In the case of a distribute HA system with multiple NICs, if you enter the IP address
of the master server to deploy XML NBI, and this IP address is not in the relevant address drop-
list, the Address for Standby Server dialog box is displayed.
1. You must enter the IP address of the XML NBI on the standby server.
CAUTION
l You can enter any IP address of the standby server (except 127.0.0.1).
l You can set the same IP address or different IP addresses for the JMS Server IP and
Web Server IP fields.
l Ensure that the input IP address is correct. That is, the standby server should be able to
communicate with the upper-layer NMS successfully with the input IP address.
l The XML NBI searches for the IP configuration list (hosts file) of the computer
automatically. Additionally, the first IP address in the configuration list is bound to the
JMS Server IP. In the case of a single IP address, you need not set the JMS Server
IP. In the case of multiple IP addresses, you need to set the JMS Server IP because the
bound IP address is unknown. When setting the JMS Server IP field, you need to set
it to an IP address that the upper-layer NMS can have access to. The same as the Web
Server IP.
2. Click OK.
10 The dialog box is displayed, prompt that restart all of the NMS service.
11 Click OK, close the dialog box.
12 Log in to the System Monitor. Restart all services of the U2000.
13 In the System Monitor client, check the Status of the XML service and JMS service. If all the
processes are running, the XML NBI is enabled successfully.

----End

Northbound XML Interface User Guide 4 Maintaining the XML NBI
4 Maintaining the XML NBI
About This Chapter
This chapter provides instructional suggestions for the maintenance conditions and routine
operations for the XML interface. This chapter also describes the basic operation for maintaining
the XML interface. In addition, this chapter describes how to solve the problems that may occur
during maintenance, which can help maintenance personnel to solve the problems quickly.
4.1 Requirements for Maintenance Staff

This section describes the requirements for maintenance staff.
4.2 Routine Maintenance
By Routine Maintenance, faults such as malfunction in the system operation can be detected in
time and countermeasures are adopted to properly handle the problem. In this way, hidden
troubles are cleared to prevent the occurrence of an accident. It is recommended that you perform
routine maintenance once a week.
4.3 Logging In to the System Monitor Client
The U2000 System Monitor Client uses the client/server model. To perform an operation, you
need to log in to the server through the U2000 client.
4.4 Stopping the XML NBI
If you need not use the XML NBI, you can stop the XML process by using the System Monitor
client.
4.5 Disabling the XML NBI
If you need not use the XML NBI, you can disable the related XML processes so that the
processes are not started together with the nmsuser.
4.6 Restarting the XML NBI
This topic describes how to restart the XML NBI.
4.7 Deleting the XML Interface Instance
You can delete an instance for the XML interface if it is not in use, which enhances the running
efficiency of the U2000.
4.8 Deleting the XML NBI Component
You can delete the component for the XML NBI if it is not in use, which enhances the running

4 Maintaining the XML NBI Northbound XML Interface User Guide
4.9 FAQ
This section describes the identifying and handling methods for common failures in the system.

4.1 Requirements for Maintenance Staff

This section describes the requirements for maintenance staff.
To guarantee the smooth maintenance and rapid problem solving, the maintenance staff are
required to have the following experiences:
l Be familiar with the basic operations of the PC, Sun workstation, Windows, Solaris and
Linux operating systems.
l Have a good understanding of the XML technology.
l Understand concepts of the telecommunication management network (TMN) and know the
basic networking architecture of the U2000 well.
l Be familiar with the configuration and the operations of enabling and disabling the
U2000 XML interface.
NOTE
For maintenance of the workstation, refer to the maintenance manual provided by its supplier.
4.2 Routine Maintenance

By Routine Maintenance, faults such as malfunction in the system operation can be detected in
time and countermeasures are adopted to properly handle the problem. In this way, hidden
troubles are cleared to prevent the occurrence of an accident. It is recommended that you perform
routine maintenance once a week.
Checking the XML Service

l When the U2000 single server is running, log in to the client of Sysmonitor which monitors
the U2000 process. Check whether the XML Service processes are running properly.
l In the U2000 high availability system, run the following command in the active server to
query the operating status of the XML Service processes.
# ps -ef | grep xml
The XML service operates normally only when the outputs of the XML Service process
have their respective IDs
NOTE
The active server refers to the host computer in use. Normally, a high availability system uses only one
active server.
If the JMS service is started, you need to check whether the JMS service process is started. The method
of checking the JMS service process is the same as that of the XML service.
Backing up the logs of the U2000 XML Interface

The log information of the U2000 XML interface is saved in the %IMAPROOT%\server\log
\nbi directory. Back up the log files regularly in case they occupy too much of the system disk
space. The log files records the running information of the U2000 XML interface and the
operation performed by the NMS/OSS through the U2000 XML interface. If an error occurs
when the U2000 XML interface is running, you can refer to the log files to do the troubleshooting.
If you want to back up the log information of the U2000 XML interface, manually copy the log
information to a specified directory.

NOTE
In the case of the Solaris OS and Linux OS, the environment variable is represented by $Variable (Variable
indicates the name of the variable).
In the case of the Windows OS, the environment variable is represented by %Variable% (Variable
indicates the name of the variable).
The environment variable $IMAP corresponds to the installation directory of the U2000 server.
l In the case of the Solaris OS and Linux OS, the U2000 server is installed in the /opt/U2000/server
directory by default. Hence, $IMAP corresponds to /U2000/server/conf.
l In the case of the Windows OS, the U2000 server is installed in the C:\U2000\server directory by
default, Hence, %IMAP% corresponds to C:\U2000\server\conf and %IMAPROOT% corresponds
to C:\U2000.
4.3 Logging In to the System Monitor Client

The U2000 System Monitor Client uses the client/server model. To perform an operation, you
need to log in to the server through the U2000 client.
Prerequisite
Before login, ensure that the U2000 client and server are connected normally, and the server
works correctly.
Context
l The default port number of the server is 31030. Do not change it in normal conditions.
Otherwise, you cannot log in to the U2000 server.
l The login mode is classified into the SSL mode and the common mode. In SSL mode, the
data is encrypted when being transmitted between the client and the server. In common
mode, the data is not encrypted during transmission.
l The port used for login in common mode is different from that in SSL mode. The port is
31030 in common mode, and 31080 in security (SSL) mode.
l If you do not log in during the preset period after the previous login, the U2000 disables
or delete the user account.
l If you never use a new user account for login, the account is not restricted to these rules,
that is, the U2000 does not set it to be invalid or delete it.
Procedure
1 Double-click the related shortcut icon on the desktop to start the system monitor client.
2 In the Login dialog box, select a server from the Server drop box.
NOTE
If there is no server to select, do as the followings:
1. Click on the right of Server drop box.

2. In the Server List dialog box, click Add.
3. In the Add Server Information dialog box, specify Name and Server Name(or IP Address), and
then select a login mode. Click OK.
4. In the Server List dialog box, click OK.

3 In the Login dialog box, enter the user name and password.
The user name and password are the same as those for the U2000 client.
4 Click Login.
NOTE
l If the user name and the password are correct, the Loading dialog box is displayed, indicating the
loading progress.
l If the user name or password is wrong, the Information dialog box prompts cannot login.
l If the password is to expire in the specified days, the system prompts you to change the password before
the expiration date.
l If the license is to expire in the specified days, the system notifies you of the expiration date.
l If you use a temporary license, you are prompted to apply for an official license.
----End
4.4 Stopping the XML NBI

If you need not use the XML NBI, you can stop the XML process by using the System Monitor
client.
Prerequisite
l On Solaris or SUSE Linux, you must have the nmsuser user rights.
l On Windows, you must have the administrator user rights.
l In an HA system, the XML interface is configured on the active server.
l The U2000 must be started.
l The XML Service and JMS Service processes are in the running state.
Context
NOTE
After you add an instance of the XML interface by using the NMS Maintain Tool, the startup mode is
Automatic by default. The XML interface process is started together with the U2000.
Procedure
1 Log in to the System Monitor.
2 On the System Monitor, click the Process Monitor tab.

3 Select the XML Service process, right-click, and then choose Stop the Process from the shortcut
menu.
4 The dialog box displayed, click Yes.
5 Follow step 3 to step 4, stop JMS Service processes.
6 In the System Monitor client, when Status of the relevant XML processes is Stopped, the
operation is successful.
----End

4.5 Disabling the XML NBI

If you need not use the XML NBI, you can disable the related XML processes so that the
processes are not started together with the nmsuser.
Prerequisite
l The XML Service and JMS Service processes are in the running state.
Procedure
3 Select the XML Service process, right-click, and then choose Startup Mode > Disabled from
the shortcut menu.
4 Select the JMS Service process, right-click, and then choose Startup Mode > Disabled from
the shortcut menu.
5 In the System Monitor client, when Startup Mode of the relevant XML processes is
Disabled, the operation is successful.

----End
4.6 Restarting the XML NBI

This topic describes how to restart the XML NBI.
Prerequisite
l The XML Service and JMS Service processes are in the Stopped state.
Procedure

3 In the System Monitor client, select the JMS Service process, right-click, and then choose Start
the Process from the shortcut menu.
4 In the System Monitor client, select the XML Service process, right-click, and then choose
Start the Process from the shortcut menu.
5 In the System Monitor client, when Status of the relevant XML processes, namely JMS
Service and XML Service are Running, the operation is successful.
----End

4.7 Deleting the XML Interface Instance

You can delete an instance for the XML interface if it is not in use, which enhances the running
Prerequisite
l Log in to the Solaris or SUSE Linux OS as user root.
l Log in to the Windows OS as user Administrator.
started.
l The U2000 must be operating.
l It is recommended that you stop the XML interface before delete the instance.
Context
Procedure
2 On the NMS Maintenance Suite client, click the Instance tab. Select the AgentXML instance
from the instance list, right-click, and choose Delete Instance
3 Click OK. After the confirmation, the NMS Maintenance Suite begins deleting the AgentXML
instance.
4 Click the Deployment Package tab, if the Instance Count of the XML NBI deployment package
is zero, that means the deletion success.

NOTE
After the AgentXML instance is deleted, the Sysmonitor does not display the information about the XML
Service process, JMS Service process. If you need to re-enable the XML interface, refer to 3 Deploying
and Configuring the XML NBI.
----End
4.8 Deleting the XML NBI Component

You can delete the component for the XML NBI if it is not in use, which enhances the running
Prerequisite
l Log in to the Solaris or SUSE Linux OS as user root.
l Log in to the Windows OS as user Administrator.
started.
l The U2000 must be operating.
l Ensure you have deleted the XML NBI instance.
Context
Procedure
2 On the NMS Maintenance Suite client, click Deployment Package tab, check whether the
instance count of XML NBI deployment package is zero.
l If Instance Count is not zero, you need to deleted the XML NBI instance first.
l If Instance Count is zero, choose Deploy > Remove Component from the Main Menu.
The dialog box is displayed.
3 Select Northbound XML Interface component, click OK. The deleting of the component is
started.
NOTE
You can not delete the components which are basic or have not installed. You can not select them in the
left window.
4 Wait until the message the component is successfully removed is displayed. Click OK.

5 View the Deployment Package list, the Northbound XML Interface deployment package not
exist indicate that the operation is successful.
----End
4.9 FAQ
This section describes the identifying and handling methods for common failures in the system.
NOTE
For the irremovable faults, please dial 800-830-2118 (available at any time) for technical support from
Huawei, and work together with engineers from Huawei to clear the faults.
4.9.1 Failure in Starting the U2000 XML Interface

4.9.2 Whether the U2000 Successfully Enables the XML Interface
4.9.3 Whether the U2000 XML Interface is Licensed
4.9.1 Failure in Starting the U2000 XML Interface
Possible Cause
A failure in starting the U2000 XML interface is usually caused by incorrect configuration of
the configuration file.
It is recommended that you perform the following steps:
Procedure
1 Open the %IMAPROOT%\server\nbi\xml\conf\communicate.cfg configuration file. Check
whether the configuration items (such as IP address, port, mode, and license file path) of MDP
are correct. If the configuration items are incorrect, configure the XML interface instance again
by following 3 Deploying and Configuring the XML NBI.
2 Open the %IMAPROOT%\server\nbi\xml\conf\database.cfg configuration file. Check

whether the configuration items (such as database type, IP address, and port) of the database are
correct. If the configuration items are incorrect, configure the XML interface instance again by
following 3 Deploying and Configuring the XML NBI.
----End
4.9.2 Whether the U2000 Successfully Enables the XML Interface

l In the window of the System Monitor, view whether XML Service process is in the running
state. If so, it indicates that the XML interface is started successfully.
l To determine whether the XML interface is started, do as follows: enter the WSDL address
of the Web service that the system should support in the browser and check whether the
output is correct.
– In the browser, enter http://server IP:port/OperationsSystemRetrieval?wsdl. If the
WSDL definition is displayed in the browser, it indicates that the XML interface is
started successfully.

– If the error message "cannot find the server" is displayed, it indicates that the XML
interface is not started.
4.9.3 Whether the U2000 XML Interface is Licensed

l Log in to the U2000 client and view the license. Choose Help > About > License from the
Main Menu of the U2000 client to view whether the U2000 license supports the preceding
XML interface functions.
l View the XML interface functions supported by the license file of the U2000.
Table 4-1 Meanings of license items

License Item Function Value
LNSDPENES04 Indicates the number of users 0 to 80000

that are connected to the
XML interface. In details, the
number of users that can
concurrently send requests to
the XML interface every 60s.
LNSDXMLNOT01 Indicates whether the alarm 0: unauthorized

reporting and notification 1: authorized
reporting functions are
authorized.
LNSDXMLA01 Indicates whether the 0: unauthorized

function of querying the 1: authorized
alarms related to transport
NEs is authorized.

inventory related to transport
NEs is authorized.
LNSDPENEX01 Indicates the number of 0 to 80000

equivalent transport NEs for
which you can query alarms.
The user can query
networkwide alarms only
when the number of
equivalent transport NEs is
smaller than or equal to the
authorized value of this
license item.

License Item Function Value

equivalent transport NEs for
which you can query
inventory.
The user can query
networkwide NEs only when
the number of equivalent
transport NEs is smaller than
or equal to the authorized
value of this license item.

alarms related to router and
security NEs is authorized.

inventory data related to
router and security NEs is
authorized.

equivalent router and
security NEs for which you
can query alarms.
The user can query
networkwide alarms only
when the number of
security NEs is smaller than
or equal to the authorized
value of this license item.

security NEs for which you
can query inventory.
The user can query
networkwide NEs only when
the number of equivalent
router and security NEs is
smaller than or equal to the
authorized value of this
license item.

Northbound XML Interface User Guide A Relations Between License and XML Interface
A Relations Between License and XML

Interface
This part introduces the relations between license and U2000 northbound XML interface.
The U2000 license controls the software of XML interface in the following four dimensions:
l Interface function
l Technical domain
l Management capacity
l Number of OSS connections
l The first three dimensions depend on each other. The U2000 divides the license according
to the dimensions to dynamically control the XML software.
Figure A-1 Main dimensions
y
cit
a pa
t C
technical domain
m en
ge
ana
M
Interface Function
Issue 05 (2010-11-19) Huawei Proprietary and Confidential A-1

A Relations Between License and XML Interface Northbound XML Interface User Guide
Table A-1 Dimension description

Dimension Meaning
Interface function l Alarm and inventory

l Service provisioning and test diagnosis
l Performance
l Common
Technical domain l Transport

l Router and Metro including security
l Access
Management capacity Physical inventory: Controls NEs. The unit is

number of equivalent NEs.
Number of OSS connections Indicates the maximum number of OSS users

that can be online concurrently.
On Solaris or SUSE Linux, view the license as user root. Use the text viewer to view the contents
of the $IMAPROOT/server/etc/conf/license/ONXXXXXXX.dat file.
On Windows, view the license as user administrator. Use the text viewer to view the contents
of the %IMAPROOT%\server\etc\conf\license\ONXXXXXXX.dat file.
Here each "X" represents an integer ranging from 0 to 9. Refer to Table A-2 for the details of
license control items.
Table A-2 Description for License Item

License Control Item Abbreviations Value
NBI-XML Connection LNSDPENES04 0~20000

Amount License
Per Equivalent NE License LNSDPENEX01 0~300000

for NBI-XML Alarm&
Inventroy-Transmission
Network

for NBI-XML Performance-
Transmission Network

for NBI-XML Service
Provisioning and
Test&Diagnosis-
Transmission Network
A-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide A Relations Between License and XML Interface
License Control Item Abbreviations Value

for NBI-XML Alarm&
Inventroy-IP

for NBI-XML Performance-
IP

for NBI-XML Service
Provisioning and
Test&Diagnosis-IP
Per Narrowband Port License LNSDPENEC08 0~300000

for NBI-XML Alarm-Access
Network
Per Broadband Port License LNSDPENEC28 0~300000

for NBI-XML Alarm-Access
Network
Per Narrowband Resource LNSDPENEC18 0~300000

License for NBI-XML
Service Provisioning-Access
Per Broadband Resource LNSDPENEC31 0~300000

License for NBI-XML
Per Narrowband Resource LNSDPENEC13 0~300000

License for NBI-XML
Performance-Access
Per Broadband Resource LNSDPENEC32 0~300000

License for NBI-XML
Performance-Access
Compatible License for LNSDNELCR80 0~300000

XML Inventory NBI--
Access
Per PON Terminal Resource LNSDNELCR88 0~300000

License for NBI-XML
Network
Per PON Terminal Resource LNSDNELCR89 0~300000

License for NBI-XML
Alarm-Access Network
Issue 05 (2010-11-19) Huawei Proprietary and Confidential A-3

Northbound XML Interface User Guide B Service Port Description
B Service Port Description
This chapter provides information on service ports that are used by the XML interface and how
to use and query these service ports.
B.1 Service Ports Used by the XML Interface
B.2 Notes and Precautions
Issue 05 (2010-11-19) Huawei Proprietary and Confidential B-1

B Service Port Description Northbound XML Interface User Guide
B.1 Service Ports Used by the XML Interface

Service Name Service Port/ Direction (in Function Remarks
Protocol relation to the
server)
HTTP service 9997/TCP IN Listens to the If there are

access of upper- routers or
layer NMS firewalls on the
network
between the
U2000 server
and the upper-
layer NMS,
check whether
the service port
is filtered.
HTTPS service 443/TCP IN Listens to the If there are

network
between the
U2000 server r
and the upper-
layer NMS,
check whether
the service port
is filtered.
JMS service 61616/TCP IN Listens to the If there are

network
between the
U2000 server r
and the upper-
layer NMS,
check whether
the service port
is filtered.
B-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide B Service Port Description
Service Name Service Port/ Direction (in Function Remarks

Protocol relation to the
server)
JMS service 61617/TCP IN Listens to the If there are

(SSL) SSL-mode routers or
access of upper- firewalls on the
layer NMS network
between the
U2000 server r
and the upper-
layer NMS,
check whether
the service port
is filtered.
B.2 Notes and Precautions

In the practical communication process, the source (the server) and the sink (the client) use
relevant ports. Usually you only need to specify the source port, and the sink port is dynamically
created.
Note the following during the project implementation:
l The service ports used by the NMS should not be closed. Run the following command to
view the system service ports:
netstat -an
If there are routers or firewalls between the source and the sink, check all ports used by the
source and the sink. Make sure that these ports can be normally turned up to support the
communication between the sources and sinks.
Issue 05 (2010-11-19) Huawei Proprietary and Confidential B-3

Northbound XML Interface User Guide C Product List
C Product List
Equipment series Product
OSN OptiX OSN 9500
OptiX OSN 7500
OptiX OSN 3500
OptiX OSN 2500
OptiX OSN 1500
OptiX OSN 2000
OptiX OSN 500
OptiX OSN 2500 REG
PTN OptiX PTN 1900
OptiX PTN 3900
OptiX PTN 912
OptiX PTN 910
OptiX PTN 950
RTN OptiX RTN 610
OptiX RTN 620
OptiX RTN 605
OTN OptiX OSN 1800
OptiX OSN 3800
OptiX OSN 6800
OptiX OSN 8800 T32
SDH OptiX 155C
Issue 05 (2010-11-19) Huawei Proprietary and Confidential C-1

C Product List Northbound XML Interface User Guide
OptiX 155S
OptiX 155/622B_I
OptiX 155/622B_II
OptiX 2500
OptiX 2500 REG
OptiX Metro 100
OptiX Metro 200
OptiX Metro 500
OptiX 155/622H(Metro 1000)
OptiX Metro 1000V3
OptiX Metro 1050
OptiX Metro 1100
OptiX 155/622(Metro 2050)
OptiX 2500+(Metro 3000)
OptiX Metro 3100
OptiX 10G(Metro 5000)
WDM OptiX BWS 320GV3
OptiX BWS 1600G
OptiX BWS 1600G OLA
OptiX OTU40000
OptiX Metro 6020
OptiX Metro 6040
OptiX Metro 6040V2
OptiX Metro 6100
OptiX Metro 6100V1
OptiX Metro 6100V1E
Metro OptiX Metro 100
OptiX Metro 200
OptiX Metro 500
OptiX Metro 1000V3
C-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide C Product List
OptiX Metro 1050
OptiX Metro 1100
OptiX Metro 3100
Router 8070 routers:

NE05, NE08, NE08E, NE16, NE16E, NE20,
NE20E
8011 routers:
NE40, NE80
8090 routers:
NE40E, NE80E, NE5000E
R1600, R1700, R2500, R2600, R3600, and

R4000,
S2000, S2000B, S2000C, S2000EA, S3000,
S3500, and S3500EA,
S3900, S5000, S5100EI, S5500, S5600,
S6500, S7800, S8000, and S8500
SR8800
Switch CX200D
CX200
CX300
CX380
CX600
S9300
S5300
S3300
Access MA5105(BSL)
MA5100V2
ESRV5R3
ESRV5R3
MD5500V1
UA5000
ESR8850(8850)V5R5
MA5100V1
Issue 05 (2010-11-19) Huawei Proprietary and Confidential C-3

C Product List Northbound XML Interface User Guide
MA5300V1
ISN8850V5R2
Radium8750
UA5000(PVMV1)
UA5000(PVU)
MA5600V3
MA5600T
UA5000(IPMB)
MA5605
MA5680T
MA5662
SRG3200
ATN910
MA5606T
MA5615
MA5626E
MA5620E
MA5651
MA5620G
MA5626G
MA5651G
MA5610
MA5616
C-4 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide D Object Naming Rules
D Object Naming Rules
This section describes the naming rules of objects of the U2000 XML interface according to the
naming rules recommended by MTOSI.
D.1 MD
D.2 OS
D.3 ME
D.4 TL
D.5 EH
D.6 EQ
D.7 PTP
D.8 FTP
D.9 CTP
D.10 RESOURCESITE
D.11 TUNNELPOLICY
D.12 TMD
D.13 CC
D.14 PG
D.15 SNC
D.16 EPG
D.17 EXPLICITPATH
D.18 FDFR
D.19 VRRP
D.20 TCPROFILE
Issue 05 (2010-11-19) Huawei Proprietary and Confidential D-1

D Object Naming Rules Northbound XML Interface User Guide
D.1 MD
Object Name MD
Parameter Naming Rules Recommended <name>

by MTOSI <nam:rdn>
<nam:type>MD</nam:type>
<nam:value>CompanyName /MDName
<am:value>
</nam:rdn>
</name>
Note: nam indicates the alias of the name
space defined by the object naming XSD of
MTOSI. Its meaning is the same as that of
nam used in the following section.
Sample Parameter Names of the U2000 <name>

XML Interface <nam:rdn>
<nam:value>Huawei/U2000</nam:value>
</nam:rdn>
</name>
Remarks If multiple iManager U2000s need to be

managed at the same time, change the
U2000 names by configuring the MD name
to ensure that each U2000 name is unique in
the NMS management domain. For details,
see 3.6 Configuring the XML NBI.
D.2 OS
Object Name OS

by MTOSI <nam:rdn>
<nam:type>OS</nam:type>
<nam:value> OSName <am:value>
</nam:rdn>
</name>
D-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Object Name OS

<nam:type>OS</nam:type>
<nam:value>Local NM</nam:value>
</nam:rdn>
</name>
Remarks If it is necessary to manage multiple

iManager U2000 at the same time, modify the
U2000 names through the configuration file
to ensure that each U2000 OS name is unique
in the NMS management domain.
D.3 ME
Object Name ME

by MTOSI <nam:rdn>
<nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>ME</nam:type>
<nam:value>MEName <nam:value>
</nam:rdn>
</name>

</nam:rdn>
<nam:rdn>
<nam:value>3145728</nam:value>
</nam:rdn>
</name>
Remarks

D.4 TL
Object Name TL

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
<nam:type>TL</nam:type>
<nam:value>TLName <am:value>
</nam:rdn>
</name>

</nam:rdn>
<nam:rdn>
<nam:type>TL</nam:type>
<nam:value>2009-05-05 23:54:32 - 3</
nam:value>
</nam:rdn>
</name>
Remarks

D.5 EH
Object Name EH

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
<nam:value>MEName <am:value>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type>
<nam:value>EHName <am:value>
</nam:rdn>
</name>

</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type> <nam:value>/
shelf=1/slot=1/sub_slot=0</nam:value>
</nam:rdn>
</name>
Remarks Currently, the U2000 XML interface

supports three types of EquipmentHolder
objects: shelf, slot, and subslot. Rack and
subshelf objects are not supported.

D.6 EQ
Object Name EQ

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type>
<nam:value>EHName <am:value>
</nam:rdn>
<nam:rdn>
<nam:type>EQ</nam:type>
<nam:value>EQName <am:value>
</nam:rdn>
</name>

Object Name EQ

</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type> <nam:value>/
shelf=1/slot=1/sub_slot=0</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>EQ</nam:type>
</nam:rdn>
</name>
Remarks For Huawei equipment, the value of

Equipment is always 1, that is, only one
board can be installed in a slot.

D.7 PTP
Object Name PTP

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP</nam:type>
<nam:value>PTPName <am:value>
</nam:rdn>
</name>

</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP</nam:type> <nam:value>/
shelf=1/slot=3/domain=wdm/port=1</
nam:value>
</nam:rdn>
</name>

Object Name PTP
Remarks For naming rules for the shelf, slot, and

subslot in a PTP name, refer to section
"EquipmentHolder".
The values of domain include sdh, wdm, eth,
atm, sonnet, and ptn. Only the transport
equipment has these attributes. The port
names of the equipment of other domains,
such as route and security, do not contain the
domain field. For the IP domain, there is a
cli_name field after the port field, for
example, /shelf=1/slot=13/type=eth/port=0/
cli_name=Ethernet0/0/0.
D.8 FTP
Object Name FTP

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FTP</nam:type>
<nam:value>FTPName <am:value>
</nam:rdn>
</name>

Object Name FTP

</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FTP</nam:type> <nam:value>/
shelf=1/slot=3/sub_slot=1/domain=ptn/
type=ima/port=1</nam:value>
</nam:rdn>
</name>
Remarks For naming rules for the shelf, slot, and

subslot in a FTP name, refer to section
"EquipmentHolder".
The values of domain include sdh, wdm, eth,
atm, sonnet, and ptn. Only the transport
equipment has these attributes. The port
names of the equipment of other domains,
such as route and security, do not contain the
domain field. For the IP domain, there is a
cli_name field after the port field, for
example, /shelf=1/type=vlanif/port=1001/
cli_name=Vlanif1001.

D.9 CTP
Object Name CTP

<nam:rdn>
by MTOSI <nam:type>MD</nam:type>
<nam:value>CompanyName /
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP/FTP</nam:type>
<nam:value>PTPName/FTPName
<am:value>
</nam:rdn>
<nam:rdn>
<nam:type>CTP</nam:type>
<nam:value>CTPName
<am:value>
</nam:rdn>
</name>
Sample Parameter Names of the U2000

<name>
<nam:value>Huawei/U2000</
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>/shelf=1/slot=2/
sub_slot=0/type=eth/port=1/
cli_name=GigabitEthernet2/0/1</
nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>/sub_port=234</
nam:value>
</nam:rdn>
</name>
Remarks

D.10 RESOURCESITE
Object Name RESOURCESITE

by MTOSI <nam:rdn>
<am:value>
</nam:rdn>
<nam:rdn>
<nam:type>RESOURCESITE</nam:type>
<nam:value>RESOURCESITEName
<am:value>
</nam:rdn>
</name>

</nam:rdn>
<nam:rdn>
<nam:type> RESOURCESITE</nam:type>
<nam:value> 4063235</nam:value>
</nam:rdn>
</name>
Remarks This object is added by Huawei, which

represents the transport WDM NE.

D.11 TUNNELPOLICY
Object Name TUNNELPOLICY
Parameter Naming Rules Recommended

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TUNNELPOLICY</
nam:type>
<nam:value>TUNNELPOLICYName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TUNNELPOLICY</
nam:type>
<nam:value>tnl_policy</
nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of tunnel

policies extended by Huawei.

D.12 TMD
Object Name TMD

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TMD</nam:type>
<nam:value>TMDName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TMD</nam:type>
<nam:value>20|</nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of

transmission descriptors.

D.13 CC
Object Name CC

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>CC</nam:type>
<nam:value>CCName <am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>CC</nam:type>
<nam:value>PWSW=|556|
12.12.12.156|456|455|557|12.12.12.157|
458|457|12</nam:value>
</nam:rdn>
</name>
Remarks Cross-connection (CC) indicates PW

switches in the routing domain, static tunnels
in the PTN domain, and cross-connections in
the transport domain.

D.14 PG
Object Name PG

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PG</nam:type>
<nam:value>PGName <am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PG</nam:type>
<nam:value>/shelf=1/pg=1/
pos=17</nam:value>
</nam:rdn>
</name>

protection groups in the transport domain.

D.15 SNC
Object Name SNC

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>SNC</nam:type>
<nam:value>SNCName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>SNC</nam:type>
<nam:value>TUNNEL=3||||100||||</
nam:value>
</nam:rdn>
</name>
Remarks

D.16 EPG
Object Name EPG

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EPG</nam:type>
<nam:value>EPGName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EPG</nam:type>
<nam:value>/pg=1/type=1</
nam:value>
</nam:rdn>
</name>

equipment protection groups in the transport
domain.

D.17 EXPLICITPATH
Object Name EXPLICITPATH

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EXPLICITPATH</
nam:type>
<nam:value>EXPLICITPATHName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EXPLICITPATH</
nam:type>
<nam:value>ex_path</nam:value>
</nam:rdn>
</name>
Remarks

D.18 FDFR
Object Name FDFR

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FDFR</nam:type>
<nam:value>FDFRName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FDFR</
nam:type>
<nam:value>VSI=555|vsinam</
nam:value>
</nam:rdn>
</name>
Remarks

D.19 VRRP
Object Name VRRP

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>PTPName
<am:value>
</nam:rdn>
<nam:rdn>
<nam:value>CTPName
<am:value>
</nam:rdn>
<nam:rdn>
<nam:type>VRRP</nam:type>
<nam:value>VRRPName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>/shelf=1/slot=1/
sub_slot=0/type=eth/port=0/
cli_name=GigabitEthernet1/0/0</
nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>/sub_port=2</
nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>VRRP</
nam:type>
</nam:rdn>
</name>
Remarks

D.20 TCPROFILE
Object Name TCPROFILE

<name>
by MTOSI <nam:rdn>
MDName <am:value>
</nam:rdn>
<nam:rdn>
<nam:type>TCPROFILE</
nam:type>
<nam:value>TCPROFILEName
<am:value>
</nam:rdn>
</name>

<name>
nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>TCPROFILE</
nam:type>
<nam:value>/type=cbqosprofile/
name=cbqosprofiletest</nam:value>
</nam:rdn>
</name>
Remarks

Northbound XML Interface User Guide E Layer Rate Description
E Layer Rate Description
Table E-1 List of layer rates supported by the U2000 XML NBI
No Layer Rate Description
1 LR_Not_Applicable The layer is not relevant.
5 LR_E1_2M 2Mbit/s PDH signal
7 LR_E3_34M 34 Mbit/s PDH signal
8 LR_E4_140M 140 Mbit/s PDH signal
11 LR_VT2_and_TU12_VC12 VC12 SONET/SDH path signal
13 LR_Low_Order_TU3_VC3 VC3 SONET/SDH path signal
15 LR_STS3c_and_AU4_VC4 VC4 SONET/SDH path signal
16 LR_STS12c_and_VC4_4c 12xSTS-1/4xVC4 contiguous

concatenation

concatenation

concatenation
19 LR_Section_OC1_STS1_and_ STM-0 regenerator section

RS_STM0
20 LR_Section_OC3_STS3_and_ STM-1 regenerator section

RS_STM1
21 LR_Section_OC12_STS12_an STM-4 regenerator section

d_RS_STM4

d_RS_STM16
23 LR_Section_OC192_STS192 STM-64 regenerator section

_and_RS_STM64
Issue 05 (2010-11-19) Huawei Proprietary and Confidential E-1

E Layer Rate Description Northbound XML Interface User Guide
25 LR_Line_OC3_STS3_and_M STM-1 multiplex section

S_STM1
26 LR_Line_OC12_STS12_and_ STM-4 multiplex section

MS_STM4

MS_STM16
28 LR_Line_OC192_STS192_an STM-64 multiplex section

d_MS_STM64
41 LR_Optical_Multiplex_Sec- For WDM wavelength bands

tion
42 LR_Optical_Transmission_Se For WDM entire optical signal. That is, it is

ction used for OTS and OMS layers of OTM-n.m
(n>=1).
43 LR_ATM_NI For ATM network interfaces (UNI and

NNI)
46 LR_PHYSICAL_ELECTRI- Analogue signal on electrical and physical

CAL media
47 LR_PHYSICAL_OPTICAL Analogue signal on optical physical media
49 LR_OPTICAL_SECTION Represents the wavelength termination for

a non DWDM system. That is, it is used for
all kinds of single-lambda ports.
50 LR_DIGITAL_SIGNAL_RA Raw binary electrical signal of unspecified

TE rate
72 LR_DSR_OC1_STM0 STM-0 digital signal rate
76 LR_DSR_OC48_and_STM16 STM-16 digital signal rate

4

56
80 LR_DSR_2M 2 Mbit/s digital signal rate
87 LR_DSR_Gigabit_Ethernet Gigabit Ethernet digital signal rate
E-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide E Layer Rate Description

d_RS_STM8

MS_STM8
90 LR_Section_OC768_STS768 STM-256 regenerator section

_and_RS_STM256
91 LR_Line_OC768_STS768_an STM-256 multiplex section

d_MS_STM256
96 LR_Ethernet All Ethernet rates
97 LR_DSR_Fast_Ethernet 10/100 Mbit/s Ethernet
98 LR_Encapsulation For Ethernet. The following encapsulation

protocols apply: HDLC/PPP, HDLC/
LAPS, ML/PPP, and GFPTransparent or
frame mapped types
99 LR_Fragment Used for inverse multiplexing modeling

(virtual concatenation for SONET/SDHand
IMA)
100 LR_STS6c_and_VC4_2c 6xSTS-1/2xVC4 contiguous concatenation
101 LR_STS9c_and_VC4_3c 9xSTS-1/3xVC4 contiguous concatenation

concatenation
113 LR_DSR_10Gigabit_Ethernet 10 Gbit/s Ethernet
8001 LR_Section_and_RS Extended by HUAWEI
8002 LR_Line_and_MS Extended by HUAWEI
8003 LR_ATM ATM layer rate (extended by HUAWEI)
8004 LR_Optical_Supervision_Cha Optical monitoring layer rate (extended by

nnel HUAWEI)
107 LR_OCH_Transport_Unit_1 Optical channel transport Unit 1

(trail termination)

(trail termination)

(trail termination)
8006 LR_OCH_Data_Unit_5G trail and tandem connection monitoring/

termination
Issue 05 (2010-11-19) Huawei Proprietary and Confidential E-3

E Layer Rate Description Northbound XML Interface User Guide
8007 LR_OCH_Transport_Unit_5G trail termination
8010 LR_Pseudo_Wire Extended by HUAWEI
303 LR_DVB_ASI Digital Video Broadcast (ASI)
8023 LR_DVB_SDI Digital Video Broadcast (SDI)
8024 LR_FICON_Express Extended by HUAWEI
8021 LR_SAN_FC_400 Extended by HUAWEI
8022 LR_SAN_FC_1000 Extended by HUAWEI
8025 LR_HDTV Extended by HUAWEI
201 LR_PON Extended by HUAWEI
202 LR_MPLS_Path MPLS path [extended by HUAWEI]
203 LR_MPLS_Channel MPLS channel [extended by HUAWEI]
204 LR_IP_Path IP tunnel [extended by HUAWEI]
205 LR_GRE_Path GRE tunnel [extended by HUAWEI]
206 LR_LAG_Fragment Link aggregation
E-4 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide F Glossary
F Glossary
Edge Termination Point An Edge Termination Point (Edge TP) is a

Termination Point (TP) that is at an entrance
or exit point of a MultiLayer Subnetwork (i.e.
add-drop or TPs that terminate links between
two Subnetworks) topological.
Element Management System The Element Management System (EMS) is

used to manage (represent) a portion of a
network which contains one or more
MultiLayer Subnetworks. The EMS is used
as the root of the naming tree in the NML-
EML interface.
Equipment An Equipment represents the manageable

physical components of a Network Element
such as the circuit packs, the fans and any
other type of replaceable unit within the
Network Element.
EquipmentHolder An Equipment Holder shall represent

resources of the Network Element that are
capable of holding other physical
components. Specific resources that are
represented by an Equipment Holder object
shall be for instance racks (bays), shelves, and
slots or sub-slots.
Location An area, position, or portion of space that

somebody or something can occupy. It is
further decomposed into a geographic place
that relates to world-centric places and local
location that relates to locally defined
coordinate systems.
Issue 05 (2010-11-19) Huawei Proprietary and Confidential F-1

F Glossary Northbound XML Interface User Guide
Managed Element A Managed Element (ME) represents the

EMS (management) view of a Network
Element (NE).
MultiLayer Subnetwork A MultiLayer Subnetwork represents the

topology provided by the EMS system. The
main services provided within a MultiLayer
are the set-up and tear-down of Subnetwork
Connection Subnetwork (SNC).
Network Element A Network Element (NE) is telecommunica-

tions hardware equipment that is addressable
and manageable. NEs provide support or
services to the user and can be managed
through an Element Management System
(EMS). An NE is a combination of hardware
and software that primarily performs a
telecommunications service function. A
group of interconnected network elements
form a network.
Party Represents an individual, organization or

organization unit. Party is an abstract concept
that should be used in places where the
business says something.
PartyRole The part played by a party in a given context

with any characteristics, such as expected
pattern of behavior, attributes, and/or
associations that it entails. PartyRole is an
abstract concept that should be used in places
where the business refers to a Party playing a
Role.
Physical Termination Point A Physical Termination Point (PTP)

represents the actual or potential endpoint of
a Topological Link. Essentially, this is a
representation of a physical port.
ProductBundle A type of Product that is comprised of other

Product(s). The other Product(s) may be
ProductBundle(s) or ProductComponent(s).
F-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

ProductSpecification A detailed description of a tangible or

intangible object made available externally in
the form of a ProductOffering to Customers
or other Parties playing a PartyRole. A
ProductSpecification may consist of other
ProductSpecifications supplied together as a
collection. Members of the collection may be
offered in their own right. ProductSpecifica-
tions may also exist within groupings, such as
ProductCategories, ProductLines, and
ProductTypes.
Route A Route represents the route of a Subnetwork

Connection (SNC).An SNC route is
represented as a partially ordered series
ofCross Connects through which the SNC
traverses.
Service All Services are characterized as either being

a realization of a Product (CustomerFacing-
Service) facing the Customer or how a
Service is provisioned within a provider's
infrastructure (ResourceFacingService)
facing the resources. Services are defined by
a ServiceSpecification. The purpose of the
specification is twofold. First, it is used to
define attributes, methods, and relationships
that are common to all Services. Second, it
provides a convenient point to define how
Services interact with other parts business
entities.
Service Access Point A point of entry where the service can be

accessed. This point of entry is always
associated (directly or indirectly) with a
physical resource (such as a PTP, a CTP).
However, sometimes the SAP is an object or
a logical resource that contains or identifies
the support of the physical resource.
(Customer Premise Equipment, a Mobile
Terminal, a Set-top Box, an internet address).
ServiceCatalog A grouping of Service Specifications that

share common characteristics. For example
one catalog could group all internet related
Service Specifications.

ServiceCharacteristicValue A ServiceCharacteristicValue is a value

passed over the Activation Interface to
convey an individually set service
characteristic (i.e. not reference in a
ServiceTemplate) or to override a globally set
characteristic value (present in a
ServiceTemplate). A ServiceCharacteristic-
Value will apply only to the specific Service
instance created.
ServiceDefinition A type of Service Specification (from the

SID) introduced for the purposes of Service
Fulfillment. It defines ALL the
ServiceSpecCharacteristics that must be used
to create corresponding Service instances:
l the ones which are set globally (the
corresponding values are defined only in
ServiceTemplates and are sometimes
designated as "invariant")
l and the ones which are set individually
(the corresponding values can be defined
only over the Activation Interface and are
sometimes designated as "variant").
A ServiceSpecCharacteristic specified in a
ServiceDefinition may be associated with
ServiceSpecCharacteristicValues to restrict
the typing information or to specify a default
value.
ServiceOrderr A Service Order is a type of request (as

defined in the SID model). In particular, a
service order is used to track and control the
progress of a request for some action (e.g.,
provision or activation) on the services that
comprise a given product instance. It should
be mentioned that the OSS/J Order
Management API (JSR 264) defines Service
Order as follows: "A type of Request that
represents a Customer Order's products
decomposed into the services through which
the products are realized. Service Orders are
generated within the confines of the SM&O
layer."
ServiceOrderItem Service Order Items are used to represent the

order aspects of the services associated with
a given service order. There is one service
order item for each service associated with a
service order.

ServiceRequest A request made by the CRM layer to the

SM&O layer as defined in the TMForum
eTOM to take an action on one or more CFS
instances given a product identifier, a product
specification name and a related set of
characteristics. This request can be realized
by Template and by Value.
ServiceSpecCharacteristic A characteristic quality or distinctive feature

of a Service as represented in a
ServiceSpecification (specialized as
ServiceDefinition or ServiceTemplate). In
particular it contains typing information
which can be arbitrarily complex. A Service
Spec Characteristic can be atomic or
composite (also called "packages"). The
components of a composite Service Spec
Characteristic can in turn be atomic or
composite.
ServiceSpecCharacteristicValue A value that can be associated with a

ServiceSpecCharacteristic in conformance
with the specified typing information.
l When associated with a
ServiceSpecCharacteristic in a
ServiceDefinition, it is used to restrict the
typing information (in this case several
ServiceSpecCharacteristicValues may be
used) or to specify additional information
(e.g. default value).
l When associated with a
ServiceSpecCharacteristic in a
ServiceTemplate, it will apply globally to
all the Service instances conformant to
this ServiceTemplate. In this case, the
ServiceSpecCharacteristicValue is set at
the design stage when the
ServiceTemplate is created, and it cannot
be modified afterwards.
A ServiceSpecCharacteristic present in a
ServiceTemplate is sometimes qualified as
being "invariant", since it cannot be modified
after the creation of the ServiceTemplate (the
term "globally set" can also be used"). A
ServiceSpecCharacteristic which value is
passed over the Activation Interface is
sometimes qualified as being "variant", since
the value must be given for each Service
instance created (the term "individually set"
can also be used).

ServiceSpecification Changeable as well as invariant attributes,

methods, relationships and constraints which
define a Service. It can be conceptually
thought of as a template that different Service
instances can be instantiated from. Each of
these Service instances will have the same
invariant characteristics. However, the other
characteristics of the instantiated Service will
be specific to each instance.
ServiceSpecificationType The ServiceSpecificationType class defines a

generic category of ServiceSpecifications.
Each ServiceSpecificationType serves to
group a set of particular ServiceSpecifica-
tions that share the same behavior and other
semantics. One result of this is to be able to
more efficiently define a set of related
Services that can be grouped together to form
a higher-level Service. For example, a given
higher-level Service might include VPN and
QoS Services. If these Services are always
used together, then they can be categorized
using a common type.

ServiceTemplate A type of Service Specification (from the

SID) introduced for the purposes of Service
Fulfillment. It defines specific
ServiceSpecCharacteristicsValues for the
globally set ServiceSpecCharacteristics that
can be dynamically referenced by multiple
Service instances during their lifecycle A
ServiceTemplate is checked against its
associatedspan. ServiceDefinition by
verifying the presence of the
ServiceSpecCharacteristics and the validity
of the corresponding assigned
ServiceSpecCharacteristicsValues. Each of
the associated Service instances will have the
same invariant characteristics which values
are taken from the ServiceTemplate.
However, when activating a Service, it may
be possible to specify over the Activation
Interface a ServiceCharacteristicsValue
which overrides the corresponding
ServiceSpecCharacteristicValue available in
the associated ServiceTemplate. In this case
the new proposed value applies only to the
Service instance created, and the
ServiceSpecCharacteristicValue in the
ServiceTemplate is not modified. In order not
to descend into sub-classing, the
ServiceTemplate is considered to be generic
such that it serves as a framework for defining
technology or service specific templates.
Other TMForum groups, or service providers,
may use the service template as a foundation
for building or populating servicetemplates.

Subnetwork Connection A Subnetwork Connection (SNC) represents

the relationship between two of the following
types on end points:
l Physical Termination Point (PTP)
l Connection Termination Point (CTP)
l Group Termination Point (GTP)
l Floating Termination Point (FTP)
An SNC represents a transparent end-to-end
connection or a trail (closed or half-open)
through or within a MultiLayer Subnetwork
according to the roles associated to its end
points. If the SNC represents a connection, its
end points are CTPs or FTPs with the SNC's
layer rate as connectable layer rate. In the case
of GTPs (i.e. a Bundled connection) the SNC
does not have an explicit layer rate. If the SNC
represents a trail, its end points are CTPs,
FTPs or PTPs. An SNC shall be contained in
a MultiLayer Subnetwork.
Subscriber A Subscriber is an entity (associated with one

or more users) that is engaged in a service
subscription with a service provider. The
subscriber is allowed to subscribe and
unsubscribe services, to register a user or a
list of users authorized to use these services,
and also to set the limits relative to the use
that associated users make of these services.
Termination Point A Termination Point (TP) represents a logical

abstraction of anendpoint (actual or potential)
of either:
1. A Topological Link or
2. a Subnetwork Connection (SNC) or
3. a Flow Domain Fragment (FDFr) or
4. a Cross Connection (CC).
Topological Link A Topological Link (TL) is a physical link

between two Physical Termination Point
(PTP)s or a trail between two Termination
Point (TP)s (e.g., an ATM link between two
ATM NI CTPs), which are called aEnd TP
and zEnd TP of the TL.

TMD A Transmission Descriptor (TMD) represents

Transmission Descriptor a collection of attributes, which are used to
define multi-layered transmissionparame-
ters, and additional information parameters
on a Termination Point (TP).

Northbound XML Interface User Guide G Acronyms and Abbreviations
G Acronyms and Abbreviations
ABR Asynchronous Batch Response
AFB Asynchronous File Bulk
AID Alarm Identifier
ARR Asynchronous Request/Reply
ASN.1 Abstract Syntax Notation One
AVC AttributeValueChange
CDE Common Desktop Environment
CPU Central Processing Unit
EdgeTP EdgeTerminationPoint
EH EquipmenHolder
EQT Equipment
EMS Element Management System
FIFO First In First Out
FTP File Transfer Protocol
Issue 05 (2010-11-19) Huawei Proprietary and Confidential G-1

G Acronyms and Abbreviations Northbound XML Interface User Guide
GE Gigabit Ethernet
GNE Gate Network Element
GUI GraphicalUserInterface
HA High-Availability
HTTP Hyper-Text Transmission Protocol
HTTPS Hypertext Transfer Protocol Secure
ID Identity
IMAP Integrated Management Application

Platform
IP Internet Protocol
ITU-T International Telecommunication Union-

Telecommunication Standardization Sector
JMS Java Message Service
LAN Local Area Network
MAC Media Access Control
MD ManagementDomain
MDP Message Dispatch Process
ME ManagedElement
MEP Message Exchage Pattern
MLSN MultiLayerSubNetwork
MO Managed Object
G-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface User Guide G Acronyms and Abbreviations
MTOSI Multi-Technology Operations System

Interface
MTNM Multi-Technology Network Management
NE NetworkElement
NEL Network Element Level
NML Network Management Level
NMS Network Management System
OS OperationsSystem
ONE OpticalNetworkElement
OTN Optical Transport Network
OSGI Open Services Gateway Initiative
OSS Operation Support System
OSN Optical Switch Net
OSI Open Systems Interconnection
PC Personal Computer
PDH Plesiochronous Digital Hierarchy
PTP PhysicalTerminationPoint
SAP Service Access Point
SC StateChange
SDH Synchronous Digital Hierarchy
SFB Synchronous (File) Bulk
SIT Synchronous Iterator Pattern
SNC SubNetworkConnection
Issue 05 (2010-11-19) Huawei Proprietary and Confidential G-3

G Acronyms and Abbreviations Northbound XML Interface User Guide
SOAP Simple Object Access Protocol
SONET Synchronous Optical Network
SRR Synchronous Request Response
SSL Security Socket Layer
SSM Synchronization Status Message
SFTP SSH FTP
SML Service Management Layer
SOA Service-Oriented Architecture
TCP Transport Control Protocol
TL TopologicalLink
TMD TransmissionDescriptor
TMF Telecommunication Management Forum
TMN Telecommunication Management Network
TP TerminationPoint
TCA Threshold Crossed Alert
UPC Usage Parameter Control
UTC Coordinated Universal Time
WAN Wide Area Network
WSDL Web Service Definition Language
WSN Web Services Notification
XML eXtensible Markup Language
G-4 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Imanager U2000 V200R016C50 XML NBI User Guide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Imanager U2000 V200R016C50 XML NBI User Guide PDF

Uploaded by

Copyright:

Available Formats

iManager U2000 Unified Network Management

Northbound XML Interface User

HUAWEI TECHNOLOGIES CO., LTD.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19) Huawei Proprietary and Confidential i

About This Document

Product Name Version

iManager U2000 V100R002C01

Indicates a hazard with a high level of risk, which if not

Indicates a hazard with a medium or low level of risk, which

Issue 05 (2010-11-19) Huawei Proprietary and Confidential iii

Indicates a potentially hazardous situation, which if not

NOTE Provides additional information to emphasize or supplement

Boldface The keywords of a command line are in boldface.

Italic Command arguments are in italics.

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

{ x | y | ... } Optional items are grouped in braces and separated by

[ x | y | ... ] Optional items are grouped in brackets and separated by

{ x | y | ... }* Optional items are grouped in braces and separated by

[ x | y | ... ]* Optional items are grouped in brackets and separated by

Boldface Buttons, menus, parameters, tabs, window, and dialog titles

> Multi-level menus are in boldface and separated by the ">"

iv Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Changes in Issue 05 (2010-11-19) Based on Product Version V100R002C01

Changes in Issue 04 (2010-09-24) Based on Product Version V100R002C01

Changes in Issue 03 (2010-08-16) Based on Product Version V100R002C01

Changes in Issue 02 (2010-07-16) Based on Product Version V100R002C01

Changes in Issue 01 (2010-05-18) Based on Product Version V100R002C01

Issue 05 (2010-11-19) Huawei Proprietary and Confidential v

About This Document...................................................................................................................iii

3 Deploying and Configuring the XML NBI...........................................................................3-1

4 Maintaining the XML NBI.......................................................................................................4-1

Issue 05 (2010-11-19) Huawei Proprietary and Confidential vii

4.7 Deleting the XML Interface Instance............................................................................................................4-10

A Relations Between License and XML Interface.................................................................A-1

E Layer Rate Description.............................................................................................................E-1

viii Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Issue 05 (2010-11-19) Huawei Proprietary and Confidential ix

Table 1-1 Functions supported by the XML NBI (configuration)....................................................................... 1-4

Issue 05 (2010-11-19) Huawei Proprietary and Confidential xi

About This Chapter

This chapter describes the technology features of XML NBI.

Issue 05 (2010-11-19) Huawei Proprietary and Confidential 1-1

1.2 Standards and Protocols Compliance

The MTOSI is compliant with the TMF standards as follows:

1.3 Position of the XML NBI in the Integrated NMS

1-2 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Northbound XML Interface

U2000 U2000 Other EMS

1.4 Supported Domains and Functions

1.4.1 Alarm Function of the XML NBI

1.4.1 Alarm Function of the XML NBI

l Query of the alarm.

Issue 05 (2010-11-19) Huawei Proprietary and Confidential 1-3

l Query of the performance threshold-crossing event.

1.4.2 Functions of the XML NBI (Configuration)

Per-NE-based VPN Creating, deleting, modifying, activating, and Routing

Per-NE-based tunnel Creating, deleting, modifying, activating, and Routing

QoS template Creating, deleting, modifying, applying, and Routing

Attribute Configuring the attributes of physical ports (POS, Routing,

1-4 Huawei Proprietary and Confidential Issue 05 (2010-11-19)

Function Description Domain