Alcatel-Lucent

1359 CORBA NBI | Release 1.6.0.7

Administration Guide

8DG33995AAAATQZZA
January 2010
Issue 1
 NBI Rel.1.6.0.7 Admin Guide

Edition 01 RJ CORBA NBI Rel.1.5.0.1 Administration Guide IT:

TND, ACCS, R&D 8DG33995AAAATQZZA Page 2 of33

01 2010-01-1 Creation Tang zhongming

3

ED DATE CHANGE NOTE APPROVED BY PREPARED BY

Distribution: Internal External

Table Of Contents

PREFACE .......................................................................................................................................... 6
HISTORY ................................................................................................................................................... 6
REFERENCED DOCUMENTS ...................................................................................................................... 6
GLOSSARY................................................................................................................................................... 6
1. INTRODUCTION ...................................................................................................................... 7
1.1 DOCUMENT PURPOSE ....................................................................................................................... 7
1.2 DOCUMENT SCOPE .......................................................................................................................... 7
1.3 DOCUMENT ORGANIZATION .............................................................................................................. 7
1.4 NBI STRUCTURE ............................................................................................................................... 7
2. CONFIGURATION DETAILS ...................................................................................................... 9
2.1 EMLNBI CONFIGURATION ........................................................................................................... 9
2.1.1 Param.cfg ...................................................................................................................................... 9
2.1.2 wdm_ogpi_wave_length_file.dat .................................................................................................. 15
2.1.3 Trace.cfg ...................................................................................................................................... 16
2.1.4 users.cfg ...................................................................................................................................... 16
2.1.5 ftp_cmd.sh ................................................................................................................................... 16
2.2 EMLNBICOMP CONFIGURATION ................................................................................................ 16
2.2.1 NBIProxy ...................................................................................................................................... 16
2.2.1.1 Param.cfg ................................................................................................................................... 16
2.3 NEDUMP ..................................................................................................................................... 17
2.3.1.1 Param.cfg ................................................................................................................................... 17
2.4 PMSDTOOL ................................................................................................................................. 18
2.4.1 PMDSTool Configuration.............................................................................................................. 18
2.4.1.1 Param.cfg ................................................................................................................................... 18
2.5 SDHNBI CONFIGURATION ........................................................................................................ 19
2.5.1 Param.cfg .................................................................................................................................... 19
2.5.2 Trace.cfg ...................................................................................................................................... 26
2.5.3 users.cfg ...................................................................................................................................... 26
2.5.4 filter.cfg ....................................................................................................................................... 26
2.5.5 PMDSTool Configuration.............................................................................................................. 26
2.5.5.1 Param.cfg ................................................................................................................................... 26
2.6 PKTNBI CONFIGURATION .......................................................................................................... 27
2.6.1 NBI_INIT_FILE.xml ........................................................................................................................ 27
2.6.2 NBI_XML_CONFIGURE.xml .......................................................................................................... 27
2.6.3 NBI_XML_CONFIGURE.xsd .......................................................................................................... 27
2.6.4 CBM.conf ..................................................................................................................................... 27
2.6.5 SvcTAO.conf ................................................................................................................................ 28
2.6.6 libcnbi_bm_external.sl ................................................................................................................. 29
2.6.7 libcnbi_bm_impl.sl ....................................................................................................................... 29
3. NBI LOG/TRACE POLICY ........................................................................................................ 30
3.1 EMLNBI ...................................................................................................................................... 30
3.1.1 Introduction ................................................................................................................................. 30
3.1.2 General Log & Trace files of NMNBI ............................................................................................ 30
3.1.3 nmnbi.log .................................................................................................................................... 30
3.1.4 nmnbi.trace.................................................................................................................................. 30
3.1.5 nmnbi.dataflow ............................................................................................................................ 30
3.1.6 Trace level information ................................................................................................................ 30
3.2 SDHNBI ...................................................................................................................................... 31
3.2.1 Introduction ................................................................................................................................. 31
3.2.2 General Log & Trace files of SDHNBI ........................................................................................... 31
3.2.3 SDHNBI.log.................................................................................................................................. 31
 3.2.4 SDHNBI.trace ............................................................................................................................... 32
3.2.5 SDHNBI.dataflow ......................................................................................................................... 32
3.2.6 Trace level information ................................................................................................................ 32
3.3 PKTNBI ....................................................................................................................................... 33
3.3.1 Introduction ................................................................................................................................. 33
3.3.2 General Log & Trace files of BMNBI............................................................................................. 33

End table of contents

 LIST OF FIGURES AND TABLES

Figure 1 NBI structure ................................................................................................... 8

PREFACE
HISTORY

Issue Date Description

01 2010-01-13 NBI1.6.0.7

REFERENCED DOCUMENTS

[1] NBI Rel.1.6.0.7 Installation Guide 8DG 33995 AAAA RJZZA

