100800613 iManager U2000 Northbound XML Interface User Guide V100R002C01 05

iManager U2000 Unified Network ManagementSystemV100R002C01

Northbound XML Interface UserGuide

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 writtenconsent 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. NoticeThe purchased products, services and features are stipulated by the contract made between Huawei and thecustomer. All or part of the products, services and features described in this document may not be within thepurchase 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 representationsof any kind, either express or implied.

The information in this document is subject to change without notice. Every effort has been made in thepreparation of this document to ensure accuracy of the contents, but all statements, information, andrecommendations in this document do not constitute the warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.Address: Huawei Industrial Base

Bantian, LonggangShenzhen 518129People's Republic of China

Website: http://www.huawei.com

Email: [email protected]

Issue 05 (2010-11-19) Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

i

http://www.huawei.com

mailto:[email protected]

About This Document

Related VersionsThe following table lists the product versions related to this document.

Product Name Version

iManager U2000 V100R002C01

Intended AudienceThe iManager U2000 Northbound XML Interface User Guide describes the basic concept andprinciples of U2000 northbound XML interface. And it is also describes how to deploying andmaintaining the XML NBI. This document also provides the relationship between the XML NBIand license, service port description, supported equipments, the object naming rule, layer ratedescription, 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 Engineerl Data Configuration Engineerl Application Developer

Symbol ConventionsThe symbols that may be found in this document are defined as follows.

Symbol Description

DANGERIndicates a hazard with a high level of risk, which if notavoided, will result in death or serious injury.

WARNINGIndicates a hazard with a medium or low level of risk, whichif not avoided, could result in minor or moderate injury.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide About This Document


iii

Symbol Description

CAUTIONIndicates a potentially hazardous situation, which if notavoided, could result in equipment damage, data loss,performance degradation, or unexpected results.

TIP Indicates a tip that may help you solve a problem or savetime.

NOTE Provides additional information to emphasize or supplementimportant points of the main text.

Command ConventionsThe 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 byvertical bars. One item is selected.

[ x | y | ... ] Optional items are grouped in brackets and separated byvertical bars. One item is selected or no item is selected.

{ x | y | ... }* Optional items are grouped in braces and separated byvertical bars. A minimum of one item or a maximum of allitems can be selected.

[ x | y | ... ]* Optional items are grouped in brackets and separated byvertical bars. Several items or no item can be selected.

GUI ConventionsThe GUI conventions that may be found in this document are defined as follows.

Convention Description

Boldface Buttons, menus, parameters, tabs, window, and dialog titlesare in boldface. For example, click OK.

> Multi-level menus are in boldface and separated by the ">"signs. For example, choose File > Create > Folder.

About This DocumentiManager U2000 Unified Network Management System

Northbound XML Interface User Guide

iv Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

Change HistoryUpdates between document issues are cumulative. Therefore, the latest document issue containsall updates made in previous issues.

Changes in Issue 05 (2010-11-19) Based on Product Version V100R002C01Errors are corrected.




Changes in Issue 01 (2010-05-18) Based on Product Version V100R002C01Initial release.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide About This Document


v

Contents

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

1 System Overview.......................................................................................................................1-11.1 Introduction.....................................................................................................................................................1-21.2 Standards and Protocols Compliance..............................................................................................................1-21.3 Position of the XML NBI in the Integrated NMS...........................................................................................1-21.4 Supported Domains and Functions.................................................................................................................1-3

1.4.1 Alarm Function of the XML NBI..........................................................................................................1-31.4.2 Functions of the XML NBI (Configuration)..........................................................................................1-41.4.3 Performance Function of the XML NBI................................................................................................1-61.4.4 Functions of the XML NBI (Resource)..................................................................................................1-6

1.5 System Structure...........................................................................................................................................1-101.6 Technical Specifications...............................................................................................................................1-11

2 Principles.....................................................................................................................................2-12.1 Description of Involved Technology...............................................................................................................2-22.2 Working Principles of an XML NBI...............................................................................................................2-32.3 Sample Flow....................................................................................................................................................2-8

3 Deploying and Configuring the XML NBI...........................................................................3-13.1 Overview.........................................................................................................................................................3-23.2 Configuration Requirements...........................................................................................................................3-33.3 Logging in to the Client of the NMS Maintenance Suite................................................................................3-33.4 Checking the XML NBI Status.......................................................................................................................3-53.5 Deploying the XML NBI for the First Time...................................................................................................3-6

3.5.1 Adding XML NBI Component..............................................................................................................3-63.5.2 Adding the XML NBI Instance..............................................................................................................3-7

3.6 Configuring the XML NBI............................................................................................................................3-13

4 Maintaining the XML NBI.......................................................................................................4-14.1 Requirements for Maintenance Staff...............................................................................................................4-34.2 Routine Maintenance.......................................................................................................................................4-34.3 Logging In to the System Monitor Client.......................................................................................................4-44.4 Stopping the XML NBI...................................................................................................................................4-54.5 Disabling the XML NBI..................................................................................................................................4-74.6 Restarting the XML NBI.................................................................................................................................4-8

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide Contents


vii

4.7 Deleting the XML Interface Instance............................................................................................................4-104.8 Deleting the XML NBI Component..............................................................................................................4-114.9 FAQ...............................................................................................................................................................4-12

4.9.1 Failure in Starting the U2000 XML Interface......................................................................................4-124.9.2 Whether the U2000 Successfully Enables the XML Interface.............................................................4-124.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-1B.1 Service Ports Used by the XML Interface.....................................................................................................B-2B.2 Notes and Precautions....................................................................................................................................B-3

C Product List................................................................................................................................C-1

D Object Naming Rules..............................................................................................................D-1D.1 MD.................................................................................................................................................................D-2D.2 OS..................................................................................................................................................................D-2D.3 ME.................................................................................................................................................................D-3D.4 TL..................................................................................................................................................................D-4D.5 EH..................................................................................................................................................................D-5D.6 EQ..................................................................................................................................................................D-6D.7 PTP................................................................................................................................................................D-8D.8 FTP................................................................................................................................................................D-9D.9 CTP..............................................................................................................................................................D-11D.10 RESOURCESITE......................................................................................................................................D-12D.11 TUNNELPOLICY.....................................................................................................................................D-13D.12 TMD..........................................................................................................................................................D-14D.13 CC..............................................................................................................................................................D-15D.14 PG..............................................................................................................................................................D-16D.15 SNC...........................................................................................................................................................D-17D.16 EPG............................................................................................................................................................D-18D.17 EXPLICITPATH.......................................................................................................................................D-19D.18 FDFR.........................................................................................................................................................D-20D.19 VRRP.........................................................................................................................................................D-21D.20 TCPROFILE..............................................................................................................................................D-22

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

F Glossary.......................................................................................................................................F-1

G Acronyms and Abbreviations...............................................................................................G-1

ContentsiManager U2000 Unified Network Management System


viii Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

Figures

Figure 1-1 Position of the XML interface of the U2000 in the integrated NMS................................................. 1-3Figure 1-2 Software structure.............................................................................................................................1-11Figure 2-1 SOAP message................................................................................................................................... 2-4Figure 2-2 Principles of HTTP request response................................................................................................. 2-5Figure 2-3 JMS.....................................................................................................................................................2-6Figure 2-4 Interconnection process of the XML NBI..........................................................................................2-7Figure A-1 Main dimensions...............................................................................................................................A-1

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide Figures


ix

Tables

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

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide Tables


xi

1 System Overview

About This Chapter

This chapter describes the technology features of XML NBI.

1.1 IntroductionBy bringing together modern software technologies and state-of-the-art technology models, theTM Forum has enabled the birth of a new interface standard, the Multi-Technology OperationsSystems 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 multiplevendors with a minimum of "integration tax."

1.2 Standards and Protocols ComplianceThe upper-level integrated NMS and OSS can communicate with the iManager U2000 that iscompliant with the MTOSI standards by using the MTOSI. In this way, the upper-level integratedNMS and OSS can manage Huawei transport equipment, routers equipment, security equipmentand metro ethernet equipment) in a centralized manner.

1.3 Position of the XML NBI in the Integrated NMSThis section describes the position of XML NBI in the integrated NMS.

1.4 Supported Domains and FunctionsThe 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 StructureThis topic describes the system structure of the U2000 XML NBI.

1.6 Technical SpecificationsThis topic describes the performance indicators of the U2000 XML NBIs to provide a referencefor the interconnection with the OSS.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide 1 System Overview


1-1

1.1 IntroductionBy bringing together modern software technologies and state-of-the-art technology models, theTM Forum has enabled the birth of a new interface standard, the Multi-Technology OperationsSystems 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 multiplevendors with a minimum of "integration tax."

With reference to the MTOSI recommendations, the XML interface of the U2000 is developedfor iManager U2000. Network management systems of different levels can communicate withone another by using the MTOSI. The application of the MTOSI can meet the trends of theintegration of network management systems and the development of cross-domain networkmanagement systems.

1.2 Standards and Protocols ComplianceThe upper-level integrated NMS and OSS can communicate with the iManager U2000 that iscompliant with the MTOSI standards by using the MTOSI. In this way, the upper-level integratedNMS and OSS can manage Huawei transport equipment, routers equipment, security equipmentand metro ethernet equipment) in a centralized manner.

The MTOSI is compliant with the TMF standards as follows:

l TMF518l TMF612l TMF864

The MTOSI can realize the standard interface functions as follows:

l Query and notification of the physical inventoryl Alarm reportingl Alarm queryl Acknowledgement and unacknowledgement of alarms

1.3 Position of the XML NBI in the Integrated NMSThis 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 System OverviewiManager U2000 Unified Network Management System


1-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

Figure 1-1 Position of the XML interface of the U2000 in the integrated NMS

SecurityEquipment

Transport NetworkSDH/WDM/OTN/MW

IP NetworkRouter/Switch/PTN/BRAS

OSS

U2000

Northbound XML Interface

U2000

Transport NetworkSDH/WDM/OTN/MW

Other EMS

otherEquipments

1.4 Supported Domains and FunctionsThe 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 NBIThe 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.



1-3

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 VPNservice provisioning

