• No results found

M2000 Northbound CORBA Interface Developer Guide

N/A
N/A
Protected

Academic year: 2021

Share "M2000 Northbound CORBA Interface Developer Guide"

Copied!
151
0
0

Loading.... (view fulltext now)

Full text

(1)

V200R010

Northbound CORBA Interface

Developer Guide

Issue 03

Date 2010-12-31

(2)
(3)

Copyright © Huawei Technologies Co., Ltd. 2010. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.

All other trademarks and trade names mentioned in this document are the property of their respective holders.

Notice

The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied.

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

Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base Bantian, Longgang Shenzhen 518129

People's Republic of China Website: http://www.huawei.com Email: support@huawei.com

(4)
(5)

About This Document

Purpose

This document provides information about the M2000 northbound CORBA interface. The document also provides operation guidelines for connecting the network management system (NMS).

Related Versions

The following table lists product versions related to this document.

Product Name Version

M2000 V200R010

Intended Audience

This document is intended for: l Network administrator

Update History

03 (2010-12-31)

This is the third commercial release.

(6)

Content Modification Description

1.4 Technical Specifications of Northbound CORBA Interface

The content descriptions are changed.

02 (2010-10-30)

This is the second commercial release.

Compared with the first release, the changes in the second release are as follows:

Content Modification Description

1.4 Technical Specifications of Northbound CORBA Interface

The description of technical specifications is added.

01 (2010-07-31)

Initial release.

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.

2 Common Management Function of the CORBA Interface

The function of common management interface consists of a cluster of management functions. These functions are EPIRP, NotificationIRP and CSIRP.

3 Configuration Management Function of the CORBA Interface

The configuration management interface has the following three functions: BasicCMIRP, KernelCMIRP, and BulkCMIRP.

4 Alarm Management Function of the CORBA Interface

The AlarmIRP interface is the only interface used in alarm management. The alarm management has the following functions: querying alarms, clearing alarms, acknowledging alarms,

unacknowledging alarms, and reporting alarms in real time.

(7)

Before interconnecting the NMS to the M2000, you need to make certain preparations. If you complete the preparations, you can infer that the northbound CORBA interface meets the conditions for the interconnection.

6 Troubleshooting the Northbound CORBA Interface

The NMS interconnects with the M2000 through the northbound CORBA interface. If a fault occurs when the NMS is obtaining the data, refer to relevant troubleshooting methods in this chapter.

7 Appendix

A collection of supplementary material.

Conventions

Symbol Conventions

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

Symbol Description

Indicates a hazard with a high level of risk, which if not avoided, will result in death or serious injury.

Indicates a hazard with a medium or low level of risk, which if not avoided, could result in minor or moderate injury.

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

Indicates a tip that may help you solve a problem or save time.

Provides additional information to emphasize or supplement important points of the main text.

General Conventions

The general conventions that may be found in this document are defined as follows.

Convention Description

Times New Roman Normal paragraphs are in Times New Roman.

Boldface Names of files, directories, folders, and users are in

boldface. For example, log in as user root.

Italic Book titles are in italics.

Courier New Examples of information displayed on the screen are in Courier New.

(8)

Command Conventions

The command conventions that may be found in this document are defined as follows.

Convention Description

Boldface The keywords of a command line are in boldface.

Italic Command arguments are in italics.

[ ] Items (keywords or arguments) in brackets [ ] are optional. { x | y | ... } Optional items are grouped in braces and separated by

vertical bars. One item is selected.

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

vertical bars. A minimum of one item or a maximum of all items can be selected.

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

vertical bars. Several items or no item can be selected.

GUI Conventions

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

Convention Description

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

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

Keyboard Operations

The keyboard operations that may be found in this document are defined as follows.

Format Description

Key Press the key. For example, press Enter and press Tab.

Key 1+Key 2 Press the keys concurrently. For example, pressing Ctrl+Alt +A means the three keys should be pressed concurrently.

Key 1, Key 2 Press the keys in turn. For example, pressing Alt, A means the two keys should be pressed in turn.

(9)

The mouse operations that may be found in this document are defined as follows.

Action Description

Click Select and release the primary mouse button without moving the pointer.

Double-click Press the primary mouse button twice continuously and quickly without moving the pointer.

Drag Press and hold the primary mouse button and move the pointer to a certain position.

(10)
(11)

Contents

About This Document...iii

1 Introduction to Northbound CORBA Interface...1-1

1.1 Definition of Northbound Interface...1-2 1.2 Definition of Northbound CORBA Interface...1-2 1.3 Function of Northbound CORBA Interface...1-5 1.3.1 Interface Management of the CORBA...1-5 1.3.2 About IRP...1-6 1.4 Technical Specifications of Northbound CORBA Interface...1-7

2 Common Management Function of the CORBA Interface...2-1

2.1 Entry Point of the CORBA Interface... 2-2 2.1.1 Interface Description of the Entry Point of the CORBA Interface... 2-2 2.1.2 Notification Description of the Entry Point of the CORBA Interface...2-9 2.2 Notification Management Function of the CORBA Interface...2-11 2.2.1 Introduction to Notification Management Function of the CORBA...2-11 2.2.2 Interface Description of the CORBA Notification Management...2-12 2.3 Communication Surveillance Function of the CORBA Interface...2-23 2.3.1 Interface Description of the CORBA Communication Surveillance...2-23 2.3.2 Heartbeat Notification of the CORBA Communication Surveillance...2-29

3 Configuration Management Function of the CORBA Interface...3-1

3.1 Getting to Know Configuration Management of the CORBA Interface...3-2 3.2 Common Configuration Management of the CORBA...3-3 3.2.1 Interface Description of the Common Configuration Management of the CORBA...3-4 3.2.2 Notification Description of the Common Configuration Management of the CORBA...3-8 3.3 Function and Interface of Basic Configuration Management of the CORBA...3-15

4 Alarm Management Function of the CORBA Interface...4-1

4.1 Introduction to the CORBA Alarm Management...4-2 4.2 Alarm Management of the CORBA...4-2 4.2.1 Interface Description of the CORBA Alarm Management...4-2 4.2.2 Notification Description of the CORBA Alarm Management...4-29 4.2.3 Mechanism for Forwarding Common Alarms...4-47

