3JL04001BTAARJZZA01 - V1 - 5529 OAD Release 9.7 Installation and Administration Guide

Installation and Administration Guide
5529 OSS Alarm Dispatcher,

Release 9.7
3JL-04001-BTAA-RJZZA
Edition 01
March 2019
Nokia — Proprietary and confidential

Use pursuant to applicable agreements
Nokia is a registered trademark of Nokia Corporation. Other products and company

names mentioned herein may be trademarks or tradenames of their respective
owners.
The information presented is subject to change without notice. No responsibility is
assumed for inaccuracies contained herein.
© 2019 Nokia.
Contains proprietary/trade secret information which is the property of Nokia and must
not be made available to, or copied or used by anyone outside Nokia without its
written authorization. Not to be used or disclosed except in accordance with
applicable agreements.
2 3JL-04001-BTAA-RJZZA Edition 01
Table of contents
1 Preface...........................................................................................11
1.1 Related documentation..............................................................................11
1.2 Conventions used in this guide..................................................................12
1.2.1 Important information.................................................................................12
1.2.2 Procedures with options or substeps.........................................................12
1.3 Multiple PDF file search.............................................................................13
Getting started
2 What’s new ....................................................................................17
2.1 What’s new in Release 9.7 ........................................................................17
2.2 What’s new in Release 9.6.07 ...................................................................17
2.3 What’s new in Release 9.6.05 ...................................................................18
3 Getting started ..............................................................................19
3.1 Overview....................................................................................................19
3.2 Standalone and cluster 5529 OAD deployment models............................19
3.2.1 Standalone deployment.............................................................................19
3.2.2 Cluster deployment....................................................................................20
3.2.2.1 Script forwarding in a cluster .....................................................................22
3.3 System requirements.................................................................................22
3.4 Technologies and standards .....................................................................22
Installation and administration
4 Installation .....................................................................................25
4.1 Security recommendations ........................................................................25
4.2 Installation overview ..................................................................................25
4.2.1 Loss of alarms when uninstalling and re-installing the 5529 OAD ............26
4.3 Migration overview.....................................................................................26
4.4 Uninstallation .............................................................................................27
5 Administration ..............................................................................29
5.1 User authentication and authorization .......................................................29
5.1.1 Client OS authentication............................................................................30
5.2 Licensing ...................................................................................................30
5.2.1 License validation ......................................................................................31
5.2.2 License alarms ..........................................................................................31
5.3 5529 OAD NBI settings .............................................................................32
5.4 Script forwarding........................................................................................38
5.4.1 Script forwarding output example ..............................................................39
5.4.2 Identify an alarm type uniquely..................................................................40
5.5 Performance monitoring ............................................................................40
5.6 Logs...........................................................................................................41
5.6.1 nbi.log ........................................................................................................41
5.6.2 server.log...................................................................................................42
5.7 EMS alarms ...............................................................................................42
5.8 JMX console settings.................................................................................43
Edition 01 3JL-04001-BTAA-RJZZA 3
5.8.1 Enabling a unique alarm ID .......................................................................43

5.8.1.1 Format of 5520 AMS and 5529 Enhanced Applications uniqueKey
alarm ID .....................................................................................................43
5.8.1.2 Format of NE uniqueKey alarm ID.............................................................44
List of figures
3 Getting started ..............................................................................19
Figure 1 5529 OAD architecture—standalone deployment .....................................20
Figure 2 5529 OAD cluster deployment...................................................................21
List of tables
1 Preface...........................................................................................11
Table 1 Related documentation..............................................................................11
Table 2 Documentation conventions ......................................................................12
2 What’s new ....................................................................................17
Table 3 What’s new in Release 9.7 ........................................................................17
Table 4 What’s new in Release 9.6.07 ...................................................................17
Table 5 What’s new in Release 9.6.05 ...................................................................18
5 Administration ..............................................................................29
Table 6 User functions and roles............................................................................29
Table 7 5529 OAD NBI settings—general parameters...........................................32
Table 8 5529 OAD NBI settings—AWS parameters ..............................................33
Table 9 5529 OAD NBI settings—script forwarding parameters ............................34
Table 10 5529 OAD NBI settings—SNMP trap forwarder parameters.....................35
Table 11 5529 OAD NBI settings—information parameters.....................................37
Table 12 5529 OAD NBI settings—subscriber parameters ......................................38
Table 13 nbi.log file keywords ..................................................................................41
List of procedures
1 Preface...........................................................................................11
Procedure 1 Example of options in a procedure ............................................................13
Procedure 2 Example of substeps in a procedure .........................................................13
Procedure 3 To search multiple PDF files for a term .....................................................14
5 Administration ..............................................................................29
Procedure 4 To configure client OS authentication .......................................................30
Procedure 5 To configure 5529 OAD NBI settings ........................................................32
Installation and Administration Guide Preface
1 Preface
The 5529 OAD Installation and Administration Guide provides information about:
• installing the 5529 OAD
• performing administration tasks (including authorization, authentication, licensing,
and configuration)
1.1 Related documentation

Table 1 describes related documentation sources that you may need to reference.
Table 1 Related documentation
Customer documentation Description
5520 Access Management System
5520 AMS Administrator Guide Information about administrative functions, including

management of client-server communication, users, NE
communication, and schedules
5520 AMS Installation and Migration Guide Information about how to install, optimize, and uninstall the
5520 AMS server, client, and plug-in components, as well
as how to migrate data to the 5520 AMS from other EMSs
Release Notice for the NE support plug-in NE-specific information about the mapping of alarm IDs to
the 5529 OAD specific problem, native probable cause, and
MTOSI probable cause attributes
5520 AMS and 5529 Enhanced Applications
5520 AMS and 5529 Enhanced Applications 5520 AMS, 5529 Enhanced Applications, and NE alarm
Alarm Search Tool descriptions
5520 AMS and 5529 Enhanced Applications Information about the product features that impact privacy
Privacy Considerations and the measures taken to protect such data
5520 AMS Solution Glossary Terms and acronyms related to the 5520 AMS and
5529 Enhanced Applications
5529 Enhanced Applications
5529 Enhanced Applications Release Notice Information about updates to the product, software and
documentation delivery, known restrictions, and fixed issues
5529 OSS Alarm Dispatcher
5529 OAD Northbound Interface Guide Information about how to develop OSS client applications to
retrieve alarms and to subscribe to notifications of alarms
and events
Preface Installation and Administration Guide
1.2 Conventions used in this guide

