installation and configuration guide for northbound interface

Tellabs® 8000 Network Manager R17AInstallation and Configuration Guide for

Northbound Interface

70173_0112.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 andtreaties. Your right to use this manual is subject to limitations and restrictions imposed by applicable licenses and copyright laws.Unauthorized reproduction, modification, 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 affiliates 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 specifications 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_01Installation and Configuration 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 3rd party OSSs

NBIFSRV Northbound Interface service of Management Server of Tellabs® 8000 networkmanager. NBIFSRV provides e.g. Fault Management interoperability services tothird 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 Configuration Guide for Northbound Interface

3


4

Table of Contents

Table of Contents

About the Manual .............................................................................................................. 7

Objectives....................................................................................................................................................................... 7Audience......................................................................................................................................................................... 7Related Documentation .................................................................................................................................................. 7Document Conventions .................................................................................................................................................. 8Documentation Feedback............................................................................................................................................... 8

1 Foreword...................................................................................................................... 9

2 System Description..................................................................................................... 10

2.1 General................................................................................................................................................................. 102.2 Supported Configurations .................................................................................................................................... 102.3 Processes of the Northbound Interface................................................................................................................ 122.4 Hardware and Software Requirements ................................................................................................................ 13

3 Installing the Northbound Interface........................................................................... 14

3.1 General................................................................................................................................................................. 143.2 Installing the Standard Configuration of the NBI................................................................................................ 143.3 Installing the Full Management Server Configuration of NBI ............................................................................ 16

4 Configuring Northbound Interface ............................................................................ 17

4.1 General................................................................................................................................................................. 174.2 Configuration File Parameters ............................................................................................................................. 17

4.2.1 NMS.INI .............................................................................................................................................. 174.2.2 NBIFSRV_SERVICE.INI.................................................................................................................... 184.2.3 NBS.INI............................................................................................................................................... 194.2.4 NSA.INI............................................................................................................................................... 214.2.5 NKP.INI ............................................................................................................................................... 244.2.6 FMSP.INI............................................................................................................................................. 254.2.7 nma-logging.properties........................................................................................................................ 264.2.8 Usage of NTO.EXE............................................................................................................................. 27

4.3 Client Software Specific Configuration File Settings.......................................................................................... 294.3.1 IBM Tivoli Netcool ............................................................................................................................. 29


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 ............................................................................................................................. 316.2 Stopping Northbound Interface ........................................................................................................................... 31


6

About the Manual

About the Manual

This part discusses the objectives and the intended audience of this manual, Tellabs® 8000Network Manager Installation and Configuration Guide for Northbound Interface, andconsists of the following sections:

• Objectives

• Audience

• Related Documentation

• Document Conventions

• Documentation Feedback

Objectives

This manual provides instructions on installing and configuring the Northbound Interface in theTellabs® 8000 network manager.

Audience

This manual is designed for the installation personnel of a telecommunications operator.

Related Documentation

Tellabs® 8000 Network Manager R17AThird Party Hardware and Software Requirements(70002_XX)

Describes all the needed third party softwarecomponents and versions in the Tellabs 8000network manager system (operating systems,service packs, database server versions, clientversions, web browsers). Describes alsothe recommended computer platforms, LANconfigurations and the minimum performancerequirements for computers.

Tellabs® 8000 Network Manager R17ASoftware Installation Manual (70170_XX)

Provides instructions on how to install andconfigure Tellabs 8000 network manager indifferent Tellabs 8000 network manager computerplatforms (workstation, servers).

Tellabs® 8000 Network Manager R17ATCP/IP Client Programmer’s Guide for the Faultand Provisioning Adapter of the NorthboundInterface (70176_XX)

Contains instructions on how to develop clientsoftware which interfaces with NBI.

Tellabs® 8000 Network Manager R17ARelease and Installation Notes (70179_XX)

Describes the recommendations and restrictionsfor installing, configuring and using Tellabs 8000network manager.


7

About the Manual

Tellabs® 8000 Network Manager R17A BugNotes (70180_XX)

Lists the known bugs.

Tellabs® 8000 Network Manager R17ALDAP Authentication Configuration User Manual(70186_XX)

Provides instructions on how to configure LDAPAuthentication 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 instructionsare not followed.

This is a warning symbol. It indicates that bodily injury is possible if the instructions are notfollowed.

Documentation Feedback