Creating, deleting, modifying, activating, anddeactivating a per-NE-based service, a PWE3 service(AES, CES, or EES service), or an L3VPN service, andreporting notifications accordinglyAdding, deleting, activating, and deactivating a per-NE-based VPLS service site, and reportingnotifications accordinglyAdding, deleting, activating, and deactivating a per-NE-based L3VPN service site, and reportingnotifications accordinglyCreating, deleting, activating, and deactivating a per-NE-based PW switch, and reporting notificationsaccordinglyConfiguring the QoS feature for the PWE3, VPLS, andL3VPN services in the routing domain, the multicastfeature for VPLS and L3VPN services, and the BRASfeature for L3VPN services

Routingand PTNdomains

Per-NE-based tunnelmanagement

Creating, deleting, modifying, activating, anddeactivating a per-NE-based tunnel (RSVP-TE, static,or IP tunnel), and reporting notifications accordingly


QoS templatemanagement

Creating, deleting, modifying, applying, andunapplying a QoS template, and reporting the creationand deletion notifications of a QoS templateaccordinglyApplying and unapplying a QoS template to and froma port


Attributeconfiguration ofphysical ports

Configuring the attributes of physical ports (POS,ATM, Ethernet, or PDH ports) in the IP domain andreporting notifications accordinglyConfiguring the attributes of physical ports in thetransport domain and reporting notificationsaccordingly

Routing,PTN,switch, andtransportdomains




Issue 05 (2010-11-19)


Management oflogical ports

Creating, deleting, and modifying a logical port(Ethernet trunk, IP trunk, MP group, IMA, logical serialport, MFR group, VLAN IF, or tunnel IF) and reportingnotifications accordinglyConfiguring a member port for a logical port of theaggregation type, including adding, modifying, anddeleting a member port and reporting notificationsaccordinglyConfiguring an Ethernet trunk port of the aggregationtype in the switch domain, including creating anddeleting an Ethernet trunk logical port, and configuringmember ports for the Ethernet trunk logical port

Routing,PTN, andswitchdomains

Subinterfacemanagement

Creating and deleting a subinterface, configuring theattributes of a subinterface, and reporting notificationsaccordingly

Routingdomain

VLAN managementof ports

Configuring the working mode of a portConfiguring the default VLAN, allowed VLANs, andVLAN removal attributesConfiguring the VLAN stacking, VLAN mapping, andVLAN multicast feature for a port

Routingand switchdomains

Global VLANmanagement

Creating, deleting, and modifying a VLAN in theaccess domain, and configuring the multicast featurefor the VLANCreating, deleting, and modifying a global VLAN inthe switch domain, and configuring the multicastfeature for the global VLANCreating, deleting, and modifying a global VLAN inthe routing domain

Access,switch, androutingdomains

NE attributeconfiguration

Configuring the basic attributes of an NE, deleting anNE, and reporting notifications accordingly

Alldomains

GPON serviceprovisioning

Provisioning GPON services, and creating, deleting,modifying, activating, and deactivating the GPONservices

Accessdomain

ONT management Creating and deleting an ONT, and configuring theattributes of the ONT and ONT ports

Accessdomain

Transmissiondescriptormanagement

Creating and deleting a transmission descriptor, andreporting notifications accordingly


Tunnel policymanagement

Creating, deleting, and modifying a tunnel policy, andreporting notifications accordingly

Routingdomain



1-5


VRRP management Creating, modifying, and deleting a VR interface and aVR monitoring interface, configuring the globalattributes of the VR interface, and reportingnotifications accordingly

Routingdomain

ANCP management Configuring the global ANCP attributes, creating anddeleting a global ANCP template, applying an ANCPneighbor template to ports, and setting ANCP lineparameters

Routingdomain

1.4.3 Performance Function of the XML NBIThe 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 themanagementdomains and OS

Querying the management domains of the U2000 andOS information

-

Resource site query Querying information about all optical NEs in thetransport domainQuerying the names of all optical NEs in the transportdomainQuerying the details of a single optical NE by opticalNE nameQuerying information about resources (such as cardand slot information) of an optical NE by optical NEnameReporting the creation and deletion notifications of anoptical NEReporting the status change notifications of resourcesof an optical NE

Transportdomain




Issue 05 (2010-11-19)


NE informationquery

Querying the names of all NEs in the managementdomainQuerying the details of all NEs in the managementdomainQuerying the details of a single NE by NE nameQuerying information about NEs in the routing andswitch domains by IP addressReporting the creation, deletion, and attribute changenotifications of an NE

Alldomains

Fiber/Cable query Querying information about fibers in the transportdomainQuerying information about IP links and Layer 2 linksin the routing domainQuerying fibers, IP links, and Layer 2 links, andreporting the creation and deletion notificationsaccordingly

Transportand routingdomains

Query forinformation aboutthe resources of anNE

Querying information about shelves, slots, cards, andsubslots of an NE by NE nameQuerying information about cards, subslots, and othersof an equipment holder by equipment holder nameReporting addition and deletion notifications of a shelf,slot, or card

Alldomains

Query for physicalport information

Querying the names of all physical ports (includingPOS, ATM, Ethernet, and PDH ports) on an NE by NEnameQuerying the details of all physical ports on an NE byNE nameQuerying the details of a single physical port byphysical port nameReporting the change notifications of importantattributes of a physical port

Alldomains

Query for logical portinformation

Querying the names of all logical ports (includingEthernet trunk, IP trunk, MP group, IMA, logical serialport, MFR group, and VLAN IF) on an NE by NE nameQuerying the details of all logical ports on an NE byNE nameQuerying the details of a single logical port by logicalport nameReporting the creation, deletion, and attribute changenotifications of a logical portReporting the notifications of adding and deleting amember port to and from a logical port of theaggregation type

Transport,routing,PTN, andswitchdomains



1-7


Subinterface query Querying the names of all subinterfaces of a physicalport or logical port by physical port name or logical portnameQuerying the details of all subinterfaces of a physicalport or logical port by physical port name or logical portnameQuerying the details of a single subinterface bysubinterface nameReporting the creation, deletion, and attribute changenotifications of a subinterface

Transportand routingdomains

VPN service query Querying the names of all VPN services (includingPWE3, VPLS, and L3VPN services) on an NE by NEnameQuerying the details of all VPN services (includingPWE3, VPLS, and L3VPN services) on an NE by NEnameQuerying the details of a single VPN service (PWE3,VPLS, or L3VPN service) by VPN service nameReporting the creation, deletion, status change, andattribute change notifications of a VPN service


QoS template query Querying the names of all global QoS templates in themanagement domainQuerying the details of all global QoS templates in themanagement domainQuerying the details of a single QoS template by QoStemplate nameQuerying resources where a QoS template is applied byQoS template nameReporting the creation and deletion notifications of aQoS template


Tunnel query Querying the names of all dynamic tunnels, statictunnels, and IP tunnels of an NE by NE nameQuerying the details of all dynamic tunnels, statictunnels, and IP tunnels of an NE by NE nameQuerying the details of a single tunnel by tunnel nameReporting the creation, deletion, status change, andattribute change notifications of a tunnel


Tunnel policy query Querying the names of all tunnel policies of an NEQuerying the details of all tunnel policies of an NEReporting the creation and deletion notifications of atunnel policy

Routingdomain




Issue 05 (2010-11-19)


Transmissiondescriptor query

Querying the names of all transmission descriptors ofan NEQuerying the details of all transmission descriptors ofan NEReporting the creation and deletion notifications of atransmission descriptor


Query for trails andcross-connections

Querying the names of network-wide SDH, WDM,OTN, and RTN trailsQuerying the details of network-wide SDH, WDM,OTN, and RTN trailsQuerying the details of a single SDH, WDM, OTN, orRTN trail by trail nameQuerying all cross-connections of an NEQuerying the routes of a trail by trail nameQuerying the routes and optical fibers of a trail by trailnameReporting the creation, deletion, status change, andattribute change notifications of a trailReporting the creation and deletion notifications of across-connectionReporting the notification of route attribute changes ofa trail

Transportdomain

Protection groupquery

Querying all SDH, WDM, and equipment protectiongroups of an NEQuerying the details of a single SDH, WDM, orequipment protection group by protection group nameQuerying the protection switching data of a singleSDH, WDM, or equipment protection group byprotection group name

Transportdomain

GPON service query Querying the names of all PON services on an NE byNE nameQuerying the details of all PON services on an NE byNE nameQuerying the details of a single PON service by PONservice nameQuerying the routes of a PON service by PON servicename

Accessdomain

ONT query Querying information about ONTs associated with anOLT or a PON port by OLT name or PON port name,and querying ONT information by ONT name

Accessdomain



1-9


Query for servicevirtual ports andprofiles

Querying service virtual ports of an NE by NE nameQuerying ADSL line profiles, G.SHDSL line profiles,and MEF IP traffic profiles of an NE by NE name

Accessdomain

ANCP informationquery

Querying all ANCP neighbor templates on an NE byNE nameQuerying all ANCP line information of an NE by NEnameQuerying ports where an ANCP neighbor template isapplied by ANCP neighbor template name

Routingdomain

VRRP informationquery

Querying the names of all VR interfaces of an NE byNE nameQuerying the details of all VR interfaces of an NE byNE nameQuerying information about the VR monitoringinterface of a VR interface by VR interface nameQuerying the global attributes of a VR interface by VRinterface name

Routingdomain

Query for physicalinventories by usinga coarse granularityinterface

Querying the management domain, OS, cables, andNEs by using the getInventory interfaceQuerying the shelves, slots, cards, physical ports of theentire network or a single NE by using the getInventoryinterfaceQuerying the names, attributes, or details of inventoryobjects by specifying filter criteriaThe getInventory interface supports multiple MEPmodes such as SRR, SIT, and AFB.

Alldomains

1.5 System StructureThis topic describes the system structure of the U2000 XML NBI.

1.5 System Structure shows the software structure of the U2000 XML NBI.




Issue 05 (2010-11-19)

Figure 1-2 Software structure

Inventory ProvisioningPerformance

(get/set/create/delete/edit/active/deactive operations)

OSSApplications

Alarm Inventory Update(Notify events)

Qx/SNMP

ASN.1

JMSSOAP/HTTP/HTTPS/FTP/

SFTP

TCP/ODBC/JDBCDatabase

Managed Networks

U2000

GUI Client

Table 1-3 XML component