Table 2 describes the conventions that are used in this guide.
Table 2 Documentation conventions
Convention Description Example
Italics Identify a variable hostname
Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G
Key–Key Type the appropriate simultaneous keystroke sequence. CTRL–G
↵ Press the Return key. ↵
— An em dash in a table cell indicates that there is no information. —
→ A right arrow graphic following the menu label indicates that a cascading File→Save
submenu results from selecting a menu item.
1.2.1 Important information

The following conventions are used to indicate important information.
Warning — Warning indicates that the described activity or situation

may, or will, cause equipment damage or serious performance
problems.
Caution — Caution indicates that the described activity or situation

may, or will, cause service interruption.
Note — A note provides information that is, or may be, of special

interest.
1.2.2 Procedures with options or substeps

When there are options in a procedure, they are identified by letters. When there are
substeps in a procedure, they are identified by roman numerals.
Installation and Administration Guide Preface
Procedure 1 Example of options in a procedure

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:
a This is one option.
b This is another option.
2 You must perform this step.
Procedure 2 Example of substeps in a procedure

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:
i This is the first substep.
ii This is the second substep.
iii This is the third substep.
2 You must perform this step.
1.3 Multiple PDF file search

You can use Adobe Reader, Release 6.0 or later, to search multiple PDF files for a
term. Adobe Reader displays the results in a display panel. The results are grouped
by PDF file. You can expand the entry for each file.
Note — The PDF files in which you search must be in the same folder.
Preface Installation and Administration Guide
Procedure 3 To search multiple PDF files for a term
1 Open the Adobe Reader.
2 Choose Edit→Advanced Search from the Adobe Reader main menu. The Search window
opens.
3 Enter the term to search for.
4 Select the All PDF Documents in radio button.
5 Choose the folder in which to search using the drop-down menu.
6 Select the following search criteria, if required:
• Whole words only

• Case-Sensitive
• Include Bookmarks
• Include Comments
7 Click on the Search button.
Adobe Reader displays the search results. You can expand the entries for each file by
clicking on the + symbol.
Note — After you click on a hyperlink, you can right-click and choose Previous
View from the contextual menu to return to the location of the hyperlink that you
clicked on.
Installation and Administration Guide Getting started
Getting started
2 What’s new
3 Getting started
Getting started Installation and Administration Guide
Installation and Administration Guide What’s new
2 What’s new
2.1 What’s new in Release 9.7
2.2 What’s new in Release 9.6.07
2.1 What’s new in Release 9.7

Table 3 describes the 5529 OAD features and enhancements added to the
5529 OAD Installation and Administration Guide for Release 9.7.
Table 3 What’s new in Release 9.7
Feature/enhancement Description Edition See
Documentation changes
OAD NBI - Administrator user Updated the description of the OAD NBI - Administrator user 01 Table 6
function function

5529 OAD Installation and Administration Guide for Release 9.6.07.
Table 4 What’s new in Release 9.6.07
New features and enhancements
nbi.log file updates Added information about the nbi.log file, including the 01 Section 5.6.1
following new log file keywords: SourceIP and
X-Forwarded-For
NE IP Address parameter Support for the IPv6 address format is added to the NE IP 01 Table 9
Address parameter in 5529 OAD NBI settings for script
forwarding.
Documentation changes
5520 AMS and Added the 5520 AMS and 5529 Enhanced Applications 01 Table 1
5529 Enhanced Applications Privacy Considerations document to the list of related
Privacy Considerations documentation sources
(1 of 2)
What’s new Installation and Administration Guide
Changes to information in The specific problem and proposed repair action that are 01 5520 AMS and
alarms forwarded by the provided in alarms that are forwarded by the 5529 OAD did 5529 Enhanced Applications
5529 OAD not match the specific problem and proposed repair action Alarm Search Tool
that are provided in the same alarms that are displayed in the
5520 AMS GUI. In the 5529 OAD R9.6.07, the specific
problem and proposed repair action in the alarms that are
forwarded by the 5529 OAD are updated to align with the
alarms that are displayed in the 5520 AMS GUI.
For example, the 5529 SDC alarm that is forwarded by the
5529 OAD that provided “TFTP is not enabled” as the specific
problem and “Enable TFTP in the NE” as the proposed repair
action is updated as follows to align with the same alarm in the
5520 AMS GUI:
• Specific problem: BFMU Protocol Mismatch
• Proposed repair action: Check the File Transfer Protocol
Selection configuration in AMS. Check the NE protocol
configuration.
SOAP version 1.2 Added SOAP version 1.2 to the list of supported technologies 01 Section 3.4
and standards that the 5529 OAD platform is based on. SOAP
1.2 is supported on 5529 OAD R9.6 or later.
(2 of 2)

5529 OAD Installation and Administration Guide for Release 9.6.05.
Table 5 What’s new in Release 9.6.05
New features and enhancements
Comments Added the Comments functionality to the 5529 OAD NBI 01 Tables 7 to 12
settings in the Administration Tree 5520 AMS Administrator
Guide for information about
how to use Comments
3 Getting started
3.1 Overview
3.2 Standalone and cluster 5529 OAD deployment models
3.3 System requirements
3.4 Technologies and standards
3.1 Overview
The 5529 OSS Alarm Dispatcher is an application that integrates with the 5520 AMS
server, and incorporates alarm flows into OSS client applications.
The OSS client applications communicate with the 5529 OAD over the following
interfaces:
• HTTP/S—to exchange alarm information requests and responses using the
SOAP XML web service standards
• JMS—to subscribe to real-time notifications of alarms and events
If you are using the 5529 OAD on a server with multiple NICs, the OSS client will
connect to the IP address of the NIC on which GUI clients are allowed to connect.
This is configured during the installation of the 5520 AMS. For more information, see
the 5520 AMS Installation and Migration Guide.
The 5529 OAD broadcasts SNMP alarm traps over the LAN; as a result, a dedicated
northbound interface is not necessary.
3.2 Standalone and cluster 5529 OAD