[2] NBI R1.6 Technique Functional Specification 8DG 33995 AAAA DSZZA

Glossary

NBI North Bound Interface

1350OMS-EML ALCATEL’s Element Management System
1350OMS-SDH ALCATEL’s Sub Network Management System
1350OMS-PKT ALCATEL’s LAN Network Management System
EMLNBI Corba interface of 1350OMS-EML product
SDHNBI Corba interface of 1350OMS-SDH product
PKTNBI Corba interface of 1350OMS-PKT product
1. INTRODUCTION

1.1 Document Purpose

This admin guide describes how to configure, install and initialize NBI, and instructions the
detail of the configure file and the configure parameters.

It is intended for integration and validation engineers.

1.2 Document Scope

This document describes the component NBI and basic installation steps for NBI, not the
components that NBI interfaces with.

1.3 Document Organization

Chapter 1 This chapter, ’Introduction’, presents the purpose, scope, and

organization of this document.

Chapter 2 This chapter, ’Configuration Details’, provides information on how to

configure NBI.

Chapter 3 Descript trace and log file for NBI

1.4 NBI Structure

 Figure 1 NBI structure
The NBI has three tar packages for NM and RM and BM:
EMLNBI: be installed on 1350OMS-EML master, in this case to provide NBI of
1350OMS-EML
SDHNBI: be installed on 1350OMS-SDH master, in this case to provide NBI of
1350OMS-SDH
PKTNBI: be installed on 1350OMS-PKT master, in this case to provide NBI of 1350OMS-PKT
2. CONFIGURATION DETAILS
2.1 EMLNBI CONFIGURATION

2.1.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME >/EMLNBI/conf/”
after installed the EMLNBI. The parameters in it is needed for EMLNBI, some of them should
be input by user when do the system configuration, some of them are related with NMS
keywords available, some of them are created by script when install NBI, the others have
default value before installed and needn’t modify usually, if need modify, you can modify the
file directory. Now all detail parameters information in “param.cfg” will be described as
follows.

SESSION_FACTORY_NAME_SERVICE_NAME
Default value: <null>
It is the Corba NameServeice name, use it to get Corba NameServeice and bind your
name to it. If NMS doesn’t use third field NameServeice to connect to EMLNBI, needn’t set
and ignore it.

SESSION_FACTORY_BIND_NAME
Default value: <null>
It is the name to bind to the Corba NameService, EMLNBI’s user can use it to get session
factory of NBI. Must fill it if use Corba NameService. If NMS doesn’t use third field
NameServeice to connect to EMLNBI, needn’t set and ignore it.

EMS_PHYSICAL_LOCATION
Default value: <null>
the Physical location of the 1353NM server, defined by customer itself.
e.g. : Chengdu

PM_DATA_IP_ADDR
Value: "<NMS_IPADDRESS>"
It is the address where the performance monitor data file stores.

PM_DATA_FTP_USER
Default value: nbikey
The FTP user name assign NBI to get performance data FTP file. It’s the Ftp user in
paragraph 3.1.3.2 of NMNBI1.5.0.1 installation guild.
PM_DATA_FTP_PASSWORD
Default value: nbikey
The FTP password assigns NBI to get performance data FTP file. It’s the Ftp password in
paragraph 3.1.3.2 of NMNBI1.5.0.1 installation guild.

PM_DATA_FTP_PORT
Default value: 23
It needn’t be modified usually.

PING_NMS_INTERVAL
Default value: 300
NBI will ping NMS once in 300 seconds to check connecting whether well. It needn’t be
modified usually. If the quality of the network isn’t very well, you can reduce the interval,
or you can increase the interval.

DEFAULT_HEART_BEAT_PERIOD
Default value: 300
NBI send heart beat message to NBI’s user once in 300 seconds to check connecting
whether well. It needn’t be modified usually.

CO_COMM_NSERVERFILE
Value: "<NMS_INSTANCE_DIR>/conf/NameServerFile.nr6"
Used for name service, record the name service information.

CO_TRACE_CONFIGURATION_FILE_PATH
Value: "<NMS_INSTANCE_DIR>/NBI/conf/trace.cfg"
Related with Trace policy, NBI use it to find the “trace.cfg” file.

CORBA_SOCKET_PORT
Value: <NMNBI_CORBA_SOCKET_PORT>
System assigns the port to NBI, NBI’s user use it to connect with NBI.

IOR_FILE_NAME
Value: "<NMS_INSTANCE_DIR>/NBI/conf/ior.txt"
IT is used for store the ior.

ACCOUNT_FILE
Value: "<NMS_INSTANCE_DIR>/NBI/conf/users.cfg"
It used to configure the user name, and password.

EMS_NAME
Value: "<HOSTNAME>"
It is he EMS name.