Component Function

U2000 Indicates the U2000 server. It is used for managing network andproviding NBIs.

GUI client Indicates the U2000 client. It provides a GUI for performingoperations on network. The client communicates with theU2000 server through the Asn.1 protocol.

OSS applications Indicates the upper layer OSS. It performs operations on networkthrough the XML NBI provided by the U2000.

Database Indicates the U2000 database. It is used for saving and providingU2000 data.

1.6 Technical SpecificationsThis topic describes the performance indicators of the U2000 XML NBIs to provide a referencefor the interconnection with the OSS.



1-11

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 receivedconcurrently

10

Delay of response to XML request Shorter than 3s when the CPU usage islower than 50%

Alarm notification processing capability More than 60 records per second when 3NMSs are connected

Alarm notification transmission delay Shorter than 10s when 3 NMSs areconnected

CAUTIONThe alarm handling capability of the CORBA NBI depends on many factors, such as alarmquantity on the live network, and CPU performance and memory size of the server. If an alarmstorm occurs, the CORBA NBI will possibly reach its handling limit. The CORBA NBI canreport 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 arerecommended to handle network faults instantly if an alarm storm occurs. Also, the OSS issuggested to synchronize alarms actively at proper times, for example, when the system is idle.




Issue 05 (2010-11-19)

2 Principles

About This Chapter

2.1 Description of Involved TechnologyThis section describes the related technology and concept involved in this document.

2.2 Working Principles of an XML NBIThe U2000 XML NBI adopts the Web Service technology. Web Service is a technology foraccessing network services. It defines services through WSDL or XSD and implements thecommunication through the SOAP message. In addition, it supports various transmissionprotocols, such as HTTP, HTTPS, and JMS. The following describes the principles of the XMLNBI based on the key scenarios supported by the U2000 XML NBI and the preceding features.

2.3 Sample FlowThe following section describes how to query all the current alarms on the NMS.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide 2 Principles


2-1

2.1 Description of Involved TechnologyThis section describes the related technology and concept involved in this document.

MTOSIMulti-Technology Operations System Interface (MTOSI) is a standard for implementinginterfaces between OSSs. Service providers (carriers) use multiple Operational Support Systems(OSS) to manage complex networks. Since the various parts of the network must interact withthe OSSs. It is standardized by the Tele-management Forum (TM Forum). The TMF NGOSSprovides a set of reference models that aid in analyzing and designing next generation BSS andOSS solutions that may utilize the MTOSI interface specifications.

JMSThe Java Message Service (JMS) API is a Java Message Oriented Middleware (MOM) API forsending messages between two or more clients. JMS is a specification developed under the JavaCommunity 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 aconsumer reads messages from the queue. Here, the producer knows the destination of themessage and posts the message directly to the consumer's queue. It is characterized by thefollowing 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. Zeroor 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 metaphorfor 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 remaincontinuously active to receive messages, unless it has established a durable subscription.In that case, messages published while the subscriber is not connected are redistributedwhenever it reconnect.

l Using Java, JMS provides a way of separating the application from the transport layer ofproviding data. The same Java classes are used to communicate with different JMSproviders by using the JNDI information for the desired provider. The classes first use aconnection factory to connect to the queue or topic, and then use populate and send orpublish the messages. On the receiving side, the clients then receive or subscribe to themessages.

Web ServiceThe W3C defines a Web Service as a software system designed to support interoperable Machineto Machine interaction over a network. Web Service is frequently just Web APIs that are accessed

2 PrinciplesiManager U2000 Unified Network Management System



Issue 05 (2010-11-19)

over a network, such as the Internet, and executed on a remote system hosting the requestedservices. The W3C Web Service definition encompasses many different systems, but in commonusage the term refers to clients and servers that communicate using XML messages that followthe SOAP standard. Common in both the field and the terminology is the assumption that thereis also a machine readable description of the operations supported by the server, a descriptionin the Web Service Description Language (WSDL). The latter is not a requirement of a SOAPendpoint, but it is a prerequisite for automated client-side code generation in the mainstreamJava and .NET SOAP Frameworks. Some industry organizations, such as the WS-I, mandateboth SOAP and WSDL in their definition of a Web Service.

HTTP(S)Hypertext Transfer Protocol (HTTP) is a communications protocol used to transfer or conveyinformation on the World Wide Web. HTTP is a request/response protocol between clients andservers. The client making an HTTP request, such as a web browser, spider, or other end-usertool - is referred to as the user agent. The responding server, which stores or creates resourcessuch as HTML files and images, is called the origin server.

WSDLThe Web Service Description Language (WSDL) is a XML-based language that provides amodel for describing Web Service. The WSDL defines services as collections of networkendpoints, or ports. WSDL specification provides an XML format for documents for thispurpose. The abstract definition of ports and messages is separated from their concrete use orinstance, allowing the reuse of these definitions. A port is defined by associating a networkaddress with a reusable binding, and a collection of ports define a service. Messages are abstractdescriptions of the data being exchanged, and port types are abstract collections of supportedoperations. The concrete protocol and data format specifications for a particular port typeconstitutes a reusable binding, where the messages and operations are then bound to a concretenetwork protocol and message format. In this way, WSDL describes the public interface to theWeb Service.

SOAPSimple Object Access Protocol (SOAP) is a protocol for exchanging XML-based messages overcomputer networks, normally using HTTP/HTTPS. SOAP forms the foundation layer of theWeb Service stack, providing a basic messaging framework upon which abstract layers can bebuilt.

XMLThe eXtensible Markup Language (XML) is a general-purpose markup language. It is classifiedas an extensible language, because it allows its users to define their own tags. Its primary purposeis to facilitate the sharing of structured data across different information systems, particularlythrough internet. It is used both to encode documents and serialize data.

2.2 Working Principles of an XML NBIThe U2000 XML NBI adopts the Web Service technology. Web Service is a technology foraccessing network services. It defines services through WSDL or XSD and implements thecommunication through the SOAP message. In addition, it supports various transmissionprotocols, such as HTTP, HTTPS, and JMS. The following describes the principles of the XMLNBI based on the key scenarios supported by the U2000 XML NBI and the preceding features.



2-3

Defining Services Through WSDL or XSDl 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 Messagel 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 Interfacel 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.




Issue 05 (2010-11-19)

l Figure 2-2 Principles of HTTP request response

Adopting the JMS as the Notification Busl 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. Afteran OSS subscribes to a type of notifications, if the OSS goes offline due to a fault, theOSS can receive the notifications sent during the offline period when the OSS goesonline.

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 meetthe filter criteria are sent to you.



2-5

Figure 2-3 JMS




Issue 05 (2010-11-19)

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



2-7

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 FlowThe following section describes how to query all the current alarms on the NMS.

ContextNOTEWhen integrating with the XML NBI, you can compile the WSDL file to an API interface file, whichsimplifies the operation of code integration.

Procedure

1 Find the interface definition corresponding to the current alarms in the AlarmRetrievalHttp.wsdlfile, 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, asshown 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>




Issue 05 (2010-11-19)

<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:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element>

3 Find the definition of the response message in the AlarmRetrievalMessages.xsd file, as shownbelow.<xsd:element name="getActiveAlarmsResponse" type="alm:AlarmListType"> <xsd:annotation> <xsd:documentation> Response message structure of the getActiveAlarms operation </xsd:documentation> </xsd:annotation> </xsd:element>

4 Construct the following XML message according to the data type definition of the request andsend 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 tothe 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



2-9

3 Deploying and Configuring the XML NBI

About This Chapter

This chapter describes how to deploy and configure the U2000 XML NBI. It includes thefollowing information:

3.1 OverviewThis topic describes the background information and the terms involved in the process ofdeploying and configuring the northbound interface.

3.2 Configuration RequirementsU2000 XML NBI and the U2000 server run on the same PC or Sun workstation, any additionalconfiguration is not required. But to enable the XML NBI, you must purchase the license forthe corresponding functions.

3.3 Logging in to the Client of the NMS Maintenance SuiteAfter you log in to the client of the NMS Maintenance Suite, you can maintain the U2000 byusing the NMS Maintenance Suite, including deploying the U2000 and configuring the instanceof the northbound interface.

3.4 Checking the XML NBI StatusAfter check the license and ensure it is support XML functions, you need to check the currentstatus of XML NBI, and deploy the XML NBI according the status.

3.5 Deploying the XML NBI for the First TimeBy default, the XML NBI is not installed during the installation of U2000 server. To enable theXML NBI, you need to add the XML NBI the XML NBI component first, then add the XMLNBI instance.

3.6 Configuring the XML NBIIn order to enable the XML NBI, even though you have installed XML NBI component, youneed configure the XML parameters accord to NMS planning. Also, you can modify theparameters by configuring XML NBI again. Generally, general parameters are mandatory andadvanced items are optional but the default values are recommended. Every advanced item isindependent and you need not set the parameters.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide 3 Deploying and Configuring the XML NBI


3-1

3.1 OverviewThis topic describes the background information and the terms involved in the process ofdeploying and configuring the northbound interface.

Attention Iteml 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.

CAUTIONl 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-relatedprocess.

l After initializing the database of the U2000, you need to configure the northbound interfaceinstance again.

l After the northbound interface instance is configured, you need to restart all the NMSservices.

TermsThe following explains certain confusable terms:

l Component: It is the software function unit that can be selected for installation. Acomponent 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 SuiteThrough the GUI of the NMS maintenance tool, you can conveniently deploy the northboundinterface.

3 Deploying and Configuring the XML NBIiManager U2000 Unified Network Management System



Issue 05 (2010-11-19)

The NMS Maintenance Suite is a graphical system maintenance tool that is developed for theiManager U2000. The NMS Maintenance Suite is used to deploy the instances and distributedsystem of the U2000.

Refer to the NMS Maintenance Suite part of the iManager U2000 Administrator Guide for thedetails about the NMS Maintenance Suite.

3.2 Configuration RequirementsU2000 XML NBI and the U2000 server run on the same PC or Sun workstation, any additionalconfiguration is not required. But to enable the XML NBI, you must purchase the license forthe corresponding functions.

NOTE

For different operation system, the configuration requirements of U2000 is different, refer to thecorresponding Software Installation Guide for more information.

Hardware Configuration