deployment models
You can install the 5529 OAD in standalone and cluster deployments.
3.2.1 Standalone deployment

In the standalone deployment, a single 5529 OAD installation runs on a single
5520 AMS server; see Figure 1. If a server fails, the 5529 OAD stops processing
alarm and event information, and restarts when the 5520 AMS restarts.
Figure 1 shows the options for forwarding alarm and event information provided by
the 5529 OAD in a standalone deployment: XML alarm forwarding, SNMP alarm trap
forwarding, and script alarm forwarding.
Figure 1 5529 OAD architecture—standalone deployment
OSS SNMP client OSS client
Web services JMS provider
NE 5529 OAD
support
5520 AMS 5523 AWS

base Alarm
service R7.x
components
5520 AMS
JBoss
NE NE NE
Operations (HTTP/S)
SNMP alarm traps
Subscription (JMS)
Notifications (JMS)
20493
3.2.2 Cluster deployment

In a cluster deployment, multiple 5529 OAD instances run on parallel 5520 AMS
servers. The processing load is distributed among the 5529 OAD instances and, if a
server fails, the 5529 OAD is still accessible on the active server.
The physical setup of the cluster deployment is transparent to the OSS client
applications, which perceive the 5529 OAD instances as a single entity. A cluster-
aware connector manages the connection between the OSS clients and the cluster.
Figure 2 shows the cluster deployment for the 5529 OAD.
Figure 2 5529 OAD cluster deployment
OSS client
Cluster-aware
connector
Subnetwork
Cluster NE 1 Cluster NE 2 Cluster NE 3

20053
You can implement cluster deployments in the following setups:

• site cluster, in which multiple 5529 OAD instances run on parallel servers installed
at the same site
• geographic redundancy, in which the 5529 OAD instances are installed on the
servers in both primary and secondary sites. The primary site is active and
contains the operational server, which shares the processing load. The secondary
site is on standby and contains the inactive application servers.
For information about setting up the 5520 AMS in a cluster deployment, see the
5520 AMS Solution Planning Guide and 5520 AMS Server Configuration Technical
Guidelines. For information about the 5520 AMS GUI connection to the cluster, see
the 5520 AMS Installation and Migration Guide.
The connection between OSS client applications and the 5529 OAD is implemented
differently for HTTP/S and JMS clients. See the 5520 AMS Northbound Interface
Guide for more information about the OSS client connection to the cluster in a cluster
deployment.
You also need to configure the OSS client applications to work in a cluster
deployment; for more information, see the 5529 OAD Northbound Interface Guide.
3.2.2.1 Script forwarding in a cluster

If the cluster includes more than one application server, you need to save a copy of
the forwarding script on each application server. The master application server
processes alarms and invokes the forwarding script. If each application server has a
copy of the forwarding script, script forwarding will continue in the event of an
application server switchover.
3.3 System requirements

The 5529 OAD and other 5529 Enhanced Applications are installed on the
5520 AMS application server. You need additional disk space and system resources
on the 5520 AMS server for the 5529 Enhanced Applications.
See the 5520 AMS Solution Planning Guide for information about system
requirements.
3.4 Technologies and standards

The 5529 OAD platform is based on the following technologies and standards:
• XML 1.0 • HTTP and HTTPS 1.1

• XML Schema (XSD) 1.0 • MTOSI 1.1
• SOAP 1.1/1.2 • TMF OSS interfaces (TMF 854)
• WSDL 1.1 • SNMPv2
• JMS 1.1
See the following web sites for more information:
• http://www.w3.org/TR/2004/REC- • http://www.w3.org/TR/2001/NOTE-
xml-20040204 (W3C standards wsdl-20010315 (WSDL 1.1)
about XML 1.0, third edition) • http://www.oracle.com/technetwork/
• http://www.w3.org/TR/2001/REC- java/jms/index.html (JMS 1.1)
xmlschema-1-20010502 (XSD) • http://www.ietf.org/rfc/rfc2616.txt
• http://www.w3.org/TR/2000/NOTE- (HTTP 1.1)
SOAP-20000508 (SOAP 1.1) • http://www.tmforum.org (TMF and
• https://www.w3.org/TR/soap12/ MTOSI)
(SOAP 1.2)
Installation and Administration Guide Installation and administration
Installation and administration

4 Installation
5 Administration
Installation and administration Installation and Administration Guide
Installation and Administration Guide Installation
4 Installation
4.1 Security recommendations
4.2 Installation overview
4.3 Migration overview
4.4 Uninstallation
4.1 Security recommendations

To ensure the security of your system operations, Nokia has the following
recommendations:
• Use HTTP/S exclusively.
• Use secure JMS only.
For information about the 5520 AMS-specific security recommendations, see the
5520 AMS documentation.
4.2 Installation overview

The 5529 OAD application is a software plug-in. You can install the 5529 OAD only
on a 5520 AMS server, in a collocated configuration. Before you proceed, you need
the software files; see the 5529 Enhanced Applications Release Notice for
information about the files that you need.
See the 5520 AMS Installation and Migration Guide for information about
downloading software files and installing software plug-ins. See the 5520 AMS User
Guide for information about viewing plug-ins in the 5520 AMS GUI.
The installation of the 5529 OAD is a two-step process:
• Install the application files on the 5520 AMS server.
• Activate the application. The activation script copies the application files to a
deployment directory.
Installation Installation and Administration Guide
In a cluster deployment, install and activate the 5529 OAD on each application server
in the cluster.
Caution 1 — A cluster deployment should not have two application
servers running with different plug-ins installed. After you install the
5529 OAD on one application server, stop the other servers before
starting the updated server.
Caution 2 — The 5529 OAD application cannot be installed on a

running 5520 AMS server. The 5520 AMS server must be stopped, the
5529 OAD installed, and the 5520 AMS server restarted.
4.2.1 Loss of alarms when uninstalling and re-installing