(12)

5 Preparations for Interconnection Commissioning of the Northbound CORBA Interface

...5-1

5.1 Negotiating the Interconnection Parameters of the Northbound CORBA Interface...5-2 5.2 Obtaining the IDL File...5-3 5.3 Checking the CORBA Version...5-3 5.4 Obtaining the Reference of the Entry Point Object...5-4 5.5 Modifying the hosts File of the Server...5-5 5.6 Using the CORBA Interface...5-5

6 Troubleshooting the Northbound CORBA Interface...6-1

6.1 Common Troubleshooting and Information Collection (CORBA Interface)...6-2 6.2 Troubleshooting Failure to Obtain Data...6-2 6.3 Operations Required When the IP Address or Hostname of the M2000 Server Changes...6-5

7 Appendix...7-1

7.1 Description of filter...7-2 7.1.1 Notification filter Description...7-2 7.1.2 Description of filter in get_alarm_list...7-4 7.1.3 Description of filter in get_alarm_count...7-5 7.2 Description of DN String...7-5 7.3 Description of Alarm Location Detailed Information...7-6

(13)

Figures

Figure 1-1 Location of the northbound interface... 1-2 Figure 1-2 Interface management functions...1-5 Figure 1-3 Relation between managed object by the management domain...1-6 Figure 1-4 Getting object reference of other IRPs by entry points... 1-7 Figure 1-5 Relations between IRPs...1-7 Figure 3-1 Querying the event flow of MOs...3-22 Figure 4-1 Event flow of alarm information...4-8 Figure 7-1 DN string... 7-6

(14)
(15)

Tables

Table 1-1 Interface protocol...1-3 Table 2-1 Values of getting EPIRP versions...2-2 Table 2-2 Exceptions of getting EPIRP version...2-3 Table 2-3 Parameters for getting EPIRP operation profile...2-3 Table 2-4 Values of getting EPIRP operation profile...2-3 Table 2-5 Exceptions of getting EPIRP operation profile...2-4 Table 2-6 Parameters for getting EPIRP notification profile...2-4 Table 2-7 Values of getting EPIRP notification profile...2-4 Table 2-8 Exceptions of getting EPIRP notification profile...2-5 Table 2-9 Parameters for getting IRP outline...2-5 Table 2-10 Values of getting IRP outline...2-6 Table 2-11 Exceptions of getting IRP outline...2-6 Table 2-12 Parameters for getting IRP reference...2-7 Table 2-13 Values of getting IRP reference...2-8 Table 2-14 Exceptions of getting IRP reference...2-8 Table 2-15 Parameters for releasing IRP reference...2-8 Table 2-16 Values of releasing IRP reference...2-9 Table 2-17 Exceptions of releasing IRP reference...2-9 Table 2-18 Format of the notification of entry point register information change...2-10 Table 2-19 Notification management function of the CORBA interface...2-12 Table 2-20 Values of getting notificationIRP versions...2-13 Table 2-21 Exceptions of getting notificationIRP versions...2-13 Table 2-22 Parameters for getting notificationIRP operation profile...2-13 Table 2-23 Values of getting notificationIRP operation profile...2-14 Table 2-24 Exceptions of getting notificationIRP operation profile...2-14 Table 2-25 Parameters for getting notificationIRP notification profile...2-14 Table 2-26 Values of getting notificationIRP notification profile...2-15 Table 2-27 Exceptions of getting notificationIRP notification profile...2-15 Table 2-28 Parameters for getting notification categories...2-15 Table 2-29 Values of getting notification categories...2-16 Table 2-30 Exceptions of getting notification categories...2-16 Table 2-31 Parameters for subscribing specified notifications...2-17 Table 2-32 Values of subscribing specified notifications...2-18

(16)

Table 2-33 Exceptions of subscribing specified notifications...2-19 Table 2-34 Parameters for detaching notification subscription...2-19 Table 2-35 Exceptions of detaching notification subscription...2-20 Table 2-36 Parameters for changing subscription filter conditions...2-20 Table 2-37 Values of changing subscription filter conditions...2-20 Table 2-38 Exceptions of changing subscription filter conditions...2-21 Table 2-39 Parameters for querying subscription IDs...2-21 Table 2-40 Values of querying subscription IDs...2-21 Table 2-41 Exceptions of querying subscription IDs...2-22 Table 2-42 Parameters for querying specified subscription parameters...2-22 Table 2-43 Values of querying specified subscription parameters...2-23 Table 2-44 Exceptions of querying specified subscription parameters...2-23 Table 2-45 Values of getting CSIRP versions...2-24 Table 2-46 Exceptions of getting CSIRP versions...2-24 Table 2-47 Parameters for getting CSIRP operation profile... 2-24 Table 2-48 Values of getting CSIRP operation profile... 2-25 Table 2-49 Exceptions of getting CSIRP operation profile...2-25 Table 2-50 Parameters for getting CSIRP notification profile...2-25 Table 2-51 Values of getting CSIRP notification profile...2-26 Table 2-52 Exceptions of getting CSIRP notification profile... 2-26 Table 2-53 Parameters for getting heartbeat period... 2-26 Table 2-54 Values of getting heartbeat period... 2-27 Table 2-55 Exceptions of getting heartbeat period...2-27 Table 2-56 Parameters for setting heartbeat period...2-27 Table 2-57 Values of setting heartbeat period...2-28 Table 2-58 Exceptions of setting heartbeat period...2-28 Table 2-59 Parameters for triggering heartbeat notifications...2-29 Table 2-60 Values of triggering heartbeat notifications...2-29 Table 2-61 Exceptions of triggering heartbeat notifications... 2-29 Table 2-62 Format of the heartbeat notification...2-30 Table 3-1 Values of getting KernelCMIRP versions...3-4 Table 3-2 Exceptions of getting KernelCMIRP versions...3-4 Table 3-3 Parameters for getting KernelCMIRP operation profile...3-5 Table 3-4 Values of getting KernelCMIRP operation profile...3-5 Table 3-5 Exceptions of getting KernelCMIRP operation profile...3-5 Table 3-6 Parameters for getting KernelCMIRP notification profile...3-6 Table 3-7 Values of getting KernelCMIRP notification profile...3-6 Table 3-8 Exceptions of getting KernelCMIRP notification profile...3-6 Table 3-9 Parameters for getting NRMIRP versions...3-7 Table 3-10 Exceptions of getting NRMIRP versions...3-7 Table 3-11 Notification of notifyObjectCreation...3-8 Table 3-12 Notification of notifyObjectDeletion...3-10