Please contact us to suggest improvements or to report errors in our documentation:

Email: [email protected]

Fax: +358.9.4131.2430


8

1 Foreword

1 Foreword

This document provides instructions on installing and configuring the northbound interfacein Tellabs® 8000 network manager R17A and is targeted for the installation personnel of atelecommunications operator.

There is also another document on the Northbound Interface (NBI) of Tellabs 8000 manager intendedfor the third party OSS developers, containing instructions on how to develop client software whichinterfaces with the NBI. Tellabs® 8000 Network Manager TCP/IP Client Programmer’s Guide forthe 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 thismanual to refer to the Northbound Interface. The old abbreviation NBIF is, however, still usedin file names, attribute names and some interface elements.


9

2 System Description


2.1 General

The Northbound Interface in Tellabs 8000 manager is a gateway which enables interoperability withthird party OSSs in a multivendor environment.

The NBI enables the third party OSSs to request operations in Tellabs 8000 manager. The NBI is alsoable to notify the third party OSSs about configuration changes and alarms in Tellabs 8000 manager.

The NBI supports fault management and macro execution, also offers a future growth path toother areas of network management such as topology management, performance managementand connection management.

The NBI software consists of the communication adapter process and the NBI Kernel process. Thecommunication adapters are responsible for the communication protocol (e.g. TCP/IP or CORBA)specific tasks whereas the NBI Kernel is responsible for executing the service requests by callingthe lower layer services of Tellabs 8000 manager, e.g. Fault Server, Macro Manager and ObjectServer. The NBI Kernel has an interface called Internal Adaptation interface. Communicationadapters publish NBI information models (NBI IMs) which describe the services available to thirdparty clients. In addition to FMS information, the information model of NBI Kernel supports somePMS, connection management and topology information.

The Northbound Interface contains a communication adapter providing a TCP/IP interface. TheNBI supports retrieving active NE faults and faulty services and sending notifications about the NEfaults and faulty services.

The NBI runs on a Management Server computer. It can serve a maximum of twenty simultaneousclients. If needed, more than one Management Server computer may be running NBI per onemanaged network.

2.2 Supported Configurations

Standard Configuration of the NBI as the recommended option and Full Management ServerConfiguration of the NBI are the two supported NBI running configurations. The differencebetween the two configurations is that in the Standard Configuration mode the NBI is the onlyservice allowed to run in the Management Server computer, i.e. a dedicated computer is requiredfor the NBI. However, in Full Management Server Configuration also other services supported bythe Management Server may be running simultaneously, i.e. a dedicated computer for the NBI isnot required. Moreover, the macro execution feature of the NBI is supported only by the StandardConfiguration.


10


Full Management Server Configuration may be used only if:The macro execution feature of the NBI is not used.andThe performance load of the Management Server computer does not cause disturbancesfor the service, e.g. the Management Server is not serving a big number of managementworkstations.

For optimal performance and reliability, it is recommended always to use the StandardConfiguration 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 StandardConfiguration 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 dashedrectangle.


11


Fig. 2 Supported Interactions when using NBI Standard Configuration

In Fig. 2 you can see the supported interactions in the standard configuration. Server computer1 isa Management Server running Fault Server (Management Server with the service FAULTSRV).Server computer2 is a Management Server running NBI (Management Server with the serviceNBIFSRV). Note that in the standard configuration the NBI requires a dedicated Fault ServerProcess.

2.3 Processes of the Northbound Interface

The NBI runs on a Management Server computer. The most important processes of a ManagementServer running the NBI are described below.

Process Description

SUPERVISOR SUPERVISOR is the main process of Management Server. It starts the otherManagement Server processes, collects status data from other server processes andstarts NBI Supervisor process (NBS), which starts the other NBI related processes.SUPERVISOR belongs to the Management Server platform. It is also used in otherManagement Server configurations.

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 otherManagement Server configurations.


12


Process Description

NBS NBS is the NBI Supervisor process. The Management Server platform starts andstops it. NBS is responsible for starting and stopping NBI processes (NKP andNSA).

NKP NKP is the NBI Kernel process. It provides an internal adaptation interface to beused by NBI communication adapters.