the 5529 OAD
If you uninstall and re-install the 5529 OAD, any alarms are lost. After re-installing
and configuring the 5529 OAD, you need to synchronize the OSS client applications
with the 5529 OAD by executing a getActiveAlarms operation. For more information
about the getActiveAlarms operation, see the 5529 OAD Northbound Interface
Guide.
4.3 Migration overview

For information about migrating from an earlier 5529 OAD release to the current
release, and migrating between operating systems and architectures, see the
5520 AMS Installation and Migration Guide.
For information about the supported migration paths for the current release, see the
5520 AMS Release Notice.
Coordinate the migration tasks with the 5520 AMS administrator; you need to collect
the 5529 OAD configuration information for the earlier release before the 5520 AMS
is upgraded to the current release.
Before you proceed:
• The 5520 AMS and 5529 OAD release that you are going to migrate from must be
running.
• Ensure that the Keep Configuration parameter on the OAD NBI Settings window
is enabled; see Procedure 5.
Caution — Upgrading the 5529 OAD on its own does not allow for a
rollback of the 5529 OAD data. Before you upgrade the 5529 OAD,
Nokia recommends that you perform a full backup of the 5520 AMS
server, so that you can restore the 5529 OAD data from before the
upgrade, if required.
Installation and Administration Guide Installation
4.4 Uninstallation
To uninstall the 5529 OAD, see the information about uninstalling 5529 Enhanced
Applications in the 5520 AMS Installation and Migration Guide.
Installation Installation and Administration Guide
Installation and Administration Guide Administration
5 Administration
5.1 User authentication and authorization
5.2 Licensing
5.3 5529 OAD NBI settings
5.4 Script forwarding
5.5 Performance monitoring
5.6 Logs
5.7 EMS alarms
5.8 JMX console settings
5.1 User authentication and authorization

The 5529 OAD relies on the 5520 AMS security and user management mechanism
to authenticate users.
The 5520 AMS authentication/authorization mechanism is based on roles and
functions. Users can execute certain tasks or access specific functionality depending
on the roles and functions granted to them.
Create and configure users and associations with the default OAD NBI roles to obtain
access to the 5529 OAD functionality. Create and configure users in the 5520 AMS
client. See the 5520 AMS Administrator Guide for information about managing user
functions and roles.
Table 6 describes the 5529 OAD user functions and roles.
Table 6 User functions and roles
Function Role Description
Administrator NBI System OAD NBI
OAD NBI - Administrator ✓ During the installation, the 5529 OAD adds the OAD NBI -
Administrator function to the existing 5520 AMS
Administrator role.
OAD NBI - Notify ✓ The OAD NBI users with the OAD NBI - Notify function are
used by the OSS client applications to receive event
notifications from the 5529 OAD Fault topic.
(1 of 2)
Administration Installation and Administration Guide
Function Role Description
Administrator NBI System OAD NBI
OAD NBI - System ✓ This function enables NBI OSS client applications to perform
5529 OAD operations.
OAD NBI - View ✓ The OAD NBI users with the OAD NBI - View function are
used by the OSS client applications for HTTP/S request and
response operations.
OAD NBI Settings - Edit ✓ This function enables a user to configure OAD NBI Settings
parameters in the Administration perspective.
OAD NBI Settings - View ✓ This function enables a user to view the OAD NBI settings in
the Administration perspective.
(2 of 2)
5.1.1 Client OS authentication

If the 5520 AMS is configured for trusted host login, you need to bypass the EMS
System site authentication source setting (client OS) so that the 5529 OAD OSS
client applications can connect to the 5520 AMS.
Procedure 4 describes how to configure client OS authentication. Perform the
procedure for each OAD NBI user.
Procedure 4 To configure client OS authentication
1 Log in to the 5520 AMS server as an administrator and open the Administration perspective.
2 Navigate to EMS Administration→User Management→Users, and click on an OAD NBI user.

The Object Details view for the selected user opens.
3 Click on the Advanced tab.
4 In the Authentication & Authorization panel, select the Use Internal Database check box, and
click on the Apply icon to save the change.
5.2 Licensing
A license key is required to enable 5529 OAD software packages. You need to add
the 5529 OAD license key to the 5520 AMS licensing management system in the
Administration perspective. See the 5520 AMS Administrator Guide for information
about creating, managing, and viewing licenses.
5.2.1 License validation

The 5529 OAD performs a license validation as follows:
• on the first startup, as soon as the connection to the 5520 AMS licensing
management system has been established
• every 24 hours after the initial startup validation (if no license change triggered a
license validation in the meantime)
• every time a 5529 OAD license is added to the 5520 AMS licensing management
system
The following considerations apply to the license validation:

• The 5529 OAD validates the license parameters one after another.
• The first invalid license parameter raises a license exception; as a result, the
5529 OAD creates a license alarm and adds it to the 5520 AMS internal alarm
service.
You can view the result of a license validation operation in the server.log file on the
5520 AMS server.
If a license is invalid, the 5529 OAD raises a license alarm, starts to function in invalid
license mode, blocks the execution of operations, and prevents the publishing of all
alarms, except for the license alarm and the heartbeat alarm.
If a license is removed, the 5529 OAD application continues to function in the current
license mode until the next license validation.
5.2.2 License alarms

The 5529 OAD generates the following license alarms:
• Invalid OAD License (default severity: Critical)
• Number Of OAD Subscribers Exceeded (default severity: Warning)
You can configure the severity assignment of the 5529 OAD license alarms, and turn
off the reporting of the alarms; see the 5520 AMS Administrator Guide.
Note — To ensure that the 5529 OAD notifies you of any

license-related events, keep the default severity for each alarm and do
not turn off the license alarm reporting.
See section 5.7 for more information about alarms.
5.3 5529 OAD NBI settings