EMS_IP_ADDRESS
Value: "<NMS_IPADDRESS>"
Used for NBI to set EMS information.

PMDS_PMP_FTP_PORT
Value: <PMDS_NBI_SERVER_SOCKET_PORT>
It is the socket port number. Used for NBI to connect with PMDSTool process to get
performance point data file.

PMDS_PMP_FTP_HOST
Value: "<NMS_IPADDRESS>"
It is the ip address. Used for NBI to connect with PMDSTool process to get performance
point data file

PM_PLAN_STORAGE
Value: "<NMS_INSTANCE_DIR>/NBI/conf/pm_lan.dat"
It is used to store the PM plan.

COMMON_RESOURCE_FILENAME
Value: "<NMS_INSTANCE_DIR>/NBI/conf/commonResouce.dat"
Used to save or load the resource into or from this file.

LOG_FILE_NAME
Value: "<NMS_INSTANCE_DIR>/maintenance/log/nmnbi.log"
It is used to store the log of NBI.

AS_ALARM_PROBABLE_CAUSE_FILE
Value:
"<AS_INSTANCE_DIR>/conf/repository/locale/<AS_ILOGLANG>/probableCauses"
It used to match the alarm cause.

AS_ALARM_SPECIFIC_PROBLEMS_FILE
Value:
"<AS_INSTANCE_DIR>/conf/repository/locale/<AS_ILOGLANG>/probableCauses"
It used to match the alarm cause.

ASIMAPPNAME
Value: "<NMS_SYSTEM>"_"<NMS_INSTANCE>"
It used to connect Asim process.
PM_DATA_PATH
It is the path of a directory. NMNBI use it to store performance point data file.
PM_DATA_FTP_PATH
It is the path of a directory. When the ftp user login, he can performance point data file
from this path.

CMIS_USENAMEFILE
Value: True
Use or not use the name service file.

CO_TRACE_SIZE_MAX
Value: 16000000
It is the max size of the trace file of NBI.

NBI_INTERFACE_VERSION
Value: "3.0"

COMPANY_NAME
Value: "Alcatel"

EMS_VERSION
Value: "7.3"

EMS_TYPE
Value: "EMS"

MAX_MANAGE_NE
Value: 1000
The max amount of NE NBI managed.

LOG_FILE_MAX_SIZE
Value: 800000
It is the max size of the log file. It needn’t modify usually.

UTC_TIME_FORMAT
Value: True
“True” means use the UTC time format.

GLOBAL_USER_LABEL_UNIQUE
Value: False
“False” means the global user label is not unique.
“True” means the global user label is not unique.

PMDS_SEND_MSG_TIMEOUT
Value: 600
If PMDSTool can't reply after 600 seconds, call back.

PMDS_MSG_MAX_SIZE
Value: 102400
If the size of message come from PMDSTool is more than 102400 bytes, NMNBI can't
deal with the message.

ASIM_RECONNECT_DURATION
Value: 10
Try to connect Asim process after 10 seconds. Asim process is related with alarms.

ASIM_ALARM_RESOLVE_TASK_DURATION
Value: 60
To resolve one unresolved alarm after 60 seconds.

LOCATION_FILE
Value: "<NMS_INSTANCE_DIR>/NBI/conf/location.txt"
The file is used to store the physical location. NMS will get the location information from
the file, and set the location information into the file.

SEND_ALARM_PURGE_NOTIFICATION
Value: False
If the alarm was purged, does NBI send the notification to NMS? “True” means send,
“False” means don’t send.

SET_EMS_TIME_SCRIPT
Value: "/usr/Systems/1353NM_<instance>/NBI/script/nbiDateTool"
It points the directory of the script which used to set the EMS time.

MAX_TRANS_DISTANCE_FILE
Value: "/usr/Systems/1353NM_<instance>/NBI/script/
wdm_max_transmission_distance.dat "
It points to a file which is used to configure the wdm network element’s transmission
distance.
 OGPI_WAVE_LENGTH_FILE
Value: "/usr/Systems/1353NM_<instance>/NBI/script/
wdm_ogpi_wave_length_file.dat "
It points to a file which is used to configure the wave length of the Ogpi ptp of wdm
network element.

OSC_CENTRAL_FREQUENCY_FILE
Value: "/usr/Systems/1353NM_<instance>/NBI/script/
wdm_osc_central_frequency_file.dat "
It points to a file which is used to configure the optical supervision channel central
frequency of the wdm network element.

OSC_FREQUENCY_SPACING_FILE
Value: "/usr/Systems/1353NM_<instance>/NBI/script/
wdm_osc_frequency_spacing_file.dat "
It points to a file which is used to configure the optical supervision channel frequency
spacing of the wdm network element.

OPEN_MSTP_RESOURCE_LOADER
Value:False
It means that if you want to get the MSTP resource.you must be change the value to true.
The default value is False