(17)

Table 3-13 Notification of notifyAttributeValueChange... 3-12 Table 3-14 Notification of notifyCMSynchronizationRecommended...3-13 Table 3-15 Values of getting BasicCMIRP versions...3-15 Table 3-16 Exceptions of getting BasicCMIRP versions...3-15 Table 3-17 Parameters for getting BasicCMIRP operation profile...3-16 Table 3-18 Values of getting BasicCMIRP operation profile...3-16 Table 3-19 Exceptions of getting BasicCMIRP operation profile...3-16 Table 3-20 Parameters for getting BasicCMIRP notification profile...3-17 Table 3-21 Values of getting BasicCMIRP notification profile...3-17 Table 3-22 Exceptions of getting BasicCMIRP notification profile...3-17 Table 3-23 Parameters for finding managed objects (I)...3-18 Table 3-24 Values of finding managed objects (I)...3-19 Table 3-25 Exceptions of finding managed objects (I)...3-20 Table 3-26 Parameters for finding managed objects (II)...3-20 Table 3-27 Values of finding managed objects (II)...3-21 Table 3-28 Exceptions of finding managed objects (II)...3-21 Table 3-29 Exceptions of finding managed objects (III)...3-22 Table 3-30 Steps used for the event flow of querying MOs...3-22 Table 4-1 Values of getting AlarmIRP versions...4-2 Table 4-2 Exceptions of getting AlarmIRP versions...4-3 Table 4-3 Parameters for getting AlarmIRP operation profile...4-3 Table 4-4 Values of getting AlarmIRP operation profile...4-3 Table 4-5 Exceptions of getting AlarmIRP operation profile...4-4 Table 4-6 Parameters for getting AlarmIRP notification profile...4-4 Table 4-7 Values of getting AlarmIRP notification profile...4-4 Table 4-8 Exceptions of getting AlarmIRP notification profile...4-5 Table 4-9 Parameters for getting alarm list (I)...4-5 Table 4-10 Values of getting alarm list (I)...4-6 Table 4-11 Exceptions of getting alarm list (I)...4-6 Table 4-12 Parameters for getting alarm list (II)...4-7 Table 4-13 Values of getting alarm list (II)...4-7 Table 4-14 Exceptions of getting alarm list (II)...4-7 Table 4-15 Exceptions of getting alarm list (III)...4-8 Table 4-16 Unacknowledged and uncleared alarms...4-9 Table 4-17 Acknowledged but uncleared alarms...4-12 Table 4-18 Unacknowledged but cleared alarms...4-16 Table 4-19 Parameters for getting alarm count...4-20 Table 4-20 Values of getting alarm count...4-20 Table 4-21 Exceptions of getting alarm count...4-20 Table 4-22 Parameters for acknowledging alarms...4-21 Table 4-23 Values of acknowledging alarms...4-22 Table 4-24 Exceptions of acknowledging alarms...4-23

(18)

Table 4-25 Parameters for unacknowledging alarms...4-23 Table 4-26 Values of unacknowledging alarms...4-24 Table 4-27 Exceptions of unacknowledging alarms...4-25 Table 4-28 Parameters for clearing alarms...4-25 Table 4-29 Values of clearing alarms...4-26 Table 4-30 Exceptions of clearing alarms...4-26 Table 4-31 Parameters for adding comments to alarms...4-27 Table 4-32 Values of adding comments to alarms...4-28 Table 4-33 Exceptions of adding comments to alarms...4-28 Table 4-34 notifyPotentialFaultyAlarmList... 4-29 Table 4-35 Notification of new alarms...4-30 Table 4-36 Notification of the change of the alarm acknowledgement status... 4-34 Table 4-37 Notification of alarm clearance...4-38 Table 4-38 Format of adding alarm comment...4-41 Table 4-39 Notification of alarm changes...4-44 Table 4-40 Description of the configuration item...4-48 Table 5-1 Negotiated parameters...5-2 Table 5-2 Usage of the CORBA interface...5-6 Table 6-1 Troubleshooting...6-2 Table 6-2 Information to be collected...6-2 Table 6-3 Possible Causes and Problem Localization ...6-3

(19)

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.

1.1 Definition of Northbound Interface

The northbound interface links the element management system (EMS) and the NMS. 1.2 Definition of Northbound CORBA Interface

The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). The Northbound CORBA interface is one of the Northbound interfaces. The Northbound CORBA interface conforms to the CORBA protocol, FTP protocol, and 3GPP specifications.

1.3 Function of Northbound CORBA Interface

This section describes the concepts related to CORBA interface management and integrated reference point (IRP).

1.4 Technical Specifications of Northbound CORBA Interface

(20)

1.1 Definition of Northbound Interface

The northbound interface links the element management system (EMS) and the NMS. On the northbound interface, the NMS obtains information about the network elements (NEs) managed by the EMS and delivers operation commands. The NE information includes the alarm, configuration, performance and inventory data. The northbound interface is shown in Figure 1-1.

Figure 1-1 Location of the northbound interface

In the communication network, the M2000 is an EMS. The M2000 reports the alarm,

configuration, performance and inventory data to the NMS through the northbound interface.

1.2 Definition of Northbound CORBA Interface

The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). The Northbound CORBA interface is one of the Northbound interfaces. The Northbound CORBA interface conforms to the CORBA protocol, FTP protocol, and 3GPP specifications.

Interface Protocol

(21)

Table 1-1 Interface protocol

Protocol Details

CORBA The design of network management interfaces adopts the CORBA technology for interface definition. The CORBA technology uses the IDL language to define the interface information model and also uses the IIOP communication protocol stack.

The design of the network management interfaces complies with the following CORBA standards:

l OMG ORB 2.3 standard