This section contains information about accessing the 5529 OAD NBI settings in the
5520 AMS GUI, where you can perform the following operations:
• configure 5529 OAD application settings
• configure the collection of alarms from a 5523 AWS R7.x EMS
• configure the script forwarding of alarms and associated alarm filter parameters
• configure SNMP trap forwarder parameters and associated alarm filter
parameters
• display application and status information
• manage subscriber settings
Caution — Nokia recommends that you apply a filter when you use
script forwarding.
Procedure 5 describes how to configure the 5529 OAD NBI settings in the 5520 AMS
GUI.
Before you proceed, ensure that your 5520 AMS user account is assigned the
necessary functions to perform this procedure. See Table 6 and the 5520 AMS
Administrator Guide for more information about 5520 AMS function descriptions.
Procedure 5 To configure 5529 OAD NBI settings
1 Log in to the 5520 AMS GUI; see the 5520 AMS Administrator Guide.
2 In the Administration Tree, choose EMS Administration→Configuration→NBI→ OAD NBI

Settings.
3 In the Object Details view, perform the following operations as required. Click on each tab to
display the parameters.
i In the General tab, configure the 5529 OAD parameters as described in Table 7.
Table 7 5529 OAD NBI settings—general parameters
Parameter Description
Heartbeat Enabled Enables the 5529 OAD to publish Heartbeat notifications to the Fault topic.
Heartbeat Interval Specifies the time interval (in seconds) at which the Heartbeat notifications are published to the Fault
topic.
(1 of 2)
Domain Name Specifies the name of the Management Domain (the 5520 AMS server).
Operation Timeout Specifies the timeout value (in seconds) elapsed between iterations of an operation.
Keep Configuration Controls whether the user configuration is kept or removed when the 5529 OAD is undeployed.
If the Keep Configuration parameter is enabled and the 5529 OAD is undeployed, the 5529 OAD roles,
functions, and configured users are kept.
Alarm Grouping Controls whether alarms are grouped per JMS notification.
If Alarm Grouping is enabled, JMS filtering is disabled.
Alarm Encoding Controls whether each alarm XML string is encoded into a compressed byte array.
If Alarm Encoding is enabled, the JMS type is set to Bytes.
Alarm Grouping Maximum Batch The maximum batch size to be used with alarm grouping.
Size (1)
Alarm Grouping Timer The maximum time, in milliseconds, that an alarm can be held back with alarm grouping.
Interval (1) The timer interval is fixed and never resets. For example, if the interval is set to 60 000, a batch
notification will be sent every minute whether or not the maximum batch size has triggered a batch
notification during the interval.
JMS Message Delivery Mode Enables the 5529 OAD to persist alarms for a specified period of time.
Maximum Number Of AMS OAD The maximum number of concurrent threads in the 5529 OAD to process 5520 AMS alarms.
Threads Contact Nokia before changing this parameter.
Show Alarm Details in Alarm Controls whether alarm change events are sent with more detailed information about the alarm. If this
Change Notifications (2) parameter is enabled and an alarm change event occurs, all alarm attributes will be included in alarm
change events sent by the 5529 OAD.
Report NE Agent Alarms Under Enables reporting of 5520 AMS communication issues with an NE (agent alarms) as NE-raised alarms.
the NE The parameter is disabled by default.
(2 of 2)
Notes
(1) A batch notification is sent when the Alarm Grouping Maximum Batch Size has been reached or the Alarm Grouping Timer Interval has
passed.
(2) Enabling detailed alarm change events on a network with a high volume of alarm messages may impact performance, because it increases
the size of the alarm change messages.
ii In the AWS Settings tab, configure the parameters as described in Table 8.
Table 8 5529 OAD NBI settings—AWS parameters
AWS Enabled Enables the collection of alarms from a 5523 AWS R7.x EMS.
AWS Connection Status Displays the 5523 AWS connection status.
AWS Domain Name The name of the 5523 AWS managed domain. The AWS Domain Name must be
different from the 5520 AMS domain name.
AWS IP Address The 5523 AWS host IP address
AWS Port The 5523 AWS alarm port number
iii In the Script Forwarding Settings tab, configure the parameters as described in Table 9.
The following considerations apply to the script forwarding filtering:
• The filter parameter values are not case-sensitive.

• The specified filter parameters have an “AND” logical relationship. For example, if
values are specified for two attributes, the filter takes into consideration only those
two attributes.
• Some filter parameters allow you to specify multiple values. The values must be
separated by a delimiter (|). The multiple values have an “OR” logical relationship.
• The alarms are filtered only if an exact match for the filter attribute value is found. If
there is a match, the alarm is forwarded. If there is not a match, the alarm is
discarded.
• To disable a filter parameter, use the default value (any).
Table 9 5529 OAD NBI settings—script forwarding parameters
Settings
Script Name and Location Enter the full path of the forwarding script on the 5520 AMS server.
See section 5.4 for more information.
Script Forwarding Service Enabled Enables script forwarding.
Alarm Filters
Last Acknowledged User ID Filters the alarms acknowledged by a specific user.
EMS Domain Filters the alarms originating on a specific EMS domain.
Acknowledged Filters acknowledged or unacknowledged alarms.
Specific Problem Filters the alarms with a specific problem.
Repair Actions Filters the alarms that require a specific repair action.
Alarm Severity Filters the alarms by severity.
Asam Alarm ServAffType Filters the ASAM NE alarms that are service affecting and those that
are not.
Alarm Category Filters the alarms by category.
Alarm Domain Filters the alarms originating on a specific domain.
Probable Cause Filters the alarms by the alarm probable cause.
NE Name Filters the alarms by the NE name. Regular expression is supported.
NE Group Filters the alarms by one NE group selected from the drop-down menu
of available groups.
NE Type Filters the alarms by one NE type selected from the drop-down menu of
available types.
(1 of 2)
NE IP Address Filters the alarms by one or more NE IP address ranges, separated by

