Вы находитесь на странице: 1из 31

Tellabs

8000 Network Manager R17A


Installation and Conguration Guide for
Northbound Interface
70173_01
12.06.09
Document Information
2009 Tellabs. All rights reserved.
This Tellabs manual is owned by Tellabs or its licensors and protected by U.S. and international copyright laws, conventions and
treaties. Your right to use this manual is subject to limitations and restrictions imposed by applicable licenses and copyright laws.
Unauthorized reproduction, modication, distribution, display or other use of this manual may result in criminal and civil penalties.
The following trademarks and service marks are owned by Tellabs Operations, Inc. or its afliates in the United States and/or
other countries: TELLABS

, TELLABS

logo, TELLABS and T symbol

, and T symbol

.
Any other company or product names may be trademarks of their respective companies.
The specications and information regarding the products in this manual are subject to change without notice. All statements,
information, and recommendations in this manual are believed to be accurate but are presented without warranty of any kind,
express or implied. Users must take full responsibility for their application of any products.
Adobe

Reader

are registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
2
Document Information
Terms and Conventions
Term Explanation
API Application Programming Interface
CommFW Tellabs

8000 network manager Communication Framework


CORBA Common Object Request Broker Architecture
FAULTSRV Management Server running Fault service in Tellabs

8000 network manager


FMS Fault Management System
IAIF Internal Adaptation Interface of the Tellabs

8000 network manager NBI


IM Information Model
LSLL License Server
MNGTSRV Management Server of Tellabs

8000 network manager


NBI Software which provides northbound interface services for 3
rd
party OSSs
NBIFSRV Northbound Interface service of Management Server of Tellabs

8000 network
manager. NBIFSRV provides e.g. Fault Management interoperability services to
third party OSSs.
NE Network Element
OSR Object Server
OSS Operations Support System. Includes e.g. EMS, NMS and SMS functionalities.
TCP/IP Transmission Control Protocol/Internet Protocol
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
3
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
4
Table of Contents
Table of Contents
About the Manual .............................................................................................................. 7
Objectives....................................................................................................................................................................... 7
Audience......................................................................................................................................................................... 7
Related Documentation.................................................................................................................................................. 7
Document Conventions .................................................................................................................................................. 8
Documentation Feedback............................................................................................................................................... 8
1 Foreword...................................................................................................................... 9
2 System Description..................................................................................................... 10
2.1 General................................................................................................................................................................. 10
2.2 Supported Congurations.................................................................................................................................... 10
2.3 Processes of the Northbound Interface................................................................................................................ 12
2.4 Hardware and Software Requirements ................................................................................................................ 13
3 Installing the Northbound Interface........................................................................... 14
3.1 General................................................................................................................................................................. 14
3.2 Installing the Standard Conguration of the NBI................................................................................................ 14
3.3 Installing the Full Management Server Conguration of NBI ............................................................................ 16
4 Conguring Northbound Interface ............................................................................ 17
4.1 General................................................................................................................................................................. 17
4.2 Conguration File Parameters ............................................................................................................................. 17
4.2.1 NMS.INI .............................................................................................................................................. 17
4.2.2 NBIFSRV_SERVICE.INI.................................................................................................................... 18
4.2.3 NBS.INI............................................................................................................................................... 19
4.2.4 NSA.INI............................................................................................................................................... 21
4.2.5 NKP.INI ............................................................................................................................................... 24
4.2.6 FMSP.INI............................................................................................................................................. 25
4.2.7 nma-logging.properties........................................................................................................................ 26
4.2.8 Usage of NTO.EXE............................................................................................................................. 27
4.3 Client Software Specic Conguration File Settings.......................................................................................... 29
4.3.1 IBM Tivoli Netcool ............................................................................................................................. 29
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
5
Table of Contents
4.4 Using Professional Services Adapter (NIMA.EXE) in the Same Computer as NBI Socket Adapter
(NSA.EXE).......................................................................................................................................................... 29
5 Creating Northbound Interface Operators................................................................ 30
6 Controlling Northbound Interface.............................................................................. 31
6.1 Starting Northbound Interface............................................................................................................................. 31
6.2 Stopping Northbound Interface ........................................................................................................................... 31
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
6
About the Manual
About the Manual
This part discusses the objectives and the intended audience of this manual, Tellabs 8000
Network Manager Installation and Conguration Guide for Northbound Interface, and
consists of the following sections:
Objectives
Audience
Related Documentation
Document Conventions
Documentation Feedback
Objectives
This manual provides instructions on installing and conguring the Northbound Interface in the
Tellabs

8000 network manager.


Audience
This manual is designed for the installation personnel of a telecommunications operator.
Related Documentation
Tellabs

8000 Network Manager R17A


Third Party Hardware and Software Requirements
(70002_XX)
Describes all the needed third party software
components and versions in the Tellabs 8000
network manager system (operating systems,
service packs, database server versions, client
versions, web browsers). Describes also
the recommended computer platforms, LAN
congurations and the minimum performance
requirements for computers.
Tellabs

8000 Network Manager R17A


Software Installation Manual (70170_XX)
Provides instructions on how to install and
congure Tellabs 8000 network manager in
different Tellabs 8000 network manager computer
platforms (workstation, servers).
Tellabs

8000 Network Manager R17A


TCP/IP Client Programmers Guide for the Fault
and Provisioning Adapter of the Northbound
Interface (70176_XX)
Contains instructions on how to develop client
software which interfaces with NBI.
Tellabs

8000 Network Manager R17A


Release and Installation Notes (70179_XX)
Describes the recommendations and restrictions
for installing, conguring and using Tellabs 8000
network manager.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
7
About the Manual
Tellabs