In practice, the U2000 XML interface and the U2000 server run on the same PC or SUNworkstation. The hardware should be well configured enough to ensure the proper installationand running of the U2000 server. Any additional hardware configuration is not required theU2000 XML interface.

For details of hardware requirements of U2000 Server, refer to section "ConfigurationRequirements" in the iManager U2000 Software Installation Guide.

Software Configuration

Since the XML interface is integrated into the U2000 installation software, no additionalsoftware configuration is required for the installation of the U2000 XML interface.

For details of software requirements U2000 Server, refer to section "ConfigurationRequirements" 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 thelicense support XML interface function before deploying the XML NBI.

For details, see A Relations Between License and XML Interface. If the license does notsupport 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 Applyingfor and Updating the License in the iManager U2000 Administrator Guide.

3.3 Logging in to the Client of the NMS Maintenance SuiteAfter you log in to the client of the NMS Maintenance Suite, you can maintain the U2000 byusing the NMS Maintenance Suite, including deploying the U2000 and configuring the instanceof the northbound interface.



3-3

Prerequisitel 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 othernormally.

Context

In normal cases, the NMS Maintenance Suite server starts along with the OS. You can do asfollows to check whether the NMS Maintenance Suite server is started:

l In the Windows OS, check whether the msdaemon.exe and msserver.exe processes arestarted 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 DOSwindow 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 checkwhether 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 MaintenanceSuite server is started. Otherwise, run the following commands to start the NMSMaintenance Suite server:# cd /opt/HWENGR/engineering# ./startserver.sh

Procedure

1 On a computer installed with the NMS Maintenance Suite client, double-click the U2000MSuite shortcut icon on the desktop and then wait about one minute. The Login dialog box isdisplayed.

NOTE

l In the Solaris OS, you must log in to the Java desktop system as the root user. Otherwise, the U2000MSuite 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 shortcuticon. You need to run the following commands as the root user to start the NMS Maintenance Suiteclient:# 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 MaintenanceSuite server resides. In a distributed system, you need to enter the system IP address of themaster server.

l Port No.: The default port number is 12212. You do not need to change the default valueduring login.

l User Name: The default user name is admin.

l Password: The initial password is admin.

3 Click OK.




Issue 05 (2010-11-19)

NOTE

l When you log in to the client of the NMS Maintenance Suite, a progress bar showing the progress of queryingcomponents 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 clientcan log in to the NMS Maintenance Suite server at one time. In a high availability system, only one site canbe logged in at one time.

----End

Result

If a dialog box is displayed during the login, indicating that network configuration informationis inconsistent and re-synchronization is required after login, read through the message to learnthe 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 isdisplayed for you to confirm the operation.

NOTEBefore synchronizing network configuration, you need to stop NMS services. For details, see the U2000Administrator Guide.

3. Click OK.

3.4 Checking the XML NBI StatusAfter check the license and ensure it is support XML functions, you need to check the currentstatus 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 integratedin 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 theinterface, you need to add the component first and then add the instance. For details, see3.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 theinterface, you need to configure the instance. For details, see 3.6 Configuring the XMLNBI.

The details for how to install the U2000 Server, refer to iManager U2000 Software InstallationGuide. If you want to install XML NBI, ensure you have select Northbound XML Interfacecomponent 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 Clientof the NMS Maintenance Suite.

2 Click Instance tab, check whether the AgentXML exist in the instance list.



3-5

l If the AgentXML instance exist, refer the steps in 3.6 Configuring the XML NBI enablethe XML NBI.

l If the AgentXML instance not exist, you need to check whether the XML NBIdeployment package exist according the Step 3.

3 Click Deployment Package tabs, check whether the XML NBI exist in the deployment packagelist.

l If the XML NBI deployment package exist, refer the steps in 3.5.2 Adding the XML NBIInstance enable the XML NBI.

l If the XML NBI deployment package not exist, refer the steps in 3.5 Deploying the XMLNBI for the First Time enable the XML NBI.

----End

3.5 Deploying the XML NBI for the First TimeBy default, the XML NBI is not installed during the installation of U2000 server. To enable theXML NBI, you need to add the XML NBI the XML NBI component first, then add the XMLNBI instance.

3.5.1 Adding XML NBI ComponentThe XML NBI is one component of the U2000. If you have not installed the XML NBI bydefault, you need to add the XML NBI component.

3.5.2 Adding the XML NBI InstanceThe type of XML NBI deployment package is system single-instance, you can deploy oneinstance only. After adding the XML NBI component, you need to adding XML NBI instanceto enable the XML interface. You need set the general parameters, and it is recommended youset the advanced parameters to default value.

3.5.1 Adding XML NBI ComponentThe XML NBI is one component of the U2000. If you have not installed the XML NBI bydefault, you need to add the XML NBI component.

Prerequisitel 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 serverin the normal state.

Contextl 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 serverof the primary site to perform this operation.




Issue 05 (2010-11-19)

Procedure


2 On the NMS Maintenance Suite client, choose Deploy > Add Component. The AddComponent dialog box is displayed.

CAUTIONl 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 isdisplayed.

4 Wait until the dialog box is displayed to prompt the message The component is successfullyadded.

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 enablethe XML interface.

3.5.2 Adding the XML NBI InstanceThe type of XML NBI deployment package is system single-instance, you can deploy oneinstance only. After adding the XML NBI component, you need to adding XML NBI instanceto enable the XML interface. You need set the general parameters, and it is recommended youset the advanced parameters to default value.

Prerequisitel 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 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.


master server to perform this operation.



3-7

l In a high availability system, you only need to log in to the NMS maintenance tool serverof the primary site to perform this operation.

Procedure


2 On the NMS Maintenance Suitel client, click the Deployment Package tab. Right-click thenorthbound XML interface deployment package and choose Add Instance. The dialog box isdisplayed.

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 thedefault 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 JMScommunication.

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 PCor 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 JMSserver.

The IP address of U2000 server.




Issue 05 (2010-11-19)


JMS Server Port Indicate the port ID used for theJMS server.l Port 61616 is used for non-SSL

JMS server.l Port 61617 is used for SSL JMS

server.

61616

JMS User Name The user name to access the JMSserver.

admin

JMS Password The password to access the JMSserver.

test1234

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 onHTTP only by default.

Table 3-2 provides the parameters for Web Service.



WebSerivice IP Displays the IP address of theWeb server.

The IP of U2000 server

HTTP Port Set the port. 9997

Register JMS Service Sets whether to use JMS. Enable

Base on HTTP/Base onHTTPS

Choose the protocol to beused.

HTTP

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



3-9

7 Choose the item in the left object tree, set the parameters in the right windows. Refer Table3-3 for details.

Table 3-3 Parameters for the Advanced Items

Parameter Value Description

iView Log Switch Open, CloseDefault Value: Open

Enables or disables iViewinternal logs for the XMLFramework.

iView Log Level All, Trace, Warning, ErrorDefault Value: Warning

Sets the iView Debug Level.Namely, the system willrecord the selected leveliView log in the log files.

Max Debug Folder Size 100-1024 MBDefault Value: 100MB

When the debug folderreaches the maximum size,the five oldest debug file willbe deleted.

Framework Log Switch Open, CloseDefault Value: Open

Enables or disables the logsof the XML Framework.

Product Log Switch Debug, Info, Warn, Error,FatalDefault Value: Info

Specifies the level of theproduct log. Namely, thesystem will record theselected level product log inthe log files.

Framework Log Level Debug, Warn, ErrorDefault Value: Warn

Specifies the Level of TraceInformation to be placed inLog File. Namely, the systemwill record the selected levellog in the log files.




Issue 05 (2010-11-19)


Log Queue Size 10 to 2147483647Default Value: 10000

Indicates the queue size forasynchronous logs.

Product Log Max BackupIndex

1 to 100Default Value: 40

Specifies the maximumnumber of the product logfiles. When the parametervalue reaches a specifiedvalue, the system willgenerate new file to displacethe older log file.

Product Log Max File Size 1 to 100 MDefault Value: 5 M

The size of the product logfile. When the size of the fileis greater than the maximumsize, the system will generatethe new log file.

Encoding Format UTF-8, GBKDefault Value: UTF-8

Specifies the encodingformat of the files.

Configure Domain Name Default Value: Huawei/U2000

Indicates the name of amanaged 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 addressof 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.



3-11

CAUTIONl 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 andWeb Server IP fields.

l Ensure that the input IP address is correct. That is, the standby server should be able tocommunicate 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 computerautomatically. Additionally, the first IP address in the configuration list is bound to theJMS Server IP. In the case of a single IP address, you need not set the JMS ServerIP. In the case of multiple IP addresses, you need to set the JMS Server IP because thebound IP address is unknown. When setting the JMS Server IP field, you need to setit to an IP address that the upper-layer NMS can have access to. The same as the WebServer 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 theprocesses are running, the XML NBI is enabled successfully.

----End




Issue 05 (2010-11-19)

3.6 Configuring the XML NBIIn order to enable the XML NBI, even though you have installed XML NBI component, youneed configure the XML parameters accord to NMS planning. Also, you can modify theparameters by configuring XML NBI again. Generally, general parameters are mandatory andadvanced items are optional but the default values are recommended. Every advanced item isindependent and you need not set the parameters.

Prerequisitel 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.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.l The XML NBI instance must be added. Otherwise, add the related XML NBI instance

first.


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 NBI > Configure the XML interfaceinstance from the Main Menu. The dialog box is displayed.

3 In the General tab, set the parameters for basic items.



3-13

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 JMScommunication.

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 PCor workstation.

Table 3-4 provides the parameters for JMS Server.



IP Indicates the IP address of the JMSserver.

The IP address of U2000 server.

JMS Server Port Indicate the port ID used for theJMS server.l Port 61616 is used for non-SSL

JMS server.l Port 61617 is used for SSL JMS

server.

61616

JMS User Name The user name to access the JMSserver.

admin

JMS Password The password to access the JMSserver.

test1234




Issue 05 (2010-11-19)

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 onHTTP only by default.

Table 3-5 provides the parameters for Web Service.



WebSerivice IP Displays the IP address of theWeb server.

The IP of U2000 server

HTTP Port Set the port. 9997

Register JMS Service Sets whether to use JMS. Enable

Base on HTTP/Base onHTTPS