DEF_ASAP_NAME
Value: 1
When do deassign ASAP. That means the ASAP pointer must be point to a oppinted
ASAP(this ASAP’s ID was 1);The default value is 1

ISA-ES16-2.2
Value:”NS_UNTAG”
The format is
$netype-$release ["NS_TAG"|"NS_UNTAG"]. If the value is "NS_TAG", that means that this
ne dose not support tag port . Otherwise,"NS_UNTAG" means this ne does not support untag
port,The default value is NS_UNTAG

DONT_LOAD_CTP
Value: False
This parameter indicates: whether to load CTPs

DONT_LOAD_TM
Value: False
This parameter indicates: whether to load TrailMonitor

DONT_LOAD_PMP
Value: False
This parameter indicates: whether to load PMP
 DONT_LOAD_CC
Value: False
This parameter indicates: whether to load CrossConnection

DONT_LOAD_PG
Value: False
This parameter indicates: whether to load ProtectionGroup

CHANGE_PS_FOR_CLEARED_ALARM
Value: True
This parameter indicates: whether to change the cleared alarm's PS to Ps_CLEARED

MAP_SNCP_TO_OSNCP_1_PLUS_1
Value: False
This parameter indicates: whether to export SNCP protection to OSNCP protection group

PM_DATA_FTP_CMD_SCRIPT
Value: " /usr/Systems/1353NM_<instance>/script/ftp_cmd.sh
Ftp tool to transmit the PM Data file to customer's ftp server. (The ftp script should
changed to excutable)

CHECK_NE_COMMUN_STATE
Value: False
Check NE status before return the request resource to customers. (Default: do not check)

2.1.2 wdm_ogpi_wave_length_file.dat
If you want get the wave length of WDM NE, you need set the value into this file:
/usr/Systems/EML_{inst}/EMLNBI/conf/wdm_ogpi_wave_length_file.dat, please follow this
rule:
First set the appointed ogpi ptp’s wave length if you want:
<ne_userLable>/<ptp_userLable><Tab><value>
Second set all the ogpi ptps of one ne if you want:
<ne_userLable>*<Tab><value>
2.1.3 Trace.cfg

Redefine all files with full path that are used to save trace information.

SYSTEMLOG_OUTPUT
Output file of system log.
TRACE_OUTPUT
Output file of Trace.
DATAFLOW_OUTPUT
Output file of data flow.
TRACE_FILTERS
The filters of trace system.

2.1.4 users.cfg
Set the NBI’s user name and password in it, like this:
alcatel alcatel

2.1.5 ftp_cmd.sh
This ftp script should changed to excutable that about ftp tool to transmit the PM Data file to
customer's ftp server.

2.2 EMLNBIComp CONFIGURATION

2.2.1 NBIProxy
This module manage multiple sub-process of the normal operation of the NBI

2.2.1.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME
>/EMLNBIComp/NBIProxy/conf/” after installed the EMLNBIComp. The parameters in it is
needed for EMLNBI, some of them should be input by user when do the system configuration,
some of them are related with NMS keywords available, some of them are created by script
when install NBI, the others have default value before installed and needn’t modify usually, if
need modify, you can modify the file directory. Now all detail parameters information in
“param.cfg” will be described as follows.

USER_CONF_FILE
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NBIProxy/conf/user.cfg
It is the NBIProxy user name list that using to connected NBIProxy

JACORB_CONF_FILE
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NBIProxy/conf/jacorb.cfg
It is point to jacorb.cfg file that using to start java service for NBIProxy process
 LOG_CONF_FILE
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NBIProxy/conf/log.cfg
It is point to log.cfg file that using to point where the log file save

NEGROUP_IOR_FILE_DIR
Default value: <NMS_INSTANCE_DIR>/EMLNBI/conf
It is point to EMLNBI that using to proxy_ior.txt to connecting all sub_NBI process

NE_DATABASE_DIR
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NEDump/conf/ne.txt
It is point to ne.txt file that using to retrieve the ne data that from nedump process

EMS_OWNER
Default value: ALU
It is the EMS OWNER name for PKTNBI

MANAGED_EQU_TYPE
Default value: SDH & WDM & OTN & PTN
It is the management Device type

2.3 NEDump

This module manage to get data from all managed NE

2.3.1.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME
>/EMLNBIComp/NEDump/conf/” after installed the EMLNBIComp. The parameters in it is
needed for EMLNBI, some of them should be input by user when do the system configuration,
some of them are related with NMS keywords available, some of them are created by script
when install NBI, the others have default value before installed and needn’t modify usually, if
need modify, you can modify the file directory. Now all detail parameters information in
“param.cfg” will be described as follows

CO_TRACE_SIZE_MAX
Default value: 16000000
Max trace size for NEDump process
 LIST_NE_FILE
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NEDump/conf/ne.txt
All managed NE list from this file

