XTi - TMF814 Interface User Guide
XTi - TMF814
XTi - TMF814 User Guide Version 1.6.0.0 2/23/2014
NetBoss XT | XTi - TMF814 | page 1
Table of Contents XTi - TMF814 Table of Contents Introduction to the NetBoss XTi - TMF814 Interface Terms you should know Installing the NetBoss XTi TMF814 Interface Install the NetBoss XTi - TMF814 Interface Starting services Start without Windows services Diagnosing problems with services Uninstalling the NetBoss XTi TMF814 Interface Uninstall the NetBoss XTi TMF814 Interface on a Windows system Uninstall The NetBossXTi-TMF814 Interface on a Solaris system Understanding and working with the NetBoss XTi - TMF814 Interface configuration Configuration parameters for services About the interface and the JacORB Notification Service Structured event fields Implemented TMF814 version 3.0 methods Notable behavior of the structured event fields and implemented TMF814 methods How the NetBoss XTi - TMF814 Interface works EMS sends alarms using the event channel EMS sends all active alarms TMF814 NMS to EMS session termination TMF814 NMS to EMS Session startup Logging Default names and locations of NetBoss XTi - TMF814 Interface log files Copyright and trademark notice Contacting NetBoss Technologies, Inc. Headquarters Customer Support Training Sales Index
NetBoss XT | XTi - TMF814 | page 2
1 2 3 3 6 6 7 7 7 8 8 8 9 9 10 11 11 12 12 12 12 13 13 15 15 17 18 18 18 18 18 19
Introduction to the NetBoss XTi - TMF814 Interface This interface may also be referred to as the MTN M northbound interface.
The NetBoss XTi - TMF814 Interface extends NetBoss XT by providing a CORBA interface between NetBoss XT solutions and any TMF814 CORBA-compliant, third-party system. This interface provides third-party systems that are managed by NetBoss XT with detailed network status information in real-time. The interface supports alarm notification and alarm synchronization and defines the metadata for the network management system (NMS) to element management system (EMS) interface. JacORB is used to implement the CORBA-specific portions of the NetBoss XTi - TMF814 Interface. This interface runs the JacORB naming service, notification service, and ORB. JacORB is installed during the NetBoss XTi - TMF814 Interface installation. Users of this interface should be familiar with TMF814. For information about TMF814, go to the TeleManagement Forum Website at http://www.tmforum.org. The N etB oss XTi - TMF814 Interface is a licensed N etB oss XT feature.
For a general list of terms related to this interface, see Terms you should know on page 3. For more specifics about the NetBoss XTi - TMF814 Interface, see: l
Installing the NetBoss XTi TMF814 Interface on page 6
l
Starting services on page 7
l
Understanding and working with the NetBoss XTi - TMF814 Interface configuration on page 9
Terms you should know In this documentation, the terms alarm and alert are used somewhat interchangeably with alarm being associated specifically with the function of the NetBoss XTi - TMF814 Interface in keeping with the TMF814 standards. The term alert or NetBoss XT alert is associated specifically with the alarm data retrieved from NetBoss XT. For example, N etB oss XT alerts are sent as alarms in the N etB oss XTi - TMF814 Interface.
The following basic terms will help you understand the purpose and function of the NetBoss XTi - TMF814 Interface. Term
Definition
CORBA
Common Object Request Broker Architecture.
NetBoss XT | XTi - TMF814 | page 3
Term
Definition
Element Management System (EMS)
Element Management System - manages one or more of a specific type of network elements (NEs). An EMS allows you to manage all of the features of each network element individually, but not the communication between network elements; the communication between network elements is done by the network management system (NMS).
Iterator
A computer programming object or routine used to traverse all of the elements of a collection one at a time, such as items from a list, an array, or a stream (sometimes called a cursor, especially within the context of a database).
JacORB
A high-performance, multi-threaded Java ORB with support of CORBA 2.3; needs a Java Virtual Machine (VM) of 1.1 or later.
Network Element (NE)
A combination of hardware and software that primarily performs a telecommunications service function.
Network
A group of interconnected network elements (NEs).
Network Management System (NMS)
A combination of hardware and software used to montior and administer a network.
Northbound interface
An interface that conceptualizes lower level de.tails, interfaces to higher level layers, and is normally drawn at the top of an architectural overview.
Object Management Group (OMG)
An international computer industry consortium that develops enterprise integration standards including CORBA.
synchronization
Copying files from one device to another and vice versa so the files update each other with any new information entered into either device. Also controls the way information is delivered at specific times.
NetBoss XT | XTi - TMF814 | page 4
Term
Definition
TeleManagement Forum (TMF)
An open-membership organization of more than 500 companies, founded in 1988 to provide leadership, strategic guidance, and practical solutions to improve the management and operation of information and communications services. http://www.tmforum.org.
Universal Input Method (UIM
A multilingual input method library (library as opposed to a server) that is intended to be a portable, flexible computer software development platform.
NetBoss XT | XTi - TMF814 | page 5
Installing the NetBoss XTi TMF814 Interface You must have a NetBoss XT server running on the machine on which you plan to install the NetBoss XTi TMF814 Interface. Installing the NetBoss XTi TMF814 Interface involves extracting an archive (JAR) file found on the product media. The directory structure is dependent on the location or presence of a N etB oss XT installation on the server where it is installed.
Before you proceed with installing the NetBoss XTi TMF814 Interface, review Install the NetBoss XTi - TMF814 Interface on page 6
Install the NetBoss XTi - TMF814 Interface 1.
From the NetBoss XTi -TMF814 Interface media, extract the contents of TMF814.jar to NB_ HOME (for example, D:/NetBoss) using a utility such as WinZip or the Java JAR utility.
2.
Run the following scripts to install Windows Services (optionally, you can skip this step and run the services from the command line. For more details, see Starting services on page 7). bin/jacorb/namingservice/InstallNamingService-NT.bat bin/jacorb/notificationservice/InstallNotificationService-NT.bat bin/tmf814/InstallTMF814-NT.bat
C AU TION : The servic es are ins talled as Automatic automatically after this ins tallation s tep.
NetBoss XT | XTi - TMF814 | page 6
s tartup ty pe, but they w ill not start
Starting services Start the following services in the order listed: l
JacORB Naming Service
l
JacORB Notification Service
l
TMF814 Service
If you choose to install Windows Services, open the Services window from Administrative Tools, and then start these services. If you choose not to install Windows Services, see Start without Windows services on page 7. The target N etB oss XT server must be running before you start the TMF814 Service.
Start without Windows services If you did not install Windows Services, run the following scripts in the order listed: l
bin/jacorb/namingservice/NamingService.bat
l
bin/jacorb/notificationservice/NotificationService.bat
l
bin/tmf814/TMF814.bat
The scripts for the services can be run from any location because the Java Wrapper assumes that the program’s home directory is the one containing wrapper.exe, and all file references have been written relative to that. The target NetBoss XT server must be running before running the TMF814.bat script. Optionally, you can use your own naming and notification services; for information, see Configuration parameters for services on page 9.
Diagnosing problems with services Log files for each of the services are written to the logs directory. For more information, see Logging on page 15.
NetBoss XT | XTi - TMF814 | page 7
Uninstalling the NetBoss XTi TMF814 Interface You can uninstall the NetBoss XTi TMF814 Interface without uninstalling NetBoss XT. Uninstalling NetBoss XT also uninstalls the NetBoss XTi TMF814 Interface because the NetBoss XT uninstallation program removes everything from the NB_HOME directory. Should NetBoss XT be reinstalled or crash and restart, the NetBoss XTi TMF814 Interface recovers. For details on how to uninstall, see: l
Uninstall the NetBoss XTi TMF814 Interface on a Windows system on page 8
l
Uninstall The NetBossXTi-TMF814 Interface on a Solaris system on page 8
C AU TION : You cannot s uc c es s fully unins tall the N etBos s XT softw are until you stop the follow ing servic es : TMF814 Serv ic e, J ac OR B N otific ation Serv ice, Jac OR B N aming Serv ice.
Uninstall the NetBoss XTi TMF814 Interface on a Windows system 1.
Stop the following services, preferably in the order listed below, which is the reverse order in which they were started, although they can be stopped in any order: TMF814 Service JacORB Notification Service JacORB Naming Service
2.
To stop services on a Windows machine, go to Start > Settings > Control Panel > Administrative Tools > Services and stop services in the order listed above.
3.
If Windows services have been installed, run the following scripts to uninstall them: jacorb/namingservice/UninstallNamingService-NT.bat jacorb/notificationservice/UninstallNotificationService-NT.bat tmf814/UninstallTMF814-NT.bat
Uninstall The NetBossXTi-TMF814 Interface on a Solaris system 1.
Stop the following services, preferably in the order listed below, which is the reverse order in which they were started, although they can be stopped in any order: TMF814 Service JacORB Notification Service JacORB Naming Service 1.
2.
To stop services on a Unix machine, open a command prompt and enter the following: cd /etc/init.d /S##JTMF814 stop ./S##JacOrbNotificationService stop ./S##JacOrbNamingService stop
3.
Delete the unpacked directory structure.
NetBoss XT | XTi - TMF814 | page 8
Understanding and working with the NetBoss XTi - TMF814 Interface configuration Review the following topics to increase your knowledge of the NetBoss XTi - TMF814 Interface: l
Configuration parameters for services on page 9
l
Structured event fields on page 11
l
Implemented TMF814 version 3.0 methods on page 11
l
How the NetBoss XTi - TMF814 Interface works on page 12
l
Logging on page 15
Configuration parameters for services Configuration parameters for each of the three services are specified in the following three types of files (for a list and descriptions of services, see Starting services on page 7): l
orb.properties (shared between the three services)
l
process-specific properties files (unique for each service)
l
wrapper conf files (unique for each service)
All of the services read the orb.properties file from the classpath, but each service has a properties file containing configuration parameters that override the parameters in the orb.properties file. The following configuration parameters are located in: NB_HOME/bin/tmf814/config/netboss.properties emsSessionFactory.iorfile
The emsSessionFactory.iorfile parameter sets the location to which the EmsSessionFactory IOR file will be written. By default, this location is bin/tmf814. rmi.host
The rmi.host parameter names the NetBoss XT server machine. By default, this is localhost. rmi.port
The rmi.port parameter designates the RMI port of the NetBoss XT server machine. By default, this is 4242 (the default port used by NetBoss XT). ORBInitRef.NamingService
The ORBInitRef.NamingService parameter sets the location to read the NamingService IOR from. You should only change this if you are planning to use your own naming service instead of the one shipped with the NetBoss XTi - TMF814 Interface. By default, the TMF814 Service reads the NamingService IOR file from: bin/jacorb/namingservice/namingservice.ior The NamingService starts on a fixed port to avoid having to constantly reroute the NMS to a dynamically changing IOR file. By default, that port is 9105. If that port is already bound, you may need to change it in:
NetBoss XT | XTi - TMF814 | page 9
bin/jacorb/namingservice/config/namingservice.conf, by editing this line "wrapper.java.additional.5=-DOAPort=9105" notificationService.iorfile
The notificationService.iorfile parameter sets the location to read the NotificationService IOR from. You should only change this if you are planning to use your own notification service instead of the one shipped with the NetBoss XTi - TMF814 Interface (see About the interface and the JacORB Notification Service on page 10). By default, the TMF814 service reads the NotificationService IOR file from: bin/jacorb/notificationservicenotificationservice.ior iterator.maxInactiveTime
The iterator.maxInactiveTime parameter is set in the netboss.properties file and represents the amount of time in seconds that can elapse between the next_n calls to an iterator by the NMS before the iterator is discarded. The default is 300 seconds (5 minutes). ping.interval
The ping.interval parameter is set in the netboss.properties file and represents the interval between pings of NMS sessions. The default value is 300 seconds. alarmEvent.lifetime
The alarmEvent.lifetime parameter is set in the netboss.properties file and represents the timeout, in seconds, applied to NT_Alarm StructuredEvents. The default value is 1800 seconds (30 minutes). If an event is not consumed within 30 minutes of delivery, it is discarded, in which case the NetBoss XTi - TMF814 Interface will not attempt to deliver that event again, and no record of that event will exist. company.name
The company.name parameter is set in the netboss.properties file and represents the name of the company. ems.name
The ems.name parameter is set in the netboss.properties file and represents the name of the element manager system. If you have two or more NetBoss XT solutions with a NetBoss XTi - TMF814 Interface on each system, in order to keep them apart and useful to a common NMS, you will need to distinguish them with unique EMS names.
About the interface and the JacORB Notification Service You need to understand the following points about the NetBoss XTi - TMF814 Interface if you choose to use the JacORB Notification Service that is bundled with the interface: l l
The interface handles a maximum of 5 network management systems (NMS). The maximum events per NMS is 1,000. If any one NMS exceeds the maximum queue length, event delivery to all NMSs will be stopped until the NMS that is exceeding the maximum queue length has disconnected from the EventChannel or is able to consume messages again. At the moment the
NetBoss XT | XTi - TMF814 | page 10
interface detects that the queue length is exceeded, two events will be discarded from that NMS’s queue. Those events will be logged. l
l
The interface uses a first in, first out (FIFO) policy for the order in which it delivers events (meaning events should be received in the order they are sent). The only type of event the interface sends is NT_ALARM, and this includes threshold alarms.
Structured event fields The NetBoss XTi - TMF814 Interface populates its NT_ALARM StructuredEvents as specified by TMF814v3.0. The filterable_data portion of the StructuredEvent contains the following fields in the order listed: l
notificationId
l
objectName
l
nativeEMSName
l
nativeProbableCause
l
objectType
l
emsTime
l
neTime
l
isClearable
l
layerRate
l
probablecause
l
probableCauseQualifier
l
perceivedSeverity
l
serviceAffecting
l
affectedTPList
l
additionalTest
l
rcailIndicator
l
acknowledgeIndication
Implemented TMF814 version 3.0 methods Only the following TMF814 version 3.0 methods are implemented: EmsSessionFactory_I l getEmsSession l
getVersion
EmsSession_I l getManager l
getSupportedManagers
l
ping
NetBoss XT | XTi - TMF814 | page 11
EMSMgr_I l getAllEMSAndMEActiveAlarms l
getEMS
The NetBoss XTi - TMF814 Interface supports a maximum of 5 concurrent NMSSessions and 5 active EventIterators.
Notable behavior of the structured event fields and implemented TMF814 methods The following will be ignored. They are parameters to EMSMgr_ I:getAllEMSAndMEActiveAlarms: l
excludeProbableCauseList
l
excludePerceivedSeverityList
How the NetBoss XTi - TMF814 Interface works The following topics provide high-level information about how the NetBoss XTi - TMF814 Interface works: EMS sends alarms using the event channel
The NetBoss XTi - TMF814 Interface receives one event for each NetBoss XT universal input method (UIM) alarm or update to an alarm matching that of other NetBoss XT clients. In this way, the interface stays up to date with the active alarm data. How clean send of alarms works: l
The interface registers with NetBoss XT for all UIM alarms.
l
The interface waits to receive a UIM alarm.
l
The interface packages the UIM alarm into a CORBA stuctured event.
l
The interface pushes the CORBA structured event out on the EMS EventChannel.
l
The interface resumes waiting to receive a UIM alarm.
If no N etB oss XT services are available, the N etB oss XT i - TMF814 Interface tries to reestablish itself with the N etB oss XT A lertService once every 60 seconds. The N etB oss XTi - TMF814 Interface will report an alarm and event loss to each N MS session when this happens (by calling alarmLossOccurred and eventLossOccurred), and will call eventLossCleared when it has reconnected to N etB oss XT. EMS sends all active alarms
Upon establishing a session with the TMF814 EMS capability of NetBoss XT, the NMS is expected to synchronize its view of all active alarms. The active alarms are returned as a CORBA sequence of structured events that are identical to the events sent through the CORBA Notification Service asynchronously. CORBA also provides an iterator feature over its sequences and the NMS request is allowed to use this iterator. How sending all active alarms works:
NetBoss XT | XTi - TMF814 | page 12
l
The NMS calls the following EMS method: EMSMgr.getAllEMSandMEActiveAlarms()
l
l l
For each NetBoss XT alert in the active and acknowledged state, one CORBA structured event is constructed and put in a list. The first N requested with a CORBA iterator is returned to the rest. The NMS has been given a copy of each active alert in the EMS using the same event structure as sent through the notification service. The maximum return size of getAllEMS... is 100. If you ask for more, you will get 100 plus an iterator to the rest. Similarly, you can only get back a max of 100 when you call next_n on the iterator.
If the N MS takes more than 300 seconds between iterator calls, it will receive a low level C OR B A exception saying that the iterator is no longer available. This is handled by the iterator maxInactiveTime. TMF814 NMS to EMS session termination
This is a description of the actions a TMF814 NMS is likely to take, and the results required of the EMS, during the termination of a session with the EMS. W hen the interface loses connectivity to the NotificationService , the interface tries to reconnect every 60 seconds. W hile the interface is disconnected, any new N msSessions will get an exception when calling getEventChannel. Existing EMS sessions will be ended, and each N MS will be notified through an endSession call (after the N etB oss XTi - TMF814 Interface calls alarm or eventLossOccurred on each one).
Session termination with the EMS l
The NMS calls EmsSession.endSession().
l
The EMS calls deactivate_object() on the emsSession.
l
The NMS unsubscribes from the CORBA Notification Service (or otherwise cleanly shuts down the EventChannel).
The nmsSession and emsSession objects are discarded. The NMS can leave the notification subscription running and the Notification Service will continue to deliver events through the event channel. The NetBoss XTi - TMF814 Interface will not send events when there are no EMS sessions established. TMF814 NMS to EMS Session startup
This is a description of the actions a TMF814 NMS is likely to take, and the results required of the EMS, during the start of a session for servicing by the EMS. Session Setup with the EMS
NetBoss XT | XTi - TMF814 | page 13
l
The NMS asks the NetBoss XT CORBA Naming Service for the EmsSessionFactory using the following NamingContext tree. Alternatively, the NMS can directly load the EMSSessionFactory IOR (instead of loading the Naming Service); however, the EmsSessionFactory port is not fixed, so a new IOR file will likely be produced every time the TMF814 Service is restarted.
Naming Graph: EMS with V1.0 and V2.0 l
l
l
l
l
The NMS calls the EmsSessionFactor.getEmsSession() with a valid NetBoss XT user name and password as well as an NmsSession object reference. It receives back an EmsSession. The NMS calls the EmsSession.getManager (“EMS”, manager) to get back a CORBA reference to the EMSMgr object. The NMS calls the EmsSession.getEventChannel to get a CORBA reference to receive CORBA Notifications for alerts. The NMS receives an nmsSession.eventLossCleared() call from the EMS indicating that structured event forwarding is active. The NMS calls EMSMgr.getAllEMSandMEActiveAlarms() to synchronize itself.
The NMS has all of the active alarms that are available from the EMS and is set up to receive structured events from the EMS containing future EMS alarms. There is a small chance that alarm data may be duplicated through the notification mechanism relative to the active alarms being retrieved on synchronization, but no alarms should be lost. The NMS should delay processing cleared alarms delivered over the event channel until it has completed processing of the active alerts sent by the EMS (in this way, clears will not be discarded for alerts that synchronization has not yet processed.
NetBoss XT | XTi - TMF814 | page 14
Logging Seven log files may be produced if you are running the three services (JacORB Naming Service, JacORB Notification Service, TMF814 Service), but this is user-configurable. For a list and descriptions of the log files, see Default names and locations of NetBoss XTi - TMF814 Interface log files on page 15. The orb.properties file is used to specify logging parameters. By default, the Naming and Notification services and ORB running in the TMF814Service will all write to the same log file. Therefore, the following new properties files are used to override defaults and log to separate files: namingservice.properties notificationservice.propertie A new netboss.properties file is used to specify a separate log file for the ORB running as part of the TMF814Service. The default logging level in orb.properties has been changed from fatal errors to warning. It should be noted that JacORB does not allow you to configure the number of rolling log files created (it is hardcoded to be 10,000). C AU TION : You should arc hiv e thes e three log files periodic ally .
Default names and locations of NetBoss XTi - TMF814 Interface log files The following indicates the log file locations relative to the Logs directory. For example a full path might be: logs/jacorb/namingservice/console.namingservice.log jacorb/namingservice/console.namingservice.log
Contains information regarding the starting and stopping of the JacORB Naming Service, as well as any console output of the process. The logging configuration file is: bin/jacorb/namingservice/config/ namingservice.conf jacorb/namingservice/namingservice.log
Contains all log messages generated by the JacORB Naming Service. The logging configuration file is the default log level configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/jacorb/namingservice/config/namingservice.properties jacorb/notificationservice/console.notificationservice.log
Contains information regarding the starting and stopping of the JacORB Notification Service, as well as any console output of the process. The logging configuration file is: bin/jacorb/notificationservice/config/ notificationservice.conf
NetBoss XT | XTi - TMF814 | page 15
jacorb/notificationservice/notificationservice.log
Contains all log messages generated by the JacORB Notification Service. The default log level is configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/jacorb/notificationservice/config/notificationservice.properties tmf814/console.tmf814.log
Contains information regarding the starting and stopping of the TMF814 Service, as well as any console output of the process. The logging configuration file is: bin/tmf814/config/tmf814.conf tmf814/tmf814ORB.log
Contains all log messages generated by the JacORB ORB run within the TMF814 process. The default log level is configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/tmf814/config/netboss.properties tmf814/tmf814.log
Contains all log messages generated by the TMF814 Service. The logging configuration file is: bin/tmf814/config/log4j.xml
NetBoss XT | XTi - TMF814 | page 16
Copyright and trademark notice The software and documentation contained herein is the confidential and proprietary information of NetBoss Technologies, Inc. (“NetBoss”), or its vendors, and shall be used only in accordance with the terms of a written license agreement between you, or your employer, and NetBoss. Neither the software nor documentation may be modified or reproduced without the express written consent of NetBoss. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY. WHILE EFFORTS WERE MADE TO VERIFY THE COMPLETENESS AND ACCURACY OF THE INFORMATION CONTAINED IN THIS DOCUMENTATION, IT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN ADDITION, THIS INFORMATION IS BASED ON NETBOSS’ CURRENT PRODUCT PLANS AND STRATEGY, WHICH ARE SUBJECT TO CHANGE BY NETBOSS WITHOUT NOTICE. NETBOSS SHALL NOT BE RESPONSIBLE FOR ANY DAMAGES ARISING OUT OF THE USE OF, OR OTHERWISE RELATED TO, THIS DOCUMENTATION OR ANY OTHER DOCUMENTATION. NOTHING CONTAINED IN THIS DOCUMENTATION IS INTENDED TO, NOR SHALL HAVE THE EFFECT OF, CREATING ANY WARRANTIES OR REPRESENTATIONS FROM NETBOSS, ITS SUPPLIERS OR LICENSORS, OR ALTERING THE TERMS AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT GOVERNING THE USE OF NETBOSS® ; NETBOSS XT®; NETBOSS XE®; NETBOSS XTa™ ; STATEWISE®, and NETBOSS XADE SOFTWARE™. NETBOSS TECHNOLOGIES®, NETBOSS®, NETBOSS XE®, NETBOSS XT®, and StateWise® and the associated logos are trademarks or registered trademarks of NetBoss Technologies, Inc., and may not be used without permission. All text, images, illustrations, designs, icons, photographs, and other written information contained in this document (collectively, the "Contents") are copyrights, trademarks, trade dress and/or other intellectual property owned, controlled or licensed by NetBoss Technologies, Inc. (“NetBoss”), one of its affiliates or by third parties who have licensed their materials to NetBoss and are protected by U.S. and international copyright laws. The compilation (meaning the collection, arrangement, and assembly) of all Content in this document is the exclusive property of NetBoss and is also protected by U.S. and international copyright laws. Third-party software copyrights are held by their respective owners. Copyright © 2014 NetBoss Technologies, Inc. All rights reserved. Data subject to change without notice.
NetBoss XT | XTi - TMF814 | page 17
Contacting NetBoss Technologies, Inc. United States: +1-866-628-7177 International: +1-772-618-4225 Web: netboss.com Information: [email protected]
Headquarters 10305 102nd Terrace Sebastian, FL 32958 USA Public information: www.netboss.com/ Contact us: http://www.netboss.com/htm/netboss_request_info.htm
Customer Support 1-866-Net-Boss (1-866-638-2677) Option 4 Within North America +1-772-618-4225 Option 4 Outside North America Email: [email protected] Access Customer Support Ticketing System Portal Maintenance customers with a user name and password, go to the support section of our company Web site (from netboss.com, click Service & Support) or go directly to: http://www.netboss.com/htm/netboss_contactsupport.htm Create a Customer Support account Send an email to [email protected] with "Request for Web Login" in the subject line. You will receive an email from NetBoss Support with a support request ticket number confirming your request, followed within a few hours by an email that contains your user name and password.
Training +1-772-618-4225 Email: [email protected]
Sales +1-772-618-4225 Email: [email protected]
NetBoss XT | XTi - TMF814 | page 18
Index
Event channel
G
A acknowledgeIndication
11
additionalTest
11
affectedTPList
11
Alarm, definition alarmEvent.lifetime
3 10
Alert, definition
3
C company.name
9
Configuration parameters alarmEvent.lifetime
10
company.name
10
ems.name
10
emsSessionFactory.iorfile
9
iterator.maxInactiveTime
10
notificationService.iorfile
10
ORBInitRef.NamingService
12
getEMS
12
getEmsSession
11
getManager
11
getSupportedManagers
11
Getting started getVersion
Installing pre-requisites isClearable Iterator, definition iterator.maxInactiveTime
3 11
9 15
console.notificationservice.log
15
console.tmf814.log
16
CORBA - Common Object Request Broker Architecture
3 12
D
6 11 4 10
JacORB
10
console.namingservice.log
6
J
9
rmi.port
CORBA Notification Service
getAllEMSAndMEActiveAlarms
I 10
Configuration
ping.interval
12
definition
4
Naming Service
7
Notification Service
7
use in this interface
3
JDK, version
6
JRE, version
6
L layerRate
11
Log files
Diagnostics
7
E
locations
15
names
15
Logging
15
N
Element Management System see EMS
4
EMS session startup
13
EMS session termination
13
EMS, definition
4
ems.name
10
EMSMgr_I
12
EmsSession_I
11
emsSessionFactory.iorfile
9
EmsSessionFactory_I
11
emsTime
11
- 19 -
NamingService.bat
7
namingservice.log
15
nativeEMSName Structured events nativeEMSName
11
nativeProbableCause
11
NetBoss XT alert
3
NetBoss XTi - TMF814 Interface
JacORB Naming Service
7
description
3
JacORB Notification Service
7
getting started
3
starting
7
TMF814 Service
7
netboss.properties neTime
9 11
Network element, definition
Solaris
4
Network Management System
stopping services
8
Starting
see NMS
4
services
7
Network, definition
4
without Windows services
7
NMS, definition
4
Northbound interface, definition
4
notificationId
Stop services
11
NotificationService.bat
7
notificationService.iorfile
10
notificationservice.log
16
NT_ALARM StructuredEvents
11
8
Windows
8
Structure events emsTime Structured events
O Object Management Group, definition
Solaris
4
11 11
acknowledgeIndication
11
additionalTest
11
affectedTPList
11
fields
11
objectName
11
isCLearable
11
objectType
11
layerRate
11
nativeProbableCause
11
4
neTime
11
9
notificationID
11
objectName
11
OMG see Object Management Group ORBInitRef.NamingService
P
objectType
11
perceivedSeverity
11
probablecause
11
ping
11
probableCauseQualifier
11
ping.interval
10
rcailIndicator
11
6
serviceAffecting
11
probablecause
11
StructuredEvents
probableCauseQualifier
11
Pre-requisites for installation
R rcailIndicator
perceivedSeverity Synchronization, definition
11
rmi.port
9
11 4
T Telemanagement Forum, definition
5
TMF
S
see Telemanaagement Forum
Scripts
7
TMF814 Service
NamingService.bat
7
TMF814 v3.0 methods
TMF814.bat
7
serviceAffecting
11
Services diagnosing problems
7
- 20 -
5 7 11
EMSMgr_1
12
EmsSession_I
11
EmsSessionFactory_I
11
TMF814.bat
7
tmf814.log
16
tmf814ORB.log
16
U UIM, definition
5
Uninstall Solaris;Solaris uninstalling
8
Windows;Windows uninstalling
8
Uninstalling
8
Universal Input Method, see UIM
5
W Windows stopping services
8
Windows services
7
- 21 -
XTi - TMF814 User Guide Version 1.6.0.0 2/23/2014
NetBoss XT | XTi - TMF814 | page 1
Table of Contents XTi - TMF814 Table of Contents Introduction to the NetBoss XTi - TMF814 Interface Terms you should know Installing the NetBoss XTi TMF814 Interface Install the NetBoss XTi - TMF814 Interface Starting services Start without Windows services Diagnosing problems with services Uninstalling the NetBoss XTi TMF814 Interface Uninstall the NetBoss XTi TMF814 Interface on a Windows system Uninstall The NetBossXTi-TMF814 Interface on a Solaris system Understanding and working with the NetBoss XTi - TMF814 Interface configuration Configuration parameters for services About the interface and the JacORB Notification Service Structured event fields Implemented TMF814 version 3.0 methods Notable behavior of the structured event fields and implemented TMF814 methods How the NetBoss XTi - TMF814 Interface works EMS sends alarms using the event channel EMS sends all active alarms TMF814 NMS to EMS session termination TMF814 NMS to EMS Session startup Logging Default names and locations of NetBoss XTi - TMF814 Interface log files Copyright and trademark notice Contacting NetBoss Technologies, Inc. Headquarters Customer Support Training Sales Index
NetBoss XT | XTi - TMF814 | page 2
1 2 3 3 6 6 7 7 7 8 8 8 9 9 10 11 11 12 12 12 12 13 13 15 15 17 18 18 18 18 18 19
Introduction to the NetBoss XTi - TMF814 Interface This interface may also be referred to as the MTN M northbound interface.
The NetBoss XTi - TMF814 Interface extends NetBoss XT by providing a CORBA interface between NetBoss XT solutions and any TMF814 CORBA-compliant, third-party system. This interface provides third-party systems that are managed by NetBoss XT with detailed network status information in real-time. The interface supports alarm notification and alarm synchronization and defines the metadata for the network management system (NMS) to element management system (EMS) interface. JacORB is used to implement the CORBA-specific portions of the NetBoss XTi - TMF814 Interface. This interface runs the JacORB naming service, notification service, and ORB. JacORB is installed during the NetBoss XTi - TMF814 Interface installation. Users of this interface should be familiar with TMF814. For information about TMF814, go to the TeleManagement Forum Website at http://www.tmforum.org. The N etB oss XTi - TMF814 Interface is a licensed N etB oss XT feature.
For a general list of terms related to this interface, see Terms you should know on page 3. For more specifics about the NetBoss XTi - TMF814 Interface, see: l
Installing the NetBoss XTi TMF814 Interface on page 6
l
Starting services on page 7
l
Understanding and working with the NetBoss XTi - TMF814 Interface configuration on page 9
Terms you should know In this documentation, the terms alarm and alert are used somewhat interchangeably with alarm being associated specifically with the function of the NetBoss XTi - TMF814 Interface in keeping with the TMF814 standards. The term alert or NetBoss XT alert is associated specifically with the alarm data retrieved from NetBoss XT. For example, N etB oss XT alerts are sent as alarms in the N etB oss XTi - TMF814 Interface.
The following basic terms will help you understand the purpose and function of the NetBoss XTi - TMF814 Interface. Term
Definition
CORBA
Common Object Request Broker Architecture.
NetBoss XT | XTi - TMF814 | page 3
Term
Definition
Element Management System (EMS)
Element Management System - manages one or more of a specific type of network elements (NEs). An EMS allows you to manage all of the features of each network element individually, but not the communication between network elements; the communication between network elements is done by the network management system (NMS).
Iterator
A computer programming object or routine used to traverse all of the elements of a collection one at a time, such as items from a list, an array, or a stream (sometimes called a cursor, especially within the context of a database).
JacORB
A high-performance, multi-threaded Java ORB with support of CORBA 2.3; needs a Java Virtual Machine (VM) of 1.1 or later.
Network Element (NE)
A combination of hardware and software that primarily performs a telecommunications service function.
Network
A group of interconnected network elements (NEs).
Network Management System (NMS)
A combination of hardware and software used to montior and administer a network.
Northbound interface
An interface that conceptualizes lower level de.tails, interfaces to higher level layers, and is normally drawn at the top of an architectural overview.
Object Management Group (OMG)
An international computer industry consortium that develops enterprise integration standards including CORBA.
synchronization
Copying files from one device to another and vice versa so the files update each other with any new information entered into either device. Also controls the way information is delivered at specific times.
NetBoss XT | XTi - TMF814 | page 4
Term
Definition
TeleManagement Forum (TMF)
An open-membership organization of more than 500 companies, founded in 1988 to provide leadership, strategic guidance, and practical solutions to improve the management and operation of information and communications services. http://www.tmforum.org.
Universal Input Method (UIM
A multilingual input method library (library as opposed to a server) that is intended to be a portable, flexible computer software development platform.
NetBoss XT | XTi - TMF814 | page 5
Installing the NetBoss XTi TMF814 Interface You must have a NetBoss XT server running on the machine on which you plan to install the NetBoss XTi TMF814 Interface. Installing the NetBoss XTi TMF814 Interface involves extracting an archive (JAR) file found on the product media. The directory structure is dependent on the location or presence of a N etB oss XT installation on the server where it is installed.
Before you proceed with installing the NetBoss XTi TMF814 Interface, review Install the NetBoss XTi - TMF814 Interface on page 6
Install the NetBoss XTi - TMF814 Interface 1.
From the NetBoss XTi -TMF814 Interface media, extract the contents of TMF814.jar to NB_ HOME (for example, D:/NetBoss) using a utility such as WinZip or the Java JAR utility.
2.
Run the following scripts to install Windows Services (optionally, you can skip this step and run the services from the command line. For more details, see Starting services on page 7). bin/jacorb/namingservice/InstallNamingService-NT.bat bin/jacorb/notificationservice/InstallNotificationService-NT.bat bin/tmf814/InstallTMF814-NT.bat
C AU TION : The servic es are ins talled as Automatic automatically after this ins tallation s tep.
NetBoss XT | XTi - TMF814 | page 6
s tartup ty pe, but they w ill not start
Starting services Start the following services in the order listed: l
JacORB Naming Service
l
JacORB Notification Service
l
TMF814 Service
If you choose to install Windows Services, open the Services window from Administrative Tools, and then start these services. If you choose not to install Windows Services, see Start without Windows services on page 7. The target N etB oss XT server must be running before you start the TMF814 Service.
Start without Windows services If you did not install Windows Services, run the following scripts in the order listed: l
bin/jacorb/namingservice/NamingService.bat
l
bin/jacorb/notificationservice/NotificationService.bat
l
bin/tmf814/TMF814.bat
The scripts for the services can be run from any location because the Java Wrapper assumes that the program’s home directory is the one containing wrapper.exe, and all file references have been written relative to that. The target NetBoss XT server must be running before running the TMF814.bat script. Optionally, you can use your own naming and notification services; for information, see Configuration parameters for services on page 9.
Diagnosing problems with services Log files for each of the services are written to the logs directory. For more information, see Logging on page 15.
NetBoss XT | XTi - TMF814 | page 7
Uninstalling the NetBoss XTi TMF814 Interface You can uninstall the NetBoss XTi TMF814 Interface without uninstalling NetBoss XT. Uninstalling NetBoss XT also uninstalls the NetBoss XTi TMF814 Interface because the NetBoss XT uninstallation program removes everything from the NB_HOME directory. Should NetBoss XT be reinstalled or crash and restart, the NetBoss XTi TMF814 Interface recovers. For details on how to uninstall, see: l
Uninstall the NetBoss XTi TMF814 Interface on a Windows system on page 8
l
Uninstall The NetBossXTi-TMF814 Interface on a Solaris system on page 8
C AU TION : You cannot s uc c es s fully unins tall the N etBos s XT softw are until you stop the follow ing servic es : TMF814 Serv ic e, J ac OR B N otific ation Serv ice, Jac OR B N aming Serv ice.
Uninstall the NetBoss XTi TMF814 Interface on a Windows system 1.
Stop the following services, preferably in the order listed below, which is the reverse order in which they were started, although they can be stopped in any order: TMF814 Service JacORB Notification Service JacORB Naming Service
2.
To stop services on a Windows machine, go to Start > Settings > Control Panel > Administrative Tools > Services and stop services in the order listed above.
3.
If Windows services have been installed, run the following scripts to uninstall them: jacorb/namingservice/UninstallNamingService-NT.bat jacorb/notificationservice/UninstallNotificationService-NT.bat tmf814/UninstallTMF814-NT.bat
Uninstall The NetBossXTi-TMF814 Interface on a Solaris system 1.
Stop the following services, preferably in the order listed below, which is the reverse order in which they were started, although they can be stopped in any order: TMF814 Service JacORB Notification Service JacORB Naming Service 1.
2.
To stop services on a Unix machine, open a command prompt and enter the following: cd /etc/init.d /S##JTMF814 stop ./S##JacOrbNotificationService stop ./S##JacOrbNamingService stop
3.
Delete the unpacked directory structure.
NetBoss XT | XTi - TMF814 | page 8
Understanding and working with the NetBoss XTi - TMF814 Interface configuration Review the following topics to increase your knowledge of the NetBoss XTi - TMF814 Interface: l
Configuration parameters for services on page 9
l
Structured event fields on page 11
l
Implemented TMF814 version 3.0 methods on page 11
l
How the NetBoss XTi - TMF814 Interface works on page 12
l
Logging on page 15
Configuration parameters for services Configuration parameters for each of the three services are specified in the following three types of files (for a list and descriptions of services, see Starting services on page 7): l
orb.properties (shared between the three services)
l
process-specific properties files (unique for each service)
l
wrapper conf files (unique for each service)
All of the services read the orb.properties file from the classpath, but each service has a properties file containing configuration parameters that override the parameters in the orb.properties file. The following configuration parameters are located in: NB_HOME/bin/tmf814/config/netboss.properties emsSessionFactory.iorfile
The emsSessionFactory.iorfile parameter sets the location to which the EmsSessionFactory IOR file will be written. By default, this location is bin/tmf814. rmi.host
The rmi.host parameter names the NetBoss XT server machine. By default, this is localhost. rmi.port
The rmi.port parameter designates the RMI port of the NetBoss XT server machine. By default, this is 4242 (the default port used by NetBoss XT). ORBInitRef.NamingService
The ORBInitRef.NamingService parameter sets the location to read the NamingService IOR from. You should only change this if you are planning to use your own naming service instead of the one shipped with the NetBoss XTi - TMF814 Interface. By default, the TMF814 Service reads the NamingService IOR file from: bin/jacorb/namingservice/namingservice.ior The NamingService starts on a fixed port to avoid having to constantly reroute the NMS to a dynamically changing IOR file. By default, that port is 9105. If that port is already bound, you may need to change it in:
NetBoss XT | XTi - TMF814 | page 9
bin/jacorb/namingservice/config/namingservice.conf, by editing this line "wrapper.java.additional.5=-DOAPort=9105" notificationService.iorfile
The notificationService.iorfile parameter sets the location to read the NotificationService IOR from. You should only change this if you are planning to use your own notification service instead of the one shipped with the NetBoss XTi - TMF814 Interface (see About the interface and the JacORB Notification Service on page 10). By default, the TMF814 service reads the NotificationService IOR file from: bin/jacorb/notificationservicenotificationservice.ior iterator.maxInactiveTime
The iterator.maxInactiveTime parameter is set in the netboss.properties file and represents the amount of time in seconds that can elapse between the next_n calls to an iterator by the NMS before the iterator is discarded. The default is 300 seconds (5 minutes). ping.interval
The ping.interval parameter is set in the netboss.properties file and represents the interval between pings of NMS sessions. The default value is 300 seconds. alarmEvent.lifetime
The alarmEvent.lifetime parameter is set in the netboss.properties file and represents the timeout, in seconds, applied to NT_Alarm StructuredEvents. The default value is 1800 seconds (30 minutes). If an event is not consumed within 30 minutes of delivery, it is discarded, in which case the NetBoss XTi - TMF814 Interface will not attempt to deliver that event again, and no record of that event will exist. company.name
The company.name parameter is set in the netboss.properties file and represents the name of the company. ems.name
The ems.name parameter is set in the netboss.properties file and represents the name of the element manager system. If you have two or more NetBoss XT solutions with a NetBoss XTi - TMF814 Interface on each system, in order to keep them apart and useful to a common NMS, you will need to distinguish them with unique EMS names.
About the interface and the JacORB Notification Service You need to understand the following points about the NetBoss XTi - TMF814 Interface if you choose to use the JacORB Notification Service that is bundled with the interface: l l
The interface handles a maximum of 5 network management systems (NMS). The maximum events per NMS is 1,000. If any one NMS exceeds the maximum queue length, event delivery to all NMSs will be stopped until the NMS that is exceeding the maximum queue length has disconnected from the EventChannel or is able to consume messages again. At the moment the
NetBoss XT | XTi - TMF814 | page 10
interface detects that the queue length is exceeded, two events will be discarded from that NMS’s queue. Those events will be logged. l
l
The interface uses a first in, first out (FIFO) policy for the order in which it delivers events (meaning events should be received in the order they are sent). The only type of event the interface sends is NT_ALARM, and this includes threshold alarms.
Structured event fields The NetBoss XTi - TMF814 Interface populates its NT_ALARM StructuredEvents as specified by TMF814v3.0. The filterable_data portion of the StructuredEvent contains the following fields in the order listed: l
notificationId
l
objectName
l
nativeEMSName
l
nativeProbableCause
l
objectType
l
emsTime
l
neTime
l
isClearable
l
layerRate
l
probablecause
l
probableCauseQualifier
l
perceivedSeverity
l
serviceAffecting
l
affectedTPList
l
additionalTest
l
rcailIndicator
l
acknowledgeIndication
Implemented TMF814 version 3.0 methods Only the following TMF814 version 3.0 methods are implemented: EmsSessionFactory_I l getEmsSession l
getVersion
EmsSession_I l getManager l
getSupportedManagers
l
ping
NetBoss XT | XTi - TMF814 | page 11
EMSMgr_I l getAllEMSAndMEActiveAlarms l
getEMS
The NetBoss XTi - TMF814 Interface supports a maximum of 5 concurrent NMSSessions and 5 active EventIterators.
Notable behavior of the structured event fields and implemented TMF814 methods The following will be ignored. They are parameters to EMSMgr_ I:getAllEMSAndMEActiveAlarms: l
excludeProbableCauseList
l
excludePerceivedSeverityList
How the NetBoss XTi - TMF814 Interface works The following topics provide high-level information about how the NetBoss XTi - TMF814 Interface works: EMS sends alarms using the event channel
The NetBoss XTi - TMF814 Interface receives one event for each NetBoss XT universal input method (UIM) alarm or update to an alarm matching that of other NetBoss XT clients. In this way, the interface stays up to date with the active alarm data. How clean send of alarms works: l
The interface registers with NetBoss XT for all UIM alarms.
l
The interface waits to receive a UIM alarm.
l
The interface packages the UIM alarm into a CORBA stuctured event.
l
The interface pushes the CORBA structured event out on the EMS EventChannel.
l
The interface resumes waiting to receive a UIM alarm.
If no N etB oss XT services are available, the N etB oss XT i - TMF814 Interface tries to reestablish itself with the N etB oss XT A lertService once every 60 seconds. The N etB oss XTi - TMF814 Interface will report an alarm and event loss to each N MS session when this happens (by calling alarmLossOccurred and eventLossOccurred), and will call eventLossCleared when it has reconnected to N etB oss XT. EMS sends all active alarms
Upon establishing a session with the TMF814 EMS capability of NetBoss XT, the NMS is expected to synchronize its view of all active alarms. The active alarms are returned as a CORBA sequence of structured events that are identical to the events sent through the CORBA Notification Service asynchronously. CORBA also provides an iterator feature over its sequences and the NMS request is allowed to use this iterator. How sending all active alarms works:
NetBoss XT | XTi - TMF814 | page 12
l
The NMS calls the following EMS method: EMSMgr.getAllEMSandMEActiveAlarms()
l
l l
For each NetBoss XT alert in the active and acknowledged state, one CORBA structured event is constructed and put in a list. The first N requested with a CORBA iterator is returned to the rest. The NMS has been given a copy of each active alert in the EMS using the same event structure as sent through the notification service. The maximum return size of getAllEMS... is 100. If you ask for more, you will get 100 plus an iterator to the rest. Similarly, you can only get back a max of 100 when you call next_n on the iterator.
If the N MS takes more than 300 seconds between iterator calls, it will receive a low level C OR B A exception saying that the iterator is no longer available. This is handled by the iterator maxInactiveTime. TMF814 NMS to EMS session termination
This is a description of the actions a TMF814 NMS is likely to take, and the results required of the EMS, during the termination of a session with the EMS. W hen the interface loses connectivity to the NotificationService , the interface tries to reconnect every 60 seconds. W hile the interface is disconnected, any new N msSessions will get an exception when calling getEventChannel. Existing EMS sessions will be ended, and each N MS will be notified through an endSession call (after the N etB oss XTi - TMF814 Interface calls alarm or eventLossOccurred on each one).
Session termination with the EMS l
The NMS calls EmsSession.endSession().
l
The EMS calls deactivate_object() on the emsSession.
l
The NMS unsubscribes from the CORBA Notification Service (or otherwise cleanly shuts down the EventChannel).
The nmsSession and emsSession objects are discarded. The NMS can leave the notification subscription running and the Notification Service will continue to deliver events through the event channel. The NetBoss XTi - TMF814 Interface will not send events when there are no EMS sessions established. TMF814 NMS to EMS Session startup
This is a description of the actions a TMF814 NMS is likely to take, and the results required of the EMS, during the start of a session for servicing by the EMS. Session Setup with the EMS
NetBoss XT | XTi - TMF814 | page 13
l
The NMS asks the NetBoss XT CORBA Naming Service for the EmsSessionFactory using the following NamingContext tree. Alternatively, the NMS can directly load the EMSSessionFactory IOR (instead of loading the Naming Service); however, the EmsSessionFactory port is not fixed, so a new IOR file will likely be produced every time the TMF814 Service is restarted.
Naming Graph: EMS with V1.0 and V2.0 l
l
l
l
l
The NMS calls the EmsSessionFactor.getEmsSession() with a valid NetBoss XT user name and password as well as an NmsSession object reference. It receives back an EmsSession. The NMS calls the EmsSession.getManager (“EMS”, manager) to get back a CORBA reference to the EMSMgr object. The NMS calls the EmsSession.getEventChannel to get a CORBA reference to receive CORBA Notifications for alerts. The NMS receives an nmsSession.eventLossCleared() call from the EMS indicating that structured event forwarding is active. The NMS calls EMSMgr.getAllEMSandMEActiveAlarms() to synchronize itself.
The NMS has all of the active alarms that are available from the EMS and is set up to receive structured events from the EMS containing future EMS alarms. There is a small chance that alarm data may be duplicated through the notification mechanism relative to the active alarms being retrieved on synchronization, but no alarms should be lost. The NMS should delay processing cleared alarms delivered over the event channel until it has completed processing of the active alerts sent by the EMS (in this way, clears will not be discarded for alerts that synchronization has not yet processed.
NetBoss XT | XTi - TMF814 | page 14
Logging Seven log files may be produced if you are running the three services (JacORB Naming Service, JacORB Notification Service, TMF814 Service), but this is user-configurable. For a list and descriptions of the log files, see Default names and locations of NetBoss XTi - TMF814 Interface log files on page 15. The orb.properties file is used to specify logging parameters. By default, the Naming and Notification services and ORB running in the TMF814Service will all write to the same log file. Therefore, the following new properties files are used to override defaults and log to separate files: namingservice.properties notificationservice.propertie A new netboss.properties file is used to specify a separate log file for the ORB running as part of the TMF814Service. The default logging level in orb.properties has been changed from fatal errors to warning. It should be noted that JacORB does not allow you to configure the number of rolling log files created (it is hardcoded to be 10,000). C AU TION : You should arc hiv e thes e three log files periodic ally .
Default names and locations of NetBoss XTi - TMF814 Interface log files The following indicates the log file locations relative to the Logs directory. For example a full path might be: logs/jacorb/namingservice/console.namingservice.log jacorb/namingservice/console.namingservice.log
Contains information regarding the starting and stopping of the JacORB Naming Service, as well as any console output of the process. The logging configuration file is: bin/jacorb/namingservice/config/ namingservice.conf jacorb/namingservice/namingservice.log
Contains all log messages generated by the JacORB Naming Service. The logging configuration file is the default log level configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/jacorb/namingservice/config/namingservice.properties jacorb/notificationservice/console.notificationservice.log
Contains information regarding the starting and stopping of the JacORB Notification Service, as well as any console output of the process. The logging configuration file is: bin/jacorb/notificationservice/config/ notificationservice.conf
NetBoss XT | XTi - TMF814 | page 15
jacorb/notificationservice/notificationservice.log
Contains all log messages generated by the JacORB Notification Service. The default log level is configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/jacorb/notificationservice/config/notificationservice.properties tmf814/console.tmf814.log
Contains information regarding the starting and stopping of the TMF814 Service, as well as any console output of the process. The logging configuration file is: bin/tmf814/config/tmf814.conf tmf814/tmf814ORB.log
Contains all log messages generated by the JacORB ORB run within the TMF814 process. The default log level is configured in bin/common/config/orb.properties. The log file name and log levels can be overridden in: bin/tmf814/config/netboss.properties tmf814/tmf814.log
Contains all log messages generated by the TMF814 Service. The logging configuration file is: bin/tmf814/config/log4j.xml
NetBoss XT | XTi - TMF814 | page 16
Copyright and trademark notice The software and documentation contained herein is the confidential and proprietary information of NetBoss Technologies, Inc. (“NetBoss”), or its vendors, and shall be used only in accordance with the terms of a written license agreement between you, or your employer, and NetBoss. Neither the software nor documentation may be modified or reproduced without the express written consent of NetBoss. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY. WHILE EFFORTS WERE MADE TO VERIFY THE COMPLETENESS AND ACCURACY OF THE INFORMATION CONTAINED IN THIS DOCUMENTATION, IT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN ADDITION, THIS INFORMATION IS BASED ON NETBOSS’ CURRENT PRODUCT PLANS AND STRATEGY, WHICH ARE SUBJECT TO CHANGE BY NETBOSS WITHOUT NOTICE. NETBOSS SHALL NOT BE RESPONSIBLE FOR ANY DAMAGES ARISING OUT OF THE USE OF, OR OTHERWISE RELATED TO, THIS DOCUMENTATION OR ANY OTHER DOCUMENTATION. NOTHING CONTAINED IN THIS DOCUMENTATION IS INTENDED TO, NOR SHALL HAVE THE EFFECT OF, CREATING ANY WARRANTIES OR REPRESENTATIONS FROM NETBOSS, ITS SUPPLIERS OR LICENSORS, OR ALTERING THE TERMS AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT GOVERNING THE USE OF NETBOSS® ; NETBOSS XT®; NETBOSS XE®; NETBOSS XTa™ ; STATEWISE®, and NETBOSS XADE SOFTWARE™. NETBOSS TECHNOLOGIES®, NETBOSS®, NETBOSS XE®, NETBOSS XT®, and StateWise® and the associated logos are trademarks or registered trademarks of NetBoss Technologies, Inc., and may not be used without permission. All text, images, illustrations, designs, icons, photographs, and other written information contained in this document (collectively, the "Contents") are copyrights, trademarks, trade dress and/or other intellectual property owned, controlled or licensed by NetBoss Technologies, Inc. (“NetBoss”), one of its affiliates or by third parties who have licensed their materials to NetBoss and are protected by U.S. and international copyright laws. The compilation (meaning the collection, arrangement, and assembly) of all Content in this document is the exclusive property of NetBoss and is also protected by U.S. and international copyright laws. Third-party software copyrights are held by their respective owners. Copyright © 2014 NetBoss Technologies, Inc. All rights reserved. Data subject to change without notice.
NetBoss XT | XTi - TMF814 | page 17
Contacting NetBoss Technologies, Inc. United States: +1-866-628-7177 International: +1-772-618-4225 Web: netboss.com Information: [email protected]
Headquarters 10305 102nd Terrace Sebastian, FL 32958 USA Public information: www.netboss.com/ Contact us: http://www.netboss.com/htm/netboss_request_info.htm
Customer Support 1-866-Net-Boss (1-866-638-2677) Option 4 Within North America +1-772-618-4225 Option 4 Outside North America Email: [email protected] Access Customer Support Ticketing System Portal Maintenance customers with a user name and password, go to the support section of our company Web site (from netboss.com, click Service & Support) or go directly to: http://www.netboss.com/htm/netboss_contactsupport.htm Create a Customer Support account Send an email to [email protected] with "Request for Web Login" in the subject line. You will receive an email from NetBoss Support with a support request ticket number confirming your request, followed within a few hours by an email that contains your user name and password.
Training +1-772-618-4225 Email: [email protected]
Sales +1-772-618-4225 Email: [email protected]
NetBoss XT | XTi - TMF814 | page 18
Index
Event channel
G
A acknowledgeIndication
11
additionalTest
11
affectedTPList
11
Alarm, definition alarmEvent.lifetime
3 10
Alert, definition
3
C company.name
9
Configuration parameters alarmEvent.lifetime
10
company.name
10
ems.name
10
emsSessionFactory.iorfile
9
iterator.maxInactiveTime
10
notificationService.iorfile
10
ORBInitRef.NamingService
12
getEMS
12
getEmsSession
11
getManager
11
getSupportedManagers
11
Getting started getVersion
Installing pre-requisites isClearable Iterator, definition iterator.maxInactiveTime
3 11
9 15
console.notificationservice.log
15
console.tmf814.log
16
CORBA - Common Object Request Broker Architecture
3 12
D
6 11 4 10
JacORB
10
console.namingservice.log
6
J
9
rmi.port
CORBA Notification Service
getAllEMSAndMEActiveAlarms
I 10
Configuration
ping.interval
12
definition
4
Naming Service
7
Notification Service
7
use in this interface
3
JDK, version
6
JRE, version
6
L layerRate
11
Log files
Diagnostics
7
E
locations
15
names
15
Logging
15
N
Element Management System see EMS
4
EMS session startup
13
EMS session termination
13
EMS, definition
4
ems.name
10
EMSMgr_I
12
EmsSession_I
11
emsSessionFactory.iorfile
9
EmsSessionFactory_I
11
emsTime
11
- 19 -
NamingService.bat
7
namingservice.log
15
nativeEMSName Structured events nativeEMSName
11
nativeProbableCause
11
NetBoss XT alert
3
NetBoss XTi - TMF814 Interface
JacORB Naming Service
7
description
3
JacORB Notification Service
7
getting started
3
starting
7
TMF814 Service
7
netboss.properties neTime
9 11
Network element, definition
Solaris
4
Network Management System
stopping services
8
Starting
see NMS
4
services
7
Network, definition
4
without Windows services
7
NMS, definition
4
Northbound interface, definition
4
notificationId
Stop services
11
NotificationService.bat
7
notificationService.iorfile
10
notificationservice.log
16
NT_ALARM StructuredEvents
11
8
Windows
8
Structure events emsTime Structured events
O Object Management Group, definition
Solaris
4
11 11
acknowledgeIndication
11
additionalTest
11
affectedTPList
11
fields
11
objectName
11
isCLearable
11
objectType
11
layerRate
11
nativeProbableCause
11
4
neTime
11
9
notificationID
11
objectName
11
OMG see Object Management Group ORBInitRef.NamingService
P
objectType
11
perceivedSeverity
11
probablecause
11
ping
11
probableCauseQualifier
11
ping.interval
10
rcailIndicator
11
6
serviceAffecting
11
probablecause
11
StructuredEvents
probableCauseQualifier
11
Pre-requisites for installation
R rcailIndicator
perceivedSeverity Synchronization, definition
11
rmi.port
9
11 4
T Telemanagement Forum, definition
5
TMF
S
see Telemanaagement Forum
Scripts
7
TMF814 Service
NamingService.bat
7
TMF814 v3.0 methods
TMF814.bat
7
serviceAffecting
11
Services diagnosing problems
7
- 20 -
5 7 11
EMSMgr_1
12
EmsSession_I
11
EmsSessionFactory_I
11
TMF814.bat
7
tmf814.log
16
tmf814ORB.log
16
U UIM, definition
5
Uninstall Solaris;Solaris uninstalling
8
Windows;Windows uninstalling
8
Uninstalling
8
Universal Input Method, see UIM
5
W Windows stopping services
8
Windows services
7
- 21 -