Choose the protocol to beused.

HTTP

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 Table3-6 for details.



3-15

Table 3-6 Parameters for the Advanced Items


iView Log Switch Open, CloseDefault Value: Open

Enables or disables iViewinternal logs for the XMLFramework.

iView Log Level All, Trace, Warning, ErrorDefault Value: Warning

Sets the iView Debug Level.Namely, the system willrecord the selected leveliView log in the log files.

Max Debug Folder Size 100-1024 MBDefault Value: 100MB

When the debug folderreaches the maximum size,the five oldest debug file willbe deleted.

Framework Log Switch Open, CloseDefault Value: Open

Enables or disables the logsof the XML Framework.

Product Log Switch Debug, Info, Warn, Error,FatalDefault Value: Info

Specifies the level of theproduct log. Namely, thesystem will record theselected level product log inthe log files.

Framework Log Level Debug, Warn, ErrorDefault Value: Warn

Specifies the Level of TraceInformation to be placed inLog File. Namely, the systemwill record the selected levellog in the log files.

Log Queue Size 10 to 2147483647Default Value: 10000

Indicates the queue size forasynchronous logs.

Product Log Max BackupIndex

1 to 100Default Value: 40

Specifies the maximumnumber of the product logfiles. When the parametervalue reaches a specifiedvalue, the system willgenerate new file to displacethe older log file.

Product Log Max File Size 1 to 100 MDefault Value: 5 M

The size of the product logfile. When the size of the fileis greater than the maximumsize, the system will generatethe new log file.

Encoding Format UTF-8, GBKDefault Value: UTF-8

Specifies the encodingformat of the files.

Configure Domain Name Default Value: Huawei/U2000

Indicates the name of amanaged domain.




Issue 05 (2010-11-19)

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 addressof 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.

CAUTIONl 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 theJMS Server IP. In the case of a single IP address, you need not set the JMS ServerIP. In the case of multiple IP addresses, you need to set the JMS Server IP because thebound IP address is unknown. When setting the JMS Server IP field, you need to setit to an IP address that the upper-layer NMS can have access to. The same as the WebServer 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 theprocesses are running, the XML NBI is enabled successfully.



3-17

----End




Issue 05 (2010-11-19)

4 Maintaining the XML NBI

About This Chapter

This chapter provides instructional suggestions for the maintenance conditions and routineoperations for the XML interface. This chapter also describes the basic operation for maintainingthe XML interface. In addition, this chapter describes how to solve the problems that may occurduring maintenance, which can help maintenance personnel to solve the problems quickly.

4.1 Requirements for Maintenance StaffThis section describes the requirements for maintenance staff.

4.2 Routine MaintenanceBy Routine Maintenance, faults such as malfunction in the system operation can be detected intime and countermeasures are adopted to properly handle the problem. In this way, hiddentroubles are cleared to prevent the occurrence of an accident. It is recommended that you performroutine maintenance once a week.

4.3 Logging In to the System Monitor ClientThe U2000 System Monitor Client uses the client/server model. To perform an operation, youneed to log in to the server through the U2000 client.

4.4 Stopping the XML NBIIf you need not use the XML NBI, you can stop the XML process by using the System Monitorclient.

4.5 Disabling the XML NBIIf you need not use the XML NBI, you can disable the related XML processes so that theprocesses are not started together with the nmsuser.

4.6 Restarting the XML NBIThis topic describes how to restart the XML NBI.

4.7 Deleting the XML Interface InstanceYou can delete an instance for the XML interface if it is not in use, which enhances the runningefficiency of the U2000.

4.8 Deleting the XML NBI ComponentYou can delete the component for the XML NBI if it is not in use, which enhances the runningefficiency of the U2000.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide 4 Maintaining the XML NBI


4-1

4.9 FAQThis section describes the identifying and handling methods for common failures in the system.

4 Maintaining the XML NBIiManager U2000 Unified Network Management System



Issue 05 (2010-11-19)

4.1 Requirements for Maintenance StaffThis section describes the requirements for maintenance staff.

To guarantee the smooth maintenance and rapid problem solving, the maintenance staff arerequired to have the following experiences:

l Be familiar with the basic operations of the PC, Sun workstation, Windows, Solaris andLinux 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 MaintenanceBy Routine Maintenance, faults such as malfunction in the system operation can be detected intime and countermeasures are adopted to properly handle the problem. In this way, hiddentroubles are cleared to prevent the occurrence of an accident. It is recommended that you performroutine maintenance once a week.

Checking the XML Servicel 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 processhave their respective IDs

NOTE

The active server refers to the host computer in use. Normally, a high availability system uses only oneactive server.

If the JMS service is started, you need to check whether the JMS service process is started. The methodof checking the JMS service process is the same as that of the XML service.

Backing up the logs of the U2000 XML InterfaceThe 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 diskspace. The log files records the running information of the U2000 XML interface and theoperation performed by the NMS/OSS through the U2000 XML interface. If an error occurswhen 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 loginformation to a specified directory.



4-3

NOTE

In the case of the Solaris OS and Linux OS, the environment variable is represented by $Variable (Variableindicates the name of the variable).

In the case of the Windows OS, the environment variable is represented by %Variable% (Variableindicates 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/serverdirectory 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 bydefault, Hence, %IMAP% corresponds to C:\U2000\server\conf and %IMAPROOT% correspondsto C:\U2000.

4.3 Logging In to the System Monitor ClientThe U2000 System Monitor Client uses the client/server model. To perform an operation, youneed to log in to the server through the U2000 client.

PrerequisiteBefore login, ensure that the U2000 client and server are connected normally, and the serverworks correctly.

Contextl 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, thedata is encrypted when being transmitted between the client and the server. In commonmode, 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 is31030 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 disablesor 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), andthen select a login mode. Click OK.

4. In the Server List dialog box, click OK.




Issue 05 (2010-11-19)

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 theloading 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 beforethe 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 NBIIf you need not use the XML NBI, you can stop the XML process by using the System Monitorclient.

Prerequisitel 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.

ContextNOTE

After you add an instance of the XML interface by using the NMS Maintain Tool, the startup mode isAutomatic 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.



4-5

3 Select the XML Service process, right-click, and then choose Stop the Process from the shortcutmenu.

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, theoperation is successful.

----End




Issue 05 (2010-11-19)

4.5 Disabling the XML NBIIf you need not use the XML NBI, you can disable the related XML processes so that theprocesses are not started together with the nmsuser.

Prerequisitel 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.

Procedure



3 Select the XML Service process, right-click, and then choose Startup Mode > Disabled fromthe shortcut menu.

4 Select the JMS Service process, right-click, and then choose Startup Mode > Disabled fromthe shortcut menu.

5 In the System Monitor client, when Startup Mode of the relevant XML processes isDisabled, the operation is successful.



4-7

----End

4.6 Restarting the XML NBIThis topic describes how to restart the XML NBI.

Prerequisitel 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 Stopped state.

Procedure






Issue 05 (2010-11-19)

3 In the System Monitor client, select the JMS Service process, right-click, and then choose Startthe Process from the shortcut menu.

4 In the System Monitor client, select the XML Service process, right-click, and then chooseStart the Process from the shortcut menu.

5 In the System Monitor client, when Status of the relevant XML processes, namely JMSService and XML Service are Running, the operation is successful.

----End



4-9

4.7 Deleting the XML Interface InstanceYou can delete an instance for the XML interface if it is not in use, which enhances the runningefficiency of the U2000.

Prerequisitel Log in to the Solaris or SUSE Linux OS as user root.l Log in to the Windows OS as user Administrator.l In a HA system, configure the XML interface on the active server.l The NMS Maintenance Suite server installed on the master and slave servers must be

started.l The U2000 must be operating.l The NMS Maintenance Suite client communicates with the NMS Maintenance Suite server

in the normal state.l It is recommended that you stop the XML interface before delete the instance.




Procedure


2 On the NMS Maintenance Suite client, click the Instance tab. Select the AgentXML instancefrom the instance list, right-click, and choose Delete Instance

3 Click OK. After the confirmation, the NMS Maintenance Suite begins deleting the AgentXMLinstance.

4 Click the Deployment Package tab, if the Instance Count of the XML NBI deployment packageis zero, that means the deletion success.




Issue 05 (2010-11-19)

NOTE

After the AgentXML instance is deleted, the Sysmonitor does not display the information about the XMLService process, JMS Service process. If you need to re-enable the XML interface, refer to 3 Deployingand Configuring the XML NBI.

----End

4.8 Deleting the XML NBI ComponentYou can delete the component for the XML NBI if it is not in use, which enhances the runningefficiency of the U2000.

Prerequisitel Log in to the Solaris or SUSE Linux OS as user root.l Log in to the Windows OS as user Administrator.l In a HA system, configure the XML interface on the active server.l The NMS Maintenance Suite server installed on the master and slave servers must be

started.l The U2000 must be operating.l The NMS Maintenance Suite client communicates with the NMS Maintenance Suite server

in the normal state.l Ensure you have deleted the XML NBI instance.




Procedure


2 On the NMS Maintenance Suite client, click Deployment Package tab, check whether theinstance 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 isstarted.

NOTE

You can not delete the components which are basic or have not installed. You can not select them in theleft window.

4 Wait until the message the component is successfully removed is displayed. Click OK.



4-11

5 View the Deployment Package list, the Northbound XML Interface deployment package notexist indicate that the operation is successful.

----End

4.9 FAQThis 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 fromHuawei, 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 ofthe configuration file.

It is recommended that you perform the following steps:

Procedure

1 Open the %IMAPROOT%\server\nbi\xml\conf\communicate.cfg configuration file. Checkwhether the configuration items (such as IP address, port, mode, and license file path) of MDPare correct. If the configuration items are incorrect, configure the XML interface instance againby following 3 Deploying and Configuring the XML NBI.

2 Open the %IMAPROOT%\server\nbi\xml\conf\database.cfg configuration file. Checkwhether the configuration items (such as database type, IP address, and port) of the database arecorrect. If the configuration items are incorrect, configure the XML interface instance again byfollowing 3 Deploying and Configuring the XML NBI.

----End

4.9.2 Whether the U2000 Successfully Enables the XML Interfacel 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 addressof the Web service that the system should support in the browser and check whether theoutput is correct.