commas. The format of the IP range is:
IP address-Number
where:
• IP address is the IP address of an NE
• Number is the number of consecutive IP addresses
The IPv4 and IPv6 address formats are supported.
(2 of 2)
iv In the SNMP Trap Forwarder Settings tab, configure the parameters as described in
Table 10.
The 5529 OAD forwards alarms as SNMP traps to the number of destinations
configured in the OAD NBI Settings Object Details view. Nokia recommends a
maximum number of 30 SNMP destinations.
Add a new SNMP destination by clicking on the Add button. Click on the parameter
values to modify them as necessary. Remove an existing SNMP destination by
selecting the destination and clicking on the Remove button. You need the OAD NBI -
Administrator user function in your user role to add and remove SNMP destinations.
The following considerations apply to the SNMP trap filtering:
• The filter parameter values are not case-sensitive.

• The specified filter parameters have an “AND” logical relationship. For example, if
values are specified for two attributes, then the filter takes into consideration only
those two attributes.
• The value of a filter attribute can be either a string or an integer.
• Some filter parameters allow you to specify multiple values. The values must be
separated by a delimiter (|). The multiple values have an “OR” logical relationship.
• The SNMP traps are filtered only if an exact match for the filter attribute value is
found. If there is a match, the SNMP trap is forwarded. If there is not a match, the
SNMP trap is discarded.
• To disable a filter parameter, use the default value (any).
Table 10 5529 OAD NBI settings—SNMP trap forwarder parameters
Settings (SNMP Destination Settings)
Port Specifies the port number.
IP Address Specifies the IP address of the destination
Community String Specifies the community name.
Alarm Filters
Last Acknowledged User ID Filters the alarm traps acknowledged by a specific user.
(1 of 2)
EMS Domain Filters the alarm traps originating on a specific EMS domain.
Acknowledged Filters acknowledged or unacknowledged alarm traps.
Specific Problem Filters the alarm traps with a specific problem.
Repair Actions Filters the alarm traps that require a specific repair action.
Alarm Severity Filters the alarm traps by severity.
Asam Alarm ServAffType Filters the ASAM NE alarm traps that are service affecting and those that
are not.
Alarm Category Filters the alarm traps by category.
Alarm Domain Filters the alarm traps originating on a specific domain.
Probable Cause Filters the alarm traps by the alarm probable cause.
(2 of 2)
v The Information tab displays the application and status parameters, which are
described in Table 11.
If the status parameters are correct, the 5529 OAD is running properly. If any of the
status parameters are incorrect, investigate and fix the issue, as required.
You can also obtain information about the installed 5529 OAD version by using the
getSystemInfo operation. For information about the getSystemInfo operation, see the
5529 OAD Northbound Interface Guide.
Table 11 5529 OAD NBI settings—information parameters
Parameter Description Value
Product
Product Full Name Displays the full name of the product. Nokia 5529 OSS Alarm Dispatcher
OAD Version Displays the release of the licensed Release number (for example, 9.7.0)
application.
Status
Application Status Displays the status of the 5529 OAD Running

application. This value indicates that the
5529 OAD is up and running.
License Displays the status of the application Valid or Invalid

license.
Host ID Displays the ID of the licensed local String identifying the host 5520 AMS
5520 AMS host. server
Expiration Date Displays the license expiration date. License expiration date and time
XML Alarm Forwarding Displays whether the licensed XML Enabled or Disabled
North Bound Interface is enabled.
Number of Licensed Displays the number of licensed Integer

Subscribers subscriber ports.
Next License Validation Displays the next license validation Date and time of the next license
time. validation
License Violation Reason Displays the license violation reason, if String indicating the reason of the
any. license violation; for example, License
Expired.
vi In the Subscriber Settings tab, configure the parameters as described in Table 12.
Table 12 5529 OAD NBI settings—subscriber parameters
OAD Subscriber Information
Number of Durable Subscribers Displays the number of durable subscribers.
Number of Non-Durable Subscribers Displays the number of non-durable subscribers.
Total Number of Subscribers Displays the total number of subscribers.
Managing Durable Subscribers
Durable Subscribers Select a durable subscriber that you need to unsubscribe and click on
the Remove button.
When the operation to unsubscribe is complete, the entry for the
selected subscriber is changed to subscriptionID(unsubscribing).
The operation can take several minutes.
4 Click on the Apply icon ( ) to save the changes.
5.4 Script forwarding

You can configure the 5529 OAD to send a filtered subset of alarms using email or
SMS. When the 5529 OAD receives an alarm, it applies the script forwarding filter
configured in the 5520 AMS GUI; see Table 9. If the alarm matches the filter, the
5529 OAD calls a script on the 5520 AMS application server to send the notification.
By default, only critical-severity alarms are forwarded to the script; this is
configurable.
A sample script, scriptForwarding.sh, is packaged with the 5529 OAD and installed
on the 5520 AMS application server. The path to the script is:
$AMS_LOCAL_DATA_DIR/ams/local/repository/app-oad-version_release-revision/s
cript/scriptForwarding.sh
where version_release-revision is the version, release, and revision of the 5529 OAD
software. An example of version_release-revision is 1.0_9.7-999000.
Caution 1 — You need to configure the full path to the forwarding
script. The Script Name and Location parameter does not have a value
and you need to enter a valid path to the script. See Table 9 for more
information.
Caution 2 — Nokia recommends that you use a directory other than the
installation directory to store the forwarding script. When the 5529 OAD
is uninstalled or upgraded, the contents of the installation directory are
removed, including the forwarding script.
The script has a single input parameter, which is the full alarm text enclosed in double
quotes. The format of the input is a single line of colon-delimited, semi-colon
separated, attribute-value pairs; for example:
"<parametername>:<value>;<parametername>:<value>;…;"
Script forwarding is designed to handle an estimated peak alarm rate of one alarm
per second. The recommended average alarm rate is one per minute or less. Nokia
recommends that you apply a filter when you use script forwarding.
You can configure the default script to meet your requirements. If you change the
default script, you need to evaluate the maximum alarm rate for your needs.
In a cluster deployment, the same script filename, location, and permissions must be
used on each application server. The script will be invoked by the master application
server.
You can change the script filename, location, and permissions. If you make any
changes, you need to update the configuration in the OAD NBI Settings; see
section 5.3. The script permissions need to align with the UNIX user and group. The
default user is amssys and the default group is amssys. If a different user or group is
used, broader permissions are required for JBoss to invoke the script. JBoss runs as
an amssys user. Nokia recommends that you maintain the script defaults: amssys
user, amssys group, and rwxrxr-x permissions.
If the 5529 OAD is not able to run the forwarding script because the script filename,
location, or permissions do not match the configuration, the 5529 OAD logs an error
and rechecks the file every minute. Errors resulting from the forwarding script are
recorded in the nbi.log file.
Warning — If the alarm rate exceeds the time that the script takes to
consume the alarm queue, a scriptForwardingEventLossOccurred
alarm will be raised and alarms will be dropped until the alarm rate
slows down.
5.4.1 Script forwarding output example

