Professional Documents
Culture Documents
Alcatel-Lucent 5620
SERVICE AWARE MANAGER | RELEASE 10.0 R5
3GPP OSS INTERFACE DEVELOPER GUIDE
Alcatel-Lucent Proprietary
This document contains proprietary information of Alcatel-Lucent and is not to be disclosed
or used except in accordance with applicable agreements.
Copyright 2012 © Alcatel-Lucent. All rights reserved.
Alcatel-Lucent assumes no responsibility for the accuracy of the information presented, which is
subject to change without notice.
Alcatel, Lucent, Alcatel-Lucent, the Alcatel-Lucent logo, lightRadio, and TiMetra are registered
trademarks of Alcatel-Lucent. All other trademarks are the property of their respective owners.
Disclaimers
Alcatel-Lucent products are intended for commercial uses. Without the appropriate network design
engineering, they must not be sold, licensed or otherwise distributed for use in any hazardous
environments requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life-support machines, or weapons
systems, in which the failure of products could lead directly to death, personal injury, or severe physical
or environmental damage. The customer hereby agrees that the use, sale, license or other distribution
of the products for any such application without the prior written consent of Alcatel-Lucent, shall be at
the customer's sole risk. The customer hereby agrees to defend and hold Alcatel-Lucent harmless from
any claims for loss, cost, damage, expense or liability that may arise out of or in connection with the
use, sale, license or other distribution of the products in such applications.
This document may contain information regarding the use and installation of non-Alcatel-Lucent
products. Please note that this information is provided as a courtesy to assist you. While Alcatel-Lucent
tries to ensure that this information accurately reflects information provided by the supplier, please refer
to the materials provided with any non-Alcatel-Lucent product and contact the supplier for
confirmation. Alcatel-Lucent assumes no responsibility or liability for incorrect or incomplete
information provided about non-Alcatel-Lucent products.
However, this does not constitute a representation or warranty. The warranties provided for
Alcatel-Lucent products, if any, are set forth in contractual documentation entered into by
Alcatel-Lucent and its customers.
This document was originally written in English. If there is any conflict or inconsistency between the
English version and any other version of a document, the English version shall prevail.
1. LICENSE
1.1 Subject to the terms and conditions of this Agreement, Alcatel-Lucent grants
to Customer and Customer accepts a nonexclusive, nontransferable license to
use any software and related documentation provided by Alcatel-Lucent
pursuant to this Agreement ("Licensed Program") for Customer's own internal
use, solely in conjunction with hardware supplied or approved by
Alcatel-Lucent. In case of equipment failure, Customer may use the Licensed
Program on a backup system, but only for such limited time as is required to
rectify the failure.
1.2 Customer acknowledges that Alcatel-Lucent may have encoded within the
Licensed Program optional functionality and capacity (including, but not
limited to, the number of equivalent nodes, delegate workstations, paths and
partitions), which may be increased upon the purchase of the applicable license
extensions.
1.3 Use of the Licensed Program may be subject to the issuance of an application
key, which shall be conveyed to the Customer in the form of a Supplement to
this End User License Agreement. The purchase of a license extension may
require the issuance of a new application key.
3. TERM
3.1 This Agreement shall become effective for each Licensed Program upon
delivery of the Licensed Program to Customer.
iii
3.2 Alcatel-Lucent may terminate this Agreement: (a) upon notice to Customer if
any amount payable to Alcatel-Lucent is not paid within thirty (30) days of the
date on which payment is due; (b) if Customer becomes bankrupt, makes an
assignment for the benefit of its creditors, or if its assets vest or become subject
to the rights of any trustee, receiver or other administrator; (c) if bankruptcy,
reorganization or insolvency proceedings are instituted against Customer and
not dismissed within 15 days; or (d) if Customer breaches a material provision
of this Agreement and such breach is not rectified within 15 days of receipt of
notice of the breach from Alcatel-Lucent.
3.3 Upon termination of this Agreement, Customer shall return or destroy all
copies of the Licensed Program. All obligations of Customer arising prior to
termination, and those obligations relating to confidentiality and nonuse, shall
survive termination.
4. CHARGES
4.1 Upon shipment of the Licensed Program, Alcatel-Lucent will invoice
Customer for all fees, and any taxes, duties and other charges. Customer will
be invoiced for any license extensions upon delivery of the new software
application key or, if a new application key is not required, upon delivery of
the extension. All amounts shall be due and payable within thirty (30) days of
receipt of invoice, and interest will be charged on any overdue amounts at the
rate of 1 1/2% per month (19.6% per annum).
iv
6.2 ALCATEL-LUCENT EXPRESSLY DISCLAIMS ALL OTHER
WARRANTIES, REPRESENTATIONS, COVENANTS OR CONDITIONS
OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION, WARRANTIES OR REPRESENTATIONS OF
WORKMANSHIP, MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, DURABILITY, OR THAT THE OPERATION
OF THE LICENSED PROGRAM WILL BE ERROR FREE OR THAT THE
LICENSED PROGRAMS WILL NOT INFRINGE UPON ANY THIRD
PARTY RIGHTS.
6.3 Alcatel-Lucent shall defend and indemnify Customer in any action to the
extent that it is based on a claim that the Licensed Program furnished by
Alcatel-Lucent infringes any patent, copyright, trade secret or other intellectual
property right, provided that Customer notifies Alcatel-Lucent within ten (10)
days of the existence of the claim, gives Alcatel-Lucent sole control of the
litigation or settlement of the claim, and provides all such assistance as
Alcatel-Lucent may reasonably require. Notwithstanding the foregoing,
Alcatel-Lucent shall have no liability if the claim results from any modification
or unauthorized use of the Licensed Program by Customer, and Customer shall
defend and indemnify Alcatel-Lucent against any such claim.
6.4 Alcatel-Lucent Products are intended for standard commercial uses. Without
the appropriate network design engineering, they must not be sold, licensed or
otherwise distributed for use in any hazardous environments requiring fail safe
performance, such as in the operation of nuclear facilities, aircraft navigation
or communication systems, air traffic control, direct life-support machines, or
weapons systems, in which the failure of products could lead directly to death,
personal injury, or severe physical or environmental damage. The Customer
hereby agrees that the use, sale, license or other distribution of the Products for
any such application without the prior written consent of Alcatel-Lucent, shall
be at the Customer's sole risk. The Customer also agrees to defend and hold
Alcatel-Lucent harmless from any claims for loss, cost, damage, expense or
liability that may arise out of or in connection with the use, sale, license or
other distribution of the Products in such applications.
7. LIMITATION OF LIABILITY
7.1 IN NO EVENT SHALL THE TOTAL COLLECTIVE LIABILITY OF
ALCATEL-LUCENT, ITS EMPLOYEES, DIRECTORS, OFFICERS OR
AGENTS FOR ANY CLAIM, REGARDLESS OF VALUE OR NATURE,
EXCEED THE AMOUNT PAID UNDER THIS AGREEMENT FOR THE
LICENSED PROGRAM THAT IS THE SUBJECT MATTER OF THE
CLAIM. IN NO EVENT SHALL THE TOTAL COLLECTIVE LIABILITY
OF ALCATEL-LUCENT, ITS EMPLOYEES, DIRECTORS, OFFICERS OR
AGENTS FOR ALL CLAIMS EXCEED THE TOTAL AMOUNT PAID BY
CUSTOMER TO ALCATEL-LUCENT HEREUNDER. NO PARTY SHALL
BE LIABLE FOR ANY INDIRECT, SPECIAL OR CONSEQUENTIAL
DAMAGES, WHETHER OR NOT SUCH DAMAGES ARE
FORESEEABLE, AND/OR THE PARTY HAD BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
7.2 The foregoing provision limiting the liability of Alcatel-Lucent's employees,
agents, officers and directors shall be deemed to be a trust provision, and shall
be enforceable by such employees, agents, officers and directors as trust
beneficiaries.
v
8. GENERAL
8.1 Under no circumstances shall either party be liable to the other for any failure
to perform its obligations (other than the payment of any monies owing) where
such failure results from causes beyond that party's reasonable control.
8.2 This Agreement constitutes the entire agreement between Alcatel-Lucent and
Customer and supersedes all prior oral and written communications. All
amendments shall be in writing and signed by authorized representatives of
both parties.
8.3 If any provision of this Agreement is held to be invalid, illegal or
unenforceable, it shall be severed and the remaining provisions shall continue
in full force and effect.
8.4 The Licensed Program may contain freeware or shareware obtained by
Alcatel-Lucent from a third party source. No license fee has been paid by
Alcatel-Lucent for the inclusion of any such freeware or shareware, and no
license fee is charged to Customer for its use. The Customer agrees to be
bound by any license agreement for such freeware or shareware. CUSTOMER
ACKNOWLEDGES AND AGREES THAT THE THIRD PARTY SOURCE
PROVIDES NO WARRANTIES AND SHALL HAVE NO LIABILITY
WHATSOEVER IN RESPECT OF CUSTOMER'S POSSESSION AND/OR
USE OF THE FREEWARE OR SHAREWARE.
8.5 Alcatel-Lucent shall have the right, at its own expense and upon reasonable
written notice to Customer, to periodically inspect Customer's premises and
such documents as it may reasonably require, for the exclusive purpose of
verifying Customer's compliance with its obligations under this Agreement.
8.6 All notices shall be sent to the parties at the addresses listed above, or to any
such address as may be specified from time to time. Notices shall be deemed
to have been received five days after deposit with a post office when sent by
registered or certified mail, postage prepaid and receipt requested.
8.7 If the Licensed Program is being acquired by or on behalf of any unit or agency
of the United States Government, the following provision shall apply: If the
Licensed Program is supplied to the Department of Defense, it shall be
classified as "Commercial Computer Software" and the United States
Government is acquiring only "restricted rights" in the Licensed Program as
defined in DFARS 227-7202-1(a) and 227.7202-3(a), or equivalent. If the
Licensed Program is supplied to any other unit or agency of the United States
Government, rights will be defined in Clause 52.227-19 or 52.227-14 of the
FAR, or if acquired by NASA, Clause 18-52.227-86(d) of the NASA
Supplement to the FAR, or equivalent. If the software was acquired under a
contract subject to the October 1988 Rights in Technical Data and Computer
Software regulations, use, duplication and disclosure by the Government is
subject to the restrictions set forth in DFARS 252-227.7013(c)(1)(ii) 1988, or
equivalent.
8.8 Customer shall comply with all export regulations pertaining to the Licensed
Program in effect from time to time. Without limiting the generality of the
foregoing, Customer expressly warrants that it will not directly or indirectly
export, reexport, or transship the Licensed Program in violation of any export
laws, rules or regulations of Canada, the United States or the United Kingdom.
vi
8.9 No term or provision of this Agreement shall be deemed waived and no breach
excused unless such waiver or consent is in writing and signed by the party
claimed to have waived or consented. The waiver by either party of any right
hereunder, or of the failure to perform or of a breach by the other party, shall
not be deemed to be a waiver of any other right hereunder or of any other
breach or failure by such other party, whether of a similar nature or otherwise.
8.10 This Agreement shall be governed by and construed in accordance with the
laws of the Province of Ontario. The application of the United Nations
Convention on Contracts for the International Sale of Goods is hereby
expressly excluded.
vii
viii
Preface
The Preface provides general information about the 5620 Service Aware Manager
documentation suite, including this guide.
Prerequisites
Readers of the 5620 SAM documentation suite are assumed to be familiar with the
following:
• 5620 SAM software structure and components
• 5620 SAM GUI operations and tools
• typical 5620 SAM management tasks and procedures
• device and network management concepts
Guide Description
5620 SAM Release The 5620 SAM Release Description provides information about the new features
Description associated with a 5620 SAM software release.
(1 of 4)
Guide Description
5620 SAM Planning Guide The 5620 SAM Planning Guide provides information about 5620 SAM scalability and
recommended hardware configurations.
5620 SAM System The 5620 SAM System Architecture Guide is intended for technology officers and
Architecture Guide network planners to increase their knowledge of the 5620 SAM software structure and
components. It describes the system structure, software components, and interfaces of
the 5620 SAM. In addition, 5620 SAM fault tolerance, security, and network
management capabilities are discussed from an architectural perspective.
5620 SAM | 5650 CPAM The 5620 SAM | 5650 CPAM Installation and Upgrade Guide provides OS considerations,
Installation and Upgrade configuration information, and procedures for the following:
Guide • installing, upgrading, and uninstalling 5620 SAM and 5650 CPAM software in
standalone and redundant deployments
• 5620 SAM system migration to a different system
• conversion from a standalone to a redundant 5620 SAM system
5620 SAM User Guide The 5620 SAM User Guide provides information about using the 5620 SAM to manage the
service-aware IP/MPLS network, including GUI basics, commissioning, service
configuration, and policy management.
The 5620 SAM User Guide uses a task-based format. Each chapter contains:
• a workflow that describes the steps for configuring and using the functions
• detailed procedures that list the configurable parameters on the associated forms
5620 SAM management information specific to LTE network elements is covered in the
5620 SAM LTE ePC User Guide and 5620 SAM LTE RAN User Guide.
5620 SAM management information specific to 1830 PSS network elements is covered in
the 5620 SAM Optical User Guide.
5620 SAM Integration The 5620 SAM Integration Guide provides procedures to allow the 5620 SAM to integrate
Guide with additional components.
5620 SAM Supervision The 5620 SAM Supervision Module User Guide provides information about how to
Module User Guide configure and use the web-based 5620 SAM Supervision Module for fault management
and at-a-glance network element monitoring.
5620 SAM Scripts and The 5620 SAM Scripts and Templates Developer Guide provides information that allows
Templates Developer users to develop, manage, and execute CLI-based or XML-based scripts or templates.
Guide The guide is intended for developers, skilled administrators, and operators who are
expected to be familiar with the following:
• CLI scripting, XML, and the Velocity engine
• basic scripting or programming
• 5620 SAM functions
There are dynamic links between the procedures in the 5620 SAM User Guide and the
parameter descriptions in the 5620 SAM Parameter Guide.
Parameters specific to LTE network elements are covered in the 5620 SAM LTE
Parameter Reference.
Parameters specific to 1830 PSS network elements are covered in the 5620 SAM Optical
Parameter Reference.
5620 SAM Statistics The 5620 SAM Statistics Management Guide provides information about how to
Management Guide configure performance and accounting statistics collection and how to view counters
using the 5620 SAM. Network examples are included.
(2 of 4)
Guide Description
5620 SAM Maintenance The 5620 SAM Maintenance Guide provides procedures for:
Guide • generating baseline information for 5620 SAM applications
• performing daily, weekly, monthly, and as-required maintenance activities for
5620 SAM-managed networks
5620 SAM Troubleshooting The 5620 SAM Troubleshooting Guide provides task-based procedures and user
Guide documentation to:
• help resolve issues in the managed and management networks
• identify the root cause and plan corrective action for:
• alarm conditions on a network object or customer service
• problems on customer services with no associated alarms
• list problem scenarios, possible solutions, and tools to help check:
• network management LANs
• network management platforms and operating systems
• 5620 SAM client GUIs and client OSS applications
• 5620 SAM servers
• 5620 SAM databases
5620 SAM Alarm Reference The 5620 SAM Alarm Reference provides a description of all alarms supported on the
5620 SAM, including LTE and optical alarms, the raising and clearing conditions of each
alarm, and the remedial action to fix the problem. The reference is organized by
network element type.
5620 SAM Glossary The 5620 SAM Glossary defines terms and acronyms used in all of the 5620 SAM
documentation, including 5620 SAM LTE documentation.
5620 SAM Network The 5620 SAM Network Element Compatibility Guide provides release-specific
Element Compatibility information about the compatibility of managed devices in 5620 SAM releases. This
Guide document is updated regularly; always consult the latest version on OLCS as described
in Documentation on the web.
5620 SAM LTE documentation
5620 SAM LTE Release The 5620 SAM LTE Release Description provides information about the LTE features
Description associated with the release.
5620 SAM LTE ePC User The 5620 SAM LTE ePC User Guide describes how to discover, configure, and manage
Guide LTE ePC devices using the 5620 SAM. The guide is intended for LTE ePC network
planners, administrators, and operators and is to be used in conjunction with other
guides in the 5620 SAM documentation suite where management of ePC devices does not
differ from other network elements.
Alcatel-Lucent recommends that you review the entire 5620 SAM LTE ePC User Guide
before you attempt to use the 5620 SAM in your LTE network.
5620 SAM LTE RAN User The 5620 SAM LTE RAN User Guide describes how to discover, configure, and manage
Guide the Evolved NodeB, or eNodeB, using the 5620 SAM. The guide is intended for LTE RAN
network planners, administrators, and operators and is to be used in conjunction with
other guides in the 5620 SAM documentation suite where management of RAN devices
does not differ from other network elements.
Alcatel-Lucent recommends that you review the entire 5620 SAM LTE RAN User Guide
before you attempt to use the 5620 SAM in your LTE network.
5620 SAM LTE Parameter The 5620 SAM LTE Parameter Reference provides a list of all LTE ePC and LTE RAN
Reference parameters supported in the 5620 SAM.
5620 SAM XML OSS The 5620 SAM XML OSS Interface Developer Guide provides information that allows you
Interface Developer Guide to:
• use the 5620 SAM XML OSS interface to access network management information
• learn about the information model associated with the managed network
• develop OSS applications using the packaged methods, classes, data types, and
objects necessary to manage 5620 SAM functions
(3 of 4)
Guide Description
5620 SAM 3GPP OSS The 5620 SAM 3GPP OSS Interface Developer Guide describes the components and
Interface Developer Guide architecture of the 3GPP OSS interface to the 5620 SAM. It includes procedures and
samples to assist OSS application developers to use the 3GPP interface to manage LTE
devices.
5620 SAM 3GPP OSS The 5620 SAM 3GPP OSS Interface Compliance Statements document describes the
Interface Compliance compliance of the 5620 SAM 3GPP OSS interface with the 3GPP standard.
Statements
5620 SAM Optical User The 5620 SAM Optical User Guide describes how to discover, configure, and manage
Guide optical devices using the 5620 SAM. The guide is intended for optical network planners,
administrators, and operators and is to be used in conjunction with other guides in the
5620 SAM documentation suite where management of optical devices does not differ
from other network elements.
Alcatel-Lucent recommends that you review the entire 5620 SAM Optical User Guide
before you attempt to use the 5620 SAM in your network.
5620 SAM Optical The 5620 SAM Optical Parameter Reference provides a list of all optical device
Parameter Reference parameters supported in the 5620 SAM.
5650 CPAM User Guide The 5650 CPAM User Guide describes how to capture, inspect, visualize, and
troubleshoot IGP and BGP topologies using the 5650 CPAM.
7701 CPAA Hardware The 7701 CPAA Hardware Revision 2 Setup and Software Installation Instructions
Revision 1 Setup and describes the hardware setup and software installation for the 7701 CPAA Hardware
Software Installation Revision 1, the route analyzer component of the 5650 CPAM.
Instructions
7701 CPAA Hardware The 7701 CPAA Hardware Revision 2 Setup and Software Installation Instructions
Revision 2 Setup and describes the hardware setup and software installation for the 7701 CPAA Hardware
Software Installation Revision 2, the route analyzer component of the 5650 CPAM.
Instructions
(4 of 4)
On-product documentation
The 5620 SAM on-product customer documentation is delivered in HTML and PDF.
Choose Help→User Documentation from the 5620 SAM client GUI to open the help
system in a web browser.
The help system opens to the User Documentation Index, which provides a summary
of and links to all 5620 SAM customer documents.
Click on the Using the help system tab on the User Documentation Index page to find
usage tips for navigating and searching within the on-product customer
documentation.
You can return to the User Documentation Index at any time by clicking on the Home
icon, shown in Figure 1.
xii September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Preface
Documentation conventions
Table 2 lists the conventions that are used throughout the documentation.
(1 of 2)
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 xiii
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Preface
(2 of 2)
At step 1, you can choose option a or b. At step 2, you must do what the step
indicates.
1 This step offers two options. You must choose one of the following.
At step 1, you must perform a series of substeps within a step. At step 2, you must
do what the step indicates.
1 This step has a series of substeps that you must perform to complete the step. You
must perform the following substeps.
Measurement conventions
Measurements in this document are expressed in metric units and follow the Système
international d’unités (SI) standard for abbreviation of metric units. If imperial
measurements are included, they appear in brackets following the metric unit.
Table 3 lists the measurement symbols used in this document.
xiv September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Preface
Measurement Symbol
bit b
byte byte
Important information
The following conventions are used to indicate important information:
xvi September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Contents
Preface ix
Prerequisites............................................................................................ ix
5620 SAM documentation suite ...................................................................... ix
Obtaining customer documentation ............................................................... xii
On-product documentation .......................................................... xii
Documentation on the web ......................................................... xiii
Documentation conventions........................................................................ xiii
Procedures with options or substeps ...............................................xiv
Measurement conventions ...........................................................xiv
Important information................................................................ xv
2— Introduction 2-1
2.1 5620 SAM 3GPP OSS interface overview ............................................. 2-2
Before you begin ..................................................................... 2-2
2.2 3GPP overview........................................................................... 2-3
2.3 About this guide ......................................................................... 2-3
2.4 Supported devices and technologies ................................................. 2-4
2.5 Open interfaces professional support ................................................ 2-4
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 xvii
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Contents
3— IRPs 3-1
3.1 IRP overview ............................................................................. 3-2
3.2 IRP framework and concepts .......................................................... 3-2
3.3 IRP components ......................................................................... 3-3
3.4 5620 SAM 3GPP OSS interface solutions sets ........................................ 3-3
3.5 3GPP OSS interface compliance statements overview ............................ 3-4
3.6 5620 SAM 3GPP OSS interface IRPS ................................................... 3-5
Entry Point IRP........................................................................ 3-6
Fault Management/Alarm IRP ...................................................... 3-9
Basic CM IRP.......................................................................... 3-13
Notification IRP...................................................................... 3-17
Communication Surveillance IRP.................................................. 3-22
Kernel IRP ............................................................................ 3-23
Generic IRP........................................................................... 3-24
xviii September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Contents
Appendices
C. Troubleshooting C-1
C.1 3GPP OSS troubleshooting overview ................................................. C-2
C.2 Diagnosing typical 3GPP installation problems on the 5620 SAM server ........ C-2
Typical installation problem........................................................ C-2
Procedure C-1 To update the cnbi.properties file in the 5620 SAM ......... C-2
Troubleshooting 3GPP OSS SSL communication problems ..................... C-3
Procedure C-2 To verify the JMS status of the 3GPP OSS Interface ........ C-3
Verifying that messages are being received by the 3GPP OSS interface
from the 5620 SAM ............................................................. C-4
Firewall preventing OSS client access to the 3GPP OSS Interface
using the CORBA solution set ................................................. C-4
Problems referencing the Entry Point IOR ....................................... C-4
Incorrect configuration of the System DN ........................................ C-4
Problems receiving alarms and events when SPAN is configured ............. C-5
C.3 Useful logs................................................................................ C-5
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 xix
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Contents
2 — Introduction
3 — IRPs
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 1-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
1 — 5620 SAM 3GPP OSS features and functions
Table 1-1 lists the features and functions added in 5620 SAM 3GPP OSS Release
10.0.
SOAP/XML solution set The 5620 SAM 3GPP OSS now supports the SOAP/XML solution set. See the
5620 SAM 3GPP OSS
Interface Developer
Guide and
5620 SAM 3GPP OSS
Interface
Compliance
Statements.
1-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2— Introduction
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 2-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2 — Introduction
The 3GPP OSS interface provides two different 3GPP solutions sets (APIs) that
implement the following transport protocols for communicating with OSS clients:
• 3GPP CORBA API
• 3GPP SOAP/XML API
The 3GPP OSS interface is included in the overall architecture of the 5620 SAM
server as the 3GPP component of the 5620 SAM-O. Integration between the
5620 SAM and the 3GPP OSS interface happens at the 5620 SAM-O interface. The
5620 SAM-O is a 5620 SAM module that provides an XML interface to the
5620 SAM. See the 5620 SAM System Architecture Guide for more information
about 5620 SAM architecture.
Note 1 — The 5620 SAM license key has to include the 5620 SAM-O
module before an OSS can integrate with the 3GPP OSS interface.
See the 5620 SAM User Guide for more information about 5620 SAM
licensing.
Note 2 — The 3GPP OSS interface has to be enabled during the
5620 SAM server installation before an OSS can communicate with
the 5620 SAM. See the 5620 SAM | 5650 CPAM Installation and
Upgrade Guide for more information.
Note 3 — An OSS can communicate with the 5620 SAM using either
the 5620 SAM XML OSS interface or the 3GPP OSS interface. See
the 5620 SAM XML OSS Interface Developer Guide for more
information about developing OSS applications using the SOAP
XML/JMS API.
2-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2 — Introduction
• OSS interfaces
• LTE managed devices
• 5620 SAM functionality
Alcatel-Lucent recommends that developers perform the following tasks prior to
working in an OSS development environment:
• Review the requirements for license key configuration and platform size
considerations. See the 5620 SAM Planning Guide for more information.
• Pre-configure the device that you want the 5620 SAM to manage. See the device
documentation for more information.
• Back up the 5620 SAM database. A database backup utility is available in the
5620 SAM client GUI and through a CLI. See the 5620 SAM User Guide for
more information.
The 5620 SAM 3GPP OSS Interface Developer Guide provides information to help
OSS developers create applications that perform 5620 SAM-specific functions on an
LTE network. It is part of the 5620 SAM LTE documentation set, which also
includes the 5620 SAM 3GPP OSS Interface Compliance Statements.
This guide contains and overviews of the 3GPP OSS interface and IRPs, information
about OSS domains and communicating with OSS clients, and 3GPP OSS code
samples for both solution sets.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 2-3
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2 — Introduction
The 5620 SAM 3GPP OSS interface supports the retrieval of data including
receiving notifications for the following LTE NE types:
• eNode B
• 9471 WMM
The 5620 SAM 3GPP OSS interface uses the following technologies:
• XML • Java
• SOAP • CORBA
• HTTP(S) • JBoss
• WSDL • 3GPP
See the 5620 SAM System Architecture Guide for more information about the
standards compliance and versions of these technologies.
2-4 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2 — Introduction
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 2-5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
2 — Introduction
2-6 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3— IRPs
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
The 3GPP management interface concept called Integration Reference Point, or IRP,
promotes the adoption of standardized management interfaces in telecommunication
networks. The IRP concept and associated methodology use protocol- and
technology-neutral modeling methods, and protocol-specific solution sets.
The 3GPP publishes IRP specifications for operations and notifications for
telecommunication domains such as alarm, configuration, and performance
management. Detailed IRP specifications are available on the 3GPP website at
http:\\www.3gpp.org\specifications under the TSG SA WG5 for Telecom
Management.
There are also three categories of IRP specifications: Interface, NRM, and Data
Definitions. These categories are partitioned into the three specification levels
described above.
Figure 3-1 illustrates the approach for the level specifications combined with the
categories.
3-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Changes with
Solution Set Defenitions (CORBA, SOAP, XML, CMIP) new better
Technologies
Solution Set Defenitions (other/future e.g. JAVA, SNMP)
22884
The 5620 SAM server contains the IRP agent (which is the 3GPP OSS interface), and
an OSS application is considered the IRP manager.
The 3GPP OSS interface includes both a CORBA and SOAP/XML solution set.
The CORBA solution set includes an ORB implementation (JacORB) and a
Notification Service implementation (TAO). CORBA Interface Definition Language
(IDL) provides a language-neutral way of specifying the classes, or interfaces, of the
objects within the application. An interface consists of a set of named operations and
operation parameters. The 3GPP CORBA IDLs are based on the 3GPP standards
defined by the compliance statement for the supported IRPs.
The SOAP/XML solution set is implemented as a web service and deployed in
JBoss. It uses a callback mechanism for sending and receiving SOAP/XML
formatted messages. Web Services Description Language (WSDL), in combination
with SOAP and XML Schema, provides web services in a standard format. The
3GPP OSS interface WSDL file is based on the 3GPP standards defined by the
compliance statements for the supported IRPs.
The IDL and WSDL files that define the solution sets for the 3GPP OSS interface are
located in the following directory on a 5620 SAM main server:
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-3
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
path/nms/integration/SAM_O/3GPP
where path is the 5620 SAM main server installation directory, typically
/opt/5620sam/server
The 5620 SAM 3GPP OSS interface Compliance Statements include information
about all the supported IRPs. Each IRP supported by an IRP agent includes a set of
operations and notifications. The Compliance Statements define whether an
interface’s operation and notification is mandatory or optional. It also includes the
compliant versions for each of the 3GPP solution sets.
For example, Table 3-1 lists the interfaces that are defined for the Communication
Surveillance, or CS, IRP.
The compliance statements also include the following details for each supported
IRP:
• References—provides the list of 3GPP Technical Specifications numbers for the
IRPs requirements, Information Service, CORBA solution set, and SOAP/XML
solution set
• General—provides high-level general information on the IRP if required
3-4 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
See the 5620 SAM 3GPP OSS Interface Compliance Statements for more
information.
By default, once the 5620 SAM server is started the IRPs will be initialized by the
3GPP OSS Interface and made available for OSS clients to access the SAM LTE
network. See section 4.5 for more information about starting, stopping, and getting
the status of the 3GPP OSS interface processes.
Note 1 — Although the 3GPP OSS interface supports the IRPs
described above, it may not support all interfaces and methods
defined in the 3GPP standard specifications. See Appendix B for
more information.
Note 2 — The Alarm IRP is not supported for the SOAP/XML
solution set.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
try
{
org.omg.CORBA.Object entryPointObj = orb.string_to_object(ior);
entryPointIRP = EPIRPHelper.narrow(entryPointObj);
}
catch (Exception e)
{
e.printStackTrace();
}
3-6 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
where
IP address is the IP address of the server where the 5620 SAM is installed
port is the port number of the Jboss web server, typically 8980
See the 5620 SAM Planning Guide for more information about setting ports.
Once an OSS client is provided with this URL, it can start interacting with the 3GPP
OSS interface without further security enforcements.
Code 3-2 shows an example of IRP reference retrieval using the SOAP/XML Entry
Point IRP.
“EntryPointIRPService”));
return entryPointService.getEntryPointIRPPort();
getIRPOutline method
The Entry Point IRP includes the getIRPOutline method, which is used to obtain
information about all supported IRPs.
Code 3-3 shows an example of CORBA getIRPOutline method invocation.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-7
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Table 3-2 describes the supported IRP version information that should be returned
when the getIRPOutline method is used for each 3GPP OSS solution set.
3-8 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
getIRPReference method
The Entry Point IRP includes the getIRPReference method, which is used to request
a reference for a specific IRP.
Code 3-5 shows a generic example of method invocation for retrieving the reference
for any IRP supported by the CORBA solution set.
where
<IRP> is KernelIRP, HeartBeatIRP, NotificationIRP, BasicCM, or AlarmIRP
<IRP_operation> is _KernelCMIrpOperations, CSIRP, NotificationIRP,
_BasicCmIrpOperations, or AlarmIRP
Code 3-6 shows a generic example of method invocation for retrieving the reference
for any IRP supported by the SOAP/XML solution set.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-9
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Alarm and state-change detection and notification are essential. A list of the current
network alarms, operational state information, and the associated history data are
required for further fault analysis. Additionally, test procedures can be used to obtain
more detailed information, if required, and to verify an alarm or operational state to
ensure correct NE operation and the proper use of resources.
See Code 3-5 for a generic code sample that can be used to gain access to the Fault
Management/Alarm IRP for the CORBA solution set.
acknowledgeAlarms method
The Fault Management/Alarm IRP includes the acknowledgeAlarms method. The
method updates the specified alarm in the following ways:
• sets the Acknowledgement State to Acknowledged
• adds the ackUserId and ackSystemId values as comments to the alarm
• sets the Acknowledgement Time of the alarm to the current time
3-10 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
If an acknowledgeAlarms operation fails, the list of errors, which includes the alarm
identifiers and error codes, is stored in the bad alarm information object. This object
is defined as a CORBA holder, and has to be created and passed by reference to the
method.
clearAlarms method
The Fault Management/Alarm IRP includes the clearAlarms method, which clears
one or more alarm instances in an alarm list.
If a clearAlarms operation fails, the list of errors, which includes the alarm identifiers
and error codes, is stored in the bad alarm information object. This object is defined
as a CORBA holder, and has to be created and passed by reference to the method.
commentAlarms method
The Fault Management/Alarm IRP includes the commentAlarms method, which
records one or more alarm information instances in an alarm list.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-11
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
}
catch (Exception e)
{
e.printStackTrace();
fail();
}
If a commentAlarms operation fails, the list of errors, which includes the alarm
identifiers and error codes, is stored in the bad alarm information object. This object
is defined as a CORBA holder, and has to be created and passed by reference to the
method.
getAlarmList method
The Fault Management/Alarm IRP includes the getAlarmList method, which returns
the set of current alarms. The returned alarm list contains all alarms in the current
alarm list. Depending on the network manager fault management configuration, this
may include the following:
• alarms that have a perceivedSeverity other than Cleared, and alarms that have a
perceivedSeverity of Cleared but are not acknowledged
• only alarms that have a perceivedSeverity other than Cleared
The alarm life cycle reported by the interface is provided by the network manager.
Note — This operation is only supported in synchronous mode,
which means that the data is returned using an iterator and not using
a notification.
3-12 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
{
resultList.addAll(Arrays.asList(alarm_informations.value));
}
resultList.addAll(Arrays.asList(alarm_informations.value));
getAlarmCount method
The Fault Management/Alarm IRP includes the getAlarmCount method, which
retrieves a list of alarm counts, organized by severity, for alarms in raised, cleared,
and acknowledged states.
Code 3-11 shows an example of getAlarmCount method invocation.
The counters are defined as CORBA holders, and are created and passed by
reference. The counter values are retrievable after the method invocation.
Basic CM IRP
Configuration Management, or CM, provides the ability to ensure correct and
effective network operation. Basic CM actions control and monitor the NE and
network resource configurations, and can be initiated by an operator or by functions
in an NE operations system.
The Basic CM IRP allows OSS clients to invoke methods that retrieve basic data
about the 3GPP NEs in the network. This data can be associated with data from other
functions, for example, alarm management.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-13
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Supported NE Types
The 5620 SAM 3GPP device OSS interface supports the retrieval of data for the
following LTE devices:
• eNodeB
• 9471 WMM
See Code 3-5 for a generic code sample that can be used to gain access to the Basic
CM IRP for the CORBA solution set.
See Code 3-6 for a generic code sample that can be used to gain access to the Basic
CM IRP for the SOAP/XML solution set.
getMOAttributes method
The Basic CM IRP includes the goMOAttributes method, which returns the list of
NEs and option supported attributes, or specific NE and optional attributes.
Code 3-12 shows an example of CORBA getMOAttributes and getContainment
methods invocation.
3-14 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
result = batchHolder.value;
-
-
-
-
for (Iterator<String> iterator =
ATTRIBUTES_NAMES.iterator(); iterator.hasNext();) {
writer.print(iterator.next());
if (iterator.hasNext()) {
writer.print(‘\t’);
} else {
writer.print(‘\n’);
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-15
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
}
}
BasicCMIRP basicCmPort = getBasicCMIRPPort(properties,writer);
Holder<MOSequenceType> moiListOut = new Holder<MOSequenceType>();
basicCmPort.getMOAttributes(““, baseObject, new Holder<String>()),
moiListOut;
getContainment method
The Basic CM IRP includes the getContainment method, which returns the list of
NEs or a specific NE.
See Code 3-12 for a code sample that can be used to invoke the getContainment
method for the CORBA solution set.
Code 3-14 shows an example of SOAP/XML getContainment method invocation.
public GetContainmentWSOnlineClient() {
super(“GetContainmentIRP”, mandatoryPropertiesNames);
}
3-16 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Notification IRP
NEs generate notifications about network events. Different kinds of events carry
different kinds of information such as the following:
• a new alarm, as specified in Alarm IRP: Information Service
• an object creation, as specified in Basic CM IRP: Information Service
The Notification IRP defines an interface through which an IRP manager (OSS
application) can subscribe to an IRP agent (3GPP OSS interface) for receiving a
notification.
The 5620 SAM 3GPP OSS interface supports the following notification types:
• alarm—forwarded when alarm events are received from the alarm feeder
(specified in the Alarm IRP)
• heartbeat—sent by the 3GPP OSS interface to each attached client (specified in
the CS IRP)
• kernel—sent when the 3GPP OSS interface host system notifies the interface
about NE creation, deletion or modification (specified in the Kernel IRP)
See Code 3-5 for a generic code sample that can be used to gain access to the
Notification IRP for the CORBA solution set.
See Code 3-6 for a generic code sample that can be used to gain access to the
Notification IRP for the SOAP/XML solution set.
This Notification IRP includes the following methods:
• Subscribe—creates a subscription for receiving notifications
• Unsubscribe—cancels a subscription
• getSubscriptionStatus—obtains the subscription status and informs the IRP agent
about whether a subscription is required
• changeSubscriptionFilter—replaces the current subscription filter
• getSubscriptionIds—obtains the ID assigned by the Notification IRP to each
valid subscription; a valid subscription is a subscription that is not unsubscribed
or removed by the IRP agent
• getNotificationCategories—obtains a list of the notification categories that the
IRP agent supports
Subscribe method
The Notification IRP includes the Subscribe method, which creates a subscription for
receiving notifications.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-17
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
3-18 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
UnSubscribe method
The Notification IRP includes the UnSubscribe method, which cancels a
subscription.
Code 3-17 shows an example of the CORBA UnSubscribe method invocation. The
input parameters are the CORBA reference of the subscription and the subscription
ID, which are obtained by the subscription operator in the Subscribe method.
unsubscribeParameter.setManagerReference(managerReference);
unsubscribeParameter.setSubscriptionId(subscriptionId);
getNotificationIrpProxy().unsubscribe(unsubscribeParameter);
endpoint.stop();
System.out.printIn(“Disconnected.”);
getSubscriptionStatus method
The Notification IRP includes the getSubscriptionStatus method, which obtains
subscription status and informs the IRP agent about whether a subscription is
required.
String[] cats =
notificationIRP.get_subscription_status(subscriptionId,
filter_in_effect, subscription_state, time_tick_holder);
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-19
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
changeSubsciptionFilter method
The Notification IRP includes the changeSubscriptionFilter method, which replaces
the current subscription filter.
Code 3-21 shows an example of the CORBA changeSubsciptionFilter method
invocation. The input parameters are the CORBA reference of the subscription and
the subscription ID, which are obtained by the subscription operator in the Subscribe
method.
Note — Since the SOAP/XML solution set does not support filtering,
this method is not useful for that solution set.
getSubscriptionIds method
The Notification IRP includes the getSubscriptionIds method, which obtains the ID
assigned by the Notification IRP to each valid subscription. A valid subscription is a
subscription that is not unsubscribed or removed by the IRP agent.
Code 3-22 shows an example of the CORBA getSubscriptionIds method invocation.
The input parameters are the CORBA reference of the subscription and the
subscription ID, which are obtained by the subscription operator in the Subscribe
method.
3-20 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
getNotificationCategories method
The Notification IRP includes the getNotificationCategories method, which obtains
a list of the notification categories that the IRP agent supports (alarm, heartbeat, or
kernel).
Code 3-24 shows an example of the CORBA getNotificationCategories method
invocation. The input parameters are the CORBA reference of the subscription and
the subscription ID, which are obtained by the subscription operator in the Subscribe
method.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-21
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
getHeartBeatPeriod method
The Communication Surveillance IRP includes the getHeartBeatPeriod method.
Code 3-26 shows an example of the CORBA getHeartBeatPeriod method
invocation.
3-22 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Kernel IRP
The Kernel IRP contains a method that retrieves the list of network resource IRP
versions. It also defines the notification capability for NEs and NE management
systems. The 3GPP Kernel IRP standard supports the following notification types:
• object creation
• object deletion
• attribute value change
• requirement to partially or fully resynchronize the configuration information
Note — The 5620 SAM 3GPP OSS interface does not support the
resynchronization notification.
See Code 3-5 for a generic code sample that can be used to gain access to the Kernel
IRP for the CORBA solution set.
See Code 3-6 for a generic code sample that can be used to gain access to the Kernel
IRP for the SOAP/XML solution set.
getNRMIRPVersion method
The Communication Surveillance IRP includes the getNRMIRPVersion method.
Code 3-28 shows an example of the CORBA getNRMIRPVersion method
invocation.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-23
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
Generic IRP
Each IRP supports a set of common services. The Generic IRP defines the retrieval
of IRP profile notification or operation information and the supported versions of a
specific IRP. The methods defined in this section are inherited by other IRPs.
Note — The returned values vary depending on the IRP specified.
getIRPOutline method
The Generic IRP includes the getIRPOutline method, which returns the supported
IRP versions for an interface.
Code 3-30 shows an example of the CORBA getIRPOutline method invocation.
}
catch (Exception e)
{
e.printStackTrace();
}
getEntryPointProxy(getSamServerIpAddres()).getIRPOutline(version,
supportedIRPList, status);
SupportedIRP supportedIRP =
supportedIRPList.value.getSupportedIRP().get(0);
for (IRPElement irpElement :
supportedIRP.getIRPList().getIRPElement()) {
writer.printIn(irpElement.getRDN() + ‘t\’ +
irpElement.getIRPVersionSet().getVersionNumber());
}
3-24 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
writer.printIn(“Operation status: “ +
status.value.value());
} catch (GetIRPOutlineFault getIRPOutlineFault) {
writer.printIn(“GetIRPOutlineFault caught: “ +
getIRPOutlineFault.getFaultInfo());
}
getOperationsProfile method
The Generic IRP includes the getOperationsProfile method, which returns the
operations supported by a specified IRP.
Code 3-32 shows an example of the CORBA getOperationsProfile method
invocation.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 3-25
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
3 — IRPs
getNotificationsProfile method
The Generic IRP includes the getNotificationsProfile method, which returns the
notifications supported by a specified IRP.
Code 3-34 shows an example of the CORBA getNotificationsProfile method
invocation.
3-26 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4— Communicating with OSS clients
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
In order for OSS applications to connect to the 3GPP OSS interface, the following
configurations must be made on the 5620 SAM server:
• The 5620 SAM server must be licensed with an application key that activates the
5620 SAM-O package. See the 5620 SAM User Guide for more information.
• The 5620 SAM server must have the correct hardware configuration, including
memory size. See the 5620 SAM Planning Guide for more information.
• The 3GPP OSS interface package must be enabled during 5620 SAM server
installation. See the 5620 SAM | 5650 CPAM Installation and Upgrade Guide for
more information.
• Redundancy must be configured if working with a redundant 5620 SAM server
configuration. See the Redundancy section for more information.
Once the 5620 SAM server is installed with the 3GPP OSS interface enabled, the
processes of both the CORBA and SOAP/XML interfaces are now available for
connection with an OSS application.
In order for OSS applications to make an initial connection to the 3GPP OSS
interface, the OSS must access the Entry Point IRP that provides a standard
mechanism for discovering other supported IRPs and the associated references. See
Chapter 3 for more information about accessing the Entry Point IRP using either the
CORBA or SOAP/XML solution set.
Once the OSS application accesses the Entry Point IRP, a connection is established
with the 5620 SAM server and other IRPs become available for use based on the
requirements of the OSS application. The supported applications can be Fault
Management or Inventory Management. See Chapter 5 for more information.
This section describes the event monitoring function of the 3GPP OSS interface.
4-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
When the Notification IRP is initialized, for example, during 5620 SAM main server
startup, it creates one event channel and connects a proxy push consumer for that
channel with a push supplier. This supplier is used to send all 3GPP notifications.
Note — The Alarms notification type cannot be sent by the
SOAP/XML solution set to registered OSS clients.
Perform this procedure to subscribe to event notifications using the 3GPP OSS
interface.
1 Obtain the Entry Point reference using the method shown in Code 4-1.
2 Obtain the Notification IRP reference using the method shown in Code 4-2.
3 Send a subscribe request using the method shown in Code 4-3. The Notification IRP
subsequently obtains a proxy push supplier from the event channel and connects
the OSS client reference. which is the push consumer, to the proxy.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-3
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
4 Use the 3GPP OSS interface to listen for incoming event notifications that the
Notification IRP pushes to the proxy Push Consumer.
5 To unsubscribe from event notifications, use the method shown in Code 4-4.
Perform this procedure to subscribe to event notifications using the 3GPP OSS
interface.
1 Obtain the Entry Point reference using the method shown in Code 4-5.
4-4 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
2 Obtain the Notification IRP reference using the method shown in Code 4-6.
getEntryPointProxy(getSamServerIpAddress()).getIRPReference(managerI
dentifier, systemDN, “NotifactionIRP=1” , iRPReference, status);
writer.printIn(iRPReference.value + ‘\t’ +status.value.value());
} catch (GetIRPReferenceFault getIRPReferenceFault) {
writer.printIn(“getIRPReferenceFault caught: “ +
getIRPReferenceFault.getFaultInfo());
}
3 Send a subscribe request using the method shown in Code 4-7. The Notification IRP
subsequently obtains a proxy push supplier from the event channel and connects
the OSS client reference. which is the push consumer, to the proxy.
4 Use the 3GPP OSS interface to listen for incoming event notifications that the
Notification IRP pushes to the proxy Push Consumer.
5 To unsubscribe from event notifications, use the method shown in Code 4-8.
unsubscribeParameter.setManagerReference(managerReference);
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
unsubscribeParameter.setSubscriptionId(subscriptionId);
getNotificationIrpProxy().unsubscribe(unsubscribeParameter);
endpoint.stop();
System.out.printIn(“Disconnected.”);
Filtering
The 3GPP OSS interface supports a subset of 3GPP filters that can be used in
alarm-list and alarm-count retrieval operations. Fault notifications are not filtered.
3GPP alarm filtering supports the following attributes:
• Probable cause
• Perceived severity
• Alarm type
• Ack state
You can combine these attributes using AND and OR operators to create more
specific filters.
The supported filtering operations, syntax, and attribute names that can be included
as filter criteria are listed in Appendix A.
Connection monitoring
The 3GPP OSS interface notification service maintains an event queue for each
registered consumer. If the number of events in a queue reaches the maximum, for
example, if a consumer cannot keep up with the notification rate, the 5620 SAM does
the following:
• disconnects the consumer, and marks the consumer subscriptions as invalid
• discards all notifications for the consumer
The 5620 SAM 3GPP OSS interface provides bidirectional connection surveillance
using a heartbeat function. If the 5620 SAM main server becomes unavailable, the
OSS client requests received on the 3GPP interface fail, and an error message is sent
to the OSS client. Subsequent requests succeed if the server becomes available.
Contact Alcatel-Lucent technical support to obtain a list of the supported exceptions
for a specific method. See chapter 3 for information about connection surveillance.
4-6 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
The 5620 SAM 3GPP OSS interface monitors the state of each client subscription.
When a failure is detected, for example, when an exception is raised to the OSS
client, the 3GPP OSS interface maintains the OSS client connection and tries to
reconnect with the 5620 SAM main server. See section 4.4 for more information
about connection failures and redundancy.
Error recovery
The 3GPP OSS interface can recover from system restarts and from client connection
interruptions.
4.3 Security
This section describes the security considerations for the 5620 SAM 3GPP OSS
interface.
User security
A 5620 SAM 3GPP OSS user account must have span of control profile(s)
configured to include LTE devices only. The span IDs that identify groups of LTE
devices also need to be included in the CNBI.SAMO.SPAN.ID property in the
path/nms/home/config/cnbi.properties file, where path is the 5620 SAM main server
installation directory (typically /opt/562sam/server. It allows several span IDs
separated by commas, for example
CNBI.SAMO.SPAN.ID = 27 , 32
See the 5620 SAM User Guide for information about configuring user groups scope
of command and span of control profiles.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-7
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
SSL security
The 5620 SAM 3GPP OSS user uses a HTTP (default) or HTTPS encryption
protocol for sending requests and receiving responses through the 5620 SAM-O
interface to the 5620 SAM server. See the 5620 SAM User Guide for information on
how to configure the 5620 SAM server for HTTP or HTTPS.
If SSL is enabled for 5620 SAM main server, you will need to configure the file
located at <installation_directory>/nms/cnbi/home/config/cnbi.properties.
where
<installation_directory> is the home directory of the 5620 SAM server installation,
typically /opt/5620sam/server.
Configure the following properties:
• CNBI.SAMO.ServerCertFile = full path name of the SAM keystore file (Ex:
/opt/5620sam/server/nms/config/ssl/trustStore)
• CNBI.SAMO.URL = change http to https (Ex:
https://192.168.11.12:8443/xmlapi/invoke)
See the 5620 SAM User Guide for information on how to enable and configure SSL.
Firewall support
The 3GPP OSS interface supports the configuration of a firewall between the
5620 SAM and 3GPP OSS clients. When you configure a firewall, consider the
following:
• The firewall must allow inbound connections to at least one port.
• The 3GPP OSS interface must be configured to use the same port that the firewall
allows connections to.
• For a CORBA OSS client, if the inbound port is modified in the firewall rules
after the 3GPP OSS interface is installed, you must reconfigure the 3GPP OSS
interface, as described in Procedure 4-3.
• The firewall must be configured to allow outbound connections to a port.
• If the OSS client is behind a NAT router, the client must use a VPN with NAT
traversal capabilities to reach the 3GPP OSS interface. The VPN is transparent to
the 3GPP OSS interface.
4-8 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
Perform this procedure to enable CORBA OSS client communication with a 3GPP OSS
interface through a firewall.
where path is the 5620 SAM main server installation location, typically
/opt/5620sam/server
CNBI.ThreeGPPCORBA.OrbPort=
CNBI.ThreeGPPCORBA.OrbPort=inbound_port
where inbound_port is the port value that the OSS clients must use to reach the 3GPP OSS
interface
path/nms/bin
where path is the 5620 SAM main server installation directory, typically /opt/5620sam/server
The main server loads the updated configuration, and puts the new port value into
effect.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-9
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
4.4 Redundancy
In a redundant 5620 SAM deployment, the 3GPP OSS interface must be installed on
the primary and standby main servers. Each 3GPP OSS interface is unaware of the
interface on the other main server. After installation, the 3GPP OSS interface
processes are started on both the active and standby servers. However, on the standby
server, the 3GPP processes are not available for sending requests and a JMS
connection cannot be established until after a switchover has occured and the standby
becomes the new active server. See the 5620 SAM | 5650 CPAM Installation and
Upgrade Guide for more information.
After a 5620 SAM server activity switch, the 3GPP OSS interface instance on the
former primary main server becomes unresponsive, and heartbeat notifications are
not sent to the OSS clients. Each connected OSS client must begin using the entry
point IOR (for a CORBA client) or URL (for a SOAP/XML client) of the 3GPP OSS
interface instance on the former standby main server, which is the new primary main
server, and must subscribe the notification consumers using the Notification IRP of
the new primary main server entry point.
Once the 3GPP OSS interface is installed and running on the 5620 SAM server, there
are a few commands available on the 5620 SAM server that can be used to administer
the interface when logged in as samadmin.
path/nms/bin/nmsserver.bash command
where
path is the 5620 SAM main server installation directory, typically
/opt/5620sam/server
command is one of the commands described in Table 4-1
Command Description
(1 of 2)
4-10 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
Command Description
(2 of 2)
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 4-11
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
4 — Communicating with OSS clients
4-12 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5— 5620 SAM 3GPP OSS domains
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 5-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
A fault management OSS application can use the 5620 SAM 3GPP OSS interface to
do the following:
• Receive network event notifications and current alarms using the Notification,
Alarm, CS and Kernel IRPs.
• Retrieve alarms from the 5620 SAM using methods from the Alarm IRP.
See chapter 3 for more information about monitoring near-real-time events and
alarms.
1 Get the Entry Point reference. See step 1 of Procedure 4-1 for more information.
2 Get the Alarm IRP reference. See “Fault Management/Alarm IRP” in section 3.6
for a code sample associated with this step.
3 Retrieve a list of alarms using the get_alarm_list method from the Alarm IRP.
See “Fault Management/Alarm IRP” in section 3.6 for a code sample associated
with this step.
1 Get the Entry Point reference. See step 1 of Procedure 4-1 for more information.
2 Get the Alarm IRP reference. See “Fault Management/Alarm IRP” in section 3.6
for a code sample associated with this step.
5-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
The inventory management OSS application has two mechanisms by which it can
interface with the 5620 SAM 3GPP OSS interface to retrieve inventory information
from LTE devices that are managed by the 5620 SAM:
• Basic inventory available using the CORBA or SOAP/XML methods defined by
the Basic CM IRP.
• 3GPP compliant XML file that is automatically generated and updated daily.
Basic inventory
The 3GPP OSS interface provides the ability to retrieve a list of the LTE-managed
NEs. This information acts as auxiliary fault management information, because it is
a list of NEs against which alarms can be raised. A limited set of NE attributes is
supported.
See chapter 3 for information about the Basic CM IRP for inventory management.
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 5-3
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
The following optional properties, also located in the cnbi.properties file, can be
configured:
• CNBI.SAMO.DATA.FILENAME—This property is name of the inventory file.
The default value is 3GPP_Inventory_Data_<timestamp>.xml.
• CNBI.SAMO.DATA.RETENTION_PERIOD (in days)—This property is the
maximum number of days that the inventory file is kept before it is deleted. The
minimum and default value is 5 days. However, the number of files retained may
be one greater than what is set in CNBI.SAMO.DATA.RETENTION_PERIOD.
This is because older files are purged before a new inventory file is created, and
it is possible to have the configured number of files within the retention period,
in addition to the newly-created file.
• CNBI.SAMO.DESTINATION.DIRECTORY—This property specifies the
destination directory for the inventory file. The default value is
installation_directory/lte/inventory.
After configuring the properties described above, you must to execute the following
command as the samadmin user in the following directory:
path/nms/bin/nmsserver.bash cnbiread_config
Once all the mandatory properties are configured, a 3GPP compliant XML file is
generated and placed in the directory specified by the
CNBI.SAMO.DESTINATION.DIRECTORY property, and new files will be
generated every 24 hours after the configured CNBI.SAMO.DATA.START_TIME.
The oldest files will be deleted after the expiration of the time specified by the
CNBI.SAMO.DATA.RETENTION_PERIOD property.
Note — It is important that the OSS application and/or system
administrator manage the amount of available disk space where these
XML files will be stored.
5-4 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
inventoryUnitId M
inventoryUnitType M
vendorUnitFamilyType O
vendorUnitTypeNumber O
versionNumber O
vendorName M
serialNumber O
dateOfManufacture O
dateOfLastService O
unitPosition O
manufacturerData O
<InventoryUnit id="SubNetwork=5620sam">
<InventoryUnit id=
"SubNetwork=5620sam,ManagedElement=192.168.128.126">
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,rack=eNB-1,she
lf=1,cardSlot=2,card=:NA:,BBCard=:NA:">
<attributes>
<inventoryUnitType>MOD: XCEMU</inventoryUnitType>
<vendorUnitFamilyType>BB</vendorUnitFamilyType>
<vendorUnitTypeNumber>300986049</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>U80338</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 5-5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
<unitPosition>R-S-S:2-1-0</unitPosition>
<manufacturerData>3JR20022AD</manufacturerData>
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,rack=eNB-1,she
lf=1,cardSlot=1,card=:NA:,CBCard=:NA:">
<attributes>
<vendorUnitFamilyType>CB</vendorUnitFamilyType>
<vendorUnitTypeNumber>0600</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>9U0TS7</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
<unitPosition>R-S-S:2-1-0</unitPosition>
<manufacturerData>3JR20022AD</manufacturerData>
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,rack=eNB-1,she
lf=1,eNBshelf=:NA:">
<attributes>
<vendorUnitFamilyType>DBU</vendorUnitFamilyType>
<vendorUnitTypeNumber>3JR08067AA</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>1B04BC</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
<unitPosition>R-S-S:2-1-0</unitPosition>
5-6 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
<manufacturerData>3JR20022AD</manufacturerData>
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,rack=eNB-2,RFM
=1100">
<attributes>
<inventoryUnitType>MOD: RRH</inventoryUnitType>
<vendorUnitFamilyType>RRH</vendorUnitFamilyType>
<vendorUnitTypeNumber>0800</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>3EFGH4</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
<unitPosition>R-S-S:2-1-0</unitPosition>
<manufacturerData>3JR20022AD</manufacturerData>
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,rack=eNB-2,RFM
=2100">
<attributes>
<inventoryUnitType>MOD: RRH</inventoryUnitType>
<vendorUnitFamilyType>RRH</vendorUnitFamilyType>
<vendorUnitTypeNumber>0900</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>3EFGH4</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
<unitPosition>R-S-S:2-1-0</unitPosition>
<manufacturerData>3JR20022AD</manufacturerData>
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 5-7
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
5 — 5620 SAM 3GPP OSS domains
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
<InventoryUnit
id="SubNetwork=5620sam,ManagedElement=192.168.128.126,eNBEquip=:NA:"
>
<attributes>
<inventoryUnitType>BS_LTE</inventoryUnitType>
<vendorUnitFamilyType>D2U</vendorUnitFamilyType>
<vendorUnitTypeNumber>0700</vendorUnitTypeNumber>
<vendorName>ALU</vendorName>
<serialNumber>1ABCD2</serialNumber>
<dateofManufacture>010109</dateOfManufacture>
<dateOfLastService>0110</dateOfLastService>
<unitPosition>R-S-S:2-1-0</unitPosition>
<manufacturerData>3JR20022AD</manufacturerData>
<versionNumber>AE01</versionNumber>
</attributes>
</InventoryUnit>
</InventoryUnit>
</InventoryUnit>
Perform the following steps to generate a request that returns a list of managed NEs.
1 Get the Entry Point IRP reference. See “Entry Point IRP” in section 3.6 for a code
sample associated with this step.
2 Get the Basic CM IRP reference. See “Basic CM IRP” in section 3.6 for a code
sample associated with this step.
3 Retrieve a list of NEs using the find_managed_objects method from the Basic CM
IRP. See “Basic CM IRP” in section 3.6 for a code sample associated with this step.
5-8 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Appendices
C. Troubleshooting C-1
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 A-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
A. 5620 SAM-O 3GPP code samples
A-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
B. Standards compliance
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 B-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
B. Standards compliance
Additionally, the Generic IRP, which is inherited by other IRPs, supports operations
to obtain the version, operation, and notification profiles of the other IRPs.
The source of the IRP information is the 3GPP 32-series R8 specification, published
December 2009.
See the 5620 SAM 3GPP OSS Interface Compliance Statements document for
detailed 3GPP compliance information.
B-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 C-1
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
You must verify the required platform, environment and license requirements before
the 3GPP NBI can be installed. The installation of the 3GPP NBI may fail if the
following requirements are not met:
• The 3GPP NBI is supported only on a Solaris x86-based platform. It is not
supported on Windows or SPARC platforms.
• The 3GPP NBI requires a minimum of 12 GB of RAM if installed on a distributed
architecture, and a minimum of 24 GB RAM if the SAM server and SAM
database are collocated on the same machine. It will report an error if this
minimum requirement is not met.
• The 3GPP NBI interface will not install if the minimum Solaris packages for the
3GPP NBI as described in the 5620 SAM | 5650 CPAM Installation and Upgrade
Guide are not installed.
• The 5620 SAM license key must include the license for the 5620 SAM-O.
• The minimum bandwidth requirement between the OSS and 3GPP NBI is 7.1
mbps.
Refer to the 5620 SAM Planning Guide and 5620 SAM | 5650 CPAM Installation
and Upgrade Guide for more information about platform and environment
configurations.
path/nms/bin
where path is the 5620 SAM main server installation directory, typically /opt/5620sam/server
C-2 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
4 If the 3GPP NBI application does not come up successfully, you may need to restart
the 3GPP NBI processes by performing the following steps.
Procedure C-2 To verify the JMS status of the 3GPP OSS Interface
1 Log in to the 5620 SAM main server as the samadmin user.
path/nms/bin
where path is the 5620 SAM main server installation directory, typically /opt/5620sam/server
4 Verify that the output of the command is similar to the following example:
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 C-3
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
'KeepAliveEvent') or (MTOSI_objectType =
'TerminateClientSession'))) and mirror is null and mirrorli is
null
Verifying that messages are being received by the 3GPP OSS interface
from the 5620 SAM
If an OSS is not yet connected and you need to verify that JMS messages are being
received by the 3GPP NBI, you should see events being processed in the logs. At
least every 30 seconds the JMS KeepAliveEvent messages are being logged in the
installation_directory/nms/jboss/server/alu_cnm_cnbi/log/cnb.log file similar to the
following:
.....com.alu.cnm.cnbi.plugin.samo.SAMO_JMSListener.onMessage():
Processing event from SAM-O (START)...
.....com.alu.cnm.cnbi.plugin.samo.SAMO_JMSListener.onMessage:
discarding message with MTOSI object type: KeepAliveEven?..
.....com.alu.cnm.cnbi.plugin.samo.SAMO_JMSListener.onMessage():
Processing event from SAM-O (END), time ms: 1.....
Firewall preventing OSS client access to the 3GPP OSS Interface using
the CORBA solution set
If a firewall exists between the OSS and the 5620 SAM server, the firewall must be
configured to allow outbound connections to any port and allow inbound
connections to the CNBI.ThreeGPPCORBA.OrbPort port which is configured in the
installation_directory/nms/cnbi/home/config/cnbi.properties file. The default value
is 9735.
C-4 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
*
com.alu.cnm.cnbi.plugin.threegppCORBA.irp.EntryPointIRPImpl.get_irp_
reference(): user= Wrong system_dn parameter: <wrongdn>
If you change a value in the cnbi.properties file, you will need to perform the
following command after editing the file to update the 5620 SAM:
bash$ ./nmsserver.bash cnbiread_config ↵
The logs described in this section can provide you with more information to help
with debugging problems.
The installation_directory/nms/log/cnbi directory contains the following logs:
• EmsCnbi.log—provides the most detailed information on all the CNBI processes
and communication
• cnbi_console.log—provides the latest updates on the status of the 3GPP NBI
processes
• <date and time>cnbi—directory that saves historical EmsCnbi.log and
cnbi_console.log log files
Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5 September 2012 C-5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
C. Troubleshooting
These levels indicate different verbosity and detail level from less to more detailed.
FATAL, ERROR, WARN and INFO trace categories are active by default.
The following is an example of an entry in the EmsCnbi.log file that is marked with
<I> for INFO:
<2010.10.29 04:59:09 111
-0400><I><rockets><Timer-7><CNBILogger>com.alu.cnm.cnbi.plugin.three
gppCORBA.irp.notification.ConsumersQueueS
izeMonitorTask.handleConsumerStats(): Skipping subscription
CNBI.Notification.Consumer=1288199616340 because is not active.
C-6 September 2012 Alcatel-Lucent 5620 Service Aware Manager, Release 10.0 R5
3HE 06977 AAAE TQZZA Edition 01
3GPP OSS Interface Developer Guide
Customer documentation and product support
Customer documentation
http://www.alcatel-lucent.com/myaccess
Product manuals and documentation updates are available at
alcatel-lucent.com. If you are a new user and require access to this
service, please contact your Alcatel-Lucent sales representative.
Technical Support
http://support.alcatel-lucent.com
Documentation feedback
documentation.feedback@alcatel-lucent.com
© 2012 Alcatel-Lucent. All rights reserved.