– In the browser, enter http://server IP:port/OperationsSystemRetrieval?wsdl. If theWSDL definition is displayed in the browser, it indicates that the XML interface isstarted successfully.




Issue 05 (2010-11-19)

– If the error message "cannot find the server" is displayed, it indicates that the XMLinterface is not started.

4.9.3 Whether the U2000 XML Interface is Licensedl 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 precedingXML 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 usersthat are connected to theXML interface. In details, thenumber of users that canconcurrently send requests tothe XML interface every 60s.

0 to 80000

LNSDXMLNOT01 Indicates whether the alarmreporting and notificationreporting functions areauthorized.

0: unauthorized1: authorized

LNSDXMLA01 Indicates whether thefunction of querying thealarms related to transportNEs is authorized.


LNSDXMLA02 Indicates whether thefunction of querying theinventory related to transportNEs is authorized.


LNSDPENEX01 Indicates the number ofequivalent transport NEs forwhich you can query alarms.The user can querynetworkwide alarms onlywhen the number ofequivalent transport NEs issmaller than or equal to theauthorized value of thislicense item.

0 to 80000



4-13

License Item Function Value

LNSDPENEX02 Indicates the number ofequivalent transport NEs forwhich you can queryinventory.The user can querynetworkwide NEs only whenthe number of equivalenttransport NEs is smaller thanor equal to the authorizedvalue of this license item.

0 to 80000

LNSDXMLA03 Indicates whether thefunction of querying thealarms related to router andsecurity NEs is authorized.


LNSDXMLA04 Indicates whether thefunction of querying theinventory data related torouter and security NEs isauthorized.


LNSDPENEX05 Indicates the number ofequivalent router andsecurity NEs for which youcan query alarms.The user can querynetworkwide alarms onlywhen the number ofequivalent router andsecurity NEs is smaller thanor equal to the authorizedvalue of this license item.

0 to 80000

LNSDPENEX06 Indicates the number ofequivalent router andsecurity NEs for which youcan query inventory.The user can querynetworkwide NEs only whenthe number of equivalentrouter and security NEs issmaller than or equal to theauthorized value of thislicense item.

0 to 80000




Issue 05 (2010-11-19)

A Relations Between License and XMLInterface

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 functionl Technical domainl Management capacityl Number of OSS connectionsl 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

technical domain

Management Capacity

Interface Function

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide A Relations Between License and XML Interface


A-1

Table A-1 Dimension description

Dimension Meaning

Interface function l Alarm and inventoryl Service provisioning and test diagnosisl Performancel Common

Technical domain l Transportl Router and Metro including securityl Access

Management capacity Physical inventory: Controls NEs. The unit isnumber of equivalent NEs.

Number of OSS connections Indicates the maximum number of OSS usersthat can be online concurrently.

On Solaris or SUSE Linux, view the license as user root. Use the text viewer to view the contentsof the $IMAPROOT/server/etc/conf/license/ONXXXXXXX.dat file.

On Windows, view the license as user administrator. Use the text viewer to view the contentsof 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 oflicense control items.

Table A-2 Description for License Item

License Control Item Abbreviations Value

NBI-XML ConnectionAmount License

LNSDPENES04 0~20000

Per Equivalent NE Licensefor NBI-XML Alarm&Inventroy-TransmissionNetwork

LNSDPENEX01 0~300000

Per Equivalent NE Licensefor NBI-XML Performance-Transmission Network


Per Equivalent NE Licensefor NBI-XML ServiceProvisioning andTest&Diagnosis-Transmission Network


A Relations Between License and XML InterfaceiManager U2000 Unified Network Management System


A-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

License Control Item Abbreviations Value

Per Equivalent NE Licensefor NBI-XML Alarm&Inventroy-IP


Per Equivalent NE Licensefor NBI-XML Performance-IP


Per Equivalent NE Licensefor NBI-XML ServiceProvisioning andTest&Diagnosis-IP


Per Narrowband Port Licensefor NBI-XML Alarm-AccessNetwork

LNSDPENEC08 0~300000

Per Broadband Port Licensefor NBI-XML Alarm-AccessNetwork


Per Narrowband ResourceLicense for NBI-XMLService Provisioning-Access


Per Broadband ResourceLicense for NBI-XMLService Provisioning-Access


Per Narrowband ResourceLicense for NBI-XMLPerformance-Access


Per Broadband ResourceLicense for NBI-XMLPerformance-Access


Compatible License forXML Inventory NBI--Access

LNSDNELCR80 0~300000

Per PON Terminal ResourceLicense for NBI-XMLService Provisioning-AccessNetwork


Per PON Terminal ResourceLicense for NBI-XMLAlarm-Access Network


iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide A Relations Between License and XML Interface


A-3

B Service Port Description

This chapter provides information on service ports that are used by the XML interface and howto use and query these service ports.

B.1 Service Ports Used by the XML Interface

B.2 Notes and Precautions

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide B Service Port Description


B-1

B.1 Service Ports Used by the XML InterfaceService Name Service Port/

ProtocolDirection (inrelation to theserver)

Function Remarks

HTTP service 9997/TCP IN Listens to theaccess of upper-layer NMS

If there arerouters orfirewalls on thenetworkbetween theU2000 serverand the upper-layer NMS,check whetherthe service portis filtered.

HTTPS service 443/TCP IN Listens to theaccess of upper-layer NMS

If there arerouters orfirewalls on thenetworkbetween theU2000 server rand the upper-layer NMS,check whetherthe service portis filtered.

JMS service 61616/TCP IN Listens to theaccess of upper-layer NMS


B Service Port DescriptioniManager U2000 Unified Network Management System


B-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

Service Name Service Port/Protocol

Direction (inrelation to theserver)

Function Remarks

JMS service(SSL)

61617/TCP IN Listens to theSSL-modeaccess of upper-layer NMS


B.2 Notes and PrecautionsIn the practical communication process, the source (the server) and the sink (the client) userelevant ports. Usually you only need to specify the source port, and the sink port is dynamicallycreated.

Note the following during the project implementation:

l The service ports used by the NMS should not be closed. Run the following command toview the system service ports:

netstat -an

If there are routers or firewalls between the source and the sink, check all ports used by thesource and the sink. Make sure that these ports can be normally turned up to support thecommunication between the sources and sinks.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide B Service Port Description


B-3

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

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide C Product List


C-1


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 Product ListiManager U2000 Unified Network Management System


C-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)


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, andR4000,S2000, S2000B, S2000C, S2000EA, S3000,S3500, and S3500EA,S3900, S5000, S5100EI, S5500, S5600,S6500, S7800, S8000, and S8500SR8800

Switch CX200D

CX200

CX300

CX380

CX600

S9300

S5300

S3300

Access MA5105(BSL)

MA5100V2

ESRV5R3

ESRV5R3

MD5500V1

UA5000

ESR8850(8850)V5R5

MA5100V1

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide C Product List


C-3


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 Product ListiManager U2000 Unified Network Management System


C-4 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

D Object Naming Rules

This section describes the naming rules of objects of the U2000 XML interface according to thenaming 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

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide D Object Naming Rules


D-1

D.1 MDObject Name MD

Parameter Naming Rules Recommendedby MTOSI

<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn></name>Note: nam indicates the alias of the namespace defined by the object naming XSD ofMTOSI. Its meaning is the same as that ofnam used in the following section.

Sample Parameter Names of the U2000XML Interface

<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn></name>

Remarks If multiple iManager U2000s need to bemanaged at the same time, change theU2000 names by configuring the MD nameto ensure that each U2000 name is unique inthe NMS management domain. For details,see 3.6 Configuring the XML NBI.

D.2 OSObject Name OS


<name><nam:rdn><nam:type>OS</nam:type><nam:value> OSName <am:value></nam:rdn></name>

D Object Naming RulesiManager U2000 Unified Network Management System


D-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

Object Name OS


<name><nam:rdn><nam:type>OS</nam:type><nam:value>Local NM</nam:value></nam:rdn></name>

Remarks If it is necessary to manage multipleiManager U2000 at the same time, modify theU2000 names through the configuration fileto ensure that each U2000 OS name is uniquein the NMS management domain.

D.3 MEObject Name ME


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>MEName <nam:value></nam:rdn></name>


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>3145728</nam:value></nam:rdn></name>

Remarks



D-3

D.4 TLObject Name TL


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>TL</nam:type><nam:value>TLName <am:value></nam:rdn></name>


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

Remarks




Issue 05 (2010-11-19)

D.5 EHObject Name EH


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>MEName <am:value></nam:rdn><nam:rdn><nam:type>EH</nam:type><nam:value>EHName <am:value></nam:rdn></name>


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>3145740</nam:value></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 interfacesupports three types of EquipmentHolderobjects: shelf, slot, and subslot. Rack andsubshelf objects are not supported.



D-5

D.6 EQObject Name EQ


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>MEName <am:value></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>




Issue 05 (2010-11-19)

Object Name EQ


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>3145740</nam:value></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:value>1</nam:value></nam:rdn></name>

Remarks For Huawei equipment, the value ofEquipment is always 1, that is, only oneboard can be installed in a slot.



D-7

D.7 PTPObject Name PTP


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>MEName <am:value></nam:rdn><nam:rdn><nam:type>PTP</nam:type><nam:value>PTPName <am:value></nam:rdn></name>


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>3145728</nam:value></nam:rdn><nam:rdn><nam:type>PTP</nam:type> <nam:value>/shelf=1/slot=3/domain=wdm/port=1</nam:value></nam:rdn></name>




Issue 05 (2010-11-19)

Object Name PTP

Remarks For naming rules for the shelf, slot, andsubslot in a PTP name, refer to section"EquipmentHolder".The values of domain include sdh, wdm, eth,atm, sonnet, and ptn. Only the transportequipment has these attributes. The portnames of the equipment of other domains,such as route and security, do not contain thedomain field. For the IP domain, there is acli_name field after the port field, forexample, /shelf=1/slot=13/type=eth/port=0/cli_name=Ethernet0/0/0.

D.8 FTPObject Name FTP


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>MEName <am:value></nam:rdn><nam:rdn><nam:type>FTP</nam:type><nam:value>FTPName <am:value></nam:rdn></name>



D-9

