with IBM Corp. · IBM T ivoli Netcool P erformance Mana ger 1.4.3 Wireless Component Document Revision R2E1 Administra tion Guide IBM

IBM Tivoli Netcool Performance Manager 1.4.3Wireless ComponentDocument Revision R2E1

Administration Guide

IBM

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

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

Contents

About this information . . . . . . . . viiAudience . . . . . . . . . . . . . . . viiRequired skills and knowledge . . . . . . . . viiThe Tivoli Netcool Performance Manager - Wirelesscomponent user publications . . . . . . . . viiService Management Connect . . . . . . . . viiiTivoli Netcool Performance Manager technicaltraining . . . . . . . . . . . . . . . viiiSupport information . . . . . . . . . . . viiiConventions used in this publication . . . . . . ix

Typeface conventions . . . . . . . . . . ix

Chapter 1. Architecture overview . . . . 1Definitions . . . . . . . . . . . . . . . 1Server architecture . . . . . . . . . . . . 2

Mediation services . . . . . . . . . . . 2Application framework . . . . . . . . . . 3User management services. . . . . . . . . 4Database services . . . . . . . . . . . . 5

Overview of administrator tasks . . . . . . . . 5Client application tasks . . . . . . . . . . 5Server application tasks. . . . . . . . . . 5

Data flow overview . . . . . . . . . . . . 6Client application tasks . . . . . . . . . . 6Client application tasks . . . . . . . . . . 6Application framework . . . . . . . . . . 6

Chapter 2. Setup tasks . . . . . . . . 9Software installation summary . . . . . . . . 9Data source setup . . . . . . . . . . . . 10LDAP - Security Directory Server setup . . . . . 10Crontab setup . . . . . . . . . . . . . 10

Virtuo user setup . . . . . . . . . . . 11root user Setup . . . . . . . . . . . . 11Additional entries and scripts . . . . . . . 12

Setting up SAP . . . . . . . . . . . . . 12SAP configuration . . . . . . . . . . . 13

Application and system passwords . . . . . . 15Application users . . . . . . . . . . . 15OS users . . . . . . . . . . . . . . 15Oracle users . . . . . . . . . . . . . 15

Enabling HTTPS protocol. . . . . . . . . . 16Disabling HTTPS protocol . . . . . . . . 19

Chapter 3. Starting and stopping thesystem. . . . . . . . . . . . . . . 21Oracle database . . . . . . . . . . . . . 21

Starting the Oracle database . . . . . . . . 21Stopping the Oracle database . . . . . . . 22

Security Directory Server . . . . . . . . . . 22Starting the Security Directory Server. . . . . 22Stopping the Security Directory Server . . . . 22

Jazz for Service Management . . . . . . . . 23Common directory locations for Jazz for ServiceManagement . . . . . . . . . . . . . 23

Starting Jazz for Service Management applicationservers . . . . . . . . . . . . . . . 27Stopping Jazz for Service Managementapplication servers . . . . . . . . . . . 27

Process Monitor . . . . . . . . . . . . . 28Starting the Process Monitor . . . . . . . . 28Stopping the Process Monitor . . . . . . . 28

Process Manager . . . . . . . . . . . . 29Starting the Process Manager . . . . . . . 29Stopping the Process Manager . . . . . . . 29

Tivoli Netcool Performance Manager . . . . . . 29Starting Tivoli Netcool Performance Manager . . 30Stopping Tivoli Netcool Performance Manager . 30

Tivoli Netcool Performance Manager completestartup and shutdown . . . . . . . . . . . 30

Complete startup . . . . . . . . . . . 31Complete shut down . . . . . . . . . . 32

Chapter 4. Application administration 35User administration . . . . . . . . . . . 35

User administration basics . . . . . . . . 35User management . . . . . . . . . . . 40Role management . . . . . . . . . . . 44User Administration Command Line Tool . . . 46

IBM Security Directory Server password policy . . 48Modifying IBM Security Directory ServerPassword Policy . . . . . . . . . . . . 49Modifying the Directory Server password policyand unlock the LDAP account . . . . . . . 51Checking the account status with extendedoperation tool . . . . . . . . . . . . 52

External Reporting administration . . . . . . . 53Setting external reporting properties . . . . . 54Setting SMTP properties . . . . . . . . . 55External reporting dictionary mapping . . . . 55

Report granularity . . . . . . . . . . . . 55Configuring support for 15-minute reportingintervals . . . . . . . . . . . . . . 56Enabling Report Definition GUI . . . . . . 56

Aggregation properties . . . . . . . . . . 57Modifying the values for aggregation properties 57

Excel download properties . . . . . . . . . 58Secondary keys . . . . . . . . . . . . . 58Maintaining property values for User Comments,Reports and MyFavorites . . . . . . . . . . 59

User comments . . . . . . . . . . . . 59Reports . . . . . . . . . . . . . . . 59MyFavorites . . . . . . . . . . . . . 60

KPI aliases and user defined groups . . . . . . 60KPI Aliases . . . . . . . . . . . . . 60User defined groups . . . . . . . . . . 61kpia_admin tool . . . . . . . . . . . . 61Importing aliases . . . . . . . . . . . 62Import user defined groups . . . . . . . . 63Import aliases and groups . . . . . . . . 64

© Copyright IBM Corp. 2006, 2017 iii

Removing user-defined groups . . . . . . . 64Updating and removing aliases and user-definedgroups . . . . . . . . . . . . . . . 64Export aliases and groups . . . . . . . . 65File formats . . . . . . . . . . . . . 65Log files . . . . . . . . . . . . . . 68

KPI Browser configurable parameters. . . . . . 68Configurable system variables . . . . . . . 68Configurable service properties . . . . . . . 72

Chapter 5. Operations tasks . . . . . 75Daily loader operations tasks . . . . . . . . 75

Checking loader status . . . . . . . . . 75Checking for bad files . . . . . . . . . . 76

Loader housekeeping . . . . . . . . . . . 79Disk space usage . . . . . . . . . . . 79LIF file storage . . . . . . . . . . . . 79Loader configuration . . . . . . . . . . 81Configuring multiple identical loaders . . . . 83

Stability settings . . . . . . . . . . . . . 84Application directory management . . . . . . 84

Directory contents . . . . . . . . . . . 84Tivoli Netcool Performance Manager log files . . 84Loader log files . . . . . . . . . . . . 85Loader LIF file directory . . . . . . . . . 85Crontab entries . . . . . . . . . . . . 86

Chapter 6. Datasource, agent and KPIcache administration . . . . . . . . 87Data source administration . . . . . . . . . 87

Usage . . . . . . . . . . . . . . . 88Listing data sources . . . . . . . . . . 88Activating a data source . . . . . . . . . 88Deactivating a data source . . . . . . . . 89

Agent maintenance . . . . . . . . . . . . 89Overview of agent activities . . . . . . . . 89Agent activities and log files. . . . . . . . 93agent_admin command-line tool . . . . . . 93

KPI cache management . . . . . . . . . . 101Exporting user-defined calculations . . . . . . 102Importing user-defined calculations . . . . . . 102Synchronize internal computation engine KPI cache 103Changing the aggregator of raw counters fordecode function . . . . . . . . . . . . 104Reenqueueing messages from exception queue toactive queue. . . . . . . . . . . . . . 104

Chapter 7. System maintenance . . . 105Schedule administration . . . . . . . . . . 105

Scheduled jobs . . . . . . . . . . . . 105Scheduling system maintenance . . . . . . 108Listing the status of all scheduled jobs . . . . 108Administrative options for the schedule_adminscript . . . . . . . . . . . . . . . 109

Reporting on server status . . . . . . . . . 110Database check . . . . . . . . . . . . 110Directory server check . . . . . . . . . 110SAPMON check . . . . . . . . . . . 110Tivoli Netcool Performance Manager check . . 111Log files check . . . . . . . . . . . . 111

Database monitoring . . . . . . . . . . 111Operating system checks . . . . . . . . 112

Managing the Oracle database . . . . . . . . 112Starting and stopping the Oracle database . . . 112Types of Oracle backups. . . . . . . . . 114Redo logs. . . . . . . . . . . . . . 115Archiving redo logs . . . . . . . . . . 115Performing hardware diagnostics . . . . . . 117Restoring data from backups . . . . . . . 117

Database space administration. . . . . . . . 118Monitor Oracle tablespaces . . . . . . . . 118Add Oracle tablespaces . . . . . . . . . 119Add Oracle data files . . . . . . . . . . 120Modify Oracle data files . . . . . . . . . 121Drop Oracle tablespaces . . . . . . . . . 122Resize an UNDO tablespace . . . . . . . 123

Partition maintenance . . . . . . . . . . 124Partition maintenance jobs . . . . . . . . 124Amend the partition maintenance jobconfiguration . . . . . . . . . . . . 124Partition maintenance command-line tool . . . 126Adding partitions . . . . . . . . . . . 129Deleting partitions. . . . . . . . . . . 131Adding and deleting daily sub partitions fortraffic tables . . . . . . . . . . . . . 131Pinning partitions . . . . . . . . . . . 133Unpinning partitions . . . . . . . . . . 133Exporting partitions . . . . . . . . . . 134Importing partitions . . . . . . . . . . 134Showing parameters . . . . . . . . . . 135Listing parameters. . . . . . . . . . . 135Updating parameters . . . . . . . . . . 135Listing partitions . . . . . . . . . . . 135List pinned partitions. . . . . . . . . . 136List sessions . . . . . . . . . . . . . 136Update sessions . . . . . . . . . . . 136List spaces . . . . . . . . . . . . . 136Show logs . . . . . . . . . . . . . 137Show errors . . . . . . . . . . . . . 137Show status . . . . . . . . . . . . . 137

Managing disk space usage. . . . . . . . . 137Monitoring the Oracle storage directories . . . 138Monitoring the $WMCROOT/logs directories 138Monitoring the $WMCROOT/var/loader/spooldirectories . . . . . . . . . . . . . 139Reporting the size of file systems. . . . . . 139

Working with log files . . . . . . . . . . 139Information about log files . . . . . . . . 140Removing log files . . . . . . . . . . 141Archiving log files. . . . . . . . . . . 141

Loader LIF file directory. . . . . . . . . . 142Java client processes . . . . . . . . . . . 142Backing up file system . . . . . . . . . . 143

Chapter 8. Tools . . . . . . . . . . 145Importing and exporting user documents andreport results . . . . . . . . . . . . . 145

Importing definitions, templates, schedules andfolders. . . . . . . . . . . . . . . 146Exporting definitions, templates and schedules 147Importing report results . . . . . . . . . 148

iv IBM Tivoli Netcool Performance Manager: Administration Guide

Exporting report results . . . . . . . . . 150Deleting report templates . . . . . . . . 151

Running a report from the command-line . . . . 152Timezone support for reporting . . . . . . . 152

About daylight saving time rules . . . . . . 153About timezone regions . . . . . . . . . 155

Holiday maintenance . . . . . . . . . . . 158List holidays . . . . . . . . . . . . 159Add holidays . . . . . . . . . . . . 159Delete holidays . . . . . . . . . . . . 160

Archiving an NC table . . . . . . . . . . 160Archiver tool usage . . . . . . . . . . 161

Chapter 9. LCM administration . . . . 163Loader data source . . . . . . . . . . . 163NC relations. . . . . . . . . . . . . . 163Data availability . . . . . . . . . . . . 163List information for data sources . . . . . . . 166Load data sources, NC relations and dataavailability . . . . . . . . . . . . . . 166

Loading a data source from XML. . . . . . 166Loading a custom data source from XML . . . 167Loading NC relations from XML . . . . . . 167Loading data availability from XML . . . . . 167Merging of data availability blocks from XML 168

Unload data sources and NC relations . . . . . 169Unloading a data source to XML . . . . . . 169Unloading a custom data source to XML . . . 169Unloading NC relations to XML . . . . . . 170Unloading data availability to XML . . . . . 170

Delete data sources and NC relations . . . . . 171Deleting NC relations . . . . . . . . . 171

LCM port change . . . . . . . . . . . . 172

Chapter 10. SBH administration . . . 173Stored Busy Hour (SBH) administration tool . . . 173

Enable Busy Hour definitions . . . . . . . 173Disable Busy Hour definitions . . . . . . . 174Import Stored Busy Hour definitions . . . . 174Export Stored Busy Hour definitions or values 174List SBH definitions . . . . . . . . . . 175Run SBH definitions . . . . . . . . . . 175Delete SBH definitions . . . . . . . . . 176Prioritize SBH . . . . . . . . . . . . 176Enable and disable calculation of late data forall Busy Hour definitions . . . . . . . . 176

Customizing Stored Busy Hour definitions . . . 177Stored Busy Hour definition . . . . . . . 177Overriding SBH execution engine . . . . . 180Improving the performance of PDE engine . . 180

Stored Busy Hour calculation . . . . . . . . 181Calculating the Stored Busy Hour value for afield entity level higher than focal entity . . . 181

Chapter 11. Alarm administration . . . 183Alarm administration tool . . . . . . . . . 183

Document contexts . . . . . . . . . . 183Alarm Template XML documents. . . . . . 184Version numbering . . . . . . . . . . 184Manage document contexts. . . . . . . . 185

List Alarm Templates . . . . . . . . . . 187Alarm definition Mib file . . . . . . . . 188

External Alarm API . . . . . . . . . . . 188alarmapi_admin . . . . . . . . . . . 188Generate an alarm. . . . . . . . . . . 188Clear an alarm . . . . . . . . . . . . 190Display a list of available reports . . . . . . 190Empty alarm spool daemon . . . . . . . 190Raising alarm if same severity alarm occursagain . . . . . . . . . . . . . . . 191Data availability alarms . . . . . . . . . 191Generate data availability alarms . . . . . . 194Log file . . . . . . . . . . . . . . 195Parameter values - lists . . . . . . . . . 195

Complex alarmer . . . . . . . . . . . . 199Running the complex alarmer . . . . . . . 199Configuring the complex alarmer. . . . . . 201Troubleshooting . . . . . . . . . . . 207

Adaptive alarmer . . . . . . . . . . . . 207Trend alarm . . . . . . . . . . . . . 208Derivative alarm . . . . . . . . . . . 209Stability alarm . . . . . . . . . . . . 210Using Adaptive alarmer . . . . . . . . . 210Troubleshooting adaptive alarmer . . . . . 218

Chapter 12. The summarizer andsummary administration. . . . . . . 221Summarizer . . . . . . . . . . . . . . 221

Switching the summary process on or off . . . 222Summary log file . . . . . . . . . . . 222Start day of week . . . . . . . . . . . 223Summary grace period . . . . . . . . . 223Summarize old loaded data . . . . . . . 224

summary_admin CLI . . . . . . . . . . . 224Provision a summary. . . . . . . . . . 224Delete a summary definition . . . . . . . 226Run a provisioned summary . . . . . . . 226Change the number of instances . . . . . . 227Export summary metadata . . . . . . . . 227List summary definitions . . . . . . . . 228Prioritize summaries . . . . . . . . . . 228Enable a summary . . . . . . . . . . 229Disable a summary . . . . . . . . . . 229

Configuring summary definitions . . . . . . 229KPI naming conventions . . . . . . . . 230Simple summary definition. . . . . . . . 230Complex summary definition . . . . . . . 233Ignoring data availability . . . . . . . . 238Two layer summary aggregation . . . . . . 238

Chapter 13. Technology packadministration tools . . . . . . . . 243The techpack_admin tool . . . . . . . . . 243Applying a technology pack . . . . . . . . 244

Memory for Java client processes . . . . . . 244Exporting lists of dependencies . . . . . . . 245Patching a technology pack. . . . . . . . . 245Listing technology pack modules . . . . . . . 245Uninstalling a technology pack, and loaders . . . 246

Technology pack . . . . . . . . . . . 246

Contents v

Removing associated loaders . . . . . . . 247Removing the data source . . . . . . . . 247Dependent technology packs . . . . . . . 247

Displaying help . . . . . . . . . . . . 248Check differences between technology packs . . . 248Upgrading a technology pack . . . . . . . . 248Upgrading technology packs . . . . . . . . 250

Effects of a technology pack upgrade . . . . 251Unsupported upgrade scenario . . . . . . . 251Upgrading or reinstalling installed technologypacks . . . . . . . . . . . . . . . . 252Using the migratealarms tool . . . . . . . . 255Gomlet upgrade feature . . . . . . . . . . 256

Supported Gomlet upgrade scenarios . . . . 256Scenarios which are supported if there are nodependent technology packs . . . . . . . 256Unsupported scenarios . . . . . . . . . 257

Appendix A. Problem resolution anderrors. . . . . . . . . . . . . . . 259Problem resolution . . . . . . . . . . . 259

Running multiple instances on the same server 259Duplicate lc_relations entries . . . . . . . 259Unresponsive script error . . . . . . . . 259Adobe Flash Player . . . . . . . . . . 260

Errors . . . . . . . . . . . . . . . . 260SQLFatalErrorException: ORA-28000: theaccount is locked . . . . . . . . . . . 260

OutOfMemoryError: Java heap space . . . . 260

Appendix B. Cold standby . . . . . . 263Setup standby server . . . . . . . . . . . 263Backup all required data . . . . . . . . . 264

Backup Oracle database . . . . . . . . . 264Backup Tivoli Common Reporting . . . . . 265Backup Tivoli Netcool Performance Managerapplications . . . . . . . . . . . . . 265Backup LDAP data . . . . . . . . . . 267

Restore all required data to the cold standby . . . 267Oracle database restore procedure . . . . . 267Updating database tables . . . . . . . . 269Restoring Tivoli Common Reporting. . . . . 270Restore applications . . . . . . . . . . 270Restore directory server . . . . . . . . . 272Restore application services . . . . . . . 273

Configure and run the cold standby . . . . . . 274Run reset_scheduler script . . . . . . . . 274Start applications . . . . . . . . . . . 275

Notices . . . . . . . . . . . . . . 277Trademarks . . . . . . . . . . . . . . 279Terms and conditions for product documentation 280

vi IBM Tivoli Netcool Performance Manager: Administration Guide

About this information

The Administration Guide provides instructions and general information on howto maintain and support IBM® Tivoli® Netcool® Performance Manager Wirelesssystem.

AudienceThis guide is intended for experienced system administrators, databaseadministrators or other professionals who are responsible for maintaining a TivoliNetcool Performance Manager installation.

Required skills and knowledgeThe skills and knowledge that are required in order for you to follow theprocedures outlined in this document.

This guide assumes you are familiar with the following:v Oracle databasesv IBM Security Directory Serverv Linux® and UNIX® basics (such as file structures, text editing, and permissions)v Linux and UNIX system administration.

This guide also assumes that you are familiar with your company's network andwith procedures for configuring, monitoring, and solving problems on yournetwork.

The Tivoli Netcool Performance Manager - Wireless component userpublications

Tivoli Netcool Performance Manager - Wireless component consists of thefollowing publications:

Table 1. Tivoli Netcool Performance Manager - Wireless component user documentation

Document Description

Release Summary for Tivoli Netcool PerformanceManager

Additional release-specific information not in theguides.

Installing Tivoli Netcool Performance Manager -Wireless Component

Instructions for installing and configuring theTivoli Netcool Performance Manager software.

Upgrading Tivoli Netcool Performance Manager -Wireless Component

Instructions for upgrading Tivoli NetcoolPerformance Manager software.

Administering Tivoli Netcool Performance Manager -Wireless Component

Instructions and general information about how tomaintain and support Tivoli Netcool PerformanceManager

Using Tivoli Netcool Performance Manager - WirelessComponent

Conceptual information and procedures for usingTivoli Netcool Performance Manager software forperformance, trending analysis and performancealarms.

Installing and Using Tivoli Netcool PerformanceManager - Application Studio - Wireless Component

Provides instructions for installation and usage ofthe Tivoli Netcool Performance Manager -Application Studio.

© Copyright IBM Corp. 2006, 2017 vii

Table 1. Tivoli Netcool Performance Manager - Wireless component userdocumentation (continued)

Document Description

Integrating with Tivoli Monitoring - WirelessComponent

Provides instructions for integrating IBM TivoliMonitoring with Tivoli Netcool PerformanceManager.

Integrating with Tivoli Netcool/OMNIbus Web GUI -Wireless Component

Provides instructions for integrating IBM TivoliNetcool/OMNIbus Web GUI with Tivoli NetcoolPerformance Manager.

The documentation is available on the knowledge center at http://www-01.ibm.com/support/knowledgecenter/SSBNJ7/welcome.

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.

viii IBM Tivoli Netcool Performance Manager: Administration Guide

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7/welcome

http://www-01.ibm.com/support/knowledgecenter/SSBNJ7/welcome

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

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.

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

About this information ix

x IBM Tivoli Netcool Performance Manager: Administration Guide

Chapter 1. Architecture overview

The Tivoli Netcool Performance Manager System is consisted of Tivoli NetcoolPerformance Manager server and a client layer.

The client layer is the web-based user interface to the Tivoli Netcool PerformanceManager application server. The Tivoli Netcool Performance Manager serverarchitecture is consisted of several subsystems:v Mediation servicesv Gateways, Data Acquisition Toolv Tivoli Netcool Performance Manager, application frameworkv Client access layer servicesv Platform Management servicesv Business servicesv Data Loading servicesv Database servicesv User Management Servicesv Security Directory Server - LDAP

The deployment model of these subsystems depends on whether theimplementation is on a centralized or distributed network system. For simplicity,this overview illustrates the single-server deployment model.

DefinitionsDefinitions of architectural elements.v Tivoli Netcool Performance Manager servers - composes of all services that are

used by Tivoli Netcool Performance Manager including Mediation, UserManagement, Database Services, and the Tivoli Netcool Performance Managerapplication framework.

v Tivoli Netcool Performance Manager application framework - the coreapplication along with extensions for vendor technology packs that provideservices to users to create and generate reports.

v Database services - an Oracle database.v Mediation services - utilities to access data (data files) from network elements

and transform them for loading into the Tivoli Netcool Performance Managerdatabase.

The following figure illustrates the system in a client-single server deploymentmodel.

© Copyright IBM Corp. 2006, 2017 1

Each of the major components important to administering the servers is describedin the following sections.

Server architectureThe Tivoli Netcool Performance Manager server architecture composes of allservices that are used by Tivoli Netcool Performance Manager includingMediation, User Management, Database Services, and the Tivoli NetcoolPerformance Manager application framework.

Mediation servicesMediation services include the Gateway Framework and the Data Acquisition tool.

Theses tools transfer, parse, manipulate, and present performance data from thenetwork elements to the application. The main output of this process is theproduction of a lif (loader intermediate format) file for loading into the database.

Figure 1. Tivoli Netcool Performance Manager - Architecture

2 IBM Tivoli Netcool Performance Manager: Administration Guide

Application frameworkThe Tivoli Netcool Performance Manager application framework operates on alayer between the Tivoli Netcool Performance Manager database and the TivoliNetcool Performance Manager web client.

These components:v Input data in the databasev Retrieve and cache data from the database upon user requestv Serve pages to the web client interface for use by the userv Manage schedule and services to maintain the databasev Manage schedules and services that are related to user report generation

Data loadingWhen the data is delivered in the correct format to the applicable spool directory, aloader loads the data in to the database.

LoadersThe role of the loaders is to prepare and process the loading of the datainto the database. On a system, there might be any number of loaders thatare running for any number of technologies. The loader process runsconstantly, taking data from the loader spool directories and loading theperformance database.

Loader Configuration ManagerThe loader configuration manager enables data sources, LoaderConfigurations and NC Relations to be loaded from XML files into theadministration database, and unloaded from the administration database toXML files.

Platform management servicesThe platform management services are composed of several process utilities thatwork together to set up, control and monitor the application server.

SAP is the process management utility that consists of a process manager andmonitor. These tools are installed on the server and run from a Korn shell:

sapmon-naThe parent utility process to the application server process. It is responsiblefor the start and control of the application framework.

sapmgr-naThe process framework manager that registers all the Tivoli NetcoolPerformance Manager processes including the application server and theloaders.

sap The utility that is used to display the status, start, and stop the registeredprocesses.

PM business servicesThe performance management services consist of those services, which provide theuser with the functions they need to access the database and produce performancemanagement reports.

Some of the services are common or core services that the application uses tomaintain the system and services. Other services provide specific applicationfunctions.

Chapter 1. Architecture overview 3

Common and core services

These services are associated with the underlying architecture and framework thatis implemented in Tivoli Netcool Performance Manager. These services provide thebase functions to allow:v The user to interact with the systemv The system to perform critical jobs that monitor and maintain the database and

application frameworkv The system to deploy technology packs, upgrades, and patchesv The system to maintain the databasev The report generation process to occur

These services are provided by the following components of the Tivoli NetcoolPerformance Manager application framework:v Application server - The application server consists of the JBoss application

server and the agent framework. These components are used to:– Communicate with the LDAP server and data source to generate reports.– Gather information about the data source and other items to define a report.

v Legacy services - this framework consists of processes necessary for jobs to runthat maintain and monitor the system. Some examples are:– scheduler– queues– partition maintenance– summary creation

v Report Generator - The report generator is a dynamic SQL generator that allowsthe user to interact with the interface and produce dynamic SQL queries to thedatabase as in report definition or interaction request.

Application servicesv Alarm management - The alarm management module allows the user to view

alarms.

Client access layerThe client access layer is a subsystem of the JBoss server.

It is the web or HTML page server that provides the static and dynamic contentfor the web client interface.

User management servicesUser management is supported by a Lightweight Directory Access Protocol (LDAP)server.

The LDAP server provides the framework for implementation of roles, groups, andusers for through a single 'sign-on' authentication.


Database servicesThe web client accesses data that is stored in the database on the applicabledatabase server.

Data is kept in an Oracle Relational Database Management System (RDBMS).

This data includes:v Performance measurements, configuration information, and database-utilization

information from the infrastructure equipment.v Configuration data for the application itself; for example, the data loading

formula and report definitions.v Timetables that are used for scheduling reports, summarizing data, archiving

data and performing automated management tasks.

Overview of administrator tasksAn overview of the tasks carried out by the administrator of client application,application server, and associated application tools.

Client application tasksTasks carried out by the administrator of the client application.

As an administrator, you use the web client interface to accomplish the followingtasks:v User management - Add or delete users, and modify user access to the database

and to data within the application.

Server application tasksTasks carried out by the administrator of the application server and associatedapplication tools.

As an administrator of the application server and associated application tools, youuse command-line tools and UNIX or Linux commands to accomplish thefollowing tasks:v Monitor application processes - sapv Starting and stopping Tivoli Netcool Performance Manager - sapmon-na,

sapmgr-na, sapv Maintain schedules - schedule_adminv Monitor and maintain database partitions - schedule_admin, part_adminv Monitor agent framework (JBoss) activities - review logs, agent_adminv Monitor the health of the server and its subsystems - various UNIX and Linux

commandsv Configure parameters for user use - holiday_admin, user_admin, tz_admin,

alarm_admin


Data flow overviewData flow overview







GatewaysThe Gateways are scripts that are usually written in Perl or AWK languages thathave been designed to convert a specific set of performance counters from adefined equipment vendor to the standard .lif format used in Tivoli NetcoolPerformance Manager.

Gateways are customized for this specific use and cannot be used for a data setgenerated by another vendor or equipment.

Application frameworkThe Tivoli Netcool Performance Manager application framework operates on alayer between the Tivoli Netcool Performance Manager database and the TivoliNetcool Performance Manager web client.

These components:v Input data in the databasev Retrieve and cache data from the database upon user requestv Serve pages to the web client interface for use by the userv Manage schedule and services to maintain the databasev Manage schedules and services that are related to user report generation

Platform management servicesThe role of the platform management services is to start and maintain the runningof the application processes.

If the processes are not running then a user can not access the system to runreports.

The process management framework consists of three process utilities; sapmon,sapmgr and sap. These services along with the applicable loaders must be runningto:v Place the managed element data into the database


v Provide basic application functionality to the user.

Data loadingWhen the data is delivered in the correct format to the applicable spool directory, aloader loads the data in to the database.

LoadersThe role of the loaders is to prepare and process the loading of the datainto the database. On a system, there might be any number of loaders thatare running for any number of technologies. The loader process runsconstantly, taking data from the loader spool directories and loading theperformance database.

Loader Configuration ManagerThe loader configuration manager enables data sources, LoaderConfigurations and NC Relations to be loaded from XML files into theadministration database, and unloaded from the administration database toXML files.

PM business servicesThe performance management services consist of those services, which provide theuser with the functions they need to access the database and produce performancemanagement reports.

Some of the services are common or core services that the application uses tomaintain the system and services. Other services provide specific applicationfunctions.

Common and core services

These services are associated with the underlying architecture and framework thatis implemented in Tivoli Netcool Performance Manager. These services provide thebase functions to allow:v The user to interact with the systemv The system to perform critical jobs that monitor and maintain the database and

application frameworkv The system to deploy technology packs, upgrades, and patchesv The system to maintain the databasev The report generation process to occur

These services are provided by the following components of the Tivoli NetcoolPerformance Manager application framework:v Application server - The application server consists of the JBoss application

server and the agent framework. These components are used to:– Communicate with the LDAP server and data source to generate reports.– Gather information about the data source and other items to define a report.

v Legacy services - this framework consists of processes necessary for jobs to runthat maintain and monitor the system. Some examples are:– scheduler– queues– partition maintenance– summary creation


v Report Generator - The report generator is a dynamic SQL generator that allowsthe user to interact with the interface and produce dynamic SQL queries to thedatabase as in report definition or interaction request.

Application servicesv Alarm management - The alarm management module allows the user to view

alarms.

Client access layerThe client access layer is a subsystem of the JBoss server.

It is the web or HTML page server that provides the static and dynamic contentfor the web client interface.


Chapter 2. Setup tasks

Describes a number of tasks that must be performed as part of the installation ofTivoli Netcool Performance Manager.

You do not need to perform these tasks again, they are described for informationpurposes.

Setup tasks include:v Software installation summaryv Data sourcesv LDAP setupv Crontab setupv SAP

Software installation summaryTivoli Netcool Performance Manager architecture and installation summary.

The Tivoli Netcool Performance Manager architecture is typically made up of fourcomponents, each with specific functions:v The Application Component consists of the Tivoli Netcool Performance Manager

software, which is used to run an application frameworkv The Gateway Component deals with the processing of data, which is

downloaded from data sourcesv The database Component consists of an Oracle database, which the system uses

to store datav The Client PC is used to run the Tivoli Netcool Performance Manager GUI.

Components can be installed on a single server or distributed over severalmachines. For example, a single server might be used for the Application, Gatewayand database Components, or these three components might be split over threeservers.

Installation includes a number of tasks. The following table lists the maininstallation tasks.

Task Description

User and Group accounts creation User and group accounts creation.

Software installation Installing Tivoli Netcool PerformanceManager, and required third-party products.

Gateway installation Deploying gateway packages.

Technology Pack installation Installing technology packs.

Cronjob installation Installing cronjobs.

Configuring and starting Tivoli NetcoolPerformance Manager

Configuring and starting Tivoli NetcoolPerformance Manager.


Data source setupData sources provide the system with the necessary performance data for reports.

Data sources are typically servers that contain entity and performance datainformation.

For more information on data sources see Chapter 6, “Datasource, agent and KPIcache administration,” on page 87.

LDAP - Security Directory Server setupThe Security Directory Server is an LDAP directory service to manage users, roles,and privileges.

The directory server is installed as a prerequisite to the installation of TivoliNetcool Performance Manager.

For information on starting and stopping the directory server, see “SecurityDirectory Server” on page 22.

The directory server needs to be started to allow users to log in through the TivoliNetcool Performance Manager GUI.

Tivoli Netcool Performance Manager users, privileges, roles, and groups can bealtered/created through the GUI. See Chapter 4, “Application administration,” onpage 35.

Crontab setupThe crontab setup is installed and set up as part of the main installation.

The crontab is installed by using the following script:

$WMCROOT/admin/common/install/scripts/cron_install

Note: See the Installing Tivoli Netcool Performance Manager - Wireless Component, formore information on installing Cron.

The installation sets up the virtuo and root user scheduled Cron tasks.

There are two different cron setup that are installed for the two different users:v virtuo user cron setupv root user cron setup

The installation uses the following two crontab files to set up the virtuo and rootuser crontab list.

$WMCROOT/admin/common/cron/core_root_crontab

$WMCROOT/admin/common/cron/core_virtuo_crontab


Virtuo user setupThe default crontab list for a basic installation.

About this task

The following is a sample default crontab list for a basic installation.

Procedure

As user virtuo, enter:

Note: All occurrences of /appl/virtuo indicate the $WMCROOT directory.crontab -l

0 1 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 31/data/trace_archive1 \*.log.\*0 1 * * * /appl/virtuo/admin/common/cron/cron_script -a -d 0/appl/virtuo/logs \*.log.\* /data/trace_archive114,29,44,59 * * * * /appl/virtuo/bin/alarmapi_admin -da >/dev/null 2>&130 * * * * /appl/virtuo/bin/run_loader_cleanup 3600 >/dev/null 2>&10 3 * * * /appl/virtuo/admin/common/cron/cron_script -a -d 5/appl/virtuo/logs/nc_archiver \*log.\* /data/trace_archive10 3 * * * /appl/virtuo/admin/common/cron/cron_script -p -d 3/appl/virtuo/logs/loader \*.log.\* /data/trace_archive12,17,32,47 * * * * /appl/virtuo/bin/run_itm_rawcoverage_logger >/dev/null 2>&11,16,31,46 * * * * /appl/virtuo/bin/run_itm_usage_logger 15 >/dev/null 2>&10 1 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 1/appl/virtuo/var/rg/spool/export/reports \*.csv0 1 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 1/appl/virtuo/var/rg/spool/export/reports \*.xml0 1 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 1/appl/virtuo/var/rg/spool/export/reports \*.xls

root user SetupThe default crontab list for a basic installation.

About this task

The following is a sample.

Note: Some environments have extra entries.

Procedure

As user root:crontab -l

0 23 * * * /appl/virtuo/admin/oracle/cron/roll_listener_log0 23 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 2 CROND_LOG log.\*0 23 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 2 CROND_OLOG olog.\*0 23 * * * /appl/virtuo/admin/common/cron/roll_cron_log0 22 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 2 /tmp crout\*0 23 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 2 /appl/oracle/product/12.1.0.2.0/

Chapter 2. Setup tasks 11

db_1/network/log listener.log.\*0 23 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 5 /oradump/vtdb vtdb_arch_\*0 23 * * * /appl/virtuo/admin/common/cron/cron_script -r -d 2 /appl/ldap/idsslapd-idsinst/logs \*.log

Additional entries and scriptsAdding cron tab entries allows you to schedule and automate the running ofscripts.

The following script is also available:0 2 * * * /appl/virtuo/admin/common/cron/archive_loader_data -wmcr /appl/virtuo

This script archives .lif data files (files that are produced by the gateways andprocessed by the loaders in large volumes). The entry that is shown above is notadded to the crontab by default, it must be added by the administrator.

Crontab entries can be added if more scripts are written or more log files aregenerated. Cron entries are added by editing the cron list by using crontab -e

The following files are the generated cron files - these are the files that are changedby using crontab -e for root and virtuo users:/var/spool/cron/crontabs/virtuo/var/spool/cron/crontabs/root

Setting up SAPSAP is a process management utility that consists of a process manager andmonitor.

About this task

The Process Monitor manages the restart ability of Tivoli Netcool PerformanceManager. The Process Manager registers all the Tivoli Netcool PerformanceManager processes.

SAP scripts are installed under $WMCROOT/bin as part of the core installation.

Procedurev The SAP manager and framework is started by using the following commands,

as user root :

svcadm enable sapmon-nasvcadm enable sapmgr-na

service sapmonvirtuo startservice sapmgrvirtuo start

/etc/rc.d/init.d/sapmonvirtuo start/etc/rc.d/init.d/sapmgrvirtuo start

For more information on starting and stopping SAP utilities, see “ProcessMonitor” on page 28 and “Process Manager” on page 29.

v Processes are started by using the following command:


svcadm enable sap-na

service sapvirtuo start

/etc/rc.d/init.d/sapvirtuo start

v Individual processes can be started by using:

svcadm enable <process_name> -na

service <process_name> start

sap start <process_name>

v Information on processes can be displayed by using:sap disp or;sap disp -l for verbose outputProducing the following example output for sap disp:NAME STATE SINCEas STARTED Feb 13, 2009asd STARTED Feb 13, 2009nc_cache STARTED Feb 13, 2009alarm_cache STARTED Feb 13, 2009load_nokiabss_oss31ed3 stopped -

Producing the following example output for sap disp -l:NAME STATE SINCE HOST GROUP STIME PIDas STARTED Oct 23, 2008 <core_host> asgroup Oct 23, 2008 17277nc_cache STARTED Oct 29, 2008 <core_host> loadercache Oct 29, 2008 6716alarm_cache STARTED Oct 29, 2008 <core_host> loadercache Oct 29, 2008 6726load_<loadername> stopped - <target_host> Ericsson GSM BSS - -

SAP configurationThe processes are automatically configured in SAP following core installation.

The SAP tool uses property files to start the application server and configuredloaders. These files are stored in the following locations$WMCROOT/conf/processes/*.properties

The following is a sample application server property file:## application server#com.comp.process.as.exec=@{WMCROOT}/bin/run_ascom.comp.process.as.params=com.comp.process.as.group=asgroupcom.comp.process.as.start.pmgtprovider=falsecom.comp.process.as.host=${WMCHOST}com.comp.process.as.start.sequence=1


Table 2. Application Server Property File - Variable Descriptions

Variables Description

com.comp.process.as.exec=@{WMCROOT}/bin/run_as

Describes the command that is run when the user enterssap start.

com.comp.process.as.params= The space separated command-line arguments for theprocess. The variable is optional.

com.comp.process.as.group=asgroup Describes the group of processes that this processbelongs to. As well as using sap start <process name>, itis possible to start a group by using sap start <groupname>. The variable is optional.

com.comp.process.as.start.pmgtprovider=false

Defines whether the process makes callbacks to informthe framework of its init states. The variable is optionaland defaults to false.

com.comp.process.as.host=${WMCHOST} Defines the name of the server that this process runs on.

com.comp.process.as.start.sequence=1 Defines the order in which processes are started. Thenumbers must be sequential. If more than one process isgiven the same sequence number the user does not knowwhich process started first. This also applies to thedefault value of 0. If two processes are allowed to usethe default value of 0 the user does not know whichprocess started first. The variable is optional.

The following is a sample loader property file:com.comp.process.load_nokiabss_oss31ed3.exec=\@{WMCROOT}/bin/run_njloadercom.comp.process.load_nokiabss_oss31ed3.params=nokiabss_oss31ed3com.comp.process.load_nokiabss_oss31ed3.group=Nokia GSM BSScom.comp.process.load_nokiabss_oss31ed3.host=\${WMCHOST}com.comp.process.load_nokiabss_oss31ed3.start.pmgtprovider=falsecom.comp.process.load_nokiabss_oss31ed3.start.sequence=401com.comp.process.load_nokiabss_oss31ed3.start.timeout=5000

Table 3. Loader Property File - Variable Descriptions

Variables Description

com.comp.process.load_nokiabss_oss31ed3.exec=\@{WMCROOT}/bin/run_njloader

The command that is runs when users start the loader,run_njloader.

com.comp.process.load_nokiabss_oss31ed3.params=nokiabss_oss31ed3

The name of the loader, nokiabss_oss31ed3.

com.comp.process.load_nokiabss_oss31ed3.group=Nokia GSM BSS

The group of processes to which the loader belongs.

com.comp.process.load_nokiabss_oss31ed3.host=\${WMCHOST}

The name of the server that this process runs on.

com.comp.process.load_nokiabss_oss31ed3.start.pmgtprovider=false

Defines whether the process makes callbacks to informthe framework of its init states. The variable is optionaland defaults to false.

com.comp.process.load_nokiabss_oss31ed3.start.sequence=401

Defines the order in which processes are started. Theactual numbers do not have to be sequential. If morethan one process is given the same sequence number theuser does not know which process started first. Thedefault value is 0 and this variable is optional.

com.comp.process.load_nokiabss_oss31ed3.start.timeout=5000

Defines the timeout period that is, length of time to waitto restart the loader if the loader fails to start.


Manual configuration of processes through SAP is not necessary.

Application and system passwordsProvides information about changing default passwords for Tivoli NetcoolPerformance Manager.

Application usersThe list of Tivoli Netcool Performance Manager application users that cannot bemodified.

For configured users, refer to “User administration” on page 35.

The following Tivoli Netcool Performance Manager application users might not bemodified:v USERADM

v VIRTUO

v SYSADM

OS usersThe list of UNIX users for which customer system administration security rulesmight apply.

For the following UNIX users, customer system administration security rules mightapply.v VIRTUO

v ORACLE

Oracle usersOracle users and password administration.

Database usersThe list of database users for which the passwords must be changed.

The passwords for the following database users must be changed:v SYS - To be changed by database administratorv SYSTEM - To be changed by database administratorv VIRTUO - To be changed by database administrator

Note: The new passwords might need to be given to IBM Support if support isrequired to make database changes.

The following user is not used in application but is used by the Oracle EnterpriseManager. It is advised that this password is changed.v DBSNMP - To be changed by database administrator

Oracle usersThe list of Oracle users that are not used.

The passwords for these users can be changed without affecting the system.v DIP - “LOCKED and EXPIRED”v MGMT_VIEW - “LOCKED and EXPIRED”


v OUTLN - “LOCKED and EXPIRED”"v SYSMAN - “LOCKED and EXPIRED”v TSMSYS - “LOCKED and EXPIRED”v WMSYS - “LOCKED and EXPIRED”

For further information on Oracle Security, see the Oracle white paper:

http://www.oracle.com/technology/deploy/security/database-security/pdf/twp_security_checklist_database.pdf

Enabling HTTPS protocolConfiguration that is required to enable HTTPS protocol.

Before you begin

You must back up the following files:v $WMCROOT/as/server/default/deploy/jbossweb-tomcat55.sar/server.xml

v $WMCROOT/as/server/default/deploy/http-invoker.sar/invoker.war/WEB-INF/web.xml

v $WMCROOT/as/server/default/deploy/http-invoker.sar/META-INF/jboss-service.xml

Procedure1. Edit the $WMCROOT/as/server/default/deploy/jbossweb-tomcat55.sar/

server.xml to comment out the HTTP/1.1 Connector block as follows:

Add the following lines:<Connector port="${vallent.as.web.http.port}" address="${jboss.bind.address}"maxThreads="100" strategy="ms" maxHttpHeaderSize="8192"emptySessionPath="true" algorithm="IbmX509"enableLookups="false" redirectPort="${vallent.as.web.redirect.port}" acceptCount="100"connectionTimeout="20000" disableUploadTimeout="true" compression="200000"compressableMimeType="text/html,text/xml,text/css,text/plain,text/javascript,application/javascript,application/x-javascript,image/png,image/jpg,image/gif,application/x-amf,application/java-archive"

scheme="https" secure="true" clientAuth="false"keystoreFile="${jboss.server.home.dir}/conf/server.keystore"keystorePass="changeit" sslProtocol = "TLS"/>




2. Update the $WMCROOT/as/server/default/deploy/http-invoker.sar/invoker.war/WEB-INF/web.xml to change the value of type attribute in thefollowing block to HTTPS from HTTP:<param-value>jboss:service=invoker,type=https</param-value><param-value>jboss:service=invoker,type=https,target=Naming</param-value><param-value>jboss:service=invoker,type=https,target=Naming,readonly=true</param-value>

3. Update the $WMCROOT/as/server/default/deploy/http-invoker.sar/META-INF/jboss-service.xml to change the value of type and InvokerURLPrefix attributesto HTTPS in the following mbean blocks:<mbean code="org.jboss.invocation.http.server.HttpInvoker"

name="jboss:service=invoker,type=https"><attribute name>="InvokerURLPrefix">https://</attribute>

<mbean code="org.jboss.invocation.http.server.HttpProxyFactory"name="jboss:service=invoker,type=https,target=Naming">

<attribute name>="InvokerURLPrefix">https://</attribute>

<mbean code="org.jboss.invocation.http.server.HttpProxyFactory"name="jboss:service=invoker,type=https,target=Naming,readonly=true">

<attribute name>="InvokerURLPrefix">https://</attribute>

For example:<mbean code="org.jboss.invocation.http.server.HttpProxyFactory" name="jboss:service=invoker,type=https,target=Naming">

<attribute name="InvokerName">jboss:service=Naming</attribute>

<attribute name="InvokerURLPrefix">https://</attribute><attribute name="InvokerURLSuffix">:${vallent.as.web.http.port}/invoker/JMXInvokerServlet</attribute><attribute name="UseHostName">true</attribute><attribute name="ExportedInterface">org.jnp.interfaces.Naming</attribute><attribute name="JndiName" />

<attribute name="ClientInterceptors"><interceptors>

<interceptor>org.jboss.proxy.ClientMethodInterceptor</interceptor><interceptor>org.jboss.proxy.SecurityInterceptor</interceptor><interceptor>org.jboss.naming.interceptors.ExceptionInterceptor</interceptor><interceptor>org.jboss.invocation.InvokerInterceptor</interceptor></interceptors></attribute></mbean>

4. Run the following command as user virtuo to generate the keystore localhostas the first and last name and changeit as the password:$WMCROOT/jre/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore$WMCROOT/as/server/default/conf/server.keystore -validity 36500


Enter keystore password:Re-enter new password:What is your first and last name?[Unknown]:localhostWhat is the name of your organizational unit?[Unknown]:What is the name of your organization?[Unknown]:What is the name of your City or Locality?[Unknown]:What is the name of your State or Province?[Unknown]:What is the two-letter country code for this unit?[Unknown]:Is CN=Unknown, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown correct?(type "yes" or "no")[no]: yes

Enter key password for <tomcat>:(RETURN if same as keystore password):

5. Add the certificate to the Java keystore when you set up the SSL. To exportcertificate to file, use the following command:$WMCROOT/jre/bin/keytool -export -alias tomcat -storepass changeit -file$WMCROOT/tomcat.cer -keystore $WMCROOT/as/server/default/conf/server.keystore

The output of the command is as follows:

Certificate stored in file </appl/virtuo/tomcat.cer>

Import the certificate to the Java keystore as root user, use the followingcommands:su - rootcd /appl/virtuo/jre/lib/security/appl/virtuo/jre/bin/keytool -import -alias tomcat -keystorecacerts -file /appl/virtuo/tomcat.cer


Enter keystore password:Re-enter new password:Owner: CN=Unknown, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=UnknownIssuer: CN=Unknown, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=UnknownSerial number: 5208911eValid from: 8/12/13 1:09 PM until: 7/19/13 1:09 PMCertificate fingerprints:MD5: F4:2C:D8:F4:82:47:17:62:46:65:39:FD:C8:B4:8F:32SHA1: 15:83:FD:7E:64:05:23:4D:BD:C3:B6:E7:A6:59:CD:72:B0:26:25:26Trust this certificate? [no]: yesCertificate was added to keystore

6. Stop and start the Application Server by using the following command:sap stop assap start as

7. Optional: Right-click the Active Events List in OMNIbus Web GUI to run theTivoli Netcool Performance Manager defined JavaScript file. This file location isspecified in the Integrating Tivoli Netcool/OMNIbus Web GUI for Wireless. Intnpmforwireless.cgi file, update the var _protocol value to HTTPS as follows:var _protocol="https://";

8. Start sqlplus as the virtuo user:sqlplus virtuo/virtuo_password@vtdb


9. Run the following command to update the links when you switch protocolfrom http to https:SQL> update alarm_alarms set additional_text = replace(additional_text,'http','https') where substr(additional_text,1,5) = 'http:';SQL> commit;

Results

Start the web browser after the HTTPS is enabled by using the following URL:https://<hostname>:<port>/tnpmw/login.do

Disabling HTTPS protocolConfiguration that is required to disable HTTPS protocol.

Procedure1. Restore the following backup files that you have from “Enabling HTTPS

protocol” on page 16.v $WMCROOT/as/server/default/deploy/jbossweb-tomcat55.sar/server.xml

v $WMCROOT/as/server/default/deploy/http-invoker.sar/invoker.war/WEB-INF/web.xml

v $WMCROOT/as/server/default/deploy/http-invoker.sar/META-INF/jboss-service.xml

2. Stop and start the Application Server by using the following command:sap stop assap start as

3. Optional: Right-click the Active Events List in OMNIbus Web GUI to run theTivoli Netcool Performance Manager defined JavaScript file. This file location isspecified in the Integrating Tivoli Netcool/OMNIbus Web GUI - WirelessComponent. In tnpmforwireless.cgi file, update the var _protocol value toHTTP as follows:var _protocol="http://";

4. Start sqlplus as the virtuo user:sqlplus virtuo/virtuo_password@vtdb

5. Run the following command to update the links when you switch protocolfrom https to http:SQL> update alarm_alarms set additional_text = replace(additional_text,'https','http') where substr(additional_text,1,6) = 'https:';SQL> commit;

Results

Start the web browser after the HTTPS is disabled by using the following URL:https://<hostname>:<port>/tnpmw/login.do



Chapter 3. Starting and stopping the system

Describes starting and stopping the Tivoli Netcool Performance Manager system.

The following applications must be running before Tivoli Netcool PerformanceManager, can be started properly:v Oracle databasev (LDAP) Security Directory Serverv (SAP) Process Monitorv (SAP) Process Manager

When these applications are running, Tivoli Netcool Performance Manager can bestarted. All the processes are automatically started upon bootup. For moreinformation about bootup as part of the main installation, see the Installing TivoliNetcool Performance Manager - Wireless Component.

For instructions on the complete start and shutdown of Tivoli Netcool PerformanceManager and processes, see “Tivoli Netcool Performance Manager complete startupand shutdown” on page 30.

Note: A number of status checks can be performed on Tivoli Netcool PerformanceManager applications and processes, see “Reporting on server status” on page 110

Oracle databaseStarting and stopping the Oracle database.

Note: For more information about manually starting and stopping Oracle byusing SQL*Plus and the OS user as oracle, see “Starting and stopping the Oracledatabase” on page 112.

Starting the Oracle databaseTo start the Oracle database:

Procedure

Enter the following command as user root:

vsvcadm enable database-na

vservice dboravirtuo start

v/etc/rc.d/init.d/dboravirtuo start


Stopping the Oracle databaseTo stop the Oracle database:

Procedure


vsvcadm disable database-na

vservice dboravirtuo stop

v/etc/rc.d/init.d/dboravirtuo stop

Security Directory ServerStarting and stopping the Security Directory Server.

Starting the Security Directory ServerStarting the Security Directory Server.

Procedure

Enter the following command as user root :v Solaris

svcadm enable sds-na

v Linuxservice sdsna start

v AIX/etc/rc.d/init.d/sdsna start

Stopping the Security Directory ServerStopping the Security Directory Server.

Procedure

Enter the following command as user root :

vsvcadm disable sds-na

vservice sdsna stop

v/etc/rc.d/init.d/sdsna stop


Jazz for Service ManagementJazz™ for Service Management brings together the Open Services for LifecycleCollaboration (OSLC) community's open specifications for linking data and othershared integration services, including administrative, dashboard, reporting, andsecurity services. It underpins client-defined management scenarios such as cloud,performance monitoring, and IT Service Management.

Through these facets, Jazz for Service Management accelerates deployment,integration, and workflow automation across IBM Business Partner, and third-partytools. Its open and standardized approach to linking data means that clients andIBM Business Partner can rapidly deploy and improve collaboration acrossinterdependent roles and functions with less labor and cost, and regardless of thesource and the management scenarios applied. Furthermore, this approachsignificantly reduces the risk of broken integrations, because it is not version orvendor API specific.

Tivoli Netcool Performance Manager V1.4.3, uses dashboard and visualizationexperience through IBM Dashboard Application Services Hub in Jazz for ServiceManagement. Dashboard Application Services Hub is replacing the TivoliIntegrated Portal that was used in previous releases.

Some configuration or administration tasks for an integration service require thatyou restart the IBM WebSphere® Application Server. Stopping a Jazz for ServiceManagement application server impacts all integration services that are installed inthe associated WebSphere Application Server profile.

Important: For minimal installation of Tivoli Netcool Performance Manager, useonly smadmin as the administration username name and smadmin1 as theadministration password for Jazz for Service Management. The defaultadministration username is smadmin.

Common directory locations for Jazz for Service ManagementJazz for Service Management topics use path name variables for paths to commondirectories, for example, home directories.

Jazz for Service Management home directory

The JazzSM_HOME variable describes the location where Jazz for ServiceManagement is installed. This location can be specified during installation. If notspecified, the following default locations are used:

v Root user installations: /opt/IBM/JazzSMv Non-root user installations: <user_home_dorectory>IBM/JazzSM

Jazz for Service Management profile directory

The JazzSM_WAS_Profile variable describes the location of the application serverprofile that is used for Jazz for Service Management. This location is in the/profile/ subdirectory of the Jazz for Service Management home directory.

v Root user installations: /opt/IBM/JazzSM/profilev Non-root user installations: <user_home_dorectory>IBM/JazzSM/profile

Chapter 3. Starting and stopping the system 23

Jazz for Service Management profile name

The JazzSM_Profile_Name variable refers to the name assigned to the WebSphereApplication Server profile for Jazz for Service Management. The default name isJazzSMProfile.

Installation images home directory

The Install_Imgs_Home variable describes the common root directory that containsthe extracted contents of the installation images depending on the installationscenario.

Full installationIBM DB2®, IBM WebSphere Application Server, and IBM Tivoli CommonReporting if you want to install Tivoli Common Reporting during the fullinstallation flow.

Attention: You must extract the contents of the installation media for thissoftware to the same common root directory, otherwise the full installationdisplays error messages for missing software.

Custom installationIBM WebSphere Application Server, if you do not want to use an existinginstallation; Tivoli Common Reporting if you want to install it after acustom installation of the other integration services.

Note: It is not necessary to extract the contents of the installation mediafor this software to the same common root directory, but it is preferable tomaintain all extracted installation media in a central location.

Jazz for Service Management installation images home directory

The JazzSM_Image_Home variable describes the common root directory in which theJazz for Service Management is extracted. It contains the launchpad, IBMInstallation Manager, IBM Prerequisite Scanner, the Installation Manager repositorywith the software packages for the integration services except Tivoli CommonReporting.

Tip: Ensure that the path to the JazzSM_Image_Home directory does not contain anyspaces or special characters, otherwise the launchpad does not start.

IBM DB2 home

The DB2_HOME variable describes the location where IBM DB2 is installed. Thislocation was specified during installation. If not specified, the following defaultlocations are used:

v Root user installations: /opt/ibm/db2v Non-root user installations: $HOME/sqllib

$HOME represents the non-root user's home directory.


WebSphere Application Server home directory

The WAS_HOME variable describes the location where WebSphere Application Serveris installed. This location was specified during installation. If not specified, thefollowing default locations are used:

v Root user installations: /opt/IBM/WebSphere/AppServerv Non-root user installations: <user_home_dorectory>IBM/WebSphere/AppServer

Administration Services home directory

The ADMIN_HOME variable describes the location where Administration Servicesis installed. This location can be specified during installation. If not specified, the

following default locations are used: v Root user installations: /opt/IBM/JazzSM/adminv Non-root user installations: /home/nonrootuser_name/IBM/JazzSM/admin

Administration Services UI home directory

The ADMINUI_HOME variable describes the location where Administration Services UIis installed. This location can be specified during installation. If not specified, the

following default locations are used: v Root user installations: /opt/IBM/JazzSM/adminuiv Non-root user installations: /home/nonrootuser_name/IBM/JazzSM/adminui

Registry Services home directory

The REGISTRY_HOME variable describes the location where Registry Services isinstalled. This location can be specified during installation. If not specified, the

following default locations are used: v Root user installations: /opt/IBM/JazzSM/registryv Non-root user installations: /home/nonrootuser_name/IBM/JazzSM/registry

Security Services home directory

The SECURITY_HOME variable describes the location where Security Services isinstalled. This location can be specified during installation. If not specified, the

following default locations are used: v Root user installations: /opt/IBM/JazzSM/securityv Non-root user installations: /home/nonrootuser_name/IBM/JazzSM/security

Dashboard Application Services Hub home directory

The DASH_HOME variable describes the location where Dashboard ApplicationServices Hub is installed. This location can be specified during installation. If notspecified, the following default locations are used:

v Root user installations: /opt/IBM/JazzSM/uiv Non-root user installations: <user_home_dorectory>IBM/JazzSM/ui


Dashboard Application Services Hub profile directory

The DASH_Profile variable describes the location of the application server profilethat is used for Dashboard Application Services Hub. This location is inthe/profiles/ subdirectory of the Jazz for Service Management home directory.

v Root user installations: /opt/IBM/JazzSM/profilev Non-root user installations: <user_home_dorectory>IBM/JazzSM/profile

Tivoli Common Reporting home directory

The REPORTING_HOME directory that contains the uninstallation program, theinstallation log files, and Tivoli Common Reporting component files. If notspecified, the following default locations are used:

v Root user installations: /opt/IBM/JazzSM/reportingv Non-root user installations: <user_home_dorectory>IBM/JazzSM/reporting

IBM Cognos® installation directory

The c10_location directory that contains the Cognos® installation. If not specified,

the following default locations are used: v Root user installations: /opt/IBM/JazzSM/reporting/cognosv Non-root user installations: /home/nonrootuser_name/IBM/JazzSM/reporting/

cognos

Full installation log directory

The Simple_install_log_dir directory into which general and offering specific logsare created during full installation:

v On UNIX systems: $HOME/jazzsm_launchpad/logs/

IBM Prerequisite Scanner installation directory

The ips_root directory that contains the contents of the extracted PrerequisiteScanner platform package. If not specified, the default locations are used:

v On UNIX systems: Install_Imgs_Home/PrereqScanner/UNIX_LinuxRelated information:

Common directory locations


http://www.ibm.com/support/knowledgecenter/SSEKCU_1.1.3.0/com.ibm.psc.doc/ref/psc_r_pathnames.html

Starting Jazz for Service Management application serversYou can start any Jazz for Service Management virtualization and reporting serversby using the IBM WebSphere startServer command. You might need to restart theapplication server after you complete a configuration task for an integrationservice, or after you stop the application server for maintenance.

About this task

The same procedure applies to any Jazz for Service Management applicationserver.

Procedure1. On the relevant Jazz for Service Management server, open a command window.2. Change to the JazzSM_WAS_Profile/bin directory.

The default location for <JazzSM_WAS_Profile> is /opt/IBM/JazzSM/profile.3. Run the following command:

./startServer.sh server_name

Where

server_nameEnter the name of the application server that was specified when theapplication server profile was created.

For example, server1.Related information:


Stopping Jazz for Service Management application serversYou can stop any Jazz for Service Management application server by using the IBMWebSphere stopServer command. You might need to restart the application serverafter you complete a configuration task for an integration service, or stop theapplication server for maintenance. To start the server again, use the startServercommand.

Procedure1. On the relevant Jazz for Service Management server, open a command window.2. Change to the <JazzSM_WAS_Profile>/bin directory. The default location for

<JazzSM_WAS_Profile> is /opt/IBM/JazzSM/profile.3. Run the following command:

./stopServer.sh <server_name> -username <WAS_admin_user_name> -password <WAS_admin_password>

Where

server_nameEnter the name of the application server that was specified when theapplication server profile was created. For example, server1.

WAS_admin_user_nameThe default user name is smadmin.



WAS_admin_passwordPassword that is specified at the time of installation.

Example

stopServer.sh server1 -username smadmin -password jazzsmpwd

Related information:


Process MonitorThe Process Monitor manages the restart ability of the application.

Note: The process monitor must be started before the process manager. Theprocess manager cannot be started until the process monitor is started.

Distributed systems onlyIn a distributed environment the Process Monitor is only started on theServer containing the Application component.

Starting the Process MonitorTo start the Process Monitor:

Procedure


vsvcadm enable sapmon-na

vservice sapmonvirtuo start

v/etc/rc.d/init.d/sapmonvirtuo start

Stopping the Process MonitorTo stop the Process Monitor:

Procedure


vsvcadm disable sapmon-na

vservice sapmonvirtuo stop

v/etc/rc.d/init.d/sapmonvirtuo stop



Process ManagerThe Process Manager registers all the Tivoli Netcool Performance Managerprocesses.

Note: Distributed systems only: In a distributed environment the Process Manageris only started on the Server containing the Application component.

Starting the Process ManagerTo start the Process Manager:

Procedure


vsvcadm enable sapmgr-na

vservice sapmgrvirtuo start

v/etc/rc.d/init.d/sapmgrvirtuo start

Stopping the Process ManagerTo stop the Process Manager:

Procedure


vsvcadm disable sapmgr-na

vservice sapmgrvirtuo stop

v/etc/rc.d/init.d/sapmgrvirtuo stop

This command does not stop processes.

Tivoli Netcool Performance ManagerTivoli Netcool Performance Manager is started and stopped using the sapcommand.

The sap command starts and stops all registered processes.

For instructions on the complete startup and shutdown of Tivoli NetcoolPerformance Manager and processes, see “Tivoli Netcool Performance Managercomplete startup and shutdown” on page 30.


Starting Tivoli Netcool Performance ManagerTo start the Tivoli Netcool Performance Manager application:

Procedure


vsvcadm enable sap-na

vservice sapvirtuo start

v/etc/rc.d/init.d/sapvirtuo start

Results

It may take a few minutes to start all the processes.

You can check the loader logs for startup issues: $WMCROOT/logs/loader/

Log information from the application server is written to: $WMCROOT/logs/as/default

Stopping Tivoli Netcool Performance Manager

About this task

To stop the Tivoli Netcool Performance Manager application:

Procedure

Enter the following command as user root:v Solaris

svcadm disable sap-na

v Linuxservice sapvirtuo stop

v AIX/etc/rc.d/init.d/sapvirtuo stop

Tivoli Netcool Performance Manager complete startup and shutdownComplete start and shutdown procedures for Tivoli Netcool Performance Manager.


Complete startupThe complete startup procedure for Tivoli Netcool Performance Manager.

The following procedure starts the Oracle database, the directory server, theProcess Monitor, the Process Manager, and all Tivoli Netcool Performance Managerprocesses.

Note: If you do not need to start up the Oracle database or the directory server,ignore instructions relating to starting the Oracle database and Directory server.

In Solaris only, it is possible to start up all Tivoli Netcool Performance Managerapplications, the directory server and the Oracle database using a single command:svcadm enable database-na tds-na sapmon-na sapmgr-na sap-na

Oracle databaseAbout this task

Start the Oracle database:

Procedure

Enter the following command as user root on the Tivoli Netcool PerformanceManager Server:

vsvcadm enable database-na


v/etc/rc.d/init.d/dboravirtuo start

Directory server

About this task

Shut down the Security Directory Server:

Procedure

Enter the following commands as user root on the Tivoli Netcool PerformanceManager server:


vservice sdsna stop



Tivoli Netcool Performance Manager

About this task

Note: Distributed systems only: In a distributed system, this section should beperformed only on the server hosting the Application component.

Procedure1. Check which processes are currently running:v Solaris

svcs "*-na*"

v Linuxservice sapmonvirtuo statusservice sapmgrvirtuo statusservice sapvirtuo status

v AIX/etc/rc.d/init.d/sapmonvirtuo status/etc/rc.d/init.d/sapmgrvirtuo status/etc/rc.d/init.d/sapvirtuo status

2. Enter the following commands as user root to ensure that SAP processmanagement is running, and start the remaining processes.v Solaris

svcadm enable sapmon-nasvcadm enable sapmgr-nasvcadm enable sap-na

v Linuxservice sapmonvirtuo startservice sapmgrvirtuo startservice sapvirtuo start

v AIX/etc/rc.d/init.d/sapmonvirtuo start/etc/rc.d/init.d/sapmgrvirtuo start/etc/rc.d/init.d/sapvirtuo start

Results

It may take a few minutes to start all the processes.

You can check the loader logs for startup issues: $WMCROOT/logs/loader/

Log information from the application server is written to: $WMCROOT/logs/as/default

Complete shut downThe following procedure shuts down Tivoli Netcool Performance Manager, allprocesses, the Process Manager, the Process Monitor, the Directory Server, andOracle.

About this task

Note: If you do not need to shut down the Oracle database or the Directoryserver, ignore instructions to shutting down the Oracle database and Directoryserver.


Note: Distributed systems only: In a distributed system, this procedure must beperformed on the server that is hosting the Application component.

Shut down the system as follows:

Note: When you disable services, disable the services one at a time and in thesequence.

Procedure

Enter the following commands as user root on the Tivoli Netcool PerformanceManager servers:

vsvcadm disable sap-na

Before you continue, check that the sap-na service is disabled by running thesvcs sap-na command to check the status.svcadm disable sapmgr-nasvcadm disable sapmon-na

vservice sapvirtuo stopservice sapmgrvirtuo stopservice sapmonvirtuo stop

v/etc/rc.d/init.d/sapvirtuo stop/etc/rc.d/init.d/sapmgrvirtuo stop/etc/rc.d/init.d/sapmonvirtuo stop

Check the appropriate log files and processes to ensure that a graceful shutdownhas occurred. See “Log files check” on page 111.

Directory server

About this task

Shut down the Security Directory Server:

Procedure

Enter the following commands as user root on the Tivoli Netcool PerformanceManager server:


vservice sdsna stop


Oracle databaseShut down the Oracle database:


Procedure

Enter the following commands as user root on the Tivoli Netcool PerformanceManager servers:

vsvcadm disable database-na

vservice dboravirtuo stop

v/etc/rc.d/init.d/dboravirtuo stop


Chapter 4. Application administration

Describes Tivoli Netcool Performance Manager application administration.

User administrationThe User Administration tool allows you to configure a wide range of ways forusers to access the system.

The available methods of system access are:v usersv groupsv rolesv privileges

User administration basicsThe User Administration tool is accessed from the GUI by using the Tools tab.

The User Administration tool is accessed from the GUI using the Tools tab, byselecting User Administration from the list box.

Figure 2. User Administration


UsersTivoli Netcool Performance Manager users.

Tivoli Netcool Performance Manager users are those users in the LDAP repositorythat have been configured to use the application.

GroupsGroups are collections of users.

Permission to access user documents such as reports is given to groups. Users canbelong to more than one group. The system includes a number of predefinedgroups, shown in the following table, which cannot be edited. You can also createyour own groups.

Table 4. Predefined Groups

Name Description

Admin Used to group administrators together.

Everybody A group that automatically contains all ofthe users defined by the system.

RolesRoles are collections of privileges.

Roles can contain other roles. Roles are assigned to users, not to groups. Thesystem includes a number of predefined roles, which are shown in the followingtable, which cannot be edited. You can also create your own roles. The total set ofprivileges that a user has is determined by the roles that are assigned to that user,and the privileges that are associated with those roles.

You can view the privileges that are associated with a role. See “Assigning orde-assigning privileges to a role” on page 45 for information on how to determinethe privileges in a role.

Table 5. Predefined Roles

Name Description

Basic Web User A limited user who can read standard reportdefinitions, read schedule definitions, readVault documents, show users fromEverybody group, show folders fromEverybody group, access the Alarm Viewer.

Normal Web User A typical user who has all the privileges of aBasic Web User and who can edit/deletestandard report definitions, run standardreports, edit/schedule definitions, has apersonal documents area, read/editMyFavorites pages, view UDC definitions.

Power Web User An advanced user who has all the privilegesof a Normal Web User and who can alsopublish and edit Vault documents, view andedit UDCs, access the Alarm Exporter andAlarm Manager, Import and Export datawith the Admin tool.


Table 5. Predefined Roles (continued)

Name Description

System Administrator The top-level administrator who has allprivileges. System administrators have fullcontrol over the application.

PrivilegesPrivileges are a list of tasks and features available for users.

Privileges are grouped into roles, which are then applied to a particular user. Thefollowing table describes the privileges available on the system.

Table 6. Privilege Descriptions

Privilege Applies To Description

Admin: Edit Datasourcedefinitions

Administration software Allows the user to performactions associated withagents and agent activities.

Admin: edit users and userdata

Administration software,Web Client

Allows the user to edit users,groups, and roles.

Allow access to AlarmExporter

Web Client Allows the user to create andmodify alarm targets.

Allow access to AlarmManager

Web Client Allows the user to activateand deactivate alarms, and tomodify alarm definitions.

Allow access to AlarmViewer

Web Client Allows the user to view andacknowledge alarms.

Configure Jboss Administration software Allows the user to configureJboss.

Create entity and fieldmappings (equivalencies)

Administration software Allows the user to modelentity and fieldequivalencies. This privilegedoes not apply.

Edit Agent settings Administration software Allows the user to modifyproperties and performactions associated withagents and agent activities.

Edit/delete any existingreports

Web client Allows the user to modify allreport results, regardless ofthe assigned permissions.

Edit/delete any existingfolders or documents

Web client Allows the user to modify allsaved documents, regardlessof the assigned permissions.

Edit any remote UDCdefinitions

Administration software Allows the user tocreate/edit/delete anyremote UDC owned by anyuser.

Edit/delete enterprise reportdefinitions

Web client Allows the user to open andedit enterprise reportdefinitions. This privilegedoes not apply.

Edit/delete scheduledefinitions

Web client Allows the user to schedulereports to be run.

Chapter 4. Application administration 37

Table 6. Privilege Descriptions (continued)


Edit/delete standard Webreport definitions

Web client Allows the user to open andedit local report definitions.

Edit entity data Administration software Allows the user to enterinformation about an entityinstance using the EntityData Editor. This privilegedoes not apply.

Edit Holidays Administration software Allows the user to editholiday definitions using theHoliday Administration tool.

Edit MyFavorite pages Web client Allows the user to create,edit, and delete customizedpages in the Web client.

Edit remote UDC definitions Administration software Allows the user tocreate/edit/delete a remoteUDC owned by the currentuser.

Export Data with the AdminTool

Administration software Allows the user to use theexport tool.

Import Data with the AdminTool

Administration software Allows the user to use theimport tool.

Manage AutoDownloadentries

Web client Allows the user to managethe auto downloading ofscheduled reports that existon remote servers. Thisprivilege does not apply.

Promote UDCs Administration software Allows the user to promote aUDC.

Publish and edit Vaultdocuments

Web client Allows the user to organizefolders and save documentsto the vault page, assumingthey have the appropriatefile permissions.

Read enterprise reportdefinitions

Web clientAllows the user to readenterprise report definitions.This privilege does notapply.

Read MyFavorite pages Web client Allows the user to viewcustomized pages in the Webclient.

Read reports from remoteservers

Web client Allows the user to seeremote server report statusfrom the Monitor tab. Thisprivilege does not apply.

Read schedule definitions Web client Allows the user to viewreport schedules.

Read standard Web reportdefinitions

Web client Allows the user to view localreport definitions.




Read Vault documents Web client Allows the user to browsethrough documents that havebeen published to the vaultpage.

Rename remote UDCdefinitions

Administration software Allows the user to rename aremote user-definedcalculation (UDC).

Run classic reports on remoteservers

Web client Allows the user to runreports residing on a remoteserver. This privilege doesnot apply.

Run enterprise reportdefinitions

Web client Allows the user to runenterprise reports. Thisprivilege does not apply.

Run standard Web reports Web client Allows the user to run reportdefinitions. This privilegeimplies read and editprivileges.

Runtime Accessor Administration software Allows a user to run anexternal user-managedexecutable after a scheduledreport job has beencompleted.

Show folders fromEverybody group

Web client Allows the user to seedocuments in a folder inwhich the user does not haveread or write permissions. Ifthis privilege is not granted,the user can only see foldersavailable to the group(s) theybelong to.

Show users from Everybodygroup

Web client Allows the user to see allusers, including those ingroups the user does notbelong to. If this privilege isnot granted, the user canonly see other users in thegroup(s) they belong to.

User has a PersonalDocuments area

Web client Allows the user to organizefolders in a private area andsave documents there.

View Agent settings Administration software Allows the user to viewagent properties and agentactivities, but not modify anyassociated properties orperform any associatedactions.

View data availability Web client Allows user to view dataavailability. This privilegedoes not apply.




View Datasource definitions Administration software Allows the user to viewagent properties and agentactivities, but not performany actions.

View documents on remoteservers

Web client Allows the user to browsethrough documents onremote servers.

View enterprise dataavailability.

Web clientAllows the user to viewenterprise data availability.This privilege does notapply.

View entity and fieldmappings (equivalencies)

Administration software Allows the user to viewentity equivalencies, but notedit them. This privilegedoes not apply.

View entity data Administration software Allows the user to viewentity information in theEntity Data Editor, but notedit them. This privilegedoes not apply.

View promoted UDCs Administration software View promoteduser-defined-calculations(UDCs).

View remote UDCdefinitions

Administration software Allows the user to view thedefinition for a remoteuser-defined calculation.

View users and user data Administration software Allows the user to viewusers, groups, and roles, butnot edit them.

User managementUser Management covers the tasks of adding and maintaining users and groups,and associating users with roles.


Adding usersYou must have the appropriate privileges to add a user.

About this task

The Add operation adds the user to the LDAP repository and to the database,creating both inet_user (anonymous user) and user entries. A user is added bydefault to the Everybody group, and assigned the Normal Web User role.

To add a user:

Procedure1. In the manage users tab, click the Virtuo users tab.2. Click the add user button.

The add user dialog is displayed.

Figure 3. User Management


3. Enter the user's details in the appropriate fields.4. Click OK.

Results

The user is listed in the list of Users.

Editing usersYou must have the appropriate privileges to edit a user.

Procedure1. In the manage users tab, click the Virtuo users tab.2. Select the user from the list of users .3. Click the edit user button.4. Edit the user's details as required.

You cannot alter a user's login ID.5. Click ok .

Deleting usersDeleting a user removes the user from the server.

About this task

You must have the appropriate privileges to delete a user. The following userscannot be deleted: useradm, virtuo and sysadm.

To delete a user:

Procedure1. In the manage users tab, click the Virtuo users tab.2. Select the user from the list of users.

Note: Select more than one user using the Shift and Ctrl keys.3. Click the Delete selected user(s) button.

A message is displayed asking you to confirm the deletion.4. Click yes.

Creating and deleting groupsGroups are primarily for users to determine who can access their reports.

About this task

You must have the appropriate privileges to create or delete a group. You cannotdelete the system predefined groups: everybody and admin.

Procedurev To create a group:

1. In the manage users tab, click the users by group tab.2. Click the add user group button.

The add group dialog is displayed.


3. Enter a name for the group.4. Click OK.

The group is listed in the list of available user groups.v To delete a group:

1. In the manage users tab, click the users by group tab.2. Select the group that you want to delete.

Note: Select more than one group by using the Shift and Ctrl keys.You cannot delete a group that has one or more users who are associatedwith it.

3. Click the delete selected user group(s) button.A message is displayed asking you to confirm the deletion.

4. Click yes.

Adding and removing users to and from groupsAdding users to groups is an easy way to allow users access to certain folders andreports.

About this task

You must have the appropriate privileges to add a user to a group.

Procedure1. In the manage users tab, click the users by group tab.2. Select the group that you want to add/remove users to/from, in the list of

available user groups .3. Add or remove users as needed.

Users are added by dragging the user from the available users box to theassociated users box.Users are removed by dragging the user from the associated users box to theavailable users box.

Note: Select more than one user using the Shift and Ctrl keys.

Assigning and de-assigning users to and from a roleAssigning users to a role allows you to determine how they interact with thesystem.


About this task

You can restrict access to folders and systems, or you can grant special privilegesto certain classes of users. You must have the appropriate privilege to assign usersto a role.

To assign or de-assign users to a role:

Procedure1. In the manage users tab, click the users by role tab.2. Select the role that you want to assign or de-assign users to and from, in the

list of available roles.3. Assign or de-assign users as required.

Users are assigned by dragging the user from the available users box to theassociated users box.Users are de-assigned by dragging the user from the associated users box tothe available users box.

Note: Select more than one user by using the Shift and Ctrl keys.

Role managementRole management covers the tasks necessary for the setting up and maintaining ofroles.

Creating and deleting rolesCreating a role allows you to group custom privileges that can then be assigned tousers.

About this task

You must have the appropriate privileges to create or delete a role. You cannotdelete the system predefined roles: basic web user, normal web user, power webuser and system administrator.

Procedurev To create a role:

1. Click the manage roles tab.2. Click the add role button.

The add role dialog is displayed.


3. Enter details for the role.4. Click OK .

The role is listed in the list of available roles.v To delete a role:

1. Click the manage roles tab.2. Select the role you want to delete.

Note: Select more than one role using the Shift and Ctrl keys.You cannot delete a role that has one or more users associated with it.

3. Click the delete selected role(s) button.A message is displayed asking you to confirm the deletion.

4. Click yes.

Assigning or de-assigning privileges to a roleAssigning privileges to a role allows you to group the privileges you want toassign to users.

About this task

Creating roles is convenient when several people share common privileges. See“Privileges” on page 37 for information on access rights for different privileges.You must have the appropriate privileges to assign privileges to a role.

To assign or de-assign privileges to a role:

Procedure1. Click the manage roles tab.2. Select the role that you want to assign or de-assign privileges to/from, in the

list of available roles.3. Assign or de-assign privileges as needed.

Privileges are assigned by dragging the privilege from the privileges availablefor selected role box to the privileges associated with selected role box.


Privileges are de-assigned by dragging the privilege from the privilegesassociated with selected role box to the privileges available for selected rolebox.

Note: Select more than one privilege by using the Shift and Ctrl keys.

User Administration Command Line ToolThe user_admin tool provide a means of creating and deleting users as well asupgrading user passwords.

This tool is intended to support bulk provisioning of users. It can be used inparallel with the User Administration GUI.

This tool cannot be used off-line. It requires a virtuo administration login to theserver hosting the Tivoli Netcool Performance Manager application.

Usageuser_admin tool usage informationuser_admin [-asconf conf_name] parameters-u <admin_user> -p <admin_password> -listusers simple-u <admin_user> -p <admin_password> -listusers detail-u <admin_user> -p <admin_password> -listroles-u <admin_user> -p <admin_password> -add -f <firstname> -ln <lastname>

-uid <user_id> -up <user_password> -rf <role_filename> [-e <email_addr>]-u <admin_user> -p <admin_password> -modify -uid <user_id> -up <new_user_password>u <admin_user> -p <admin_password> -delete -uid <user_id>

Table 7. Options for user_admin Script

Option Description

-u Administration user name.

-p Administration password.

-listusers simple List user identifiers only.

-listusers detail List all user details for all users.

-listroles List roles.

-add -f <firstname> -ln <lastname>-uid <user_id> -up <user_password>-rf <role_filename> [-e <email_addr>]

Add user.

v <firstname> is the user's first name

v <lastname> is the user's last name

v <user_id> is the user's login ID

v <user_password> is the user's password

v <role_filename> is the name of the rolefile, a role file specifies a number ofroles

v <email_addr> is the user's email address,an email address is optional.

-modify -uid <user_id> -up<new_user_password>

Modify user. <user_id> is the user's loginID. <new_user_password> is the user's newpassword.

-delete -uid <user_id> Delete user. <user_id> is the user's loginID.


Listing usersThe List operations are threefold. The two user listings consist of the useridentifiers, and the detailed listing of all user details.

The role listing consists of listing all roles in the system.

To list user ids:user_admin -u <admin_user> -p <admin_password> -listusers simpleuser_admin -u <admin_user> -p <admin_password> -listusers detailuser_admin -u <admin_user> -p <admin_password> -listroles

Where:v <admin_user> is the administrator's login ID.v <admin_password> is the administrator's login password.

Adding usersThe Add operation adds a user to LDAP and to the database, creating bothinet_user and user entries.

A user is added by default to the Everybody group in LDAP. A user is assigned tothe roles specified in the role file. A user is assigned to all datasources in thesystem.user_admin -u <admin_user> -p <admin_password> -add -f<firstname> -ln <lastname> -uid <user_id> -up<user_password> -rf <role_filename> [-e<email_addr>]

Where:v <admin_user> is the administrator's login IDv <admin_password> is the administrator's login passwordv <firstname> is the user's first namev <lastname> is the user's last namev <user_id> is the user's login IDv <user_password> is the user's passwordv <role_filename> is the name of the role file, a role file specifies a number of rolesv <email_addr> is the user's email address, an email address is optional

Role filesA role file specifies a number of roles.

A user is added to the normal web user role by default. Each role file is a text filewith a role per line. The role name is the name of the role in LDAP, and not therole name that is specified in the user interface.

When adding a user, incorrect roles are ignored and a warning message isdisplayed. The user is added to correctly named roles only. If all roles in the rolefile are incorrect, the user is added to the normal web user role.

Example of a Role File:

WebUserNormal

WebUserPower


Modifying a user's passwordThe Modify operation allows a user password to be modified.

The following users may not be modified: useradm, virtuo and sysadm.

To modify a user:user_admin -u <admin_user> -p <admin_password> -modify-uid <user_id> -up <new_user_password>

Where:v <admin_user> is the administrator's login IDv <admin_password> is the administrator's login passwordv <user_id> is the user's login IDv <new_user_password> is the user's new password

Deleting usersThe Delete operation removes a user completely from the system.

This includes all references to the user in the database and in LDAP. The followingusers may not be deleted: useradm, virtuo and sysadm.user_admin -u <admin_user> -p <admin_password> -delete-uid <user_id>

Where:v <admin_user> is the administrator's login IDv <admin_password> is the administrator's login passwordv <user_id> is the user login ID of the user to delete

IBM Security Directory Server password policyPassword policy is a set of rules that controls how passwords are used andadministered in IBM Security Directory Server. These rules are made to ensure thatusers change their passwords periodically, and that the passwords meet theorganization's syntactic password requirements. These rules can also restrict thereuse of old passwords and ensure that users are locked out after a definednumber of failed bind attempts. Security Directory Server provides three types ofpassword policies: individual, group, and global password policies.

When you install the IBM Security Directory Server, you can use the default valuesfor the following password policies for non-administrative users from$WMCROOT/admin/ds/schema/globalpwdpolicy.ldif file:v IBM Security Directory Server global Password policy configuration that is

enabled as follows:ibm-pwdpolicy:true

v IBM Security Directory Server group and individual password policyconfiguration that is enabled as follows:ibm-pwdGroupAndIndividualEnabled:true

v Default IBM Security Directory Server global password policy configurationsthat are enabled as follows:– Account lockout password policy enabled:

pwdLockout: true


– Account lockout that is configured to be triggered on the third failed attemptto log in user account as follows:pwdMaxFailure: 3

– Account lockout duration of 120 seconds configured as follows:pwdLockoutDuration: 120

Modifying IBM Security Directory Server Password PolicyA password policy entry must be created before it can be associated with a user ora group entry as an individual or a group password policy. If the referencedpassword policy entry does not exist, a message unwilling to perform is returned.After a password policy entry is referenced by a user or group entry, it cannot berenamed or deleted unless the association between the entry and the user or groupentry is removed.

Results

The following table summarizes the function of the IBM Security Directory ServerpwdLockoutDuration and pwdMaxFailure attributes that are configured in$WMCROOT/admin/ds/schema/globalpwdpolicy.ldif.

Password policyattribute Description Valid values Default value

pwdLockoutDuration Specifies the number of secondsthat the password cannot beused to authenticate due to thespecified pwdMaxFailure failedbind attempts.

60 - 300 120

pwdMaxFailure Specifies the maximum numberof consecutive failed bindattempts that are allowed afterwhich the password is notconsidered for authentication. Ifa value of 0 is set to thepwdMaxFailure attribute then thevalue of pwdLockout is ignored.

1 - 10 3

Use the idsldapsearch search tool, which is a command-line interface to theldap_search library call. If idsldapsearch finds one or more entries, the attributesthat are specified by attributes are retrieved and the entries and values are printedto standard output. If no attributes are listed, all attributes are returned. Use thefollowing command:idsldapsearch -h <hostname> -p <server_secure_port> -D <adminDN> -w <adminPW>-b <base> <search_filter>

Where:

Parameter Description

<hostname> Specify an alternative host on which theLDAP server is running.

<server_secure_port> LDAP port number that can be found in$WMCROOT/conf/ldap/default.properties.The default LDAP port is 1389.



<adminDN> Typically, this entry is an LDAPadministrator user name. For example,“cn=Directory Manager”.

<adminPW> Password for the specified <adminDN> user.

<base> Searchbase. Use searchbase as the startingpoint for the search instead of the default. If-b is not specified, this utility examines theLDAP_BASEDN environment variable for asearchbase definition. If neither is set, thedefault base is set to “”, which is a nullsearch. A null search returns all the entriesin the entire Directory Information Tree(DIT). This search requires a -s subtreeoption. Otherwise, an error message isdisplayed. The null-based search requestsuse numerous resources.

<search_filter> The default value is “objectclass=*”

Example

For example, to use idsldapsearch to look up the full account uid of a user, runthe following command:idsldapsearch -h <hostname> -p 1389 -D “cn=Directory Manager” -w Dirmgr01 -b"dc=oraganisation,dc=co,dc=in" "uid=username*"


uid=username,ou=People,dc=organisation,dc=co,dc=inobjectClass=ctpersonobjectClass=inetorgpersonobjectClass=organizationalPersonobjectClass=personobjectClass=topmail=givenName=usernameuid=usernameuserPassword={SHA}ZviKg31zOXeNSF3KMmt8hz9E6bM=sn=usernamecn=username username

Another example to find the IBM Security Directory Server pwdLockoutDurationand pwdMaxFailure attribute values that are configured is as follows:idsldapsearch -h tnpminlnx0107 -p 1389 -D “cn=Directory Manager”-w Dirmgr01 -b “cn=pwdpolicy,cn=ibmpolicies” “objectclass=*”| egrep "pwdLockoutDuration|pwdMaxFailure"


pwdLockoutDuration=120pwdMaxFailure=3

Related information:

Password policy settings


http://www.ibm.com/support/knowledgecenter/SSVJJU_6.4.0/com.ibm.IBMDS.doc_6.4/ds_ag_srv_adm_set_pwd_policy.html?lang=en

Modifying the Directory Server password policy and unlockthe LDAP account

After IBM Security Directory Server installation is complete, you can change theSecurity Directory Server password policy rules.

About this task

Run the following command to change the Security Directory Server passwordpolicy rules:idsldapmodify -D <adminDN> -w <adminPW> -p <server_secure_port> -k -i <filename.ldif>

Where:

Parameters Description

<adminDN> Typically, an LDAP administrator user name.For example, “cn=Directory Manager”.

<adminPW> Password for the specified <adminPW>.

<server_secure_port> The LDAP port number that can be found in$WMCROOT/conf/ldap/default.propertiesfile.

<filename.ldif> A new configuration file to set up the IBMSecurity Directory Server password policy.

Exampleidsldapmodify -D “cn=Directory Manager” -w Dirmgr01 -p 1389 -k -i$WMCROOT/admin/ds/schema/globalpwdpolicy.ldif

The globalpwdpolicy.ldif file contains the following lines:

dn: cn=pwdpolicy,cn=ibmpoliciesibm-pwdGroupAndIndividualEnabled:truepwdAttribute: userPasswordpwdLockoutDuration: 120pwdMaxFailure: 3pwdFailureCountInterval: 180pwdLockout: trueibm-pwdpolicy:true

What to do next

To alter the number of failed login attempts that triggers an account lockout,modify the default settings in $WMCROOT/admin/ds/schema/globalpwdpolicy.ldiffile by changing IBM Security Directory Server pwdMaxFailure attribute to thewanted value. The following example sets the number of triggers to 5:pwdMaxFailure: 5

To alter the duration of account lockout, modify the default settings in$WMCROOT/admin/ds/schema/globalpwdpolicy.ldif by changing IBM SecurityDirectory Server pwdLockoutDuration attribute to the wanted value. The followingexample sets the lockout duration to be 5 minutes (300 seconds):pwdLockoutDuration: 300

When you are satisfied with the configurations in $WMCROOT/admin/ds/schema/globalpwdpolicy.ldif file, save and run the following command:


idsldapmodify -D “cn=Directory Manager” -w Dirmgr01 -p 1389 -k -i$WMCROOT/admin/ds/schema/globalpwdpolicy.ldif

The following message is returned to indicate a successful entry:Operation 0 modifying entry cn=pwdpolicy,cn=ibmpolicies

Overriding password policy and unlocking accountsAdministrative users can override the password policy and unlock an account thatis locked due to excessive login failures by removing the IBM Security DirectoryServer pwdAccountLockedTime and pwdFailureTime attributes by usingidsldapmodify command.

About this task

Use the following command as an example:idsldapmodify -D “cn=Directory Manager” -w Dirmgr01 -p 1389 -k -i <unlockAcc.ldif>

Where the generated unlockAcc.ldif file contains the following information:dn: uid=user,ou=People,dc=organisation,dc=co,dc=inchangetype: modifydelete: pwdAccountLockedTime-delete: pwdFailureTime

Results

You receive the following message to indicate a successful entry:Operation 0 modifying entry uid=user,ou=People,dc=organisation,dc=co,dc=in

Checking the account status with extended operation toolThe LDAP extended operation tool can be used to determine the user accountlockout status.

About this task

Run the following command to check the account status:ldapexop -h <hostname> -p <server_secure_port> -D <adminDN> -w <adminPW> -op <operation>-d <debug_level>

Where:


<hostname> Specify an alternative host on which theLDAP server is running.

<server_secure_port> LDAP port number that can be found in$WMCROOT/conf/ldap/default.properties.The default LDAP port is 1389.

<adminDN> Typically, this entry is an LDAPadministrator user name. For example,“cn=Directory Manager”.

<adminPW> Password for the specified <adminDN> user.



<operation> Identifies the extended operation to beperformed.acctStatus -d <userDN>: password policyaccount status extended operation. Thisoperation enables a directory administratorto query the server as to the account statusof any entry that contains a userPasswordattribute. The userDN is the DN of the useraccount that is being queried. The status forthe account is open, locked, or expired. Formore information about the extendedoperations, see the IBM Security DirectoryServer Version 6.4 Command Reference.

<debug_level> Full account uid of the user. User can useidsldapsearch to look up for the user fulluid.

When the account is active, the output is as follows:

Account is open.

Example

For example:ldapexop -p 1389 -h <hostname> -D "cn=Directory Manager" -w Dirmgr01 -op acctstatus-d "uid=username,ou=People ,dc=organisation,dc=co,dc=in"

The output when the account is locked is as follows:

Account is locked.

If account lockout is triggered after the third failed login attempt, as configured indefault for IBM Security Directory Server pwdMaxFailure attribute, the accountstatus will be “locked”. Based on the default IBM Security Directory ServerpwdLockoutDuration attribute, 120 seconds after lockout, account status reverts toopen again.

External Reporting administrationThe External Reporting feature does not handle multiple reports or schedulescreated with identical names.

Duplicate report results can be exported to the same locations via database, local,and FTP export. If multiple users happen to use the same report name and sameschedule name, then previously exported data is overwritten. This can occur in asingle user scenario where the user has reports of the same name in differentfolders.

It can also occur in a multiple user scenario where users happen to use the samenames.

Note: This issue is only caused by the name of report or schedule being the same.It is also important to note that this issue applies to both ad hoc and scheduled


http://www.ibm.com/support/knowledgecenter/SSVJJU_6.4.0/com.ibm.IBMDS.doc_6.4/ds_cr_home.html?lang=en

http://www.ibm.com/support/knowledgecenter/SSVJJU_6.4.0/com.ibm.IBMDS.doc_6.4/ds_cr_home.html?lang=en

external exporting.

Setting external reporting propertiesThe external reporting properties file is used to set properties and values for userswho are exporting reports by using the Export Options dialog.

Note: See Exporting Reports in the Using Tivoli Netcool Performance Manager -Wireless Component, for more information on using the Export Options dialog.

The external reporting properties file is in $WMCROOT/conf/externalreporting/default.properties. An example external reporting properties file as shown:########### db connection path ########vallent.ds.path=dbconnectionvallent.ds.file=vtdb#XRT foldersexternal.reporting.destination.folder=/appl/virtuo/var/rg/spool/export/reports/localxrt.scripts.folder=/appl/virtuo/admin/scheduler/scripts#Databaseexternal.reporting.batch.size=1000external.reporting.tablespace=TRAFFIC_LARGE#FTP - User May uncomment and change values for the keys below#external.reporting.ftp.default.server=localhost#external.reporting.ftp.default.folder=/tmp#external.reporting.ftp.default.port=21#external.reporting.ftp.default.user=default#external.reporting.ftp.default.password=@ENC@:142A97452514B49Fdefault#SMTPexternal.reporting.smtp.subject=IBM Tivoli Netcool Performance Manager forWireless Report

The following list describes each property:v vallent.ds.path - database connection setting. Must not be changed.v vallent.ds.file - database connection setting. Must not be changed.v external.reporting.destination.folder - default location local exports are

written to.v xrt.scripts.folder - default location where scripts are stored so they appear in

the drop-down list box for the Auto run External Application feature whencreating/editing a schedule. See Scheduling a report in the Using Tivoli NetcoolPerformance Manager - Wireless Component, for information on using this feature.

v external.reporting.batch.size - database setting. Must not be changed.v external.reporting.tablespace - database setting. Must not be changed.v external.reporting.ftp.default.server - default FTP host to be used for

exporting reports by using FTP. To set a default value, uncomment the propertyand edit the property value if required.

v external.reporting.ftp.default.folder - default FTP server folder location tobe used for exporting reports to using FTP. To set a default value, uncommentthe property and edit the property value if required.


v external.reporting.ftp.default.port - default FTP port number to be used forexporting reports by using FTP. To set a default value, uncomment the propertyand edit the property value if required.

v external.reporting.ftp.default.user - default FTP user to be used forexporting reports by using FTP. To set a default value, uncomment the propertyand edit the property value if required.

v external.reporting.ftp.default.password - default FTP password to be usedfor exporting reports by using FTP. To set a default value, uncomment theproperty and edit the property value if required.

v external.reporting.smtp.subject - default Subject entry for all emails sent byusing external reporting.

Setting SMTP propertiesA number of properties must be set correctly in order for SMTP (email) export towork.

These properties are found in the as-default.properties file in/appl/virtuo/conf/as/. The following properties must be set:smtp.host=<full DNS name of the SMTP host>smtp.port=25

External reporting dictionary mappingThe XRT_DICT table contains the information that allows a user map a given reportname to its corresponding export table name.

Each row in this table consists of the report name, the corresponding export tablename, and the time stamp for when the table was last updated with data.

To retrieve the most current table to which a report exports, run the following SQLquery, where <report_name> is the name of the report:SELECT aliasname FROM XRT_DICT WHERE reportname = ’<report_name>’AND tstamp = (SELECT MAX(tstamp) FROM XRT_DICT WHERE reportname = ’<report_name>’);

To map the report's KPI names to their corresponding column names in the exporttable, query the MANGLER table with the following SQL query, where ' <table_name>' is the table name that is returned by the query:SELECT name, mangling FROM mangler WHERE ctx = UPPER(’<table_name>’);

Note: This query returns all KPI names that are exported to the respective table,even KPIs that are no longer contained in the report definition.

Report granularityThe granularity of a report relates to the minimum time intervals at which datacan be reported on.

The default granularity for report generation is 30-minutes. The granularity limit isset in the data source record. To achieve greater report granularity, the timeinterval can be set to 15-minutes.

There are two issues that are concerned with setting report granularity at15-minutes:1. Configuring support for 15-minute intervals so that the system is able to

recognize and compute 15-minute intervals.


2. Enabling the Report Definition GUI to group report results in 15 intervals, byenabling the use the group by 15 minutes check box.

Configuring support for 15-minute reporting intervalsA shell script file can be used to configure the system to support 15-minutereporting intervals.

About this task

Note: This script with solve both issues if it is run before systeminitialization:sys_init. If this script is run after system initialization, you mustfollow the instructions in “Enabling Report Definition GUI” after you comple thisstep.

This file must be copied into /appl along with all of the other packages.

To configure the 15-minute reporting:

Procedure

Call report_configure_15m.sh without arguments:virtuo$ ksh report_configure_15m.sh

File contentShell script file content.#!/bin/ksh

# Script to add reporting intervals as per prospect# should be run as user virtuo before sys_initexport ORACLE_SID=vtdbecho "UPDATE pm_product_info SET value = 96 WHERE property = ’TimeSlices’;" \| sqlplus "virtuo/<password>"echo "UPDATE wm_system_value SET value = 5 WHERE variable_id = \(SELECT id FROM wm_system_variable WHERE name = ’MinReportPeriod’);" \| sqlplus "virtuo/<password>"

This file does not need to be modified and can be used as is.

Note: A reporting interval shorter than 15-minutes is currently not supported.

Enabling Report Definition GUIInstructions on how to enable the Report Definition GUI

About this task

You do not need to follow these instructions if the report_configure_15m.sh scriptwas run before system initialization: sys_init.

The following script does not solve issue number 1. This script would usually needto be run after the instructions in section See Configure support for 15-minutereporting intervals, and after system initialization: sys_init .

To Enable the Report Definition GUI:

Procedure1. Run the following command as user virtuo :


update pe_datasource set report_timeslices=96 where report_timeslices=48;commit;

2. Restart the application server:sap stop assap start as

Aggregation propertiesChanging the behavior of time and entity aggregators by using aggregationproperties.

The behavior of time and entity aggregators might change depending on thevalues of the properties:v ForceSumSummarisation

v ForceOverrideCounterTimeAggregator

By default these properties are set to False . The following applies if theseproperties are set to True .v ForceSumSummarisation - for complex KPIs with more than one counter or an

expression, all aggregators are ignored and the aggregator Sum is used instead.v ForceOverrideCounterTimeAggregator - overrides a counter's aggregation. For

complex KPIs with only 1 counter and no expression, the counter aggregatorsare ignored and the KPI's aggregator is used.

See Using Tivoli Netcool Performance Manager - Wireless Component for informationon aggregation types.

Modifying the values for aggregation propertiesModify the aggregation properties values. The dbsysval_admin tool is used to viewand change property values.

About this task

This procedure is applicable for the following properties:v ForceOverrideCounterTimeAggregator

v ForceSumSummarisation

Note: The accepted values for these two parameters are TRUE or FALSE.

Procedure1. To check the current value for the properties, use -values as virtuo user. For

example:dbsysval_admin -values ForceOverrideCounterTimeAggregator

2. To change the current value for the properties, use the -update option as virtuouser. For example,dbsysval_admin -update ForceOverrideCounterTimeAggregator TRUE

3. To ensure that these changes are reflected correctly, use the followingcommands:agent_admin -u sysadm -p <password> -list current | grep DICTIONARYagent_admin -u sysadm -p <password> -run 8

Note: The number eight is the job id of the DICTIONARY service. TheDICTIONARY service is also scheduled to run every two hours.


4. To synchronize internal computation engine KPI cache, run the followingcommand:kpicache_admin -u <user> -p <password> <dsname>

For more information about this command, see “Synchronize internalcomputation engine KPI cache” on page 103

5. To synchronize the changes, use the following command:summary_sync

Excel download propertiesA property can be used to enable or disable the use quotes for the object id fieldwhen a report is downloaded to Excel format.

For example, whether the object id field (normally CELL_ID) is surrounded byquotes, “1-1-1-1” or not, 1-1-1-1.

The property is com.ibm.tnpmw.reporting.export.quoteStrings, the default valueis true .

The property is located in the following file:

/appl/virtuo/conf/reporting/default.properties

If quoteStrings=false, then quote marks are not used when a report isdownloaded to Excel format.

If quoteStrings=true, or set to some other value then quote marks are used whena report is downloaded to excel format.

See Excel Downloads in the Using Tivoli Netcool Performance Manager - WirelessComponent, for information on downloading a report to excel.

Secondary keysA primary key is the field in a database that is the primary key used to uniquelyidentify a record in a database. A secondary key is an additional key, or alternatekey, which can be use in addition to the primary key to locate specific data.

The following is not supported for secondary keys:v Provisioning of busy hours with secondary keysv Complex summariesv Reports with KPIs based on traffic tables containing secondary keys and traffic

tables not containing secondary keys. For a report with KPIs based on traffictables having secondary key tables, KPIs must be associated with the same KPIgroup.


Maintaining property values for User Comments, Reports andMyFavorites

The dbsysval_admin tool can be used to view and change the values of a numberof properties.

The dbsysval_admin tool can be used to view and change the values of a numberof properties for the following:v User Commentsv Reportsv MyFavorites

To display the current value for a property use the -values option:dbsysval_admin -values <property>

For example:dbsysval_admin -values MyFavoritesMaxChartsDisplayed

To change the current value for a property use the -update option:dbsysval_admin -update <property> <value>

For example:dbsysval_admin -update MyFavoritesMaxChartsDisplayed 8

User commentsViewing and changing values for user comments.

The following values can be viewed and changed for user comments:v ReportCommentMaxLength - the maximum number of characters for a user

comment. The default is 250.

See the Using Tivoli Netcool Performance Manager - Wireless Component for moreinformation on User Comments.

ReportsViewing and changing values for reports.

The following values can be viewed and changed for reports:v QuickReportMaxKPICharsShown - The maximum number of characters of a KPI

name that are displayed in a table view of a report. The default is 20.v QuickReportTruncCharsReverse - The truncation direction of KPI names. The

default is False, truncation occurs from the end of the KPI name. If the value isset to True, truncation occurs from the beginning of the KPI name, so the last ncharacters are displayed.

See the Using Tivoli Netcool Performance Manager - Wireless Component for moreinformation on viewing reports.


MyFavoritesViewing and changing values for a MyFavorites page.

The following values can be viewed and changed for a MyFavorites page:v MyFavoritesMaxTableRowsDisplayed - The maximum number of table rows

displayed for a MyFavorites page. The default is 300.v MyFavoritesMaxChartsDisplayed - The maximum number of charts displayed

for a MyFavorites page. The default is 5.v MyFavoritesMaxElementsDisplayed - The maximum number of elements

displayed in a MyFavorites page. An element can be a graph, a table or acomment. The default is 30.

See the Using Tivoli Netcool Performance Manager - Wireless Component , for moreinformation on the MyFavorites page.

KPI aliases and user defined groupsManaging KPI Aliases and User Defined Groups.

KPI AliasesA KPI alias is a name that better identifies a KPI to a user.

KPI aliases are used in report results instead of standard technology pack KPInames. KPI aliases are also used in report definitions. Only KPIs of the followingfield types can have an alias:v Pegv PCalcv Attributev UDC

Where a Peg or PCalc KPI has an alias then all summaries and stored busy hoursbased on that KPI will also use the alias.

Table 8. Aliasing of summary and busy hour KPIs

KPI type Technology Pack Name Alias

Raw Nok.Traffic.tch_request C1234 (aliased to the counter number)

Summary Nok.Traffic.daily.tch_request daily.C1234

Busy Hour Nok.Traffic.sbhv.daily.tch_request sbhv.daily.C1234

ComplexSummary

Nok.Traffic.daily.max_tch_request Daily.max_C1234

See the Using Tivoli Netcool Performance Manager - Wireless Component for moreinformation on field types.

Aliases should be used to map KPIs from technology packs to user defined names.Aliases must be used in conjunction with user defined groups to map the mostrelevant subset of KPIs from a technology pack.

Note: Care must be taken not to alias very large numbers of KPIs, for example anentire technology pack. This will have a performance overhead during dictionarysynchronization.


User defined groupsA user defined group is a group of KPIs and UDCs that are grouped together forsome purpose.

For example, grouping may reflect different network functions such as planning,optimization and management.

kpia_admin toolThe kpia_admin tool uses a file to map existing technology pack KPI names to aliasnames and user defined groups.

A number of different file formats can be used to import the aliases and userdefined groups in to the system. See File formats for supported file types.

Usagekpia_admin [ -i | -e ] -f <filename> { -d <base dir> } { -t [ alias | group | all ] }

{ -a [ true | false ] }kpia_admin -r <group name>

The following table lists the kpia_admin tool parameters:

Table 9. kpia_admin parameters

Parameter Option Type Description

-i -f <filename> Mandatory Import file. Specifiesthe file containingthe KPI aliasesand/or user definedgroup definitions thatare to be importedinto the system.

-e -f <filename> Mandatory Export file. Specifiesthe file to export allKPI aliases and userdefined groupdefinitions to.

-r <group name> Mandatory Remove group.Specifies the userdefined group to beremoved.

-d <base dir> OptionalSpecifies the basedirectory for the<filename>parameter.

The base directory isthe location fromwhich all other(relative) pathnamesare taken.

If not provided thecurrent directory isused.


Table 9. kpia_admin parameters (continued)

Parameter Option Type Description

-t [ alias | group |all ]

OptionalType. Specifieswhether to importonly aliases, onlyuser defined groupsor all (both aliasesand groups) in a file.

By default all isused.

-a [ true | false ] OptionalAppend. Specifieswhether to appendpre-defined groups ina file. If not specifiedthe default value isfalse .

If append is set tofalse then existingassociations topre-defined groupsfor KPIs areremoved. If appendis set to true thenassociations topre-defined groupsare retained. Apre-defined group isa group defined by aKPI's technologypack.

Note: This option isalso available in thexml file format as anattribute of groups.The CLI appendvalue overrides thexml option value. SeeXML file format.

Importing aliasesTo create an alias or a number of aliases you import a file, which maps the aliases.

About this task

If no directory is specified, the location of the file is assumed to be the currentdirectory.

Procedure

To import an alias file:kpia_admin -i -f <filename> -t aliaskpia_admin -i -f <filename> -d <directory> -t alias


For example:kpia_admin -i -f aliases.csv -t aliaskpia_admin -i -f aliases.alias -d /appl/virtuo/admin/aliases -t alias

In this example, the following csv file has been imported:v KPI name 1, KPI alias 1, KPI user-defined group 1v KPI name 2, KPI alias 2, KPI user-defined group 1

Where KPI name must have the following format:<Entity>.<Vendor>.<Block>.<KPI name>

For example: TRX.Nokia.RLC_Blocks.dl_rlc_mac_blocks

Note: Run the kpicache_admin and data dictionary (agent_admin) to access the KPIalias from the UI.

Import user defined groupsTo create a user defined group or groups you import a file, which maps the groupsto KPIs.

Procedure

To import a user defined groups file:kpia_admin -i -f <filename> -t group

For example:kpia_admin -i -f userdefinedgroups.csv -t groupkpia_admin -i -f userdefinedgroups.groups -t group

Append to existing user defined groupsAppend is used to specify whether to append user defined groups to a KPI'sexisting user defined groups.

About this task

If append is set to false then existing associations to user defined groups for KPIsare removed, and replaced with the new user defined groups. If append is set totrue then associations to existing groups are retained, and the new user definedgroups are "appended" to the existing groups.

If not specified the default value is false .

Note: This option is also available in the xml file format as an attribute of groups.The CLI append value overrides the xml option value. See XML file format.

Procedure

To import a user defined groups file and append to existing groups:kpia_admin -i -f <filename> -t group -a true


Import aliases and groupsTo create both aliases and user defined groups you import a file which maps thealiases and groups.

Procedure

To import a user defined groups file:kpia_admin -i -f <filename> -t all

For example:kpia_admin -i -f userdefinedgroups.csv -t all

Removing user-defined groupsTo remove a user-defined group that you specify the group to be removed.

About this task

When a user-defined group is removed by using the -r option, it is removed for allKPIs.

Procedure

To remove a user-defined group:kpia_admin -r <user defined group name>

For example:kpia_admin -r userdefinedgroupname1

Updating and removing aliases and user-defined groupsAliases and user-defined groups can be removed or changed by reimporting a file.

About this task

The following example assumes the -append option is set to false.

Procedure

Where a file has been imported to create aliases and groups, the same file can beused to update or remove aliases and groups by amending and reimporting thefile.

Note: If the -append option is set to true, existing user-defined groups areretained. When unspecified the -appendoption is set to false by default.

Example

In this example, the following csv file has been imported.

KPI name 1, KPI alias 1, KPI user-defined group 1KPI name 2, KPI alias 2, KPI user-defined group 1

Where the KPI name must have the following format:<Entity>.<Vendor>.<Block>.<KPI name>


For example: TRX.Nokia.RLC_Blocks.dl_rlc_mac_blocks

The file is then updated as:

KPI name 1, KPI alias A, KPI user-defined group 1KPI name 2, KPI alias 2, KPI user-defined group 2

When the file is imported again, KPI name 1's alias has been removed andreplaced with KPI alias A. KPI name 2 is no longer a member of KPI user-definedgroup 1, but is now a member of KPI user-defined group 2.

You can remove or update multiple aliases and user-defined groups in a file, for allfile types.

Note: Run the kpicache_admin and data dictionary (agent_admin) to access the KPIalias from the UI.

Export aliases and groupsTo export all KPI aliases and user defined groups currently defined in the system,you specify the name and (optionally) the location of the file to export to.

If you do not specify a location the current directory is used. Use the following fileextensions: csv, xml, or kpia. It is these file extensions that contain both alias andgroup data. You cannot export KPI aliases and user defined groups separately.

To export all KPI aliases and user defined groups:kpia_admin -e -f <filename>kpia_admin -e -f <filename> -d <directory>

For example:kpia_admin -e -f kpialiases1.csvkpia_admin -e -f kpialiases1.csv -d /appl/virtuo/admin/aliases/export

File formatsThe kpia_admin tool supports a number of file formats that can be used to importand export KPI aliases and user defined groups.

These include:v CSVv XMLv Customized files:

– kpia– alias - import only– group - import only

Valid KPIsKPIs that can have an alias.

Only KPIs of the following field types can have an alias:v Pegv PCalcv Attributev UDC


See the Using Tivoli Netcool Performance Manager - Wireless Component for moreinformation on field types.

RestrictionsRestrictions on KPIs.

An alias does not have to be unique. Only one alias per KPI is permitted. An aliascan be up to 50 characters long. An alias can use alphanumeric characters and theunderscore character. Alphabetic characters are case insensitive. An alias cannotbegin with a numeric character.

A user-defined group name can be up to 50 characters long. A user-defined groupname can use alphanumeric characters and the underscore character. Alphabeticcharacters are case insensitive. A user-defined group name cannot begin with anumeric character. A KPI can be a member of multiple groups.

If you specify a KPI more than once in a file the last entry is used to map aliasesand groups. For example:KPI name 1, KPI alias A, KPI user defined group 1KPI name 1, KPI alias B, KPI user defined group 2

In this example, KPI name 1 is mapped with KPI alias B and KPI user definedgroup 2. The first entry is ignored.

CSVThe format for a csv file is KPI name, KPI alias and user defined group.

For each KPI it is optional whether a KPI alias and a user-defined group arespecified.

For example:KPI name 1, KPI alias A, KPI user defined group 1KPI name 2, KPI alias 2, KPI user defined group 1, KPI user defined group 2KPI name 3, KPI alias 3,KPI name 4, , KPI user defined group 1, KPI user defined group 2

XMLThe format for an xml file.

KPI alias, and user-defined group are both optional. You can specify whether a KPIhas an alias or is a member of a user-defined group, or both. Append is alsooptional. If append is set to false, then existing associations to pre-defined groupsfor KPIs are removed. If append is set to true, then associations to pre-definedgroups are retained. A pre-defined group is a group that is defined by a KPI'stechnology pack.<fields>

<field><kpiname>kpi_name0</kpiname><alias>alias0</alias><groups append="true">

<group>group01</group><group>group02</group>

</groups></field><field><kpiname>kpi_name1</kpiname><alias>alias1</alias><groups>

<group>group01</group>


<group>group02</group></groups>

</field><field><kpiname>kpi_name1</kpiname><alias>alias1</alias><groups/>

</field><field><kpiname>kpi_name2</kpiname><alias/><groups>

<group>group01</group></groups>

</field></fields>

Customized file typesA number of customized file types can be used.

A number of customized file types can be used for:v Aliases and groups, using the file extension kpiav Aliases, using the file extension aliasv Groups, using the file extension group

For example,userdefinedgroups1.group

A file that uses the appropriate format and extension must be used for customizedfile types.

kpia

This file format that contains both alias and user-defined groups in the followingformat:kpi_name0 = alias0 | group01, group02,kpi_name1 = alias1 | group11, group12, group13# This is a comment line

alias

Used for import only. This file format contains only aliases in the following format:kpi_name0 = alias0kpi_name1 = alias1

group

Used for import only. This file format contains only user defined groups in thefollowing format:kpi_name0 = group01, group02, group03


Log filesLog file location.

The kpi_admin log file's location is: /appl/virtuo/logs/kpia/kpia.log

KPI Browser configurable parametersConfiguration of the KPI Browser is achieved by using a number of systemparameters and properties files.

The following are used and can be configured:v Systems variables stored in WM_SYSTEM_VALUES_Vv Service properties;v Scheduler properties, in <deploy_area>\conf\simplereporting\

default.properties

v Back-end cache properties, in <deploy_area>\conf\as\cache-default.properties

Configurable system variablesA number of parameters are available as configurable system variables.

These parameters are used to control the following aspects of the KPI Browser:v Default aspects of graph rendering.v Maximum and minimum limits for resource, KPI, and graph selections.v User interface caches.v Report execution and queuing.

The following table describes parameters that can be set for the KPI Browser.

Table 10. Configurable parameters

Parameter TypeAllowedValues Default Description

KPIB_Enable3dBoolean NA False

Default state of 3D mode forGraphs. When true the graphs aredisplayed in 3D.

KPIB_EnableToolTip Boolean NA FalseDefault state of tooltip mode forGraphs. When true the graphs havetooltips associated with themshowing the value of each memberin the graph.

KPIB_EnableLegendBoolean NA True

Default state of Legend mode forGraphs. When true the graphs aredisplayed with their legends

KPIB_ModeStandardBoolean NA True

When true KPI Selection mode isstandard. When false the userdefined mode is selected. In aliasmode the user defined alias is usedfor KPI selection if available. If notavailable the long name is used.


Table 10. Configurable parameters (continued)


KPIB_MaxResourceSelectionInt 1+ 20

Max number of resources that canbe selected.

KPIB_MaxKpiSelectionInt 1+ 20

Max number of KPIs that can beselected.

KPIB_IncrementRawHourMinInt 1+ 1

Min Increment value allowed whenField Interval is Raw.

KPIB_IncrementRawHourMaxInt 1+ 336 Max Increment value allowed when

Field Interval is Raw. Must be equalto or greater thanKPIB_IncrementRawHourMin.

KPIB_IncrementRawDayMinInt 1+ 1

Min Increment value allowed whenField Interval is Raw.

KPIB_IncrementRawDayMaxInt 1+ 14

Max Increment value allowed whenField Interval is Raw. Must be equalto or greater thanKPIB_IncrementRawDayMin.

KPIB_IncrementDailyDayMinInt 1+ 1

Min Increment value allowed whenField Interval is Daily and Time isDay.

KPIB_IncrementDailyDayMaxInt 1+ 28

Max Increment value allowed whenField Interval is Daily and Time isDay. Must be equal to or greaterthan KPIB_IncrementDailyDayMin.

KPIB_IncrementDailyWeekMinInt 1+ 1

Min Increment value allowed whenField Interval is Daily and Time isWeek.

KPIB_IncrementDailyWeekMaxInt 1+ 4

Max Increment value allowed whenField Interval is Daily and Time isWeek. Must be equal to or greaterthanKPIB_IncrementDailyWeekMin.

KPIB_IncrementWeeklyMinInt 1+ 1

Min Increment value allowed whenField Interval is Weekly and Time isWeek.

KPIB_IncrementWeeklyMaxInt 1+ 8

Max Increment value allowed whenField Interval is Weekly and Time isWeek. Must be equal to or greaterthan KPIB_IncrementWeeklyMin.

KPIB_IncrementMonthlyMinInt 1+ 1 Min Increment value allowed when

Field Interval is Monthly.




KPIB_IncrementMonthlyMaxInt 1+ 12

Max Increment value allowed whenField Interval is Monthly. Must beequal to or greater thanKPIB_IncrementMonthlyMin

KPIB_GraphGridLayoutDefaultXaxisInt 1+ 2

Default number of graphs availablein X axis that you see on screen.This can be changed dynamicallyfrom within the screen.

KPIB_GraphGridLayoutMaxXaxisInt 1+ 10 Max number of graphs available in

X axis. Must be equal to or greaterthanKPIB_GraphGridLayoutDefaultXaxis.

KPIB_GraphGridLayoutDefaultYaxisInt 1+ 2

Default number of graphs availablein Y axis that you see on screen.This can be changed dynamicallyfrom within the screen.

KPIB_GraphGridLayoutMaxYaxisInt 1+ 10

Max number of graphs available inY axis. Must be equal to or greaterthanKPIB_GraphGridLayoutDefaultYaxis.

KPIB_ReportPollingInshallahFrequencyInt 1000+ 2000

The number of millisecondsbetween polls on the client to checkif the KPI Browser report hasfinished. Once finished the report isdisplayed on screen.

KPIB_ReportPollingTimeToFrequencyShiftInt 1000+ 5000 The number of milliseconds before

the client moves to a different timeinterval for polling the server to seeif the KPI Browser report hasfinished.

KPIB_ReportPollingSecondaryFrequencyInt 1000+ 20000

The time interval in millisecondsbetween polls on the client to checkif the KPI Browser report hasfinished. This value is used onlywhen the shift from initial tosecondary frequency has occurred.

KPIB_retryTimesInt 0+ 3

Number of times to retry therunning of a report when a pollingof a report has timed out.

KPIB_ReportPollingTimeOutInt 1+ 30000

The number of milliseconds beforea polling for a report is consideredto have timed out.




KPIB_SupportedGraphTypesString Comma

delimitedintegers

5,0,1,2,4,6,7,1,14,15,17,18,19,20

A list of comma delimited integersthat represent graph types that areavailable for the KPI Browserreport. The CSV order representsthe order in which the graph namesare displayed in the UI. See “Validgraph values.”

KPIB_GlobalFilterEntityUICacheTimeoutInt 0+ 300

Time in seconds before uniqueselections held in cache for theEntity Selection expire.

KPIB_FieldTypeUICacheTimeoutInt 0+ 300

Time in seconds before uniqueselections held in cache for the FieldType expire.

KPIB_SBHListUICacheTimeoutInt 0+ 300 Time in seconds before unique

selections held in cache for the SBHexpire.

KPIB_KpiGroupListUICacheTimeoutInt 0+ 300 Time in seconds before unique

selections held in cache for KPIGroup expire.

KPIB_ResourceSearchUICacheTimeoutInt 0+ 300 Time in seconds before unique

selections held in cache forResource Search expire.

Change a valueThe dbsysval_admin tool can be used to view and change values.

To display the current value for a parameter, use the -values option, as uservirtuo :dbsysval_admin -values <property>

For example:dbsysval_admin -values KPIB_Enable3d

To change the current value for a property, use the -update option, as user virtuo :dbsysval_admin -update <property> <value>

For example:dbsysval_admin -update KPIB_Enable3d true

Valid graph valuesA list of each graph and corresponding value.

The following table lists each graph and corresponding value.

Table 11. Allowed Graphs

Value Graph

0 Bar


Table 11. Allowed Graphs (continued)

Value Graph

1 Stacked Bar

2 Superimposed Bar

3 Area

4 Stacked Area

5 Line Plot

6 Scatter

7 Stair

11 Stacked Polyline

14 Stacked Stair

15 Summed Stair

17 Stacked 100 Bar

18 Stacked 100 Line Plot

19 Stacked 100 Area

20 Stacked 100 Stair

Configurable service propertiesThe properties of the service used to run reports and cache data on the server.

These are properties of the service used to run reports and cache data on theserver. You can update values by amending the relevant service properties file.v Scheduler properties, in <deploy_area>\conf\simplereporting\

default.properties

v Back-end cache properties, in <deploy_area>\conf\as\cache-default.properties

default.propertiesThis properties file contains the property values for the simple report service.

Table 12. default.properties

Property Service Default Value Description

executorthreads NA 10Number of reports that can beexecuted concurrently. This is thenumber of threads in the simple reportexecutor pool.

queue.length NA 1000Maximum number of reports that canbe queued, waiting for a thread toexecute. Further reports requests arecancelled automatically until there isspace in the queue.

file.maxage simplereport_old 60 minutesMaximum age of the report on diskbefore the service deletes it.


Table 12. default.properties (continued)

Property Service Default Value Description

exceution.maxage simplereport_exec 10 minutes Length of time in minutes before theservice cancels a KPI Report that isrunning.

storedef NA False It is possible to view the status ofexecuting and executed reports usingloadSimpleReportQueueDump.do fromthe web client. Setting this to trueenables the display of the reportdefinition in this web page. By defaultit is set to false to reduce memoryfootprint.

staleness NA 5 minutes Maximum age of report results beforeconsidered stale

The KPI Browser has a caching facility.If you run the same report twice in arow it gets the result from the previousexecution.

The staleness setting is the length oftime a report result can be consideredvalid before it is refreshed.Note: This affects the KPI Browseralone.

cache-default.propertiesThis properties file contains the property values for the server caches used by theKPI Browser.

Table 13. cache-default properties

Property group Description

Entity dimension field values Entities are cached as they are requested andhave associated vendor and technologyproperties. The field value cache and theindex cache are then built up over time asrequests are made.

Entity dimension field indexes Requests are made based on vendor andtechnology. Matching entity indexes areretrieved from the Entity dimension fieldvalue cache, and cached here with a hash ofthe unique request. The field value cacheand the index cache are then built up overtime as requests are made.

KPI fields All KPIs are cached and have associatedvendor, technology, entity, and KPI Groups.Uses the same caching mechanism as theentity cache but entities are replaced byKPIs.


Table 13. cache-default properties (continued)

Property group Description

KPI indexes Requests are made based on vendor,technology, entity, and KPI Group. MatchingKPI indexes are retrieved from the KPI fieldscache, and cached here with a hash of theunique request. All KPIs are cached andhave associated vendor, technology, entity,and KPI Groups. Uses the same cachingmechanism as the entity cache but entitiesare replaced by KPIs.

Simple report results Cache of each requested report. If a requestfor the same report is received, it is fetchedfrom cache based on staleness.limit andexceution.maxage.

reportCBResults Reads the serialized report result file intomemory for rapid access. MaxObjects limitsthe number of report result files that areheld in memory at a given time (default 5).MaxMemoryIdleTimeSeconds is the period tohold the reports in memory in seconds(default 5 minutes).


Chapter 5. Operations tasks

Describes a number of operations tasks and housekeeping activities that areessential for the operation of the system.

These include:v “Daily loader operations tasks”v “Loader housekeeping” on page 79v “Application directory management” on page 84

Although not regular tasks, the following is also described:v “Stability settings” on page 84

Daily loader operations tasksIn a Tivoli Netcool Performance Manager system, there might be a number ofloaders running for a number of technologies.

The loader process runs constantly taking data from the loader spool directoriesand loading it into the performance database.

The loader process is critical to the functioning of the system.

The following must be done on a daily basis:v Check Loader statusv Check for bad files

Checking loader statusInstructions on how to check the status of the loaders.

About this task

To check the status of the loaders, complete the following steps:

Procedure1. As the virtuo: user, enter the command:

sap disp

Output will be displayed listing the loaders that are started and loaders thatare stopped. For example:[virtuo]sap dispNAME STATE SINCEas STARTED Mar 14, 2007nc_cache STARTED Mar 14, 2007alarm_cache STARTED Mar 14, 2007load_ericssongsmbssneutral STARTED Mar 14, 2007load_ericssongsmbss STARTED Mar 14, 2007load_nokiagsmbssneutral STARTED Mar 14, 2007load_nokiagsmbss STARTED Mar 14, 2007load_motorolagsmbss stopped -load_motorolagsmbssneutral stopped -load_motorolaumtsutran stopped -load_ericssonumtsutran stopped -


2. If the loaders have not started correctly, check the loader logs for startup issues.Loader log files are stored in the $WMCROOT/logs/loader directory.

Note: nc_cache and alarm_cache are processes with which all loaderscommunicate. They must be started prior to starting the loaders. nc_cacheprovides a common view of all network configuration (nc) information to theloader processes. This ensures that the nc data is synchronized between allloaders. For example, if loader A rehomes a cell then loader B is made aware ofthis rehoming event. alarm_cache provides a common view of all alarms raisedby the loaders.

Checking for bad filesInstructions on how to check for large amounts of bad files.

Procedure

Check the following directories for large amounts of bad files:$WMCROOT/var/loader/spool/<datasourcename>/<datasourceversion>/badIf there is a large number of bad files in either of these directories the loader logfiles should be checked. Loader log files are stored in the $WMCROOT/logs/loaderdirectory.

Results

The following is an example output from a loader log file.12:23:51,756 INFO [DataLoader] TaskId[2]. File processing started for[INUSE.MSC_1-#-CELL_DATA-#-BSS9.20081016.12.00.1-2-1.lif],12:23:53,537 INFO [LoadMapBlockPool] TaskID[2], [CELL_DATA] LoadMap block loaded successfully12:23:54,175 INFO [ExpressionMapPool] TaskID[2], [CELL_DATA] LoadMap block compiled successfully12:23:55,182 INFO [MasterCacheRequest] TaskID[2], Master Request. No Blocks [100 Diffs 1].12:23:55,191 INFO [MasterCacheRequest] TaskID[2], Table [NC_BSC] version[0].Number of lookups [2]. Number of diff [1]. Times [,Wed Feb 25 10:40:00 GMT 2009,Wed Feb 25 13:56:00 GMT 2009]12:23:55,193 INFO [MasterCacheRequest] TaskID[2],Table [NC_CELL] version[0].Number of lookups [100]. Number of diff [1]. Times [,Wed Feb 25 10:40:00 GMT 2009,Wed Feb 25 13:56:00 GMT 2009]12:23:55,318 INFO [MasterCacheResponse] TaskID[2],Master Response. Return Code [RELOAD]12:23:55,320 INFO [MasterCacheResponse] TaskID[2],Table[NC_CELL] version[32].Number of new/updated rows[1].12:23:55,377 INFO [MasterCacheRequest] TaskID[2],Master Request. No Blocks [100 Diffs 1].12:23:55,379 INFO [MasterCacheRequest] TaskID[2],Table [NC_CELL] version[32].Number of lookups [100]. Number of diff [1]. Times [,Wed Feb 25 10:40:00 GMT 2009,Wed Feb 25 13:56:00 GMT 2009]12:23:55,575 INFO [MasterCacheResponse] TaskID[2],Master Response. Return Code [RELOAD]12:23:55,576 INFO [MasterCacheResponse] TaskID[2],Table[NC_CELL] version[null]. Number of new/updated rows[100].12:23:55,599 INFO[MasterCacheRequest] TaskID[2], Master Request. No Blocks [100 Diffs 0].12:23:55,601 INFO [MasterCacheRequest] TaskID[2], Table [NC_CELL] version[32].Number of lookups [0]. Number of diff [0]. Times []12:23:55,613 INFO[MasterCacheResponse] TaskID[2], Master Response. Return Code [OK]12:23:55,859 INFO [TableDAO] TaskID[2], Table [VNL_CELL_SDCCH_TAB], Evaluated [100]rows with null data for one or more of the columns [[V165GLHAHL26SEC5R00HW01QK4]]12:23:55,921 INFO [TableDAO] TaskID[2], Merged [100] rows intotraffic table [VNL_CELL_SDCCH_TAB]12:23:56,038 INFO [TableDAO] TaskID[2], Merged [100] rowsinto traffic table [VNL_CELL_INTERFERENCE_TAB]12:23:56,287 INFO [TableDAO] TaskID[2], Merged [100] rowsinto traffic table [VNL_CELL_HANDVR_RSLT_TAB]12:23:56,358 INFO [TableDAO]TaskID[2], Table [VNL_CELL_TCH_TAB], Evaluated [100]rows with null data for one or more of the columns [[V1LL006AHL26SEC5R00HW01QK4]]12:23:56,428 INFO [TableDAO] TaskID[2], Merged [100] rowsinto traffic table [VNL_CELL_TCH_TAB]12:23:56,560 INFO [DAHandler] TaskID[2],


Calculated DA informationda_loaded_tables[4] wml_loaded_table_interval[2] da_loaded_blocks[0]12:23:56,560 INFO [DAHandler] TaskID[2], DA:Not writing data to tables yet.Cache size[6], Max Size[1000]12:23:56,562 INFO [AlarmHandler] TaskID[2], Sending [0] alarm objects tothe alarm cache from file[/appl/virtuo/var/loader/spool/nokiabss_oss31ed3/OSS3.1_ED3/INUSE.MSC_1-#-CELL_DATA-#-BSS9.20081016.12.00.1-2-1.lif]12:23:56,563 INFO [FinalHandler] TaskID[2], File processing finished for[/appl/virtuo/var/loader/spool/nokiabss_oss31ed3/OSS3.1_ED3/INUSE.MSC_1-#-CELL_DATA-#-BSS9.20081016.12.00.1-2-1.lif] with result [true]loading time [4] sec12:23:56,563 INFO [FinalHandler] TaskID[2], No of processed blocks [100];No of bad blocks: [0]; No of unprocessed blocks: [0]12:23:57,629 INFO [DAHandler] TaskID[2], DA:Writing data to tables.da_loaded_tables[4] wml_loaded_table_interval[2] da_loaded_blocks[0]12:23:57,689 INFO [DAAbstractDAO] TaskID[2], Merged [4] rows into table[wml_loaded_table_interval] for period [Start : Wed Feb 25 10:40:00 GMT 2009End Wed Feb 25 11:10:00 GMT 2009]12:23:57,720 INFO [DAAbstractDAO] TaskID[2], Merged [4] rows into table[wml_loaded_table_interval] for period [Start : Wed Feb 25 13:56:00 GMT 2009End Wed Feb 25 14:26:00 GMT 2009]12:23:57,747 INFO [DAAbstractDAO] TaskID[2], Merged [4] rows into table[da_loaded_tables] for period [Start : Wed Feb 25 10:40:00 GMT 2009End Wed Feb 25 14:26:00 GMT 2009]

If the loader is sending lif files to the bad directory a number of SQL errormessages might be generated. The example shows an error in a loader log file.

12:29:08,764 ERROR [TrafficHandler] SQL_INSERT Could not insert [1] rows into table [NC_CELL]SQL_INSERT Could not insert [1] rows into table [NC_CELL]at com.ibm.tivoli.tnpmw.loader.dao.NcDAO.insert(NcDAO.java:140)at com.ibm.tivoli.tnpmw.loader.cache.nc.master.NcMasterCache.persistData(NcMasterCache.java:692)at com.ibm.tivoli.tnpmw.loader.cache.nc.master.NcMasterCache.applyFileDiff(NcMasterCache.java:412)at com.ibm.tivoli.tnpmw.loader.cache.nc.master.NcMasterCache.processRequest(NcMasterCache.java:319)at com.ibm.tivoli.tnpmw.loader.cache.nc.master.rmi.NCCacheRemoteImpl.processRequest(NCCacheRemoteImpl.java:205)at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source)at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)at java.lang.reflect.Method.invoke(Unknown Source)at sun.rmi.server.UnicastServerRef.dispatch(Unknown Source)at sun.rmi.transport.Transport$1.run(Unknown Source)at java.security.AccessController.doPrivileged(Native Method)at sun.rmi.transport.Transport.serviceCall(Unknown Source)at sun.rmi.transport.tcp.TCPTransport.handleMessages(Unknown Source)at sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run(Unknown Source)at java.lang.Thread.run(Unknown Source)Caused by: java.sql.BatchUpdateException:ORA-12899: value too large for column "VIRTUO"."NC_CELL"."CELL_ID"(actual: 98, maximum: 50)at oracle.jdbc.driver.DatabaseError.throwBatchUpdateException(DatabaseError.java:343)at oracle.jdbc.driver.OraclePreparedStatement.executeBatch(OraclePreparedStatement.java:10720)at com.ibm.tivoli.tnpmw.loader.dao.NcDAO.insert(NcDAO.java:131)... 15 more

Example

The Oracle oerr ora command can be used to provide additional informationabout the problem.

For example:

Chapter 5. Operations tasks 77

oerr ora 140001400, 00000, "cannot insert NULL into (%s)"

In some cases lif files may go to the bad directory and there may be very littleinformation in the error logs to track the problem. In such cases the log level canbe set to a higher level to produce logs with more information.

Note: It is advisable to only to run the loader at log level DEBUG for short periodsof time because the logs that are generated can be very large. Log level INFO is thenormal logging requirement.

Changing the loader log levelInstructions on how to change the loader log level of any loader while it isrunning:

About this task

To change the loader log level of any loader while it is running, use theloader_admin command.

Procedure

As the virtuo user, enter the following command:loader_admin -loglevel <loglevel> -instance <instance_name>

There are three settings for <loglevel>:v DEBUGv INFOv ERROR

Note: You can also set the loader log level along with other loader properties byusing loader_admin -load <properties_xml> -instance <instance_name>.

Log levelsListing of log levels.

The following table lists the three logging levels.

Table 14. Logging Levels

Logging Level Description

DEBUG This level indicates low level messages thatcan be used to analyze componentprocessing data.

INFO This level indicates activity in the system atcertain points in the operation, such asstarting up or shutting down. It will showwhether a lif file was successfully processedor not, and which traffic tables wereupdated.

ERROR This indicates errors that can be recoveredfrom. This will be true for almost all errorhandling.


DEBUG level logging - impacts on performanceLog levels can be set for various parts of the system.

In normal operation the log level for all of the subsystems should be set to INFO.DEBUG level can adversely impact performance.

Loader housekeepingLoader housekeeping tasks.

The following housekeeping task should be done on a daily basis:v Disk space usagev Loader configurationv Configuring multiple identical loaders

Disk space usageLIF files are constantly being parsed, loaded, and moved to either good or baddirectories.

If a problem occurs LIF files might be parsed but not loaded. This might cause the$WMCROOT/var/loader/spool/<datasourcename>/<datasourceversion> file system tofill up, preventing any new files from being created.

After LIF files are processed they must be removed from the system, otherwise the$WMCROOT/var/loader/spool/<datasourcename>/<datasourceversion> file systemmight fill up.

To check file system allocation and usage (in particular for /spool):1. Enter the following command as user virtuo:

$df -k

LIF file storageCurrently, the loader stores the successfully loaded files within a loader gooddirectory. This process causes an extra load to hardware resources such as diskstorage.

To improve the Tivoli Netcool Performance Manager Wireless system performance,a new parameter keep.good.lif is added to the loader property file<properties.xml> to activate or deactivate the file storage for each loader instance.For more information about loader configuration and the properties file, see“Loader configuration” on page 81.

The following scenarios describe how the keep.good.lif parameter works within aloader instance:v If the LIF file is processed successfully and keep.good.lif = TRUE, the data file

is moved to the good directory, for example, $WMCROOT/var/loader/spool/<datasourcename>/<datasourceversion>/good

v If the LIF file is processed successfully and keep.good.lif = FALSE, then datafile is permanently deleted from the system.

v If the LIF file is not processed successfully and keep.good.lif = TRUE, the datafile is moved to the bad directory.

v If the LIF file is not processed successfully and keep.good.lif = FALSE, the datafile is moved to the bad directory.


Activating and deactivating the keep.good.lif parameterThe default value for the keep.good.lif parameter is TRUE. You can set the value toFALSE.

Before you begin

Ensure that the loader is started by using the following command:sap disp

Note: Start the loader if it is stopped by using the command: sap start <loader>.

Procedure1. To change the keep.good.lif value for every loader instance, unload loader

properties into xml file by using the following command as virtuo user: Thenokiabss_oss31ed3 loader file is used as an example.loader_admin -unload config_nokiabss_oss31ed3.xml -instance nokiabss_oss31ed3

2. Change the value of the following parameter to TRUE or FALSE in theconfig_nokiabss_oss31ed3.xml.xml file as follows:<property>

<name>keep.good.lif</name><value>TRUE</value>

</property>

3. Load the config_nokiabss_oss31ed3.xml file by using the following command:loader_admin -load config_nokiabss_oss31ed3.xml -instance nokiabss_oss31ed3

The keep.good.lif parameter accepts any string value other than TRUE orFALSE. In this scenario, you might notice the following FileDispatcherinformation message in the $WMCROOT/logs/loader/nokiabss_oss31ed3.log file:Parameter [keep.good.lif] is incorrectly set, value expected is TRUE or FALSE (default to TRUE).

If the keep.good.lif parameter is missing from the loader properties, youmight notice the following FileDispatcher information message in the$WMCROOT/logs/loader/nokiabss_oss31ed3.log file:Parameter [keep.good.lif] is missing in loader properties (default to TRUE).

You can verify the value by running the following SQL query:select * from lc_loader_config_properties where name=’keep.good.lif’;

The result set contains the list of loader instances and the corresponding valuesfor keep.good.lif as TRUE or FALSE.

Note: The new technology packs that are installed later will have thekeep.good.lif parameter available in their <properties.xml> file.


Loader configurationThe loader_admin -load and -unload commands can be used to change theconfiguration of a loader.

The unload command exports a loader configuration to an xml file:loader_admin -unload <properties_xml> -instance <instance_name>

These properties can be edited and then reloaded with:loader_admin -load <properties_xml> -instance <instance_name>

Properties operate on a per-loader instance basis. Changes to properties of oneinstance will not affect the operation of another instance, even an instance of thesame technology pack. The following is a list of editable properties:v alarmcache.aged - retention in minutes before alarms are cleared automatically.v alarms.enabled - can be true or false . Indicates whether alarm generation is

turned on or off.v datasource.bad - path to the folder for failed files.v datasource.folder - source folder for lif files to be parsed.v datasource.good - path to the folder for successful files.v error.handling.mode - describes whether files are processed in file mode or

block mode. In file mode the whole file fails if one block is bad. In block modeonly the failed block is lost. 0 indicates file mode, 1 indicates block mode.

v log.folder - destination folder for log files.v log.level - log level. Can be DEBUG, INFO or ERROR.v reread.interval - how often to check for configuration changes.v thread.pool.LifStreamProcessor - sets the number of threads for each section

of the loader.v thread.pool.TrafficHandler - sets the number of threads for each section of the

loader.v thread.pool.groups - defines the handlers that are to be used in loading.v log.rehome.folder - destination folder for rehoming log.v log.rehome.filename - destination file for rehoming log.v log.filename - destination file for standard log.v timezone - the timezone of that the LIFS being loaded were generated for.v itm.interval - how often to log IBM Tivoli Monitoring (ITM) metrics.v itm.folder - destination folder for ITM log.v itm.file - destination file for ITM log.v itm.enabled - whether ITM logging is enabled.

For more information about the IBM Tivoli Monitoring parameters, seeIntegrating with Tivoli Monitoring - Wireless Component.

v keep.good.lif - a flag to activate or deactivate the storage functionality to keepor delete a successfully loaded LIF file.

v itm.late.latency.offset - configures the late latency of a loader. Default valueis 0. Valid range must be >= 0 to <= 1440.

When new properties are loaded, a running loader will check for changes toproperties that start with log . and rehoming. These properties will be reloadedwithout a restart. All other properties require a restart of the loader instance inorder to take effect.


Note: Threading properties. Threading is used to improve the overall performanceof the loaders. The optimal setting is:thread.pool.TrafficHandler = 4thread.pool.LifStreamProcessor = 2

That is, 2 threads parsing the lif file and 4 threads writing the data to the traffictables. Writing data to traffic tables takes twice as long as lif parsing. While it ispossible to increase the number of threads beyond this, this results in adegradation in performance due to thread swapping.

Improving the performance of the loaderUse this information to improve when the loader performance is degrading due tolarge NC tables that run long processes at nc_cache.

Procedurev Use the property mastercache.secondary.tables to process specific NC tables by

secondary cache at the loader level.Typically, you can use this SQL statement to create default entries in thelc_loader_config_properties table to indicate that all NC processing can be doneby primary nc_cache.INSERT INTO lc_loader_config_propertiesSELECT DISTINCT datasource_id, loader_name, ’mastercache.secondary.tables’, ’’FROM lc_loader_config_propertiesWHERE loader_name NOT IN (SELECT DISTINCT loader_nameFROM lc_loader_config_propertiesWHERE name = ’mastercache.secondary.tables’OR loader_name = ’SYSTEM’);commit;

You can change the configuration of a particular loader to process the specificNC tables by using secondary cache. For example, Loader1 is updatingNC_NEIGHBOUR table that contains many rows and it is blocking other loadersfor other NC tables, use the following SQL statement:update lc_loader_config_properties set value=’NC_NEIGHBOUR’ where loader_name = ’Loader1’and name=’mastercache.secondary.tables’;

Note: Use comma separator for multiple NC tables. For example:update lc_loader_config_properties set value=’NC_NEIGHBOUR,NC_BSC’ where loader_name = ’Loader1’and name=’mastercache.secondary.tables’;

v Apply an index on nc_version for nc_cache to access records that are based onnc_version for faster and improved loader performance.Typically, loaders load NC table records by using nc_cache, which looks uprecords based on nc_version. To index the nc_version, follow these steps:1. Copy the contents of this shell script in a notepad application and save it as

<script.sh>.sqlplus -s -l /nolog <<EOF

connect virtuo/Virtuo01@vtdbwhenever oserror exit 9whenever sqlerror exit sql.sqlcodeSET FEEDBACK OFFSET VERIFY OFFset lin 300spool nc_version_indexes.sql

Select Distinct ’CREATE INDEX ’ || substr((Table_Name),0,20)|| dbms_random.string(’U’, 6) || ’_NCV ON ’ || Table_Name || ’ ("NC_VERSION");’ remFrom user_tablesWhere Table_Name Like ’NC_%’


AND table_name NOT IN ( SELECT A.table_name FROM user_ind_columns a, user_indexes bWhere A.Index_Name=B.Index_NameAnd A.Table_Name Like ’NC_%’And A.Column_Name = ’NC_VERSION’)

AND table_name NOT IN( ’NC_ARCHIVER_TMP’,’NC_ARCHIVER_TMP_CLEANUP’,’NC_ARCHIVER_TMP_CLEANUP_LOG’,’NC_ARCHIVER_TMP_INUSE’);

spool off;@nc_version_indexes.sqlEOFres=$?if [ $res -ne 0 ]; then

echo "`date`: ERROR: while appying indexes"else

echo "`date`: Successfully applied indexes for all nc_tables"fi

2. Provide the execution permission to the script by using this command:chmod u+x <script.sh>

3. Run the script with this command:./<script.sh>

This script applies indexing on nc_version column of all NC tables.v Set the parameter nccache.aggressive.memory.clean to true for a particular

loader to periodically clean the cache content for the loader and free up memory.This technique uses the memory management from the JVM.Typically, you see the out of memory issue due to insufficient memory isallocated to the JVM. When the local cache is storing too much of unique NCdata that uses more than 90% of allocated memory, leaving small amount ofmemory for runtime processing results in out of memory. Issues occur whenmultithreading is enabled or with under-sized memory configuration. By default,the nccache.aggressive.memory.clean is set to false with this SQL statement:INSERT INTO lc_loader_config_propertiesSELECT DISTINCT datasource_id, loader_name, ’nccache.aggressive.memory.clean’, ’FALSE’FROM lc_loader_config_propertiesWHERE loader_name NOT IN (SELECT DISTINCT loader_nameFROM lc_loader_config_propertiesWHERE name = ’nccache.aggressive.memory.clean’OR loader_name = ’SYSTEM’);

commit;

To update the nccache.aggressive.memory.clean to true for a loader that has outof memory issue, use this statement:update lc_loader_config_properties set value=’true’ where loader_name = ’Loader1’and name=’nccache.aggressive.memory.clean’;commit;

Configuring multiple identical loadersUnder certain circumstances more than one loader of a particular type may need tobe configured and started.

This is especially true when a single loader is unable to cope with the number ofincoming LIF files. Multiple loaders need to be configured in order to handle theincoming data.

See the Installing Tivoli Netcool Performance Manager - Wireless Component forinformation about configuring multiple loaders.


Stability settingsFlapping, otherwise known as oscillating Network Configuration data, occurswhen LIF files are loaded, which have slightly different Network Configurationparentage information for the same node id.

This scenario might occur if two loaders are loading from different data sourcesand, for some reason, there are differences in the Network Configuration datauploaded from the different data sources.

The stability period is the time during which it is permissible for re-parenting ofan access key to take place. The default value of 2 hours, That is, 7200 seconds,and is set in the loader properties in the database. The property name isrehoming.allow.all.

It can be changed using the loader_admin -load <properties_xml> -instance<instance_name> command.

Application directory managementManagement of space in the /appl folder is required to prevent log files filling upthe disk

It is important for the efficient running of the system to monitor and manage thedisk space of the /appl directory.

To check the /appl directory's usage, execute the following command as uservirtuo:df -k /appl

Directory contentsThe appl directory contents.

The appl directory contains the following:v Oracle 12c Software install /appl/oraclev Tivoli Netcool Performance Manager software /appl/oraclev SDS (Security Directory Server) ldap instance directories /applv Archive directory /appl/archive - this is not mandatory but may have been

created during an upgradev Install packages and artifacts - not mandatoryv Tivoli Netcool Performance Manager log files.

Tivoli Netcool Performance Manager log filesThe majority of logs in /appl are generated to the / appl/virtuo/logs directory.

Each part of the application has a log file under the directories:v alarmapi

v as

v conf_read

v database

v external_reporting

v generic


v itm

v lcm

v loader

v part_maint

v sap_cli

v sapmgr

v sapmgr_cli

v sapmon

v sapmon_cli

v sbh_ext_tab_upgrader

v sbh_sk_remover

v storedbusyhour

v summariser

v vmm

v web

Loader log filesLoaders can generate a large amount of logging information especially if the dataloading is generating error messages.

The /appl directory can increase in size quickly due to this. Review theappropriate cron entry to access whether loader log files are archived withadequate frequently.

Loader errors should be resolved quickly to avoid constant generation of large logsfiles.

Loader LIF file directoryWhere to find the default loader LIF directory.

The default loader LIF directory is located under /appl/virtuo/var/loader/spool.If LIF files are not removed from the system with adequate frequency, the /appldirectory can increase in size quickly.

It is recommended the loader LIF directory be moved to a location other than/appl. This can be achieved by creating a soft link.

It is also possible to change the following loader properties: datasource.folder,datasource.good , datasource.bad, log.folder, log.rehome.folder and itm.folder.See Loader Configuration.

Oracle log filesWhere to find the Oracle vtdb instance runtime log files.

By default the Oracle vtdb instance runtime logs are generated to the followingdirectory: /appl/oracle/admin/vtdb

It is recommended to have the Oracle logs generated to a location other than/appl. This can be achieved by creating a soft link.


Crontab entriesCrontab entries are used to manage log files and report generation.

Cron entries must be periodically reviewed to assess whether log files are archivedwith adequate frequently. Altering the frequency of the cron jobs might be neededif very large logs are seen to be produced.

Note: If the system is distributed over multiple servers, the log files will be on theserver where the service in running. For example, the Oracle logs are on thedatabase server and application server logs are on the application server in thelocations specified.

See Crontab setup for default root user and virtuo user crontab entries.


Chapter 6. Datasource, agent and KPI cache administration

Datasource, agent and KPI cache administration.

This section describes the following:v Datasource Administrationv Agent Maintenancev KPI Cache Management

Data source administrationData sources provide the system with the necessary performance data for reports.

About this task

A data source is typically a server that contains entity and performance datainformation.

After a software installation users and data sources need to be created. Users anddata sources are created as part of the installation process.

Note: See the Installing Tivoli Netcool Performance Manager - Wireless Component, formore information on the installation process.

The following command is used to create default users and data sources afterinstallation:sys_init -u <admin_user> -p <admin_pass> -h <host>

Alternatively, use a web browser and complete the following:

Procedure1. Insert the following in a web browser:

http://<hostname>:8080/sysinit

Where <hostname> is the hostname for the machine.2. Log in with the administration userid <admin_user> and the administration

password <admin_pass>.

Results

After completion of the initialization of the default users, users are maintainedusing GUI User Administration tool. See “User management” on page 40.

Datasources are maintained by the ds_admin script. The ds_admin script canperform the following task:v Display existing datasources, See “Listing data sources” on page 88.

The ds_admin script is located in:

$WMCROOT/bin

The ds_admin script can be run from any directory as user virtuo .


UsageUsage for the ds_admin tool.

ds_admin [-asconf conf_name] parametersv List Data Sources: -u user -p password -listv Activate Data Source: -u user -p password -activate dsnamev Deactivate Data Source: -u user -p password -deactivate dsname

Note: The -asconf option is used for multiple instances of the application server. Itis reserved for use or removal of future implementations of the product.

Listing data sourcesInstructions how to list data sources.

About this task

Procedure

Run the ds_admin script using the following syntax:ds_admin -u <user> -p <password> -list

The parameters to be included with the ds_admin script to list datasources aredescribed in “Listing data sources.”Parameters for Listing Datasources

Option Description

-u <user> User name.

-p <password> Password.

Example

The following command is sample list output.[hostname:virtuo] ds_admin -u <user> -p <password> -listName Host Active Enterprise Local JDBCname hostname true true true jdbc:oracle:thin:@tralee:1521:vtdbname hostname true false false jdbc:oracle:thin:@tralee:1521:vtdb

Activating a data sourceInstructions on how to activate a data source.

About this task

The -activate option is used during the installation of the product. This option iscurrently reserved for use only by an application installation administrator.


Deactivating a data sourceInstructions how to deactivate a data source.

About this task

The -deactivate option is reserved for future use or removal of futureimplementations of the product.

Agent maintenanceWhen the system is installed, the scheduler process is configured to run certainstandard administrative jobs or activities on a regular schedule.

The administrative jobs or activities are maintained and monitored by twocommand-line tools:v schedule_admin

v agent_admin

See “Schedule administration” on page 105 for more information on theschedule_admin tool.

The agent_admin tool is used to monitor and manage agent activities executed bythe agent framework. These agent activities usually relate to supporting TivoliNetcool Performance Manager activities such as creating summaries, synchronizingthe LDAP database and cleaning up agent or file activities.

Overview of agent activitiesAgents collect information from data sources and perform maintenance on theproduct.

It is the responsibility of the agents to collect information from the data sources todo the following tasks:v Populate a set of tables (data dictionary) which defines the entities and fields

available from the data source.v Keep the source system database information synchronized with the local web

tables.

After the information is populated, a user can run a report via the web by usingthe information to query the data source via a dynamic SQL query. The queryresults are then available to the user via a web browser.

The types of tasks the agents perform fall into four categories:v Databasev Proceduralv Sweeperv Summaryv NCMANAGER

Note: Some of the agent activities in the table are marked reserved. Theseactivities indicate that the agent activity is reserved for use or removal of futureimplementations of the product. Do not stop these activities from running as itmight result in system consequences. These jobs have minimal impact on yoursystem resources.

Chapter 6. Datasource, agent and KPI cache administration 89

Table 15. Agent Types and Descriptions

Agent Activities Label Description

Procedure Agent Activity Cleanup The procedure agent runsevery hour to remove oldagent activity information.The procedure agent runsfirst on initial use of theadministration software.

Procedure Temporary Report andSchedule Cleanup

The procedure agent runsevery hour to removetemporary reports andschedules. The procedureagent runs first on initial useof the administrationsoftware.

Procedure Data source cleanup. This procedure agent runsdaily and cleans up deleteddata sources (reserved).

Sweeper Unused file deletion. The sweeper agent runsevery 20 minutes to removereport results that are nolonger active from thedatabase and the file system.A consequence of this agentis the removal of reportresults from the Monitor tab.

LDAP Synchronization LDAP Synchronization The LDAP synchronizationagent updates the databasewith information about theconfigured data source,changes to the data sourceproperties might occur ifanother Tivoli NetcoolPerformance Manager serveruses the same data source.The LDAP agent also runsperiodically normally afterevery hour to ensure that theTivoli Netcool PerformanceManager server and SecurityDirectory Serveraresynchronized.

Procedure Update Mapping ofRehomed Instances.

Updates mapping ofrehomed instances(reserved).


Table 15. Agent Types and Descriptions (continued)


Instance Data System Retrieve Entity DataThe instance data agentgathers information from theremote data source that isused to track the networkelements that are availablefor reports. The informationis stored in tables that aremaintained by the instanceschema agent

The instance data agent runsautomatically if the instanceschema agent adds a table orcolumn. The instance dataagent also runs periodicallyusually every two hours toupdate the information aboutthe Tivoli NetcoolPerformance Manager server.(reserved).

Data Dictionary Data Dictionary ImportThe data dictionary agentmaintains the field and entityinformation about the TivoliNetcool PerformanceManager server. Theinformation includes thefollowing:

v Version information for thedata source.

v List of available entities.

v List of available fields.

Data dictionary runs oncewhen a new data source isadded to the system. Thisagent also runs periodicallyusually every 2 hours toensure that the TivoliNetcool PerformanceManager server is up to date.To avoid database errors,only one data dictionaryagent is active at 1 time(reserved).


Table 15. Agent Types and Descriptions (continued)


Summary Summary Computations Tivoli Netcool PerformanceManager is configured toprovide summarycomputations for all trafficcounters that are gatheredfrom a managed networkelement. The role of thisagent is to assess ifsummaries must becompleted and to populatethe database with thecomputed summaries. Thisagent runs every two hoursand assesses whatsummaries are ready forcreation. The SummaryComputation agent ensuresdaily, weekly, and monthlysummary computations areperformed.

Busy Hour Busy Hour Calculation Tivoli Netcool PerformanceManager is configured toprovide busy hourcomputations for trafficcounters that are specified inbusy hour definitions. Therole of this agent is to assessif busy hours must becompleted and to populatethe database with thecomputed busy hours. Thisagent runs every two hoursand assesses what busyhours are ready forcalculation. The Busy HourCalculation agent ensuresdaily, weekly, and monthlybusy hour calculations areperformed.

NCMANAGER Deactivating the networkelements that do not havedata for a specified numberof days.

Updates the active networkelements that do not haveany data for a specificnumber of days as inactivenetwork elements. Thedeactivated networkelements do not participatein summaries, and reportcalculations and hence thereis an improved performance.


Agent activities and log filesEach of the agent activities produces an entry into the as-server.log file thatdetails the activity, run time of the activity and status of the activity.

The log file rolls over by size and then by date so you may notice that there aremultiple log files each day.

The log files are located in:

$WMCROOT/logs/as/default

agent_admin command-line toolThe agent_admin tool is used to monitor and manage agent activities that areexecuted by the agent framework.

These agent activities typically relate to supporting system activities such ascreating summaries, synchronizing the LDAP database and cleaning up agent orfile activities.

The agent_admin script can perform the following tasks:v Display current activities. See “Listing current activities” on page 94.v Listing past activities. See “Listing past activities” on page 95.v Display activity logs. See “Activity logs” on page 97.v Running activities. See “Running activities” on page 98.v Canceling activities. See “Canceling activities” on page 98.

The agent_admin script is in:$WMCROOT/bin

This tool can be run from any directory as user virtuo.

Usageagent_admin [-asconf conf_name] parameters

Current activities-u user -p password -list current

Past activities-u user -p password -list past

Activity log-u user -p password -logs id run_id

Run activity-u user -p password -run id

Disable activity-u user -p password -disable id

Enable activity-u user -p password -enable id

Cancel activity-u user -p password -cancel id

The -asconf option is used for multiple instances of the application server. It isreserved for future implementations of the product.


Listing current activitiesCurrent activities are agent activities that have not been completed, which includesactivities that are running and activities that are waiting to run.

About this task

Complete the following to display the list of current activities running for thesystem.

Procedure

Run the agent_admin script using the following syntax:agent_admin -u <user> -p <password> -list current

The parameters to be included with the agent_admin script to list current activitiesare described in the table.

Table 16. Parameters for Listing Current Activities

Option Description



-list current Lists current activities.

Example

The following command is sample list output of current activities.[hostname:virtuo] agent_admin -u <user> -p <password> -list currentActivity Run Type Data Source State Cancel Active Start End Data Start Data EndAttempt Retry Entity Label

4 39525 SWEEPER <hostname> SCHEDULED N 2013-06-18 07:49:00 null null nullnull 1 N null Unused file deletion

1 6587 PROCEDURE <hostname> SCHEDULED N 2013-06-18 08:06:00 null null nullnull 1 N null Agent activity cleanup

10 2733 BUSYHOUR <hostname-rs> SCHEDULED N 2013-06-18 08:19:00 null null nullnull 1 N null Busy Hour calculation

5 6593 LDAP_SYNC <hostname> SCHEDULED N 2013-06-18 08:20:00 null null2012-09-05 14:22:59 null 1 N null Ldap synchronization

2 6596 PROCEDURE <hostname> SCHEDULED N 2013-06-18 08:43:00 null null nullnull 1 N null Temporary report and schedule cleanup

8 3511 DICTIONARY <hostname-rs> SCHEDULED N 2013-06-18 09:02:00 null null nullnull 1 N null Data dictionary import

9 3318 SUMMARY <hostname-rs> SCHEDULED N 2013-06-18 09:19:00 null null nullnull 1 N null Summary computations

21 378 NCMANAGER <hostname-rs> SCHEDULED N 2013-06-18 09:39:49 null null nullnull 1 N null Network element deactivation

3 280 PROCEDURE <hostname> SCHEDULED N 2013-06-19 02:00:00 null nullnull null 1 N null Datasource cleanup

Current activity propertiesA list of the information available for each current activity.

This information is useful when analyzing a list of current activities.


Table 17. Current Activity Properties

Property Description

Activity The unique ID of the agent activity, type andlabel.

Run The Run ID of the unique agent activity typecurrently running.

Type See See Agent Types and Descriptions for adescription of agent types.

Datasource The datasource affected by the activity.

State Shows whether the activity is running or inthe queue.

Cancel Determines whether the activity wascanceled. If an activity was canceled it isshown on the current list until the activityends on the server.

Active The next time an activity is expected to run.

Start Date and time when the activity started (ifavailable).

End The time a failed activity ended.

Data Start The start time of gathering traffic data froma datasource.

Data End The end time of gathering traffic data from adatasource.

Attempt The number of times a failed activity isretried.

Retry Shows whether the activity has previouslyfailed.

Entity The entity of the data source affected by theactivity.

Label See Agent Types and Descriptions, for agentactivity labels and descriptions.

The Activity property ID uniquely identifies an agent activity based on acombination of the agent label and type.

Listing past activitiesInstructions on how to list past activities.

About this task

A past activity can be one of the following agent activities:v Completedv Failedv Cancelled

The number of days of past activities displayed depends on the setup of dataretention and partitions during installation. It provides all past agent activitiesbased on the install setting of the length of time to retain the Enterprise agentretention setting.


Complete the following to list past activities:

Procedure

Run the agent_admin script by using the following syntax:agent_admin -u <user> -p <password> -list past

The parameters to be included with the agent_admin script to list past activities aredescribed in “Listing past activities” on page 95.

Table 18. Parameters for Listing Past Activities

Option Description



-list past Lists past activites.

Example

The following command is sample list output of past activities.[hostname:virtuo] agent_admin -u <user> -p <password> -list pastActivity Type Data source state Cancel Active Start End Entity Label Message5 271 LDAP_SYNC tralee COMPLETED 2006-11-14 18:15:092006-11-14 18:15:10 null Ldap synchronization null12 136 INSTANCE tralee-rs FAILED 2006-11-14 17:42:092006-11-14 17:42:11 System Retrieve entity data Entity System not found.1 271 PROCEDURE tralee COMPLETED 2006-11-14 17:33:092006-11-14 17:33:09 null Agent activity cleanup null2 271 PROCEDURE tralee COMPLETED 2006-11-14 17:30:092006-11-14 17:30:10 null Temporary report and schedule cleanup null5 270 LDAP_SYNC tralee COMPLETED 2006-11-14 17:15:292006-11-14 17:15:30 null Ldap synchronization null1 270 PROCEDURE tralee COMPLETED 2006-11-14 16:33:092006-11-14 16:33:10 null Agent activity cleanup null14 133 SUMMARY tralee-rs COMPLETED 2006-11-14 16:31:092006-11-14 16:31:09 null Summary computations null2 270 PROCEDURE tralee COMPLETED 2006-11-14 16:30:092006-11-14 16:30:10 null Temporary report and schedule cleanup null13 136 DICTIONARY tralee-rs FAILED 2006-11-14 16:26:192006-11-14 16:26:20 null Data dictionary import No entity data exists for datasource tralee-rs.5 269 LDAP_SYNC tralee COMPLETED 2006-11-14 16:15:192006-11-14 16:15:20 null Ldap synchronization null12 135 INSTANCE tralee-rs FAILED 2006-11-14 15:42:292006-11-14 15:42:31 System Retrieve entity data Entity System not found.1 269 PROCEDURE tralee COMPLETED 2006-11-14 15:33:192006-11-14 15:33:20 null Agent activity cleanup null2 269 PROCEDURE tralee COMPLETED 2006-11-14 15:30:192006-11-14 15:30:20 null Temporary report and schedule cleanup null5 268 LDAP_SYNC tralee COMPLETED 2006-11-14 15:15:092006-11-14 15:15:10 null Ldap synchronization null1 268 PROCEDURE tralee COMPLETED 2006-11-14 14:33:292006-11-14 14:33:29 null Agent activity cleanup null14 132 SUMMARY tralee-rs COMPLETED 2006-11-14 14:31:292006-11-14 14:31:29 null Summary computations null

Past activity propertiesA description of the information available for each past activity.

This information is useful when analyzing a list of past activities.


Table 19. Past Activity Properties

Property Description

Activity The unique ID of the agent activity, type andlabel.

Type See See Agent Types and Descriptions for adescription of agent types.

Datasource The datasource affected by the activity.

State Shows whether the activity completed orfailed.

Cancel Determines whether the activity wascanceled.

Active The next time an activity is expected to run.

Start Date and time when the activity started (ifavailable).

End The time the activity ended.

Entity The network entity of interest for thespecific activity.

Label See See Agent Types and Descriptions, foragent activity labels and descriptions.

Message Displays server messages related to theactivity. Messages are typically received forfailed activities.

Activity logsThe agent activity log contains a complete view of all the agent activities, whichincludes current and past agent activities.

About this task

The agent_admin script allows you to view an activity for a specific run of an agenttype.

Procedure

Run the agent_admin script by using the following syntax:agent_admin -u <user> -p <password> -logs <id> <run_id>

The parameters to be included with the agent_admin script to display activity logsare described in See Parameters for Listing Activity Logs.

Table 20. Parameters for Listing Activity Logs

Option Description



-logs <id> <run_id> Lists activity logs, for the agent activity typeid and the agent activity run_id.

Note: You can use the -list current option to determine the agent activity type.


Running activitiesInstructions on how to run activities.

Procedure

Run the agent_admin script by using the following syntax:agent_admin -u <user> -p <password> -run <id>

The parameters to be included with the agent_admin script to run an activity aredescribed in See Parameters for Running Activities.

Table 21. Parameters for Running Activities

Option Description



-run <id> Runs the activity, the id is the identity ofagent activity type to run.


Canceling activitiesYou should stop a current activity if the activity continues to fail and is notexpected to succeed.

About this task

Canceling an activity can only cancel the current activity. It does not stop the agentfrom performing future scheduled activities.

Caution: Stopping an agent activity may stop an important aspect of the dataacquisition process or server maintenance.

Procedure

Run the agent_admin script by using the following syntax:agent_admin -u <user> -p <password> -cancel <id>

The parameters to be included with the agent_admin script to cancel an activity aredescribed in See Parameters for Cancelling an Activity.

Table 22. Parameters for Canceling an Activity

Option Description

-u <user> The administration user name.

-p <password> The administration password.

-cancel <id> Cancels the activity, the id is the identity ofactivity to cancel.


Updating the active network elements as inactive networkelementsOptimization of network resources as maintenance to improve data processing.


By default, all network elements have ENDSTAMP as 19-JAN-2038 or 19-Jan-203823:59:00 in NC_<ENTITY> table. After you run the NC_Manager tool, all the networkelements, which do not receive data in past "X" days will be deactivated in theNC_<ENTITY> table. The ENDSTAMP is changed from 19-JAN-2038 or 19-Jan-203823:59:00 to current timestamp.

If you want to alter the timestamp format, you must run the following SQLstatement on the server.ALTER session SET nls_date_format = ’DD-Mon-YYYY HH24:MI:SS’;

To improve the data processing, those network elements that do not have data inpast “X” days must be deactivated. Thereafter, these inactive network elements areexcluded in summary and report calculations.

Note: "X" indicates the number days as specified in lookbackdays, which is definedin $WMCROOT/conf/nc_manager/default.properties.

Types of network elements:

Active network elements

By default, the TIMESTAMP and ENDSTAMP of a network element are setas 29-Oct-1932 or 29-Oct-1932 00:01:00 and 19-JAN-2038 or 19-Jan-203823:59:00.

When a network element is rehomed, the existing record of the networkelement is split into two where one has an ENDSTAMP of 1 second lesserthan the rehomed time and the most recent network element still holds theENDSTAMP of 19-Jan-2038 or 19-Jan-2038 23:59:00.

Inactive network elements

Network elements that have an ENDSTAMP lesser than 19-JAN-2038 or19-Jan-2038 23:59:00. These network elements are deactivated byNC_Manager tool, which means there is no data in past "X" days. Thesenetwork elements are considered as inactive elements.

These network elements do not participate in summaries, and reports fortime intervals later than their ENDSTAMP.

NC_Manager is the tool that detects and deactivates the NC elements that do nothave traffic data for "X" number of days. NC_Manager is run via the agent_admincommand.

When you run the NC_Manager tool, all the messages are logged in toas-ncmanager.log file that is in $WMCROOT/logs/as/default folder.

You can use one of the two methods to update the state of a network element fromactive to inactive:v Run by using the scheduler:Run the agent_admin task through scheduler.

Scheduler takes the input parameters from default.properties file. The defaultschedule time is once a week.

v Run manually:Run the agent_admin task from command line. The NC_Manageridentifies the network elements from NC tables of entities that are specified inthe property file and that do not receive any data in the last "X" days.The agent_admin command takes the input parameters from thedefault.properties file. The inputs are entities and lookbackdays.


Update the active cells as inactive cellsThis is done by calling the NC_Manager tool to run by using the followingcommand:agent_admin –u user –p password –run 21

Where, 21 is the id for NC_Manager tool.Use the following command to look for the NC Manager running:agent_admin –u user –p password -list current | grep NCMANAGER

For more information about the input parameters, see “default.properties file.”

default.properties file:

The default.properties file is available in the following location:$WMCROOT/conf/nc_manager/default.properties.

The contents of the file are as follows:vallent.ds.path=dbconnectionvallent.ds.file=vtdb

mastercache.impl=com.ibm.tivoli.tnpmw.loader.cache.nc.master.rmi.NCCacheRemoteImplmastercache.name=NC_MASTER_CACHEmastercache.port=9876

request.size=100com.ibm.tivoli.tnpmw.ncmanager.entities=Cell,Neighbourcom.ibm.tivoli.tnpmw.ncmanager.lookbackdays=30

Description of the parameters in the default.properties file:


vallent.ds.path Data sourse config file path. You mustnot change this parameter value.

vallent.ds.file Data sourse config file name. You mustnot change this parameter values.

mastercache.impl Master Cache impl class name. Youmust not change this parameter value.

mastercache.name Master Cache Name. You must notchange this parameter value.

mastercache.port Master Cache Port. You must notchange this parameter value.

request.size=100 Stores the batch size in which NCrecords are deactivated in bulk.

com.ibm.tivoli.tnpmw.ncmanager.entities Entities for which NC records are to bedeactivated. Default values are Cell,Neighbour, Eutrancell, andEutranrelation.Note: Currently, the entities Cell,Neighbour, Eutrancell, andEutranrelation are also supported.



com.ibm.tivoli.tnpmw.ncmanager.lookbackdays Number of days in past from thecurrent day for which data availabilityis checked. The default value is 30. Youcan change this value to provide adifferent value for the NC_Manager.

Running the NC_Manager:

After you run the NC_Manager, the network elements that do not have any data for"X" number of days are deactivated and do not participate in summaries, andreports. Lesser number of network elements participate in summaries, and reportcalculations and hence there is an improved performance.

Procedure

When the NC_Manager tool is called via the agent_admin command, it performs thefollowing tasks:For more information, see Update the active cells as inactive cells.1. Reads the input parameters from default.properties file.2. Validates the input parameter before execution. If validation fails, it sends back

the status as FAILED and go back to SCHEDULED state.3. Identifies the NC tables and corresponding traffic tables.4. Scans and filters the network elements that are based on data availability in

traffic table.5. Updates ENDSTAMP of network elements from 19-JAN-2038 or 19-Jan-2038

23:59:00 to current timestamp. All network elements that are deactivated arestored in the WM_NCMANAGER_HISTORY table.

What to do next

Reactivating the network elements:

If a new LIF is loaded that has a TIMESTAMP later than the ENDSTAMP in theNC_<ENTITY> table, the network element is reactivated automatically. A newentry is added into the NC_<ENTITY> table. The TIMESTAMP is set to the timethat is available in the loaded LIF file and ENDSTAMP is 19-JAN-2038 or19-Jan-2038 23:59:00.

KPI cache managementThe kpicache_admin tool can be used to export and import UDCs from/into thesystem in a format compatible with previous releases.

In particular, it applies to UDCs that are not attached to a report or template, as isthe case in previous releases. When used to export UDCs, it exports all UDCs inthe system. The kpicache_admin tool is also for internal synchronization processesand for debugging.

Note:

Do not run more than one of the following tools, or more that one instance of anyof these individual tools, at the same time:


v techpack_admin

v sbh_admin

v summary_admin

v kpicache_admin

v report_impexp

For example, do not run summary_admin and sbh_admin, or two instances ofsummary_admin at the same time).

Exporting user-defined calculationsInstructions on how to export user-defined calculations.

About this task

To export UDCs:

Procedure

Run the kpicache_admin script by using the following syntax:kpicache_admin -u <user> -p <password> -d <filename> <dsname>

The parameters to be included with kpicache_admin script for dumping the UDCare described in See Parameters for Dumping the UDC.

Table 23. Parameters for Dumping the UDC

Option Description

-u <user> User name

-p <password> Password

-d <filename> <dsname> Dumps the file <filename> for the datasource <dsname> . The path to where the fileis exported must be specified or the scriptmust be executed where the file is located.The name of the server must be used whenspecifying the <dsname>, and not the IPaddress.

Examplekpicache_admin -u sysadm -p <password> -d /tmp/UDC_export.xml crosshavenz2-rs

This will result in all provisioned UDCs being exported to a file.

Importing user-defined calculationsInstructions on how to import user-defined calculations.

About this task

Procedure

Run the kpicache_admin script by using the following syntax:kpicache_admin -u <user> -p <password> -l <filename> <dsname>


The parameters to be included with kpicache_admin script for loading the UDCdump are described in See Parameters for Loading the UDC.

Table 24. Parameters for Loading the UDC

Option Description



-l <filename> <dsname> Loads the file <filename> for the data source<dsname>. The path to where the file islocated must be specified or the script mustbe executed where the file is located. Thename of the server must be used whenspecifying the <dsname>, and not the IPaddress.

Examplekpicache_admin -u sysadm -p <password> -l /tmp/UDC_import.xml crosshavenz2-rs

Synchronize internal computation engine KPI cacheAfter importing UDCs, the user must re-build the internal computation engine KPIcache with the kpicache_admin synchronization option.

About this task

Complete the following procedure to synchronize the cache:

Procedure

Run the kpicache_admin script by using the following syntax:kpicache_admin -u <user> -p <password> <dsname>

The parameters to be included with the kpicache_admin script for synchronizingthe KPI cache are described in See Parameters for Synchronizing KPI Cache.

Table 25. Parameters for Synchronizing KPI Cache

Option Description

-u <user> User name

-p <password> Password

<dsname> Name of the data source to be synchronized.

Results

Re-synchronisation of the KPI cache for a data source option is for internal use toensure the data source synchronisation process occurs correctly and allows fordebugging. It does not perform any cache function, it only synchronizes currentdata source tables. To update tables so the UDCs are visible to the user from theGUI, the dictionary synchronisation process must be executed by schedule ormanually by using agent_admin script.

Examplekpicache_admin -u sysadm -p <password> crosshavenz2-rs


The UDCs are not be visible to the user from the UI until the GUI cache has alsobeen re-built using the DICTIONARY service. This can be done manually using theagent_admin CLI tool.agent_admin -u sysadm -p <password> -list current | grep DICTIONARYagent_admin -u sysadm -p <password> -run 8

In this example “8” is the job id of the DICTIONARY service. The DICTIONARYservice is also scheduled to run every two hours.

Changing the aggregator of raw counters for decode functionFor decode function, aggregation must be done on UDC level rather than the KPIlevel. Currently, aggregation is done at the KPI level first, and then aggregator ofUDC is applied. For example, UDC is created with decode function by using KPI oftwo different entities. Aggregator for KPI is SUM and aggregator for UDC is AVGthen aggregator of UDC that is AVG is applied first followed by decode function.

About this task

Insert the OverrideProtectDecode column in wm_system_values_v table to enablethe aggregation at UDC level.

Procedure1. Insert the column into the database to enable the feature:

insert into wm_system_values_v (name,value) values (’OverrideProtectDecode’, ’false’);commit;

2. Update the existing OverrideProtectDecode function into the database:update wm_system_values_v SET value= 'true' where name = 'OverrideProtectDecode';Commit;

Reenqueueing messages from exception queue to active queueWhen the number of reports that are running on a system are high, the job failuremight occur. This issue happens due to inadequate resources to run the reports.

About this task

When you see the error message, Active queue job failure: <Active> in thestatus message of jobs page or tasks page under Monitor tab, increase the value ofretry_attemtps in wm_system_values_v table. Wireless system queues the jobsfrom exception queue to active queue and retries based on the number specified inretry_attemtps.

Procedure

Use the following SQL statement:insert into wm_system_values_v values (’retry_attemtps’,<number of attempts>);

For example:insert into wm_system_values_v values (’retry_attemtps’,6);

Note: The default value for this parameter is 5.Check the number of times a job is retried in the message_job_tracker table. AnOracle job is created to clean all entries older than three days from this table.


Chapter 7. System maintenance

Maintenance of the system includes using scripts, processes, and programs thatenable the Tivoli Netcool Performance Manager server to run at optimalperformance levels. System maintenance tasks include the following tasks:

Schedule administrationThe scheduler process is configured to run certain standard administrative jobs onscheduled dates and times.

You can change the date and time a job is run. The administrative jobs andactivities are maintained and monitored by two command line tools:v schedule_admin

v agent_admin

See See agent_admin Command Line Tool for more information on theagent_admin tool.

To ensure reliable handling of data access and storage, the system uses severalmaintenance jobs and agent activities. The jobs invoked by the system perform thefollowing functions:v Maintain database partition, creation and cleanup.v Perform job task cleanup.v Synchronize information between various subsystems and tables.v Perform summary computations.

The schedule_admin tool is used to monitor and manage the jobs relating to coreactivities such as partitioning the database and miscellaneous task or job cleanupchores.

Scheduled jobsA description of the current scheduled jobs controlled by the schedule_admin tool.

Note: Important: These schedule jobs: aggregator, file_missing,scenario_activation, bhupdate, smupdate, bh_clean, bh_summary currently have nofunctional impact on the system. Do not stop these jobs from running as it mayresult in system consequences. These jobs have minimal impact on your systemresources.

See “Scheduled jobs” below provides a description of the current scheduled jobscontrolled by the schedule_admin tool. These jobs are currently in use.

Table 26. Scheduled Job Descriptions.

Job Category Description

misc_clean Cleanup Task-status, active-task,active-job, schedule,pm-schedule logs are purgedevery two hours.


Table 26. Scheduled Job Descriptions. (continued)


pm_daily Partition Maintenance v Purges loaded traffic dataand partitions that areolder than a specifiednumber of days. Thenumber of days specifiedis set by the administratorduring installation.

v Compresses data on thedisk. Compressing a diskreorganizes daily data andreclaims as much as 40%of the disk. It alsoimproves query time by25% to 70%.

v Creates new daily futurepartitions to store data.

pm_weekly Partition Maintenance v Purges summary data andbusy hour partitions thatare older than the datespecified duringinstallation, for summaryand busy hourdeterminations.


v Creates new weeklypartitions to store data.

The default scheduled timefor the pm_weekly job to runis 20:00:00.


Table 26. Scheduled Job Descriptions. (continued)


pm_monthly Partition Maintenance v Purges summary and busyhour data and partitionsthat are older than thedate specified duringinstallation, for summaryand busy hourdeterminations. Createsnew monthly partitions tostore data related todate-time scope andholiday definitions.


The default scheduled timefor the pm_monthly job torun is 20:01:00.

event_clean Cleanup Removes handled-eventsfrom the database that areolder than a the 30-dayretention period on a dailybasis. Default scheduled timeis 22:00:00.

rgfp Cleanup Report group file purge andlog files cleanup occurs threetimes per hour.

The schedule_admin script is used to schedule all administrative tasks. It is locatedin:

$WMCROOT/bin

The schedule_admin script can be run from any directory as user virtuo.

Usageschedule_admin [-dbconf conf_name] parameters

- List job types: -list types- List all jobs: -list all- List set job type cleanup times: -list cleanup- List jobs to be executed: -list next- Change job type limit: -limit job_type max- Enable job type: -enable job_type- Disable job type: -disable job_type- Set job type cleanup period: -setcleanup job_type period

- period expressed in minutes- Schedule a job: -schedule job_name date time

- date format: yyyymmdd- time format: hhmm

- Schedule a job immediately: -schedule job_name immediate- Turn off a job: -schedule job_name off- Turn on a job: -schedule job_name on

Chapter 7. System maintenance 107

Note: The -dbconf option is reserved for future use or removal in futureimplementations of the product.

The list of administrative options for the schedule_admin script are described in“Administrative options for the schedule_admin script” on page 109.

Scheduling system maintenanceInstructions on how to schedule system maintenance.

Procedure

Schedule administration tasks by executing the following command by using thesyntax:schedule_admin -schedule <job_name> <administrative option>

Example

The command below schedules the job pm_daily to run at 11:30 on the 27/08/2007.

schedule_admin -schedule pm_daily 20070827 1130

Listing the status of all scheduled jobsInstructions on how to list the status of all scheduled jobs.

Procedure

The following command lists the status of all scheduled jobs in the system:schedule_admin -list all

Example output:JOB FAILURE|==============================================================================|| Job | Last Run | Failed | Duration || | Time | Time | HH:MM:SS ||=======================|=====================|=====================|==========|

JOB SUCCESS|==============================================================================|| Job | Last Run | Completed | Duration || | Time | Time | HH:MM:SS ||=======================|=====================|=====================|==========|| misc_clean | 2006/09/01 16:00:13 | 2006/09/01 16:00:15 | 00:00:02 || bh_clean | 2006/09/01 17:00:12 | 2006/09/01 17:00:13 | 00:00:01 || pm_daily | 2006/09/01 10:13:46 | 2006/09/01 10:14:28 | 00:00:42 || pm_weekly | 2006/09/01 10:13:16 | 2006/09/01 10:13:22 | 00:00:06 || pm_monthly | 2006/08/25 20:02:39 | 2006/08/25 20:05:25 | 00:02:46 || event_clean | 2006/09/01 10:15:59 | 2006/09/01 10:16:00 | 00:00:01 ||==============================================================================|

JOBS RUNNING|========================================================|| Job | Last Run | Duration || | Time | HH:MM:SS ||=======================|=====================|==========|| bh_summary | 2006/09/01 17:00:40 | 48:44:00 ||========================================================|

NEXT RUN JOBS|=============================================|


| Job | Next Run || | Time ||=======================|=====================|| pm_weekly | job not scheduled || rgfp | job not scheduled || bh_clean | job not scheduled || pm_monthly | job not scheduled || pm_daily | job not scheduled || scenario_activation | job not scheduled || misc_clean | job not scheduled || event_clean | job not scheduled ||=============================================|

Administrative options for the schedule_admin scriptA description of the administrative options for the schedule_admin script.

Table 27. schedule_admin script

Option Description

-list types Lists the available job types.

-list allLists the status of all the scheduled jobs onthe Tivoli Netcool Performance Managerplatform. Job names are:

v misc_clean

v pm_monthly

v pm_weekly

v pm_daily

v event_clean

v rgfp

v analyze_user_data

-list cleanup Lists set job type cleanup times.

-list next Lists jobs to be executed.

-limit <job_type> [max] Changes the job type limit.

-enable <job_type> Enables a particular job type.

-disable <job_type> Disables a particular job type.

-setcleanup <job_type> <period> Set a cleanup period for a set job type. Theperiod must be entered in minutes.

-schedule <job_name> <date> <time> Schedule a particular job. Date must beentered in YYYYMMDD format and timemust be entered in the HHMM.

-schedule <job_name> immediate Schedule a particular job to run at thecurrent time.

-schedule <job_name> off Turn off a job.

-schedule <job_name> on Turn on a job.


Reporting on server statusSome health checks can be performed on the system to verify it is stable.

If the Tivoli Netcool Performance Manager server is rebooted the following processchecks can be performed to check all processes started successfully:

Database checkIn a distributed system the database check must be performed on the server that ishosting the database component.

Procedure

As user root, enter the following:

vsvcs database-na

vservice dboravirtuo status

v/etc/rc.d/init.d/dboravirtuo status

Directory server checkIn a distributed system the Directory server check should only be performed onthe server hosting the directory server.

Procedure

As user root enter the following:

vsvcs sds-na

vservice sdsna status

v/etc/rc.d/init.d/sdsna status

SAPMON checkIn a distributed system the SAPMON check must only be performed on the servershosting the Application and Gateway components.

Procedure

As user root enter the following:

vsvcs sapmon-na

vservice sapmonvirtuo status

v


/etc/rc.d/init.d/sapmonvirtuo status

One process must be returned.

Tivoli Netcool Performance Manager checkIn a distributed system the Tivoli Netcool Performance Manager check must onlybe performed on the server hosting the Application component.

About this task

The application framework processes are started automatically when the server isrebooted.

Procedure1. As user virtuo enter the following command to check the Tivoli Netcool

Performance Manager processes:sap disp -l

A sample of the output is shown below.[hostname:virtuo] sap disp -lNAME STATE SINCE HOST GROUP STIME PIDas STARTED Oct 23, 2008 <core_host> asgroup Oct 23, 2008 17277nc_cache STARTED Oct 29, 2008 <core_host> loadercache Oct 29, 2008 6716alarm_cache STARTED Oct 29, 2008 <core_host> loadercache Oct 29, 2008 6726...........

2. Ensure there are no exceptions in the processes log files.The location of the processes log files is set by the WMCLOGDIR variable in the$WMCROOT/conf/environment/default.properties file. These log files are usuallylocated in $WMCROOT/logs.

Log files checkThe majority of the Tivoli Netcool Performance Manager server log files are storedin $WMCROOT/logs.

Procedure

The main log files to check after restarting any of the processes are:v $WMCROOT/logs/as/default/*

v $WMCROOT/logs/loader/*

Database monitoringA description of quick status checks that can be completed.

About this task

The following checks should be completed by an Oracle database administrator.

Procedure1. Alert Log Monitoring - check the $ORACLE_BASE/admin/vtdb/bdump/

alert_vtdb.log file for Oracle errors or warnings.2. Oracle processes trace files - check the $ORACLE_BASE/admin/vtdb/bdump/*.trc

files.3. Oracle listener status - check the $ORACLE_HOME/network/log/listener.log file.


4. System Global Area (SGA) Memory Monitoring. Run the following commandto provide free memory information for the main pools in the Oracle SGA:export ORACLE_SID=vtdb; echo "select * from v\$sgastat;"|sqlplus virtuo/<password>| grep "free memory"

For information on tablespaces, see “Database space administration” on page118.

Operating system checksA list of checks for your operating system.

About this task

Complete the following operating system checks from your operating system:

Procedurev System resource utilizationv Virtual memory statusv Available memory statusv Processor sanity check

Managing the Oracle databaseDescribes in detail the available database management functions.

Starting and stopping the Oracle databaseStarting and stopping the Oracle database.

By default when the Tivoli Netcool Performance Manager server is started or shutdown, the system is automatically configured to start and shutdown the Oracledatabase.

Disabling automatic start up and shutdown of the OracledatabaseInstructions on how to disable the automatic settings and allow manual start upand shutdown of the Oracle database.

To disable the automatic settings and allow manual start up and shutdown of theOracle database complete the following:1. Log in to the database as OS user, oracle .2. Open the oratab file located in:

v /var/opt/oracle

v /etc/

v /etc/

Database entries in the oratab file appear in the following format:$ORACLE_SID:$ORACLE_HOME:<N|Y>

Y signifies that you want the system configured so that the database isautomatically started upon system boot up and automatically shutdown whenthe system is shutdown.N signifies that you want to manually start up and shutdown the database.


3. Find the entries for all the databases that you want to change. They areidentified by the sid in the first field. Change the last field for each entry to N .Example:vtdb:/appl/oracle/product/12.1.0.2.0/db_1:N

where /appl/oracle/product/12.1.0.2.0/ is the $ORACLE_HOME variable.Usually you should only have one entry for the SID vtdb .

Manually shutting down the Oracle databaseInstructions on how to manually shut down the Oracle database.1. As user virtuo, display the processes currently running:

sap disp

2. Stop all SAP processes, as user root :

vsvcadm disable sap-na

vservice sapvirtuo stop

v/etc/rc.d/init.d/sapvirtuo stop

3. Monitor the process status and wait for all processes to stop, as user virtuo :sap disp

4. Switch to OS user oracle :su - oracle

5. Start SQL*Plus, and connect to the database as the DBA administrator:$ export ORACLE_SID=vtdb$ sqlplus /nologSQL> connect / as sysdba

6. Shut down the database and exit:SQL> shutdown immediateSQL> exit

Manually starting the Oracle databaseInstructions on how to manually start the Oracle database.1. Switch to the OS user oracle :

su - oracle

2. Start SQL*Plus, and connect to the database as the DBA administrator:$ export ORACLE_SID=vtdb$ sqlplus /nologSQL> connect / as sysdba

3. Start the database:SQL> startupSQL> exit

4. Start all SAP processes, as user root :

vsvcadm enable sap-na

vservice sapvirtuo start

v



v Monitor the process status and wait for all processes to start, as user virtuo:sap disp

Types of Oracle backupsDatabase backup is an important process that needs to be setup and carried out onthe Tivoli Netcool Performance Manager platform on a regular basis.

Data is constantly being read from and written to the Oracle database. Care mustbe taken to archive the data correctly.

Note: Backup the Oracle database regularly. Backups of the database should betaken more often than backups of the Tivoli Netcool Performance Manager system.

Oracle software offers two methods for backing up the database:v offlinev online

Use of Oracle Recovery Manager (RMAN) is the preferred method for both onlineand offline types of database backup. For manual user or cron driven backups,only offline backups are recommended for a Tivoli Netcool Performance Managerdatabase. Online user driven backup is not recommended.

For an offline backup, you must shut down the database before archiving data.Before you can determine which method is appropriate for your installation, youneed to consider several factors:v Size of available auxiliary storage.v Cost of auxiliary storage required by the backup scheme.v Level of server availability to users during backup.v Ease of data restoration.

For any of these backup modes, the auxiliary storage should be large enough tohold the backup image without operator intervention.

Online backups using RMAN is the preferred backup method, with the databaserunning in archive log mode. Online backup has the following advantages:v The database remains available to users and data loading continues at all times.v You do not need to back up the entire database at the same time.v Allows the quickest and most flexible recovery.

For complete information on performing online and offline backups, see yourOracle documentation:v Database Backup and Recovery User's Guide


https://docs.oracle.com/database/121/BRADV/toc.htm

Redo logsOracle software creates log files called redo logs , each of which contain asequential log of actions applied to the database.

These redo logs accumulate daily and contain up-to-the-minute details on databaseoperations. By default, the Tivoli Netcool Performance Manager server installs theOracle database in archive log mode. Although archive log mode requires moredisk space for daily operations, it provides point-in-time recovery in case of dataloss. You can restore data from the last online backup, then restore data from allarchive logs since that date to return your database to its most current state.

Note: Archive logs can take up large quantities of disk space if you do notregularly back them up. If you set up a backup schedule with only one or two fullbackups per week, you must check the archive logs if you are not backing them upregularly.

Archiving redo logsThe set of administration tasks and information required to archive redo logs.

ARCHIVELOG modeEach database should have ARCHIVELOG mode enabled. This allows the redo logs tobe archived instead of being overwritten.

Store the archive logs in a separate place to the rest of the database files andensure that they are periodically backed up. The archive logs can be used if andwhen a restore of the database is required to restore the database to the point intime when the database went down.

This section describes how to check if the database is in ARCHIVELOG mode and howto enable and disable ARCHIVELOG mode.

Checking ARCHIVELOG mode statusInstructions on how to check ARCHIVELOG mode status.

About this task

To check ARCHIVELOG mode status, complete the following steps:

Procedure1. Log in as OS user oracle and enter the following commands:

$ export ORACLE_SID=<MYDB>

where <MYDB> is the name of the database$ sqlplus /nologSQL> connect / as sysdba

2. To check the ARCHIVELOG mode status, enter the following SQL command:SQL> archive log list;

If the database is in ARCHIVELOG mode the following output is returned:Database log mode Archive ModeAutomatic archival Enabled

If the database is not in ARCHIVELOG mode the following is returned:Database log mode No Archive ModeAutomatic archival Disabled


Updating ARCHIVELOG settingsUpdate the log destination where the archive log files are stored from the defaultto a location which has sufficient space to store the archive logs.

About this task

The recommended location is /oradump/<MYDB>. Ensure the log destination existsprior to setting it. Create the directory as OS user oracle if it does not alreadyexist.

Update the target archive location by completing the following:




2. To change the archive log destination, enter the following SQL command:SQL> alter system set log_archive_dest=’/oradump/<MYDB>’ scope=both;

Enabling ARCHIVELOG modeInstructions on how to enable ARCHIVELOG mode status.

About this task

To enable ARCHIVELOG mode status, complete the following steps:

Procedure1. Log in as user oracle and enter the following commands:



2. To enable ARCHIVELOG mode status, enter the following SQL commands:SQL> ShutdownSQL> Startup mountSQL> Alter database archivelog;SQL> alter database open;

3. To check the ARCHIVELOG mode status, enter the following SQL command:SQL> archive log list;Database log mode Archive ModeAutomatic archival EnabledArchive destination /oradump/<MYDB>Oldest online log sequence 7Next log sequence to archive 7Current log sequence 9

Results

The database is now in ARCHIVELOG mode.

Disabling ARCHIVELOG modeInstructions on how to disable ARCHIVELOG mode status.


About this task

To disable ARCHIVELOG mode status, complete the following:

Procedure1. Log in as OS user, oracle and enter the following commands:



2. To enable ARCHIVELOG mode status, enter the following SQL commands:SQL> ShutdownSQL> Startup mountSQL> Alter database noarchivelog;SQL> alter database open;

3. To check the ARCHIVELOG mode status, enter the following SQL command:SQL> archive log list;Database log mode No Archive ModeAutomatic archival DisabledArchive destination /oradump/<MYDB>Oldest online log sequence 7Current log sequence 9

Results

The database is now in NOARCHIVELOG mode.

Performing hardware diagnosticsDiagnostic checks on your hardware before restoring data are recommended, if youencounter a problem such as a corrupt database.

Other database errors can surface when you restore a missing or corrupt file.

For Example:

When mounting a database, Oracle software stops when it encounters the firsterror, even though more than one error might exist. If you perform hardwarediagnostics before restoring the missing file, you might find other corruptdatabases as well.

Restoring data from backupsHow you restore data depends on the procedures you used to back it up, andwhat you must restore.

For complete information on data restoration procedures, please see your Oracledocumentation.


Database space administrationThe dbspace_admin tool allows you to monitor database space usage, addtablespaces, drop tablespaces, add datafiles and modify datafiles.

Note: Only experienced Oracle database administrators must perform tablespaceoperations.

The tool is located in: $WMCROOT/bin/dbspace_admin

The dbspace_admin script can be run from any directory as user virtuo .

UsageUsage: [-stats] [-addfile] [-addtbs] [-droptbs] [-modifyfile]

Database space stats: -stats- Display the tablespace and datafile usage statisticsAdd a data file: -addfile -tbsname <tablespace_name> -dirpath <dir_path>-extsize <size_in_kb> -totalsize <size_in_mb>- Add a datafile to an existing tablespace.- Recommended values: -totalsize=20000M (20GB) or multiples of it. This isthe max autoextend size of each datafile.- Recommended values: -extsize=1024K for data tablespaces, -extsize=256Kfor index tablespacesAdd a tablespace: -addtbs -tbsname <tablespace_name> -dirpath <dir_path>-extsize <size_in_kb> -totalsize <size_in_mb>- Add a tablespace.- Recommended values: -totalsize default value should be 20000MB (20GB).This is the maxsize it will autoextend to.- Recommended values: -extsize=1024K for data tablespaces, -extsize=256Kfor index tablespacesDrop a tablespace: -droptbs -tbsname <tablespace_name>- Drop an existing tablespace.- This should only be used if the tablespace can be safely dropped withoutaffecting the systemModify a data file: -modifyfile -filepath <file_path> -totalsize <size_in_mb>- Modify the total/max size of an existing datafile

Monitor Oracle tablespacesOracle tablespaces must be monitored regularly to ensure sufficient space isavailable for new data to load.

Procedure

Run the following command:dbspace_admin -stats

The -stats option is described in “Monitor Oracle tablespaces.”


Table 28. Parameters for Monitoring Tablespaces

Option Description

-stats Lists the space usage statistics by data fileand by tablespace. Includes the amount ofspace used, space free and percentage spacefree. Also includes a flag to show when atablespace has less than 10% free space.

Datafile statistics:

v Tablespace Name

v Tablespace file ID

v Free (%)

v Actual (Mb)

v Free (Mb)

v Used (Mb)

v Max (Mb)

v File name

Tablespace statistics:

v Tablespace Name

v Over

v Free (%)

v Actual (Mb)

v Used (Mb)

v Free (Mb)

v Max (Mb)

Add Oracle tablespacesOracle database tablespaces can be added to the database. You must ensure thatthere is sufficient space in the target location for the amount of space you areallocating before attempting to add a tablespace.

About this task

Database system privileges are needed to add tablespaces. You are prompted forthe system user password when executing the -addtbs option.

To add a tablespace:

Procedure

Run the following command:dbspace_admin -addtbs -tbsname <tablespace_name> -dirpath <dir_path>

-extsize <size_in_kb> -totalsize <size_in_mb>

The parameters used with the -addfile option are described in “Add Oracletablespaces.”

Table 29. Parameters for Adding a Tablespace

Option Description

-tbsname The name of the tablespace to be created.


Table 29. Parameters for Adding a Tablespace (continued)

Option Description

-dirpath The path to the directory where thedatabases file(s) will be created. If a totalsize of over 20 GB is specified, multipledatafiles are added, each with a max size of20 GB.

-extsize The extent size for the new tablespace. Thismust be based on the projected growth rateof the tablespace.

-totalsizeThe total size in megabytes for the newtablespace. If a total size of over 20 GB isspecified, multiple data files are added, eachwith a max size of 20 GB. The total sizespecified is the maxisize each data file canauto extend to. The recommended defaultvalue is:

v -totalsize=20000 MB (20 GB)

Exampledbspace_admin -addtbs -tbsname VT_TEST_DATA -dirpath /oradata02/vtdb

-extsize 1024 -totalsize 80000

This example shows the addition of an 80 GB tablespace, VT_TEST_DATA, to thedirectory, /oradata02/vtdb . This will result in 4*20 GB data files in the targetdirectory, each with an extent size of 1024 KB.

Add Oracle data filesOracle data files can be added to existing tablespaces using the dbspace_admin tool.You must ensure that there is sufficient space in the target location for the amountof space you are allocating before attempting to add datafiles.

About this task

Database system privileges are needed to add data files. You are prompted for thesystem user password on executing the -addfile option.

Procedure

Run the following command:dbspace_admin -addfile -tbsname <tablespace_name> -dirpath <dir_path>

-extsize <size_in_kb> -totalsize <size_in_mb>

The parameters used with the -addfile option are described in “Add Oracletablespaces” on page 119.

Table 30. Parameters for Adding a data file

Option Description

-tbsname The name of the tablespace that the datafiles are added to.


Table 30. Parameters for Adding a data file (continued)

Option Description

-dirpath The path to the directory where thedatabases files are created. If a total size ofover 20 GB is specified, multiple data fileswill be added, each with a max size of 20GB.

-extsize The increment size for the new data files.This must match the increment size of theother data files associated with the specifictablespace. Differs from extent size which isset only on tablespace creation.

-totalsizeThe total size in megabytes for the new datafiles. If a total size of over 20 GB isspecified, multiple data files are added, eachwith a maxsize of 20 GB. The total sizespecified is the maxsize each datafile canauto extend to.

Recommended default value:

v -totalsize=20000 MB (20 GB)

Exampledbspace_admin - addfile -tbsname VT_TEST_DATA -dirpath /oradata02/vtdb

-extsize 1024 -totalsize 25000

This example shows the adding of 25Gb worth of datafiles to the tablespace,VT_TEST_DATA , in the directory, /oradata02/vtdb . This will result in one 20Gbdatafile and one 5Gb datafile in the target directory, each with an extent size of1024Kb.

Modify Oracle data filesOracle data files can be modified, or resized.

About this task

You should ensure that there is sufficient space in the target location for theamount of space you are allocating before attempting to modify a data file.

Database system privileges are needed to modify data files. You will be promptedfor the system user password on executing the -modifyfile option.

Procedure

Execute the following command:dbspace_admin -modifyfile -filepath <file_path> -totalsize <size_in_mb>

The parameters used with the -modifyfile option are described in “Modify Oracledata files.”


Table 31. Parameters for Modifying a data file

Option Description

-filepath The file path to the databases file which isbeing modified.

-totalsize The total size in megabytes that the existingdatafile will be resized to. It is notrecommended to set the total max autoextend size to greater than 20 GB.

Exampledbspace_admin - modifyfile -filepath /oradata02/vtdb/vt_test_data06.dbf

-totalsize 20000

This example shows the modifying of a datafile, /oradata02/vtdb/vt_test_data06.dbf, with a new maxsize of 20 GB. This will result in the max sizeof an existing data file that is changed so that it can auto extend to a max of 20GB. The actual size of the data file will not be changed.

Drop Oracle tablespacesOracle tablespaces can be dropped from the database.

About this task

Only non-system tablespaces can be dropped using the dbspace_admin tool. Systemtablespaces such as SYSTEM, SYSAUX, TEMP, and UNDOTBS cannot be dropped.

Note: A tablespace must not be dropped from the system unless you are sure thatthe tablespace is no longer needed. When a tablespace is dropped all associatedtables and data are also dropped.

Database system privileges are needed to drop tablespaces. You will be promptedfor the system user password on executing the -droptbs option.

To drop a tablespace:

Procedure

Run the following command:dbspace_admin -droptbs -tbsname <tablespace_name>

After a tablespace is dropped the associated data files will need to be manuallydropped from the system as the oracle user. The dbspace_admin tool will list thefiles that will need to be removed.The parameters used with the -droptbs option are described in See Parameters forModifying a Datafile.

Table 32. Parameters for Dropping a Tablespace

Option Description

-tbsname The name of the tablespace to be dropped.

Exampledbspace_admin -droptbs -tbsname VT_TEST_DATA


This example shows the dropping of a tablespace, VT_TEST_DATA, from thedatabase. This results in the tablespace and all associated datafiles being droppedfrom the database. The associated datafiles listed in the resulting output must bemanually dropped from the system as the oracle user.

Resize an UNDO tablespaceAn UNDO tablespace is used for implementing automatic undo management inthe Oracle database.

About this task

The Oracle database uses an UNDO tablespace for maintaining undo records,which are used to undo or roll back uncommitted changes made to the database.

Procedure1. To resize an UNDO tablespace run these commands on the database server as

user virtuo :$ export ORACLE_SID=<MYDB>$ sqlplus SYS AS SYSDBASQL> SELECT file_name, tablespace_name, bytes/1024/1024 UNDO_SIZE_MB, SUM(bytes/1024/1024) OVER() TOTAL_UNDO_SIZE_MB

FROM dba_data_files dWHERE EXISTS (SELECT 1 FROM v$parameter p WHERE LOWER

(p.name)=’undo_tablespace’ AND p.value=d.tablespace_name);

The resulting size of an UNDO tablespace can be calculated by a formula basedon the result returned by:CURR_UNDOTBS_FILE_SIZE_MB :

NEW_UNDOTBS_FILE_SIZE_MB = CURR_UNDOTBS_FILE_SIZE_MB +CURR_UNDOTBS_FILE_SIZE_MB*0.2

Note: It is not recommended to grow any data files above 20 GB in size. If atablespace needs to be grown over 20 GB a new datafile has to be added.

2. Check if enough free disk space exists on the disk where the UNDOTBS file(s)are placed. If free disk space is available and the resulting size of the data fileis less then 20 GB - resize the UNDO tablespace data file with the command:SQL> ALTER DATABASE DATAFILE ’<undotbs_file_name>’ RESIZE<new_undotbs_size>M ;

3. If new files have to be added to the UNDO tablespace run the command:SQL> ALTER TABLESPACE <undotbs_name> ADD DATAFILE ’new_file_name’ SIZE<20%_of_current_undotbs_size>M ;

4. Check the current size of the UNDO tablespace:SQL> SELECT file_name, tablespace_name, bytes/1024/1024 UNDO_SIZE_MB, SUM(bytes/1024/1024) OVER() TOTAL_UNDO_SIZE_MB

FROM dba_data_files dWHERE EXISTS (SELECT 1 FROM v$parameter p WHERE LOWER

(p.name)=’undo_tablespace’ AND p.value=d.tablespace_name);


Partition maintenancePartition maintenance is a system maintenance job, which is responsible for thecreation, deletion and optimization of date range partitioned tables.

It enables a seamless process of creating, deleting, moving and analyzing partitionswithout impacting the performance of the system.

Tivoli Netcool Performance Manager uses partitioned, index organized tables(IOTs) for storing traffic data. This ensures that large data tables are stored in astructured format, with the aim of minimizing the usage of space and optimizingthe performance of report generation.

The partition maintenance job deals with the adding of partitions, to ensure thatsufficient partitions exist in the future, and with the purging of old data from thesystem. The adding and deleting of data is based on configurable data retentionsettings within the partition maintenance process.

As well as creating and deleting data, the partition maintenance process helpsoptimize the database performance by:v Analyzing tables and gathering partition level statistics.v Moving data in IOT partitions to compress and optimize the data

Partition maintenance jobsThe partition maintenance process is automated through several jobs that arescheduled to run automatically.

These jobs are used to automatically create partitions for future dates and also toremove partitions where old unwanted data is stored.

The scheduler automatically sets partition maintenance to run at a specified timenightly. The partition maintenance jobs that are run are described in “Scheduledjobs” on page 105.

To change the default time when partition maintenance jobs are run refer to“Schedule administration” on page 105.

Amend the partition maintenance job configurationInstructions on how to amend the partition maintenance job configuration.

Procedure

If the partition maintenance job is always canceled by the timeout (by default, 6hours) that results in some missing table partitions, amend the partitionmaintenance job configuration to increase the speed of the partition maintenancejob. This ensures that all partitions are created during the partition creationwindow.

Tuning the Oracle database parametersInstructions on how to tune the Oracle database parameters


About this task

As database user SYS AS SYSDBA from SQLplus, verify the current setting for thejob_queue_processes parameter as follows:



where <MYDB> is the name of the database$ sqlplus /nologSQL> connect sys/<system_password> as sysdba

2. Verify the current setting for the job_queue_processes parameter:SQL> SHOW PARAMETER job_queue_processes

3. The returned value should be >= 10. If it is not, enter the command:SQL> ALTER SYSTEM SET job_queue_processes=10 SCOPE=BOTH;

Increase the number of partition maintenance sessionsInstructions on how to increase the number of partition maintenance sessions.

Procedure

To increase the number of partition maintenance sessions, enter the followingcommands as database user virtuo from SQLplus:SQL> UPDATE wm_system_values_v SET value=X WHERE name=’PartMaintSessions’;SQL> COMMIT;

where X = 2. If this does not solve the problem, set X = 4. Do not exceed a value of4.If having 4 sessions does not solve the problem, increase the partition maintenancejob running time.

Increase the partition maintenance job running timeInstructions on how to increase the partition maintenance job running time.

Procedure

To increase the partition maintenance job running time, enter the followingcommands as database user virtuo from SQLplus:SQL> UPDATE wm_system_values_v SET value=60*60*N WHERE name=’PartMaintMaxRunTime’;SQL> COMMIT;

where N = the number of hours to run, maximum 8.

Note: Do not change the number of licenses for the partition maintenance job fromthe default value 1. You can verify the number of licences by entering thefollowing command as database uservirtuo:SQL> SELECT maximum FROM sched_license WHERE job_type=20;

The resulting value should be 1.

Gather Oracle statistics with maintenance jobInstructions on how to gather the Oracle statistics daily.


About this task

Tivoli Netcool Performance Manager provides a feature to analyze tables andpartition on daily basis. This feature uses copy stats from Oracle database andpopulates table partition with last known up-to-date statistics. If you use thisfeature, the partition statistics will be copied daily at 3 a.m. The feature alsoanalyzes global statistic for all tables that have statistics data older than seven daysat 12 a.m. daily. This feature is enabled by default. If this feature is disabled, onlythen the partition statistics for each table will be collected at 3 a.m. on daily basis.

Procedure1. To run partition maintenance jobs by using copy stats and analyze tables, run

the following command from application server:$ dbsysval_admin -update PartMaintCopyStats true

2. To get back to the default partition maintenance job, run the followingcommand from application server:$ dbsysval_admin -update PartMaintCopyStats false

3. Optional: To change the list of tables to be analyzed by ANALYZE_TABLES job, runthe following command:$ dbsysval_admin -update PartMaintAnalyzeTablesDelay N

WhereN is the number days to be excluded from the daily analyze tables. The defaultvalue is seven days.

Note: You must set the PartMaintCopyStats to TRUE. If you want to increasethe frequency of analyze tables, decrease the number of days.Attention: If you run partition maintenance job daily, it impacts the Oracleperformance.

4. Optional: To increase the running time of the analyze tables job, run thefollowing command from application server:$ dbsysval_admin -update PartMaintMaxAnalyzeRunTime N

WhereN is the number of seconds to run. The default value is 28800 seconds and themaximum value that is allowed is 82800 seconds.

Note: If the partition maintenance job takes more than 56 hours to analyze allthe tables, you can increase the number of seconds.

Partition maintenance command-line toolPartition maintenance uses a command-line tool, called part_admin, to allow usersto manually run partition maintenance tasks and update partition maintenancesettings.

The part_admin script is located at the following location and can be run from anydirectory as user virtuo :

$WMCROOT/bin/part_admin

Partition maintenance CLI parametersA description of the available partition maintenance CLI parameters.


The scope of the partition maintenance CLI can be limited by the followingparameters:[-type] [-subtype] [-tabtype] [-sdate] [-edate] [-filter] [-param] [-value]

Partition maintenance CLI parameters are described in the following table:

Table 33. Partition maintenance CLI parameters


-type Type of table, examples include TECHPACK ,ENTITY and TABLE .

-subtypeSubtype associated with a specific type.Subtypes are associated with the main types,examples include:

v TECHPACK For example, "Neutral GSMCore" , "Ericsson GSM BSS R10"

v ENTITY : For example, "CELL" , "MSC" ,"OSI_Channe l "

v TABLE For example, "traffic" ,"softalarm" , "sSUMDaily"

-tabtype Table type, examples include "traffic" ,"softalarm" , "sSUMDaily"

-filterFilter the output by table name, examplesinclude

v "ERI_BSC_TBF_GSL_TAB"

v "ERI_%_TAB"

-sdate Start time, sdate format: yyyymmddhh24.

-edate End time, edate format: yyyymmddhh24.

-param Parameter for updating partitionmaintenance parameters, examples includedata_retention , tablespace_name

-value Value for update partition maintenanceparameters and settings.

Partition maintenance CLI tasksA description of the partition maintenance CLI tasks.

The following table lists tasks that can be completed using the part_admin tool:

Table 34. Partition maintenance CLI parameters

Option Description

-addAdd partitions. Scope can be limited using:

[-type] [-subtype] [-tabtype] [-filter][-sdate] [-edate]

-deleteDelete partitions. Scope can be limited using:



Table 34. Partition maintenance CLI parameters (continued)

Option Description

-pinPin partitions into the database to allowthem to be maintained outside of thedefined data retention periods. Scope can belimited using:


-unpinUnpin partitions from the database to allowthem to be dropped from the system whenthey are outside of the defined dataretention periods. Scope can be limitedusing:


-exportExport partition data from the database.Scope can be limited using:

-tname <TABLE_NAME> -sdate <DATE> -edate<DATE>

or,

-pname <TABLE_NAME>:<PART_NAME>

-importImport data into the database which hasbeen previously exported using thepart_admin tool. Scope can be limited using:

-pname <TABLE_NAME>:<PART_NAME>

-showparams Display all configurable partitionmaintenance parameters.

-listparamsDisplay all parameters settings. Scope can belimited using:

[-type] [-subtype] [-tabtype]

-updateparamsUpdate specific partition maintenancesettings. Scope can be limited using:

[-type] [-subtype] [-tabtype] [-filter][-param] [-value]

-listsessions Lists the current number of configurableparallel partition maintenance sessions.

-updatesessionsUpdate the number of configurable parallelpartition maintenance sessions. Scope can belimited using:

[-value]


Table 34. Partition maintenance CLI parameters (continued)

Option Description

-listtypesThe scope of partition maintenance tasks canbe limited by type. The -listtypes optioncan be used to list the available types on thesystem. Valid types are TECHPACK , ENTITYand TABLE . Subtypes are associated with themain types, examples include:

v TECHPACK For example, "Neutral GSMCore" , "Ericsson GSM BSS R10"

v ENTITY : For example, "CELL" , "MSC" ,"OSI_Channel"

v TABLE For example, "traffic" ,"softalarm" , "sSUMDaily"

Scope can be limited using [-type]

-listpartLists partitions by table name to allow theuser to see what partitions currently exist onthe system. The list can be limited using:


-listpinnedLists partitions by table name to allow theuser to see what partitions are currentlypinned on the system. The list can belimited using:

[-type] [-subtype] [-tabtype] [-filter]

-listspace Display the current space settings pertablespace.

-logsDisplay the partition maintenance logs perjob id. Scope can be limited using:

[-id]

-errors Display the partition maintenance error logsper job id.

-status Display the status of the active partitionmaintenance job.

-help Display help.

Adding partitionsAdding a partition adds a partition to an individual table or a group of tables.

About this task

Partitions are generally added to allow backloading of data into a table or ifspecific data was being added to a particular table.

Adding partitions outside of the retention period pins them into the database.


Procedure

The syntax to add partitions option is as follows:part_admin -add [-type] [-subtype] [-tabtype] [-filter] -sdate -edate

Example

The following example adds partitions to all traffic tables in the Neutral GSM Coretechnology packs from the 1st January 2007 to the 10th January 2007:part_admin -add -type TECHPACK -subtype "Neutral GSM Core" -tabtype "traffic"-sdate 2007010100 -edate 2007011000

The following example adds partitions to the table ERI_BSC_TBF_GSL_TAB fromthe 1st January 2007 to the 10th January 2007:part_admin -add -filter "ERI_BSC_TBF_GSL_TAB" -sdate 2007010100 -edate 2007011000

Backloading dataWhen you backload old data, you must ensure partitions exist for the selectedbackload time period.

About this task

If these partitions do not exist then you must add the partitions beforecommencing backloading.

Procedurev Existing partitions can be shown using the following command:

part_admin -listpart [-type] [-subtype] [-tabtype] [-filter]

Partitions are created based on the retention settings defined in the/appl/virtuo/conf/vmm/default.properties file and in the PART_TABLES table.

v The following command will show the current retention settings on the system:part_admin -listparams [-type] [-subtype] [-tabtype] [-filter]

where:DATA RETENTION is the number of partitions which will be kept in the past.PAST RETENTION is the minimum number of partitions which are automaticallycreated in the past.FUTURE RETENTION is the minimum number of partitions which are automaticallycreated in the future.If the necessary partitions do not exist for the data being backloaded, then runthe part_admin -add command to add the necessary partitions. This will ensurethat the data is loaded correctly and will be managed correctly by partitionmaintenance.


Deleting partitionsDeleting a partition drops a partition from an individual table or a group of tables.

Procedure

The syntax of the deleting partitions option is as follows:part_admin -delete [-type] [-subtype] [-tabtype] [-filter] -sdate -edate

Example

The following example deletes partitions from all daily summary tables of entitytype X25 from the 1st January 2007 to the 10th January 2007:part_admin -delete -type ENTITY -subtype "X25" -tabtype "sSUMDaily"-sdate 2007010100 -edate 2007011000

The following example deletes partitions from all tables with a name like %_DSMfrom the 1st January 2007 to the 10th January 2007:part_admin -delete -filter "%_DSM" -sdate 2007010100 -edate 2007011000

Note: Deleting partitions on a regular basis is not usually required. Scheduledpartition maintenance jobs usually control this task. If you must delete partitionsusing this procedure ensure you are deleting the correct partitions to prevent lossof a large amount of important data.

Adding and deleting daily sub partitions for traffic tablesThe add and delete daily sub partitions feature is introduced to increase theperformance that is required for scanning the tables. Sometimes the table sizemight grow large although the scan is limited for a filter and it might increase thetime for execution of the query. To counter these cases for traffic tables, daily subpartitions can be created. You can then scan only the required sub partitions andthe performance can be optimized.

About this task

The daily sub partitions can be created for future dates only, that is, for the datesfor which the data is still not loaded in the tables. The daily sub partitions must beadded in ascending order of dates.

Since the sub partitions are to be created for daily, the maximum time period forwhich the partitions are created is 24 hours. Therefore, the number of daily subpartitions to be created is as follows based on the value given:v 2

Two partitions are created at P+sysdate+00 and P+sysdate+12 time stamps.v 3

Three partitions are created at P+sysdate+00, P+sysdate+08, and P+sysdate+16time stamps.

v 4Four partitions are created at P+sysdate+00, P+sysdate+06, P+sysdate+12, andP+sysdate+18 time stamps.

v 6Six partitions are created at P+sysdate+00, P+sysdate+04, P+sysdate+08,P+sysdate+12, P+sysdate+16, and P+sysdate+20 time stamps.


v 8Eight partitions are created at P+sysdate+00, P+sysdate+03, P+sysdate+06,P+sysdate+09, P+sysdate+12, P+sysdate+15, P+sysdate+18, and P+sysdate+21time stamps.

You can create daily sub partitions for a table by using the num_partitionsparameter that is introduced to the part_admin command.

Procedure1. Set or update the value for num_partitions parameter by using the following

command:part_admin -updateparams –filter <tablename_tab> -param num_partitions -value <number>

2. Run the add partition command to create daily sub partitions for a table for aspecific date by using the following command:part_admin -add -type TABLE -tabtype "traffic" -filter "<tablename_tab>" -sdate <timestamp> -edate <timestamp>

For example:part_admin -add -type TABLE -tabtype "traffic" -filter "NOK_CELL_LINK_BALANCE_TAB" -sdate 2014080100 -edate 2014080123

The output is as follows:

3. Run the delete partition command to delete the created daily partitions for aspecific table by using the following command:part_admin -delete -type TABLE -tabtype "traffic" -filter "<tablename_tab>" -sdate <timestamp> -edate <timestamp>

For example:part_admin -delete -type TABLE -tabtype "traffic" -filter "NOK_CELL_LINK_BALANCE_TAB" -sdate 2014080800 -edate 2014080823

The output is as follows:


Results

After the num_partitions value is set for a table, the partition maintenance job isrun for daily sub partitions.Related concepts:“Partition maintenance command-line tool” on page 126Partition maintenance uses a command-line tool, called part_admin, to allow usersto manually run partition maintenance tasks and update partition maintenancesettings.

Pinning partitionsPartitions are pinned into the database to allow them to be maintained outside thedefined data retention periods.

Procedure

The syntax of the pinning partitions option is as follows:part_admin -pin [-type] [-subtype] [-tabtype] [-filter] -sdate -edate

Example

The following example pins partitions from all softalarm tables of entity type X25from the 1st January 2007 to the 10th January 2007:part_admin -pin -type ENTITY -subtype "X25" -tabtype "softalarm"

-sdate 2007010100 -edate 2007011000

Unpinning partitionsPartitions are unpinned from a database to allow them to be dropped when theyare outside the defined data retention periods.

Procedure

The syntax of the pinning partitions option is as follows:part_admin -unpin [-type] [-subtype] [-tabtype] [-filter] -sdate -edate


Example

The following example unpins partitions from all softalarm tables from the 1stJanuary 2007 to the 10th January 2007:part_admin -unpin -type TABLE -subtype "softalarm" -sdate 2007010100

-edate 2007011000

Exporting partitionsPartitions can be exported to allow them to be maintained outside of the database.

About this task

Partitions can be exported for a particular date range or for a particular partition.

Procedure

The syntax of the exporting partitions options are as follows:part_admin -export -tname <TABLE_NAME> -sdate <DATE> -edate <DATE>

Or,part_admin -export -pname <TABLE_NAME>:<PART_NAME>

Example

The following example exports partitions in table ERI_BSC_TBF_GSL_TAB fromthe 1st January 2007 to the 10th January 2007:part_admin -export -tname ERI_BSC_TBF_GSL_TAB -sdate 2007010100 -edate 2007011000

The following example exports the partition P2007011000 in tableERI_BSC_TBF_GSL_TAB:part_admin -export -pname ERI_BSC_TBF_GSL_TAB:P2007011000

Importing partitionsPartitions that are exported through the part_admin CLI can be re-imported byusing the import option.

Procedure

The syntax of the importing partitions option is as follows:part_admin -import -pname <TAB_NAME>:<PART_NAME>

Example

The following example imports the partition P2007011000 in tableERI_BSC_TBF_GSL_DSM:part_admin -import -pname ERI_BSC_TBF_GSL_DSM:P2007011000


Showing parametersThe show parameters option allows the user to see all the configurable partitionmaintenance parameters.

Procedure

The syntax of the show parameters option is as follows:part_admin -showparams

Listing parametersThe list parameters option allows the user to view the current parameter settings,limited by type/subtype/table type or table name (filter).

Procedure

The syntax of the list parameters option is as follows:part_admin -listparams [-type] [-subtype] [-tabtype]

Updating parametersThe update parameters option allows the user to update the current parametersetting. The user can update the retention periods, the partitioning period,tablespace etc.

About this task

Note: The impact of these changes on the system must be considered beforeimplementation.

The updates to a parameter's setting can be limited by type, subtype or table typeor table name.

Procedure

The syntax of the update parameters option is as follows:part_admin -updateparams [-type] [-subtype] [-tabtype] [-filter] [-param] [-value]

Example

The following example updates the data_retention to 90 days for all softalarmtables:part_admin -updateparams -type TABLE -subtype "softalarm" -param data_retention -value 90

Listing partitionsPartitions can be listed by table name to allow the user to see what partitionscurrently exist on the system. The list can be limited by type, subtype, table type,and table name or time period.

Procedure

The syntax of the list partitions option is as follows:part_admin -listpart [-type] [-subtype] [-tabtype] [-filter] [-sdate][-edate]


List pinned partitionsPinned partitions can be listed by table name to allow the user to see whatpartitions are currently pinned on the system. The list can be limited by type orsubtype, table type and table name.

Procedure

The syntax of the list pinned partitions option is as follows:part_admin -listpinned [-type] [-subtype] [-tabtype] [-filter]

List sessionsThe list sessions option allows the user to view the current number of configurableparallel partition maintenance sessions.

Procedure

The syntax of the lists sessions option is as follows:part_admin -listsessions

Update sessionsThe update sessions option allows the user to update the number of configurableparallel partition maintenance sessions.

About this task

The number of parallel partition maintenance sessions is the number of parallel,slave sessions which can run to create partitions.

Note: The number of sessions is dependent on the of CPUs on a system and theimpact of changing this setting should be considered before implementation.

Procedure

The syntax of the update sessions option is as follows:part_admin -updatesessions -value

List spacesThe list space option allows the user to view the current space settings pertablespace.

Procedure

The syntax of the list space option is as follows:part_admin -listspace


Show logsThe logs option allows the user to view the partition maintenance logs.

Procedure

The syntax of the logs option is as follows:part_admin -logs [-id <job_id>/latest]

The -logs option gives a summary of all partition maintenance logs by job idalong with a start time, end time and total duration.The -logs -id <job_id> option gives detailed logs of all tasks that ran for aparticular job.The -logs -id latest option gives detailed logs of all tasks that ran for the latestjobs.

Show errorsThe errors option allows the user to view the partition maintenance error logs.

About this task

This will show all errors that have occurred in partition maintenance in the last 30days, ordered by time.

Procedure

The syntax of the errors option is as follows:part_admin -errors

Show statusShow status allows the user to view the current status of the active partitionmaintenance job.

About this task

To view the current status of the active partition maintenance job, do the following:

Procedure

The syntax of the show status option is as follows:part_admin -status

Managing disk space usageInstructions on how to manage disk space.

Before you attempt to manage disk space, you must meet the followingrequirements:v Ensure enough disk space is available for the requirements of the database.v Ensure enough disk space is available for the software installation.v Archiving for log files is setup.


Whenever disk utilization is near 100%, the Tivoli Netcool Performance Managerprocesses might be blocked. It is important to monitor disk space and remove oldfiles because recovery from a disk overflow might require rebooting the system.

You should conduct regular checks on the amount of disk space available in orderto ensure that:v Oracle is running at peak performance.v Server processes continue to run.v Data continues to load.

The main files to monitor for disk space usage are:v Data filesv Log filesv Tablespace files

All other files must be a static file size.

Monitoring the Oracle storage directoriesInstructions on how to monitor the Oracle storage directories.

Procedure1. As user virtuo, enter the following command to report the total disk space

usage in the Oracle storage directories:du -ks /ora*

Example output is as shown:4730154 /oradata0118675938 /oradata0217844018 /oradata0324129314 /oradata042 /oradump393458 /oralogs1393458 /oralogs2

2. As user virtuo enter the following command to report the available capacity inthe oracle storage directories:df -k /ora*

Monitoring the $WMCROOT/logs directoriesInstructions on how to monitor the $WMCROOT/logs directories

Procedure

As user virtuo, enter the following command to report on the disk space usage ineach of the $WMCROOT/log directories: Example output is shown below.du -k $WMCROOT/logs

Example output is as shown:53 /appl/virtuo/logs/sapmgr33 /appl/virtuo/logs/sapmon18 /appl/virtuo/logs/sap_cli29 /appl/virtuo/logs/conf_read1564 /appl/virtuo/logs/web/default1565 /appl/virtuo/logs/web41094 /appl/virtuo/logs/as/default41095 /appl/virtuo/logs/as


9679 /appl/virtuo/logs/vmm2 /appl/virtuo/logs/sapmgr_cli1 /appl/virtuo/logs/loader/CHOPPED4066 /appl/virtuo/logs/loader911 /appl/virtuo/logs/gways57452 /appl/virtuo/logs

Monitoring the $WMCROOT/var/loader/spool directoriesInstructions on how to monitor the $WMCROOT/var/loader/spool directories

Procedure

As user virtuo, enter the following command to report the total disk space usagein the $WMCROOT/var/loader/spool directories:du -ks $WMCROOT/var/loader/spool

Example output is as shown:367832 /appl/virtuo/var/loader/spool

Reporting the size of file systemsInstructions on how to report the size of file systems.

About this task

The following command reports on the size of the file systems and the space inuse:

Procedure

As user virtuo enter the following command:df -k /ora* $WMCROOT

Example output is shown below.Filesystem kbytes used avail capacity Mounted on/dev/dsk/c0t2d0s0 25822151 4755778 20808152 19% /oradata01/dev/dsk/c0t2d0s1 25822151 18701562 6862368 74% /oradata02/dev/dsk/c0t3d0s0 25822151 17869642 7694288 70% /oradata03/dev/dsk/c0t3d0s1 25822151 24154938 1408992 95% /oradata04/dev/dsk/c0t2d0s3 10327372 10258 10213841 1% /oradump/dev/dsk/c0t0d0s6 10327372 403714 9820385 4% /oralogs1/dev/dsk/c0t1d0s1 10327372 403714 9820385 4% /oralogs2/dev/dsk/c0t1d0s0 15493995 9810710 5528346 64% /appl

Working with log filesCrontab entries are used to manage log files and report generation.

Cron entries must be periodically reviewed to assess whether log files are archivedwith adequate frequently. Altering the frequency of the cron jobs might be requiredif very large logs are seen to be produced.

Note: If the system is distributed over multiple servers, the log files are on theserver where the service in running. For example, the Oracle logs are on thedatabase server and application server logs will be on the application server in thelocations specified


.

The cron installation uses the following two crontab files to setup the virtuo androot user:v $WMCROOT/admin/common/cron/core_root_crontrab

v $WMCROOT/admin/common/cron/core_virtuo_crontrab

See “Crontab setup” on page 10 for default root user and virtuo user crontabentries.

Information about log filesInformation about log files.

Tivoli Netcool Performance Manager can perform the following functions for logfiles:v Remove old log files. See “Removing log files” on page 141.v Archive old log files. See “Archiving log files” on page 141.

The cron_script script is used to perform the functions described above. It islocated in:[hostname:virtuo] /$WMCROOT/admin/common/cron

For help when using the cron_script script, enter the following:./cron_script -help

Tivoli Netcool Performance Manager saves the following types of logs on theserver:v Appserver logs - Application Server logs in $WMCROOT/logs/as/default/v VMM tool - Technology Pack Activation logs in $WMCROOT/logs/vmmv SAP Manager logs - in $WMCROOT/logs/sap*v Loader logs - in $WMCROOT/logs/loaderv Install logs - in $WMCROOT/admin/oracle/schema/core/install_schema.log

$WMCROOT/admin/ds/schema/install_schema.log

$WMCROOT/admin/logs/pmw_install.log

v Web access logs - in $WMCROOT/logs/web/default

The cron entries below are setup for the following log files within the TivoliNetcool Performance Manager installation. Tivoli Netcool Performance Managersupports the removal, rollover and archiving of the files below:[hostname:virtuo]crontab -l0 1 * * * /appl/virtuo/admin/common/cron/cron_script-r -d 31 /data/trace_archive1 \*.log.\*

0 1 * * * /appl/virtuo/admin/common/cron/cron_script-a -d 0 /appl/virtuo/logs \*.log.\* /data/trace_archive1

14,29,44,59 * * * * /appl/virtuo/bin/alarmapi_admin -da30 * * * * /appl/virtuo/bin/run_loader_cleanup 36000 3 * * * /appl/virtuo/admin/common/cron/cron_script-a -d 5 /appl/virtuo/logs/nc_archiver \*log.\* /data/trace_archive1

0 3 * * * /appl/virtuo/admin/common/cron/cron_script-p -d 3 /appl/virtuo/logs/loader \*.log.\* /data/trace_archive1

0 1 * * * /appl/virtuo/admin/common/cron/cron_script


-r -d 1 /appl/virtuo/var/rg/spool/export/reports \*.csv

0 1 * * * /appl/virtuo/admin/common/cron/cron_script-r -d 1 /appl/virtuo/var/rg/spool/export/reports \*.xml

0 1 * * * /appl/virtuo/admin/common/cron/cron_script-r -d 1 /appl/virtuo/var/rg/spool/export/reports \*.xls

Removing log filesInstructions on how to remove log files.

About this task

As user virtuo complete the following steps to remove a log file:

Procedure1. Move to the directory where the cron_script is located:

cd /$WMCROOT/admin/common/cron

2. Run the following command:./cron_script -r -d <dirname> <filename>

The parameters to be included with the -r option to remove old log files aredescribed in “Removing log files.”

Table 35. Parameters for Removing Log Files

Option Description

<-d> (optional) The -d option is optional. Use the nextargument to specify the age of the file indays.

<dirname> The directory the log files are currentlystored in.

<filename> The filename of the file you want to remove.

Note: Multiple files can be removed at the same time using the (*) wildcard.For example:***/appl/virtuo/admin/common/cron/cron_script -r -d 31/data/trace_archive1\*.log\*

Archiving log filesInstructions on how to archive log files.

About this task

Complete the following steps as user virtuo to archive a log file:

Procedure1. Move to the directory where the cron_script is located:

cd /$WMCROOT/admin/common/cron

2. Run the following command:cron_script -a -d <dirname> <filename> <archive_dir>

The parameters to be included with the -a option to remove old log files aredescribed in “Archiving log files.”


Table 36. Parameters for Archiving Log Files

Option Description

<-d> (optional) The -d option is optional. Use the nextargument to specify the age of the file indays.

<dirname> The directory the log files are currentlystored in.

<filename> The file name of the file you want toremove.

<archive_dir> The directory to archive the files to.

Note: Multiple files can be archived at the same time using the (*) wildcard.Example :***/appl/virtuo/admin/common/cron/cron_script -a -d 0/data/trace_log1\*.log.\* /data/trace_archive1

Loader LIF file directoryThe archive_loader_data script is used to archive .lif files.

These are files produced by the gateways and processed by the loaders in largevolumes. The archive_loader_data script is located in:

[hostname:virtuo] $WMCROOT/admin/common/cron

The default loader LIF directory is located under /appl/virtuo/var/loader/spool .If LIF files are not removed from the system with adequate frequency, the /appldirectory can increase in size quickly.

Java client processesIf a JavaTM client process requires an extensive use of memory and the defaultJava heap size is insufficient, then the process can fail with an OutOfMemoryErrorJava exception.

About this task

The exception looks similar to the following:java.lang.OutOfMemoryError: Java heap space

This error can occur when installing or upgrading large technology packs andwhen using the sbh_sk_remover tool. This problem is resolved by increasing thememory available to Java client processes. Available memory is increased byamending the ANT_OPTS environment variable.

Note: If you are installing large technology packs, it is strongly recommendedthat you set the ANT_OPTS variable to a value of 1G prior to installation. Do notallow the installation to fail before increasing the ANT_OPTS value.

To increase available memory for Java client processes:


Procedure1. Run the following command:

export ANT_OPTS="-Xmx1G"

2. Run the client process.For example, run the technology pack installation:techpack_admin -a

3. After the client process completes successfully, reset the ANT_OPTS variable to itsoriginal value:unset ANT_OPT

Note: You do not need to stop and re-start the application server after youreset the ANT_OPTS value.

What to do next

Confirming the correct setting is being used

To confirm the correct memory setting is being used, run a Java client tool andthen check how much memory the process has been assigned. In the examplebelow the ANT_OPTS variable has been set to 512m.

To confirm the correct memory setting is being used:1. Run the following commands:

techpack_admin -l installed &ps -ef | grep java

Example output:virtuo 1492 25435 2 09:12:55 pts/2 0:03 /appl/virtuo/jre/bin/java

-Xmx512m -classpath /appl/virtuo/ant/lib/ant-launcher

In this example the correct setting being used is 512m.

Backing up file systemTo protect the system from loss of data, regular file system backups must be madein addition to backing up the Oracle database.

Procedure

The following file systems must be included in the backup:v /

v /var

v /appl

v /export/home

v /data/trace_log1

v /data/trace_archive1

A backup schedule must include full and incremental backups of these filesystems. Ensure that the backup media are correctly labeled and stored in a securelocation, and that the integrity of the backups is checked periodically.



Chapter 8. Tools

Covers a number of additional tools available to administer and support thesystem.

Importing and exporting user documents and report resultsInstructions on how to import and export user documents and report results.

About this task

Do not run more than one of the following tools, or more that one instance of anyof these individual tools, at the same time:v techpack_admin

v sbh_admin

v summary_admin

v kpicache_admin

v report_impexp

For example, do not run summary_admin and sbh_admin, or two instances ofsummary_admin at the same time.

The report_impexp tool provides functionality for:v Importing and exporting report definitionsv Importing and exporting report templatesv Importing and exporting report schedulesv Importing and exporting report resultsv Deleting report templates

Caution is required when transferring exported files to and from a MicrosoftWindows computer. Some Windows text editors automatically insert carriagereturns in files. You can remove the carriage returns by using the dos2unixprogram.

The report_impexp tool is located in: $WMCROOT/bin

Procedure

The report_impexp tool can be executed from any directory as user virtuo .For help when using the report_impexp script, enter the following:report_impexp -h [1|2|3|4|5]

Where:v 1 = help for importing artifactsv 2 = help for exporting artifactsv 3 = help for importing report resultsv 4 = help for exporting report resultsv 5 = help for deleting templates


Importing definitions, templates, schedules and foldersThe import operation imports all user documents from an import file or directoryto a destination directory.

usagereport_impexp -i -u <user_id> -p <password> -f <file|dir>

-l <server_directory> -dup <failonerror|overwrite|ignore>

options

The options and parameters to be used with the report_impexp tool for importingreport definitions, templates, schedules and folders are described in the followingtable.

Table 37. Options for report_impexp tool - import user documents

Option Description

-i Initiates the import process.

-u <user> The user name of the user invoking theimport tool.

-p <password> The user's password.

-f <file|dir>Name of xml file from which to import userdocuments.

Can be a reference to a file or a folder. If areference to a folder is given then arecursive search is carried out for all fileswith an .xml extension. Each file is thenimported.

-l <server_directory>Destination on server that is the rootlocation for imported documents. This mustbe a valid user folder location. For example:/Users/sysadm

/Users/peter/folder1

/Users/mary/backup/daily

If the -l option is not used then the locationand associations are taken from theimported document(s).

-dup [failonerror| overwrite|ignore]Import process behavior. This option isspecified with one of the following threeparameters:

failonerror - fail when an existingdocument with the same name is found

overwrite - overwrite when existingdocuments with the same names are found

ignore - ignore documents that already exist


Examplesreport_impexp -i -u <user> -p <password> -f import.xml -l /Users/mark -dup ignorereport_impexp -i -u <user> -p <password> -f import.xml -dup ignore

Exporting definitions, templates and schedulesThe export operation exports all specified user documents to an output file.

usagereport_impexp -e -c <a|d|t|s> -u <user_id> -p <password> -m <pattern_match>

-f <file> -l <server_directory> [-r <true|false>]

options

The options and parameters to be used with the report_impexp tool for exportingreport definitions, templates, schedules and folders are described in the followingtable.

Table 38. Options for report_impexp tool - export user documents

Option Description

-e Initiates the export process.

-cContent or type of object to export. Thecommand line options for -c are as follows:

[all|definition|template|schedule]

v all - selects report definitions, reporttemplates, schedules and folders

v definition - selects report definitionsand folders

v template - selects report templates andfolders

v schedule - selects schedules and folders

Shortcuts [a|def|t|s]

v a - all of the types below

v def - report definitions

v t - report templates

v s - report schedules

The all definitions and template selectionswill include any dependent folders.

-u <user> The username of the user invoking theexport tool.


-m <pattern_match> Pattern matches for user documents usingstandard wildcards. Quotes must be placedaround the wildcards. For example, for allreport definitions use "*".

-f <file> File to export documents to. This must be anxml file.

Chapter 8. Tools 147

Table 38. Options for report_impexp tool - export user documents (continued)

Option Description

-l <server_directory>Location on server to export the file to. Thismust be a user folder location or path thathas been defined during report definition.For example, /Users/sysadm . User folderlocations can be checked in the GUI.Locations can be found in the Browse tab,see the Using Tivoli Netcool PerformanceManager - Wireless Component.

The user should have permission to read thedocument contents of the selected location.

-rOptional. Recursive search (sub-directories)of source root location for other files thatmatch the search pattern specified by the -moption. The -r option is specified by one ofthe following parameters:

true

false

Examplesreport_impexp -e -c all -u <user> -p <password> -m "*"

-f export.xml -l /Users/username -r true

Importing report resultsThe import operation imports report results from an import file or directory to adestination directory.

Note: Report results do not contain any result data, they contain metadata aboutthe location of the results file. Results files are stored locally on the applicationserver where the request was initiated, in WMCROOT/var/rg/spool/.

To provide the data it is important for the user to externally manage the copyingand pasting of the results files. The reason for this external handling of result datais that the size of the results file can be large.

usagereport_impexp -i -c <r> -u <user_id> -p <password> -f <file|dir>

-l <server_directory> -dup <failonerror|overwrite|ignore>

options

The options and parameters used with the report_impexp tool for importing reportresults are described in the following table.

Table 39. Options for report_impexp - import report results

Option Description

-i Import.


Table 39. Options for report_impexp - import report results (continued)

Option Description

-c <r>Content or type of object to import. Use thefollowing parameter:

r - report results



-f <file|dir>The file or directory to import. This option isspecified by one of the followingparameters:

file - the file to import.

dir - the directory of files to import.

This must be a valid user folder location.For example: /Users/sysadm

/Users/peter/folder1

/Users/mary/backup/daily

If the -l option (below) is not used then thelocation and associations are taken from theimported document(s).

The name specified by the <data-source-pk>field in the file(s) must match the name ofthe destination machine. In the examplebelow, server.one.locale1.abc.com is thename of the destination machine:

report results fields

==============

<data-source-pk>

<name>server.one.locale1.abc.com</name>

</data-source-pk>

-l <server_directory> Destination on server that is the rootlocation for imported documents.


Table 39. Options for report_impexp - import report results (continued)

Option Description

-dup [failonerror|overwrite|ignore]Import process behavior.

Note: While this option must be set, it is notused on the server side. Because norelationship is maintained on the server sidebetween report results and definitions, theserver can load multiple copies.

This option is specified with one of thefollowing three parameters:

failonerror - fail when an existing reportwith the same name is found

overwrite - overwrite when existing fileswith the same names are found

ignore - ignore files that already exist

Examplesreport_impexp -i -c results -u <user> -p <password> -f /appl/virtuo/tmp/exportResults.xml -l /Users/sysadm -dup ignore

Exporting report resultsThe export operation exports report results to an output file.

usagereport_impexp -e -c <r> -u <user_id> -p <password> -m <pattern_match>

-f <file> -l <server_directory> [-r]

options

The options and parameters to be used with the report_impexp tool for exportingreport results are described in the following table.

Table 40. Options for report_impexp tool - export report results

Option Description

-e Initiates the export process.

-cContent or type of object to export. Thisoption uses the following parameter:

r - report results

-u <user> The user name of the user invoking theexport tool.


-m <pattern_match> Pattern matches for document names usingstandard wildcards. Quotes must be placedaround the wildcards. For example, for allreport results use “*”.


Table 40. Options for report_impexp tool - export report results (continued)

Option Description

-f <file>The file to export documents to. This optionis specified by the following parameter:

file - the file to export to.

-l <location> Destination on server that is the rootlocation for exported documents.


true

false

Note: If the report results are not on the file system where the report_impexp toolis being used then the report result content will not appear in the exported dataset.

Examplesreport_impexp -e -c results -u <user> -p <password> -m ’Report_27*’ -fexportResults.xml -l /Users/sysadm -r true

Deleting report templatesThe delete operation deletes report templates.

usagereport_impexp -d -u <user> -p <password> -m <pattern_match> -l <server_directory> [-r]

options

The options and parameters to be used with the report_impexp tool for deletingreport templates are described in the following table.

Table 41. Options for report_impexp tool - delete report templates

Option Description

-d Initiates the delete process.

-u <user> The username of the user initiating theoperation.


-m <pattern_match> Pattern matches for document names usingstandard wildcards. Quotes must be placedaround the wildcards. For example, for alltemplate names use "*".

-l <location> Location on server of report templates.


Table 41. Options for report_impexp tool - delete report templates (continued)

Option Description


true

false

Examplesreport_impexp -d -u <user_id> -p <password> -m "CDMA*" -l /Users/sysadm/

report_impexp -d -u <user_id> -p <password> -m "DAILY_TCH" -l /Users/sysadm -r true

Running a report from the command-lineYou run a report using the report_run command-line tool.

About this task

To run a report from the command-line:

Procedure

Use the commandreport_run -u <username> -p <password> -r <report_name> [-f folder_path]

Table 42. Options for the report_run tool

Option Description

-u <username> The user name of the user running thereport.


-r <report_name> Report name. You can use a pattern matchfor report names using the % wildcard.

-f <folder_path> Optional. location of the report definition torun.

-l Lists all report names.

Timezone support for reportingThe report scheduler offers users the option of running reports according to adifferent timezone than the one where the server is located.

A number of timezone regions and Daylight Saving Time (DST) rules are alreadydefined in the system. It is possible to define additional timezone regions and DSTrules.

The administrator can:v Set up Daylight Saving Time (DST) rules


v Define timezone regions, and assign DST rules to them if required

The following sections explain:

“About daylight saving time rules” “About timezone regions” on page 155

About daylight saving time rulesA DST rule defines the boundaries (starting and ending point) and the amount ofDST savings, in minutes. A DST boundary is a date time reference.

A single DST rule can be referenced by more than one timezone region.

You can define several different types of rules. Usually, the entries follow aday-of-the-week-in-month form, for example, "first Sunday in April."

You can also define a rule by specifying any of the following forms:v Exact day of the monthv The day of the week occurring on or after an exact day of the monthv The day of the week occurring on or before an exact day of the month

The interface assigns numeric values to the days of the week. Sunday is defined as1, Monday is defined as 2, and so on.

The following table shows an example of a DST rule for Seattle. It defines daylightsaving time as starting the first Sunday in April at 2:00 AM and ending the lastSunday in October at 2:00 AM.

Table 43. Example of DST rule for the Seattle region

attribute example

Starting Month April

Day first

day of Week Sunday

Time 2:00 AM

Ending Month October

Day last

day of week Sunday

Time 2:00 AM

Savings Savings 60 Minutes

DST rule IDEach DST rule has an ID. When a new DST rule is created, the systemautomatically assigns a number to the rule, and displays it after the rule is created.

The identifier is always an integer, and cannot be changed. You can list DST rulesand their IDs, see “List DST rules” on page 154.

Use the tz_admin script to manage rules for timezone regions.


Create a DST ruleThe tz_admin script allows you to create a DST rule.

Procedure

Use the following command:tz_admin -adddstr start <start_format> end <end_format> mins

where <start_format> and <end_format> can take any of the following forms:v After MM dayofweek DD HH:mmv Before MM dayofweek DD HH:mmv First MM dayofweek DD HH:mmv Last MM dayofweek DD HH:mmv Exact MMDD HH:mm

Where:

Table 44. DST rule

attribute description

after First (1=Sun, ...) on or after

before Last (1=Sun, ...)or before

first First (1=Sun, ...)

last Last (1=Sun, ...)

exact Exact day, specify month (MM) and day(DD)

For example, 0415 represents April 15.

dayofweek The numerical values for Sunday toSaturday (1 to 7)

D Day of the month DD

M Month, 01-12

H Hours 00-24

mm Minutes 0-60

mins Minutes of DST time: 1 to 1440.

Example

The DST for Europe or London is:tz_admin -adddstr start last 03 dayofweek 01 01:00 end last 10 dayofweek 01 01:00 mins 60

Which translates as: start on the last Sunday in March at 01:00, end on the lastSunday in October at 01:00, with 60 minutes of DST.

List DST rulesThe tz_admin script allows you to list DST rules.

To list a DST rule:tz_admin -listdstr <dst_rule_id>

Where:


Table 45. Options for listing a timezone region

Option Description

dst_rule_id DST Rule ID

To list all DST rules:tz_admin -listdstr all

Delete a DST ruleThe tz_admin script allows you to delete a DST rule.

To delete a DST rule:tz_admin -deletedstr <dst_rule_id>

Where:


Option Description


About timezone regionsA timezone region is different from a timezone. In the Mountain timezone of theUnited States, for example, the state of Arizona does not observe Daylight SavingTime, whereas the majority of the rest of the timezone does.

The administrator defines timezone regions, which the user can then select whenscheduling reports.

The following are the default regions available at installation time; you can addothers at any time:v America/Anchoragev America/Buenos Airesv America/Caracasv America/Chicagov America/Denverv America/Honoluluv America/Indianapolisv America/Lima Peruv America/Mexico Cityv America/New Yorkv America/Noronhav America/Phoenixv America/Puerto Ricov America/San Franciscov America/Santiagov America/Sao Paulov America/Seattlev Asia/Bangkokv Asia/Calcutta


v Asia/Dubaiv Asia/Hong Kongv Asia/Jerusalemv Asia/Riyadhv Asia/Tokyov Australia/Adelaidev Australia/Brisbanev Australia/Perthv Australia/Sydneyv Europe/Athensv Europe/Berlinv Europe/Brusselsv Europe/Helsinkiv Europe/Londonv Europe/Madridv Europe/Moscowv Europe/Parisv Europe/Romev Europe/Viennav Europe/Warsawv Europe/Zurichv Greenwich Mean Timev Pacific/Auckland

Use the tz_admin script to manage timezone regions.

Create a timezone regionUse the tz_admin script to create a timezone region.

About this task

You can set the current time zone region for your computer as well as define newregions to fit your business needs.

You create a timezone region by providing a name, GMT offset in minutes, andoptionally assigning a DST rule to it.

Procedure

Use the following command:tz_admin -addtzr <timezone_name> <gmt_offset> [<dst_rule_id>]

Where:

Table 47. Options for creating a timezone region

Option Description

timezone_name Name of the timezone region (64 charactersmaximum)


Table 47. Options for creating a timezone region (continued)

Option Description

gmt_offset GMT offset in minutes (-720 to 720).Longitudes west of GMT are negative, andlongitudes east of GMT are positive.


List timezone regionsUse the tz_admin script to list timezone regions.

Procedure

Use the following commands:To display the current timezone region:tz_admin -listcurtzr

To list all timezone regions:tz_admin -listtzr all

To list a specific timezone region:tz_admin -listtzr <timezone_name>

Where:


Option Description


Change the timezone regionUse the tz_admin script to change the timezone regions.

About this task

You can change the current timezone region.

Note: Existing schedules that deliver reports based on timezone regions could beimpacted when you change the region on a computer. The schedules are based onthe number of hours difference between two computers and are not linkeddynamically to a region's name. When you change a timezone region for acomputer, the hour relationship will not change.

Procedure

Use the following command:tz_admin -addcurtzr <timezone_name>

Where:



Option Description


Delete a timezone regionUse the tz_admin script to delete a timezone regions.

Procedure

Use the following commandtz_admin -deletetzr <timezone_name>

Where:


Option Description


Assign a timezone region a DST ruleUse the tz_admin script to assign a timezone region a DST rule.

Procedure

Use the following command:tz_admin -linktzr <timezone_name> <dst_rule_id>

Where:


Option Description



Holiday maintenanceHolidays are definable dates you can include in or exclude from reports.

Including or excluding holidays can provide for more accurate data depending onthe monitoring that is conducted. For example, a weekly report that monitorscommon traffic patterns can become skewed if it includes data from a holiday withabnormal traffic.

Conversely, you might want to create a report that only includes data fromholidays.

The holiday_admin tools provide the means to list and alter the holiday definitionsin the system.

This tool cannot be used off-line. It requires a virtuo administrative log in.


This tool is available on Windows as holiday_admin.js. It can be invoked eitherdirectly from the command line or by choosing either the script or wscriptcommand processor.

Using holiday_admin you can:v List holidaysv Add holidaysv Delete holidays

Parameters for holiday_admin are as follows:


Option Description

-u Administrator's user name.

-p Administrator's password.

-list Lists all holidays.

-add <date> Adds a holiday, the date is specified asMMDDYY. For example, 041506 representsApril 15. You can add more then one dateby separating each date with a space, forexample 041506 041606

-remove <date> Deletes a holiday, the date is specified asMMDDYY. For example, 041506 representsApril 15. You can remove more then onedate by separating each date with a space,for example 041506 041606

List holidaysUse the holiday_admin to list holidays.

Procedure

Use the following command:holiday_admin -u < admin_user > -p < admin_password > -list

Where:<admin_user> is the administrator's log in ID<admin_password> is the administrator's log in password

Add holidaysUse the holiday_admin to add holidays.

Procedure

Use the following command:holiday_admin -u <admin_user> -p <admin_password> -add <date> <date>

where:<admin_user> is the administrator's login ID<admin_password> is the administrator's login password<date> is the date of the holiday to be added specified as YYYY-MM-DD. You canadd more then one date by separating each date with a space, for example


2009-05-19 2009-05-20.

Delete holidaysUse the holiday_admin to delete holidays.

Procedure

Use the following command:holiday_admin -u <admin_user> -p <admin_password> -remove <date> <date>

where:<admin_user> is the administrator's login ID<admin_password> is the administrator's login password< date > is the date of the holiday to be deleted specified as YYYY-MM-DD. Youcan remove more then one date by separating each date with a space, for example2009-05-19 2009-05-20.

What to do next

Setting UDC constants

The parameter_admin is a command line tool that is used to set constants that canbe included in UDC expressions.

For example, for UDCs by using the crit traffic function a parameter can bedefined as the DGOS. For example:parameter_admin -s DEFAULT_DGOS -t float -v 0.6

Then in crit UDC expressions the parameter can be used. For example:

crit( [Cell]![{Neutral.tch.available_ch}], parameterFloat("DEFAULT_DGOS"), "B")

Where parameterFloat returns the float value of the configuration parameter. See

If the DGOS needs to be changed, the parameter value can be changed it changesin all the expressions in which it is used.

Archiving an NC tableNC tables space continues to grow naturally over time on some systems. Thenc_archiver_admin tool is used to archive network configuration data. Typically,the nc_archiver_admin tool archives an NC table that contains data later that 10days.

About this task

The nc_archiver_admin script runs and cleans the NC tables in two phases:1. Initially, the archiver tool gathers the network configuration data for deletion.

The loaders are not stopped at this stage.2. Then, the archiver tool deletes the data. The loaders are stopped at this stage

thus minimizing the downtime that is required while the housekeeping takesplace.


Procedure1. To archive an NC table, run the following command:

nc_archiver_admin -n nc_bsc -o 10 -d nc_archive/ -c false For example,archive the nc_bsc table.The NC instances are not deleted but are exported to a file:<nc_archive>/nc_bsc.csv. The directory is stated with the -d option.

2. Review the nc_bsc.csv file, and then remove NC instances that are not to bearchive from the csv file.

3. Run the following command to remove the NC instances:nc_archiver_admin -n nc_bsc -c true -f./nc_archive/nc_bsc.csv

Note: All running loader processes must be stopped before you remove theentities with this tool.For more information about the usage of the nc_archiver_admin tool,see“Archiver tool usage”

Archiver tool usageNC tables space continues to grow naturally over time on some systems.

The nc_archiver_admin script runs and cleans the NC tables in a two phases, firstit gathers the network configuration data for deletion and in the second phase itdeletes the data when the loaders are stopped thus minimizing the downtime thatis required while the housekeeping takes place.

The usage information for this script is as follows:nc_archiver_admin -n {all | <nc_table_name>}{-t <date> | -o <number_of_days> }-d <archive_directory>{-c <true | false> }{ -f <path>}{-u <true | false>}

Where:

-n

The entity table name that the Network Configuration data is to bearchived from.

-t

The time from which older historical Network Configuration entries arearchived or deleted. Date format that is used with -t option isMM/dd/YY. For example, -t 07/30/99. The date that is specified must notbe in the future.

-o

Number of days to keep historical Network Configuration Entries. Allentries older than the specified number of days are archived.

[-c]

Whether to commit the entity removal or output removable entities to afile. If not specified when -d is specified, defaults to false. This option isignored if -f is specified.

[-d]


Specifies the directory where the CSV file is to be written to. If notspecified the data in NC table is deleted without being written to CSVoutput file. This has no effect if -f is specified

[-f]

Path to a csv file of entities to delete. The file can be generated by runningthis tool with -c set to false.

[-u]

Flag to delete rehomed data from entity table and update the performancetables to use most recent instance of entity data. The -c option is ignoredin this case and the delete is committed. By default, it is false.

-h(elp)Display help information.

Note: All running loader processes such as nc_cache and alarm_cachemust be stopped before you remove entities with this tool. Loaders and cachesneed not be stopped when commit [-c] is set to false.


Chapter 9. LCM administration

The lcm_admin (Loader Configuration Manager) tool enables data sources, LoaderConfigurations and NC Relations to be loaded from XML files into theadministration database, and unloaded from the administration database to XMLfiles.

This tool also enables the addition, updating and deletion of Loader Datasources,Loader Configurations and NC Relations.

Loader data sourceA loader data source contains a set of mappings from input data to databasetables.

A data source is uniquely identified through its data source name, data sourceversion, technology pack name and technology pack version.

NC relationsEach NC relations entry provides a relationship between the network configurationdata used by a network element, with generated performance data.

For example, a relations entry can show a relationship between an NC cell tablewhich contains information on the location of a network element in the network,and a cell traffic table, which is a performance table that contains performance datagenerated by the network element.

Data availabilityIf a technology pack is provided with data availability definitions, these definitionsare contained in an .xml file.

This file contains information about the technology pack, and a list of blocks ofdata that are loaded for that technology pack.

Data availability is not supported when a data block has been loaded withdifferent time intervals within the same period of time.

For example: Block a block B1 has been loaded from different lif files relating tothe same time period T1 to T2, but the lif files use different time intervals -30-minutes 60-minutes and 15-minutes. In such a case a data availability report onsuch a block might provide inaccurate results.

UsageUsage: lcm_admin {

-h | -help | --help |-v | -version | --version |} | {-listdatasources |-list} | {-load <xml_file>} | {


-loadcustom <datasource_xml_file>} | {-merge <data_availability_xml_file>Adds data availability blocks to any already loaded.

} | {-unload [<datasource_xml_file>]-datasource <datasource_name>-dsversion <datasource_version>-techpack <techpack_name>-tpversion <techpack_version>[-type <datasource_type>]Type must be specified if using merged loadmaps

-unload [<relations_xml_file>]-relations[-nctable <nc_table>][-sourcetable <source_table>]

-unload [<dataavailability_xml_file>]-dataavailability-techpack <techpack_name>-tpversion <techpack_version>

-unloadcustom [<datasource_xml_file>]-datasource <datasource_name>-dsversion <datasource_version>-techpack <techpack_name>-tpversion <techpack_version>[-type <datasource_type>]Type must be specified if using merged loadmaps

} | {-delete <datasource_xml_file> |-datasource <datasource_name>-dsversion <datasource_version>-techpack <techpack_name>-tpversion <techpack_version>Delete of a datasource also deletes any loaderconfiguration related to it.

-delete <relations_xml_file> |-relations-nctable <nc_table>[-sourcetable <source_table>]If the nctable does not have a source table please pass-sourcetable followed by " " or "" or "*"

}-reread -datasource <datasource_name> -dsversion <datasource_version>

}NOTE: If a command is given with a name option, but the name parameter contains spaces, thendouble-quotes should be used, for example,

lcm_admin -delete-datasource "Nokia T13" -dsversion 2.0-techpack "GPRS CN" -tpversion 1.0

Table 53. lcm_admin options

Option Description

-listdatasources Lists a summary of all data sources in theadministration database.

-list Lists a summary of all LoaderConfigurations and all data sources in theadministration database.


Table 53. lcm_admin options (continued)

Option Description

-load <xml_file>Loads a loader data source into theadministration database from an XML file<xml_file> .

Load all files in the loadmaps dir.

Load data availability blocks for atechnology pack.

-loadcustom <datasource_xml_file> Loads a custom loader data source into theadministration database from an XML file<datasource_xml_file> .

-merge <data_availability_xml_file> Adds data availability blocks to any alreadyloaded.

-unload [<datasource_xml_file>]|

-datasource <datasource_name>

-dsversion <datasource_version>

-techpack <techpack_name>

-tpversion <techpack_version>

Unloads a data source by specifying eitheran XML file, or the data sources' identifyingparameters.

-unload [<dataavailability_xml_file>]

-dataavailability



Unloads a data availability XML file byspecifying an XML file, technology pack andtechnology pack version.

-unload [<relations_xml_file>]

-relations

[-nctable <nc_table>] [-sourcetable<source_table>]

Unloads a relations XML file by specifyingeither an XML file, or a combination of NCtable and source table.

-unloadcustom [<datasource_xml_file>]|





Unloads a custom data source by specifyingeither an XML file, or the data sources'identifying parameters.

-delete <datasource_xml_file>





Deletes a data source by specifying either anXML file, or the data sources' identifyingparameters.

Chapter 9. LCM administration 165

Table 53. lcm_admin options (continued)

Option Description

-delete [<relations_xml_file>]

-relations

[-nctable <nc_table>]

[-sourcetable <source_table>]

Deletes NC Relations entry(s) by specifyingeither an XML file, or a combination of theNC Relations entries NC table and sourcetable.

List information for data sourcesThe -list or -listdatasources option, displays a summary of all loader datasources in the database.

The -list or -listdatasources option, displays a summary of all loader datasources in the database, in the following format:Teckpack Name Version DataSource Name Version Technology Vendor

-------------------------------------------------------------------------

Ericsson GSM BSS 1.0 Ericsson BSS R10 GSM EricssonNokia GSM BSS 1.0 Nokia BSS OSS3.1 ED3 GSM Nokia

The list is sorted in ascending alphabetical order by Technology Pack name, thenby ascending Technology Pack version, then in ascending alphabetical order bydata source name and ascending data source version.

To list data sources, as user virtuo :lcm_admin -listdatasources

Orlcm_admin -list

Load data sources, NC relations and data availabilityInstructions on how to load data sources, NC relations and data availability.

Loading a data source from XMLThe -load option is used to create a new data source or update an existing datasource from a specified loader data source XML file.

About this task

If the data source specified in the XML file already exists, then this data source isupdated with the configuration in the loaded XML file. If the data source does notexist an attempt is made to create a new data source in the database.

Procedure

As the virtuo user, enter the command:lcm_admin -load <xml_file>


Loading a custom data source from XMLThe -loadcustom option is used to create a new custom datasource or update anexisting custom data source from a specified Loader data source XML file.

About this task

If the data source specified in the XML file already exists, then this data source isupdated with the configuration in the loaded XML file. If the data source does notexist an attempt is made to create a new data source in the database.

To load a custom data source:

Procedure

As the virtuo user, enter the command:lcm_admin -loadcustom <datasource_xml_file>

Loading NC relations from XMLThe -load option is used to create or update an NC Relations entry or set of NCRelations entries in the database from a specified NC Relations XML file.

About this task

If the NC Relations specified in the XML file already exist, then this NC Relationsentry(s) is updated with the configuration in the loaded XML file. If the NCRelations specified in the XML file do not exist then an attempt is made to create anew NC Relations entries) in the database.

Note: If an attempt to load a new set of NC Relations is made, and any of theserelations already exist in the database, then none of the NC Relations will beentered into the database. If an attempt is made to update a set of NC Relationsentries in the database and any of the NC Relations entries do not exist in thedatabase then none of the NC Relations entries are updated.

Procedure

As the virtuo user, enter the command:lcm_admin -load <relations_xml_file>

Loading data availability from XMLThe -load option is used to load data availability for a technology pack.

About this task

If a technology pack is provided with data availability definitions, these definitionsare contained in an .xml file. This file contains information about the technologypack, and a list of blocks of data that are loaded for that technology pack. If thevalue of the block is set to true, that is, <block name="ATMUSAGE">true</block>,then after the file is loaded the loader will start producing Data Availability (DA)statistics every time it loads a block of ATMUSAGE data.


Note: This file is supposed to be user-customized: blocks can be switched on or offby the user. Blocks that are tracked take much longer to load than blocks that arenot. For performance reasons you must not enable Data Availability entity typesbelow the BSC, BS, RNC.

Note: Data availability is not supported when a data block has been loaded withdifferent time intervals within the same period of time.

For example: Block B1 has been loaded from different lif files relating to the sametime period T1 to T2, but the lif files use different time intervals - 30-minutes60-minutes and 15-minutes. In such a case a data availability report on such ablock would provide inaccurate results.

Procedure1. Check which loaders are running by using the following command as user

virtuo:sap disp

2. Stop the appropriate loader by using the following command as user virtuo:sap stop <loader name>

3. Load the data availability XML by using the following command as uservirtuo:lcm_admin -load <data_availability.xml>

For example:lcm_admin -loaddataavailability_umts_siemens_utran_umr050_1.0.0.0.xml

4. Restart the loader as user virtuo :sap start <loader_name>

Merging of data availability blocks from XMLThe -merge option is used to add data availability blocks to any already loaded.

About this task

The -load option overwrites any previously loaded blocks and enables the loaderto start producing DA statistics for the blocks in the file passed to it. The -mergeoption will add any blocks not already having DA statistics loaded to the list ofexisting blocks, to produce DA statistics.

Procedure

To load data availability for a technology pack, enter the command:lcm_admin -merge <data_availability_xml_file>


Unload data sources and NC relationsInstructions on how to unload data sources and NC relations.

Unloading a data source to XML

About this task

The -unload option is used to save a loader data source to an XML file in itsoriginal format so that it can be modified and saved back to the database using the-load command. All data source parameters must be specified (apart from theXML file name) to unload a data source, including data source name, data sourceversion, the technology pack name and the technology pack version.

Procedure

As the virtuo user, enter the command:lcm_admin -unload [<datasource_xml_file>] -datasource<datasource_name> -dsversion <datasource_version>-techpack <techpack_name> -tpversion <techpack_version>

Where:[<datasource_xml_file>] is the name of the file to be created. The file can becreated with a relative or absolute file path. If a relative path is specified, it isrelative to the current working directory. Any existing file using the same file nameis overwritten. If the optional parameter [<datasource_xml_file>] is omitted thenfile naming uses a standard output.

Unloading a custom data source to XMLThe -unloadcustom option is used to save a custom loader data source to an XMLfile in its original format so that it can be modified and saved back to the databaseby using the -loadcustom command.

About this task

All data source parameters must be specified (apart from the XML file name) tounload a Datasource, including data source name, data source version, thetechnology pack name and the Technology Pack version.

Procedure

To unload a custom data source, as user virtuo, enter the command:lcm_admin -unloadcustom [<datasource_xml_file>] -datasource<datasource_name> -dsversion <datasource_version>-techpack <techpack_name> -tpversion <techpack_version>

Where:[<datasource_xml_file>] is the name of the file to be created. The file can becreated with a relative or absolute file path. If a relative path is specified, it isrelative to the current working directory. Any existing file using the same file nameshall be overwritten. If the optional parameter [<datasource_xml_file>] is omittedthen file naming can use a standard output.


Unloading NC relations to XMLThe -unload option is used to save an NC Relation entries in its original format toan XML file so that it can be modified and saved back to the database using the-load command.

About this task

The [<relations_xml_file>] parameter is optional. It is used to specify the nameof the file to be created. The file can be created with a relative or absolute file path.

If a relative path is specified, it is relative to the current working directory. Anyexisting file using the same file name shall be overwritten. If the optionalparameter [<relations_xml_file>] is omitted then file naming will use a standardoutput.

A combination of NC table and Source table can be used to retrieve NC Relationsentries.

Procedurev If the sourcetable option is not specified:

lcm_admin -unload [<relations_xml_file>] -relations -nctable<nc_tablename>

then all NC relations entries in the lc_relations table with the specified NCtable name will be unloaded.

v To unload any NC Relations entry for a specified NC table and Source table thefollowing command is used:lcm_admin -unload [<relations_xml_file>] -relations -nctable<nc_tablename> -sourcetable <source_tablename>

v To unload any NC Relations entry that has a specified NC table and a blankSource table the following command is used:lcm_admin -unload [<relations_xml_file>] -relations -nctable<nc_tablename> -sourcetable " "

Unloading data availability to XMLThe -unload option is used to unload a data availability file for a technology pack,in its original format so that the file can be modified and saved back to thedatabase by using the -load command.

About this task

All parameters must be specified to unload the file including the technology packname and the technology pack version.

Procedure

To unload a data availability XML file, as user virtuo, enter the command:lcm_admin -unload [<dataavailability_xml_file>] -dataavailability -techpack <techpack_name>-tpversion <techpack_version>

Where:<dataavailability_xml_file> is the name of the file to be created. The file can becreated with a relative or absolute file path. If a relative path is specified, it isrelative to the current working directory. Any existing file using the same file nameshall be overwritten. If the optional parameter [<dataavailability_xml_file>] is


omitted then file naming will use a standard output.

Delete data sources and NC relationsThe -delete option is used to delete a data source. You can not delete aDatasource that is associated with a Loader Configuration.

A data source can be deleted using two methods:v by specifying the data source name, data source version, technology pack name

and technology pack version of the data source to be deleted.v by specifying a data source XML file which will be parsed to obtain the data

source name, data source version, technology pack name and technology packversion of the data source to be deleted.

To delete a data source by specifying data source parameters:lcm_admin -delete -datasource <datasource_name> -dsversion<datasource_version> -techpack <techpack_name>-tpversion <techpack_version>

To delete a data source by specifying a data source XML file:lcm_admin -delete <datasource_xml_file>

Deleting NC relationsThe -delete option is used to delete an NC Relations entry.

An NC Relations entry can be deleted by using two methods:v by specifying a combination of the NC Relations NC table and Source table.v by specifying an NC Relations XML file which will be parsed to obtain the NC

Relations to be deleted.

To delete any NC relations entry that has an NC table and a specified Source tablethe following command is used:lcm_admin -delete -relations -nctable <nc_tablename>-sourcetable <source_tablename>

This will delete any NC Relations entry with the specified nctable andsourcetable combination.

To delete any NC Relations entry that has an NC table and a blank Source tablethe following command is used:lcm_admin -delete -relations -nctable <nc_tablename>-sourcetable " "

To delete a set of NC Relations entries by specifying an NC Relations XML file thefollowing command is used:lcm_admin -delete -relations <relations_xml_file>

This attempts to delete all NC Relations entries from the database that arespecified in the NC Relations XML file. If an NC Relations entry specified in theNC Relations XML file does not exist in the database an error is logged, and thelcm_admin tool continues to delete the remaining NC Relations entries that arespecified in the NC Relations XML file.


LCM port changeThe PROPERTYSERVICE_PROPERTY table contains a property name and value that isused by the lcm_admin tool.PROPERTY_NAME VALUEdomain localhost:8080

If the application server port ASHTTPPORT=8080 changes, then the new port valuemust be changed in the PROPERTYSERVICE_PROPERTY table to allow the LoaderConfiguration Manager to work correctly.

Use the following SQL to update the port value.export ORACLE_SID=vtdbsqlplus virtuo/<password>update PROPERTYSERVICE_PROPERTY set VALUE = ’localhost:<new portvalue>’ where PROPERTY_NAME=’domain’exitcommit;


Chapter 10. SBH administration

The Busy Hour feature provides a way of calculating the busiest hour of the dayfor a performance metric.

The Busy Hour feature reflects the peak demands on the network, for that metric,for each day.

This section describes:v “Stored Busy Hour (SBH) administration tool”v “Customizing Stored Busy Hour definitions” on page 177v “Stored Busy Hour calculation” on page 181

Stored Busy Hour (SBH) administration toolCapabilities of the Stored Busy Hour (SBH) administration tool.

Note: Do not run more than one of the following tools, or more that one instanceof any of these individual tools, at the same time: techpack_admin, sbh_admin,summary_admin, kpicache_admin, report_impexp. For example, do not runsummary_admin and sbh_admin, or two instances of summary_admin at the same time).

The sbh_admin (Stored Busy Hour Administration) tool helps you to:v Enable and disable SBH definitionsv Import SBH definitionsv Export SBH definitions and valuesv List SBH definitionsv Execute SBH definitionsv Delete SBH definitionsv Prioritize SBH processingv Turn on/off late data recalculation

Enable Busy Hour definitionsInstructions on how to enable Busy Hour definitions.

Usagesbh_admin -enable -n <name>

-n Specify the <name> of the Busy Hour(s) to enable.Wildcards are possible using the % character.

sbh_admin -enable -n SBH1

Enables the Stored Busy Hour definition SBH1.


Disable Busy Hour definitionsInstructions on how to disable Busy Hour definitions.

Usagesbh_admin -disable -n <name>

-n Specify the <name> of the Busy Hour(s) to disable.Wildcards are possible using the % character.

sbh_admin -disable -n SBH1

Disables the Stored Busy Hour definition SBH1.

Import Stored Busy Hour definitionsInstructions on how to import Stored Busy Hour definitions.

Stored busy hour definitions are imported by using XML files. See “CustomizingStored Busy Hour definitions” on page 177 for information on the content of thesefiles.

Usagesbh_admin -i (-f <file> | -p <directory>) -m (overwrite|ignore|fail)

-f Import the Stored Busy Hour Definition from <file >.-p Import all busy hour definitions stored in <directory>. Allfiles with an .xml suffix will be imported.

-m modeoverwrite If the definition already exists, update it.ignore If the definition already exists, do not update it and

do not fail the import.fail If the definition already exists, fail the import.

sbh_admin -i -f SBH1.xml -m overwrite

Import the Busy Hour is defined in SBH1.xml, overwriting the definition if italready exists.sbh_admin -i -p indir -m overwrite

If two files exist in indir (SBH1.xml and SBH2.xml).The definitions in SBH1.xml andSBH2.xml will be imported.

The data dictionary must be run in order to be able to access the stored busy hourKPI from the UI. This can be done manually using the agent_admin CLI tool. Forexample:agent_admin -u sysadm -p <password> -run <DataDictionaryid>

Export Stored Busy Hour definitions or valuesInstructions on how to export Stored Busy Hour definitions or values.

Usagesbh_admin -e -n <name> -t (definition|value) (-f <file> | -p <directory>)-scope <scope> -start <startDate> -end <endDate>

-n Specify the <name> of the Busy Hour to export. Wildcards arepossible using the % character

-t Export the definition or the value.-f Export the Stored Busy hour Definition(s) to <file>. Note, it

is possible to export more than one definition to a singlefile.

-p Export all busy hour definitions that match <name> to<directory>. The file names will be the name of the SBH.

-scope Export either daily, weekly or monthly values. Only applicable


when exporting values-start Export values that were calculated between <startDate> and

<endDate>-end Export values that were calculated between <startDate> and

<endDate>

The dates must be in the format dd/MM/yyIf these options are omitted the latest values will becalculated.

sbh_admin -e -n SBH1 -t definition -f SBH1.xml

Export the definition of SBH1 to the file SBH1.xml .sbh_admin -e -n SBH% -t definition -p outdir

Export all definitions that match SBH% to the directory outdir. If two definitionsexist (SBH1 SBH2), the files outdir/SBH1.xml and outdir/SBH2.xml will be created.sbh_admin -e -n SBH1 -t value -f SBH1.xml -scope daily -start 12/02/07 -end 15/02/07

Export the daily values of SBH1 calculated between 12/2/07 and 15/02/7 to thefile SBH1.xml.

List SBH definitionsInstructions on how to list SBH definitions.

Usagesbh_admin -l (-n name) (-detail) (-f <file>)

-n Specify the <name> of the Busy Hour to list. Wildcards arepossible using the % character. If this option is omittedthen all definitions will be listed.

-detail Print detailed information on the definition: If this optionis omitted then only the name and enabled/disabled will beprinted.

-f Print the information to a <file>. If omitted theinformation will be printed to the screen.

sbh_admin -l -n SBH1 -detail -f SBH1.log

Print detailed information on SBH1 to the file SBH1.xml .

Run SBH definitionsInstructions on how to run SBH definitions.

Usagesbh_admin -r -n <name> -f <file> -start <startDate> -end <endDate>

-n Specify the <name> of the Busy Hour(s) to execute. Wildcardsare possible using the % character

-f Print the results of the execution to <file>. If this optionis omitted then the results will be printed to the screen

-start Execute calculations between <startDate> and <endDate>-end Execute calculations between <startDate> and <endDate>

The dates must be in the format dd/MM/yyIf these options are omitted the latest values will becalculated.

sbh_admin -r -n SBH1

Run the Stored Busy Hour definition SBH1.

Chapter 10. SBH administration 175

Delete SBH definitionsInstructions on how to delete SBH definitions.

Usagesbh_admin -d -n <name>

-n Specify the <name> of the Busy Hour(s) to delete. Wildcards arepossible using the % character

sbh_admin -d -n SBH1

Delete the SBH definition SBH1.

Note: When a Stored Busy Hour definition is deleted the data for the SBH isretained in the system. If a deleted Stored Busy Hour definition is (re-)provisioned,the data calculated for the SBH will be available again. See the Installing TivoliNetcool Performance Manager - Wireless Component, for information on provisioningan SBH definition.

Prioritize SBHInstructions on how to prioritize SBH.

It is possible to prioritize the execution order of SBHs to ensure the most importantbusy hours can be processed first when scheduled jobs are run. The defaultpriority is 99, this is the lowest priority. The highest priority is 1.

Usagesbh_admin -s -n <name> -t priority -v <priority_value>

-n Specify the <name> of the Stored Busy Hour to prioritize. Wildcards arepossible using the % character

-v Priority value, 1-99

sbh_admin -s -n SBH1 -t priority -v 1

Sets the priority of the SBH definition SBH1 to 1.sbh_admin -s -n Cell% -t priority -v 1

Sets the priority of all SBH definitions beginning with Cell to 1.

Where a number of busy hours have the same priority they are executed accordingto busy hour name, in ascending order. For example, of two busy hours SBHA1and SBHB2 with the same priority, SBHA1 are run first.

Enable and disable calculation of late data for all Busy Hourdefinitions

Instructions on how to enable or disable calculation of late data for all Busy Hourdefinitions.

Usagesbh_admin -ld <enable|disable|individual>-ld Late data calculation may be enabled/disabled on a per

Busy Hour basis by setting the calculate-late-dataattribute.

enable/disable: The calculate-late-data attribute in all definitions isignored.individual: The calculation or not of late data is specified by thedefinition itself.


sbh_admin -ld enable

Enable the calculation of late data for all Busy Hour definitions.

By default, the SBH administration tool examines the data that is loaded withtimestamps up to 7 days old. To change the value of this property, run thefollowing command:$WMCROOT/bin/dbsysval_admin -update DA_LATE_DATA_LOOKBACK <number_of_days_for_lookback>

Note: If the data look back is set to a large number and there is incoming late datafor these days, the performance of the SBH administration tool is affected. Thesystem calculates the stored busy hours for all these days. Changes inDA_LATE_DATA_LOOKBACK property affect late data calculation for summarizer.Related reference:“Calculate-late-data tag” on page 231The Calculate-late-data summary definition XML tag.

Customizing Stored Busy Hour definitionsThis section describes customizing Stored Busy Hour (SBH) definitions.

You can customize an existing SBH definition by exporting and then re-importingthe definition, see “Export Stored Busy Hour definitions or values” on page 174 formore information.

Alternatively, the SBH's XML file can be edited before the being provisioned orimported.

Stored Busy Hour definitionAn example SBH XML file:

<busy-hour-definition-list><busy-hour-definition>

<name>Complex_Determiner_Complex_Values</name><focal-entity>Cell</focal-entity><determiner-type>max</determiner-type><busy-hour-determiner>

<entity>Cell</entity><field-name>Nokia.Packet_Control_Unit.sum_rlc_ul_traffic</field-name><tp-field-id>W1G2O3XAHK26SEC6000HW01QK4</tp-field-id>

</busy-hour-determiner><busy-hour-values>

<busy-hour-value><entity>Cell</entity><field-name>Nokia.Packet_Control_Unit.sum_rlc_ul_traffic</field-name><tp-field-id></tp-field-id>

</busy-hour-value><busy-hour-value>

<entity>BSC</entity><field-name>Nokia.TRX_Availability.ave_non_avail_due_int</field-name><tp-field-id></tp-field-id>

</busy-hour-value><busy-hour-value>

<entity>Cell</entity><field-name>ratio2_rl_traffic</field-name><tp-field-id></tp-field-id>

</busy-hour-value></busy-hour-values>

<rollup>false</rollup><override>pde</override>


<busy-hour-attributes><rank-count>1</rank-count><first-required>2007-11-01</first-required>

<busy-hour-calculation-type>nonsliding</busy-hour-calculation-type><disable>false</disable><calculate-late-data>true</calculate-late-data>

</busy-hour-attributes></busy-hour-definition>

</busy-hour-definition-list>

The following list describes the content of an SBH XML file:v <busy-hour-definition-list> - All stored busy hour definition files must start

with this tag, indicating that the contents are a set of stored busy hourdefinitions. This tag must occur only once.

v <busy-hour-definition> - Indicates the start of an individual definition.Multiple definitions can be included in a <busy-hour-definition-list>.

v <name>Complex_Determiner_Complex_Values</name> - The name of the storedbusy hour. Maximum of 60 characters.

v <focal-entity>Cell</focal-entity> - This value is the entity level at which thedeterminer is calculated. It must be the same or higher in the hierarchy as thedeterminer KPI's entity.

v <determiner-type>max</determiner-type> - Smallest or largest value to be usedfor the busy hour: min or max. If a value is omitted, the default max is used. maxuses the greatest value for the busy hour. min uses the smallest value for thebusy hour. For example, min is used where a KPI represents the percentage of achannel's availability - the busier the equipment the less percentage availabilitythere is.

v<busy-hour-determiner>

<entity>Cell</entity><field-name>Nokia.Packet_Control_Unit.sum_rlc_ul_traffic</field-name><tp-field-id>W1G2O3XAHK26SEC6000HW01QK4</tp-field-id></busy-hour-determiner>

This set of tags specifies which KPI is used to decide which hour of the day isthe busiest.– The <entity> tag contains the entity of the KPI being used.– The <field-name> tag contains the name of the KPI.– The <tp-field-id> tag contains the Universal Unique Identifier (UUID) of the

KPI. The UUID is not case-sensitive, but the case of the field name mustmatch that in the technology pack. Either field-name or tp-field-id can beleft blank provided the other is specified. The tags cannot be omitted, buteither can be empty.When the busy hour is calculated, the value and time stamp of this field arestored in the sbh_busy_hour_daily, sbh_busy_hour_weekly, andsbh_busy_hour_monthly tables.

v <busy-hour-values> - This tag contains the list of KPIs to use as the associatedvalues of the busy hour. When the busy hour is run, the determiner is calculatedfirst to get the busiest hour and then all the KPIs in the values list are calculatedat that hour.

v<busy-hour-value><entity>Cell</entity><field-name>ratio2_rl_traffic</field-name><tp-field-id></tp-field-id></busy-hour-value>


This set of tags is identical to the busy-hour-determiner. The values are stored inone of two ways: in TRAFFIC_xBH tables or in ENTITY_xBH tables. Peg KPIs thatare not being rolled up are stored in the busy hour equivalent of their traffictable. For each traffic table, the three busy hour tables, with the _TAB of thetraffic table that is replaced with _DBH, _WBH, and _MBH (for daily, weekly, andmonthly values). These tables are created by the system when the technologypacks are installed.PCalcs and UDCs are stored in entity busy hour tables. These tables are namedwith the entity name followed by _DBH, _WBH, and _MBH. These tables are createdwhen technology packs are installed, but contain the instance_id, entity_idcolumns, timestamp, and measurement_seconds.Columns are added to these tables when busy hours that contain PCalcs orUDCs are installed. Columns to store PCalcs are named with the UUID of theKPI. Columns to store UDCs are named with a conflated form of the UDC namethat is altered to suit column naming requirements. The mapping of field nameto column name is stored in the MANGLER table. Columns are added to the tablesuntil the configured limit is reached and a new table is created with the numberof the table added to the name. For example, CELL_DBH1, CELL_WBH1, CELL_MBH1...... _DBH2, and so on.

v <rollup>true</rollup> - The rollup tag specifies whether the associated valuesare rolled up to the focal entity. If false, KPIs are calculated and stored at theirown entity. If true, all associated values are rolled up to the focal entity andstored in the entity xBH tables of the focal entity. This includes Pegs, PCalcs, andUDCs. When Pegs are being rolled up, the columns in the entity busy hourtables are named by using the UUID of the KPI.This tag is optional and must contain true or false. If not present, it defaults tofalse.

v <override>pde</override> - The override tag specifies execution engine that isused to calculate SBH values. Typically, the execution engine that is useddepends on the value of pde.enable property from /appl/virtuo/conf/storedbusyhour/default.properties file. For example, if pde.enable=true, allSBHs are calculated by using pde. If pde.enable=false, all SBHs are calculatedby using repgen. Add the <override> tag in the SBH definition to overrides thevalue in the pde.enable property.

v <busy-hour-attributes> - This set of tags configures the busy hour. It is anoptional tag, but if it is included then all the attributes must be specified.

v <rank-count>1</rank-count> - The number of hours to calculate. For example, 3calculates the busiest 3 hours of the day and also all the associated values ateach of the 3 hours. This value must be a number from 1 - 24.

v <first-required>2007-11-01</first-required> - The earliest date that the busyhour attempts to be calculated. Any dates before this, whether they are specifiedmanually on the command line or automatically during an agent-invoked run, isignored. The date format is YYYY-MM-DD.

v <disable>false</disable> - whether the busy hour is active. Must be true orfalse.

v <busy-hour-calculation-type>nonsliding</busy-hour-calculation-type> - Bydefault, the value for this parameter is nonsliding. This parameter defineswhether the busy hour is sliding or not. It can be either sliding or nonsliding.Nonsliding means that the busy hour always aligned to hours, for example 14:00to 15:00 or 18:00 to 19:00. Sliding busy hours are calculated down to the intervalof the data, for example 14:15 to 15:15.

v <calculate-late-data>true</calculate-late-data> - If the system recalculatesa busy hour for a date on or before the most recently calculated busy hour. For


example, if yesterday is already been calculated, and more data for yesterday isreceived, that data is considered late data.

Overriding SBH execution engineYou can select SBH execution engine on individual SBH level. The override tagoverrides default execution engine from default.properties file and uses thevalue from SBH definition. For example, if pde.enable=false and the value ofoverride tag is <override>pde</override>, then SBH is calculated by using PDEengine.

About this task

The override tag is optional and must take pde/PDE or repgen/REPGEN as itsvalue. To override SBH execution engine, follow these steps:

Procedure1. Add override tag in SBH definition as follows:

</busy-hour-value></busy-hour-values><rollup>false</rollup><override>pde</override><busy-hour-attributes>

Note: The value in the override tag overrides the flag in pde.enable propertyin default.properties file. The default.properties file is located in/appl/virtuo/conf/storedbusyhour folder.

2. Import or overwrite this SBH definition by using the following commands:Import the SBH definition:sbh_admin -i -f /appl/<file.xml>

Overwrite the SBH definition:sbh_admin -i -f /appl/<file.xml> -m overwrite

Where <file.xml> is the Stored Busy Hour definition.

Improving the performance of PDE engineYou can choose to disable the rehoming events and ncUpdate events to improvethe PDE execution performance.

About this task

Set these flags in the default.properties file that is located in/appl/virtuo/conf/storedbusyhour.

Note: If you do not have these two properties in the file, the values are set tofalse. If you add the properties to the file, it improves the performance of theengine by switching these properties on and off.

Procedurev Disable calculation for rehoming to stop capturing the rehoming events by

setting this flag in default.properties file:com.ibm.tivoli.tnpmw.sbh.pde.isRehomingEventPresent=false

v Disable calculation for ncupdate to stop capturing the ncUpdate events bysetting this flag in default.properties file:


com.ibm.tivoli.tnpmw.sbh.pde.isNcUpdateEventPresent=false

Stored Busy Hour calculationStored Busy Hour value can be calculated on an entity equal, lower, or higher thanfocal entity. The Busy Hour Determiner entity must be same or lower than thefocal entity.

If you want to calculate the Stored Busy Hour value on an entity level higher thanfocal entity, there are some advantages that are as follows:v Supports the calculation of performance metrics or UDC based on the stored

busy hour value from higher entity level for the defined focal entity.v Provides Time to Value to customers who can pre-calculate the results and

minimize the work on report design. Relation between time scope from thedeterminer to the metric or UDC value can be done on the Tivoli CommonReporting design, but the values need not to be aggregated.

You can create a stored busy hour value that is higher than the focal entity but thebusy hour determiner entity must be same or lower than the focal entity. For moreinformation about Stored Busy Hour definition, see “Stored Busy Hour definition”on page 177. The calculation engine that is used in this scenario is the PDE Engine.This calculation affects the “Import Stored Busy Hour definitions” on page 174 and“Run SBH definitions” on page 175 operations alone.

Calculating the Stored Busy Hour value for a field entity levelhigher than focal entity

If you want to calculate the Stored Busy Hour value for an entity level higher thanfocal entity, you must follow the steps that are described here.

Procedurev Optional: Enable the PDE option as the calculation engine for Stored Busy Hour

calculation from the /appl/virtuo/conf/storedbusyhour/default.propertiesfile:# This option enables the PDE when performing# complex busy hour calculations (the repgen wont be used)com.ibm.tivoli.tnpmw.sbh.pde.enable=true

If you do not enable the PDE option and want to calculate the Stored Busy Hourvalue for an entity higher than the focal entity, then the application is forced touse the PDE Engine. You can see a log message in the $WMCROOT/logs/as/as-busyhour.log file as follows:pde is disabled but for the busy hour value entity higher than the focal entity condition,the pde engine is used.

Note: You see this message if you enable the DEBUG mode in$WMCROOT/as/server/default/conf/log4j.xml file.

v Set the rollup value to False in the Stored Busy Hour definition. If the roll upvalue is set to True, and you run the following import command in any mode:sbh_admin -i -f <file.xml> -m (overwrite|ignore|fail)

You receive the following error message:Failed to create the Stored Busy Hour definition <NAME>.Details An exception occurred - 'rollup' tag should be false in SBH definition [<NAME>]


v Ensure that the Busy Hour Determiner entity must be same or lower than thefocal entity. If the Busy Hour Determiner entity is higher than the focal entity.For example, focal entity is Common_Control_Channel and the busy hourdeterminer entity is Cell, and you run the following import command in anymode:sbh_admin -i -f <file.xml> -m (overwrite|ignore|fail)

You receive the following error message:Failed to create the Stored Busy Hour definition <NAME>.Details SBH determiner entity [Name:<entity_name> id:<n>]should not be greater than focal entity [Name:<entity_name> id:<n>]

v List the available Stored Busy Hour definitions by using the followingcommand:sbh_admin -l -n <NAME> -detail -f <NAME>.log

v Run the Stored Busy Hour definition by using the following command:sbh_admin -r -n <NAME>

Note: Currently, you cannot see the busy hour value for entities higher than theselected focal entity in the Tivoli Netcool Performance Manager Web client. Thereporting on the stored busy hour can be done by using common reporting onthe common pack that contains a busy hour definitions model. For moreinformation about creating a common pack with a busy hour definitions model,see the Installing and Using Tivoli Netcool Performance Manager - Application Studio.


Chapter 11. Alarm administration

Using the alarm administration tool and the external alarm API.

Alarm administration consists of:v The “Alarm administration tool”v The “External Alarm API” on page 188

Alarm administration toolThe alarm_admin tool enables alarm template and alarm definition XML files to beloaded into the database, unloaded to a file, updated or deleted.

Using the alarm_admin tool, you can:v List an alarm templatev Manage contextsv Export all alarm templates and definitions from one server and import to

another server

The Alarm Manager application requires that alarm templates be present in thedatabase in order for alarm definitions to be created; alarm definitions are basedon Alarm Templates. It is also possible to create alarm templates in the AlarmManager application. Before an alarm template can be created, it must have acontext.

For more information on the Alarm Manager see the Using Tivoli NetcoolPerformance Manager - Wireless Component .

Document contextsAll alarm templates (and alarm definitions) are organized into a tree-likehierarchical structure consisting of document contexts.

A context is a particular node in the tree, for example:+GSM Layer+----- GSM Alarm Template Layer 1+---------------------------- Congestion Alarms

All the elements shown above are nodes, the top-level node GSM Layer is referredto as the root node.

The same document context tree is used to logically organize alarm templates andalarm definitions.

Note: Before an alarm template can be created, it must have a context.


Alarm Template XML documentsAll Alarm templates created are identified uniquely by a context name, an alarmname and a version ID.

These fields are represented by XML tags in alarm template documents.

The <AlarmContext> tag specifies the full context path, which the document shouldbe assigned to, for example, “GSM.GSM Layer 1”.

The <AlarmName> tag specifies the name of the alarm, which corresponds to theX.733 Specific Problem field, for example,. “btsCongestion”.

The <VersionID> tag specifies the numerical version of the alarm template XMLdocument, for example 1.0, 1.1, 1.2, and so on.

Alarm Template xml documents loaded into the database must conform to theAlarm Template DTD.

Version numberingAlarm template XML documents must contain a version number that must containa fractional part represented as a whole number.

For example, 1.0, 2.0 and 3.0 are all valid version numbers whereas 1.1 is not.

This is to keep the versioning scheme in line with alarm definitions, which use thesame version numbering system.

Usage

Usage for alarm_admin:-h | -help | --help |

} | {-load -t|-d <alarm_template_or_definition_xml_file> |-load -t|-d -all <alarm_temp_def_files_directory> |-drop -context <context> -name <name> -version <version> |-unload -t|-d -context <context> -name <name> -version <version> -file <file> |-unload -t|-d -all <alarm_temp_def_files_directory> |-list |-createcontext <document_context_path> |-removecontext <document_context_path> [-r]}

Table 54. alarm_admin options

Option Description

-list Shows a summary of all loaded alarmtemplates.

-load <alarm_template_xml_file> Create or update a single template ordefinition from an XML file.

-load -t|-d -all<alarm_temp_def_files_directory>

Create or update all templates ordefinitions from a folder.

-drop -context <context> -name <name> -version<version>

Not currently supported. Requires thecontext, template name, and version.

-unload -t|-d -context <context> -name <name>-version <version> -file <file>

Unload a template or definition to afile.

-unload -t|-d -all<alarm_temp_def_files_directory>

Unload all templates or definitions toa folder.


Table 54. alarm_admin options (continued)

Option Description

-createcontext <document_context_path> Must be one or more path elementnames separated by "." For example,"IP Layer.IP Layer 1".

-removecontext <document_context_path> [-r] Must be one or more path elementnames separated by ".". For example,"IP Layer.IP Layer 1".

Exporting all alarm templates and definitions at a time

You can migrate all alarm templates and alarm definitions from one server toanother server by using the alarm_admin tool. Data source ID, report folder ID, andreport ID are used in alarm templates and alarm definition XML files. These IDscan be different in different servers. The IDs are updated with the IDs that exist inthe source server on the migrated environment also by using this tool.

Manage document contextsOptions for the management of document contexts.

The -createcontext option is used to create a new document context path whereeach node in the given path will be created as necessary.

The -removecontext option is used to remove either a single node of a contextpath, or the context path node and all its child nodes recursively (by using theoptional -r qualifier).

Because document contexts are created automatically as needed when loadingalarm templates into the database, this option should not be needed very often.However, document contexts may need to be set up to provide a particular treestructure, even though some nodes in the tree may not yet contain AlarmTemplates.

Note: If an alarm template is being created using the Alarm Manager tool, acontext must exist before the template can be created. See the Using Tivoli NetcoolPerformance Manager - Wireless Component, for information on the Alarm Manager.

Creating a document contextHow to create a document context.

About this task

Note: This option is not supported in this release of the product.

Procedure

The -createcontext option, creates all nodes in the document context pathspecified.

Example

The command:alarm_admin -createcontext One.Two.Three

Chapter 11. Alarm administration 185

Creates the nodes:OneOne.TwoOne.Two.Three

Nodes are created on an as required basis, so that any nodes in the context paththat currently exist are effectively ignored.

Removing a document contextThe -removecontext option.

About this task

This function might be needed for maintenance when certain context paths are notreferred to by any alarm templates and are therefore no longer needed.

Procedure

The -removecontext option, removes one or more context nodes in the givencontext path.

Removing a single context nodeIt is not possible to remove a context node that has children.

About this task

For a given context path only a childless node can be removed.

Example

For example, given that the context path One.Two.Three.Four.Five:alarm_admin -removecontext One.Two.Three.Four.Five

removes the last node (Five).

Removing a subcontext treeUsing the -removecontext option to remove a subcontext tree.

About this task

To remove a context node and its children:

Procedure

use the -removecontext option together with the -r flag. This removes the contextnode of the given context path and all of its children, it's children's children and soon recursively down the context tree.

Example

For a context One.Two.Three.Four.Five:alarm_admin -removecontext One.Two.Three -r

will remove the nodes:v One.Two.Three

and its child contexts


v One.Two.Three.Fourv One.Two.Three.Four.Five

with the following nodes remaining:v Onev One.Two

Note: When using the -r option the parent node must be specified, you cannotspecify a subset of the context. In the example above, specifying alarm_admin-removecontext Two.Three.Four.Five -r will return an error.

It is not possible to remove the specified document context path when there arealarm templates or Alarm Definitions that are stored under that context node orany of its children. This is true when removing a single context and also acomplete context subtree. In the latter case the specified context cannot be removedif it, or any of its child context nodes, contains any Alarm Templates.

Note: Alarm Definitions are organized in the same document context hierarchy asalarm templates.

List Alarm TemplatesThe -list option displays a list of all alarm templates in the database.

About this task

The -list option displays a list of all alarm templates in the database.

To list all alarm templates:

Procedure

Run the command:alarm_admin -list

Example

The following is a -list output example:

Alarm Template Summary[IP Tech Layer.IP Tech Layer 1.Congestion Alarms.btsCongestion]Version 3.0Version 2.0Version 1.0[IP Tech Layer.IP Tech Layer 1.Dropped Call Alarms.tchAvailability]Version 1.0


Alarm definition Mib fileThe metricaAlarmTrap.mib file can be extracted from Netcool_feature.zip file.

The Netcool_feature.zip file, which is available in the following location:

$WMCROOT/conf/netcool_rules.

External Alarm APIThe External Alarm API enables administrators to raise and clear alarms using acommand line tool and using PL-SQL.

It is also possible to configure and generate data availability alarms.

Alarms are viewed in the Alarm Viewer, see the Using Tivoli Netcool PerformanceManager - Wireless Component, for information on using the Alarm Viewer.

alarmapi_adminThe alarmapi_admin command line tool

Usagealarmapi_admin -d

Alarm Spool Daemon (usually run by sap).alarmapi_admin -e

Empty Alarm Spool.alarmapi_admin -da

Generate Data Availability alarms (usually run by cron).alarmapi_admin -g notification_id ev_source ev_type monitored_attribute \

managed_object_class managed_object_instance alarm_predicate probable_cause \specific_problem additional_text trend_indication report_idalarm_severity [event_time]Generate a specific alarm.

alarmapi_admin -rDisplay available report definitions with their report IDs.

Generate an alarmHow to generate an alarm.

About this task

To generate an alarm by using the command line:alarmapi_admin -g <notification_id> <ev_source> <ev_type> <monitored_attribute><managed_object_class> <managed_object_instance> <alarm_predicate> <probable_cause><specific_problem> <additional_text> <trend_indication> <report_id> <alarm_severity> [event_time]

To generate an alarm using PL-SQL:exec ALARMAPI.alarm(notification_id, ev_source,ev_type, monitored_attribute,managed_object_class, managed_object_instance, alarm_predicate, probable_cause, specific_problem,additional_text, trend_indication,report_id, alarm_severity,SYSDATE);

Where:

Table 55. Alarm API parameters

Parameter CLI format PL-SQL format Description Default

notification_id Integer INTEGER Alarm notificationId.

None.


Table 55. Alarm API parameters (continued)

Parameter CLI format PL-SQL format Description Default

ev_source String VARCHAR2(255) Event/Alarmsource.

None.

ev_type String VARCHAR2(255) Event type, see“Event types” onpage 195.

None.

monitored_attribute String NUMBER Attribute value thattriggered the alarm,for example 51.3.

None.

managed_object_class String VARCHAR2(255) Entity name, forexample cell.

None.

managed_object_instance String VARCHAR2(255) Entity instancename/local key, forexample 12345.

None.

alarm_predicate String VARCHAR2(255) Alarm predicate. None.

probable_cause String VARCHAR2(255) Probable alarmcause, see“Probable causes”on page 195.

None.

specific_problem String VARCHAR2(255) Specific alarmproblem.

None.

additional_text String VARCHAR2(255) Any additional text. None.

trend_indication String VARCHAR2(255) 'more severe'(raised) or 'lessSevere' (cleared),see “Trendindications” onpage 198.

None.

report_id Integer NUMBER Associated reportId, given usingalarmapi_admin -r .

None.

alarm_severity String VARCHAR2(255) Alarm severity, see“Severity” on page198.

None.

event_timeString:

v yyyyMMddHHmmss

DATE Optional. Alarmtime. When thealarm reflects anevent thathappened in thepast, this should beset to the eventtime. If notprovided, it isassumed to be thecurrent time.

Currenttime.

Command line example:alarmapi_admin -g 3 "Seizure Attempts" Environmental 0 Cell 10002 seizure_attemptsinformationMissing "Threshold Crossed" additional_text "more Severe" 1401 Major 20071231133153

PL-SQL example:


Procedure1. Ensure the alarm spool daemon is running, see “Empty alarm spool daemon,”

for instructions on starting/stopping the daemon.2. As user virtuo, run the following command:

exec ALARMAPI.alarm(3,’Test’,’Environmental’,123.456,’Cell’,’12346’, ’seizure attempts’,’informationMissing’,’Threshold crossed’, ’Some Additional Text’,’more Severe’,1401,’Major’, SYSDATE);

Note: Generating alarms from the command line can be slow. If many alarmsneed to be generated, it is recommended that they are batched using thePL-SQL alarming feature.

Clear an alarmAlarms can be cleared by using the CLEARED event type.

About this task

For example, to clear an alarm by using the command line:alarmapi_admin -g 3 "Seizure Attempts" Environmental 0 Cell 10002seizure_attempts informationMissing "Threshold Crossed" additional_text"less Severe" 1223 Cleared 20071231133153

Display a list of available reportsReports available for association with Tivoli Netcool Performance Manager alarmscan be listed.

Procedure

Enter the command:alarmapi_admin -r

The values listed are used to define the report_id parameter when generatingalarms from the command line and PL-SQL, and when configuring dataavailability alarms.

Note: Linking an alarm to a report Id makes it possible for users to openin-context reports directly from other supported applications.

Empty alarm spool daemonThe alarm spool daemon is a component of the PL-SQL alarm functionality.

It runs as a sap process and permanently polls the database for PL-SQL generatedalarms, forwarding PL-SQL generated alarms to the Tivoli Netcool PerformanceManager software. Interaction with the component is usually unnecessary.

If many alarms have been queued (in case of backlog for example), it is possible toempty the alarm spool of all its alarms.

To empty the alarm spool:1. Stop the daemon, as user virtuo :

sap stop asd

2. Empty the spool:alarmapi_admin -e

3. Re-start the daemon:


sap start asd

Raising alarm if same severity alarm occurs againNew alarms are not raised if the severity of the alarm does not change. Sometimes,it is useful to raise an alarm even if the severity does not change.

About this task

To see an alarm even if the severity does not change, set theraise.alarm.if.severity.is.same property to true in lc_load_config_propertiestable. By default, this parameter is set to false.

Data availability alarmsData availability alarms are raised when availability reaches a level below adefined level of availability.

A raised alarm is cleared when the level of availability returns to above thedefined level.

Data availability alarms are configured using the following tables:v DA_MONITOR

v DA_MONITOR_ENTITY

Several alarm monitors can be configured using the DA_MONITOR table. Each alarmmonitor can be configured to monitor a set of block/entity combinations using theDA_MONITOR_ENTITY table.

DA_MONITOR tableThe DA_MONITOR table description and parameters.

The following lists the tables's parameters. The system uses these parameters tofill-in the generated alarm if the computed availability is lower than the requiredthreshold.

Table 56. DA_MONITOR table

Name Description Null? Type

MONITOR_ID Unique Monitor ID. NOT NULL INTEGER

MIN_PERCENTThe minimumrequired dataavailabilitypercentage (0=0%,100=100%).

An alarm is raised ifdata availability islower than minimumrequired dataavailabilitypercentage value,and cleared if theavailability is equalto, or greater thanthis value.

NOT NULL NUMBER


Table 56. DA_MONITOR table (continued)


OBJECT_CLASS Entity name, forexample cell.

NOT NULL VARCHAR2(255)

OBJECT_INSTANCE Entity instance nameor local key, forexample, 12345.


PROBABLE_CAUSE Probable alarm cause,see “Probable causes”on page 195.


SEVERITY Alarm severity,“Severity” on page198.


ADDITIONAL_TEXT Any additional text. NOT NULL VARCHAR2(255)

NOTIFICATION_ID Alarm notificationID.

NOT NULL INTEGER

REPORT_ID Associated report ID. NOT NULL INTEGER

DELAY_MINUTES Delay in minutes fordata latency. Forexample, if data isusually loaded intothe database 1 hourafter the actual datatimestamp, 60 needsto be entered.

NOT NULL INTEGER

ENABLED 1 enables themonitor. Any othervalue will disable themonitor.

NOT NULL INTEGER

One row should be created for each alarm monitor.

Configure monitor

The following example uses SQL*Plus.1. Connect to the database and configure the monitor, for example:

sqlplus virtuo/<PASSWORD>@VTDB << ENDDELETE FROM DA_MONITOR_ENTITY;DELETE FROM DA_MONITOR;INSERT INTO DA_MONITOR( MONITOR_ID,MIN_PERCENT,OBJECT_CLASS,OBJECT_INSTANCE,PROBABLE_CAUSE,SEVERITY, ADDITIONAL_TEXT,NOTIFICATION_ID,REPORT_ID,DELAY_MINUTES,ENABLED)VALUES(1,50,’BS’,’Dublin’, ’informationMissing’,’Major’,’Base Station Dublin is probably down’,3,1223,0,1);COMMIT;END

DA_MONITOR_ENTITY tableThe DA_MONITOR_ENTITY table description and parameters.

The following lists the tables's parameters.


Table 57. DA_MONITOR_ENTITY table


MONITOR_ID Unique monitor IDdefined for themonitor.

NOT NULL INTEGER

BLOCK_ID The block id asdefined in theDA_BLOCKNAMES table.

NOT NULL INTEGER

ENTITY_NAME The entity name (forexample. Cell) of theentity to monitor asdefined in theWMN_ENTITY table.


LOCAL_KEY the unique identifier(for example,CELL_ID) of the entityto monitor. For agiven entity, theunique identifiercolumn can be foundunder the FDN_ATTRcolumn of theWMN_ENTITY table (it isusually <entity>_ID).


One row must be configured for each entity or block to monitor, for each alarmmonitor.

The entity name and local key parameters do not have to be the same as objectclass and object instance. Usually, a high-level object (such as a BSC) is configuredfor the alarm content, and a set of lower-level objects (such as cells) will beconfigured for the monitored blocks.

Several combinations of identical block Id, entity name and local key are supportedbut if each combination is unique.

Configure a monitor block

The following example uses SQL*Plus.1. Connect to the database and configure the monitor block, or set of monitor

blocks, for example:sqlplus virtuo/<PASSWORD>@VTDB << ENDDELETE FROM DA_MONITOR_ENTITY;INSERT INTO DA_MONITOR_ENTITY( MONITOR_ID,BLOCK_ID, ENTITY_NAME,LOCAL_KEY)VALUES (1,2,’Cell’,’12345’);INSERT INTO DA_MONITOR_ENTITY( MONITOR_ID,BLOCK_ID, ENTITY_NAME,LOCAL_KEY)VALUES (1,3,’Cell’,’12345’);INSERT INTO DA_MONITOR_ENTITY( MONITOR_ID,BLOCK_ID, ENTITY_NAME,LOCAL_KEY)VALUES (1,2,’BS’,’12345’);INSERT INTO DA_MONITOR_ENTITY( MONITOR_ID,BLOCK_ID, ENTITY_NAME,LOCAL_KEY)VALUES (1,2,’Cell’,’12346’);COMMIT;END


Generate data availability alarmsData availability alarms are raised and cleared automatically on an hourly basis.Data availability alarms are cleared when data availability returns to a value equalto or greater than that set by the MIN_PERCENT parameter.

Data availability alarms are normally executed using a cron job. By default, thiscron job processes data availability alarms every 15-minutes, from 14-minutespassed the hour.

The following is the default cron entry:14,29,44,59 * * * * /appl/virtuo/bin/alarmapi_admin -da

The entry can be changed.

Data availability alarms can also be generated manually. To manually generate adata availability alarm:alarmapi_admin -da

Monitor intervalFor each alarm monitor, the data availability alarm period is defined as:truncoffset(now)−1hour-delay,truncoffset(now)−delay

Where:v now - is the time the data availability alarm process starts at (defined in a cron

entry by default as at 14, 29, 44 and 59 minutes past the hour, each hour).v delay - is the DELAY_MINUTES value specified in the DA_MONITOR tablev offset - is the value of ibm.tivoli.tnpmw.alarms.alarmapi.da.intervalMinutes

It is possible to define a different offset by changing the value for the propertyibm.tivoli.tnpmw.alarms.alarmapi.da.intervalMinutes found inappl/virtuo/conf/alarm_external_api/alarmapi.properties .

The following table illustrates monitoring intervals given global offset settings,delays for each monitor and Data Availability alarm processor wake-up times:

The following table gives example monitoring intervals:

Table 58. Monitoring intervals

Offset (minutes) Delay (minutes) Wake-up Monitoring Interval

60 0 14:14 [13:00-14:00[

60 30 14:14 [12:30-13:30[

60 180 14:14 [10:00-11:00[

60 0 14:29 [13:00-14:00[

60 30 14:29 [12:30-13:30[

60 180 14:29 [10:00-11:00[

15 0 14:14 [13:00-14:00[

15 30 14:14 [12:30-13:30[

15 180 14:14 [10:00-11:00[

15 0 14:29 [13:15-14:15[

15 30 14:29 [12:45-13:45[


Table 58. Monitoring intervals (continued)

Offset (minutes) Delay (minutes) Wake-up Monitoring Interval

15 180 14:29 [10:15-11:15[

Log fileLog file location.

The log file for the Alarm API feature can be found at: /appl/virtuo/logs/alarmapi/alarmapi*.log

Parameter values - listsThe defined values for the available parameters.

A number parameters have a defined values, including:v “Event types”v “Probable causes”v “Trend indications” on page 198v “Severity” on page 198

Event typesThe list of possible values for event types.

Note: Tivoli Netcool Performance Manager may accept non-standard values, butalarms with non-standard values cannot be forwarded to SNMP recipients.

The alarm event types cannot be configured with any string. The following tablelists all the possible values for event types.

Table 59. Event Types

Event type

Communications

QualityOfService

ProcessingError

Equipment

Environmental

Probable causesThe list of possible values for probable_cause.

The alarm probable causes cannot be configured with any string. The followingtable lists all the possible values for probable_cause.

Table 60. Probable Causes

Probable cause Probable cause

adapterError lossOfRedundancy

airCompressorFailure lossOfSignal

airConditioningFailure lossOfSignalX733

airDryerFailure lossOfSynchronisation


Table 60. Probable Causes (continued)


aIS lowBatteryThreshold

antennaFailure lowCablePressure

applicationSubsystemFailture lowFuel

applicationSubsystemFailure lowHumidity

authenticationFailure lowTemperatue

backplaneFailure lowWater

bandwidthReduced materialSupplyExhausted

bandwidthReducedX733 memoryMismatch

batteryChargingFailure modulationFailure

batteryDischarging multiplexerProblem

batteryFailure multiplexerProblemX733

breachOfConfidentiality nEIdentifierDuplication

broadcastChannelFailure nonRepudiationFailure

cableTamper other

callEstablishmentError outOfCPUCycles

callSetUpFailure outOfHoursActivity

commercialPowerFailure outOfMemory

communicationsProtocolError outOfMemoryX733

communicationsSubsystemFailure outOfService

configurationOrCustomisationError outputDeviceError

configurationOrCustomizationError pathTraceMismatch

congestion payloadTypeMismatch

congestionX733 performanceDegraded

connectionEstablishmentError powerProblem

coolingFanFailure powerProblems

coolingSystemFailure powerSupplyFailure

corruptData pressureUnacceptable

coruptData proceduralError

cpuCyclesLimitExceeded processorProblem

databaseInconsistency processorProblems

dataSetOrModemError protectingResourceFailure

dataSetProblem protectionMechanismFailure

degradedSignal protectionPathFailure

degradedSignalX733 pumpFailure

delayedInformation pumpFailureX733

demodulationFailure queueSizeExceeded

denialOfService realTimeClockFailure

diskFailure receiveFailure

dteDceInterfaceError receiveFailureX733

duplicateInformation receiverFailure




enclosureDoorOpen receiverFailureX733

enclosureDoorOpenX733 rectifierFailure

engineFailure rectifierHighVoltage

equipmentIdentifierDuplication rectifierLowFVoltage

equipmentMalfunction reducedLoggingCapability

excessiveBER remoteAlarmInterface

excessiveErrorRate remoteNodeTransmissionError

excessiveResponseTime remoteNodeTransmissionErrorX733

excessiveRetransmissionRate replaceableUnitMissing

excessiveVibration replaceableUnitProblem

explosiveGas replaceableUnitTypeMismatch

externalEquipmentFailure resourceAtOrNearingCapacity

externalIFDeviceProblem responseTimeExcessive

externalPointFailure retransmissionRateExcessive

farEndReceiverFailure routingFailure

fileError sfwrDownloadFailure

fileErrorX733 sfwrEnvironmentProblem

fire signalLabelMismatch

fireDetected signalQualityEvaluationFailure

fireDetectorFailure smoke

flood softwareError

framingError softwareErrorX733

framingErrorX733 softwareProgramAbnormallyTerminated

frequencyHoppingFailure softwareProgramError

fuseFailure storageCapacityProblem

generatorFailure storageCapacityProblemX733

heatingVentCoolingSystemProblem synchronizationSourceMismatch

highHumidity systemResourcesOverload

highTemperature temperatureUnacceptable

highWind terminalProblem

humidityUnacceptable thresholdCrossed

iceBuildUp timeoutExpired

informationMissing timingProblem

informationModificationDetected timingProblemX733

informationOutOfSequence toxicGas

inputDeviceError toxicLeakDetected

inputOutputDeviceError tranceiverFailure

intrusionDetection transmissionError

invalidMessageReceived transmiterFailure

iODeviceError transmitFailure




keyExpired transmitFailureX733

lanError transmitterFailure

leakDetected trunkCardProblem

lineCardProblem unauthorizedAccessAttempt

localNodeTransmissionError unavailable

localNodeTransmissionErrorX733 underlayingResourceUnavailable

lossOfFrame underlyingResourceUnavailable

lossOfFrameX733 unexpectedInformation

lossOfMultiFrame ventilationsSystemFailure

lossOfPointer versionMismatch

lossOfRealTimel versionMismatchX733

Trend indicationsThe list of possible values for trend_indication.

The trend indications cannot be configured with any string. The following tablelists all the possible values for trend_indication.

Table 61. Trend Indications

Trend Indication

More Severe

Less Severe

No Change

SeverityThe list of possible values for alarm_severity.

The alarm severity cannot be configured with any string. The following table listsall the possible values for alarm_severity .

Table 62. Severity values

Severity

Cleared

Indeterminate

Critical

Major

Minor

Warning


Complex alarmerThe complex alarmer tool is an external tool that allows alarm generation withinTivoli Netcool Performance Manager for Wireless based on report results. Thecomplex alarmer relies on the existing alarm mechanism within Tivoli NetcoolPerformance Manager for Wireless in such a way that the generated complexalarms look similar to the standard alarms that are generated by Tivoli NetcoolPerformance Manager for Wireless.

You can view integrated and seamless alarms on the GUI. The supplementaryalarm-related functions, such as exporting alarm are applicable to the complexalarms.

The complex alarmer tool provides the necessary user configurations to setupconditions to trigger the alarms, and specify properties of the generated alarms.

Running the complex alarmerThe complex alarmer script name is report_alarm. The script is available in the/appl/virtuo/bin folder.

About this task

To run the script, you must supply two input arguments:v Tivoli Netcool Performance Manager for Wireless report results in CSV format.

Note: The report data interval must be either daily or hourly.v Complex alarmer configuration file

Procedure

Use the following command to run the script:report_alarm <report_results_CSV_file> <alarm_configuration_file>

v <report_results_CSV_file> is /reportresults/Cell_TCH_AlarmReport.csvv <alarm_configuration_file> is /appl/virtuo/conf/report_alarms/

sample_alarm.properties

Note: The content of the alarm_configuration_file must be as shown in “Mappingthe CSV report results column to alarm configuration file” on page 201. Save thefile as alarm_name.properties in /appl/virtuo/conf/report_alarms directory.

For example:$ cd /appl/virtuo/bin$ report_alarm /reportresults/Cell_TCH_AlarmReport.csv/appl/virtuo/conf/report_alarms/sample_alarm.properties

The output looks as follows:

Licensed Materials - Property of IBM

5724W86

(C) Copyright IBM Corp. 2012 All Rights Reserved.

Report complex alarming action executing. See extensions log file for operation information


You can check the generated alarms in the /appl/virtuo/logs/as/default/as-extensions.log file. The output looks as follows:

10:59:42,993 INFO [ReportToAlarmDriver] ReportAlarmDriver starting10:59:42,994 INFO [ReportToAlarmDriver] Virtuo home is /appl/virtuo10:59:42,994 INFO [ReportToAlarmDriver] generateAlarms()

load config from /appl/virtuo/ext/report_alarms/conf/cell_tch_alarm.properties10:59:49,746 INFO [ReportToAlarmDriver] generateAlarms()

parseReport: /appl/virtuo/ext/report_alarms/input/Cell_TCH_AlarmReport.csv10:59:49,781 INFO [ReportToAlarmDriver] generateAlarms() generating 1 alarms from 1 rows10:59:49,785 INFO [AlarmAPI] Generating 1 alarms10:59:49,814 INFO [AlarmAPI] Execute a batch of 10010:59:49,828 INFO [ReportToAlarmDriver] Severity Minor count: 110:59:49,828 INFO [ReportToAlarmDriver] ReportAlarmDriver complete

Results

You can view the generated alarms in the Alarm Viewer on Tivoli NetcoolPerformance Manager for Wireless system as shown in the figure:


Configuring the complex alarmerYou must perform these configuration tasks.

Mapping the CSV report results column to alarm configurationfileThe report result is in CSV format. Each column in a data row in the report resultis represented by an index number in the alarm configuration file. The indexnumber starts from 0 for the first column from the left and increments by 1 foreach subsequent column.

For example, if the report_results_CSV_file has just one data row as follows:"CELL.CELL_ID","T_HOUR","CELL.BSC_ID","_%_BLOCKING","_%_DROPPED_CALLS","_%_RF_LOSS","UTILISATION","TRAFFIC""Sample-Cell-0/1",2009-11-04 13,"BSC/0",.56,2.04,4.08,2.807,7.58

then:v {0} is the value of the first column: Sample-Cell-0/1v {1} is the value of the second column: 2009-11-04 13v {2} is the value of the third column: BSC/0v {3} is the value of the fourth column: 0.56

By using the indexing and the formatted strings, the alarm_configuration_file extractsdata from specific columns of the report_results_CSV_file. The result is then used foreither alarm evaluation or for display purpose. The {x} placeholder determines thecolumn from which data is extracted to be used by the alarm configuration.

Following example uses the sample alarm_configuration_file with the samereport_results_CSV_file example:EventType=CommunicationsEventSource=Cell_TCH_BlockingMonitoredAttribute={3}ManagedObjectClass=cellManagedObjectInstance={0}ProbableCause=communicationsProtocolErrorSpecificProblem=problem at {0}AdditionalText=Dropped Calls {4}%, RF Loss {5}%, Utilization {6}%Severity_Cleared=0.0-0.5,{3} < 0.5%Severity_Minor=0.5-0.75,{3} > 0.5%Severity_Major=0.75-1.5,{3} > 0.75%Severity_Critical=1.5-100,{3} > 1.5%EventTime={1}ReportName=#Users#sysadm#complex_alarm_reportLinkReport=False

The Managed Object Instance is taken from the first column (index {0}), which isSample-Cell-0/1. The AdditionalText field contains information about 3 KPIs fromthe report result, namely from columns 5, 6 and 7. The final AdditionalText fieldof the alarm is Dropped Calls 2.04%, RF Loss 4.08%, Utilization 2.807%.

Alarm configuration file propertiesThis table lists the fields that are configured in the alarm configuration file withtheir properties.

Use the sample alarm configuration file from “Mapping the CSV report resultscolumn to alarm configuration file,” if necessary.


Table 63. Alarm configuration file properties

Fields Description

EventType v Translates to EventType field in Alarm Viewer.

v Can be configured with any string.

v Use pre-determined standard event types.

MonitoredAttribute v Translates to MonitoredAttribute field in AlarmViewer.

v Column from report results to be used to evaluatewhether alarm is to be generated or not.

ManagedObjectClass v Translates to ObjectClass field in Alarm Viewer.

v Entity type of the instance that triggers the alarm.


v Set to class of the focal entity of the report results.

ManagedObjectInstance v Translates to ManagedObjectInstance field in AlarmViewer.

v Entity instance that triggers the alarm.


v Set to actual instance extracted from report results.Typically, this is the first column.

ProbableCause v Translates to ProbableCause field in Alarm Viewer.

v Must use pre-determined standard probable cause.

v See “Probable causes” on page 195

SpecificProblem v Translates to SpecificProblem field in Alarm Viewer.

v Specific problem that is indicated by the alarm.


AdditionalText v Translates to AdditionalText field in Alarm Viewer.

v Additional text for the generated alarm.

v If LinkReport is set to True, the AdditionalText isreplaced by a web link.

v See “Linking the alarm to a report” on page 204.


Severity_Cleared v Translates to Severity_Cleared field in Alarm Viewer.

v Condition for alarm of severity = CLEAR to begenerated.

v See “Managing severity evaluation” on page 203.

Severity_Minor v Translates to Severity_Minor field in Alarm Viewer.

v Condition for alarm of severity = MINOR to begenerated.


Severity_Major v Translates to Severity_Major field in Alarm Viewer.

v Condition for alarm of severity = MAJOR to begenerated.



Table 63. Alarm configuration file properties (continued)

Fields Description

Severity_Critical v Translates to Severity_Critical field in Alarm Viewer.

v Condition for alarm of severity = CRITICAL to begenerated.

v See “Managing severity evaluation.”

EventTime v Translates to EventTime field in Alarm Viewer.

v Event time of alarm generated.

v Typically, set to the timestamp column of the reportresult.

ReportName v Translates to ReportName field in Alarm Viewer.

v Name of report definition to link to the alarm.

v Used if LinkReport is set to True.

v See “Linking the alarm to a report” on page 204.

LinkReport v Translates to LinkReport field in Alarm Viewer.

v Flag to indicate whether the alarm is to be linked to areport.

v Set toTrue to link an alarm to a report.

v Otherwise, set to False.

EventSource v Viewable from the database table for administrationpurpose to track the source of the alarm.

v For complex alarm, the EventSource field is used togenerate a unique ID for the Notification Identifierfield. Notification Identifier is an identifier thatseparates the alarms. If you have two complex alarmsetups that monitor the same ManagedObjectClass andManagedObjectInstance, you can set a differentEventSource name to differentiate the two alarms via adifferent Notification Identifier. TheManagedObjectClass is the entity to monitor, forexample, Cell and the ManagedObjectInstance is thenetwork element name, for example, Sample-Cell-0/1.EventSource must be set to the represented reportname that the complex alarm is evaluating so that thealarm has a different Notification Identifier.

v The Notification Identifier field is displayed both inthe Alarm Viewer and alarm_alarmslog table in thedatabase.

autoClear True or False. Indicates whether to clear alarms based onmaxAge automatically or not. Set this field to True toenable auto-clear option based on maxAge for complexalarms.

maxAge Number of seconds after an alarm is last updated tokeep an alarm in the system after which it is clearedautomatically. This property is applicable only whenautoClear is set to True.

Managing severity evaluationThe complex alarmer configuration specifies the conditions to raise an alarm of aparticular severity. The MonitoredAttribute field in the alarm configuration fileindicates the column from the report results used for this evaluation.


The condition for each severity is defined separately in the alarm configuration fileand has the following format: <evaluation>, <display string>.

<evaluation>Defines the condition for the severity to be True.v Follows the format of a-b.v If the value of the monitored attributed is >= a and < b, then an alarm

with this severity is generated.v To specify a limitless upper boundary for the range, specify the lower

boundary, that is, set <evaluation> to a. This limit applies only to theCRITICAL severity predicate.

v Negative range is not supported.

<display string>Defines the string to be displayed in the Predicate field in Alarm Viewer.v Follows the format of {x} <comparator> <value>.v {x} is an index to a column in report results and typically would be set

to the monitored attribute.v <value> is the value with which {x} is compared.v <comparator> indicates the mathematical comparator between {x} and

<value>.v It is mandatory to define <display string>.

The following example details how to specify the conditions for alarm severity inthe alarm configuration file:Severity_Cleared=0.0-0.5,{3} < 0.5%Severity_Minor=0.5-0.75,{3} > 0.5%Severity_Major=0.75-1.5,{3} > 0.75%Severity_Critical=1.5-100,{3} > 1.5%

An alarm of any severity is generated in the following conditions:v The conditions for an alarm of any severity is defined in the alarm configuration

file.v The conditions for an alarm of any severity is set to True as specified in the

alarm configuration file.v An alarm is outstanding, that is, active for the same Managed Object Instance

and Event Source (notification identifier). Alarms are identified by the<ManagedObjectInstance>, <EventSource> pair. By using the previous alarmconfiguration file and report results sample, the alarm is identified asSample-Cell-0/1, Cell_TCH_Blocking

Note: If the value of MonitoredAtrribute falls within a range that is not specifiedby any of the severity conditions, the alarm is raised with a severity ofINDETERMINATE.

Linking the alarm to a reportThe complex alarmer module links a complex alarm to a particular report withinTivoli Netcool Performance Manager for Wireless.

About this task

To enable this functionality, follow these steps:


Procedurev Set the LinkReport alarm configuration field to True in the alarm configuration

file.v Set the ReportName alarm configuration field to the path and name of the report

definition file.For example:ReportName=#Users#sysadm#complex_alarm_ReportLinkReport=True

A web link is generated in the AdditionalText alarm field. The web link opens areport definition that defined in ReportName alarm configuration field.If LinkReport is set to True, the value that is specified by AdditionalText in thealarm configuration file is overridden by the generated web link.

Note:

What to do next

If the generated web link contains only the hostname and not the domain name inthe URL, then follow these steps to resolve the issue:1. Set the value of vallent.application.host.name in /appl/virtuo/conf/as/as-

default.properties file in this format:<hostname>.<domainname>

2. Restart the sap utilities.

Scheduling the reports for complex alarm generationAs part of the export functionality, the scheduled reports in Tivoli NetcoolPerformance Manager for Wireless can be configured to start a script every timeafter the report is run. The path and name of the report results is passed to thisscript. A report can be scheduled to be run and exported in CSV format, and ascript can then be started to run the complex alarm tool on the exported reportresults automatically.

About this task

To schedule a report for complex alarm generation, follow these steps:

Procedurev Create the generate_<alarm_name>_alarms.ksh script file in the following folder:

/appl/virtuo/admin/scheduler/scripts You can also find an example ofsample_generate_alarm.ksh in the same folder.The sample generate_<alarm_name>_alarms.ksh script is as follows:#!/bin/ksh# Log name of report to log fileexport DATE=`dateèxport LOG_FILE=/appl/virtuo/logs/report_alarms/alarm_script.log

folder=$(dirname $LOG_FILE);

if [ ! -d "$folder" ]; then

mkdir $folderecho "Logs folder $folder created."

fi

echo "$DATE Report: $1" > $LOG_FILE# Make a copy of the report


cp $1 /tmp#Get the base name of the file.export FILE_NAME=ècho $1 | xargs basename`# Run the complex alarm script on the report results using a specific alarm# configuration fileecho "Processing /tmp/$FILE_NAME" >> $LOG_FILE/appl/virtuo/bin/report_alarm /tmp/$FILE_NAME \/appl/virtuo/conf/report_alarms/sample_alarm.properties >> $LOG_FILE# Clean up the copy of the report resultsrm /tmp/$FILE_NAME

v Schedule a report to run and export the results in a CSV format. You mustperform the following tasks:1. After the generate_<alarm_name>_alarms.ksh script is created, schedule the

report to run hourly and the report output is passed tosample_generate_alarm.ksh this script. Export a scheduled report in CSVformat. For more information about how to export a scheduled report in CSVformat, see Exporting reports section in Using Tivoli Netcool PerformanceManager - Wireless Component.

2. Configure the scheduled report to start the sample_generate_alarm.kshscript. For more information about configuring a scheduled report, seeScheduling a report section in Using Tivoli Netcool Performance Manager -Wireless Component.

The script calls the report_alarm script on the exported report results thatare based on a particular alarm configuration file.

Note: To run multiple alarm configuration files for the same report results,call the complex alarm script multiple times from within the script by usinga different alarm configuration file each time. Ensure that thesample_generate_alarm.ksh script has appropriate file permissions. Forexample, chmod 755 sample_generate_alarm.ksh.

Date and Time formats for Event TimeDetails the date and time formats for the complex alarmer.

The complex alarmer supports four date time formats for the event time:v yyyy-MM-dd - Day granularity.

For example, 2012-03-20 12:00 (By default, the system displays 12:00 AM if theevent time from the report is in day granularity.)

v yyyy-MM-dd HH - Hour granularity.For example, 2012-03-20 15:00 (By default, the system displays 00 minutes if theevent time from the report is in hour granularity.)

v yyyy-MM-dd HH:mm - Minute granularity.For example, the system displays the event time as 2012-03-20 13:17

v yyyy-MM-dd HH:mm:ss - Second granularity.For example, the system displays the event time as 2012-03-20 14:25

Note: Since the Second granularity format is not supported in the web client,system does not display the event time in seconds, it display the time up tominutes only.)

For an alarm, you can view these details in the Event Time column through theAlarm Viewer.

Clearing an alarm automaticallyComplex Alarms can be cleared automatically starting from v1.4.3.


Before you begin

Make sure you have set the following properties in the <alarm_configuration_file>.For example, /appl/virtuo/conf/report_alarms/sample_alarm.propertiesv autoClear

v maxAge

For more information, see Alarm configuration file properties in Administering TivoliNetcool Performance Manager - Wireless Component.

Procedure

Run the $WMCROOT/bin/alarm_clear.sh script.Or, set a cronjob to run the $WMCROOT/bin/alarm_clear.sh script periodically.

TroubleshootingTroubleshooting complex alarmer.

Alarm floodingSymptomsAlarm processing adds extra load to the Tivoli Netcool Performance Manager forWireless system. It adds unnecessary extra load to the Tivoli Netcool PerformanceManager for Wireless system to the point where other components maybe affected.

Resolving the problemIt is important to monitor that the complex alarm setup does not trigger excessivenumber of alarms that causes alarm flooding on each run.

Data availabilitySymptomsThe execution of a complex alarm is effective if the reports have the necessarydata. The reports depend on data that is loaded into the system.

Resolving the problemTake into account the run time of the reports in relation to the time interval of thedata that is loaded into the system. For example, for an hourly data interval,running the scheduled report at 15 minutes is acceptable only if the previous hourdata loads within 15 minutes.

Adaptive alarmerThe adaptive alarmer tool is an extension of complex alarmer. It is a customizedOracle alarm package to enhance the existing Tivoli Netcool Performance Manager- Wireless component alarm solution that works with report engine and report API.

You can create three types of adaptive alarms with daily or hourly and you canexclude the weekend data by excluding Saturday and Sunday from the reportscheduler:v Trend alarmsv Derivative alarmsv Stability alarms

Note: Each alarm is configured with a configuration file. You require at least twoweeks of data to configure and trigger an daily alarm and two days of data if you


want to trigger an hourly alarm. When an adaptive alarm is triggered, it alwaysdisplays the current day in the Event Time on the Tivoli Netcool PerformanceManager web client.

Trend alarmThis alarm checks the current value of a KPI and compares it against the historicaltrend. Historical values are averaged over a user-defined period in the past andthen stored in the database as profiles.

Upper and lower thresholds are calculated for profiles. If the current KPI valuedeviates too far from the profile and violated the upper or lower threshold, then analarm is raised. You can calculate the profile thresholds by using the followingoptions:v Standard deviation

Standard deviation is used against the profile to determine upper and lowerthreshold. Deviation from profile can be adjusted by the user.

v Percentage offset from profile valuev Fixed offset from profile valuev Percentage offset from profile trendlinev Fixed offset from profile trendline

Alarm is raised at an hourly interval when the KPI value is below the lowerthreshold and above upper threshold.

Percentage or fixed value against the profile can be applied to calculate thethresholds as follows:

In the example, an alarm is raised at 12.00.Fixed:Upper = profile + FixedLower = profile - Fixed

Percent:Upper = profile + (percent * profile)Lower = profile - (percent * profile)

Percentage or fixed offset from profile trendline can be calculated as follows:


Fixed:Upper = trendline + FixedLower = trendline - Fixed

Percent:Upper = trendline + (percent * trendline)Lower = trendline - (percent * trendline)

Derivative alarmDerivative alarms calculate the latest gradient of the current day or week andcompare it with the profile gradient at the same timeline.

Historical values are averaged over a user-defined period in the past and thenstored in the database as profiles. If current network gradient is greater or lowerthan the historical gradient of the profile, then an alarm is raised. An illustration toshow how a derivative alarm works is as follows:

Profile Gradient: ap = yp/xpIf 'ac > ap' or 'ac < ap' then raise alarm


Stability alarmStability alarms are used to check how stable a network is by checking a numberof time periods for violations.

Alarms are raised if all time periods in a row concurrently violate the threshold,with stability enabled. With stability disabled, alarms are raised if number ofviolations equals to the number of hits that are needed to raise an alarm. Timeperiod can be any period within the monitoring range. You can define thethreshold, stability period, and monitoring period.

The available alarm options are as follows:v Stability enabledv Stability disabled

An illustration to show how a stability alarm works is as follows:

Point to consider:v All periods within the stability range n must violate the threshold for an alarm

to be raised.v Stability range n is 3 in this example. Therefore, all three periods must violate.v Since the criteria for number of hits is 3, it means that at least any 3 periods

within the monitoring range must violate the threshold for an alarm to beraised.

v Monitoring range must start from 1 until the current hour. If NoOfHoursToWait is13, you must have at least 13 hours of data for the alarm to trigger.

Using Adaptive alarmerSteps that are required to create and run adaptive alarm types by using thereport_alarm script.

Procedure1. “Creating an alarm report definition” on page 2112. “Creating and running the adaptive alarmer script” on page 2123. “Editing the alarm configuration file properties” on page 2134. “Creating and running the sample alarm properties configuration script” on

page 217


Creating an alarm report definitionTo run a report, you must first create a report definition. When you create a reportdefinition, you can use its defaults to quickly produce a report, or go beyond thedefaults to produce information that might better meet your needs. You can alsouse a report definition template to base your report definition on.

About this task

For more information, see Creating report definition from Using Tivoli NetcoolPerformance Manager - Wireless Component.

Procedure1. Log in to Tivoli Netcool Performance Manager web client.2. Click define report.3. Select the datasource from DataSource Selection.4. Select the Focal entity from Focal Entity Type and click next.5. Select the KPI from Field Selections and click next.6. In the Date Time Selection, select the time as needed. Follow these guidelines:

Hourly alarms

v Select the last 2 days and make sure that current day is not included.This is an internal requirement to make the alarm run in real timeevery hour.

v Add time range 0 - 24.v Select Relative as the report type.v Ignore Start of Week as this is an hourly alarm. Select all days.

Daily alarms

v Select the last 2 weeks and make sure that current week is notincluded. This is an internal requirement to make the alarm run inreal time every day.

v Add time range 0 - 24.v Select Relative as the report type.

5-day daily alarm

v Select the last 2 weeks and make sure that current week is notincluded. This is an internal requirement to make the alarm run inreal time every day.

v Add time range 0 - 24.v Select Relative as the report type.v Start of Week must be Sunday or Monday.v Select all 5 weekdays from Monday to Friday only, excluding

weekends.7. Click next.8. Select Hour if you want to generate an hourly report from the group by field

from Extended Functions.Or, select Day if you want to generate a daily report from the group by fieldfrom Extended Functions.

9. Click Save to complete the report definition.


Creating and running the adaptive alarmer scriptThe adaptive alarmer can be triggered from report_alarm command. Create aschedule to run the command.

Before you begin

Ensure that you created a report definition. See Create an alarm report definition.

About this task

The report_alarm command is available in the /appl/virtuo/bin folder. It isrecommended to call this command within the scheduled reports by calling thesample_adaptive_alarm.ksh script. The sample_adaptive_alarm.ksh is available in/appl/virtuo/admin/scheduler/scripts folder.

Important: You must run the sample_adaptive_alarm.ksh script for Trend andDerivative thresholds only and not needed for Stability thresholds.

Procedure1. Create the sample_adaptive_alarm.ksh script to run the adaptive alarmer by

using report_alarm command:#!/bin/ksh# Log name of report to log fileexport DATE=`dateèxport LOG_FILE=/appl/virtuo/logs/report_alarms/alarm_script.logfolder=$(dirname $LOG_FILE);if [ ! -d "$folder" ]; thenmkdir $folderecho "Logs folder $folder created."fiecho "$DATE Adaptive alarm Report: $1" > $LOG_FILE

# Run the adaptive alarm script on the report results using a specific alarmreport_alarm -n <report_name> -f <frequency(H/D)>

The report_alarm command requires two parameters; <report_name> and<frequency> in hour or day.

2. Schedule a report to run this script. See “Scheduling an alarm report”When the schedule is completed, sample_adaptive_alarm.ksh generates aprofile and saves it in CUSTOM_PROFILE_STORE table in the database.

Scheduling an alarm report:

Each time the alarm report runs, it runs script that is available in the selected .kshfile.

Procedure

1. Log in to Tivoli Netcool Performance Manager web client.2. Click Reporting > new schedule.3. Select the report that you created earlier from the list.

A New Schedule window opens.4. Specify the needed frequency to run the reports and also the days to exclude.5. In the Automatic Export of Report Results section, click Edit.6. Click the Database tab and select the Database Export check box.7. Click Apply.


8. In the Auto-Run External Application section, select the check box and selectthe .ksh file that you created earlier to schedule.For example, you can select the following files:v sample_adaptive_alarm.ksh

Select this file if you are scheduling to run the script to create the profile forthe alarm types.

v sample_alarm_properties.ksh

Select this file if you are scheduling to run the script to configure the sampleproperties files for the alarm types.

9. Click save schedule.

Editing the alarm configuration file propertiesThere are three sample properties files.

Enter the specific values for these parameters for each of the alarm properties files.

Sample properties file for trend alarm

The sample properties file is available in /appl/virtuo/conf/report_alarms/sample_trend_alarm.properties. The contents are asfollows:ReportName=adaptive_alarm_reportManagedObjectClass=TRXProbableCause=communicationsProtocolErrorAggregateType=HThresholdCalculationMethod=2SeverityClearedUpper=10SeverityClearedLower=1SeverityMinorUpper=20SeverityMinorLower=10SeverityMajorUpper=50SeverityMajorLower=20SeverityCriticalUpper=100SeverityCriticalLower=50UseTrendline=1WeekType=7StartOfWeek=SundayAlarmType=1

Description of the parameters is as follows:


ReportName Name of the report that you created earlier.

ManagedObjectClass Translates to ObjectClass field in AlarmViewer.

<Enity_Name>

ProbableCause <Probable cause text>

It translates to ProbableCause field in AlarmViewer. It is case-sensitive and if this valueis not given, an alarm is not triggered onTivoli Netcool/OMNIbus Web GUI.

AggregateType v H = hourly

v D = daily



SeverityClearedUpper (Optional) Cleared Alarm is raised if valuein report is greater than theSeverityClearedUpper.

SeverityClearedLower (Optional) Cleared Alarm is raised if valuein report is lower than theSeverityClearedLower.

SeverityMinorUpper (Optional) Minor Alarm is raised if value inreport is greater than theSeverityMinorUpper.

SeverityMinorLower (Optional) Minor Alarm is raised if value inreport is lower than theSeverityMinorLower.

SeverityMajorUpper (Optional) Major Alarm is raised if value inreport is greater than theSeverityMajorUpper.

SeverityMajorLower (Optional) Major Alarm is raised if value inreport is lower than the SeverityMajorLower.

SeverityCriticalUpper (Optional) Critical Alarm is raised if value inreport is greater than theSeverityCriticalUpper.

SeverityCriticalLower (Optional) Critical Alarm is raised if value inreport is lower than theSeverityCriticalLower.

UseTrendline v 1 = All comparison is using the profiletrendline value

v 0 = All comparison is using the profilevalue

WeekType v 5 = daily report that excludes last 2 daysof the week.

v 7 = daily report that includes whole week.

StartOfWeek v Monday - indicates that Monday is thefirst day of the week

v Sunday - indicates that Sunday is the firstday of the week

AlarmType 1- represents trend alarm.

ThresholdCalculationMethod Specify the following values for thecalculation method in trend alarms:

v 1 - Standard deviation

v 2 - Percentage

v 3 - Fixed

Sample properties file for derivative alarm

The sample properties file is available in /appl/virtuo/conf/report_alarms/sample_derivative_alarm.properties. The contents are asfollows:ReportName=adaptive_alarm_reportManagedObjectClass=TRXProbableCause=ThresholdCrossedAlarmSeverity=3AggregateType=H


ThresholdType=UWeekType=7StartOfWeek=SundayAlarmType=2NoOfHoursToWait=2NoOfDaysToWait=2



ReportName Name of the parameter that you createdearlier.


<Enity_Name>



AlarmType 2 - represents derivative alarm.

AlarmSeverity v 0 - Cleared

v 1 - Minor

v 2 - Major

v 3 - Critical

Note: If a value other than 0 to 3 isspecified in properties file, it triggers amajor alarm.


v D = daily

ThresholdType v U - represents upper bound

v L - represents lower bound

NoOfHoursToWait (Optional) The alarm waits until the hoursspecified in NoOfHoursToWait have passedin a day before the derivative is calculated,and then updates every hour.

NoOfDaysToWait (Optional) The alarm waits until the daysspecified in NoOfDaysToWait have passed ina week before the derivative is calculated,and then updates every day.





Sample properties file for stability alarm


The sample properties file is available in /appl/virtuo/conf/report_alarms/sample_stability_alarm.properties. The contents are asfollows:ReportName=adaptive_alarm_reportManagedObjectClass=TRXProbableCause=ThresholdCrossedAlarmType=3AlarmSeverity=4AggregateType=HThresholdType=UThresholdValue=30NumberOfHits=1StabilityActive=1MonitoringPeriod=1WeekType=7StartOfWeek=Sunday



ReportName Name of the parameter that you createdearlier.


<Enity_Name>



AlarmType 3 - represents stability alarm.

AlarmSeverity v 0 - Cleared

v 1 - Minor

v 2 - Major

v 3 - Critical

Note: If a value other than 0 to 3 isspecified in properties file, it triggers amajor alarm.


v D = daily

ThresholdType v U - represents upper bound

v L - represents lower bound

ThresholdValue Any number more than 0. Represents thethreshold values.

NumberOfHits Any number more than 0. Representsnumber of hits of point that reached thethreshold.



StabilityActive v 0 - disable stability.

If monitoring period = 1 and number ofhits = 1, then it checks only the last hourfor a violation.

If monitoring period = 2, then it checksthe last two hours for a violation. Oneviolation causes an alarm to be raised.Check the configuration file instructionsfor more information.

v 1- enable.

– If number of hits = 1, then it checksonly the last hour for violation.

– If number of hits = 2, then it checks thelast two hours for violations. Bothhours must violate for an alarm to beraised.

MonitoringPeriod Any number more than 0. Represents theperiod to be monitored.





Creating and running the sample alarm properties configuration script:

Run the sample properties files to configure the various alarms by using the kshscript.

Procedure

v Create the sample_alarm_properties.ksh file to configure the specific type ofalarm in the following directory:/appl/virtuo/admin/scheduler/scripts#!/bin/ksh# Log name of report to log fileexport DATE=`dateèxport LOG_FILE=/appl/virtuo/logs/report_alarms/alarm_script.logfolder=$(dirname $LOG_FILE);if [ ! -d "$folder" ]; thenmkdir $folderecho "Logs folder $folder created."fiecho "$DATE Adaptive alarm Report: $1" > $LOG_FILE

# Run the adaptive alarm script on the report results using a specific alarm# configuration file. Please change the sample properties to a correct file./appl/virtuo/bin/report_alarm -d/appl/virtuo/conf/report_alarms/sample<alarm_type>_alarm.properties>> $LOG_FILE

v Modify this script for each of the alarm types by replacing the name of thealarm in <alarm_type> variable.

v Schedule a report to run the script. See “Scheduling an alarm report” on page212.


Troubleshooting adaptive alarmerTroubleshooting issues that are related to adaptive alarmer.

About this taskv You can check and monitor the generated alarms and their log messages in the

/appl/virtuo/logs/as/default/as-extensions.log file and custom_alarm_logtable.

v You might see the following errors:– If you are grouping hourly on daily report, then you see the error as:

Incorrect Grouping selected for Alarm report <report_name>.For daily Alarm Reports select summary kpis and group by "Day" only. Process aborted.

– If required amount of data is not present, you see error as:Report not set within required monitoring period for Hourly Alarm Report <report_name>.Only 2 days of results including current day must exist.Check Report Definition Settings and try again. Process aborted.

– If profile value is not calculated for any report, you see error as:No data to process. Run Alarm Report <report_name> and try again.Performing Cleanup.

– If report result is not calculated, you see the error as:Report does not exist.Check your configuration settings. Re-run Alarm Report and try again.

Missing alarm type in the scriptSpecify the name of the alarm for which you are configuring the alarm propertiesfile when you are working with adaptive alarms.

SymptomsIf the alarm type is not specified in the sample properties file that is provided as aparameter to the report_alarm script, you might encounter the following message:Report complex alarming action executing. See extensions log file for operation informationException in thread "main" java.lang.NullPointerExceptionat com.ibm.virtuo.admin.complexalarms.alarms.reporting.ReportToAlarmDriver.generateAdaptiveAlarms(ReportToAlarmDriver.java:170)at com.ibm.virtuo.admin.complexalarms.alarms.reporting.ReportToAlarmDriver.run(ReportToAlarmDriver.java:108)at com.ibm.virtuo.admin.complexalarms.alarms.reporting.ReportToAlarmDriver.main(ReportToAlarmDriver.java:81

Resolving the problemTo resolve this issue, specify the correct value for the <alarm_type> parameter whenyou run the script.

Related tasks

“Creating and running the sample alarm properties configuration script” onpage 217Run the sample properties files to configure the various alarms by using theksh script.

Discrepancy in the display of adaptive alarms on the AlarmViewer and Active Event List (AEL)The alarms that are displayed on Alarm Viewer and AEL are different.

SymptomsIf there are three alarms that are displayed on Alarm Viewer for three KPIs thatbelong to a single entity, on the AEL you might see a single alarm with a count ofthree. One of the three KPI names is displayed for the single alarm that is


triggered on AEL.



Chapter 12. The summarizer and summary administration

The summary_admin tool is used for creating, deleting, running, and exportingsummary definitions, as well as setting the number of summary engine instancesthat can run concurrently.

Often there is a need to reuse data collected for a particular period multiple times,for example, a whole day's, week's or month's worth of data. Traffic dataaggregated over predefined time intervals (raw, hour, day, week, month) can bestored in the database for later use as normal KPIs.

This aggregated data is called summary data and the process of collecting this datais called summarization. The summarization process is run once a day.

Note: Do not run more than one of the following tools, or more that one instanceof any of these individual tools, at the same time: techpack_admin, sbh_admin,summary_admin, kpicache_admin or report_impexp. For example, do not runsummary_admin and sbh_admin, or two instances of summary_admin at the same time).

Note: Do not run concurrent summary reports, such as user-defined calculationsummaries. It is recommended that summary reports instead are run sequentially.Running summary reports concurrently will have a significant performance impacton Tivoli Netcool Performance Manager database resources.

SummarizerA description of the features supported by the Summarizer component and thesummarization process.

The Summarizer component and the summarization process supports thefollowing:v Processing of summaries can be switched on and off. If summaries are switched

on they will run if they are switched off they will not run.v A Summary log file is written to the appserver log file directory in

$WMCROOT/logs/as/default . This is a log for summaries ran by the scheduler.v The start day of the week can be set. The start day of the week can vary

depending on the geographical location. The summary process allows you to setthe start day of the week to the day the user requires.

v The summarizer will summarize old loaded data automatically. When thesummarizer process is started it detects whether old loaded data is loaded intothe system. Data is defined as old loaded data if it is older than 1 day.If the old loaded data has already being summarized then it will bere-summarized and the old summary data is deleted and the new summary datais populated in the summary table. If the old loaded data is older than 1 weekor 1 month it will cause weekly and monthly summaries to be re-calculatedrespectively.


Switching the summary process on or offSwitching the summaries on or off is done by setting a value in thewm_system_values_v view.

About this task

The agent_admin tool runs the summary process but the summary process detectswhether it is to process summaries or exit.

See See Agent Maintenance, for information about the agent_admin tool.

Procedure

Processing of summaries can be switched on or off by setting the ProcessSummaryvalue in the wm_system_values_v view to either true or false. To view what theProcessSummary value is set to, log on to sqlplus, and run the following SQLstatement.SELECT * FROM wm_system_values_v WHERE name = ’ProcessSummary’;

If the value is set to true, summaries will be run, if set to false summaries will notbe run. To change the value for ProcessSummary run the following SQL statement.UPDATE wm_system_values_v set value = ’TRUE’WHERE name = ’ProcessSummary’;Commit;

Summary log fileAn overview of the summary log file.

A Summary log file is written to the appserver log file directory in$WMCROOT/logs/as/default . This is a log for summaries ran by the scheduler, thename of the log file is as-summary.log.

Note: The log file for summaries ran by the summary_admin CLI tool is located in:$WMCROOT/logs/summariser/summariser-server.log.

The information contained in the log file depends on the DEBUG level set for theapplication. Information can include:v Details on whether the summary process is switched on or off.v The start time for the summary process.v Details on summaries that have run in the past including how many rows were

processed by the summary.v The end time for the summary process.

The following example information is typical of information contained in theas-summary.log file.

10:09:17,431 INFO [summary.NewDataHandler] (Thread-123) Summary execution is switched on.10:09:17,529 INFO [summary.NewDataHandler] (Thread-123) Summary engine execution has started

at Thu Feb 15 10:09:17 GMT 200710:09:29,436 INFO [summary.SummaryQueryBuilder] (Thread-123) 0 rows were stored in table

VNL_CELL_SDCCH_DSM for dates between Tue Feb 13 00:00:00 GMT 2007 and Wed Feb 1423:59:59 GMT 200710:09:37,595 INFO [summary.SummaryQueryBuilder] (Thread-123) 100 rows were stored in table

VNL_CELL_HO_CAUSE_DSM for dates between Tue Feb 13 00:00:00 GMT 2007 and Wed Feb14 23:59:59 GMT 200710:10:11,326 INFO [summary.SummaryQueryBuilder] (Thread-123) 200 rows were stored in table


VNL_CELL_HANDVR_RSLT_DSM for dates between Tue Feb 13 00:00:00 GMT 2007 and Wed

etc .....

10:32:28,194 INFO [summary.NewDataHandler] (Thread-39) Summary engineexecution has completed at Thu Feb 13 11:32:28 GMT 2007

Information for summaries can also be found in the summary_history table:describe summary_history;Name Null Type------------------------------ ------------------------------------------------------------------------SUMMARY_HISTORY_ID NOT NULL NUMBERSUMMARY_ID NOT NULL NUMBERSUMMARY_INTERVAL CHAR(1)FIRST_AVAIL DATELAST_AVAIL DATELAST_RUN_START DATELAST_RUN_END DATELAST_RUN_RESULT NUMBER(6)LAST_RUN_TEXT VARCHAR2(200)LAST_SUCCESSFUL_RUN DATE

Start day of weekThe start day of the week can vary depending on where in the world you arelocated, the summary process allows you to set what day of the week the userwants to use as the start of the week.

To view what the start day of the week is set to, log on to SQLPLUS and run thefollowing SQL statement:SELECT * FROM wm_system_values_v WHERE name = ’StartOfWeek’;

The following list details what value determines what day of the week.SUNDAY 7MONDAY 1TUESDAY 2WEDNESDAY 3THURSDAY 4FRIDAY 5SATURDAY 6

The start of the week must be set when the system is installed and should not bealtered afterwards, to set the value for StartOfWeek, issue the following commandby using SQLPLUS:UPDATE wm_system_values_v SET value = ’1’ WHERE name = ’StartOfWeek’;COMMIT;

Summary grace periodThe summary service is normally scheduled to run every night, so when the dayhas finished (rolled over) the service will wait a certain amount of time (the graceperiod) before you run all the summaries.

This is to give the system time to collect all the necessary data from its data feeds.For example, if the summary service is scheduled to run at midnight (00:00), itwould actually run at 02:00, if the grace is set to 2.

This value can be found in:/appl/virtuo/conf/summaryservice/default.properties

Chapter 12. The summarizer and summary administration 223

and can be changed by setting the attribute:com.vallent.pm.summaryservice.core.engine.

The default is 2. The values supported are 0 to 23.

Summarize old loaded dataThe summarizer will summarize or re-summarize old loaded data automaticallyfor Daily, Weekly, or Monthly data only.

Raw or Hourly data is not summarized by the summarizer. When the summarizerprocess is started, it detects if old loaded data is loaded onto the system. daily,weekly, or monthly data is determined to be old loaded data if it is older than 1day old. If the old loaded data has already being summarized then it will bere-summarized. The old summary data is deleted and the new summary data ispopulated in the summary table.

If the old loaded data is older than 1 week or 1 month it will cause weekly andmonthly summaries to be re-calculated respectively.

Summarizing old loaded data can be turned off, see “Calculate-late-data tag” onpage 231.

summary_admin CLIThe summary_admin CLI tool is a ksh shell script located in the $WMCROOT/bindirectory, and is used primarily to run one-off summaries.

You use the summary_admin CLI tool to create (provision), export, delete, run,disable, or enable summary definitions. In addition, you can set the number ofsummary engine instances that can run concurrently.

Provision a summaryThe create options allow the user to create a summary definition.

You can create a summary definition in one of two ways:v using parametersv using an XML file

Only simple summary definitions can be created using the parameters option,whereas both simple and complex definitions can be created using the XML option.

Note: Both options are mutually exclusive.

Create a summary using parametersUsing the summary_admin cli command to create a summary using parameters.Usage: summary_admin -c -source <source_table|UDC> ( [-ir] [-sir] [-fr][-ts] [- ignoreaggr] [-entity] [-udc] )

-c Mandatory. Use this switch to create a summary.-source <source_table_name|UDC>

Mandatory. Specify the source for the summary to be atraffic table, or all UDCs on system.[-ir <raw|hourly|daily|weekly|monthly>]Specify what intervals to create for the summary;raw, hourly, daily, weekly, or monthly.If the source is traffic table then daily, weeklyand monthly intervals are created by default.


If the source is UDC then raw and hourly intervalsare created by default.[-sir <daily|raw>]

Optional. The interval of an existing source summary table.[-fr <DD-MM-YYYY>]

Optional. The date that the summary is to run from.[-ts <tablespace name>]

Optional. An existing tablespace in which the summary willbe created.[-ignoreaggr <yes|no>]

Optional. Ignore the average of average check.[-entity <entity_level>]

Optional. The entity level from which to create a UDC summary.[-udc <udc_name>]

Optional. A UDC to add to an existing summary.

v The –ir option is used to identify the type of summary to create, while the –siroption is used to identify the type of summary that will be used as a source forthe summary creation. By default, the source (-sir) is ‘raw’ performance tables.

v The -sir option is to be used in cases where the user wants to create a summarybased on an existing summary, i.e. create a weekly or monthly summary basedon a daily summary. The -sir and –ir options are used in conjunction.

v The use of the –ir option does not require the use of the -sir option, as thisoption defaults to ‘raw’.

v It is not permissible to create a monthly summary based on a weekly summary.

Create a summary using an XML fileUsing the summary_admin cli command to create a summary using an xml file.Usage: summary_admin -c –f <filename> [-ignoreaggr <yes|no>]

-c Mandatory. Use this switch used to create a summary.-f <filename> Mandatory. The filename and path of an XML file to

use for creating the summary.[-ignoreaggr <yes|no>] Ignore the average of average check.

The following is an example of how to provision a summary using an xml file:summary_admin –c –f /appl/virtuo/import/filename.xml

By default summary definition provisioning during technology pack installation isswitched off. If summary definition provisioning during technology packinstallation is required then the following property must be set to true:vallent.vmm.techpack.provision.summaries

This property is found in:/appl/virtuo/conf/vmm/default.properties

See the Tivoli Netcool Performance Manager: Installation Guide - Wireless Component,for information on technology pack installation and provisioning summarydefinitions.


Delete a summary definitionUsing the summary_admin cli command to delete a summary.

About this taskUsage: summary_admin –delete <summary_name> [-ir] [-udc]

-delete <summary_name> Mandatory. The name of a summary to delete.[-ir <raw|hourly|daily|weekly|monthly>]

Optional. The interval of a summary to delete.If no interval is specified then all intervalsare deleted.

[-udc <udc_name>]Optional: A UDC to delete from an existingsummary.

Note: If the optional interval switch is omitted, then all three summaries (daily,weekly, monthly) will be deleted from the system.

Run a provisioned summaryUsing the summary_admin cli command to run a provisioned summary.

About this taskUsage: summary_admin -r <summary_name> [-ir] -fr -er | -previous

-r <summary_name> Mandatory. Use this switch and the summary nameto run a summary.

[-ir <raw|hourly|daily|weekly|monthly>]The summary interval. mandatory for raw and hourlyintervals, optional otherwise.If no interval is specified, then daily, weekly,and monthly intervals are run.

-fr <DD-MM-YYYY> Start date for the summary.-er <DD-MM-YYYY> End date for the summary.-previous Optional. Runs the summary for the previous

complete period.

Procedurev To run a raw or hourly summary, you must specify the start and end date in the

format dd-mm-yyyy hh:mm , for example 31-07-2011 00:00. To run a daily, weekly,or monthly summary, you can specify the start and end times in the formatdd-mm-yyyy , for example 31-07-2011 .

Note: To run a raw or hourly summary for formula storage, do not use thescheduler.

v If the optional interval switch is omitted then the default response of thesummary service is to execute the daily, weekly, and monthly summaries of thespecified summary.

v To run a particular summary for a particular time period, all switch optionsmust be used: interval, start date, and end date. However, to run the daily,weekly, and monthly summaries for a particular summary definition then omitthe -ir (interval required) option, and specify the start -fr and end -er dates.

v If a weekly summary is run that uses start and end dates that span two weeks(for example, assuming today's date as 10-Sept-07 and fr = 9-AUG-07 er =16-AUG-07), then the default action of the summary service will be to run twosummaries, one for the full week containing the start date (5-AUG-07 to11-AUG-07), and another for the full week containing the end date (12-AUG-07to 18-AUG-07). The same applies for the monthly option.


v The -previous option can be used instead of specifying dates when running asummary. When you use the -previous option, the summary runs for the lastcomplete period, depending on its interval.

v For example, if the current time and date is 01-07-2011 13:35, and you run the-previous option for a summary which is at an hourly interval, the date andtime run in the summary is between 01-07-2011 12:00 and 01-07-2011 12:59. Thisalso applies to raw summaries. In addtion, daily summaries run for the previousday, weekly summaries run for the previous week, and monthly summaries runfor the previous month.

Results

Note: A summary will run even if the data set is incomplete. That is, if today'sdate is 23-Aug-07 and the start of the week is Sunday the 19-Aug-07, and the userruns:summary_admin -r <summary_name> -ir weekly -fr 19-08-2007 -er 23-08-2007

then the summary will still run even though the week has not rolled over and thedata set is incomplete for the week. A date in the future cannot be specified, andwill return an error.

Note: On completion, the command will display a BUILD SUCCESSFUL message. TheBUILD SUCCESSFUL message indicates that the summary run has started andreturned successfully. It does not indicate if the summary run was successful. Thesummary run outcome is listed in the output.

Change the number of instancesUsing the summary_admin cli command to change the number of instances.

About this taskUsage: summary_admin –set –n noin –v

-set Mandatory. Use this switch used to set summary parameters.-n The name of the parameter,for example, noin - number of summary instances.-v The new value of the parameter.

Procedure

To change the number of summary engine instances that can run concurrently use:summary_admin -set -n noin -v 3

Export summary metadataUsing the summary_admin cli command to export summary metadata.

About this taskUsage: summary_admin -e [ summary_name | -t | -ir ] -f <filename>

-e [<summary_name>] Mandatory. Use this switch to export summaries.If no summary name specified then all summariesare exported.

-t <user|standard|techpack> Optional. The creational summary type.It cannot be used if the summary name isspecified, or with temporal type -ir.

-ir <daily|weekly|monthly> Optional. The temporal summary type.It cannot be used if the summary name isspecified, or with creational type -t.

-f <filename> Mandatory. The name of an XML file into whichthe metadata is exported.


Procedurev To export all the nok_trx_rx_quality metadata, that is, daily, weekly, monthly:

summary_admin -e nok_trx_rx_quality -f /appl/virtuo/export/nok_trx_rx_quality.xml

v To export the metadata of all daily provisioned summaries:summary_admin -e -ir daily -f /appl/virtuo/export/daily_summaries.xml

The summary definition XML contains the XML for daily, weekly, and monthlysummaries. When exporting 'daily' alone, the daily XML data is not extractedfrom the summary definition XML, the whole XML is exported. In this way, thedaily part of the export command relates to the summary history. The exampleabove would export all the provisioned summaries and would include summaryhistory information related to daily summaries.

v To export the metadata of all provisioned summaries:summary_admin -e -f /appl/virtuo/export/all_summaries.xml

v To export the metadata of all standard provisioned summaries:summary_admin -e -t standard -f /appl/virtuo/export/all_summaries.xml

Results

Note:

If the summary name is specified after the -e option, then the user cannot useeither the -t or -ir option. The following is not valid:

summary_admin -e vnl_cell_tch -ir daily -f /tmp/vnl_cell_tch_export.xml orsummary_admin -e vnl_cell_tch -t standard -f /tmp/vnl_cell_tch_export.xml

Note: If summaries are provisioned during technology pack installation they canbe exported using the creational type techpack.

List summary definitionsUsing the summary_admin cli command to list summary definitions.

About this taskUsage: summary_admin –l [summary_name]

-l Lists all provisioned summary definitions.-l <summary_name> Lists the specified summary definition.

Prioritize summariesUsing the summary_admin cli command to prioritize summaries.

About this task

It is possible to prioritize the execution order of summaries to ensure the mostimportant summaries can be processed first when scheduled jobs are run. Thedefault priority is 99, this is the lowest priority. The highest priority is 1.summary_admin -set -n <name> -t priority -v <priority_value>-n Specify the <name> of the Summary to prioritize-v Priority value, 1-99

Examplesummary_admin -set -n VNL_CELL_TCH -t priority -v 1

Sets the priority of the VNL_CELL_TCH to 1.


Where a number of summaries have the same priority they are executed accordingto the summary type, simple before complex, and then by summary name sortedin ascending order.

For example, if a number of summaries have the same priority, then the simplesummaries are executed first, followed by the complex summaries. Within thesimple and complex summaries, summaries are executed according to summaryname in ascending order. For example, summary SummaryA is executed beforeSummaryB.

Enable a summaryUsing the summary_admin cli command to enable a summary.

About this task

By default, scheduled summaries are enabled so that they run as part of thescheduled summary run. You can run the following command to re-enable adisabled summary:

summary_admin -set -n <summary_name> -t enable -v truesummary_admin -set -n <summary_name> -t enable -v true

-n The name of the summary to enable.

Examplesummary_admin -set -n NOK_CELL_RES_AVAIL# -t enable -v true

Enables the summary NOK_CELL_RES_AVAIL#.

Disable a summaryUsing the summary_admin cli command to disable a summary.

About this task

You can disable a scheduled summary so that it is not ran as part of the scheduledsummary run.summary_admin -set -n <summary_name> -t enable -v false

-n The name of the summary to disable.

Examplesummary_admin -set -n NOK_CELL_RES_AVAIL# -t enable -v false

Disables the summary NOK_CELL_RES_AVAIL#.

Configuring summary definitionsThis section describes customizing summary definitions.

You can only customize an existing summary definition. A summary definition willneed to have been provisioned or created before it can be customized, see SeeProvision a summary for more information.

To customize an existing summary you must first export the summary. Forexample:

To export all the SIE_CELL_CCCH_CH summary metadata:


summary_admin -e SIE_CELL_CCCH_CH -f /appl/virtuo/export/ SIE_CELL_CCCH_CH.xml

KPI naming conventionsConventions for the naming of Key Performance Indicators.

The following convention is used to name KPIs:

Vendor.field_branch.group.field_name

For example, the raw counter Neutral.tch.blocks has:v Vendor=Neutralv field_branch=tchv no group, meaning it is a technology pack raw KPIv field_name=blocks

For example, the summary KPI Neutral.tch.daily.blocks has:v Vendor=Neutralv field_branch=tchv group=dailyv field_name=blocks

Simple summary definitionA simple summary definition is essentially a mapping between a traffic table and asummary table.

The following is an example summary definition XML file for a simple summarydefinition.<Summaries>

<summary><name>VNL_CELL_TCH</name><source>

<table>VNL_CELL_TCH</table></source><summary-attributes>

<intervals-required><interval type="daily" source="raw"/><interval type="weekly" source="daily"/><interval type="monthly" source="daily"/>

</intervals-required><calculate-late-data>true</calculate-late-data><summary-type>standard/summary-type>

</summary-attributes><enabled>true</enabled>

</summary></Summaries>

Name tagThe Name summary definition XML tag.

The summary name is specified by the <name> field:

<name>VNL_CELL_TCH</name>

Table tagThe Table summary definition XML tag.


The related source table used to calculate the summary is specified by the <table>field, for example<source>

<table>VNL_CELL_TCH</table></source>

For each raw KPI associated with each column of a source traffic table, a summaryKPI will be created.

If, for example, a raw KPI is named Neutral.tch.blocks , then the associatedsummary KPI will be named Neutral.tch.daily.blocks .

Intervals tagThe Intervals summary definition XML tag.

A summary can be defined for three intervals and their source intervals:<intervals-required>

<interval type="daily" source="raw"/><interval type="weekly" source="daily"/><interval type="monthly" source="daily"/>

</intervals-required>

In our simple summary definition example, the above configuration will create thefollowing summary tables:v VNL_CELL_TCH_DSM based on VNL_CELL_TCH_TABv VNL_CELL_TCH_WSM based on VNL_CELL_TCH_DSMv VNL_CELL_TCH_MSM based on VNL_CELL_TCH_DSM

It is possible to specify what intervals should be created, by removing <interval>tags.

Calculate-late-data tagThe Calculate-late-data summary definition XML tag.

The following tag is used to control late data calculation for daily, weekly, andmonthly data.<calculate-late-data>true</calculate-late-data>

If the tag is set to true late data calculation is enabled, if it is set to false late datacalculation is disabled.

This setting is used only when summarization is run for scheduled summarization,it is ignored when you run summarization by using the summary_admin commandline tool.

The summarizer re-summarizes or summarizes old loaded data automatically.When the summarizer process is started, it detects if old loaded data is loadedonto the system. Data is determined to be old loaded data if it's older than 1 dayold. If the old loaded data has already being summarized then, it is re-summarizedand the old summary data is deleted and the new summary data is populated inthe summary table.

If the old loaded data is older than one week or one month, it causes weekly andmonthly summaries to be recalculated. By default, the summarizer agent examinesthe data that is loaded with timestamps up to 7 days old. To change the value ofthis property, run the following command:


$WMCROOT/bin/dbsysval_admin -update DA_LATE_DATA_LOOKBACK <number_of_days_for_lookback>

Note: If the data look back is set to a large number and there is incoming late datafor these days, the performance of the summarizer is affected. The systemcalculates summaries for all these days. Changes in DA_LATE_DATA_LOOKBACKproperty affect late data calculation for stored busy hour.

The following sql command can be used to update the setting in a summary that isalready in the system, without the need to export, delete, and reprovision thesummary:update summary_definitionset definition = updateXML(definition, ’//calculate-late-data/text()’, ’false’)where summary_definition.summary_name = ’VNL_CELL_TCH’;

Related reference:“Enable and disable calculation of late data for all Busy Hour definitions” on page176Instructions on how to enable or disable calculation of late data for all Busy Hourdefinitions.

Summary-type tagThe Summary-type summary definition XML tag.

The summary type that you want to create is specified by the <summary-type> field:<summary-type>Standard</summary-type>

The summary-type can be defined as user, tech pack, or Standard.

user summary-type is user for custom summaries that are defined by users.

tech packsummary-type is tech pack for summaries that are available with atechnology pack before installation.

Standardsummary-type is Standard and is set automatically on summaries that areprovisioned by using the summary_admin -c -source command. For moreinformation about this command, see “Create a summary usingparameters” on page 224.

Status tagThe Status summary definition XML tag.

If the summary definition is an exported (unloaded) definition it also contains thesummary execution status for each of the interval types defined for the summary,for example:

<status><interval>weekly</interval><first-available>2008-09-07</first-available><last-available>2008-09-14</last-available><last-run>

<start-time>2008-10-20T16:16:38.000+01:00</start-time><end-time>2008-10-20T16:16:38.000+01:00</end-time><last-run-success>2008-10-20T16:16:38.000+01:00</last-run-success><result>1</result><reason>Successful run 64 row(s) updated</reason>

</last-run></status>


In the summary status it lists the last results, numbers of rows updated and thestart and end time of the last occasion the summary was run.

Complex summary definitionA complex summary is essentially a mapping between individual KPIs andsummary KPIs.

Complex summaries based on raw or hourly data are available from TivoliCommon Reporting or directly from the database, they are not available in theTivoli Netcool Performance Manager UI.

You must manually create a complex summary definition by creating an XML filewith content that conforms to the structure of the following example complexsummary definition XML file.<summary>

<name>NOK_CELL_HANDOVERS</name><source>

<entity>Cell</entity><field-list>

<field><source-field>

<entity>Cell</entity><field-name>Nokia.Handovers.bsc_i_att_hscsd</field-name><tp-field-id>vydglg6ahk26sec6000hw01qk4</tp-field-id>

</source-field><dest-field/><aggregators>

<field-aggregator>A</field-aggregator><field-aggregator>Z</field-aggregator><field-aggregator>M</field-aggregator>

</aggregators></field>

</field-list></source><summary-attributes>

<intervals-required><interval type="raw" source="raw"/><interval type="hourly" source="raw"/><interval type="daily" source="raw"/><interval type="weekly" source="daily"/><interval type="monthly" source="daily"/>

</intervals-required><calculate-late-data>true</calculate-late-data><summary-type>user</summary-type>

</summary-attributes><enabled>true</enabled>

</summary></Summaries>

Entity tagThe Entity summary definition XML tag.

This specifies the focal entity of the summary.

In the previous example summary definition XML file, the first instance of<entity> , can be set to <entity>BSC</entity> to enable entity rollup to BSC level.

Source-field tagThe Source-field summary definition XML tag.


This tag specifies information about an existing source KPI, in most cases atechnology pack KPI such as a PEG or PCALC, but UDCs can also be used. Forsummaries with raw or hourly intervals, PEGs cannot be used.

Nested elements are given in the following table:

Table 64. Source-filed tag nested elements

Element Description Example

entity The entity of the KPI. Cell

field-name The full name of the KPI (includingvendor, branch, group (optional) andname.

Neutral.tch.blocks

tp-field-id Optional. The UUID of the KPI asprovided by the technology pack.

vydglg6ahk26sec6000hw01qk4

UDCs do not have a UUID, so the tp-field-id can be omitted for UDCs.

Aggregators tagThe Aggregators summary definition XML tag.

This tag is used to create one summary KPI per aggregator, per source KPI.

This will configure the system to aggregate the same raw value (defined by thesource-field tag) using different aggregation functions (avg, sum, min, and so on).

The following table lists all aggregators.

Table 65. Aggregators

Code Name Time aggregation Entity aggregation

T AvgNull avg nil

G AvgMax avg max

R AvgMin avg min

F AvgSum avg sum

A Average avg avg

c Count count count

C Max max max

L MaxNull max nil

V MaxAvg max avg

Q MaxSum max sum

H MaxMin max min

E MinAvg min avg

O MinMax min max

D MinSum min sum

M Min min min

P MinNull min nil

Y NullAvg nil avg

X NullMin nil min

W NullSum nil sum


Table 65. Aggregators (continued)

Code Name Time aggregation Entity aggregation

N NULL nil nil

Z NullMax nil max

B SumNull sum nil

K SumMax sum max

J SumAvg sum avg

I SumMin sum min

S Sum sum sum

Configuring specific aggregatorsHow to configure specific aggregators.

In the complex summary definition given here:<source-field>





The three summary KPIs created will be the following:

Table 66. Example Summary KPIs - using specific aggregators

Summary KPI full name uuidTime Aggfunction

Entity Aggfunction

Nokia.Handovers.daily.avgavg_bsc_i_att_hscsd

AVGAVG_vydglg6ahk26sec6000hw01qk4 average average

Nokia.Handovers.daily.nilmax_bsc_i_att_hscsd

NILMAX_vydglg6ahk26sec6000hw01qk4 nil max

Nokia.Handovers.daily.minmin_bsc_i_att_hscsd

MINMIN_vydglg6ahk26sec6000hw01qk4 min min

Configuring the default aggregatorIf the aggregators tag is empty, then the summary KPI uses the default aggregatorof the raw KPI.<field-list>

<field><source-field>


</source-field><dest-field/><aggregators/> 

</field></field-list>


Assuming S is the default aggregator, the following properties would be applied.

Table 67. Example Summary KPI - using default aggregator


Entity Aggfunction

Nokia.Handovers.daily.bsc_i_att_hscsd

vydglg6ahk26sec6000hw01qk4

sum sum

This is especially useful for summaries based on PCalcs. For PEGs the defaultaggregator is not specified in SummaryInstance.xml files. This is to avoid possibleduplication with the default PEG summaries that are created when a technologypack is automatically installed, see the Tivoli Netcool Performance Manager:Installation Guide - Wireless Component, for more information.

Note: Users who manually modify a SummaryInstance*.xml file should ensure noduplication of the default aggregators takes place. This would cause summary KPInaming clashes, unless the <dest-field> tag is overridden in one of the duplicates.

Configuring specific aggregators and a default aggregatorIf both a default aggregator and specific aggregators are needed, then two <field>tags with the same <source-field> , can be used.

For example:field-list>

<field>

<source-field><entity>Cell</entity><field-name>Nokia.Handovers.bsc_i_att_hscsd</field-name><tp-field-id>vydglg6ahk26sec6000hw01qk4</tp-field-id>




<field>

<source-field><entity>Cell</entity><field-name>Nokia.Handovers.bsc_i_att_hscsd</field-name><tp-field-id>vydglg6ahk26sec6000hw01qk4</tp-field-id>

</source-field><dest-field/><aggregators/>

</field>

</field-list>

dest-field tagThe dest-field summary definition XML tag.

The <dest-field> tag is used to avoid name clashes that can occur between simpleand complex summary KPIs. The following elements can be nested inside a<dest-field> tag, they are all optional:


<dest-field><vendor>MyVendor</vendor><field-branch>myBranch</field-branch><field-name>myNewKpiName</field-name>

</dest-field>

In this example, the summary KPI would be named:MyVendor.myBranch.daily.myNewKpiName

A custom uuid would be generated in the form VMMxxxxxxxxxx , since at least onecomponent of the destination field was customized.

Customization of the dest-field can be combined with customization ofaggregators. The example in the previous section would now give the followingsummary KPIs:

Table 68. Summary KPIs - using destination and aggregator customization


Entity Aggfunction

MyVendor.myBranch.daily.avgavg_myNewKpiNameAVGAVG_VMM1234567890123

average average

MyVendor.myBranch.daily.nilmax_myNewKpiNameNILMAX_VMM1234567890123

nil max

MyVendor.myBranch.daily.minmin_myNewKpiNameMINMIN_VMM1234567890123

min min

Intervals-required tagThe Intervals-required summary definition XML tag.

A summary can be defined for five intervals and their source intervals:<intervals-required>

<interval type="raw" source="raw"/><interval type="hourly" source="raw"/><interval type="daily" source="raw"/><interval type="weekly" source="daily"/><interval type="monthly" source="daily"/>

</intervals-required>

It is possible to specify what intervals should be created, by removing <interval>tags.

Note: Raw, Hourly, and Daily summaries can only be based on raw data. Derivingweekly and monthly summaries from raw data will impair performance. If weeklyor monthly intervals are specified and they depend on a daily interval, then thedaily interval needs to be specified first.


Ignoring data availabilitySummaries are executed each day based on Data Availability.

The summary will run if there is data loaded for a given period, regardless of theamount of data. No percentage threshold of data availability is used. If there is nodata present for the period being summarized, then the summary will not beinitiated. However, summaries can be run to ignore Data Availability calculations,by executing the summaries on the command line.

Two layer summary aggregationThe second layer summary aggregates KPI summary at the entity level. Both directand indirect entity relationships are supported for two layer aggregation.

Currently, single layer of grouping attributes support busy hour and summary. Insingle layer of aggregation, if the lower entity, that is Cell uses time averageaggregation, the focal entity, that is BSC, also uses time average aggregation. Intwo layer aggregation, the entity and focal entity can have different aggregations.For example Cell can use time average aggregation and BSC can use entityaggregation. Both layers need a defined summary. The first layer aggregation isbased on the second layer summary table. The second layer aggregation is basedon the raw traffic data.

Data availability for the second layer aggregation is based on the last successfulrun time and available date from the first layer summary. If the last successful runof the first layer summary is newer than second layer summary, the first layersummary data is refreshed and hence the second layer summary needs to refresh.The late data check during data availability lookup is only supported for simplesummary table. Complex summary that composes of multiple fields or UDCssupport only previous day recalculation.

Overview of two layer summaryWhile creating the second layer summary, you must create a summary definitionxml file and set summary attributes.

Procedure1. Create a second layer summary definition xml file based on the first layer

summary, and provision the summary definition file.2. Set priority for the second layer summary. Ensure that the priority value of the

second layer summary is lower compared to the first layer summary. However,the difference between the priority values should be minimum.

3. Run the provision summary file for data availability lookup.

Note: The system can look up data availability only if you set appropriatepriority levels.

4. Delete the two layer summary, if required.5. View the summary log file.

Creating a second layer summaryYou can refer to the first layer summary and create the entity-level second layersummary in the CLI.


Before you begin

Ensure that you run the provisioned first layer summary where first layersummary can be simple or complex. The summary interval for the second layermust be same or less than the first. An example of the first layer complexsummary definition is as follows:1. First layer simple summary

<Summaries><summary><name>VNL_CELL_TCH</name><source><table>VNL_CELL_TCH</table></source><summary-attributes><intervals-required><interval type="daily" source="raw"/><interval type="weekly" source="raw"/><interval type="monthly" source="raw"/></intervals-required><calculate-late-data>true</calculate-late-data><summary-type>standard</summary-type></summary-attributes><enabled>true</enabled></summary>

</Summaries>

2. Second layer simple summary:<Summaries><summary><name>VNL_CELL_TCH_TWO</name><source><entity>BSC</entity>

<summary-name>VNL_CELL_TCH</summary-name></source>

<summary-attributes><intervals-required><interval type="daily" source="raw"/><interval type="weekly" source="raw"/><interval type="monthly" source="raw"/></intervals-required><calculate-late-data>true</calculate-late-data><summary-type>standard</summary-type></summary-attributes><enabled>true</enabled></summary>

</Summaries>

Procedure1. Provision the second layer complex summary by using a summary definition

XML file by using the following command:summary_admin -c –f <filename>

Note: The second layer summaries can only be provisioned through CLI.An example of the second layer summary definition file is as follows:<Summaries><summary><name>VNL_CELL_TCH_TWO</name><source><entity>BSC</entity><summary-name>VNL_CELL_TCH</summary-name></source>

<summary-attributes><intervals-required>


<interval type="daily" source="raw"/><interval type="weekly" source="raw"/><interval type="monthly" source="raw"/></intervals-required><calculate-late-data> true </calculate-late-data><summary-type>user</summary-type>

</summary-attributes><status-list/><enabled>true</enabled></summary></Summaries>

The entities that are modified for second layer summary are as follows:

Tag Description

<name> Name of the second layer summary. Thisname must be a unique name.

<summary-name> Name of the first layer summary

<entity> Valid parent entity

<interval type> Since we are only supporting entityaggregation, the source intervals must beraw for daily, weekly and monthly intervals.

2. Run the provisioned summary by using the following command:summary_admin -r <summary_name> -fr <DD-MM-YY> -er <DD-MM-YY>

Important: There must be an existing first layer summary for the intervalsspecified in second layer summary definition. For example, VNL_CELL_TCHsummary must be already provisioned for intervals daily, weekly and monthly.Ensure that there is no previously existing second layer summary for same firstlayer summary for the same interval and same entity.For more information about the summary_admin CLI tool, see AdministeringTivoli Netcool Performance Manager - Wireless Component.

Results

After you run the summary, you can see the following:v The second layer summary is inserted in summary_definition table with the

summary name mentioned in the summary XML file. For example,VNL_CELL_TCH_TWO.

v <second-level-summary-name>_XSM tables are created in the database where X canbe “R”, “H”, “D”, “W” and “M” for intervals raw, hourly, daily, weekly andmonthly.

v Second layer summaries do not have secondary key columns because they arenon-metric keys.

Setting priorityYou must set the appropriate priority for first layer summary and second layersummary. The first layer summary has higher priority.v Run the following command to change the priority of the first layer summary.

By default, the priority level is set to 99.summary_admin -set -n <summary-name> -t priority -v <priority_value>

Running data availability lookupThe system checks if data is available for the entities you have specified in thesecond layer summary xml file. You must specify time intervals for data look up.


v Run the following command to execute the second layer summary.summary_admin –r <summary_name> -fr <DD-MM-YY> -er <DD-MM-YY>

Deleting summaryYou can delete the entity-level second layer summary, if required.

Procedure1. Delete the second layer summary.

summary_admin -delete <summary_name>

2. Delete first layer summary.summary_admin -delete <summary_name>

Note: If you delete first layer summary before deleting the dependent secondlayer summary, the system displays an error message.

Viewing the summary log filesAfter you provision the second layer summary, you can view the log file.

When you run the summary definition file, the summary log file is stored at thefollowing location:/appl/virtuo/logs/summariser/summariser-server.log

If you want enable debug level logs, modify the following property:/appl/virtuo/conf/logging/default.properties comnitel.log.basedir=${WMCLOGDIR}comnitel.log.level=DEBUG4comnitel.log.console=falsecomnitel.log.syslog=falsecomnitel.log.syslog.facility=LOCAL0comnitel.log.syslog.host=localhost comnitel.log.layout=com.comnitel.log.layout.LogTTCCLayoutFactorycomnitel.log.option.date=ABSOLUTE

Note: If you want to view details of the log, set the log level to DEBUG4.



Chapter 13. Technology pack administration tools

Tools for the administration of technology packs.

The techpack_admin toolThe techpack_admin tool applies standard technology packs to a Tivoli NetcoolPerformance Manager system.

This tool is found in $WMCROOT/bin.

Note: Do not run more than one of the following tools, or more that one instanceof any of these individual tools, at the same time:v techpack_admin

v sbh_admin

v summary_admin

v kpicache_admin orv report_impexp

For example, do not run summary_admin and sbh_admin, or two instances ofsummary_admin at the same time).

UsageUsage: techpack_admin -parameters-a Mandatory:Apply new TechPack modules dependencies-e Mandatory:Export the UDC’s and reports that are

dependent on a tech pack-d DirName Mandatory:The Dir where the files will be exported

to-n TechPackName Mandatory:The name of the TP in "" quotes-p Mandatory:Patch an already installed TP-d DirName Mandatory:The root dir where the tech pack

patch files are located under e.g. using-d $WMCROOT/admin/techpacks/<techpack_dir> applies patch from the followingdir $WMCROOT/admin/techpacks/<techpack_dir>/<version>/patches/metalayer

-n TechPackName Mandatory:The name of the TP in "" quotes-v Version Mandatory:The version of the TP to be patched-l Mandatory:List TechPack modules

installeduninstalledaudit[-n TechPackName] Optional:The name of the TP in"" quotes for use with audit

-u Mandatory:Uninstall a named tech pack module techpack-n TechPackName Mandatory:The name of the TP in "" quotes

-x Mandatory:Upgrade Techpack.check Mandatory:Check if upgrade is possible-n TechPackDirName Mandatory:The name of the TP Directory under $WMCROOT

admin/techpacks in "" quotes-v TechpackVersion Mandatory:The version of the TP in "" quotes

upgrade Mandatory:Upgrade the techpack-n TechPackDirName Mandatory:The name of the TP Directory under


$WMCROOT/admin/techpacks in "" quotes-v TechpackVersion Mandatory:The version of the TP in "" quotes

-h Help option

Note: Before running the techpack_admin tool, ensure that the as process isrunning by running the command sap disp as. The status of the as process shouldbe STARTED. If it is not, run the sap start as command.

Applying a technology packThe techpack_admin - a option applies technology pack modules to a system.

About this task

The technology pack modules to apply are read from the $WCMROOT/admin/techpacks/new_techpacks file.

The new_techpacks file is created automatically by the installation of technologypack modules on the system. Technology pack modules are installed in$WMCROOT/admin/techpacks.

The new_techpacks file lists the name and version of each technology pack to beapplied. An example of a new_techpacks file is:v Neutral_GSM_BSS_NSS_GOM 1.0v Neutral_GSM_Core 1.0v Ericsson_GSM_BSS_R10 1.0

The technology packs are applied in the order in which they appear in thenew_techpacks file.

If all technology packs are successfully applied, the new_techpacks file will bedeleted. If the application of any technology pack fails, the techpack_admin toolwill stop applying any further technology packs and will roll back the DMLapplication of any previous technology packs that have been successfully applied.

Memory for Java client processesIf you are installing large technology packs, it is strongly recommended that youset the ANT_OPTS environment variable to a value of 1G prior to installation.

About this task

To set the ANT_OPTS environment variable:

Procedure1. Run the following command:


2. After technology pack installation completes successfully, reset the ANT_OPTSvariable to its original value:unset ANT_OPT

Note: You do not need to stop and re-start the application server after youreset the ANT_OPTS value.


Exporting lists of dependenciesThe techpack_admin -e option is used to export lists in .csv format of all UDCs,reports and report templates that are dependent on a technology pack.

About this task

This information is useful when uninstalling a technology pack.

Exampletechpack_admin -e dependencies -d <DirName> -n "Nokia GSM BSS"

where <DirName> is the directory to write the .csv files to.

In this example, all dependent UDCs, reports and report templates, will be listed inthe files Nokia_GSM_BSS_udcs.csv and Nokia_GSM_BSS_reports.csv in the directoryspecified in the -d option.

Patching a technology packThe techpack_admin -p option is used to apply a patch to an existing technologypack.

Exampletechpack_admin -p -d <DirName> -n <TechPackName> -v <Version>

where:

<DirName> is the root directory under which the technology pack patches arelocated. For example using $WMCROOT/admin/techpacks/<techpack_dir> applies thepatch from the directory $WMCROOT/admin/techpacks/<techpack_dir>/<version>/patches/metalayer.

<TechPackName> is the name of the technology pack to be patched in quotes.

<Version> is the version number of the technology pack to be patched.techpack_admin -p -d $WMCROOT/admin/techpacks/Nokia GSM BSS -n "Nokia GSM BSS" -v 3.1

Listing technology pack modulesThe techpack_admin -l option lists the technology pack modules

The technology pack modules are:v installed - provides a list of technology packs applied to the system, UDCs,

and all data related to the applied technology packs.v uninstalled - provides a list of technology packs that are uninstalled from the

system.v audit [-n TechPackName] - returns an audit log with information on a

technology pack including information on any customizations and entities thatare customized. Technology pack name is optional and must be in quotes.

Chapter 13. Technology pack administration tools 245

Exampletechpack_admin -l audit -n "Nokia GSM BSS NetAct OSS3.1 ED3"

Uninstalling a technology pack, and loadersInstructions on how to uninstalling a technology pack, and loaders

Technology packHow to uninstall a technology pack.

About this task

The -u option uninstalls a technology pack. Technology pack modules are installedin $WMCROOT/admin/techpacks .

To uninstall a technology pack: , enter the following command:

Procedure1. As user virtuo, list the technology packs that are installed on the system:

techpack_admin -l installed

2. Make sure the technology pack you are going to uninstall has no dependencies.All dependent technology packs must be uninstalled beforehand. See“Dependent technology packs” on page 247, for information on dependenttechnology packs.

3. Uninstall the technology pack:techpack_admin -u techpack -n “<TechPackName>”

For example:techpack_admin -u techpack -n “Ericsson UMTS UTRAN R3.0”

4. You will be asked to confirm the uninstallation.The uninstall may take several minutes, do not interrupt the uninstall.

Data dictionaryWhen a technology pack is uninstalled the data dictionary is disabled.

About this task

When a technology pack is re-installed, as is the case when upgrading atechnology pack, the data dictionary is automatically enabled and run.

If it is necessary to permanently delete a technology pack and not reinstall it, thenafter the technology pack has been uninstalled, the data dictionary must bere-enabled and run. To do this:

Procedure

Enter the following commands:agent_admin -u sysadm -p <password> -enable <DataDictionaryid>

agent_admin -u sysadm -p <password> -run <DataDictionaryid>


Removing associated loadersRemoving loaders for a technology pack.

Procedure

Enter the following command:loader_admin -delete -techpack <TechPackName> -tpversion <TechPack Version>

Where:<TechPackName> is the name of the technology pack in "" quotes.<TechPack Version> is the version of the technology pack in "" quotes.

Exampleloader_admin -delete -techpack “Ericsson UMTS UTRAN” -tpverison “1.0”

Note: The loader_admin -delete command replaces the techpack_admin -u loadercommand that is used in previous versions of Tivoli Netcool Performance Manager.

Removing the data sourceDeleting the data sources associated with a technology pack by using thelcm_admin -delete command.

About this task

For information on how to delete the data sources associated with a technologypack by using the lcm_admin -delete command, see section “Delete data sourcesand NC relations” on page 171.

Dependent technology packsA number of technology packs define top-level concepts that are not specific to anyequipment vendor implementation.

About this task

For example, concepts like Wireless CELL or Access Point. These technology packsare GOM (Global object model) technology packs, and they are used by otherdependent technology packs.

You cannot delete a technology pack used by another technology pack.

Procedure

You can use the techpack_admin -l installed command to display dependenciesbetween technology packs. The following example output illustrates this:


[moduleInventory] TechPack: UMTS (1.0.20)[moduleInventory] Module: Ericsson UMTS UTRAN R3.0[moduleInventory] Release: (1.0)[moduleInventory] Technology: UMTS[moduleInventory] Vendor: Ericsson (ERI)[moduleInventory] Subsystem: RAN[moduleInventory] Installed: 6 Mar 2007 16:57:41[moduleInventory] Requires: Neutral GSM BSS/NSS GOM (1.0)[moduleInventory] Neutral GPRS BSS GOM (1.0)[moduleInventory] Neutral UMTS UTRAN GOM (1.0)[moduleInventory] Neutral GPRS/UMTS CN GOM (1.0)[moduleInventory] Neutral Core GOM (1.0)

Note: In the example above you cannot uninstall Neutral GSM BSS/NSS GOMwithout first uninstalling Ericsson UMTS UTRAN R3.0.

Displaying helpDisplaying help for the tool.

Procedure

The -h option displays the usage of the tool.

Check differences between technology packsThe check option compares a newly deployed technology pack with the existingversion installed on the system and reports the differences.

It also indicates whether the upgrade can be proceeded with or not.v -x Mandatory: Upgrade technology pack.v check Mandatory: Check if upgrade is possiblev -n TechPackDirName Mandatory: Name of the technology pack directory in quotesv -v TechpackVersion Mandatory: The version of the technology pack in quotes

It is ran as follows on the command line:techpack_admin -x check -n “VNL_GOMlet” -v “2.2”

Note: The technology pack directory is under $WMCROOT/admin/techpacks

Upgrading a technology packThe upgrade option compares a newly deployed technology pack with the existingversion installed on the system and proceeds with the upgrade if this is allowed.v -x Mandatory: Upgrade technology pack.v upgrade Mandatory: Upgrade the technology packv -n TechPackDirName Mandatory: Name of the technology pack Directory in

quotesv -v TechpackVersion Mandatory: The version of the v in "" quotes

It is ran as follows on the command line:

techpack_admin -x upgrade -n “VNL_GOMlet” -v “2.2”


Example upgrade procedure

Upgrading Gomlet to: VNL_GOMlet 2.21. As user virtuo:

Check for existing <.remove> file for this Gomlet, for example,vallent-vt-VNL_GOMlet.remove:

2. If this exists, remove it as user virtuo:rm -f /appl/virtuo/admin/software/vallent-vt-VNL_GOMlet.remove

3. Deploy new Gomlet - picking up package from /appl:/appl/virtuo/admin/common/install/scripts/deploy_techpacks -wmcr/appl/virtuo/ -pkgdir /appl/ -techpacks /appl/vallent-vt-VNL_GOMlet-2.2.tar.gz

4. Run Gomlet upgrade check option:techpack_admin -x check -n "VNL_GOMlet" -v "2.2"

5. If the check allows the upgrade and you are satisfied to proceed, run thefollowing:techpack_admin -x upgrade -n "VNL_GOMlet" -v "2.2"

Known Issuesv A Gomlet upgrade can add a subsystem of any name on upgrade.v A Gomlet upgrade can add a relation of any name on upgrade.v Adding an Entity with a null name is not supported. However, the check option

does not highlight this as an issue. The actual upgrade catches this scenario andprevents the insertions of null entity names. There is a constraint in the databasethat prevents the insertion of null entity names.

v The following misleading message is output by the check option:[upgradeTechPacks] The following entities cannot be updated as they are usedin dependent tech pack(s).[upgradeTechPacks] Upgrade check was successful. This tech pack [VNLGOMlet] can be upgraded from version [2.1] to version [2.2].The first line is the misleading bit: "The following entities..." - this message isoutput even if there are no entities which cannot be updated.The second line: Upgrade check was successful reports the true status of theupgrade check.

v When the check option fails, the formatting of the message which is output canlead to confusion.There are a number of issues here:Misplaced end of line in the upgrade check and Build Failed messages.Missing technology pack dependencies are reported in a concatenated listmaking it difficult to read

v A decrease in column length or size is not supported.This is reported by the check option, as follows:[upgradeTechPacks] Updated attributes:

[upgradeTechPacks] Global_Translation_Type

[upgradeTechPacks] GTT_Name -

[upgradeTechPacks] (length 300 -> 30)

It does not state that this decrease in column length will not be applied duringthe upgrade. However, during the upgrade itself, the increase in column lengthis not applied. The column remains at it's original size.


Upgrading technology packsTasks that are required to complete the upgrade of technology packs.

Be aware of the potential effects of installing a technology pack:v “Effects of a technology pack upgrade” on page 251.

Be aware of the following unsupported scenario:v “Upgrading or reinstalling installed technology packs” on page 252.

Follow the instructions in the following section:v “Unsupported upgrade scenario” on page 251.

Before starting a technology pack upgrade:v Test all technology pack upgrades on production environments on a mirrored

environment.v Read all the following sections.

Note: When upgrading a technology pack, shut down any associated loaders forthe period of the upgrade. The technology pack upgrade requires a two-stepuninstall or install process as detailed below. This does not remove any dataloaded up to the time of the upgrade.

Technology packs are identified by:v The technology pack name and release.v The data source name and version.

To decide which of the following upgrade scenarios is required, find the name andrelease of the technology packs installed (including loadmap data source name andversion) and the same for the new technology packs for installation.

For an installed technology pack:1. Enter the following command as user virtuo to find the technology pack name

and release of an installed technology pack:techpack_admin -l installed

2. Enter the following command as user virtuo to find the associated datasourcename and version of an installed technology pack:lcm_admin -listdatasources

For a new technology pack deployed to the filesystem:v The name and release of a new technology pack deployed to the filesystem in

$WMCROOT/admin/techpacks can be found in the main.xml file included in themetalayer directory of the technology pack.

Example<Module name="Nokia GSM BSS" release="1.0"compatible_release="1.0" vendor="Nokia" technology="GSM"subsystem="RAN" vendor_version="OSS3.1 ED3" techpack="GSM" techpack_version="1.1.2"/>

v The loadmap data source name and version can be found in thedatasource*.xml file in the loadmaps directory in the technology pack directoryunder $WMCROOT/admin/techpacks .

For example:


<DataSource Name="Nokia BSS" Technology="GSM" Type="Vendor"Vendor="Nokia" Version="OSS3.1 ED3"/>

Effects of a technology pack upgradeDescribes the potential effects upgrading a technology pack has on your system.

Technology pack definitionsA technology pack upgrade can contain additional or modified busy hours andsummary definitions, but these default definitions are not automatically installedor upgraded.

Check the technology pack ReadMe file for any information that could affectreports, UDCs, or busy hour and summary definitions, for example, renamedcounters.

If the default technology pack definitions included with the technology pack havechanged, or if you have made changes to your definitions, such as addingcounters, or changing aggregators, you must reconcile the definitions after theupgrade and manually merge any differences.

You must also handle all custom-defined reports, UDCs, busy hours and summarydefinitions in the same way as the default definitions defined in the technologypack.

Complex summary definitions that depend on daily computationsYou may have configured weekly or monthly complex summary definitions thatdepend on daily computations.

If the original KPI type is average aggregation, the weekly values would bere-averaged after the upgrade, with unexpected results. You must use the-ignoreaggr option when provisioning this type of summary. The normalprocedure of backing up all summaries to one .XML file before upgrade andre-using the same .XML file does not work unless you use the -ignoreaggr option.

Migrating alarmsThe sequence of steps when upgrading a technology pack is different if you aremigrating alarms data.

To determine the ruleset_ids for the old technology pack, you must run themigratealarms tool, see “Using the migratealarms tool” on page 255, after the newversion of the technology pack is installed, and before the loaders are deleted.

Unsupported upgrade scenarioIf the technology pack being upgraded contains loadmaps where the data sourcename and version match the old data source name and version but the technologypack name and release version are different, an error will occur.

This is because you are attempting to associate a loader with more than onetechnology pack or with a different version of the same technology pack, which isnot supported.


Upgrading or reinstalling installed technology packsInstructions on how to upgrading or reinstalling installed technology packs

About this task

This section covers the following scenarios:v The technology pack release and data source version is different to the installed

technology packs.v The technology pack release is different but the data source version is the same

as the installed technology packs.v Reinstalling existing technology packs.

To upgrade or reinstall installed technology packs:

Procedure1. Check which loaders are running by using the following command as user

virtuo:sap disp

2. Stop all loaders by using the following command for each loader process asuser virtuo:sap stop <loader name>

Note: If all loaders are not stopped when you try to upgrade the technologypack, the NC tables are not updated.

3. If you are reinstalling existing technology packs, back up existing loadmaps toallow the new technology packs to be deployed correctly.Back up and move the technology pack directories in $WMCROOT/admin/techpacks to $WMCROOT/admin/techpacks/backup .

4. Unload existing loadmaps and loadmaps customizations.Run a full loadmap dump by running the following command:lcm_admin -unload backup_loadmaps.xml -datasource <datasource_name> -dsversion<datasource_version> -techpack <techpack_name> -tpversion <techpack_version>-type <Neutral or Vendor>

Back up any loadmap customizations by running the following command:lcm_admin -unloadcustom custom_loadmaps.xml -datasource <datasource_name>-dsversion <datasource_version> -techpack <techpack_name>-tpversion <techpack_version> -type <Neutral or Vendor>

5. To avoid conflicts, remove or rename the technology pack .remove scripts in$WMCROOT/admin/software that have the same name as the technology packsyou are about to install.

6. Read the new technology pack ReadMe file for specific instructions for thenew technology pack.

7. Export and remove Stored Busy Hours (SBH) and Complex Summarydefinitions. For more information on how to do this, see “summary_adminCLI” on page 224. Ensure that all exports and removals are complete beforeproceeding to uninstall the technology packs.

8. Uninstall the technology packs in reverse order of installation or according totheir dependencies.

9. Run the following command to retrieve the list of technology packs installed.The dependencies between technology packs are listed also.techpack_admin -l installed


Note: A technology pack cannot be uninstalled if it has dependent technologypacks installed.

10. Run the following command to verify that BUSYHOUR and SUMMARY tasksare not running before you disable them. If tasks are running, allow them tocomplete before proceeding.agent_admin -u sysadm -p <sysadm_password> -list current...12:48:55,055 INFO [AgentTool] Login...Activity Run Type Data Source State Cancel Active StartEnd Data Start Data End Attempt Retry Entity Label

8 182 DICTIONARY <server>.com-rs DISABLED N 2009-05-15 12:26:00null null null null 1 N null Data dictionary import

10 177 BUSYHOUR <server>.com-rs DISABLED N 2009-05-15 12:41:00null null null null 1 N null Busy Hour calculation

2 353 PROCEDURE <server>.com SCHEDULED N 2009-05-15 12:50:00null null null null 1 N null Temporary report and schedule cleanup

4 2112 SWEEPER <server>.com SCHEDULED N 2009-05-15 12:55:00null null null null 1 N null Unused file deletion

5 352 LDAP_SYNC <server>.com SCHEDULED N 2009-05-15 12:59:00null null 2009-04-30 19:26:52 null 1 N null Ldap synchronization

9 178 SUMMARY <server>.com-rs DISABLED N 2009-05-15 13:05:00null null null null 1 N null Summary computations

1 354 PROCEDURE <server>.com SCHEDULED N 2009-05-15 13:35:00null null null null 1 N null Agent activity cleanup

3 15 PROCEDURE <server>.com SCHEDULED N 2009-05-16 02:00:00null null null null 1 N null Datasource cleanup

11. The activity ID of the BUSYHOUR and SUMMARY agents. In the aboveexample, the BUSY HOUR ID is 10 and the SUMMARY ID is 9. Disable themas follows:agent_admin -u sysadm -p <sysadm_password> -disable <BUSYHOUR ID>

agent_admin -u sysadm -p <sysadm_password> -disable <SUMMARY ID>

12. To uninstall the list of technology packs, run the following for each technologypack installed:techpack_admin -u techpack -n <old_techpack_name>

13. Deploy the new set of technology packs using the procedure in Installing theTechnology Pack Step 1 of the Insatllin gTivoli Netcool Performance Manager -Wireless Component .

14. If you are upgrading a set of installed technology packs with a newtechnology pack version but the same datasource name and version, you needto complete this step if you want to keep your existing loadmaps.Otherwise, skip to “Unsupported upgrade scenario” on page 251. To keepyour existing loadmaps, move the newly deployed loadmaps out of the$WMCROOT/admin/techpacks/<techpack>/<release>/loadmaps directory so thatthey will not be automatically installed when you apply the technology packsin “Unsupported upgrade scenario” on page 251.

15. Apply the technology packs by running the following command as uservirtuo :techpack_admin -a

16. Check the following logs for errors or failure messages:$WMCROOT/logs/vmm/vmm-server.log*


17. Check the unloaded loadmap customizations for reapplying, if necessary. Thismay not be required as customizations may be included in the new loadmap,by default.

18. If alarms are provisioned on the old technology pack, run the migratealarmstool to migrate all alarms definitions and states from the old technology pack,otherwise continue to the next step.

19. If you are upgrading technology packs with a different data source version,list the loaders and if required, delete any unwanted older versions of theloader:sap disploader_admin -delete -techpack <old_techpack_name> -tpverison <old_techpack_name>lcm_admin -delete <datasource_xml>

Note: The loader_admin -delete command replaces the techpack_admin -uloader command used in previous versions of Tivoli Netcool PerformanceManager.

20. If you unloaded Summary Definitions when uninstalling the old version ofthe technology pack, then reload them using the -ignoreaggr option. Reloadthe exported SBH definitions also.

Note: Any import failures due to technology pack upgrade changes need tobe amended in the definitions and re-imported.

21. As user root, run the following commands:

vsvcs sapmgr-nasvcadm disable sapmgr-nasvcs sapmgr-nasvcadm enable sapmgr-nasvcs sapmgr-na

vservice sapmgrvirtuo statusservice sapmgrvirtuo stopservice sapmgrvirtuo statusservice sapmgrvirtuo startservice sapmgrvirtuo status

v/etc/rc.d/init.d/sapmgrvirtuo status/etc/rc.d/init.d/sapmgrvirtuo stop/etc/rc.d/init.d/sapmgrvirtuo status/etc/rc.d/init.d/sapmgrvirtuo start/etc/rc.d/init.d/sapmgrvirtuo status

22. If multiple instances of a loader are required, refer to Configuring multipleidentical loaders in the Installing Tivoli Netcool Performance Manager - WirelessComponent.

23. Start all relevant loaders:sap dispsap start <sap loader name>

24. Stop and re-start the NC cache to apply any changes to NC attributes andmappings:sap stop nc_cachesap start nc_cache

25. Import any newly delivered SBH and Summary Definitions that are suppliedwith the upgraded technology packs if they are required. Decide if you needthe new definitions based on a comparison of the existing summaries and


SBH definitions that were supplied with the old technology pack, and anychanges supplied with the new definitions.Enable the agents for running the summaries and SBHs as follows:agent_admin -u sysadm -p <sysadm_password> -enable <SUMMARY ID>agent_admin -u sysadm -p <sysadm_password> -enable <BUSYHOUR ID>

26. Check the technology pack readme files for potential effects on your system asdiscussed in “Effects of a technology pack upgrade” on page 251. The nexttime you run SBH or Summary definitions, check the completion status anderror logs for potential errors due to technology pack changes, such asrenamed or deleted KPIs.

Using the migratealarms toolThe migratealarms tool migrates all alarms definitions and states from an oldtechnology pack version to a new version.

Run the migratealarms tool after the technology pack is upgraded and before theold loader definitions are removed. Run the migratealarms tool for everytechnology pack upgrade.Usage: -type migratealarms -otn <"old techpack name"> -otv <old techpack version>ntn <"new technology pack name"> -ntv <new technology pack version>

-type migratealarms Mandatory specifies what function tool is to perform-otn Mandatory,old techpack nameDouble quotes must be used if the name of the techpack name containsspaces-otv Mandatory,old techpack version-ntn Mandatory,new techpack name

Double quotes must be used if the name of the techpack name containsspaces

-ntv Mandatory,new techpack version

Example

Running this command updates all ruleset_ids for the old technology packalarms and updates them with the ruleset_ids for the new technology packalarms.$WMCROOT/admin/techpackupgrade/techpack_upgrade -type migratealarms-otn UMTS_Ericsson_UTRAN_P5 -otv 2.0.0.0 -ntn “Ericsson UMTS UTRAN” -ntv 3.0.0

You are prompted to turn off the nc_cache and alarm_cache processes, and allloaders.$WMCROOT/admin/techpackupgrade/techpack_upgrade -type migratealarmsThe nc_cache, alarm_cache and all loaders should not be running ifthe migratealarms command is to be ran.Check sap to determine if these processes are still running. If they are thenstop them.Are all the above processes stopped <y or n> ?

Answer Y to enable all alarms to be migrated correctly.


Gomlet upgrade featureThe Gomlet upgrade feature allows the upgrade of a Gomlet to proceed withoutthe reactivation, reinstalling or bouncing of the larger dependent technology packs.

The Gomlet upgrade feature allows the upgrade of a Gomlet to proceed withoutthe reactivation, reinstalling or bouncing of the larger dependent technology packs,thus allowing:v Seamless upgrades of Gomlets without major disruption to the other technology

packs.v Avoidance of time consuming TP upgrade procedures on customer sites with a

large amount of technology packs leading to significant downtime for thecustomer.

Note: Not all Gomlet upgrade scenarios are supported by this feature. Scenariosoutside those listed below are not supported.

Supported Gomlet upgrade scenariosA list of the supported Gomlet upgrade scenarios.v Add Entityv Add attributev Add classv Add Dependencyv Add Relationsv Field Description changev Remove Relationsv Column Extend - including Primary key column extensionv Change in prerequisite module or compatible release

Scenarios which are supported if there are no dependenttechnology packs

A dependency may exist due to a dependent technology packs or Gomlet (installedon the system being upgraded) referencing the upgrade item.

The following scenarios will only succeed if there are no dependent technologypacks.v Remove Entityv Remove attributev Remove classv Remove Dependencyv Rename Entityv Rename attributev Rename classv Changes at object level, hierarchy changesv Changes to discriminators - changing technology,vendor, qualifier or subsystem

in child definitionsv Move Entity


Note: These scenarios, for example, Moving or removing an entity can have amajor impact on a customer system when the upgraded Gomlet is applied. Prior tomaking these type of changes to a Gomlet, a full impact analysis must be done,particularly on the impact of the change on the following:v - Entityv - Hierarchyv - Loadmapv - Gatewayv - Existing customer data

Unsupported scenariosA list of unsupported scenarios.v Primary Key Column renamev Field aggregator changev Decrease in column sizev Rename field header or header2v Change in datatype. For example, Integer to Stringv Movement of an entity from one technology to another - changing

technology,vendor, qualifier or subsystem in Module information



Appendix A. Problem resolution and errors

Describes potential errors and problem resolution.

Problem resolutionDescribes problem resolution.

Running multiple instances on the same serverResolving problem encountered when running multiple instances on the sameserver.

If there are multiple Tivoli Netcool Performance Manager instances on the sameserver then the names used for each performance database must be different.Otherwise, each loader tries to attach to the same database.

Duplicate lc_relations entriesResolving the problem of duplicate lc_relations entries

Problem

Because there is no unique index on the lc_relations table, it is possible to createduplicate entries in this table. If this reoccurs on an ongoing basis, the number ofrecords in this table can grow exponentially. This in turn can result in slow loaderstart up.

Resolution

You can avoid it by deleting the duplicate entries from the table. The followingquery can be used to identify duplicate entries:select source_tabname, nc_tabname, access_key, master_tabname, count(*)from lc_relationsgroup by source_tabname, nc_tabname, access_key,master_tabnamehaving count(*) > 1

Unresponsive script errorWhen a very large report an unresponsive script error may be seen.

If the user clicks on the Continue option in the Warning dialog, the reportcompletes as normal.

This error occurs using the Mozilla Firefox browser. There is a browser setting toincrease the time given to a java script.

To Change the setting on a Mozilla Firefox browser.1. Open the page about:config.

Do this by typing about:config in to the Location bar address field.2. Change the setting dom.max_script_run_time to 20 seconds. This should be

sufficient for all java scripts.


This problem has not been seen on Internet Explorer.

Adobe Flash PlayerWhen the user interface is accessed for the first time and Adobe® Flash player isnot installed on the system, it should install automatically.

However, on a computer that has been upgraded from Windows XP to WindowsVista, Flash Player fails to install automatically and must be manually installed.After the installation, Tivoli Netcool Performance Manager works correctly.

ErrorsDescribes potential errors.

SQLFatalErrorException: ORA-28000: the account is lockedA potential installation error.

This error is expected to appear in log files under /appl/oracle/product/12.1.0.2.0/db_1/cfgtoollogs/emca/vtdb/ during application setup and can besafely ignored.

OutOfMemoryError: Java heap spaceA potential installation error. This error is seen when you run Tivoli NetcoolPerformance Manager Java client processes.

This error can occur when you install or upgrading large technology packs andwhen you use the sbh_sk_remover tool.java.lang.OutOfMemoryError: Java heap space

This problem is resolved by increasing the memory available to Java clientprocesses. Available memory is increased by amending the ANT_OPTS variable.

To increase available memory for Java client processes:1. Run the following command:


2. Rerun the client process.For example, rerun the technology pack installation:techpack_admin -a

3. After the client process completes successfully, reset the ANT_OPTS variable to itsoriginal value:unset ANT_OPT

If you are installing or upgrading a large technology pack, it is recommended thatyou set the ANT_OPTS variable to a value of 1G before installation. Do not allow theinstallation to fail before you increase the ANT_OPTS value.

Note: You do not need to stop and restart the application server after you reset theANT_OPTS value.

Confirming the correct setting is being usedA potential installation error. To confirm the correct memory setting is being used,run a Java client tool and then check how much memory the process has beenassigned.


In the example below the ANT_OPTS variable has been set to 512m.

To confirm the correct memory setting is being used:1. Run the following commands:

techpack_admin -l installed &ps -ef | grep java

Example output:virtuo 1492 25435 2 09:12:55 pts/2 0:03 /appl/virtuo/jre/bin/java -Xmx512m-classpath /appl/virtuo/ant/lib/ant-launcher

In this example the correct setting that is used is 512m.

Appendix A. Problem resolution and errors 261


Appendix B. Cold standby

Discusses how to create a cold standby. A cold standby is a system which can, witha small amount of configuration, take over from your existing Tivoli NetcoolPerformance Manager Wireless system if a failure occurs.

A Tivoli Netcool Performance Manager Wireless cold standby mirrors theinfrastructure of your existing Tivoli Netcool Performance Manager Wirelesssystem. If your existing Tivoli Netcool Performance Manager Wireless systemexperiences a serious error, you can quickly configure the cold standby to act asfailover.

Note: In this information, primary server refers to the active Tivoli NetcoolPerformance Manager server. Standby server is the backup server on which theprimary server's configuration can be restored.

Cold standby procedures

The following are the main procedures required to create and run a cold standby:1. Set up the cold standby infrastructure to mirror your existing system.2. Implement a regular backup of the data that required for your cold standby to

act as failover.3. If a failure occur, restore the required files and data on the cold standby

system.4. Configure the cold standby into a running Tivoli Netcool Performance Manager

Wireless system.

Setup standby serverYour cold standby infrastructure must be set up to mirror the infrastructure ofyour existing Tivoli Netcool Performance Manager wireless system.

About this task

In a distributed setup, where Tivoli Netcool Performance Manager components areinstalled on separate servers, each server in the configuration must have acorresponding standby server. Therefore the primary database server requires thecreation of a corresponding standby database server, and so on for each servertype.

The standby servers must match the hardware and OS configuration of theprimary servers: Disk layout and partitions, memory, CPUs, OS patches, etc.

Procedure1. Prepare the standby servers according to the Pre-installation tasks topic in

Installing Tivoli Netcool Performance Manager- Wireless Component .After you complete these steps, the following must be setup on the standbyservers:v Required file system is createdv Ports and firewalls are configured


v Platform package is installedv Users and groups createdv Kernel parameters configured

2. Install Oracle RDBMS on the standby database server by using the steps in theInstalling Tivoli Netcool Performance Manager - Wireless Component . See InstallingOracle RDBMS and the Oracle client.

3. Install the Security Directory Server and IBM DB2 on the standby applicationserver by using the steps in the topic Installing the IBM Security Directory Serverand IBM DB2 in Installing Tivoli Netcool Performance Manager - WirelessComponent .

What to do next

Distributed installations only: Install the Oracle Client on the standby applicationserver using the steps in the topic Installing Oracle RDBMS and the Oracle client inInstalling Tivoli Netcool Performance Manager - Wireless Component .

Backup all required dataDescribes the backup procedures that you must implement.

Any references to the primary server indicate the active Tivoli NetcoolPerformance Manager server.

Note: IBM Tivoli Monitoring Agents are not backed up as part of the TivoliNetcool Performance Manager Cold Standby procedure. Any IBM TivoliMonitoring agents, which were installed on the original Tivoli NetcoolPerformance Manager server must be freshly installed and configured on the newTivoli Netcool Performance Manager server.

Backup Oracle databaseBacking up the oracle database.

Procedure1. Follow the procedures recommended by your DBA to carry out full backup of

the Tivoli Netcool Performance Manager database. Ensure that backups areperformed regularly and the media is stored in a location where they can berestored to the standby server.

2. In addition to the Oracle database files, take backups of the following files anddirectories from the primary database server and copy to a suitable location onthe standby database server:

v /etc/oratab

v /var/opt/oracle/oratab

All platforms:v $ORACLE_HOME/network/admin/listener.ora

v $ORACLE_HOME/network/admin/tnsnames.ora

v $ORACLE_HOME/network/admin/sqlnet.ora

v $ORACLE_BASE/admin directoryv $ORACLE_HOME/dbs directory


v $HOME/.profile for oracle user

Backup Tivoli Common ReportingBackup the Tivoli Common Reporting component on the primary server.

Export Cognos configurationExport the Cognos configuration from Tivoli Common Reporting in unencryptedformat.

Procedure1. Set and export the DISPLAY environment variable.2. Run the following commands as root on the primary server where Tivoli

Common Reporting is installed:bashcd <Cognos directory>/bin64

Where:v <Cognos directory> is the location where the Cognos component is installed,

for example, /opt/IBM/JazzSM/reporting/cognos.3. Start the Cognos configuration tool:

export JAVA_HOME=<TIP_DIR>/java/jre./tcr_cogconfig.sh

4. The Cognos configuration tool starts up. Select File > Export As....5. Click Yes at the prompt.6. Save the export file as cogstartup.xml.7. Click Close when the export process has completed.8. Close the Cognos configuration tool by selecting File > Exit.9. Copy the exported cogstartup.xml file to the standby server.

Backup Tivoli Common Reporting installationBackup the Tivoli Common Reporting component installation.

Procedure1. Stop the Tivoli Common Reporting processes as user root:v cd /opt/IBM/JazzSM/profile/binv ./stopServer.sh server1 -username <WAS_admin> -password <WAS_admin>

Where <n> is the numeric identifier of the Tivoli Common Reporting server thatyou are stopping.

2. Take a backup of the following folder: /opt/IBM/JazzSM

Backup Tivoli Netcool Performance Manager applicationsBacking up the Tivoli Netcool Performance Manager applications.

Procedure1. As the virtuo user, shut down the applications on the primary application

server.sap stop -f

2. As root user, stop the appication services on the primary application server.

vsvcadm disable sap-na sapmgr-na sapmon-na

Appendix B. Cold standby 265

vservice sapvirtuo stop

service sapmgrvirtuo stopservice sapmonvirtuo stop

v/etc/rc.d/init.d/sapvirtuo stop/etc/rc.d/init.d/sapmgrvirtuo stop/etc/rc.d/init.d/sapmonvirtuo stop

3. Backup the $WMCROOT directory of the Tivoli Netcool Performance Managerprimary servers.This is the location where the Tivoli Netcool Performance Manager applicationis installed (default is /appl/virtuo)

Note: Backup $WMCROOT on all primary servers.4. Backup the application services as follows:

vbackup the SMF service manifests and startup methods for the applicationcomponents.The files for backup are:– /var/svc/manifest/site/application/virtuo/database-na.xml (For a

distributed install this file is located on the database server.)– /var/svc/manifest/site/application/virtuo/sap-na.xml

– /var/svc/manifest/site/application/virtuo/sapmgr-na.xml

– /var/svc/manifest/site/application/virtuo/sapmon-na.xml

– /lib/svc/method/virtuo/dboravirtuo (For a distributed install this file islocated on the database server.)

– /lib/svc/method/virtuo/sap_na

– /lib/svc/method/virtuo/sapmgr_na

– /lib/svc/method/virtuo/sapmon_na

v– /etc/rc.d/init.d/dboravirtuo

– /etc/rc.d/init.d/sapmgrvirtuo

– /etc/rc.d/init.d/sapmonvirtuo

– /etc/rc.d/init.d/sapvirtuo

5. Backup the virtuo and root user crontab files on all primary servers.

v/var/spool/cron/crontabs/root

/var/spool/cron/crontabs/virtuo

v/var/spool/cron/root

/var/spool/cron/virtuo

6. Backup ${HOME}/.profile for the virtuo user on all servers.


Backup LDAP dataBacking up the Tivoli Netcool Performance Manager LDAP data.

Procedure1. Backup the LDAP configuration data from Security Directory Server.

Run the following command as virtuo on the primary application server (orthe server on which the Security Directory Server is installed):/opt/IBM/ldap/<version>/sbin/idsdb2ldif -o output_file

Where <version> must be set to the version number of LDAP.2. Copy the generated output_file to the standby server.

Restore all required data to the cold standbyDescribes the restore procedure for the standby server.

Oracle database restore procedureRestore procedure for the Oracle database.

Procedure1. Follow the procedures recommended by your DBA to restore the Tivoli

Netcool Performance Manager database so that it is in a consistent state onthe standby database server.If you are using on-line database backup, apply all available archived redo logfiles and open the database with the RESETLOGS instance start up commandswitch.

2. Copy the backed up oratab file to /etc/ (Linux/AIX) or /var/opt/oracle/(Solaris).

3. Copy the following files, which are backed up from the primary server, to${ORACLE_HOME}/network/admin on the standby database server:v listener.ora,v sqlnet.ora andv tnsnames.ora

Distributed installations only: Copy tnsnames.ora from the primaryapplication server to ${ORACLE_HOME}/network/admin on the standbyapplication server.

Note: Make sure the permissions and ownership of these files are same asthey are on the primary server after they are copied.

4. Update the host names in the tnsnames.ora and listener.ora files.sed "s/primarydbhost/standbydbhost/g" ${ORACLE_HOME}/network/admin/tnsnames.ora> ${ORACLE_HOME}/network/admin/tnsnames.ora.N

mv -f ${ORACLE_HOME}/network/admin/tnsnames.ora.N${ORACLE_HOME}/network/admin/tnsnames.ora

sed "s/primarydbhost/standbydbhost/g" ${ORACLE_HOME}/network/admin/listener.ora> ${ORACLE_HOME}/network/admin/listener.ora.N

mv -f ${ORACLE_HOME}/network/admin/listener.ora.N${ORACLE_HOME}/network/admin/listener.ora

Where you substitute the primarydbhost and standbydbhost with the actualhost names of the standby and primary servers.Distributed installations only: update the tnsnames.ora on the standbyapplication server


5. Copy the oracle user .profile to the oracle user's ${HOME} directory.

Note: Do this on both application server and database server.6. Copy the virtuo user .profile to the virtuo user's ${HOME} directory.

Note: Do this on both application server and database server.7. Copy the contents of the backed up ${ORACLE_HOME}/dbs directory to

${ORACLE_HOME}/dbs.


8. Copy the contents of the backed up ${ORACLE_BASE}/admin directory to${ORACLE_BASE}/admin.


9. Restore the database service:

va. As root user, create the directory /var/svc/manifest/site/application/

virtuo if it does not already exist:mkdir -p /var/svc/manifest/site/application/virtuo

b. Copy the SMF manifest database-na.xml to /var/svc/manifest/site/application/virtuo.

c. Set the correct permissions and ownership on the files using thecommands:chown root:sys /var/svc/manifest/site/application/virtuo/database-na.xml

chmod 440 /var/svc/manifest/site/application/virtuo/database-na.xml

d. As root user, create the directory /lib/svc/method/virtuo if it does notalready exist:mkdir -p /lib/svc/method/virtuo

e. Copy the method dboravirtuo to /lib/svc/method/virtuo.f. Set the correct permissions and ownership on the file using the

commands:chown root:bin /lib/svc/method/virtuo/dboravirtuo

chmod 555 /lib/svc/method/virtuo/dboravirtuo

g. As root user, import the service manifest using the command:svccfg import /var/svc/manifest/site/application/virtuo/database-na.xml

Note: The database-na service will start automatically on Solaris

va. As root user, copy the dboravirtuo script to /etc/rc.d/init.d.b. Set the correct permissions and ownership on the files using the

commands:chmod 755 /etc/rc.d/init.d/dboravirtuo

chown root:root /etc/rc.d/init.d/dboravirtuo

c. Create links in rc directories using the following commands for Linuxand AIX®:

–ln -s /etc/rc.d/init.d/dboravirtuo /etc/rc0.d/K10dboravirtuo


ln -s /etc/rc.d/init.d/dboravirtuo /etc/rc3.d/S89dboravirtuo

ln -s /etc/rc.d/init.d/dboravirtuo /etc/rc5.d/S89dboravirtuo

–ln -s /etc/rc.d/init.d/dboravirtuo /etc/rc.d/rc2.d/K10dboravirtuo

ln -s /etc/rc.d/init.d/dboravirtuo /etc/rc.d/rc2.d/S89dboravirtuo

10. Start up the database service: /etc/rc.d/init.d/dboravirtuo start

Updating database tablesUpdate the database to change any references to the original server.

Procedure1. As the virtuo user, start SQLPLUS:

sqlplus virtuo/virtuo_password@vtdb

2. Run the following to view the current data source configuration:column datasource_name format a35

column hostname format a35

select datasource_name, hostname from pe_datasource;

The output will be similar to:

DATASOURCE_NAME HOSTNAME

----------------------------------------------------

primaryappserver primaryappserver

primaryappserver-rs primaryappserver

Note: The names of the data sources and host names, the host name mustmatch that of the primary application server. Also note that one of the datasources will have the server host name with '-rs' appended.

3. Run the following commands to update these values, substitutingstandbyappserver and primaryappserver with the actual host names of thestandby and primary servers.update pe_datasource set datasource_name = ’standbyappserver’where datasource_name = ’primaryappserver’;

update pe_datasource set datasource_name = ’standbyappserver-rs’where datasource_name = ’primaryappserver-rs’;

update pe_datasource set hostname = ’standbyappserver’where hostname = ’primaryappserver’;

4. Run the following command to update the loader configuration:update lc_loader_config_properties set value = ’standbyappserver’

where name = ’alarmcache.host’ or name = ’alarmcache.srv.host’or name = ’mastercache.host’;


Restoring Tivoli Common ReportingPerform the following to restore the Tivoli Common Reporting directories.

Procedure1. Restore the backed up Tivoli Common Reporting directories and the two

deployment engine directories in the same locations as on the primary server.2. Copy the unencrypted cogstartup.xml file from the primary server into the

directory:/opt/IBM/JazzSM/reporting/cognos/configuration

3. Edit the cogstartup.xml file and replace the host name of the primary TivoliCommon Reporting server with that of the standby Tivoli Common Reportingserver.

4. Edit the following files and replace all occurrences of the primary TivoliCommon Reporting server host name with that of the standby Tivoli CommonReporting server:v /opt/IBM/JazzSM/profile/config/cells/JazzSMNode01Cell/nodes/

JazzSMNode01/serverindex.xml

v /opt/IBM/JazzSM/profile/config/cells/JazzSMNode01Cell/security.xml

v /opt/IBM/JazzSM/commonpackservice/conf/biserviceclient.properties

5. Edit the following files and replace all occurrences of the primary databaseserver host name with that of the standby database server:v /opt/IBM/JazzSM/profile/config/cells/JazzSMNode01Cell/resources.xml

v /opt/IBM/JazzSM/commonpackservice/conf/profile.properties

v /opt/IBM/JazzSM/commonpackservice/conf/dbconfig.xml

6. If you have configured Tivoli Common Reporting to use an LDAP userrepository and the LDAP server has changed, edit the following file and changethe LDAP server host name:/opt/IBM/JazzSM/profile/config/cells/JazzSMNode01Cell/wim/config/wimconfig.xml

Restore applicationsRestore the applications.

Procedure1. Restore the backed up $WMCROOT directory on the standby server.2. Replace the primary DB server host name with the standby DB server host

name in the following files:v ${WMCROOT}/conf/dbconnection/vtdb.properties

v ${WMCROOT}/conf/as/as-default.properties

v ${WMCROOT}/conf/alarm_external_api/alarmapi.properties

v ${WMCROOT}/as/server/default/deploy_core/na-defds-ds.xml

v ${WMCROOT}/as/server/default/deploy_core/na-alarm-ds.xml

3. Replace the primary application server host name with the standby applicationserver host name in the following files:v ${WMCROOT}/conf/environment/default.properties

v ${WMCROOT}/conf/alarm_external_api/alarmapi.properties

v ${WMCROOT}/conf/ldap/default.properties

v ${WMCROOT}/conf/as/ldap-default.properties


v ${WMCROOT}/conf/as/jndi-default.properties

4. Copy the file ${WMCROOT}/as/server/default/deploy_core/na-${primaryappserver}-rs-ds.xml to a new file named ${WMCROOT}/as/server/default/deploy_core/na-${standbyappserver}-rs-ds.xml.a. In the new file, replace the primary DB server host name with the standby

DB server hostname.b. Change the ownership of the new file to virtuo:virtuo.c. Remove the file ${WMCROOT}/as/server/default/deploy_core/na-

${primaryappserver}-rs-ds.xml.d. Edit the new file by changing the following:

<jndi-name>ProspectDS/<primaryappserver>-rs</jndi-name>

to be:<jndi-name>ProspectDS/<standbyappserver>-rs</jndi-name>

5. Copy the file ${WMCROOT}/as/server/default/deploy_core/na-${primaryappserver}-ds.xml to a new file named ${WMCROOT}/as/server/default/deploy_core/na-${standbyappserver}-ds.xml.a. In the new file, replace the primary DB server host name with the standby

DB server hostname.b. Change the ownership of the new file to virtuo:virtuo.c. Remove the file ${WMCROOT}/as/server/default/deploy_core/na-

${primaryappserver}-ds.xml.d. Edit the new file by changing the following:

<jndi-name>ProspectDS/<primaryappserver></jndi-name>

to be:<jndi-name>ProspectDS/<standbyappserver></jndi-name>

6. Restore the root and virtuo user crontabs.

v/var/spool/cron/crontabs/root/var/spool/cron/crontabs/virtuo

v/var/spool/cron/root/var/spool/cron/virtuo

7. Restart the cron daemon.

vsvcadm restart cron

vservice crond restart

vkill `ps -ef | grep /usr/sbin/cron | grep -v grep | awk ’{print $2}’`

8. Edit the root crontab and change the host name of the primary database serverto that of the standby database server.


Restore directory serverCreate the Directory Server schema on the standby application server.

About this task

Perform the following to restore the Directory Server:

Note: If the domain name of the standby server and the primary server are thesame skip to step 3.

Procedure1. If primary and standby domain names are different, check the value of the

LDAPROOT parameter from the primary server.Run this command to get the value:awk -F"/" ’/^java.naming.provider.url/ { print $NF }’ $WMCROOT/conf/ldap/default.properties

The value returned must be in the form "dc=x,dc=y,dc=z" where x.y.z is theserver's domain name.For example, if the domain name is ibm.com then the LDAPROOT parameter isdc=ibm,dc=com.

2. If primary and standby domain names are different, edit the script$WMCROOT/admin/ds/bin/create_ds_schema.a. Locate the following line:

export LDAPROOT LDAPHOST LDAPPORT DBHOST DBIPADDR

b. Insert the following line before this:LDAPROOT=$(awk -F"/" ’/^java.naming.provider.url/ { print $NF }’$WMCROOT/conf/ldap/default.properties)

c. Save the file.3. Remove the install_schema.done file to allow the schema to be installed:

rm $WMCROOT/admin/ds/schema/install_schema.done

4. As virtuo user, run the script $WMCROOT/admin/ds/bin/create_ds_schema.Respond to the prompts with the required parameters.

Note: Ensure that you enter the same password for the sysadm user as wasused on the primary server.

5. Copy the exported SDS LDIF file containing the LDAP data to the standbyserver. Update the host names in the file using the following command:sed -e "/cn=crypto/,/^$/"d -e "s/primaryappserver/standbyappserver/g"-e "s/primarydbserver/standbydbserver/g" ldap_export_file > ldap_import_file

Where:v primaryappserver is the actual host name of the primary application server.v standbyappserver is the actual host name of the cold standby application

server.v primarydbserver is the actual host name of the primary db server.v ldap_export_file is the output_file backed up in “Backup LDAP data” on

page 267.If it is a stand-alone system, use the following command:sed -e "/cn=crypto/,/^$/"d -e "s/primaryserver/standbyserver/g"ldap_export_file > ldap_import_file

Where:v primaryserver is the actual host name of the primary server.


v standbyserver is the actual host name of the cold standby server.v ldap_export_file is the output_file backed up in “Backup LDAP data” on

page 267.6. Import the LDAP data as user virtuo with the following command:

/opt/IBM/ldap/sds_version/bin/idsldapmodify -c -a -k -h standbyserver-p ldapport -D "cn=Directory Manager" -w password -f ldap_import_file

Where:v standbyserver is the actual host name of the cold standby server.v sds_version is the installed version of Security Directory Server (for example,

6.4).v ldapport is the LDAP port number (for example, 1389).v password is the password for the cn=Directory Manager user.v ldap_import_file is the import file created in step 4.

Note: Before you import the LDAP data, make sure <primary servername>does NOT exist in the ldap_import file; for example, search for it using acommand like the following: grep <primary servername> ldap_import_file.

Restore application servicesRestore the application services.

Procedure

v1. As root user, copy the following SMF manifests to /var/svc/manifest/site/

application/virtuo:– sap-na.xml

– sapmgr-na.xml

– sapmon-na.xml

2. As root user, run the commands:chown root:sys /var/svc/manifest/site/application/virtuo/*-na.xml

chmod 440 /var/svc/manifest/site/application/virtuo/*-na.xml

3. As root user, copy the following methods to /lib/svc/method/virtuo:– sap_na

– sapmon_na

– sapmgr_na

4. As root user, run the commands:chown root:bin /lib/svc/method/virtuo/*virtuochown root:bin /lib/svc/method/virtuo/*_nachmod 555 /lib/svc/method/virtuo/*virtuochmod 555 /lib/svc/method/virtuo/*_na

5. As root user, Import the service manifests using the following commands:svccfg import /var/svc/manifest/site/application/virtuo/sapmon-na.xml

svccfg import /var/svc/manifest/site/application/virtuo/sapmgr-na.xml

svccfg import /var/svc/manifest/site/application/virtuo/sap-na.xml

v1. As root user, copy the following scripts to /etc/rc.d/init.d:

– sapvirtuo


– sapmgrvirtuo

– sapmonvirtuo

2. As root user, run the commands:chmod 755 /etc/rc.d/init.d/*virtuo

chown root:root /etc/rc.d/init.d/*virtuo

What to do next

Create links in rc directories:

Note: If any of the following links already exist there is no need to recreate them.

vln -s /etc/rc.d/init.d/sapmonvirtuo /etc/rc2.d/K14sapmonvirtuo

ln -s /etc/rc.d/init.d/sapmonvirtuo /etc/rc3.d/S96sapmonvirtuo

ln -s /etc/rc.d/init.d/sapmonvirtuo /etc/rc5.d/S96sapmonvirtuo

ln -s /etc/rc.d/init.d/sapmgrvirtuo /etc/rc2.d/K13sapmgrvirtuo

ln -s /etc/rc.d/init.d/sapmgrvirtuo /etc/rc3.d/S98sapmgrvirtuo

ln -s /etc/rc.d/init.d/sapmgrvirtuo /etc/rc5.d/S98sapmgrvirtuo

ln -s /etc/rc.d/init.d/sapvirtuo /etc/rc2.d/K12sapvirtuo

ln -s /etc/rc.d/init.d/sapvirtuo /etc/rc3.d/S99sapvirtuo

ln -s /etc/rc.d/init.d/sapvirtuo /etc/rc5.d/S99sapvirtuo

vln -s /etc/rc.d/init.d/sapmonvirtuo /etc/rc.d/rc2.d/K14sapmonvirtuo

ln -s /etc/rc.d/init.d/sapmonvirtuo /etc/rc.d/rc2.d/S96sapmonvirtuo

ln -s /etc/rc.d/init.d/sapmgrvirtuo /etc/rc.d/rc2.d/K13sapmgrvirtuo

ln -s /etc/rc.d/init.d/sapmgrvirtuo /etc/rc.d/rc2.d/S98sapmgrvirtuo

ln -s /etc/rc.d/init.d/sapvirtuo /etc/rc.d/rc2.d/K12sapvirtuo

ln -s /etc/rc.d/init.d/sapvirtuo /etc/rc.d/rc2.d/S99sapvirtuo

Configure and run the cold standbyDescribes the procedure by which you configure and start standby server.

Run reset_scheduler scriptRun the reset_scheduler script

Procedure1. Copy the reset_scheduler script to a suitable location on the standby database

server.2. Make the script executable and run the script as virtuo as follows:

reset_scheduler -sid oracle_sid

Replace oracle_sid with the Oracle database identifier (by default this is"vtdb").


Results

The script proceeds to reset the schedules in the database.

Start applicationsRestart all applications.

Procedure

vEnsure all services are running:svcadm enable database-na sds-na sapmgr-na sapmon-na sap-na


service sdsna start

service sapmonvirtuo start

service sapmgrvirtuo start

service sapvirtuo start


v/etc/rc.d/init.d/sdsna start

/etc/rc.d/init.d/dboravirtuo start

/etc/rc.d/init.d/sapmonvirtuo start

/etc/rc.d/init.d/sapmgrvirtuo start



What to do next

As virtuo on all platforms, check the process status by running the following:sap disp

The standby servers have now been restored fully and are ready to use.



Notices

This information was developed for products and services offered in the US. Thismaterial might be available from IBM in other languages. However, you may berequired to own a copy of the product or product version in that language in orderto access it.

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-1785US

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

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 jurisdictions do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement maynot apply to 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


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 provide 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 Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

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.

The performance data discussed herein is presented as derived under specificoperating conditions. Actual results may vary.

The client examples cited are presented for illustrative purposes only. Actualperformance results may vary depending on specific configurations and operatingconditions.

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.

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 actual people or business enterprises is entirelycoincidental.

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:

© (your company name) (year).Portions of this code are derived from IBM Corp. Sample Programs.© Copyright IBM Corp. _enter the year or years_.

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 "Copyright andtrademark information" 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.

Notices 279

http://www.ibm.com/legal/us/en/copytrade.shtml

Java and all Java-based trademarks and logosare trademarks or registered trademarks ofOracle 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.

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.


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.

Notices 281


IBM®

Printed in USA