l OMG Notification Service 1.0 standard l TAO 1.3 Version

NOTE

l OMG represents the Object Management Group. l ORB represents the Object Request Broker.

FTP The file transfer mode in the management interface uses the File Transfer Protocol (FTP) and the FTP protocol stack.

(22)

Protocol Details

3GPP The CORBA interface complies with the following 3GPP protocols: l 3GPP TS 32.111-1 v6.0.0 Fault Management; Part 1: 3G fault

management requirements

l 3GPP TS 32.111-2 v6.0.0 Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS) l 3GPP TS 32.111-3 v6.0.0 Fault Management; Part 3: Alarm

Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)

l 3GPP TS 32.352 v6.0.0 Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP): Information Service (IS)

l 3GPP TS 32.411 v6.0.0 Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements

l 3GPP TS 32.412 v6.0.0 Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)

l 3GPP TS 32.413 v6.0.0 Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)

l 3GPP TS 32.601 v6.0.0 Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Requirements

l 3GPP TS 32.602 v6.0.0 Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)

l 3GPP TS 32.603 v6.0.0 Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)

l 3GPP TS 32.611 v6.0.0 Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Requirements

l 3GPP TS 32.612 v6.0.0 Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)

l 3GPP TS 32.615 v6.0.0 Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): eXtensible Markup Language (XML) file format definition

l 3GPP TS 32.613 v6.0.0 Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)

(23)

Protocol Details

l 3GPP TS 32.661 v6.0.0 Telecommunication management; Configuration Management (CM); Kernel CM: Requirements l 3GPP TS 32.662 v6.0.0 Telecommunication management;

Configuration Management (CM); Kernel CM Information Service (IS)

l 3GPP TS 32.663 v6.0.0 Telecommunication management; Configuration Management (CM); Kernel CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)

1.3 Function of Northbound CORBA Interface

This section describes the concepts related to CORBA interface management and integrated reference point (IRP).

1.3.1 Interface Management of the CORBA

Based on the common management, configuration management, and fault management, the Itf-N consists of a cluster of management interfaces, such as common management interface, configuration management interface, and fault management interface.

1.3.2 About IRP

The integrated reference point (IRP) is the abstract name of the interface function. 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. For example, Entry Point IRP (EPIRP) and NotificationIRP.

1.3.1 Interface Management of the CORBA

Based on the common management, configuration management, and fault management, the Itf-N consists of a cluster of management interfaces, such as common management interface, configuration management interface, and fault management interface.

Figure 1-2 shows the interface management functions.

(24)

1.3.2 About IRP

The integrated reference point (IRP) is the abstract name of the interface function. 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. For example, Entry Point IRP (EPIRP) and NotificationIRP.

IRPAgent

IRPAgent is the agent of IRP. In the network resource model, IRPAgent is used as the subnode of ManagementNode. IRPAgent includes each object class of IRPs on the Itf-N interface. Therefore, the Itf-N interface is considered as IRPAgent in the network resource model. IRPAgent referred in the latter section is considered as the Itf-N interface system. The managed object are called IRPs.

Figure 1-3 shows the relation between managed object by the management domain.

Figure 1-3 Relation between managed object by the management domain

Relations Between IRPs

(25)

Figure 1-4 Getting object reference of other IRPs by entry points

Figure 1-5 shows relations between IRPs.

Figure 1-5 Relations between IRPs

1.4 Technical Specifications of Northbound CORBA

Interface

This section describes the technical specifications related to the northbound CORBA interface.

Specification Item Value

Maximum number of NMS users on the CORBA interface 5 Maximum number of notifications to be subscribed to on

CORBA interfaces

8

(26)
(27)

2

Common Management Function of the

CORBA Interface

About This Chapter

The function of common management interface consists of a cluster of management functions. These functions are EPIRP, NotificationIRP and CSIRP.

2.1 Entry Point of the CORBA Interface

The entry point is the first object that IRPAgent accesses. 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. AlarmIRP is one example of the managed object.

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. Function description and format are detailed in the introduction to the CORBA notification management function.

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.

(28)

2.1 Entry Point of the CORBA Interface

The entry point is the first object that IRPAgent accesses. 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. AlarmIRP is one example of the managed object.

The interoperable object reference (IOR), that is, CORBA object reference of the entry point, is released as a file. In addition, IOR is permanent, that is, the IP address of the server where IRPAgent is located is fixed and IOR is permanently effective.

Object references of other IRPs are variable. When IRPAgent is rebooted, these object references must be obtained again.

2.1.1 Interface Description of the Entry Point of the CORBA Interface

This describes the functions of CORBA entry point. These functions consist of getting EPIRP versions, getting EPIRP operation profile, getting EPIRP notification profile, getting IRP outline, getting IRP reference, and releasing IRP reference.

2.1.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, send a notification of entry point register information change to the NMS according to requirement.

2.1.1 Interface Description of the Entry Point of the CORBA

Interface

This describes the functions of CORBA entry point. These functions consist of getting EPIRP versions, getting EPIRP operation profile, getting EPIRP notification profile, getting IRP outline, getting IRP reference, and releasing IRP reference.

Getting EPIRP Versions

l Function description

The NMS invokes get_EP_IRP_versions to get EPIRP versions. l Function format

ManagedGenericIRPConstDefs::VersionNumberSet get_EP_IRP_versions () raises (GetEPIRPVersions);

There is no parameter in getting EPIRP versions.

Table 2-1 Values of getting EPIRP versions

Returned Value Description Support

(Y/N)

VersionNumberSet Indicates a set of versions that the EPIRP supports. The value of VersionNumberSet is a set of strings. Huawei supports only one of the EPIRP versions.

(29)

Table 2-2 Exceptions of getting EPIRP version

Exception Description Support

(Y/N)

GetEPIRPVersions Indicates the exceptions caused by unknown reasons.

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. l Function format ManagedGenericIRPConstDefs::MethodList get_EP_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetEPIRPOperationsProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-3 Parameters for getting EPIRP operation profile

Parameter In/Out Description Support

(Y/N)

iRPVersion In Indicates the version ID of EPIRP in the EPIRP profile obtained by the NMS. The version ID should be consistent with the version ID returned by Getting EPIRP Versions.