NSA NSA is the TCP/IP Socket Communication Adapter process of the Tellabs 8000manager northbound interface. The available services are described in more detailin the NBI information model (see Tellabs® 8000 Network Manager TCP/IP ClientProgrammer’s Guide for the Fault and Provisioning Adapter of the NorthboundInterface. The third party client software, i.e. a third party NMS or SMS, connectsto 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 andFault 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 Serverconfiguration when running NBI. Macro Manager Service (MMSRV) and MacroManager Agent (MMAG) are needed when MTOSI Service is used or the8600-based macros are executed using NBI.

NMA NMA is an MTOSI Service. It provides MTOSI 2.0 interface for the MTOSI webclients.

2.4 Hardware and Software Requirements

Refer to Tellabs® 8000 Network Manager Third Party Hardware and Software Requirements forinformation on the operating system and hardware requirements.


13

3 Installing the Northbound Interface


3.1 General

Management Server running the NBI in the Tellabs 8000 manager R17A uses the Tellabs 8000manager R17A database. The Server needs a database connection, and the SYBASE Open Clientsoftware for Windows has to be installed on the Server. The required level for Sybase Open Client isdefined in Tellabs® 8000 Network Manager Third Party Hardware and Software Requirements.

Older database versions must be updated to R17A database before the Management Serverrunning NBI for R17A can be used. Information on how to update the database is given inTellabs ® 8000 Network Manager Release and Installation Notes.

3.2 Installing the Standard Configuration of the NBI

To install the standard configuration 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.


14


Step 3 Select the configuration.

• SelectManagement Server from Selected Configuration and select the Northbound In-terface service from Services to install the standard NBI configuration. Deselect the rest ofthe presented Services.

Do not select any other service than the Northbound interface service from the list of Serviceswhen installing the standard configuration 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 checkbox. Moreover, if you use MTOSI Service, tick the MTOSI support check box. Notethat selecting MTOSI support automatically selects also 8600 Macro support which isrequired 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 fields.Leave all other entry fields empty.

• Click Next.

Step 5 Set other miscellaneous settings.

• In frame Preferred network adapter for Tellabs 8000 network manager, fill in the in-formation about the network adapter which is connected to the Tellabs 8000 managementLAN.

• 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 Windowsservice check box, click the Run as a namedWindows account radio button and fill in theAccount, Password and Confirm password entry fields.

• 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 configuration.

• After checking that the selected installation is correct, click Install.

• The installation of Tellabs 8000 manager starts.


15


Step 9 Complete the installation.

• If you wish to edit the NMS.INI file, click the Edit NMS.INI file button.

• If you wish to check the log file, click the View installation log file 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 inTellabs 8000 manager.For further instructions, refer to section User instructions in Tellabs® 8000 Network ManagerOnline Help.

Step 13 If the Management Server computer has more than one LAN card, set the configuration fileparameter USER_DEFINED_IP_ADDRESS in nsa.dat.

Step 14 In the MTOSI configuration if desired, configure the MD and FD names in nma.xml (located in the%NMSDIR%\dat directory).

Step 15 If HTTPS protocol is used in the MTOSI configuration, you need to create the Java key standardclient and server certificate files. The client certificate should be called client.jks and the servercertificate server.jks. After file creation, copy the certification files to the %NMSDIR%\certsdirectory. Save the passwords used in the certificate 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.INIby 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 entryin %NMSDIR%\dat\nkp.ini.

3.3 Installing the Full Management Server Configuration of NBI

To install the Full Management Server Configuration of NBI, please refer to Tellabs® 8000 NetworkManager Software Installation Manual.

The installation should be done according to the installation instructions of the Management Serverdescribed in the above mentioned document.


16

4 Configuring Northbound Interface


4.1 General

The configuration file parameters that have to be defined when configuring the NBI are describedhere. The parameters reside in the following files:

• <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 configuration file settings specific to the third party client software are described.

4.2 Configuration File Parameters

4.2.1 NMS.INI

After installing the NBI software configuration you must set the correct values to the followingparameters.

DBSRVR = <Name of the database server>DBNAME = <Name of the database>COMPUTERNAME = <LAN name of the Management Server computer>

After installing the NBI software configuration the following default values have already been setto the NMS.INI file. They may not be edited.

CONFIGURATION = MNGTSRVSRV_SERVICE1 = NBIFSRVCACHER = ONCACHER_INI_FILE = <drive>\nms\dat\CACHER.INI(CACHER.PAR in case of a partitioned network)NBS_PIPE = NBIF_SUPV_PIPENKP_PIPE = NBIF_KERNEL_PIPENKP_PORT = 40058


17


4.2.2 NBIFSRV_SERVICE.INI

The Management Server service parameters are defined in the NBIFSRV_SERVICE.INI file. Theparameters are described below. The correct values are set to these parameters during the installationof the NBI software. These values may not be edited.

Parameter DescriptionSERVICE_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 xranges from 1 to 256. The first server process in thelist must have the value 1, and the second processmust have the value 2, etc.

SLAVE_PROCESS[x]_STARTTIME The longest allowed start time for a process inseconds. If the process has not started properlyduring the defined time, the server is shut down. Thevalue can be increased if there are problems withstarting the process.

SLAVE_PROCESS[x]_STARTPARAMS Process command line parameters.

SLAVE_PROCESS[x]_PRIORITY Indicates the starting order of the processes requiredby the service.

SLAVE_PROCESS[x]_CONSOLE This parameters can have the values YES or NO.YES means that a process has a console. The defaultvalue is NO.

SLAVE_PROCESS[x]_STOPTIME This parameter defined the timeout in seconds forshutting down the process when the shutdown isrequested by the supervisor. After the timeout haselapsed 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 ManagementServer Supervisor in case of an unexpected processshutdown. The default value is YES.

SLAVE_PROCESS[x]_RESTART_TIME The time in seconds how long a process has tobe alive before Management Server Supervisorrestarts it in case of an unexpected processshutdown. This parameter is relevant only ifSLAVE_PROCESS[x]_RESTART=YES

Example of NBIFSRV_SERVICE.INI

SERVICE_RESTART=YES

SLAVE_PROCESS1_NAME = NAMSSLAVE_PROCESS1_STARTTIME = 300SLAVE_PROCESS1_STARTPARAMS =SLAVE_PROCESS1_PRIORITY = 1SLAVE_PROCESS1_RESTART = NO

SLAVE_PROCESS2_NAME = CICO


18


SLAVE_PROCESS2_STARTTIME = 300SLAVE_PROCESS2_STARTPARAMS =SLAVE_PROCESS2_PRIORITY = 1SLAVE_PROCESS2_RESTART = NO

SLAVE_PROCESS3_NAME = TDSVSLAVE_PROCESS3_STARTTIME = 300SLAVE_PROCESS3_STARTPARAMS =SLAVE_PROCESS3_PRIORITY = 1SLAVE_PROCESS3_RESTART = NO

SLAVE_PROCESS4_NAME = FMSPSLAVE_PROCESS4_STARTTIME = 300SLAVE_PROCESS4_STARTPARAMS = srvmode=1SLAVE_PROCESS4_PRIORITY = 1SLAVE_PROCESS4_RESTART = NO

SLAVE_PROCESS5_NAME = NBSSLAVE_PROCESS5_STARTTIME = 300SLAVE_PROCESS5_STARTPARAMS =SLAVE_PROCESS5_CONSOLE = NOSLAVE_PROCESS5_STOPTIME = 30SLAVE_PROCESS5_PRIORITY = 2

SLAVE_PROCESS5_RESTART = YESSLAVE_PROCESS5_RESTART_TIME = 60

4.2.3 NBS.INI

The NBI Supervisor parameters are defined in NBS.INI. These parameters are described below.

The correct values are set to these parameters during the installation of the NBI software. Thesevalues may normally not be edited.

Parameter DescriptionNBIF_KERNEL_FOREGROUND This parameter can have the values YES or NO. YES

means that the NBI Kernel process NKP.EXE has aconsole. The default value is NO.

CA_NUM_START_TRIALS The number of attempts to start the communicationadapter in case of an unsuccessful start. The defaultvalue is 2.

CA_WAIT_BETWEEN_START_TRIALS Waiting time (in milliseconds) between attempts tostart the communication adapter. The default value is2000 milliseconds.

CA[x] The name of the communication adapter process(without .exe). The index value x ranges from 1 to5. (It is possible to run one to five CommunicationAdapter Processes simultaneously, each with adifferent configuration.)


19


Parameter Description

CA[x]_SUPVPIPE The supervisor pipe name of the communicationadapter. The name must be unique if more than onecommunication adapter is used.

CA[x]_FOREGROUND This parameter can have the values YES or NO. YESmeans that the communication adapter has a console.The default value is NO.

CA[x]_INIFILE The path and name of the communication adapterINI file. The value must be unique if more than onecommunication adapter is used. The index value xranges from 1 to 5. (It is possible to run one to fivecommunication adapter processes simultaneously,each with a different configuration.)

NBIF_KERNEL_KILL_WAITTIME The time in seconds how long NBI Supervisor waitsfor a controlled shutdown of the NBI Kernel process(NKP.EXE) after sending a stop request to it beforeNBI Supervisor kills the NBI Kernel process. Thedefault value is 2 seconds.

NBIF_KERNEL_ALLOWED_START_TIME The time in seconds how long NBI Supervisor waitsfor the NBI Kernel process to start. If the time elapses,NBI Supervisor terminates all NBI processes. Thedefault value is 10 seconds.

COMM_ADAPTER_KILL_WAITTIME The time in seconds how long NBI Supervisor waitsfor a controlled shutdown of the communicationadapter process after sending a stop request to it beforeNBI Supervisor kills the communication adapterprocess. The default value is 7 seconds.

COMM_ADAPTER_ALLOWED_START_TIME The time in seconds how long NBI Supervisor waitsfor the communication adapter process to start. Ifthe time elapses, NBI Supervisor terminates all NBIprocesses. The default value is 30 seconds.

NBIF_SUPV_LOGFLAGS This parameter controls the logging of NBISupervisor to NBIF_SUPV_LOGFILE and todisplay if NBIFSRV_SERVICE.INI containsthe SLAVE_PROCESS[x]_CONSOLE = YESdefinition for the NBI Supervisor process (NBS). Thiscan be changed in the run time with the commandline application NTO.EXE. For instructions on usingNTO.EXE see 4.2.8 Usage of NTO.EXE. The possiblevalues are:# display everything. errors onlyto 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 tofile:NBIF_SUPV_LOGFLAGS=001000# display and log nothing:NBIF_SUPV_LOGFLAGS=000000# display nothing. errors only tofile:NBIF_SUPV_LOGFLAGS=100000


20


Parameter DescriptionNBIF_SUPV_NMSTRACE_USE This parameter can have the values ON or OFF. ON

means that NBI Supervisor uses NMSTRACE fortracing. OFF means that NBI Supervisor does notuse NMSTRACE. The default value is ON. Thiscan be changed in the run time with the commandline application NTO.EXE. For instructions on usingNTO.EXE see 4.2.8 Usage of NTO.EXE.

NBIF_SUPV_LOGFILE The path and name of the NBI Supervisor log file.This can be changed in the run time with the commandline application NTO.EXE. For instructions on usingNTO.EXE see 4.2.8 Usage of NTO.EXE.

Example of NBS.INI

# display nothing. errors only to fileNBIF_SUPV_LOGFLAGS=100000NBIF_SUPV_LOGFILE=%NMSDIR%\log\nbs.logNBIF_SUPV_NMSTRACE_USE=ONNBIF_KERNEL_FOREGROUND=NOCA_NUM_START_TRIALS = 2CA_WAIT_BETWEEN_START_TRIALS = 2000CA0=NSACA0_SUPVPIPE=nsapipeCA0_INIFILE=%NMSDIR%\dat\nsa.iniCA0_FOREGROUND=NONBIF_KERNEL_KILL_WAITTIME = 2NBIF_KERNEL_ALLOWED_START_TIME = 10COMM_ADAPTER_KILL_WAITTIME = 7COMM_ADAPTER_ALLOWED_START_TIME = 30

4.2.4 NSA.INI

The TCP/IP communication adapter (NSA.EXE) parameters are defined in NSA.INI. These aredescribed below.

Note! After installing the NBI software configuration you must set the correct value to thefollowing parameter:

SOCKET_PORT_NUMBER This parameter defines the Internet Port Number of the TCP/IPcommunication adapter of the northbound interface. This is a 16-bitvalue, i.e. the maximum value is 65535. This value must equal to theport number used by the 3rd party clients which will open a TCP/IPconnection 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. Thesevalues may normally not be edited unless other instructions are given in 4.3 Client SoftwareSpecific Configuration File Settings.


21


Parameter DescriptionBYTE_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 orderconversion is not performed. The default value is ON.Northbound interface is designed to run on a computerwhich stores data in byte order called Little-Endian,which is the reverse of the network standard Big-Endianorder.BYTE_CONVERSION=ON means that the NBI sendsdata to the 3rd party system and receives data from the 3rdparty system in the standard Big-Endian byte order.

COMMADAPTER_LOGFILE The path and name of the TCP/IP communication adapter(NSA.EXE) log file. This parameter can be changedin the run time with the command line applicationNTO.EXE. For instructions on using NTO.EXE see4.2.8 Usage of NTO.EXE.

OPEN_CONNECTION_REQUIRED This can have the values YES or NO. YES means thatthe OpenConnection request from a 3rd party system isrequired as the first request after establishing the socketconnection to the NBI. The default value is YES.

DEFAULT_USER_NAME The username of the NBI operator to which the connected3rd party client is automatically associated by the NBI ifOPEN_CONNECTION_REQUIRED=NO. This parameteris irrelevant if OPEN_CONNECTION_REQUIRED=YES.This parameter must have a valid value ifOPEN_CONNECTION_REQUIRED=NO.

SYSTEM_NOTIF_FORMAT This parameter can have the values BASIC orENHANCED. BASIC means that the system notificationcontains only a message header. ENHANCED meansthat the system notification contains a message headerand additional information. The default value isENHANCED.

AUTO_EVENT_NOTIF_SUBSCRIPTION This parameter can have the values ON or OFF. ONmeans that the event notification and system notificationsubscriptions are executed automatically when a 3rd partyclient calls a Bulk-Get-request. The default value isOFF.

FILTER_SHUTTINGDOWN_SYS-TEM_NOTIFICATIONS

This parameter can have the values ON or OFF. ONmeans that the Shuttingdown system notification will notbe sent to the 3rd party client even if a system notificationsubscription existed. The default value is OFF.


22


Parameter DescriptionCOMMADAPTER_LOGFLAGS This parameter controls the logging of the

TCP/IP communication adapter (NSA.EXE) toCOMMADAPTER_LOGFILE and to display if NBS.INIcontains the CA[x]_FOREGROUND=YES definitionfor the TCP/IP communication adapter (NSA.EXE).This parameter can be changed in the run time with thecommand line application NTO.EXE. For instructionson using NTO.EXE see 4.2.8 Usage of NTO.EXE. Thepossible values are:# display everything. errors only tofile:COMMADAPTER_LOGFLAGS=100001# display and log errors only:COMMADAPTER_LOGFLAGS=100100# display and log everything:COMMADAPTER_LOGFLAGS=001001# display nothing. everything tofile:COMMADAPTER_LOGFLAGS=001000# display and log nothing:COMMADAPTER_LOGFLAGS=000000# display nothing. errors only tofile: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 meansthat 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 commandline application NTO.EXE. For instructions on usingNTO.EXE see 4.2.8 Usage of NTO.EXE.

USER_DEFINED_IP_ADDRESS This parameter can be defined in NSA.INI only if theManagement Server running NBI has more than oneLAN card. In that case this parameter defines the LANcard which is used for the NBI message traffic with the3rd party OSS. If USER_DEFINED_IP_ADDRESS isnot set, the used LAN card is randomly selected by thesystem from the available alternatives.

TIME_USAGE This parameter can have the values UTC, LOCAL orLOCALWINTER. UTC means that datetime attributevalues are returned as Coordinated Universal Time(UTC). LOCAL means that datetime attribute values arereturned as local time (having regard to daylight savingtime). LOCALWINTER means that datetime attributevalues are returned as local normal time. The defaultvalue is LOCALWINTER.

Example of NSA.INI

# display nothing. errors only to fileCOMMADAPTER_LOGFLAGS=100000COMMADAPTER_LOGFILE=%NMSDIR%\log\nsa.logCOMMADAPTER_NMSTRACE_USE=ONBYTE_CONVERSION=ONSOCKET_PORT_NUMBER=2461


23


OPEN_CONNECTION_REQUIRED=YES#DEFAULT_USER_NAME=SYSTEM_NOTIF_FORMAT=ENHANCEDAUTO_EVENT_NOTIF_SUBSCRIPTION=OFFFILTER_SHUTTINGDOWN_SYSTEM_NOTIFICATIONS = OFF

4.2.5 NKP.INI

The NBI Kernel parameters (NKP.EXE) are defined in NKP.INI. They are described below.

Note! After installing the NBI software configuration you must set the correct value to the followingparameter if a 3rd party client uses the macro execution feature of the NBI.

NBIFKERNEL_MACROFILEDIR Path to the Tellabs 8000 manager macro files which are executedby the NBI on 3rd party client’s request. This parameter is relevantonly if the 3rd party client is using the macro execution feature ofNBI. Default value =<drive>:\NMS\MAC.

The correct values are set to these parameters during the installation of the NBI software. Thesevalues may not be edited.

Parameter DescriptionNBIFKERNEL_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 readdata does not fit into one buffer, the rest of the data is sentto the caller in the subsequent buffers.

NBIFKERNEL_LOGFLAGS This parameter controls the logging of NBIKernel (NKP.EXE) to NBIFKERNEL_LOGFILEand to display if NBS.INI contains theNBIF_KERNEL_FOREGROUND=YES definition.This parameter can be changed in the run time with thecommand line application NTO.EXE. For instructionson using NTO.EXE see 4.2.8 Usage of NTO.EXE. Thepossible values are:# display everything. errors only tofile: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 tofile:NBIFKERNEL_LOGFLAGS=100000


24


Parameter DescriptionNBIFKERNEL_LOGFILE The path and name of the NBI Kernel (NKP.EXE) log file.

This parameter can be changed in the run time with thecommand line application NTO.EXE. For instructions onusing NTO.EXE see 4.2.8 Usage of NTO.EXE.

NBIFKERNEL_NMSTRACE_USE This parameter can have the values ON or OFF. ONmeans that NBI Kernel (NKP.EXE) uses NMSTRACE fortracing. OFF means that NBI Kernel (NKP.EXE) does notuse NMSTRACE. The default value is ON. This parametercan be changed in the run time with the command lineapplication NTO.EXE. For instructions on using NTO.EXEsee 4.2.8 Usage of NTO.EXE.

Example of NKP.INI

# display nothing. errors only to fileNBIFKERNEL_LOGFLAGS=100000NBIFKERNEL_LOGFILE=%NMSDIR%\log\nkp.logNBIFKERNEL_NMSTRACE_USE=ONNBIFKERNEL_MACROFILEDIR=%NMSDIR%\macNBIFKERNEL_MAX_GET_BUFF_SIZE = 50000

4.2.6 FMSP.INI

After installing the NBI software configuration you must change the following two parametervalues in case the Fault Management features of NBI are used and you want NBI to behave as inR14 and earlier:

FmspMaxFaultsMode = ON

FmspServerServiceFaultFilterOks = OFF


25



FmspMaxFaultsMode The parameter can have valuesON andOFF. The parameteraffects the behavior of NBI in case the maximum numberof faults (indicated by FmspRecommendedMaxFaultsin fmsp.ini) is reached. ON means that NBI is stopped.If NBI is restarted it does not give any faults as responsewhen 3rd party OSS asks faults. OFFmeans that NBIcontinues to operate as long there are enough resources inthe computer. When the computer runs out of resources thebehavior is indeterminate. The default value is OFF.

FmspServerServiceFaultFil-terOks

The parameter can have values ON and OFF. Theparameter determines whether service faults whichare defined to not disturbing the service (withservicefault.mtnevent=0) are returned to the3rd party OSS or not. Definitions for not disturbing theservice faults can be viewed and modified with the Tellabs8000 manager Fault Management GUI using the Serviceview for Fault service section of dialog Set Fault StatusView.ON means that the 3rd party OSS does not receive servicefaults which are defined to belong in category “notdisturbing the service”. OFF means that the 3rd partyOSS receives service faults which are defined to belong incategory “not disturbing the service”. The default valueis ON.

4.2.7 nma-logging.properties

The nma-logging.properties file is relevant only for the MTOSI user.

The NMA logging options are located in %NMSDIR%\dat\nma-logging.properties.


log4j.rootLogger The parameter defines the logging level and defines wherethe operating system does the logging. The user can eitherlog to console or to file or both and specify the logginglevel, where ALL, DEBUG, ERROR, FATAL, INFO, OFF,TRACE, WARN are supported. The following syntaxneeds to be followed: Level.ERROR,console,file (the usercan omit either console or file parameter) and that is theoffered default.

log4j.appender.file.File The parameter defines the output target file when thesystem is logging to some file. The default target is%NMSDIR%\log\nma.log.


26


4.2.8 Usage of NTO.EXE

The command line application NTO.EXE is used for changing tracing and logging options when theNBI is running. The initial values of these options are given in the configuration files NBS.INI,NSA.INI and NKP.INI. The values are read from these files when the NBI is started. Note thatchanges made by NTO.EXE are not stored into the mentioned files but are effective only until theNBI is stopped.

The options that can be changed with NTO.EXE are as follows:

NBS.INI:

NBIF_SUPV_LOGFILENBIF_SUPV_LOGFLAGSNBIF_SUPV_NMSTRACE_USE

NSA.INI:

COMMADAPTER_LOGFILECOMMADAPTER_LOGFLAGSCOMMADAPTER_NMSTRACE_USE

NKP.INI:

NBIFKERNEL_LOGFILENBIFKERNEL_LOGFLAGSNBIFKERNEL_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. Exit1. NBIF Kernel2. NBIF Supervisor3. Communication Adapter


27


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 specific menu opens. The process specific menu displays the current tracing and loggingoptions of the process and provides the possibility to change one of them.

For example, if the selection is 2.NBIF Supervisor, the process specific menu may displaythe following options:

Current Tracing/Logging options for Nbif SupervisorNmsTrace usage = 1Log file name = c:\NMS\log\nbs.logLogging flags = 100000Please make a choice from the following :0. Cancel (return to start menu)1. Update NmsTrace usage for Nbif Supervisor2. Update Log file name for Nbif Supervisor3. 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 filename for <Process> or 3.Update Logging flags for <Process>, NTO.EXEasks 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 specific menu again and you have to make a new selection. If youselect 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.


28


4.3 Client Software Specific Configuration File Settings

4.3.1 IBM Tivoli Netcool

Before starting to use IBM Tivoli Netcool for Tellabs 8000 manager R17A check that Tellabsprobe version of IBM Tivoli Netcool is compliant with R17A.

When the 3rd party client system is IBM Tivoli Netcool, the following configuration file settings arerequired in addition to the instructions provided in 4 Configuring Northbound Interface.

In NSA.INI configuration file:

BYTE_CONVERSION=OFFOPEN_CONNECTION_REQUIRED=NODEFAULT_USER_NAME=<Valid NBI Operator’s username>SYSTEM_NOTIF_FORMAT=BASICAUTO_EVENT_NOTIF_SUBSCRIPTION=ONFILTER_SHUTTINGDOWN_SYSTEM_NOTIFICATIONS = ON

4.4 Using Professional Services Adapter (NIMA.EXE) in the SameComputer as NBI Socket Adapter (NSA.EXE)

If Tellabs Professional Services Adapter (NIMA.EXE) is run simultaneously in the same computeras NBI Socket Adapter (NSA.EXE), uncomment the rows starting with #NIMA in NKP.INI beforestarting the system.


29

5 Creating Northbound Interface Operators

5 Creating Northbound Interface Operators

A 3rd party client system is associated with a northbound interface operator when using thenorthbound interface. When opening a connection to the northbound interface, the 3rd party clientsystem must know the username and password of the NBI operator (with the exception that NSA.INIcontains the OPEN_CONNECTION_REQUIRED=NO configuration. In that case the username of theNBI operator is taken from the parameter DEFAULT_USER_NAME in NSA.INI).

To create NBI operators, proceed as follows:

Step 1 Check that operator profiles exist for NBI operators.

• Select the Security – Profiles menu option from Tellabs 8000 manager Toolbox.The Profile Manager dialog opens.

• The Profiles list for private subnetwork should contain the following profiles:• no nbif privileges

• read only nbif privileges

• all nbif privileges

• If the operator profiles for NBI operators do not exist, create them by executing the followingcommands 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 fields: Username, Password and Verification.

• Tick the NBI Operator check box.

• If the operator needs LDAP authentication, tick the LDAP Operator check box.For information on configuring LDAP operators, refer to Tellabs 8000 Network ManagerLDAP Authentication Configuration User Manual.

• Do not exit the dialog.

Step 3 Select a profile for the operator.

• Select one of the following profiles from the Profile drop-down list.• no nbif privileges

• read only nbif privileges

• all nbif privileges

• Click Add.

• Click Exit.


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 8000Server 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 serverservice. 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 bystarting the binary from the command prompt. SUPERVISOR.EXE is a controlling and supervisorprocess 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 andclicking the Run Command button in the Tellabs 8000 Server Command Center dialog.


31

installation and configuration guide for northbound interface

Documents