The following is a script forwarding output example.
id:75044;
alarmCategory:COMMUNICATIONS;
alarmSeverity:CRITICAL;
raisedTimeStamp:Tue Sep 18 23:02:53 ICT 2012;
clearedTimeStamp:{empty};
lastModificationTimeStamp:{empty};
additionalInfo:{empty};
sourceFriendlyName:NE System:GPON48;
acknowledged:false;
probableCause:Synchronization Source Mismatch;
alarmDomain:NE;
notes:{empty};
asamAlarmServAffType:serviceAffecting;
specificProblem:System In Holdover Mode Or In Free Run Mode;
repairActions:Check the peer equipment and link between peer equipment and
the ASAM for all the timing references.;
filterId:{empty};
filterThreshold:{empty};
filterType:{empty};
filterWindow:{empty};
userId:{empty};
emsDomain:AMS;
lastAcknowledgedTimeStamp:{empty};
lastAcknowledgedUserId:{empty};
neAlarmType:1/6;
lastAcknowledgedInetAddress:{empty};
lastChangedUserIdInetAddress:{empty};
aliasName:{empty};
neIpAddress:172.21.222.101;
5.4.2 Identify an alarm type uniquely

The 5529 OAD can be enabled to include a unique alarm identifier (uniqueKey) for
5520 AMS, 5529 Enhanced Applications, and NE alarm types that are forwarded by
the 5529 OAD in the script forwarding interface. See the 5529 Enhanced
Applications Release Notice for more information.
5.5 Performance monitoring

The EMS Performance Monitoring view displays performance monitoring data for an
application server in graphical format. You can view the following graphs for the
5529 OAD:
• Event Loss Occurred
• Internal Message Count
• JMS Messages Queued
• Subscribers
Data for the 5529 OAD is updated every two minutes.

See the 5520 AMS Administrator Guide for information about:
• displaying EMS performance monitoring data; choose the OSS Alarm Dispatcher
counter
• exporting graphs
5.6 Logs
The 5529 OAD log information is copied to the following files in the
$AMS_DEBUG_DIR directory:
• nbi.log
• server.log
Note — In a cluster deployment, log information is recorded on the
server where the authentication is done.
5.6.1 nbi.log
The nbi.log file contains 5529 OAD-specific messages and JMS client connection,
disconnection, and authentication failure messages.
The 5529 OAD logs information about the result of operation requests sent by OSS
client applications to the nbi.log file. The 5529 OAD supports logging for the
operations described in the 5529 OAD Northbound Interface Guide.
Each new operation request adds a new entry to the nbi.log. Each log entry starts
with a timestamp that indicates when the operation was completed or failed, and
contains keywords that identify information blocks about the operation result. Two
adjacent information blocks are delimited by a comma.
Table 13 describes the keywords that can be present in an nbi.log entry for the result
of an operation request.
Table 13 nbi.log file keywords
Keyword Description
INFO JBOSS log level information
Operation: Name of the supported operation that was sent in the request
Examples: getActiveAlarms, getActiveAlarmsCount, getSystemInfo
SourceIP: Source IP address of the OSS client (or load balancer) that sent the operation
request.
When the SourceIP information is present in the log, the X-Forwarded-For
information is not present in the log.
X-Forwarded-For: Original source IP address of the OSS client that sent the operation request.
The X-Forwarded-For is an HTTP header field that is used to identify the
originating IP address of an OSS client that originated the request through an
HTTP proxy or load balancer. For more information about the
X-Forwarded-For field, see the 5520 AMS Northbound Interface Guide.
When the X-Forwarded-For information is present in the log, the SourceIP
information is not present in the log.
(1 of 2)
Keyword Description
Username: Name of the OSS client application that sent the operation request
Result: Result of the operation

Example: Success or Failed
ErrorCode: Error code if the operation result is Failed

The error code in the nbi.log is the same error code that is provided in the
operation response.
ErrorMessage: User-friendly description of the error if the operation result is Failed
(2 of 2)
The following logs from the nbi.log file are examples of JMS client connection,
disconnection, and authentication failure messages:
• Log in: 2015-05-29 11:29:00,275 INFO [oad-13335]-[OAD]
[com.alcatel.axs.container.jms.DurableSubscribers Interceptor] User OADNBI
logged in from IP_address
• Log out: 2015-05-29 11:30:18,418 INFO [oad-13335]-[OAD]
[com.alcatel.axs.container.jms.DurableSubscribersInterceptor] User OADNBI
logged out from IP_address
• Failed connection: 2015-05-29 11:31:39,752 INFO [nbi-13718]-[NBI]
[com.alcatel.axs.container.jms.DurableSubscribersInterceptor] Failed login
attempt made for User OADNBI from IP_address
For more information about the nbi.log file, see the 5520 AMS Administrator Guide.
5.6.2 server.log
The server.log file contains communication messages exchanged with the
5520 AMS, internal error messages, and details about processing events from the
5520 AMS.
For more information about the server.log file, see the 5520 AMS Administrator
Guide.
5.7 EMS alarms

See the 5520 AMS and 5529 Enhanced Applications Alarm Search Tool for
information about the EMS alarms raised by the 5529 OAD. The alarms can be
viewed in the Alarm perspective of the 5520 AMS.
5.8 JMX console settings

This section describes JMX console settings that affect 5529 OAD operations. You
require permission from Nokia Product Line Management to modify the settings. The
modification needs to be performed by Nokia personnel only. Contact your Nokia
technical representative for more information.
5.8.1 Enabling a unique alarm ID