Y

Table 2-4 Values of getting EPIRP operation profile

Returned Value Description Support

(Y/N)

MethodList Indicates the information list of operations the EPIRP supports.

The information list contains the following items:

l Names of operations l Parameter lists

(30)

Table 2-5 Exceptions of getting EPIRP operation profile

Exception Description Support

(Y/N)

InvalidParameter Indicates that the given iRPVersion is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported.

N

GetEPIRPOperationsProfile Indicates the exceptions caused by unknown reasons.

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. l Function format ManagedGenericIRPConstDefs::MethodList get_EP_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetEPIRPNotificationProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-6 Parameters for getting EPIRP notification profile

Parameter In/Out Description Support

(Y/N)

iRPVersion In Indicates the version information about EPIRP in the EPIRP outline gotten by the NMS. The version ID should be consistent with the version ID returned by Getting EPIRP Versions.

Y

Table 2-7 Values of getting EPIRP notification profile

Returned Value Description Support

(Y/N)

MethodList Indicates the profile list of notifications that an EPIRP supports.

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)

(31)

Table 2-8 Exceptions of getting EPIRP notification profile

Exception Description Support

(Y/N)

InvalidIRPVersion Indicates that the given iRPVersion is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported.

N

GetEPIRPNotificationProfile Indicates the exceptions caused by unknown reasons.

Y

Getting IRP Outline

l Function description

The NMS invokes get_IRP_outline to get the outline of the management domain Managed Object.

l Function format

EPIRPConstDefs::ResultType get_IRP_outline (

in ManagedGenericIRPConstDefs::VersionNumber iRPVersion, out EPIRPConstDefs::SupportedIRPListType supportedIRPList )

raises (GetIRPOutline,InvalidIRPVersion); Table 2-9 Parameters for getting IRP outline

Parameter In/Out Description Support

(Y/N)

iRPVersion In Indicates the version information about EPIRP in the EPIRP outline gotten by the NMS.

The parameter has the following two situations:

l If this parameter is null, the Agent returns the outline of all EPIRPs, including this EPIRP instance itself.

l If this parameter is not null, the entered value is the complete IRP information.

If you plan to query the general information about the CS IRP, the input parameter is CS IRP V1.2.0.

(32)

Parameter In/Out Description Support (Y/N)

supportedIRPList Out Indicates the returned list of the IRP profile according to input parameter conditions.

The list contains all IRP information in systemDn and IRPAgent. The IRP information contains:

l irpId l irpVersion l irpClassName

l irpManagementScope

The value of the parameter is of multi-nested structure.

Y

Table 2-10 Values of getting IRP outline

Returned Value Description Support

(Y/N)

OK Indicates that the operation succeeds. Y

FAILURE Indicates that the operation fails. Y

Table 2-11 Exceptions of getting IRP outline

Exception Description Support

(Y/N)

InvalidIRPVersion Indicates that the given IRPVersion is invalid.

Y

GetIRPOutline Indicates the exceptions caused by unknown reasons.

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.

l Function format EPIRPConstDefs::ResultType get_IRP_reference ( in EPIRPConstDefs::ManagerIdentifierType managerIdentifier, in EPIRPConstDefs::DNType systemDn, in EPIRPConstDefs::IRPIdType irpId, in EPIRPConstDefs::IRPClassNameType irpClassName, out string iRPReference

(33)

)

raises (

GetIRPReference,

ManagedGenericIRPSystem::InvalidParameter); Table 2-12 Parameters for getting IRP reference

Parameter In/Out Description Support

(Y/N)

managerIdentifier In Indicates a character string identifying Manager (NMS). The character string is given by the NMS and is unique. You can provide different values for

managerIdentifier to invoke this

operation. If the number of different values reaches five, an exception occurs.

Huawei recommends that you use a unique value for the parameter in an NMS.

Y

systemDN In Indicates the DN value of IRPAgent obtained from the Agent system. The value of this parameter should be consistent with the value of

systemDn returned by Getting IRP Outline.

Y

irpId In Indicates irpId of IRP obtained by the NMS.

The value of this parameter should be consistent with the value of irpId returned by Getting IRP Outline.

Y

irpClassName In Indicates the class name of IRP obtained by the NMS.

The value of this parameter should be consistent with the class name of IRP returned by Getting IRP Outline.

Y

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, the reference is different.

(34)

Table 2-13 Values of getting IRP reference

Returned Value Description Support

(Y/N)

OK Indicates that the operation succeeds. Y

Failure Indicates that the operation fails. Y

Table 2-14 Exceptions of getting IRP reference

Exception Description Support

(Y/N)

InvalidParameter Indicates that the following parameters or their combination are invalid:

l systemDN l irpId

l irpClassName l managerIdentifier

Y

GetIRPReference Indicates the exceptions caused by unknown reasons.

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. l Function format EPIRPConstDefs::ResultType release_IRP_reference( in EPIRPConstDefs::ManagerIdentifierType managerIdentifier, in string iRPReference ) raises ( ReleaseIRPReference, UnknownIRPReference);

Table 2-15 Parameters for releasing IRP reference

Parameter In/Out Description Support

(Y/N)

managerIdentifier In Indicates a character string identifying the NMS.

The parameter should be consistent with managerIdentifier specified in

Getting IRP Reference.

(35)

Parameter In/Out Description Support (Y/N)

iRPReference In Indicates the CORBA object reference, that is, IOR of IRP to be released by the NMS.

The parameter should be consistent with iRPReference returned by

Getting IRP Reference through relevant managerIdentifier.

Y

Table 2-16 Values of releasing IRP reference

Returned Value Description Support

(Y/N)

OK Indicates that the operation succeeds. Y

Failure Indicates that the operation fails. Y

Table 2-17 Exceptions of releasing IRP reference

Exception Description Support

(Y/N)

UnknownIRPReference Indicates that the specified iRPReference is invalid or the specified managerIdentifier does not match iRPReference.

The reason is that iRPReference is not obtained by managerIdentifier through the operation Getting IRP Reference.

Y

ReleaseIRPReference Indicates the exceptions caused by unknown reasons.

Y

2.1.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, send a notification of entry point register information change to the NMS according to requirement.

