M2000 Northbound CORBA Interface Developer Guide

March 24, 2018 | Author: Ronaldo Albuquerque | Category: Common Object Request Broker Architecture, Information Technology Management, Digital & Social Media, Digital Technology, System Software
Share
Report this link


Comments



Description

M2000 V200R010Northbound CORBA Interface Developer Guide Issue Date 03 2010-12-31 HUAWEI TECHNOLOGIES CO., LTD. Copyright © Huawei Technologies Co., Ltd. 2010. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd. Trademarks and Permissions and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders. Notice The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute the warranty of any kind, express or implied. Huawei Technologies Co., Ltd. Address: Huawei Industrial Base Bantian, Longgang Shenzhen 518129 People's Republic of China http://www.huawei.com [email protected] Website: Email: Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. i . Compared with the second release. The document also provides operation guidelines for connecting the network management system (NMS). iii .. Product Name M2000 Version V200R010 Intended Audience This document is intended for: l Network administrator Update History 03 (2010-12-31) This is the third commercial release. the changes in the third release are as follows: Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Ltd. Related Versions The following table lists product versions related to this document.M2000 Northbound CORBA Interface Developer Guide About This Document About This Document Purpose This document provides information about the M2000 northbound CORBA interface. 01 (2010-07-31) Initial release.4 Technical Specifications of Northbound CORBA Interface Modification Description The content descriptions are changed. The alarm management has the following functions: querying alarms. Ltd. 4 Alarm Management Function of the CORBA Interface The AlarmIRP interface is the only interface used in alarm management. 3 Configuration Management Function of the CORBA Interface The configuration management interface has the following three functions: BasicCMIRP. and reporting alarms in real time. These functions are EPIRP.. clearing alarms. 02 (2010-10-30) This is the second commercial release. and BulkCMIRP. Issue 03 (2010-12-31) . the changes in the second release are as follows: Content 1.About This Document M2000 Northbound CORBA Interface Developer Guide Content 1. 5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface iv Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. KernelCMIRP. Organization 1 Introduction to Northbound CORBA Interface This introduction defines the Northbound CORBA interface provided by the M2000 and describes the functions of the Northbound CORBA interface. acknowledging alarms. Compared with the first release. NotificationIRP and CSIRP. unacknowledging alarms. 2 Common Management Function of the CORBA Interface The function of common management interface consists of a cluster of management functions.4 Technical Specifications of Northbound CORBA Interface Modification Description The description of technical specifications is added. Examples of information displayed on the screen are in Courier New. which if not avoided. Convention Times New Roman Boldface Italic Courier New Description Normal paragraphs are in Times New Roman. log in as user root.M2000 Northbound CORBA Interface Developer Guide About This Document Before interconnecting the NMS to the M2000. Symbol Description Indicates a hazard with a high level of risk. 6 Troubleshooting the Northbound CORBA Interface The NMS interconnects with the M2000 through the northbound CORBA interface. which if not avoided. Conventions Symbol Conventions The symbols that may be found in this document are defined as follows. v . directories. could result in equipment damage. Indicates a potentially hazardous situation. Book titles are in italics. will result in death or serious injury. and users are in boldface. If a fault occurs when the NMS is obtaining the data. 7 Appendix A collection of supplementary material. you can infer that the northbound CORBA interface meets the conditions for the interconnection. Ltd. refer to relevant troubleshooting methods in this chapter. could result in minor or moderate injury. you need to make certain preparations. Names of files. which if not avoided.. folders. or unexpected results. General Conventions The general conventions that may be found in this document are defined as follows. For example. performance degradation. data loss. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates a hazard with a medium or low level of risk. Provides additional information to emphasize or supplement important points of the main text. If you complete the preparations. Indicates a tip that may help you solve a problem or save time. Issue 03 (2010-12-31) . [ x | y | .. Convention Boldface > Description Buttons. }* Description The keywords of a command line are in boldface. A means the two keys should be pressed in turn. Convention Boldface Italic [] { x | y | . parameters. click OK. Keyboard Operations The keyboard operations that may be found in this document are defined as follows. Multi-level menus are in boldface and separated by the ">" signs.. Format Key Key 1+Key 2 Key 1.About This Document M2000 Northbound CORBA Interface Developer Guide Command Conventions The command conventions that may be found in this document are defined as follows. and dialog titles are in boldface.. Several items or no item can be selected. For example. } [ x | y | . Items (keywords or arguments) in brackets [ ] are optional. For example. Optional items are grouped in braces and separated by vertical bars. pressing Alt. One item is selected or no item is selected. Mouse Operations vi Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ] { x | y | . ]* GUI Conventions The GUI conventions that may be found in this document are defined as follows. Optional items are grouped in braces and separated by vertical bars. One item is selected. Press the keys concurrently. Ltd. press Enter and press Tab. Optional items are grouped in brackets and separated by vertical bars.. pressing Ctrl+Alt +A means the three keys should be pressed concurrently.. Optional items are grouped in brackets and separated by vertical bars. window. A minimum of one item or a maximum of all items can be selected. For example... For example. choose File > Create > Folder. menus. Command arguments are in italics. Press the keys in turn. tabs. For example. Key 2 Description Press the key... Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.M2000 Northbound CORBA Interface Developer Guide About This Document The mouse operations that may be found in this document are defined as follows. Press and hold the primary mouse button and move the pointer to a certain position. vii .. Action Click Double-click Drag Description Select and release the primary mouse button without moving the pointer. Ltd. Press the primary mouse button twice continuously and quickly without moving the pointer. . ...................................................2 Notification Management Function of the CORBA Interface.......1-6 1..........4-2 4......1.................................3 Communication Surveillance Function of the CORBA Interface..........................3......................................... ix ....................iii 1 Introduction to Northbound CORBA Interface...............1 Getting to Know Configuration Management of the CORBA Interface.....................................................3...........................4 Technical Specifications of Northbound CORBA Interface...............................................................3-1 3....2 Alarm Management of the CORBA................3 Mechanism for Forwarding Common Alarms.......1 Interface Description of the Common Configuration Management of the CORBA.........................................2....................................................2-23 2........M2000 Northbound CORBA Interface Developer Guide Contents Contents About This Document...............................................................................................................2-11 2........................................................1 Definition of Northbound Interface................................................2................4-47 Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co...3 Function and Interface of Basic Configuration Management of the CORBA.....................................................2-29 3 Configuration Management Function of the CORBA Interface.....................................1....................................1 Interface Description of the Entry Point of the CORBA Interface.............................................3-4 3..2-11 2...............2 Notification Description of the Entry Point of the CORBA Interface.................................2-23 2...............2 Notification Description of the CORBA Alarm Management..........2...............................1-2 1....................................................................1-7 2 Common Management Function of the CORBA Interface..............................4-2 4...................................2 Notification Description of the Common Configuration Management of the CORBA.........................2.........................................................................................................................................................1 Interface Description of the CORBA Communication Surveillance.......1-5 1.....1 Introduction to Notification Management Function of the CORBA.............2-12 2.........................3-15 4 Alarm Management Function of the CORBA Interface...............................................1-2 1............ 2-2 2...............2 Definition of Northbound CORBA Interface....................4-1 4....................................................................1 Introduction to the CORBA Alarm Management.........2-1 2....2........................ Ltd......2 Interface Description of the CORBA Notification Management........................................2 Heartbeat Notification of the CORBA Communication Surveillance........................................................................................3-8 3............................1 Entry Point of the CORBA Interface....3-2 3...........3.......................................3...2-9 2.............................................................................3-3 3........... 2-2 2.....................................................1 Interface Management of the CORBA......1 Interface Description of the CORBA Alarm Management..................................................................................................................3 Function of Northbound CORBA Interface....................1-5 1............2...........4-2 4...4-29 4................2 About IRP..............................................2.........................1-1 1.................2 Common Configuration Management of the CORBA............................... ......................................................................................................................................................................................................................................................7-2 7....................................7-5 7...................................................................................6-5 7 Appendix................................1 Description of filter........5-3 5...........7-6 x Huawei Proprietary and Confidential Copyright © Huawei Technologies Co..........................................2 Description of DN String....................2 Description of filter in get_alarm_list..........................................................................................................................................7-4 7.........................................................................................................................5-1 5................................................................................................7-1 7........ Issue 03 (2010-12-31) ..........5-3 5..............2 Obtaining the IDL File.......................3 Operations Required When the IP Address or Hostname of the M2000 Server Changes..........................................2 Troubleshooting Failure to Obtain Data...................................................................................................................Contents M2000 Northbound CORBA Interface Developer Guide 5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface ..1......................................................................................................6 Using the CORBA Interface.......................3 Description of filter in get_alarm_count......1 Negotiating the Interconnection Parameters of the Northbound CORBA Interface......................1 Common Troubleshooting and Information Collection (CORBA Interface)................6-2 6.......................7-5 7...................5-5 6 Troubleshooting the Northbound CORBA Interface...........................5-4 5...............5-2 5.............6-2 6...............................................................1.......................................................4 Obtaining the Reference of the Entry Point Object....................................................... Ltd....1..............................................................5 Modifying the hosts File of the Server.............................................3 Checking the CORBA Version..........................5-5 5..................................................................................................1 Notification filter Description...............6-1 6.......................................................................3 Description of Alarm Location Detailed Information...7-2 7........... ..................................................... 1-2 Figure 1-2 Interface management functions...........................................................................................1-7 Figure 3-1 Querying the event flow of MOs................................................................................................................. 7-6 Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co............................................1-6 Figure 1-4 Getting object reference of other IRPs by entry points................................................................................3-22 Figure 4-1 Event flow of alarm information................................. Ltd.................................................................................................. xi .......................................................................................................................................1-5 Figure 1-3 Relation between managed object by the management domain............................................... 1-7 Figure 1-5 Relations between IRPs..........................M2000 Northbound CORBA Interface Developer Guide Figures Figures Figure 1-1 Location of the northbound interface.....................................................4-8 Figure 7-1 DN string........................ . .......................................2-17 Table 2-32 Values of subscribing specified notifications.........................2-13 Table 2-21 Exceptions of getting notificationIRP versions.................................... xiii ...........................................................................................................................................................................................................................................................................2-10 Table 2-19 Notification management function of the CORBA interface...............................................................................................1-3 Table 2-1 Values of getting EPIRP versions.................................................2-4 Table 2-6 Parameters for getting EPIRP notification profile................................................................................................................................................................................................................ Ltd.............................................................................................2-16 Table 2-30 Exceptions of getting notification categories.......................2-16 Table 2-31 Parameters for subscribing specified notifications....................................................................................................................................M2000 Northbound CORBA Interface Developer Guide Tables Tables Table 1-1 Interface protocol.........2-9 Table 2-18 Format of the notification of entry point register information change..................................2-3 Table 2-5 Exceptions of getting EPIRP operation profile.............................................................................................................................................................................................2-3 Table 2-4 Values of getting EPIRP operation profile..................................................................................................................2-12 Table 2-20 Values of getting notificationIRP versions...............................2-14 Table 2-26 Values of getting notificationIRP notification profile..................................................................................................................2-4 Table 2-8 Exceptions of getting EPIRP notification profile........................................................................................................2-6 Table 2-11 Exceptions of getting IRP outline........2-15 Table 2-27 Exceptions of getting notificationIRP notification profile......................................................2-3 Table 2-3 Parameters for getting EPIRP operation profile.......2-15 Table 2-29 Values of getting notification categories.......................................................................................2-5 Table 2-9 Parameters for getting IRP outline..............................2-18 Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.........................................................................................................................2-7 Table 2-13 Values of getting IRP reference.................................................................................................................................................................2-9 Table 2-17 Exceptions of releasing IRP reference............2-8 Table 2-16 Values of releasing IRP reference........................................................2-15 Table 2-28 Parameters for getting notification categories................2-2 Table 2-2 Exceptions of getting EPIRP version.............................................................................................................................................................................................................2-14 Table 2-25 Parameters for getting notificationIRP notification profile............................................................................2-5 Table 2-10 Values of getting IRP outline.........................2-6 Table 2-12 Parameters for getting IRP reference..........2-14 Table 2-24 Exceptions of getting notificationIRP operation profile.....................................................................................................................................................2-13 Table 2-23 Values of getting notificationIRP operation profile....................................................................................................................................2-8 Table 2-15 Parameters for releasing IRP reference......................2-13 Table 2-22 Parameters for getting notificationIRP operation profile........................2-4 Table 2-7 Values of getting EPIRP notification profile.................2-8 Table 2-14 Exceptions of getting IRP reference..................................................... .................. 2-26 Table 2-53 Parameters for getting heartbeat period..........................................................................................3-6 Table 3-9 Parameters for getting NRMIRP versions...........................................................................................2-22 Table 2-42 Parameters for querying specified subscription parameters...........................................2-21 Table 2-41 Exceptions of querying subscription IDs..................3-10 xiv Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.................................................................2-29 Table 2-61 Exceptions of triggering heartbeat notifications...............................................................................................................................................................................................................................................................3-5 Table 3-4 Values of getting KernelCMIRP operation profile.........2-26 Table 2-52 Exceptions of getting CSIRP notification profile..................................................2-25 Table 2-50 Parameters for getting CSIRP notification profile................................2-25 Table 2-51 Values of getting CSIRP notification profile............................................................................3-5 Table 3-5 Exceptions of getting KernelCMIRP operation profile......................2-27 Table 2-57 Values of setting heartbeat period.................................2-20 Table 2-36 Parameters for changing subscription filter conditions........................2-24 Table 2-47 Parameters for getting CSIRP operation profile............................................3-5 Table 3-6 Parameters for getting KernelCMIRP notification profile.......................................................... 2-24 Table 2-48 Values of getting CSIRP operation profile..................... 2-26 Table 2-54 Values of getting heartbeat period..........................................................................................................2-28 Table 2-58 Exceptions of setting heartbeat period..............................2-20 Table 2-38 Exceptions of changing subscription filter conditions.............................................................................................................................................................................................................Tables M2000 Northbound CORBA Interface Developer Guide Table 2-33 Exceptions of subscribing specified notifications.........................................3-7 Table 3-10 Exceptions of getting NRMIRP versions..............................................2-27 Table 2-56 Parameters for setting heartbeat period................................................................................................................................................................................................................... Ltd..................2-24 Table 2-46 Exceptions of getting CSIRP versions............................2-21 Table 2-39 Parameters for querying subscription IDs.....................................3-6 Table 3-8 Exceptions of getting KernelCMIRP notification profile.................................................................................... Issue 03 (2010-12-31) .3-6 Table 3-7 Values of getting KernelCMIRP notification profile....................................2-23 Table 2-45 Values of getting CSIRP versions.....3-4 Table 3-3 Parameters for getting KernelCMIRP operation profile............................................................................................................................................................................................................................................................................... 2-25 Table 2-49 Exceptions of getting CSIRP operation profile...................................................................................3-8 Table 3-12 Notification of notifyObjectDeletion...........................................2-22 Table 2-43 Values of querying specified subscription parameters....................................................................................................... 2-27 Table 2-55 Exceptions of getting heartbeat period.........................................................................................2-23 Table 2-44 Exceptions of querying specified subscription parameters.......................................................................................2-19 Table 2-34 Parameters for detaching notification subscription........................................2-20 Table 2-37 Values of changing subscription filter conditions...................................................................................................................................................................................................................................................2-19 Table 2-35 Exceptions of detaching notification subscription..................................................................3-7 Table 3-11 Notification of notifyObjectCreation...........................................................................................................................................................................................................3-4 Table 3-2 Exceptions of getting KernelCMIRP versions....................................................................................2-30 Table 3-1 Values of getting KernelCMIRP versions.............................................................................................................................2-29 Table 2-60 Values of triggering heartbeat notifications..................................................................................2-28 Table 2-59 Parameters for triggering heartbeat notifications............................................................................................................... 2-29 Table 2-62 Format of the heartbeat notification..............2-21 Table 2-40 Values of querying subscription IDs....................... .........................................................................................................................................................................3-21 Table 3-28 Exceptions of finding managed objects (II)....................................................................................................................4-20 Table 4-20 Values of getting alarm count.............................................................................................................................................................................................................3-15 Table 3-17 Parameters for getting BasicCMIRP operation profile..............................4-4 Table 4-6 Parameters for getting AlarmIRP notification profile................................................................................4-16 Table 4-19 Parameters for getting alarm count.........3-17 Table 3-22 Exceptions of getting BasicCMIRP notification profile......4-5 Table 4-10 Values of getting alarm list (I).............................4-3 Table 4-5 Exceptions of getting AlarmIRP operation profile...................................................................................................................................................................3-16 Table 3-20 Parameters for getting BasicCMIRP notification profile...............................................................................4-22 Table 4-24 Exceptions of acknowledging alarms....................3-16 Table 3-19 Exceptions of getting BasicCMIRP operation profile...........................................................................3-22 Table 3-30 Steps used for the event flow of querying MOs......................................4-5 Table 4-9 Parameters for getting alarm list (I).............4-12 Table 4-18 Unacknowledged but cleared alarms...................................................................................4-4 Table 4-7 Values of getting AlarmIRP notification profile........................................................................................................4-7 Table 4-14 Exceptions of getting alarm list (II).............4-6 Table 4-11 Exceptions of getting alarm list (I)..................................................................4-7 Table 4-15 Exceptions of getting alarm list (III)....................................................................................................................................................................................................................................................................3-19 Table 3-25 Exceptions of finding managed objects (I)..............................................................................................................................................................3-13 Table 3-15 Values of getting BasicCMIRP versions.................................................................................................................................................3-20 Table 3-26 Parameters for finding managed objects (II).......4-9 Table 4-17 Acknowledged but uncleared alarms.........3-15 Table 3-16 Exceptions of getting BasicCMIRP versions...............................................................................................................................................4-3 Table 4-4 Values of getting AlarmIRP operation profile.....................................................................................................................................................4-6 Table 4-12 Parameters for getting alarm list (II)..................................................3-21 Table 3-29 Exceptions of finding managed objects (III)............................................................................................................................3-20 Table 3-27 Values of finding managed objects (II).................................................................................................................................................................................................................................3-17 Table 3-21 Values of getting BasicCMIRP notification profile........................................4-3 Table 4-3 Parameters for getting AlarmIRP operation profile............................................................................................................................................................................................................3-16 Table 3-18 Values of getting BasicCMIRP operation profile.........................................3-18 Table 3-24 Values of finding managed objects (I).4-20 Table 4-21 Exceptions of getting alarm count...................................................................... 3-12 Table 3-14 Notification of notifyCMSynchronizationRecommended.......4-7 Table 4-13 Values of getting alarm list (II)..........................4-8 Table 4-16 Unacknowledged and uncleared alarms............................................................................................... Ltd....3-22 Table 4-1 Values of getting AlarmIRP versions.................................4-4 Table 4-8 Exceptions of getting AlarmIRP notification profile............................................................4-23 Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co..................................................4-21 Table 4-23 Values of acknowledging alarms......................................................... xv ................................4-2 Table 4-2 Exceptions of getting AlarmIRP versions.........4-20 Table 4-22 Parameters for acknowledging alarms...........M2000 Northbound CORBA Interface Developer Guide Tables Table 3-13 Notification of notifyAttributeValueChange...................................................................................................................................................................................................................................................................3-17 Table 3-23 Parameters for finding managed objects (I)............................................................................................................. ............................................................................................................................................................................................................................................................................4-24 Table 4-27 Exceptions of unacknowledging alarms..............................4-27 Table 4-32 Values of adding comments to alarms...............................................4-41 Table 4-39 Notification of alarm changes..........................................................................................................................4-26 Table 4-31 Parameters for adding comments to alarms............................................................................................................... 4-34 Table 4-37 Notification of alarm clearance.................6-2 Table 6-2 Information to be collected.............................................................4-44 Table 4-40 Description of the configuration item...............................................................................................................................4-28 Table 4-34 notifyPotentialFaultyAlarmList....4-23 Table 4-26 Values of unacknowledging alarms.....................................................................................................................................................................................................................4-28 Table 4-33 Exceptions of adding comments to alarms.........................................................................................................................................................................................................................................................................4-25 Table 4-29 Values of clearing alarms....... 4-29 Table 4-35 Notification of new alarms..................................................5-6 Table 6-1 Troubleshooting.......................6-3 xvi Huawei Proprietary and Confidential Copyright © Huawei Technologies Co........................................4-26 Table 4-30 Exceptions of clearing alarms...................................4-38 Table 4-38 Format of adding alarm comment.................................4-48 Table 5-1 Negotiated parameters...............................5-2 Table 5-2 Usage of the CORBA interface........................................................................................................................................................................................................................................................................................................................................................... Ltd.......................... Issue 03 (2010-12-31) ................................................4-25 Table 4-28 Parameters for clearing alarms....................Tables M2000 Northbound CORBA Interface Developer Guide Table 4-25 Parameters for unacknowledging alarms..............6-2 Table 6-3 Possible Causes and Problem Localization ................................................................................4-30 Table 4-36 Notification of the change of the alarm acknowledgement status.................................................................................... 1-1 . and 3GPP specifications..4 Technical Specifications of Northbound CORBA Interface This section describes the technical specifications related to the northbound CORBA interface.2 Definition of Northbound CORBA Interface The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). FTP protocol. 1.1 Definition of Northbound Interface The northbound interface links the element management system (EMS) and the NMS. 1. 1.M2000 Northbound CORBA Interface Developer Guide 1 Introduction to Northbound CORBA Interface 1 Introduction to Northbound CORBA Interface About This Chapter This introduction defines the Northbound CORBA interface provided by the M2000 and describes the functions of the Northbound CORBA interface. Ltd. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The Northbound CORBA interface conforms to the CORBA protocol. The Northbound CORBA interface is one of the Northbound interfaces.3 Function of Northbound CORBA Interface This section describes the concepts related to CORBA interface management and integrated reference point (IRP). 1. Ltd.1 Definition of Northbound Interface The northbound interface links the element management system (EMS) and the NMS.. Interface Protocol Table 1-1 describes the related information on interface protocol. On the northbound interface. Issue 03 (2010-12-31) . The northbound interface is shown in Figure 1-1. The NE information includes the alarm. The Northbound CORBA interface is one of the Northbound interfaces. The M2000 reports the alarm. Figure 1-1 Location of the northbound interface In the communication network. performance and inventory data. The Northbound CORBA interface conforms to the CORBA protocol.1 Introduction to Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide 1. the M2000 is an EMS. 1-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. the NMS obtains information about the network elements (NEs) managed by the EMS and delivers operation commands. and 3GPP specifications. configuration. configuration.2 Definition of Northbound CORBA Interface The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). performance and inventory data to the NMS through the northbound interface. 1. FTP protocol. 3 standard l OMG Notification Service 1.3 Version NOTE l OMG represents the Object Management Group. The design of the network management interfaces complies with the following CORBA standards: l OMG ORB 2. The CORBA technology uses the IDL language to define the interface information model and also uses the IIOP communication protocol stack. FTP The file transfer mode in the management interface uses the File Transfer Protocol (FTP) and the FTP protocol stack..0 standard l TAO 1. Ltd.M2000 Northbound CORBA Interface Developer Guide 1 Introduction to Northbound CORBA Interface Table 1-1 Interface protocol Protocol CORBA Details The design of network management interfaces adopts the CORBA technology for interface definition. 1-3 . l ORB represents the Object Request Broker. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. .0 Telecommunication management.352 v6.0. Bulk CM Integration Reference Point (IRP): eXtensible Markup Language (XML) file format definition l 3GPP TS 32.0.0. Part 1: 3G fault management requirements l 3GPP TS 32.0 Telecommunication management.0.0 Telecommunication management.602 v6.0.615 v6.611 v6.1 Introduction to Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide Protocol 3GPP Details The CORBA interface complies with the following 3GPP protocols: l 3GPP TS 32. Configuration Management (CM). Performance Management (PM) Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS) l 3GPP TS 32. Ltd. Performance Management (PM) Integration Reference Point (IRP): Requirements l 3GPP TS 32. Part 3: Alarm Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS) l 3GPP TS 32.0 Telecommunication management.0 Telecommunication management.0.111-1 v6.0 Telecommunication management.111-3 v6.0 Telecommunication management. Configuration Management (CM). Configuration Management (CM). Basic CM Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32.0 Telecommunication management.0.413 v6.0.603 v6. Basic CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS) l 3GPP TS 32. Performance Management (PM) Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32.613 v6.0 Telecommunication management.612 v6.411 v6.412 v6.0.0.0 Telecommunication management. Configuration Management (CM). Configuration Management (CM).111-2 v6. Communication Surveillance (CS) Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32.0.0. Bulk CM Integration Reference Point (IRP): Requirements l 3GPP TS 32. Basic CM Integration Reference Point (IRP): Requirements l 3GPP TS 32.601 v6.0 Fault Management. Configuration Management (CM).0 Telecommunication management. Issue 03 (2010-12-31) . Part 2: Alarm Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32.0.0 Fault Management.0.0 Fault Management. Bulk CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS) 1-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Bulk CM Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32. Configuration Management (CM). configuration management interface. 1. configuration management. and fault management interface.0. Figure 1-2 Interface management functions Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Entry Point IRP (EPIRP) and NotificationIRP.3 Function of Northbound CORBA Interface This section describes the concepts related to CORBA interface management and integrated reference point (IRP).. Configuration Management (CM).662 v6. Kernel CM Information Service (IS) l 3GPP TS 32. Kernel CM: Requirements l 3GPP TS 32. and fault management interface.0 Telecommunication management. and fault management.663 v6.0. Kernel CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS) 1.0 Telecommunication management.M2000 Northbound CORBA Interface Developer Guide 1 Introduction to Northbound CORBA Interface Protocol Details l 3GPP TS 32. The relatively independent interface function provided by the Itf-N interface can be considered as an IRP and then integrated in the network resource model as a managed object. the ItfN consists of a cluster of management interfaces.0.3. such as common management interface. the ItfN consists of a cluster of management interfaces. 1-5 . configuration management interface.661 v6.3.1 Interface Management of the CORBA Based on the common management. 1. For example.0 Telecommunication management.2 About IRP The integrated reference point (IRP) is the abstract name of the interface function. Configuration Management (CM). Configuration Management (CM).3. and fault management. 1.1 Interface Management of the CORBA Based on the common management. configuration management. Ltd. Figure 1-2 shows the interface management functions. such as common management interface. The relatively independent interface function provided by the Itf-N interface can be considered as an IRP and then integrated in the network resource model as a managed object. The managed object are called IRPs. Ltd. Figure 1-3 shows the relation between managed object by the management domain. IRPAgent referred in the latter section is considered as the Itf-N interface system. Issue 03 (2010-12-31) . IRPAgent IRPAgent is the agent of IRP. For example. IRPAgent is used as the subnode of ManagementNode.2 About IRP The integrated reference point (IRP) is the abstract name of the interface function.1 Introduction to Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide 1. IRPAgent includes each object class of IRPs on the Itf-N interface. 1-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Entry Point IRP (EPIRP) and NotificationIRP. Figure 1-3 Relation between managed object by the management domain Relations Between IRPs Figure 1-4 shows the function of entry points that can get object reference of other IRPs. In the network resource model.3. Therefore. the Itf-N interface is considered as IRPAgent in the network resource model.. Value 5 8 15 1-7 . Figure 1-5 Relations between IRPs 1. Specification Item Maximum number of NMS users on the CORBA interface Maximum number of notifications to be subscribed to on CORBA interfaces Maximum delay in reporting a northbound alarm (unit: second) Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co..4 Technical Specifications of Northbound CORBA Interface This section describes the technical specifications related to the northbound CORBA interface. Ltd.M2000 Northbound CORBA Interface Developer Guide 1 Introduction to Northbound CORBA Interface Figure 1-4 Getting object reference of other IRPs by entry points Figure 1-5 shows relations between IRPs. Issue 03 (2010-12-31) .1 Introduction to Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide 1-8 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.. Ltd. 2. 2-1 . 2. NotificationIRP and CSIRP. Ltd. These functions are EPIRP.2 Notification Management Function of the CORBA Interface The notification Management function of the CORBA interface is used for event reporting to the NMS and the management of order information.1 Entry Point of the CORBA Interface The entry point is the first object that IRPAgent accesses.3 Communication Surveillance Function of the CORBA Interface The communication surveillance interface function provides a mechanism to monitor the status of communication channels between the NMS and IRPAgent.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface 2 Common Management Function of the CORBA Interface About This Chapter The function of common management interface consists of a cluster of management functions. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 2. In this situation. AlarmIRP is one example of the managed object. The NMS can access the point at any time according to your requirement and get CORBA reference of managed object in a managed system specified by IRPAgent. Function description and format are detailed in the introduction to the CORBA notification management function. exceptions can be detected as soon as possible.. 2. Issue 03 (2010-12-31) . that is. is released as a file. Getting EPIRP Versions l l Function description The NMS invokes get_EP_IRP_versions to get EPIRP versions. In addition.1 Interface Description of the Entry Point of the CORBA Interface This describes the functions of CORBA entry point. getting EPIRP notification profile. send a notification of entry point register information change to the NMS according to requirement.2 Notification Description of the Entry Point of the CORBA Interface When changes happen to the IRP information (for the EPIRP instance itself or other EPIRP instances that the EPIRP instance knows) saved in the entry point. Ltd.1 Entry Point of the CORBA Interface The entry point is the first object that IRPAgent accesses. that is. Function format ManagedGenericIRPConstDefs::VersionNumberSet get_EP_IRP_versions () raises (GetEPIRPVersions). 2. getting EPIRP operation profile. IOR is permanent. getting IRP reference. These functions consist of getting EPIRP versions. getting EPIRP operation profile. 2.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide 2. Huawei supports only one of the EPIRP versions. Object references of other IRPs are variable. There is no parameter in getting EPIRP versions. Support (Y/N) Y 2-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. AlarmIRP is one example of the managed object. these object references must be obtained again. getting IRP reference. getting EPIRP notification profile. Table 2-1 Values of getting EPIRP versions Returned Value VersionNumberSet Description Indicates a set of versions that the EPIRP supports. When IRPAgent is rebooted. These functions consist of getting EPIRP versions. and releasing IRP reference. The interoperable object reference (IOR). getting IRP outline. CORBA object reference of the entry point. the IP address of the server where IRPAgent is located is fixed and IOR is permanently effective.1. getting IRP outline.1.1 Interface Description of the Entry Point of the CORBA Interface This describes the functions of CORBA entry point.. The value of VersionNumberSet is a set of strings. The NMS can access the point at any time according to your requirement and get CORBA reference of managed object in a managed system specified by IRPAgent. and releasing IRP reference.1. M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-2 Exceptions of getting EPIRP version Exception GetEPIRPVersions Description Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Getting EP IRP Operation Profile l Function description NMS invokes get_EP_IRP_operations_profile to get the profile of operations supported by EPIRP. The version ID should be consistent with the version ID returned by Getting EPIRP Versions. Ltd. 2-3 . ManagedGenericIRPSystem::OperationNotSupported. ManagedGenericIRPSystem::InvalidParameter). Support (Y/N) Y Table 2-4 Values of getting EPIRP operation profile Returned Value MethodList Description Indicates the information list of operations the EPIRP supports.. Table 2-3 Parameters for getting EPIRP operation profile Parameter iRPVersion In/Out In Description Indicates the version ID of EPIRP in the EPIRP profile obtained by the NMS. l Function format ManagedGenericIRPConstDefs::MethodList get_EP_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetEPIRPOperationsProfile. The information list contains the following items: l Names of operations l Parameter lists Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-5 Exceptions of getting EPIRP operation profile Exception InvalidParameter OperationNotSupported GetEPIRPOperationsProfile Description Indicates that the given iRPVersion is invalid or null. Support (Y/N) Y Table 2-7 Values of getting EPIRP notification profile Returned Value MethodList Description Indicates the profile list of notifications that an EPIRP supports. Support (Y/N) Y N Y Getting EP IRP Notification Profile l Function description The NMS invokes get_EP_IRP_notification_profile to get the profile of the notification supported by EPIRP. Ltd. The profile list contains the following items: l Names of notifications supported by the EPIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) 2-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the exceptions caused by unknown reasons. Indicates that this operation is not supported. ManagedGenericIRPSystem::OperationNotSupported. ManagedGenericIRPSystem::InvalidParameter). Issue 03 (2010-12-31) Support (Y/N) Y . The version ID should be consistent with the version ID returned by Getting EPIRP Versions. Table 2-6 Parameters for getting EPIRP notification profile Parameter iRPVersion In/Out In Description Indicates the version information about EPIRP in the EPIRP outline gotten by the NMS.. l Function format ManagedGenericIRPConstDefs::MethodList get_EP_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetEPIRPNotificationProfile. If you plan to query the general information about the CS IRP. l Function format EPIRPConstDefs::ResultType get_IRP_outline ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion.. Ltd. the entered value is the complete IRP information. the Agent returns the outline of all EPIRPs.2. Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.0. Table 2-9 Parameters for getting IRP outline Parameter iRPVersion In/Out In Description Indicates the version information about EPIRP in the EPIRP outline gotten by the NMS.InvalidIRPVersion). Indicates that this operation is not supported. The parameter has the following two situations: l If this parameter is null. the input parameter is CS IRP V1. including this EPIRP instance itself. out EPIRPConstDefs::SupportedIRPListType supportedIRPList ) raises (GetIRPOutline. Support (Y/N) Y N Y Getting IRP Outline l Function description The NMS invokes get_IRP_outline to get the outline of the management domain Managed Object. l If this parameter is not null. Indicates the exceptions caused by unknown reasons.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-8 Exceptions of getting EPIRP notification profile Exception InvalidIRPVersion OperationNotSupported GetEPIRPNotificationProfile Description Indicates that the given iRPVersion is invalid or null. 2-5 . Support (Y/N) Y Y Table 2-11 Exceptions of getting IRP outline Exception InvalidIRPVersion GetIRPOutline Description Indicates that the given IRPVersion is invalid. Ltd. The list contains all IRP information in systemDn and IRPAgent. in EPIRPConstDefs::DNType systemDn. l Function format EPIRPConstDefs::ResultType get_IRP_reference ( in EPIRPConstDefs::ManagerIdentifierType managerIdentifier. Indicates that the operation fails.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter supportedIRPList In/Out Out Description Indicates the returned list of the IRP profile according to input parameter conditions. Issue 03 (2010-12-31) . The IRP information contains: l irpId l irpVersion l irpClassName l irpManagementScope The value of the parameter is of multinested structure. out string iRPReference 2-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.. Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Table 2-10 Values of getting IRP outline Returned Value OK FAILURE Description Indicates that the operation succeeds. in EPIRPConstDefs::IRPClassNameType irpClassName. in EPIRPConstDefs::IRPIdType irpId. Support (Y/N) Y Y Getting IRP Reference l Function description The NMS invokes get_IRP_reference to get the CORBA object reference specified in IRPAgent or the object reference of EPIRP. The character string is given by the NMS and is unique.. The value of this parameter should be consistent with the value of systemDn returned by Getting IRP Outline. systemDN In Indicates the DN value of IRPAgent obtained from the Agent system. 2-7 . an exception occurs. Huawei recommends that you use a unique value for the parameter in an NMS. Ltd. You can provide different values for managerIdentifier to invoke this operation. the reference is different. Y Y Y Y Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ManagedGenericIRPSystem::InvalidParameter). If the number of different values reaches five. The value of this parameter should be consistent with the class name of IRP returned by Getting IRP Outline. irpClassName In Indicates the class name of IRP obtained by the NMS. Table 2-12 Parameters for getting IRP reference Parameter managerIdentifier In/Out In Description Indicates a character string identifying Manager (NMS). The value of this parameter should be consistent with the value of irpId returned by Getting IRP Outline. irpId In Indicates irpId of IRP obtained by the NMS.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface ) raises ( GetIRPReference. iRPReference Out Indicates the CORBA object reference of IRP needed by the NMS. When you use a different managerIdentifier to get the same object of IRP. Support (Y/N) Y Y Table 2-14 Exceptions of getting IRP reference Exception InvalidParameter Description Indicates that the following parameters or their combination are invalid: l systemDN l irpId l irpClassName l managerIdentifier GetIRPReference Indicates the exceptions caused by unknown reasons. The parameter should be consistent with managerIdentifier specified in Getting IRP Reference. l Function format EPIRPConstDefs::ResultType release_IRP_reference( in EPIRPConstDefs::ManagerIdentifierType managerIdentifier. in string iRPReference ) raises ( ReleaseIRPReference. Indicates that the operation fails. Table 2-15 Parameters for releasing IRP reference Parameter managerIdentifier In/Out In Description Indicates a character string identifying the NMS. UnknownIRPReference). Ltd.. Y Support (Y/N) Y Releasing IRP Reference l Function description The NMS invokes release_IRP_reference to release the reference of a specified IRP that is not in use.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-13 Values of getting IRP reference Returned Value OK Failure Description Indicates that the operation succeeds. Support (Y/N) Y 2-8 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Issue 03 (2010-12-31) . When the object is released successfully through the Releasing IRP Reference interface. The reason is that iRPReference is not obtained by managerIdentifier through the operation Getting IRP Reference.. IOR of IRP to be released by the NMS. that is. send a notification of entry point register information change to the NMS according to requirement. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Ltd. The parameter should be consistent with iRPReference returned by Getting IRP Reference through relevant managerIdentifier. Y Support (Y/N) Y 2. Support (Y/N) Y Table 2-16 Values of releasing IRP reference Returned Value OK Failure Description Indicates that the operation succeeds. Support (Y/N) Y Y Table 2-17 Exceptions of releasing IRP reference Exception UnknownIRPReference Description Indicates that the specified iRPReference is invalid or the specified managerIdentifier does not match iRPReference.2 Notification Description of the Entry Point of the CORBA Interface When changes happen to the IRP information (for the EPIRP instance itself or other EPIRP instances that the EPIRP instance knows) saved in the entry point. ReleaseIRPReference Indicates the exceptions caused by unknown reasons. Indicates that the operation fails.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Parameter iRPReference In/Out In Description Indicates the CORBA object reference. 2-9 .1. Triggering Conditions l l Issue 03 (2010-12-31) When the newly obtained object reference is successful through the Getting IRP Reference interface. the IRP object instance.) Indicates the instances of MO that sends the notification. Notification Format Table 2-18 lists the format of the notification of entry point register information change. This parameter shows the version number of the associated IRP information model. The value of this parameter is defined by EPIRPNotifications::notifyIRPInfo Changes::ET_IRPINFO_CHANGE S. Indicates the name of an event. Indicates the DN value of the IRP when the information about the EP changes. Indicates the type of the reported notification.fixed_h eader. Issue 03 (2010-12-31) .2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide l When the IRPAgent system starts or stops. Indicates the identifier of the IRPAgent that generates notifications.event_ty pe header. that is.fixed_h eader. Indicates the time when an event occurs. Ltd. Indicates the notification identifier and is used to exclusively identify a notification. (This parameter is null. type_name string event_name e string string header.event_ty pe Description Indicates the name of a managed domain. Table 2-18 Format of the notification of entry point register information change Attribute Name domain_name Type string Domain header..fixed_h eader filterable_data a long remainder_of_ body filterable_data filterable_data b c TimeBase:: UtcT string IRP_DN string remainder_of_ body 2-10 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. . subscribing specified notifications. and order limitation. Function description and format are detailed in the introduction to the CORBA notification management function. getting notification categories. The change modes are as follows: l REGISTER A new object reference value is obtained. querying subscription IDs.2.2 Notification Management Function of the CORBA Interface The notification Management function of the CORBA interface is used for event reporting to the NMS and the management of order information. l MODIFY The IRPAgent system starts the object reference value. getting notificationIRP operation profile. Table 2-19 describes the notification management function of the CORBA interface. getting notificationIRP notification profile. 2. Ltd. MODIFY}. 2. 2-11 . Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.1 Introduction to Notification Management Function of the CORBA The notification management function of the CORBA interface is used for event reporting to the NMS. l DEREGISTER The IRPAgent system stops or releases an object reference. and querying parameters of specified subscription.2 Interface Description of the CORBA Notification Management This describes the CORBA notification management function that involves getting notificationIRP versions. order management. ADDITIONAL_T EXT string remainder_of_ body Indicates the additional description text added to the notification. NOTE CosNotification::PropertySeq is the value type of remainder_of_body.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Attribute Name CHANGE_MODE Type enum ChangeMod eType {REGISTE R. order management. 2.1 Introduction to Notification Management Function of the CORBA The notification management function of the CORBA interface is used for event reporting to the NMS. 2. Domain remainder_of_ body Description Indicates that the change modes of the EPIRP information. DEREGIST ER.2. changing subscription filter conditions. and order limitation. detaching notification subscription.2. IRPAgent automatically cancels the subscription of the object. If an object is invalid. The management includes the subscription period.2 Interface Description of the CORBA Notification Management This describes the CORBA notification management function that involves getting notificationIRP versions. Subscribing a maximum of eight notifications If the actual subscription number exceeds the maximum subscription number.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-19 Notification management function of the CORBA interface Scenario Enabling IRPAgent to report events to the NMS Description The NMS invokes the notification management interface to enable the NMS to receive the notification of CosNotifyComm::SequencePushConsumer that is defined by the CORBA specification IOR and the notification of integrating the CORBA specification. the NMS is recommended to actively invoke an interface to cancel the subscription before the CosNotifyComm::SequencePushConsumer is invalid. Managing subscribed notifications 2. IRPAgen check whether the currently subscribed CosNotifyComm::SequencePushConsumer object is valid. Ltd.2. an exception occurs. and querying parameters of specified subscription. getting notificationIRP operation profile. l Function format ManagedGenericIRPConstDefs::VersionNumberSet get_notification_IRP_versions () raises (GetNotificationIRPVersions). Issue 03 (2010-12-31) . The notification is sent to the NMS through the notification channel. querying subscription IDs. notification class. To ensure that all the subscribed notifications are valid. subscribing specified notifications. getting notificationIRP notification profile. If the CosNotifyComm::SequencePushConsumer object is invalid and need be subscribed again. Obtain the parameters irrelevant to the NotificationIRP version. IRPAgen can determine the validity by using the method of _non_existent provided by CORBA. and filter condition. getting notification categories. The NMS is recommended to actively cancel unneeded subscription.. changing subscription filter conditions. 2-12 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Getting Notification IRP Versions l Function description The NMS invokes get_notification_IRP_versions to get the NotificationIRP version information. detaching notification subscription. ManagedGenericIRPSystem::OperationNotSupported. l Function format ManagedGenericIRPConstDefs::MethodList get_notification_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber notification_irp_version ) raises ( GetNotificationIRPOperationsProfile. ManagedGenericIRPSystem::InvalidParameter). Table 2-22 Parameters for getting notificationIRP operation profile Parameter notification_irp_version In/Out In Description Indicates the NotificationIRP version ID in the NotificationIRP profile obtained by the NMS.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-20 Values of getting notificationIRP versions Returned Value VersionNumberSet Description Indicates a set of versions that the NotificationIRP supports. Ltd. Huawei supports only one of the NotificationIRP versions. The value of VersionNumberSet is a set of strings. 2-13 . Support (Y/N) Y Table 2-21 Exceptions of getting notificationIRP versions Exception GetNotificationIRPVersions Description Indicates the exceptions caused by unknown reasons. Suppor t (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.. Support (Y/N) Y Getting Notification IRP Operation Profile l Function description The NMS invokes get_notification_IRP_operations_profile to get the profile of operations supported by a specified version of NotificationIRP. The version ID should be consistent with the version ID returned by Getting Notification IRP Versions. The information list contains the following items: l Names of operations l Parameter lists Support (Y/N) Y Table 2-24 Exceptions of getting notificationIRP operation profile Exception InvalidParameter Description Indicates that the given notification_irp_version is invalid or null. ManagedGenericIRPSystem::InvalidParameter). Indicates that this operation is not supported. 2-14 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ManagedGenericIRPSystem::OperationNotSupported. Table 2-25 Parameters for getting notificationIRP notification profile Parameter notification_irp_version In/Out In Description Indicates the NotificationIRP version ID in the NotificationIRP profile obtained by the NMS. Ltd. Issue 03 (2010-12-31) Support (Y/N) Y . The version ID should be consistent with the version ID returned by Getting Notification IRP Versions.. Support (Y/N) Y OperationNotSupported GetEPIRPOperationsProfile N Y Getting Notification IRP Notification Profile l Function description The NMS invokes get_notification_IRP_notification_profile to get the profile of the notification supported by NotificationIRP.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-23 Values of getting notificationIRP operation profile Returned Value MethodList Description Indicates the information list of operations the NotificationIRP supports. l Function format ManagedGenericIRPConstDefs::MethodList get_notification_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber notification_irp_version ) raises ( GetNotificationIRPNotificationProfile. Indicates the exceptions caused by unknown reasons. . The profile list contains the following items: l Names of notifications supported by the NotificationIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) NOTE Notifications are not defined in the NotificationIRP. Support (Y/N) Y N Y Getting Notification Categories l Function description The NMS invokes get_notification_categories to query the notification categories supported by IRPAgent and the mapping notification types. ManagedGenericIRPSystem::OperationNotSupported). Indicates the exceptions caused by unknown reasons. 2-15 . Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Ltd. Table 2-27 Exceptions of getting notificationIRP notification profile Exception InvalidIRPVersion OperationNotSupported GetNotificationIRPNotificationProfile Description Indicates that the given notification_irp_version is invalid or null. Indicates that this operation is not supported. Function format NotificationIRPConstDefs::NotificationCategorySet get_notification_categories ( out NotificationIRPConstDefs::NotificationTypesSet notification_type_list ) raises ( GetNotificationCategories. l Table 2-28 Parameters for getting notification categories Parameter notification_type_list In/Out Out Description Indicates the list of notification types that map to notification categories.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-26 Values of getting notificationIRP notification profile Returned Value Description Suppo rt (Y/ N) Y MethodList Indicates the profile list of notifications that an NotificationIRP supports. in ManagedGenericIRPConstDefs::StringTypeOpt filter ) raises ( Attach. ManagedGenericIRPSystem::InvalidParameter. Function format NotificationIRPConstDefs::SubscriptionId attach_push ( in string manager_reference. ManagedGenericIRPSystem::ParameterNotSupported. Subscribing Specified Notifications l l Function description The NMS invokes attach_push to subscribe notifications of specified categories.. 2-16 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the exceptions caused by unknown reasons. in unsigned long time_tick. in NotificationIRPConstDefs::NotificationCategorySet notification_categories. AtLeastOneNotificationCategoryNotSupported). AlreadySubscribed. Issue 03 (2010-12-31) . Each element in this set specifies a notification category.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-29 Values of getting notification categories Returned Value NotificationCategorySet Description Indicates the set of notification categories supported by IRPAgent. Ltd. Suppor t (Y/N) Y Table 2-30 Exceptions of getting notification categories Exception Description Suppo rt (Y/ N) N Y OperationNotSupported GetNotificationCategories Indicates that this operation is not supported. Ltd. that is. Set the value of the timer according to the following two situations: l If you enter a value between 1 and 15. After this timer expires. the timer is set to 15. manager_reference invokes the push operation. no new subscriptions are received. the NMS invokes Querying Parameters of Specified Subscription periodically to refresh the timer to ensure that the relevant channel is not released. the subscribed notification is detached to release the notification channel resources.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-31 Parameters for subscribing specified notifications Parameter manager_reference In/Out In Description Identifies the event receiver at the NMS side. the parameter value should be CosNotifyComm::SequencePushConsumer.. l If you enter null or 0. Normally. Y Suppor t (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The unit for this parameter is minute. The IRPAgent uses the event channel to transfer the NMS an event information. the timer is set to the entered value. l If you enter a value more than 15 (included). the timer never expires. For IOR. When the subscribed number exceeds eight. time_tick In Indicates a timer. 2-17 . infer that all the notification categories supported by IRPAgent are subscribed. l If notification_categories is null. Y Table 2-32 Values of subscribing specified notifications Returned Value SubscriptionId Description Identifies the notification subscription. l If all the notification classes are subscribed. Suppor t (Y/N) Y filter In Defines the filter condition for the notification subscription. For the repeated subscription of manager_reference. If all the notification classes are subscribed in the set. Issue 03 (2010-12-31) . refer to 7. For details of the syntax. Support (Y/ N) Y 2-18 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. infer that conditions defined by notification_categories have no extra restrictions. Ltd. The NMS can uniquely identify a subscription record by using this value.1 Notification filter Description. there must be a notification class that is not subscribed in the parameter-defined set. infer that all the notification classes unsubscribed by manager_reference need be subscribed.. an AlreadySubscribed exception is displayed. Each element in the set should be an element of the notification category returned by Getting Notification Categories. The parameter is set based on all notification categories defined by notification_categories.1. an AlreadySubscribed exception is displayed. If the set is null. If this parameter is valued null.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter notification_categories In/Out In Description Defines the set of notifications to be filtered. 2-19 Support (Y/N) Y subscription_id In Y . Support (Y/ N) Y ParameterNotSupported InvalidParameter AtLeastOneNotificationCategoryNotSupported Attach N Y Y Y Detaching Notification Subscription l l Function description The NMS invokes detach to detach the notification subscription. ManagedGenericIRPSystem::ParameterNotSupported. Function format void detach ( in string manager_reference. Indicates the exceptions caused by unknown reasons. ManagedGenericIRPSystem::InvalidParameter). infer that all notifications earlier subscribed by manager_reference are detached..M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-33 Exceptions of subscribing specified notifications Exception AlreadySubscribed Description Indicates that the notifications defined by notification_categories are already subscribed by the manager_reference receiver. Ltd. If this parameter is null. The parameter should be consistent with manager_reference specified in Subscribing Specified Notifications. in NotificationIRPConstDefs::SubscriptionId subscription_id) raises ( DetachException. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates that this parameter is incorrect or that the parameter notification_categories is invalid. Indicates that this parameter is incorrect or that its format is incorrect. Table 2-34 Parameters for detaching notification subscription Parameter manager_reference In/Out In Description Indicates the identifier of the event receiver at the home NMS that is going to detach the notification subscription. Indicates that this parameter is not supported. Indicates the unique identifier of the notification subscription. Table 2-37 Values of changing subscription filter conditions Returned Value 2-20 Description - Suppor t (Y/N) Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. in string filter) raises ( ChangeSubscriptionFilter. . ManagedGenericIRPSystem::OperationNotSupported. Table 2-36 Parameters for changing subscription filter conditions Parameter subscription_id filter In/Out In In Description Indicates the unique identifier of the notification subscription. Ltd.1.1 Notification filter Description.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Retract the subscription of the parameters having no values. Suppor t (Y/N) Y Y NOTE For details of the syntax of filter. Support (Y/N) Y ParameterNotSupported DetachException N Y Changing Subscription Filter Conditions l l Function description The NMS invokes change_subscription_filter to change the subscription filter conditions. Alternatively. Indicates the subscription of filter conditions.. Table 2-35 Exceptions of detaching notification subscription Exception InvalidParameter Description Indicates that the specified parameter manager_reference. Indicates that this parameter is not supported. ManagedGenericIRPSystem::InvalidParameter). refer to 7. Function format void change_subscription_filter ( in NotificationIRPConstDefs::SubscriptionId subscription_id. the notification subscription identified by subscription_id is not subscribed by manager_reference. Indicates the exceptions caused by unknown reasons. subscription_id or their combination is invalid. If a specified manager_reference is valid but not subscribed. Querying Subscription IDs l Function description The NMS invokes get_subscription_ids to query all subscription IDs related to a specified manager_reference. l Function format NotificationIRPConstDefs::SubscriptionIdSet get_subscription_ids ( in string manager_reference ) raises ( GetSubscriptionIds. 2-21 Support (Y/N) Y .. Ltd. Table 2-39 Parameters for querying subscription IDs Parameter manager_reference In/Out In Description Indicates the identifier of the event receiver to be queried at the NMS side. ManagedGenericIRPSystem::OperationNotSupported. Indicates that this operation is not supported. ManagedGenericIRPSystem::InvalidParameter). the returned list is null. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the exceptions caused by unknown reasons. The parameter should be consistent with the specified manager_reference given by Subscribing Specified Notifications.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-38 Exceptions of changing subscription filter conditions Exception Description Suppo rt (Y/ N) Y N Y InvalidParameter OperationNotSupported ChangeSubscriptionFilter Indicates that the subscription_id or filter is invalid or null. Support (Y/N) Y Table 2-40 Values of querying subscription IDs Returned Value SubscriptionIdSet Description Indicates the set of all subscription IDs related to manager_reference. 2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-41 Exceptions of querying subscription IDs Exception InvalidParameter OperationNotSupported GetSubscriptionIds Description Indicates that the manager_reference is invalid. Indicates that this operation is not supported. Indicates the exceptions caused by unknown reasons. Support (Y/N) Y N Y Querying Parameters of Specified Subscription l Function description The NMS invokes get_subscription_status to query parameters of a specified subscription, including subscription parameters and subscription statuses. l Function format NotificationIRPConstDefs::NotificationCategorySet get_subscription_status ( in NotificationIRPConstDefs::SubscriptionId subscription_id, out ManagedGenericIRPConstDefs::StringTypeOpt filter_in_effect, out NotificationIRPConstDefs::SubscriptionState subscription_state, out unsigned long time_tick ) raises ( GetSubscriptionStatus, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-42 Parameters for querying specified subscription parameters Parameter subscription_id time_tick filter_in_effect subscription_state In/Out In Out Out Out Description Indicates the unique identifier of the notification subscription. Indicates the value for invoking attach_push. Indicates the filter condition used by the current subscription. Indicates the status of the current subscription, including: l Active l Suspended Because the Suspended status is not supported, only the Active status exists. Support (Y/N) Y Y Y Y 2-22 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. Issue 03 (2010-12-31) M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-43 Values of querying specified subscription parameters Returned Value NotificationCategorySet Description Indicates the set of notification categories supported by the current subscription. Support (Y/N) Y Table 2-44 Exceptions of querying specified subscription parameters Exception InvalidParameter OperationNotSupported GetSubscriptionStatus Description Indicates that the subscription_id is invalid. Indicates that the operation is not supported. Indicates the exceptions caused by unknown reasons. Support (Y/N) Y N Y 2.3 Communication Surveillance Function of the CORBA Interface The communication surveillance interface function provides a mechanism to monitor the status of communication channels between the NMS and IRPAgent. In this situation, exceptions can be detected as soon as possible. The NMS monitors communication channels using the following two ways: l l By setting a heartbeat interval, the NMS can receive heartbeat notifications to monitor the status of communication channels between the NMS and IRPAgent. The NMS actively invoke IRPAgent to trigger the heartbeat interface to query the status of communication channels. 2.3.1 Interface Description of the CORBA Communication Surveillance The CORBA communication surveillance involves getting CSIRP versions, getting CSIRP operation profile, getting CSIRP notification profile, getting heartbeat period, setting heartbeat period, and triggering heartbeat notifications. 2.3.2 Heartbeat Notification of the CORBA Communication Surveillance When the heartbeat period is up, IRPAgent sends a heartbeat notification accordingly to the NMS. 2.3.1 Interface Description of the CORBA Communication Surveillance The CORBA communication surveillance involves getting CSIRP versions, getting CSIRP operation profile, getting CSIRP notification profile, getting heartbeat period, setting heartbeat period, and triggering heartbeat notifications. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 2-23 2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Getting CSIRP Versions l l Function description The NMS invokes get_CS_IRP_versions to get the CSIRP version information. Function format ManagedGenericIRPConstDefs::VersionNumberSet get_CS_IRP_versions () raises (GetCSIRPVersions); There is no parameter in getting CSIRP versions. Table 2-45 Values of getting CSIRP versions Returned Value VersionNumberSet Description Support (Y/N) Indicates a set of versions that the Y EPIRP supports. The value of VersionNumberSet is a set of strings. Huawei supports only one of the EPIRP versions. Table 2-46 Exceptions of getting CSIRP versions Exception GetCSIRPVersions Description Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Getting CSIRP Operation Profile l Function description The NMS invokes get_CS_IRP_operations_profile to get the profile of operations supported by a specified version of CSIRP. l Function format ManagedGenericIRPConstDefs::MethodList get_CS_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetCSIRPOperationsProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-47 Parameters for getting CSIRP operation profile Parameter iRPVersion In/Out In Description Indicates the version ID of CSIRP in the profile obtained by the NMS. The version ID should be consistent with the version ID returned by Getting CSIRP Versions. Support (Y/N) Y 2-24 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. Issue 03 (2010-12-31) l Function format ManagedGenericIRPConstDefs::MethodList get_CS_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetCSIRPNotificationProfile. The information list contains the following items: l Names of operations l Parameter lists Support (Y/N) Y Table 2-49 Exceptions of getting CSIRP operation profile Exception InvalidParameter OperationNotSupported GetCSIRPOperationsProfile Description Indicates that iRPVersion is invalid or null. 2-25 . Ltd. ManagedGenericIRPSystem::OperationNotSupported. Indicates that this operation is not supported.. The version ID should be consistent with the version ID returned by Getting CSIRP Versions. Table 2-50 Parameters for getting CSIRP notification profile Parameter iRPVersion In/Out In Description Indicates the version ID of CSIRP in the profile obtained by the NMS. Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ManagedGenericIRPSystem::InvalidParameter).M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-48 Values of getting CSIRP operation profile Returned Value MethodList Description Indicates the information list of operations the CSIRP supports. Support (Y/N) Y N Y Getting CSIRP Notification Profile l Function description The NMS invokes get_CS_IRP_notification_profile to get the profile of notifications supported by a specified version of CSIRP. The value 0 is also valid and 0 means that the interval for sending heartbeat notifications is not set. l Function format CSIRPConstDefs::ResultType get_heartbeat_period( out CSIRPConstDefs::HeartbeatPeriodType heartbeatPeriod ) raises (GetHeartbeatPeriod). that is. the heartbeat period. The profile list contains the following items: l Names of notifications supported by the CSIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) Support (Y/N) Y Table 2-52 Exceptions of getting CSIRP notification profile Exception InvalidIRPVersion OperationNotSupported GetCSIRPNotificationProfile Description Indicates that the iRPVersion is invalid or null. Support (Y/N) Y N Y Getting Heartbeat Period l Function description The NMS invokes get_heartbeat_period to get the interval for sending heartbeat notifications. Issue 03 (2010-12-31) Support (Y/N) Y . Indicates that this operation is not supported. Table 2-53 Parameters for getting heartbeat period Parameter heartbeatPeriod In/Out Out Description Indicates the interval for which IRPAgent reports heartbeat notifications periodically to the NMS (unit: minute). Indicates the exceptions caused by unknown reasons. Ltd.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-51 Values of getting CSIRP notification profile Returned Value MethodList Description Indicates the profile list of notifications that a CSIRP supports.. 2-26 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Value range: 5 to 60 The default value is 5. Support (Y/N) Y Setting Heartbeat Period l Function description The NMS invokes set_heartbeat_period to set the interval for Agent to send heartbeat notifications. ManagedGenericIRPSystem::ValueNotSupported. Whenever the heartbeatPeriod attribute changes. 2-27 Support (Y/N) Y .M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-54 Values of getting heartbeat period Returned Value Success Failure Description Indicates that this operation succeeds. Ltd. the Agent sends a heartbeat notification with the new heartbeat period immediately to all the NMS that have subscribed this notification.. Table 2-56 Parameters for setting heartbeat period Parameter heartbeatPeriod In/Out In Description Indicates the heartbeat period. InvalidHeartbeatPeriod. Support (Y/N) Y Y Table 2-55 Exceptions of getting heartbeat period Exception GetHeartbeatPeriod Description Indicates the exceptions caused by unknown reasons. Indicates that this operation fails. The changed heartbeat period (unit: minute). failure is returned for this operation. ConflictingHeartbeatPeriod. l Function format CSIRPConstDefs::ResultType set_heartbeat_period( in CSIRPConstDefs::HeartbeatPeriodType heartbeatPeriod ) raises ( SetHeartbeatPeriod. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. If the changed heartbeat period is the same in value as the old one. If the heartbeat period is changed to 0. Value range: 5 to 60 The value 0 is also valid. the Agent sends a notification informing about the change and sends no more heartbeat notifications later unless this value is changed to another different value. ManagedGenericIRPSystem::OperationNotSupported). Support (Y/N) Y Y N N Y Triggering Heartbeat Notifications l Function description The NMS invokes trigger_heartbeat to trigger a heartbeat notification..2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 2-57 Values of setting heartbeat period Returned Value Success Failure Description Indicates that this operation succeeds. This does not affect the normal heartbeat notifications sent periodically by IRPAgent. Indicates that this operation is not supported. Indicates that this operation fails. Issue 03 (2010-12-31) . The NMS can perform this operation to actively query the communication state with IRPAgent. InvalidManagerIdentifier). 2-28 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. IRPAgent sends immediately a heartbeat notification and indicates in the notification that this notification is triggered by the NMS. Support (Y/N) Y Y Table 2-58 Exceptions of setting heartbeat period Exception InvalidHeartbeatPeriod ConflictingHeartbeatPeriod ValueNotSupported OperationNotSupported SetHeartbeatPeriod Description Indicates that the specified heartbeat period is invalid. When receiving this operation. Indicates that the specified parameter is not supported. Indicates the exceptions caused by unknown reasons. Ltd. l Function format CSIRPConstDefs::ResultType trigger_heartbeat( in CSIRPConstDefs::ManagerIdentifierType managerIdentifier ) raises (TriggerHeartbeat. Indicates that the specified heartbeat period is the same as the current value. Ltd. the NMS should be active to subscribe the heartbeat notification. When the sent heartbeat notification is triggered by the NMS. Indicates the exceptions caused by unknown reasons. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 2-29 Issue 03 (2010-12-31) . Triggering Conditions l l The heartbeat interval set by the NMS is not 0 and the interval time is up. Suppor t (Y/N) Y Y Table 2-61 Exceptions of triggering heartbeat notifications Exception InvalidManagerIdentifier TriggerHeartbeat Description Indicates that managerIdentifier is invalid. it does not affect the original heartbeat period.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Table 2-59 Parameters for triggering heartbeat notifications Parameter managerIdentifier In/Out In Description Indicates the identifier of the NMS triggering the heartbeat notification. If the NMS expects a heartbeat notification. the parameter must get the object reference of CSIRP through the Getting IRP Reference interface.2 Heartbeat Notification of the CORBA Communication Surveillance When the heartbeat period is up. Suppor t (Y/N) Y Y 2.. IRPAgent sends a heartbeat notification accordingly to the NMS. The parameter is a character string. Indicates that this operation fails. The NMS successfully resets the heartbeat by performing the Setting Heartbeat Period operation. In addition. Suppor t (Y/N) Y Table 2-60 Values of triggering heartbeat notifications Returned Value Success Failure Description Indicates that this operation succeeds.3. Ltd. Issue 03 (2010-12-31) . event_name e string string header. a long remainder_of_b ody filterable_data filterable_data b c TimeBase:: UtcT string HEARTBEAT_P ERIOD unsigned short remainder_of_b ody 2-30 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. IRPAgent begins to count the heartbeat period again.fixed_he ader. (This parameter is null..event_type Indicates the type of the reported heartbeat notification notifyHeartbeat. This parameter shows the version number of the associated IRP information model. type_name string header.2 Common Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide l The NMS successfully passes the Triggering Heartbeat Notifications operation. Indicates the time when the event occurs.event_type Description Indicates the name of a managed domain.fixed_he ader filterable_data Indicates the name of an event. NOTE After sending a heartbeat notification. Indicates the notification identifier and is used to exclusively identify a notification. Indicates the identifier of the IRPAgent that generates notifications. the CSIRP object instance. The value of this parameter is defined by CSIRPNotifications::notifyHeartbea t::EVENT_TYPE. Indicates the heartbeat interval. Notification Format Table 2-62 lists the format of the heartbeat notification.) Indicates the instances of MO that sends the notification.fixed_he ader. Because the NMS may modify the heartbeat interval. Table 2-62 Format of the heartbeat notification Attribute Name domain_name Type string Domain header. that is. the attribute is used to indicate the currently defined interval. The attribute is valued as ENUM {IRPManager. the value of the parameter is the same as that for the triggerHeartbeat operation. Ltd. NOTE CosNotification::PropertySeq is the value type of remainder_of_body. the value of the parameter is null.M2000 Northbound CORBA Interface Developer Guide 2 Common Management Function of the CORBA Interface Attribute Name TRIGGER_FLA G Type ENUM {IRPMana ger. CHANNEL_ID string remainder_of_b ody The channel identifier of the OMG notification service. MANAGER_IDE NTIFIER remainder_of_b ody l If triggerFlag is IRPManager.. l If triggerFlag is IRPAgent. 2-31 . IRPAgent}. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. IRPAgent } string Domain remainder_of_b ody Description Indicates whether the notification is normal or triggered by IRPManager. . 2 Common Configuration Management of the CORBA Common configuration has the function of actively reporting the change of a configuration object. 3. Huawei only supports the interface of querying configuration managed objects. The NMS can use the interfaces to manage configuration managed objects. 3. create. or requests the NMS to synchronize the configuration.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface 3 Configuration Management Function of the CORBA Interface About This Chapter The configuration management interface has the following three functions: BasicCMIRP. network resource model (NRM). and modify the interfaces of configuration managed objects. KernelCMIRP actively sends a notification to the NMS for managing configuration objects. delete.1 Getting to Know Configuration Management of the CORBA Interface This describes the concepts of the managed object (MO). Ltd. 3. You can query.. KernelCMIRP.3 Function and Interface of Basic Configuration Management of the CORBA BasicCMIRP provides interface operations for configuration managed objects. distinguished name (DN). deleted. 3-1 . and relative distinguished name (RDN). Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. and BulkCMIRP. or modified. When a configuration object needs to be created. which consists of a prefix and a set of RDNs. Ltd. distinguished name (DN).. An MO is also a network resource that can be managed.2 Description of DN String. For details about the DN syntax. It is an instance of a managed object class (MOC) that is defined in the network resource. 3-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. DN and RDN A DN is the unique identification of an MO.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide 3. is a model of the actual network resource that is managed. Issue 03 (2010-12-31) . which is provided by IRPAgent. Managed Object (MO) An MO is an abstract entity that can be accessed through an open interface in two or more systems.1 Getting to Know Configuration Management of the CORBA Interface This describes the concepts of the managed object (MO). Network Resource Model (NRM) An NRM. and relative distinguished name (RDN). network resource model (NRM). see 7. It includes MOCs and their relevant attributes and operations. org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Schema/ServiceConfig. KernelCMIRP actively sends a notification to the NMS for managing configuration objects. 1. or modified. or requests the NMS to synchronize the configuration.1 Interface Description of the Common Configuration Management of the CORBA This describes the common configuration management of the CORBA interface.xml If the following information is displayed in the beginning of the file.0 Begin to modify the value of subNetworkId in the CvtDef_Omc. 3-3 ..sh 3. notifyObjectDeletion. getting KernelCMIRP notification profile. . you can infer that SubNetworkId is changed to 2 successfully. Run the following command to check the modification result: # cat /export/home/omc/var/etc/IRPService/itf_n_config. you can infer that IRPService is running properly. you can perform the following steps to modify SubNetworkId of a DN to identify the data reported by each M2000. Current Corba Interface is CorbaNBI NBIV1. Run the environment variable script.xml . getting KernelCMIRP operation profile. 3. The common configuration management involves getting KernelCMIRP versions.2.xml .. deleted. run the following command to view the running status of the service and ensure that it is running properly: # svc_adm -cmd status | grep IRPService If the system displays the following information. IRPService [running ] 5. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. When a configuration object needs to be created.M2000 Northbound CORBA Interface Developer Guide NOTE 3 Configuration Management Function of the CORBA Interface When an NMS manages a network through multiple M2000s. Run the following command to restart IRPService: # svc_adm -cmd restartsvc IRPService After the service is restarted. By default. <SubNetwork xmlns:xsi="http://www. The default installation directory of the M2000 server is /opt/OMC.xsd" subNetworkId="2" dnPrefix="www. you can infer that SubNetworkId is already changed to 2. Modify success! Please Restart IRPService! 4.2 Common Configuration Management of the CORBA Common configuration has the function of actively reporting the change of a configuration object. # modify_SubNetworkId. This part takes changing SubNetworkId to 2 for example. Run the following command to navigate to the installation directory of the M2000 server. 3./svc_profile..w3. run the following command: # cd /opt/OMC 2.2. Ltd.sh 2 If the system displays the following information. notifyCMSynchronizationRecommended in the common configuration management of the CORBA interface. # ..com"> 3. and getting NRM versions. notifyAttributeValueChange. Begin to modify the value of subNetworkId in the itf_n_config. Run the following command to modify SubNetworkId.huawei..2 Notification Description of the Common Configuration Management of the CORBA The part describes the notifyObjectCreation.2. 3-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The common configuration management involves getting KernelCMIRP versions. and getting NRM versions.. ManagedGenericIRPSystem::InvalidParameter). Getting KernelCMIRP Versions l Function description The NMS invokes get_kernel_CM_IRP_versions to get the KernelCMIRP version information. l Function format ManagedGenericIRPConstDefs::VersionNumberSet get_kernel_CM_IRP_versions () raises (GetKernelCMIRPVersionsException). Support (Y/N) Y Table 3-2 Exceptions of getting KernelCMIRP versions Exception GetKernelCMIRPVersionsException Description Indicates the exceptions caused by unknown reasons. Table 3-1 Values of getting KernelCMIRP versions Returned Value VersionNumberSet Description Indicates a set of versions that the KernelCMIRP supports. Huawei supports only one of the KernelCMIRP versions. getting KernelCMIRP notification profile.1 Interface Description of the Common Configuration Management of the CORBA This describes the common configuration management of the CORBA interface. Ltd.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide 3. l Function format ManagedGenericIRPConstDefs::MethodList get_kernel_CM_IRP_operation_profile( in ManagedGenericIRPConstDefs::VersionNumber kernel_CM_IRP_version ) raises ( GetKernelCMIRPOperationProfileException. ManagedGenericIRPSystem::OperationNotSupported. There is no parameter in getting KernelCMIRP versions. Support (Y/N) Y Getting KernelCMIRP Operation Profile l Function description The NMS invokes get_kernel_CM_IRP_operation_profile to get the profile of operations supported by a specified version of KernelCMIRP. getting KernelCMIRP operation profile. Issue 03 (2010-12-31) .2. The value of VersionNumberSet is a set of strings. . Indicates that the operation is not supported.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Table 3-3 Parameters for getting KernelCMIRP operation profile Parameter kernel_CM_IRP_version In/Out In Description Indicates the KernelCMIRP version information in the IRP profile obtained by the NMS. 3-5 . l Function format ManagedGenericIRPConstDefs::MethodList get_kernel_CM_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber kernel_CM_IRP_version ) raises ( Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Support (Y/N) Y OperationNotSupported GetKernelCMIRPOperationProfileException N Y Getting KernelCMIRP Notification Profile l Function description The NMS invokes get_kernel_CM_IRP_notification_profile to get the profile of notifications supported by KernelCMIRP. The information list contains the following items: l Names of operations l Parameter lists Support (Y/N) Y Table 3-5 Exceptions of getting KernelCMIRP operation profile Exception InvalidParameter Description Indicates that the kernel_CM_IRP_version is invalid or null. Suppor t (Y/N) Y Table 3-4 Values of getting KernelCMIRP operation profile Returned Value MethodList Description Indicates the information list of operations that the FileTransferIRP supports. Ltd. The version ID should be consistent with the version ID returned by Getting kernel CMIRP Versions. Indicates the exceptions caused by unknown reasons. Table 3-6 Parameters for getting KernelCMIRP notification profile Parameter kernel_CM_IRP_version In/Out In Description Indicates the KernelCMIRP version information in the IRP profile obtained by the NMS. Indicates that the operation is not supported. Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Table 3-7 Values of getting KernelCMIRP notification profile Returned Value MethodList Description Indicates the profile list of notifications that an KernelCMIRP supports. Support (Y/N) Y OperationNotSupported GetKernelCMIRPNotificationProfileException N Y Getting NRMIRP Versions l 3-6 Function description Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide GetKernelCMIRPNotificationProfileException. Ltd. ManagedGenericIRPSystem::InvalidParameter).. Issue 03 (2010-12-31) . ManagedGenericIRPSystem::OperationNotSupported. The version ID should be consistent with the version ID returned by Getting kernel CMIRP Versions. The profile list contains the following items: l Names of notifications supported by the KernelCMIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) Suppor t (Y/N) Y Table 3-8 Exceptions of getting KernelCMIRP notification profile Exception InvalidIRPVersion Description Indicates that the given kernel_CM_IRP_version is invalid or null. . Accordingly. the parameter versionNumberList lists information about the extended version. the parameter versionNumberList lists the version information about standard specifications that work as the extension basis. Ltd. In this situation.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface The NMS invokes get_NRM_IRP_version to get the version of NRM supported by IRPAgent. The version information has the following three parts: l Version information about standard specifications which work as the basis l Unique ID of the manufacturer l Version information about the extended NRM of this manufacturer Y Support (Y/N) Y There is no value in getting NRMIRP versions. l Function format void get_NRM_IRP_version ( out ManagedGenericIRPConstDefs::VersionNumberSet versionNumberList. Table 3-10 Exceptions of getting NRMIRP versions Exception GetNRMIRPVersion Description Indicates the exceptions caused by unknown reasons. Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. out ManagedGenericIRPConstDefs::VersionNumberSet vSEVersionNumberList ) raises (GetNRMIRPVersion). This NRM is the extension on existing specifications. The NRM has the following types: l Common NRM l Wireless access NRM l Core network NRM vSEVersionNumberList Out Indicates the unique version of the extended NRM supported by Agent. 3-7 . Table 3-9 Parameters for getting NRMIRP versions Parameter versionNumberList In/Out Out Description Indicates the version of the NRMs supported by Agent. send the notifyObjectCreation notification. Indicates the type of the reported notification. Issue 03 (2010-12-31) . Indicates the notification identifier and is used to exclusively identify a notification.) Indicates the instances of MO that sends the notification. that is.fixed_he ader. add an MO at the NMS side according to e and ATTRIBUTE_LIST in the notification.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide 3. that is.event_type Description Indicates the name of a managed domain. – The OMC adds a management NE. Ltd. l Triggering conditions – An NE adds a configuration managed object. l Notification format Table 3-11 lists the format of the notifyObjectCreation notification. (This parameter is null. notifyObjectCreation When a configuration managed object is added.fixed_he ader. notifyAttributeValueChange. The value is defined by KernelCmNotifications::MO Creation::EVENT_TYPE. notifyCMSynchronizationRecommended in the common configuration management of the CORBA interface. the notifyObjectCreation notification.2 Notification Description of the Common Configuration Management of the CORBA The part describes the notifyObjectCreation. You need to not query configuration managed objects by querying an interface. This parameter shows the version number of the associated IRP information model. notifyObjectDeletion.event_type a long remainder_of_b ody 3-8 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Table 3-11 Notification of notifyObjectCreation Attribute Name domain_name Type string Domain header. the DN of the new MO instances.2. After the NMS receives the notification.. type_name string header. event_name e string string header.fixed_he ader filterable_data Indicates the name of an event. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. l Management_operation The notification is triggered by an NMS operation delivered from Manager. Indicates the additional text related to the notification.. Indicates the identifier of the IRPAgent that generates notifications.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Attribute Name b c Type TimeBase: :UtcT string Domain filterable_data filterable_data Description Indicates the time when the event occurs. Ltd. delete the corresponding object or its sub-object at the NMS side according to the e field in the notification. After the NMS receives the notification. 3-9 . l Unknown The cause for triggering the notification is unknown. ADD_TEXT SOURCE string string remainder_of_b ody remainder_of_b ody ATTRIBUTE_LIST KernelCm Notificatio ns::MOCre ation::Initi alAttribute Values remainder_of_b ody Indicates the attribute list of a new object. Indicates the indicator of the source operation that triggers this notification. The value of the attribute may be one of the following values: l Resource_operation This notification is triggered by an operation on the managed resources. The list includes: l Attribute name l Value NOTE CosNotification::PropertySeq is the value type of remainder_of_body. notifyObjectDeletion The notifyObjectDeletion notification is sent when an MO is deleted. l Notification format Table 3-12 lists the format of the notifyObjectDeletion notification.fixed_h eader filterable_data Indicates the name of an event..) Indicates the instances of MO that sends the notification. This parameter shows the version number of the associated IRP information model. the DN of the deleted MO instances.fixed_h eader. The value is defined by KernelCmNotifications::MODeleti on::EVENT_TYPE. – The OMC deletes the configuration of an NE. Table 3-12 Notification of notifyObjectDeletion Attribute Name domain_name Type string Domain header. type_name string a long remainder_of_ body filterable_data filterable_data b c TimeBase:: UtcT string ADD_TEXT string remainder_of_ body 3-10 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.fixed_h eader. Ltd.event_ty pe header. Indicates the time when the event occurs. Indicates the notification identifier and is used to exclusively identify a notification.3 Configuration Management Function of the CORBA Interface NOTE M2000 Northbound CORBA Interface Developer Guide The e field in the notification is the base object of the object to be deleted. Issue 03 (2010-12-31) . that is. Indicates the additional text related to the notification. Indicates the identifier of the IRPAgent that generates notifications. event_name e string string header. (This parameter is null. The sub-object does not send the notifyObjectDeletion notification. Indicates the type of the reported notification. that is.event_ty pe Description Indicates the name of a managed domain. l Triggering condition – A configuration object of an NE is deleted. the notifyObjectDeletion notification. ATTRIBUTE_ LIST KernelCmN otifications:: MODeletion ::AttributeV alues remainder_of_ body Indicates the attribute list of an object to be deleted. Ltd. 3-11 . Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. l Unknown The cause for triggering the notification is unknown.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Attribute Name SOURCE Type string Domain remainder_of_ body Description Indicates the indicator of the source operation that triggers this notification. The list includes: l Attribute name l Value NOTE CosNotification::PropertySeq is the value type of remainder_of_body. modify the MO in the NMS according to e and ATTRIBUTE_LIST in the notification. notifyAttributeValueChange The notifyAttributeValueChange notification is sent when an MO is modified. l Triggering condition – Attributes of a configuration object at an NE side are modified. l Notification format Table 3-13 lists the format of the notifyAttributeValueChange notification. The value of the attribute may be one of the following values: l Resource_operation This notification is triggered by an operation on the managed resources.. l Management_operation The notification is triggered by an NMS operation delivered from Manager. – Attribute values of an NE managed by the OMC are changed. After the NMS receives the notification. The value if defined by KernelCmNotifications::AttributeValu eChange::EVENT_TYPE.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 3-13 Notification of notifyAttributeValueChange Attribute Name domain_name Type string Domain header. Indicates the additional text related to the notification. the DN of the modified MO. that is. Ltd. Indicates the notification identifier and is used to exclusively identify a notification.e vent_type header.fixe d_header filterable_d ata remainder_ of_body filterable_d ata filterable_d ata remainder_ of_body remainder_ of_body Indicates the name of an event. (This parameter is null.. that is. Indicates the identifier of the IRPAgent that generates notifications. l Management_operation The notification is triggered by an NMS operation from Manager. Indicates the time when the event occurs. event_name e string string header. l Unknown The cause for triggering the notification is unknown.e vent_type Description Indicates the name of a managed domain. Indicates the type of the reported notification.fixe d_header. The value of the attribute may be one of the following values: l Resource_operation This notification is triggered by an operation on the managed resources. Indicates the indicator of the source operation that triggers this notification. the notifyAttributeValueChange notification. type_name string a long b c ADD_TEXT SOURCE TimeBase:: UtcT string string string 3-12 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. This parameter shows the version number of the associated IRP information model.) Indicates the instances of MO that sends the notification. Issue 03 (2010-12-31) .fixe d_header. the notification is sent.event_type Description Indicates the name of a managed domain. NOTE Both the notification of creating the ManagedElement object and the notification of synchronizing configuration information are sent. the NMS can synchronize configuration data of IRPAgent according to the BASE_MOI field and the SCOPE field in the notification. This parameter shows the version number of the associated IRP information model. Indicates the type of the reported notification. event_name string header. Ltd. l Attribute values after the change.fixed_he ader Indicates the name of an event.) 3-13 type_name string header. For example. l Attribute values before the change (optional). that is. l Triggering condition – The OMC adds a management NE. The list includes: l Attribute name.fixed_he ader. After the NMS receives the notification.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Attribute Name MODIFIED_A TTRIBUTE_S ET Type KernelCm Notificatio ns::Attribut eValueCha nge::Modif iedAttribut eSet Domain remainder_ of_body Description Indicates the list of the changed object attributes. The value is defined by KernelCmNotifications::CMSynchr onizationRecommended::EVENT_ TYPE. start a timing task to synchronize at 00:00 every day.. notifyCMSynchronizationRecommended When configuration information is modified greatly. the notifyCMSynchronizationRecommended notification. – The OMC timing mechanism sends synchronization information to an NE. .event_type Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.fixed_he ader. Table 3-14 Notification of notifyCMSynchronizationRecommended Attribute Name domain_name Type string Domain header. l Notification format Table 3-14 lists the format of the notifyCMSynchronizationRecommended notification. (This parameter is null. Indicates the additional text related to the notification. that is. the configured MO instances. BASE_ALL }. Indicates the notification identifier and is used to exclusively identify a notification. BASE_NTH_LEVEL. }. The attribute value may be: l Base MO l Whole subtree l From the base MO to the layer N subtree l Objects in layer N The default value is the whole subtree. The value is defined as follows: enum ScopeType { BASE_ONLY. Indicates the time when the event occurs. Issue 03 (2010-12-31) . Unsigned long level. BASE_SUBTREE. This field is not supported. struct ScopePara { ScopeType type. SCOPE KernelCm ConstDefs ::ScopePa ra 3-14 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the scope specified for synchronization. Ltd. a long remainder_of_b ody filterable_data filterable_data b c TimeBase ::UtcT string ADD_TEXT BASE_MOC string string remainder_of_b ody remainder_of_b ody BASE_MOI string remainder_of_b ody remainder_of_b ody Indicates the instance identifier of the base MO of a subtree specified to be synchronized..3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name e Type string Domain filterable_data Description Indicates the instances of MO that sends the notification. Indicates the identifier of the IRPAgent that generates notifications. Indicates the class of the base MO of a subtree specified to be synchronized. M2000 Northbound CORBA Interface Developer Guide NOTE 3 Configuration Management Function of the CORBA Interface CosNotification::PropertySeq is the value type of remainder_of_body. You can query. Table 3-15 Values of getting BasicCMIRP versions Returned Value VersionNumberSet Description Indicates a set of versions that the BasicCMIRP supports. The value of VersionNumberSet is a set of strings. Ltd. Huawei only supports the interface of querying configuration managed objects.3 Function and Interface of Basic Configuration Management of the CORBA BasicCMIRP provides interface operations for configuration managed objects. 3. 3-15 . delete. and modify the interfaces of configuration managed objects. There is no parameter in getting BasicCMIRP versions. l Function format ManagedGenericIRPConstDefs::VersionNumberSet get_basicCm_IRP_version() raises (GetBasicCmIRPVersion). The NMS can use the interfaces to manage configuration managed objects. Support (Y/N) Y Table 3-16 Exceptions of getting BasicCMIRP versions Exception GetBasicCmIRPVersion Description Indicates the exceptions caused by unknown reasons.. Support (Y/N) Y Getting BasicCMIRP Operation Profile l Function description The NMS invokes get_basicCm_IRP_operation_profile to get the profile of operations supported by a specified version of BasicCMIRP. create. Getting BasicCMIRP Versions l Function description The NMS invokes get_basicCm_IRP_version to get the BasicCMIRP version information. l Function format ManagedGenericIRPConstDefs::MethodList get_basicCm_IRP_operation_profile ( in ManagedGenericIRPConstDefs::VersionNumber basicCm_IRP_version ) raises ( Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Huawei supports only one of the BasicCMIRP versions. 3-16 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Issue 03 (2010-12-31) ..3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide GetBasicCmIRPOperationProfile. Table 3-17 Parameters for getting BasicCMIRP operation profile Parameter basicCm_IRP_version In/Out In Description Indicates the BasicCMIRP version information in the IRP profile obtained by the NMS. Ltd. The version ID should be consistent with the version ID returned by Getting BasicCMIRP Versions. Support (Y/ N) Y OperationNotSupported GetBasicCmIRPOperationProfile N Y Getting BasicCMIRP Notification Profile l Function description The NMS invokes get_basicCm_IRP_notification_profile to get the profile of notifications supported by BasicCMIRP. Indicates that the operation is not supported. ManagedGenericIRPSystem::InvalidParameter). The information list contains the following items: l Names of operations l Parameter lists Support (Y/N) Y Table 3-19 Exceptions of getting BasicCMIRP operation profile Exception InvalidParameter Description Indicates that the given basicCm_IRP_version is invalid or null. Indicates the exceptions caused by unknown reasons. ManagedGenericIRPSystem::OperationNotSupported. Support (Y/N) Y Table 3-18 Values of getting BasicCMIRP operation profile Returned Value MethodList Description Indicates the information list of operations that the BasicCMIRP supports. M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface l Function format ManagedGenericIRPConstDefs::MethodList get_basicCm_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber basicCm_IRP_version ) raises ( GetBasicCmIRPNotificationProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 3-20 Parameters for getting BasicCMIRP notification profile Parameter basicCm_IRP_version In/Out In Description Indicates the BasicCMIRP version information in the BasicCMIRP profile obtained by the NMS. The version ID should be consistent with the version ID returned by Getting BasicCMIRP Versions. Support (Y/N) Y Table 3-21 Values of getting BasicCMIRP notification profile Returned Value MethodList Description Indicates the profile list of notifications that an BasicCMIRP supports. The profile list contains the following items: l Names of notifications supported by the BasicCMIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) Support (Y/N) Y NOTE Notifications are not defined in the BasicCMIRP. Table 3-22 Exceptions of getting BasicCMIRP notification profile Exception InvalidParameter Description Indicates that the given basicCm_IRP_version is invalid or null. Indicates that the operation is not supported. Support (Y/ N) Y OperationNotSupported N Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 3-17 3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Exception GetBasicCmIRPNotificationProfile Description Indicates the exceptions caused by unknown reasons. Support (Y/ N) Y Finding Managed Objects l Function description The NMS invokes find_managed_objects to query MOs in a specified condition and their attribute values. l Function format(1) BasicCmInformationIterator find_managed_objects ( in BasicCMIRPConstDefs::DN baseObject, in BasicCMIRPConstDefs::SearchControl searchControl, in BasicCMIRPConstDefs::AttributeNameSet requestedAttributes ) raises ( FindManagedObjects, ManagedGenericIRPSystem::ParameterNotSupported, ManagedGenericIRPSystem::InvalidParameter, ManagedGenericIRPSystem::ValueNotSupported, ManagedGenericIRPSystem::OperationNotSupported, UndefinedMOException, IllegalDNFormatException, UndefinedScopeException, IllegalScopeTypeException, IllegalScopeLevelException, IllegalFilterFormatException, FilterComplexityLimit); Table 3-23 Parameters for finding managed objects (I) Parameter baseObject In/Out In Description Indicates the ID of the base object instance. The parameter identifies exclusively the base object of an MO subtree. Support (Y/N) Y 3-18 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. Issue 03 (2010-12-31) M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Parameter searchControl In/Out In Description Defines query conditions. The structure of the parameter is as follows: struct SearchControl { ScopeType type; unsigned long level; FilterType filter; ResultContents contents; }; Support (Y/N) Y The type field defines a query range and is used in combination with the level field. l If type is BASE_ONLY and level is null, a base object is returned. l If type is BASE_NTH_LEVEL, all the objects at the level layer are returned. If level is 0, the base object is returned. l If type is BASE_SUBTREE, all the objects between base objects and objects at the level layer are returned. l If type is BASE_ALL and level is null, base objects and all the objects under the base objects are returned. l The filter field is not supported. l If contents is NAMES, only the DNs of required MOs are returned and attributes of the MOs are not returned. l If contents is NAMES_AND_ATTRIBUTES, the DNs and attributes of required MOs are returned. requestedAttributes in Defines a name list of attributes to be queried. Y Table 3-24 Values of finding managed objects (I) Returned Value BasicCmInformationIterator Description Indicates that the returned value is the CORBA object of BasicCmInformationIterator. Support (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 3-19 Indicates an illegal filter condition. Indicates that the filter scope is undefined. l Function format(2) boolean next_basicCmInformations ( in unsigned short how_many. The value of the parameter must be greater than 0. Indicates the exceptions caused by unknown reasons.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 3-25 Exceptions of finding managed objects (I) Exception Description Suppo rt (Y/ N) Y Y N Y N N Y Y N N N Y IllegalDNFormatException UndefinedScopeException IllegalScopeTypeException IllegalScopeLevelException IllegalFilterFormatException FilterComplexityLimit ParameterNotSupported InvalidParameter UndefinedMOException ValueNotSupported OperationNotSupported FindManagedObjects Indicates an illegal DN. Indicates a complex filter condition that cannot be parsed. Indicates that the given parameter is invalid. Indicates an illegal filter scope type. Indicates that baseObjectInstance is invalid. out BasicCMIRPConstDefs::ResultSet fetchedElements ) raises ( NextBasicCmInformations. Table 3-26 Parameters for finding managed objects (II) Parameter how_many In/ Out In Description Indicates the number of objects that the NMS expects. Indicates an illegal filter scope level. Support (Y/N) Y 3-20 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates that the operation is not supported. Indicates that the given parameters are not supported.. Ltd. ManagedGenericIRPSystem::InvalidParameter. ManagedGenericIRPSystem::OperationNotSupported). Indicates the value is not supported. Issue 03 (2010-12-31) . Indicates that the operation is not supported. Indicates an invalid parameter. Description Indicates operation failure caused by some unknown causes. 3-21 . ManagedGenericIRPSystem::OperationNotSupported). l TRUE indicates that some object information is not returned. l If the current configuration object number is less than or equal to the value of how_many. l FALSE indicates that all object information is returned and iterator objects are released. Support (Y/N) Y Y N Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface Parameter fetchedElements In/ Out Out Description Returns an information list of configuration objects. for example the value of InvalidParameter is 0.. Ltd. the length of the parameter is equal to how_many. The list includes DNs and attribute lists. The list includes the following subitems: l mo: the object class name of each returned attribute value l attributes: the list of queried attribute names and values NOTE l If the current configuration object number is more than the value of how_many. Support (Y/N) Y Table 3-28 Exceptions of finding managed objects (II) Exception NextBasicCmInformations InvalidParameter OperationNotSupported l Function format(3) void destroy () raises ( DestroyException. Support (Y/N) Y Table 3-27 Values of finding managed objects (II) Returned Value boolean Description Indicates that the returned value is of the Bool type. the parameter is the information about current configuration objects. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.3 Configuration Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 3-29 Exceptions of finding managed objects (III) Exception DestroyException OperationNotSupported l Event flow The process of querying the event flow of MOs is shown in Figure 3-1. Figure 3-1 Querying the event flow of MOs Description Indicates the exceptions caused by unknown reasons. IRPAgent queries MOs according to conditions provided by the NMS and creates the BasicCmInformationIterator object. Indicates that the operation is not supported. 1 2 Step The NMS uses the find_managed_objects interface to query MOs in a specified condition. Table 3-30 Steps used for the event flow of querying MOs No. Support (Y/N) Y N Table 3-30 lists the steps used for querying the event flow of MOs. Issue 03 (2010-12-31) 3-22 .. Ltd. 3-23 .M2000 Northbound CORBA Interface Developer Guide 3 Configuration Management Function of the CORBA Interface No. 4 When the NMS does not select all the MO information.. infer that the information list of MOs is not null. l If the returned value is false. 3 Step The NMS invokes the next_basicCmInformation interface of BasicCmInformationIterator to query qualified MOs. invoke destroy to release the BasicCmInformationIterator object. l If the returned value is true. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. infer that the information list of MOs is null and IRPAgent automatically releases the BasicCmInformationIterator object. Ltd. . 1 Introduction to the CORBA Alarm Management With alarm management function..2 Alarm Management of the CORBA The alarm management of the CORBA interface describes the CORBA alarm management and its functions. The alarm management has the following functions: querying alarms. acknowledge. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. clearing alarms. and add comments to alarms. Ltd. In addition. acknowledging alarms. unacknowledging alarms. counter-acknowledge alarms.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface 4 Alarm Management Function of the CORBA Interface About This Chapter The AlarmIRP interface is the only interface used in alarm management. 4-1 . 4. you can query. 4. and reporting alarms in real time. alarms can be reported in real time. clear. Getting AlarmIRP Versions l l Function description The NMS invokes get_alarm_IRP_versions to get information about AlarmIRP versions. and clearing alarms.2. Table 4-1 Values of getting AlarmIRP versions Returned Value VersionNumberSet Description Indicates a set of versions that AlarmIRP supports. The real-time report of alarms enables the NMS to handle alarms in real time. 4. clear.1 Introduction to the CORBA Alarm Management With alarm management function. getting alarm list. The value of VersionNumberSet is a set of strings. unacknowledging alarms.2 Alarm Management of the CORBA The alarm management of the CORBA interface describes the CORBA alarm management and its functions. getting AlarmIRP notification profile.2. getting alarm list. alarm contents.3 Mechanism for Forwarding Common Alarms In a multi-mode base station (MBTS). getting alarm count.1 Interface Description of the CORBA Alarm Management The CORBA alarm management involves getting AlarmIRP versions. 4. In addition.1 Interface Description of the CORBA Alarm Management The CORBA alarm management involves getting AlarmIRP versions. 4. unacknowledging alarms. alarm acknowledgement status change notification. while the NMS manages alarms through the alarm operation interface. acknowledging alarms. getting alarm count.2. and add comments to alarms. counter-acknowledge alarms. You can differentiate normal mode alarms from common alarms by viewing alarm information. Ltd. Huawei supports only one of the AlarmIRP versions. 4. getting AlarmIRP operation profile.. Function format ManagedGenericIRPConstDefs::VersionNumberSet get_alarm_IRP_versions () raises (GetAlarmIRPVersions). acknowledging alarms.2. and alarm change notification. common alarms can be generated on certain common devices. the NMS collects alarm statistics and synchronizes alarms. 4-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide 4. 4. you can query. and clearing alarms. new alarm notification. getting AlarmIRP notification profile. getting AlarmIRP operation profile. alarm contents. alarms can be reported in real time. Through the alarm query interface. alarm clearance notification. There is no parameter in getting AlarmIRP versions. acknowledge.2 Notification Description of the CORBA Alarm Management The description of the CORBA alarm management notification contains the triggering conditions and formats of the potential faulty alarm list notification. Issue 03 (2010-12-31) Support (Y/N) Y . alarm comment notification. . Support (Y/N) Y Getting AlarmIRP Operation Profile l Function description The NMS invokes get_alarm_IRP_operations_profile to get the profile of operations supported by AlarmIRP. Table 4-3 Parameters for getting AlarmIRP operation profile Parameter alarm_irp_version In/Out in Description Indicates the version of managed objects in the AlarmIRP managed domain.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-2 Exceptions of getting AlarmIRP versions Exception GetAlarmIRPVersions Description Indicates the exceptions caused by unknown reasons. The information list contains the following items: l Names of operations l Parameter lists Suppor t (Y/N) Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The value of this parameter should be consistent with the version number displayed in Getting AlarmIRP Versions. ManagedGenericIRPSystem::OperationNotSupported. ManagedGenericIRPSystem::InvalidParameter). l Function format ManagedGenericIRPConstDefs::MethodList get_alarm_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber alarm_irp_version ) raises ( GetAlarmIRPOperationsProfile. Suppor t (Y/N) Y Table 4-4 Values of getting AlarmIRP operation profile Returned Value MethodList Description Indicates the information list of operations that AlarmIRP supports. 4-3 . Ltd. Suppor t (Y/N) Y N Y Getting AlarmIRP Notification Profile l Function description The NMS invokes get_alarm_IRP_notification_profile to get the profile of notifications supported by AlarmIRP. Support (Y/N) Y Table 4-7 Values of getting AlarmIRP notification profile Returned Value MethodList Description Indicates the profile list of notifications that an AlarmIRP supports. The value of this parameter should be consistent with the version number displayed in Getting AlarmIRP Versions. Table 4-6 Parameters for getting AlarmIRP notification profile Parameter alarm_irp_version In/Out in Description Indicates the AlarmIRP version in the AlarmIRP profile obtained by the NMS. ManagedGenericIRPSystem::InvalidParameter).. ManagedGenericIRPSystem::OperationNotSupported. Ltd. Indicates that this operation is not supported. Issue 03 (2010-12-31) Support (Y/N) Y .4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-5 Exceptions of getting AlarmIRP operation profile Exception InvalidParameter OperationNotSupported GetAlarmIRPOperationsProfile Description Indicates that the given alarm_irp_version is invalid or null. Indicates the exceptions caused by unknown reasons. The profile list contains the following items: l Names of notifications supported by AlarmIRP l Names of fields in the notification (including the names of filterable_data and remainder_of_body fields) 4-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. l Function format ManagedGenericIRPConstDefs::MethodList get_alarm_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber alarm_irp_version ) raises ( GetAlarmIRPNotificationProfile. For the Union type. If this parameter is null. Indicates the exceptions caused by unknown reasons. Table 4-9 Parameters for getting alarm list (I) Parameter base_object In/Out in Description Either null or a certain object.. no filtering conditions are set. out boolean flag.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-8 Exceptions of getting AlarmIRP notification profile Exception InvalidParameter OperationNotSupported GetAlarmIRPNotificationProfile Description Indicates that the given alarm_irp_version is invalid or null. in AlarmIRPConstDefs::DNTypeOpt base_object. refer to 7. filter in Defines the filtering conditions for the alarm information to be obtained by the NMS.2 Description of filter in get_alarm_list. Suppor t (Y/N) Y N Y Getting Alarm List l Function description The NMS invokes get_alarm_list to get an alarm list of the current operations that meet certain requirements. NOTE For details about the filtering restrictions. Indicates that this operation is not supported.1. ManagedGenericIRPSystem::ParameterNotSupported. l Function format (1) AlarmIRPConstDefs::AlarmInformationSeq get_alarm_list ( in ManagedGenericIRPConstDefs::StringTypeOpt filter. only the alarm information related to the specified objects or the child objects in the current alarm list is displayed. out AlarmInformationIterator iter ) raises ( GetAlarmList. 4-5 . If this parameter is a certain object. ManagedGenericIRPSystem::InvalidParameter). Suppor t (Y/N) Y Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. if this parameter is null. Ltd. all the alarm information in the current alarm list is displayed. This parameter is the CORBA object of AlarmInformationIterator. l If flag is false.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter flag In/Out out Description l If flag is true. 4-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates that this operation is not supported. out AlarmIRPConstDefs::AlarmInformationSeq alarm_informations ) raises ( NextAlarmInformations. Ltd.. Support (Y/N) Y N Y l Function format (2) boolean next_alarmInformations ( in unsigned short how_many. Suppor t (Y/N) Y iter out Indicates that the alarm information is obtained through iter when flag is false. l If flag is false. Y Table 4-10 Values of getting alarm list (I) Returned Value AlarmInformationSeq Description l If flag is true. the Returned Value shows alarm information. Indicates the exceptions caused by unknown reasons. the Returned Value is null. Support (Y/N) Y Table 4-11 Exceptions of getting alarm list (I) Exception InvalidParameter ParameterNotSupported GetAlarmList Description Indicates that the parameter is invalid. Issue 03 (2010-12-31) . the iter shows the alarm information while the Returned Value list is null. ManagedGenericIRPSystem::InvalidParameter). the Returned Value shows the alarms that meet certain requirements. M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-12 Parameters for getting alarm list (II) Parameter how_many In/Out in Description Indicates the number of alarms that the NMS expects. The value of this parameter must be greater than 0 and less than or equal to 2000. alarm_informations out Indicates the displayed alarm information list. l If the number of current alarms exceeds the value of how_many, the sequence length of alarm_informations is equal to that of how_many. l If the number of current alarms is less than or equal to how_many, alarm_informations indicates the alarm information list. Y Suppo rt (Y/N) Y Table 4-13 Values of getting alarm list (II) Returned Value boolean Description Indicates that the returned value is of boolean. l TRUE indicates that some alarm information is not returned. l FALSE indicates that all alarm information is returned and iterator objects are released. Support (Y/N) Y Table 4-14 Exceptions of getting alarm list (II) Exception InvalidParameter Description Indicates that the parameter is invalid. For instance, if the value of how_many is 0, infer that this parameter is invalid. NextAlarmInformations l Function format (3) void destroy () raises( CORBA::SystemException); Support (Y/N) Y Indicates that this operation is not supported. Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 4-7 4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-15 Exceptions of getting alarm list (III) Exception SystemException Description Indicates the exceptions caused by unknown reasons. Support (Y/N) Y l Event flow Figure 4-1 shows the event flow of alarm information. Figure 4-1 Event flow of alarm information 1. 2. 3. 4. 5. 6. 7. Get alarm lists. Query alarms. The AlarmInformationIterator is displayed when the value of flag is false. All alarms are displayed when the value of flag is true. In case the value of flag is false, the next_alarmInformations is invoked. The system displays alarms. If the value false is displayed, objects are released. If the value true is displayed, the system continue to query alarms. Release objects directly. Alarm Contents l Unacknowledged and uncleared alarms Table 4-16 lists the format of the Unacknowledged and uncleared alarms. 4-8 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. Issue 03 (2010-12-31) M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-16 Unacknowledged and uncleared alarms Attribute Name domain_name type_name Type string string Domain header.fixed_hea der.event_type header.fixed_hea der.event_type Description Indicates the version number of the associated IRP information model. Reports the name of a new alarm. The value of this parameter is as follows: AlarmIRPConstDefs::NotificationType :: NOTIFY_FM_NEW_ALARM. Indicates the name of an event and defines communication alarms, internal error-handling alarms, QoS alarms, and equipment alarms. The value of this parameter maps to AlarmIRPConstDefs::AlarmType. e b c g string TimeBase: :UtcT string short filterable_data filterable_data filterable_data filterable_data Indicates the object instances of an alarm. Indicates the time when an alarm occurs. Indicates the identifier of the IRPAgent. Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType. The value range and information about this parameter are defined in ProbableCause. h short filterable_data Indicates the severity of an alarm. The following lists severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently, INDETERMINATE is not supported. event_name string header.fixed_hea der Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 4-9 The filterable_data area in alarm messages contains this attribute only after this attribute is activated. For details about how to activate the maintenance-mode alarm function and the attribute. Ltd. see Reporting maintenance-mode alarms.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name jj Type long Domain filterable_data Description Vendor-customized alarm type 1: Fault alarm nn long filterable_data The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. By default. the maintenance-mode alarm function is inactive. i string 4-10 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The NMS receives maintenance-mode alarms only after this function is activated. Indicates the detailed reasons for an alarm.. Issue 03 (2010-12-31) . f string remainder_of_b ody remainder_of_b ody Indicates the serial number of alarms and is used to be the only identifier for an alarm. This parameter records the Huawei alarm private information. xml file. The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format for location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name j Type string Domain remainder_of_b ody Description Indicates the detailed location information about an alarm.. Slot No. Check whether the CORBA V1.2.=0. 4.=4. Run the following command to restart the IRPService service: svc_adm -cmd restartsvc IRPService l Alarms that are already acknowledged but not cleared Table 4-17 lists the format of the acknowledged but uncleared alarms.0 interface. and then set enableSpecialAlarmStatusID to true.=1. 4-11 . Open the /opt/OMC/etc/IRPService/itf_n_config. Run the following command as user root or omcuser on the M2000 server to activate the maintenance-mode alarm function: SettingTool -cmd setparam -path "/imap/ifms/specialAlarmStatus/nbenable" -value "true" 2.0 interface. Run the following command to restart the FaultService service: svc_adm -cmd restartsvc FaultService 3. Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. If the installed interface is not the CORBA V1. To set the maintenance-mode alarm function.2. <AlarmIRP irpId="4" Turner="synch" FileCategory="IM" ThreadNum="2" enableSpecialAlarmStatusID="false"> 5. replace it with the CORBA V1. perform the following steps: 1.2. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.0 interface is installed by referring to the iManagerM2000V200R010C00 Guide to Query and Change Northbound CORBA Interface. Subrack No. Ltd. Issue 03 (2010-12-31) . and equipment alarms. That is. This parameter refers to the acknowledgement state of an alarm.ev ent_type header. QoS alarms.fixed_header Indicates the name of an event and defines communication alarms. The value of this parameter maps to AlarmIRPConstDefs::Notif icationType ::NOTIFY_FM _ACK_STATE_CHANGE D. type_name string b c g TimeBase: :UtcT string short filterable_data filterable_data filterable_data 4-12 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.ev ent_type Description Indicates the version number of the associated IRP information model. Indicates the time when an alarm occurs. this parameter shows the object instances of alarms occurred. event_name string header. Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType.. Indicates the identifier of the IRPAgent. Ltd. internal error-handling alarms.fixed_header. e string filterable_data Indicates the MO instances in the alarm notification. The value range and information about this parameter are defined in ProbableCause. The value of this parameter maps to AlarmIRPConstDefs::Alar mType.fixed_header. Indicates the state of an alarm.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-17 Acknowledged but uncleared alarms Attribute Name domain_name Type string Domain header. k jj TimeBase: :UtcT long filterable_data filterable_data Indicates the time when an alarm is acknowledged. INDETERMINATE is not supported. 4-13 . Ltd. The following lists the severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently. Vendor-customized alarm type 1: Fault alarm Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co..M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name h Type short Domain filterable_data Description Indicates the severity of an alarm. Indicates an identifier for a user that acknowledges an alarm. For details about how to activate the maintenance-mode alarm function and the attribute. By default. Issue 03 (2010-12-31) . see Reporting maintenance-mode alarms. f string remainder_of_body Indicates the serial number of alarms and is used to be the only identifier for an alarm. The NMS receives maintenancemode alarms only after this function is activated. l string remainder_of_body 4-14 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co..4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name nn Type long Domain filterable_data Description The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. The NMS acknowledgement alarms should be acknowledged by users whose ids are in the range of ack_user_id. the maintenance-mode alarm function is inactive. Ltd. The OMC acknowledgement alarms should be performed only by OMC authorized users. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. This parameter records the Huawei alarm private information. Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. l Unacknowledged but cleared alarms Table 4-18 lists the format of the unacknowledged but cleared alarms. j string remainder_of_body Indicates the detailed location information about an alarm. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format for location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No. Subrack No. Slot No.=1. The value 1 indicates that the alarm in Acknowledge state. 4-15 .=4..M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name n Type short Domain remainder_of_body Description Indicates the current state of alarm acknowledgement.=0. i string remainder_of_body Indicates the detailed reasons for an alarm. Ltd. event_name string header. QoS alarms. Here this parameter refers to the alarms in Clear state.eve nt_type Description Indicates the version number of the associated IRP information model. The value range and information about this parameter are defined in ProbableCause. The value of this parameter maps to AlarmIRPConstDefs::Alar mType. Issue 03 (2010-12-31) .fixed_header.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-18 Unacknowledged but cleared alarms Attribute Name domain_name Type string Domain header. and equipment alarms.fixed_header Indicates the name of an event and defines communication alarms. Indicates the time when an alarm occurs.. e string filterable_data Indicates the object instances in the alarm notification.eve nt_type header. internal error-handling alarms.fixed_header. Indicates the identifier of the IRPAgent. Indicates the state of an alarm. The value of this parameter maps to AlarmIRPConstDefs::NotificationType : NOTIFY_FM_CLEARED_ ALARM. Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType. Ltd. type_name string b c g TimeBase ::UtcT string short filterable_data filterable_data filterable_data 4-16 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The following lists the severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently. the maintenancemode alarm function is inactive. see Reporting maintenance-mode alarms. The filterable_data area in alarm messages contains this attribute only after this attribute is activated..M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name h Type short Domain filterable_data Description Indicates the severity of an alarm. For details about how to activate the maintenance-mode alarm function and the attribute. 4-17 . Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. jj long filterable_data Vendor-customized alarm type 1: Fault alarm nn long filterable_data The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. Ltd. By default. INDETERMINATE is not supported. The NMS receives maintenance-mode alarms only after this function is activated. This parameter records the Huawei alarm private information. 4-18 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. For the NMS.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name f Type string Domain remainder_of_body Description Indicates the serial number of alarms and is used to be the only identifier for an alarm. Indicates the detailed reasons for an alarm. alarms can be cleared by users whose IDs are in the range of clear_user_id. Issue 03 (2010-12-31) . In case of automatic alarm clearance.. alarms can be cleared only by OMC authorized users. Ltd. y string remainder_of_body ll i TimeBase ::UtcT string remainder_of_body remainder_of_body Indicates the time when an alarm is cleared. For the OMC. Indicates an identifier for a user that clears an alarm. the authorized user is NE. Ltd. out unsigned long major_count.=4. Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. Slot No. out unsigned long cleared_count ) raises ( GetAlarmCount. out unsigned long warning_count. Getting Alarm Count l Function description The NMS invokes get_alarm_count to get the count of all the current alarms different severities. Subrack No.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name j Type string Domain remainder_of_body Description Indicates the detailed location information about an alarm. The alarm count is consistent with the alarm information returned by Getting Alarm List.=1. ManagedGenericIRPSystem::ParameterNotSupported. l Function format void get_alarm_count ( in ManagedGenericIRPConstDefs::StringTypeOpt filter. ManagedGenericIRPSystem::OperationNotSupported. You can query the count of alarms in different severities before Getting Alarm List. out unsigned long minor_count. The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format for location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No.=0. out unsigned long indeterminate_count.. 4-19 . Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ManagedGenericIRPSystem::InvalidParameter). out unsigned long critical_count. Displays the count of alarms in major. Support (Y/N) Y critical_count major_count minor_count warning_count indeterminate_cou nt cleared_count out out out out out out Displays the count of alarms in critical. NOTE For details about the filtering format. Displays the count of alarms in minor. refer to 7. Support (Y/N) Y N N Y Acknowledging Alarms l Function description The NMS invokes acknowledge_alarms to acknowledge one or more alarms. Indicates that the operation is not supported.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-19 Parameters for getting alarm count Parameter filter In/ Out in Description Indicates the filtering conditions for the alarm count that the NMS wants to get. Indicates the exceptions caused by unknown reasons. Displays the count of alarms in indeterminate.1. Y Y Y Y Y Y Table 4-20 Values of getting alarm count Returned Value Description Support (Y/N) - Table 4-21 Exceptions of getting alarm count Exception InvalidParameter ParameterNotSupported OperationNotSupported GetAlarmCount Description Indicates that the given parameters are invalid. Displays the count of alarms in cleared. Displays the count of alarms in warning. 4-20 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.3 Description of filter in get_alarm_count.. Ltd. Issue 03 (2010-12-31) . Indicates that this parameter is not supported. Currently. Ltd. in string ack_user_id. in ManagedGenericIRPConstDefs::StringTypeOpt ack_system_id. 4-21 . The ALARM_ID field in the alarm information indicates the alarm identifier. Defines the information about the system where the NMS is located..M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface l Function format ManagedGenericIRPConstDefs::Signal acknowledge_alarms ( in AlarmIRPConstDefs::AlarmInformationIdAndSevSeq alarm_information_id_and_sev_list. Table 4-22 Parameters for acknowledging alarms Parameter In/Out Description Supp ort (Y/ N) Y alarm_information_id_and_se v_list in Defines the identifier of alarms to be acknowledged and the set of alarm severities. ManagedGenericIRPSystem::ParameterNotSupported. however. out AlarmIRPConstDefs::BadAcknowledgeAlarmInfoSeq bad_ack_alarm_info_list ) raises ( AcknowledgeAlarms. NOTE Alarm severity is a parameter that must be entered. ack_user_id in Defines the identifier of an NMS user who acknowledges alarms. the M2000 does not handle this parameter. Y ack_system_id in N Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The parameter is defined by the NMS. ManagedGenericIRPSystem::InvalidParameter). 4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter In/Out Description Supp ort (Y/ N) Y bad_ack_alarm_info_list out Indicates errors in the alarm acknowledgement. the returned value is OK and this parameter is null.. although the alarm ID exists. Support (Y/N) Y Y Y 4-22 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Issue 03 (2010-12-31) . If all the alarms are acknowledged correctly. the reason for the errors can be classified as ACKNOWLEDGMENTFAILED. Ltd. The displayed information contains the alarm identifiers and the reasons for the errors. the reason for the errors can be classified as ACKNOWLEDGMENTFAILED. Indicates that all the alarms that require acknowledgements fail in acknowledgement. the reason for the errors can be classified as UNKNOWNALARMID. l If the acknowledge information does not display the wanted modification. Indicates that only some of the alarms that require acknowledgements are acknowledged. l If an alarm is already acknowledged. although the alarm ID exists. Table 4-23 Values of acknowledging alarms Returned Value OK PartialFailure Failure Description Indicates that all the alarms that require acknowledgements are acknowledged. The following lists the reasons for errors: l If the alarm ID does not exist. ManagedGenericIRPSystem::OperationNotSupported. in ManagedGenericIRPConstDefs::StringTypeOpt ack_system_id. Indicates the parameter is not supported.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-24 Exceptions of acknowledging alarms Exception InvalidParameter AcknowledgeAlarms ParameterNotSupported Description Indicates that at least one group of parameters is invalid. Table 4-25 Parameters for unacknowledging alarms Parameter alarm_information_id_list In/Out in Description Defines the identifier of alarms to be unacknowledged. ManagedGenericIRPSystem::ParameterNotSupported. ManagedGenericIRPSystem::InvalidParameter). in string ack_user_id. Ltd. Function format ManagedGenericIRPConstDefs::Signal unacknowledge_alarms ( in AlarmIRPConstDefs::AlarmInformationIdSeq alarm_information_id_list. The parameter is defined by the NMS and should be consistent with ack_user_id. out AlarmIRPConstDefs::BadAlarmInformationIdSeq bad_alarm_information_id_list ) raises ( UnacknowledgeAlarms. 4-23 .. Support (Y/N) Y Y Y Unacknowledging Alarms l l Function description The NMS invokes unacknowledge_alarms to unacknowledge one or more alarms. ack_user_id in Defines the identifier of an NMS user who unacknowledges alarms. Indicates the exceptions caused by unknown reasons. Defines the information about the system where the NMS is located. The ALARM_ID field in the alarm information indicates the alarm identifier. Y Support (Y/N) Y ack_system_id in N Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the cancel of the acknowledgements fails. Support (Y/N) Y Table 4-26 Values of unacknowledging alarms Returned Value OK PartialFailure Description Indicates that all the alarms that require unacknowledgement are unacknowledged. Indicates that only some of that alarms that require unacknowledgements are unacknowledged. If all the alarms to be unacknowledged are unacknowledged. The following lists the reasons for the errors: l If the alarm ID specified in the input parameter does not exist. l If the alarm ID specified in the input parameter exists but the actual alarm status is "unacknowledged". The displayed information contains the alarm identifiers and the reasons for the errors. Support (Y/N) Y Y Failure Y 4-24 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Issue 03 (2010-12-31) . Ltd. the returned value is OK and this parameter is null. the error information is the alarm is unacknowledged state. the error information is could not find the alarm.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter bad_alarm_information_id_li st In/Out out Description Indicates errors in the alarm unacknowledgement.. Ltd. Indicates the exceptions caused by unknown reasons. Indicates that the given parameters are not supported.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Table 4-27 Exceptions of unacknowledging alarms Exception InvalidParameter Description Indicates that all the groups of parameters or at least one group of parameters is invalid. 4-25 . out AlarmIRPConstDefs::BadAlarmInformationIdSeq bad_alarm_information_id_list ) raises ( ClearAlarms. Defines the information about the system where the NMS is located.. Function format ManagedGenericIRPConstDefs::Signal clear_alarms ( in AlarmIRPConstDefs::AlarmInformationIdSeq alarm_information_id_list. ManagedGenericIRPSystem::InvalidParameter). Suppor t (Y/N) Y clear_user_id in Y clear_system_id in N Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. ManagedGenericIRPSystem::ParameterNotSupported. in string clear_user_id. Indicates that the operation is not supported. Defines the identifier of an NMS user who clears alarms. Table 4-28 Parameters for clearing alarms Parameter alarm_information_id_list In/Out in Description Defines the identifier list of the alarms that the NMS would clear. in ManagedGenericIRPConstDefs::StringTypeOpt clear_system_id. Support (Y/ N) Y ParameterNotSupported OperationNotSupported UnacknowledgeAlarms Y N Y Clearing Alarms l l Function description The NMS invokes clear_alarms to clear one or more alarms. 4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter bad_alarm_information_id _list In/Out out Description Indicates errors in the alarm clearance. the returned value is OK and this parameter is null. The following lists the reasons for the errors: l The alarm ID does not exist. Ltd. l The NE does not support manual alarm clearance. Indicates that only some of the alarms that require clearance are cleared. If all the alarms to be cleared are cleared. l The OMC disconnects with the NE. Issue 03 (2010-12-31) . Indicates the exceptions caused by unknown reasons. Indicates that the given parameters are not supported. Support (Y/N) Y Y Y Table 4-30 Exceptions of clearing alarms Exception InvalidParameter ParameterNotSupported ClearAlarms Description Indicates that at least one group of parameters is invalid. Support (Y/N) Y Y Y 4-26 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.. Indicates the clearance of alarms fails. Suppor t (Y/N) Y Table 4-29 Values of clearing alarms Returned Value OK PartialFailure Failure Description Indicates that all the alarms that require clearance are cleared. The displayed information contains the alarm identifiers and reasons for the errors. Refers to the information about the NMS system that will add comments to alarms. Refers to the identifier of the NMS user who will add comments to alarms. out AlarmIRPConstDefs::BadAlarmInformationIdSeq bad_alarm_information_id_list ) raises ( CommentAlarms. in ManagedGenericIRPConstDefs::StringTypeOpt comment_system_id. ManagedGenericIRPSystem::InvalidParameter). in string comment_text. Support ed (Y/N) Y comment_user_id in Y comment_system_id in N comment_text in Y Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.. ManagedGenericIRPSystem::OperationNotSupported. Table 4-31 Parameters for adding comments to alarms Parameter alarm_information_id_list In/ Out in Description Refers to the list of the identifiers indicating the alarms to which the NMS will add comments. ManagedGenericIRPSystem::ParameterNotSupported. in string comment_user_id. Ltd.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Adding Comments to Alarms l l Function description The NMS invokes this function to add comments to one or more alarms. Function format ManagedGenericIRPConstDefs::Signal comment_alarms ( in AlarmIRPConstDefs::AlarmInformationIdSeq alarm_information_id_list. Refers to the comments to be added to alarms. 4-27 . l If the alarm identifier specified in the typed parameter exists but adding comments to this alarm is not supported. Ltd. The system output contains alarm identifiers and error causes. Indicates that adding comments to the specified alarms fails. Issue 03 (2010-12-31) . Support ed (Y/N) N 4-28 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Support ed (Y/N) Y Table 4-32 Values of adding comments to alarms Returned Value OK PartialFailure Failure Description Indicates that comments are successfully added to all the specified alarms. The error information is as follows: l If the alarm identifier specified in the typed parameter does not exist. the returned value is OK and this parameter is empty. Indicates that comments are added to some of the specified alarms.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Parameter bad_alarm_information_id_lis t In/ Out out Description Refers to the alarm information indicating the failure to add comments to alarms.. Support ed (Y/N) Y Y Y Table 4-33 Exceptions of adding comments to alarms Exception OperationNotSupported Description Indicates that adding comments to a certain alarm is not supported. If comments are successfully added to all the specified alarms. the system displays commenting the alarm is not supported. the system displays could not find the alarm. fixed_hea der. Indicates that at least one group of the typed parameters are invalid. type_name string header. alarm clearance notification.fixed_hea der.event_type Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Support ed (Y/N) Y Y 4. that is. alarm acknowledgement status change notification. This parameter shows the version number of the associated IRP information model. and alarm change notification. the IRPAgent sends the notifyPotentialFaultyAlarmList to inform the NMS that the current alarm list may be inaccurate.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Exception ParameterNotSupported InvalidParameter Description Indicates that one or more typed parameters are not supported. Notification format Table 4-34 lists the format of the notifyPotentialFaultyAlarmList notification.event_type Description Indicates the name of a managed domain. The value of this parameter is defined by AlarmIRPConstDefs::Notifi cationType::NOTIFY_FM_ POTENTIAL_FAULTY_A LARM_LIST. or is not sure about the current alarm list. 4-29 . In such a situation. Ltd. new alarm notification.2. Table 4-34 notifyPotentialFaultyAlarmList Attribute Name domain_name Type string Domain header. Indicates the type of the reported notification. Notification of Potential Faulty Alarm List The IRPAgent may find that the current alarm list is inconsistent with the actual network resources. notifyPotentialFaultyAlarmList. l l Triggering condition The connection between the NE and the OMC become disconnected.2 Notification Description of the CORBA Alarm Management The description of the CORBA alarm management notification contains the triggering conditions and formats of the potential faulty alarm list notification.. alarm comment notification. the NMS sends the new alarm notification. the object instance of AlarmIRP. (This parameter is null.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name event_name Type string Domain header. l l Triggering condition New alarms occur on NEs or on the OMC. Notification format Table 4-35 lists the format of the new alarm notification.fixed_hea der filterable_data Description Indicates the name of an event. Indicates the reasons for reconstruction of alarm list.fixed_he ader. Ltd. Indicates the identifier of the IRPAgent that generates notifications. 4-30 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. that is.) Indicates the instances of MO that sends the notification. Notification of New Alarms When new alarms occur on NEs or on the OMC. Issue 03 (2010-12-31) . Indicates the notification identifier and is used to exclusively identify a notification.event_type Description Indicates the version number of the associated IRP information model. e string a long remainder_of_bo dy b c TimeBase::Utc T string filterable_data filterable_data x string remainder_of_bo dy NOTE AlarmIRPConstDefs::AttributeSetType is the value type of the remainder_of_body.. Table 4-35 Notification of new alarms Attribute Name domain_name Type string Domain header. Indicates the time when an event occurs. event_name string header.. The value of this parameter is that of AlarmIRPConstDefs::Alarm Type. Indicates the notification identifier and is used to exclusively identify a notification. the object instance of the alarm. that is. 4-31 .event_type Description Indicates the type of the reported alarm. e string filterable_data Indicates the instances of MO that sends the notification. The value range and information about this parameter are defined in ProbableCause of the IDL. Ltd. the new alarm. The value of this parameter is as follows: AlarmIRPConstDefs::NotificationType :: NOTIFY_FM_NEW_ALAR M. a long remainder_of_b ody b c g TimeBase::Ut cT string short filterable_data filterable_data filterable_data Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the time when an alarm occurs. QoS alarms.fixed_he ader. that is. Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType. and equipment alarms. internal error-handling alarms.fixed_he ader Indicates the name of an event and defines communication alarms. Indicates the identifier of the IRPAgent.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name type_name Type string Domain header. INDETERMINATE is not supported. jj long filterable_data Vendor-customized alarm type 1: Fault alarm nn long filterable_data The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. the maintenancemode alarm function is inactive. The NMS receives maintenance-mode alarms only after this function is activated. see Reporting maintenancemode alarms. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. For details about how to activate the maintenance-mode alarm function and the attribute. By default. The following lists severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently..4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name h Type short Domain filterable_data Description Indicates the severity of an alarm. Issue 03 (2010-12-31) . f string remainder_of_b ody Indicates the serial number of alarms and is used to be the only identifier for an alarm. 4-32 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Ltd. j string remainder_of_b ody Indicates the detailed location information about an alarm. The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format of location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No.=4.=1.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name i Type string Domain remainder_of_b ody Description Indicates the detailed reasons for an alarm. This parameter records the Huawei alarm private information.. Subrack No. – The OMC successfully acknowledges or unacknowledges alarms. Slot No. 4-33 . l Triggering condition – The NMS successfully acknowledges or unacknowledges alarms through Acknowledging Alarms or Unacknowledging Alarms. Notification of the Change of Alarm Acknowledgement Status If the acknowledgement status of an alarm is changed.=0. the NMS sends the alarm acknowledgement notification. l Notification format Table 4-36 lists the format of the alarm acknowledgement notification. Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Ltd. the notification of the change of the alarm acknowledgement status. that is.fixed_he ader Indicates the name of an event and defines communication alarms. The value of this parameter is as follows: AlarmIRPConstDefs::NotificationType :: NOTIFY_FM_ACK_STATE _CHANGED.fixed_he ader. Indicates the identifier of the IRPAgent. and equipment alarms. Issue 03 (2010-12-31) . internal error-handling alarms.. type_name string header. Indicates the type of the reported alarm. That is.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 4-36 Notification of the change of the alarm acknowledgement status Attribute Name domain_name Type string Domain header. Ltd. Indicates the time when an alarm occurs. The value of this parameter is that of AlarmIRPConstDefs::AlarmType. QoS alarms.fixed_he ader. this parameter shows the object instances of alarms occurred.event_type a long remainder_of_b ody b c TimeBase: :UtcT string filterable_data filterable_data 4-34 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. event_name string header. e string filterable_data Indicates the MO instances in the alarm notification.event_type Description Indicates the name of a managed domain. Indicates the notification identifier and is used to exclusively identify a notification. This parameter shows the version number of the associated IRP information model. Vendor-customized alarm type 1: Fault alarm jj filterable_data Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The value range and information about this parameter are defined in ProbableCause in the IDL. k TimeBase: :UtcT long filterable_data Indicates the time when an alarm is acknowledged or unacknowledged.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name g Type short Domain filterable_data Description Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType. INDETERMINATE is not supported. h short filterable_data Indicates the severity of an alarm. The following lists the severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently. 4-35 . Ltd.. For details about how to activate the maintenance-mode alarm function and the attribute. l The NMS acknowledgement alarms should be acknowledged or unacknowledged by users whose ids are in the range of ack_user_id.. the maintenancemode alarm function is inactive. Issue 03 (2010-12-31) . see Reporting maintenancemode alarms. l The OMC acknowledgement or unacknowledgement alarms should be performed only by OMC authorized users. l In case of automatic acknowledgement. f string remainder_of_b ody remainder_of_b ody Indicates the serial number of alarms and is used to be the only identifier for an alarm.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name nn Type long Domain filterable_data Description The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. Ltd. By default. The NMS receives maintenance-mode alarms only after this function is activated. Indicates an identifier for a user that acknowledges or unacknowledges an alarm. l string 4-36 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. the authorized user is system. j string remainder_of_b ody Indicates the detailed location information about an alarm.=0.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name n Type short Domain remainder_of_b ody Description Indicates the current acknowledgement state of an alarm. This parameter records the private information of Huawei alarms.=4. Slot No. For details.=1. 4-37 . The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format of location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No. refer to the definition of AlarmIRPConstDefs::AckState. Ltd. Subrack No. l The value 1 indicates that the alarm in Acknowledge state.. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. l The value 2 indicates that the alarm in Unacknowledge state. Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. i string remainder_of_b ody Indicates the detailed reasons for an alarm. l Notification format Table 4-37 lists the format of the alarm clearance notification. . and equipment alarms.fixed_ header.event_ type Description Indicates the name of a managed domain. l Triggering condition – The notification of alarm clearance shows that the NMS successfully clears alarms through Notification of Alarm Clearance. notification of alarm clearance. event_name string header..4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Notification of Alarm Clearance When an alarm is cleared. that is. Indicates the type of the reported notification. This parameter shows the version number of the associated IRP information model. Ltd. Indicates the time when an alarm is cleared.event_ type b TimeBase:: UtcT filterable_dat a 4-38 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Table 4-37 Notification of alarm clearance Attribute Name domain_name Type string Domain header. e a string long filterable_dat a remainder_of _body Indicates the object instances in the alarm notification.fixed_ header. – The OMC successfully clears alarms. the NMS sends the alarm clearance notification. The value of this parameter is that of AlarmIRPConstDefs::AlarmType. The value of this parameter is as follows: AlarmIRPConstDefs::NotificationType :: NOTIFY_FM_CLEARED_AL ARM. Indicates the notification identifier and is used to exclusively identify a notification. QoS alarms. Issue 03 (2010-12-31) type_name string header. – The NEs automatically clear alarms. internal error-handling alarms.fixed_ header Indicates the name of an event and defines communication alarms. M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name c g Type string short Domain filterable_dat a filterable_dat a Description Indicates the identifier of the IRPAgent. Indicates the possible reasons for an alarm and has more detailed categorizations compared with AlarmType. The value range and information about this parameter are defined in ProbableCause. h short filterable_dat a Indicates the severity of an alarm. The following lists the severities of alarms: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently, INDETERMINATE is not supported. jj long filterable_dat a Vendor-customized alarm type 1: Fault alarm Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 4-39 4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name nn Type long Domain filterable_dat a Description The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. By default, the maintenancemode alarm function is inactive. The NMS receives maintenancemode alarms only after this function is activated. For details about how to activate the maintenance-mode alarm function and the attribute, see Reporting maintenance-mode alarms. f string remainder_of _body remainder_of _body Indicates the serial number of alarms and is used to be the only identifier for an alarm. Indicates an identifier for a user that clears an alarm. l For the NMS, alarms can be cleared by users whose IDs are in the range of clear_user_id. l For the OMC, alarms can be cleared only by OMC authorized users. l In case of automatic alarm clearance, the authorized user is NE. y string i string remainder_of _body Indicates the detailed reasons for an alarm. This parameter records the Huawei alarm private information. 4-40 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. Issue 03 (2010-12-31) M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name j Type string Domain remainder_of _body Description Indicates the detailed location information about an alarm. The information consists of the following items: l NE location l Vendor l NE name l Alarm name l Detailed alarm location information The format of location information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No.=1, Subrack No.=4, Slot No.=0, Board type=WRFU| appendInfo: NOTE AlarmIRPConstDefs::AttributeSetType is the value type of remainder_of_body. Notification of Adding Alarm Comment When the alarm comment is added through the Northbound interface, the notification is sent. l l Trigger condition The NMS successfully adds alarm comment. Notification format Table 4-38 the notification format of adding alarm comment. Table 4-38 Format of adding alarm comment Attribute Name domain_name Type string Domain header.fixed_header. event_type Description Indicates the management domain name. It is the version number of corresponding IRP information model. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd. 4-41 that is. The value is AlarmIRPConstDefs::N otificationType ::. Indicates the possible reasons for an alarm and has more detailed categorizations compared with alarmType. Indicates the instances of MO that sends the notification. Ltd. Indicates the time when the notification of adding alarm comment occurs. The value is defined by AlarmIRPConstDefs::Al armType. that is.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name type_name Type string Domain header. event_name string header. Indicates the event name. Issue 03 (2010-12-31) . It defines notification alarm. NOTIFY_FM_COMME NT_ADDED. and equipment alarm.fixed_header. notification of adding alarm comment. The value range and information about this parameter are defined in ProbableCause of IDL..fixed_header e string filterable_data b TimeBase:: UtcT string filterable_data c filterable_data g short filterable_data 4-42 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the identifier of the managed system (IRPAgent) that generates the notification. event_type Description Indicates the type of reported notification. internal errorhandling alarm. the object instance of alarm. QoS alarm. Its value is alarm type. By default. Ltd. 4-43 . jj long filterable_data Vendor-customized alarm type 1: Fault alarm nn long filterable_data The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided.M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name h Type short Domain filterable_data Description Indicates the following alarm severity: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently.. For details about how to activate the maintenance-mode alarm function and the attribute. INDETERMINATE is not supported. see Reporting maintenance-mode alarms. The NMS receives maintenancemode alarms only after this function is activated. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. the maintenance-mode alarm function is inactive. Ltd. Table 4-39 Notification of alarm changes Attribute Name domain_name Type string Domain header. event_type 4-44 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Notification of Alarm Changes The alarm notification is delivered when the NE alarm changes. Indicates the added alarm comment information AlarmIRPConstDefs::C ommentSet. the notification of new alarm.fixed_header. f string remainder_of_body o sequence remainder_of_body NOTE The value type of remainder_of_body domain is AlarmIRPConstDefs::AttributeSetType. Indicates the serial number of alarms and is used to be the only identifier for an alarm. The value is AlarmIRPConstDefs::N otificationType ::. event_type Description Indicates the management domain name. l l Trigger condition The NE alarm changes. Indicates the type of the reported notification. Notification format Table 4-39 describes the notification format of alarm changes.fixed_header. Issue 03 (2010-12-31) . type_name string header. that is.. It is the version number of corresponding IRP information model. NOTIFY_FM_CHANG ED_ALARM.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name a Type long Domain remainder_of_body Description Indicates the notification identifier and is used to exclusively identify a notification. The value range and information about this parameter are defined in ProbableCause of IDL. that is. Its value is alarm type.fixed_header Description Indicates the event name. e string filterable_data b c TimeBase:: UtcT string filterable_data filterable_data g short filterable_data h short filterable_data Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Indicates the possible reasons for an alarm and has more detailed categorizations compared with alarmType. QoS alarm. Ltd. INDETERMINATE is not supported. the object instance of alarm.. Indicates the time when alarm changes. 4-45 .M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name event_name Type string Domain header. It defines notification alarm. Indicates the instances of MO that sends the notification. internal errorhandling alarm. Indicates the identifier of the managed system (IRPAgent) that generates the notification. The value is defined by AlarmIRPConstDefs::Al armType. Indicates the following alarm severity: l INDETERMINATE l CRITICAL l MAJOR l MINOR l WARNING l CLEARED NOTE Currently. and equipment alarm. the maintenance-mode alarm function is inactive. The filterable_data area in alarm messages contains this attribute only after this attribute is activated. a long remainder_of_body Indicates the notification identifier and is used to exclusively identify a notification. Issue 03 (2010-12-31) . f string remainder_of_body i string remainder_of_body 4-46 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. see Reporting maintenance-mode alarms. Indicates the detailed reasons for an alarm. Ltd. The NMS receives maintenancemode alarms only after this function is activated. Indicates the serial number of alarms and is used to be the only identifier for an alarm. This field records the Huawei alarm private information. For details about how to activate the maintenance-mode alarm function and the attribute..4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide Attribute Name jj Type long Domain filterable_data Description Vendor-customized alarm type 1: Fault alarm nn long filterable_data The maintenance-mode alarm statuses are as follows: l 0: Normal l 1: Creation l 2: Expansion l 3: Upgrade l 4: Commissioning No default value of this attribute is provided. By default. M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Attribute Name j Type string Domain remainder_of_body Description Indicates the detailed location information about an alarm. 4. The default value is 0. where NA indicates a normal mode alarm. common alarms can be generated on certain common devices. Common alarms are generated on some common devices in an MBTS. You can run the SettingTool command to set the configuration item.sh Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The directory for this configuration item is /imap/ifms/mbtsfilter. alarm name. A common alarm can be reported repeatedly to the NMS through northbound interfaces. NE name. or LTE are to be reported. You can differentiate normal mode alarms from common alarms by viewing alarm information.=0. UMTS. vendor.The information consists of NE location. To avoid this problem.3 Mechanism for Forwarding Common Alarms In a multi-mode base station (MBTS). On the M2000 client.. GSM. UMTS. Subrack No. l Run the following commands to set the configuration item: # . The format is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No. Board type=WRFU| appendInfo: NOTE The value type of remainder_of_body domain is AlarmIRPConstDefs::AttributeSetType. indicating that the common alarms whose Common Alarm Identifier values are GSM. /opt/OMC/svc_profile.=4. choose Monitor > Browse Alarm List and then choose Advanced > Properties > Common Alarm Indentifier. Slot No.=1. 4-47 . you can determine the method to be used for reporting common alarms through the northbound interfaces by setting a configuration item. see Table 4-40. Ltd.2. and the value range is 0-7. For details about this configuration item. and detailed alarm location information. or LTE. The value of Common Alarm Identifier can be NA. You can then determine whether the generated alarms are normal mode alarms or common alarms by viewing values in the Common Alarm Identifier column. or LTE are to be reported through the northbound interfaces. two alarms generated by the MBTS GSM and MBTS UMTS are to be reported. Issue 03 (2010-12-31) . Ltd. only the common alarm whose Common Alarm Identifier value is GSM is to be reported. UMTS. l In an MBTS UL or GU. no common alarm is to be reported. l In an MBTS UL. only the common alarm whose Common Alarm Identifier value is UMTS is to be reported. is set to 1. only the common alarm whose Common Alarm Identifier value is UMTS is to be reported. In an MBTS GU. l l Run the following command to restart FaultService: # svc_adm -cmd restartsvc FaultService Run the following command to check whether FaultService is started: # svc_adm -cmd status | grep FaultService If the system displays the following information.4 Alarm Management Function of the CORBA Interface M2000 Northbound CORBA Interface Developer Guide # SettingTool -cmd setparam -path "/imap/ifms/mbtsfilter" -value 1 If the directory of the configuration item. All the information contained in the alarms is the same except that they have different network serial numbers (SNs). 3 Only the common alarms whose Common Alarm Identifier values are GSM or UMTS are to be reported through the northbound interfaces. One alarm is generated by the MBTS GSM and the other is generated by the MBTS UMTS. that is. only the common alarm whose Common Alarm Identifier value is GSM is to be reported. l In an MBTS GL. /imap/ifms/mbtsfilter. l In an MBTS GL. 2 Only the common alarm whose Common Alarm Identifier value is UMTS is to be reported through the northbound interfaces. l In an MBTS GU. two common alarms with the same information are to be reported. In an MBTS GU.. 4-48 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 1 Only the common alarm whose Common Alarm Identifier value is GSM is to be reported through the northbound interfaces. only the common alarm whose Common Alarm Identifier value is GSM is to be reported. it indicates that FaultService is started: FaultService [running ] Run the SettingTool command to view the value of the configuration item: SettingTool -cmd getparam -path "/imap/ifms/mbtsfilter" Table 4-40 Description of the configuration item Value 0 Meaning The common alarms whose Common Alarm Identifier values are GSM. Ltd. l In an MBTS UL. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. No common alarm is to be reported..M2000 Northbound CORBA Interface Developer Guide 4 Alarm Management Function of the CORBA Interface Value 4 Meaning Only the common alarm whose Common Alarm Identifier value is LTE is to be reported through the northbound interfaces. only the common alarm whose Common Alarm Identifier value is LTE is to be reported. l In an MBTS GL. two common alarms generated by the MBTS UMTS and MBTS LTE are to be reported. two common alarms generated by the MBTS GSM and MBTS LTE are to be reported. l In an MBTS GU. l In an MBTS UL. only the common alarm whose Common Alarm Identifier value is UMTS is to be reported. 6 Only the common alarms whose Common Alarm Identifier values are UMTS or LTE are to be reported through the northbound interfaces. l In an MBTS GL. only the common alarm generated by the MBTS LTE is to be reported. l In an MBTS GL. only the common alarm whose Common Alarm Identifier value is GSM is to be reported. UMTS. regardless of the type of the MBTS. l In an MBTS GU. 4-49 . l In an MBTS UL. or LTE are not to be reported through the northbound interfaces. l In an MBTS GU. 7 The common alarms whose Common Alarm Identifier values are GSM. 5 Only the common alarms whose Common Alarm Identifier values are GSM or LTE are to be reported through the northbound interfaces. only the common alarm whose Common Alarm Identifier value is LTE is to be reported. only the common alarm whose Common Alarm Identifier value is LTE is to be reported. no common alarm is to be reported. . that is.3 Checking the CORBA Version Before interconnecting the M2000 to the NMS. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 5. subscribe to notifications. The reference of the entry point object is the prerequisite for the M2000 to invoke the northbound CORBA interface. 5. you need to make certain preparations. you can infer that the northbound CORBA interface meets the conditions for the interconnection. The NMS interconnects to the M2000 by invoking the IDL file. and receive notifications by using their host names.M2000 Northbound CORBA Interface Developer Guide 5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface Commissioning of the Northbound CORBA Interface About This Chapter Before interconnecting the NMS to the M2000. make sure that the northbound CORBA version on the M2000 server is valid. 5. After you modify the hosts files of the M2000 server and the NMS host.2 Obtaining the IDL File This describes how to obtain the IDL file. make sure that the NMS is licensed to use the northbound CORBA interface and has the negotiated interconnection parameters.4 Obtaining the Reference of the Entry Point Object This describes how to obtain the reference of the entry point object. they communicate with each other.5 Modifying the hosts File of the Server This section describes how to enable the NMS host and the M2000 server to communicate with each other through their host names. 5-1 5 Preparations for Interconnection . If you complete the preparations.ior file.6 Using the CORBA Interface This section describes how to use the northbound CORBA interface when the M2000 system adopts different networking modes. the1. 5. 5. 5.1 Negotiating the Interconnection Parameters of the Northbound CORBA Interface Before connecting the M2000 to the NMS. the IDL file of the M2000 needs to be provided to the NMS. Before the interconnection.. Ltd. ftpuser. Click the Resource Control Item tab. The actual password of the FTP user. make sure that the NMS has the required license. Do as follows to check whether the NMS has the required license.. Description For example. make sure that the NMS is licensed to use the northbound CORBA interface and has the negotiated interconnection parameters. The M2000 provides the IP address and hostname of the server for the interconnection. ftpuser. you can infer that the NMS is authorized to use the CORBA interface. see Table 5-1. FTP password Configuration model For example. Ltd. 1. IP address and hostname of the M2000 server The value of this parameter depends on the actual condition.1 Negotiating the Interconnection Parameters of the Northbound CORBA Interface Before connecting the M2000 to the NMS. If the RNC is used on site. For details. Negotiating the Interconnection Parameters The negotiated parameters include the parameters that the M2000 should provide to the NMS and the parameters that the NMS should provide to the M2000. Checking License Before the interconnection. Table 5-1 Negotiated parameters Parameter Type Parameters provided to the NMS by the M2000 Parameter FTP user name Parameter Value The FTP user can be any user that has the permission to read the 1. If Resource contains Alarm CORBA Interface or Basic Configuration CORBA Interface. The License Information window is displayed.ior file. the configuration model of this NE needs to be provided for the NMS. Issue 03 (2010-12-31) . 2. 3. Choose License > OMC License Management > License Information. 5-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. The value of this parameter depends on the actual condition. Log in to the M2000 client.5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide 5. 2.×. The NMS interconnects to the M2000 by invoking the IDL file. . To use the other IDL files.0.sh # displayCorbaNBI The following message is displayed: -------Current Version-------CorbaNBI NBIV×. make sure that the northbound CORBA version on the M2000 server is valid. 5. After the package of release documents is decompressed. Before the interconnection. Procedure Step 1 Run the following commands to check the CORBA version. If the version is not V1. CAUTION The northbound CORBA interface of the M2000 supports only the IDL file delivered with the version. the path of the IDL file is as follows ENG\07.× If the version is V1. you can infer that this version is valid. the IDL file of the M2000 needs to be provided to the NMS.2.0. Description The NMS provides its IP address and hostname for the interconnection. 5-3 . # cd /opt/OMC # .M2000 Northbound CORBA Interface Developer Guide 5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface Parameter Type Parameters provided to the M2000 by the NMS Parameter IP address and hostname of the NMS Parameter Value The value of this parameter depends on the actual condition. Prerequisite Log in to the M2000 server. 5. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. change the version to V1. you need to consult Huawei R&D engineers.2.0 according to the iManagerM2000V200R010C00 Guide to Query and Change Northbound CORBA Interface.2 Obtaining the IDL File This describes how to obtain the IDL file../svc_profile. Ltd.3 Checking the CORBA Version Before interconnecting the M2000 to the NMS.Northbound File\Corba interface\<Installed Corba version>\IDL. that is. see 2.ior file of the M2000.ior file from the /opt/OMC/var/itf_n/EPIRP directory on the M2000 server to the specified local path through the FTP. Issue 03 (2010-12-31) . If the file does not exist. see 6 Troubleshooting the Northbound CORBA Interface. Step 2 The NMS obtains the 1.com. Procedure Step 1 Run the following commands to view the reference of the entry point object. ----End 5-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.ior file. ----End 5.ior file exists. Context For more information about the reference of the entry point object..1 Entry Point of the CORBA Interface. you can download the document from the website:http://support. In addition. the1. NOTE The reference of the entry point object is dynamically generated by the northbound interface and is written to the /opt/OMC/var/itf_n/EPIRP/1.sh # cd var/itf_n/EPIRP # ls Check whether the 1. The NMS obtains the common functions.4 Obtaining the Reference of the Entry Point Object This describes how to obtain the reference of the entry point object.ior file. . The reference of the entry point object is the prerequisite for the M2000 to invoke the northbound CORBA interface.ior file must be transferred in ASCII mode./svc_profile. the 1. CAUTION When the FTP mode is used.huawei. alarm functions.5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface NOTE M2000 Northbound CORBA Interface Developer Guide The iManagerM2000V200R010C00 Guide to Query and Change Northbound CORBA Interface document is decompressed to the doc\ENG\07.Northbound File\Corba interface directory. Ltd. # cd /opt/OMC # . Prerequisite Log in to the M2000 server as user root or omcuser. and configuration functions by invoking the 1. subscribe to notifications. Save the file and exit the vi editor. add the IP address and hostname of the M2000 server to the /etc/hosts file through the vi editor. respectively. Step 2 Run the following command to open the /etc/hosts file on the M2000 server.71.224.224.71. if the IP address and hostname of the M2000 server are 10.100 nms_01 Press Esc and run the :wq! command. log in to the system as user root. l If the NMS uses the UNIX operating system.103 M2000_BAM03 Press Esc and run the :wq! command.M2000 Northbound CORBA Interface Developer Guide 5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface 5.103 and M2000_BAM03. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. l If the NMS server uses the Microsoft Win32 operating system. # vi /etc/hosts Step 3 Add the IP address and hostname of the interconnected NMS server at the end of the file.224. Ltd. add the IP address and hostname of the M2000 server to the hosts file saved in the system32\drivers\etc\hosts directory through the text editor. Step 4 Optional: When the NMS accesses the M2000 through the hostname of the M2000. the hosts file of the NMS server needs to be modified. add the following information to the end of the /etc/hosts file. respectively. add the following information to the end of the /etc/hosts file: 10. For example. they communicate with each other. and emergency system. ----End 5. Save the file and exit the vi editor.71.. remote HA system. The M2000 system can adopt the following networking modes: single-server system.5 Modifying the hosts File of the Server This section describes how to enable the NMS host and the M2000 server to communicate with each other through their host names. and receive notifications by using their host names.71. After you modify the hosts files of the M2000 server and the NMS host. HA system. 10. SLS system.100 and nms_01. Then.224.6 Using the CORBA Interface This section describes how to use the northbound CORBA interface when the M2000 system adopts different networking modes. Add the IP address and hostname of the M2000 server in the hosts file of the NMS. see Table 5-2. Procedure Step 1 Log in to the M2000 server as user root or omcuser. if the IP address and hostname of the NMS server are 10. 5-5 . For details about how to use the northbound CORBA interface in different networking modes. # vi /etc/hosts For example. See this document.5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide Table 5-2 Usage of the CORBA interface M2000 System Type Single-server system HA system Remote HA system Usage Reference See this document. See this document and M2000 Solution Description (Remote HA System) provided in the product documentation. Ltd. Issue 03 (2010-12-31) . See this document and M2000 Semergency System User Guide provided in the product documentation. SLS system Emergency system 5-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. See this document.. If a fault occurs when the NMS is obtaining the data. 4. Certain key attribute of the MO is null. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.3 Operations Required When the IP Address or Hostname of the M2000 Server Changes This describes the operations that should be performed for the M2000 and the NMS when the IP address or hostname of the M2000 server is changed. 6. collect the fault information and contact Huawei engineers for assistance. 3. If it is not possible to rectify the fault by using common troubleshooting methods. The DN is repeated. 6. The MO data conversion fails. 6. Free disk space is unavailable on the M2000 server. rectify the fault according to common troubleshooting methods. NEs are disconnected. 6. 2.2 Troubleshooting Failure to Obtain Data This section describes how to troubleshoot the issue when data obtaining fails due to the following causes: 1. refer to relevant troubleshooting methods in this chapter.M2000 Northbound CORBA Interface Developer Guide 6 Troubleshooting the Northbound CORBA Interface 6 Troubleshooting the Northbound CORBA Interface About This Chapter The NMS interconnects with the M2000 through the northbound CORBA interface.. 5. The service is not started. Ltd. 6-1 .1 Common Troubleshooting and Information Collection (CORBA Interface) If a fault occurs when the NMS attempts to obtain data through the northbound CORBA interface. and NE version. Certain key attribute of the MO is null. If it is not possible to rectify the fault by using common troubleshooting methods.6 Troubleshooting the Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide 6.trace. Indicates the IP address of the M2000 server. see Table 6-1. The MO 6-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. You can obtain logs from the /opt/OMC/var/logs directory on the M2000 server. you need to collect relevant information for fault localization.2 Troubleshooting Failure to Obtain Data. Troubleshooting Method See 6. collect the fault information and contact Huawei engineers for assistance.3 Operations Required When the IP Address or Hostname of the M2000 Server Changes. Ltd. 3. The . See 6.2 Troubleshooting Failure to Obtain Data This section describes how to troubleshoot the issue when data obtaining fails due to the following causes: 1. Table 6-1 Troubleshooting Common Fault Obtaining data failed. The DN is repeated. rectify the fault according to common troubleshooting methods. Information Collection If a fault not included in Table 6-1 occurs when the NMS is obtaining the data. The IP address of the M2000 server is changed. Issue 03 (2010-12-31) . Troubleshooting For the methods of handling common faults that may occur during the process for obtaining relevant data for the NMS.1 Common Troubleshooting and Information Collection (CORBA Interface) If a fault occurs when the NMS attempts to obtain data through the northbound CORBA interface. 6.irp_agent. NE mediation version. 2.. Table 6-2 lists the information that needs to be collected and the collection methods.trace file for IRPService is iMAP. Indicates the information about the M2000 version. Table 6-2 Information to be collected Related Information Operation information Version information IP address information Log information Description Records the operations performed before a fault occurs and the troubleshooting measures taken later. ManagedElement=37. Table 6-3 lists the possible causes of the problem and methods for locating the problem. the NMS cannot obtain the required configuration data. The northbound CORBA interface fails to obtain the configuration data. 6-3 . For example.M2000 Northbound CORBA Interface Developer Guide 6 Troubleshooting the Northbound CORBA Interface data conversion fails. DC=www. If the file includes the following information. Description In the northbound CORBA interface. NEs are disconnected.118: (25382|59) Svr. you can infer that the key attribute signallingPointId is null.trace file under the /opt/OMC/var/ logs directory. Free disk space is unavailable on the M2000 server.GFace: attribute signallingPointId not exist! Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.irp_agent. SignallingPoint is the key attribute of the MO. Free disk space is unavailable on the M2000 server.huawei. As a result. T-ER:TagID 0001:08-02 11:20:58. data of the MO cannot be obtained. a DN is used to uniquely identify an MO. IRPService is not started. The DN is repeated. 6. 5. Ltd. Check the iMAP. This DN indicates the MO object of a signaling point. 4. Conversion of the MO data fails. Localization Log in to the M2000 server. and SignallingPoint=0. Table 6-3 Possible Causes and Problem Localization Cause Certain key attribute of the MO is null. NOTE This is a typical problem of the northbound CORBA interface..com. NEs are disconnected. Troubleshooting Obtaining data fails possibly due to the following causes: l l l l l l Certain key attribute of the MO is null. Problem Description The NMS cannot obtain relevant data of the NE. Handling the Fault of obtaining the configuration data failed The NMS invokes the northbound CORBA interface to obtain the configuration data. If the value of SignallingPoint is NULL. SubNetwork=1. The service is not started. you can infer that the service process fails to be started.trace file under the /opt/OMC/var/ logs directory. while convertor to any where type is NetIdListType. DuplicateRdnInfo . Check the iMAP. struct. unsigned int.irp_agent. . If multiple MOs obtained share a DN. Check the iMAP. sequence. If the file exists. the DN cannot uniquely identify an MO.irp_agent.sh # svc_adm -cmd status If the following message is displayed. Conversion of the data type may fail. and unsigned long) obtained from the M2000 to the specified type of data (such as enum. In this case. you can infer that the service process is successfully started. Ltd. The northbound CORBA interface needs to convert the type of data (such as int. Localization Log in to the M2000 server. keyValue[220_0] Conversion of the MO data fails. 1. long.. long. # cd /opt/OMC # . If the file includes the following information. If IRPService is not started.ior file exists after the service is started. If the file includes the following information. Log in to the M2000 server as user root or omcuser. run the relevant commands to start it. the northbound CORBA interface indicates the exception. you can infer that the service is started. run the following command: # svc_adm -cmd startsvc IRPService Check whether the 1. IRPService [running ] 3.trace file under the /opt/OMC/var/ logs directory.gv moi number is more than the metaInfo length! Handling the Fault of Service Unactivation Check whether IRPService is started. If the service is not started. the interface indicates the exception.6 Troubleshooting the Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide Cause The DN is repeated. you can infer that an exception related to NetIdListType occurs during the conversion of the data type. Description In the northbound CORBA interface./svc_profile. 2. and their combinations). 6-4 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. string. If the file does not exist. Check the status of IRPService. In this case. Issue 03 (2010-12-31) . you can infer that The DN is repeated. string. a DN is used to uniquely identify an MO. Log in to the M2000 server. After the IP address of the M2000 server is changed. Solution Contact Huawei technical support. Handling Insufficient Disk Space Faults on the M2000 Server Clear the disk space on the M2000 server. In the Main Topology window. After the northbound service process is restarted. In this case. see 5. 2.ior file and to modify the hosts file. Ltd. Question The NMS obtains common data.4 Obtaining the Reference of the Entry Point Object.ior file is generated. and configuration data through obtaining the 1. 6-5 . In this case. choose Topology > Main Topology. Rectify the fault on the NE mediation. see the Commissioning Guide of the corresponding M2000 networking mode. the northbound Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Deleting a file by mistake can result in incorrect system operation.ior file. 6. if the IP address or hostname of the M2000 server needs to be changed. right-click the disconnected NE and then choose Reconnect NE. you need to restart the northbound service process. To reinstall the NE mediation. You are advised to clear the disk space by referring to the Administrator Guide of the corresponding M2000 networking mode.ior file contains different information from the original 1. The new 1.M2000 Northbound CORBA Interface Developer Guide NOTE 6 Troubleshooting the Northbound CORBA Interface For details on how to check whether the 1. the interface needs to instruct the NMS to obtain the new 1. After the M2000 is interconnected to the NMS. On the M2000 client.. alarm data.3 Operations Required When the IP Address or Hostname of the M2000 Server Changes This describes the operations that should be performed for the M2000 and the NMS when the IP address or hostname of the M2000 server is changed. a new 1. CAUTION Confirm the files can be deleted before clearing the disk space. what operations should be performed for the M2000 and the NMS? Answer If the IP address or hostname of the M2000 server needs to be changed. 3.ior file exists or not. Handling NE Disconnection Faults 1.ior file. settings of the northbound CORBA interface need not be changed. Verify the network and rectify the network fault. ior file is saved in the /opt/OMC/var/itf_n/EPIRP/ directory.4 Obtaining the Reference of the Entry Point Object. Issue 03 (2010-12-31) .5 Modifying the hosts File of the Server. see 5. Otherwise. the NMS cannot invoke the CORBA interface. For details on how to obtain the 1.. The 1. see 5.6 Troubleshooting the Northbound CORBA Interface M2000 Northbound CORBA Interface Developer Guide interface needs to instruct the NMS to obtain the new 1.ior file. Ltd.ior file. For details on how to modify the hosts file of the NMS server. 6-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. M2000 Northbound CORBA Interface Developer Guide 7 Appendix 7 About This Chapter A collection of supplementary material. 7. The filters in the get_alarm_list and get_alarm_count are also described.1 Description of filter This describes the supporting fields.3 Description of Alarm Location Detailed Information Analyze and locate alarms through Alarm Location Detailed Information. 7. Ltd. syntax description.2 Description of DN String A DN string is used to represent each object. Appendix 7. 7-1 .. and conventions of the filter. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. 1 Notification filter Description This describes the supporting field.3 Description of filter in get_alarm_count This describes the supporting field of the get_alarm_count. 7. 7..1.1. syntax description. and conventions of the filter.1.2 Description of filter in get_alarm_list This describes the supporting fields. 7. and conventions of the filter. syntax description.1 Description of filter This describes the supporting fields. and conventions of the filter.1 Notification filter Description This describes the supporting field. The filters in the get_alarm_list and get_alarm_count are also described. Fields Supporting filter l l l type_name event_name e Description of Supported Syntax <ConstraintExpr>:= [ <Expr> ] <Expr> := <Expr> <ExprOp> <Expr> | "(" <Expr> ")" | "not" <Expr> | <SetExpr> <SetOp> <SetExpr> | <StrExpr> <StrOp> <StrExpr> | <NumExpr> <NumOp> <NumExpr> <NumOp> := "==" | "!=" | "<" | "<=" | ">" | ">=" <SetOp> := "==" | "!=" <StrOp> := "==" | "!=" <ExprOp>:="and"|"or" <NumExpr> := <NumTerm> | <NumExpr> "+" <NumTerm> | <NumExpr> "-" <NumTerm> <NumTerm> := <NumFactor> | <NumTerm> "*" <NumFactor> | <NumTerm> "/" <NumFactor> <NumFactor> := <Identifier> | <Number> | "(" <NumExpr> ")" | "-" <NumFactor> <StrExpr> := "$"<Identifier> | <String> | "(" <StrExpr> ")" <SetExpr> := "$"<Identifier> | <Set> 7-2 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Issue 03 (2010-12-31) . Ltd.1. 7. and conventions of the get_alarm_list. syntax description.7 Appendix M2000 Northbound CORBA Interface Developer Guide 7. syntax description. however. Ltd. | : | " | \ | | | < | . The notification." [ <Integer> ] ] <AlphaNum> := <Letter> | <Digit> | "_" <String> := "'" { <Char> }* "'" <Char> := <Letter> | <Digit> | <Other> <Set> := "{" <Elements> "}" <Elements> := [ <Element> { <Sp>+ <Element> }* ] <Element> := <Number> | "$"<Identifier> | <String> <Letter> := | l | m | n | w | x | y | H | I | J | S | T | U a | | | | | o z K V b | | | | | p A L W c | | | | | q B M X d | | | | | r C N Y e | | | | | s D O Z f | | | | t E P g | | | | u F Q h | | | | i | j | k v G R 7 Appendix <Digit> := 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 <Other> := <Sp> | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | .. cannot be received. | > | / | ? | . Instance $type_name == 'x1' Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. If $ is not added. filter can pass the syntax check.| _ | = | + | [ | { | } | ] | . <Sp> := " " Convention l <Identifier> supports the following fields: – type_name – event_name –e NOTE These field names correspond to associated fields in the notification. 7-3 . l The symbol $ must be added before <Identifier>.M2000 Northbound CORBA Interface Developer Guide <Identifier> := <Letter> { <AlphaNum> }* <Number> := <Integer> | <Float> | "-" <Number> <Integer> := { <Digit> }+ <Float> := <Integer> [ ". Ltd. and conventions of the get_alarm_list. Fields Supporting filter The following fields in get_alarm_list support filter: l l l l type_name event_name b h Syntax Description l l l l l l l l l <SingleExpr> := "$"<Identifier><separator><ExprOp> <separator><Expr> <OrExpr> ::= <SingleExpr><separator>"or"<separator><SingleExpr> <AndExpr> : "("<OrExpr>")"<separator>"and"<separator>"("<OrExpr>")" <separator>::= " " <ExprOp>::= "==" | "<=" | ">=" <Expr>:= <StrExpr> | <NumExpr> <StrExpr> := "'" { <Char> }* "'" <NumExpr>:= <Integer> <Identifier>::= "type_name" | "event_name" | "b" | "h" Convention The conventions are as follows: l <Identifier> supports the following fields: – type_name – event_name –b –h l l l l l l In <SingleExpr> preceding and following the keyword "or". and h support only the operator "==". The operators that the field name b supports are only ">=" and "<=".1. In <SingleExpr> preceding and following the keyword "and".7 Appendix M2000 Northbound CORBA Interface Developer Guide 7. The field name type_name supports the following values: – x1 – x3 – x5 l 7-4 The field name event_name supports the following values: Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. <Identifier> must be the same. syntax description. <Identifier> must be different except that for the field name b.2 Description of filter in get_alarm_list This describes the supporting fields.. event_name. Issue 03 (2010-12-31) . The field names type_name. <Integer> is data of a decimal integer. SubNetwork=1 .3 Description of filter in get_alarm_count This describes the supporting field of the get_alarm_count. The supporting format is $e == 'DN'. Ltd.1. Supporting Field and Format l l The supporting field is e. The time format for alarms is the one defined in time of TimeBase::UtcT. DN refers to the alarm to be filtered. 7-5 . Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. Instance $e == 'DC=www. ManagementNode=1' 7.huawei. Instance l l l l $type_name == 'x1' $type_name == 'x1' or $type_name == 'x2' ($type_name == 'x1' or $type_name == 'x2') and ($event_name == 'x1') and ($b == 133459954540000000) ($b >= 133459954540000000) and ($b <= 133459955540000000) 7.M2000 Northbound CORBA Interface Developer Guide 7 Appendix – x1 – x2 – x3 – x4 – x5 l The field name h supports the following values: –2 –3 –4 –5 l The field name b is used to filter alarm time. Figure 7-1 shows the expression of a DN string.2 Description of DN String A DN string is used to represent each object..com. signallingLinkSetTP=SLSTP_1. mscFunction=MSCF_1 DN for Object 9: subnetwork= subnetwork_A.. Issue 03 (2010-12-31) . utranCell=UCL_1 DN for Object 11: subnetwork=subnetwork_A. managedElement= ME_1. signallingPoint=SP_1. mscFunction=MSCF_1. signallingLinkSetTP=SLSTP_2 DN for Object 12: subnetwork=subnetwork_A. mscFunction=MSCF_1. The DN of a specific object is follows: l l l l DN for Object 5: subnetwork=subnetwork_A. managedElement= ME_1. managedElement=ME_2. 7-6 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co.7 Appendix M2000 Northbound CORBA Interface Developer Guide Figure 7-1 DN string Figure 7-1 shows the RDN of each object. rncFunction=RNCF_1. Ltd. managedElement=ME_1. signallingPoint=SP_1. Each object shown Figure 7-1 is numbered and the DN of each object can be obtained.3 Description of Alarm Location Detailed Information Analyze and locate alarms through Alarm Location Detailed Information. signallingLinkTP=SLTP_1 7. Subrack No.=1. The fields NeLocation. alarmName: indicates the name of an alarm. NeLocation: indicates the location of the NE in which the alarm occurs.=4. and neName give the information about the NE where the alarm occurs.=0. vendor: indicates the manufacture of alarm devices. NOTE l l l The fields NeType give the information about the type of the NE that has alarms. Board type=WRFU| appendInfo: where. neName: indicates the name of the NE where the alarm occurs. The fields alarmName and alarmLocation are used to locate alarms. Thus. 7-7 . the NMS can analyze and locate alarms through Alarm Location Detailed Information. The information can be also traced on the OMC. Vendor.M2000 Northbound CORBA Interface Developer Guide 7 Appendix The Alarm Location Detailed Information is shown in the field j in the notification. The Alarm Location Detailed Information contains the following items: l l l l l l NeType NeLocation Vendor neName Alarm name Alarm location The format for the Alarm Location Detailed Information is as follows: NeType: NodeB| NeLocation: ShangHai | vendor: Huawei | neName: N91003| alarmName: RF Unit Maintenance Link Failure| alarmLocation: Cabinet No. l l l l l l NeType: indicates the type of the NE that has alarms.. Slot No. Issue 03 (2010-12-31) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co. alarmLocation: indicates the location information about an alarm. Ltd.
Copyright © 2024 DOKUMEN.SITE Inc.