NE_FIND_SCRIPT
Default value: <NMS_INSTANCE_DIR>/EMLNBIComp/NEDump/script/listAllNe.sh
Using this script to reload all managed ne’s list

2.4 PMSDTool

2.4.1 PMDSTool Configuration

This tool is used for EMLNBIComp to get the performance monitor data file, and get
performance monitor threshold value.

2.4.1.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME
>/EMLNBIComp/PMDSTool/conf/” after installed the EMLNBIComp. Now the important
parameters information in “param.cfg” will be described as follows.

Parameter name: NBIport

PMDSTool supports this port for NMNBI to connect.

Parameter name: UnsoReportTimer

It is interval times that PMDSTool generate performance data file and send notify to EMLNBI,
and the unit is hour.
Parameter name: MAXLINENUMOFCSVFILE
The max size of the generated performance monitor data file, “0” means random size.

Parameter name: use_GMT0

“True” or “False”. Means whether use GMT in performance monitor data.

Parameter name: CSV_delimiter

It is the delimiter in the generated performance monitor data file.

Parameter name: UnsoReportStartTime

When NMS start the unsold reporting of performance point, it is the start time of the
performance monitor data in the data file.
Format: “yyyy/mm/dd hh:mm:ss”
“<Null>” means 3 hours before you start.

2.5 SDHNBI CONFIGURATION

2.5.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME >/SDHNBI/conf/”
after installed the SDHNBI. The parameters in it is needed for SDHNBI, some of them should
be input by user when do the system configuration, some of them are related with NMS
keywords available, some of them are created by script when install NBI, the others have
default value before installed and needn’t modify usually, if need modify, you can modify the
file directory. Now all detail parameters information in “param.cfg” will be described as
follows.

SESSION_FACTORY_NAME_SERVICE_NAME
Default value: <null>
It is the Corba NameServeice name, use it to get Corba NameServeice and bind your
name to it. If NMS doesn’t use third field NameServeice to connect to SDHNBI, needn’t set
and ignore it.

SESSION_FACTORY_BIND_NAME
Default value: <null>
It is the name to bind to the Corba NameService, NBI’s user can use it to get session
factory of NBI. Must fill it if use Corba NameService. If NMS doesn’t use third field
NameServeice to connect to SDHNBI, needn’t set and ignore it.

EMS_PHYSICAL_LOCATION
Default value: <null>
the Physical location of the 1350OMS-SDH server, defined by customer itself.
e.g. : Chengdu

PM_DATA_IP_ADDR
Value: "<NMS_IPADDRESS>"
It is the address where the performance monitor data file stores.
PM_DATA_FTP_USER
Default value: nbikey
The FTP user name assigned NBI to get performance data FTP file. It’s the Ftp user in
paragraph 3.1.3.2 of SDHNBI1.6.0.7 installation guild.

PM_DATA_FTP_PASSWORD
Default value: nbikey
The FTP password assigns NBI to get performance data FTP file. It’s the Ftp password in
paragraph 3.1.3.2 of SDHNBI1.6.0.7 installation guild.

PM_DATA_FTP_PORT
Default value: 23
It needn’t be modified usually.

NCDR_FILE_DIR
Default value: "/home/ftp/Isn/repository/nbikey"
It’s the FTP path used to store the NCDR file, It’s the Ftp absolute path in paragraph
3.1.3.2 of SDHNBI1.6.0.7 installation guild.

PING_NMS_INTERVAL
Default value: 300
NBI will ping NMS once in 300 seconds to check connecting whether well. It needn’t be
modified usually. If the quality of the network isn’t very well, you can reduce the interval,
or you can increase the interval.

DEFAULT_HEART_BEAT_PERIOD
Default value: 300
NBI send heart beat message to NBI’s user once in 300 seconds to check connecting
whether well. It needn’t be modified usually.

ISN_AUTH_KEY
Default value: nbikey
Use it to set the message to send to ISN. It’s the “MgrKey” in ISN, which assign NBI to use.
(Ref. SDHNBI1.6.0.7 Installation Guild paragraph 3.1.3.1)

ISN_SERVICE
Default value: ISN
Use it to set the message to send to ISN. It needn’t be modified usually.

IOOISN_SEND_MSG_TIMEOUT
Default value: 360
If NBI send message to ISN can’t get reply after 360 seconds, NBI go on to do other thing.
It needn’t be modified usually.

CO_COMM_NSERVERFILE
Value: "<NMS_INSTANCE_DIR>/conf/NameServerFile.nr6"
Used for name service, record the name service information.

CO_TRACE_CONFIGURATION_FILE_PATH
Value: "<NMS_INSTANCE_DIR>/SDHNBI/conf/trace.cfg"
Related with Trace policy, NBI use it to find the “trace.cfg” file.