Triggering Conditions

l When the newly obtained object reference is successful through the Getting IRP Reference interface.

(36)

l When the IRPAgent system starts or stops.

Notification Format

Table 2-18 lists the format of the notification of entry point register information change.

Table 2-18 Format of the notification of entry point register information change

Attribute Name Type Domain Description

domain_name string header.fixed_h eader.event_ty pe

Indicates the name of a managed domain. This parameter shows the version number of the associated IRP information model.

type_name string header.fixed_h

eader.event_ty pe

Indicates the type of the reported notification.

The value of this parameter is defined by

EPIRPNotifications::notifyIRPInfo Changes::ET_IRPINFO_CHANGE S.

event_name string header.fixed_h eader

Indicates the name of an event. (This parameter is null.)

e string filterable_data Indicates the instances of MO that sends the notification, that is, the IRP object instance.

a long remainder_of_

body

Indicates the notification identifier and is used to exclusively identify a notification.

b TimeBase::

UtcT

filterable_data Indicates the time when an event occurs.

c string filterable_data Indicates the identifier of the IRPAgent that generates notifications.

IRP_DN string remainder_of_

body

Indicates the DN value of the IRP when the information about the EP changes.

(37)

Attribute Name Type Domain Description CHANGE_MODE enum ChangeMod eType {REGISTE R, DEREGIST ER, MODIFY}; remainder_of_ body

Indicates that the change modes of the EPIRP information.

The change modes are as follows: l REGISTER

A new object reference value is obtained.

l DEREGISTER

The IRPAgent system stops or releases an object reference. l MODIFY

The IRPAgent system starts the object reference value.

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.

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. Function description and format are detailed in the introduction to the CORBA notification management function.

2.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, order management, and order limitation.

2.2.2 Interface Description of the CORBA Notification Management

This describes the CORBA notification management function that involves getting notificationIRP versions, getting notificationIRP operation profile, getting notificationIRP notification profile, getting notification categories, subscribing specified notifications, detaching notification subscription, changing subscription filter conditions, querying subscription IDs, and querying parameters of specified subscription.

2.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, order management, and order limitation.

(38)

Table 2-19 Notification management function of the CORBA interface

Scenario Description

Enabling IRPAgent to report events to the NMS

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 notification is sent to the NMS through the notification channel. Managing subscribed

notifications

The management includes the subscription period, notification class, and filter condition.

To ensure that all the subscribed notifications are valid, IRPAgen check whether the currently subscribed

CosNotifyComm::SequencePushConsumer object is valid. IRPAgen can determine the validity by using the method of _non_existent provided by CORBA. If an object is invalid, IRPAgent automatically cancels the subscription of the object.

If the CosNotifyComm::SequencePushConsumer object is invalid and need be subscribed again, the NMS is

recommended to actively invoke an interface to cancel the subscription before the CosNotifyComm::SequencePush-Consumer is invalid.

Subscribing a maximum of eight notifications

If the actual subscription number exceeds the maximum subscription number, an exception occurs.

The NMS is recommended to actively cancel unneeded subscription.

2.2.2 Interface Description of the CORBA Notification

Management

This describes the CORBA notification management function that involves getting notificationIRP versions, getting notificationIRP operation profile, getting notificationIRP notification profile, getting notification categories, subscribing specified notifications, detaching notification subscription, changing subscription filter conditions, querying subscription IDs, and querying parameters of specified subscription.

Getting Notification IRP Versions

l Function description

The NMS invokes get_notification_IRP_versions to get the NotificationIRP version information.

l Function format

ManagedGenericIRPConstDefs::VersionNumberSet get_notification_IRP_versions () raises (GetNotificationIRPVersions);

(39)

Table 2-20 Values of getting notificationIRP versions

Returned Value Description Support (Y/N)

VersionNumberSet Indicates a set of versions that the NotificationIRP supports. The value of

VersionNumberSet is a set of strings.

Huawei supports only one of the NotificationIRP versions.

Y

Table 2-21 Exceptions of getting notificationIRP versions

Exception Description Support (Y/N)

GetNotificationIRPVersions Indicates the exceptions caused by unknown reasons.

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.

l Function format ManagedGenericIRPConstDefs::MethodList get_notification_IRP_operations_profile ( in ManagedGenericIRPConstDefs::VersionNumber notification_irp_version ) raises ( GetNotificationIRPOperationsProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter);

Table 2-22 Parameters for getting notificationIRP operation profile

Parameter In/Out Description Suppor

t (Y/N)

notification_irp_version In Indicates the NotificationIRP version ID in the

NotificationIRP profile obtained by the NMS. The version ID should be consistent with the version ID returned by Getting

Notification IRP Versions. Y

(40)

Table 2-23 Values of getting notificationIRP operation profile

Returned Value Description Support

(Y/N)

MethodList Indicates the information list of operations the NotificationIRP supports.

The information list contains the following items: l Names of operations

l Parameter lists

Y

Table 2-24 Exceptions of getting notificationIRP operation profile

Exception Description Support

(Y/N)

InvalidParameter Indicates that the given

notification_irp_version is invalid or

null.

Y

OperationNotSupported Indicates that this operation is not supported.

N

GetEPIRPOperationsProfile Indicates the exceptions caused by unknown reasons.

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.

l Function format ManagedGenericIRPConstDefs::MethodList get_notification_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber notification_irp_version ) raises ( GetNotificationIRPNotificationProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter);

Table 2-25 Parameters for getting notificationIRP notification profile

Parameter In/Out Description Support

(Y/N)

notification_irp_version In Indicates the NotificationIRP version ID in the NotificationIRP profile obtained by the NMS. The version ID should be consistent with the version ID returned by Getting

Notification IRP Versions.

(41)

Table 2-26 Values of getting notificationIRP notification profile

Returned Value Description Suppo

rt (Y/ N)

MethodList Indicates the profile list of notifications that an NotificationIRP supports.

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)

Y

NOTE

Notifications are not defined in the NotificationIRP.

Table 2-27 Exceptions of getting notificationIRP notification profile

Exception Description Support

(Y/N)

InvalidIRPVersion Indicates that the given