The 5529 OAD can be enabled to include a unique alarm identifier (uniqueKey) for
5520 AMS, 5529 Enhanced Applications, and NE alarm types that are forwarded by
the 5529 OAD. The uniqueKey alarm IDs are unique for NE alarms because they
contain the NE type and release number and are not affected by changes in the GUI.
The existing neAlarmType alarm ID for NE alarms remains unchanged.
When this feature is enabled, a uniqueKey alarm ID is added to the vendor
extensions of each alarm for all 5520 AMS, 5529 Enhanced Applications, and NE
alarms. Whether the feature is enabled or disabled, the change is effective
immediately and does not require the 5529 OAD to be restarted. The change is also
logged in the nbi.log file.
The uniqueKey alarm ID is included in the following 5529 OAD interfaces:
• HTTP/S (SOAP XML)
• JMS
• SNMP traps
• script forwarding
You cannot filter on the uniqueKey alarm ID in the JMS or HTTP/S (SOAP XML)
interfaces.
The values in the uniqueKey alarm ID match the alarms described in the 5520 AMS
and 5529 Enhanced Applications Alarm Search Tool.
5.8.1.1 Format of 5520 AMS and 5529 Enhanced

Applications uniqueKey alarm ID
The format of the uniqueKey alarm ID for 5520 AMS and 5529 Enhanced
Applications alarms is:
application#application_release_number#object_type#probable_cause#specific_
problem
where:
• application is ams, which is the application where the alarm is raised (ams is also
used for 5529 Enhanced Applications alarms)
• application_release_number is the application release number; for example, 9.7
• object_type is the object type where the alarm is raised; for example, license, ne,
or provisionedjbossserver
• probable_cause is the probable cause of the alarm; for example, eMSProblem or
alarmSynchronizationProblem
• specific_problem is the specific problem associated with the probable cause; for
example, invalidOADLicense or alarmResynchronizationFailure. This element is
optional and may not always appear in the uniqueKey alarm ID, in which case the
ID ends with the # delimiter.
An example of a 5520 AMS uniqueKey alarm ID is:

ams#9.7#license#eMSProblem#majorExpiredLicense
An example of a 5529 Enhanced Applications uniqueKey alarm ID is:
ams#9.7#license#eMSProblem#invalidOADLicense
5.8.1.2 Format of NE uniqueKey alarm ID

The format of the uniqueKey alarm ID for NE alarms is:
NE_plug_type#NE_plug_type_release_number#object_type#probable_cause#spe
cific_problem
where:
• NE_plug_type is the type of NE support plug-in where the alarm is raised; for
example, isam, ihub, gpon, or g6
• NE_plug_type_release_number is the release number of the NE support plug-in
type; for example, 5.6, 4.9, or 12.3
• object_type is the object type where the alarm is raised; for example, ontslot or
imagroup
• probable_cause is the probable cause of the alarm; for example,
configurationOrCustomizationError
• specific_problem is the specific problem associated with the probable cause; for
example, invalidBoardType or farEndFailedConfiguration. This element is
optional and may not always appear in the uniqueKey alarm ID, in which case the
ID will end with the # delimiter.
An example of the NE uniqueKey alarm ID is:

g6#12.3#nesystem#synchronizationSourceMismatch#primaryClockFailure
Customer document and product support
Customer documentation
Customer Documentation Welcome Page
Technical Support
Product Support Portal
Documentation feedback
Customer Documentation Feedback
© 2019 Nokia.
3JL-04001-BTAA-RJZZA

3JL04001BTAARJZZA01 - V1 - 5529 OAD Release 9.7 Installation and Administration Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

3JL04001BTAARJZZA01 - V1 - 5529 OAD Release 9.7 Installation and Administration Guide

Uploaded by

Copyright:

Available Formats

Installation and Administration Guide

5529 OSS Alarm Dispatcher,

Installation and Administration Guide

Nokia — Proprietary and confidential

Nokia is a registered trademark of Nokia Corporation. Other products and company

5.8.1 Enabling a unique alarm ID .......................................................................43

1.1 Related documentation

Customer documentation Description

5520 Access Management System

5520 AMS Administrator Guide Information about administrative functions, including

5520 AMS and 5529 Enhanced Applications

5529 Enhanced Applications

5529 OSS Alarm Dispatcher

1.2 Conventions used in this guide

Convention Description Example

Italics Identify a variable hostname

Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G

Key–Key Type the appropriate simultaneous keystroke sequence. CTRL–G

↵ Press the Return key. ↵

— An em dash in a table cell indicates that there is no information. —

1.2.1 Important information

Warning — Warning indicates that the described activity or situation

Caution — Caution indicates that the described activity or situation

Note — A note provides information that is, or may be, of special

1.2.2 Procedures with options or substeps

Procedure 1 Example of options in a procedure

a This is one option.

b This is another option.

2 You must perform this step.

Procedure 2 Example of substeps in a procedure

i This is the first substep.

ii This is the second substep.

iii This is the third substep.

2 You must perform this step.

1.3 Multiple PDF file search

Procedure 3 To search multiple PDF files for a term

1 Open the Adobe Reader.

3 Enter the term to search for.

4 Select the All PDF Documents in radio button.

5 Choose the folder in which to search using the drop-down menu.

6 Select the following search criteria, if required:

• Whole words only

7 Click on the Search button.

2.2 What’s new in Release 9.6.07

2.3 What’s new in Release 9.6.05

2.1 What’s new in Release 9.7

Feature/enhancement Description Edition See

2.2 What’s new in Release 9.6.07

Feature/enhancement Description Edition See

New features and enhancements

Feature/enhancement Description Edition See

2.3 What’s new in Release 9.6.05

Feature/enhancement Description Edition See

New features and enhancements

3.2 Standalone and cluster 5529 OAD deployment models

3.3 System requirements

3.4 Technologies and standards

3.2 Standalone and cluster 5529 OAD

3.2.1 Standalone deployment

OSS SNMP client OSS client

Web services JMS provider

5520 AMS 5523 AWS

3.2.2 Cluster deployment