CORBA_SOCKET_PORT
Value: <SDHNBI_CORBA_SOCKET_PORT>
System assigns the port to NBI, NBI’s user use it to connect with NBI.

IOR_FILE_NAME
Value: "<NMS_INSTANCE_DIR>/SDHNBI/conf/ior.txt"
IT is used for store the ior.

ACCOUNT_FILE
Value: "<NMS_INSTANCE_DIR>/SDHNBI/conf/users.cfg"
It is used to configure the user name, and password.

EMS_NAME
Value: "<HOSTNAME>"
It is he EMS name.

ISN_AGENT_HOST
Value: "<NMS_IPADDRESS>"
It is used to connect with ISN.

EMS_IP_ADDRESS
Value: "<NMS_IPADDRESS>"
Used for NBI to set EMS information.

PMDS_PMP_FTP_PORT
Value: <PMDS_NBI_SERVER_SOCKET_PORT>
It is the socket port number. Used for NBI to connect with PMDSTool process to get
performance point data file.

PMDS_PMP_FTP_HOST
Value: "<NMS_IPADDRESS>"
It is the ip address. Used for NBI to connect with PMDSTool process to get performance
point data file

RM_ALARM_PROBABLE_CAUSE_FILE
"<NMS_INSTANCE_DIR>/SDHNBI/conf/ProbableCauseMapping.txt"
It is used to match to probable which the SDH Alarm is. Can’t be modified.

LOG_FILE_NAME
Value: "<NMS_INSTANCE_DIR>/maintenance/log/SDHNBI.log"
It is used to store the log of NBI.

AS_ALARM_PROBABLE_CAUSE_FILE
Value:
"<AS_INSTANCE_DIR>/conf/repository/locale/<AS_ILOGLANG>/probableCauses"
It used to match the alarm cause.

AS_ALARM_SPECIFIC_PROBLEMS_FILE
Value:
"<AS_INSTANCE_DIR>/conf/repository/locale/<AS_ILOGLANG>/probableCauses"
It used to match the alarm cause.

ASIMAPPNAME
Value: "<NMS_SYSTEM>"_"<NMS_INSTANCE>"
It used to connect Asim process.

PM_DATA_PATH
It is the path of a directory. SDHNBI use it to store performance point data file.
PM_DATA_FTP_PATH
It is the path of a directory. When the ftp user login, he can performance point data file
from this path.

ISN_AGENT_PORT
Default value:
Use it to set the message to send to ISN.

CMIS_USENAMEFILE
Value: True
Use or not use the name service file.
CO_TRACE_SIZE_MAX
Value: 8000000
It is the max size of the trace file of NBI.

NBI_INTERFACE_VERSION
Value: "3.0"

COMPANY_NAME
Value: "Alcatel"

ISN_LOCAL_USER
Value: ""
It used to set the domain of the ISN command. Needn’t modify usually.

EMS_VERSION
Value: "7.3"

EMS_TYPE
Value: "EMS"

MAX_MANAGE_NE
Value: 1000
The max amount of NE NBI managed.

CHECK_NE_COMMUN_STATE
Value: True
Check or not check the Network Element communication state.

ISN_DOMAIN
Value: ""
It used to set the domain of the ISN command. It needn’t modify usually.

LOG_FILE_MAX_SIZE
Value: 800000
It is the max size of the log file. It needn’t modify usually.

UTC_TIME_FORMAT
Value: True
“True” means use the UTC time format.

GLOBAL_USER_LABEL_UNIQUE
Value: False
“False” means the global user label is not unique.
“True” means the global user label is not unique.
PMDS_SEND_MSG_TIMEOUT
Value: 600
If PMDSTool can't reply after 600 seconds, call back.

PMDS_MSG_MAX_SIZE
Value: 102400
If the size of message come from PMDSTool is more than 102400 bytes, SDHNBI can't
deal with the message.

ASIM_RECONNECT_DURATION
Value: 10
Try to connect Asim process after 10 seconds. Asim process is related with alarms.

ASIM_ALARM_RESOLVE_TASK_DURATION
Value: 60
To resolve one unresolved alarm after 60 seconds.

ISN_RES_RELOAD_INTERVAL
Value: 172800
Reload the resoles after 172800 seconds. If you set the interval larger, the performance of
SDHNBI will be better. But if some resource changed, NBI may use more time to get the
refresh one
This parameter indicates: reload SDH resource interval

NMBATCH_CMD_FILE_BASENAME
Value: "nmbatchCmd"
Interval configuration file name for send message to ISN.

NMBATCH_OUTPUT_FILE_BASENAME
Value: "nmbatchOutput"
Interval configuration file name for send message to ISN.
LOCATION_FILE
Value: "<NMS_INSTANCE_DIR>/SDHNBI/conf/location.txt"
The file is used to store the physical location. NMS will get the location information from
the file, and set the location information into the file.