notification_irp_version is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported. N

GetNotificationIRPNotifi-cationProfile

Indicates the exceptions caused by unknown reasons.

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.

l Function format

NotificationIRPConstDefs::NotificationCategorySet get_notification_categories ( out NotificationIRPConstDefs::NotificationTypesSet notification_type_list )

raises (

GetNotificationCategories,

ManagedGenericIRPSystem::OperationNotSupported); Table 2-28 Parameters for getting notification categories

Parameter In/Out Description Support

(Y/N)

notification_type_list Out Indicates the list of notification types that map to notification categories.

(42)

Table 2-29 Values of getting notification categories

Returned Value Description Suppor

t (Y/N)

NotificationCategorySet Indicates the set of notification categories supported by IRPAgent. Each element in this set specifies a notification category.

Y

Table 2-30 Exceptions of getting notification categories

Exception Description Suppo

rt (Y/ N)

OperationNotSupported Indicates that this operation is not supported. N GetNotificationCategories Indicates the exceptions caused by unknown

reasons.

Y

Subscribing Specified Notifications

l Function description

The NMS invokes attach_push to subscribe notifications of specified categories. l Function format

NotificationIRPConstDefs::SubscriptionId attach_push ( in string manager_reference,

in unsigned long time_tick,

in NotificationIRPConstDefs::NotificationCategorySet notification_categories, in ManagedGenericIRPConstDefs::StringTypeOpt filter ) raises ( Attach, ManagedGenericIRPSystem::ParameterNotSupported, ManagedGenericIRPSystem::InvalidParameter, AlreadySubscribed, AtLeastOneNotificationCategoryNotSupported);

(43)

Table 2-31 Parameters for subscribing specified notifications

Parameter In/Out Description Suppor

t (Y/N)

manager_reference In Identifies the event receiver at the NMS side. For IOR, the parameter value should be CosNotifyComm::Sequence-PushConsumer.

The IRPAgent uses the event channel to transfer the NMS an event

information, that is,

manager_refer-ence invokes the push operation.

When the subscribed number exceeds eight, no new subscriptions are received.

Y

time_tick In Indicates a timer.

After this timer expires, the subscribed notification is detached to release the notification channel resources.

Normally, the NMS invokes Querying Parameters of Specified

Subscription periodically to refresh the timer to ensure that the relevant channel is not released.

The unit for this parameter is minute. Set the value of the timer according to the following two situations:

l If you enter a value between 1 and 15, the timer is set to 15.

l If you enter a value more than 15 (included), the timer is set to the entered value.

l If you enter null or 0, the timer never expires.

(44)

Parameter In/Out Description Suppor t (Y/N)

notification_catego-ries

In Defines the set of notifications to be filtered. Each element in the set should be an element of the notification category returned by Getting Notification Categories. If the set is null, infer that all the notification categories supported by IRPAgent are subscribed.

For the repeated subscription of

manager_reference, there must be a

notification class that is not subscribed in the parameter-defined set. If all the notification classes are subscribed in the set, an AlreadySubscribed exception is displayed.

l If notification_categories is null, infer that all the notification classes unsubscribed by

manager_refer-ence need be subscribed.

l If all the notification classes are subscribed, an

AlreadySubscri-bed exception is displayed.

Y

filter In Defines the filter condition for the notification subscription.

The parameter is set based on all notification categories defined by

notification_categories.

If this parameter is valued null, infer that conditions defined by

notification_categories have no extra

restrictions.

For details of the syntax, refer to 7.1.1 Notification filter Description.

Y

Table 2-32 Values of subscribing specified notifications

Returned Value Description Support (Y/

N)

SubscriptionId Identifies the notification subscription. The NMS can uniquely identify a subscription record by using this value.

(45)

Table 2-33 Exceptions of subscribing specified notifications

Exception Description Support (Y/

N)

AlreadySubscribed Indicates that the notifications defined by

notification_categories are already

subscribed by the manager_reference receiver.

Y

ParameterNotSuppor-ted

Indicates that this parameter is not supported. N

InvalidParameter Indicates that this parameter is incorrect or that its format is incorrect.

Y

AtLeastOneNotifica- tionCategoryNotSup-ported

Indicates that this parameter is incorrect or that the parameter notification_categories is invalid.

Y

Attach Indicates the exceptions caused by unknown reasons.

Y

Detaching Notification Subscription

l Function description

The NMS invokes detach to detach the notification subscription. l Function format void detach ( in string manager_reference, in NotificationIRPConstDefs::SubscriptionId subscription_id) raises ( DetachException, ManagedGenericIRPSystem::ParameterNotSupported, ManagedGenericIRPSystem::InvalidParameter);

Table 2-34 Parameters for detaching notification subscription

Parameter In/Out Description Support

(Y/N)

manager_reference In Indicates the identifier of the event receiver at the home NMS that is going to detach the notification subscription. The parameter should be consistent with

manager_refer-ence specified in Subscribing Specified Notifications.

Y

subscription_id In Indicates the unique identifier of the notification subscription.

If this parameter is null, infer that all notifications earlier subscribed by

manager_reference are detached.

(46)

Retract the subscription of the parameters having no values.

Table 2-35 Exceptions of detaching notification subscription

Exception Description Support

(Y/N)

InvalidParameter Indicates that the specified parameter

manager_reference, subscription_id or

their combination is invalid. Alternatively, the notification subscription identified by

subscription_id is not subscribed by manager_reference.

Y

ParameterNotSupported Indicates that this parameter is not supported. N DetachException Indicates the exceptions caused by unknown

reasons.

Y

Changing Subscription Filter Conditions

l Function description

The NMS invokes change_subscription_filter to change the subscription filter conditions. l Function format void change_subscription_filter ( in NotificationIRPConstDefs::SubscriptionId subscription_id, in string filter) raises ( ChangeSubscriptionFilter, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter);

Table 2-36 Parameters for changing subscription filter conditions

Parameter In/Out Description Suppor

t (Y/N)

subscription_id In Indicates the unique identifier of the notification subscription.

Y

filter In Indicates the subscription of

filter conditions.

Y

NOTE

For details of the syntax of filter, refer to 7.1.1 Notification filter Description.