Object Name FTP


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type>ME</nam:type><nam:value>3145728</nam:value></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, andsubslot in a FTP name, refer to section"EquipmentHolder".The values of domain include sdh, wdm, eth,atm, sonnet, and ptn. Only the transportequipment has these attributes. The portnames of the equipment of other domains,such as route and security, do not contain thedomain field. For the IP domain, there is acli_name field after the port field, forexample, /shelf=1/type=vlanif/port=1001/cli_name=Vlanif1001.




Issue 05 (2010-11-19)

D.9 CTPObject Name CTP


<name> <nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn><nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </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 U2000XML Interface <name>

<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>PTP</nam:type> <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:type>CTP</nam:type> <nam:value>/sub_port=234</nam:value> </nam:rdn> </name>

Remarks



D-11

D.10 RESOURCESITEObject Name RESOURCESITE


<name><nam:rdn><nam:type>MD</nam:type><nam:value>CompanyName /MDName<am:value></nam:rdn><nam:rdn><nam:type>RESOURCESITE</nam:type><nam:value>RESOURCESITEName<am:value></nam:rdn></name>


<name><nam:rdn><nam:type>MD</nam:type><nam:value>Huawei/U2000</nam:value></nam:rdn><nam:rdn><nam:type> RESOURCESITE</nam:type><nam:value> 4063235</nam:value></nam:rdn></name>

Remarks This object is added by Huawei, whichrepresents the transport WDM NE.




Issue 05 (2010-11-19)

D.11 TUNNELPOLICYObject Name TUNNELPOLICY

Parameter Naming Rules Recommendedby MTOSI <name>

<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>TUNNELPOLICY</nam:type> <nam:value>TUNNELPOLICYName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </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 tunnelpolicies extended by Huawei.



D-13

D.12 TMDObject Name TMD


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>TMD</nam:type> <nam:value>TMDName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </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 oftransmission descriptors.




Issue 05 (2010-11-19)

D.13 CCObject Name CC


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>CC</nam:type> <nam:value>CCName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </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 PWswitches in the routing domain, static tunnelsin the PTN domain, and cross-connections inthe transport domain.



D-15

D.14 PGObject Name PG


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>PG</nam:type> <nam:value>PGName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>PG</nam:type> <nam:value>/shelf=1/pg=1/pos=17</nam:value> </nam:rdn></name>

Remarks This is a sample of renaming rules ofprotection groups in the transport domain.




Issue 05 (2010-11-19)

D.15 SNCObject Name SNC


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>SNC</nam:type> <nam:value>SNCName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>SNC</nam:type> <nam:value>TUNNEL=3||||100||||</nam:value> </nam:rdn></name>

Remarks



D-17

D.16 EPGObject Name EPG


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>EPG</nam:type> <nam:value>EPGName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>EPG</nam:type> <nam:value>/pg=1/type=1</nam:value> </nam:rdn></name>

Remarks This is a sample of renaming rules ofequipment protection groups in the transportdomain.




Issue 05 (2010-11-19)

D.17 EXPLICITPATHObject Name EXPLICITPATH


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>EXPLICITPATH</nam:type> <nam:value>EXPLICITPATHName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>EXPLICITPATH</nam:type> <nam:value>ex_path</nam:value> </nam:rdn></name>

Remarks



D-19

D.18 FDFRObject Name FDFR


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>FDFR</nam:type> <nam:value>FDFRName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>FDFR</nam:type> <nam:value>VSI=555|vsinam</nam:value> </nam:rdn></name>

Remarks




Issue 05 (2010-11-19)

D.19 VRRPObject Name VRRP


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>MEName <am:value> </nam:rdn> <nam:rdn> <nam:type>PTP</nam:type> <nam:value>PTPName <am:value> </nam:rdn> <nam:rdn> <nam:type>CTP</nam:type> <nam:value>CTPName <am:value> </nam:rdn> <nam:rdn> <nam:type>VRRP</nam:type> <nam:value>VRRPName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>ME</nam:type> <nam:value>3145728</nam:value> </nam:rdn> <nam:rdn> <nam:type>PTP</nam:type> <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:type>CTP</nam:type> <nam:value>/sub_port=2</nam:value> </nam:rdn> <nam:rdn> <nam:type>VRRP</nam:type> <nam:value>360</nam:value> </nam:rdn></name>

Remarks



D-21

D.20 TCPROFILEObject Name TCPROFILE


<nam:rdn> <nam:type>MD</nam:type> <nam:value>CompanyName /MDName <am:value> </nam:rdn> <nam:rdn> <nam:type>TCPROFILE</nam:type> <nam:value>TCPROFILEName <am:value> </nam:rdn></name>


<nam:rdn> <nam:type>MD</nam:type> <nam:value>Huawei/U2000</nam:value> </nam:rdn> <nam:rdn> <nam:type>TCPROFILE</nam:type> <nam:value>/type=cbqosprofile/name=cbqosprofiletest</nam:value> </nam:rdn></name>

Remarks




Issue 05 (2010-11-19)

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 contiguousconcatenation



19 LR_Section_OC1_STS1_and_RS_STM0

STM-0 regenerator section









iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide E Layer Rate Description


E-1


25 LR_Line_OC3_STS3_and_MS_STM1

STM-1 multiplex section







41 LR_Optical_Multiplex_Sec-tion

For WDM wavelength bands

42 LR_Optical_Transmission_Section

For WDM entire optical signal. That is, it isused for OTS and OMS layers of OTM-n.m(n>=1).

43 LR_ATM_NI For ATM network interfaces (UNI andNNI)

46 LR_PHYSICAL_ELECTRI-CAL

Analogue signal on electrical and physicalmedia

47 LR_PHYSICAL_OPTICAL Analogue signal on optical physical media

49 LR_OPTICAL_SECTION Represents the wavelength termination fora non DWDM system. That is, it is used forall kinds of single-lambda ports.

50 LR_DIGITAL_SIGNAL_RATE

Raw binary electrical signal of unspecifiedrate

72 LR_DSR_OC1_STM0 STM-0 digital signal rate




76 LR_DSR_OC48_and_STM16 STM-16 digital signal rate

77 LR_DSR_OC192_and_STM64

STM-64 digital signal rate

78 LR_DSR_OC768_and_STM256

STM-256 digital signal rate

80 LR_DSR_2M 2 Mbit/s digital signal rate



87 LR_DSR_Gigabit_Ethernet Gigabit Ethernet digital signal rate

E Layer Rate DescriptioniManager U2000 Unified Network Management System


E-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)










96 LR_Ethernet All Ethernet rates

97 LR_DSR_Fast_Ethernet 10/100 Mbit/s Ethernet

98 LR_Encapsulation For Ethernet. The following encapsulationprotocols apply: HDLC/PPP, HDLC/LAPS, ML/PPP, and GFPTransparent orframe mapped types

99 LR_Fragment Used for inverse multiplexing modeling(virtual concatenation for SONET/SDHandIMA)

100 LR_STS6c_and_VC4_2c 6xSTS-1/2xVC4 contiguous concatenation

101 LR_STS9c_and_VC4_3c 9xSTS-1/3xVC4 contiguous 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_Channel

Optical monitoring layer rate (extended byHUAWEI)

107 LR_OCH_Transport_Unit_1 Optical channel transport Unit 1(trail termination)



8006 LR_OCH_Data_Unit_5G trail and tandem connection monitoring/termination

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide E Layer Rate Description


E-3


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 Layer Rate DescriptioniManager U2000 Unified Network Management System


E-4 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

F Glossary

E

Edge Termination Point An Edge Termination Point (Edge TP) is aTermination Point (TP) that is at an entranceor exit point of a MultiLayer Subnetwork (i.e.add-drop or TPs that terminate links betweentwo Subnetworks) topological.

Element Management System The Element Management System (EMS) isused to manage (represent) a portion of anetwork which contains one or moreMultiLayer Subnetworks. The EMS is usedas the root of the naming tree in the NML-EML interface.

Equipment An Equipment represents the manageablephysical components of a Network Elementsuch as the circuit packs, the fans and anyother type of replaceable unit within theNetwork Element.

EquipmentHolder An Equipment Holder shall representresources of the Network Element that arecapable of holding other physicalcomponents. Specific resources that arerepresented by an Equipment Holder objectshall be for instance racks (bays), shelves, andslots or sub-slots.

L

Location An area, position, or portion of space thatsomebody or something can occupy. It isfurther decomposed into a geographic placethat relates to world-centric places and locallocation that relates to locally definedcoordinate systems.

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide F Glossary


F-1

M

Managed Element A Managed Element (ME) represents theEMS (management) view of a NetworkElement (NE).

MultiLayer Subnetwork A MultiLayer Subnetwork represents thetopology provided by the EMS system. Themain services provided within a MultiLayerare the set-up and tear-down of SubnetworkConnection Subnetwork (SNC).

N

Network Element A Network Element (NE) is telecommunica-tions hardware equipment that is addressableand manageable. NEs provide support orservices to the user and can be managedthrough an Element Management System(EMS). An NE is a combination of hardwareand software that primarily performs atelecommunications service function. Agroup of interconnected network elementsform a network.

P

Party Represents an individual, organization ororganization unit. Party is an abstract conceptthat should be used in places where thebusiness says something.

PartyRole The part played by a party in a given contextwith any characteristics, such as expectedpattern of behavior, attributes, and/orassociations that it entails. PartyRole is anabstract concept that should be used in placeswhere the business refers to a Party playing aRole.

Physical Termination Point A Physical Termination Point (PTP)represents the actual or potential endpoint ofa Topological Link. Essentially, this is arepresentation of a physical port.

ProductBundle A type of Product that is comprised of otherProduct(s). The other Product(s) may beProductBundle(s) or ProductComponent(s).

F GlossaryiManager U2000 Unified Network Management System


F-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

ProductSpecification A detailed description of a tangible orintangible object made available externally inthe form of a ProductOffering to Customersor other Parties playing a PartyRole. AProductSpecification may consist of otherProductSpecifications supplied together as acollection. Members of the collection may beoffered in their own right. ProductSpecifica-tions may also exist within groupings, such asProductCategories, ProductLines, andProductTypes.

R

Route A Route represents the route of a SubnetworkConnection (SNC).An SNC route isrepresented as a partially ordered seriesofCross Connects through which the SNCtraverses.

