with IBM Corp. - tnpmsupport.persistentsys.com · Huawei U2000 2.3.1.0 T echnology Pack ... . 226 Notices ... commands, and paths that ar e dependent on your operating system. About

IBM Tivoli Netcool Performance ManagerWireline ComponentOctober 2015Document Revision R2E1

Configuring Technology Packs

IBM

NoteBefore using this information and the product it supports, read the information in “Notices” on page 229.

© Copyright IBM Corporation 1997, 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this information . . . . . . .. vIntended audience . . . . . . . . . . .. vTivoli Netcool Performance Manager - WirelineComponent. . . . . . . . . . . . . .. vWhat this information contains . . . . . . .. viService Management Connect . . . . . . .. viiTivoli Netcool Performance Manager technicaltraining . . . . . . . . . . . . . .. viiSupport information . . . . . . . . . .. viiConventions used in this publication . . . . .. vii

Typeface conventions . . . . . . . . .. viii

Configuring packs . . . . . . . . .. 1Configuring technology packs . . . . . . .. 1

Configuring SNMP technology packs . . . .. 1Configuring UBA technology packs. . . . .. 3Configuring technology packs for enablingcommon reporting . . . . . . . . . .. 10

Additional configuration steps for certain SNMPtechnology packs . . . . . . . . . . .. 11

Arris CMTS DOCSIS 3.0 Technology Pack . .. 12Cisco CBQoS Technology Pack . . . . . .. 14MIB-II Technology Pack . . . . . . . .. 17

Additional configuration steps for certain UBATechnology Packs . . . . . . . . . . .. 18

Alcatel-Lucent SAM 5620 LogToFile TechnologyPack . . . . . . . . . . . . . . .. 18Alcatel-Lucent 5529 SDC Technology Pack . .. 95Alcatel-Lucent 5620 SAM Technology Pack .. 126Alcatel-Lucent 5670 RAM Technology Pack .. 188Cisco IP Telephony Technology Pack . . .. 202GenBand C20 Converged IP SoftswitchTechnology Pack . . . . . . . . . .. 203UBA PVLine Format Technology Pack . . .. 219Huawei U2000 2.3.1.0 Technology Pack . . .. 226

Notices . . . . . . . . . . . . .. 229Terms and conditions for product documentation 231Trademarks . . . . . . . . . . . . .. 232Additional copyright notices . . . . . . .. 233

© Copyright IBM Corp. 1997, 2015 iii

iv IBM Tivoli Netcool Performance Manager: Configuring Technology Packs

About this information

Describes how to configure Tivoli® Netcool® Performance Manager technologypacks.

Tivoli Netcool Performance Manager 1.4 supports both Oracle and DB2® databases.

Attention: DB2 is supported on Linux only. Whereas, Oracle is supported onSolaris, AIX®, and Linux systems.

Tivoli Netcool Performance Manager rolled out the ability to report on theperformance data by using the Cognos® reporting capability of Tivoli CommonReporting, included as standard in Tivoli Netcool Performance Manager.

Intended audienceThe audience for this guide.v Network administrators or operations specialists responsible for installing and

configuring technology packs and common packs on an IBM Tivoli NetcoolPerformance Manager system on an enterprise network.

v Common pack modelers who want to publish data models for CommonReporting in Tivoli Netcool Performance Manager.

Readers must be familiar with the following topics:v Basic principles of TCP/IP networks and network managementv SNMP conceptsv Administration of the Oracle database management systemv Tivoli Netcool Performance Managerv Tivoli Netcool Performance Manager technology pack and common pack

conceptsv Tivoli Netcool Performance Manager reporting conceptsv Jazz for Service Managementv IBM Cognosv IBM Cognos Framework Manager

Tivoli Netcool Performance Manager - Wireline ComponentIBM® Tivoli Netcool Performance Manager consists of a wireline component(formerly Netcool/Proviso) and a wireless component (formerly Tivoli NetcoolPerformance Manager for Wireless).

Tivoli Netcool Performance Manager - Wireline Component consists of thefollowing subcomponents:v DataMart is a set of management, configuration, and troubleshooting GUIs. The

Tivoli Netcool Performance Manager System Administrator uses the GUIs todefine policies and configuration, and to verify and troubleshoot operations.

v DataLoad provides flexible, distributed data collection and data import of SNMPand non-SNMP data to a centralized database.

© Copyright IBM Corp. 1997, 2015 v

v DataChannel aggregates the data collected through Tivoli Netcool PerformanceManager DataLoad for use by the Tivoli Netcool Performance ManagerDataView reporting functions. It also processes online calculations and detectsreal-time threshold violations.

v DataView is a reliable application server for on-demand, web-based networkreports.

v Technology Packs extend the Tivoli Netcool Performance Manager system withservice-ready reports for network operations, business development, andcustomer viewing.

The following figure shows the different Tivoli Netcool Performance Managermodules.

Tivoli Netcool Performance Manager documentation consists of the following:v Release notesv Configuration recommendationsv Installation and upgrade informationv User guidesv Technical notesv Online help

The documentation is available for viewing and downloading on the informationcenter at http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/tnpm_1.4_kc_welcome.html?lang=en.

What this information containsThis publication contains the following sections:v “Configuring technology packs” on page 1

Describes how to configure the technology packs.v “Additional configuration steps for certain SNMP technology packs” on page 11

Describes additional configuration steps required for certain SNMP technologypacks.

v “Additional configuration steps for certain UBA Technology Packs” on page 18

vi IBM Tivoli Netcool Performance Manager: Configuring Technology Packs

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/tnpm_1.4_kc_welcome.html?lang=en

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/tnpm_1.4_kc_welcome.html?lang=en

Describes additional configuration steps required for certain UBA technologypacks.

Service Management ConnectConnect, learn, and share with Service Management professionals: product supporttechnical experts who provide their perspectives and expertise.

Access Network and Service Assurance community at https://www.ibm.com/developerworks/servicemanagement/nsa/index.html. Use Service ManagementConnect in the following ways:v Become involved with transparent development, an ongoing, open engagement

between other users and IBM developers of Tivoli products. You can access earlydesigns, sprint demonstrations, product roadmaps, and prerelease code.

v Connect one-on-one with the experts to collaborate and network about Tivoliand the Network and Service Assurance community.

v Read blogs to benefit from the expertise and experience of others.v Use wikis and forums to collaborate with the broader user community.Related information:

Tivoli Netcool Performance Manager 1.4 community on developerWorks

Tivoli Netcool Performance Manager technical trainingFor Tivoli Netcool Performance Manager technical training information, see thefollowing Tivoli Netcool Performance Manager Training website at:https://tnpmsupport.persistentsys.com/training.

Support informationIf you have a problem with your IBM software, you want to resolve it quickly. IBMprovides the following ways for you to obtain the support you need:

OnlineAccess the IBM Software Support site at http://www.ibm.com/software/support/probsub.html .

IBM Support AssistantThe IBM Support Assistant is a free local software serviceability workbenchthat helps you resolve questions and problems with IBM softwareproducts. The Support Assistant provides quick access to support-relatedinformation and serviceability tools for problem determination. To installthe Support Assistant software, go to http://www.ibm.com/software/support/isa.

Troubleshooting GuideFor more information about resolving problems, see the problemdetermination information for this product.

Conventions used in this publicationSeveral conventions are used in this publication for special terms, actions,commands, and paths that are dependent on your operating system.

About this information vii

https://www.ibm.com/developerworks/servicemanagement/nsa/index.html

https://www.ibm.com/developerworks/servicemanagement/nsa/index.html

https://www.ibm.com/developerworks/community/groups/service/html/communityview?communityUuid=d4b565fd-04e5-47c2-965a-943ccdfabdb9

https://tnpmsupport.persistentsys.com/training

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/isa

http://www.ibm.com/software/support/isa

Typeface conventionsThis publication uses the following typeface conventions:

Bold

v Lowercase commands and mixed case commands that are otherwisedifficult to distinguish from surrounding text

v Interface controls (check boxes, push buttons, radio buttons, spinbuttons, fields, folders, icons, list boxes, items inside list boxes,multicolumn lists, containers, menu choices, menu names, tabs, propertysheets), labels (such as Tip:, and Operating system considerations:)

v Keywords and parameters in text

Italic

v Citations (examples: titles of publications, diskettes, and CDs)v Words defined in text (example: a nonswitched line is called a

point-to-point line)v Emphasis of words and letters (words as words example: "Use the word

that to introduce a restrictive clause."; letters as letters example: "TheLUN address must start with the letter L.")

v New terms in text (except in a definition list): a view is a frame in aworkspace that contains data.

v Variables and values you must provide: ... where myname represents....

Monospace

v Examples and code examplesv File names, programming keywords, and other elements that are difficult

to distinguish from surrounding textv Message text and prompts addressed to the userv Text that the user must typev Values for arguments or command options

Bold monospace

v Command names, and names of macros and utilities that you can typeas commands

v Environment variable names in textv Keywordsv Parameter names in text: API structure parameters, command

parameters and arguments, and configuration parametersv Process namesv Registry variable names in textv Script names

viii IBM Tivoli Netcool Performance Manager: Configuring Technology Packs

Configuring packs

Provides details about the configuration steps that are required for SNMP andUBA technology packs.

Configuring technology packsTypical configuration steps for SNMP and UBA technology packs.

Configuring SNMP technology packsTypical configuration steps for an SNMP technology pack.

Procedure1. Load the DataMart environment.

To load the shell with the DataMart environment, follow these steps:a. Log in to the DataMart server as pvuser.b. Change your working directory to the DataMart home directory

(/opt/datamart, by default), by using the following command:cd /opt/datamart

c. Load the shell with the DataMart environment, by sourcing thedataMart.env file, as follows:. /opt/datamart/dataMart.env

Note: After you load the DataMart environment into the shell, thePVMHOME variable is set to the DataMart home directory /opt/datamartby default. These instructions assume that this variable is set.

2. Activate data collection requests.During installation of the technology pack, all predefined data collectionrequests are promoted to the database and set to inactive (that is, idle displaysin the Active column of the Tivoli Netcool Performance Manager DataMartRequest Editor). You must activate these predefined data collection requests byusing the Request Editor.To set data collection requests to active, follow these steps:a. Change your working directory to $<PVMHOME>/bin (/opt/datamart/bin, by

default) on the DataMart server.b. Enter the following command, and then press Enter to open the DataMart

GUI:pvm

c. Click the Configuration tab, and then click Request Editor to open theRequest Editor.

d. Click the Collection tab.e. Click Refresh. The predefined data collection requests are loaded into the

Request Editor from the database.f. Click the Inactive button in the Filter group box to display only idle

requests.g. In the Sub-Element Groups pane, select all idle data collection requests in

the following group or groups:Root > Sub-Element Collect > <tech_pack>

© Copyright IBM Corp. 1997, 2015 1

h. Click the Active box under Details. The Request Editor toggles the idlesetting for these data collection requests from idle to active in the Activecolumn.

i. Click Save.3. Merge the technology pack subelement inventory text files.

Subelement inventory control rules for the technology pack are contained in thefile <tech_pack>_inventory_subelements.txt, which is installed in thefollowing directory on the DataMart server:<$PVMHOME>/APFiles/<tech_pack>/datamart/conf

You must merge the contents of this file with the fileinventory_subelements.txt located in <$PVMHOME>/conf (by default,/opt/datamart/conf) on the DataMart server.

Important: You must perform the following steps on the MIB-II TechnologyPack before you perform them on the SNMP technology pack that has adependency on the MIB-II Technology Pack.To merge the subelement inventory control rules for the Technology Pack,follow these steps:a. Enter the following command to change your working directory to

<$PVMHOME>/conf

cd <$PVMHOME>/conf

b. Copy <tech_pack>_inventory_subelements.txt to the <$PVMHOME>/confdirectory, by entering the following command:cp $<$PVMHOME>/APFiles/<tech_pack>/datamart/conf/<tech_pack>_inventory_subelements.txt

c. Enter the following command to make a backup copy of theinventory_subelements.txt file:cp inventory_subelements.txt inventory_subelements.txt.ORIG

d. Enter the following command to append the contents of<tech_pack>_inventory_subelements.txt to inventory_subelements.txt:

Important: Ensure that you use two forward brackets (>>); otherwise, theoriginal content of inventory_subelements.txt is overwritten.cat <tech_pack>_inventory_subelements.txt >>inventory_subelements.txt

e. Perform diff on the backed-up file and the appended file to ensure that themerge succeeded, as shown in the following example:diff inventory_subelements.txt inventory_subelements.txt.ORIG

4. Run the initial SNMP inventory and initiate a discovery.An inventory collects data about the network resources that the technologypack monitors. After you install an SNMP technology pack, you must create aninventory profile by using the Inventory Tool Wizard. You must then initiate adiscovery by running the inventory profile by using the Inventory Tool.Running the initial inventory against SNMP objects is an intricate task andunfortunately beyond the scope of this configuration chapter. For instructionson using the Inventory Tool Wizard to create an inventory profile, and theInventory tool to run the inventory profile, see the Configuring and OperatingDataMart.

5. Deploy reports.After the technology pack installation completes, the rules for the new deviceare automatically loaded into the database. The inventory process uses these

2 IBM Tivoli Netcool Performance Manager: Configuring Technology Packs

rules to group elements and subelements. You must manually deploy(auto-group) the reports by associating them with groups in the NOCReporting tree in the DataMart Resource Editor.To deploy the Technology Pack reports, follow these steps:a. Open the Tivoli Netcool Performance Manager DataMart Resource Editor.b. Click the Report SE Group tab.c. Move the cursor to the left pane and scroll up to select any group under the

SUB-ELEMENTS > NOC Reporting tree.d. Right-click and select the AutoGrouping option from the menu. The

AutoGrouping option places the reports in dynamically generated groupsthat are created during inventory.

e. Click Yes to continue.f. Click Close to exit the message box. Or, click Details to view a description

of any errors.g. Optional: Create an entry cron that uses the inventory CLI command and

the -reportGrouping option to deploy reports regularly. The followingexample shows an entrycron that periodically deploys the report operation:0 * * * * . /opt/datamart/dataMart.env && inventory -noX -reportGrouping

This option instructs the inventory command to run the report groupingrules and update the deployed reports that are stored in the database.Report grouping rules must be created before this option can be used.Formore information about creating report grouping rules, see the Configuringand Operating DataMart.For more information about the inventory command, see the CommandLine Interface Reference.

What to do next

Verifying resourcesUse the Tivoli Netcool Performance Manager DataMart Resource Editor todetermine whether the following technology pack resources (elements,subelements, properties, and so on) are successfully discovered and createdin the database during inventory.

For more information about Tivoli Netcool Performance Manager DataMartResource Editor, see the Configuring and Operating DataMart.

Configuring UBA technology packsTypical configuration steps for a UBA technology pack.

Procedure1. Load the DataMart environment.

To load the shell with the DataMart environment, follow these steps:a. Log in to the DataMart server as pvuser.b. Change your working directory to the DataMart home directory

(/opt/datamart, by default), by using the following command:cd /opt/datamart

c. Load the shell with the DataMart environment, by sourcing thedataMart.env file, as follows:. /opt/datamart/dataMart.env

Configuring packs 3

Note: After you load the DataMart environment into the shell, the<PVMHOME> variable is set to the DataMart home directory,/opt/datamart by default. These instructions assume that this variable is set.

2. Copy technology-specific files from the DataMart server to the DataChannelserver.Technology-specific files are used to associate a UBA technology pack with aspecific instance of the UBA.

Note: While it is possible to install DataMart and DataChannel on the sameserver, in a typical installation these modules are installed on separate servers.If so, use FTP to copy the technology-specific files. Otherwise, if DataMart andDataChannel are on the same server, use the cp command to copy the files tothe appropriate DataChannel directory.To copy technology-specific files to the DataChannel server, follow these steps:a. Log in to the Tivoli Netcool Performance Manager DataChannel server by

entering the user name and password that you specified when you installand configure a DataChannel. The default user name and password arepvuser and PV.

b. Change your working directory to the <DATA_CHANNEL_HOME>/scriptsdirectory by entering the following command, replacing<DATA_CHANNEL_HOME> with the DataChannel home directory(/opt/datachannel, by default):$ cd <DATA_CHANNEL_HOME>/scripts

c. Copy the <tech_pack> directory from <$PVMHOME>/APFiles/<tech_pack>/datachannel/scripts to <DATA_CHANNEL_HOME>/scripts.

d. Verify that the technology-specific files are now in the target directory asfollows: Verify that the bulk adapter design files (*.js), scripts (if any), otherfiles (if any) are now in the <DATA_CHANNEL_HOME>/scripts/<tech_pack>directory.

3. Activate data collection requests.During installation of the technology pack, all predefined data collectionrequests are promoted to the database and set to inactive (that is, idle displaysin the Active column of the Tivoli Netcool Performance Manager DataMartRequest Editor). You must activate these predefined data collection requests byusing the Request Editor.To set data collection requests to active, follow these steps:a. Change your working directory to <$PVMHOME>/bin (/opt/datamart/bin, by

default) on the DataMart server.b. Enter the following command, and then press Enter to invoke the DataMart

GUI:pvm

c. Click the Configuration tab, and then click Request Editor to open theRequest Editor.




the following group or groups:Root > Sub-Element Collect > <tech_pack>



i. Click Save.4. Edit pack-specific UBA parameters, which are based on Tivoli Netcool/Proviso

v4.4.3 and Tivoli Netcool Performance Manager platforms:In this release of Tivoli Netcool Performance Manager, you are instructed tomodify the technology pack-specific UBA parameters when you install thetechnology pack by using the Topology Editor. If you did not modify the UBAparameters with site-specific values or you want to make more edits, you cando so now. Otherwise, you can go to the next step.

5. Load the DataChannel environment. In subsequent steps, you execute dccmdcommands. To ensure that you can run these commands, load the shell withthe DataChannel environment by following these steps:a. Log in to the DataChannel server as pvuser.b. Change your working directory to the DataChannel home directory

(/opt/datachannel, by default), by using the following command:cd /opt/datachannel

c. Load the shell with the DataChannel environment, by sourcing thedataChannel.env file, as follows:. /opt/datachannel/dataChannel.env

6. Restart the DataChannel to activate the UBA and read in changes to thedeployed topology.a. Open a terminal emulator on the DataChannel server.b. Use the dccmd command to stop all DataChannel applications:

dccmd stop all

c. Use the dccmd command to release all daemons that run in the DataChannel:dccmd forget all

d. Use the following command to find the process identifiers (pids) associatedwith the DataChannel visual processes:<DATA_CHANNEL_HOME>/bin/findvisual

Where:<DATA_CHANNEL_HOME> is /opt/datachannel, by default.

e. Use the following commands to stop each DataChannel visual process:kill -9 <cnsw_pid>kill -9 <logw_pid>kill -9 <amgrw_pid>kill -9 <cmgrw_pid>

Note: The logw is a Java process and must to be killed by using ps -ef|grep LOG, and then kill the logw process ID.

f. Use the following commands to restart each DataChannel visual process:cnswlogwcmgrwamgrw

g. Use the dccmd command to start all DataChannel applications:dccmd start all

h. Use the dccmd command to verify that all of the DataChannel applicationsstarted properly:

Configuring packs 5

dccmd status all

Note: More specifically, make sure that the UBA application associated withthe DataChannel that is configured for the technology pack is running.

i. Watch the output of the status switch to verify that all the necessaryprocesses are running. If these processes are running, run the tail utility onthe log file for the UBA by issuing a command similar to the followingexample:tail -f DATA_CHANNEL_HOME/log/proviso.log | grepUBA.<channel_number>.<collector_number>- | more

Where:

Variable Description

<DATA_CHANNEL_HOME> By default, /opt/datachannel

<channel_number> Specifies the channel number (forexample, 1) you specified when youconfigured this DataChannel.

The trailing dash (–) after<collector_number>

Removes extraneous log messages fromyour view. That is, the trailing dashguarantees that the command displaysonly those messages that are generatedby your application. The first set ofmessages relates to syntax checks.

The following table identifies some events to watch for during the syntaxcheck:

Event Description

The UBA application starts successfully,but then stops executing.

Typically, this event occurs because of alicensing issue.

The bulk adapter design file might becorrupted.

This event causes a syntax error beforethe UBA application connects to thedatabase.

The UBA application connects to thedatabase.

This event causes a message similar tothe following example to display:DB_CONNECT Connecting to <sid> as <user>

If you see this database connectionmessage without prior errors, the UBAapplication passed the syntax check.

7. Ensure that the bulk input files can be read. To verify that the UBA applicationcan read the bulk input files, follow these steps:a. Place a bulk input file at the source input location. The source input

location for bulk input files is specified by using the URI parameter fromthe pack XSD file, which you can view by using the Topology Editor.Within the configured file retrieval interval (typically, 5 minutes), the UBAapplication retrieves the bulk input file and copies it to the followingdirectory:<DATA_CHANNEL_HOME>/UBA.<channel_number>.<collector_number>/<instance>/do/

where:


Variable Description

<DATA_CHANNEL_HOME> By default, /opt/datachannel

<channel_number> Specifies the channel number (forexample, 1) that you specified whenyou configured this DataChannel.

<collector_number> Specifies the collector number (forexample, 100) that you specified whenyou configured this UBA bulk collector.

<instance> Specifies the string for the INSTANCESparameter in the pack XSD file.Typically, this string represents thename of the pack and is read-only. Youcan view the string that is specified forINSTANCES by using the Topology Editor.

The UBA application then processes the bulk input file according to theinstructions in the bulk adapter design file.

Note: The first time that the UBA processes a bulk input file, it passes ametric to the CME. The CME rejects the metric as a BAD_METRIC metric doesnot have an associated grouped subelement before this metric is recorded.This is an expected behavior. The CME accepts metrics from the bulk inputfiles after the inventory is run.

b. Ensure that the UBA application can successfully read the bulk input filethat you copied into the source input location, by issuing a tail command.For example,tail -f <DATA_CHANNEL_HOME>/log/proviso.log | grepUBA.<channel_number>.<collector_number>- | more

The following table identifies the success messages that you must look for.

Success message Description

PERF_INPUT_PROCESSING Processed<integer> records in <float> seconds(<float> records/minute): <int> records

Specifies a bulk adapter design filecompletion message. A bulk adapter designfile successfully completes when a similarinformational message displays in the logfile.Success occurs when <int> records equals 0.

METRIC_STREAM_INFO completed writingmetric output:DATA_CHANNEL_HOME/UBA.<channel_number>.<collector_number>/streaming/state/temp/output/<time>.<instance>.NRAW.BOF; wrote <int>metrics; <int> bad resource IDs; <int>bad formula names (#())

Specifies a metric creation success message.The UBA application successfully createsmetrics when a similar debug 2 messagedisplays in the log file.For some technology packs, the metriccreation might be done across differentinstances of UBA applications. Successoccurs when <int> metric is greater thanone, <int> bad resource IDs equals 0, and<int> bad formula names equals 0.

Configuring packs 7

Success message Description

PERF_INVFLUSH Inserted/updated <int>inventory objects in <float> seconds

Specifies an inventory success message. Theinventory successfully completes when asimilar informational message displays inthe log file.If <int> is greater than one, the UBAapplication created or updated at least onesubelement, and the inventory process issuccessful. The log file might record furtherdetails (if necessary) in the messages that areassociated with the PERF_INVFLUSHPVsubelement message category.

8. Run the bulk inventory profile.The UBA application handles the inventory and metrics according to theinstructions provided in the technology pack design file or files. The UBAapplication inserts the created elements, subelements, and metrics into thedatabase. However, the UBA application does not handle the grouping of theseelements and subelements.To handle the grouping of the elements and subelements that were insertedinto the database, UBA technology packs supply a bulk inventory profile. Thisbulk inventory profile is automatically created when the pack is installed. Bulkinventory profiles use the following name syntax:bulk_N

Where:

Syntax item Description

bulk_ Identifies as a bulk inventory profile fora UBA technology pack.

N Specifies the collector number (forexample, 100) that the user specifiedwhen configuring this UBA bulkcollector.

You must use the Inventory Tool to run a bulk inventory profile.To run the bulk inventory profile for this technology pack, perform thefollowing steps:a. At the command prompt where you loaded the DataMart environment,

change your working directory to <$PVMHOME>/bin (/opt/datamart/bin, bydefault) on the DataMart server.

b. Invoke the DataMart GUI by entering the following command and pressingEnter:pvm

c. Click Inventory Tool in the Resource tab. The Inventory Tool windowappears.This window displays a list of the existing inventory profiles on theConfiguration tab. The name of the inventory profile to run is bulk_N,where N is the collector number that is configured for this pack.

d. On the Configuration tab, click the bulk inventory profile for thistechnology pack, and then select Run Profile from the Action menu. The


Live Information tab displays messages about the status of the profile. Formore information about running an inventory profile, see the Configuringand Operating DataMart.

e. Optional: Every time the UBA technology pack design file creates newelements, subelements, and metrics, you must perform the previous steps togroup the elements and subelements. One way to accomplish this taskregularly is to create an entry cron that uses the inventory CLI command.The following example shows an entry cron that periodically performs thegrouping operation for a bulk inventory profile called bulk_100:0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100 -actionpregrouping -reload-noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100 -actiongrouping -reload -noX

For more information about the inventory command, see the CommandLine Interface Reference.

9. Deploy reports.After the technology pack installation completes, the rules for the new deviceare automatically loaded into the database. The inventory process uses theserules to group elements and subelements. You must manually deploy(auto-group) the reports by associating them with groups in the NOCReporting tree in the DataMart Resource Editor.To deploy the Technology Pack reports, follow these steps:a. Open the Tivoli Netcool Performance Manager DataMart Resource Editor.b. Click the Report SE Group tab.c. Move the cursor to the left pane and scroll up to select any group under the

SUB-ELEMENTS > NOC Reporting tree.d. Right-click and select the AutoGrouping option from the menu. The


e. Click Yes to continue.f. Click Close to exit the message box. Or, click Details to view a description

of any errors.g. Optional: Create an entrycron that uses the inventory CLI command and

the -reportGrouping option to deploy reports regularly. The followingexample shows an entrycron that periodically deploys report operation:0 * * * * . /opt/datamart/dataMart.env && inventory -noX -reportGrouping

This option instructs the inventory command to run the report groupingrules and update the deployed reports that are stored in the database.Report grouping rules must be created before this option can be used. Formore information about creating report grouping rules, see the Configuringand Operating DataMart.For more information about the inventory command, see the CommandLine Interface Reference.

What to do next

Verifying resourcesUse the Tivoli Netcool Performance Manager DataMart Resource Editor todetermine whether the following technology pack resources (such as,elements, subelements, and properties) are successfully discovered andcreated in the database during inventory.

Configuring packs 9

For more information about Tivoli Netcool Performance Manager DataMartResource Editor, see the Configuring and Operating DataMart.

Changing predefined threshold requestsIf a technology pack supplies predefined threshold requests. The setupprogram automatically loads these predefined threshold requests into thedatabase and configures them for you. You do not need to activate them,but you can use Tivoli Netcool Performance Manager to change them.

For information about working with predefined threshold requests, see theConfiguring and Operating DataMart.

Verifying resourcesUse the Tivoli Netcool Performance Manager DataMart Resource Editor todetermine whether the technology pack resources (elements, subelements,properties, and so on) were successfully discovered and created in the databaseduring inventory.

For information about using the DataMart Resource Editor, see the Configuring andOperating DataMart.

Configuring technology packs for enabling common reportingTypical configuration steps for technology packs for enabling common reporting.

About this task

After you install the technology pack, perform these steps before you run thecommon pack reports.

Procedure1. Enable user access to Cognos Reporting tree in DataView.

a. Log in to Dashboard Application Services Hub portal.b. Select Administration > User Preferences Management.

1) Select the user profile to access Cognos reports. By default, smadmin.2) Select the Access tab to edit the user access.3) Select Cognos Reporting tree.4) Save the changes.

2. Create a time zone or calendar. For more information, see Aggregation Sets.3. Link a time zone to Cognos Reporting tree.

a. As pvuser, open a terminal.b. Create a file linkGroupTZ.txt. File content format must be as follows:

<Sub-element group>|_|<Calendar type>|_|<Timezone>|_|

For example:Cognos Reporting|_|CME Permanent|_|Greenwich Mean Time|_|

c. Source the DataMart environment by using the following command:source /opt/datamart/dataMart.env

d. Run the following resmgr example command to review timezone to groupassociations:$ resmgr -export segp -colNames "npath cal.name tz.name" –file linkGroupTZ.txt

$ vi linkGroupTZ.txtAnd append the last line


http://www-01.ibm.com/support/knowledgecenter/#!/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/install/ctnpm_installguide_appendixcaggregationsets-12-1.dita

# type = segp# col = npath cal.name tz.name# filter =# order =# sep = |_|# sepRec =# rule =# filterRule =## cmdLine = -export segp -colNames "npath cal.name tz.name"~NOC Reporting|_|CME Permanent|_|Greenwich Mean Time|_|~GMT+1|_|CME Permanent|_|Eastern European Time|_|~GMT-1|_|CME Permanent|_|Azores Time|_|~Moscow GMT+3|_|CME Permanent|_|Moscow Standard Time|_|~CST-6|_|CME Permanent|_|Central Standard Time|_|

e. Run the resmgr command to set the time zone to Cognos Reporting tree asfollows:resmgr –import segp –colNames “name cal.name tz.name” -file linkGroupTZ.txt

Example of output is as follows:

# type = segp# col = name cal.name tz.name# filter =# order =# sep = |_|# sepRec =# rule =# filterRule =## cmdLine = -export segp -colNames "name cal.name tz.name"NOC Reporting|_|CME Permanent|_|Greenwich Mean Time|_|Cognos Reporting|_|CME Permanent|_|Greenwich Mean Time|_|

For more information, see Linking DataView Groups to timezone.

What to do next

Follow these steps:1. As root user, export JAVA_HOME by using the following command:

Export JAVA_HOME=/opt/IBM/WebSphere/AppServer/java/jre/

2. Start the IBM Cognos Configuration window by using the followingcommands:cd /opt/ibm/cognos/c10_64/bin64./cogconfig.sh

3. Click the Restart icon and ensure that the restart process is completed.

Additional configuration steps for certain SNMP technology packsAdditional configuration steps are required for certain SNMP technology packs.

Configuring packs 11

http://www-01.ibm.com/support/knowledgecenter/#!/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/install/ttnpm_installguide_linkingdataviewgroupstotimezones-12-8.dita

Arris CMTS DOCSIS 3.0 Technology PackAdditional configuration steps required for Arris CMTS DOCSIS 3.0 TechnologyPack.

Updating the InventoryHook.sh scriptYou can update the InventoryHook.sh script.

About this task

The InventoryHook.sh script is implemented in Arris CMTS DOCSIS 3.0Technology Pack to perform correlations that cannot be accomplished by using thestandard SNMP formula language. This enriches the properties of DOCSIS 3.0interfaces with ChannelSet and Fibernode property values.

To update the InventoryHook.sh script, follow these steps:

Procedure1. Log in as pvuser (or the user name that you specified during installation) on

the system where DataMart is installed.2. Change your working directory to the DataMart home directory by using the

following command:cd /opt/datamart

By default, the $DATAMARTHOME is /opt/datamart.3. Source the DataMart environment by using the following command:

. /opt/datamart/dataMart.env

4. Enter the following command to open the DataMart GUI:$PVMHOME/bin/pvm

5. Create an inventory profile for Arris CMTS DOCSIS 3.0 Technology Pack withthe name “DOCSIS”.

6. Run the inventory profile. For more information, see Configuring and OperatingDataMart.

7. Back up a copy of InventoryHook.sh file to InventoryHook.sh.bk file if italready exists in the $DATAMARTHOME/bin/ directory.

8. Copy all the scripts from $DATAMARTHOME/APFiles/<Pack_Name>/datamart/bin/to $DATAMARTHOME/bin.

9. Modify the execution mode for all the files that are copied in the previousstep to 755 by using the following command:#chmod 755 <filename.pl>

10. In the InventoryHook.sh file, edit the following:a. Modify $DATAMARTHOME with the DataMart home directory.b. Change the profile name at the beginning of the script

(Arris_CMTS_DOCSIS3_PROFILENAME) to the given inventory profile name(DOCSIS).

c. Modify the nclIdx value. You can retrieve this value from the database byusing the following command:. /opt/datamart/dataMart.env# resmgr -export se -colNames "name nclIdx"

d. Replace the nclIdx value for createChannelSetInventory.pl with thenclIdx value in the second column of <Interface>_DSChset.

e. Replace the nclIdx value for createFibernodeInventory.pl with thenclIdx value in the second column of <Interface>_If.


11. Save the InventoryHook.sh file, and then run the inventory profile again. Youcan see the execution of the scripts in Inventory Profile GUI in theafterdiscovery section.

Enabling CSE featureBefore you proceed to the next steps, ensure that the inventory profile for ArrisCMTS DOCSIS 3.0 is named as “DOCSIS”.

Procedure1. Create inventory profile for composite resources as follows:

a. In the Inventory Tool Wizard, enter the Profile Name as CSE and click Next.b. Select the Automatic Grouping option and click Finish.

Note: Do not select Discovery and Synchronization options.c. Click the Configuration tab and ensure that the CSE profile is created.

2. Run the CSE Engine as follows:a. Run the CSE Engine from Inventory Tool > Actions option.b. In the Resource Editor, click the Sub-Element tab to ensure that the

composite subelement is created.c. Click the Sub-Element Group tab and select SUB-ELEMENTS > NOC

Reporting > Composite Docsis 3.0 in the left navigation pane. Verify thegrouping.

d. In the left navigation pane, select the composite subelement from theComposite Docsis 3.0 folder to ensure that relations are created between thecomposite and the interfaces.

3. Run the inventory profile CSE as follows:a. Click the Run icon to run the profile.b. In the Resource Editor, click the Sub-Element Group tab and select

SUB-ELEMENTS > Sub-Element Collect > Composite Docsis 3.0 in the leftnavigation pane. Verify the grouping.

c. In the left navigation pane, select the composite subelement from theComposite Docsis 3.0 folder to ensure that relations are created between thecomposite and the interface.

d. Next, click Action > Report Grouping for relations between the compositeand the interfaces.

4. Update ECMA formulas as follows:a. Log in as pvuser.b. Change the directory by using the following command:

cd /$PVMHOME/APFiles/arris_cmts_docsis/datachannel/scripts

c. Copy the files by using the following command:cp -r arris_cmts_docsis/ /$DC_HOME/scripts/

d. Change the directory by using the following command:cd /$DC_HOME/scripts/arris_cmts_docsis/cse

e. Source the datachannel.env by using the following command:source /$DC_HOME/datachannel/dataChannel.env

f. Load the formulas and labels with frmi tool by using the followingcommand:frmi -doc /$DC_HOME/scripts/arris_cmts_docsis/cse/docsis.js -labels/$DC_HOME/scripts/arris_cmts_docsis/cse/labels.txt

5. Install Cross Collector CME (CME.1.2000) if it is not installed.


a. Add Cross-Collector CME to topology and run Deployer to updateconfiguration.

b. Stop all DataChannel components as follows:1) Open a terminal emulator on the DataChannel server.2) Use the dccmd command to stop all DataChannel applications:

dccmd stop all

3) Use the dccmd command to release all daemons that run in theDataChannel:dccmd forget all

4) Use the following command to find the process identifiers (pids)associated with the DataChannel visual processes:<DATA_CHANNEL_HOME>/bin/findvisual

Where:<DATA_CHANNEL_HOME> is /opt/datachannel, by default.

5) Use the following commands to stop each DataChannel visual process:kill -9 <cnsw_pid>kill -9 <logw_pid>kill -9 <amgrw_pid>kill -9 <cmgrw_pid>

Note: The logw is a Java process and must to be killed by using ps -ef|grep LOG, and then kill the logw process ID.

6) Use the following commands to restart each DataChannel visualprocess:cnswlogwcmgrwamgrw

7) Remove the PBL folder by using the following command:mv PBL PBL_backup

8) Use the dccmd command to start all DataChannel applications:dccmd start all

9) Use the dccmd command to verify that all of the DataChannelapplications started properly:dccmd status all

10) PBL restarts the Cross-Collector CME, when needed.

Cisco CBQoS Technology PackAdditional configuration steps required for Cisco CBQoS Technology Pack.

Losing indexes after device rebootsAfter a network device reboot, repolling is required.

After a network device reboot, the CISCO-CLASS-BASED-QOS-MIB must berepolled to re-establish the following indexes:v cbQosConfigIndex

v cbQosPolicyIndex

v cbQosObjectsIndex


Repolling is required because a reboot can cause the order of the Modular Qualityof Service (QoS) Command-Line Interface (CLI) (MQC) configuration to differ fromthe actual configuration order, which is user-driven and unpredictable.

Traditionally, MIB persistence is handled by Cisco IOS APIs, which save the indexand key information to NVRAM. The data is then retrieved and repopulated afterreloading. However, this approach does not work well for the currentimplementation of the cbQosObjectsIndex because of the large amount ofinformation that needs to be saved.

An index encoding scheme that is based on configuration entries instead ofoperational sequence is implemented to provide persistent indexes on router reloadso that MIB information retains the same set of object values each time anetworking device reboots.

You might want to configure networking devices to use the QoS: CBQoS MIBIndex Enhancements feature.

Customizing Discovery resultsYou can customize the results of the Discovery formulas.

The properties of the following subelements are merged with and display asproperties of the CB QoS Class Map subelement:v CB QoS Queueing Actionv CB QoS Police Actionv CB QoS Traffic Shaping Action

By modifying the cbqos_object_id_mv.pl script, it is possible to customize theresults of the Discovery formulas and to fill the indexes that are associated withthe QueueID, PoliceID, and ShapeID properties.

Attention: Edits to the scripts described in the following sections must be doneunder the guidance of IBM Professional Services.

Customizing InventoryAppPack.sh:

The InventoryAppPack.sh script is configured to perform Cisco QoS-related steps.

About this task

The InventoryAppPack.sh script is a generic script. It resides in the<$PVMHOME>/conf directory. It contains processing logic for a number of technologypacks and is configured to perform Cisco QoS-related steps as follows:

Procedure

1. Determines whether the ProfileName, CollectorNumber, and DirProfileparameters are passed to it by InventoryHook.sh. If so, it assigns the parametervalues to internal variables. If not, it generates a failure message and exits.

2. Determines whether the TaskName parameter evaluates to AfterDiscovery. Ifnot, it generates a failure message and exits.

3. Determines whether the ProfileName parameter evaluates to Cisco_QoS. If not,it generates a failure message and exits.

4. Passes the following files to cbqos_object_id_mv.pl:


a. $DirProfile/inventory/subelement_invariant.dat – An input file thatcontains index values, which are associated with the QueueID,PoliceID, andShapeID properties.

b. $DirProfile/inventory/subelement_invariant.dat_mod – An output file towhich cbqos_object_id_mv.pl writes the results of its index substitutionoperations.

5. Waits for cbqos_object_id_mv.pl to process the files and generates anappropriate message if cbqos_object_id_mv.pl returns successfully. Otherwise,it generates a failure message and exits.

6. Copies subelement_invariant.dat to a backup file calledsubelement_invariant.dat.orig.

7. Moves subelement_invariant.dat_mod to a file namedsubelement_invariant.dat. This overwrites the input file that was backed up inthe previous step.

Customizing cbqos_object_id_mv.pl:

How to customize the cbqos_object_id_mv.pl script.

About this task

The cbqos_object_id_mv.pl script is in the <$PVMHOME>/bin directory. It reads theinput file, performs a substitution procedure, and writes the results to the outputfile. The substitution procedure assigns index values to the QueueID, PoliceID, andShapeID properties so that these properties are assigned to the CB_QoS Class Mapsubelement.It uses the following steps:

Procedure

v Determines whether the input (subelement_invariant.dat) and output(subelement_invariant.dat_mod) files were passed to it by InventoryAppPack.sh.If not, it generates a failure message and exits. Otherwise, it opens both files forprocessing.

v Searches the input file for the strings QueueID, PoliceID, and ShapeID, and thenstores their associated index values in three internal variables. It then searchesfor the strings <P1>, <S1>, and <Q1> and replaces them with the stored indexvalues.

v Prints the results to the output file (subelement_invariant.dat_mod). (If nosubstitution is performed, it prints no results to the output file).

v Closes both files and returns the results to InventoryAppPack.sh.v Configure the cbqos_object_id_mv.pl script by giving the following commands:

dos2unix/opt/datamart/APFiles/cisco_cbqos/datamart/bin/cbqos_object_id_mv.pl > /tmp/tempmv /tmp/temp /opt/datamart/bin/cbqos_object_id_mv.pl

v To change the file permissions for the script files, run these commands:chmod 777 /opt/datamart/bin/cbqos_object_id_mv.plchmod 777 /opt/datamart/conf/InventoryAppPack.sh

Note: If the ProfileName parameter evaluates to Cisco_QoS, you must use thesescripts.


MIB-II Technology PackAdditional configuration steps required for MIB-II Technology Pack.

Install StepsAfter the installation of technology pack, the following installation steps are to beperformed for improved UI consistency with Netcool in a Tivoli Integrated Portalconsole. These steps are applicable for installation on Tivoli Netcool PerformanceManager 1.4.

About this task

To update corporate logo, follow these steps:

Procedure1. Export the existing DataView contentv Location

– <jazzsm_location>/products/tnpm/dataview/legacy/bin

v Syntax– export.sh -dashuser <dashuser> -dashpassword <dashpassword>

v Parameters– <dashuser>

The user name used to connect to Dashboard Application Services Hub .– <-dashpassword>

The password used to connect to Dashboard Application Services Hub.2. Back up the existing files, which are modified by this procedurev Logo

– Location- <jazzsm_location>/products/tnpm/dataview/legacy/content/SilverStream/

Objectstore/Images

– Syntax- mv logo_yournamehere.gif logo_yournamehere.gif.save

3. Copy the updated artifactsv Logo

– Source- <$PVMHOME>/APFiles/<techpack>/tip/logo_yournamehere.gif

– Destination- <jazzsm_location>/products/tnpm/dataview/legacy/content/SilverStream/

Objectstore/Images

– Syntax- cp <$PVMHOME>/APFiles/rfc_mib2/tip/logo_yournamehere.gif

<tip_location>/products/tnpm/dataview/legacy/content/SilverStream/Objectstore/Images

4. Import the updated artifactsv Location

– <jazzsm_location>/products/tnpm/dataview/legacy/bin

v Syntax– import.sh -dashuser <dashuser> -dashpassword <dashpassword>


The user name used to connect to Dashboard Application Services Hub.


– <dashpassword>

The password used to connect to Dashboard Application Services Hub.

Note: Though CSS files are dynamically downloaded and applied by thebrowser, you must clear the browser cache to enable these changes.

Uninstall StepsFollow the uninstall steps to revert the corporate logo to the default versions.

Procedure1. Restore the original files from backupv Logo

– Location-

<jazzsm_location>/products/tnpm/dataview/legacy/content/SilverStream/Objectstore/Images

– Syntax- – import.sh -dashuser dashuser-dashpassword dashpassword

2. Import the original artifactsv Location

– <tip_location>/products/tnpm/dataview/legacy/bin

v Syntax– import.sh -dashuser <dashuser> -dashpassword <dashpassword>


The user name used to connect to DASH– <dashpassword>

The password used to connect to DASH.

Note: Though CSS files are dynamically downloaded and applied by thebrowser, you must clear the browser cache to enable these changes.

Additional configuration steps for certain UBA Technology PacksAdditional configuration steps for certain UBA Technology Packs.

Alcatel-Lucent SAM 5620 LogToFile Technology PackAdditional configuration steps required for Alcatel-Lucent SAM 5620 LogToFileTechnology Pack.

Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology PackoverviewThe LogToFile feature is added to the SAM server to allow downstream systems toretrieve metric data as it arrives and without any filtering. The data is fed to thedownstream systems in a streaming fashion. The downstream system must do thefiltering with caution and as necessary.

In the earlier releases of Alcatel-Lucent 5620 SAM Technology Pack, FindToFile isused to obtain the metric data from SAM Server for any time period you want.Though this feature is convenient, FindToFile feature adds extra computationalburden to the SAM Server. The new LogToFile feature relieves the SAM server ofthe burden of querying and filtering for the subset of data that the downstreamsystem needs.


Differences between LogToFile and FindToFile technologies:

Alcatel-Lucent 5620 SAM LogToFile Technology Pack supports the LogToFiletechnology and Alcatel-Lucent 5620 SAM Technology Pack comes with FindToFiletechnology. These are some of the differences between the LogToFile andFindToFile technologies.

Architecture of FindToFile technology for collecting network elements fromSAM server

Architecture of LogToFile technology for collecting network elements from SAMserver


Table 1. Differences between Alcatel-Lucent 5620 SAM Technology Pack and Alcatel-Lucent5620 SAM LogToFile Technology Pack

FindToFile LogToFile

FindToFile technology uses two componentsfor collecting data from SAM server with thehelp of multi-point JMS connection interface.

SAMIF componentThis component is responsible forfetching the inventory data fromSAM server.

BLB componentBLB component: This component isresponsible for fetching metric datafrom SAM server. Output of theSAMIF and BLB components aregiven as input to the UBA.

LogToFile technology uses IBM InfoSphereDataStage that replaces the SAMIF and BLBcomponents. The DataStage output is fed asinput to UBA. Therefore, processing ofinventory and metric data is done by UBAonly. In LogToFile the connection to theSAM server is with the help of a singlepoint JMS connection interface.

FindToFile technology adds extracomputational burden to the SAM Server.

LogToFile technology relieves the SAMserver of the burden of querying andfiltering for the data subsets.

XML files are given to UBA for processing. CSV files are given to UBA for processing.

With FindToFile technology, there is a limiton adding the collectors in Tivoli NetcoolPerformance Manager as the collector itselfmakes a connection with the SAM server sothat the number of collectors is directlyproportional to the number of connections tothe SAM server.

There is no limit to add collectors in TivoliNetcool Performance Manager for LogToFiletechnology as there is only one connectionthat is made to SAM server via theDataStage.

The number of XML files that are created isbased on the number of metric classes.

DataStage produces one file per UBA perperiod. The record types in the incomingCSV files are heterogeneous. The inventorydata is added to the CSV only when there isa full dump or JMS inventory message isreceived.

UBA structure:

An array of UBAs is divided into UBAs for accounting and performance. There canbe multiple UBAs. However, the UBAs must be in a set of accounting andperformance. These UBAs processes the inventory and metric data that ispresented to them by IBM InfoSphere Information Server DataStage.

The metrics (XML files) and inventory (XML files/JMS messages) from the SAMserver are parsed by DataStage and converted to CSV files for the UBAs. DataStageproduces one file per UBA per period.

The record types in the incoming CSV files are heterogeneous. The inventory datais added to the CSV file only under the following conditions:v When there is a full dump.v When a JMS inventory message is received.

Alcatel-Lucent 5620 SAM LogToFile Technology Pack model:

In the previous versions of Alcatel-Lucent 5620 SAM Technology Pack, the SAMIFand BLB communicate directly with SAM server. SAMIF acquires and processes


inventory via bulk transfer (full dump) and JMS messages (changes). BLB issuesperiodic FindToFile web requests for metric data and acquires that data over SFTPand makes it available to the UBAs.

SAMIF communicated via JMS, web requests, and SFTP to acquire and processinventory. The BLB communicated via web requests and SFTP to export andacquire bulk metric data files. One UBA processes performance metrics andanother UBA processes accounting metrics. This design does not accommodatemore than two UBAs.

In the current design, SAMIF and BLB are removed and IBM InfoSphere DataStageis used to interface with the SAM server by using JMS, web requests, and SFTP.You can have an array of UBAs that are divided into UBAs for accounting metricsand UBAs for performance metrics.

In Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack, DataStageinterfaces with the SAM server and provides metric and inventory data to theUBAs. Rather than having a separate component to process inventory for the entiresystem, inventory is processed inline by the UBAs. DataStage performs thefollowing functions:v Acquires and processes inventory and metrics from SAM in XML format.

Note: The two types of XML files that must be parsed are; JMS, web requestsand statistics XML files. The data from the XML files is parsed to<Name><Value> pairs.

v Filters the inventory and metric data. This function was previously handled bySAM server.

v Partitions data to a UBA pair. These partitions are done by first looking atexisting resource and collector mapping. If the mapping is not available, then ituses its own hash partitioning engine to assign the resource to one of theavailable UBAs with overriding option.

v Waits for complete data for a window period.v Merges metrics and inventory into one CSV file per window period for each

UBA.

This data partitioning process can be shown as in the following diagram:

Related concepts:Hash partitioningHash partitioning is based on a function on a column in each record, which is thehash partitioning key or hash key field. Records with the same value for hash keyfield are assigned to the same UBA pair.


Period window handlingTypically, Tivoli Netcool Performance Manager collects and performs computationson data in a streaming fashion. It makes the arrival of data sensitive to processingwindow. After the processing window slides to new period, any data that has anearlier timestamp is dropped.

Data collection model:

Alcatel-Lucent 5620 SAM LogToFile Technology Pack manages the performanceand accounting metrics for the network infrastructure.

DataStage parses the XML files and JMS messages from the SAM server andtransfers the data to the UBAs as CSV files. DataStage produces one file per UBAper period. These XML files contain records of inventory and metric data. Theinventory and metrics data are in the CSV format, with an initial integer identifierthat specifies a record type, and the subsequent fields contain the actual data of therecord.

The incoming CSV files are processed by a single input schema in the UBA. Therecord types in the incoming CSV files are heterogeneous. For more informationabout the file formats, see “Bulk input file formats” on page 35.

Figure 1. Data collection model for the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack


The UBAs handle processing of both inventory and metric data. Any number ofUBAs can be configured to handle this process with each UBA designated either asaccounting UBA or performance UBA. The number of UBAs are best scaled up toload.

These XML files are then collected and processed, with the results presented in aset of web-based reports. These reports are listed and described inAlcatel-Lucent5620 SAM LogToFile 2.5.0.0 Technology Pack Reference.

InventoryThe Alcatel-Lucent 5620 SAM LogToFile Technology Pack contains anobject database that represents the network resources and theirrelationships to other network resources. It also represents some abstractresources and relationships. Services and their subscribers are representedalong with their relationships to each other and to the Service Access PointQueues.

MetricsDataStage periodically receives the metrics file. The DataStage is notifiedon every period about the metrics file availability. The SAM statistics arethen passed to the UBA for parsing and processing into Tivoli NetcoolPerformance Manager metrics.

Figure 1 shows that the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 TechnologyPack manages the inventory of the resources and metrics, real, and abstract, in twoways:v Complete data collection for inventoryv Event-driven data collection for inventory

Complete data collection

In the complete data collection, DataStage sends XML requests to theAlcatel-Lucent 5620 SAM server for each SAM object type that is needed torun the inventory and metric data collection. Specifically, the request is forXML files that contain information about all instances of that object typeand metrics. The requests from DataStage specify result filter of propertyvalues that are returned for each SAM object type. This filter operationlimits the set of property values to the values that matter to the technologypack inventory.

DataStage partitions the data based on IP address and other informationfrom Proviso database and merge metrics and inventory into one CSV fileper period per subchannel that is then delivered to the UBAs in CSVformat.

When the inventory and metrics are in separate bulk input files (as is thecase in the Alcatel-Lucent 5620 SAM environment), a technology packdeveloper typically implements several types of bulk adapter design files,as described in “Bulk adapter design files” on page 36.

Event-driven data collection for inventory

The Alcatel-Lucent 5620 SAM LogToFile uses the JMS to view real-timeevents and alarm feed information from the managed network. For moreinformation, see the Alcatel- Lucent 5620 SAM-O OSS Interface DeveloperGuide. DataStage establishes a JMS connection with SAM to receiveinventory updates and notices of metric data file availability. SAM JMS


client daemon listens for JMS messages from SAM and passes them toApache ActiveMQ queue. DataStage job reads the messages from thequeue and processes them.

Note: Alcatel-Lucent 5620 SAM-O is an open interface on theAlcatel-Lucent 5620 SAM. An OSS client application can access informationthrough the Alcatel-Lucent 5620 SAM-O.Figure 1 shows that in the event-driven inventory, DataStage processes JMScreate, delete, and update messages.

DataStage synchronizes the partition information based on IP addressesand subchannel affiliations from Tivoli Netcool Performance Managerdatabase on start. For newly encountered elements, the data goes throughthe Hash Partitioning to be assigned with a collector number. It is notnecessary for DataStage to write the element to the Tivoli NetcoolPerformance Manager database. The UBAs generate the elements and otherinventory. By default, in new deployment scenario, when the TivoliNetcool Performance Manager database has no resource information, alldata goes through the Hash Partitioning.

However, it is possible through configuration to restrict the assignedsubchannels to a subset of the accounting or performance subchannels.This is favorable in the event when one subchannel starts to reach itsmaximum capacity. In addition, the user might explicitly override thesubchannel affiliation for individual partition keys. When a network haslarge number of devices, you might want to ensure that they aredistributed across the available subchannels. Metrics and inventory aremerged together and appended to a file destined for a subchannel with thepartition key that determines the destination subchannel. After theresources are available in Tivoli Netcool Performance Manager database,the CFGs that are used for the planned distributions are not significant asthe database information takes precedence.

In LogToFile context, availability of a metric file is notified to theDataStage through JMS connection. DataStage then retrieves the file.DataStage uses SFTP connections for multiple downloads rather thanestablish new connections for every download.

DataStage also establishes a JMS connection with SAM to receive inventoryupdates, file available messages and control messages. The JMS process isrunning continuously. The Monitor stage in job periodically checks andrestarts the JMS daemon if the daemon is not running. Monitor Stageconstantly checks for the Keep Alive event to ensure that the connection isconsistent with the SAM Server. JMS daemon buffers messages and passesthe messages to DataStage.

DataStage also processes the full inventory dump by using the existingFindToFile web requests. Full dump on inventory is run on need basis.There is an automated full dump on start. Warnings can be found in thelogs that show missed JMS messages. These warnings can be monitored toinitiate a full dump if required.

Finally, DataStage requires that all inventory update messages haveinformation to help determine the partition key value. DataStage requiresthe partition key value to determine to which subchannel an inventoryupdate must be routed.


Components in DataStage job workflow:

The DataStage job is designed to handle real-time data that is flowing in as low as5 min interval. DataStage provides pipelining feature where output processed datawhile there is still incoming data.

Job design overview

A job consists of stages that are linked together, which describe the flow of datafrom a data source to a data target (for example, a final data warehouse). A stageusually has at least one data input or one data output. However, some stages canaccept more than one data input, and output to more than one stage.

DataStage wave generator is used for handling the job. There is a need todetermine end-of-wave or end-of-data marker on every interval for some stages tostart processing the data. For example, Sort stage and Aggregator stage. Sort stagecannot work when the data is still incoming data. To handle this, an end of wavemarker is generated on every interval. End-of-wave indicates that the data can bepushed to the next level.

Various components of data collection and their functions are as follows:

JMS Client Poller

The process for handling the data by the job is as follows:v JMS Client Poller stage is an ActiveMQ queue poller. It reads all SAM JMS

messages and JMS MapMessages from JMS Client daemon. There are two specialmap messages:– action/WAVE, output as “WAVE”– action/DONE, output as “DONE”

v The JMS Client Poller passes all the output messages through Wave Generatorstage without parsing them. Parsing is done at the DataStage.

v Wave Generator inserts an end-of-wave marker on every WAVE message.v A HeartBeat is sent by the monitor stage.

Note: Both the JMS Client Poller and Wave Generator stage work sequentially.

Web services

Request string is passed as input and SAM web service response is the output ofthis stage. The web services issue:v Full dump requestsv Register LogToFile requestsv Register sasLogToFile requestsv FindToFile requests (For special inventory classes)

Note: A CSV file contains a web service type and web service request. The webservice requests are as follows:v deregisterLogToFilev deregisterSasLogToFilev fullDumpv registerLogToFile


v registerSasLogToFilev findToFile

Apache ActiveMQ

ActiveMQ is responsible for:v Buffer message for JMS Poller, is backed by disk storage.v Polled by JMS poller to get messages.

Filter elements

Two types of SAM class filters are available. The filters are as followsv Properties filter

This is done with the help of resultFilter option that is available both on theregisterLogToFile and the findtToFile web services. The result filter isconfigurable as part of individual class request that is specified in theconfiguration file.

v Object filterReduces the SAM server load. This filter implementation involves filterconfiguration file. The configuration items are as follows:– Class name (Key)– Expression (Evaluation)

Related information:

Stages

Wave Generator stage page - General tab

Load balancing in Alcatel-Lucent 5620 SAM LogToFileTechnology PackTo improve performance for configurations that produce large numbers of datafiles and require multiple UBAs, the Alcatel-Lucent 5620 SAM LogToFileTechnology Pack provides a Load Balancing mechanism.

Alcatel-Lucent 5620 SAM LogToFile Technology Pack uses a load balancingalgorithm that is ready for immediate use called hash partitioning.

Data partitioning:

Data partitioning involves identifying the classes (inventory and metric classes)and identifying the partition key for each class and distribute data based on thiskey. Typically, this key is an attribute that has an IP address as its value.

Partitioning strategy

Partitioning strategy is a way to scale up or scale out the processing that is basedon the data volume requirements. DataStage has a built-in capability to scale upand use the number of CPUs that are available in the system. Therefore, a singleDataStage job that interfaces with the SAM Server is able to scale to match the datavolume requirements.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.ds.design.doc/topics/c_ddesref_Stages.html

http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.ds.design.help.doc/topics/wavegen.html

Each UBA is associated with fixed CPU processing that does not scale up.Therefore, when partially processed data is transferred from DataStage job to UBApair for further processing, multiple instances of UBA pairs might be required tohandle the load.

Partitioning in Alcatel-Lucent 5620 SAM LogToFile Technology Pack is achieved inthe following ways:v Partitioning that is based on resource mapping that is available in Tivoli Netcool

Performance Manager database.v Partitioning that is based on hash partitioning algorithm.v Partitioning that is based on manual collector resource mapping in the

collector_mapping.csv configuration file.

DataStage handles the data partitioning for UBA pair as follows:v On start-up, the DataStage job collects all resources from the Tivoli Netcool

Performance Manager database, their partition keys, and the assigned collectors.Each record that DataStage collects are cross-checked against this look up list toidentify which collector the record must be passed on to.

Note: A unique collector id is assigned to each UBA. Therefore, the termcollector and UBA are used interchangeably.

v If a record does not have a collector mapping, for example, a new resourcerecord, the DataStage automatically assigns a UBA pair for the record by usinghash partitioning.

v The hash partitioning algorithm distributes the resources across UBA pairs. Inthis distribution, there is a possibility for a single collector to be over loaded. Insuch a scenario, this collector mapping can be overridden by manuallyidentifying the resources that are tied to an overloaded collector. Update theresource information in the collector_mapping.csv file by manually assigningthe resources to specific collectors, and the resources must be removed from theTivoli Netcool Performance Manager system. The DataStage job must berestarted.You can generate the collector mapping from subelements and elements asfollows:– From subelement, take the familyName, elementName name-value pair. You

can get the familyName for each record from its className.– From element, take the elementName and collector.– Join the subelement and element by elementName.– Identify collector by matching familyName and key value against the

collector mapping from Tivoli Netcool Performance Manager.

This information is written to the collector_mapping.csv file as familyName,value, collector. For example:5620_SAM_AingrAengrQueue, 35.121.20.24, 101

Related tasks:Distributing the existing load in new subchannelsWhen you want to provision an existing element and you have the load balancingcriteria, you can specify the family, IP address of the element and collector ID itmust be mapped to in the collector_mapping.csv file. Data partitioning or loaddistribution is done at the network element (NE) level.


Avoiding the subchannel overloading for inventoryTypically, the load balancing algorithm works on total number of networkelements. The new and existing elements are assigned to the available collectors byusing hash partitioning. The hash partitioning can be overridden by modifying thecollector_lookup.csv file.

Hash partitioning:

Hash partitioning is based on a function on a column in each record, which is thehash partitioning key or hash key field. Records with the same value for hash keyfield are assigned to the same UBA pair.

This method is useful for ensuring that related records are in the same partition,which is a prerequisite for UBA operation. Although the data is distributed acrosspartitions, the hash partitioner ensures that records with identical keys are in thesame partition that allows access to all its related historical processed information.

Hash partitioning does not necessarily result in an even distribution of databetween partitions. The hash partitioning model that is used in Alcatel-Lucent 5620SAM LogToFile Technology Pack is called as CRC32. Any string or alphanumericcharacter that is passed through the hash partitioning model results in a 32 bit longinteger value that are distributed to be able create logical boundaries by number ofavailable UBAs and to assign each range for a particular UBA pair.

For example, if you hash partition a data set based on an IP address value, thehashed value might be crc32(X), where X is an IP address.

Note: Typically, IP address is the best record partition key. Following class fields inAlcatel-Lucent 5620 SAM LogToFile Technology Pack contain IP address:v siteIdv nodeIdv fromNodeIdv toNodeId



Partition (database)

Cyclic redundancy check

Window period:

Typically, Tivoli Netcool Performance Manager collects and performs computationson data in a streaming fashion. It makes the arrival of data sensitive to processingwindow. After the processing window slides to new period, any data that has anearlier timestamp is dropped.

There are two ways of tuning the data collection process:

Improving confidenceConfidence is a measure of making sure that all records within atimestamp or period are received. Increase in confidence levels results inminimizing the data loss.

Reducing latencyLatency is a measure of delay between receiving a record and performingcomputations on it for storage. Reducing the latency results in faster datarefreshes and more real-time data. Reducing the latency can facilitate fasterdata refreshes and more near real-time data but the late data is lost.

In LogToFile solution, tuning depends on data arrival patterns and requirements. Ifall data arrives in a fixed pattern and predefined duration, then the windowprogress can be tuned to the duration. If the incoming data pattern is not fixed andlate data comes after long delays, then the decision can be made to delay thewindow progress. Or, take middle approach to wait for most of the data to arrivewith a calculated risk for late data to get dropped.

Note: LogToFile window progress is designed to work independently forPerformance and Accounting, so that the tuning can be done individually for each

Figure 2. Records distribution by using hash partition that is based on random IP addresses for 1000 elements


http://en.wikipedia.org/wiki/Partition_%28database%29#Partitioning_criteria

http://en.wikipedia.org/wiki/Cyclic_redundancy_check

of these types; PERFORMANCE_WAIT_DURATION or ACCOUNTING_WAIT_DURATION.You must understand the following concepts to create the best configuration toyour environment:

Waves

As in Alcatel-Lucent 5620 SAM LogToFile architecture, DataStage LogToFilejob uses real-time features. The job is “always on” for maximum efficiency.The “always on” job continuously reads data from a real-time source.DataStage job works as follows:1. When the job starts up, it does all required initialization with SAM

server and Tivoli Netcool Performance Manager.2. Job waits for JMS notification to decide what to process.3. Job needs to inject logical end-of-data in order for the job to use current

set of JMS notifications.End-of-data function puts records into distinct groups, called WAVES.Monitor stage periodically sends WAVE message through internalApache ActiveMQ, the same message queue that feeds other SAM JMSnotifications to the job. A WAVE_PERIOD parameter is to control thefrequency of WAVE messages. The default interval is 5 minutes (300seconds). The possible reason to reduce this value is to improveresponsiveness or processing granularity.

4. Job repeats the steps 2 - 3 while the job is running.

Note: The wave period is the smallest denominator for all otherwindow-related parameters; WINDOW_PERIOD, PERFORMANCE_WAIT_DURATION,and ACCOUNTING_WAIT_DURATION.

Window period

In LogToFile technology, the DataStage has its own window handling. Thesubsequent processing components such as UBA and CME are strict streamprocessing that drops the data that does not comply with timestampprogression. Therefore, DataStage LogToFile Job introduced its ownwindow handling to manage data by grouping based on the originatingtimestamp. You can also provide parameters to configure according to yourrequirements.

The WINDOW_PERIOD configuration that is the length of time that is requiredto group a set of data before it slides to next period. For example, if thewindow period is configured to 15 minutes (900 seconds) and the currenttimestamp is 1:00:00 AM to 1:14:59 AM. After the window is progressed, allthe data that is collected and grouped by the period is written to a CSVfile and the next timestamp 1:15:00 AM to 1:29:59 AM is made the currenttimestamp.

Note: Current window does not have any correlation to the current wallclock time.

Records that are received with older than current window timestamp getdropped while records with future timestamps are buffered until thewindow period is active.

WINDOW_PERIOD configuration applies for both Performance and Accountingdata. However, these periods are maintained separately for Performanceand Accounting. For example, for a WINDOW_PERIOD that is set as 15minutes, current Performance window might be from 2:00:00 AM to 2:14:59AM, while Accounting is still at 1:00:00 AM to 1:14:59 AM.


Wait duration

Explains the behavior of PERFORMANCE_WAIT_DURATION andACCOUNTING_WAIT_DURATION. These parameter values are set in seconds andit is the amount of time the DataStage waits for data on the period beforeit progresses to the next window. This duration can be depicted in numberof waves. For example, if the wait period is set to 10 minutes (600seconds), and WAVES set to the default value of 5 minutes (300 seconds),number of waves is equal to wait period or wave. That is, 600/300 is equalto two Waves. The window period progresses only if the DataStage jobdoesn't receive any new data for the period for exactly two waves.Otherwise, the count is restarted. See the following scenarios:

Figure 3. Scenario 1: Wait increases when no new data is coming on subsequent waves.


Inventory dataThe inventory data is a special data that does not bound to streamingrules. Inventory data has the following processing properties:v Even the data with older timestamps that passed the window periods

does not get dropped and the data is inserted current window period.v Wait duration is not applicable for this data. Therefore, the window

period does not progress.

Note: The inventory data alone does not produce CSV files, there must beaccompanied metrics data for window period to progress and eventuallygenerate CSV files.

Mix periods:

Mix period refers to polling interval that is configured at SAM server that is notuniform across all SAM classes. For example, Accounting SAP class might beconfigured at 15-minutes interval while Network Queue is set to 30 minutes.

In such a scenario, the WINDOW_PERIOD must be set to the biggest interval, that is 30minutes in this case. If the WINDOW_PERIOD is set to the smallest interval; 15 minutes,this value matches the SAP class.

Consider the scenario where the current window is 1:00:00 AM to 1:14:59 AM, after15-minutes wait completes, CSV file is produced that contains 1:00:00 AM to1:14:59 AM SAP data. As window progresses from 1:15:00 AM to 1:29:59 AM, both

Figure 4. Wait count restarts when new data comes on subsequent waves.


SAP and Network Queue are processed, for SAP class, complete data for theperiod is collected and written to CSV but for the Network Queue class, therecords it received are from 1:00:00 AM to 1:29:59 AM. Therefore, all records withtimestamp before 1:15:00 AM are dropped.

When window period is set to biggest interval and after every window progress,CSV files are produced with a single data set of biggest interval and multiple datasets of smallest interval. This configuration is to have a better granularity reportfor certain SAM classes at the same time not to overload the underlying systemprocessing for other classes.

Restriction: This configuration is useful when you want a higher collectionfrequency to obtain detailed reporting. However, this configuration might notimprove latency. If you want to achieve minimum latency at higher collectionfrequency, then you must increase the collection period for all the metrics classes.Ensure that you have adequate system resource capability.

The following configurations are required on DataStage based on this example:

Parameter Value

WINDOW_PERIOD 1800

WAVE PERIOD (DataStage heartbeat) 300

ACCOUNTING_WAIT_DURATION 300Note: The default value.

PERFORMANCE_WAIT_DURATION 300Note: The default value.

Configurations that are required on Tivoli Netcool Performance Manager:v All UBA FILE_PERIOD (polling period) must be same as WINDOW_PERIOD.v Request Editor must be configured with the metrics period same as polling

period set in SAM Server.

Note: The Topology Editor FILE_PERIOD parameter must be the same as theWINDOW_PERIOD, in this example, it is 30 minutes.

Devices and servicesDetails about Alcatel-Lucent SAM 5620 LogToFile server compatibility, supporteddevices, Alcatel-Lucent SAM 5620 LogToFile services, data collection model, bulkinput file formats, and bulk adapter design files.

Alcatel-Lucent 5620 SAM server compatibility:

Currently, the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack runs onthe Alcatel-Lucent 5620 SAM Server Release 10 and Release 11.

Supported devices:

The list of devices that are supported by the Alcatel-Lucent 5620 SAM LogToFileTechnology Pack depends on the version of the technology pack.

Devices supported in this release

The Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack supports thefollowing devices:


v Alcatel-Lucent 7750 Service Routerv Alcatel-Lucent 7710 Service Routerv Alcatel-Lucent 7705 Service Aggregation Routerv Alcatel-Lucent 7450 Ethernet Service Switchv Alcatel-Lucent 7210 Service Access Switchv Alcatel-Lucent OmniSwitch 6850v Alcatel-Lucent OmniSwitch 6250v Alcatel-Lucent 7750 MGv Alcatel-Lucent 9471 WMMv Alcatel-Lucent 9500 MPR

For more information about these devices, see http://www.alcatel-lucent.com.

How the devices are supported

The Alcatel-Lucent 5620 SAM LogToFile Technology Pack supports these devices inthe following ways:

Defines data generation, data storage, and data collection methodsThe Alcatel-Lucent 5620 SAM LogToFile Technology Pack communicateswith the device through the SOAP/XML interface, and uses JMS fornotification of inventory changes. For more information about theSOAP/XML interface and other components that are associated with thedata collection model, see “Data collection model” on page 22.

Defines Tivoli Netcool Performance Manager propertiesThe Alcatel-Lucent 5620 SAM defines and manages all of the relevantobjects that are associated with the device in the Alcatel-Lucent XML-basedequipment package. The Alcatel-Lucent 5620 SAM LogToFile TechnologyPack maps the appropriate set of SAM object properties that are defined inthe equipment package to Tivoli Netcool Performance Manager properties.Typically, the Netcool Performance Manager property name is the same asthe SAM object property name, except that the Netcool PerformanceManager property name also has the prefix sam. For information about theproperties that are currently supported by the Alcatel-Lucent 5620 SAMLogToFile Technology Pack, see the IBM Tivoli Netcool Performance Manager:Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack Reference.

Alcatel-Lucent 5620 SAM LogToFile services:

Alcatel-Lucent 5620 SAM users can configure services such as VPRN, VPLS, andcustomer or subscriber sites to the core network at the SAPs.

A user might also configure a set of policies to manage different classes of traffic atthe SAPs. A SAP can have one policy that is applied for ingress traffic, and anotherfor egress (to the customer site). Alcatel-Lucent 5620 SAM has a predefined set ofeight traffic classes:

bel2afl1h2efh1


http://www.alcatel-lucent.com

nc

In addition, the Alcatel-Lucent 5620 SAM LogToFile supports unicast, multicast,and broadcast IP traffic.

A user can define a policy to manage each combination of traffic classes and casttypes uniquely. With eight classes and four types, 32 different combinations arepossible. On a SAP, each unique combination is supported by a separate queue,which means up to 32 queues to be managed. On ingress, the SAPs supportseparate queues for the different casts of traffic. However, on egress, the SAPs donot support separate queues. Therefore, on egress, there is a maximum of eightqueues.

The Alcatel-Lucent 5620 SAM represents these entities in the following objects:

SAPs SAP object represents a SAP. The SAP object has a PolicyId property.

PoliciesPolicy object represents the policy.

ForwardingClassesForwardingClass object represents one of the eight possible classes oftraffic. This object has a PolicyId property that indicates the policy towhich it belongs. If the object is an ingress ForwardingClass, it has fourqueue IDs, one each for Unicast, Multicast, Broadcast, and Other. If theobject is an egress ForwardingClass, it has one queue ID.

Service queuesEgress Service Queue object or an Ingress Service Queue object represents aservice queue on a SAP.

Bulk input file formats:

DataStage produces one file for each UBA per period. These files contain records ofinventory and metric data.

The inventory and metrics data records are in the CSV format. The initial integeridentifier of the CSV files specifies a record type, and the subsequent fields containthe actual data of the record. The output CSV file from the DataStage has twosections:1. Header2. Data

Header starts with 0 (zero), and is called as the 0-record schema. Data starts withrecord type, which is identical to the one that is defined in the header.

Sample Header0,"{""recordType"":17,""dataType"":""C"",""className"":""equipment.Shelf"",""fieldNames"":[""administrativeState"",""deviceState"",""displayedName"",""equipmentState"",""numberOfCardSlots"",""objectFullName"",""operationalState"",""shelfId"",""shelfName"",""shelfType"",""siteId"",""siteName""]}"

Sample data17,"noop","deviceStateUnknown","sim242_60","indeterminate","12","network:138.120.242.60:shelf-1","unknown","1","sim242_60","sr_shelf_12Slot","138.120.242.60","sim242_60"


Bulk input file schema

The UBA input has a schema that works on CSV input files. The general format ofa CSV file is as follows:0, "{“recordType”: 1, ”dataType”:”input source”, “className”: “TheClassName”,“fieldNames”: [“field1”, “field2”, ... “fieldn”]}"

recordTypeSpecifies an integer that is used to identify the record format.

dataType

Specifies the source of the record data. The sources can be "A", "D", "C", or"M".

The following list contains the definition of 0-Record CSV data type:v A - Attribute Changev D - Object Deletionv C - Object Creation or Full dumpv M - Metrics

Note: The JMS inventory messages are identified by data types of A, Dand C.

classNameSpecifies the Alcatel-Lucent class name that is used to identify the class(inventory or metric) that this record belongs to. The class name is used bythe UBA to identify the mapping between the class and the recordidentifier.

fieldNamesSpecifies an array of the field names that is available within the record thatis defined.

Bulk adapter design files:

Tivoli Netcool Performance Manager bulk adapters support bulk input files in theCSV format. The DataStage server produces data in CSV format and uses JMS fornotification of inventory changes.

Each UBA technology pack provides at least one bulk adapter design file to definethe data format supported by that technology pack. Technology pack developersimplement bulk adapter design files using JavaScript®. Some technology packsprovide several bulk adapter design files.

Typically, a bulk adapter design file can process both inventory and metrics datafrom the same bulk input file, and provides a function that creates the bulkcollection formula names. When the inventory and metrics are located in separatebulk input files (as is the case in the Alcatel-Lucent 5620 SAM environment), atechnology pack developer implements several types of bulk adapter design files.The Alcatel-Lucent 5620 SAM LogToFile Technology Pack provides the UBA designfiles.

UBA design files

UBA is a DataChannel application that interprets and parses bulk input files thatcontain inventory and metrics data, or (as is the case in the Alcatel-Lucent 5620


SAM environment) metrics data only. A technology pack developer implementsUBA design files that tell the UBA application how to interpret and parse thesebulk input files.

The current version of the Alcatel-Lucent 5620 SAM LogToFile Technology Packsupports two UBA Bulk Collectors. The two main UBA design files are as follows:v The SAMUBAAdaptor_polled.js file is used by the first UBA Bulk Collector and

handles most of the metrics.v The SAMUBAAdaptor_accounting.js file is used by the second (accounting) UBA

Bulk Collector and handles the accounting metrics. These metrics areservice-oriented metrics.

You can find the UBA design files in the Alcatel-Lucent 5620 SAM LogToFileTechnology Pack from the following location:datachannel/scripts/alcatel_5620_sam_log2file

Installation and configuration of IBM InfoSphere InformationServer and related componentsDescribes how to install and configure the various IBM InfoSphere InformationServer and other related components that are required for Alcatel-Lucent 5620SAM LogToFile 2.5.0.0 Technology Pack such as:

Components

v IBM InfoSphere Information Server 8.7v IBM InfoSphere Information Server Client 8.7v Apache ActiveMQ 5.5.1v Oracle Client 11g (64-bit)

Planning for IBM InfoSphere Information Server software installation:

Ensure that hardware and software requirements for the product modules that youwant to install are met on your computers.

For latest information about the installation requirements, see these resources:v System Requirements

Restriction: It is recommended that you install the IBM InfoSphere InformationServer on a separate stand-alone server. The recommended RHEL x86_64versions are 5.5 to 5.10.

v Release NotesRelated information:

IBM InfoSphere Information Server, Version 8.7 release notes

Installing IBM InfoSphere Information Server 8.7 software:

IBM® InfoSphere™ Information Server includes a set of collaborative productmodules and components that you can distribute across multiple computers. Thissection describes how to install and remove the InfoSphere Information Server andInfoSphere Information Server client software.


https://www.ibm.com/support/docview.wss?uid=swg27021833

http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.relinfo.doc/topics/iisihrinfo_infsv_rnote_v87.html

http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.relinfo.doc/topics/iisihrinfo_infsv_rnote_v87.html

Installing IBM InfoSphere Information Server by using the wizard (graphical mode):

You can run the installation program locally by using a web browser on the targetcomputer. Alternatively, you can use a web browser on any system in a distributedenvironment.

Before you begin

During the initial installation session, install the required product modules thatyou plan to use either now or in future. If you install only some of the productmodules now, and then install fixes and service packs, you must reinstall the fixesand service packs as you add the product modules later.

Note: Ensure that the system has only RHEL operating system installed and noother components on it. You can install the other components as and whenrequired.

Ensure that you disable the firewall by using the following step:v Click System > System Firewall > Disable Firewall to disable the firewall.

Disable the firewall temporarily until the installation is complete.

About this task

When you first start the installation program, it presents a non-graphical interface.The program starts a self-contained web server on the computer. You can then starta web browser on the computer or on a remote computer and access the graphicalinterface. After you enter your settings in the wizard pages, the program storesyour settings in a response file. If you run the installation program again, you canload your settings from this file into the program instead of entering them again.

Procedure

1. Extract the InfoSvr_v8.7_Linux64.tar.gz file to a location of your choice.The installation media is in the is-suite directory.

2. Change to the is-suite directory and run the installation program as rootuser by using the following command:./setup [-verbose]

The -verbose option is optional. The option causes the installation program todisplay log messages to the console and also write them to the log file. If the-verbose option is not specified, log messages are written to the log file only.Several messages are displayed. The program then displays a message abouthow to access the installation wizard:

======> Enter one of the following URLs to your web browser to begin the installation process:http://localhost:8080/ISInstallhttps://localhost:8443/ISInstall

3. Open a web browser on the computer or on a remote computer, and go to oneof the addresses that is listed in the messages from starting the installationprogram.

4. Select a language from the menu for the installation program to use and clickLogin. This selection applies only to this installation session. Later in theinstallation process, you can select the language to apply to the InfoSphereInformation Server installation.

5. Click Next on the prompts in the installation program to continue to installthe product. The installation program runs an Early Requirements Check to


ensure that your installation is configured correctly as shown in the figure:

The page displays the results of the check as PASSED or FAILED. If the checkfound issues that might cause problems with the installation, it is marked asWARNING on the page.For more information about resolving the failed installation prerequisites, seeInstallation prerequisites check failed.

6. When all early requirements checks are passed, click Next.7. Click the default path where you want to install the Information Server in the

Installation directory field, and then click Next. By default, the installationdirectory is /opt/IBM/InformationServer.

8. Click New installation in the "Installation Type Selection" page, and then clickNext.

9. Click to select all the tiers in the "Tier Selection" page and click Next.10. Enter the password for the root user in the Password for root field and click

OK.11. Click Select All in the "Product Selection" page and click Next.12. Accept the terms and conditions in the "Software License Agreement" page

and click Next.13. Select the IBM InfoSphere DataStage (Select this edition to develop parallel

and server jobs) check box and clear the IBM InfoSphere DataStageBalanced Optimization check box in the "IBM InfoSphere DataStageInstallation Options" page and click Next.

14. Click Next in the "High Availability Server Cluster Configuration" page asthere is no support for High Availability Server in the present context.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.install.doc/topics/wsisinst_install_prereq_check_fails.html

15. Click Install WebSphere Application Server in the "Application ServerOptions" page and click Next.

16. Click Browse to select the installation directory for the WebSphere ApplicationServer. By default, the installation directory is /opt/IBM/WebSphere/AppServer.

17. Select the Customize WebSphere Application Server profile ports check boxin the "IBM WebSphere Application Server Installation" page, and then clickNext.

18. Verify that each port number is unique in the "IBM WebSphere ApplicationServer Profile Ports Assignment" page and click Next.

19. Enter the Application Server administrator user name and password and clickNext.

20. Enter the InfoSphere Information Server administrator user name andpassword and click Next.

21. Click Install IBM DB2 9.7 Enterprise Server Edition to install and create thedatabases within DB2 and click Next.

22. Specify the default directory where you want to install the DB2 databasesystem. By default, the installation directory is /opt/IBM/db2/v9.

23. Click Create a user as an instance owner in the "IBM DB2 Instance User"page and enter the user information, and then click Next. Also, enter a portnumber for the new instance. You receive a conformation after the user iscreated. Click OK.

24. Click Create a new user as a fenced user in the "DB2 Fenced UserInformation" page and enter the DB2 fenced user information and then clickNext.

25. Click Create the user as administrator user in the "DB2 Administrator Userinformation" page and enter the administrator user information, and then clickNext

26. Enter the metadata repository owner information, database name, databaseinstance name, and database location in the "Metadata RepositoryConfiguration" page, and then click Next.

27. Enter the metadata repository owner information, database name, databaseinstance name, and database location in the "Staging Area Configuration"page, and then click Next. The default agent port settings that are displayedin the "IBM InfoSphere Information Server Agent Ports Configuration" pagework in most configurations.

28. Enter the Information Analyser Repository Configuration information andthen click Next.

29. Enter the two TCP/IP port numbers to use for the IBM InfoSphere DataStageand QualityStage job monitor in the "Job Monitor Ports Configuration" page,which takes snapshots of job performance. The job monitor uses one port torequest job information and the second port to report job information. Thedefault port settings are acceptable in most configurations. The default settingsare 13400 and 13401 for the first and second ports.

30. Enter the unique tag information for the engine in the ITAG field and portnumber in the RPC port number field. If you are not installing multipleengine instances on the same computer, you can skip this step.

31. Click Create user as the IBM InfoSphere DataStage Administrator in the"IBM InfoSphere DataStage Administrator" page and enter the userinformation, and then click Next.

32. Clear the SAS check box and click Next. The existing job does not use SASand you can ignore this step.


33. Click Add Projects and enter the InfoSphere DataStage projects to create inthe "IBM InfoSphere DataStage Projects" page. You must create at least oneproject during installation. By default, a project by name dstage1 is created.Remove the dstage1 project and add the UDM project.

34. Click Next. The installation program runs a system requirements check for theselections that are made. The page displays the results of the check as PASSEDor FAILED. If the check found issues that might cause problems with theinstallation, it is marked as WARNING on the page. To resolve the issues thatare found during this check, see Installation prerequisites check failed.

35. Click Next if all the system requirements checks are passed.36. Click Install IBM InfoSphere Information Server and save my settings in a

response file in the "Response File Review" page and click Next to begin theinstallation.Or, enter a name and location for the response file in the Response filelocation field in the "Response File Review" page. By default, it is available inthe following location: /opt/IBM/InformationServer/response.txt and clickNext to begin the installation. You can choose to cancel the installation anduse the saved response file in a later session. The "Post Installation Summaryfor Current Computer" page is displayed that contains the product, tiers, andproduct components that you installed, and information about how long theinstallation program ran and whether the installation was successful.

37. Click Install.38. Click Finish.Related information:

Troubleshooting installations

Installing IBM InfoSphere Information Server

Installing IBM InfoSphere Information Server client by using the wizard (graphicalmode):

You can run the installation program locally by using a web browser on the targetcomputer. Alternatively, you can use a web browser on any system in a distributedenvironment.

Before you begin

During the initial installation session, install all of the product modules that youplan to use either now or in the future unless explicitly stated otherwise. If youinstall only some of the product modules now, and then install fixes and servicepacks, you must reinstall the fixes and service packs if you add product moduleslater. Ensure that you disable the firewall by using the following step:v Click Control Panel > System and security > Windows Firewall to disable the

firewall. Disable the firewall temporarily until the installation is complete.

About this task

When you first start the installation program, it presents a non-graphical interface.The program starts a self-contained web server on the computer. You can then starta web browser on the computer or on a remote computer and access the graphicalinterface. After you enter your settings in the wizard pages, the program storesyour settings in a response file. If you run the installation program again, you canload your settings from this file into the program instead of entering them again.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.install.doc/topics/wsisinst_install_prereq_check_fails.html

http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.install.doc/topics/wsisinst_ts_is_container.html

http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.install.nav.doc/containers/cont_iis_information_server_installation.html

Procedure

1. Extract the Infosvr_Client_v8.7_Win.zip file to a location of your choice. Forexample, C:\is-client

2. Double-click the installation program, setup.exe. Several messages aredisplayed. The program then displays a message about how to access theinstallation wizard:

======> Enter one of the following URLs to your web browser to begin the installation process:http://localhost:8080/ISInstallhttps://localhost:8443/ISInstall

The installation program automatically starts the default web browser on thelocal computer to display the graphical interface.

3. Select a language from the menu for the installation program to use and clickLogin. This selection applies only to this installation session. Later in theinstallation process, you can select the language to apply to the InfoSphereInformation Server installation.

4. Click Next on the prompts in the installation program to continue to installthe product. The installation program runs an Early Requirements Check toensure that your installation is configured correctly as shown in the figure:

The page displays the results of the check as PASSED or FAILED. If the checkfound issues that might cause problems with the installation, it is marked asWARNING on the page.

5. When all early requirements checks are passed, click Next.


6. Click Browse to select the directories where you want to install theInformation Server in the Installation directory field, and then click Next. Bydefault, the installation directory is C:\IBM\InformationServer

7. Click New installation in the "Installation Type Selection" page, and then clickNext.

8. Click Select All in the "Product Selection" page and click Next.9. Accept the terms and conditions in the "Software License Agreement" page

and click Next.10. Enter the port numbers in the "Metadata Interchange Agents Ports

Configuration" page. The default port numbers are as shown in the figure:

11. Select the Create desktop shortcuts check box in the "Desktop shortcutcreation option" page and click Next. After the installation program hascollected your selections, it runs another, more detailed system requirementscheck in the "System Requirements Check" page that is based on yourselections. During this check, it analyzes your computer resources and filesystem to determine whether the installation is likely to succeed.

12. Click Next if all the system requirements checks are passed. For any warningsthat are displayed, you can select the Ignore "WARNING" items andcontinue check box, and then click Next.

13. Specify a name and location for the response file in the Response file locationfield in the "Response File Review" page. By default, it is:C:\IBM\InformationServer\response.txt. You can choose to cancel theinstallation and use the saved response file in a later session.

14. Click Install IBM InfoSphere Information Server and save my settings in aresponse file in the "Response File Review" page and click Next. A"Preinstallation Summary for the Current Computer" page is displayed thatcontains the product, installation directory, tiers, and disk space information.


15. Click Install. When the installation process is complete, a "Post InstallationSummary for the Current Computer" page is displayed that contains theproduct, tiers, and product components that you installed, and informationabout how long the installation program ran and whether the installation wassuccessful.

16. Click Finish.Related information:

Troubleshooting installations

Verifying and testing the installation:

After you install and configure InfoSphere DataStage and InfoSphereQualityStage™, test the installation by logging in to the Administrator and Designerclients.

About this task

For example, open the IBM InfoSphere DataStage and QualityStage Administrationclient by providing the information as follows and click Login:


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.install.doc/topics/wsisinst_ts_is_container.html?lang=en

Installing Apache ActiveMQ:

Apache ActiveMQ is an open source software that is customized and bundled withAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack JAR file. ApacheActiveMQ is responsible for buffering messages that are received from SAM JMSfor the DataStage Job. Apache ActiveMQ is an interface to JMS poller to passmessages.

About this task

Apache ActiveMQ must be installed on the same server where the IBM InfoSphereInformation Server server is installed.

Procedure

1. The tnpm-apache-activemq-5.5.1-bin.tar.gz file is available in the technologypack media. After pack installation, you must be able to find the ApacheActiveMQ bundle at $PVM_HOME/APFiles/alcatel_5620_sam_log2file/datastage/.

2. As root user, extract the file to /opt directory by using the following command:

tar zxvf tnpm-apache-activemq-5.5.1-bin.tar.gz

3. Add activemq.rc file as a system service by linking the file in /etc/init.d byusing the following commands:

ln -s /opt/apache/activemq/5.5.1/bin/activemq.rc /etc/init.d/activemq.rc/sbin/chkconfig --add activemq.rc/sbin/chkconfig activemq.rc on/sbin/chkconfig –list activemq.rc

Important: If you install DataStage in a non-default location, you must updatethe activemq.rc file to specify the actual installation location. The defaultinstallation location for DataStage is /opt/IBM/InformationServer.

4. Start Apache ActiveMQ by using the following command:

./activemq.rc start

If you want to stop the Apache ActiveMQ, you can use the followingcommand:

./activemq.rc stop

5. To verify that ActiveMQ installation is successful, do one of the following steps:a. Log in to the server where ActiveMQ is installed by using the following

command:

http://<host_name>:8161/admin/

If the web page opens as shown in the figure, the installation is successful:


b. OrTo check that the ActiveMQ service is running, give the followingcommand:

ps -ef |grep active

6. To verify ActiveMQ is listed in service configuration tool, you can usesystem-config-services to start Service Configuration.This is a graphical tool for enabling and disabling services. Functions to start,stop, and restart services are also included.

Installing Oracle 11g (64 bit) client:

Oracle 11g is required for DataStage to establish connection with Proviso DB. Onjob start, DataStage connects to Proviso DB to obtain all collector information,which can be used for data partition for UBA.

Before you begin

Ensure that all dependencies are installed and kernel parameters that are updatedso.v To check the kernel parameter, use the following command:

/sbin/sysctl -a | grep <PARAMETER>

v To update the kernel parameter, use the following command:

/sbin/sysctl -w <PARAMETER>="<VALUE>"

Permanently, change the kernel parameter by modifying the /etc/sysctl.conffile.

About this task

Oracle 11g client must be installed on the same server where the IBM InfoSphereInformation Server server is installed.


Procedure

1. Install Oracle 11g client.

Note: The 64 bit Oracle client must be installed.2. Configure the tnsname.ora file that is in $ORACLE_HOME/network/admin to

connect to Tivoli Netcool Performance Manager Wireline.3. Update the DataStage dsenv file that is in $DS_HOME. By default, the $DS_HOME is

/opt/IBM/InformationServer/Server/DSEngine.4. Create a soft link to libccora11g.so by using the following command:

cd $ORACLE_HOME/libln -s /opt/IBM/InformationServer/Server/StagingArea/Installed/OracleConnector/Server/linux/libccora11g.solicccora11g.so

Typically, The libccora11g.so is in the following path:/opt/IBM/InformationServer/Server/StagingArea/Installed/OracleConnector/Server/linux/libccora11g.so.

5. Update the $DSHOME/dsenv as dsadm user. The following parameters must beincluded:

export ORACLE_HOMEexport TNS_ADMINupdate LD_LIBRARY_PATH to include $APT_ORCHHOME/bin, $ORACLE_HOME/lib and $ORACLE_HOME/rdbms/libupdate PATH to include $APT_ORCHHOME/bin and $ORACLE_HOME/libexport ORACLE_BASEupdate LIBPATH to include $ORACLE_HOME/rdbms/lib & $ORACLE_HOME/lib

6. Run the install.liborchoracle script by using the following steps:a. Source the environment by using the following commands:

export DSHOME=/opt/IBM/InformationServer/Server/DSEngineexport APT_ORCHHOME=/opt/IBM/InformationServer/Server/PXEngine

b. Run the install.liborchoracle script by using the following command:

/opt/IBM/InformationServer/Server/StagingArea/Installed/PxOracle/install/install.liborchoracle

7. Restart the DataStage as root by using the following commands:

/etc/init.d/ds.rc stop/etc/init.d/ds.rc start


Installing Oracle client

Configure the InfoSphere Information Server componentsDescribes the configuration tasks.

Opening the IBM InfoSphere Information Server web console:

Use the InfoSphere Information Server web console to manage security, viewscheduled tasks, work with reports, or perform tasks that are related to IBM®

InfoSphere® Business Glossary or the Information Services catalog.

Before you begin

To access the web console, determine the URL to use, configure your browser, andgo to the console window.


http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/oracle/ctnpm_ora_installora10gclient_1.4.dita

About this task

The URL for the IBM® InfoSphere® Information Server web console differsdepending upon the IBM WebSphere® Application Server communication protocoland configuration. The syntax of the URL is as follows:protocol://host:port/ibm/iis/console

protocol is the communication protocol: either http or https. host and port differdepending upon the communication protocol and WebSphere Application Serverconfiguration (clustered or non-clustered).

For example, in a configuration where clustering is not set up, the HTTPS URLmight be:https://<myhost.example.com>:9443/ibm/iis/console

Configuring web browser to open the IBM InfoSphere Information Server webconsole:

The IBM® InfoSphere® Information Server web console is supported by bothMicrosoft Internet Explorer and Mozilla Firefox. You must do these steps in yourpreferred web browser before you use the IBM InfoSphere Information Server webconsole.

About this task

v Determine the URL to use as described in “Opening the IBM InfoSphereInformation Server web console” on page 47.

v If HTTPS is enabled in the URL, follow the browser prompts to accept thecertificate and proceed to the login page.

Procedure

1. Open a web browser, and go to the console. The URL to use depends upon theIBM WebSphere Application Server communication protocol and configurationin use.

2. Type your user name and password. By default, use wasadmin user andpassword.

3. Click OK to open the Home tab.Related information:

IBM InfoSphere Information Server console overview

InfoSphere Information Server system requirements

Configuring Microsoft Internet Explorer to open the IBM InfoSphere Information Serverweb console:Procedure

1. Enable JavaScript:a. Click Tools > Internet Options .b. On the Security tab, click Custom Level.c. In the Security Settings window, select Scripting > Active Scripting >

Enable.2. Set the browser to accept cookies for the InfoSphere Information Server host

site.a. Click Tools > Internet Options.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.found.moz.rc.common.doc/topics/iisinfsrv_mcom_overview.html

http://www-03.ibm.com/software/products/en/infosphere-information-server

b. On the Privacy tab, click Sites.c. In the Address of Web site field, enter the InfoSphere Information Server

host name.d. Click Allow.e. Click OK.

3. Enable pop-up windows for the URL of the IBM InfoSphere Information Serverweb console:a. Click Tools > Pop-up Blocker > Pop-up Blocker Settings or turn off the

pop-up window blocker.b. If you selected the settings, type the URL and click Add.

4. Specify that the pages are refreshed every time that you visit the site:a. Click Tools > Internet Options and on the General tab, click Settings.

Select Settings in the Browsing history section.b. Select Every time I visit the webpage or Automatically and click OK.

5. Optional: Disable the display of friendly HTTP error messages. Follow thesesteps:a. Click Tools > Internet Options.b. On the Advanced tab, clear Browsing > Show friendly HTTP error

messages.

Configuring Mozilla Firefox to open the IBM InfoSphere Information Server web console:Procedure

1. Enable JavaScript:a. Click Tools > Options in the Content tab.

2. Set the browser to accept cookies for the InfoSphere Information Server hostsite.a. Click Tools > Options.b. On the Privacy tab, click the Accept cookies from sites option or click

Exceptions and add the site to the allowed site list by entering the hostname and click Allow.

3. Enable pop-windows for the URL of the web console.a. Click Tools > Options.b. Select the Contents tab and either clear the Block pop-up windows option

or click Exceptions and add the site to the allowed list by entering the hostname and click Allow.

Creating dsadm users in the IBM InfoSphere Information Server web console:

You must create a user for each person that must log in to IBM InfoSphereInformation Server.

About this task

Ensure that you have suite administrator authority. To create a user, follow thesesteps:

Procedure

1. In the IBM InfoSphere Information Server web console as wasadmin user, clickthe Administration tab.

2. In the Navigation pane, select Users and Groups > Users.


3. In the Users pane, click New User.4. In the Create New User pane, provide information about the user. Give the

following information:

Option Description

User name dsadm.Note: You must create a dsadm user. Thedsadm user is required for all operations onDataStage job in Alcatel-Lucent 5620 SAMLogToFile 2.4.0.0 Technology Pack.

Password Give the same password as you set for dsadmUNIX user.

First/Last Name dsadm

5. In the Roles pane, specify all roles.6. In the Suite Component pane, select whether the user has any suite component

roles. To log in to any of the product modules, a user must have the suite userrole. Also, add at least one suite component role for each suite component thatyou want the user to access. For example, if you are creating a user thataccesses IBM InfoSphere Information Analyzer, you must assign the suite userrole, and also the Information Analyzer Project Administrator, DataAdministrator, or User role.

7. Link the dsadm user to Server Engine by using these steps:a. Expand Domain Management from Navigation pane.b. Click Engine Credentials.c. Select the server.d. Open Configuration.e. Select the Share User registry between Infosphere Information Server and

its engine option.f. Click Save and Close.

8. Click Save and Close to save the user information in the metadata repository.

Deploying Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 DataStagejobsYou can design InfoSphere DataStage Administrator jobs by using the IBMInfoSphere DataStage and QualityStage Designer client.

To deploy DataStage LogToFile, the following clients are used:

Administrator ClientYou can create and configure the UDM project.

Designer ClientYou can import, configure, and compile the UDM project.

Director ClientYou can run and monitor a job.

The Designer client uses a repository where you can store the objects that you arecreating as part of the design process. These objects can be reused by other jobdesigners.

Note: You must not modify the job design.


Jobs and their associated objects are organized in projects. DataStageadministrators create projects by using the Administrator client. When you startthe Designer client, you specify the project that you work, and everything that youdo is stored in that project.

When your job designs are finished, they are run in the Director client. No data ismoved or transformed until you actually run the job. When you start the Directorclient, you specify the project that contains the jobs to run.

Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack job design: Thefeatures of Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack job designare as follows:

LogTofile interface to SAM serverLogToFile solution relieves loads from SAM server thus allowing SAMserver to support higher performance load.

Class record filter optionData from SAM server are not filtered. Filtering the class records reducesloads from DataStage and UBA processing.

Multiple UBA PartitionThis solution supports multiple sets of Accounting and Performance UBAsto support UBA and Data Channel scalability.

Period window handlingClass Data from LogToFile might not arrive within the period interval. Toensure data completeness, job waits for late data files and merge the datainto its correct period interval.

CSV output for UBAsCSV file requires less processing effort that is compared to XML. Multiplesmall files are bundled in single UBA input to improve I/O utilization.

Setting up a project:

A project is a container that organizes and provides security for objects that aresupplied, created, or maintained for data integration, data profiling, qualitymonitoring, and so on. Projects are a method for organizing your work. You definedata files, stages, and build jobs in a specific project. A project can contain one ormore jobs. Any of the metadata objects in a project (such as jobs or tabledefinitions) can be grouped logically and organized into folders. You can definesecurity at the project level. Only users who are authorized for your project canaccess your jobs.

Procedure

1. Log in to the Administrator client as dsadm.2. Click the Projects tab in the Administrator window.3. Click the Add button.4. Enter the project name in the Name field. The project name must be given as

UDM. You must create the UDM project only if you have not created in Step 35of “Installing IBM InfoSphere Information Server by using the wizard(graphical mode)” on page 38. UDM is automatically appended to the defaultlocation for the new project. You cannot add a project to a location that exists.

5. Click OK. You can see the project that you created in the following directory:/opt/IBM/InformationServer/Server/Projects/UDM


6. Create a directory by name udm inside the project that you created by using thefollowing commands:cd /opt/IBM/InformationServer/Server/Projects/UDMumask 002mkdir udm

You can install and import the job in this directory.

Extracting the job archive file:Before you begin

Ensure that you created a project by name UDM and a subdirectory by name udminside the project directory. The ds_job_vm.n.0.0.b.dsx is packaged inside thealcatel_5620_sam_ds_vm.n.0.0_build_b.tar.gz (version number, major buildnumber, minor build number) file from the technology pack JAR file.

Procedure

1. Extract the alcatel_5620_sam_ds_vm.n.0.0_build_b.tar.gz file in/opt/IBM/InformationServer/Server/Projects/UDM/udm by using the followingcommand:tar zxvf alcatel_5620_sam_ds_vm.n.0.0_build_b.tar.gz

2. Open IBM InfoSphere DataStage and QualityStage Administrator on yourdesktop.

3. Log in with the user name and password of dsadm with the DataStage andQualityStage Administrator.

4. Click the Projects tab to list the Projects.5. Select the project UDM, and then click Properties.6. In the Project Properties window, click Environment. The Environment

Variables window opens.7. Expand General and change the value for LD_LIBRARY_PATH variable to:

/usr/lib:.:/opt/IBM/InformationServer/Server/Projects/UDM/udm/lib

This is the path where the custom libraries are located.8. Optional: Expand Parallel and change the value for APT_CONFIG_FILE variable

to other than default (/opt/IBM/InformationServer/Server/Configurations/default.apt) with appropriate numbers of DataStage nodes that are required.Some examples while configuring multiple nodes by using default.apt file:Example 1:{

node "node1"{

fastname "datastage"pools ""resource disk "/disk1/tnpm/datastage/Server/Datasets" {pools ""}resource scratchdisk "/disk1/tnpm/datastage/Server/Scratch" {pools ""}

}node "node2"{


}node "node3"{

fastname "datastage"pools ""


resource disk "/disk1/tnpm/datastage/Server/Datasets" {pools ""}resource scratchdisk "/disk1/tnpm/datastage/Server/Scratch" {pools ""}

}node "node4"{


}node "node5"{


}node "node6"{


}node "node7"{


}node "node8"{


}}

Example 2:{

node "node1"{

fastname "datastage"pools ""resource disk "/opt/IBM/InformationServer/Server/Datasets" {pools ""}resource scratchdisk "/opt/IBM/InformationServer/Server/Scratch" {pools ""}

}node "node2"{

fastname "datastage"pools ""resource disk "/opt/IBM/InformationServer/Server/Datasets" {pools ""}resource scratchdisk "/opt/IBM/InformationServer/Server/Scratch" {pools ""}

}node "node3"{


}node "node4"{

fastname "datastage"pools ""


resource disk "/disk1/tnpm/datastage/Server/Datasets" {pools ""}resource scratchdisk "/disk1/tnpm/datastage/Server/Scratch" {pools ""}

}node "node5"{


}node "node6"{


}node "node7"{


}node "node8"{


}}

9. Click OK.10. Click Close to save the new project and to exit the InfoSphere DataStage and

QualityStage Administrator.Related information:

DataStage Configuration file : Explained

Updating the operator.apt file:

An extra configuration step.

Procedure

1. Go to the operator.apt file from this location:/opt/IBM/InformationServer/Server/PXEngine/etc/operator.apt

2. Edit the operator.apt file to add the following lines:

CSVWriterOp libCSVWriterOperator 1FeedbackOp libWaveOperator 1ReceiverOp libWaveOperator 1WindowOp libWindowOperator 1PerlizeOp libPerlizeOperator 1CombineOp libCombineOperator 1AuditOp libAuditOperator 1HousekeeperOp libHousekeeperOperator 1XMLChunkerOp libXMLChunkerOperator 1DeduplicateOp libDeduplicateOperator.so 1

These are the custom libraries that are specific to the Technology Pack.


https://www.ibm.com/developerworks/community/blogs/nix/entry/datastage_configuration_file_explained3?lang=en

Configuring Java for connecting to SAM Server 13:

Connecting to SAM 13

Procedure

1. Install Java version 1.7.0_76-b13 (Oracle Corporation) or later on DataStageserver.

2. Update JAVA_HOME variable in <DataStage_Home>/udm/bin/env.sh file to the newinstalled Java as follows:#JAVA 1.7 path to connect to SAM13export JAVA_HOME=<JAVA 1.7 Path>

3. Run the job from director client.

Importing an IBM InfoSphere DataStage job:

You must import the SAM LogToFile job into the project. The project and its jobare created and then imported into the metadata repository by using IBM®

InfoSphere™ DataStage® and QualityStage™ Designer.

Before you begin

Before you import the ds_job_v2.2.0.0.6.dsx that is available in the technologypack JAR file, close all the existing jobs that are open in the Designer from theprevious JAR file. This is not required on a fresh installation.

Procedure

1. Log in to IBM InfoSphere DataStage and QualityStage Designer as dsadm andpassword, and select your project from the Project list.

2. Transfer the ds_job_v2.2.0.0.6.dsx file from the DataStage Server machine(/opt/IBM/InformationServer/Server/Projects/UDM/udm/jobs) to the designerclient machine.

3. On the menu bar, click Import > DataStage Components.4. In the DataStage Repository Import window, browse to the directory where you

transferred the job files. Select ds_job_v2.2.0.0.6.dsx as the import file.5. Select Import selected radio button and Perform impact analysis check box.6. Click OK to import the job. You see the Import load progress window that

shows the number of items that are loaded.7. In the "DataStage Import" window, select all the items that are loaded and click

OK.8. Click Jobs > 5620sam > J02main5620sam You can see the job design flow

diagram in the canvas.

Configuring the DataStage job:Procedure

1. In the IBM InfoSphere DataStage and QualityStage Designer, click Routines >5620sam > checksum from the Repository pane.

2. Optional:

Note: This step is needed only if you created a project with a name other thanUDM.Change the Library path for all routines to /opt/IBM/InformationServer/Server/Projects/UDM/udm/lib/libroutines.so and click Save. The compiledcustom libraries are available in this path.


3. Repeat step 1 through step 2 for all the routines.4. Click Close.5. Click the Job Properties button and then click the Parameters tab.6. Change the default value for the following parameters:

Option Description

DS_HOME /opt/IBM/InformationServer/Server/DSEngine

DS_WORKSPACE /opt/IBM/InformationServer/Server/Projects/UDM

SAM_PRIMARY_SERVER <sam_primary_server>

SAM_SECONDARY_SERVER <sam_secondary_server>

SAM_USER <SAM_USER>

SAM_PASSWORD <SAM_PASSWORD>

SAM_FTP_USERNAME <SAM_FTP_USERNAME>

SAM_FTP_PASSWORD <SAM_FTP_PASSWORD>

For the remaining parameters, accept the default values.

7. Click OK.8. Click File > Exit to close IBM InfoSphere DataStage and QualityStage Designer.

Note: Generating MD5 Password:a. As user samadmin, go to /opt/5620sam/server/nms/bin in SAM Server.


b. ./md5hash.bash<password of sam oss management user>

c. The corresponding MD5 password will be displayed.

Usage of the CSV files in the cfg directory:

The four CSV files that you must configure from the cfg directory where the IBMInfoSphere Information Server server is installed.

You can access the cfg directory from this location:/opt/IBM/InformationServer/Server/Projects/UDM/udm/cfg

The files that you must configure are as follows:

collector_lookup.csvYou can specify the UBAs with their collector IDs that you have in this file.The UBAs exist in pairs of Performance and Accounting UBAs. For moreinformation about this file, see “Specifying what inventory and metrics tocollect” on page 87.

collector_mapping.csvWhen you want to provision a new element and you have the loadbalancing criteria, you can specify the family, IP address of the elementand collector ID it must be mapped to. There are 37 families and thefamilies are as follows:v 5620_SAM_AingrAengrQueuev 5620_SAM_Aosqos_Policyv 5620_SAM_BaseCardv 5620_SAM_CardSlotv 5620_SAM_CfmEthTestv 5620_SAM_CfmOneWayDelayv 5620_SAM_CfmSingleEndedLossv 5620_SAM_CfmTwoWayDelayv 5620_SAM_Channelv 5620_SAM_ControlProcessorv 5620_SAM_DaughterCardv 5620_SAM_DHCP6_Addressv 5620_SAM_DS1_E1v 5620_SAM_Hw_Environmentv 5620_SAM_IMALinkv 5620_SAM_ISA_Mdav 5620_SAM_ISA_Memberv 5620_SAM_LAGInterfacev 5620_SAM_MCMCardv 5620_SAM_MMEv 5620_SAM_MPLS_Sitev 5620_SAM_MPLSInterfacev 5620_SAM_MSSv 5620_SAM_NQueuev 5620_SAM_OAM_Testv 5620_SAM_PhysicalPort


v 5620_SAM_PPP_Interfacev 5620_SAM_PPP_Protocolv 5620_SAM_S11Peerv 5620_SAM_S1UPeerv 5620_SAM_S5Peerv 5620_SAM_S8Peerv 5620_SAM_SdpBindingv 5620_SAM_ServiceAccessInterfacev 5620_SAM_Shelfv 5620_SAM_Subnet_Addressv 5620_SAM_Virtual_Router

The format of the entries in the file is as follows:<Class_Family>,<Partition_Key_Value>,<Collector_Number>

Where:v Class_Family - Implementation in technology packv Partition_Key_Value - Each SAM class has a designated partition key,

which is one of the attributes in a class and this value is provided as thesiteId, which is the IP address.

v Collector_Number - Collectors that are provisioned in Tivoli NetcoolPerformance Manager.

For example:5620_SAM_PhysicalPort,10.212.3.40,400

csv_lookup.csvThis file contains information about the classes and the various attributesthat are associated to the classes. An example of csv_lookup.csv file is asfollows:equipment.ControlProcessor,objectFullNameequipment.ControlProcessor,operationalStateequipment.ControlProcessor,slotId

filter_lookup.csvIf you want to filter some records that are coming from the SAM server,you can write an expression for the filter criteria in this file. For moreinformation about this file, see “Specifying what inventory and metrics tocollect” on page 87.

This file has Perl regular expressions and smart operators. For example:<className>,<expression>. It has a Boolean field in which “0” denotesFALSE and “1” denotes TRUE.

For example,ies.L3AccessInterface,{serviceId} ~~ [1000..2000, 5000..6000] ||{accountingPolicyId} == 100

This filter pools all the data in the range for service ID 1000 - 2000 or 5000- 6000 or having accounting policy ID as 100.

familykey_lookup.csvThis file contains information about families and their partition key. Anexample of family_lookup.csv file is as follows.5620_SAM_PhysicalPort,samSiteId5620_SAM_MPLSInterface,samNodeId


makekey_lookup.csvThis file is internal to DataStage to generate the unique key for each recordin the class by applying regular expression on partition ID, which isavailable in relation_lookup.csv.

precedence_lookup.csvThis file contains information about the classes and their precedence. Byprecedence means that records in the csv file are processed as in theirprecedence in the precedence_lookup.csv. The lower the number higher isthe precedence.

relation_lookup.csvThis file contains information about the class category, element type name,class family, class name, and the type of class (Performance or Inventory).Type of class is a Boolean field in which 0 denotes that the mentioned classis a Performance class and 1 denotes an Inventory class.<Class_Category>,<Class_Group>,<Class_Family>,<Sam_Class_Name>,<Class_Partition_Key>,<Class_Data_TypeClass_Category>

Where:v Class_Category = Performance /Accountingv Class_Group = No relevant implementation. A group name to group

classes together.v Class_Family = Implementation in technology packv Sam_Class_Name = Support classes in SAMv Class_Data_Type = 1 – Inventory / 0 - MetricPerformance,RouterObject,5620_SAM_PhysicalPort,equipment.PhysicalPort,siteId,1Performance,RouterObject,5620_SAM_PhysicalPort,equipment.InterfaceStatsLogRecord,monitoredObjectSiteId,0Accounting,NetworkQueueObject,5620_SAM_NQueue,nqueue.Entry,siteId,1Accounting,NetworkQueueObject,5620_SAM_NQueue,service.CombinedNetworkEgressOctetsLogRecord,monitoredObjectSiteId,0Accounting,NetworkQueueObject,5620_SAM_NQueue,service.CombinedNetworkIngressOctetsLogRecord,monitoredObjectSiteId,0

requestxml_lookup.csvThis file contains information about the various classes and the associatedmetrics and properties, which are requested from SAM server at the timewhen the job is started. This file contains information about the classcategory, element type name, class family, class name, and the type of class(performance or inventory). Type of class is a Boolean field in which 0denotes a Performance class and 1 denotes an Inventory class. Therequestxml_lookup.csv is a comma-separated file with the following fields:1. Request type2. Request (in the XML format)

An example of requestxml_lookup.csv file is as follows:Performance,MPLSServiceObject,5620_SAM_MPLSInterface,mpls.Interface,nodeId,1Performance,MPLSServiceObject,5620_SAM_MPLSInterface,mpls.MplsInterfaceStatsLogRecord,monitoredObjectSiteId,0

This CSV file contains following types of SOAP requests:v fullDumpv registerLogToFilev registerSasLogToFilev findToFile

To disable any request, follow these steps:


1. Open the requestxml_lookup.csv.2. Locate the class that you do not need.3. Add a “.” at the beginning of the line.

For example, to disable the following class:.registerLogToFile,<SOAP Contents for any class>

server_lookup.csvIf you have an auxiliary server, you must enter the IP address and the usercredentials to log in to the server in this file.

Some example scenarios where the configuration files are used for load balancingand other functions are provided here.

Configuring the filter_lookup.csv file:

You can configure the filter_lookup.csv file to add filters.

About this task

This example here shows how to add portInService Filter:

Procedure

1. Open the filter_lookup.csv file.2. Locate the following line:

equipment.PhysicalPort,1

3. Modify the line as follows:equipment.PhysicalPort,{administrativeState} ~~ portInService

4. Locate the following line:lag.Interface,1

5. Modify the line as follows:lag.Interface,{administrativeState} ~~ portInService

Avoiding the subchannel overloading for inventory:

Typically, the load balancing algorithm works on total number of networkelements. The new and existing elements are assigned to the available collectors byusing hash partitioning. The hash partitioning can be overridden by modifying thecollector_lookup.csv file.

About this task

To restrict the load on a subchannel, follow these steps:

Procedure

1. Open the collector_lookup.csv file.2. You want to change an overloaded collector number for one of the entries that

is as follows: For example:<Collector id>,<Class category>

100, Performance101, Accounting

Remove the overloaded collector entry from the file.3. Save the collector_lookup.csv file.


4. Restart the DataStage job.The load balancing routine does not consider the collector number 100 as partof the distribution equation.

Important: There is no limitation on the number of <Collector id>,<Classcategory> pairs that can be configured in the collector_lookup.csv file. Butmake sure that the collector ids that are specified in both thecollector_lookup.csv and collector_mapping.csv files are configured on theTivoli Netcool Performance Manager system as well.

Related concepts:Configuring multiple UBA collectors instancesRelated tasks:Distributing the existing load in new subchannelsWhen you want to provision an existing element and you have the load balancingcriteria, you can specify the family, IP address of the element and collector ID itmust be mapped to in the collector_mapping.csv file. Data partitioning or loaddistribution is done at the network element (NE) level.Related information:

Adding a Collector

Adding a UBA collector for a UBA pack

Distributing the existing load in new subchannels:

When you want to provision an existing element and you have the load balancingcriteria, you can specify the family, IP address of the element and collector ID itmust be mapped to in the collector_mapping.csv file. Data partitioning or loaddistribution is done at the network element (NE) level.

About this task

To move the load from one subchannel to another, follow these steps:

Procedure

1. Remove the element from Resource Editor. For more information, seeConfiguring and Operating DataMart.

2. Add the entries in collector_mapping.csv. For example:5620_SAM_PhysicalPort,10.212.3.40,200

The 5620_SAM_PhysicalPort element is directed to collector 200 thus overridinghash partitioning.

3. Restart the DataStage job.The new subchannel picks up the CSV file.

Note: You might notice some data loss in the process.

Enabling the firewall on the IBM InfoSphere Information Server andWebSphere Application Server:

Open and make the TCP ports available through firewall for InfoSphereInformation Server and WebSphere Application Server.


http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/install/ctnpm_installguide_stepaddacollector-05-19.dita

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_tp14C.doc/pack_install_config/ttnpm_tpinstall_addingaubacollectorforubapacks_modify_1.dita

Procedure

1. Activate the firewall on the DataStage server by using the following steps:a. Click System > Administration > Security Level and Firewall.b. In the Security Level Configuration window, click Firewall list and select

Enabled.c. Click the SELinux tab and select Permissive from the SELinux Setting list.

2. Enable the ports for the DataStage server by using the following steps:a. Log in to https:/<hostname>:<port>/ibm/console. InfoSphere Information

Server web-based client opens.b. Click Servers > Server Types > Websphere application servers.c. Select your server name from the Application Server panel.d. On the Communications section, click Ports. A page that displays the list of

ports opens.3. Additionally, you must enable all the was.* ports and dsrpc.port port. To do

this, follow these steps:a. Open the response.txt file and add the port number with this command:

Note: The default location for response.txt file is:/opt/IBM/InformationServer/Server/Projects

$ cat /opt/IBM/InformationServer/response.txt | grep -i port

A list of ports are displayed in the console.b. Open the ports with this command:

iptables -I INPUT -p tcp --dport <port_number> -j ACCEPT

c. Enable the ports was.* ports and dsrpc.port port.d. Save the setting and restart the iptables with these commands:

service iptables save

service iptables restart

e. List the opened ports with this command:iptables –L

f. Save this setting to a file by using the following command:iptables-save > /root/ds_firewalls

g. Append the following lines to /etc/rc.local file so that setting is restoredupon restart:iptables-restore > /root/ds_firewalls


Configuring your network

Compiling the job:

You must compile the job to prepare it to run on your system on the IBMInfoSphere DataStage and QualityStage Designer.

Before you begin

Ensure that the job named J02main5620sam that you created is open and active inthe job design area.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.productization.iisinfsv.install.doc/topics/wsisinst_pln_networks.html

Procedure

1. Select File > Compile.

Or, click the Compile ( ) button from the toolbar. The "Compile Job"window opens. As the job is compiled, the window is updated with messagesfrom the compiler.

2. When the "Compile Job" window displays a message that the job is compiledsuccessfully, click OK.

Results

The job is now compiled and ready to run.Related information:

Getting jobs ready to run

Running the job:

You can use the Director client to run the job and to view the log that the jobproduces as it runs.

About this task

You run the job from the Director client. The Director client is the operatingconsole. You also can use the Director client to monitor the jobs and troubleshootthe job by any error log that you receive when you run the job.

Procedure

1. Click Start > All Programs > IBM InfoSphere Information Server > IBMInfoSphere DataStage and QualityStage Director. The IBM InfoSphereDataStage and QualityStage Director opens. In the Director client, your jobstatus is compiled, which means that the job is ready to run.

2. Select your job in the right pane of the Director client, and select Job > RunNow. Ensure that the job parameters are set correctly.

3. In the "Job Run Options" window, click Limits tab and select No limit inWarnings pane.

4. Optional: In the "Job Run Options" window, click the General tab, and thenclick Record job performance data option to enable performance data.

5. Click Run.6. When the job status changes to Running, select View > Log.

Or, click the Log ( ) button to open the job in log mode.7. Examine the job log to see the type of information that the Director client

reports as it runs a job. The messages that you see are either control orinformation type. Jobs can also have Fatal and Warning messages.

8. Select File > Exit to close the Director client.

What to do next

You see many warning messages at the time of a job startup. These warningmessages can be ignored. These warnings are thrown by DataStage checks. But payattention to the warnings that you might see while the job is running. Thesewarnings are displayed to alert the user.


http://www-01.ibm.com/support/knowledgecenter/SSZJPZ_8.7.0/com.ibm.swg.im.iis.ds.design.doc/topics/gettingjobsreadytorun.html

The job starts a daemon. This daemon is connected to SAM JMS and directs all themessages to ActiveMQ. The DataStage job reads from the ActiveMQ. To check thedaemon process, follow these steps:1. Go to /opt/IBM/InformationServer/Server/Projects/UDM/udm/logs directory.2. Open the sam-jms-daemon.log file to see the messages that are flowing in. By

default, the KeepAlive messages appear every 30 seconds. This time intervalcan be configured on the SAM server.

Attention: It is recommended to restart the DataStage job once in every few days.When the job is restarted without restarting the JMS client daemon, the full dumpis not started.

Viewing the JMS message flow from SAM server in Apache ActiveMQ:

You can view the results of your job execution by opening the Apache AciveMQfrom the Web browser. You can see the JMS message flow from SAM server inApache ActiveMQ.

Procedure

1. Open the Apache ActiveMQ console from the web browser:http://<Server_IP_Address>:8161/admin/

<Server_IP_Address> is the server where Apache ActiveMQ is installed.2. Click the Queues tab. You can see the Number Of Consumers, Messages

Enqueued and Messages Dequeued. You can also perform maintenance fromhere.

Gracefully shutting down the job:

The stages are shut down one after the other. Job continues to run until its processis complete and then shuts down. To stop a job, you must wait until the job iscompleted.

Procedure

1. Go to /opt/IBM/InformationServer/Server/Projects/UDM/udm/bin directory.2. Run the sendDoneMessage.sh file by using the following command:

cd /opt/IBM/InformationServer/Server/Projects/UDM/udm/bin./sendDoneMessage.sh

Ideally, when you stop the Job, the daemon process must be running. Check thestatus of the daemon by using the following command:./daemon.sh status

If for some reason the status gives the following output:

UDMD_STATUS=STOPPEDUDMD_REASON=’daemon no longer running’DS_DIR=${DS_DIR-/opt/IBM/InformationServer/Server/DSEngine}SAM_JMSURL1=${SAM_JMSURL1-10.0.0.56}SAM_JMSURL2=${SAM_JMSURL2-10.0.0.79}DS_WORKSPACE=${DS_WORKSPACE-//opt/IBM/InformationServer/Server/Projects/UDM}SAM_UNIQUE_ID=${SAM_UNIQUE_ID-devds_J01main5620sam}SAM_USERNAME=${SAM_USERNAME-sam-o}SAM_PASSWORD=${SAM_PASSWORD-5620Sam!}

Look at the sam-jms-daemon.log file from the /opt/IBM/InformationServer/Server/Projects/UDM/udm/logs directory. You can troubleshoot and start the


daemon manually. For more information about starting the daemon, see“Starting the daemon manually”

Starting the daemon manually:

At the time of job start, it checks whether the daemon process is running or not. Ifthe daemon is not running, the job starts the daemon. You can run the daemonmanually.

About this task

You must start the daemon manually, when you want to shut down the job for anymaintenance work at the same time not lose any SAM JMS notifications. Thedaemon continues to listen and collect all JMS notifications.

Note: You must increase file retention period on SAM server to ensure that the fileis not dropped until DataStage job starts and notifications are processed.

To run the daemon manually, follow these steps:

Procedure

1. Go to /opt/IBM/InformationServer/Server/Projects/UDM/udm/bin directory.2. Start the daemon process by using the following command:

./daemon.sh startSTATUS:SUCCESS

3. To check the status of the daemon, use the following command:./daemon.sh status

The following output is displayed:

UDMD_STATUS=RUNNINGUDMD_REASON=’daemon is running’UDMD_PID=6505DS_DIR=${DS_DIR-/opt/IBM/InformationServer/Server/DSEngine}SAM_JMSURL1=${SAM_JMSURL1-10.0.0.56}SAM_JMSURL2=${SAM_JMSURL2-10.0.0.79}DS_WORKSPACE=${DS_WORKSPACE-//opt/IBM/InformationServer/Server/Projects/UDM}SAM_UNIQUE_ID=${SAM_UNIQUE_ID-devds_J01main5620sam}SAM_USERNAME=${SAM_USERNAME-sam-o}SAM_PASSWORD=${SAM_PASSWORD-5620Sam!}

Note: You can start the daemon manually only after the job is run successfullyat least once.

Data flow in the data subdirectories:

Access the data directory from here: /opt/IBM/InformationServer/Server/Projects/UDM/udm/data.

The data directory contains all the data files. The different subdirectories in thedata directory are as follows:

in When there is a file available message from the SAM server, DataStage jobfetches the XML files and places it in the in directory.

done After the DataStage job processes these XML files, it moves them into thedone directory. You must clean these XML files to free the space for storage.


cache This directory contains the temporary data that is required by the job forits processing. This directory contains a set of socket files forintercommunication, map files for sharing the memory among the differentstages, and litedb files are where the data is buffered and storedtemporarily even when the job is shut down to avoid data loss.

out The CSV files are created in the out directory that is based on theinformation in the XML files and JMS messages if any.

Important: The files from the cache directory are used by the DataStage job forinternal use. You must not delete or alter any file from the subdirectory while thejob is running. Otherwise, the job might fail.

Configuring the DataStage job for Secure File Transfer support:About this task

To add Secure File Transfer support for DataStage job, follow these steps:

Procedure

1. In the IBM InfoSphere DataStage and QualityStage Designer, click the JobProperties button, and then click the Parameters tab.

2. Change the default value for the SECURE_FILE_TRANSFER to TRUE.3. Create the SSH private key file by name sshkey_file.4. Copy the SSH private key file to this location:

/opt/IBM/InformationServer/Server/Projects/UDM/udm/cfg/sshkey_file

5. Or, link the sshkey_file to the target private key file by using the followingcommands as dsadm:$ pwd/opt/IBM/InformationServer/Server/Projects/UDM/udm/cfg$ ls -l sshkey_filelrwxrwxrwx 1 dsadm dstage 23 Nov 7 21:47 sshkey_file ->

/home/dsadm/.ssh/id_rsa

Issuing a full dump in Alcatel-Lucent 5620 SAM LogToFile Technology Pack:

Procedure

1. Go to /opt/IBM/InformationServer/Server/Projects/UDM/udm/bin directory.2. Run the sendDoneMessage.sh file by using the following command:

cd /opt/IBM/InformationServer/Server/Projects/UDM/udm/bin./sendDoneMessage.sh

This command stops the job. For more information, see “Gracefully shuttingdown the job” on page 64.

3. Check the status of the daemon by using the following command:./daemon.sh status

Output of the command is as follows:[dsadm@qads bin]$ ./daemon.sh statusUDMD_STATUS=STOPPEDUDMD_REASON=’daemon no longer running’

4. Clear the content from the following directories:v in

v done

v out

v cache


5. Log in to the Apache ActiveMQ, and then click Operations > Delete to deletethe queue.

6. ClickStart > All Programs > IBM InfoSphere Information Server > IBMInfoSphere DataStage and QualityStage Director.

7. In the Director client, select the job, and then click Clear Log.8. In the Director client, select the job, and then click Reset to reset the job.9. In the Director client, open the log pane, and click Run now. For more

information, see “Running the job” on page 63.10. In the Job Run Options window, click Limits > Warnings > No Limit.11. Click Run.

Installing the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0Technology PackThe Topology Editor was introduced at the same time as the 4.3-U technology packrelease. All 4.3-U or higher UBA technology pack installations require the TopologyEditor to configure the technology pack.

Configuration details are described in the Pack Installation and Configuration Guide.You can install the Alcatel-Lucent 5620 SAM LogToFile 2.4.0.0 Technology Packeither from a launchpad or by using the command line.

Tivoli Netcool Performance Manager supports the 4.3-U or higher technology packinstallation procedures.

All technology packs, both legacy bundle and stand-alone packs, require theTechnology Pack Installer. Always use the latest Technology Pack Installer,regardless of the version of the technology pack.

Important: The latest Technology Pack Installer (ProvisoPackInstaller.jar file)version is 3.6.0.0. It works on both Oracle and IBM DB2®.

All technology packs require that the Starter Kit or the Pack Bundle PrerequisitePack to be installed.

Prerequisite software:

Ensure that you fulfill these prerequisites before you install and configure theAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack.

Prerequisite software for Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Packinstallation:

You must have all the prerequisite software and required information before youinstall and configure a technology pack.v IBM Tivoli Netcool Performance Manager 1.4v 1.4.0.0-TIV-TNPM-IF0021v 1.4.0.0-TIV-TNPM-IF0024v Oracle 11g client 64 bitv UBA collectors. You can add UBA collectors as described in Add a Collector in

Installing Tivoli Netcool Performance Manager - Wireline Component and associate itwith a UBA pack as part of this technology pack installation.

v Ensure that you have access to the Tivoli Netcool Performance ManagerDataMart server that is running an X Window System server.


Note: If there is no graphics card on the DataMart server, the Xvfb virtual framebuffer package that provides X Window System services is automaticallyinstalled. For more information, see Setting Up a Remote X Window Display inInstalling Tivoli Netcool Performance Manager - Wireline Component.

v Ensure that you have access to the Dashboard Application Services Hub portal.v Ensure that you have access to the DataChannel server.v Ensure that you have access to the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0

Technology Pack installation files on one of the following locations:– Product distribution site: https://www-112.ibm.com/software/howtobuy/

softwareandservices. On the product distribution sites are theProvisoPackInstaller.jar file, and technology pack JAR files.

– Tivoli Netcool Performance Manager CD distribution, which contains theProvisoPackInstaller.jar file, technology pack JAR files, and the JAR filesfor the Starter Kit components.For more information about the Starter Kit, see “Preinstallation setup tasks.”For more information about obtaining software, see your IBM customerrepresentative.

v The correct version of Java. For more information, see ConfigurationRecommendations.

v Apache ActiveMQ v5.5.1 that is bundled with the Alcatel-Lucent 5620 SAMLogToFile 2.5.0.0 Technology Pack JAR file.

Additional information: Before configuring a technology pack, ensure that you:v Have the following documentation for your version of Tivoli Netcool

Performance Manager:– Release summary for the current technology pack release– Installing packs

– Upgrading packs (if you are upgrading the technology-pack software)– Upgrading Tivoli Netcool Performance Manager (if you are upgrading the core

software)– Configuring and Operating DataMart

Note: Refer to this document to create an inventory profile and initiate adiscovery.

v Ensure that you have access to the following site to check for interim fixes or fixpacks that might apply to your technology pack:http://www-306.ibm.com/software/sysmgmt/products/support/NetcoolProviso.html

v The Tivoli Netcool Performance Manager documentation and the IBM TivoliNetcool Performance Manager: Pack Release Notes, which are available on thefollowing website:IBM Knowledge Center for Tivoli Netcool Performance Manager 1.4

v The Oracle TNS name of the server on which you installed Oracle server withthe Tivoli Netcool Performance Manager database configuration. For moreinformation, see Specifying a Basename for DB_USER_ROOT in the Installing TivoliNetcool Performance Manager - Wireline Component.

Preinstallation setup tasks:

Ensure that all necessary configuration steps are completed on the prerequisitesoftware.v Completed the following tasks:


https://www-112.ibm.com/software/howtobuy/softwareandservices


http://www-306.ibm.com/software/sysmgmt/products/support/NetcoolProviso.html

http://www-306.ibm.com/software/sysmgmt/products/support/NetcoolProviso.html

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7_1.4.0/com.ibm.tnpm_1.4_kc.doc/tnpm_1.4_kc_welcome.html

– Reviewed the release notes for the current technology pack.

Note: Release notes contain important information that you must considerbefore you install a technology pack. They also contain information aboutspecific patches that must be installed before you configure a technology pack

– Installed the 1.4 version of the Tivoli Netcool Performance Managercomponents, as described in the Installing Tivoli Netcool Performance Manager -Wireline Component.

– Configured at least one DataChannel.– Created a user on the server with permission to FTP and delete files.

v Open a terminal emulator and log on to the DataMart server as pvuser.v Change your working directory to the DataMart home directory (/opt/datamart,

by default).v Load the shell with the DataMart environment by sourcing the dataMart.env

file, as follows:. /opt/datamart/dataMart.env

Note: After you load the DataMart environment into the shell, the PVMHOMEvariable is set to the DataMart home directory, /opt/datamart, by default. Theseinstructions assume that this variable is set.

v Set and export the DISPLAY environment variable (see Setting Up a Remote XWindow Display in the Installing Tivoli Netcool Performance Manager - WirelineComponent), so that the Technology Pack Installer GUI displays back on yoursystem.

v Installed the Technology Pack.

Note: Localization is done automatically during installation of the technologypack.

Preparing the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Packinstallation directory:

You can obtain technology pack installation files from the IBM product distributionwebsite, or from the Tivoli Netcool Performance Manager technology pack CD.

Before you begin

If you are installing the packs by using an instance of the Tivoli NetcoolPerformance Manager launchpad on the local file system, you can install directlyfrom the CD. Otherwise, you must create a temporary directory and copy thetechnology pack files to the local system before you begin the installation. Youcannot run the launchpad from the Tivoli Netcool Performance Manager DVD, andthen install technology packs directly from the CD distribution.

Note: If you are using a local instance of the launchpad and you want to installdirectly from the technology pack CD, you can skip this step and proceed to“Installing the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack” onpage 67.

Procedure

1. On the system where DataMart is located, use the mkdir command to createapp-packs directory to hold the technology pack JAR files and theProvisoPackInstaller.jar file. For example:


mkdir -p $PVMHOME/version/app-packs

2. If you want to use technology packs from the IBM product distributionwebsite, download the JAR files by following these steps:a. Use the cd command to change your working directory to the app-packs

directory that you created in Step 1. For example:cd $PVMHOME/version/app-packs

b. Download the following from this website:https://www-112.ibm.com/software/howtobuy/softwareandservicesv ProvisoPackInstaller.jar filev JAR files for technology packs you want to install (the bundled JAR file

for bundled packs or individual JAR files for stand-alone packs)3. If you want to use technology packs from the Tivoli Netcool Performance

Manager technology pack CD, browse to the /Proviso/AP/jar location on theCD and copy the following files to the temporary directory:v ProvisoPackInstaller.jar filev JAR files for technology packs you want to install (the bundled JAR file for

bundled packs or individual JAR files for stand-alone packs)4. Unmount the CD.

Installing the technology pack by using the launchpad:

Use this information to install a technology pack by using the launchpad.

Before you begin

Check the version of Java running on your system by entering the followingcommand:java -version

You must upgrade your version of Java depending on the technology pack release.

Important: For 4.3-U and higher technology packs, the launchpad requires you toenter the path to supported Java runtime binary files. Only version 1.5.0_b(14+) issupported. The Tivoli Netcool Performance Manager topology editor provides asupported version of the Java binary files. Using the older Java version mightresult in an error detailing that it is not possible to proceed with the installation.

About this task

To install a Tivoli Netcool Performance Manager technology pack, follow thesesteps:

Procedure

1. Start the installer as follows:a. If it is not already open, open the launchpad (see Starting the Launchpad in

the Installing Tivoli Netcool Performance Manager - Wireline Component).

Note: Open a terminal emulator and log on to the DataMart server aspvuser. You must su to root. Otherwise, the launchpad fails to start.

b. On the launchpad, click Install Technology Pack.c. On the Install Technology Pack window, enter the following information:v The DataMart home directory (for example,/opt/datamart, by default).



v The Java run time environment home directory (for example,/opt/IBM/proviso/topologyEditor/jre/bin).

Note: For information about supported JRE versions, see the IBM TivoliNetcool Performance Manager: Configuration Recommendations.

v The Tivoli Netcool Performance Manager user (for example, pvuser).d. Click the Install Technology Pack link.

A window prompts you to select the technology pack installation setupdirectory.

e. Click Browse to locate the temporary directory ($PVMHOME/version/app-packs) that you created in “Preparing the Alcatel-Lucent 5620 SAMLogToFile 2.5.0.0 Technology Pack installation directory” on page 69, or thedirectory on the Tivoli Netcool Performance Manager CD where the packJAR files are located (by default, /Proviso/AP/jar).The technology pack can be loaded to the server where the Tivoli NetcoolPerformance Manager database is installed.

f. Click the directory, and then click Select to display the specified directoryin the window.

g. Click OK.When the Technology Pack Installer starts, it displays a Tivoli NetcoolPerformance Manager Technology Packs Welcome window.

2. Click Next.3. Accept the license agreement, and then click Next.

The Technology Pack Installer displays the Database Access Parameterswindow with the parameter values that you specified when installing andconfiguring Oracle, the Tivoli Netcool Performance Manager database, andTivoli Netcool Performance Manager DataMart. For more information, seeInstalling and configuring the prerequisite software and Installing in a distributedenvironment in the Installing Tivoli Netcool Performance Manager - WirelineComponent.

4. Reenter the password of the database user, which is PV by default.5. Click Next to continue.

The Technology Pack Installer displays the Tivoli Integrated Portal accessparameter values that you specified when installing and configuring TivoliNetcool Performance Manager DataView as described in Installing in adistributed environment in the Installing Tivoli Netcool Performance Manager -Wireline Component.

Note: The Technology Pack Installer GUI always displays 16315 as the defaultport number for Tivoli Integrated Portal. If you want to use a different portnumber, you must give the port number at the time of Tivoli NetcoolPerformance Manager installation. Otherwise, the Technology Pack Installerdisplays an error message and you cannot proceed with the installation.

6. Reenter the password, which is tipadmin for the Tivoli Integrated Portal user.The Technology Pack Installer displays a Feature Selection window, which listsall the packs you downloaded to the directory created in “Preparing theAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack installationdirectory” on page 69 in the left panel. All the packs are automaticallyselected for installation.

7. Clear any technology packs in the list that you do not want to install, andthen click Next.


Note: The prerequisites for technology packs item in the Feature Selectionwindow is always installed. You cannot clear this item. The Starter Kit is notincluded in this item.Depending on the type of packs you install, you might be presented withslightly different windows.

8. Click Next to start the installation.As the stand-alone packs are installed, the Technology Pack Installer displaysthe name of each pack and indicates the progress. When the installationcompletes, the Technology Pack Install Complete window is displayed.

9. Click Finish to exit the Technology Pack Installer.10. Go to What to do next section to perform post-installation tasks.

What to do next

After the installation completes, do the following tasks:

Important: A technology pack does not work until it is configured. After youconfigure the technology pack, data is collected and reports are populated.v Populate the family dictionary table as described in “Populating the family

dictionary table.”v Add a UBA collector as described in“Adding a UBA collector for a UBA pack”

on page 73.v Configure the technology pack as described in “Configuring the technology

pack” on page 74.

Populating the family dictionary table:

Use this information to populate the family dictionary table for any newAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0 installation.

Procedure

1. Change your working directory to the standard directory by using thefollowing command:cd $PVMHOME/APFiles/alcatel_5620_sam_log2file/datamart/standard/

2. Provide the run permission to the importLogToFileFamilyDictionary.rmg scriptfile by using the following command:chmod +x importLogToFileFamilyDictionary.rmg

3. Source the DataMart environment by using the following command:.$PVMHOME/dataMart.env

4. Run the importLogToFileFamilyDictionary.rmg script file by using thefollowing command:./importLogToFileFamilyDictionary.rmg

Initially, you receive the $Import has started message. When the import iscompleted, you see the $Completed import message.

UBA collectors: The UBA collector is associated with two DataChannelcomponents:

Complex Metric Engine (CME)x.xPerforms calculations on the collected data.


File Transfer Engine (FTE)x.xTransfers files from the collector output directories and places them in theinput directory of the CME.

Note: Topology Editor includes the channel and collector numbers in thecomponent names. For example, Data Channel 1 can have Collector UBA1.1, with Complex Metric Engine 1.1 and File Transfer Engine 1.1.The FTE writes data to the file /var/adm/wtmpx on each system that hosts acollector. As part of routine maintenance, check the size of this file toprevent it from growing too large. For more information about Disk QuotaManagement, see Installing Tivoli Netcool Performance Manager - WirelineComponent.

Note: The Solaris version can be configured with strict access defaultsettings for secure environments. Strict FTP access settings might interferewith automatic transfers between a DataChannel subchannel and theDataLoad server. Check for FTP lockouts in /etc/ftpd/ftpusers, and checkfor strict FTP rules in /etc/ftpd/ftpaccess.

Follow the instructions in “Adding a UBA collector for a UBA pack.”

Adding a UBA collector for a UBA pack:

Use this information to add a UBA collector.

Procedure

1. Load the pack XSD file into an existing topology, as follows:a. If it is not already open, open the Topology Editor (see Starting the Topology

Editor in the Installing Tivoli Netcool Performance Manager - WirelineComponent).

b. Open a deployed topology (a topology.xml file) (see Opening an ExistingTopology File in the Installing Tivoli Netcool Performance Manager - WirelineComponent).

c. In the Technology Pack view, right-click the Technology Packs folder andselect Load Technology Pack from the menu.The Load the technology pack configuration metadata window displays.There are two radio buttons: XSD file and JAR file.

d. Click the JAR file radio button and select Browse.There is a known issue and a workaround for opening an XSD file from aUBA pack. For more information, see UBA pack XSD file inside a JAR filecannot be loaded into the Topology Editor section in IBM Tivoli NetcoolPerformance Manager: Pack Release Notes.

e. Using the Directory: field, the up and down arrows, and the Folders paneon the configuration metadata window, go to the directory where thetechnology pack JAR files exist. For example, $PVMHOME/APFiles or adirectory on the Tivoli Netcool Performance Manager CD

f. Select a technology pack JAR file, and then click OK. The pack JAR file isdisplayed in the configuration metadata window.

g. Click Finish. The Topology Editor adds the selected stand-alone technologypack to the list of technology packs displayed in the Technology Packsview.

2. After you load a UBA pack XSD file, you must add a UBA collector andassociate it with a UBA technology pack as follows:


a. In the Logical view, right-click the DataChannel x folder and select fromthe Add collector UBA menu.The Configure Collector window opens.

b. Select the technology pack. For example, Alcatel-Lucent 5620 SAMLogToFile from the list of technology packs, and then click Next.

c. Using the list of available hosts on the Configure Collector window, selectthe workstation that hosts the collector. For example, corinth

d. Accept the default collector number. For example, 2.e. Click Finish.

The Topology Editor displays the new collector under the DataChannel xfolder in the Logical view.

f. Highlight the collector to view its properties. The Topology Editor displaysboth the UBA collector core parameters and the UBA technologypack-specific parameters. The core parameters are configured with all UBAtechnology packs. Review the values for the parameters to make sure thatthey are valid. For information about the core parameters, see the PropertiesReference. For information about the pack-specific parameters, see theTopology Editor Help.

g. To add extra UBA collectors for a UBA technology pack, repeat Step 2-athrough Step 2-f.

h. Redeploy the updated topology. See Starting the Deployer in the InstallingTivoli Netcool Performance Manager - Wireline Component.

3. Configure the UBA technology packs.

Log files:

The Technology Pack Installer writes log files to the /usr/tmp directory.

Log files in this directory contain a detailed history of the tasks the TechnologyPack Installer performs as it installs technology packs. You can check this log fileto help solve any issues that might occur during technology pack installation. Forexample, a log file might contain a message that indicates that the Technology PackInstaller GUI cannot display back on your system because the DISPLAYenvironment variable was not set. For more information, see Setting Up a Remote XWindow Display in the Installing Tivoli Netcool Performance Manager - WirelineComponent.

Log files for bulk technology packs are named installer<timestamp>.log, wheretimestamp is the time that the file was created in seconds since the UNIX epoch.Log files for stand-alone packs are named: APInstall<timestamp>.log.

For technology packs, log file names have the format APInstall<number>.log. Forexample: APInstall1311248677586.log.

Configuring the technology packConfigure the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology pack.

Before you begin

Ensure that you:v Have the following software and documentation for your version of Tivoli

Netcool Performance Manager:– IBM Tivoli Netcool Performance Manager: Pack Release Notes for the current

technology pack release


– Installing Tivoli Netcool Performance Manager - Wireline Component.– Installing and Configuring Technology Packs.– Configuring and Operating DataMart

Important: For more information about running a bulk inventory profile, seeConfiguring and Operating DataMart document.

– Access to the Tivoli Netcool Performance Manager DataMart server

Note: Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology pack issupported on Tivoli Netcool Performance Manager 1.4.

– An X Window server on the DataMart server– Access to the Tivoli Integrated Portal– Access to the DataChannel server.

v Ensure that you completed the following tasks:– Reviewed the release notes for the current technology pack.

Note: Release notes contain important information that you must considerbefore you install a technology pack. They also contain information aboutspecific patches that must be installed before you configure a technologypack.

– Installed the current version of the Tivoli Netcool Performance Managercomponents, as described in the Installing Tivoli Netcool Performance Manager -Wireline Component.

– Installed the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack.– Configured at least one DataChannel.– Configured two UBA Bulk Collector subchannels.– Created a user on the Alcatel-Lucent 5620 SAM server with permission to FTP

and delete files.v Configured the XSD file. To configure the XSD file, follow these steps:

1. Open the Topology Editor, and click Topology > Open existing topology toload existing topology from database

2. On the Technology Packs pane, load the Alcatel-Lucent SAM 5620 LogToFileXSD file.

3. In the Logical View, create the following collectors on any new or existingchannels, and configure their corresponding parameters:– Performance UBA– Accounting UBA

4. Click Run > Run Deployer for Installation to deploy the topology that youconfigured.

To configure the Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack,follow these steps:

Procedure1. Load the DataMart environment. To load the shell with the DataMart

environment, follow these steps:a. Log in to the DataMart server as pvuser.b. Create new folder DATA_CHANNEL_HOME/scripts/alcatel_5620_sam_log2file.c. Change your working directory to the DataMart home directory

(/opt/datamart, by default), by using the following command:


$ cd /opt/datamart

d. Load the shell with the DataMart environment, by sourcing thedataMart.env file, as follows:$ . /opt/datamart/dataMart.env

Note: After you load the DataMart environment into the shell, thePVMHOME variable is set to the DataMart home directory, /opt/datamartby default. These instructions assume that this variable is set.

2. Copy technology-specific files from the DataMart server to the DataChannelserver. Technology-specific files are used to associate a UBA technology packwith a specific instance of the UBA.


entering the user name and password that you specified when you installand configuring a DataChannel. The default user name and password arepvuser and PV.

b. Change your working directory to the DATA_CHANNEL_HOME/scripts/alcatel_5620_sam_log2file directory by entering the following command,replacing DATA_CHANNEL_HOME with the DataChannel home directory(/opt/datachannel, by default):$ cd DATA_CHANNEL_HOME/scripts/alcatel_5620_sam_log2file

c. Using the FTP utility in text mode, log in to the DataMart server by usingthe appropriate user name and password (pvuser and PV, by default).

d. Using the cd subcommand, change your working directory to the$PVMHOME/APFiles/alcatel_5620_sam_log2file/datachannel/scripts/alcatel_5620_sam_log2file directory.

e. By using the get subcommand, copy the bulk adapter design files (*.js),scripts (if any), and other files (if any) from the DataMart server to theDataChannel server.

f. Exit the FTP utility by entering the bye subcommand.g. Verify that the technology-specific files are now in the target directory as

follows:v Verify that the bulk adapter design files (*.js), scripts, other files (if any)

are now in the $ cd DATA_CHANNEL_HOME/scripts/alcatel_5620_sam_log2file directory.

3. Copy the samOss.jar file to the IBM InfoSphere Information Server. ThesamOss.jar file is distributed on a SAM distribution DVD referred to as the5620 SAM software DVD-ROM, and is in the following directory: ,<SAM_ROOT_RELEASE_DIR>/nms/integrations/SAM_O

You must copy the samOss.jar file from the directory on the DVD to the/opt/IBM/InformationServer/Server/Projects/UDM/udm/jar directory.

4. Activate data collection requests. During installation of the technology pack, allpredefined data collection requests are promoted to the database and set toinactive (that is, idle displays in the Active column of the Tivoli NetcoolPerformance Manager DataMart Request Editor). You must activate these


predefined data collections requests by using the Request Editor. To set datacollection requests to active, follow these steps:a. Change your working directory to $PVMHOME/bin (/opt/datamart/bin, by

default) on the DataMart server.b. Start the DataMart GUI by entering the following command and pressing

Enter:$ pvm

c. Click the Configuration tab, then click Request Editor to open the RequestEditor.




the following group or groups: Root->Sub-Element Collect->Alcatel-Lucent 5620 SAM


i. Click Save.5. Load the DataChannel environment. In subsequent steps, you can run the

dccmd commands. To ensure that you can run these commands, load the shellwith the DataChannel environment by following these steps:a. Log in to the DataChannel server as pvuser.b. Change your working directory to the DataChannel home directory

(/opt/datachannel, by default), by using the following command:$ cd /opt/datachannel

c. Load the shell with the DataChannel environment, by sourcing thedataChannel.env file, as follows:$ . /opt/datachannel/dataChannel.env

6. Restart the DataChannel to activate the UBA and read in changes to thedeployed topology.a. Open a terminal emulator on the DataChannel server.b. Use the dccmd command to stop all DataChannel applications:

$ dccmd stop all

c. Use the dccmd command to release all daemons that are running in theDataChannel:$ dccmd forget all

d. Use the following command to find the process identifiers (pids) associatedwith the DataChannel visual processes:$ findvisual

e. Use the following commands to stop each DataChannel visual process:$ kill -9 <cnsw_pid>$ kill -9 <logw_pid>$ kill -9 <amgrw_pid>$ kill -9 <cmgrw_pid>

f. Use the following commands to restart each DataChannel visual process:


$ cnsw$ logw$ amgrw$ cmgrw

g. Use the dccmd command to start all DataChannel applications:$ dccmd start all

h. Use the dccmd command to verify that all of the DataChannel applicationsstarted properly:$ dccmd status all

More specifically, make sure that the UBA application associated with theDataChannel that you configured for the Alcatel-Lucent SAM 5620LogToFile Technology Pack is running.

i. Watch the output of the status switch to verify that all the necessaryprocesses are running. If these processes are running, run the tail utility onthe log file for the UBA by running a command similar to the followingcommand:tail -f DATA_CHANNEL_HOME/log/proviso.log | grep UBA.<channel_number>.<collector_number> | more

where:

Variable Meaning

<channel_number> Specifies the channel number.

<collector_number> Specifies the collector number (for example,100) that you specified when you configurethis UBA Bulk Collector.

The trailing dash (–) after <collector_number> Removes extraneous log messages from yourview. That is, the trailing dash guaranteesthat the command displays only thosemessages that are generated by yourapplication. The first set of messages relateto syntax checks.


Event Meaning

The UBA application starts successfully, butthen stops running.



This event causes a syntax error before theUBA application connects to the database.


This event causes a message similar to thefollowing example to display: DB_CONNECTConnecting to <sid> as <user> If you seethis database connection message withoutprior errors, the UBA application passed thesyntax check.

7. Run the bulk inventory profile. The UBA application handles the inventory andmetrics according to the instructions provided in the technology pack designfile or files. The UBA application inserts the created elements, subelements, andmetrics into the database. However, the UBA application does not handle thegrouping of these elements and subelements. To handle the grouping of theelements and subelements that were inserted into the database, UBA


technology packs supply a bulk inventory profile. This bulk inventory profile isautomatically created when the pack is installed. Bulk inventory profiles usethe following name syntax: bulk_N where:

Syntax item Meaning

bulk_ Identifies as a bulk inventory profile for aUBA technology pack.

N Specifies the collector number (for example,100) that the user specified when youconfigure this UBA Bulk Collector.

You must use the Inventory Tool to run a bulk inventory profile. To run thebulk inventory profiles for this technology pack, do the following steps:a. In the command window where you loaded the DataMart environment,

change your working directory to $PVMHOME/bin (/opt/datamart/bin, bydefault) on the DataMart server.

b. Start the DataMart GUI:$ pvm

c. Click Inventory Tool in the Resource tab. The Inventory Tool windowappears. This window displays a list of the existing inventory profiles onthe Configuration tab. The names of the inventory profiles to run arebulk_N1 and bulk_N2, where N1 and N2 are the collector numbers that areconfigured for this pack.

d. On the Configuration tab, click the bulk inventory profiles for thistechnology pack and then select Run Profile from the Action menu. TheLive Information tab displays messages about the status of the profiles. Formore information about running an inventory profile, see Configuring andOperating DataMart.

e. Every time the UBA technology pack design file creates new elements,subelements, and metrics, you must perform the previous steps to groupthe elements and subelements. One way to accomplish this task regularly isto create a cron entry that uses the inventory command. The followingexample shows the cron entries that periodically perform the groupingoperation for the bulk inventory profiles that are called bulk_100 andbulk_101:0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100-action pregrouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100-action grouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_101-action pregrouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_101-action grouping -reload -noX

For more information about the inventory command, see Command LineInterface Reference.

8. Deploy reports. After the technology pack installation completes, the rules forthe new device are automatically loaded into the database. The inventoryprocess uses those rules to group elements and subelements. You mustmanually deploy (auto-group) the reports by associating them with groups inthe NOC Reporting tree in the DataMart Resource Editor. To deploy theAlcatel-Lucent SAM 5620 LogToFile Technology Pack reports, follow thesesteps:a. Open the Tivoli Netcool Performance Manager DataMart Resource Editor.b. Click the ReportSEGroup tab.


c. Move the cursor to the left pane and scroll up to select any group under theSUB-ELEMENTS > NOC Reporting tree.

d. Right-click and select the AutoGrouping option from the menu. TheAutoGrouping option places the reports in dynamically generated groupsthat are created during inventory.

e. Click Yes to continue.f. Click Close to exit the message box, or click Details to view a description of

any errors.g. You can also deploy reports regularly by creating a cron entry that uses the

inventory CLI command and the-reportGrouping

option. This option instructs the inventory command to run the reportgrouping rules and update the deployed reports that are stored in thedatabase. Report grouping rules must first are created before this option canbe used. For information about creating report grouping rules, seeConfiguring and Operating DataMart. The following example shows a cronentry that periodically performs the deployment report operation:0 * * * * . /opt/datamart/dataMart.env && inventory -noX -reportGrouping

For more information about the inventory command, see Command LineInterface Reference.

Verifying resources:

Use the Tivoli Netcool Performance Manager DataMart Resource Editor todetermine whether the technology pack resources (elements, subelements,properties, and so on) were successfully discovered and created in the databaseduring inventory.

For information about using the DataMart Resource Editor, see the IBM TivoliNetcool Performance Manager DataMart Configuration and Operation Guide.

Configuring Secure File Transfer support in Alcatel-Lucent 5620 SAM LogToFile2.5.0.0 Technology Pack:

If you want to use Secure File Transfer, OpenSSH must be configured forkey-based authentication when you connect from the Tivoli Netcool PerformanceManager account on the client (the host that is running the Tivoli NetcoolPerformance Manager process that must use SFTP) to the account on the server. Inaddition, the host keys must be established such that the host key confirmationprompt is not displayed during the connection.

UBAs in Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack can connectto the DataStage server by using FTP alone.Related information:

SSH login without password

Secure File Transfer Installation

Upgrading the Alcatel-Lucent 5620 SAM LogToFile TechnologyPackDescribes how to upgrade Alcatel-Lucent 5620 SAM LogToFile 2.4.0.0 TechnologyPack to Alcatel-Lucent 5620 SAM LogToFile 2.5.0.0 Technology Pack.


http://www.linuxproblem.org/art_9.html

https://tnpmsupport.persistentsys.com/sites/all/themes/corporate/4.4.3/wireline/NetcoolProvisoTechNote-sftp.pdf

Note: There is no support for upgrade from Alcatel-Lucent 5620 SAM 2.14.0.0 orearlier versions that are based on FindToFile technology to Alcatel-Lucent 5620SAM LogToFile Technology Pack.

Upgrading the Alcatel-Lucent 5620 SAM LogToFile 2.4.0.0 Technology Pack toAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0:

You can upgrade the Alcatel-Lucent 5620 SAM 2.4.0.0 Technology Pack toAlcatel-Lucent 5620 SAM LogToFile 2.5.0.0.

About this task

To upgrade the Alcatel-Lucent 5620 SAM 2.4.0.0 Technology Pack to Alcatel-Lucent5620 SAM LogToFile 2.5.0.0.

Procedure

1. Upgrading the DataStage Job

a. Stop the Job by referring to Gracefully shutting down the job section.b. Move the existing udm directory inside UDM project to udm_bk.c. Create a directory by name udm inside the project that being created by

using the following commands:$ cd /opt/IBM/InformationServer/Server/Projects/UDM$ umask 002$ mkdir udm

d. Extract the alcatel_5620_sam_ds_vm.n.0.0_build_b.tar.gz file in/opt/IBM/InformationServer/Server/Projects/UDM/udm by using thefollowing command:$ tar -zxvf alcatel_5620_sam_ds_vm.n.0.0_build_b.tar.gz

e. Configuration files under udm/cfg folder will have default configuration,change it as per requirements.

f. Copy samOss.jar file to IBM InfoSphere Information Server. The samOss.jarfile is distributed on a SAM distribution DVD which referred to as the 5620SAM software DVD-ROM. It is available in the followingdirectory<SAM_ROOT_RELEASE_DIR>/nms/integrations/SAM_O . Please copy thesamOss.jar file from the directory on the DVD to /opt/IBM/InformationServer/Server/Projects/UDM/udm/jar directory.

g. Importing DataStage job in DataStage Designer Client. Refer to Importing anIBM InfoSphere DataStage job section.

h. Run the DataStage job from Director Client. Refer to Running the job section2. Upgrading Technology Pack

a. Stop the DataChannel:1) Start a terminal emulator on the DataChannel server2) Run the dccmd command to stop all the DataChannel applications:

$ dccmd stop all

3) Run the following command to find the process identifiers (pids) thatare associated with the DataChannel visual processes:$ findvisual

4) Run the following commands to remove the files:$ kill -9 <cnsw_pid>$ kill -9 <logw_pid>$ kill -9 <amgrw_pid>$ kill -9 <cmgrw_pid>


b. Run the following commands to remove the files:v /opt/proviso/datachannel/bin

rm –rf *_visual

v /opt/proviso/datachannel/staterm –rf *pidrm -rf *_visual

v /opt/proviso/datachannel/logrm –rf *log

c. Create backup of the DataChannel directories and do not delete them fromthe original location.

d. Install the Alcatel-Lucent 5620 SAM LogToFile 2.4.0.0 Technology Pack. Formore information, see Installing Technology Packs guide.

e. Start the Topology Editor and load the technology pack from the JAR file.f. Check the properties set in the UBA Collectors. Modify the value

accordingly for the upgrade environment, if needed.g. Save the topology.h. Run the deployer to complete the installation.i. Start the Request Editor, set to inactive, and then Save.j. Update the polling time to 5 Minutes or 15 Minutes, set to active, and then

click Save

k. Run the following commands to restart each DataChannel visual process:$ cnsw$ logw$ amgrw$ cmgrw

l. Run the dccmd command to start all the DataChannel applications:$ dccmd start all

m. Compile the uba profiles.n. Run the auto-grouping again after the full dump process is completed for

the first time.

Configuring Java for connecting to SAM Server 13:

Connecting to SAM 13

Procedure

1. Install Java version 1.7.0_76-b13 (Oracle Corporation) or later on DataStageserver.

2. Update JAVA_HOME variable in <DataStage_Home>/udm/bin/env.sh file to the newinstalled Java as follows:#JAVA 1.7 path to connect to SAM13export JAVA_HOME=<JAVA 1.7 Path>

3. Run the job from director client.

Setting up the Alcatel-Lucent 5620 SAM servers to supportLogToFileThe SAM server administrator must set up the appropriate SAM serversenvironment so that the Alcatel-Lucent SAM 5620 LogToFile Technology Packoperates correctly.


About this task

Setting up the Alcatel-Lucent 5620 SAM servers includes the following tasks:

Install SAM on the primary and redundant servers:

The SAM server administrator must have installed SAM on primary andredundant servers. The DataStage job accesses the SAM servers to request theinventory and metrics.

Synchronize the clocks:

Use the appropriate tool to ensure that the clocks on the SAM server and theserver on which the DataStage is installed are synchronized.

For example, make sure that the Coordinated Universal Time (UTC) on the serveron which DataStage is operating matches the UTC time on the server on whichAlcatel-Lucent 5620 SAM is operating.

Install the Alcatel-Lucent 5620 SAM Client GUI:

The SAM server administrator must have installed the Alcatel-Lucent 5620 SAMClient GUI on some client computer or server.

During the installation, the SAM server administrator must configure the IPaddresses of the SAM primary and redundant servers.

Configure an OSS user account:

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI toconfigure an OSS (operational support system) user account from the clientcomputer or server.

This user account consists of a user name and password that allows the user toaccess the SAM primary and redundant servers. This OSS user account must nothave administrative privileges. The SAM server administrator must record the username and password for this OSS user account and keep it in a secure place.

The IBM InfoSphere Information Server needs access to this OSS account.

Configure the SAM accounting and polling statistics:

Accounting policies are relevant to the Access Interfaces and the metrics that theyreport. The type of accounting policy on an Access Interface determines the metricsthat are reported.

When inventory is collected, Tivoli Netcool Performance Manager learns theaccounting policy for each Access Interface. From these accounting policies, theAlcatel-Lucent 5620 SAM LogToFile Technology Pack can determine the accountingpolicy type.

The Alcatel-Lucent 5620 SAM defines and manages accounting policies, whichdetermine how SAM accounting statistics are collected. The Alcatel-Lucent 5620SAM LogToFile Technology Pack currently supports two types of SAM accountingstatistic: access-port statistics and network-port statistics. The accounting package


provides a maximum of 13 active accounting policies, one for each type of recordfor the eight access-port statistics types and for the five network-port statisticstypes.

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI toconfigure SAM accounting statistics on the primary and redundant SAM servers.

The Alcatel-Lucent 5620 SAM LogToFile Technology Pack supports the accountingpolicies that are listed in the Table, depending on the type of nodes that aremonitored.

Table 2. Supported accounting policies

Accounting policy Description

CombinedNetworkEgressOctetsLogRecord Manages the collection of octet activity foregress network queues.

CombinedNetworkIngressOctetsLogRecord Manages the collection of octet activity foringress network queues.

CompleteServiceEgressPacketOctetsLogRecord

Manages the collection of packet and octetactivity for egress service queues.

CompleteServiceIngressPacketOctetsLogRecord

Manages the collection of packet and octetactivity for ingress service queues.

ServiceEgressOctetsLogRecord Manages the collection of octet activity foregress service queues.

ServiceEgressPacketsLogRecord Manages the collection of packet activity foregress service queues.

ServiceIngressOctetsLogRecord Manages the collection of octet activity foringress service queues.

ServiceIngressPacketsLogRecord Manages the collection of packet activity foringress service queues.

Note:

The service.ServiceEgressOctetsLogRecord class and theservice.ServiceEgressPacketsLogRecord class are mutually exclusive. You cannotcollect metrics for both classes at the same time.

Similarly, the service.ServiceIngressOctetsLogRecord class and theservice.ServiceIngressPacketsLogRecord class are mutually exclusive. You cannotcollect metrics for both classes at the same time.

The SAM server administrator uses the appropriate utility to configure pollingstatistics for SAM statistics classes. To configure polling statistics for these SAMstatistics classes, enable the appropriate MIBs on the primary and redundant SAMservers.

The default Tivoli Netcool Performance Manager collection period for all types ofSAM statistics is set to every 15 minutes, so the SAM server policies must beconfigured to match this default value.

Note: The collection period for any type of SAM statistics must be set to the samevalue as the collection period for the corresponding Tivoli Netcool PerformanceManager requests.


Enable the MIBs for the SAM statistics classes:

SAM server administrator must enable all of the MIBs listed in the table for theAlcatel-Lucent 5620 SAM LogToFile Technology Pack.

The first column of the table identifies the SAM statistics class on which to enablepolling statistics; the second column identifies the MIBs to enable for the SAMstatistics classes; and the third column identifies the object types to enable. TheSAM server administrator can enable more object types, but the Alcatel-Lucent5620 SAM LogToFile Technology Pack expects at a minimum the ones that arelisted in the third column.

Table 3. MIBs to enable for SAM statistics classes

SAM statistics class MIB Object types

equipment.AllocatedMemoryStatsLogRecord TIMETRA-SYSTEMMIB sgiMemoryPoolAllocated

equipment.AvailableMemoryStatsLogRecord TIMETRA-SYSTEMMIB sgiMemoryAvailable

equipment.InterfaceAdditionalStatsLogRecord IF-MIB ifXEntry

equipment.InterfaceStatsLogRecord IF-MIB (in the filenamed rfc2233-IF-MIB)

ifEntry

equipment.MediaIndependentStatsLogRecord HC-RMON-MIB mediaIndependentEntry

equipment.SystemCpuStatsLogRecord TIMETRA-SYSTEMMIB sgiCpuUsage

equipment.SystemMemoryStatsLogRecord TIMETRA-SYSTEMMIB sgiMemoryUsed

mpls.MplsInterfaceStatsLogRecord TIMETRA-MPLS-MIB vRtrMplsIfStatEntry

ppp.PppStatsLogRecord andppp.PppControlProtocol

TIMETRA-PPP-MIB tmnxPppEntry

svt.SdpBindingBaseStatsLogRecord TIMETRA-SERV-MIB sdpBindBaseStatsEntry

ethernetequipment.Dot3StatsLogRecord EtherLike-MIB dot3StatsEntry

mpls.SiteStatsLogRecord TIMETRA-MPLS-MIB vRtrMplsGeneralStatEntry

service.PppoeSapStatsLogRecord TIMETRA-PPPOEMIB tmnxPppoeSapStatsEntry

svq.CustMultiSvcSiteIngSchedPlcyPortStatsLogRecord

TIMETRA-SERV-MIB custMultiSvcSiteIngSchedPlcyPortStatsEntry

svq.CustMultiSvcSiteEgrSchedPlcyPortStatsLogRecord

TIMETRA-SERV-MIB custMultiSvcSiteEgrSchedPlcyPortStatsEntry

aosqos.QoSIngressPolicyStatsLogRecord ALCATEL-IND1-QOS-MIB

alaQoSRuleEntry

equipment.CardHealthStatsLogRecord ALCATEL-IND1-HEALTH-MIB

healthModuleEntry

Setting up ping tests:

The SAM server enables SAM server administrators to run ping tests to receiveinformation about traffic latency and jitter.

The results from the tests can include SAM statistics such as round-trip time,one-way trip time, jitter. These test results can be collected as metrics against OAMTest object subelements representing the tests.

Note: This section describes one method of creating OAM (ping) tests. Thismethod uses the Alcatel-Lucent 5620 SAM Client GUI to set up the OAM test to


run periodically by using the scheduler on the SAM server. To run the OAM teston the SAM server, you must set the NE schedulable setting to off. This is only onemethod for running OAM tests and is provided for users who have no knowledgeabout how to run OAM tests. In other methods for running OAM tests, the NEschedulable setting can be set to on. In any method that is employed to run theOAM tests, the period of the tests must be set to the same value as the period forthe metric requests. The default value is 15 minutes.

A SAM server administrator can create ping tests in two ways:

Alcatel-Lucent 5620 SAM Client GUIThe Alcatel-Lucent 5620 SAM Client GUI allows a SAM serveradministrator to set up a ping test, specifying the period of the test, thetype of test, and so on.

OSS requestsThe SAM server administrator might also establish OSS requests thatcreates ping tests on the SAM server.

Although the two methods are available, the Alcatel-Lucent SAM 5620 LogToFileTechnology Pack expects that a SAM server administrator manually set up pingtests by using the Alcatel-Lucent 5620 SAM Client GUI. For more informationabout setting up these ping tests, see the Alcatel-Lucent 5620 Service Aware ManagerRelease 7.0 User Guide.

To collect ping-related SAM statistics that are meaningful within Tivoli NetcoolPerformance Manager, multiple consecutive data points must be collected for anyparticular OAM Test object subelement. Thus, it is recommended that ping tests beset up to run on a schedule that lasts for a significant duration (minimum threehours).

This section summarizes the steps to follow. For more information, see theAlcatel-Lucent 5620 Service Aware Manager Release 7.0 User Guide.v Create a test suite. Make sure the NE Schedulable option is selected and Test

Result Storage is set to Both Database and File

v Create one or more ping tests. The Alcatel-Lucent 5620 SAM LogToFileTechnology Pack supports several types of ping tests. Remember to select theNE Schedulable option and set the Test Result Storage to Both Database andFile. Make sure the tests run without errors.

v Add the ping tests to the test suite.v Create a schedule to run the test suite. Set the schedule to run at the same

frequency as the Tivoli Netcool Performance Manager collection requests forjitter and latency. For example, if Tivoli Netcool Performance Manager collectionrequests occur every 15 minutes, then set the schedule to run the ping test suiteevery 15 minutes.

Note: Ensure that you set the frequency to a value that is consistent with theother collection periods.

v Apply the schedule to the test suite and run the tests that are contained in thesuite. Each time a test completes, Tivoli Netcool Performance Manager collects aset of metrics.

SAM server administrators can run several types of ping tests to measure trafficcharacteristics at different levels of the network stack. Each ping test is represented


by its own SAM class and associated ping result class. For more information aboutthese classes, see the Alcatel-Lucent 5620 SAM XML Reference - Release 7.0documentation.

Modifying the collection strategyDescribes how to modify the amount of data that is managed by the Alcatel-Lucent5620 SAM LogToFile Technology Pack. You can modify by changing the types ofdata that are collected, or by changing the collection period for the SAM statistics,or both.

Specifying what inventory and metrics to collect:

The types of inventory and metrics that must be collected from SAM server isspecified in the configuration files. These configuration files are found on theDataStage server. The configuration files specify which inventory class and metricsclasses must be requested from the SAM server. The SAM server then creates thenecessary files that are received by DataStage.

About this task

There are three different configuration items:

Filter Drops the records.

PartitionEnables multiple UBAs.

WindowHandles different periods. For example, 5, 15.

Filter:The name of the filter file is filter_lookup.csv, and has the configuration level asUser. No match for this file is not available.

Fields Steps to get the information

Class name Name of the SAM Class. For metric classes,use <class name>LogRecord names.

Expression Set it as '1' (TRUE) if no filter is needed.

The Expression field accepts full blown Perl expressions with special variablesenclosed with '{}' to refer to attributes within the class. There is a special'{DEFAULT}' to refer to the partition key attribute of the class.

For example, equipment.PhysicalPort,{DEFAULT} eq "1.1.1.1"This expression means that the DataStage filter allows only theequipment.PhysicalPort class objects that have "1.1.1.1" value for its siteId.

equipment.PhysicalPort,{cardSlotId} != 2This expression means that the DataStage filter allows only theequipment.PhysicalPort class objects other than the card slot id of 2.

equipment.PhysicalPort,{DEFAULT} eq "1.1.1.1" && {cardSlotId} != 2 logicaloperator is supported.

equipment.PhysicalPort,{DEFAULT} =~ /^1.1/ Regular expression is supported. Itallows site key that starts with "1.1".equipment.PhysicalPort,0


It is the simple way to filter out all records of class equipment.PhysicalPort.

Configuring multiple UBA collectors instances:

PartitioningThe UBA partitioning involves two configuration files:1. collector_lookup.csv

2. collector_mapping.csv

collector_lookup.csvThe name of the filter file is collector_lookup.csv, and has theconfiguration level as User. No match for this file is not available. This fileis used to specify the number of UBAs that are available in theenvironment, and the type of each UBA. For details, see “Specifying whatinventory and metrics to collect” on page 87. Following is an example forthe collector_lookup.csv format:v 100, Performancev 101, Accounting

Fields Steps to get the information.

Collector id Id for the collector that is based on the UBAconfiguration.

Class category Performance or Accounting.

Note: You must update this configuration.

collector_mapping.csvThe name of the filter file is collector_mapping.csv, and has theconfiguration level as User. No match for this file is not available.Following is an example for the collector_mapping.csv format:v 5620_SAM_Channel,10.1.241.76,100v 5620_SAM_Shelf,38.120.242.185,100

Fields Steps to get the information.


Class Family Possible family classes are as follows:

v 5620_SAM_AingrAengrQueue

v 5620_SAM_Aosqos_Policy

v 5620_SAM_BaseCard

v 5620_SAM_CardSlot

v 5620_SAM_CfmEthTest

v 5620_SAM_CfmOneWayDelay

v 5620_SAM_CfmTwoWayDelay

v 5620_SAM_CfmSingleEndedLoss

v 5620_SAM_Channel

v 5620_SAM_ControlProcessor

v 5620_SAM_DaughterCard

v 5620_SAM_DHCP6_Address

v 5620_SAM_DS1_E1

v 5620_SAM_Hw_Environment

v 5620_SAM_IMALink

v 5620_SAM_ISA_Mda

v 5620_SAM_ISA_Member

v 5620_SAM_LAGInterface

v 5620_SAM_MCMCard

v 5620_SAM_MME

v 5620_SAM_MPLSInterface

v 5620_SAM_MPLS_Site

v 5620_SAM_MSS

v 5620_SAM_NQueue

v 5620_SAM_OAM_Test

v 5620_SAM_PhysicalPort

v 5620_SAM_PPP_Interface

v 5620_SAM_PPP_Protocol

v 5620_SAM_S11Peer

v 5620_SAM_S1UPeer

v 5620_SAM_S5Peer

v 5620_SAM_S8Peer

v 5620_SAM_SdpBinding

v 5620_SAM_ServiceAccessInterface

v 5620_SAM_Shelf

v 5620_SAM_Subnet_Address

v 5620_SAM_Virtual_Router

Key value The value for key. The key is from therelation lookup configuration. Most of thesekeys are based on the IP address. TheobjectFullName can also be used as a key.

Collector id Id for collector that is based on the UBAdestination.

Note: This configuration is intended for new elements from SAM that theuser wants to overwrite the default hash key rule. For example, a user canforce the element to go to a specific collector or UBA for better load


balance. However, this configuration does not overwrite mapping that theJob gathers from Proviso. Therefore, following is the partition rule:Mapping from Priviso DB → collector_mapping.csv → Job key hash.

Changing the collection period for SAM statistics: Provides general guidelineson how to change the collection period for SAM statistics.

General guidelines on changing the collection period for SAM statistics:

The default collection period for all SAM statistics is 15 minutes.

If you change the collection period, ensure that you follow these guidelines:1. You must set the APP.FILE_PERIOD parameter on each UBA component and the

WINDOW_PERIOD parameter on the IBM InfoSphere Information Server toequivalent values.For example, if you set the APP.FILE_PERIOD parameter to 300 seconds (5minutes), then you must set the WINDOW_PERIOD parameter to 300.

Note: The APP.FILE_PERIOD and WINDOW_PERIOD parameters are specified inseconds.

2. The collection period for any type of SAM statistics must be set to the samevalue as the collection period for the corresponding Tivoli Netcool PerformanceManager requests.

DataStage settings

For more information, see “Window period” on page 29.

Tivoli Netcool Performance Manager 1.4 settings

The Alcatel-Lucent 5620 SAM LogToFile Technology Pack supplies theseparameters that are based on the Tivoli Netcool Performance Manager platforms.

These parameters are supplied in the pack XSD file. You specify values for theseparameters as part of adding a UBA Bulk Collector and associating it with theAlcatel-Lucent 5620 SAM LogToFile Technology Pack. For more information, seethe section on adding a UBA collector in the Installing Tivoli Netcool PerformanceManager - Wireline Component.

List of classes that are enabled or disabled:

List of classes that are enabled or disabled in the DataStage requestxml_lookup.csvfile. The requestxml_lookup.csv file is in /opt/IBM/InformationServer/Server/Projects/UDM/udm/cfg directory. Some classes are disabled. However, you canenable a disabled class.

Classes that are enabled

v aengr.ForwardingClassv aengr.Policyv aengr.Queuev aingr.ForwardingClassv aingr.Policyv aingr.Queuev aosqos.Policy


v aosqos.QoSIngressPolicyStatsLogRecordv dhcp.Dhcp6AddressPrefixv dhcp.LocalDhcp6ServerPrefixStatsv dhcp.LocalDhcpServerSubnetStatsv dhcp.Subnetv epipe.Epipev equipment.AllocatedMemoryStatsLogRecordv equipment.AvailableMemoryStatsLogRecordv equipment.BaseCardv equipment.CardHealthStatsLogRecordv equipment.CardSlotv equipment.ControlProcessorv equipment.DaughterCardv equipment.HardwareTemperaturev equipment.HwEnvironment (metrics)v equipment.HwEnvironmentv equipment.InterfaceAdditionalStatsLogRecordv equipment.InterfaceStatsLogRecordv equipment.MCMCardv equipment.MediaIndependentStatsLogRecordv equipment.PhysicalPortv equipment.Shelfv equipment.SystemCpuMonStatsv equipment.SystemCpuStatsLogRecordv equipment.SystemMemoryStatsLogRecordv ethernetequipment.AggrMaintRxStatsv ethernetequipment.AggrMaintTxStatsv ethernetequipment.Dot3StatsLogRecordv ethernetoam.CfmEthTestv ethernetoam.CfmLoopbackv ethernetoam.CfmOneWayDelayTestv ethernetoam.CfmTwoWayDelayTestv ethernetoam.Mepv icmp.IcmpPingv ies.L3AccessInterfacev ies.ServiceAccessPointv ipipe.L2AccessInterfacev lag.Interfacev lte.S11AgwPeerStatsv lte.S11Peerv lte.S1uAgwPeerStatsv lte.S1uPeerv lte.S5AgwPeerStatsv lte.S5Peerv lte.S8AgwPeerStats


v lte.S8Peerv ltegw.S11FailureCodeStatsv ltegw.S5AgwFailureCodeStatsv ltegw.S8AgwFailureCodeStatev ltemme.MAFConnectionv ltemme.MmeServiceMemberMafv mpls.Interfacev mpls.LspPingv mpls.MplsInterfaceStatsLogRecordv mpls.Sitev mpls.SiteStatsLogRecordv mpr.IMALinkv mpr.IMALinkCurrentStatsv nat.IsaMdav nat.IsaMemberv nat.IsaMemberUsageStatsv nqueue.Entryv nqueue.ForwardingClassv nqueue.Policyv ppp.Interfacev ppp.PppControlProtocolv ppp.PppControlProtocol (metrics)v radioequipment.PdhFrameHopHistoryDataStats15Minv radioequipment.PdhFrameLinkHistoryDataStats15Minv radioequipment.RadioAnalogueMeasurev rtr.RouteStatsLogRecordv rtr.VirtualRouterv sasqos.AccessIngressv sasqos.Meterv sasqos.PortAccessEgressv sasqos.PortAccessEgressQueuev service.CombinedNetworkEgressOctetsLogRecordv service.CombinedNetworkIngressOctetsLogRecordv service.CompleteServiceEgressPacketOctetsLogRecordv service.CompleteServiceIngressPacketOctetsLogRecordv service.PppoeSapStatsLogRecordv sonetequipment.Sts12Channelv sonetequipment.Sts1Channelv sonetequipment.Sts48Channelv svq.AggregationSchedulerv svt.MeshSdpBindingv svt.MirrorSdpBindingv svt.SdpBindingBaseStatsLogRecordv svt.SpokeSdpBindingv svt.TunnelPing


v svt.VccvPingv vll.L2AccessInterfacev vpls.L2AccessInterfacev vpls.Vplsv vprn.ServiceAccessPointv ethernetoam.CfmLoopbackResultv ethernetoam.CfmTwoWayDelayTestResultv ethernetoam.CfmSingleEndedLossTestv icmp.IcmpPingResultv svt.TunnelPingResultv svt.VccvPingResultv tdmequipment.DS1E1PortSpecificsv tdmequipment.DS1HistoryStats15minInv tdmequipment.DS1HistoryStats15minOutv tdmequipment.E1HistoryStats15minInv tdmequipment.E1HistoryStats15minOutv service.SitePingv svq.CustMultiSvcSiteEgrSchedPlcyPortStatsLogRecordv svq.CustMultiSvcSiteIngSchedPlcyPortStatsLogRecord

Classes that are disabled

v equipment.DigitalDiagnosticMonitoringv ethernetoam.CfmEthTestResultv ethernetoam.CfmOneWayDelayTestResultv ethernetoam.CfmSingleEndedLossTestResultv mirror.L2AccessInterfacev ppp.PppStatsv sasqos.AccessIngressForwardingClassv sasqos.PortAccessEgressForwardingClassv service.NetworkEgressPacketsv service.NetworkIngressPacketsv service.ServiceEgressOctetsv service.ServiceEgressPacketsv service.ServiceIngressOctetsv service.ServiceIngressPacketsv service.SitePingResultv sonetequipment.Sts192Channelv sonetequipment.Sts3Channelv sonetequipment.TributaryChannelv sonetequipment.TributaryGroupv sonetequipment.Tu3Channelv sonetequipment.Tug3Groupv tdmequipment.DS0ChannelGroupv tdmequipment.DS1E1Channelv tdmequipment.DS3E3Channel


v vprn.L3AccessInterface

Disabling or enabling a class:

How to enable or disable a class.

About this task

You can enable or disable a class from the following configuration files:v requestxml_lookup.csv filev filter_lookup.csv file

Procedure

Modifying the requestxml_lookup.csv file:v Add a dot before the Request type.

Notice that a dot is added before findToFile in the following example:.findToFile,<?xml version="1.0" encoding="UTF-8"?>...<fullClassName>equipment.DigitalDiagnosticMonitoring</fullClassName>...</SOAP:Envelope> .registerLogToFile,<?xml version="1.0" encoding="UTF-8"?>...<fullClassName >service.NetworkEgressPackets</fullClassName>...</SOAP:Envelope>

To enable a class:v Remove the dot that is available before Request type.

Notice that the dot that was added before findToFile is removed in thefollowing example:findToFile,<?xml version="1.0" encoding="UTF-8"?>...<fullClassName>equipment.DigitalDiagnosticMonitoring</fullClassName>...</SOAP:Envelope> .registerLogToFile,<?xml version="1.0" encoding="UTF-8"?>...<fullClassName >service.NetworkEgressPackets</fullClassName>...</SOAP:Envelope>

Modifying the filter_lookup.csv file:v Append 0 to the class name that you want to disable.

For example, if you want to disable equipment.DigitalDiagnosticMonitoringclass, edit the line as follows:equipment.DigitalDiagnosticMonitoring,0

v To enable a class that is disabled, edit the line as follows:equipment.DigitalDiagnosticMonitoring,1

Related concepts:Usage of the CSV files in the cfg directoryThe four CSV files that you must configure from the cfg directory where the IBMInfoSphere Information Server server is installed.


Alcatel-Lucent 5529 SDC Technology PackAdditional configuration steps required for Alcatel-Lucent 5529 SDC TechnologyPack.

Devices and servicesThis topic provides a summary of the Alcatel-Lucent 5529 SDC device technology,and the associated bulk input file format, that the Alcatel-Lucent 5529 SDCTechnology Pack is designed to support.

Summary of device technology:

The Alcatel-Lucent 5529 Statistics and Data Collector (SDC) is a high-performanceapplication that collects data, statistics, and performance information fromAlcatel-Lucent access network devices – in this case, Alcatel-Lucent 7302/7330DSLAM and Alcatel-Lucent 7340.

The Alcatel-Lucent 5529 SDC receives network inventory from an EnhancedMessaging Service (EMS) - in this case, the Alcatel-Lucent 5523 ADSL Work Station(AWS). The Alcatel-Lucent 5529 SDC has a northbound interface for integrationwith Performance Management products such as Tivoli Netcool PerformanceManager.

The Alcatel-Lucent 5529 SDC 2.10.0.0 Technology Pack operates with followingAlcatel-Lucent 5529 SDC versions:v Alcatel-Lucent 5529 SDC version 9.3.10

Whereas the Alcatel-Lucent 5529 SDC 2.9.0.0 Technology Pack operates withfollowing Alcatel-Lucent 5529 SDC versions:v Alcatel-Lucent 5529 SDC version 5.2v Alcatel-Lucent 5529 SDC version 6.1v Alcatel-Lucent 5529 SDC version 6.2v Alcatel-Lucent 5529 SDC version 7.0v Alcatel-Lucent 5529 SDC version 7.1v Alcatel-Lucent 5529 SDC version 7.2v Alcatel-Lucent 5529 SDC version 8.0v Alcatel-Lucent 5529 SDC version 8.2

The Alcatel-Lucent 5529 SDC supports two types of metrics collection:v Bulk collection – Specifies long term, periodic collection of performance data.v On-demand details collection – Specifies short term, ad hoc collection of

high-resolution data.

The Alcatel-Lucent 5529 SDC Technology Pack is only concerned with bulkcollection.

Typically, the Alcatel-Lucent 5529 SDC is configured with a collection strategy thatspecifies which parameters to collect and how often. An administrator mustconfigure this collection strategy by using the Alcatel-Lucent 5529 SDC GUIprovided by the Alcatel-Lucent 5529 SDC. For more information, see “Setting upthe Alcatel-Lucent 5529 SDC” on page 108.



The Alcatel-Lucent 5529 SDC devices gather performance data and other statisticsfrom multiple network elements. This data is referred to collectively as networkhealth metrics. Each Alcatel-Lucent 5529 SDC device produces, on a specifiedregular basis, a bulk input file that contains the network health metrics and otherinformation. The Alcatel-Lucent 5529 SDC Technology Pack supports multipleinput files per UBA, where each input file contains data for one polling periodonly. The syntax for these bulk input files is discussed in “Bulk input file name.”The Alcatel-Lucent 5529 SDC Technology Pack provides a file that interprets thesebulk input files. For more information, see Bulk adapter design files.

Bulk input file name:

Alcatel-Lucent 5529 SDC version 9.3.10 devices produce tar.gz files that containcomma-separated files (csv) files that are named using the following syntax:

<NE_IP_Address>_<Type>_<Time>.tar.gz

Where:v NE_IP_Address specifies the IP address of the device from which the data was

collected.v Type specified whether data is instant data or historical data.v Time specifies the time on which the data was collected. The time format is as

below:yyyy-MM-dd-HH-mm

Where:– yyyy specifies a four-digit integer (for example, 2015) that identifies the year

in which the Alcatel-Lucent 5529 SDC produced the CSV file.– MM specifies a two-digit integer (for example, 10) that identifies the month in

which the Alcatel-Lucent 5529 SDC produced the CSV file.– dd specifies a two-digit integer (for example, 13) that identifies the day in

which the Alcatel-Lucent 5529 SDC produced the CSV file.– HH specifies a two-digit integer (for example, 13) that identifies the metric

hour in which the Alcatel-Lucent 5529 SDC produced the CSV file.– mm specifies a two-digit integer (for example, 13) that identifies the minutes

after the metric hour in which the Alcatel-Lucent 5529 SDC produced the CSVfile.

v tar.gz specifies a file extension of tar.gz, which indicates this is a tar.gz filetype.

The following list shows examples of the tar.gz file names:v 138.120.242.17_H-15M_2015-01-09-13-00.tar.gz

v 172.22.176.217_H-15M_2015-06-03-14-15.tar.gz

Bulk input file schema:

The Alcatel-Lucent 5529 SDC version 9.3.10 produces compressed .tar.gz file,which contains CSV files for each managed object type with the following fields.

The file name format for the .csv files in the archive is <Managed ObjectType>.csv. For example, iSAM_ontEthPort.csv.


Each .csv results file contains the Time stamp, Object Type, and NE Namefollowed by the column headings for the counters.

Table 4. The .csv file content

Field Description Example

Time stamp Time stamp specifies the timestamp.

2014-10-31T08:00:00-04:00

Object Type Object Type specifies type ofobject. See Table 5

Ethernet Port

NE Name NE Name specifies the DeviceName.

ISAM17

Object ID The first column Object IDcontains the short name ofthe object without the objecttype and NE name.

IHUB:10

Table 5. ObjectID address formats

Object Type Address Format Example

Port rack-shelf-slot-port In the following example, thePort object has a rack valueof 1, a shelf value of 1, a slotvalue of 2, and a port valueof 23.R1.S1.LT2.P23

ATM TP rack-shelf-slot-port.VPI/VCI

This object type specifies theATM termination point thatis associated with theVPI/VCI on the specifiedDSL port. In the followingexample, the ATM TP objecthas a rack value of 1, a shelfvalue of 1, a slot value of 3,a port value of 23, a VPIvalue of 32, and a VCI valueof 11.R1.S1.LT3.P23.32/11

Bridge port rack-shelf-slot-port.VPI.VCI

In the following example, theBridge port object has a rackvalue of 1, a shelf value of 2,a slot value of 1, a port valueof 12, a VPI value of 8, and aVCI value of 11.R1.S2.LT1.P12.8.11

Bridge port – VLANAssociation

VlanIndex BridgeIndex In the following example, theBridge port VLANAssociation object has aVLAN index of 121 and aBridge index of 2003.C121.P2003

ONT Rack-Shelf-Slot-PON-ONT In the following example, theONT object has a rack valueof 1, a shelf value of 2, a slotvalue of 1, a PON id of 1and an ONT id of 2.R1.S2.LT1.PON1.ONT2


Table 5. ObjectID address formats (continued)


PON Rack-Shelf-Slot-PON In the following example, thePON object has a rack valueof 1, a shelf value of 1, a slotvalue of 2 and a PON id of1.R1.S1.LT2.PON1

SAP Statistics svcId PortType-PortNumber-VlanID

In the following example, theSAP Statistics object has anSVC id of 1, a port type ofPORT, a port number of 8,and a VLAN id of 500.IHUB:SVC1.PORT8.VLAN500

Voice Rack-Shelf-Slot-PON-ONT-VOIP-Service ID

In the following example, theVoice object has a rack valueof 1, a shelf value of 1, a slotvalue of 4, a PON id of 1, anONT id of 2, and a VOIPservice id of 12.R1.S1.LT4.PON1.ONT2.SERV12

Daily ONT Supervision Rack-Shelf-Slot-PON-ONT In the following example, theDaily ONT Supervisionobject has a rack value of 1,a shelf value of 1, a slotvalue of 4, a PON id of 3,and an ONT id of 1.R1.S1.LT4.PON3.ONT1

UNI Port Rack-Shelf-Slot-PON-ONT-ONT Slot-ONTPort-CallHistNr

In the following example, theUNI Port object has a rackvalue of 1, a shelf value of 1,a slot value of 4, a PON id of1, an ONT id of 1, an ONTSlot of 1, and an ONT portof 1, and CallHistNr is 45.R1.S1.LT4.PON1.ONT1.C1.P1.ID45

ONT Ethernet Port Rack-Shelf-Slot-PON-ONT-ONTSlot-ONT Port

In the following example, theONT Ethernet Port object hasa rack value of 1, a shelfvalue of 1, a slot value of 4,a PON id of 1, an ONT id of3, an ONT slot of 1, and anONT port of 1.R1.S1.LT4.PON1.ONT3.C1.P1


Table 5. ObjectID address formats (continued)


Node Node This object type providesNode Name and Node IPvalues, which can be used topopulate the properties“Alcatel5529SDC_DeviceName” and“Alcatel5529SDC_DeviceIP”for all the sub elementsunder that particular node.

Format: timestamp,objecttype,counter,value

Examples

v 1342196160365,Node,370,198.162.148.239When Counter ID = 370,populate the property asfollows:Alcatel5529SDC_DeviceIP= 198.162.148.239

v 1342196160365,Node,371,BNBYLAB-ARAMD-2When Counter ID = 371,populate the property asfollows:Alcatel5529SDC_DeviceName= BNBYLAB-ARAMD-2

Note: The Alcatel-Lucent 5529 SDC Technology Pack collects metrics that arerelated to the Port object.

The following example shows the fields for a number of Port objects in a CSV filethat is generated by the Alcatel-Lucent 5529 SDC version 9 and below:v 11115732020921, 1-1-1-1,17,0.0

v 11115732020921, 1-1-1-2,17,0.0

v 11115732020921, 1-1-1-3,17,0.0

v 11115732020921, 1-1-1-4,17,0.0

v 11115732020921, 1-1-2-1,17,0.0

v 11115732020921, 1-1-2-2,17,0.0

v 11115732020921, 1-1-2-3,17,0.0

v 11115732020921, 1-1-2-4,17,0.0

In this example:v The first field specifies the time stamp, for example, 11115732020921.v The second field specifies the address of the Port object, for example, 1-1-2-4.v The third field specifies the SDC parameter ID, for example, 17.v The fourth field specifies the counter value, for example, 0.0.


Mapping between formulas and input file fields:

The CounterID field in the CSV file specifies the SDC parameter ID.

Table 6 maps each bulk collection formula (and some properties, indicated by theAlcatel5529SDC_prefix) to the associated SDC parameter ID and SDC parametername. For more information about bulk collection formulas and properties, see theIBM Tivoli Netcool Performance Manager Alcatel-Lucent 5529 SDC 2.8.0.0 TechnologyPack Reference.

Table 6. Bulk collection formulas and properties mapped to SDC parameter ID and SDC Counter Name

Formula or propertySDC

parameterID

SDC parametername

SDC counter name

ATM Incoming octets 90101ATM Incomingoctets ifInOctets

ATM Incomingpacket errors

90105ATM Incomingpacket errors ifInErrors

ATM Outgoing octets 90102ATM Outgoingoctets ifOutOctets

ATM Outgoingpacket errors

90106ATM Outgoingpacket errors ifOutErrors

ATM Unknownprotocol errors

90110ATM Unknownprotocol errors ifInUnknownProtos

Bad received GEMheaders

11095A count of receivedGEM headers thatare bad

gponOntOntsideAggGemIntervalBadHeaders

Blocks received US 11079A count of receivedGEM blocks gponOntOltsideODAggGemIntervalReceiveBlocksCounter64

Blocks transmittedDS

11077A count oftransmitted GEMblocks

gponOntOltsideODAggGemIntervalTransmitBlocksCounter64

BP-VLAN DSDiscarded Bytes

1443VLAN current dayport vlan discardedbyte counter DS

extendPortTotalCurrent1DayDnDiscByteCounter

BP-VLAN DSDiscarded Frames

1435VLAN current dayport vlan discardedframe counter DS

extendPortTotalCurrent1DayDnDiscFrameCounter

BP-VLAN DSForwarded Bytes

1427VLAN current dayport vlan forwardedbyte counter DS

extendPortTotalCurrent1DayDnFwdByteCounter

BP-VLAN DSForwarded Frames

1419VLAN current dayport vlan forwardedframe counter DS

extendPortTotalCurrent1DayDnFwdFrameCounter

BP-VLAN USDiscarded Bytes

1439VLAN current dayport vlan discardedbyte counter US

extendPortTotalCurrent1DayUpDiscByteCounter

BP-VLAN USDiscarded Frames

1431VLAN current dayport vlan discardedframe counter US

extendPortTotalCurrent1DayUpDiscFrameCounter

BP-VLAN USForwarded Bytes

1423VLAN current dayport vlan forwardedbyte counter US

extendPortTotalCurrent1DayUpFwdByteCounter


Table 6. Bulk collection formulas and properties mapped to SDC parameter ID and SDC Counter Name (continued)


parameterID

SDC parametername

SDC counter name

BP-VLAN USForwarded Frames

1415VLAN current dayport vlan forwardedframe counter US

extendPortTotalCurrent1DayUpFwdFrameCounter

Connects peak timeper second

11160Connects peak timeper second igmpModulePeakConnectsPerSecond

CPU Utilization 111191The CPU loadpercent value cpuLoadAverage

DS Discarded Bytes 1483VLAN current dayport total discardedbyte counter DS

extendPortVlanCurrent1DayDnDiscByteCounter

DS Discarded Frames 1475VLAN current dayport total discardedframe counter DS

extendPortVlanCurrent1DayDnDiscFrameCounter

DS Forwarded Bytes 1467VLAN current dayport total forwardedbyte counter DS

extendPortVlanCurrent1DayDnFwdByteCounter

DS ForwardedFrames

1459VLAN current dayport total forwardedframe counter DS

extendPortVlanCurrent1DayDnFwdFrameCounter

Errored GEMFragments

11070A count of erroredGEM fragments gponPonAggGemIntervalErrorFragsUp

Errored GEMfragments

11071A count of erroredGEM fragments(upstream)

gponOntOltsideAggGemTCAThresholdErrorFragsUp

Errored SecondsDownstream

87Current day erroredseconds DS xdslFarEndLineCurrent1DayESCounter

Errored SecondsUpstream

88Current day erroredseconds US xdslLineCurrent1DayESCounter

Frames received US 11080A count of receivedGEM fragments gponOntOltsideODAggGemIntervalReceiveFrags

Frames transmittedUS

11078A count oftransmitted GEMfragments

gponOntOltsideODAggGemIntervalTransmitFrags

Incoming broadcastpackets

80003Incoming broadcastpackets ifInBroadcastPkts

Incoming discardedpackets

90003Incoming discardedpackets ifInDiscards

Incoming multicastpackets

80001Incoming multicastpackets ifInMulticastPkts

Incoming non-unicastpackets

90012Incomingnon-unicast packets extendEtherPortStatisticsIfInNUcastPkts

Incoming octets 90001 Incoming octets ifInOctets

Incomingoctets(64Bits)

90015Incomingoctets(64Bits) ifHCInOctets

Incoming packeterrors

90005Incoming packeterrors ifInErrors




parameterID

SDC parametername

SDC counter name

Incoming unicastpackets

90007Incoming unicastpackets ifInUcastPkts

Loss of FramingFailures Downstream

1244Current day loss offrame DS xdslFarEndLineCurrent1DayLOFCounter

Loss of FramingFailures Upstream

1245Current day loss offrame US xdslLineCurrent1DayLOFCounter

Loss of Link seconds 1249Current day loss oflink xdslFarEndLineCurrent1DayLOLCounter

Loss of PowerFailures Downstream

1247Current day loss ofpower DS xdslFarEndLineCurrent1DayLPRCounter

Loss of PowerFailures Upstream

1261Current day loss ofpower US xdslLineCurrent1DayLPRCounter

Loss of SignalFailures Downstream

1236Current day loss ofsignal DS xdslFarEndLineCurrent1DayLOSCounter

Loss of SignalFailures Upstream

1237Current day loss ofsignal US xdslLineCurrent1DayLOSCounter

Lost frames US 11081A count of lostGEM fragments(upstream)

gponOntOltsideODAggGemIntervalLostFragsUp

Lost GEM fragmentsDS

11089A count of lostGEM fragments(downstream)

gponOntOntsideAggGemIntervalLostFragsDown

Lost GEM fragmentsUS

11090A count of lostGEM fragments(upstream)

gponOntOntsideAggGemIntervalLostFragsUp

Memory Used 111195The used memorysize in absolutevalue

memAbsoluteUsage

Outgoing broadcastpackets

80004Outgoing broadcastpackets ifOutBroadcastPkts

Outgoing discardedpackets

90004Outgoing discardedpackets extendEtherPortStatisticsIfOutDiscards

Outgoing multicastpackets

80002Outgoing multicastpackets ifOutMulticastPkts

Outgoing non-unicastpackets

90013Outgoingnon-unicast packets extendEtherPortStatisticsIfOutNUcastPkts

Outgoing octets 90002 Outgoing octets ifOutOctets

Outgoingoctets(64Bits)

90016Outgoingoctets(64Bits) ifHCOutOctets

Outgoing packeterrors

90006Outgoing packeterrors ifOutErrors

Outgoing unicastpackets

90008Outgoing unicastpackets ifOutUcastPkts

Received GEM blocks 11092A count of receivedGEM blocks gponOntOntsideAggGemIntervalReceiveBlocksCounter64




parameterID

SDC parametername

SDC counter name

Received GEMfragments

11091A count of receivedGEM fragments gponOntOntsideAggGemIntervalReceiveFrags

Severely ErroredSeconds (SES)Downstream

89Current dayseverely erroredseconds DS

xdslFarEndLineCurrent1DaySESCounter

Severely ErroredSeconds (SES)Upstream

90Current dayseverely erroredseconds US

xdslLineCurrent1DaySESCounter

Total failed joinrequests received

11156Total failed joinrequests received igmpModuleUnsuccessfulJoinReqCounter

Total IGMP messagesreceived

11151Total IGMPmessages received igmpModuleTotalIGMPMsgsCounter

Total join requestsreceived

11154Total join requestsreceived igmpModuleTotalJoinRequestsCounter

Total Memory 111194The total memorysize on board totalMemSize

Total multicast groupcounter

11166Total multicastgroup counter igmpModuleCurrentNumRootConnections

Total successful joinrequests received

11155Total successful joinrequests received igmpModuleSuccessfulJoinReqCounter

Transmitted GEMblocks


gponOntOntsideAggGemIntervalTransmitBlocksCounter64

Transmitted GEMfragments


gponOntOntsideAggGemIntervalTransmitFrags

Unavailable SecondsDownstream

1232Current dayunavailable secondsDS

xdslFarEndLineCurrent1DayUASCounter

Unavailable SecondsUpstream

1231Current dayunavailable secondsUS

xdslLineCurrent1DayUASCounter

Unknown protocolerrors

90010Unknown protocolerrors extendEtherPortStatisticsIfInUnknownProtos

US Discarded Bytes 1479VLAN current dayport total discardedbyte counter US

extendPortVlanCurrent1DayUpDiscByteCounter

US Discarded Frames 1471VLAN current dayport total discardedframe counter US

extendPortVlanCurrent1DayUpDiscFrameCounter

US Forwarded Bytes 1463VLAN current dayport total forwardedbyte counter US

extendPortVlanCurrent1DayUpFwdByteCounter

US ForwardedFrames

1455VLAN current dayport total forwardedframe counter US

extendPortVlanCurrent1DayUpFwdFrameCounter




parameterID

SDC parametername

SDC counter name

Ingress Packet PerSAP 1602

Current intervalingress packets perSAP fadSapPMCurrent1DayIngressPkts

Egress Packet PerSAP 1610

Current intervalegress octets perSAP fadSapPMCurrent1DayEgressOctets

Ingress Octets PerSAP 1609

Current intervalingress octets perSAP fadSapPMCurrent1DayIngressOctets

Egress Octets PerSAP 1615

Current intervalegress packets perSAP fadSapPMCurrent1DayEgressPkts

Transmit OpticalSignal at 1490 nm atOLT Side 121254

OLT sidetransmitted signallevel gponOntOpticSupDailyOltsideTxOpticalSignalLevel

Receive OpticalSignal at 1310 nm atOLT Side 121253

OLT side receivedsignal level gponOntOpticSupDailyOltsideRxOpticalSignalLevel

Laser Bias Current atOLT 121257

OLT side laser biascurrent gponOntOpticSupDailyOltsideBiasCurrent

Transmit OpticalSignal at 1310 nm atONT Side 121250

ONT sidetransmitted signallevel gponOntOpticSupDailyOntsideTxOpticalSignalLevel

Laser Bias Current atONT 121251

ONT side laser biascurrent gponOntOpticSupDailyOntsideLaserBiasCurrent

Receive OpticalSignal at 1490 nm atONT Side 121248

ONT side receivedsignal level gponOntOpticSupDailyOntsideRxOpticalSignalLevel

OLT Temperature 121255OLT sidetemperature gponOntOpticSupDailyOltsideTemperature

ONT Temperature 121252ONT sidetemperature gponOntOpticSupDailyOntsideTemperature

Total Bursty ErroredSeconds 14003

Current intervalbursty erroredseconds bponCesIntervalBESs

Total SeverelyErrored Seconds 14002

Current intervalseverely erroredseconds bponCesIntervalSESs

Total UnavailableSeconds 14004

Current intervalunavailable seconds bponCesIntervalUASs

Total Controlled SlipSeconds 14005

Current intervalcontrolled slipseconds bponCesIntervalCSSs

Total ErroredSeconds 14001

Current intervalerrored seconds bponCesIntervalESs

Total Call SetupFailures 11614 Call set up failures gponPotsCallCntlIntervalSetupFails




parameterID

SDC parametername

SDC counter name

Total RTP PacketErrors 11615 RTP Errors gponPotsRtpIntervalRtpErrors

RTP Packet Loss 11616 RTP Packet loss gponPotsRtpIntervalPacketLoss

Transmitted MulticastEthernet Frame 11708

Current intervaltransmittedmulticast frames gponEtherTrafficIntervalTxFramesMulticast

Total UnsuccessfullyReceived Frames DueTo Internal MACReceive Error 11108

Current intervalnumber of IMRE bponLanEtherIntervalIMREs

Total Frames HavingAlignment Errors 11107

Current intervalnumber ofalignment errors bponLanEtherIntervalAEs

SuccessfullyTransmitted SingleCollision Frames 11102

Current intervalnumber of SCF bponLanEtherIntervalSCFs

Total Frames ThatAre Too Long 11099

Current intervalnumber of FTL bponLanEtherIntervalRBOs

Total Carrier SenseError 11106

Current intervalnumber of CS errors bponLanEtherIntervalCSEs

Total Late Collision 11097

Current intervalnumber of latecollisions bponLanEtherIntervalLCs

SuccessfullyTransmitted MultipleCollision Frames 11103

Current intervalnumber of MCF bponLanEtherIntervalMCFs

Transmitted EthernetBytes 11703

Current intervaltransmitted bytes gponEtherTrafficIntervalTxBytesCounter64

Received EthernetBytes 11704

Current intervalreceived bytes gponEtherTrafficIntervalRxBytesCounter64

Transmitted EthernetFrames 11701

Current intervaltransmitted frames gponEtherTrafficIntervalTxFrames

Dropped EthernetFrames Upstream 11705

Current intervaldropped frames US gponEtherTrafficIntervalDroppedFramesUp

Received MulticastEthernet Frame 11709

Current intervalreceived multicastframes gponEtherTrafficIntervalRxFramesMulticast

Total ExcessiveCollision 11096

Current intervalnumber of excessivecollisions bponLanEtherIntervalECs

Dropped EthernetFrames Downstream 11707

Current intervaldropped frames DS gponEtherTrafficIntervalDroppedFramesDown

Total UnsuccessfullyTransmitted FramesDue To Internal MACTransmit Error 11105

Current intervalnumber of IMTE bponLanEtherIntervalIMTEs




parameterID

SDC parametername

SDC counter name

Total Frame CheckSequence Errors 11098

Current intervalnumber of FCSerrors bponLanEtherIntervalFTLs

Total Frames DelayedDue To DeferredTransmission 11104

Current intervalnumber of DTframes bponLanEtherIntervalDTs

Alcatel5529SDC_ONT_Ethernet_Label 121286 Label bponLanEtherPortLabel

Alcatel5529SDC_ONT_Ethernet_Operational_State 121270 Operational state bponLanEtherPortCurrStatus

Received EthernetFrames 11702

Current intervalreceived frames gponEtherTrafficIntervalRxFrames

Received Voice GEMBlocks OLT side 11311

Current intervalnumber of receivedGEM blocks gponVoipServiceOltsideGemIntervalReceiveBlocks

Transmitted VoiceGEM FragmentsONT side 11301

Current intervalnumber oftransmitted GEMfragments gponVoipServiceOltsideGemIntervalTransmitFrags

Lost Voice GEMFragments UpstreamONT side 11297

Current intervalnumber of lost GEMfragments US gponVoipServiceOltsideGemIntervalLostFragsUp

Transmitted VoiceGEM Blocks ONTside 11300

Current intervalnumber oftransmitted GEMblocks gponVoipServiceOntsideGemIntervalTransmitBlocks

Lost Voice GEMFragments UpstreamOLT side 11309

Current intervalnumber of lost GEMfragments US gponVoipServiceOntsideGemIntervalLostFragsUp

Received Voice GEMFragments ONT side 11298

Current intervalnumber of receivedGEM fragments gponVoipServiceOltsideGemIntervalReceiveFrags

Transmitted VoiceGEM Blocks OLTside 11312

Current intervalnumber oftransmitted GEMblocks gponVoipServiceOltsideGemIntervalTransmitBlocks

Transmitted VoiceGEM Fragments OLTside 11313

Current intervalnumber oftransmitted GEMfragments gponVoipServiceOltsideGemIntervalTransmitFrags

Lost Voice GEMFragmentsDownstreamONTside 11296

Current intervalnumber of lost GEMfragments DS gponVoipServiceOntsideGemIntervalLostFragsDown




parameterID

SDC parametername

SDC counter name

Received Voice GEMBlocks ONT side 11299

Current intervalnumber of receivedGEM blocks gponVoipServiceOntsideGemIntervalReceiveBlocks

Received Voice GEMFragments OLT side 11310

Current intervalnumber of receivedGEM fragments gponVoipServiceOntsideGemIntervalReceiveBlocks

PON BER Upstream 151515 PON BER stats US bponPonStatsBerUpstream

PON AGG UpstreamError Count 11286

Current IntervalPON AGGupstream errorcount gponOntOntsidePonAggEtherIntervalUpErrors

PON AGGDownstream ErrorCount 11285

Current IntervalPON AGGdownstream errorcount gponOntOntsidePonAggEtherIntervalDownErrors

PON BERDownstream 151516 PON BER stats DS bponPonStatsBerDownstream

OLT Temperature 21009 OLT temperature gponPonOltsideOpInfoTemp

OLT Laser BiasCurrent 21007 OLT bias current gponPonOltsideOpInfoBiasCurrent

ONT Laser BiasCurrent 151520

ONT laser biascurrent gponOntAniOpInfoLaserBiasCurrent

OLT Transmit OpticalSignal Level at1310nm 21008

OLT transmit opticalsignal level gponPonOltsideOpInfoTxOpticalSignalLevel

ONT Receive OpticalSignal Level at1310nm 151523

ONT receive opticalsignal level (at1310nm) gponOntOltsideOpInfoRxOpticalSignalLevel

ONT Receive OpticalSignal Level at 1490nm 151521

ONT current opticalsignal level (at 1490nm) gponOntAniOpInfoOpticalSignalLevel

OLT Transmit OpticalSignal Level at 1490nm 21010 OLT voltage gponPonOltsideOpInfoVoltage

ONT Temperature 151519 ONT temperature gponOntAniOpInfoTemperature

Alcatel5529SDC_Ethernet_Speed

13133Operationalinterface speed issPortCtrlSpeed

Alcatel5529SDC_EthernetLAG_Speed

13133Operationalinterface speed fsAggIfSpeed

Alcatel5529SDC_DeviceIP

370 Node IP ipAdEntAddr

LagIdentfier 121240

The currentadministrative valueof the Key for theLAG

dot3adAggActorAdminKey




parameterID

SDC parametername

SDC counter name

MAC address 121216The interface'saddress at itsprotocol sub-layer

ifPhysAddress

Alcatel5529SDC_LAG_Name

121229The textual name ofthe interface fsAggIfName

To find Lag Master 121212 Interface description fsAggIfDescription


Tivoli Netcool Performance Manager bulk adapters can support several dataformats for bulk input files, for example CSV, XML, and binary. The Alcatel-Lucent5529 SDC produces data in CSV format.

Each UBA technology pack provides at least one bulk adapter design file to definethe data format supported by that technology pack. Technology pack developersimplement bulk adapter design files using JavaScript. Some technology packsprovide several bulk adapter design files, each of which handles a specific bulkinput file format.

A bulk adapter design file typically can process both inventory and metrics datafrom the same bulk input file, and provides a function that creates the bulkcollection formula names. When the inventory and metrics are located in separatebulk input files, a technology pack developer typically implements several types ofbulk adapter design files.

The Alcatel-Lucent 5529 SDC Technology Pack provides the following bulk adapterdesign files:v aggregatorDefinition.js

v APModeler.js

v AppLogger.js

v common.js

v func.js

v inventory.js

v lagAggregatorDefinition.js

v metrics.js

v operatorDefinition.js

v schemaDefinition.js

v SubElementClasses.js

v UBAAdaptor.js

v mapping.js

Setting up the Alcatel-Lucent 5529 SDCThe Alcatel-Lucent 5529 SDC system administrator must set up the environment sothat the Alcatel-Lucent 5529 SDC Technology Pack operates correctly.

This topic reviews the tasks associated with setting up such an environment.


Installing the Alcatel-Lucent 5529 SDC software:

The Alcatel-Lucent 5529 SDC system administrator must install the Alcatel-Lucent5529 SDC software.

Understanding the Alcatel-Lucent 5529 SDC system administration tasks:

The Alcatel-Lucent 5529 SDC system administrator must have performed at leastthe following administrative tasks:v Applied the appropriate security measuresv Configured system-wide settingsv Created account profiles and accountsv Added and synchronized DSLAM providers with the Alcatel-Lucent 5529 SDCv Configured a collection strategy for the Alcatel-Lucent 5529 SDC Technology

Pack

Configuring a collection strategy for the Alcatel-Lucent 5529 SDC TechnologyPack:

When configuring the Alcatel-Lucent 5529 SDC, the Alcatel-Lucent 5529 SDCsystem administrator must establish a collection strategy for DSLAM providers. Inthis case, the DSLAM provider is an EMS/NMS. To establish the collection strategyfor the EMS/NMS, the system administrator uses the Alcatel-Lucent 5529 SDCGUI.

The SDC gets inventory from the EMS/NMS, and the Alcatel-Lucent 5529 SDCTechnology Pack gets performance data from the SDC.

To create a collection strategy for the EMS/NMS, follow these steps:1. Create a collection template that specifies the parameters to be collected. When

the Collection templates editor window is displayed, specify the parameters tobe collected for the EMS/NMS. Table 7 on page 110 identifies the parameters tospecify for Ethernet type and XDSL type ports.

2. Create a collection template group to link the collection templates with datahandlers and specify the frequency of the collection.

3. Create a collection strategy that consists of multiple collection template groups.4. Configure the data handler on the SDC with the following specific values:

a. Set the bulk input file name pattern to DeviceName_Date.csv. This is thedefault syntax. See “Bulk input file formats” on page 96 for a description ofthis syntax.

b. Set the date pattern to yyyy-MM-dd-HH-mm. See “Bulk input file formats” onpage 96 for a description of this syntax.

c. Name the files by using the local time zone.d. Configure all DSLAMs with the same time and time zone as the SDC. This

is required to correctly calculate or reset deltas for XDSL port dailyperformance management counters.


Table 7. Collection strategy parameters for EMS/NMS

Port type SDC parameters SDC ID SDC counter name

Board

CPU Utilization 111191 cpuLoadAverage

Memory Used 111195 memAbsoluteUsage

Total Memory 111194 totalMemSize

Bridge PortVLANs

VLAN current dayport vlandiscarded bytecounter DS

1443 extendPortTotalCurrent1DayDnDiscByteCounter

VLAN current dayport vlandiscarded bytecounter US

1439 extendPortTotalCurrent1DayUpDiscByteCounter

VLAN current dayport vlandiscarded framecounter DS

1435 extendPortTotalCurrent1DayDnDiscFrameCounter

VLAN current dayport vlandiscarded framecounter US

1431 extendPortTotalCurrent1DayUpDiscFrameCounter

VLAN current dayport vlanforwarded bytecounter DS

1427 extendPortTotalCurrent1DayDnFwdByteCounter

VLAN current dayport vlanforwarded bytecounter US

1423 extendPortTotalCurrent1DayUpFwdByteCounter

VLAN current dayport vlanforwarded framecounter DS

1419 extendPortTotalCurrent1DayDnFwdFrameCounter

VLAN current dayport vlanforwarded framecounter US

1415 extendPortTotalCurrent1DayUpFwdFrameCounter

VLAN name 1402 dynamicSubscriberVlan


Table 7. Collection strategy parameters for EMS/NMS (continued)


Daily ONTSupervision

Laser Bias Currentat OLT

121257 gponOntOpticSupDailyOltsideBiasCurrent

Laser Bias Currentat ONT

121251 gponOntOpticSupDailyOntsideLaserBiasCurrent

OLT Temperature 121255 gponOntOpticSupDailyOltsideTemperature

ONT Temperature 121252 gponOntOpticSupDailyOntsideTemperature

Receive OpticalSignal at 1310 nmat OLT Side

121253 gponOntOpticSupDailyOltsideRxOpticalSignalLevel

Receive OpticalSignal at 1490 nmat ONT Side

121248 gponOntOpticSupDailyOntsideRxOpticalSignalLevel

Transmit OpticalSignal at 1310 nmat ONT Side

121250 gponOntOpticSupDailyOntsideTxOpticalSignalLevel

Transmit OpticalSignal at 1490 nmat OLT Side

121254 gponOntOpticSupDailyOltsideTxOpticalSignalLevel




Ethernet

DSL managementtype

58 ifType

Incomingbroadcast packets

80003 ifInBroadcastPkts

Incomingdiscarded packets

90003 ifInDiscards


80001 ifInMulticastPkts

Incomingnon-unicastpackets

90012 extendEtherPortStatisticsIfInNUcastPkts

Incoming octets 90001 ifInOctets


90005 ifInErrors


90007 ifInUcastPkts

Outgoingbroadcast packets

80004 ifOutBroadcastPkts

Outgoingdiscarded packets

90004 extendEtherPortStatisticsIfOutDiscards


80002 ifOutMulticastPkts

Outgoingnon-unicastpackets

90013 extendEtherPortStatisticsIfOutNUcastPkts

Outgoing octets 90002 ifOutOctets


90006 ifOutErrors


90008 ifOutUcastPkts

The desired stateof the interface

13131 ifAdminStatus


90010 extendEtherPortStatisticsIfInUnknownProtos

Operationalinterface speed

13133 issPortCtrlSpeed




EthernetLAG

Actor admin keyfor aggregator

121240 dot3adAggActorAdminKey

Incomingbroadcast packets

80003 ifInBroadcastPkts

Incomingdiscarded packets

90003 ifInDiscards


80001 ifInMulticastPkts

Incomingnon-unicastpackets

90012 extendEtherPortStatisticsIfInNUcastPkts

Incoming octets 90001 ifInOctets


90005 ifInErrors


90007 ifInUcastPkts

Interfacedescription

121212 fsAggIfDescription

Interface speed 90011 ifSpeed

Outgoingbroadcast packets

80004 ifOutBroadcastPkts

Outgoingdiscarded packets

90004 extendEtherPortStatisticsIfOutDiscards


80002 ifOutMulticastPkts

Outgoingnon-unicastpackets

90013 extendEtherPortStatisticsIfOutNUcastPkts

Outgoing octets 90002 ifOutOctets


90006 ifOutErrors


90008 ifOutUcastPkts


90010 extendEtherPortStatisticsIfInUnknownProtos




IGMP Cards

Connects peaktime per second

11160 igmpModulePeakConnectsPerSecond

Total failed joinrequests received

11156 igmpModuleUnsuccessfulJoinReqCounter

Total IGMPmessages received

11151 igmpModuleTotalIGMPMsgsCounter

Total join requestsreceived

11154 igmpModuleTotalJoinRequestsCounter

Total multicastgroup counter

11166 igmpModuleCurrentNumRootConnections

Total successfuljoin requestsreceived

11155 igmpModuleSuccessfulJoinReqCounter

VLANs

Circuit 1485 bridgePort

VLAN current dayport totaldiscarded bytecounter DS

1483 extendPortVlanCurrent1DayDnDiscByteCounter

VLAN current dayport totaldiscarded bytecounter US

1479 extendPortVlanCurrent1DayUpDiscByteCounter

VLAN current dayport totaldiscarded framecounter DS

1475 extendPortVlanCurrent1DayDnDiscFrameCounter

VLAN current dayport totaldiscarded framecounter US

1471 extendPortVlanCurrent1DayUpDiscFrameCounter

VLAN current dayport totalforwarded bytecounter DS

1467 extendPortVlanCurrent1DayDnFwdByteCounter

VLAN current dayport totalforwarded bytecounter US

1463 extendPortVlanCurrent1DayUpFwdByteCounter

VLAN current dayport totalforwarded framecounter DS

1459 extendPortVlanCurrent1DayDnFwdFrameCounter

VLAN current dayport totalforwarded framecounter US

1455 extendPortVlanCurrent1DayUpFwdFrameCounter




XDSL

ATM Incomingoctets

90101 ifInOctets

ATM Incomingpacket errors

90105 ifInErrors

ATM Outgoingoctets

90102 ifOutOctets

ATM Outgoingpacket errors

90106 ifOutErrors

ATM Unknownprotocol errors

90110 ifInUnknownProtos

Current dayerrored seconds DS

87 xdslFarEndLineCurrent1DayESCounter

Current dayerrored seconds US

88 xdslLineCurrent1DayESCounter

Current day loss offrame DS

1244 xdslFarEndLineCurrent1DayLOFCounter

Current day loss offrame US

1245 xdslLineCurrent1DayLOFCounter

Current day loss oflink

1249 xdslFarEndLineCurrent1DayLOLCounter

Current day loss ofpower DS

1247 xdslFarEndLineCurrent1DayLPRCounter

Current day loss ofpower US

1261 xdslLineCurrent1DayLPRCounter

Current day loss ofsignal DS

1236 xdslFarEndLineCurrent1DayLOSCounter

Current day loss ofsignal US

1237 xdslLineCurrent1DayLOSCounter

Current dayseverely erroredseconds DS

89 xdslFarEndLineCurrent1DaySESCounter

Current dayseverely erroredseconds US

90 xdslLineCurrent1DaySESCounter

Current dayunavailableseconds DS

1232 xdslFarEndLineCurrent1DayUASCounter

Current dayunavailableseconds US

1231 xdslLineCurrent1DayUASCounter

DSL managementtype

58 ifType




ONT

Blocks transmittedDS

11077 gponOntOltsideODAggGemIntervalTransmitBlocksCounter64

Blocks received US 11079 gponOntOltsideODAggGemIntervalReceiveBlocksCounter64

Frames receivedUS

11080 gponOntOltsideODAggGemIntervalReceiveFrags

Frames transmittedUS

11078 gponOntOltsideODAggGemIntervalTransmitFrags

Lost frames US 11081 gponOntOltsideODAggGemIntervalLostFragsUp

Received GEMfragments

11091 gponOntOntsideAggGemIntervalReceiveFrags

Received GEMblocks

11092 gponOntOntsideAggGemIntervalReceiveBlocksCounter64

Transmitted GEMblocks

11093 gponOntOntsideAggGemIntervalTransmitBlocksCounter64

Transmitted GEMfragments

11094 gponOntOntsideAggGemIntervalTransmitFrags

Errored GEMfragments

11071 gponOntOltsideAggGemTCAThresholdErrorFragsUp

Lost GEMfragments DS

11089 gponOntOntsideAggGemIntervalLostFragsDown

Lost GEMfragments US

11090 gponOntOntsideAggGemIntervalLostFragsUp

Bad received GEMheaders

11095 gponOntOntsideAggGemIntervalBadHeaders

PON BERUpstream 151515 bponPonStatsBerUpstream

PON AGGUpstream ErrorCount 11286 gponOntOntsidePonAggEtherIntervalUpErrors

PON AGGDownstream ErrorCount 11285 gponOntOntsidePonAggEtherIntervalDownErrors

PON BERDownstream 151516 bponPonStatsBerDownstream

OLT Temperature 21009 gponPonOltsideOpInfoTemp

OLT Laser BiasCurrent 21007 gponPonOltsideOpInfoBiasCurrent

ONT Laser BiasCurrent 151520 gponOntAniOpInfoLaserBiasCurrent

OLT TransmitOptical SignalLevel at 1310nm 21008 gponPonOltsideOpInfoTxOpticalSignalLevel

ONT ReceiveOptical SignalLevel at 1310nm 151523 gponOntOltsideOpInfoRxOpticalSignalLevel

ONT ReceiveOptical SignalLevel at 1490 nm 151521 gponOntAniOpInfoOpticalSignalLevel

OLT TransmitOptical SignalLevel at 1490 nm 21010 gponPonOltsideOpInfoVoltage

ONT Temperature 151519 gponOntAniOpInfoTemperature




ONTEthernetPort

TransmittedMulticast EthernetFrame 11708 gponEtherTrafficIntervalTxFramesMulticast

TotalUnsuccessfullyReceived FramesDue To InternalMAC ReceiveError 11108 bponLanEtherIntervalIMREs

Total FramesHaving AlignmentErrors 11107

bponLanEtherIntervalAEs

SuccessfullyTransmitted SingleCollision Frames 11102 bponLanEtherIntervalSCFs

Total Frames ThatAre Too Long 11099 bponLanEtherIntervalRBOs

Total Carrier SenseError 11106 bponLanEtherIntervalCSEs

Total Late Collision 11097 bponLanEtherIntervalLCs

SuccessfullyTransmittedMultiple CollisionFrames 11103 bponLanEtherIntervalMCFs

TransmittedEthernet Bytes 11703 gponEtherTrafficIntervalTxBytesCounter64

Received EthernetBytes 11704 gponEtherTrafficIntervalRxBytesCounter64

TransmittedEthernet Frames 11701 gponEtherTrafficIntervalTxFrames

Dropped EthernetFrames Upstream 11705 gponEtherTrafficIntervalDroppedFramesUp

Received MulticastEthernet Frame 11709 gponEtherTrafficIntervalRxFramesMulticast

Total ExcessiveCollision 11096 bponLanEtherIntervalECs

Dropped EthernetFramesDownstream 11707 gponEtherTrafficIntervalDroppedFramesDown

TotalUnsuccessfullyTransmittedFrames Due ToInternal MACTransmit Error 11105 bponLanEtherIntervalIMTEs

Total Frame CheckSequence Errors 11098 bponLanEtherIntervalFTLs

Total FramesDelayed Due ToDeferredTransmission 11104 bponLanEtherIntervalDTs

This is a textualstring that can beused to label theEthernet port 121286 bponLanEtherPortLabel

Operational stateof the Ethernetport 121270 bponLanEtherPortCurrStatus

Received EthernetFrames 11702 gponEtherTrafficIntervalRxFrames




PONErrored GEMFragments

11070 gponPonAggGemIntervalErrorFragsUp

SAPStatistics

Ingress Packet PerSAP 1602 fadSapPMCurrent1DayIngressPkts

Egress Packet PerSAP 1610 fadSapPMCurrent1DayEgressOctets

Ingress Octets PerSAP 1609 fadSapPMCurrent1DayIngressOctets

Egress Octets PerSAP 1615 fadSapPMCurrent1DayEgressPkts

UNI Port

Total BurstyErrored Seconds 14003 bponCesIntervalBESs

Total SeverelyErrored Seconds 14002 bponCesIntervalSESs

Total UnavailableSeconds 14004 bponCesIntervalUASs

Total ControlledSlip Seconds 14005 bponCesIntervalCSSs

Total ErroredSeconds 14001 bponCesIntervalESs

Total Call SetupFailures 11614 gponPotsCallCntlIntervalSetupFails

Total RTP PacketErrors 11615 gponPotsRtpIntervalRtpErrors

RTP Packet Loss 11616 gponPotsRtpIntervalPacketLoss




Voice

Received VoiceGEM Blocks OLTside 11311 gponVoipServiceOltsideGemIntervalReceiveBlocks

Transmitted VoiceGEM FragmentsONT side 11301 gponVoipServiceOltsideGemIntervalTransmitFrags

Lost Voice GEMFragmentsUpstream ONTside 11297 gponVoipServiceOltsideGemIntervalLostFragsUp

Transmitted VoiceGEM Blocks ONTside 11300 gponVoipServiceOntsideGemIntervalTransmitBlocks

Lost Voice GEMFragmentsUpstream OLT side 11309 gponVoipServiceOntsideGemIntervalLostFragsUp

Received VoiceGEM FragmentsONT side 11298 gponVoipServiceOltsideGemIntervalReceiveFrags

Transmitted VoiceGEM Blocks OLTside 11312 gponVoipServiceOltsideGemIntervalTransmitBlocks

Transmitted VoiceGEM FragmentsOLT side 11313 gponVoipServiceOltsideGemIntervalTransmitFrags

Lost Voice GEMFragmentsDownstreamONTside 11296 gponVoipServiceOntsideGemIntervalLostFragsDown

Received VoiceGEM Blocks ONTside 11299 gponVoipServiceOntsideGemIntervalReceiveBlocks

Received VoiceGEM FragmentsOLT side 11310 gponVoipServiceOltsideGemIntervalReceiveFrags

NodeNode name 371 node name

Node IP 370 ipAdEntAddr

Installing the Load Balancer Adapter:

After you install the Alcatel-Lucent 5529 SDC Technology Pack on the TivoliNetcool Performance Manager DataMart server, install the Load Balancer Adapteron the Alcatel-Lucent 5529 SDC server as follows:

Procedure

1. Log in to the Alcatel-Lucent 5529 SDC server.2. Create the <adapter_home>/alcatel_5529_sdc/LoadBalancer directory.3. Change your working directory to the <adapter_home>/alcatel_5529_sdc/

LoadBalancer directory by using the following command:


$ cd <adapter_home>/alcatel_5529_sdc/LoadBalancer

4. Using the ftp utility in text mode, log in to the DataMart server by using theappropriate user name and password (pvuser and PV, by default).

5. Using the cd subcommand, change your working directory to the$PVMHOME/APFiles/alcatel_5529_sdc/LoadBalancer directory.

6. Using the get subcommand, copy the SdcAdaptor.tar file from the DataMartserver to the Alcatel-Lucent 5529 SDC server.

7. Exit the ftp utility by entering the bye subcommand.8. Use the tar command to extract the contents of the tar file:

tar xvf SdcAdaptor.tar

The <adapter_home>/alcatel_5529_sdc/LoadBalancer directory now containsthe following files and directories:README adaptor.properties donelog reload SdcAdaptor.tarbin lib overloadsdcAdaptor.sh

Configuring the Load Balancer Adapter: To configure the Load Balancer Adapter,use the adaptor.properties file that is provided in the Alcatel-Lucent 5529 SDCTechnology Pack.

Table 8. Configuration of Adaptor properties file

Parameter Description

UBA_LISTComma-separated list of UBA instances thatare available to process the data files.

UBA.<channel_number>.<collector_number>.INPUT_DIRECTORY

Input directory for the UBA instance. Specifyan input directory for each UBA instance.

UBA.<channel_number>.<collector_number>.ELEMENT_LIMIT

Maximum number of elements to beprocessed by the UBA instance. Specify anelement limit for each UBA instance.

ADAPTOR_INPUT_DIRECTORYThe input directory for the Load BalancerAdaptor (.tar.gz files)

ADAPTOR_FILE_PERIODFile period (expressed in minutes) for thecollection of each set of files.

ADAPTOR_LOG_FILE_SIZE_LIMITMaximum size of the Load Balancer Adapterlog file. When the log file size reaches thislimit, the log file is backed up.

ADAPTOR_LOG_FILE_BACKUP_LIMITNumber of backup log files to retain. If anextra backup log file is created, the oldestlog file is deleted.

For more information about the Load Balancer Adapter, see “Load BalancerAdapter.”

Load Balancer AdapterTo improve performance for configurations that produce large numbers of datafiles and require multiple UBAs, the Alcatel-Lucent 5529 SDC Technology Packprovides a Load Balancer Adapter.

The Load Balancer Adapter runs on the Alcatel-Lucent 5529 SDC server.


Overview:

The Load Balancer Adapter improves performance in two ways:v Reduces the number of files to be transferred from the Alcatel-Lucent 5529 SDC

server to the Tivoli Netcool Performance Manager DataChannel server.The Load Balancer Adapter creates jumbo files on the Alcatel-Lucent 5529 SDCserver; that is, files that contain the combined content of a large number of CSVdata files.

v Ensures that the processing load is balanced.The Load Balancer Adapter evenly distributes the jumbo files across all of theUBAs.

Location of Load Balancer Adapter:

The Load Balancer Adapter must be installed on the same file system as theAlcatel-Lucent 5529 SDC server, and must have access to the data files generatedby the Alcatel-Lucent 5529 SDC.

For the purposes of this guide, the Load Balancer Adapter is installed in the<adapter_home>/alcatel_5529_sdc/LoadBalancer directory.

Starting or stopping the Load Balancer Adapter:

Before you begin

v Ensure that the JAVA_HOME environment variable is set. The minimum supportedJava version is listed in the IBM Tivoli Netcool Performance Manager TechnologyPack Release Summary for the current technology pack release.

v Review the contents of the adaptor.properties file, as described in “Configuringthe Load Balancer Adapter” on page 120.


v Previous versions of the Alcatel-Lucent 5529 SDC Technology Pack that did notinclude Load Balancer Adapter functionality, require an adaptor.sync file. Formore information, see “Synchronizing with the Tivoli Netcool PerformanceManager database” on page 125.

Procedure

To start or stop the Load Balancer Adapter, use the sdcAdaptor.sh script that isprovided in the <adapter_home>/alcatel_5529_sdc/LoadBalancer directory.

Action Command

Start the Load Balancer Adapter sdcAdaptor.sh start

Stop the Load Balancer Adapter sdcAdaptor.sh stop

Results

v When started, the Load Balancer Adapter creates a .lock file. To remove the.lock file, stop the Load Balancer Adapter.

v After sending the stop command, the Load Balancer Adapter must firstcomplete processing its incomplete tasks before it stops. If the Load BalancerAdapter is in the middle of reading, moving, or writing files, it does not stop.Only when all tasks are complete, will the Load Balancer Adapter stop.

Log files:

Load Balancer Adapter messages are stored in the following log file:v <adapter_home>/alcatel_5529_sdc/LoadBalancer/log/adaptor.log

The format of the log file entries is as follows:[date timestamp, thread] class message_priority message

Where:date timestamp is the date of the logging event.thread is the thread that generated the logging event.class is the fully-qualified class name.message_priority is the pirority of the logging event and can be one of thefollowing values: DEBUG, INFO, WARN, ERROR, FATAL.message is the application-suppied message.

[2010-11-03 13:02:30,470] main AbstractAdaptor INFO - Starting theAdaptor...

The adaptor.log file stores the load status of each UBA; that is, the number ofelements being processed by the UBA. The format of the load-status messages is asfollows:UBA.<channel_number>.<collector_number> <elements_processed>/<UBA_element_limit elements>, <element_percentage>

[2010-11-05 10:36:02,226] main SdcUbaManager INFO - UBA.1.200: 40/80elements, 50%

The Load Balancer Adapter issues a load-status message in the followingcircumstances:v When an <element_percentage> value reaches another 5% threshold (that is, at

5%, 10%, 15%, and so on) during file processing.v On startup, when state is recovered from the adaptor.sync file.


v Every hour, independent of load increase, even if no 5% threshold is crossed.

If the overload state is triggered, the Load Balancer Adapter logs an error messagein the adaptor.log file. For more information, see “overload” on page 124.

Generating data files occur in 15-minute cycles. Load Balancer Adapter processingalso occurs in 15-minute cycles, but always begins 15 minutes after the currentData generation timestamp; or when there is a second cycle of data files generated.So the number of data files might be different when the Load Balancer Adapterprocessing cycle occurs after a data generation cycle.

Data generation timestamp is 13:01; Load Balancer Adaptor processinginterval is 13:02

At 13:31 two cycles of data files are generated. The next expected Load BalancerAdapter processing cycle time is 13:32. So the number of data files might increaseas the data generated in the data input directory increases.

Note: The smallest unit in the Load Balancer Adapter timer is in seconds.

You can specify the maximum size of the log file, and the number of backup logfiles to save after this limit is reached. For example, if two backup log files arespecified then it is 3 log files in total, one current log file and two backup log files,as detailed:-rw-r--r-- 1 pvuser staff 247 Nov 4 14:43 adaptor.log-rw-r--r-- 1 pvuser staff 1036 Nov 4 14:43 adaptor.log.1-rw-r--r-- 1 pvuser staff 1099 Nov 4 14:43 adaptor.log.2

For more information about these settings, see “Configuring the Load BalancerAdapter” on page 120.

Processing the files:About this task

At the end of each time period that is specified by the ADAPTOR_FILE_PERIODparameter, the Load Balancer Adapter processes the files as follows:1. Identifies all new data files in the locations that are specified by the

ADAPTOR_INPUT_DIRECTORY_LIST parameter, and all files in the<adapter_home>/alcatel_5529_sdc/LoadBalancer/reload directory.

2. Sorts all files that are found in Step 1, and processes them in chronologicalorder.

3. Identifies the element that is associated with each file.4. Assigns each element to a UBA, based on the current UBA load status.5. Creates a jumbo file for each UBA by using the following naming convention:

jumbo-file_<UBA_instance>_<timestamp>.gz

The jumbo file is generated by combining the content of all new CSV files forthat UBA, and is stored in the <adapter_home>/alcatel_5529_sdc/LoadBalancer/done/tmp directory during jumbo-file generation.

6. Moves the completed jumbo file to the UBA input directory specified in theadaptor.properties file.The size of the jumbo file depends on the number of files per period and thenumber of UBAs available.


For more information about Load Balancer Adapter configuration parameters andthe adaptor.properties file, see “Configuring the Load Balancer Adapter” on page120. For more information about the reload directory, see “reload.”

The Load Balancer Adapter keeps the processed files in the followingsubdirectories under the <adapter_home>/alcatel_5529_sdc/LoadBalancerdirectory:v done

v overload

v reload

done:

Data files are moved from the SDC Server directory to the done directory forprocessing. The data files are stored in the done directory for 1 hour before beingdeleted. After a data file is processed, it is then added to the appropriate jumbofile.

Jumbo files are generated and compressed in the done/tmp directory. When all ofthe data files for the period are processed, the jumbo files are moved to theUBA.<channel_number>.<collector_number>.INPUT_DIRECTORY

For more information about the INPUT_DIRECTORY, see “Configuring the LoadBalancer Adapter” on page 120.

overload:

Data files that cannot be processed are stored in the overload directory.

When all of the UBAs reach their element limits, the Load Balancer Adapter is inan overload state. No new elements can be processed. Instead, the new elementfiles are placed in the overload directory, and an error message is recorded in theadaptor.log file. The metrics for existing elements are processed as normal.However, new elements are not inventoried until the capacity of the system isincreased.

To increase the capacity of the system, edit the adaptor.properties file to eitherincrease the element limit for an existing UBA, or add a UBA. After the systemcapacity is increased, move the files from the overload directory to the reloaddirectory so that the Load Balancer Adapter can reprocess the files.

Note: Take care to move the files, do not copy them. Use the UNIX mv commandto preserve the original datestamp so that the files are processed in the correctchronological order.

reload:

Data files that must be reprocessed are placed in the reload directory.

For example, after you increase the system capacity, all files from the overloaddirectory must be moved (not copied) to the reload directory so that the LoadBalancer Adapter can reprocess the files.


It is not necessary to include the reload directory in the list that is specified by theADAPTOR_INPUT_DIRECTORY_LIST parameter; the Load Balancer Adapter searches thereload directory by default.

moving files:

The Load Balancer Adapter uses the Java renameTo method to move files.

This method requires that the source and destination directories be on the same filesystem.

Synchronizing with the Tivoli Netcool Performance Manager database:

The Load Balancer Adapter does not maintain state: if the Load Balancer Adapteris stopped, or dies or is killed, all of its information in memory is lost. Torepopulate the memory model, the Load Balancer Adapter must load asynchronization file.

About this task

To synchronize the Load Balancer Adapter with the database content, do thefollowing steps:

Procedure

1. Copy the sdcAdaptorSync.sh shell script from the Alcatel-Lucent 5529 SDCserver to the Tivoli Netcool Performance Manager DataMart server.The shell script is in the <adapter_home>/alcatel_5529_sdc/LoadBalancer/bindirectory.

2. Run the sdcAdaptorSync.sh shell script to generate the adaptor.sync file fromthe Tivoli Netcool Performance Manager database.

3. Transfer the adaptor.sync file to the Alcatel-Lucent 5529 SDC server, and placethe file in the directory where the Load Balancer Adapter is installed.

4. Start the Load Balancer Adapter. The adaptor.sync file creates a memory modelthat is consistent with the Tivoli Netcool Performance Manager database.

5. The Load Balancer Adapter starts to process files.

Adding nodes after the initial configuration:About this task

If you add nodes after the initial configuration of the Load Balancer Adapter, dothe following steps:

Procedure

1. Stop the Load Balancer Adapter.2. Update the configuration parameters in the adaptor.properties file to add any

new UBAs needed to handle the additional nodes.3. Wait for the UBAs to process the existing Alcatel-Lucent 5529 SDC data, and to

create any new inventory.4. Synchronize the Load Balancer Adapter with the Tivoli Netcool Performance

Manager database, as described in “Synchronizing with the Tivoli NetcoolPerformance Manager database.”

5. Restart the Load Balancer Adapter.


Removing nodes after the initial configuration:

If you remove nodes after the initial configuration of the Load Balancer Adapter,the nodes are still assigned to a UBA, but do not create any load.

About this task

If you determine that the nodes are unnecessary and will not be used again,update the configuration as follows:

Procedure

1. Stop the Load Balancer Adapter.2. Delete the obsolete elements by using the DataMart Resource Editor.3. Wait for a safe period.

Note: There might be files in the DataChannel that the UBA still needs toprocess. Errors might be seen in the DataChannel until these files are processed.The time to wait depends on the number of files that are waiting to beprocessed. In this case, synchronize the Load Balancer Adapter with the TivoliNetcool Performance Manager database, as described in “Synchronizing withthe Tivoli Netcool Performance Manager database” on page 125.

4. Restart the Load Balancer Adapter.

Alcatel-Lucent 5620 SAM Technology PackAdditional configuration steps required for Alcatel-Lucent 5620 SAM TechnologyPack.

Devices and servicesThis topic provides details about Alcatel-Lucent 5620 SAM server compatibility,supported devices, Alcatel-Lucent 5620 SAM services, data collection model, bulkinput file formats, and bulk adapter design files.

Supported devices:

The list of devices that are supported by the Alcatel-Lucent 5620 SAM TechnologyPack depends on the version of the technology pack.

Devices that are supported in this releaseThis version of the Alcatel-Lucent 5620 SAM Technology Pack supports thefollowing devices:v Alcatel-Lucent 9500 MPRv Alcatel-Lucent 7750 Service Routerv Alcatel-Lucent 7710 Service Routerv Alcatel-Lucent 7705 Service Aggregation Routerv Alcatel-Lucent 7450 Ethernet Service Switchv Alcatel-Lucent 7210 Service Access Switchv Alcatel-Lucent OmniSwitch 6850v Alcatel-Lucent OmniSwitch 6250

For more information about these devices, see http://www.alcatel-lucent.com.


For more information about these devices, see http://www.alcatel-lucent.com

For more information about these devices, see http://www.alcatel-lucent.com

How the devices are supportedThe Alcatel-Lucent 5620 SAM Technology Pack supports these devices inthe following ways:

Defines data generation, data storage, and data collection methodsThe Alcatel-Lucent 5620 SAM Technology Pack communicates withthe device through the Simple Object Access Protocol/ExtensibleMarkup Language (SOAP/XML) interface, and uses JMS fornotification of inventory changes. For more information about theSOAP/XML interface and other components that are associatedwith the data collection model, see Data collection model.

Defines Tivoli Netcool Performance Manager propertiesThe Alcatel-Lucent 5620 SAM defines and manages all of therelevant objects that are associated with the device in theAlcatel-Lucent XML-based equipment package. The Alcatel-Lucent5620 SAM Technology Pack maps the appropriate set of SAMobject properties that are defined in the equipment package toTivoli Netcool Performance Manager properties. In general, theNetcool Performance Manager property name is the same as theSAM object property name, except that the Netcool PerformanceManager property name also has the prefix “sam”. For informationabout the properties that are currently supported by theAlcatel-Lucent 5620 SAM Technology Pack, see the IBM TivoliNetcool Performance Manager: Alcatel-Lucent 5620 SAM 2.12.0.0Technology Pack Reference.

Alcatel-Lucent 5620 SAM services:

Alcatel-Lucent 5620 SAM users can configure services, such as VPRN, VPLS, andcustomer or subscriber sites to the core network at the SAPs.

A user might also configure a set of policies to manage different classes of traffic atthe SAPs. An SAP can have one policy that is applied for ingress traffic, andanother for egress (to the customer site). The Alcatel-Lucent 5620 SAM has apredefined set of eight traffic classes:

bel2afl1h2efh1nc

In addition, the Alcatel-Lucent 5620 SAM supports unicast, multicast, andbroadcast IP traffic.

A user can define a policy to manage each combination of traffic classes and casttypes uniquely. With eight classes and four types, 32 different combinations arepossible. On an SAP, each unique combination is supported by a separate queue,which means up to 32 queues to be managed. On ingress, the SAPs supportseparate queues for the different casts of traffic. However, on egress, the SAPs donot support separate queues. Therefore, on egress, there is a maximum of eightqueues.


The Alcatel-Lucent 5620 SAM represents these entities in the following objects:

SAPs SAP object represents an SAP. The SAP object has a PolicyId property.

PoliciesThe Policy object represents the policy.

ForwardingClassesA ForwardingClass object represents one of the eight possible classes oftraffic. This object has a PolicyId property that indicates the policy towhich it belongs. If the object is an ingress ForwardingClass, it has fourqueue IDs, one each for Unicast, Multicast, Broadcast, and Other. If theobject is an egress ForwardingClass, it has one queue ID.

Service queuesAn Egress Service Queue object or an Ingress Service Queue objectrepresents a service queue on an SAP.

Data collection model:

The Alcatel-Lucent 5620 SAM Technology Pack integrates with the Alcatel-Lucent5620 SAM, collecting and reporting performance metrics for the networkinginfrastructure and services that the Alcatel-Lucent 5620 SAM manages.

Communication between Tivoli Netcool Performance Manager components andAlcatel-Lucent 5620 SAM is through the SOAP/XML interface and XML files.Simple Object Access Protocol (SOAP) is a lightweight XML-based messagingprotocol. SOAP is used to encode the information in web service request andresponse messages before sending them over a network. SOAP messages areindependent of any operating system or protocol. SOAP messages can betransported by using various Internet protocols, including Simple Mail TransferProtocol (SMTP), Multipurpose Internet Mail Extensions (MIME), and HyperTextTransfer Protocol (HTTP).

Figure 5. Data collection model for the Alcatel-Lucent 5620 SAM Technology Pack


When the technology pack is operating, Tivoli Netcool Performance Managerperiodically commands the Alcatel-Lucent 5620 SAM, through SOAP/XML, togenerate XML files that contain metrics for a number of the managed resources.These XML files are then collected and processed, with the results presented in aset of web-based reports, which are listed and described in Alcatel-Lucent 5620SAM 2.10.2.0 Technology Pack Reference.

InventoryThe Alcatel-Lucent 5620 SAM contains an object database that representsthe network resources and their relationships to other network resources. Italso represents some abstract resources and relationships. Services andtheir owners (called Subscribers) are represented, along with theirrelationships to each other and to the Service Access Point Queues.

MetricsThe Bulk Load Balancer (BLB) periodically makes requests to theAlcatel-Lucent 5620 SAM server to retrieve SAM statistics for one period.The SAM statistics are then passed to the UBA for parsing and processinginto Tivoli Netcool Performance Manager metrics.

Figure shows that the Alcatel-Lucent 5620 SAM Technology Pack manages theinventory of the resources, real and abstract, in two ways:v Complete inventoryv Event-driven inventory

Complete inventoryFigure shows that in the complete inventory, the SAM Inventory File(SAMIF) adapter application uses the instructions that are contained in theSAMIF design files. These instructions are used to send a singleSOAP/XML request to the Alcatel-Lucent 5620 SAM for each SAM objecttype, which is needed to execute the inventory. Specifically, the request isfor an XML file that contains information about all instances of that objecttype. The requests from the SAMIF adapter application filters the set ofproperty values that are returned for each SAM object type. This filteroperation limits the set of property values to those that matter to thetechnology pack inventory.

The SAMIF adapter application reads each XML file and does thefollowing actions:v Collects inventory for Tivoli Netcool Performance Manager-monitored

objects that the Alcatel-Lucent 5620 SAM Technology Pack manages, andstores this object information in its memory.

v Creates the appropriate subelements. Maps Tivoli Netcool PerformanceManager properties to their associated SAM object properties.

v Assigns these Tivoli Netcool Performance Manager properties to theirassociated subelements.

v Stores these resources in the Tivoli Netcool Performance Managerdatabase.

Furthermore, the SAMIF adapter application creates an ID Map file whosepurpose is to provide inventory-related information to the Bulk LoadBalancer (BLB) adapter. The ID Map file maps foreign keys of the externalsystem to the Resource ID and Collector ID used within Tivoli NetcoolPerformance Manager.

When the inventory and metrics are in separate bulk input files (as is thecase in the Alcatel-Lucent 5620 SAM environment), a technology pack


developer typically implements several types of bulk adapter design filesas described in Bulk adapter design files.

Event-driven inventoryThe Java™ Message Service (JMS) API is a messaging standard. It enablesapplication components that are based on the Java 2 Platform, EnterpriseEdition (J2EE) to create, send, receive, and read messages. The JMS APIenables distributed communication that is loosely coupled, reliable, andasynchronous. The Alcatel-Lucent 5620 SAM uses the JMS API to viewreal-time events and alarm feed information from the managed network.For more information, see the Alcatel-Lucent 5620 SAM-O OSS InterfaceDeveloper Guide.

Note: Alcatel-Lucent 5620 SAM-O is an open interface on the Alcatel-Lucent 5620SAM. An OSS client application can access information through the Alcatel-Lucent5620 SAM-O.Figure shows that in the event-driven inventory, the SAMIF adapter applicationuses the instructions, which are contained in the SAMIF design files to process JMScreate, delete, and update messages. For more information about SAMIF designfiles, see Bulk adapter design files.


The Alcatel-Lucent 5620 SAM devices gather performance data and other SAMstatistics from multiple network elements, in XML format. This data is referred tocollectively as network health metrics. Each Alcatel-Lucent 5620 SAM deviceproduces, on an hourly basis, bulk input files that contain the network healthmetrics and other information.

The Alcatel-Lucent 5620 SAM Technology Pack supports multiple input files perUBA, where each input file contains data for one polling period only. The syntaxfor these bulk input files is explained in Bulk input file name. The Alcatel-Lucent5620 SAM Technology Pack provides several files that interpret these bulk inputfiles. For more information, see Bulk adapter design files.

Bulk input file name

In the Alcatel-Lucent 5620 SAM environment, the inventory and metrics are inseparate bulk input files.

Inventory bulk input file nameThe Alcatel-Lucent 5620 SAM Technology Pack uses the following syntaxfor inventory file names:

proviso-inventoryType-dateRequested-timeRequested-* Here are someexample inventory file names:v proviso-physicalPort-2010.02.16-21.52.38-3443809958133862-26361

v proviso-mplsInterface-2010.02.16-21.53.52-3443810032485722-14952

v proviso-iesL3AccessInterface-2010.02.16-22.34.46-3443812486323659-98844


Tivoli Netcool Performance Manager bulk adapters can support several dataformats for bulk input files, for example CSV, XML, and binary. The Alcatel-Lucent5620 SAM server produces data in XML format, and uses JMS for notification ofinventory changes.


Each UBA technology pack provides at least one bulk adapter design file to definethe data format supported by that technology pack. Technology pack developersimplement bulk adapter design files by using JavaScript®. Some technology packsprovide several bulk adapter design files, each of which handles a specific bulkinput file format.

A bulk adapter design file typically can process both inventory and metrics datafrom the same bulk input file, and provides a function that creates the bulkcollection formula names. When the inventory and metrics are in separate bulkinput files (as is the case in the Alcatel-Lucent 5620 SAM environment), atechnology pack developer typically implements several types of bulk adapterdesign files. The Alcatel-Lucent 5620 SAM Technology Pack provides the followingtypes of bulk adapter design files:v SAMIF design filesv UBA design filesv BLB design files

SAMIF design filesThe SAM Inventory File (SAMIF) adapter is a DataChannel application thatinterprets and parses bulk input files that contain inventory data. Atechnology pack developer implements SAMIF design files that tell theSAMIF adapter application how to interpret and parse these bulk inputfiles. The main SAMIF design file, SAMIFAdaptor.js, contains globalvariable declarations and statements that import the other SAMIF designfiles.

The Alcatel-Lucent 5620 SAM Technology Pack provides the followingSAMIF design files:v SAMIF_aingr_aengr_forwarding_class.js

v SAMIF_aingr_aengr_policy.js

v SAMIF_aingr_aengr_queue.js

v SAMIF_aosqos_policy.js

v SAMIF_cfm_ethernet.js

v SAMIF_cfm_loopback.js

v SAMIF_cfm_oneway_delay.js

v SAMIF_cfm_twoway_delay.js

v SAMIF_dhcp_Dhcp6AdressPrefix.js

v SAMIF_dhcp_subnet.js

v SAMIF_equipment_BaseCard.js

v SAMIF_equipment_cardSlot.js

v SAMIF_equipment_channel.js

v SAMIF_equipment_ControlProcessor.js

v SAMIF_equipment_DaughterCard.js

v SAMIF_equipment_hw_environment.js

v SAMIF_equipment_physical_port.js

v SAMIF_equipment_IMA_Link.js

v SAMIF_equipment_MCMCard.js

v SAMIF_equipment_shelf.js

v SAMIF_icmp_ping.js

v SAMIF_lag_interface.js


v SAMIF_mpls_dynamic_lsp.js

v SAMIF_mpls_interface.js

v SAMIF_mpls_ping.js

v SAMIF_mpls_site.js

v SAMIF_nat_IsaMda.js

v SAMIF_nat_IsaMember.js

v SAMIF_ppp_control_protocol.js

v SAMIF_ppp_interface.js

v SAMIF_rtr_virtual_router.js

v SAMIF_selectJmsVersion.js

v SAMIF_service_access_interface.js

v SAMIF_service_access_point.js

v SAMIF_service_site_ping.js

v SAMIF_svq_aggregation_scheduler.js

v SAMIF_svt_sdp_binding.js

v SAMIF_svt_tunnel_ping.js

v SAMIF_svt_vccv_ping.js

v SAMIF_tdmequipment_DS1_E1_PortSpecific.js

v SAMIFAdaptor.js

v SAMIF_cfm_single_ended_loss.js

v SAMIF_ethernetoam_mep.js

UBA design filesThe Universal Bulk Adaptor (UBA) is a DataChannel application thatinterprets and parses bulk input files that contain inventory and metricsdata, or (as is the case in the Alcatel-Lucent 5620 SAM environment)metrics data only. A technology pack developer implements UBA designfiles that tell the UBA application how to interpret and parse these bulkinput files.

The current version of the Alcatel-Lucent 5620 SAM Technology Packsupports two UBA Bulk Collectors. Therefore, the Alcatel-Lucent 5620 SAMTechnology Pack provides two main UBA design files:v The SAMUBAAdaptor_polled.js file is used by the first UBA Bulk

Collector and handles most of the metrics.v The SAMUBAAdaptor_accounting.js file is used by the second

(accounting) UBA Bulk Collector and handles the accounting metrics.These metrics are service-oriented metrics.

The Alcatel-Lucent 5620 SAM Technology Pack provides the followingUBA design files:v SAMUBA_aosqos_policy.js

v SAMUBA_avail_aggregator.js

v SAMUBA_avail_extensions.js

v SAMUBA_avail_operator.js

v SAMUBA_avail_schema.js

v SAMUBA_cfm_ethernet.js

v SAMUBA_cfm_oneway_delay.js

v SAMUBA_cfm_single_ended_loss.js

v SAMUBA_dhcp_LocalDhcp6ServerPrefixStats.js


v SAMUBA_dhcp_LocalDhcpServerSubnetStats.js

v SAMUBA_equipment_allocated_memory.js

v SAMUBA_equipment_available_memory.js

v SAMUBA_equipment_cardSlot.js

v SAMUBA_equipment_digital_diagnostic_monitoring.js

v SAMUBA_equipment_interface.js

v SAMUBA_equipment_interface_additional.js

v SAMUBA_equipment_media_independent.js

v SAMUBA_equipment_system_cpu.js

v SAMUBA_equipment_system_memory.js

v SAMUBA_ethernet_equipment_dot3_stats.js

v SAMUBA_ethernetequipment_AggrMainRxStats.js

v SAMUBA_ethernetequipment_AggrMainTxStats.js

v SAMUBA_hw_environment.js

v SAMUBA_hw_temperature.js

v SAMUBA_IsaMemberUsageStats.js

v SAMUBA_metrics.js

v SAMUBA_mpls_interface.js

v SAMUBA_mpls_site.js

v SAMUBA_mpr_IMALinkCurrentStats.js

v SAMUBA_mss.js

v SAMUBA_nqueue_combined_network_egress.js

v SAMUBA_nqueue_combined_network_ingress.js

v SAMUBA_OAM_ping_results.js

v SAMUBA_ppp_control_protocol.js

v SAMUBA_ppp_interface.js

v SAMUBA_radioequipment_PdhFrameHopHistoryDataStats.js

v SAMUBA_radioequipment_PdhFrameLinkHistoryDataStats.js

v SAMUBA_radioequipment_RadioAnalogueMeasure.js

v SAMUBA_rtr_route_stats.js

v SAMUBA_schema.js

v SAMUBA_sdp_binding_base_stats.js

v SAMUBA_svc_complete_service_egress.js

v SAMUBA_svc_complete_service_ingress.js

v SAMUBA_svc_pppoe.js

v SAMUBA_tdmequipment_DS1HistoryStats15minInLogRecord.js

v SAMUBA_tdmequipment_DS1HistoryStats15minOutLogRecord.js

v SAMUBA_tdmequipment_E1HistoryStats15minInLogRecord.js

v SAMUBA_tdmequipment_E1HistoryStats15minOutLogRecord.js

v SAMUBAAdaptor_accounting.js

v SAMUBAAdaptor_polled.js

BLB design filesThe Bulk Load Balancer (BLB) adapter is a DataChannel application thatrequests bulk data files from the SAM server. The BLB then passes the bulkdata files to the UBA for processing. The BLB also parses ID map files that


are received from the SAMIF, to understand what inventory exists. TheAlcatel-Lucent 5620 SAM Technology Pack provides the following BLBdesign file:v SAMBLBAdaptor.js

Other JavaScript filesThe Alcatel-Lucent 5620 SAM Technology Pack also provides the followingJavaScript files, which are used internally:v AppLogger.js

v jms_2_0.js

v jms_2_1.js

v jms_3_0.js

v SAM_app_config.js

v SAM_hash_array.js

v SAM_property_mapping.js

v SAM_property_storage.js

v SAM_soap_filter.js

v SAMCommon.js

v SAMDomainModel.js

Setting up the Alcatel-Lucent 5620 SAM serversThe SAM server administrator must set up the appropriate SAM serversenvironment so that the Alcatel-Lucent 5620 SAM Technology Pack operatescorrectly.

About this task

Setting up the Alcatel-Lucent 5620 SAM servers includes the following tasks:

Install SAM on the primary and redundant servers:

The SAM server administrator must have installed SAM on primary andredundant servers. The Alcatel-Lucent 5620 SAM Technology Pack accesses theSAM servers to request the inventory and metrics.

Synchronize the clocks:

Use the appropriate tool to ensure that the clocks on the SAM server and theserver on which the Tivoli Netcool Performance Manager DataChannel is installedare identical.

For example, make sure the Coordinated Universal Time (UTC) on the server onwhich Tivoli Netcool Performance Manager DataChannel is operating matches theUTC time on the server on which Alcatel-Lucent 5620 SAM is operating.

Install the Alcatel-Lucent 5620 SAM Client GUI:

The SAM server administrator must have installed the Alcatel-Lucent 5620 SAMClient GUI on some client computer or server.

During the installation, the SAM server administrator configured the IP addressesof the SAM primary and redundant servers.


Configure an OSS user account:

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI toconfigure an operational support system (OSS) user account from the clientcomputer or server.

This user account consists of a user name and password that allows the user toaccess the SAM primary and redundant servers. This OSS user account must nothave administrative privileges. The SAM server administrator must record the username and password for this OSS user account and keep it in a secure place.

The DataChannel BLB application needs access to this OSS account. TheAlcatel-Lucent 5620 SAM Technology Pack supplies the following parameters inwhich the previously listed OSS user account information can be specified:v SAM.USERNAME

v SAM.PASSWORD

The Alcatel-Lucent 5620 SAM Technology Pack supplies these parameters for TivoliNetcool Performance Manager version 4.4.3 and later. These parameters are in thepack XSD file. You specify values for these parameters as part of adding a UBABulk Collector and associating it with the Alcatel-Lucent 5620 SAM TechnologyPack. For more information about adding a bulk collector, see the section onadding a UBA bulk collector in the IBM Tivoli Netcool Performance Manager:Installation Guide.

Configure the SAM accounting and polling statistics:

Accounting policies are relevant to the Access Interfaces and the metrics that theyreport. The type of accounting policy on an Access Interface determines the metricsthat are reported.

When inventory is collected, Tivoli Netcool Performance Manager learns theaccounting policy for each Access Interface. From these accounting policies, theAlcatel-Lucent 5620 SAM Technology Pack can determine the accounting policytype.

The Alcatel-Lucent 5620 SAM defines and manages accounting policies, whichdetermine how SAM accounting statistics are collected. The Alcatel-Lucent 5620SAM Technology Pack currently supports two types of SAM accounting statistic:access-port statistics and network-port statistics. The accounting package providesa maximum of 13 active accounting policies, one for each type of record for theeight access-port statistics types and for the five network-port statistics types.

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI toconfigure SAM accounting statistics on the primary and redundant SAM servers.

The Alcatel-Lucent 5620 SAM Technology Pack supports the accounting policiesthat are listed in the table, depending on the type of nodes that are monitored.

Table 9. Supported accounting policies


CombinedNetworkEgressOctetsLogRecord Manages the collection of octet activity foregress network queues.

CombinedNetworkIngressOctetsLogRecord Manages the collection of octet activity foringress network queues.


Table 9. Supported accounting policies (continued)


CompleteServiceEgressPacketOctetsLogRecord

Manages the collection of packet and octetactivity for egress service queues.

CompleteServiceIngressPacketOctetsLogRecord

Manages the collection of packet and octetactivity for ingress service queues.

ServiceEgressOctetsLogRecord Manages the collection of octet activity foregress service queues.

ServiceEgressPacketsLogRecord Manages the collection of packet activity foregress service queues.

ServiceIngressOctetsLogRecord Manages the collection of octet activity foringress service queues.

ServiceIngressPacketsLogRecord Manages the collection of packet activity foringress service queues.

Note:

The service.ServiceEgressOctetsLogRecord class and theservice.ServiceEgressPacketsLogRecord class are mutually exclusive. You cannotcollect metrics for both classes at the same time.

Similarly, the service.ServiceIngressOctetsLogRecord class and theservice.ServiceIngressPacketsLogRecord class are mutually exclusive. You cannotcollect metrics for both classes at the same time.

The SAM server administrator uses the appropriate utility to configure pollingstatistics for SAM statistics classes. To configure polling statistics for these SAMstatistics classes, enable the appropriate MIBs on the primary and redundant SAMservers.

The default Tivoli Netcool Performance Manager collection period for all types ofSAM statistics is set to every 15 minutes, so the SAM server policies must beconfigured to match this default value.

Note: The collection period for any type of SAM statistics must be set to the samevalue as the collection period for the corresponding Tivoli Netcool PerformanceManager requests.

For information about how to change the collection period for SAM statistics, see“Changing the collection period for SAM accounting statistics” on page 170.

Enable the MIBs for the SAM statistics classes:

SAM server administrator must enable all of the MIBs listed in the table for theAlcatel-Lucent 5620 SAM Technology Pack.

The first column of the table identifies the SAM statistics class on which to enablepolling statistics; the second column identifies the MIBs to enable for the SAMstatistics classes; and the third column identifies the object types to enable. TheSAM server administrator can enable more object types, but the Alcatel-Lucent5620 SAM Technology Pack expects at a minimum the ones that are listed in thethird column.


Table 10. MIBs to enable for SAM statistics classes

SAM statistics class MIB Object types

equipment.AllocatedMemoryStatsLogRecord

TIMETRA-SYSTEMMIB sgiMemoryPoolAllocat ed

equipment.AvailableMemoryStatsLogRecord

TIMETRA-SYSTEMMIB sgiMemoryAvailable

equipment.InterfaceAdditionalStatsLogRecord

IF-MIB ifXEntry

equipment.InterfaceStatsLogRecord

IF-MIB (in the file namedrfc2233-IF-MIB)

ifEntry

equipment.MediaIndependentStatsLogRecord

HC-RMON-MIB mediaIndependentEntry

equipment.SystemCpuStatsLogRecord

TIMETRA-SYSTEMMIB sgiCpuUsage

equipment.SystemMemoryStatsLogRecord

TIMETRA-SYSTEMMIB sgiMemoryUsed

mpls.MplsInterfaceStatsLogRecord

TIMETRA-MPLS-MIB vRtrMplsIfStatEntry

ppp.PppStatsLogRecord andppp.PppControlProtocol

TIMETRA-PPP-MIB tmnxPppEntry

svt.SdpBindingBaseStatsLogRecord

TIMETRA-SERV-MIB sdpBindBaseStatsEntr y

ethernetequipment.Dot3StatsLogRecord

EtherLike-MIB dot3StatsEntry

mpls.SiteStatsLogRecord TIMETRA-MPLS-MIB vRtrMplsGeneralStatEntry

service.PppoeSapStatsLogRecord

TIMETRA-PPPOEMIB tmnxPppoeSapStatsEntry

svq.CustMultiSvcSiteIngSchedPlcyPortStatsLogRecord

TIMETRA-SERV-MIB custMultiSvcSiteIngSchedPlcyPortStatsEntry

svq.CustMultiSvcSiteEgrSchedPlcyPortStatsLogRecord

TIMETRA-SERV-MIB custMultiSvcSiteEgrSchedPlcyPortStatsEntry

aosqos.QoSIngressPolicyStatsLogRecord

ALCATEL-IND1- QOS-MIB alaQoSRuleEntry

equipment.CardHealthStatsLogRecord

ALCATEL-IND1- HEALTH-MIB healthModuleEntry

Configure FTP accounts on the primary and redundant SAM servers:

The SAM server administrator uses the ftp utility to configure FTP user accountson the primary and redundant SAM servers

The FTP users must have access to the SAM XML output directory, which bydefault is /opt/5620sam/server/xml_output. The FTP users must also havepermission to delete files.

Important: You must set the permissions for the SAM XML output directory andthe parent directories so that the DataChannel BLB and SAMIF applications cansuccessfully retrieve the XML source input files.

The SAM server administrator must record the following information about theFTP user accounts and keep this information in a secure place:v User names for the FTP accounts on SAM server 1 and SAM server 2v Encrypted passwords for the FTP accounts on SAM server 1 and SAM server 2v Host names of SAM server 1 and SAM server 2


v The name of the server on which the Alcatel-Lucent 5620 SAM Technology Packwas installed

The DataChannel BLB and SAMIF applications need to retrieve the XML sourceinput files from the two FTP accounts. The Alcatel-Lucent 5620 SAM TechnologyPack supplies the following URI-related parameters in which the previously listedFTP account information can be specified:v SAM.EXPORT_URIv SAM.EXPORT_URI_2

The Alcatel-Lucent 5620 SAM Technology Pack supplies these parameters. Theseparameters are supplied in the pack’s XSD file. You specify values for theseparameters as part of adding a UBA Bulk Collector and associating it with theAlcatel-Lucent 5620 SAM Technology Pack. For more information about adding aUBA Bulk Collector, see the section on adding a UBA Bulk Collector in the IBMTivoli Netcool Performance Manager: Installation Guide. For convenience, thedescriptions for these parameters are provided in Appendix A, UBA parameters(Tivoli Netcool/Proviso v4.4.3 and Tivoli Netcool Performance Manager).

Configure the HTTP SOAP and JMS accounts:

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI toconfigure HTTP SOAP and JMS accounts on the primary and redundant SAMservers.

The SAM server administrator must record the following information about theHTTP SOAP and JMS user accounts and keep it in a secure place:v Host name of SAM server 1 that hosts HTTP SOAP and JMS accountsv Host name of SAM server 2 that hosts HTTP SOAP and JMS accounts

The DataChannel BLB and SAMIF applications need to know about these HTTPSOAP accounts and the SAMIF needs to know about the JMS accounts. TheAlcatel-Lucent 5620 SAM Technology Pack supplies the following parameters inwhich the previously listed HTTP SOAP and JMS account information can bespecified:v SAM.SOAP_URIv SAM.SOAP_URI_2v SAM.JMS_URIv SAM.JMS_URI_2

The Alcatel-Lucent 5620 SAM Technology Pack supplies these parameters. Theseparameters are supplied in the pack’s XSD file. You specified values for theseparameters as part of adding a UBA Bulk Collector and associating it with theAlcatel-Lucent 5620 SAM Technology Pack. For more information about adding aUBA Bulk Collector, see the section on adding a UBA Bulk Collector in the IBMTivoli Netcool Performance Manager: Installation Guide.

Specify the JMS port:

The DataChannel SAMIF application must have access to the JMS accounts that theSAM server administrator created on the primary and redundant SAM servers.

The SAM.JMS_PORT parameter specifies the JMS port number for the SAM primaryserver. Two related parameters (SAM.JMS_URI and SAM.JMS_URI_2) identify, by using


http URLs, the JMS account locations on the primary and redundant SAM servers.These URI-related parameters use the JMS port number that is specified for theSAM.JMS_PORT parameter.

You configure the JMS port number on the SAM server when you install orreconfigure the SAM server. The value of the JMS port number depends on thenumber of SAM servers in your configuration, as follows:v If your configuration has two SAM servers, set the SAM.JMS_PORT parameter to

port number 1100 for both the primary server and the redundant server.v If your configuration is a stand-alone SAM server, set the SAM.JMS_PORT

parameter to port number 1099.

Note: Ensure that you configure the SAM.JMS_PORT parameter to have the samevalue as the corresponding value on the SAM server.

The Alcatel-Lucent 5620 SAM Technology Pack supplies this parameter. Thisparameter is supplied in the pack’s XSD file. You specified a value for thisparameter as part of adding a UBA Bulk Collector and associating it with theAlcatel-Lucent 5620 SAM Technology Pack. For more information about adding aUBA Bulk Collector, see the section on adding a UBA Bulk Collector in the IBMTivoli Netcool Performance Manager: Installation Guide.

Install the JRE 1.6 or later Environment:

The SAMIF application expects that the server on which the Alcatel-Lucent 5620SAM Technology Pack was installed is running the Java Runtime Environment(JRE) 1.6 or later.

More specifically, the SAMIF application looks for the JRE 1.6 in the standardlocation, which is /usr/java/jre. If the JRE 1.6 is installed in a nonstandardlocation, the SAMIF needs a way to locate it. The SAM.JAVA_PATH parameteridentifies the nonstandard location of the JRE 1.6.

The Alcatel-Lucent 5620 SAM Technology Pack supplies this parameter. Thisparameter is supplied in the pack’s XSD file. You specified a value for thisparameter as part of adding a UBA Bulk Collector and associating it with theAlcatel-Lucent 5620 SAM Technology Pack. For more information about adding aUBA Bulk Collector, see the section on adding a UBA Bulk Collector in the IBMTivoli Netcool Performance Manager: Installation Guide.

Set up ping tests:

The SAM server enables SAM server administrators to run ping tests to receiveinformation about traffic latency and jitter.

The results from the tests can include SAM statistics such as round-trip time,one-way trip time, jitter. These test results can be collected as metrics against OAMTest object subelements that represent the tests.

Note: This section describes one method of creating OAM (ping) tests. Thismethod uses the Alcatel-Lucent 5620 SAM Client GUI to set up the OAM test torun periodically by using the scheduler on the SAM server. To run the OAM teston the SAM server, you must set the NE NE schedulable to off. This is only onemethod for running OAM tests and is provided for users who have no knowledgeabout how to run OAM tests. In other methods for running OAM tests, the NEschedulable setting can be set to on. In any method that is employed to run the


OAM tests, the period of the tests must be set to the same value as the period forthe metric requests. The default value is 15 minutes.

A SAM server administrator can create ping tests in two ways:

Alcatel-Lucent 5620 SAM Client GUIThe Alcatel-Lucent 5620 SAM Client GUI allows a SAM serveradministrator to set up a ping test, specifying the period of the test, thetype of test, and so on.

OSS requestsThe SAM server administrator might also establish OSS requests that createping tests on the SAM server.

Although the two methods are available, the Alcatel-Lucent 5620 SAM TechnologyPack expects that a SAM server administrator manually sets up ping tests by usingthe Alcatel-Lucent 5620 SAM Client GUI. For more information about setting upthese ping tests, see the Alcatel-Lucent 5620 Service Aware Manager Release 7.0 UserGuide.

To collect ping-related SAM statistics that are meaningful within Tivoli NetcoolPerformance Manager, multiple consecutive data points need to be collected forany particular OAM Test object subelement. Thus, it is recommended that pingtests be set up to run on a schedule that lasts for a significant duration (minimumthree hours).

This section summarizes the steps to follow. For more information, see theAlcatel-Lucent 5620 Service Aware Manager Release 7.0 User Guide.v Create a test suite. Make sure the NE Schedulable option is not selected so that

the test schedule runs on the SAM server and not the routers themselves.v Create one or more ping tests. The Alcatel-Lucent 5620 SAM Technology Pack

supports several types of ping tests. Remember not to select the NE Schedulableoption. Make sure the tests run without errors.

v Add the ping tests to the test suite.v Create a schedule to run the test suite. Set the schedule to run at the same

frequency as the Tivoli Netcool Performance Manager collection requests forjitter and latency. For example, if Tivoli Netcool Performance Manager collectionrequests occur every 15 minutes, then set the schedule to run the ping test suiteevery 15 minutes.

Note: Ensure that you set the frequency to a value that is consistent with theother collection periods. See “Changing the collection period for SAMaccounting statistics” on page 170 for guidelines about setting this schedule.

v Apply the schedule to the test suite and run the tests that are contained in thesuite. Each time a test completes, Tivoli Netcool Performance Manager collects aset of metrics.

SAM server administrators can run several types of ping tests to measure trafficcharacteristics at different levels of the network stack. Each ping test is representedby its own SAM class and associated ping result class. For more information aboutthese classes, see the Alcatel-Lucent 5620 SAM XML Reference - Release 7.0documentation.

Configure the technology packHow to configure the Alcatel-Lucent 5620 SAM Technology pack.


Before you begin

Ensure that you:v Have the following software and documentation for your version of Tivoli

Netcool Performance Manager:– Pack Release Summary for the current technology pack release– Installing Tivoli Netcool Performance Manager - Wireless Component.– Installing and Configuring Technology Packs.– Upgrading Tivoli Netcool Performance Manager - Wireline Component (if you

are upgrading the core software).– Upgrading Technology Packs (if you are upgrading the technology pack

software).– Configuring and Operating DataMart

Important: Refer to this guide to run a bulk inventory profile.– Access to the Tivoli Netcool Performance Manager DataMart server– An X Window server on the DataMart server.

Note: (Tivoli Netcool Performance Manager pre-v4.4.3) If there is no graphicscard on the DataMart server, you can install the Xvfb virtual frame bufferpackage to provide X Window services, as described in the Installing TivoliNetcool Performance Manager - Wireline Component.

– Access to the SilverStream server.– Access to the Tivoli Integrated Portal– Access to the DataChannel server.

v Completed the following tasks:– Reviewed the release notes for the current technology pack.

Note: Release notes contain important information that you must considerbefore you install a technology pack. They also contain information onspecific patches that must be installed before you configure a technologypack.

– Installed the current version of the Tivoli Netcool Performance Managercomponents, as described in theInstalling Tivoli Netcool PerformanceManager - Wireless Component.

– Installed the Alcatel-Lucent 5620 SAM Technology Pack.

Note: Installation instructions for a technology pack can be found in theInstalling and Configuring Technology Packs. Upgrade instructions for atechnology pack can be found in the Installing and Configuring TechnologyPacks. Localization is done automatically during installation of the technologypack.

– Configured at least one DataChannel.– Configured two UBA Bulk Collector subchannels.– Created a user on the Alcatel-Lucent 5620 SAM server with permission to FTP

and delete files.v Configured the technology-specific components.

The Alcatel-Lucent 5620 SAM Technology Pack requires that you configure thefollowing technology-specific components:– Bulk Load Balancer (BLB)


– DataSync 5620 SAM (also referred to as SAMIF or SAM Inventory File)

You configured these components as follows:– Tivoli Netcool/Proviso V4.4.3 and Tivoli Netcool Performance Manager

As part of the DataChannel installation, you:1. Loaded the pack XSD file into an existing topology.2. Added two UBA Bulk Collectors and associated them with the

Alcatel-Lucent 5620 SAM Technology Pack.3. Modified the technology pack-specific parameters for the BLB and SAMIF.

Note: Now, you also modified technology pack-specific parameters for theUBA.

4. Redeployed the updated topology. See the Installing and ConfiguringTechnology Packs for more information.

Note: You have another opportunity to modify the pack-specific UBA, BLB,and SAMIF parameters during pack configuration, as described in thischapter.

To configure the Alcatel-Lucent 5620 SAM Technology Pack, follow these steps:

Procedure1. Load the DataMart environment. To load the shell with the DataMart

environment, follow these steps:a. Log in to the DataMart server as pvuser.b. Change your working directory to the DataMart home directory

(/opt/datamart, by default), by using the following command:$ cd /opt/datamart

c. Load the shell with the DataMart environment, by sourcing thedataMart.env file, as follows:$ . /opt/datamart/dataMart.env

Note: After you load the DataMart environment into the shell, thePVMHOME variable is set to the DataMart home directory, /opt/datamartby default. These instructions assume that this variable is set.

2. Copy technology-specific files from the DataMart server to the DataChannelserver. Technology-specific files are used to associate a UBA technology packwith a specific instance of the UBA.


entering the user name and password that you specified when youinstalled and configured a DataChannel. The default user name andpassword are pvuser and PV.


b. Change your working directory to the DATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory by entering the following command, replacingDATA_CHANNEL_HOME with the DataChannel home directory(/opt/datachannel, by default):$ cd DATA_CHANNEL_HOME/scripts/alcatel_5620_sam

c. Using the FTP utility in text mode, log in to the DataMart server by usingthe appropriate user name and password (pvuser and PV, by default).

d. Using the cd subcommand, change your working directory to the$PVMHOME/APFiles/alcatel_5620_sam/datachannel/scripts/alcatel_5620_sam directory.

e. Using the get subcommand, copy the bulk adapter design files (*.js),scripts (if any), and other files (if any) from the DataMart server to theDataChannel server.

f. Exit the FTP utility by entering the bye subcommand.g. Verify that the technology-specific files are now in the target directory as

follows:v (Tivoli Netcool/Proviso v4.4.3 and Tivoli Netcool Performance Manager)

Verify that the bulk adapter design files (*.js), scripts (if any), other files(if any) are now in the DATA_CHANNEL_HOME/scripts/alcatel_5620_samdirectory.

3. Copy the samOss.jar file to the DataChannel server.In the previous step, you copied technology-specific files from the DataMartserver to the DATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory on theDataChannel server. The technology-specific files included SamJms.jar, theJAR file that is required by the Alcatel-Lucent 5620 SAM Server. TheSamJms.jar file requires that the samOss.jar file is also in theDATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory. The samOss.jar file isdistributed on a SAM distribution DVD referred to as the 5620 SAM softwareDVD-ROM, and is in the following directory: <SAM_ROOT_RELEASE_DIR>/nms/integrations/SAM_OYou must copy the samOss.jar file from the directory on the DVD to theDATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory (/opt/datachannel/scripts/alcatel_5620_sam, by default) on the DataChannel server.After you complete the copy operation, the DATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory contains the samOss.jar file, the Bulk AdaptorDesign files, the alcatel_5620_sam_sample_dc.cfg template file (Tivoli NetcoolPerformance Manager pre-v4.4.3 only), SamJms.jar, and any othertechnology-specific files.

4. Activate data collection requests. During installation of the technology pack,all predefined data collection requests are promoted to the database and set toinactive (that is, idle displays in the Active column of the Tivoli NetcoolPerformance Manager DataMart Request Editor). You must activate thesepredefined data collection requests by using the Request Editor. To set datacollection requests to active, follow these steps:a. Change your working directory to $PVMHOME/bin (/opt/datamart/bin, by

default) on the DataMart server.b. Start the DataMart GUI by entering the following command and pressing

Enter:$ pvm

c. Click the Configuration tab, then click Request Editor to open the RequestEditor.

d. Click the Collection tab.


e. Click Refresh. The predefined data collection requests are loaded into theRequest Editor from the database.

f. Click the Inactive button in the Filter group box to display only idlerequests.

g. In the Sub-Element Groups pane, select all idle data collection requests inthe following group or groups: Root->Sub-Element Collect->Alcatel-Lucent 5620 SAM


i. Click Save.5. Edit pack-specific SAMIF, UBA, and BLB parameters, which are based on the

following Tivoli Netcool Performance Manager platforms: Tivoli NetcoolPerformance Manager v4.4.3 and Tivoli Netcool Performance ManagerIn this release of Tivoli Netcool Performance Manager, you were instructed tomodify the technology pack-specific SAMIF, UBA, and BLB parameters whenyou installed the Alcatel-Lucent 5620 SAM Technology Pack, by using theTopology Editor. If you did not modify the SAMIF, UBA, and BLB parameterswith site-specific values or you want to make more edits, you can do so now.Otherwise, you can go to the next step. See the Installing and ConfiguringTechnology Packs for more information.

6. Load the DataChannel environment. In subsequent steps, you run dccmdcommands. To ensure that you can run these commands, load the shell withthe DataChannel environment by following these steps:a. Log in to the DataChannel server as pvuser.b. Change your working directory to the DataChannel home directory

(/opt/datachannel, by default), by using the following command:$ cd /opt/datachannel

c. Load the shell with the DataChannel environment, by sourcing thedataChannel.env file, as follows:$ . /opt/datachannel/dataChannel.env

7. Restart the DataChannel to activate the UBA and read in changes to thedeployed topology (v4.4.3 and Tivoli Netcool Performance Manager).a. Open a terminal emulator on the DataChannel server.b. Use the dccmd command to stop all DataChannel applications:

$ dccmd stop all

c. Use the dccmd command to release all daemons that are running in theDataChannel:$ dccmd forget all

d. Use the following command to find the process identifiers (pids)associated with the DataChannel visual processes:$ findvisual

e. Use the following commands to stop each DataChannel visual process:$ kill -9 <cnsw_pid>$ kill -9 <logw_pid>$ kill -9 <amgrw_pid>$ kill -9 <cmgrw_pid>

f. Use the following commands to restart each DataChannel visual process:$ cnsw$ logw$ amgrw$ cmgrw


g. Use the dccmd command to start all DataChannel applications:$ dccmd start all

h. Use the dccmd command to verify that all of the DataChannel applicationsstarted properly:$ dccmd status all

More specifically, make sure that the UBA application associated with theDataChannel that you configured for the Alcatel-Lucent 5620 SAMTechnology Pack is running.

i. Watch the output of the status switch to verify that all the necessaryprocesses are running. If these processes are running, run the tail utility onthe log file for the UBA by issuing a command similar to the following:$ tail -f DATA_CHANNEL_HOME/log/proviso.log | grepUBA.<channel><collector>- | more

where:

Variable Meaning

<channel_number> Is /opt/datachannel, by default.

<collector_number> Specifies the collector number (for example,100) that you specified when you configurethis UBA Bulk Collector.

The trailing dash (–) after <collector_number> Removes extraneous log messages from yourview. That is, the trailing dash guaranteesthat the command displays only thosemessages that are generated by yourapplication. The first set of messages relateto syntax checks.


Event Meaning

The UBA application starts successfully, butthen stops running.



This event causes a syntax error before theUBA application connects to the database.


This event causes a message similar to thefollowing example to display: DB_CONNECTConnecting to <sid> as <user> If you seethis database connection message withoutprior errors, the UBA application passed thesyntax check.

8. Run the initial inventory. The initial inventory of elements and subelementsruns automatically when you start the SAMIf component. This activity can betime-consuming, depending on the size of the network that the Alcatel-Lucent5620 SAM manages. In a large network, the initial inventory can take 6 - 12hours. To run a subsequent inventory for the Alcatel-Lucent 5620 SAMTechnology Pack, follow these steps:a. Log in as pvuser on the server that hosts the BLB process for the

Alcatel-Lucent 5620 SAM Technology Pack.b. Verify that all Alcatel-Lucent 5620 SAM Technology Pack components are

running:


$ /opt/datachannel/bin/dccmd status -channel channel#

where channel# is the number of the DataChannel, which you specifiedwhen you configured the DataChannel for the Alcatel-Lucent 5620 SAMTechnology Pack.

c. Run the inventory utility.

Note: In previous releases of the Alcatel-Lucent 5620 SAM Technology PacksamifDump was used to run the initial inventory utility. This is no longernecessary, and might not even work, so it must not be used. Use ofsamifDump might mask JMS problems.To initiate an inventory full dump, restart the SAMIF, and it automaticallyperforms an inventory dump and collection after it successfully connects tothe JMS. If the full dump does not start, the JMS connection might needdiagnosis.

9. Run the bulk inventory profile. The UBA application handles the inventoryand metrics according to the instructions provided in the technology packdesign file or files. The UBA application inserts the created elements,subelements, and metrics into the database. However, the UBA applicationdoes not handle the grouping of these elements and subelements. To handlethe grouping of the elements and subelements that were inserted into thedatabase, UBA technology packs supply a bulk inventory profile. This bulkinventory profile is automatically created when the pack is installed. Bulkinventory profiles use the following name syntax: bulk_N where:

Syntax item Meaning

bulk_ Identifies it as a bulk inventory profile for aUBA technology pack.

N Specifies the collector number (for example,100) that the user specified whenconfiguring this UBA Bulk Collector.

You must use the Inventory Tool to run a bulk inventory profile. To run thebulk inventory profiles for this technology pack, perform the following steps:a. In the command window where you loaded the DataMart environment,

change your working directory to $PVMHOME/bin (/opt/datamart/bin, bydefault) on the DataMart server.

b. Start the DataMart GUI:$ pvm

c. Click Inventory Tool in the Resource tab. The Inventory Tool windowappears. This window displays a list of the existing inventory profiles onthe Configuration tab. The names of the inventory profiles to run arebulk_N1 and bulk_N2, where N1 and N2 are the collector numbers that areconfigured for this pack.

d. On the Configuration tab, click the bulk inventory profiles for thistechnology pack and then select Run Profile from the Action menu. TheLive Information tab displays messages about the status of the profiles.See theInstalling and Configuring Technology Packs for more informationabout running an inventory profile.

e. Every time the UBA technology pack design file creates new elements,subelements, and metrics, you must perform the previous steps to groupthe elements and subelements. One way to accomplish this task regularlyis to create a cron entry that uses the inventory command. The following


example shows the cron entries that periodically perform the groupingoperation for the bulk inventory profiles that are called bulk_100 andbulk_101:0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100-action pregrouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_100-action grouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_101-action pregrouping -reload -noX0 * * * * . /opt/datamart/dataMart.env && inventory -name bulk_101-action grouping -reload -noX


10. Deploy reports. After the technology pack installation completes, the rules forthe new device are automatically loaded into the database. The inventoryprocess uses those rules to group elements and subelements. You mustmanually deploy (auto-group) the reports by associating them with groups inthe NOC Reporting tree in the DataMart Resource Editor.To deploy theAlcatel-Lucent 5620 SAM Technology Pack reports, follow these steps:a. Open the Tivoli Netcool Performance Manager DataMart Resource Editor.b. Click the ReportSEGroup tab.c. Move the cursor to the left pane and scroll up to select any group under

the SUB-ELEMENTS->NOC Reporting tree.d. Right-click and select the AutoGrouping option from the menu. The


e. Click Yes to continue.f. Click Close to exit the message box, or click Details to view a description

of any errors.g. You can also deploy reports regularly by creating a cron entry that uses

the inventory CLI command and the -reportGrouping option. This optioninstructs the inventory command to run the report grouping rules andupdate the deployed reports that are stored in the database. Reportgrouping rules must first be created before this option can be used. Forinformation on creating report grouping rules, see the Configuring andOperating DataMart. The following example shows a cron entry thatperiodically performs the deployment report operation:0 * * * * . /opt/datamart/dataMart.env && inventory -noX -reportGrouping


Verifying resources:

Use the Tivoli Netcool Performance Manager DataMart Resource Editor todetermine whether the technology pack resources (elements, subelements, andproperties) were successfully discovered and created in the database duringinventory.

For information about using the DataMart Resource Editor, see the IBM TivoliNetcool Performance Manager: DataMart Configuration and Operation Guide.


Modifying the collection strategyDescribes how to modify the amount of data that is managed by the Alcatel-Lucent5620 SAM Technology Pack. You can modify by changing the types of data that arecollected, or by changing the collection period for the SAM statistics, or both.

Specifying what inventory and metrics to collect:

Use the include and exclude filter parameters to specify what inventory andmetrics to collect.

About this task

These parameters are supplied in the pack XSD file. Use the Topology Editor tospecify a value for the include and exclude filter parameters when you configurethe technology-specific components (BLB and SAMIF) as part of adding a UBABulk Collector and associating it with the Alcatel-Lucent 5620 SAM TechnologyPack.

For more information about adding this type of collector, see the section on addinga UBA Bulk Collector in the IBM Tivoli Netcool Performance Manager InstallationGuide.

For information about how the filtering mechanism changed in recent versions ofthe Alcatel-Lucent 5620 SAM Technology Pack, see Changes in the filteringmechanism for inventory and metric section in IBM Tivoli Netcool Performance Manager:Pack Upgrade Guide.

Guidelines for using filter parameters:

Use the following guidelines when you use the include and exclude filterparameters to filter specific categories of inventory and metrics. These guidelinesassume that you configured one instance of the Alcatel-Lucent 5620 SAMTechnology Pack.

About this task

See Issues when configuring multiple Alcatel-Lucent 5620 SAM Technology Packinstances for issues that are related to using the include and exclude filterparameters when you configure more than one instance of the Alcatel-Lucent 5620SAM Technology Pack.

Note: If you want to collect all categories of inventory and metrics, accept thedefault value for the include and exclude filter parameters. (The default value forthe include and exclude filter parameters is no value.) You do not need to doanything further. You can skip this and subsequent sections that are related to theinclude and exclude filter parameters.

Procedure

1. The inventory filters apply to the SAMIF, and the metrics filters apply to theBLB.

2. Use the first column of Table 3 to determine the subelement type for whichyou want to include and exclude inventory and metrics. In this example, thesubelement type is Physical Port objects.


3. Use the second column of Table 3 to identify the include and exclude inventoryand metrics filter parameters that are associated with this subelement type. Inthis example, the inventory filter parameters are:v INC_FILTER_EQUIPMENT_PHYSICAL_PORT

v EXC_FILTER_EQUIPMENT_PHYSICAL_PORT

v INC_FILTER_CFM_SINGLE_ENDED_LOSS

v EXC_FILTER_CFM_SINGLE_ENDED_LOSS

In this example, the metrics filter parameters are:v INC_FILTER_EQUIPMENT_INTERFACE

v EXC_FILTER_EQUIPMENT_INTERFACE

v INC_FILTER_EQUIPMENT_INTERFACE_ADD

v EXC_FILTER_EQUIPMENT_INTERFACE_ADD

v INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

v EXC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

v INC_FILTER_CFM_SINGLE_ENDED_LOSS

v EXC_FILTER_CFM_SINGLE_ENDED_LOSS

4. Specify the values for the include and exclude filter parameters according tothe information provided in Valid values for include and exclude filterparameters. To include the metrics and associated inventory for a subelement,assign the appropriate value to the include filter parameters for the inventoryand metrics. Assign the same value to all of the include filter parameters forthat subelement.In this example, set the values for the following parameters:v INC_FILTER_EQUIPMENT_PHYSICAL_PORT

v INC_FILTER_EQUIPMENT_INTERFACE

v INC_FILTER_EQUIPMENT_INTERFACE_ADD

v INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

Do not assign a value for the exclude filter parameters.Conversely, to exclude the metrics and associated inventory for a subelement,assign the appropriate value to the exclude filter parameters for the inventoryand metrics. Assign the same value to all of the exclude filter parameters forthat subelement.In this example, set the values for the following parameters:v EXC_FILTER_EQUIPMENT_PHYSICAL_PORT

v EXC_FILTER_EQUIPMENT_INTERFACE

v EXC_FILTER_EQUIPMENT_INTERFACE_ADD

v EXC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

Do not assign a value for the include filter parameters.

Supported filter parameters:

The table provides the following information:v First column – Specifies the subelement type.v Second column – Specifies the names of the filter parameters, for the categories

of inventory and metrics that are available for the specified subelement type.These filter parameters control the inclusion or exclusion of the differentcategories of inventory and metrics.

v Third column – Specifies the Alcatel-Lucent 5620 SAM-O XML packageinventory and metrics classes that are associated with the parameters listed in


the second column. It also specifies the name of the Alcatel-Lucent 5620 SAMproperty that contains the IP address for an object, which is the default valuethat is used to filter the inventory and metrics. See the Alcatel-Lucent 5620 SAMXML Reference - Release 7.0 documentation for descriptions of these classes.

Table 11. Include and exclude filter parameters and associated XML packages and classes

Subelement Include and exclude filter parameters Alcatel-Lucent 5620 SAM-O XML package class

Base Cardobject

DaughterCard object

MCM Cardobject

ControlProcessorobject

Inventory:INC_FILTER_EQUIPMENT_BASE_CARDEXC_FILTER_EQUIPMENT_BASE_CARDINC_FILTER_EQUIPMENT_DAUGHTER_CARDEXC_FILTER_EQUIPMENT_DAUGHTER_CARDINC_FILTER_EQUIPMENT_MCM_CARDEXC_FILTER_EQUIPMENT_MCM_CARDINC_EQUIPMENT_CNTL_PROCESSOREXC_EQUIPMENT_CNTL_PROCESSOR

Inventory:equipment.BaseCardequipment.DaughterCardequipment.MCMCardequipment.ControlProcessor

Default filter property:siteId

Metrics: INC_FILTER_HW_TEMP_STATSEXC_FILTER_HW_TEMP_STATSINC_FILTER_EQUIPMENT_CPUMONSTATSEXC_FILTER_EQUIPMENT_CPUMONSTATS

Metrics: equipment.HardwareTemperature

Default filter propertymonitoredObjectSiteId

NAT ISAMDA object

NAT ISAMemberobject

Inventory:INC_FILTER_NAT_ISA_MDAEXC_FILTER_NAT_ISA_MDAINC_FILTER_NAT_ISA_MEMBEREXC_FILTER_NAT_ISA_MEMBER

Inventory:nat.IsaMdanat.IsaMember

Default filter property:siteName

Metrics: INC_ISA_MEM_USG_STATSEXC_ISA_MEM_USG_STATS

Metrics: nat.IsaMemberUsageStats


DHCP6Addressobject

SubnetAddressobject

Inventory:INC_DHCP_ADD_PREFIXEXC_DHCP_SUBNETINC_DHCP_SUBNETEXC_DHCP_SUBNET

Inventory:dhcp.Dhcp6AddressPrefixdhcp.Subnet

Default filter property:nodeId

Metrics: INC_LOCAL_DHCP_SERSUBSTATSEXC_LOCAL_DHCP_SERSUBSTATSINC_LOCAL_DHCP6_SERPRESTATSEXC_LOCAL_DHCP6_SERPRESTATS

Metrics: dhcp.LocalDhcp6ServerPrefixStatsdhcp.LocalDhcpServerSubnetStats


MPR IMALink object Inventory:

INC_FILTER_MPR_IMA_LINKEXC_FILTER_MPR_IMA_LINK

Inventory:mpr.IMALink


Metrics: INC_IMA_LINK_CUR_STATSEXC_IMA_LINK_CUR_STATS

Metrics: mpr.IMALinkCurrentStatsLogRecord



Table 11. Include and exclude filter parameters and associated XML packages and classes (continued)


DS1_E1 objectInventory:

INC_FILTER_CHANNEL_DS1E1EXC_FILTER_CHANNEL_DS1E1INC_FILTER_CHANNEL_DS1E1_PORTEXC_FILTER_CHANNEL_DS1E1_PORT

Inventory:tdmequipment.DS1E1PortSpecifics


Metrics: INC_DS1_HIS_INEXC_DS1_HIS_ININC_DS1_HIS_OUTEXC_DS1_HIS_OUTINC_E1_HIS_INEXC_E1_HIS_ININC_E1_HIS_OUTEXC_E1_HIS_OUTINC_AGR_MAINT_RX_STATSEXC_AGR_MAINT_RX_STATSINC_AGR_MAINT_TX_STATSEXC_AGR_MAINT_TX_STATSINC_PDH_FRM_HOP_HIS_STATSEXC_PDH_FRM_HOP_HIS_STATSINC_PDH_FRM_LIN_HIS_STATSEXC_PDH_FRM_LIN_HIS_STATSINC_RAD_ANALOG_MEASEXC_RAD_ANALOG_MEAS

Metrics: tdmequipment.DS1HistoryStats15minInLogRecordtdmequipment.DS1HistoryStats15minOutLogRecordtdmequipment.E1HistoryStats15minInLogRecordtdmequipment.E1HistoryStats15minOutLogRecordethernetequipment.AggrMaintRxStatsLogRecordethernetequipment.AggrMaintTxStatsLogRecordradioequipment.PdhFrameHopHistoryDataStats15MinLogRecordradioequipment.PdhFrameLinkHistoryDataStats15MinLogRecordradioequipment.RadioAnalogueMeasure


AccessInterfaceobject

Inventory:INC_FILTER_IES_L3_ACCESS_INTERFACEEXC_FILTER_IES_L3_ACCESS_INTERFACEINC_FILTER_MIRROR_L2_ACCESS_INTERFACEEXC_FILTER_MIRROR_L2_ACCESS_INTERFACEINC_FILTER_VLL_L2_ACCESS_INTERFACEEXC_FILTER_VLL_L2_ACCESS_INTERFACEINC_FILTER_VPLS_L2_ACCESS_INTERFACEEXC_FILTER_VPLS_L2_ACCESS_INTERFACEINC_FILTER_VPRN_L3_ACCESS_INTERFACEEXC_FILTER_VPRN_L3_ACCESS_INTERFACEINC_FILTER_IPIPE_L2_ACCESS_INTERFACEEXC_FILTER_IPIPE_L2_ACCESS_INTERFACE

Inventory:service.L2AccessInterfaceservice.L3AccessInterfaceies.L3AccessInterfacemirror.L2AccessInterfacevll.L2AccessInterfacevpls.L2AccessInterfacevprn.L3AccessInterfaceipipe.L2AccessInterface


Metrics: N/A Metrics: AvailabilitymetricsALCATEL_5620_SAM.AVAIL_NAME_SPACE

Default filter propertyPHYSICAL_PORT

AOSQOSObject Inventory:

INC_FILTER_AOSQOS_POLICYEXC_FILTER_AOSQOS_POLICY

Inventory:aosqos.Policy

Default filter propertysiteId

Metrics: INC_FILTER_AOSQOS_POLICYEXC_FILTER_AOSQOS_POLICY

Metrics: aosqos.QoSIngressPolicyStatsLogRecord





Egress ServiceQueue object

IngressService Queueobject

(Alcatel-Lucent 7750ServiceRouter andAlcatel-Lucent7450 EthernetServiceSwitch)

Inventory:INC_FILTER_IES_L3_ACCESS_INTERFACEEXC_FILTER_IES_L3_ACCESS_INTERFACEINC_FILTER_MIRROR_L2_ACCESS_INTERFACEEXC_FILTER_MIRROR_L2_ACCESS_INTERFACEINC_FILTER_VLL_L2_ACCESS_INTERFACEEXC_FILTER_VLL_L2_ACCESS_INTERFACEINC_FILTER_VPLS_L2_ACCESS_INTERFACEEXC_FILTER_VPLS_L2_ACCESS_INTERFACEINC_FILTER_VPRN_L3_ACCESS_INTERFACEEXC_FILTER_VPRN_L3_ACCESS_INTERFACE

Inventory:ies.L3AccessInterfacemirror.L2AccessInterfacevll.L2AccessInterfacevll.L2AccessInterfacevpls.L2AccessInterfacevprn.L3AccessInterface

Default filter propertynodeId

Metrics: INC_FILTER_COMPLETE_SERVICE_EGRESSEXC_FILTER_COMPLETE_SERVICE_EGRESSINC_FILTER_COMPLETE_SERVICE_INGRESSEXC_FILTER_COMPLETE_SERVICE_INGRESS

Metrics: service.CompleteServiceEgressPacketOctetsLogRecordservice.CompleteServiceEgressPacketOctetsLogRecordservice.CompleteServiceEgressPacketOctetsLogRecord


Channelobject

Inventory:INC_FILTER_CHANNEL_DS0_GROUPEXC_FILTER_CHANNEL_DS0_GROUPINC_FILTER_CHANNEL_DS1E1EXC_FILTER_CHANNEL_DS1E1INC_FILTER_CHANNEL_DS3E3EXC_FILTER_CHANNEL_DS3E3INC_FILTER_CHANNEL_STS1EXC_FILTER_CHANNEL_STS1INC_FILTER_CHANNEL_STS12EXC_FILTER_CHANNEL_STS12INC_FILTER_CHANNEL_STS192EXC_FILTER_CHANNEL_STS192INC_FILTER_CHANNEL_STS3EXC_FILTER_CHANNEL_STS3INC_FILTER_CHANNEL_STS48EXC_FILTER_CHANNEL_STS48INC_FILTER_CHANNEL_TRIBEXC_FILTER_CHANNEL_TRIBINC_FILTER_CHANNEL_TRIB_GROUPEXC_FILTER_CHANNEL_TRIB_GROUPINC_FILTER_CHANNEL_TU3EXC_FILTER_CHANNEL_TU3INC_FILTER_CHANNEL_TUG3_GROUPEXC_FILTER_CHANNEL_TUG3_GROUP

Inventory:tdmequipment.DS0ChannelGrouptdmequipment.DS1E1Channeltdmequipment.DS3E3Channelsonetequipment.Sts1Channelsonetequipment.Sts12Channelsonetequipment.Sts192Channelsonetequipment.Sts3Channelsonetequipment.Sts48Channelsonetequipment.TributaryChannelsonetequipment.TributaryGroupsonetequipment.Tu3Channelsonetequipment.Tug3Group

Default filter propertysiteId

Metrics: INC_FILTER_EQUIPMENT_INTERFACEEXC_FILTER_EQUIPMENT_INTERFACEINC_FILTER_EQUIPMENT_INTERFACE_ADDEXC_FILTER_EQUIPMENT_INTERFACE_ADD

Metrics: equipment.InterfaceStatsLogRecordequipment.InterfaceAdditionalStatsLogRecord

Default filter property:monitoredObjectSiteId




CardSlotObject Inventory:

INC_FILTER_EQUIPMENT_CARD_SLOTEXC_FILTER_EQUIPMENT_CARD_SLOT

Inventory:equipment.CardSlot


Metrics: INC_FILTER_EQUIPMENT_CARD_SLOTEXC_FILTER_EQUIPMENT_CARD_SLOT

Metrics: equipment.CardHealthStatsLogRecord




(Alcatel-Lucent 7705ServiceAggregationRouter andAlcatel-Lucent7210 ServiceAccessSwitch)


Inventory:ies.L3AccessInterfacemirror.L2AccessInterfacevll.L2AccessInterfacevpls.L2AccessInterfacevprn.L3AccessInterface


Metrics: INC_FILTER_SERVICE_EGRESSEXC_FILTER_SERVICE_EGRESSINC_FILTER_SERVICE_INGRESSEXC_FILTER_SERVICE_INGRESS

Metrics: service.ServiceEgressOctetsLogRecord

Or

service.ServiceEgressPacketsLogRecord

service.ServiceIngressOctetsLogRecord

Or

service.ServiceIngressPacketsLogRecord




(Alcatel-Lucent 7750ServiceRouter andAlcatel-Lucent7450 EthernetServiceSwitch)


Inventory:ies.L3AccessInterfacemirror.L2AccessInterfacevll.L2AccessInterfacevpls.L2AccessInterfacevprn.L3AccessInterface


Metrics: INC_FILTER_COMPLETE_SERVICE_EGRESSEXC_FILTER_COMPLETE_SERVICE_EGRESSINC_FILTER_COMPLETE_SERVICE_INGRESSEXC_FILTER_COMPLETE_SERVICE_INGRESS

Metrics: service.CompleteServiceEgressPacketOctetsLogRecordservice.CompleteServiceIngressPacketOctetsLogRecord





Ethernet CFMObject

Inventory:INC_FILTER_CFM_ONEWAY_DELAYEXC_FILTER_CFM_ONEWAY_DELAYINC_FILTER_CFM_ETHERNETEXC_FILTER_CFM_ETHERNETINC_FILTER_CFM_SINGLE_ENDED_LOSSEXC_FILTER_CFM_SINGLE_ENDED_LOSS

Metrics: ethernetoam.CfmEthTestethernetoam.CfmSingleEndedLossTest


Metrics: INC_FILTER_CFM_ONEWAY_DELAYEXC_FILTER_CFM_ONEWAY_DELAYINC_FILTER_CFM_ETHERNETEXC_FILTER_CFM_ETHERNETINC_FILTER_CFM_SINGLE_ENDED_LOSSEXC_FILTER_CFM_SINGLE_ENDED_LOSS

Metrics: ethernetoam.CfmOneWayDelayTestResultethernetoam.CfmEthTestResultethernetoam.CfmSingleEndedLossTestResult

Default filter property:fromNodeId

HardwareEnvironmentobject

Inventory:INC_FILTER_EQUIPMENT_HW_ENVIRONMENTEXC_FILTER_EQUIPMENT_HW_ENVIRONMENT

Inventory:equipment.HwEnvironment


Metrics: INC_FILTER_EQUIPMENT_HW_ENVIRONMENTEXC_FILTER_EQUIPMENT_HW_ENVIRONMENT

Metrics: equipment.HwEnvironment


LAG Interfaceobject Inventory:

INC_FILTER_LAG_INTERFACEEXC_FILTER_LAG_INTERFACE

Inventory:lag.Interface


Metrics: INC_FILTER_EQUIPMENT_INTERFACEEXC_FILTER_EQUIPMENT_INTERFACEINC_FILTER_EQUIPMENT_INTERFACE_ADDEXC_FILTER_EQUIPMENT_INTERFACE_ADD

Metrics: equipment.InterfaceStatsLogRecordequipment.InterfaceAdditionalStatsLogRecord


MPLSInterfaceobject

Inventory:INC_FILTER_MPLS_INTERFACEEXC_FILTER_MPLS_INTERFACE

Inventory:mpls.Interface


Metrics: INC_FILTER_MPLS_INTERFACEEXC_FILTER_MPLS_INTERFACE

Metrics: mpls.MplsInterfaceStatsLogRecord


MPLS ObjectInventory:

INC_FILTER_MPLS_SITEEXC_FILTER_MPLS_SITE

Inventory:mpls.Site


Metrics: INC_FILTER_MPLS_SITEEXC_FILTER_MPLS_SITE

Metrics: mpls.SiteStatsLogRecord





NetworkQueue object Inventory:

INC_FILTER_NETWORK_QUEUEEXC_FILTER_NETWORK_QUEUE

Inventory:nqueue.Entrynqueue.ForwardingClassnqueue.Policy


Metrics: INC_FILTER_COMBINED_NETWORK_EGRESSEXC_FILTER_COMBINED_NETWORK_EGRESSINC_FILTER_COMBINED_NETWORK_INGRESSEXC_FILTER_COMBINED_NETWORK_INGRESSINC_FILTER_NETWORK_EGRESSEXC_FILTER_NETWORK_EGRESSINC_FILTER_NETWORK_INGRESSEXC_FILTER_NETWORK_INGRESS

Metrics: service.CombinedNetworkEgressOctetsLogRecordservice.CombinedNetworkIngressOctetsLogRecordservice.NetworkEgressPacketsLogRecordservice.NetworkIngressPacketsLogRecord


OAM Testobject Inventory:

INC_FILTER_ICMP_PINGEXC_FILTER_ICMP_PINGINC_FILTER_MPLS_PINGEXC_FILTER_MPLS_PINGINC_FILTER_SERVICE_SITE_PINGEXC_FILTER_SERVICE_SITE_PINGINC_FILTER_TUNNEL_PINGEXC_FILTER_TUNNEL_PINGINC_FILTER_VCCV_PINGEXC_FILTER_VCCV_PINGINC_FILTER_CFM_LOOPBACKEXC_FILTER_CFM_LOOPBACKINC_FILTER_CFM_TWOWAY_DELAYEXC_FILTER_CFM_TWOWAY_DELAY

Inventory:icmp.IcmpPingmpls.LspPingservice.SitePingsvt.TunnelPingsvt.VccvPingethernetoam.CfmLoopbackethernetoam.CfmOneWayDelayTestethernetoam.CfmTwoWayDelayTest


Metrics: INC_FILTER_ICMP_PINGEXC_FILTER_ICMP_PINGINC_FILTER_MPLS_PINGEXC_FILTER_MPLS_PINGINC_FILTER_SERVICE_SITE_PINGEXC_FILTER_SERVICE_SITE_PINGINC_FILTER_TUNNEL_PINGEXC_FILTER_TUNNEL_PINGINC_FILTER_VCCV_PINGEXC_FILTER_VCCV_PINGINC_FILTER_CFM_LOOPBACKEXC_FILTER_CFM_LOOPBACKINC_FILTER_CFM_TWOWAY_DELAYEXC_FILTER_CFM_TWOWAY_DELAY

Metrics: icmp.IcmpPingResultmpls.LspPingResultservice.SitePingResultsvt.TunnelPingResultsvt.VccvPingResultethernetoam.CfmLoopbackResultethernetoam.CfmOneWayDelayTestethernetoam.CfmTwoWayDelayTest





Physical Portobject Inventory:

INC_FILTER_EQUIPMENT_PHYSICAL_PORTEXC_FILTER_EQUIPMENT_PHYSICAL_PORT

Inventory:equipment.PhysicalPort


Metrics: INC_FILTER_EQUIPMENT_INTERFACEEXC_FILTER_EQUIPMENT_INTERFACEINC_FILTER_EQUIPMENT_INTERFACE_ADDEXC_FILTER_EQUIPMENT_INTERFACE_ADDINC_FILTER_EQUIPMENT_MEDIA_INDEPENDENTEXC_FILTER_EQUIPMENT_MEDIA_INDEPENDENTINC_FILTER_ETHERNET_EQUIPMENT_DOT3_STATSEXC_FILTER_ETHERNET_EQUIPMENT_DOT3_STATSINC_FILTER_EQUIPMENT_DDMEXC_FILTER_EQUIPMENT_DDM

Metrics: equipment.InterfaceStatsLogRecordequipment.InterfaceAdditionalStatsLogRecordequipment.MediaIndependentStatsLogRecordethernetequipment.Dot3StatsLogRecordequipment.DigitalDiagnosticMonitoring


PPP ControlProtocolobject

Inventory:It is not currently possible to filter the inventoryfor PPP Control Protocol objects. However, eachPPP Control Protocol object requires an associatedPPP Interface object. Therefore, the filtering thatis applied to the PPP Interface object is alsoapplied to the associated PPP Control Protocolobject.

Inventory:ppp.PppControlProtocol

Default filter property:Not applicable

Metrics: INC_FILTER_PPP_CONTROL_PROTOCOLEXC_FILTER_PPP_CONTROL_PROTOCOL

Metrics: ppp.PppControlProtocol


PPP Interfaceobject Inventory:

INC_FILTER_PPP_INTERFACEEXC_FILTER_PPP_INTERFACE

Inventory:ppp.Interface


Metrics: INC_FILTER_PPP_INTERFACEEXC_FILTER_PPP_INTERFACE

Metrics: ppp.PppStatsLogRecord


SDP Bindingobject Inventory:

INC_FILTER_SVT_MESH_SDP_BINDINGEXC_FILTER_SVT_MESH_SDP_BINDINGINC_FILTER_SVT_MIRROR_SDP_BINDINGEXC_FILTER_SVT_MIRROR_SDP_BINDINGINC_FILTER_SVT_SPOKE_SDP_BINDINGEXC_FILTER_SVT_SPOKE_SDP_BINDING

Inventory:svt.MeshSdpBindingsvt.MirrorSdpBindingsvt.SpokeSdpBinding


Metrics: INC_FILTER_SVT_SDP_BINDING_BASEEXC_FILTER_SVT_SDP_BINDING_BASE

Metrics: svt.SdpBindingBaseStatsLogRecord





Shelf objectInventory:

INC_FILTER_EQUIPMENT_SHELFEXC_FILTER_EQUIPMENT_SHELF

Inventory:equipment.Shelf


Metrics: INC_FILTER_EQUIPMENT_CPUEXC_FILTER_EQUIPMENT_CPUINC_FILTER_EQUIPMENT_MEMORYEXC_FILTER_EQUIPMENT_MEMORY

Metrics: equipment.SystemCpuStatsLogRecordequipment.SystemMemoryStatsLogRecord


Service AccessPoint Object Inventory:

INC_FILTER_VPRN_SERVICE_ACCESS_POINTEXC_FILTER_VPRN_SERVICE_ACCESS_POINTINC_FILTER_IES_SERVICE_ACCESS_POINTEXC_FILTER_IES_SERVICE_ACCESS_POINT

Inventory:vprn.ServiceAccessPointies.ServiceAccessPoint


Metrics: INC_FILTER_SVC_PPPOEEXC_FILTER_SVC_PPPOE

Metrics: service.PppoeSapStatsLogRecord


Multi ServiceSite object Inventory:

INC_FILTER_SVQ_AGGREGATION_SCHEDULEREXC_FILTER_SVQ_AGGREGATION_SCHEDULER

Inventory:svq.AggregationScheduler


Metrics: INC_FILTER_MSS_INGRESSEXC_FILTER_MSS_INGRESSINC_FILTER_MSS_EGRESSEXC_FILTER_MSS_EGRESS

Metrics: svq.CustMultiSvcSiteIngSchedPlcyPortStatsLogRecordsvq.CustMultiSvcSiteEgrSchedPlcyPortStatsLogRecord


Virtual RouterInventory:

INC_FILTER_VIRTUAL_ROUTEREXC_FILTER_VIRTUAL_ROUTER

Inventory:rtr.VirtualRouter


Metrics: INC_FILTER_ROUTE_STATSEXC_FILTER_ROUTE_STATS

Metrics: rtr.RouteStatsLogRecord


Filter parameters that apply to several subelement types:

Some metrics apply to several subelement types. Take care before you exclude themetrics for a particular subelement type, in case those metrics are also associatedwith other subelement types. In such cases, you might prefer to edit the filter toexclude the particular subelement, rather than exclude the metrics for allsubelements.

The table lists the metrics, and the subelement types that are associated with eachmetric.


Table 12. Metrics filter parameters and associated subelement types

Include and exclude filter parameters Subelement

INC_FILTER_COMBINED_NETWORK_EGRESS

EXC_FILTER_COMBINED_NETWORK_EGRESS

Network Queue object

INC_FILTER_COMBINED_NETWORK_INGRESS

EXC_FILTER_COMBINED_NETWORK_INGRESS


INC_FILTER_COMPLETE_SERVICE_EGRESS

EXC_FILTER_COMPLETE_SERVICE_EGRESS

Egress Service Queue object

Ingress Service Queue object

(Alcatel-Lucent 7750 Service Router andAlcatel-Lucent 7450 Ethernet Service Switch)

INC_FILTER_COMPLETE_SERVICE_INGRESS

EXC_FILTER_COMPLETE_SERVICE_INGRESS



(Alcatel-Lucent 7750 Service Router andAlcatel-Lucent 7450 Ethernet Service Switch)

INC_FILTER_EQUIPMENT_CPU

EXC_FILTER_EQUIPMENT_CPU

Shelf object

INC_FILTER_EQUIPMENT_HW_ENVIRONMENT

EXC_FILTER_EQUIPMENT_HW_ENVIRONMENT

Hardware Environment object

INC_FILTER_EQUIPMENT_INTERFACE_ADD

EXC_FILTER_EQUIPMENT_INTERFACE_ADD

Channel object

LAG Interface object

Physical Port object

INC_FILTER_EQUIPMENT_INTERFACE

EXC_FILTER_EQUIPMENT_INTERFACE

Channel object

LAG Interface object


INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

EXC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT

INC_FILTER_EQUIPMENT_DDM

INC_FILTER_EQUIPMENT_DDM

EXC_FILTER_EQUIPMENT_DDM


INC_FILTER_EQUIPMENT_MEMORY

EXC_FILTER_EQUIPMENT_MEMORY

Shelf object


Table 12. Metrics filter parameters and associated subelement types (continued)


INC_FILTER_ICMP_PING

EXC_FILTER_ICMP_PING

OAM Test object

INC_FILTER_MPLS_INTERFACE

EXC_FILTER_MPLS_INTERFACE

MPLS Interface object

INC_FILTER_MPLS_PING

EXC_FILTER_MPLS_PING

OAM Test object

INC_FILTER_PPP_CONTROL_PROTOCOL

EXC_FILTER_PPP_CONTROL_PROTOCOL

PPP Control Protocol object

INC_FILTER_PPP_INTERFACE

EXC_FILTER_PPP_INTERFACE

PPP Interface object

INC_FILTER_NETWORK_EGRESS

EXC_FILTER_NETWORK_EGRESS


INC_FILTER_NETWORK_INGRESS

EXC_FILTER_NETWORK_INGRESS


INC_FILTER_SERVICE_EGRESS

EXC_FILTER_SERVICE_EGRESS



(Alcatel-Lucent 7705 Service AggregationRouter and Alcatel-Lucent 7210 Service AccessSwitch)

INC_FILTER_SERVICE_INGRESS

EXC_FILTER_SERVICE_INGRESS



(Alcatel-Lucent 7705 Service AggregationRouter and Alcatel-Lucent 7210 Service AccessSwitch)

INC_FILTER_ROUTE_STATS

EXC_FILTER_ROUTE_STATS

Virtual Router

INC_FILTER_SERVICE_SITE_PING

EXC_FILTER_SERVICE_SITE_PING

OAM Test object

INC_FILTER_SVT_SDP_BINDING_BASE

EXC_FILTER_SVT_SDP_BINDING_BASE

SDP Binding object




INC_FILTER_TUNNEL_PING

EXC_FILTER_TUNNEL_PING

OAM Test object

INC_FILTER_VCCV_PING

EXC_FILTER_VCCV_PING

OAM Test object

INC_FILTER_IPIPE_L2_ACCESS_INTERFACE

EXC_FILTER_IPIPE_L2_ACCESS_INTERFACE

Access Interface object

INC_FILTER_CFM_LOOPBACK

EXC_FILTER_CFM_LOOPBACK

OAM Test object

INC_FILTER_CFM_ONEWAY_DELAY

EXC_FILTER_CFM_ONEWAY_DELAY

INC_FILTER_CFM_TWOWAY_DELAY

EXC_FILTER_CFM_TWOWAY_DELAY

INC_FILTER_CFM_ETHERNET

EXC_FILTER_CFM_ETHERNET

INC_FILTER_CFM_SINGLE_ENDED_LOSS

EXC_FILTER_CFM_SINGLE_ENDED_LOSS

Ethernet CFM Object

INC_FILTER_AOSQOS_POLICY

EXC_FILTER_AOSQOS_POLICY

AOSQOS Object

INC_FILTER_EQUIPMENT_CARD_SLOT

EXC_FILTER_EQUIPMENT_CARD_SLOT

CardSlot Object

INC_FILTER_MPLS_SITE

EXC_FILTER_MPLS_SITE

MplsSite Object

INC_FILTER_SVQ_AGGREGATION_SCHEDULER

EXC_FILTER_SVQ_AGGREGATION_SCHEDULER

INC_FILTER_MSS_INGRESS

EXC_FILTER_MSS_INGRESS

INC_FILTER_MSS_EGRESS

EXC_FILTER_MSS_EGRESS

Multi-Service Site object




INC_FILTER_VPRN_SERVICE_ACCESS_POINT

EXC_FILTER_VPRN_SERVICE_ACCESS_POINT

INC_FILTER_IES_SERVICE_ACCESS_POINT

EXC_FILTER_IES_SERVICE_ACCESS_POINT

INC_FILTER_SVC_PPPOE

EXC_FILTER_SVC_PPPOE

Service Access Point Object

Valid values for include and exclude filter parameters:

The include and exclude filter parameters for inventory and metrics enable you tospecify the inventory and metrics objects to include or exclude during a specifiedcollection.

The table summarizes the valid values for these filter parameters. The subsequentsections provide examples.

It is impractical and beyond the scope of the guide to provide exhaustivedescriptions and explanations of the Alcatel-Lucent 5620 SAM technology.

Table 13. Valid values for include and exclude filter parameters

Value Meaning

No valueFor INC_ parameters: Includes all of the availableinventory and metrics for this Alcatel-Lucent 5620SAM-O class.

For EXC_ parameters: Excludes none of theavailable inventory and metrics for thisAlcatel-Lucent 5620 SAM-O class.

* (asterisk character for exclude inventoryparameters) For INC_ parameters: Includes all of the available

inventory and metrics for this Alcatel-Lucent 5620SAM-O class.

For EXC_ parameters: Excludes all (that is, doesnot collect any) inventory for this Alcatel-Lucent5620 SAM-O class.

Single property and associated valueIncludes or excludes the inventory and metrics forAlcatel-Lucent 5620 SAM-O classes that aregenerated for the specified property.


Table 13. Valid values for include and exclude filter parameters (continued)

Value Meaning

Property that uses the UNIX ? (question mark) filename specification Includes or excludes the inventory and metrics for

Alcatel-Lucent 5620 SAM-O classes that aregenerated for the specified property range. In thiscase, the range was specified by using the UNIX ?file name specification.

The UNIX ? specification matches any singlecharacter.

Property that uses the UNIX * (asterisk) file namespecification Includes or excludes the inventory and metrics for

Alcatel-Lucent 5620 SAM-O classes that aregenerated for the specified property range. In thiscase, the range was specified by using the UNIX *file name specification.

The UNIX * specification matches any number ofcharacters.

Single IP address Includes or excludes the inventory and metrics forAlcatel-Lucent 5620 SAM-O classes that aregenerated for the specified IP address.

IP address that uses the UNIX ? (question mark)file name specification Includes or excludes the inventory and metrics for

Alcatel-Lucent 5620 SAM-O classes that aregenerated for the specified IP address range. In thiscase, the range was specified by using the UNIX ?file name specification.

The UNIX ? specification matches any singlecharacter.

IP address that uses the UNIX * (asterisk) file namespecification Includes or excludes the inventory and metrics for

Alcatel-Lucent 5620 SAM-O classes that aregenerated for the specified IP address range. In thiscase, the range was specified by using the UNIX *file name specification.

The UNIX * specification matches any number ofcharacters.

range(n..m)Supports metric filtering on integers that usenumeric ranges. The range supports the logic of'greater than or equal to AND less than or equalto'. There is a logical AND between the upper andlower bound of the range. The range() functionalitycan be used on properties that are purely integervalues.


Rules for specifying filter values:

The following list defines the rules for specifying parameter values:v Use a space to separate multiple values for a property.v Use a semicolon to separate multiple property specifications in one filter

parameter.v Note the exclude specifications override the include specifications.v Specify the same value for a metrics filter parameter and its associated inventory

filter parameters, for a given subelement. See “Supported filter parameters” onpage 149 for the include and exclude filter parameter mappings for metrics andinventory.

SyntaxUse the following syntax to specify parameter values:FilterParameter=Prop1:val1 val2; Prop2: val3 val4 val5; Prop3: val6 val7whereProp1 matches val1 OR val2ANDProp2 matches val3 OR val4 OR val5ANDProp3 matches val6 OR val7

For the INC_ filter parameters, "matches" means that the filter includes theitems that match the specified values.

For the EXC_ filter parameters, "matches" means that the filter excludes theitems that match the specified values.

Specifying the propertiesSpecify the names of the properties as defined on the SAM server, not theTivoli Netcool Performance Manager names. For example, you can filter onthe property siteName, but not on the property samSiteName.

The Alcatel-Lucent 5620 SAM XML Reference - Release 7.0 documentationcontains details about all of the packages and their associated objects andproperties.

Specifying the valuesSome values can come from the SAM server in two different ways:v As a text string, which usually occurs during the full dumpv As a numerical value, which comes from the JMS object creation

messagesv You must include both of these values in the filter specification, as

shown in the following example:EXC_FILTER=operationalState:portInService 2

v In this example, the text version of the operationalState property isportInService, but the numerical value that is passed through JMS is 2.

Specifying properties in a filterIn older versions of the Alcatel-Lucent 5620 SAM Technology Pack, theonly type of values that you might specify for the filter parameters were IPaddresses.

Starting with Alcatel-Lucent 5620 SAM Technology Pack Version 2.6.0.0, thefiltering mechanism is even more granular. You can now filter on otherproperties, not just IP addresses, and you can provide several values foreach property.


Specifying an IP address in a filterIn older versions of the Alcatel-Lucent 5620 SAM Technology Pack, youdid not explicitly specify a property with the IP address because thefiltering mechanism automatically handled the property specification.

Starting with Alcatel-Lucent 5620 SAM Technology Pack Version 2.6.0.0,you can specify several other kinds of properties in addition to IPaddresses. Therefore, you must also specify the corresponding propertyname. However, property names are not consistent across the differentobjects. For some inventory objects, the IP address is stored in the siteIdproperty. For other objects, the IP address is stored in the nodeId property.You must ensure that you have the correct property for each object. Toidentify the name of the Alcatel-Lucent 5620 SAM property that containsthe IP address for an object (that is, the default value that is used to filterthe inventory and metrics for that object), see Table 11 on page 150 table.

Note: IP address filtering is a special case. IP address filteringautomatically maps the property specifications, so that you do not have tospecify the different IP-address-containing property for each object type.

The old filtering syntax still works. If you have filters that use the oldsyntax, and you do not want to change the filter (for example, by filteringon more properties), you can still use the existing filters. You can also usethe old filtering syntax in one clause of a filter, and have other clauses thatuse the new syntax for other properties.

Matching patterns in filter syntax: strings and numbersIn earlier releases, you might use only IP addresses to filter the inventoryand metrics. IP addresses are defined on the SAM server as strings.

Starting with Tivoli Netcool Performance Manager Version 2.6.0.0, you canuse many other properties to specify what inventory and metrics to collect.Some of these filtering properties are defined on the Alcatel-Lucent 5620SAM server as strings, and some are defined as numbers.

Pattern matching in filter syntax is performed by a pure string match only.The UNIX ? and * characters can be applied to string-type properties(including IP addresses). They cannot be applied to ranges of numbers.

With the addition of the range () filter it is now possible to specify a rangeof numbers in a filter. See “Examples that use the range() specification” onpage 167.

The following example shows a filter specification that contains a numberbut is treated as a string – in this example, the text version of theoperationalState property is portInService, but the numerical value thatis passed through JMS is 2.SAMIF.2.200.ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_

PHYSICAL_PORT=operationalState: portInService 2

The following example shows an invalid specification because the svcIdproperty is defined on the Alcatel-Lucent 5620 SAM server as a number,and the UNIX ? and * specifications cannot be applied to numbers:SAMIF.2.200.ALCATEL_5620_SAM.APP.INC_FILTER_VPLS_L2_ACCESS_

INTERFACE=svcId: 1100*


For valid examples of filter specifications that use the UNIX ? and *characters, see “Examples that use the UNIX "?" file name specification” onpage 166 and “Examples that use the UNIX "*" file name specification” onpage 166.

Maximum filter parameter lengthTivoli Netcool Performance Manager does not impose a limit on how manycharacters can be included in a filter parameter specification.

Although there is no defined limit for filter parameter length, excessivelylong filter settings can affect performance.

Example filter parameter specifications:

Provides several different examples to show how to use the filter parameters.

The following examples show how to use the old-style simple IP filtering:v “Example that shows how to include all values”v “Example that shows how to exclude all values”v “Examples that use a single IP address” on page 166v “Examples that use the UNIX "?" file name specification” on page 166v “Examples that use the UNIX "*" file name specification” on page 166v “Examples that use the range() specification” on page 167

The following examples show the new, more complex, property filtering:v “Examples that use multiple properties and values” on page 167v “Example that includes and excludes specific inventory and metrics” on page

168

Example that shows how to include all values:

The following example shows how to include all available inventory and metricsthat are associated with the Physical Port object.v V4.4.3 and later

Use the Topology Editor to ensure that no value is set for these SAMIFparameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_PHYSICAL_PORT=ALCATEL_5620_SAM.APP.EXC_FILTER_EQUIPMENT_PHYSICAL_PORT=

Use the Topology Editor to ensure that no value is set for these BLB parameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE=ALCATEL_5620_SAM.APP.EXC_FILTER_EQUIPMENT_INTERFACE=ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE_ADD=ALCATEL_5620_SAM.APP.EXC_FILTER_EQUIPMENT_INTERFACE_ADD=ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT=ALCATEL_5620_SAM.APP.EXC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT=

Example that shows how to exclude all values:

The following example shows how to exclude all (that is, do not collect any)available inventory that is associated with the Physical Port object.v V4.4.3 and later

Use the Topology Editor to set this SAMIF parameter to * (that is, asterisk):ALCATEL_5620_SAM.APP.EXC_FILTER_EQUIPMENT_PHYSICAL_PORT=siteId:*


Note: Take care before you turn off the metrics for a particular subelement type, incase those metrics are also associated with other subelement types. In such cases,you might prefer to edit the filter to exclude the particular subelement, rather thanturn off the metrics for all subelements. For more information about thesubelement types that are associated with each metric, see Table.

Examples that use a single IP address:

The following examples show how to include, at a specified IP address, allavailable inventory and metrics that are associated with the Physical Port object.v V4.4.3 and later

Use the Topology Editor to supply an IP address to these SAMIF parameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_PHYSICAL_PORT=192.0.2.2

Use the Topology Editor to supply an IP address to these BLB parameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE=192.0.2.2ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE_ADD=192.0.2.2ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT=192.0.2.2

v All available metrics that are generated at address 192.0.2.2 are collected forthe equipment.InterfaceStatsLogRecord,equipment.InterfaceAdditionalStatsLogRecord, andequipment.MediaIndependentStatsLogRecord classes that are defined in theequipment package.

Examples that use the UNIX "?" file name specification:

The following examples show how to include, at a specified range of IP addresses,all available inventory and metrics that are associated with the Physical Port object.The range specification uses the UNIX ? (question mark) file name specification.v V4.4.3 and later

Use the Topology Editor to supply an IP address range to this SAMIF parameter:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_PHYSICAL_PORT=192.0.2.2?

Use the Topology Editor to supply an IP address range to these BLB parameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE=192.0.2.2?ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE_ADD=192.0.2.2?ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT=192.0.2.2?

v All available metrics that are generated at addresses 192.0.2.20 through192.0.2.29 inclusive are collected for the equipment.InterfaceStatsLogRecord,equipment.InterfaceAdditionalStatsLogRecord, andequipment.MediaIndependentStatsLogRecord classes that are defined in theequipment package.You can also specify the range as 192.0.2.2??. This range specification matches192.0.2.200 through 192.0.2.255 inclusive.

Examples that use the UNIX "*" file name specification:

The following examples show how to include, at a specified range of IP addresses,all available inventory and metrics that are associated with the Physical Port object.The range specification uses the UNIX * (asterisk) file name specification.

Tivoli Netcool Performance Manager v4.4.3 and laterUse the Topology Editor to supply an IP address range to this SAMIFparameter:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_PHYSICAL_PORT=192.0.2.2*


Use the Topology Editor to supply an IP address range to these BLBparameters:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE=192.0.2.2*ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE_ADD=192.0.2.2*ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_MEDIA_INDEPENDENT=192.0.2.2*

v All available inventory that is generated at addresses from 192.0.2.2,192.0.2.20 through 192.0.2.29 inclusive, and 192.0.2.200 through192.0.2.255 inclusive are collected for the equipment.PhysicalPort classthat is defined in the equipment package.

v All available metrics that are generated at addresses 192.0.2.2,192.0.2.20 through 192.0.2.29 inclusive, and 192.0.2.200 through192.0.2.255 inclusive are collected for theequipment.InterfaceStatsLogRecord,equipment.InterfaceAdditionalStatsLogRecord, andequipment.MediaIndependentStatsLogRecord classes that are defined inthe equipment package.

Another example, 192.1.*.*, would match any inventory and metrics forthese classes in the 192.1.X.X subnet.

You can also specify the range as 192.0.2.2??. This range specificationmatches 192.0.2.200 through 192.0.2.255 inclusive.

Examples that use the range() specification:

The following examples show how to include metric filtering on integers by usingnumeric ranges.Syntax: range(n..m)

The range supports the logic of 'greater than or equal to AND less than or equalto'.

Note: There is a logical AND between the upper and lower bound of the range.

The range() functionality can be used on properties that are purely integer values.The * and ? can be used on strings. The * and ? can be used on IP addresses thatare strings, but you cannot use the range() on IP addresses.Example - svcId: range(1010..1050)

In the preceding example, numbers greater than or equal to 1010 AND less than orequal to 1050 match the filter.

Also, multiple ranges that are used together are supported.Example - svcId: range(1..10) range(100..200)

In the preceding example, numbers greater than or equal to 1 AND less than orequal to 10 OR numbers greater than or equal to 100 AND less than or equal to200 match the filter.

Note: There is a logical OR between ranges when there is more than one range.

Examples that use multiple properties and values:SAMIF.1.100.ALCATEL_5620_SAM.INC_FILTER_PHYSICAL_PORT=SAMIF.1.100.ALCATEL_5620_SAM.INC_FILTER_PHYSICAL_PORT=cardSlotId:10 11;lagMembershipId: 0


SAMIF.1.100.ALCATEL_5620_SAM.INC_FILTER_PHYSICAL_PORT=192.0.3.* 192.0.4.*SAMIF.1.100.ALCATEL_5620_SAM.EXC_FILTER_PHYSICAL_PORT=siteId:192.0.3.100SAMIF.1.100.ALCATEL_5620_SAM.INC_FILTER_PHYSICAL_PORT=192.0.3.*; cardSlotId:10 11;lagMembershipId: 0

Note: The last example shows how to combine the old filter style with the newfilter style.

Example that includes and excludes specific inventory and metrics:

The following example shows how to include, at a specified IP address, allavailable inventory and metrics that are associated with theequipment.PhysicalPort class defined in the equipment package and to exclude allavailable inventory from the lag.Interface class that is defined in the lagpackage.

V4.4.3 and laterUse the Topology Editor to supply an IP address to this SAMIF parameter:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_PHYSICAL_PORT=siteId:192.0.2.2

Use the Topology Editor to supply an asterisk (collect no inventory) to thisSAMIF parameter:ALCATEL_5620_SAM.APP.EXC_FILTER_LAG_INTERFACE=*

Use the Topology Editor to supply an IP address to this BLB parameter:ALCATEL_5620_SAM.APP.INC_FILTER_EQUIPMENT_INTERFACE=siteId:192.0.2.2

Issues when configuring multiple Alcatel-Lucent 5620 SAM Technology Pack instances:

Specifying values for the include and exclude filter parameters when there is onlyone instance of the Alcatel-Lucent 5620 SAM Technology Pack is relativelystraightforward. All of the Tivoli Netcool Performance Manager resources(elements and subelements) are on the same instance. However, when yourenvironment requires two or more instances, then you need to understand theTivoli Netcool Performance Manager elements and the instances on which they arelocated. It is necessary because you want to specify the correct value for theinclude and exclude filter parameters.

Table 14 on page 169 table has the following columns:v First column – Specifies the instance of the Alcatel-Lucent 5620 SAM Technology

Pack. In this example, there are two instances - instance 1 and instance 2.v Second column – Specifies the element type.v Third column – Specifies the family names of the subelements that are associated

with this element.v

Table 14 on page 169 table shows that the subelements for the MPLS Serviceobject, Router object, and Network Queue object are on one instance, and thesubelements for the remaining objects are on another instance.

Do not split the subelements that are associated with the same element across twocollectors. This causes SQL errors. Your inventory or metrics or both are notcollected properly, and you lose data. Also, the Network Queue object must not besplit from the physical ports. They must reside in the same instance.


Table 14. Tivoli Netcool Performance Manager elements on multiple Alcatel-Lucent 5620 SAM Technology Packinstances

Instance Element type Subelement family

SAMIF.1.100

BLB.1.100

UBA.1.100

UBA.1.101

MPLS Service object 5620_SAM_MPLSInterface

Router object5620_SAM_Channel5620_SAM_Hw_Environment5620_SAM_LAGInterface5620_SAM_OAM_Test5620_SAM_PhysicalPort5620_SAM_PPP_Interface5620_SAM_PPP_Protocol5620_SAM_Shelf5620_SAM_Virtual_Router

Network Queue object 5620_SAM_NQueue

SAMIF.2.100

BLB.2.100

UBA.2.100

UBA.2.101

Service object5620_SAM_ServiceAccessInterface5620_SAM_AingrAengrQueue

Service Tunnel object 5620_SAM_SdpBinding

Changing the collection period for SAM statistics:

This section provides general guidelines on how to change the collection period forSAM statistics, and describes how to change the collection periods for varioustypes of SAM statistics:v “General guidelines on changing the collection period for SAM statistics”v “Changing the collection period for SAM accounting statistics” on page 170v “Changing the collection period for SAM polling statistics” on page 170v “Changing the collection period for SAM OAM test statistics” on page 171v “Changing the collection period for SAM availability statistics” on page 171v “Example to show how to change the collection period for SAM statistics” on

page 171

General guidelines on changing the collection period for SAM statistics:

The default collection period for all SAM statistics is 15 minutes.

If you change any collection period, ensure that you follow these guidelines:1. You must set the APP.FILE_PERIOD parameter (on each UBA component) and

the SAM.EXPORT_SCHEDULE parameter (on the BLB component) to equivalentvalues.For example, if you set the APP.FILE_PERIOD parameter to 600 (that is, 600seconds, or 10 minutes), then you must set the SAM.EXPORT_SCHEDULE parameterto 0,10,20,30 * * * *.

Note: The APP.FILE_PERIOD parameter is specified in seconds, and theSAM.EXPORT_SCHEDULE parameter is specified as a series of values that areexpressed in minutes.


2. Both the APP.FILE_PERIOD and SAM.EXPORT_SCHEDULE parameters must be set tothe minimum value of the following collection periods:v Collection period for SAM accounting statistics (see “Changing the collection

period for SAM accounting statistics”)v Collection period for SAM polling statistics (see “Changing the collection

period for SAM polling statistics”)v Collection period for SAM OAM Test statistics (see “Changing the collection

period for SAM OAM test statistics” on page 171)v Collection period for SAM availability statistics (see “Changing the collection

period for SAM availability statistics” on page 171)See also the “Example to show how to change the collection period for SAMstatistics” on page 171.

3. The collection period for any type of SAM statistics must be set to the samevalue as the collection period for the corresponding Tivoli Netcool PerformanceManager requests.

The Alcatel-Lucent 5620 SAM Technology Pack supplies these parameters that arebased on the following Tivoli Netcool Performance Manager platforms:

Tivoli Netcool Performance Manager 4.4.3 and laterThese parameters are supplied in the pack XSD file. You specified valuesfor these parameters as part of adding a UBA Bulk Collector andassociating it with the Alcatel-Lucent 5620 SAM Technology Pack. For moreinformation, see the section on adding a UBA Bulk Collector in theInstalling Tivoli Netcool Performance Manager - Wireline Component.

Changing the collection period for SAM accounting statistics:

To change the collection period for the SAM accounting statistics, do the followingactions:1. Change the accounting period on the SAM server, as described in the SAM

Server documentation.2. Change the Tivoli Netcool Performance Manager request period for the

subelements in the following folders in the Sub-Element Collecttree:Sub-Element Collect > Alcatel-Lucent 5620 SAM > Services >AingrAengrQueueSub-Element Collect > Alcatel-Lucent 5620 SAM > Router > NetworkQueues

3. Change the file period on the SAM server, as described in the SAM Serverdocumentation.This value must be the same as, or greater than, the accounting period that youspecified in Step 1.

4. Change the value of the APP.FILE_POLICY_PERIOD parameter (on the BLBcomponent).

5. Review the value of the APP.FILE_PERIOD and SAM.EXPORT_SCHEDULE parameters,as described in “General guidelines on changing the collection period for SAMstatistics” on page 169.See also the “Example to show how to change the collection period for SAMstatistics” on page 171.

Changing the collection period for SAM polling statistics:

To change the collection period for the SAM polling statistics, do the followingactions:


1. Change the collection period for the MIBs listed in “Enable the MIBs for theSAM statistics classes” on page 136.

2. Change the Tivoli Netcool Performance Manager request period for thesubelements in the following folders in the Sub-Element Collect tree:Sub-Element Collect > Alcatel-Lucent 5620 SAM > RouterSub-Element Collect > Alcatel-Lucent 5620 SAM > Services > SdpBinding

3. Review the value of the APP.FILE_PERIOD and SAM.EXPORT_SCHEDULE parameters,as described in “General guidelines on changing the collection period for SAMstatistics” on page 169.See also the “Example to show how to change the collection period for SAMstatistics.”

Changing the collection period for SAM OAM test statistics:

To change the collection period for the SAM OAM Test statistics, do the followingactions:1. Perform the steps that are described in “Set up ping tests” on page 139.2. Change the Tivoli Netcool Performance Manager request period for the

subelements in the following folder in the Sub-Element Collect tree:Sub-Element Collect > Alcatel-Lucent 5620 SAM > Router > OAM Tests

3. Review the value of the APP.FILE_PERIOD and SAM.EXPORT_SCHEDULE parameters,as described in “General guidelines on changing the collection period for SAMstatistics” on page 169See also the “Example to show how to change the collection period for SAMstatistics.”

Changing the collection period for SAM availability statistics:

To change the collection period for the SAM availability statistics, do the followingactions:1. Change the value of the JMS_FILE_OUTPUT.ACCESS_INTERFACE.PERIOD and

JMS_FILE_OUTPUT.PHYSICAL_PORT.PERIOD parameters (on the SAMIF component).2. Change the Tivoli Netcool Performance Manager request period for the

subelements in the following folders in the Sub-Element Collecttree:Sub-Element Collect > Alcatel-Lucent 5620 SAM > Router > InterfaceSub-Element Collect > Alcatel-Lucent 5620 SAM > Services >ServiceAccessInterface

3. Review the value of the APP.FILE_PERIOD and SAM.EXPORT_SCHEDULE parameters,as described in “General guidelines on changing the collection period for SAMstatistics” on page 169.See also the “Example to show how to change the collection period for SAMstatistics.”

Example to show how to change the collection period for SAM statistics:

The following table shows how to set several parameters to change the collectionperiod for various SAM statistics from the default value of 15 minutes to a newvalue of 10 minutes, based on the guidelines.

The guidelines are provided in “General guidelines on changing the collectionperiod for SAM statistics” on page 169, where UBA1 is the polling UBA and UBA2is the accounting UBA.


Table 15. Example Parameter Values to Change the Collection Period for SAM Statistics

Parameter Component Default Value New Value

APP.FILE_PERIOD UBA1, UBA2 900 600

APP.FILE_POLICY_PERIOD BLB 900 600

JMS_FILE_OUTPUT.ACCESS_INTERFACE.PERIOD

SAMIF 900 600

JMS_FILE_OUTPUT.PHYSICAL_PORT.PERIOD

SAMIF 900 600

SAM.EXPORT_SCHEDULE BLB 0,15,30,45 * * * * 0,10,20,30 * * * *

The Alcatel-Lucent 5620 SAM Technology Pack supplies these parameters in one ofthe following ways:

Tivoli Netcool Proviso v4.4.3 and Tivoli Netcool Performance Manager 1.3.0 orlater These parameters are supplied in the pack XSD file. You specified values

for these parameters as part of adding a UBA Bulk Collector andassociating it with the Alcatel-Lucent 5620 SAM Technology Pack. For moreinformation about adding a UBA Bulk Collector, see the section in theInstalling Tivoli Netcool Performance Manager - Wireline Component.

Changing the collection strategy for availability metrics:

The UBAs calculate the availability of physical ports (calculated by UBA1) andservices (calculated by UBA2) by using operational status information that isreceived through JMS.

The JMS data is received by the SAMIF. The SAMIF puts intermediate files in theDATA_CHANNEL_HOME /jms_xml directory to be picked up by the UBAs.DATA_CHANNEL_HOME is the DataChannel home directory (/opt/datachannel,by default).

Several steps in this section explain to ensure that the correct values are specifiedfor parameters in the deployed topology (V4.4.3 and later). You specify the valuesfor these parameters in one of the following ways:

Tivoli Netcool/Proviso v4.4.3 and Tivoli Netcool Performance Manager 1.3.0 orlater These parameters are supplied in the pack XSD file. You used the Topology

Editor to specify a value for these parameters as part of adding a UBABulk Collector and associating it with the Alcatel-Lucent 5620 SAMTechnology Pack. For more information about adding a UBA BulkCollector, see the section in the Installing Tivoli Netcool Performance Manager- Wireline Component.

Stopping the collection of availability metrics:

To stop collecting availability metrics for Access Interface objects and Physical Portobjects, do the following steps:1. Stop each UBA:

$ dccmd stop UBA.<channel_number>. <collector_number1>$ dccmd stop UBA.<channel_number>. <collector_number2>

2. Set the AVAIL_NAME_SPACE parameter for each collector to a null value:UBA. <channel_number> . <collector_number1> .ALCATEL_5620_SAM.AVAIL_NAME_SPACE=UBA. <channel_number> . <collector_number2> .ALCATEL_5620_SAM.AVAIL_NAME_SPACE=


3. Set the JMS_FILE_OUTPUT.<object_type>.ACTIVE parameters to the value FALSE.The following example shows how to set these parameters for Tivoli NetcoolPerformance Manager in the Topology Editor help XSD file:SAMIF.<channel_number>.<collector_number1>.ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.PHYSICAL_PORT.ACTIVE=FALSESAMIF.<channel_number>.<collector_number1>.ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.ACCESS_INTERFACE.ACTIVE=FALSE

4. Remove the following folders:DATA_CHANNEL_HOME /UBA. <channel_number> .<collector_number1> /ALCATEL_5620_SAM/state

DATA_CHANNEL_HOME /UBA. <channel_number> .<collector_number2> /ALCATEL_5620_SAM/statewhere DATA_CHANNEL_HOME is the DataChannel home directory(/opt/datachannel , by default).

5. Stop and restart the SAMIF.$ dccmd stop SAMIF.<channel_number>.<collector_number1>$ dccmd start SAMIF.<channel_number>.<collector_number1>

6. Restart each UBA:$ dccmd start UBA.<channel_number>.<collector_number1>$ dccmd start UBA.<channel_number>.<collector_number2>

7. Wait to ensure that the UBAs stop to produce the availability data, but continueto produce other data.For example:v Wait to see whether the UBAs continue to produce output BOF files in the

following directories:DATA_CHANNEL_HOME/UBA.<channel_number>.<collector_number1>/outputDATA_CHANNEL_HOME/UBA.<channel_number>.<collector_number2>/output

v Check to see whether any files exist in the following directories:DATA_CHANNEL_HOME /jms_xml/PORT/* (for Physical Port objects)DATA_CHANNEL_HOME /jms_xml/ACCESS/* (for Access Interface objects)

These directories contain the input files that the UBAs use to produce theavailability data. If the UBAs do not move the input files from thesedirectories, the UBAs are probably not producing the availability data.

Starting the collection of availability metrics:

To start collecting availability metrics for Access Interface objects and Physical Portobjects, do the following steps:1. Stop the BLB:

$ dccmd stop BLB.<channel_number>. <collector_number1>

2. Stop each UBA$ dccmd stop UBA.<channel_number>. <collector_number1>$ dccmd stop UBA.<channel_number>. <collector_number2>

3. Set the AVAIL_NAME_SPACE parameter for each collector to the appropriatevalue. The following example shows how to set these parameters for TivoliNetcool Performance Manager in the Topology Editor XSD file:UBA. <channel_number> . <collector_number1> .ALCATEL_5620_SAM.AVAIL_NAME_SPACE=PHYSICAL_PORTUBA. <channel_number> . <collector_number1> .ALCATEL_5620_SAM.AVAIL_NAME_SPACE=ACCESS_INTERFACE

4. Remove the following folders:


DATA_CHANNEL_HOME /UBA. <channel_number> .<collector_number1> /ALCATEL_5620_SAM/stateDATA_CHANNEL_HOME /UBA. <channel_number> .<collector_number2> /ALCATEL_5620_SAM/statewhere DATA_CHANNEL_HOME is the DataChannel home directory( /opt/datachannel , by default).

5. Set the JMS_FILE_OUTPUT.<object_type>.ACTIVE parameters to the value TRUE.The following example shows how to set these parameters for Tivoli NetcoolPerformance Manager pre-v4.4.3 in the dc.cfg file:SAMIF. <channel_number> . <collector_number1> .ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.PHYSICAL_PORT.ACTIVE=TRUESAMIF. <channel_number> . <collector_number1> .ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.ACCESS_INTERFACE.ACTIVE=TRUE

6. Stop and restart the SAMIF:$ dccmd stop SAMIF.<channel_number>. <collector_number1>$ dccmd start SAMIF.<channel_number>. <collector_number1>

7. Start each UBA:$ dccmd start UBA.<channel_number>. <collector_number1>$ dccmd start UBA.<channel_number>. <collector_number2>

8. Start the BLB:$ dccmd start BLB.<channel_number>. <collector_number1>

Troubleshooting Alcatel-Lucent 5620 SAM Technology PackconfigurationTroubleshooting tips for issues related to the SAM Inventory File (SAMIF), BulkLoad Balancer (BLB), and Universal Bulk Adaptors (UBAs).

Specifying parameter values:

Several tips for you to ensure that the correct values were specified for parametersin the deployed topology (Tivoli/Netcool Proviso v4.4.3 and later).

You specify the values for these parameters in one of the following ways,depending on the Tivoli Netcool Performance Manager platform:

Tivoli Netcool/Proviso 4.4.3 and Tivoli Netcool Performance Manager 1.3.0 orlater These parameters are supplied in the pack XSD file. You used the Topology

Editor to specify a value for these parameters as part of adding a UBABulk Collector and associating it with the Alcatel-Lucent 5620 SAMTechnology Pack. For more information, see the section on adding a UBABulk Collector in the Installing Tivoli Netcool Performance Manager - WirelineComponent.

Inventory issues:

If you do not see the expected inventory in your Tivoli Netcool PerformanceManager instance, use the information in this section. Complete the steps in eachsubsection to verify that you configured your instance correctly.

Overview of inventory:

The Alcatel-Lucent 5620 SAM Technology Pack creates inventory through twomechanisms.

Full dump mechanism Requests bulk files of inventory data from the SAM server.


JMS mechanismProvides incremental inventory updates through an event-notificationsystem.

Note: The full dump does not run unless the JMS is working correctly.

The inventory files from a full dump are in a directory on the SAM server. Thedefault location is the /opt/5620sam/server/xml_output directory. The SAM serveradministrator sets this location during SAM server configuration.

The Alcatel-Lucent 5620 SAM Technology Pack uses the following syntax forinventory file names:proviso-inventoryType-dateRequested-timeRequested-*

When you are diagnosing an inventory problem, you can use the inventoryTypeinformation from the inventory file name to identify which type of object has theinventory problem.

Here are some example inventory file names:proviso-physicalPort-2010.02.16-21.52.38-3443809958133862-26361proviso-mplsInterface-2010.02.16-21.53.52-3443810032485722-14952proviso-iesL3AccessInterface-2010.02.16-22.34.46-3443812486323659-98844

JMS is not working:

If JMS is not working, complete the following troubleshooting steps:1. Ensure that the DATA_CHANNEL_HOME/scripts/alcatel_5620_sam directory

contains the SamJms.jar and samOss.jar files.2. Ensure that you are using the samOss.jar file that comes with the SAM server

version that you are running. Do not use an older version of the samOss.jarfile.

3. Make sure that the correct value was specified for the SAM.JAR_PATH parameter,as described in “Specifying parameter values” on page 174 based on the TivoliNetcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.JAR_PATH

The SAM.JAR_PATH parameter specifies the location of the SamJms.jar andsamOss.jar files.

4. Make sure that the correct value was specified for the SAM.JAVA_PATH parameter,as described in “Specifying parameter values” on page 174, based on the TivoliNetcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.JAVA_PATH

The SAM.JAVA_PATH parameter identifies the full path of the JRE 1.6 executable.The default value is /usr/bin/java. If Java is installed in any other location,you must set the SAM.JAVA_PATH parameter.

5. Verify that Java is available and can be run, by running the followingcommand:$ java -version


If Java is installed in a nondefault location, specify the full path for the Javaexecutable. For example, if Java is installed in the /export/home/pvuser/java1.6directory:a. Set the SAM.JAVA_PATH parameter to /export/home/pvuser/java1.6/java.b. Run the following command:

$ /export/home/pvuser/java1.6/java -version

6. Ensure that you are using JRE Version 1.6 or later. To identify the JRE version,use the java -version command as described in Step 5.

7. Make sure that the correct value was specified for the JMS port number, asdescribed in “Specifying parameter values” on page 174, based on the TivoliNetcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.JMS_PORT

The value of the JMS port number depends on the number of SAM servers inyour configuration, as described in “Specifying parameter values” on page 174.

8. To test whether the JMS port is active, run the following command:$ telnet <sam_server> <JMS_port>

JMS Filter is not updated in the Topology Editor:

When you try to upgrade the 4.3Y/1.3A/1.3B Alcatel-Lucent SAM TechnologyPack that is running on Tivoli Netcool/Proviso 4.4.3.3 to 1.3D (v2.10.0.0), the JMSfilter is not updated in the Topology Editor.

To work around this issue, follow these steps:1. Extract the XSD file from Alcatel-Lucent SAM Technology Pack.2. Launch Topology Editor.3. Right-click Application Packs in the Application Packs pane, and then click

Load Application Pack.4. Select XSD file, and then click Browse to navigate to the path where the

current XSD file is stored.5. Click OK to overwrite the existing file.6. In the Logical View pane, navigate to SAMIF under the UBA primary collector

to see the Advanced Properties tab.7. Select the ALCATEL_5620_SAM.SAM_JMS_FILTER property under Advanced

Properties to find the current updates to this property. The value must be asfollows:ALA_clientId in (’proviso-KLPRO01Z5-1-2’,’’) and MTOSI_objectType in(’KeepAliveEvent’,’StateChangeEvent’,’TerminateClientSession’,’equipment.PhysicalPort’,’equipment.Shelf’,’equipment.HwEnvironment’,’mpls.Interface’,’lag.Interface’,’vll.L2AccessInterface’,’vprn.L3AccessInterface’,’ies.L3AccessInterface’,’vpls.L2AccessInterface’,’mirror.L2AccessInterface’,’aengr.ForwardingClass’,’aingr.ForwardingClass’,’aengr.Queue’,’aingr.Queue’,’svt.MeshSdpBinding’,’svt.MirrorSdpBinding’,’svt.SpokeSdpBinding’,’aingr.Policy’,’aengr.Policy’,’icmp.IcmpPing’,’mpls.LspPing’,’svt.TunnelPing’,’svt.VccvPing’,’service.SitePing’,’sonetequipment.Sts1Channel’,’sonetequipment.Sts3Channel’,’sonetequipment.Sts12Channel’,’sonetequipment.Sts48Channel’,’sonetequipment.Sts192Channel’,’tdmequipment.DS1E1Channel’,’tdmequipment.DS3E3Channel’,’sonetequipment.TributaryChannel’,’sonetequipment.Tu3Channel’,’sonetequipment.TributaryGroup’,’sonetequipment.Tug3Group’,’tdmequipment.DS0ChannelGroup’,’ppp.Interface’,’ppp.PppControlProtocol’,’nqueue.ForwardingClass’,


’nqueue.Policy’,’nqueue.Entry’,’sasqos.Meter’,’sasqos.AccessIngress’,’sasqos.AccessIngressForwardingClass’,’sasqos.PortAccessEgress’,’sasqos.PortAccessEgressForwardingClass’,’sasqos.PortAccessEgressQueue’,’rtr.VirtualRouter’,’ipipe.L2AccessInterface’,’equipment.CardSlot’,’ethernetoam.CfmLoopback’,’ethernetoam.CfmOneWayDelayTest’,’ethernetoam.CfmTwoWayDelayTest’,’ethernetoam.CfmEthTest’,’aosqos.Policy’,’svq.AggregationScheduler’,’mpls.Site’,’vprn.ServiceAccessPoint’,’ies.ServiceAccessPoint’,’ethernetoam.CfmSingleEndedLossTest’,’ethernetoam.Mep’ ) and ALA_category not in (’STATISTICS’,’ACCOUNTING’)

8. If any of the filters are missing, you must add them manually by using thepreceding information. Or, you can take the updated filters from the XSD filefor Alcatel-Lucent SAM 2.10.0.0 Technology Pack.

SAM inventory fails and does not start the full dump:

During the full dump, the SAMIF application requests inventory data files fromthe SAM server and retrieves them to process and create the inventory. If one ofthe files it requests is not able to be retrieved, it does not start the full dump. Ifthis failure condition persists, then this full dump failure situation loopsrepeatedly.

In this case, complete the following troubleshooting steps:1. User configuration or file/directory permissions do not allow the full dump

files to be seen or retrieved by the SAMIF. Check the permissions as specifiedin “Setting up the Alcatel-Lucent 5620 SAM servers” on page 134, and inparticular in the section “Configure FTP accounts on the primary andredundant SAM servers” on page 137.

2. Check user-specified filters. If there is a problem with user-specified filters, itmight result in files not being written to and the full dump might loop.If the user specifies a filter of the type property: value and the filterspecification is not valid for the SAM server, it fails to write a file, thus causingthe full dump to fail. There is no log indication for this failure case, but itcauses a "file not found" during the full dump.There are two cases where it might happen:a. The property that is specified in the filter is not available in the inventory

class, which is being requested. For example, if there is a typographicalerror in the property name, or specified a property that is not applicable tothat class. It causes the file request to fail, and the full dump loops.

Note: Information about the properties that are valid for each class areoutside of the scope of this user guide.

b. The filter specification uses the wrong matching syntax for the propertyspecified. As described in the section Matching patterns in filter syntax:strings and numbers, the * and ? are only applicable to string properties,and the range() match is only applicable to numerical properties. Usingthese matching constructs on the wrong type of property results in failure toretrieve a file, and the full dump loops.

Note: Information about the types of properties (whether they arenumerical or string) is outside the scope of this guide.

SAM inventory does not exist in the SAM server:

If inventory does not exist in the SAM server, make sure that discovery is turnedon in the SAM server. Use the Alcatel-Lucent 5620 SAM Client GUI to checkwhether discovery is turned on.


SAM inventory does not exist in Tivoli Netcool Performance Manager:

If inventory does not exist in Tivoli Netcool Performance Manager, complete thefollowing troubleshooting steps:1. Make sure that the Java Message Service (JMS) is working.

To verify that JMS is working, search for the "JMS_CONNECTION_ESTABLISHED"message. The following example shows the expected output when JMS isworking.2010.03.05-04.41.19 UTC SAMIF.2.100-2823 I SAM_CONNECTAttempting connection to sam server: http://192.0.2.8:8080/xmlapi/invoke2010.03.05-04.41.19 UTC SAMIF.2.100-2823 1EXSTATUSCHANGE SAM JMS communication process listening for events since:2010.03.05-04.41.192010.03.05-04.41.19 UTC SAMIF.2.100-2823 3 [DL39218] JMS_PROCESS_STARTEDThe SAM JMS communication process has started (pid: 2849)2010.03.05-04.41.20 UTC SAMIF.2.100-2823 I SAM_CONNECTEDConnection established with http://192.0.2.8:8080/xmlapi/invoke2010.03.05-04.41.41 UTC SAMIF.2.100-2823 I [DL39222]JMS_CONNECTION_ESTABLISHED The SAM JMS connection has beenestablished (a keep-alive message was received)

If the "JMS_CONNECTION_ESTABLISHED" message is not displayed, the JMS is notworking. Review the $DC_HOME/log/proviso.log file for errors. Complete thesteps in “JMS is not working” on page 175 to verify that you configured yourinstance correctly.

2. Make sure that the SAMIF full dump is working.To verify that the full dump is working, search for the Full Dump Completemessage. The following example shows the expected output when the fulldump is working.2009.12.18-15.34.32 UTC SAMIF.2.100-26288 I[SAMIF] onFullDump **** Full Dump Started ****.2009.12.18-15.49.42 UTC SAMIF.2.100-26288 I[SAMIF] onFullDump **** Full Dump Complete ****.

If the "Full Dump Started" message is repeated, there is a problem with theinventory. Stop the SAMIF and review the $DC_HOME/log/proviso.log file forerrors with the SAMIF.

SAM inventory does not complete:

If the customer inventory is large, a full dump might take too long to complete. Inthis situation, the SAMIF times out, and a new full dump is requested because theoriginal full dump is assumed to have failed.

To fix this problem, increase the value that is specified for the SAM.SOAP_TIMEOUTparameter, as described in “Specifying parameter values” on page 174, based onthe Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.SOAP_TIMEOUT

The default value for the SAM.SOAP_TIMEOUT parameter is 900 (900 seconds).

Loading metadata takes a long time to complete on SAMIF component restart or reestablishconnection to SAM server:

This issue occurs most often when you have many subelements with numerousproperties. It can happen with any component that reads metadata, for example


the SAMIF or CME. You can optimize the Oracle queries for the specific data inyour database by running the following command in the DataMart environment:

'dbMgr analyzeMetaDataTables A Y'

This command must be run if numerous objects are inventoried or if the inventoryis changed significantly. For example, if a new property is added to thesubelements. Typically, this command must be scheduled to run at least one time aday in active networks.

SAMIF files do not exist in the SAM server directory:

Troubleshooting steps when SAMIF files do not exist in the SAM server directory.

If the inventory files are not transferred to the default directory on the SAM server,as described in the “Overview of inventory” on page 174, complete the followingtroubleshooting steps:1. Make sure that an OSS user account is configured on the SAM server. For more

information, see “Configure an OSS user account” on page 135.2. Make sure that the correct values were specified for the SAM.USERNAME and

SAM.PASSWORD parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.USERNAMEALCATEL_5620_SAM.SAM.PASSWORD

3. Make sure that the correct value was specified for the SAM.SAM_VERSIONparameter, as described in “Specifying parameter values” on page 174, basedon the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.SAM_VERSION

The SAM.SAM_VERSION parameter refers to the JMS protocol version, not theSAM server version.

4. Make sure that the correct values were specified for the SAM.SOAP_URI andSAM.SOAP_URI_2 parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.SOAP_URIALCATEL_5620_SAM.SAM.SOAP_URI_2

SAMIF files do not exist in the SAMIF temp directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfersinventory files to the DataChannel SAMIF application temp and done directories.

If the inventory files are not transferred to the SAMIF application temp and outputdirectories, complete the following troubleshooting steps:1. Make sure that an FTP user account is configured on the primary and

redundant SAM servers. For more information, see “Configure FTP accounts onthe primary and redundant SAM servers” on page 137.


2. Make sure that the correct values were specified for the SAM.EXPORT_URI andSAM.EXPORT_URI_2 parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.EXPORT_URIALCATEL_5620_SAM.SAM.EXPORT_URI_2

3. Check the UNIX file permissions on the SAM server. Ensure that thepermissions on the xml_output directory are set to allow read, write, andexecute by the SAM FTP user.

4. If files in the temp directory are 60 bytes in size, one of the following conditionsexists:v The SAM server has no inventory of that type.v The SAM server is not configured to discover inventory of that type.v The inventory filter parameters might be set such that they do not match any

inventory on the SAM server. For more information about filter parameters,see “Specifying what inventory and metrics to collect” on page 148.

You can use the inventoryType information from the inventory file name toidentify which type of object has the inventory problem, as described in “Overviewof inventory” on page 174. If you think that you must have inventory of that type,make sure that the discovery polling for that type is configured on the SAM server.

BLB does not put files in its output directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfers idmapfiles to the DataChannel SAMIF application output and done directories, and thento the DataChannel BLB application output and done directories.

If the BLB is processing files, but does not put files in the output directory, the BLBmight not receive notification of the inventory from SAMIF through the idmapfiles.

If the idmap files do not exist in the BLB application output directory, complete thefollowing troubleshooting steps:1. Regenerate the idmap files, as follows:

$ dccmd debug SAMIF.2.100 "self server firstAdaptor modelInterfacegenerateFullIdMap"

Replace 2.100 with the channel and collector number for your installation.2. Check the $DC_HOME/log/proviso.log file. If the proviso-*.xml files appear in

the SAMIF temp directory and no SAMIF idmap files ever appear in the outputdirectory, the SAMIF DataChannel application might be failing with an error.

3. Determine whether the inventory ran one time and is now being rerun. In thiscase, no new idmap files appear in the SAMIF output directory because none ofthe inventory is new. This scenario is unlikely to occur.

If the idmap files do not exist in the BLB application done directory, complete thefollowing troubleshooting steps:1. Make sure that the BLB application is configured correctly.2. Make sure that the BLB application is running.


3. Make sure that the correct value was specified for the IDMAP.URI parameter, asdescribed in “Specifying parameter values” on page 174, based on the TivoliNetcool Performance Manager platform:

Platform Parameter

Tivoli Netcool/Proviso v4.4.3 and TivoliNetcool Performance Manager 1.3.0 or later

ALCATEL_5620_SAM.IDMAP.URI

UBA idmap files are no longer supported:

Starting with Alcatel-Lucent 5620 SAM Technology Pack Version 2.4.1.0, idmap filesare no longer used by the UBA.

Metric data collection issues:

If you do not see the expected metrics in your Tivoli Netcool PerformanceManager instance, use this information. Complete the steps in each subsection toverify that you configured your instance correctly.

The following sections provide an overview of metric data, and describetroubleshooting tips for issues that are related to the metric data collection:

Overview of metric data:

The SAM server supports the following types of metric data:

Polled

Polled metric data is collected by the SAM server from the routers byusing SNMP. To collect the data, MIBs must be enabled on the SAM server,and polling periods must be set. For more information about the MIBs thatare needed, see “Enable the MIBs for the SAM statistics classes” on page136.

Exception to the Rule: The exception is the HwEnvironmentTemperature files.These files are in effect inventory files in which the temperature propertiesare read in as metrics. For various reasons that are related to the data notbeing real metrics, the temperature data is only available for a subelementunder the following conditions:v The CPU utilization metric for that subelement is available.v The data that is processed is “current”: the BLB and UBA caught up to

the wall-clock time as much as is possible and no backlog of data isbeing processed.

AccountingAccounting metric data is collected by the routers into files. These files areretrieved by the SAM server, and read into its database. To get the data,the accounting and file policies must be configured on the SAM server anddistributed to the routers. Accounting data is the data that is collected forservices. For more information about accounting data, see “Configure theSAM accounting and polling statistics” on page 135.

Availability data from the JMSThe UBA calculates the availability of physical ports and services by usingoperational status information that is received through JMS. The JMS datais received by the SAMIF. Therefore, for the availability calculations towork, the SAMIF must be running. The SAMIF puts intermediate files in


the datachannel/jms_xml directory to be picked up by the UBA. If theSAMIF is not running, and the UBA is expecting availability data, all dataoutput of the UBA blocks until this data is received.

The Alcatel-Lucent 5620 SAM Technology Pack uses the following syntax formetric-data file names:fileDescription_dateCollected-timeCollected.host_channel_collector.xml

Here is an example file name for a metric-data file:InterfaceStats_2010.03.18-16.30.00.100.HOST22_2_100.xml

SAM metrics do not display in the Alcatel-Lucent 5620 SAM Client GUI:

The SAM server administrator uses the Alcatel-Lucent 5620 SAM Client GUI todisplay metrics for the different objects (for example, services and networkelements) in a SAM network environment.

If SAM metrics do not display in the Alcatel-Lucent 5620 SAM Client GUI,complete the following troubleshooting steps:1. Enable the appropriate MIBs for the polled data.2. Enable an accounting policy for the service data.

SAM metric files are empty or do not exist in the SAM server:

Typically, SAM metric files are transferred to a directory, such as/opt/5620sam/nms/server/xml_output, on the SAM server.

If the SAM metric files are empty (that is, the XML file has left and right anglebrackets with no data, and is 60 bytes or less), complete the followingtroubleshooting steps:1. Determine whether the absence of data is because there are no inventory

elements and subelements from which to receive metrics.2. Ensure that you enabled the appropriate MIBs for polled data.3. Ensure that you enabled an accounting policy for service data.4. Ensure that you set your filter parameters correctly. For more information about

filter parameters, see “Specifying what inventory and metrics to collect” onpage 148.

If SAM metric files do not exist in the SAM server, complete the followingtroubleshooting steps:1. Make sure that an OSS user account is configured. For more information, see

“Configure an OSS user account” on page 135.2. Make sure that the correct values were specified for the SAM.USERNAME and

SAM.PASSWORD parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter


ALCATEL_5620_SAM.SAM.USERNAMEALCATEL_5620_SAM.SAM.PASSWORD

3. Make sure that the correct value was specified for the SAM.SAM_VERSIONparameter, as described in “Specifying parameter values” on page 174 based onthe Tivoli Netcool Performance Manager platform:


Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.SAM_VERSION

The SAM.SAM_VERSION parameter refers to the JMS protocol version, not theSAM server version.

4. Make sure that the correct values were specified for the SAM.SOAP_URI andSAM.SOAP_URI_2 parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.SOAP_URIALCATEL_5620_SAM.SAM.SOAP_URI_2

5. Check the UNIX file permissions. Ensure that the permissions on thexml_output directory are set to allow read, write, and execute by the SAM FTPuser.

6. Ensure that you have enough disk space. For more information, see “Metricscollection fails due to lack of disk space” on page 187.

SAM metric files do not exist in BLB directories:

Typically, the DataChannel File Transfer Engine (FTE) application transfers SAMmetric files to the DataChannel BLB application do, done, and output directories.

If SAM metric files are not transferred to the BLB application do, done, and outputdirectories, complete the following troubleshooting steps:1. Make sure that an FTP user account is configured on the primary and


2. Make sure that the correct values were specified for the SAM.EXPORT_URI andSAM.EXPORT_URI_2 parameters, as described in “Specifying parameter values” onpage 174, based on the Tivoli Netcool Performance Manager platform:

Platform Parameter

V4.4.3 and later ALCATEL_5620_SAM.SAM.EXPORT_URIALCATEL_5620_SAM.SAM.EXPORT_URI_2

3. Check the UNIX file permissions. Ensure that the permissions on the do, done,and output directories are set to allow read, write, and execute by the SAMFTP user.

4. Ensure that the BLB received notification of the inventory from SAMIF throughthe idmap files. If the idmap files do not exist in the BLB application outputdirectory, regenerate the idmap files, as follows:$ dccmd debug SAMIF.2.100 "self server firstAdaptor modelInterfacegenerateFullIdMap"

Replace 2.100 with the channel and collector number for your installation.5. Ensure that you have enough disk space. For more information, see “Metrics

collection fails due to lack of disk space” on page 187.


SAM metric files do not exist in UBA directories:

Typically, the DataChannel File Transfer Engine (FTE) application transfers SAMmetric files to the DataChannel Universal Bulk Adaptor (UBA) application do, done,and output directories.

If the SAM metric files do not exist in the UBA application do, done, and outputdirectories, complete the following troubleshooting steps:1. Make sure that an OSS user account is configured. For more information, see

“Configure an OSS user account” on page 135.2. Make sure that the correct values were specified for the following parameters,

as described in “Specifying parameter values” on page 174, based on the TivoliNetcool Performance Manager platform.

3. Check UNIX file permissions.4. Ensure that the SAMIF is running.

The UBA must get files from all of its inputs to produce any BOF files in theoutput directory. If one of the inputs is blocked, all BOF production is blocked.One of these inputs is the datachannel/jms_xml directory, which containsavailability data. This data is generated by the SAMIF. Therefore, if the SAMIFis not running, UBA data generation is blocked.

5. Ensure that you have enough disk space. For more information, see “Metricscollection fails due to lack of disk space” on page 187.

Files do not exist in UBA output directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfers files tothe DataChannel Universal Bulk Adaptor (UBA) application output directory.

Make sure that the UBA receives all the expected input files. If the UBA does notreceive these files, it blocks the creation of BOFs (Binary Object Files) until they arereceived.

If the files do not exist in the UBA application output directory, complete thefollowing troubleshooting steps:1. Check the Bulk Load Balancer (BLB) output directory to make sure that the

UBAs are picking up the files.2. Check the UBA and SAMIF settings. The creation of BOF files is blocked when,v Availability data in the SAMIF is disabled, for either the physical port or

access interfaces, andv The UBA is configured to expect this availability data. In this case, make sure

that the SAMIF settings are configured as follows:ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.PhysicalPort.ACTIVE=TRUEALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.AccessInterface.ACTIVE=TRUE

When ALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.AccessInterface.ACTIVE=TRUEit collects the availability xml files and inventory for AccessInterface.WhenALCATEL_5620_SAM.SAM.JMS_FILE_OUTPUT.AccessInterface.ACTIVE=FALSE itdoes not collect the availability xml files and inventory for AccessInterface.

Note: The above TRUE and FALSE settings apply to AccessInterface andnot to PhysicalPort.However, if the intention is to not collect the availability data, then makesure that the UBA has a blank value that is assigned as follows:


UBA.2.101.ALCATEL_5620_SAM.AVAIL_NAME_SPACE=

Note: If the preceding UBA setting is changed to either a blank value or anactual value, then the UBA state might need to be removed and restarted(when the change is not effective by just changing the configuration andrestarting).

3. Check that the SAMIF is running. When you collect availability metrics, theSAMIF needs to be running as it provides raw data that is used for availabilitycalculations to the UBAs. If the SAMIF is stopped, and therefore not producingthe data, the UBA(s) do not produce any BOF output.

4. Make sure that the BLB requests to the SAM server are successfully creating allthe expected input files. BLB files might not be correctly written by the SAMserver if they have erroneous metric filter specifications configured. For moreinformation, see “BLB requests metric files but they are not created” on page186.

5. If the UBA is not producing files because it is not receiving input, then it ispossible to issue a debug command to help determine the schema that is notreceiving input. The command:dccmd debug UBA.1.100 "(self server firstAdaptor rootOperator sources collect:[:each | each source -> each peek])"

It displays the timestamp and records the status of each schema. "nil" canindicate a schema did not see any data, but it might also show “nil” while thepack is processing.dccmd debug UBA.1.100 "(self server firstAdaptor rootOperator sources collect:[:each | each source -> each peek notNil])"

It displays the schema inputs, and if any are false, then they do have no input.Alternatively, they are between inputs. It can be useful for debugging streammerge blockage issues.

BOF files exist with no meaningful data in the UBA output directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfers BOFs(Binary Object Files) to the DataChannel Universal Bulk Adaptor (UBA) applicationoutput directory.

If the BOF files exist in the UBA application output directory with no meaningfuldata (that is, there are no metric IDs in the files), complete the followingtroubleshooting steps:1. Make sure that you correctly installed the Alcatel-Lucent 5620 SAM Technology

Pack2. Try to rerun the inventory3. Perform the following actions as a last resort:

a. Stop the SAMIF application.b. Delete all of the inventory.c. Remove the SAMIF directory (including all subdirectories).d. Restart the SAMIF application.

These actions re-create the inventory with new IDs. In general, do not use thistroubleshooting tip except during initial installation of the Alcatel-Lucent 5620SAM Technology Pack.


BOF files do not exist in the FTE output directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfers BOFs(Binary Object Files) to the DataChannel FTE application output directory.

If the BOF files are not transferred to the FTE application output directory,complete the following troubleshooting steps:1. Make sure that an FTP user account is configured on the primary and


2. Make sure that the user exists on the SAM server. Also, make sure that thecorrect FTP user name and password values were specified for theSAM.EXPORT_URI and SAM.EXPORT_URI_2 parameters, as described in “Specifyingparameter values” on page 174, based on the Tivoli Netcool PerformanceManager platform:

Platform Parameter


ALCATEL_5620_SAM.SAM.EXPORT_URIALCATEL_5620_SAM.SAM.EXPORT_URI_2

3. Check the UNIX permissions.4. Ensure that you have enough disk space. For more information, see “Metrics

collection fails due to lack of disk space” on page 187

BOF files do not exist in the CME output directory:

Typically, the DataChannel File Transfer Engine (FTE) application transfers BinaryObject Files (BOFs) to the DataChannel Complex Metric Engine (CME) applicationoutput directory.

If the BOF files are not transferred to the CME application output directory,complete the following troubleshooting steps:1. Make sure that you imported the Alcatel-Lucent 5620 SAM Technology Pack

predefined collection requests. For more information, see the Activate datacollection requests step in “Configuring UBA technology packs” on page 3.

2. Check the UNIX permissions.3. Ensure that you have enough disk space. For more information, see “Metrics

collection fails due to lack of disk space” on page 187.

BLB requests metric files but they are not created:

The BLB application requests metric data files from the SAM server each period,and retrieves them to process and create the metric.

If one of the files it requests is not created, then that file is missing for a period. IfBLB metric files are missing, complete the following steps:1. Check user-specified filters. If there is a problem with user-specified filters, it

might result in files not being written to and the full dump might loop.If the user specifies a filter of the type property: value and the filterspecification is not valid for the SAM server, it fails to write a file. There is noTivoli Netcool Performance Manager log indication for this failure case, but thefile is not written to the XML output directory on the SAM server. If SOAPrequest logging is enabled on the SAM server, the error is logged by the SAMserver in the response to the request.


There are two cases where it might happen:a. The property that is specified in the filter is not available in the metric class,

which is being requested. For example, if there is a typographical error inthe property name, or specified a property that is not applicable to thatclass. It causes the file request to fail, and no metric file is written.

Note: Information about the properties that are valid for each class areoutside of the scope of this user guide.

b. The filter specification uses the wrong matching syntax for the propertyspecified. As described in the section Matching patterns in filter syntax:strings and numbers, the * and ? are only applicable to string properties,and the range() match is only applicable to numerical properties. Usingthese matching constructs on the wrong type of property results in failure toretrieve a file, and no metric file is written.

Note: Information about the types of properties (whether they arenumerical or string) is outside the scope of the guide.

Metrics collection fails due to lack of disk space:

If the metric-collection operation fails on the SAM server, make sure that you haveenough disk space on the computer or server on which Tivoli Netcool PerformanceManager is installed.

The amount of space that is required depends on the following:v Size of the SAM networkv Values that are set for the following retention parameters in the dc.cfg file:

Platform Parameter


FC_RETENTION_HOURS

It is possible, in a SAM networking environment, that several gigabytes worth ofdata files might be collected and transferred to the UBA application donedirectory each day. These data files accumulate according to the values specifiedfor the retention parameters. Therefore, it is possible to use the maximum diskspace before the retention period expires and the DataChannel deletes the datafiles from the done directory.You must monitor the size of the data files that are transferred to the donedirectory during metric collection, and determine whether adjustments must bemade to the retention parameters.

SAM server software hangs:

When the SAM server software hangs, no inventory files are transferred to thedefault directory on the SAM server.

If the SAM server software hangs, make sure that you imported the Alcatel-Lucent5620 SAM Technology Pack predefined collection requests. For more information,see the Active data collection requests step in “Configuring UBA technology packs”on page 3.


Binary files acquired instead of text files:

If a BLB or UBA application that is expecting text input acquires binary files, thereis a risk of corrupting the persistent state of the BLB or UBA application. Thiscorruption might cause errors to occur when the BLB or UBA application restarts,or later when it runs.

Although such a BLB or UBA application is unlikely to acquire binary files insteadof text files, this situation might happen in either of the following circumstances:v The URIs are inadvertently altered to pick up bad files.v The file becomes corrupted.

To avoid the risk of corrupting the persistent state of the BLB or UBA application,make sure that the BLB or UBA application that is expecting text input is neverallowed to acquire binary files. There is no workaround to this issue. If thissituation occurs, contact IBM Professional Services.

Alcatel-Lucent 5670 RAM Technology PackAdditional configuration steps that are required for Alcatel-Lucent 5670 RAMTechnology Pack.

Overview of Alcatel-Lucent 5670 RAM Technology PackAlcatel-Lucent 5670 RAM Technology Pack is bundled with ramAdaptor andsamInventory tools.

You must configure the “samInventory” on page 193 and “ramAdaptor” on page194.

Alcatel-Lucent 5620 SAM Technology Pack version 2.10.0.0 or later is thedependent pack and this pack must be installed and the SAM inventory isrunning.

The Alcatel-Lucent 5670 RAM Technology Pack data flow is as shown in thefollowing diagram:

1. ramAdaptor SFTP xdr files from the RAM server.


2. ramAdaptor converts the xdr file from binary format to text format.3. ramAdaptor distributes the xdr text files to multiple directories.4. UBA collectors pick up the xdr text files from ramAdaptor directory and

process the files.5. UBA collectors pick up the csv file that is generated by samInventory. The

content of the csv file is obtained from the Alcatel-Lucent 5620 SAMTechnology Pack resource properties during inventory and the values areassigned to the Alcatel-Lucent 5670 RAM Technology Pack resource properties.

Bulk input file formats in Alcatel-Lucent 5670 RAM TechnologyPack

There are many formats associated with Bulk input files, for example CSV, XML,and binary. Typically, a technology pack provides a Bulk Adaptor Design File(implemented as a JavaScript file) that defines the format or formats of the Bulkinput files for which it is responsible for processing. This Bulk Adaptor Design Fileprocesses both inventory and statistics from the same Bulk input file. Morespecifically, this Bulk Adaptor Design File provides a function that creates the Bulkcollection formula names. Some technology packs might provide several BulkAdaptor Design Files each of which handles a specific Bulk input file format.

Alcatel-Lucent 5670 RAM devices produce xdr files that are named by using thefollowing syntax:<statistics types>_N<IP>_D<file_inteval>_T<unix_timestamp>_V<version>.xdr

For example: AA_AP__N192.168.0.1__D15__T1325394000000__V2.xdr

Configuring the RAM serverRAM server must be configured.

Procedure1. Configure an SFTP user account for Tivoli Netcool Performance Manager

Wireline to access RAM server at the operating system level.2. Follow steps 6 - 16 in RAM Administration Guide to run the Convert Stats

Files Operation.3. Configure the following parameters:

Configuration Parameter Value Description

Output File Location <XDR file output directory> This directory must exist inRAM server. It must beaccessible by both the RAMuser and also the SFTP useraccount that is used by TivoliNetcool PerformanceManager Wireline.

Compress File (zip) Disabled Tivoli Netcool PerformanceManager wireline only workwith uncompress IPDR files(with xdr extension).

File Retention (Hour) <The file retention hours> The retention duration inhours.

4. Select the following statistics types that are currently supported by TivoliNetcool Performance Manager technology pack


Statistics typeGrouping in Tivoli NetcoolPerformance Manager Filename pattern

Router/Application Group By Router AA_AG__*.xdr

Router/Protocol AA_PR__*.xdr

Router/Application AA_AP__*.xdr

Subscriber/ApplicationGroup

By Subscriber AA_SUBAG__*.xdr

AA_SUBPAG__*.xdr

Subscriber/Protocol AA_SUBPR__*.xdr

AA_SUBPPR_*.xdr

Special Study -Subscriber/Protocol

AA_SUBPRS__*.xdr

AA_SUBPAP__*.xdr

Subscriber/Application AA_SUBAP__*.xdr

Special Study -Subscriber/Application

AA_SUBAPS__*.xdr

TCP/Subscriber/AppGroup AA_TSUBAG__*.xdr

TCP/Subscriber/App AA_TSUBAP__*.xdr

TCP SpecialStudy/Subscriber/App

AA_TSUBAPS__*.xdr

Volume/Subscriber/AppGroup

AA_VSUBAG__*.xdr

Volume/Subscriber/App AA_VSUBAP__*.xdr

Voice/Subscriber/App AA_VOSUBAP__*.xdr

Audio/Subscriber/App AA_AUSUBAP__*.xdr

Video/Subscriber/App AA_VISUBAP__*.xdr

Unknown/Subscriber/App AA_USUBAP__*.xdr

Aggregation/Subscriber AA_SUBGR__*.xdr

Charging Group/Subscriber AA_SUBCG__*.xdr



SAP/Application Group By SAP AA_SAPAG__*.xdr

SAP/Protocol AA_SAPPR__*.xdr

Special Study - SAP/Protocol AA_SAPPRS__*.xdr

SAP/Application AA_SAPAP__*.xdr

Special Study -SAP/Application

AA_SAPAPS__*.xdr

TCP/SAP/AppGroup AA_TSAPAG__*.xdr

TCP/SAP/App AA_TSAPAP__*.xdr

TCP SpecialStudy/SAP/App

AA_TSAPAPS__*.xdr

Volume/SAP/AppGroup AA_VSAPAG__*.xdr

Volume/SAP/App AA_VSAPAP__*.xdr

Voice/SAP/App AA_VOSAPAP__*.xdr

Audio/SAP/App AA_AUSAPAP__*.xdr

Video/SAP/App AA_VISAPAP__*.xdr

Unknown/SAP/App AA_USAPAP__*.xdr

Aggregation/SAP AA_SAPGR__*.xdr

Charging Group/SAP AA_SAPCG__*.xdr

SDP Binding/ApplicationGroup

By SDP Binding AA_SBAG__*.xdr

SDP Binding/Protocol AA_SBPR__*.xdr

Special Study - SDPBinding/Protocol

AA_SBPRS__*.xdr

SDP Binding/Application AA_SBAP__*.xdr

Special Study - SDPBinding/Application

AA_SBAPS__*.xdr

TCP/SDPBinding/AppGroup

AA_TSBAG__*.xdr

TCP/SDP Binding/App AA_TSBAP__*.xdr

TCP Special Study/SDPBinding/App

AA_TSBAPS__*.xdr

Volume/SDPBinding/AppGroup

AA_VSBAG__*.xdr

Volume/SDP Binding/App AA_VSBAP__*.xdr

Voice/SDP Binding/App AA_VOSBAP__*.xdr

Audio/SDP Binding/App AA_AUSBAP__*.xdr

Video/SDP Binding/App AA_VISBAP__*.xdr

Unknown/SDPBinding/App

AA_USBAP__*.xdr

Aggregation/SDP Binding AA_SBGR__*.xdr

Charging Group/SDPBinding

AA_SBCG__*.xdr



Transit Sub/ApplicationGroup

By Transit Sub AA_TRAG__*.xdr

AA_TRPAG__*.xdr

Transit Sub/Protocol AA_TRPR__*.xdr

AA_TRPPR_*.xdr

Special Study - TransitSub/Protocol

AA_TRPRS__*.xdr

Transit Sub/Application AA_TRAP__*.xdr

AA_TRPAP__*.xdr

Special Study - TransitSub/Application

AA_TRAPS__*.xdr

TCP/Transit Sub/AppGroup AA_TTRAG__*.xdr

TCP/Transit Sub/App AA_TTRAP__*.xdr

TCP Special Study/TransitSub/App

AA_TTRAPS__*.xdr

Volume/TransitSub/AppGroup

AA_VTRAG__*.xdr

Volume/Transit Sub/App AA_VTRAP__*.xdr

Voice/Transit Sub/App AA_VOTRAP__*.xdr

Audio/Transit Sub/App AA_AUTRAP__*.xdr

Video/Transit Sub/App AA_VITRAP__*.xdr

Unknown/Transit Sub/App AA_UTRAP__*.xdr

Aggregation/Transit Sub AA_TRGR__*.xdr

Charging Group/Transit Sub AA_TRCG__*.xdr



Business TransitSub/Application Group

By Business Transit Sub AA_TBAG__*.xdr

Business TransitSub/Protocol

AA_TBPR__*.xdr

Special Study - BusinessTransit Sub/Protocol

AA_TBPRS__*.xdr

Business TransitSub/Application

AA_TBAP__*.xdr

Special Study - BusinessTransit Sub/Application

AA_TBAPS__*.xdr

TCP/Business TransitSub/AppGroup

AA_TTBAG__*.xdr

TCP/Business TransitSub/App

AA_TTBAP__*.xdr

TCP Special Study/BusinessTransit Sub/App

AA_TTBAPS__*.xdr

Volume/Business TransitSub/AppGroup

AA_VTBAG__*.xdr

Volume/Business TransitSub/App

AA_VTBAP__*.xdr

Voice/Business TransitSub/App

AA_VOTBAP__*.xdr

Audio/Business TransitSub/App

AA_AUTBAP__*.xdr

Video/Business TransitSub/App

AA_VITBAP__*.xdr

Unknown/Business TransitSub/App

AA_UTBAP__*.xdr

Aggregation/Business TransitSub

AA_TBGR__*.xdr

Charging Group/BusinessTransit Sub

AA_TBCG__*.xdr

5. Set the SAM server to generate the xdr file in 15-minute interval, which is thedefault interval that is used in Alcatel-Lucent 5670 RAM Technology Pack.

samInventoryThe sam_inventory.sh script is developed to export SAP inventories that arediscovered by Alcatel-Lucent 5620 SAM Technology Pack into a SAM inventorycsv file by using resmgr command. The exported SAP inventory in SAM inventorycsv file is then consumed by Alcatel-Lucent 5670 RAM Technology Pack UBA topopulate values for ramSubscriberName, ramServiceName, and ramServiceTypeproperties for SAP-related inventories that are discovered in Alcatel-Lucent 5670RAM Technology Pack.

The SAM inventory csv file has the following naming convention:sam_inventory_<YYYY-MM-HH-hh-mm>.csv

The interval to trigger the sam_inventory.sh script must be same as interval for thegenerated RAM raw files.


Configuring samInventory:

Before you begin

Ensure that you do the following:1. The sam_inventory.sh script must be deployed on the server where DataMart

is installed.2. Alcatel-Lucent 5620 SAM Technology Pack version 2.10.0.0 or above is installed

and running.3. All SAP inventories are discovered by Alcatel-Lucent 5620 SAM Technology

Pack.

Procedure

1. Untar the samInventory.tar file on the server that is running DataMart byusing the following command:

Note: The samInventory.tar file is included in the technology pack JAR file.After the pack is installed, you can find the samInventory.tar file in thefollowing directory:<$PVMHOME>/APFiles/alcatel_5670_ram/ramAdaptor

tar -xvf samInventory.tar

2. Edit the sam_inventory.sh and update the OUTPUT_DIR value to the directorywhere the generated SAM inventory file is placed.

3. The sam_inventory.sh script outputs the inventory by using the resmgrcommand into a csv file and append the timestamp as part of the filename.This timestamp must have the same interval as the RAM raw file timestamp.By default, the generated timestamp follows the timezone that is configured inthe server (TZ parameter. To overwrite the server timezone, follow these steps:a. Uncomment the following lines in the sam_inventory.sh script.

#TZ="UTC"#export TZ

b. Update the TZ parameter value to the desired timezone.

Note: It is recommended to set to the same timezone that RAM server usedto generate the xdr file timestamp.

4. Configure the crontab to execute the sam_inventory.sh script in interval. Thisinterval must be the same interval as for the generated RAM raw files. For15-minutes interval, the crontab entry is as follows:

0,15,30,45 * * * * . /opt/datamart/dataMart.env &&/export/home/pvuser/samInventory/sam_inventory.sh# Make sure to create a crontab entry to cleanup the output dir59 * * * * rm <Directory to put the csv files>/*.csv

Note: If the incoming RAM raw data files are of different time intervals, theneach different time interval must have a corresponding sam_inventory.csv fileof the same interval.

ramAdaptorThe ramAdaptor is developed as a pre-mediation tool to handle xdr file formatthat is generated by the Alcatel-Lucent 5670 Reporting and Analysis Manager(RAM) Technology Pack.

Before passing the converted xdr file to Tivoli Netcool Performance ManagerWireline UBA collector, the ramAdaptor performs the following tasks:


1. SFTP the binary xdr files from Alcatel-Lucent 5670 Reporting and AnalysisManager (RAM).

2. Converts the xdr file, which is in binary format into text file. The text file is theoutput of the ramAdaptor with the filename that ends with xdr.txt.

3. Load balances all the text files that are converted from xdr files to therespective directory to be picked up by multiple UBAs.

4. UBA collectors pick up the xdr text file from the ramAdaptor directory andprocess the file.

ramAdaptor directory layout:

Table 16. Directory layout

Directory/File Description

ramAdaptor.sh The main scripts to start and stop the ramAdaptor.

adaptor.properties Configuration file for the ramAdaptor.

history/ Directory to store the processed binary xdr file fortroubleshooting purpose. In normal scenario, it must be empty.

unmatched/ Directory to store the converted xdr text file that does notmatch any of the file name pattern inUBA.X.X.FILENAME_REGEX. In normal scenario, it must beempty.

lib/ Library folder that contains all the Java libraries that theramAdaptor needed.

log/adaptor.log Log file for the ramAdaptor.

temp/ Working directory for the ramAdaptor.

temp/do/ Directory to store the binary xdr sftp from the RAM server.

temp/done/ Directory to store the converted xdr files.

uba/ Input directory for different UBA, user must create therespective directory that is based on the UBA created.

.registry Directory that is created by the ramAdaptor to storeramAdaptor related data when running. Do not delete thisdirectory.

.lock An empty file that is created by the ramAdaptor to ensureonly 1 instance of the ramAdaptor is running. This file isremoved when the ramAdaptor is stopped.

.hist A file that is created by the ramAdaptor to store all theprocessed file name so that the ramAdaptor does not pick upthe same file again. Any file name with timestamp older thanthe configuredADAPTOR_BACKLOG_RETENTION_MINUTES is removedfrom this file to maintain the file size.

Starting and stopping the ramAdaptor:

The ramAdaptor.sh script is used to start and stop the ramAdaptor. TheramAdaptor creates a .lock file when it starts. To remove the .lock file, stop theramAdaptor.

Before you begin

Ensure that you performed the following tasks:


v The JAVA_HOME environment variable must be set. The supported Java versionsare 1.5 and greater.

v Untar the ramAdaptor.tar file on the server that is running DataMart by usingthe following command:tar -xvf ramAdaptor.tar

Note: The ramAdaptor.tar file is included in the technology pack JAR file. Afterthe pack is installed, you can find the samInventory.tar file in the followingdirectory:<$PVMHOME>/APFiles/alcatel_5670_ram/ramAdaptor

v These configuration parameters that are found in the adaptor.properties filemust be reviewed and configured before you start the ramAdaptor:– ADAPTOR_RAM_SERVER– ADAPTOR_RAM_PORT– ADAPTOR_RAM_USERNAME– ADAPTOR_RAM_PASSWORD– ADAPTOR_RAM_REMOTE_DIR– UBA_LIST– UBA.X.X.INPUT_DIRECTORY– UBA.X.X.FILENAME_REGEX

Note: Manually create all the directories that are defined in theUBA.X.X.INPUT_DIRECTORY.

For more information, see “The adaptor.properties file”

Procedure

v To start the ramAdaptor, follow these steps:1. Export the JAVA_HOME by giving the following command:

export JAVA_HOME=/usr/java

Note: If JAVA_HOME is not set correctly, you must run this step.2. Locate the ramAdaptor.sh file.3. Start the ramAdaptor by starting the ramAdaptor.sh script by using the

following command:ramAdaptor.sh start

v To stop the ramAdaptor, follow these steps:1. Export the JAVA_HOME by using the following command:

export JAVA_HOME=/usr/java

Note: If JAVA_HOME is not set correctly, you must run this step.2. Locate the ramAdaptor.sh file.3. Stop the ramAdaptor by stopping the ramAdaptor.sh script by using the

following command:ramAdaptor.sh stop

The adaptor.properties file:

The adaptor.properties file is the ramAdaptor configuration file. This file must bereviewed and edited before you start the ramAdaptor.


Property Default value Description

ADAPTOR_SLEEP_INTERVAL_SECONDS120 How frequently theramAdaptor to poll theRAM server for new files.Value is in seconds.

ADAPTOR_BACKLOG_RETENTION_MINUTES60 The backlog retentionperiod in minutes. TheramAdaptor does not pickup files that are olderthan the (current time -retention). Try not to setthis value too largebecause it causes the.hist file size to grow.

ADAPTOR_LOG_FILE_LEVEL Info The logging level. Possiblevalues are (in descendingorder, starting fromhighest log level): ALL,TRACE, DEBUG, INFO,WARN, and ERROR

ADAPTOR_LOG_FILE_SIZE_LIMIT 100 KB The maximum file size forthe log file.

ADAPTOR_LOG_FILE_BACKUP_LIMIT2 Number of back up logfiles to keep when theoriginal log file exceedstheADAPTOR_LOG_FILE_SIZE_LIMIT.

ADAPTOR_WORKING_DIRECTORY ./temp/ The working directory forthe ramAdaptor, theremust be a do and donedirectories inside thisdirectory.

ADAPTOR_RAM_SERVER x.x.x.x The IP address or hostname for the RAM server.

ADAPTOR_RAM_PORT 22 The SFTP port for RAMserver. Default SFTP portis 22.

ADAPTOR_RAM_USERNAME xxx The SFTP user name usefor RAM server.

ADAPTOR_RAM_PASSWORD xxx The SFTP password usefor RAM server.

ADAPTOR_RAM_REMOTE_DIR /export/home/pvuser/xdr/ The directory in the RAMserver where the xdr filesare stored.



ADAPTOR_RAM_FILENAME_REGEX ÂA_(AG|AP|PR|SUBAG|SUBPAG|SUBAP|SUBPAP|SUBCG|SUBGR|SUBAPS|SUBPR|SUBPPR|SUBPRS|TSUBAG|TSUBAP|TSUBAPS|VSUBAG|VSUBAP|VOSUBAP|AUSUBAP|VISUBAP|USUBAP|SAPAG|SAPCG|SAPGR|TSAPAG|VSAPAG|SAPPR|SAPPRS|SAPAP|SAPAPS|TSAPAP|TSAPAPS|VSAPAP|VOSAPAP|AUSAPAP|VISAPAP|USAPAP|SBAG|SBCG|SBGR|SBPR|SBPRS|SBAP|SBAPS|TSBAG|TSBAP|TSBAPS|VSBAG|VSBAP|VISBAP|AUSBAP|VOSBAP|USBAP|TRAG|TRPAG|TRCG|TRGR|TRPR|TRPPR|TRPRS|TRAP|TRPAP|TRAPS|TTRAG|TTRAP|TTRAPS|VTRAG|VTRAP|VITRAP|AUTRAP|VOTRAP|UTRAP|TBAG|TBCG|TBGR|TBPR|TBPRS|TBAP|TBAPS|TTBAG|TTBAP|TTBAPS|VTBAG|VTBAP|VITBAP|AUTBAP|VOTBAP|UTBAP)__.*\\.xdr$

The file name pattern forthe xdr files. It is in Javaregular expression format.

ADAPTOR_RAM_DELETE_ON_ACQUIREDTrue Flag to indicate whetherto remove the xdr files inRAM server after SFTP tolocal Tivoli NetcoolPerformance Managerserver.

ADAPTOR_RAM_KEEP_XDR_FILE False Flag to indicate whetherto keep a copy of thebinary XDR file in folderspecified inADAPTOR_RAM_KEEP_XDR_DIR.Make sure that there isproper housekeepingwhen this flag is turnedon.

ADAPTOR_RAM_KEEP_XDR_DIR ./history/ Directory to store thebinary xdr files afteracquired from RAMserver whenADAPTOR_RAM_KEEP_XDR_FILEflag set to true.

ADAPTOR_RAM_UNMATCHED_DIR ./unmatched/ Directory to store theconverted xdr text file thatdoes not match any of thefile name pattern inUBA.X.X.FILENAME_REGEX.In normal scenario, itmust be empty.



ADAPTOR_RAM_SFTP_FILESIZE_CHECK_INTERVAL_MS

500 If the XDR file is stillbeing processed by theRAM server, the file sizeof the respective XDR filesize is increasing. Whenthe ramAdaptor detectssuch an event, it waits fora certain duration andrevalidate the file size. Ifthere is no longer anyincreasing of the file size,it transfers the XDR file.This configuration allowsuser to define theduration wait beforerevalidate the file size inmilliseconds.

ADAPTOR_RAM_SFTP_FILESIZE_CHECK_RETRY_COUNT

10 If the XDR file is stillbeing processed by theRAM server, the file sizeof the respective XDR filesize is increasing. Whenthe ramAdaptor detectssuch event, it waits for acertain duration andrevalidate the file size. Ifthere is no longer anyincreasing of the file size,it transfers the XDR file.This configuration allowsyou to define the numberof maximum retries thatramAdaptor revalidatesthe file size before ittransfers the XDR file.

UBA_LIST UBA.1.10, UBA.1.20, UBA.1.30,UBA.1.40, UBA.1.50, UBA.1.60

List of UBA collectors thatare configured for RAMseparated by comma.Restriction: In the TivoliNetcool PerformanceManager 1.3.1, in theTopology Editor, a newCME Collector must benumbered 1 - 498.



UBA.X.X.INPUT_DIRECTORY ./uba/10 (For UBA.1.10)- OR -./uba/20 (For UBA.1.20)- OR -./uba/30 (For UBA.1.30)- OR -./uba/40 (For UBA.1.40)- OR -./uba/50 (For UBA.1.50)- OR -./uba/60 (For UBA.1.60)

The directory where theoutput text files are goingto be placed for therespective UBA to pick upfrom. These output textfiles are converted fromxdr files, as mention inthe overview. Ensure thatyou have the samenumber of key-value pairsthat correspond to thenumber of UBAs definedin the UBA_LIST. Theformat of the key-valuepair is as follows:

UBA.X.X.INPUT_DIRECTORY=xxxxxx

For example:

UBA.1.10.INPUT_DIRECTORY=./uba/10

UBA.1.20.INPUT_DIRECTORY=./uba/20

Note: You must manuallycreate directory that isspecified in thisconfiguration.Restriction: In the TivoliNetcool PerformanceManager 1.3.1, in theTopology Editor, a newCME Collector must benumbered 1 - 498.



UBA.X.X.FILENAME_REGEX # for By Router Group(AA_AG, AA_AP, AA_PR)UBA.1.10.INPUT_DIRECTORY=./uba/10/UBA.1.10.FILENAME_REGEX=ÂA_(AG|AP|PR)__.*\\.xdr\\.txt

# for By Subscriber Group(AA_SUBAG, AA_SUBAP, AA_SUBCG,AA_SUBPAG,AA_SUBPAP,AA_SUBPPR,AA_SUBGR, AA_SUBAPS, AA_SUBPR,AA_SUBPRS, AA_TSUBAG, AA_TSUBAP,AA_TSUBAPS, AA_VSUBAG, AA_VSUBAP,AA_VOSUBAP, AA_AUSUBAP, AA_VISUBAP,AA_USUBAP)UBA.1.20.INPUT_DIRECTORY=./uba/20/ÂA_(SUBAG|SUBPAG|SUBAP|SUBPAP|SUBCG|SUBGR|SUBAPS|SUBPR|SUBPPR|SUBPRS|TSUBAG|TSUBAP|TSUBAPS|VSUBAG|VSUBAP|VOSUBAP|AUSUBAP|VISUBAP|USUBAP)__.*\\.xdr\\.txt

# for By SAP Group(AA_SAPAG, AA_SAPCG, AA_SAPGR,AA_TSAPAG, AA_VSAPAG, AA_SAPPR,AA_SAPPRS, AA_SAPAP, AA_SAPAPS,AA_TSAPAP, AA_TSAPAPS,AA_VSAPAP, AA_VOSAPAP,AA_AUSAPAP, AA_VISAPAP,AA_USAPAP)UBA.1.30.INPUT_DIRECTORY=./uba/30/UBA.1.30.FILENAME_REGEX=ÂA_(SAPAG|SAPCG|SAPGR|TSAPAG|VSAPAG|SAPPR|SAPPRS|SAPAP|SAPAPS|TSAPAP|TSAPAPS|VSAPAP|VOSAPAP|AUSAPAP|VISAPAP|USAPAP)__.*\\.xdr\\.txt

# for By SDP Binding Group(AA_SBAG, AA_SBCG, AA_SBGR,AA_SBPR, AA_SBPRS, AA_SBAP,AA_SBAPS, AA_TSBAG, AA_TSBAP,AA_TSBAPS, AA_VSBAG, AA_VSBAP,AA_VISBAP, AA_AUSBAP,AA_VOSBAP, AA_USBAP)UBA.1.40.INPUT_DIRECTORY=./uba/40/UBA.1.40.FILENAME_REGEX=ÂA_(SBAG|SBCG|SBGR|SBPR|SBPRS|SBAP|SBAPS|TSBAG|TSBAP|TSBAPS|VSBAG|VSBAP|VISBAP|AUSBAP|VOSBAP|USBAP)__.*\\.xdr\\.txt

The file name pattern inJava regular expression toidentify the text files thatthe respective UBA isprocessed. Ensure thatyou have the samenumber of key-value pairsthat correspond to thenumber of UBAs definedin the UBA_LIST. Theformat of the key-valuepair is as follows:

UBA.X.X.FILENAME_REGEX=xxxxxx

For example:

UBA.1.10.FILENAME_REGEX=ÂA_(AG|AP|PR)__.*\\.xdr\\.txtUBA.1.20.FILENAME_REGEX=ÂA_(SUBAG|SUBAP|SUBAPS|SUBPR|SUBPRS|TSUBAG|TSUBAP|VSUBAG|VSUBAP|VOSUBAP|AUSUBAP|VISUBAP)__.*\\.xdr\\.txtUBA.1.30.FILENAME_REGEX=ÂA_(SAPAG|TSAPAG|VSAPAG|SAPPR|SAPPRS|SAPAP|SAPAPS|TSAPAP|VSAPAP|VOSAPAP|AUSAPAP|VISAPAP)__.*\\.xdr\\.txtUBA.1.40.FILENAME_REGEX=ÂA_(SBAG|SBPR|SBPRS|SBAP|SBAPS|TSBAG|TSBAP|VSBAG|VSBAP|VISBAP|AUSBAP|VOSBAP)__.*\\.xdr\\.txtUBA.1.50.FILENAME_REGEX=ÂA_(TRAG|TRPR|TRPRS|TRAP|TRAPS|TTRAG|TTRAP|VTRAG|VTRAP|VITRAP|AUTRAP|VOTRAP)__.*\\.xdr\\.txtUBA.1.60.FILENAME_REGEX=ÂA_(TBAG|TBPR|TBPRS|TBAP|TBAPS|TTBAG|TTBAP|VTBAG|VTBAP|VITBAP|AUTBAP|VOTBAP)__.*\\.xdr\\.txt



# for By Transit Sub Group(AA_TRAG,AA_TRPAG,AA_TRPAP,AA_TRPPR, AA_TRCG, AA_TRGR,AA_TRPR, AA_TRPRS, AA_TRAP,

AA_TRAPS, AA_TTRAG, AA_TTRAP,AA_TTRAPS, AA_VTRAG, AA_VTRAP,AA_VITRAP, AA_AUTRAP,AA_VOTRAP, AA_UTRAP)UBA.1.50.INPUT_DIRECTORY=./uba/50/ÂA_(TRAG|TRPAG|TRPAP|TRPPR|TRCG|TRGR|TRPR|TRPRS|TRAP|TRAPS|TTRAG|TTRAP|TTRAPS|VTRAG|VTRAP|VITRAP|AUTRAP|VOTRAP|UTRAP)__.*\\.xdr\\.txt

# for By Business Transit Sub Group(AA_TBAG, AA_TBCG, AA_TBGR,AA_TBPR, AA_TBPRS, AA_TBAP,AA_TBAPS, AA_TTBAG, AA_TTBAP,AA_TTBAGS, AA_VTBAG, AA_VTBAP,AA_VITBAP, AA_AUTBAP,AA_VOTBAP, AA_UTBAP)UBA.1.60.INPUT_DIRECTORY=./uba/60/UBA.1.60.FILENAME_REGEX=ÂA_(TBAG|TBCG|TBGR|TBPR|TBPRS|TBAP|TBAPS|TTBAG|TTBAP|TTBAPS|VTBAG|VTBAP|VITBAP|AUTBAP|VOTBAP|UTBAP)__.*\\.xdr\\.txt

Cisco IP Telephony Technology PackIn this section, you will learn about the additional configuration steps that arerequired for the Cisco IP Telephony Technology Pack.

Running the adaptor script and configuring the log4j.propertiesfileAfter you install the Cisco IP Telephony technology pack 2.5.0.0, you run theremaining script files that also include the adaptor script file.

When you run the adaptor script file, the following message is displayed:Do you want to override the systime to UTC? (y/n).

If you press N, the adaptor starts in the default time zone. The default time zoneuses the current system time zone.

In the Cisco IP Telephony technology pack 2.5.0.0, the log4j functionality is added.You can use this functionality to configure log settings in the log4j.propertiesfile. You can direct log messages to a log file and specify the size of a log file.During the installation, you must modify the log4j.appender.file.File parameterin thelog4j.properties file to specify the location of the adaptor log file. It isrecommended to specify the location where the adaptor JAR file is stored.Depending upon the requirements, you can modify other parameters or keep themunchanged.


GenBand C20 Converged IP Softswitch Technology PackAdditional configuration steps that are required for GenBand C20 Converged IPSoftswitch Technology Pack.

New bulk input file formats introduced in GenBand C20Converged IP Softswitch Technology PackThe GenBand C20 Converged IP Softswitch devices gather performance data andother statistics from multiple network elements. This data is referred to collectivelyas network health metrics. Each GenBand C20 Converged IP Softswitch deviceproduces, on a specified regular basis, a bulk input file that contains the networkhealth metrics and other information.

Many formats are associated with Bulk input files, for example CSV, XML, andbinary. Typically, a technology pack provides a Bulk Adaptor Design File(implemented as a JavaScript file) that defines the format or formats of the Bulkinput files for which it is responsible for processing. This Bulk Adaptor Design Fileprocesses both inventory and statistics from the same Bulk input file. Morespecifically, this Bulk Adaptor Design File provides a function that creates the Bulkcollection formula names. Some technology packs might provide several BulkAdaptor Design Files each of which handles a specific Bulk input file format.

This bulk input file is a comma-separated values (csv) file. All the input files arecollected for a time interval and all the records within the files are sorted andprocessed every minute.

The GenBand C20 Converged IP Softswitch Technology Pack supports multipleinput files per UBA, where each input file contains data for one polling periodonly.

The syntax for these bulk input files is explained in “New bulk input file schema”on page 205.

The GenBand C20 Converged IP Softswitch Technology Pack provides files thatinterpret these bulk input files. For more information, see Bulk Adaptor Design Filesin GenBand C20 Converged IP Softswitch 2.6.0.0 Technology Pack Reference.

New bulk input file names:

The two new bulk input files that are introduced in GenBand C20 Converged IPSoftswitch 2.6.0.0 Technology Pack are for MAS and A2 devices.

GenBand C20 Converged IP Softswitch devices produce csv files that are named byusing the following syntax:<hostname>_<yyyy-MM-dd-HH-mm-ss-msmsms>_<File_collection_type>

where:v <hostname>: specifies the name of the device from which the data was collected.v The date format is as follows: yyyy-MM-dd-HH-mm-ss-msmsms

where:– yyyy: specifies a four-digit integer (for example, 2012) that identifies the year

in which the GenBand C20 Converged IP Softswitch Technology Packproduced the csv file.


– MM: specifies a two-digit integer (for example, 10) that identifies the monthin which the GenBand C20 Converged IP Softswitch Technology Packproduced the csv file.

– dd: specifies a two-digit integer (for example, 13) that identifies the day inwhich the GenBand C20 Converged IP Softswitch Technology Pack producedthe csv file.

– HH: specifies a two-digit integer (for example, 13) that identifies the metrichour in which the GenBand C20 Converged IP Softswitch Technology Packproduced the csv file.

– mm: specifies a two-digit integer (for example, 13) that identifies the minutesafter the metric hour in which the GenBand C20 Converged IP SoftswitchTechnology Pack produced the csv file.

– ss: specifies a two-digit integer (for example, 13) that identifies the secondsafter the metric hour in which the GenBand C20 Converged IP SoftswitchTechnology Pack produced the csv file.

– msmsms: specifies a three-digit integer (for example, 133) that identifies themilliseconds after the metric hour in which the GenBand C20 Converged IPSoftswitch Technology Pack produced the csv file.

– <File_collection_type>: specifies the file collection type.v csv specifies a file extension of csv, which indicates it is a csv file type.

The following list shows examples of the csv file names:v EMS1_2012-03-14-04-00-00-000_OTP_csv.closed

v SESS2_2012-03-14-04-00-00-000_OTP_csv.closed

Note: For MAS device, the input file naming structure is different. For example:HT1ANNMOH.edtnab02ca2_2012-03-14_04-00-00_Perf.csv

<hostname>_<yyyy-mm-dd_HH-MM-ss>_<File_collection_type>

v <hostname>: specifies the name of the device from which the data was collected.v yyyy: specifies a four-digit integer (for example, 2012) that identifies the year in

which the GenBand C20 Converged IP Softswitch Technology Pack produced thecsv file.

v MM: specifies a two-digit integer (for example, 10) that identifies the month inwhich the GenBand C20 Converged IP Softswitch Technology Pack produced thecsv file.

v dd: specifies a two-digit integer (for example, 13) that identifies the day in whichthe GenBand C20 Converged IP Softswitch Technology Pack produced the csvfile.

v HH: specifies a two-digit integer (for example, 13) that identifies the metric hourin which the GenBand C20 Converged IP Softswitch Technology Pack producedthe csv file.

v mm: specifies a two-digit integer (for example, 13) that identifies the minutesafter the metric hour in which the GenBand C20 Converged IP SoftswitchTechnology Pack produced the csv file.

v ss: specifies a two-digit integer (for example, 13) that identifies the seconds afterthe metric hour in which the GenBand C20 Converged IP Softswitch TechnologyPack produced the csv file.

v <File_collection_type>: specifies the file collection type.


New bulk input file schema:

Bulk input file schema for Genband C20 MAS and Genband C20 A2 devices aredescribed here.

The syntax of a csv file that is produced by GenBand C20 Converged IP SoftswitchTechnology Pack MAS device is as follows:2012-03-14 04:00:00,HT1ANNMOH,edtnab02ca2,InboundCalls,282,65,773,1800

The CSV file contains the following fields:v Timestamp: specifies UTC timestamp.v Hostname: specifies the hostname.v OM group: specifies the Operational Management (OM) group. An OM group

collects performance data that is exported to the input files.v Value: specifies the average value for the metric.v Low: specifies the minimum value for the metric.v High: specifies the maximum value for the metricv IntervalSec: specifies the number of seconds between two generated input files.

The syntax of a csv file that is produced by GenBand C20 Converged IP SoftswitchTechnology Pack A2 device is as follows:03-14-2012,04:00:09,EMS1,ServerCpuAndMemory,Summary Row,minCpuOccupancyValue,5,medianCpuOccupancyValue,14,maxCpuOccupancyValue,92,totalRam,1693111660,minRamUtilizationValue,20,medianRamUtilizationValue,40,maxRamUtilizationValue,79,totalSwap,2291697004,minSwapUtilizationValue,45,medianSwapUtilizationValue,29,maxSwapUtilizationValue,83

v Timestamp: specifies UTC timestamp.v Subelement: specifies subelement names (EMS, SESS, or SESM device).v OM group: specifies the Operational Management group. An OM group collects

performance data that is exported to the input files.v Instances: specifies instances of the OM group.v Metric names: specifies all the metric names.v Metric values: specifies the values that are used for the metrics.

Note: The directory path of input files for MAS and A2 device must be as follows:A2_<site_name>/EMS_<component_name>/<filename>A2_<site_name>/SESS_<component_name>/<filename>A2_<site_name>/SESM_<component_name>/<filename>A2_<site_name>/MAS_<component_name>/<filename>

Configuring certain scripts for Genband C20 devicesDescribes the configuration steps that are required for certain Genband C20 scripts.

You must configure the following script files for Genband C20 devices:v PVGConfig.jsv CS2KPERFConfig.jsv USPConfig.jsv cs2kcdr.plv cs2kcdr-config.pl

These scripts must be configured after “Configuring UBA technology packs” onpage 3 of “Configuring UBA technology packs” on page 3


Configuring the PVGConfig.js script:

Describes the steps required for the PVGConfig.js script for Genband C20 PVGdevice.

Procedure

Set the Element Name Source for the Genband C20 PVG device in thePVGConfig.js file.Before the Technology Pack can create the Element name for the Genband C20PVG device, the source for the element name must be identified in thePVGConfig.js file. To configure the PVGConfig.js design file, follow these steps:1. On the DataChannel server, change your working directory to the

DATA_CHANNEL_HOME/scripts directory by entering the following command,replacing DATA_CHANNEL_HOME with the DataChannel home directory(/opt/datachannel, by default):cd DATA_CHANNEL_HOME/scripts

2. Make a backup copy of the PVGConfig.js design file, by entering the followingcommand:cp PVGConfig.js PVGConfig.js.ORIG

3. In a text editor, open the PVGConfig.js design file for editing.4. Specify the source of the element name for the Passport Packet Voice Gateway

(PVG) by uncommenting one of the following options:v FILE - Specifies that the source for the element name is a PVG Bulk input

file. The default option is to specify the filename by using the FILE option.See Genband C20 PVG Performance Data on page 152 for an explanation ofthe syntax that the PVG Bulk input files use.

v LINKID - Specifies that the source for the element name is the LINKIDrecord that resides in a PVG Bulk input file.

v OFFICEID - Specifies that the source for the element name is the OFFICEIDrecord that resides in a PVG Bulk input file.

The following example shows the selection of the FILE option:

//// $Id: PVGConfig.js 1346 2007-07-11 23:23:26Z wmartin $//setPVGElementName("FILE");// setPVGElementName("LINKID")// setPVGElementName("OFFICEID")

Configuring the CS2KPERFConfig.js script:

Describes the steps required for the CS2KPERFConfig.js script for Genband C20CS2K Performance device.

About this task

Set the Location for the Genband C20 CS2K Performance device in theCS2KPERFConfig.js file. Before the GenBand C20 Converged IP SoftswitchTechnology Pack can create the Location name for the Nortel CS2000 Performancedevice, the location names must be identified in the CS2KPERFConfig.js file.To configure the CS2KPERFConfig.js design file, follow these steps:


Procedure

1. On the DataChannel server, change your working directory to theDATA_CHANNEL_HOME/scripts directory by entering the following command,replacing DATA_CHANNEL_HOME with the DataChannel home directory(/opt/datachannel, by default):cd DATA_CHANNEL_HOME/scripts

2. Make a backup copy of the CS2KPERFConfig.js design file, by entering thefollowing command:cp CS2KPERFConfig.js CS2KPERFConfig.js.ORIG

3. In a text editor, open the CS2KPERFConfig.js design file for editing.4. Specify the location name for the Genband C20 CS2K Performance device as

follows:v switchN - Specifies the name of the switch.v locationN - Specifies the location of the switch.

Configuring the USPConfig.js script:

Describes the steps required for the USPConfig.js script for Genband C20 USPdevice.

About this task

Set the Location for the Genband C20 USP device in the USPConfig.js file. Beforethe Genband C20 Converged IP Softswitch Technology Pack can create theLocation name for the Genband C20 USP device, the location names must beidentified in the USPConfig.js file. To configure the USPConfig.js design file,follow these steps:

Procedure

1. On the DataChannel server, change your working directory to theDATA_CHANNEL_HOME/scripts directory by entering the following command,replacing DATA_CHANNEL_HOME with the DataChannel home directory(/opt/datachannel, by default):cd DATA_CHANNEL_HOME/scripts

2. Make a backup copy of the USPConfig.js design file, by entering the followingcommand:cp USPConfig.js USPConfig.js.ORIG

3. In a text editor, open the USPConfig.js design file for editing.4. Specify the location name for the Genband C20 USP device as follows:v switchN - Specifies the name of the switch.v locationN - Specifies the location of the switch.

5. You can edit existing error messages or add new error messages for theGenband C20 USP device as follows:v messageErrors [N] - Specifies the error condition.v text - Specifies the error message for the corresponding error condition.

Configuring cs2kcdr.pl script execution:

Explains how to configure and run the cs2kcdr.pl script that is delivered as partof the GenBand C20 Converged IP Softswitch Technology Pack.


About this task

The cs2kcdr.pl script runs as a daemon, so it will fork when it is run instand-alone mode. The script requires the following Perl modules available fromhttp://www.cpan.org:Net::FTP Date::Manip

The cs2kcdr.pl daemon retrieves files by using Net::FTP. If your environmentrequires SFTP access, you can optionally download the module by using CPAN, andchange the cs2kcdr.pl to call Net::SFTP instead of Net::FTP. The Net::SFTPmodule is also available from http://www.cpan.org.

The cs2kcdr.pl can run on multiple platforms, provided perl and the appropriatemodules are installed, and that the systems running the UBA collectors have FTP(or file) access to the output CSV from the cs2kcdr.pl script.

Note: Some of the directories specified in the configuration section of thecs2kcdr.pl file may need to be created by hand.The cs2kcdr.pl is configured by editing the cs2kcdr-config.pl script.

CAUTION:Do not edit the cs2kcdr.pl script.

Editing the cs2kcdr-config.pl script:About this task

To edit the cs2kcdr-config.pl script, follow these steps:

Procedure

1. Log in to the Tivoli Netcool Performance Manager DataChannel server byentering the username and password that you specified when installing andconfiguring a DataChannel. The default username and password are pvuserand PV, respectively.

2. Change your working directory to the <DATA_CHANNEL_HOME>/scripts directoryby entering the following command, replacing <DATA_CHANNEL_HOME >with the DataChannel home directory (/opt/datachannel, by default):$ cd DATA_CHANNEL_HOME/scripts

The cs2kcdr.pl and cs2kcdr-config.pl scripts were copied to the thisdirectory as part of the configuration tasks performed in “Configuring packs,”on page 1.

3. Using the text editor of your choice open the cs2kcdr-config.pl script.4. Locate the values of the cs2kcdr-config.pl script shown in the following

table and edit the parameters according to the requirements of yourenvironment:

Option Description

$logDir = Specifies the location of the cs2kcdr.pldaemon log file.

$NNI = Specifies the sensor ID number for theswitch.

$maxFilesPerRun = Specifies the number of IPDR and AMA filesthat are processed in a single run.


http://www.cpan.org

http://www.cpan.org

Option Description

$runInterval = Specifies how often to run and collect inputfiles.

$globalAggrInterval = Specifies the aggregation period for metrics.

$amapath = Specifies the path of the AMA output files.

$amadir = Specifies the location of the AMA outputfiles.

5. In the cs2kcdr-config.pl script locate the values found in the table below andedit the parameters according to the requirements of your environment:

Option Description

$ipdrpath = Specifies the path of the temporary datastore for IPDR files.

$ipdrdir = Specifies the location of the temporary datastore for IPDR files.

$numberOfOutputs = Specifies the number of separate outputstreams that will be created for processingby separate UBA collectors.

$outputDir = Specifies the location of the CSV outputfiles. The CSV files use the suffix n.csv,where n is the number of the stream of CSVfiles so the appropriate UBA can locate itsinput files via the Input URI filter.

$exceptDir = Specifies the location of the exception outputdirectory.

$storeExceptionDetail = Specifies which termination codes are to bewritten to a separate output file forexamination.

$terminationCodeHash = Specifies the list of termination codes.

6. In the cs2kcdr-config.pl script locate the values for our $cdrConfig and editthe parameters according to the requirements of your environment. Thefollowing table provides descriptions of the our $cdrConfig parameters:

Option Description

name Specifies a string that represents theidentifier for the remote GenBand C20servers. This string should match the<SOFTSWITCH_NAME> value that ispart of the Universal Resource Identifier(URI) associated with the data source.GenBand C20 binary AutomaticMessage Accounting (AMA) file namesare something like:CS2K_<DDMMYYYY>_<NUMBER>_<SOFTSWITCH_NAME>.bin.

location Specifies a string that represents thelocation for where the remote GenBandC20 servers are installed.


Option Description

zone Specifies a string that represents theH.323 Zone for the remote GenBandC20 servers.

7. Locate the our $trunkConfig section of the cs2kcdr-config.pl script and editthe parameters according to the requirements of your environment. Thefollowing table provides a description of the parameter:

Option Description

name Specifies a string that represents theidentifier for the remote GenBand C20Communication Server 2000 (CS2K)Softswitch Trunks.

8. Locate the our $locationMap section of the cs2kcdr-config.pl script and editthe parameters according to the requirements of your environment. Thefollowing table provides descriptions of the our $locationMap parameters:

Option Description

extensionPattern Specifies the extension pattern for a CDRlocation.

extensionRange Specifies an extension range for a CDRlocation.

9. For IPDR Processing the following section must be configured:our $xmlHosts = {"hostname.example.com" => {user => "pvuser",pass => "pv",path => "/opt/uba/cs2k/ipdr"}};

10. Once you are finished with your edits, write and quit the cs2kcdr-config.plfile.

11. Run the cs2kcdr.pl script.

Activating percentile requestsDuring installation of the technology pack, all predefined percentile requests arepromoted to the database and set to inactive (that is, idle displays in the Activecolumn of the Tivoli Netcool Performance Manager DataMart Request Editor). Youneed to activate these predefined percentile requests by using the Request Editor.

About this task

To set percentile requests to active, follow these steps:

Procedure1. Click the Aggregation tab on the Request Editor.2. In the Sub-Element Groups pane, select all percentile requests in the following

group:Root > NOC Reporting > Carrier VOIP

3. Click the Active box under Details. The Request Editor toggles the idle settingfor these percentile requests from idle to active in the Active column.


4. Click Save.

NetFlow IPFIX Technology PackAdditional configuration steps that are required for NetFlow IPFIX TechnologyPack.

Note: The NetFlow IPFIX Technology Pack operates with routers running NetFlow,versions 1, 5 - 9, and IETF IPFIX.

Overview:

The following sections describe how to install, configure, and run the TNPMFLOWCollector that is used to obtain and process NetFlow datagrams.

Deployment considerations:

There are various deployment considerations, such as topology, duplication, andscalability.

Topology:

In high volume environments, the TNPMFLOW Collector can be installed onmultiple machines by using a one-to-one relationship between a TNPMFLOWCollector and the technology pack. For example, in a deployment of 500 routers,five instances of the technology pack/TNPMFLOW Collector combination can beused, each to monitor 100 routers.

Duplication:

The TNPMFLOW Collector does not prevent packets, which pass through twoNetFlow-enabled interfaces, from being counted twice.

To avoid it, configure your network so that duplication never occurs, for example,by enabling NetFlow export on edge interfaces only. The following diagram depictssuch a configuration:


Scalability:

Deployment of this technology pack can be scaled to meet local requirements byadding more installations of the technology pack and TNPMFLOW Collector,where required.

Tivoli Netcool Performance Manager is optimized to track devices and theircharacteristics for a long time. To use this modeling scheme to track IP addresses(whose information and characteristics are not useful for more than a few hours ordays), would be resource-intensive. The Network-host and Host-network reportsdo this, but because they are resource-intensive, it is disabled by default during theinstallation process. If you choose to enable these report sets, you must use themin a small environment with a limited number of hosts.

TNPMFLOW installation:

Install the TNPMFLOW Collector after you install the NetFlow IPFIX TechnologyPack, but before you perform the pack configuration steps.

Note: If Aurora NetFlow Collector is already installed, uninstall it by using thefollowing command:aurora deinstall

TNPMFLOW uses the RPM (Red Hat RHEL, Suse SLES) installation mechanism.The following sections show the specific commands for this mechanism. Version,release and architecture specifications might vary between distributions.

Figure 6. Example of a configuration that avoids duplication


Note: The NetFlow IPFIX Technology Pack stores the TNPMFLOW installationpackages in the following directory:$PVMHOME/APFiles/cisco_netflow/adaptor

Solaris:

Use this information to install TNPMFLOW on Solaris 9 or 10 platform.

Procedure

1. Log in as a user with root administration rights.2. Install TNPMFLOW on Solaris 9 or 10 platform by using the following

commands:#> gunzip tnpmflow-4.1.1.9-2013.06.13-sparc64.tar.gz#> tar xf tnpmflow-4.1.1.9-2013.06.13-sparc64.tar#> cd tnpmflow#> ./INSTALL

The installation directories are /opt/tnpmflow, /var/lib/tnpmflow, and/etc/tnpmflow. Files are written into /etc/init.d.

3. Add the root user by using the following command:tnpmflow addroot

You are prompted to enter a user ID. Enter the user ID as admin. A messagesimilar to the following is displayed:User ’admin’ successfully created in file ’users/admin’The password for this account is ’/7n5e7e08a9UCRs’

Note the password that is indicated in the message.4. Start the TNPMFLOW Collector by using the following command:

tnpmflow start

RPM installation (RHEL, SLES):

Use this information to install TNPMFLOW on RHEL and SLES platforms.

Procedure

1. Log on as a user with root administration rights.2. Install TNPMFLOW on RHEL and SLES platforms by using the following

command:#> rpm -Uhv tnpmflow-4.1.1.9-2013.06.13.x86_64.rpm

The installation directories are /opt/tnpmflow, /var/lib/tnpmflow, and/etc/tnpmflow. Files are written into /etc/rc.d, /var/www/html, and/var/www/cgi-bin for RHEL and /srv/www/cgi-bin and /srv/www/htdocs forSLES.

3. Add the root user by using the following command:tnpmflow addroot

You are prompted to enter a user ID. Enter the user ID as admin. A messagesimilar to the following is displayed:User ’admin’ successfully created in file ’users/admin’The password for this account is ’/7n5e7e08a9UCRs’

Note the password that is indicated in the message.


4. Start the TNPMFLOW Collector by using the following command:tnpmflow start

Pre-configuration:

Pre-configured aspects are NetMatrix, NetApp, Network, NetToS, and AsNum.

Note these aspect names must be the same as the values provided forCISCO_NETFLOW.TOPIC_FILTER in the Topology Editor. The aspect FlowState is alsopre-configured but not used. All aspect configurations are done in/opt/tnpmflow/var/sites/proviso/etc/site.conf. /etc/tnpmflow/site_proviso.conf is a link to it.NetHost tva_counter exporter_ip domain_src ip_dst applicationHostNet tva_counter exporter_ip ip_src domain_dst application

Default System UsersThe following table shows default system users for running TNPMFLOWon different platforms.

Table 17. Default system users

Platform Default system user:group

Solaris pvuser:staff

Linux tnpmflow:tnpmflow

During the installation, the default system user and group are added to theoperating system if it does not exist yet. Installation files and variable datafiles are owned by the tnpmflow system user.

TNPMFLOW configuration:

TNPMFLOW uses the main configuration file /etc/tnpmflow/tnpmflow.conf, whichcontains settings valid for all sites.

The receiving port is configured here. The default port is set to 2055. To change thedefault port, the parameter flow_url must be changed.. The simulations andprevious versions of the NetFlow IPFIX pack use UDP port 9996, so it isrecommended that you change or add udp://any:9996 to the following flow_url:

### -----------------------------------------------------------------------### Collector port numbers (NetFlow: 2055/UDP and IPFIX: 4739/SCTP)### -----------------------------------------------------------------------flow_url udp://any:2055#flow_url udp://any:2055 any://any:4739 udp://any:9005

Site-specific configuration issues are maintained in individual site configurationfiles, for example /etc/tnpmflow/site_proviso.conf, for the default Tivoli NetcoolPerformance Manager site. The most important configuration options are:### -----------------------------------------------------------------------### NetFlow/IPFIX accepted from these exporters (for ports see tnpmflow.conf)### -----------------------------------------------------------------------set routers 0.0.0.0/0#set routers 127.0.0.1/8 10.10.10.0/24

### ---------------------------------------------------------------### Create custom aspects### ---------------------------------------------------------------aspectnew NetworkHost counter multiple ip_router domain_src ip_dst applicationnew NetworkMatrix counter multiple ip_router domain_src domain_dst application


new NetApp counter multiple ip_router domain_src protocol application tosnew Network counter multiple ip_router domainnew AsNum counter multiple ip_router asn_src asn_dstnew NetHost tva_counter exporter_ip domain_src ip_dst applicationset name "Src Network - Dst Host"new HostNet tva_counter exporter_ip ip_src domain_dst applicationset name "Src Host - Dst Network"

end

### ---------------------------------------------------------------### Domain reporting (domain id: 0 < ID < 2048)### ---------------------------------------------------------------domain

# Global domain reportingset aspects AsNum Network NetApp NetworkMatrix NetworkHostset periods hour

# Private Address Space (RFC1918 + RFC4193)new 1 "Private"set local yesset subnet 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7

# Link Local Address Space (RFC3330 + RFC3513)new 2 "Link Local"set local yesset subnet 169.254.0.0/16 fe80::/10

# Documentation Address Space (RFC3330 + RFC3849)new 3 "Documentation"set local yesset subnet 192.0.2.0/24 2001:db8::/32

# Domain definiton with autonomous system numbernew 4 "Swisscom"set flag /tnpmflow/flags/ch.gifset asn 3303

# Domain definiton with autonomous system numbernew 5 "DTAG"set flag /tnpmflow/flags/de.gifset asn 3320

select NetHost octetsset itemsmax 200000set itemslim 400000set periods hour

select NetHost packetsset itemsmax 200000set itemslim 400000set periods hour

select HostNet octetsset itemsmax 200000set itemslim 400000set periods hour

select HostNet packetsset itemsmax 200000set itemslim 400000set periods hour

end

### -----------------------------------------------------------------------### Compress (ZIP=bzip2) or delete (ZIP=REMOVE) flow file after...### Day = 86400s### Month = 2592000s


### Never = 0s### -----------------------------------------------------------------------set flowflushcommand REMOVEset flowflushperiod 86400

### -----------------------------------------------------------------------### Size of NetFlow/IPFIX receive buffer (10MB min and 100MB max)### -----------------------------------------------------------------------set flowbuffersize 100### -----------------------------------------------------------------------### Enable/Disable DNS reverse lookup### -----------------------------------------------------------------------set dnsresolving yes

TNPMFLOW can be customized with respect to the grouping of TCP/UDP portsinto applications and naming of protocols, autonomous systems, services,interfaces, and traffic service classes (for example, quality of service types). Theconfiguration files are:/etc/tnpmflow/protocols/etc/tnpmflow/services/etc/tnpmflow/applications/etc/tnpmflow/tos/etc/tnpmflow/icmp/etc/tnpmflow/asn/etc/tnpmflow/interfaces

Sites are used to separate traffic information between administrative domains. Asingle TNPMFLOW installation can be used for many administrative domains withpotentially overlapping (private) address spaces and individual configurations. Aseparate database is maintained for every site. It is recommended to start aninstallation with a single default site. The default site in the Tivoli NetcoolPerformance Manager installation is named Proviso.

Certain router interfaces can be explicitly excluded, for example, to avoid duplicateNetFlow reporting.

Configuring with TNPMFLOW script:

Use a script called tnpmflow to start and stop the TNPMFLOW engine, and to add,remove, or list topics and aspects.

This script automatically updates the report_site.ash when it is used to addtopics.Usage: tnpmflow OPTIONS

The following table shows possible values for options.

Table 18. Possible values for options

Option Description

start [verbose|confirm] Start

restart [verbose] Restart

stop [verbose|confirm] Stop

reset [<site_name>] Reset interactively

connect Connect to system CLI

showsites Show all sites

addsite [<site>] Add new site


Table 18. Possible values for options (continued)

Option Description

delsite [<site>] Delete site

showusers Show all user accounts

showuser [<id>] Show single user account

addroot [<id>] Add new root user account

deluser [<id>] Delete user account

setflowurl [<flowurl>] Set the flow URL

import [<site>[<dir>]] Import flow files in a directory

status [mail|sms] Show runtime status

updatehttpd Update the web server configuration

rmhttpd Remove the web server configuration

deinstall Deinstall the system

version Version

help Help

User-defined aspects:

TNPMFLOW provides a list of basic aspects and makes it possible to define newcomposed aspects.

The basic aspects are:<basic aspect> :=

host | port | tos | domain | direction |type | proto | appl | flow | interface |asn | icmp

User-defined aspects are defined in the individual site configuration files, forexample /etc/tnpmflow/site_proviso.conf for the default Proviso site.<user-defined aspect> :=aspect new <aspect name> counter multiple <component>+

The parameter counter means that only total counters are stored in the database.The parameter multiple means that multiple units are recorded in the database, forexample, in/out octets, in/out packets and in/out flows. For configuration withTivoli Netcool Performance Manager, user-defined aspects must always usecounter and multiple. The components of a user-defined aspect can be:<component> :=domain | domain_src | domain_dst | direction |ip | ip_src | ip_dst | ip_nexthop | ip_version |ip_router | ip_router_port |interface | interface_in | interface_out |port | port_src | port_dst |protocol | service | application |as | as_src | as_dst |type | tos | tcp_flags | flowlabel |icmp | flow_version |duration | packets | octets

Following are four examples of user-defined aspects:


aspect new MyTopic1 counter multiple ip_router domain protocol application tosaspect new MyTopic2 counter multiple asn_dst ip_dstaspect new MyTopic3 counter multiple application ip_src ip_dstaspect new MyTopic4 counter multiple ip ip_version

Following are aspect definitions for AS Matrix and Protocol/Port Matrixaggregations:aspect new ASPortMatrix counter multiple as_src as_dst interface_in interface_outaspect new ProtocolPortMatrix counter multiple protocol port_src port_dst

Adding networks and domainsConfigure network and domain names by editing the site configurationfile. The following shows an example of a domain definition.domain# Global domain reportingset aspects AsNum Network NetApp NetworkMatrixset periods hour# Private Address Space (RFC1918 + RFC4193)new 1 "Private"set local yesset subnet 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7# Link Local Address Space (RFC3330 + RFC3513)new 2 "Link Local"set local yesset subnet 169.254.0.0/16 fe80::/10# Documentation Address Space (RFC3330 + RFC3849)new 3 "Documentation"set local yesset subnet 192.0.2.0/24 2001:db8::/32# Domain definiton with autonomous system numbernew 4 "Swisscom"set flag /tnpmflow/flags/ch.gifset asn 3303

# Domain definiton with autonomous system numbernew 5 "DTAG"set flag /tnpmflow/flags/de.gifset asn 3320

end

TNPMFLOW configuration and load balancing:

The normal load balancing mechanism performs well when there are manyNetFlow-enabled routers that send data to the same database. In these conditions,you can configure multiple TNPMFLOW/UBA instances to balance the load.

This approach to load balancing is not helped if one large router can generateenough flow data to overload a single TNPMFLOW/UBA instance by itself. Todeal with this situation, the following modifications to the TNPMFLOWconfiguration are required:

tnpmflow_split_report.pl

This file is delivered in <DATACHANNEL_HOME>/APFiles/cisco_netflow/adaptor andmust be copied to /opt/tnpmflow/bin.

As delivered, it is set up to split the TNPMFLOW output based on the inputinterface (line 15, “my $split_key = ‘in’;”).

If the router is configured to collect flows from the output side of its interfaces,change it to ‘out’.


/etc/tnpmflow/site_proviso.conf

In the aspect section, change the topic definitions by adding interface_ininterface_out at the end of each, as follows:

new NetMatrix tva_counter exporter_ip domain_src domain_dst applicationinterface_in interface_out

Do this for all topic definitions, except for FlowState, which is not used.

/opt/tnpmflow/var/sites/proviso/etc

Addinterface_in=%flow:interface_in#name%,interface_out=%flow:interface_ out#name%,

between the SE and UE markers in the same line as follows:site aspect printf"Source=TNPMFLOW,Site=proviso,Topic=NetMatrix,Timestamp=$date$,SE,ip_router=%flow:exporter_ip%,interface_in=%flow:interface_in#name%,interface_out=%flow:interface_out#name%,domain_src=%flow:domain_src#name%,domain_dst=%flow:domain_dst#name%,application=%flow:application#name%,UE,PacketsOut=$packets_sent$,BytesOut=$bytes_sent$,PacketsIn=$packets_recv$,BytesIn=$bytes_recv$\n" @@keys:$i$@@

Do this for all topic definitions, except for FlowState, which is not used.

Restart TNPMFLOW. TNPMFLOW continues to put all its output (.csv) files in/opt/tnpmflow/var/sites/proviso/reports

It also creates two directories in reports that are called 0 and 1.

Change your existing UBA to take its input fromreports/0

and configure a second UBA to take input fromreports/1

Both UBAs must direct output to the same CME. Stop and restart the channel.

Note: Enable pvuser to access the reports folder by using the following command:chmod -R 777 /opt/tnpmflow/var/sites/proviso/reports

UBA PVLine Format Technology PackAdditional configuration steps required for UBA PVLine Format Technology Pack.

PVLine input file formatsThe UBA PVLine Format devices gather performance data and other statistics frommultiple network elements. This data is referred to collectively as network healthmetrics . Each UBA PVLine Format device produces, on a specified regular basis, abulk input file that contains the network health metrics and other information.

This bulk input file is a PvLine format file. These input files are acquired by theUniversal Bulk adapter (UBA) script through an FTP process, and then each recordin those files is processed. All the input files are collected for a time interval andall the records within the files are sorted and processed as per the time interval setin the APP_FILE_PERIOD parameter.


The UBA PVLine Format Technology Pack supports multiple input files per UBA,where each input file contains data for one polling period only.

The filename format for these bulk input files is discussed in “Bulk input filename.”

The UBA PVLine Format Technology Pack provides a file that interprets these bulkinput files. See Bulk adaptor design files in UBA PVLine Format 2.2.0.0 Technology PackUser Guide for more information.

Bulk input file name:

The implementation plan is to collect performance data by pulling the PvLine filesfrom Tivoli Netcool Performance Manager by using the ftp protocol.

The file name format is defined as below:UBA_PVLine_Format_<YYYY.MM.DD>-<HH.MM.SS>.pvline

<YYYY.MM.DD>-<HH.MM.SS> - This indicates the timestamp value.

UBA_PVLine_Format_2011.04.14-07.06.15.pvline

PVLine file format values:

Table 19. PVLine file format values

Format Default value

Format name Tivoli Netcool Performance ManagerPV-Line

Format abbreviation PVLINE

File Typically, specified as .pvline

File version 3.0

Vendor IBM

Format parser type Resource block parser

Default formula path empty string

Default family 'bulk'

Default profile ` bulk_<nn>' Where: <nn> is the BulkCollector number

Header line format:

Summarizes the header lines format and syntax in PVLine files.

Table 20. Header line format

Option Syntax Description

OPTION:TYPE=Line This Option Syntax is used by BulkCollector (BCOL). Specifies the file formatassociated with PvLine. The value Lineindicates that this file format is the completeASCII format.


Table 20. Header line format (continued)

Option Syntax Description

OPTION:PVMVersion=3.0 This Option Syntax is used by BCOL.Specifies the import file version to berecognized. Version 3.0 is the only versionthat works.

OPTION:Element=<element_name> Sets the default formula path. This optionprovides a space saving mechanism forsetting the default formula path. The BulkCollector prepends the specified path to allmetric names, for metric type data lines. Ifyou do not specify this option, the defaultformula path is the empty string.

OPTION:TimeOffset=<time_offset> Sets the local timezone in which PvLine filesare generated. By default, the offset is 0(zero), which means timestamps are inCoordinated Universal Time (UTC).

Note: OPTION:TYPE=Line and OPTION:PVMVersion=3.0 are compulsory forBCOL. These are not required by the UBA Collector to process the data file. Iffound, UBA is still able to process the data file.

Data line format:

Summarizes the Data line format and syntax in PVLine files.

The PvLine file consists of multiple data lines where each line consists of sevenfields. The line syntax is as follows:date|metric/propertyname|targettype|targetname|Instance|valuetype|value

Table 21. Data line format

Field Position Field Item Description

Field1 date yyyy/mm/dd hh:mm:ssEg: G2011/01/03 21:50:00

The UBA outputs timestamps inGMT. More specifically, the UBAconverts the timestamp to GMT byadding the time offset.

Example: OPTION:TimeOffset = 3600(1hour)

Record timestamp need to be set toGMT + 1


Table 21. Data line format (continued)


Field2 metric/ propertyname Specifies the metric or property nameto use when the import routineprocesses the value supplied in thevalue field (field7).

If a metric name is supplied:

The metric name maps to the fullyqualified bulk collection formulaname, which includes its parentgroup name. A leading ~ does notwork. Example:AP~Specific~Bulk~(device)~Inbound Errors

You can use theOPTION:FormulaPath PvLine fileheader option to set a PvLinefile-based default for this formulapath.

The valuetype field (field6) must beset to type float or type string

String is supported by BCOL but notUBA.

If a property name is supplied: Thevaluetype field (field6) must be set totype property or type inventory.

If the valuetype field (field 6) is set totype inventory , then field 2 must beset to one of the following string:

v Invariant

v Instance

v Label

v State

v Family

v NodeType

Note: NodeType is supported byBCOL but not UBA.




Field3 targettype Specifies one of the following string:

v alias – Indicates that the targettype is a subelement. If targettypeis a subelement, then targetname(field4) specifies the name of thiselement.

v host – Indicates that the target typeis an element. If targettype is anelement, then targetname (field4)specifies the name of this element.

Note: The element name can also beset by using the OPTION:ElementPvLine file header line option. In caseof conflict between these twomethods, the priority will be given toOPTION:Element feature.

Field4 targetname Specifies the name used to uniquelyidentify the resource. The importprogram will use this name as thesubelement and will associate it withthe element identified in theOPTION:Element PvLine file headerline option.

Field5 Instance This field is not used but must bespecified with a blank entry.

field1|field2|field3|field4| |field6|field7




Field6 valuetype Specifies one of the following ASCIIstrings:

v float - Used to specify a numericvalue: floating point, short integer,long integer, exponents, and rollingcounters. Specifying float in thisfield tells the import program touse the name specified in themetric/propertyname field (field 2)as the metric name.Note: Specific formulas can beused in the CME to identifymetrics that need to be treated asrolling counters. The CME willhandle all processing required toaccurately calculate delta valuesfor these metrics.

v string - Used in BCOL to specify astring metric that is passed to theCME. The string metric can beused in CME formulas as part of acalculation to output either ametric or a property.

v property - Used to specify acharacter string that tells theimport program to use the namespecified in themetric/propertyname field (field 2)as the property name. Propertiesare typically used to groupresources into logical groups forreporting purposes. Examples ofproperties include linkSpeed ,location , customer , and so on.

v inventory - Used to identify specialproperties that must be handleddifferently from other properties bythe inventory process. If this fieldis set to inventory, then themetric/propertyname field (field 2)must be set to one of these values:Invariant, Instance, Label, State,Family, or NodeType.

Field7 value Specifies a numeric or string valuethat is associated with the metric orproperty name specified in themetric/propertyname field (field 2)and the valuetype field (field 6).

Sample of PVLine data content:# Type Both# ## ## # Setting Options# OPTION:Type=Line# OPTION:PVMVersion=3.0


# OPTION:TimeOffset=0# OPTION:FormulaPath= AP~Specific~Bulk~(device)# # Collection Interval for the following resources = 15 minutes# OPTION:Element=BigRouter## G1998/08/12 23:30:00 | Family | alias | Abcd | | inventory | {device}# G1998/08/12 23:30:00 | Customer | alias | Abcd | | property | Acme# G1998/08/12 23:30:00 | Continent | alias | Abcd | | property | Europe# G1998/08/12 23:30:00 | Country | alias | Abcd | | property | France# G1998/08/12 23:30:00 | City | alias | Abcd | | property | Paris# G1998/08/12 23:30:00 | CIR | alias | Abcd | | property | 128# G1998/08/12 23:30:00 | IP Traffic Percentage | alias | Abcd | | float |

95.448312749999999# G1998/08/12 23:30:00 | Power Level | alias | Abcd | | float | 1.672e-23# G1998/08/12 23:30:00 | Inbound Packets | alias | Abcd | | float | 749999999

Additional Topology Editor parametersThere are certain additional topology editor parameter.

Auto-create options

There are two toggle options:

APP_AUTO_CREATE_FRM

Automatically create the formulas after acquisition of bulk input files.

Set this parameter to TRUE to instruct the UBA collector to create theformulas on the fly. If this parameter is set to FALSE, formulas must beimported manually into the database using resmgr utility before UBA cancontinue to process them.

APP_AUTO_CREATE_PROP

Automatically create the properties after acquisition of bulk input files.

Set this to TRUE to instruct the UBA collector to create the properties onthe fly. If this parameter is set to FALSE, properties need to be importedmanually into the database using resmgr utility before UBA can continueto process them.

Logging level option

Currently, the UBA PVLine Format Technology Pack has logging levels inside theadaptor script.You can set the logging level inside the Topology Editor. Supportedlogging levels are as follows:# FATAL = 0# ERROR = 1# WARNING = 2# INFO = 3# DEBUG = 4# TRACE = 5

For example:# dccmd debug UBA.2.201 "self configuration" | grep "’APP.L"# ’APP.LEVEL’->’5’# ’APP.LOGGING’->’TRUE’

Note: There are two parameters: APP_LOGGING and APP_LEVEL used to controlAppLogger debug messages. The APP_LOGGING parameter enables the


AppLogger facility. The purpose of AppLogger is to provide a minimal level ofcontrol over the log messages used for debugging by IBM technology packdevelopers.

Interval between two generated input files option

The APP_FILE_PERIOD parameter helps to set the time interval in secondsbetween two generated input files. Set the number of seconds between twogenerated input files. If first input file is generated at T1 timestamp and secondinput file is generated at T2 timestamp, then the file period is equal to thedifference between T2 and T1. Typically, the collection requests for the pack matchthe value specified for the APP_FILE_PERIOD parameter.

Note: You must configure APP_FILE_PERIOD inside the Topology Editor sinceOPTION:Interval= is not supported in the datafile.

Huawei U2000 2.3.1.0 Technology PackAdditional configuration steps that are required for the Huawei U2000 2.3.1.0Technology Pack.

Configuring when NRM data is available

About this task

The following configuration steps are needed when NRM data is available:

Procedure1. Install the Huawei U2000 Technology Pack. For more information, see Installing

Technology Packs and Configuring Technology Packs.2. Source the DataMart environment by using the following command:

source /opt/datamart/dataMart.env

3. Change your working directory to NRM scripts folder by using the followingcommand:$ cd $PVHOME/APFiles/huawei_u2000/datamart/conf/NRM_U2000/Enrichment_with_NRM_csv

4. Run the following command to change the permission of NRM scripts toexecutable mode.$ chmod +x *

The NRM scripts are as follows:v NRM.env

v Huawei_NRM_Enrichment.pl

v HuaweiEnrich.sh

5. Provide the values for the properties in the NRM.csv file.The following list defines the rules for specifying NRM.csv properties values:v There are 8 fields in NRM.csv file

– Element Name

– Technology

– Region

– PoP_Location

– OTT_PoP_Location

– DeviceModel

– Vendor


– FCC_Port

v The values for these eight fields are separated with a comma.v Provide a value for either PoP_Location or OTT_PoP_Location only. PoP type

can be either PoP_Location or OTT_PoP_Location and not both.v If you do not want to provide a value for any of these fields, make sure that

these fields are separated by comma. The script appends the default values.

Note: The following elements are assigned to the default values:– Technology --> Technology– Region --> Region– PoP_Location --> PoP Location– DeviceModel --> Device Model– Vendor --> Vendor– FCC_Port --> FCC Port

The following example is the correct format of the properties values in theNRM.csv file.IPTV_AUQ_Serv_SW_1.H,IPTV,Pune,AUQ,,Model1,PSL,FCC

6. Add the collector number that is assigned for Huawei U2000 as PROFILE inthe NRM.env file.For example, if you add collector number 2 for Huawei U2000, the entry in theNRM.env file is: export PROFILE=2

7. Run the HuaweiEnrich.sh by using the following command:$ ./HuaweiEnrich.sh

8. Run the bulk inventory profile.9. Run Reporting Grouping and AutoGrouping.

Configuring when no NRM data is available

About this task

The following configuration steps are needed when there is no NRM dataavailable:

Procedure1. Install the Huawei U2000 Technology Pack.

For more information, see Installing Technology Packs and Configuring TechnologyPacks.

2. Source the DataMart environment by using the following command:source /opt/datamart/dataMart.env

3. Change your working directory to NRM scripts folder by using the followingcommand:$ cd $PVHOME/APFiles/huawei_u2000/datamart/conf/NRM_U2000/Enrichment_with_default_values

4. Run the following command to change the permission of NRM scripts toexecutable mode.$ chmod +x *

The NRM scripts are as follows:v NRM.env

v Huawei_NRM_Enrichment.pl

v HuaweiEnrich.sh


5. Add the collector number that is assigned for Huawei U2000 as PROFILE inthe NRM.env file.For example, if you have add collector number 2 for Huawei U2000, the entryin the NRM.env file is export PROFILE=2

6. Run the HuaweiEnrich.sh by using the following command:$ ./HuaweiEnrich.sh

Note: The following elements are assigned to the default values:v Technology --> Technologyv Region --> Regionv PoP_Location --> PoP Locationv DeviceModel --> Device Modelv Vendor --> Vendorv FCC_Port --> FCC Port

7. Run the bulk inventory profile.8. Run Reporting Grouping and AutoGrouping.


Notices

This information was developed for products and services that are offered in theUSA.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785United States of America

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided forconvenience only and do not in any manner serve as an endorsement of those

© Copyright IBM Corp. 1997, 2015 229

websites. The materials at those websites are not part of the materials for this IBMproduct and use of those websites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationDepartment number/Building numberSite mailing address_City, State; Zip Code_USA (or appropriate country)

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:


This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

Portions of this code are derived from IBM Corp. Sample Programs.

© Copyright IBM Corp. _enter the year or years_. All rights reserved.

Terms and conditions for product documentationPermissions for the use of these publications are granted subject to the followingterms and conditions.

Applicability

These terms and conditions are in addition to any terms of use for the IBMwebsite.

Personal use

You may reproduce these publications for your personal, noncommercial useprovided that all proprietary notices are preserved. You may not distribute, displayor make derivative work of these publications, or any portion thereof, without theexpress consent of IBM.

Commercial use

You may reproduce, distribute and display these publications solely within yourenterprise provided that all proprietary notices are preserved. You may not makederivative works of these publications, or reproduce, distribute or display thesepublications or any portion thereof outside your enterprise, without the expressconsent of IBM.

Rights

Except as expressly granted in this permission, no other permissions, licenses orrights are granted, either express or implied, to the publications or anyinformation, data, software or other intellectual property contained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in itsdiscretion, the use of the publications is detrimental to its interest or, asdetermined by IBM, the above instructions are not being properly followed.

You may not download, export or re-export this information except in fullcompliance with all applicable laws and regulations, including all United Statesexport laws and regulations.

Notices 231

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESEPUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUTWARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDINGBUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY,NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the web at www.ibm.com/legal/copytrade.shtml.

Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States,other countries, or both.

IT Infrastructure Library is a registered trademark of the Central Computer andTelecommunications Agency which is now part of the Office of GovernmentCommerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks orregistered trademarks of Intel Corporation or its subsidiaries in the United Statesand other countries.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both

Microsoft and Windows are trademarks of Microsoft Corporation in the UnitedStates, other countries, or both.

ITIL is a registered trademark, and a registered community trademark of TheMinister for the Cabinet Office, and is registered in the U.S. Patent and TrademarkOffice.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Java and all Java-based trademarks and logos are trademarks orregistered trademarks of Oracle and/or its affiliates.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in theUnited States, other countries, or both and is used under license therefrom.

Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo aretrademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.


http://www.ibm.com/legal/us/en/copytrade.shtml

http://www.ibm.com/legal/us/en/copytrade.shtml

Additional copyright noticesThe following copyright information is for software used by Tivoli NetcoolPerformance Manager Wireline Component.

Tcl 8.3.3, Combat/TCL 0.7.3, Combat/TCL 0.7.5, TclX 8.3, TK 8.3.3

This software is copyrighted by the Regents of the University of California, SunMicrosystems, Inc., Scriptics Corporation, and other parties. The following termsapply to all files associated with the software unless explicitly disclaimed inindividual files.

The authors hereby grant permission to use, copy, modify, distribute, and licensethis software and its documentation for any purpose, provided that existingcopyright notices are retained in all copies and that this notice is included verbatimin any distributions. No written agreement, license, or royalty fee is required forany of the authorized uses. Modifications to this software may be copyrighted bytheir authors and need not follow the licensing terms described here, provided thatthe new terms are clearly indicated on the first page of each file where they apply.

IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANYPARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIALDAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITSDOCUMENTATION, OR ANY DERIVATIVES THEREOF, EVEN IF THEAUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANYWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULARPURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN"AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NOOBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,ENHANCEMENTS, OR MODIFICATIONS.

GOVERNMENT USE: If you are acquiring this software on behalf of the U.S.government, the Government shall have only "Restricted Rights" in the softwareand related documentation as defined in the Federal Acquisition Regulations(FARs) in Clause 52.227.19 (c) (2). If you are acquiring the software on behalf of theDepartment of Defense, the software shall be classified as "Commercial ComputerSoftware" and the Government shall have only "Restricted Rights" as defined inClause 252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the authorsgrant the U.S. Government and others acting in its behalf permission to use anddistribute the software in accordance with the terms specified in this license.

SCOTTY Stack

This software is copyrighted by Juergen Schoenwaelder, the Technical University ofBraunschweig, the University of Twente, and other parties. The following termsapply to all files associated with the software unless explicitly disclaimed inindividual files.

The authors hereby grant permission to use, copy, modify, distribute, and licensethis software and its documentation for any purpose, provided that existingcopyright notices are retained in all copies and that this notice is included verbatimin any distributions. No written agreement, license, or royalty fee is required forany of the authorized uses. Modifications to this software may be copyrighted by

Notices 233

their authors and need not follow the licensing terms described here, provided thatthe new terms are clearly indicated on the first page of each file where they apply.


THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANYWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULARPURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN“AS IS” BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NOOBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,ENHANCEMENTS, OR MODIFICATIONS.

Various copyrights apply to this package, listed in 3 separate parts below. Pleasemake sure that you include all the parts. Up until 2001, the project was based atUC Davis, and the first part covers all code written during this time. From 2001onwards, the project has been based at SourceForge, and Networks AssociatesTechnology, Inc hold the copyright on behalf of the wider Net-SNMP community,covering all derivative work done since then. An additional copyright section hasbeen added as Part 3 below also under a BSD license for the work contributed byCambridge Broadband Ltd. to the project since 2001.

Part 1: CMU/UCD copyright notice: (BSD like)

Copyright © 1989, 1991, 1992 by Carnegie Mellon University

Derivative Work - 1996, 1998-2000

Copyright © 1996, 1998-2000 The Regents of the University of California

All Rights Reserved

Permission to use, copy, modify and distribute this software and its documentationfor any purpose and without fee is hereby granted, provided that the abovecopyright notice appears in all copies and that both that copyright notice and thispermission notice appear in supporting documentation, and that the name of CMUand The Regents of the University of California not be used in advertising orpublicity pertaining to distribution of the software without specific writtenpermission.

CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIMALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALLIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENTSHALL CMU OR THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BELIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES ORANY DAMAGES WHATSOEVER RESULTING FROM THE LOSS OF USE, DATAOR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OROTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITHTHE USE OR PERFORMANCE OF THIS SOFTWARE.

Part 2: Networks Associates Technology, Inc copyright notice (BSD)


Copyright © 2001, Networks Associates Technology, Inc

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:v Redistributions of source code must retain the above copyright notice, this list of

conditions and the following disclaimer.v Redistributions in binary form must reproduce the above copyright notice, this

list of conditions and the following disclaimer in the documentation and/orother materials provided with the distribution.

v Neither the name of the NAI Labs nor the names of its contributors may be usedto endorse or promote products derived from this software without specificprior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ANDCONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AREDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS ORCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUTNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVERCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Part 3: Cambridge Broadband Ltd. copyright notice (BSD)

Portions of this code are copyright © 2001, Cambridge Broadband Ltd.


Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:v Redistributions of source code must retain the above copyright notice, this list of

conditions and the following disclaimer.v Redistributions in binary form must reproduce the above copyright notice, this

list of conditions and the following disclaimer in the documentation and/orother materials provided with the distribution.

v The name of Cambridge Broadband Ltd. may not be used to endorse or promoteproducts derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER “AS IS” ANDANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITEDTO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FORA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THECOPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUTNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVERCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

Notices 235

STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

BLT 2.4u

Portions (c) 1993 AT&T, (c) 1993 - 1998 Lucent Technologies, (c) 1994-1998 SunMicrosystems, Inc., and (c) 1987-1993 The Regents of the University of California.

Permission to use, copy, modify and distribute this software and its documentationfor any purpose and without fee is hereby granted, provided that the abovecopyright notice appears in all copies and that both that copyright notice and thispermission notice appear in supporting documentation, and that the names ofAT&T, Lucent Technologies Inc., Sun Microsystems, Inc. and The Regents of theUniversity of California not be used in advertising or publicity pertaining todistribution of the software without specific written permission.

THE COPYRIGHT HOLDERS AND OTHER CONTRIBUTORS DISCLAIM ALLWARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALLIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENTSHALL THE COPYRIGHT HOLDERS OR OTHER CONTRIBUTORS BE LIABLEFOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANYDAMAGES WHATSOEVER RESULTING FROM THE LOSS OF USE, DATA ORPROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OROTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITHTHE USE OR PERFORMANCE OF THIS SOFTWARE.

CMU-SNMP 1.14

CMU/UCD copyright notice: (BSD like)

Copyright 1989, 1991, 1992 by Carnegie Mellon University

Derivative Work - 1996, 1998-2000 Copyright 1996, 1998-2000 The Regents of theUniversity of California

All Rights Reserved




Scotty 2.8, incrTCL 3.0, [incr TCL] 3.2

Portions Copyright (c) 1987-1994 The Regents of the University of California.Copyright (c) 1994-1995 Sun Microsystems, Inc.

This software is copyrighted by the Regents of the University of California, SunMicrosystems, Inc., and other parties. The following terms apply to all filesassociated with the software unless explicitly disclaimed in individual files.

The authors hereby grant permission to use, copy, modify, distribute, and licensethis software and its documentation for any purpose, provided that existingcopyright notices are retained in all copies and that this notice is included verbatimin any distributions. No written agreement, license, or royalty fee is required forany of the authorized uses. Modifications to this software may be copyrighted bytheir authors and need not follow the licensing terms described here, provided thatthe new terms are clearly indicated on the first page of each file where they apply.


THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANYWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULARPURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN"AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NOOBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,ENHANCEMENTS, OR MODIFICATIONS.

RESTRICTED RIGHTS: Use, duplication or disclosure by the government is subjectto the restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in TechnicalData and Computer Software Clause as DFARS 252.227-7013 and FAR 52.227-19.

Portions Copyright (c) 1993-1998 Lucent Technologies, Inc.

Permission to use, copy, modify, and distribute this software and its documentationfor any purpose and without fee is hereby granted, provided that the abovecopyright notice appear in all copies and that both that the copyright notice andwarranty disclaimer appear in supporting documentation, and that the names ofLucent Technologies any of their entities not be used in advertising or publicitypertaining to distribution of the software without specific, written priorpermission.

Lucent disclaims all warranties with regard to this software, including all impliedwarranties of merchantability and fitness. In no event shall Lucent be liable for anyspecial, indirect or consequential damages or any damages whatsoever resultingfrom loss of use, data or profits, whether in an action of contract, negligence orother tortuous action, arising out of or in connection with the use or performanceof this software.

Notices 237

UCD SNMP 4.2.5

Portions Copyright 1989, 1991, 1992 by Carnegie Mellon University. DerivativeWork - 1996, 1998-2000, Copyright 1996, 1998-2000 The Regents of the University ofCalifornia All Rights Reserved



Portions Copyright: (c) 2001-2003, Networks Associates Technology, Inc, (c)2001-2003, Cambridge Broadband Ltd, (c) 2003-2005, Sparta, Inc., (c) 2004, Cisco,Inc and Information Network Center of Beijing University of Posts andTelecommunications, (c) Fabasoft R&D Software GmbH & Co KG, [email protected].


Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list ofconditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, thislist of conditions and the following disclaimer in the documentation and/or othermaterials provided with the distribution.

3. Neither the names of Networks Associates Technology, Inc, CambridgeBroadband Ltd., Sparta, Inc., Cisco, Inc, Beijing University of Posts andTelecommunications, Fabasoft R&D Software GmbH & Co KG or any of itssubsidiaries, brand or product names, nor the names of their contributors may beused to endorse or promote products derived from this software without specificprior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ANDCONTRIBUTORS `ÀS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AREDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS ORCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT


NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVERCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

JDOM 1.0

Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list ofconditions, and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, thislist of conditions, and the disclaimer that follows these conditions in thedocumentation and/or other materials provided with the distribution.

3. The name "JDOM" must not be used to endorse or promote products derivedfrom this software without prior written permission. For written permission, pleasecontact <request_AT_jdom_DOT_org>.

4. Products derived from this software may not be called "JDOM", nor may"JDOM" appear in their name, without prior written permission from the JDOMProject Management <request_AT_jdom_DOT_org>.

In addition, we request (but do not require) that you include in the end-userdocumentation provided with the redistribution and/or in the software itself anacknowledgement equivalent to the following:

"This product includes software developed by the JDOM Project(http://www.jdom.org/)." Alternatively, the acknowledgment may be graphicalusing the logos available at http://www.jdom.org/images/logos.

THIS SOFTWARE IS PROVIDED `ÀS IS'' AND ANY EXPRESSED OR IMPLIEDWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULARPURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS ORTHE PROJECT CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTEGOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDINGNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OFTHIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCHDAMAGE.

This software consists of voluntary contributions made by many individuals onbehalf of the JDOM Project and was originally created by Jason Hunter<jhunter_AT_jdom_DOT_org> and Brett McLaughlin <brett_AT_jdom_DOT_org>.For more information on the JDOM Project, please see <http://www.jdom.org/>.

Notices 239

Regex 1.1a

Copyright (C) 1996, 1999 Vassili Bykov. It is provided to the Smalltalk communityin hope it will be useful.

1. This license applies to the package as a whole, as well as to any component of it.By performing any of the activities described below, you accept the terms of thisagreement.

2. The software is provided free of charge, and `às is'', in hope that it will beuseful, with ABSOLUTELY NO WARRANTY. The entire risk and all responsibilityfor the use of the software is with you. Under no circumstances the author may beheld responsible for loss of data, loss of profit, or any other damage resultingdirectly or indirectly from the use of the software, even if the damage is caused bydefects in the software.

3. You may use this software in any applications you build.

4. You may distribute this software provided that the software documentation andcopyright notices are included and intact.

5. You may create and distribute modified versions of the software, such as portsto other Smalltalk dialects or derived work, provided that:

a. any modified version is expressly marked as such and is not misrepresented asthe original software;

b. credit is given to the original software in the source code and documentation ofthe derived work;

c. the copyright notice at the top of this document accompanies copyright noticesof any modified version.


Notices 241

IBM®

Printed in USA

Documents

with IBM Corp. - tnpmsupport.persistentsys.com · Huawei U2000 2.3.1.0 T echnology Pack ... . 226 Notices ... commands, and paths that ar e dependent on your operating system. About