Table 2-37 Values of changing subscription filter conditions

Returned Value Description Suppor

t (Y/N)

(47)

-Table 2-38 Exceptions of changing subscription filter conditions

Exception Description Suppo

rt (Y/ N)

InvalidParameter Indicates that the subscription_id or

filter is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported.

N

ChangeSubscriptionFilter Indicates the exceptions caused by unknown reasons.

Y

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, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-39 Parameters for querying subscription IDs

Parameter In/Out Description Support

(Y/N)

manager_reference In Indicates the identifier of the event receiver to be queried at the NMS side.

The parameter should be consistent with the specified

manager_refer-ence given by Subscribing Specified Notifications.

Y

Table 2-40 Values of querying subscription IDs

Returned Value Description Support

(Y/N)

SubscriptionIdSet Indicates the set of all subscription IDs related to manager_reference.

If a specified manager_reference is valid but not subscribed, the returned list is null.

(48)

Table 2-41 Exceptions of querying subscription IDs

Exception Description Support

(Y/N)

InvalidParameter Indicates that the manager_reference is invalid.

Y

OperationNotSupported Indicates that this operation is not supported. N GetSubscriptionIds Indicates the exceptions caused by unknown

reasons.

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 In/Out Description Support

(Y/N)

subscription_id In Indicates the unique identifier of the notification subscription.

Y

time_tick Out Indicates the value for invoking

attach_push.

Y

filter_in_effect Out Indicates the filter condition used by the current subscription.

Y

subscription_state Out Indicates the status of the current subscription, including:

l Active l Suspended

Because the Suspended status is not supported, only the Active status exists.

(49)

Table 2-43 Values of querying specified subscription parameters

Returned Value Description Support

(Y/N)

NotificationCategorySet Indicates the set of notification categories supported by the current subscription.

Y

Table 2-44 Exceptions of querying specified subscription parameters

Exception Description Support

(Y/N)

InvalidParameter Indicates that the subscription_id is invalid.

Y

OperationNotSupported Indicates that the operation is not supported. N GetSubscriptionStatus Indicates the exceptions caused by unknown

reasons.

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 By setting a heartbeat interval, the NMS can receive heartbeat notifications to monitor the status of communication channels between the NMS and IRPAgent.

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

(50)

Getting CSIRP Versions

l Function description

The NMS invokes get_CS_IRP_versions to get the CSIRP version information. l 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 Description Support (Y/N)

VersionNumberSet Indicates a set of versions that the EPIRP supports. The value of

VersionNumberSet is a set of strings.

Huawei supports only one of the EPIRP versions.

Y

Table 2-46 Exceptions of getting CSIRP versions

Exception Description Support (Y/N)

GetCSIRPVersions Indicates the exceptions caused by unknown reasons.

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 In/Out Description Support

(Y/N)

iRPVersion In 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.

(51)

Table 2-48 Values of getting CSIRP operation profile

Returned Value Description Support

(Y/N)

MethodList Indicates the information list of operations the CSIRP supports.

The information list contains the following items: l Names of operations

l Parameter lists

Y

Table 2-49 Exceptions of getting CSIRP operation profile

Exception Description Support

(Y/N)

InvalidParameter Indicates that iRPVersion is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported.

N

GetCSIRPOperationsProfile Indicates the exceptions caused by unknown reasons.

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.

l Function format ManagedGenericIRPConstDefs::MethodList get_CS_IRP_notification_profile ( in ManagedGenericIRPConstDefs::VersionNumber iRPVersion ) raises ( GetCSIRPNotificationProfile, ManagedGenericIRPSystem::OperationNotSupported, ManagedGenericIRPSystem::InvalidParameter); Table 2-50 Parameters for getting CSIRP notification profile

Parameter In/Out Description Support

(Y/N)

iRPVersion In 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.

(52)

Table 2-51 Values of getting CSIRP notification profile

Returned Value Description Support

(Y/N)

MethodList Indicates the profile list of notifications that a CSIRP supports.

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)

Y

Table 2-52 Exceptions of getting CSIRP notification profile

Exception Description Support

(Y/N)

InvalidIRPVersion Indicates that the iRPVersion is invalid or null.

Y

OperationNotSupported Indicates that this operation is not supported. N

GetCSIRPNotification-Profile

Indicates the exceptions caused by unknown reasons.

Y

Getting Heartbeat Period

l Function description

The NMS invokes get_heartbeat_period to get the interval for sending heartbeat notifications, that is, the heartbeat period.

l Function format

CSIRPConstDefs::ResultType get_heartbeat_period(

out CSIRPConstDefs::HeartbeatPeriodType heartbeatPeriod )

raises (GetHeartbeatPeriod);

Table 2-53 Parameters for getting heartbeat period

Parameter In/Out Description Support

(Y/N)

heartbeatPeriod Out Indicates the interval for which IRPAgent reports heartbeat

notifications periodically to the NMS (unit: minute).

Value range: 5 to 60 The default value is 5.

The value 0 is also valid and 0 means that the interval for sending heartbeat notifications is not set.

References

Related documents

This section outlines the method to find the best allocation of n distinguishable processors to m dis- tinguishable blocks so as to minimize the execution time.. Therefore,

The casualty rate for secondary schools (4.5 casualties per 1000 pupils) is significantly higher than that for primary schools (1.7), and our analysis found that a factor strongly

Most companies recruit for full-time and internship positions, but some indicate Co-Op as a recruiting priority, while not attending Professional Practice

• Storage node - node that runs Account, Container, and Object services • ring - a set of mappings of OpenStack Object Storage data to physical devices To increase reliability, you

The Department of Health, Physical Education, Recreation and Dance offers a Master of Science in Education in Health and Physical Education and a Master of Science in

We are now using the second part of our test database (see Figure 4 ) ; the boxpoints table which contains 3000 customer points, and the box table with 51 dierent sized bounding

It is the (education that will empower biology graduates for the application of biology knowledge and skills acquired in solving the problem of unemployment for oneself and others

In a surprise move, the Central Bank of Peru (BCRP) reduced its benchmark interest rate by 25 basis points (bps) to 3.25% in mid-January following disappointing economic growth data