ISN_SNC_CREATE_CHANGE_TIMEOUT
Value: 600
The time out seconds when create path or delete path. If ISN don’t reply SDHNBI after
600 seconds, SDHNBI return automatically

ISN_SNC_NEXT_STATE_CHANGE_DELAY
Value: 10
SDHNBI monitors the state of path every 10 seconds.

SEND_ALARM_PURGE_NOTIFICATION
Value: False
If the alarm was purged, does NBI send the notification to NMS? “True” means send,
“False” means don’t send.

NCDR_RECORD_PROCESS_CPU_LIMIT
Value: 30
It is used to limit the CPU resource cost bye NBI process. If the used resource of CPU by
NBI is more than this percent, NBI will not parse the NCDR file from ISN.

NCDR_REPORT_RETRIEVE_TIMEOUT
Value: 90
NBI don’t deal the report, if the NCDR report callback after 90 seconds.

RETURN_SUBLINKCONNECT_AS_TL
Value: False
You can turn on/off (set to True/False) the parameter
RETURN_SUBLINKCONNECT_AS_TL to indicate SDHNBI to report/don't report sub link
connections as TL.

SET_EMS_TIME_SCRIPT
Value: "/usr/Systems/SDH_<instance>/SDHNBI/script/nbiDateTool"
It points the directory of the script which used to set the EMS time.

RETURN_EMBEDED_ROUTE
Value: True
NBI return the embedded route information to NMS.
 CHANGE_PS_FOR_CLEARED_ALARM
Value: True
This parameter indicates: whether to change the cleared alarm's PS to Ps_CLEARED

RMUSERID
Value: snml@<HOSTNAME>
This parameter indicates: RM f-interface access userID

FILTER_CONF_FILE
Value: "<NMS_INSTANCE_DIR>/SDHNBI//conf/filter.cfg"
This parameter indicates: SDH f-interface notification filter configuration file path

2.5.2 Trace.cfg
Redefine all files with full path that are used to save trace information.

SYSTEMLOG_OUTPUT
Output file of system log.
TRACE_OUTPUT
Output file of Trace.
DATAFLOW_OUTPUT
Output file of data flow.
TRACE_FILTERS
The filters of trace system.

2.5.3 users.cfg
Set the NBI’s user name and password in it, like this:
alcatel alcatel

2.5.4 filter.cfg
This filter.cfg script can execute SDH f-interface notification filter configuration file path

2.5.5 PMDSTool Configuration

This tool is used for SDHNBI to get the performance monitor data file, and get performance
monitor threshold value.

2.5.5.1 Param.cfg
The “param.cfg” is resided in the directory “/usr/Systems/< NMS_NAME
>/SDHNBI/PMDSTool/conf/” after installed the SDHNBI. Now the important parameters
information in “param.cfg” will be described as follows.
Parameter name: NBIport
PMDSTool supports this port for SDHNBI to connect.

Parameter name: UnsoReportTimer

It is interval times that PMDSTool generate performance data file and send notify to SDHNBI,
and the unit is hour.
Parameter name: MAXLINENUMOFCSVFILE
The max size of the generated performance monitor data file, “0” means random size.

Parameter name: use_GMT0

“True” or “False”. Means whether use GMT in performance monitor data.

Parameter name: CSV_delimiter

It is the delimiter in the generated performance monitor data file.

Parameter name: UnsoReportStartTime

When NMS start the unsold reporting of performance point, it is the start time of the
performance monitor data in the data file.
Format: “yyyy/mm/dd hh:mm:ss”
“<Null>” means 3 hours before you start.

2.6 PKTNBI CONFIGURATION

2.6.1 NBI_INIT_FILE.xml
PKT nbi use this file to initialization objects for notifications. It’s used by src code only
shall not be modified.

2.6.2 NBI_XML_CONFIGURE.xml
PKT nbi use this file to retrieve objects. It’s used by src code only
shall not be modified.

2.6.3 NBI_XML_CONFIGURE.xsd
Xsd file of xml.

2.6.4 CBM.conf
It’s the configuration file of CORNBI for PKT.
There are two parts of it, “common” indicate parameters which used by nbi to communicate
with PKT. This part shall not be modified. “nbi” shows parmeters of PKTNBI self and
communication parameters with client.
[nbi]
TraceMaxLineCount = 10000
It set trace file’s max line is 10000.

TraceFile="/usr/Systems/PKT_1/PKTNBI/trace/cbm"
It set the trace file location of nbi. The file name will be cbm.trc

TraceLevel=8
It set the trace level = 8, there trace level range is 1-8, the larger the more detail in trace file.

MaxNumberOfOpenIterator=10
The max number of iterator, if the max number has been reached, nbi should be restart,
otherelse max_number_of_iterator exception will be thrown when retriving object with
iterator.