8000 Network Manager R17A Bug


Notes (70180_XX)
Lists the known bugs.
Tellabs

8000 Network Manager R17A


LDAP Authentication Conguration User Manual
(70186_XX)
Provides instructions on how to congure LDAP
Authentication in Tellabs 8000 network manager.
Document Conventions
This is a note symbol. It emphasizes or supplements information in the document.
This is a caution symbol. It indicates that damage to equipment is possible if the instructions
are not followed.
This is a warning symbol. It indicates that bodily injury is possible if the instructions are not
followed.
Documentation Feedback
Please contact us to suggest improvements or to report errors in our documentation:
Email: -documentation@tellabs.com
Fax: +358.9.4131.2430
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
8
1 Foreword
1 Foreword
This document provides instructions on installing and conguring the northbound interface
in Tellabs

8000 network manager R17A and is targeted for the installation personnel of a
telecommunications operator.
There is also another document on the Northbound Interface (NBI) of Tellabs 8000 manager intended
for the third party OSS developers, containing instructions on how to develop client software which
interfaces with the NBI. Tellabs

8000 Network Manager TCP/IP Client Programmers Guide for


the Fault and Provisioning Adapter of the Northbound Interface contains:
NBI information model
Data presentation of TCP/IP Protocol Adapter.
From Tellabs 8000 manager R16 onwards, the abbreviation NBI is used throughout this
manual to refer to the Northbound Interface. The old abbreviation NBIF is, however, still used
in le names, attribute names and some interface elements.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
9
2 System Description
2 System Description
2.1 General
The Northbound Interface in Tellabs 8000 manager is a gateway which enables interoperability with
third party OSSs in a multivendor environment.
The NBI enables the third party OSSs to request operations in Tellabs 8000 manager. The NBI is also
able to notify the third party OSSs about conguration changes and alarms in Tellabs 8000 manager.
The NBI supports fault management and macro execution, also offers a future growth path to
other areas of network management such as topology management, performance management
and connection management.
The NBI software consists of the communication adapter process and the NBI Kernel process. The
communication adapters are responsible for the communication protocol (e.g. TCP/IP or CORBA)
specic tasks whereas the NBI Kernel is responsible for executing the service requests by calling
the lower layer services of Tellabs 8000 manager, e.g. Fault Server, Macro Manager and Object
Server. The NBI Kernel has an interface called Internal Adaptation interface. Communication
adapters publish NBI information models (NBI IMs) which describe the services available to third
party clients. In addition to FMS information, the information model of NBI Kernel supports some
PMS, connection management and topology information.
The Northbound Interface contains a communication adapter providing a TCP/IP interface. The
NBI supports retrieving active NE faults and faulty services and sending notications about the NE
faults and faulty services.
The NBI runs on a Management Server computer. It can serve a maximum of twenty simultaneous
clients. If needed, more than one Management Server computer may be running NBI per one
managed network.
2.2 Supported Congurations
Standard Conguration of the NBI as the recommended option and Full Management Server
Conguration of the NBI are the two supported NBI running congurations. The difference
between the two congurations is that in the Standard Conguration mode the NBI is the only
service allowed to run in the Management Server computer, i.e. a dedicated computer is required
for the NBI. However, in Full Management Server Conguration also other services supported by
the Management Server may be running simultaneously, i.e. a dedicated computer for the NBI is
not required. Moreover, the macro execution feature of the NBI is supported only by the Standard
Conguration.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
10
2 System Description
Full Management Server Conguration may be used only if:
The macro execution feature of the NBI is not used.
and
The performance load of the Management Server computer does not cause disturbances
for the service, e.g. the Management Server is not serving a big number of management
workstations.
For optimal performance and reliability, it is recommended always to use the Standard
Conguration of the NBI, i.e. run the NBI in a dedicated Management Server.
If the macro execution feature of the NBI is used, it is mandatory to use the Standard
Conguration of the NBI, i.e. run the NBI in a dedicated Management Server.
Fig. 1 Tellabs 8000 Network Manager NBI Product
Fig. 1 presents the NBI in Tellabs 8000 manager. The NBI software is depicted inside the dashed
rectangle.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
11
2 System Description
Fig. 2 Supported Interactions when using NBI Standard Conguration
In Fig. 2 you can see the supported interactions in the standard conguration. Server computer1 is
a Management Server running Fault Server (Management Server with the service FAULTSRV).
Server computer2 is a Management Server running NBI (Management Server with the service
NBIFSRV). Note that in the standard conguration the NBI requires a dedicated Fault Server
Process.
2.3 Processes of the Northbound Interface
The NBI runs on a Management Server computer. The most important processes of a Management
Server running the NBI are described below.
Process Description
SUPERVISOR SUPERVISOR is the main process of Management Server. It starts the other
Management Server processes, collects status data from other server processes and
starts NBI Supervisor process (NBS), which starts the other NBI related processes.
SUPERVISOR belongs to the Management Server platform. It is also used in other
Management Server congurations.
SRVCTRUI SRVCTRUI is the Status dialog (controlling panel) of Management Server.
Management Servers are controlled and monitored through this process.
SRVCTRUI belongs to the Management Server platform. It is also used in other
Management Server congurations.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
12
2 System Description
Process Description
NBS NBS is the NBI Supervisor process. The Management Server platform starts and
stops it. NBS is responsible for starting and stopping NBI processes (NKP and
NSA).
NKP NKP is the NBI Kernel process. It provides an internal adaptation interface to be
used by NBI communication adapters.
NSA NSA is the TCP/IP Socket Communication Adapter process of the Tellabs 8000
manager northbound interface. The available services are described in more detail
in the NBI information model (see Tellabs

8000 Network Manager TCP/IP Client


Programmers Guide for the Fault and Provisioning Adapter of the Northbound
Interface. The third party client software, i.e. a third party NMS or SMS, connects
to this process by using the TCP/IP protocol and socket interface.
FMSP FMSP is the Fault Server process. This process takes care of fault processing and
Fault Services for NBI.
CICO, TDSV,
NAMS, LSLL,
MMSRV,
MMAG
The Circuit Connector (CICO), Test Data Server (TDSV), Name Server (NAMS)
and License Server (LSLL) processes are also needed in the Management Server
conguration when running NBI. Macro Manager Service (MMSRV) and Macro
Manager Agent (MMAG) are needed when MTOSI Service is used or the
8600-based macros are executed using NBI.
NMA NMA is an MTOSI Service. It provides MTOSI 2.0 interface for the MTOSI web
clients.
2.4 Hardware and Software Requirements
Refer to Tellabs

8000 Network Manager Third Party Hardware and Software Requirements for
information on the operating system and hardware requirements.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
13
3 Installing the Northbound Interface
3 Installing the Northbound Interface
3.1 General
Management Server running the NBI in the Tellabs 8000 manager R17A uses the Tellabs 8000
manager R17A database. The Server needs a database connection, and the SYBASE Open Client
software for Windows has to be installed on the Server. The required level for Sybase Open Client is
dened in Tellabs

8000 Network Manager Third Party Hardware and Software Requirements.


Older database versions must be updated to R17A database before the Management Server
running NBI for R17A can be used. Information on how to update the database is given in
Tellabs

8000 Network Manager Release and Installation Notes.
3.2 Installing the Standard Conguration of the NBI
To install the standard conguration of NBI, proceed as follows.
Step 1 Start the installation of the Tellabs 8000 manager software.
Insert the installation CD-ROM into the drive.
Type <Drive>:\NMS\INSTALL\SETUP.
Tellabs 8000 manager Setup Wizard starts.
Click Next.
Step 2 Select the installation type and mode.
Select 8000 Manager Mode.
Select the installation type Install.
After making the necessary selections click Next.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
14
3 Installing the Northbound Interface
Step 3 Select the conguration.
Select Management Server from Selected Conguration and select the Northbound In-
terface service from Services to install the standard NBI conguration. Deselect the rest of
the presented Services.
Do not select any other service than the Northbound interface service from the list of Services
when installing the standard conguration of NBI.
If you have a partitioned network, tick the Partitioned Network check box.
If you use the 8600 Macro execution support of NBI, tick the 8600 Macro support check
box. Moreover, if you use MTOSI Service, tick the MTOSI support check box. Note
that selecting MTOSI support automatically selects also 8600 Macro support which is
required by MTOSI Service.
Click Next.
Step 4 Set the names of the used Tellabs 8000 manager servers.
Fill in Database Server name and Database name entry elds.
Leave all other entry elds empty.
Click Next.
Step 5 Set other miscellaneous settings.
In frame Preferred network adapter for Tellabs 8000 network manager, ll in the in-
formation about the network adapter which is connected to the Tellabs 8000 management
LAN.
Click Next.
Step 6 Select the environment where to store settings.
If you want to run the server as a Windows service, tick the Run server as a Windows
service check box, click the Run as a named Windows account radio button and ll in the
Account, Password and Conrm password entry elds.
Make the other selections.
Click Next.
Step 7 Select the destination drive and directory and make other needed selections.
Select Installation directory.
Deselect the Install additional HTML Online Helps check box.
If you do not wish to install the full documentation set (such as DB description) to the
\NMS\Doc directory, deselect the Install full documentation set check box.
Click Next.
If you are asked to create a directory, click Yes.
Step 8 Verify the conguration.
After checking that the selected installation is correct, click Install.
The installation of Tellabs 8000 manager starts.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
15
3 Installing the Northbound Interface
Step 9 Complete the installation.
If you wish to edit the NMS.INI le, click the Edit NMS.INI le button.
If you wish to check the log le, click the View installation log le button.
Click Finish.
Tellabs 8000 manager is installed.
Step 10 Install Sybase Open Client on the Management Server which is to run the NBI.
For further instructions, refer to Tellabs

8000 Network Manager Software Installation Manual.


Step 11 Install the NBI licenses.
For further instructions, refer to Tellabs

8000 Network Manager Release and Installation Notes.


Step 12 If the PMS features of the northbound interface will be used, enable the PM data collection in
Tellabs 8000 manager.
For further instructions, refer to section User instructions in Tellabs

8000 Network Manager


Online Help.
Step 13 If the Management Server computer has more than one LAN card, set the conguration le
parameter USER_DEFINED_IP_ADDRESS in nsa.dat.
Step 14 In the MTOSI conguration if desired, congure the MD and FD names in nma.xml (located in the
%NMSDIR%\dat directory).
Step 15 If HTTPS protocol is used in the MTOSI conguration, you need to create the Java key standard
client and server certicate les. The client certicate should be called client.jks and the server
certicate server.jks. After le creation, copy the certication les to the %NMSDIR%\certs
directory. Save the passwords used in the certicate creation to nma.xml by replacing the token
"password" with the actual password in the following XML tags:
<keyManagerPswd>password</keyManagerPswd>
<clientJKSPswd>password</clientJKSPswd>
<serverJKSPswd>password</serverJKSPswd>
Moreover, in the case of HTTPS, enable the #NMA_HTTPS_PORT = 8818 entry in NMS.INI
by removing the # character.
In the case of MTOSI Service, it is mandatory to change the NBIFKERNEL_MACRO-
FILEDIR=%NMSDIR%\mac entry to the NBIFKERNEL_MACROFILEDIR=%NMSDIR%\bin entry
in %NMSDIR%\dat\nkp.ini.
3.3 Installing the Full Management Server Conguration of NBI
To install the Full Management Server Conguration of NBI, please refer to Tellabs

8000 Network
Manager Software Installation Manual.
The installation should be done according to the installation instructions of the Management Server
described in the above mentioned document.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
16
4 Conguring Northbound Interface
4 Conguring Northbound Interface
4.1 General
The conguration le parameters that have to be dened when conguring the NBI are described
here. The parameters reside in the following les:
<drive>\NMS\NMS.INI
<drive>\NMS\dat\service\NBIFSRV_SERVICE.INI
<drive>\NMS\dat\NBS.INI
<drive>\NMS\dat\NSA.INI
<drive>\NMS\dat\NKP.INI
<drive>\NMS\dat\FMSP.INI
Also, the conguration le settings specic to the third party client software are described.
4.2 Conguration File Parameters
4.2.1 NMS.INI
After installing the NBI software conguration you must set the correct values to the following
parameters.
DBSRVR = <Name of the database server>
DBNAME = <Name of the database>
COMPUTERNAME = <LAN name of the Management Server computer>
After installing the NBI software conguration the following default values have already been set
to the NMS.INI le. They may not be edited.
CONFIGURATION = MNGTSRV
SRV_SERVICE1 = NBIFSRV
CACHER = ON
CACHER_INI_FILE = <drive>\nms\dat\CACHER.INI
(CACHER.PAR in case of a partitioned network)
NBS_PIPE = NBIF_SUPV_PIPE
NKP_PIPE = NBIF_KERNEL_PIPE
NKP_PORT = 40058
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
17
4 Conguring Northbound Interface
4.2.2 NBIFSRV_SERVICE.INI
The Management Server service parameters are dened in the NBIFSRV_SERVICE.INI le. The
parameters are described below. The correct values are set to these parameters during the installation
of the NBI software. These values may not be edited.
Parameter Description
SERVICE_RESTART If this parameter is set to YES, the service will be
restarted if it has been stopped because of a failure.
The default value is NO.
SLAVE_PROCESS[x]_NAME The name of the server process. The index value x
ranges from 1 to 256. The rst server process in the
list must have the value 1, and the second process
must have the value 2, etc.
SLAVE_PROCESS[x]_STARTTIME The longest allowed start time for a process in
seconds. If the process has not started properly
during the dened time, the server is shut down. The
value can be increased if there are problems with
starting the process.
SLAVE_PROCESS[x]_STARTPARAMS Process command line parameters.
SLAVE_PROCESS[x]_PRIORITY Indicates the starting order of the processes required
by the service.
SLAVE_PROCESS[x]_CONSOLE This parameters can have the values YES or NO.
YES means that a process has a console. The default
value is NO.
SLAVE_PROCESS[x]_STOPTIME This parameter dened the timeout in seconds for
shutting down the process when the shutdown is
requested by the supervisor. After the timeout has
elapsed the process will be killed by the supervisor.
SLAVE_PROCESS[x]_RESTART This parameter can have the values YES or NO.
YES means the process is restarted by Management
Server Supervisor in case of an unexpected process
shutdown. The default value is YES.
SLAVE_PROCESS[x]_RESTART_TIME The time in seconds how long a process has to
be alive before Management Server Supervisor
restarts it in case of an unexpected process
shutdown. This parameter is relevant only if
SLAVE_PROCESS[x]_RESTART=YES
Example of NBIFSRV_SERVICE.INI
SERVICE_RESTART=YES
SLAVE_PROCESS1_NAME = NAMS
SLAVE_PROCESS1_STARTTIME = 300
SLAVE_PROCESS1_STARTPARAMS =
SLAVE_PROCESS1_PRIORITY = 1
SLAVE_PROCESS1_RESTART = NO
SLAVE_PROCESS2_NAME = CICO
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
18
4 Conguring Northbound Interface
SLAVE_PROCESS2_STARTTIME = 300
SLAVE_PROCESS2_STARTPARAMS =
SLAVE_PROCESS2_PRIORITY = 1
SLAVE_PROCESS2_RESTART = NO
SLAVE_PROCESS3_NAME = TDSV
SLAVE_PROCESS3_STARTTIME = 300
SLAVE_PROCESS3_STARTPARAMS =
SLAVE_PROCESS3_PRIORITY = 1
SLAVE_PROCESS3_RESTART = NO
SLAVE_PROCESS4_NAME = FMSP
SLAVE_PROCESS4_STARTTIME = 300
SLAVE_PROCESS4_STARTPARAMS = srvmode=1
SLAVE_PROCESS4_PRIORITY = 1
SLAVE_PROCESS4_RESTART = NO
SLAVE_PROCESS5_NAME = NBS
SLAVE_PROCESS5_STARTTIME = 300
SLAVE_PROCESS5_STARTPARAMS =
SLAVE_PROCESS5_CONSOLE = NO
SLAVE_PROCESS5_STOPTIME = 30
SLAVE_PROCESS5_PRIORITY = 2
SLAVE_PROCESS5_RESTART = YES
SLAVE_PROCESS5_RESTART_TIME = 60
4.2.3 NBS.INI
The NBI Supervisor parameters are dened in NBS.INI. These parameters are described below.
The correct values are set to these parameters during the installation of the NBI software. These
values may normally not be edited.
Parameter Description
NBIF_KERNEL_FOREGROUND
This parameter can have the values YES or NO. YES
means that the NBI Kernel process NKP.EXE has a
console. The default value is NO.
CA_NUM_START_TRIALS The number of attempts to start the communication
adapter in case of an unsuccessful start. The default
value is 2.
CA_WAIT_BETWEEN_START_TRIALS Waiting time (in milliseconds) between attempts to
start the communication adapter. The default value is
2000 milliseconds.
CA[x] The name of the communication adapter process
(without .exe). The index value x ranges from 1 to
5. (It is possible to run one to ve Communication
Adapter Processes simultaneously, each with a
different conguration.)
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
19
4 Conguring Northbound Interface
Parameter Description
CA[x]_SUPVPIPE The supervisor pipe name of the communication
adapter. The name must be unique if more than one
communication adapter is used.
CA[x]_FOREGROUND This parameter can have the values YES or NO. YES
means that the communication adapter has a console.
The default value is NO.
CA[x]_INIFILE The path and name of the communication adapter
INI le. The value must be unique if more than one
communication adapter is used. The index value x
ranges from 1 to 5. (It is possible to run one to ve
communication adapter processes simultaneously,
each with a different conguration.)
NBIF_KERNEL_KILL_WAITTIME
The time in seconds how long NBI Supervisor waits
for a controlled shutdown of the NBI Kernel process
(NKP.EXE) after sending a stop request to it before
NBI Supervisor kills the NBI Kernel process. The
default value is 2 seconds.
NBIF_KERNEL_ALLOWED_START_TIME
The time in seconds how long NBI Supervisor waits
for the NBI Kernel process to start. If the time elapses,
NBI Supervisor terminates all NBI processes. The
default value is 10 seconds.
COMM_ADAPTER_KILL_WAITTIME The time in seconds how long NBI Supervisor waits
for a controlled shutdown of the communication
adapter process after sending a stop request to it before
NBI Supervisor kills the communication adapter
process. The default value is 7 seconds.
COMM_ADAPTER_ALLOWED_START_TIME
The time in seconds how long NBI Supervisor waits
for the communication adapter process to start. If
the time elapses, NBI Supervisor terminates all NBI
processes. The default value is 30 seconds.
NBIF_SUPV_LOGFLAGS This parameter controls the logging of NBI
Supervisor to NBIF_SUPV_LOGFILE and to
display if NBIFSRV_SERVICE.INI contains
the SLAVE_PROCESS[x]_CONSOLE = YES
denition for the NBI Supervisor process (NBS). This
can be changed in the run time with the command
line application NTO.EXE. For instructions on using
NTO.EXE see 4.2.8 Usage of NTO.EXE. The possible
values are:
# display everything. errors only
to file:
NBIF_SUPV_LOGFLAGS=100001
# display and log errors only:
NBIF_SUPV_LOGFLAGS=100100
# display and log everything:
NBIF_SUPV_LOGFLAGS=001001
# display nothing. everything to
file:
NBIF_SUPV_LOGFLAGS=001000
# display and log nothing:
NBIF_SUPV_LOGFLAGS=000000
# display nothing. errors only to
file:
NBIF_SUPV_LOGFLAGS=100000
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
20
4 Conguring Northbound Interface
Parameter Description
NBIF_SUPV_NMSTRACE_USE
This parameter can have the values ON or OFF. ON
means that NBI Supervisor uses NMSTRACE for
tracing. OFF means that NBI Supervisor does not
use NMSTRACE. The default value is ON. This
can be changed in the run time with the command
line application NTO.EXE. For instructions on using
NTO.EXE see 4.2.8 Usage of NTO.EXE.
NBIF_SUPV_LOGFILE
The path and name of the NBI Supervisor log le.
This can be changed in the run time with the command
line application NTO.EXE. For instructions on using
NTO.EXE see 4.2.8 Usage of NTO.EXE.
Example of NBS.INI
# display nothing. errors only to file
NBIF_SUPV_LOGFLAGS=100000
NBIF_SUPV_LOGFILE=%NMSDIR%\log\nbs.log
NBIF_SUPV_NMSTRACE_USE=ON
NBIF_KERNEL_FOREGROUND=NO
CA_NUM_START_TRIALS = 2
CA_WAIT_BETWEEN_START_TRIALS = 2000
CA0=NSA
CA0_SUPVPIPE=nsapipe
CA0_INIFILE=%NMSDIR%\dat\nsa.ini
CA0_FOREGROUND=NO
NBIF_KERNEL_KILL_WAITTIME = 2
NBIF_KERNEL_ALLOWED_START_TIME = 10
COMM_ADAPTER_KILL_WAITTIME = 7
COMM_ADAPTER_ALLOWED_START_TIME = 30
4.2.4 NSA.INI
The TCP/IP communication adapter (NSA.EXE) parameters are dened in NSA.INI. These are
described below.
Note! After installing the NBI software conguration you must set the correct value to the
following parameter:
SOCKET_PORT_NUMBER This parameter denes the Internet Port Number of the TCP/IP
communication adapter of the northbound interface. This is a 16-bit
value, i.e. the maximum value is 65535. This value must equal to the
port number used by the 3
rd
party clients which will open a TCP/IP
connection to the communication adapter.
Note! Do not use port number values smaller than 1024.
The correct values are set to these parameters during the installation of the NBI software. These
values may normally not be edited unless other instructions are given in 4.3 Client Software
Specic Conguration File Settings.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
21
4 Conguring Northbound Interface
Parameter Description
BYTE_CONVERSION
This parameter can have the values ON or OFF. ON
means that byte order conversion is performed for 16-bit,
32-bit and 64-bit values. OFF means that byte order
conversion is not performed. The default value is ON.
Northbound interface is designed to run on a computer
which stores data in byte order called Little-Endian,
which is the reverse of the network standard Big-Endian
order.
BYTE_CONVERSION=ON means that the NBI sends
data to the 3
rd
party system and receives data from the 3
rd
party system in the standard Big-Endian byte order.
COMMADAPTER_LOGFILE
The path and name of the TCP/IP communication adapter
(NSA.EXE) log le. This parameter can be changed
in the run time with the command line application
NTO.EXE. For instructions on using NTO.EXE see
4.2.8 Usage of NTO.EXE.
OPEN_CONNECTION_REQUIRED
This can have the values YES or NO. YES means that
the OpenConnection request from a 3
rd
party system is
required as the rst request after establishing the socket
connection to the NBI. The default value is YES.
DEFAULT_USER_NAME
The username of the NBI operator to which the connected
3
rd
party client is automatically associated by the NBI if
OPEN_CONNECTION_REQUIRED=NO. This parameter
is irrelevant if OPEN_CONNECTION_REQUIRED=YES.
This parameter must have a valid value if
OPEN_CONNECTION_REQUIRED=NO.
SYSTEM_NOTIF_FORMAT This parameter can have the values BASIC or
ENHANCED. BASIC means that the system notication
contains only a message header. ENHANCED means
that the system notication contains a message header
and additional information. The default value is
ENHANCED.
AUTO_EVENT_NOTIF_SUBSCRIPTION
This parameter can have the values ON or OFF. ON
means that the event notication and system notication
subscriptions are executed automatically when a 3
rd
party
client calls a Bulk-Get-request. The default value is OFF.
FILTER_SHUTTINGDOWN_SYS-
TEM_NOTIFICATIONS
This parameter can have the values ON or OFF. ON
means that the Shuttingdown system notication will not
be sent to the 3
rd
party client even if a system notication
subscription existed. The default value is OFF.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
22
4 Conguring Northbound Interface
Parameter Description
COMMADAPTER_LOGFLAGS
This parameter controls the logging of the
TCP/IP communication adapter (NSA.EXE) to
COMMADAPTER_LOGFILE and to display if NBS.INI
contains the CA[x]_FOREGROUND=YES denition
for the TCP/IP communication adapter (NSA.EXE).
This parameter can be changed in the run time with the
command line application NTO.EXE. For instructions
on using NTO.EXE see 4.2.8 Usage of NTO.EXE. The
possible values are:
# display everything. errors only to
file:
COMMADAPTER_LOGFLAGS=100001
# display and log errors only:
COMMADAPTER_LOGFLAGS=100100
# display and log everything:
COMMADAPTER_LOGFLAGS=001001
# display nothing. everything to
file:
COMMADAPTER_LOGFLAGS=001000
# display and log nothing:
COMMADAPTER_LOGFLAGS=000000
# display nothing. errors only to
file:
COMMADAPTER_LOGFLAGS=100000
COMMADAPTER_NMSTRACE_USE This parameter can have the values ON or OFF.
ON means that the TCP/IP communication adapter
(NSA.EXE) uses NMSTRACE for tracing. OFF means
that the TCP/IP communication adapter (NSA.EXE)
does not use NMSTRACE. The default value is ON.
This can be changed in the run time with the command
line application NTO.EXE. For instructions on using
NTO.EXE see 4.2.8 Usage of NTO.EXE.
USER_DEFINED_IP_ADDRESS
This parameter can be dened in NSA.INI only if the
Management Server running NBI has more than one
LAN card. In that case this parameter denes the LAN
card which is used for the NBI message trafc with the
3
rd
party OSS. If USER_DEFINED_IP_ADDRESS is
not set, the used LAN card is randomly selected by the
system from the available alternatives.
TIME_USAGE This parameter can have the values UTC, LOCAL or
LOCALWINTER. UTC means that datetime attribute
values are returned as Coordinated Universal Time
(UTC). LOCAL means that datetime attribute values are
returned as local time (having regard to daylight saving
time). LOCALWINTER means that datetime attribute
values are returned as local normal time. The default
value is LOCALWINTER.
Example of NSA.INI
# display nothing. errors only to file
COMMADAPTER_LOGFLAGS=100000
COMMADAPTER_LOGFILE=%NMSDIR%\log\nsa.log
COMMADAPTER_NMSTRACE_USE=ON
BYTE_CONVERSION=ON
SOCKET_PORT_NUMBER=2461
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
23
4 Conguring Northbound Interface
OPEN_CONNECTION_REQUIRED=YES
#DEFAULT_USER_NAME=
SYSTEM_NOTIF_FORMAT=ENHANCED
AUTO_EVENT_NOTIF_SUBSCRIPTION=OFF
FILTER_SHUTTINGDOWN_SYSTEM_NOTIFICATIONS = OFF
4.2.5 NKP.INI
The NBI Kernel parameters (NKP.EXE) are dened in NKP.INI. They are described below.
Note! After installing the NBI software conguration you must set the correct value to the following
parameter if a 3
rd
party client uses the macro execution feature of the NBI.
NBIFKERNEL_MACROFILEDIR
Path to the Tellabs 8000 manager macro les which are executed
by the NBI on 3
rd
party clients request. This parameter is relevant
only if the 3
rd
party client is using the macro execution feature of
NBI. Default value =<drive>:\NMS\MAC.
The correct values are set to these parameters during the installation of the NBI software. These
values may not be edited.
Parameter Description
NBIFKERNEL_MAX_GET_BUFF_SIZE The maximum size of the buffer which is returned to the
caller of the Bulk-Get request of NBI Kernel. If the read
data does not t into one buffer, the rest of the data is sent
to the caller in the subsequent buffers.
NBIFKERNEL_LOGFLAGS
This parameter controls the logging of NBI
Kernel (NKP.EXE) to NBIFKERNEL_LOGFILE
and to display if NBS.INI contains the
NBIF_KERNEL_FOREGROUND=YES denition.
This parameter can be changed in the run time with the
command line application NTO.EXE. For instructions
on using NTO.EXE see 4.2.8 Usage of NTO.EXE. The
possible values are:
# display everything. errors only to
file:
NBIFKERNEL_LOGFLAGS=100001
# display and log errors only:
NBIFKERNEL_LOGFLAGS=100100
# display and log everything:
NBIFKERNEL_LOGFLAGS=001001
# display nothing. everything to file:
NBIFKERNEL_LOGFLAGS=001000
# display and log nothing:
NBIFKERNEL_LOGFLAGS=000000
# display nothing. errors only to
file:
NBIFKERNEL_LOGFLAGS=100000
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
24
4 Conguring Northbound Interface
Parameter Description
NBIFKERNEL_LOGFILE
The path and name of the NBI Kernel (NKP.EXE) log le.
This parameter can be changed in the run time with the
command line application NTO.EXE. For instructions on
using NTO.EXE see 4.2.8 Usage of NTO.EXE.
NBIFKERNEL_NMSTRACE_USE This parameter can have the values ON or OFF. ON
means that NBI Kernel (NKP.EXE) uses NMSTRACE for
tracing. OFF means that NBI Kernel (NKP.EXE) does not
use NMSTRACE. The default value is ON. This parameter
can be changed in the run time with the command line
application NTO.EXE. For instructions on using NTO.EXE
see 4.2.8 Usage of NTO.EXE.
Example of NKP.INI
# display nothing. errors only to file
NBIFKERNEL_LOGFLAGS=100000
NBIFKERNEL_LOGFILE=%NMSDIR%\log\nkp.log
NBIFKERNEL_NMSTRACE_USE=ON
NBIFKERNEL_MACROFILEDIR=%NMSDIR%\mac
NBIFKERNEL_MAX_GET_BUFF_SIZE = 50000
4.2.6 FMSP.INI
After installing the NBI software conguration you must change the following two parameter
values in case the Fault Management features of NBI are used and you want NBI to behave as in
R14 and earlier:
FmspMaxFaultsMode = ON
FmspServerServiceFaultFilterOks = OFF
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
25
4 Conguring Northbound Interface
Parameter Description
FmspMaxFaultsMode The parameter can have values ONand OFF. The parameter
affects the behavior of NBI in case the maximum number
of faults (indicated by FmspRecommendedMaxFaults
in fmsp.ini) is reached. ON means that NBI is stopped.
If NBI is restarted it does not give any faults as response
when 3rd party OSS asks faults. OFFmeans that NBI
continues to operate as long there are enough resources in
the computer. When the computer runs out of resources the
behavior is indeterminate. The default value is OFF.
FmspServerServiceFaultFil-
terOks
The parameter can have values ON and OFF. The
parameter determines whether service faults which
are dened to not disturbing the service (with
servicefault.mtnevent=0) are returned to the
3
rd
party OSS or not. Denitions for not disturbing the
service faults can be viewed and modied with the Tellabs
8000 manager Fault Management GUI using the Service
view for Fault service section of dialog Set Fault Status
View.
ON means that the 3
rd
party OSS does not receive service
faults which are dened to belong in category not
disturbing the service. OFF means that the 3
rd
party
OSS receives service faults which are dened to belong in
category not disturbing the service. The default value
is ON.
4.2.7 nma-logging.properties
The nma-logging.properties le is relevant only for the MTOSI user.
The NMA logging options are located in %NMSDIR%\dat\nma-logging.properties.
Parameter Description
log4j.rootLogger The parameter denes the logging level and denes where
the operating system does the logging. The user can either
log to console or to le or both and specify the logging
level, where ALL, DEBUG, ERROR, FATAL, INFO, OFF,
TRACE, WARN are supported. The following syntax
needs to be followed: Level.ERROR,console,le (the user
can omit either console or le parameter) and that is the
offered default.
log4j.appender.file.File The parameter denes the output target le when the
system is logging to some le. The default target is
%NMSDIR%\log\nma.log.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
26
4 Conguring Northbound Interface
4.2.8 Usage of NTO.EXE
The command line application NTO.EXE is used for changing tracing and logging options when the
NBI is running. The initial values of these options are given in the conguration les NBS.INI,
NSA.INI and NKP.INI. The values are read from these les when the NBI is started. Note that
changes made by NTO.EXE are not stored into the mentioned les but are effective only until the
NBI is stopped.
The options that can be changed with NTO.EXE are as follows:
NBS.INI:
NBIF_SUPV_LOGFILE
NBIF_SUPV_LOGFLAGS
NBIF_SUPV_NMSTRACE_USE
NSA.INI:
COMMADAPTER_LOGFILE
COMMADAPTER_LOGFLAGS
COMMADAPTER_NMSTRACE_USE
NKP.INI:
NBIFKERNEL_LOGFILE
NBIFKERNEL_LOGFLAGS
NBIFKERNEL_NMSTRACE_USE
Changing Tracing and Logging Options in Run Time
Step 1 Start NTO.EXE from the command line.
Type the following command:
<drive>:\NMS\bin>nto
The start menu of NTO.EXE is displayed:
NBIF Tracing/Logging Control Utility.
Please make a choice from the following :
0. Exit
1. NBIF Kernel
2. NBIF Supervisor
3. Communication Adapter
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
27
4 Conguring Northbound Interface
Step 2 Select one of the alternatives from 0 to 3 and press Enter.
If you select 1.NBIF Kernel, 2.NBIF Supervisor or 3.Communication Adapter,
the process specic menu opens. The process specic menu displays the current tracing and logging
options of the process and provides the possibility to change one of them.
For example, if the selection is 2.NBIF Supervisor, the process specic menu may display
the following options:
Current Tracing/Logging options for Nbif Supervisor
NmsTrace usage = 1
Log file name = c:\NMS\log\nbs.log
Logging flags = 100000
Please make a choice from the following :
0. Cancel (return to start menu)
1. Update NmsTrace usage for Nbif Supervisor
2. Update Log file name for Nbif Supervisor
3. Update Logging flags for Nbif Supervisor
Step 3 Select one of the alternatives from 0 to 3 and press Enter.
If you select 1.Update NmsTrace usage for <Process>, 2.Update Log file
name for <Process> or 3.Update Logging flags for <Process>, NTO.EXE
asks you to give a new value for the corresponding option.
Step 4 Type the new value and press Enter (or cancel the operation by pressing . and Enter).
NTO.EXE displays the process specic menu again and you have to make a new selection. If you
select 0 and press Enter, you will return to the start menu.
You can stop the execution of NTO.EXE by selecting 0 and pressing Enter in the start menu.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
28
4 Conguring Northbound Interface
4.3 Client Software Specic Conguration File Settings
4.3.1 IBM Tivoli Netcool
Before starting to use IBM Tivoli Netcool for Tellabs 8000 manager R17A check that Tellabs
probe version of IBM Tivoli Netcool is compliant with R17A.
When the 3
rd
party client system is IBM Tivoli Netcool, the following conguration le settings are
required in addition to the instructions provided in 4 Conguring Northbound Interface.
In NSA.INI conguration le:
BYTE_CONVERSION=OFF
OPEN_CONNECTION_REQUIRED=NO
DEFAULT_USER_NAME=<Valid NBI Operators username>
SYSTEM_NOTIF_FORMAT=BASIC
AUTO_EVENT_NOTIF_SUBSCRIPTION=ON
FILTER_SHUTTINGDOWN_SYSTEM_NOTIFICATIONS = ON
4.4 Using Professional Services Adapter (NIMA.EXE) in the Same
Computer as NBI Socket Adapter (NSA.EXE)
If Tellabs Professional Services Adapter (NIMA.EXE) is run simultaneously in the same computer
as NBI Socket Adapter (NSA.EXE), uncomment the rows starting with #NIMA in NKP.INI before
starting the system.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
29
5 Creating Northbound Interface Operators
5 Creating Northbound Interface Operators
A 3
rd
party client system is associated with a northbound interface operator when using the
northbound interface. When opening a connection to the northbound interface, the 3
rd
party client
system must know the username and password of the NBI operator (with the exception that NSA.INI
contains the OPEN_CONNECTION_REQUIRED=NO conguration. In that case the username of the
NBI operator is taken from the parameter DEFAULT_USER_NAME in NSA.INI).
To create NBI operators, proceed as follows:
Step 1 Check that operator proles exist for NBI operators.
Select the Security Proles menu option from Tellabs 8000 manager Toolbox.
The Prole Manager dialog opens.
The Proles list for private subnetwork should contain the following proles:
no nbif privileges
read only nbif privileges
all nbif privileges
If the operator proles for NBI operators do not exist, create themby executing the following
commands with isql in the <drive>/NMS/sql directory.
>use <database name>
>go
>:r cre_nbif_operprof.qry
>go
Step 2 Create an NBI operator.
Select the Security Operators menu option in Tellabs 8000 manager Toolbox.
The Operator Management dialog opens.
Click New operator.
Fill in the following entry elds: Username, Password and Verication.
Tick the NBI Operator check box.
If the operator needs LDAP authentication, tick the LDAP Operator check box.
For information on conguring LDAP operators, refer to Tellabs 8000 Network Manager
LDAP Authentication Conguration User Manual.
Do not exit the dialog.
Step 3 Select a prole for the operator.
Select one of the following proles from the Prole drop-down list.
no nbif privileges
read only nbif privileges
all nbif privileges
Click Add.
Click Exit.
Tellabs

8000 Network Manager R17A 70173_01


Installation and Conguration Guide for Northbound Interface 2009 Tellabs.
30
6 Controlling Northbound Interface
6 Controlling Northbound Interface
A shortcut to <drive>\NMS\BIN\SUPERVISOR.EXE starts the NBI. You can start the Tellabs 8000
Server Command Center dialog by launching a shortcut to <drive>\NMS\BIN\SRVCTRUI.EXE.
You can also start the dialog independent of the state of the NBI, i.e., whether it is started or not.
After the start-up, the Tellabs 8000 Server Command Center dialog shows the status of the server
service. It also shows the running processes.
6.1 Starting Northbound Interface
You can start the NBI by launching a shortcut to <drive>\NMS\BIN\SUPERVISOR.EXE or by
starting the binary from the command prompt. SUPERVISOR.EXE is a controlling and supervisor
process that starts all the other necessary processes.
6.2 Stopping Northbound Interface
You can stop the NBI by selecting Stop All Services from the Commands drop-down list and
clicking the Run Command button in the Tellabs 8000 Server Command Center dialog.
70173_01 Tellabs

8000 Network Manager R17A


2009 Tellabs. Installation and Conguration Guide for Northbound Interface
31