S

Service All Services are characterized as either beinga realization of a Product (CustomerFacing-Service) facing the Customer or how aService is provisioned within a provider'sinfrastructure (ResourceFacingService)facing the resources. Services are defined bya ServiceSpecification. The purpose of thespecification is twofold. First, it is used todefine attributes, methods, and relationshipsthat are common to all Services. Second, itprovides a convenient point to define howServices interact with other parts businessentities.

Service Access Point A point of entry where the service can beaccessed. This point of entry is alwaysassociated (directly or indirectly) with aphysical resource (such as a PTP, a CTP).However, sometimes the SAP is an object ora logical resource that contains or identifiesthe support of the physical resource.(Customer Premise Equipment, a MobileTerminal, a Set-top Box, an internet address).

ServiceCatalog A grouping of Service Specifications thatshare common characteristics. For exampleone catalog could group all internet relatedService Specifications.



F-3

ServiceCharacteristicValue A ServiceCharacteristicValue is a valuepassed over the Activation Interface toconvey an individually set servicecharacteristic (i.e. not reference in aServiceTemplate) or to override a globally setcharacteristic value (present in aServiceTemplate). A ServiceCharacteristic-Value will apply only to the specific Serviceinstance created.

ServiceDefinition A type of Service Specification (from theSID) introduced for the purposes of ServiceFulfillment. It defines ALL theServiceSpecCharacteristics that must be usedto create corresponding Service instances:l the ones which are set globally (the

corresponding values are defined only inServiceTemplates and are sometimesdesignated as "invariant")

l and the ones which are set individually(the corresponding values can be definedonly over the Activation Interface and aresometimes designated as "variant").

A ServiceSpecCharacteristic specified in aServiceDefinition may be associated withServiceSpecCharacteristicValues to restrictthe typing information or to specify a defaultvalue.

ServiceOrderr A Service Order is a type of request (asdefined in the SID model). In particular, aservice order is used to track and control theprogress of a request for some action (e.g.,provision or activation) on the services thatcomprise a given product instance. It shouldbe mentioned that the OSS/J OrderManagement API (JSR 264) defines ServiceOrder as follows: "A type of Request thatrepresents a Customer Order's productsdecomposed into the services through whichthe products are realized. Service Orders aregenerated within the confines of the SM&Olayer."

ServiceOrderItem Service Order Items are used to represent theorder aspects of the services associated witha given service order. There is one serviceorder item for each service associated with aservice order.




Issue 05 (2010-11-19)

ServiceRequest A request made by the CRM layer to theSM&O layer as defined in the TMForumeTOM to take an action on one or more CFSinstances given a product identifier, a productspecification name and a related set ofcharacteristics. This request can be realizedby Template and by Value.

ServiceSpecCharacteristic A characteristic quality or distinctive featureof a Service as represented in aServiceSpecification (specialized asServiceDefinition or ServiceTemplate). Inparticular it contains typing informationwhich can be arbitrarily complex. A ServiceSpec Characteristic can be atomic orcomposite (also called "packages"). Thecomponents of a composite Service SpecCharacteristic can in turn be atomic orcomposite.

ServiceSpecCharacteristicValue A value that can be associated with aServiceSpecCharacteristic in conformancewith the specified typing information.l When associated with a

ServiceSpecCharacteristic in aServiceDefinition, it is used to restrict thetyping information (in this case severalServiceSpecCharacteristicValues may beused) or to specify additional information(e.g. default value).

l When associated with aServiceSpecCharacteristic in aServiceTemplate, it will apply globally toall the Service instances conformant tothis ServiceTemplate. In this case, theServiceSpecCharacteristicValue is set atthe design stage when theServiceTemplate is created, and it cannotbe modified afterwards.

A ServiceSpecCharacteristic present in aServiceTemplate is sometimes qualified asbeing "invariant", since it cannot be modifiedafter the creation of the ServiceTemplate (theterm "globally set" can also be used"). AServiceSpecCharacteristic which value ispassed over the Activation Interface issometimes qualified as being "variant", sincethe value must be given for each Serviceinstance created (the term "individually set"can also be used).



F-5

ServiceSpecification Changeable as well as invariant attributes,methods, relationships and constraints whichdefine a Service. It can be conceptuallythought of as a template that different Serviceinstances can be instantiated from. Each ofthese Service instances will have the sameinvariant characteristics. However, the othercharacteristics of the instantiated Service willbe specific to each instance.

ServiceSpecificationType The ServiceSpecificationType class defines ageneric category of ServiceSpecifications.Each ServiceSpecificationType serves togroup a set of particular ServiceSpecifica-tions that share the same behavior and othersemantics. One result of this is to be able tomore efficiently define a set of relatedServices that can be grouped together to forma higher-level Service. For example, a givenhigher-level Service might include VPN andQoS Services. If these Services are alwaysused together, then they can be categorizedusing a common type.




Issue 05 (2010-11-19)

ServiceTemplate A type of Service Specification (from theSID) introduced for the purposes of ServiceFulfillment. It defines specificServiceSpecCharacteristicsValues for theglobally set ServiceSpecCharacteristics thatcan be dynamically referenced by multipleService instances during their lifecycle AServiceTemplate is checked against itsassociatedspan. ServiceDefinition byverifying the presence of theServiceSpecCharacteristics and the validityof the corresponding assignedServiceSpecCharacteristicsValues. Each ofthe associated Service instances will have thesame invariant characteristics which valuesare taken from the ServiceTemplate.However, when activating a Service, it maybe possible to specify over the ActivationInterface a ServiceCharacteristicsValuewhich overrides the correspondingServiceSpecCharacteristicValue available inthe associated ServiceTemplate. In this casethe new proposed value applies only to theService instance created, and theServiceSpecCharacteristicValue in theServiceTemplate is not modified. In order notto descend into sub-classing, theServiceTemplate is considered to be genericsuch that it serves as a framework for definingtechnology or service specific templates.Other TMForum groups, or service providers,may use the service template as a foundationfor building or populating servicetemplates.



F-7

Subnetwork Connection A Subnetwork Connection (SNC) representsthe relationship between two of the followingtypes 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-endconnection or a trail (closed or half-open)through or within a MultiLayer Subnetworkaccording to the roles associated to its endpoints. If the SNC represents a connection, itsend points are CTPs or FTPs with the SNC'slayer rate as connectable layer rate. In the caseof GTPs (i.e. a Bundled connection) the SNCdoes not have an explicit layer rate. If the SNCrepresents a trail, its end points are CTPs,FTPs or PTPs. An SNC shall be contained ina MultiLayer Subnetwork.

Subscriber A Subscriber is an entity (associated with oneor more users) that is engaged in a servicesubscription with a service provider. Thesubscriber is allowed to subscribe andunsubscribe services, to register a user or alist of users authorized to use these services,and also to set the limits relative to the usethat associated users make of these services.

T

Termination Point A Termination Point (TP) represents a logicalabstraction of anendpoint (actual or potential)of either:1. A Topological Link or2. a Subnetwork Connection (SNC) or3. a Flow Domain Fragment (FDFr) or4. a Cross Connection (CC).

Topological Link A Topological Link (TL) is a physical linkbetween two Physical Termination Point(PTP)s or a trail between two TerminationPoint (TP)s (e.g., an ATM link between twoATM NI CTPs), which are called aEnd TPand zEnd TP of the TL.




Issue 05 (2010-11-19)

TMDTransmission Descriptor

A Transmission Descriptor (TMD) representsa collection of attributes, which are used todefine multi-layered transmissionparame-ters, and additional information parameterson a Termination Point (TP).



F-9

G Acronyms and Abbreviations

A

ABR Asynchronous Batch Response

AFB Asynchronous File Bulk

AID Alarm Identifier

ARR Asynchronous Request/Reply

ASN.1 Abstract Syntax Notation One

AVC AttributeValueChange

C

CDE Common Desktop Environment

CPU Central Processing Unit

E

EdgeTP EdgeTerminationPoint

EH EquipmenHolder

EQT Equipment

EMS Element Management System

F

FIFO First In First Out

FTP File Transfer Protocol

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide G Acronyms and Abbreviations


G-1

G

GE Gigabit Ethernet

GNE Gate Network Element

GUI GraphicalUserInterface

H

HA High-Availability

HTTP Hyper-Text Transmission Protocol

HTTPS Hypertext Transfer Protocol Secure

I

ID Identity

IMAP Integrated Management ApplicationPlatform

IP Internet Protocol

ITU-T International Telecommunication Union-Telecommunication Standardization Sector

J

JMS Java Message Service

L

LAN Local Area Network

M

MAC Media Access Control

MD ManagementDomain

MDP Message Dispatch Process

ME ManagedElement

MEP Message Exchage Pattern

MLSN MultiLayerSubNetwork

MO Managed Object

G Acronyms and AbbreviationsiManager U2000 Unified Network Management System


G-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

MTOSI Multi-Technology Operations SystemInterface

MTNM Multi-Technology Network Management

N

NE NetworkElement

NEL Network Element Level

NML Network Management Level

NMS Network Management System

O

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

P

PC Personal Computer

PDH Plesiochronous Digital Hierarchy

PTP PhysicalTerminationPoint

S

SAP Service Access Point

SC StateChange

SDH Synchronous Digital Hierarchy

SFB Synchronous (File) Bulk

SIT Synchronous Iterator Pattern

SNC SubNetworkConnection

iManager U2000 Unified Network Management SystemNorthbound XML Interface User Guide G Acronyms and Abbreviations


G-3

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

T

TCP Transport Control Protocol

TL TopologicalLink

TMD TransmissionDescriptor

TMF Telecommunication Management Forum

TMN Telecommunication Management Network

TP TerminationPoint

TCA Threshold Crossed Alert

U

UPC Usage Parameter Control

UTC Coordinated Universal Time

W

WAN Wide Area Network

WSDL Web Service Definition Language

WSN Web Services Notification

X

XML eXtensible Markup Language

G Acronyms and AbbreviationsiManager U2000 Unified Network Management System


G-4 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 05 (2010-11-19)

100800613 iManager U2000 Northbound XML Interface User Guide V100R002C01 05

Documents

Transcript of 100800613 iManager U2000 Northbound XML Interface User Guide V100R002C01 05