IOR_FileName="/usr/Systems/PKT_1/PKTNBI/conf/ior.txt"
It set the IOR File name and path of nbi.

ResourceFile="/usr/Systems/PKT_1/PKTNBI/conf/commonResource.dat"
Resource data file, it used by src code only and can’t be modified.

DBLogFileName="/usr/Systems/PKT_1/maintenance/log/C_Dbi.log"
It set the db log file and location. This log file will record db operations of nbi

DBConnectionNumber=10
It set the DBConnection max number of NBI, if reach max number, any retrieving operation
will be blocked.

2.6.5 SvcTAO.conf
NBI startup parameters.
2.6.6 libcnbi_bm_external.sl
share library used by nbi.

2.6.7 libcnbi_bm_impl.sl
share library used by nbi.
3. NBI Log/Trace Policy
3.1 EMLNBI

3.1.1 Introduction
In this section, the log/trace files will be described as “which file and the purpose”.

3.1.2 General Log & Trace files of NMNBI

The following table lists the 3 log/trace files in EMLNBI.
ID File Name File Location
1 nmnbi.log <NMS_INSTANCE_DIR>/maintenance/log/
2 nmnbi.trace <NMS_INSTANCE_DIR>/maintenance/trace/
3 nmnbi.dataflow <NMS_INSTANCE_DIR>/maintenance/trace/

3.1.3 nmnbi.log
nmnbi.log records the following trace information:
It records the nmnbi’s event and command log information

3.1.4 nmnbi.trace
nmnbi.trace records debug information of nmnbi application.

3.1.5 nmnbi.dataflow
nmnbi.dataflow records the following trace information:
It records the relevant information of nmnbi application.

3.1.6 Trace level information

The default setting for trace level is the following:
TRACE_FILTERS
{
ALL
{
ALL 1+
}
}
Maximum level for traces is obtained with the following setting:
TRACE_FILTERS
{
ALL
{
ALL 1 2 3 4 5 6 7
}
}
N.B. "ALL 1+" is equivalent to "ALL 1 2 3 4 5 6 7" in previous setting.
And the following is an example for another configuration:
TRACE_FILTERS
{
ALL
{
ALL 1 2 5
}
}

The following table gives the information traced according to the trace level specified:
Level Information
1 error statuses (raising, ignoring, clearing)
2 process events (init, shutdown, I/O)
3 process I/O dataflow
4 method calls and results
5 platform calls and results (system, HPOV, SGBD, ...)
6 debugging
7 specific
The trace level can be configured in trace.cfg.

The corresponding trace files record the daemon error and output information. They can help
developer debug the process easily.

3.2 SDHNBI

3.2.1 Introduction
In this section, the log/trace files will be described as “which file and the purpose”.

3.2.2 General Log & Trace files of SDHNBI

The following table lists the 3 log/trace files in SDHNBI.
ID File Name File Location
1 SDHNBI.log <NMS_INSTANCE_DIR>/maintenance/log/
2 SDHNBI.trace <NMS_INSTANCE_DIR>/maintenance/trace/
3 SDHNBI.dataflow <NMS_INSTANCE_DIR>/maintenance/trace/

3.2.3 SDHNBI.log
SDHNBI.log records the following trace information:
It records the SDHNBI’s event and command log information.

3.2.4 SDHNBI.trace
SDHNBI.trace records debug information of SDHNBI application.

3.2.5 SDHNBI.dataflow
SDHNBI.dataflow records the following trace information:
It records the relevant information of SDHNBI application.

3.2.6 Trace level information

The default setting for trace level is the following:
TRACE_FILTERS
{
ALL
{
ALL 1+
}
}
Maximum level for traces is obtained with the following setting:
TRACE_FILTERS
{
ALL
{
ALL 1 2 3 4 5 6 7
}
}
N.B. "ALL 1+" is equivalent to "ALL 1 2 3 4 5 6 7" in previous setting.
And the following is an example for another configuration:
TRACE_FILTERS
{
ALL
{
ALL 1 2 5
}
}

The following table gives the information traced according to the trace level specified:
Level Information
1 error statuses (raising, ignoring, clearing)
2 process events (init, shutdown, I/O)
3 process I/O dataflow
4 method calls and results
 5 platform calls and results (system, HPOV, SGBD, ...)
6 debugging
7 specific
The trace level can be configured in trace.cfg.

The corresponding trace files record the daemon error and output information. They can help
developer debug the process easily.

3.3 PKTNBI

3.3.1 Introduction
In this section, the log/trace files will be described as “which file and the purpose”.

3.3.2 General Log & Trace files of BMNBI

ID File Name File Location
1 bmnbi.trace <NMS_INSTANCE_DIR>/PKTNBI/trace/

END OF DOCUMENT