BMC 2.7 Performance Manager Portal, 2.7 Remote Service Monitor Monitoring and Management Guide

BMC Performance Manager Portal
Monitoring and Management Guide
Supporting
BMC Performance Manager Portal 2.7
Remote Service Monitor 2.7
April 2009
www.bmc.com
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information
about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address
BMC SOFTWARE INC
2101 CITYWEST BLVD
HOUSTON TX 77042-2827
USA
Telephone
713 918 8800 or
800 841 2031
Fax
(01) 713 918 8000
Fax
713 918 8000
Outside United States and Canada
Telephone
(01) 713 918 8800
© Copyright 2009 BMC Software, Inc.
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent
and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and
logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the
property of their respective owners.
ITIL® is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the
U.S. Patent and Trademark Office, and is used here by BMC Software, Inc., under license from and with the permission of OGC.
Linux is the registered trademark of Linus Torvalds.
Oracle is a registered trademark of Oracle Corporation.
Solaris, Java, JMX, JRE, and Sun are registered trademarks of Sun Microsystems, Inc., in the U.S. and several other countries.
UNIX is the registered trademark of The Open Group in the US and other countries.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is
subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted
rights notices included in this documentation.
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF
THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to
restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS
252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX
77042-2827, USA. Any contract notices should be sent to this address.
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting Customer
Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From
this website, you can
■
■
■
■
■
■
■
■
read overviews about support services and programs that BMC offers
find the most current information about BMC products
search a database for issues similar to yours and possible solutions
order or download product documentation
download products and maintenance
report an issue or ask a question
subscribe to receive proactive e-mail alerts when new product notices are released
find worldwide BMC support center locations and contact information, including e-mail addresses, fax numbers, and
telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call 800 537 1813 or
send an e-mail message to [email protected]. (In the subject line, enter SupID:<yourSupportContractID>,
such as SupID:12345). Outside the United States and Canada, contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue immediately:
■
product information
—
—
—
■
product name
product version (release number)
license number and password (trial or permanent)
operating system and environment information
—
—
—
—
—
machine type
operating system type, version, and service pack or other maintenance level such as PUT or PTF
system hardware configuration
serial numbers
related software (database, application, and communication) including type, version, and service pack or
maintenance level
■
sequence of events leading to the issue
■
commands and options that you used
■
messages received (and the time and date that you received them)
—
—
—
product error messages
messages from the operating system, such as file system full
messages from related software
3
License key and password information
If you have questions about your license key or password, contact BMC as follows:
■
(USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail message to
[email protected].
■
(Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20 354 8702, or send
an e-mail message to [email protected].
■
(Asia-Pacific) Contact your BMC sales representative or your local BMC office.
4
BMC Performance Manager Portal Monitoring and Management Guide
Contents
Chapter 1
Overview of the BMC Performance Manager Portal
15
How the BMC Performance Manager Portal fits into the BMC Portal . . . . . . . . . . . .
BMC Portal features common to all modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How the BMC Performance Manager Portal monitors your infrastructure. . . . .
Methods of data collection for Performance Managers . . . . . . . . . . . . . . . . . . . . . .
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal module in the BMC Portal . . . . . . . . . . . . . . .
Remote Service Monitor program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional security for BMC Performance Manager Portal . . . . . . . . . . . . . . . . . .
Security requirements for RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infrastructure element credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
16
17
17
18
18
19
19
20
21
21
22
Chapter 2
23
Getting started with the BMC Performance Manager Portal
Verifying the BMC Performance Manager Portal installation . . . . . . . . . . . . . . . . . . .
Adding infrastructure elements for agentless monitoring . . . . . . . . . . . . . . . . . . . . . .
Verifying an upgrade from an earlier version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrating PATROL Agent data into the BMC Performance Manager Portal . . . . .
Options for identifying PATROL Agents as elements . . . . . . . . . . . . . . . . . . . . . . .
Methods for discovering PATROL Agent data. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Synchronization of thresholds and application classes . . . . . . . . . . . . . . . . . . . . . .
Integrating infrastructure elements and the BMC Atrium CMDB . . . . . . . . . . . . . . . .
Searching for objects in the BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing object status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Portal and infrastructure status views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Individual parameter history charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter history tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter filtering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
25
27
27
28
29
40
42
42
44
45
45
46
47
Chapter 3
49
Users and administrators
User configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Account Information task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Blackout Periods task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Change Password task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dashboards task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Element Profiles task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
50
50
50
50
51
51
51
5
Elements task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Monitoring On/Off task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Notifications task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Object Groups task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Personal Preferences task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Remote Service Monitors task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Shared Credentials task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Tags task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
User Groups task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Users task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Administrator configuration options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Tasks on the Accounts tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Tasks on the Provider tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Tasks on the Portal tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Chapter 4
Remote Service Monitors
69
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Types of RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Communication between the Portal and RSMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Communication between RSMs and elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Communication between RSMs and PATROL Agents . . . . . . . . . . . . . . . . . . . . . . 74
Notifications about RSM system problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
RSM program installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
RSM computer system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Data execution prevention (DEP) configuration for the RSM . . . . . . . . . . . . . . . . . 76
Configure Distributed Component Object Model (DCOM) and Windows
Management Instrumentation (WMI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Using the installation wizard to install the RSM program . . . . . . . . . . . . . . . . . . . 84
Using a silent installation to install the RSM program. . . . . . . . . . . . . . . . . . . . . . . 88
Upgrading the RSM Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Clustered RSMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Cluster types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Clustered RSM operating status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Clustered RSM security considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
RSM load-balancing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
RSM failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Clustering RSMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Clustered RSM upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
RSM configuration and maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Configuration and maintenance tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Changing the security level for an RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Configuring an RSM to use a proxy server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Configuring the RSM to use HTTP protocol to communicate with the Portal . . 101
Changing the credentials for an RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Changing the maximum heap memory allocated for the Java VM on the RSM 104
Viewing the log files for the RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Collecting log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
RSM program uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Using the installation wizard to uninstall the RSM program . . . . . . . . . . . . . . . . 106
6
BMC Performance Manager Portal Monitoring and Management Guide
Manually uninstalling the RSM program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Using command-line options to uninstall the RSM program . . . . . . . . . . . . . . . . 109
Chapter 5
Performance Managers and application classes
111
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameters and thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter thresholds and event severity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Thresholds and parameter status changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods of remote monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Agentless monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATROL Agent integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing new Performance Managers on the Portal . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading Performance Managers on the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Removing Performance Managers from the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . .
Types of Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Core Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Custom Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing unpublished custom Performance Managers . . . . . . . . . . . . . . . . . . . . . .
Editing published custom Performance Managers . . . . . . . . . . . . . . . . . . . . . . . .
112
112
113
113
114
114
115
118
120
122
123
123
124
124
131
132
132
Chapter 6
133
Reports
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter update intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Standard parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accumulated parameter values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data summarization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data retention policies that affect object view content . . . . . . . . . . . . . . . . . . . . . . . . .
Retention policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties that control the raw data retention policies . . . . . . . . . . . . . . . . . . . . .
Properties that control event history retention . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purging inactive data from the Portal history tables . . . . . . . . . . . . . . . . . . . . . . .
Purging unknown and unused events from the event table. . . . . . . . . . . . . . . . .
Reports tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Time interval controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Top N report for object groups or the account . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Health At A Glance report for elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple parameter history charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dashboard parameter charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enterprise reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Downloading and installing the Crystal Reports components. . . . . . . . . . . . . . .
Installing the reporting integration components . . . . . . . . . . . . . . . . . . . . . . . . . .
Generating reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report types and details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstalling reporting integration components . . . . . . . . . . . . . . . . . . . . . . . . . . .
Continuous data export configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Continuous data export requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
134
134
135
136
136
137
137
137
138
139
141
143
144
144
147
152
153
153
154
155
163
167
170
172
173
7
Configuring the datafeed utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Changing the retention policy for the CDE database . . . . . . . . . . . . . . . . . . . . . . . 182
Maintaining the continuous export to the CDE database . . . . . . . . . . . . . . . . . . . 182
Additional configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Chapter 7
Portal events and data integration
187
Levels of integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Portal-wide integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Provider-wide integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Account integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
BMC Atrium CMDB integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
BMC Performance Manager Portal as a CMDB Consumer . . . . . . . . . . . . . . . . . . 190
BMC Performance Manager Portal as a CMDB Provider . . . . . . . . . . . . . . . . . . . 191
Reconciliation rules for infrastructure elements and the BMC Atrium CMDB . 191
Service Model integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Event integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Event integration using email notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Event integration using SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Event integration using AlarmPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Event integration using BMC II Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Combining BMC Performance Manager and PATROL Agent events. . . . . . . . . 201
SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
MIB files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Object identifiers (OIDs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Parsing SNMP traps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
BMC-Performance-Manager-Portal-MIB description. . . . . . . . . . . . . . . . . . . . . . . 207
Trap properties customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Sample trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Trap error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Events tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
List content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Page controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Chapter 8
BMC Performance Manager Portal command-line interface
219
Preparing the client computer for the bpmcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
bpmcli syntax and arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Data-manipulation commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
addElements: adding a single element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
addElements: adding multiple elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
addPATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
deleteElements: deleting a single element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
deleteElements: deleting multiple elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
refreshDatafeedMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
refreshPATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
savePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Data-extraction commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
exportParameterHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
getApplicationsForElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
8
BMC Performance Manager Portal Monitoring and Management Guide
getElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getParameterHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getParameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getPortalVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getSubApplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A
BMC Performance Manager Portal troubleshooting and FAQs
245
246
249
250
251
253
Monitoring problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
RSM computers running Windows require permission changes . . . . . . . . . . . . . . . . 254
RSM upgrade fails on Windows 2003 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
When you use Management Profiles to integrate data, Console Server list is empty . .
256
Reinstalling the application server component of the Portal . . . . . . . . . . . . . . . . 256
Specifying RTservers for the BMC Performance Manager Portal . . . . . . . . . . . . 256
Changing the security for the BMC Performance Manager Portal . . . . . . . . . . . 257
Cannot find errors when data discovery runs as a background process. . . . . . . . . . 258
PATROL integration error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Crystal Reports Server troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Error message in Crystal Reports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Report does not contain expected data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Checking log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Frequently asked questions (FAQs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Appendix B
Monitoring the health of the Portal
265
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Self-monitoring Performance Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Service Monitor setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure RSM to monitor JMX behind a firewall . . . . . . . . . . . . . . . . . . . . . . . . .
BMC PM Monitor application classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Performance Manager configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATROL Agent health monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring PATROL Agent monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing the threshold settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
265
266
266
267
268
270
270
271
272
272
Appendix C
273
BMC Performance Manager Portal files
Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal property files . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Service Monitor property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration file properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSM log files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
273
274
274
275
295
295
295
9
10
Glossary
297
Index
305
BMC Performance Manager Portal Monitoring and Management Guide
Figures
BMC Portal with the BMC Performance Manager Portal module installed . . . . . . . 19
Account view on the Status tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Parameter history chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Parameter history table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Buttons to filter parameters on the Status tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
websdk.services.notification.ok.unknown.support property . . . . . . . . . . . . . . . . . . . 58
Types of Remote Service Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Example of RSMOptions.txt file for silent installation . . . . . . . . . . . . . . . . . . . . . . . . . 90
Clustered RSMs in the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Alert After threshold options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Performance Manager parameter mapping to Knowledge Module parameters . . 116
Affect of status changes on reported parameter values . . . . . . . . . . . . . . . . . . . . . . . 135
Standard parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Accumulated parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Top N: report settings and content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Top N: time controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Health At A Glance: Element Status Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Health At A Glance: Key Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Health At A Glance: Element Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Options for multiple parameter history charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Comparative parameter history charts for one element . . . . . . . . . . . . . . . . . . . . . . . 152
Comparative parameter history report for one parameter . . . . . . . . . . . . . . . . . . . . . 153
Example of a typical report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Continuous data export process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Data target lines in the datafeed.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Datafeed cache properties in the datafeed.properties file . . . . . . . . . . . . . . . . . . . . . . 175
Oracle properties in the datafeed.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
CSV properties in the datafeed.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
CDE database structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Simplified view of service model integration methods from the Portal . . . . . . . . . . 193
BMC Performance Manager Portal event integration . . . . . . . . . . . . . . . . . . . . . . . . . 194
Two comparable events from one threshold breach . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Sample agentless and agent-based events sent from the Portal . . . . . . . . . . . . . . . . . 203
OID structure in BMC-Performance-Manager-Portal-MIB . . . . . . . . . . . . . . . . . . . . . 205
Sample trap for an Element State Change event (part 1 of 2) . . . . . . . . . . . . . . . . . . . 213
Infrastructure element view of Events tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Alerts to Show list on Events tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Sample CSV file for adding elements with bpmcli . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Sample CSV file for deleting elements with bpmcli . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Figures
11
Using data-extraction commands to retrieve input arguments for subsequent
commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
How the Historical Data Export utility uses the startData argument . . . . . . . . . . . . 241
RSM setup for monitoring the Portal components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
12
BMC Performance Manager Portal Monitoring and Management Guide
Tables
Highlights of security levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
PATROL Agent data required in CSV file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Page controls on Status tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Application ports for firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Authentication information on Logon Information screen . . . . . . . . . . . . . . . . . . . . . . 87
Options for an RSM silent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
RSMs and clustered RSM counterparts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Icons for clustered RSM operating status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Minimum and maximum values for mapped thresholds . . . . . . . . . . . . . . . . . . . . . . 116
Differences between Performance Manager and Knowledge Module
thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Core Performance Managers and their application classes . . . . . . . . . . . . . . . . . . . . 123
Features of the Performance Managers page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Application class properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Supported collection protocols for custom application classes . . . . . . . . . . . . . . . . . 128
Charts available from the Reports tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Output controls for Reports tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Element event attributes in Health At A Glance report . . . . . . . . . . . . . . . . . . . . . . . 151
Reporting integration prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
BMC Performance Manager components required for various reports . . . . . . . . . . 156
Report schedule parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
BMC Performance Manager report details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Additional configuration options for the datafeed utility . . . . . . . . . . . . . . . . . . . . . 183
Variables for arimportcmd command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Slot names in the base event class populated for the Portal . . . . . . . . . . . . . . . . . . . 199
PATROL_Portal event class extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
BMC-Performance-Manager-Portal-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Parameter error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Types of events available for object views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Page controls for Events tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Basic arguments for bpmcli commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Data-manipulation bpmcli commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
addElements arguments for adding a single element . . . . . . . . . . . . . . . . . . . . . . . . . 224
addElements arguments for adding multiple elements . . . . . . . . . . . . . . . . . . . . . . . 227
Values required for CSV input file for the addPATROL CLI command . . . . . . . . . 228
addPATROL arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
deleteElements argument for deleting a single element . . . . . . . . . . . . . . . . . . . . . . . 231
deleteElements argument for deleting multiple elements . . . . . . . . . . . . . . . . . . . . . 232
deleteElements argument for deleting multiple elements . . . . . . . . . . . . . . . . . . . . . 233
refreshPATROL arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Tables
13
Data-extraction bpmcli commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
exportParameterHistory arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
getApplicationsForElement argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
getParameterHistory arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
getParameters argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Parameter status values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
getSubApplications argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Error messages for PATROL integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Predefined settings for monitoring the BMC Performance Manager
Portal module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
BMC PM Monitor application classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Location of BMC Performance Manager Portal property files . . . . . . . . . . . . . . . . . . 274
Properties in drmop.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Properties in the padm.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Properties in rsm-RsmHostName.properties file on the RSM computer . . . . . . . . . . 293
Properties in the rsm.properties file on the RSM computer . . . . . . . . . . . . . . . . . . . . 293
Properties in portal-PortalWebServer.properties file on the RSM computer . . . . . . 293
JMX credentials on RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
14
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
1
Overview of the BMC Performance
Manager Portal
1
This chapter describes how the BMC Performance Manager Portal fits into the BMC
Portal and the features in the BMC Performance Manager Portal.
This chapter presents the following topics:
How the BMC Performance Manager Portal fits into the BMC Portal . . . . . . . . . . . .
BMC Portal features common to all modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How the BMC Performance Manager Portal monitors your infrastructure. . . . .
Methods of data collection for Performance Managers . . . . . . . . . . . . . . . . . . . . . .
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal module in the BMC Portal . . . . . . . . . . . . . . .
Remote Service Monitor program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional security for BMC Performance Manager Portal . . . . . . . . . . . . . . . . . .
Security requirements for RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infrastructure element credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
16
17
17
18
18
19
19
20
21
21
22
How the BMC Performance Manager Portal
fits into the BMC Portal
The BMC Portal—also referred to as the Portal—is composed of a database,
application server, and web server, and provides the access point for its utilities and
modules. You access the BMC Portal from a browser on your client (desktop)
computer.
The BMC Performance Manager Portal extends the features in the BMC Portal,
enabling you to leverage both agentless technologies and the PATROL Agent to
monitor the availability and performance of your business infrastructure.
Chapter 1
Overview of the BMC Performance Manager Portal
15
BMC Portal features common to all modules
Your user permissions determine the extent to which you can configure and monitor
your Portal account. At any time, users with the applicable permissions can view
■
the current status of the infrastructure in the account
■
lists of the elements and parameters in the account that recently crossed thresholds
and triggered events
■
charts that show how well the elements in the account performed
■
a history log of the events in the account
Each object view tab provides a high-level view of the account that allows you to
access more detailed information. Icons, colors, and other graphical cues enable you
to quickly determine the source of problems.
BMC Portal features common to all modules
The BMC Portal provides many common features across all of its modules, including
■
account properties
■
object group names
■
blackout period scheduling (times when metrics are not collected from the
elements)
■
customization of notification criteria that the BMC Portal uses to determine when
to notify your personnel about problems in your environment
■
users and user groups
■
object views that provide status, events, and report data
■
dashboard configuration
■
system and user-defined tagging of objects that you can use to quickly retrieve
objects
The BMC Portal Getting Started guide and Help provide detailed information about
these features.
16
BMC Performance Manager Portal Monitoring and Management Guide
BMC Performance Manager Portal features
NOTE
For information about configuring the BMC Portal, see the BMC Portal Getting Started guide.
This guide also describes the accounts, users, and administrators, as well as authentication,
rights, and permissions.
BMC Performance Manager Portal features
The BMC Performance Manager Portal leverages agentless and PATROL Agent
technologies to monitor and report on the performance of the IT infrastructure that
supports your business. The Status, Reports, and Events tabs provide views about
your account and the objects that compose the account.
Following installation and configuration of the BMC Performance Manager Portal,
you can begin adding computers and other devices to the account as infrastructure
elements. You organize infrastructure elements into groups to which you assign
rights and permissions for users of the Portal. Collectively, infrastructure elements
and groups are known as infrastructure objects. The infrastructure objects in your
account correspond to the computers and devices that compose the IT infrastructure
for your business.
How the BMC Performance Manager Portal monitors your
infrastructure
The BMC Performance Manager Portal uses Remote Service Monitors (RSMs) to
collect metrics about your infrastructure. An RSM is a computer on which you have
installed the RSM program. Depending on the size of your environment and your
high availability (HA) requirements, you can implement one or many RSMs. For
more information about installing and configuring the RSM program, see Chapter 4,
“Remote Service Monitors,” on page 69.
To know what to monitor on the specified infrastructure elements, the RSM uses
Performance Managers. Each Performance Manager contains one or more application
classes that you can select to monitor operating systems, programs, files, processes,
and more. Each application class contains parameters that define the type of metric to
obtain from the infrastructure element.
Performance Managers, and the application classes that they contain, are installed on
the Portal and saved in the Portal database when you select them from an installation
CD or EPD website, or when you import them from the Portal user interface.
Performance Managers that are installed on the Portal are available to all users on the
Chapter 1
Overview of the BMC Performance Manager Portal
17
Methods of data collection for Performance Managers
Portal who have the appropriate user permissions. For more information about
installing application classes, see Chapter 5, “Performance Managers and application
classes,” on page 111.
Methods of data collection for Performance Managers
Performance Managers contain the applications that obtain performance and
availability metrics about the monitored infrastructure objects in your account.
Performance Managers can provide agentless monitoring or can integrate parameter
data from a PATROL Agent. After you install the Performance Managers in the Portal,
you can configure the elements in your account to use the application classes in the
Performance Managers.
The application classes in agentless Performance Managers use industry-standard
protocols, such as PerfMon and SNMP, to retrieve metrics about the performance of
the monitored element. As you add elements to the account, the user interface
displays the application classes available for the new elements, based on the
operating system of the element. During element configuration, you can accept
default thresholds or, if permitted by your user permission, modify thresholds to
reflect the service level agreement (SLA) for your account.
The application classes in PATROL integration Performance Managers retrieve
parameter data from PATROL Agents. PATROL integration Performance Managers
correspond to the PATROL Knowledge Modules (KMs) on the selected agent, and
contain mappings to a subset of the parameters in the KM. You can integrate
parameter data from PATROL Agents, version 3.5 and later.
The RSM program begins collecting metrics about your account within minutes of
your adding and configuring the first elements. As soon as data collection begins, you
can use the BMC Performance Manager Portal to view performance and availability
metrics and status.
Components
The following components compose the BMC Performance Manager Portal:
■
■
18
BMC Performance Manager Portal module in the BMC Portal
Remote Service Monitor program
BMC Performance Manager Portal Monitoring and Management Guide
BMC Performance Manager Portal module in the BMC Portal
Figure 1 shows how the BMC Performance Manager Portal components interact with
the BMC Portal.
Figure 1
BMC Portal with the BMC Performance Manager Portal module installed
BMC Portal
database server
RSM computer
The programs that comprise the BMC Performance
Manager Portal module reside on the Portal
application server. The RSMs obtain parameter
metrics from the monitored elements and send
events and parameter metrics to the Portal web
server.
When you specify an application class that is not on
the specified RSM, the RSM queries the Portal for
the corresponding Performance Manager. After the
RSM retrieves it from the Portal, the Performance
Manager remains on the RSM.
web browser
web server
application server
PATROL Agents
remote elements
BMC Performance Manager Portal module in the BMC Portal
During installation of the BMC Portal, the installation program places the BMC
Performance Manager Portal on the BMC Portal application server. The BMC Portal
provides the access point to the BMC Performance Manager Portal module and the
views that provide the metrics about your monitored infrastructure. You use your
Internet browser to access the Portal to view data and reports that show the
performance and availability of your account.
For further information about the individual components of the BMC Portal, see the
BMC Portal Getting Started guide.
Remote Service Monitor program
The Remote Service Monitor (RSM) program remotely monitors its assigned elements
and sends parameter values to the Portal. You install the RSM program on each
computer designated as an RSM.
Chapter 1
Overview of the BMC Performance Manager Portal
19
Security
After you add an element to the Portal, the RSM begins collecting parameter data
from the element at the collection intervals specified for each application class, and
then sends parameter values to the Portal at the report update interval for the
element. The RSM also sends parameter values to the Portal as soon as it detects that
a parameter has changed its status (for example, when the parameter status changes
from warning to alarm).
For more information about the Remote Service Monitor program, see Chapter 4,
“Remote Service Monitors,” on page 69.
Security
During installation of the BMC Portal, the installation program installs basic security
on the Portal. If you intend to integrate data from a PATROL Agent, you might need
to specify a different security level.
The RSM installation program also requests a security level. When integrating
PATROL Agent data, the security level on the RSM must match the security of the
monitored PATROL Agent.
Table 1 summarizes the key elements for each of the five levels of security. Basic
security (the default) is the lowest level of security. Levels 1 through 4 provide
increasingly higher levels of security, along with increasingly greater configuration
demands.
Table 1
Highlights of security levels (part 1 of 2)
Security level
basic security
level 1
Description
■
default level of security employed when you install PATROL, BMC
Performance Manager Portal, and BMC Portal
■
no cryptographic protection of network traffic
■
no verification of product or data integrity
■
authentication provided and protected password stored in
unattended operations in the PATROL application
■
minimized security and access control lists
(ACLs) in favor of usability and performance
■
Diffie-Hellman used for privacy
no SSL authentication of either party to the other
■
level 2
■
■
■
20
private communications provided by SSL
no SSL authentication performed (runs in keyless mode)
defaults to unattended agent restart
BMC Performance Manager Portal Monitoring and Management Guide
Additional security for BMC Performance Manager Portal
Table 1
Highlights of security levels (part 2 of 2)
Security level
level 3
level 4
Description
■
private communications and server authentication provided by
SSL
■
certificate provided by agent so that the client can authenticate the
agent
■
client not authenticated back to the agent
■
defaults to unattended agent restart; can configure for attended
agent restart
■
private communications and mutual authentication of the console
and the agent provided by SSL
■
defaults to unattended agent restart; can configure for attended
agent restart
Additional security for BMC Performance Manager Portal
If you have a PATROL Central environment and want to use Management Profiles to
discover PATROL Agents, the security on the Portal must match that of the target
console servers. When you install the BMC Performance Manager Portal module, the
installation program asks if you want to discover PATROL Agents in a PATROL
Central environment. If you select Yes, the installation prompts you for an RTserver
name and for the necessary security level.
For more information about security, see the PATROL Security User Guide.
To change the security level for the Portal, see the BMC Portal Getting Started guide.
For more information about Management Profiles and the RTserver, see your
PATROL Central documentation.
Security requirements for RSMs
When installing the RSM program, the installation program prompts you for a
security level. Because an RSM that integrates PATROL Agent parameter values must
have the same security level as that of the PATROL Agent, you must install an RSM
for each security level of the PATROL Agents from which you integrate data.
If your environment does not use PATROL Agents, the installation program applies
the Basic security (level 0) to the RSM, a setting that enables you to change security at
a later time, if necessary.
Chapter 1
Overview of the BMC Performance Manager Portal
21
Infrastructure element credentials
To change the security on an RSM, see “Changing the security level for an RSM” on
page 99.
Infrastructure element credentials
During element configuration, the BMC Performance Manager Portal prompts you
for authentication credentials that the RSM program can use to access the element.
The credentials for infrastructure elements are encrypted and stored in the Portal
database, using Secure Hash Algorithm (SHA), which provides 160-bit
cryptographically secure hash of the credentials. The Portal encrypts the credentials
and sends them to the RSM computers, and the RSM program does not store any
element credentials locally.
22
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
2
Getting started with the BMC
Performance Manager Portal
2
This chapter describes activities that you must perform immediately after installing
and configuring the BMC Performance Manager Portal module on the Portal or after
upgrading to the current version of the Portal. The scenarios in this chapter acquaint
you with the methods for configuring the BMC Performance Manager Portal to
monitor your infrastructure.
This chapter presents the following topics:
Verifying the BMC Performance Manager Portal installation . . . . . . . . . . . . . . . . . . .
Adding infrastructure elements for agentless monitoring . . . . . . . . . . . . . . . . . . . . . .
Verifying an upgrade from an earlier version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrating PATROL Agent data into the BMC Performance Manager Portal . . . . .
Options for identifying PATROL Agents as elements . . . . . . . . . . . . . . . . . . . . . . .
Methods for discovering PATROL Agent data. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Synchronization of thresholds and application classes . . . . . . . . . . . . . . . . . . . . . .
Integrating infrastructure elements and the BMC Atrium CMDB . . . . . . . . . . . . . . . .
Searching for objects in the BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing object status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Portal and infrastructure status views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Individual parameter history charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter history tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter filtering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2
Getting started with the BMC Performance Manager Portal
24
25
27
27
28
29
40
42
42
44
45
45
46
47
23
Verifying the BMC Performance Manager Portal installation
Verifying the BMC Performance Manager
Portal installation
The BMC Portal Getting Started guide describes how to configure the Portal and its
modules, including the BMC Performance Manager Portal. This section describes
tasks that you can perform to ensure that the BMC Performance Manager Portal is
ready to monitor infrastructure.
To verify the BMC Performance Manager Portal installation
1 Using the procedure in “Using the installation wizard to install the RSM program”
on page 84, install the RSM program on the Portal computer or another computer
designated as an RSM.
You can install one of the RSM instances on the Portal computer.
2 Using the procedure in “Adding infrastructure elements for agentless monitoring”
on page 25, add one element to the account.
To test the installation, select a simple application class, such as Ping.
3 Select the Status tab.
4 In the navigation pane, expand the object tree to display the top-level Infrastructure
object group and the objects that it contains.
Within moments of adding the element, the status of the new infrastructure
element should change to OK.
If a problem occurs
If the status of the element is critical, you might have a problem with the Portal
installation or with the configuration of the element.
24
■
Verify that a firewall is not preventing the RSM from successfully reaching the
computer.
■
Verify that a firewall is not preventing the RSM from sending data to the Portal.
■
Determine whether a network problem is causing the ping command to fail.
■
See the troubleshooting appendix in the BMC Portal Getting Started guide or the
BMC Portal Installation Guide.
BMC Performance Manager Portal Monitoring and Management Guide
Adding infrastructure elements for agentless monitoring
Where to go from here
■
Begin adding infrastructure elements. See “Adding infrastructure elements for
agentless monitoring” on this page.
■
Review the metrics collected about infrastructure elements. See Chapter 6,
“Reports,” on page 133.
Adding infrastructure elements for agentless
monitoring
You can quickly add computers and devices for agentless monitoring. The following
scenario provides the procedure for adding an element and configuring it with the
Ping application class, which measures network latency, and to verify that the
element can accept network requests.
Before you begin
You must have at least one RSM installed and available to the Portal. If necessary, see
“Using the installation wizard to install the RSM program” on page 84.
To add an infrastructure element to the BMC Performance Manager Portal
1 Log on with user credentials.
2 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
3 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 4.
4 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM, and click Next to open the Elements–Add Infrastructure
Element–Identification page.
NOTE
If an instance of the RSM program has not been installed, the list of Remote Service
Monitors is empty. If this occurs, click Cancel and install the RSM program. See “Using the
installation wizard to install the RSM program” on page 84.
Chapter 2
Getting started with the BMC Performance Manager Portal
25
Adding infrastructure elements for agentless monitoring
5 To specify an element name that appears on all charts and Status pages, type a
name in Element Name (label).
If you do not specify a label name, the host name or IP address is used as the
element name.
6 In the text box, type the host name of the computer, select Host Name, and click
Next.
To add many elements, you can paste a list of host names in the text box or specify
a range of IP addresses. When adding multiple elements, separate host names with
commas.
7 On the Elements–Add Infrastructure Element–Select Group page, specify the
platform name and group name, and click Next:
A From the Element(s) Platform list, select the platform that corresponds to the host
name that you specified in step 6.
B In Group Name, type test group.
8 On the Elements–Add Infrastructure Element–Application Classes page, select the
Networking category, select the Ping application class, and click Next.
9 On the Elements–Add Infrastructure Element–Properties and Credentials page,
review the properties for the Ping application class, and click Next:
■
When you keep the default value for Report Update Interval Minutes, the RSM
sends parameter values to the Portal every 5 minutes for BMC Portal versions
earlier than 2.7, and every 10 minutes for versions BMC Portal 2.7 and later,
unless a parameter threshold is violated.
■
When you keep the default value for Collection Interval , the RSM collects
parameter values for the Ping application class once every minute.
10 On the Elements–Add Infrastructure Element–Thresholds page, accept the default
thresholds, and click Finish.
After you finish adding the element to the Portal, the RSM starts accessing the
element to collect parameter values. You might need to wait a minute or two before
the Portal receives the initial parameter values and updates the Status tab.
Where to go from here
Begin viewing the parameter metrics collected by the RSM by selecting the Status and
Reports tabs.
26
BMC Performance Manager Portal Monitoring and Management Guide
Verifying an upgrade from an earlier version
Verifying an upgrade from an earlier version
If you upgraded from BMC Performance Manager Portal 1.2, your application classes
were migrated to the Performance Manager format and installed on the Portal. If you
upgraded from BMC Performance Manager Portal 2.1, see the procedure described in
“To upgrade a Performance Manager during a Portal upgrade” on page 120.
The following procedure describes how to view the Performance Managers that were
upgraded from version 1.2 and to ensure that the Portal is collecting data following
the upgrade.
To verify an upgrade from BMC Performance Manager Portal 2.1
1 Log on using Portal administrator credentials (superadmin/superadmin by default).
2 Select the Portal tab.
3 Under Tasks, select Performance Managers to open the Performance Managers page.
This page lists the names of all the Performance Managers that were upgraded from
the earlier version.
4 After viewing the Performance Managers list on the Portal, log on as a user and
select the Status tab to view the values and status for the infrastructure elements in
your account.
Shortly after the upgrade, the Status tab should reflect new values collected by the
upgraded application classes and RSM for your Portal.
Integrating PATROL Agent data into the BMC
Performance Manager Portal
BMC Software has created PATROL integration Performance Managers for many of
the KMs, providing mappings to many of those KMs' parameters. Using the PATROL
Agent as a data source, the RSM mines parameter data from the agent and sends it to
the Portal. The BMC Performance Manager Portal can integrate parameter data from
PATROL Agents, version 3.5 and later.
Chapter 2
Getting started with the BMC Performance Manager Portal
27
Options for identifying PATROL Agents as elements
Options for identifying PATROL Agents as elements
When you add PATROL Agents to the Portal as elements, you either specify the host
names of the agents or use a discovery method to find them. When you specify the
host names or IP addresses, you can accept the default parameter thresholds in the
PATROL integration application class, or you can modify the default values (during
the add process or later). The Elements–Add Infrastructure Element–Identification
page provides the following options for identifying PATROL Agents and discovering
thresholds from PATROL Agents, version 3.5 and later:
■
Select Host Name or IP Address to specify one or more PATROL Agents as elements.
When you select one of these options, you must know which Knowledge Modules
(KMs) are installed on the managed system and their corresponding Performance
Managers in the Portal. After specifying the host names, you select the PATROL
integration Performance Managers that correspond to the KMs on the agents. In
most cases, the PATROL integration Performance Manager names and version
numbers match the PATROL KM names and version numbers.
This method uses the thresholds defined in the selected PATROL integration
Performance Manager. By default, threshold management is handled from the
PATROL Agent. To change threshold management to the Portal, access the
Properties page for element to change the threshold management preference.
The threshold values that you set in the Portal for PATROL integration parameters
have no effect on the values set for the parameters in the BMC Performance
Manager consoles, PATROL Configuration Manager, PATROL Knowledge Module
for Event Management, or other BMC Software products.
NOTE
The BMC Performance Manager consoles include
■
■
■
■
■
PATROL Central Operator - Web Edition
PATROL Central Operator - Microsoft Windows Edition
PATROL Console for Microsoft Windows
PATROL Console for UNIX®
Select PATROL Integration to have the BMC Performance Manager Portal discover
the agents and the KMs on the agents, match the KMs with the PATROL
integration Performance Managers on the Portal, and obtain parameter thresholds.
When you use this option to discover PATROL Agents, you can also choose to
monitor the health and availability of the selected PATROL Agents. See “PATROL
Agent health monitoring” on page 271 for more information.
For more information about managing thresholds for PATROL Agent elements, see
“PATROL Agent integration” on page 115.
28
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
Methods for discovering PATROL Agent data
When you select the PATROL Integration option, you can choose from the following
discovery options:
■
Discover agent data from a PATROL Central environment, which requires that you
specify credentials for a PATROL Console Server.
This method requires that you specify an RTserver for the Portal to discover
Management Profiles on the console server. When using this option, consider
creating Management Profiles that contain the managed systems that you want to
add.
■
Discover agent data from a PATROL desktop (DT) file, which requires that you
specify the full path and file name for the desktop file.
■
discover agent data from a PATROL Event Translation (PET) file, which requires
that you specify the full path and file name for the configuration file.
■
Discover PATROL Agent data by specifying a comma-separated value (CSV) file
that contains the element name, agent host name, port number for the PATROL
Agent, and user name.
The CSV file can optionally contain the password to authenticate the user name.
■
Use the addPATROL command in the bpmcli to add elements from a list of
PATROL Agents. See “addPATROL” on page 228 for more information.
The data discovery process can take a long time, but after you click Commit to initiate
the process, you can navigate to other pages by clicking the Status, Events, Reports, or
Configure tab.
■
■
To view the status of the new elements, select the Status tab.
To see whether any errors occurred during data discovery, locate and view the
portal.log file. See “Cannot find errors when data discovery runs as a background
process” on page 258.
If your PATROL environment contains a mixture of PATROL architectures, you can
use a combination of the integration options.
NOTE
■
The BMC Performance Manager Solutions CD contains many PATROL integration
Performance Managers that provide integration with PATROL parameter data.
■
To ensure that you do not stop the Portal from mining data from the agents, do not unload
the corresponding KM from the PATROL Agent.
Chapter 2
Getting started with the BMC Performance Manager Portal
29
Methods for discovering PATROL Agent data
Discovering PATROL Agents in a PATROL Central
environment
If your business uses the PATROL Central environment to manage infrastructure, you
can specify Management Profiles for the Portal to use to discover PATROL Agents.
The discovery process also matches the PATROL integration Performance Managers
with the KMs and obtains parameter thresholds from the agent. For more information
about the components in the PATROL Central environment, see the PATROL Central
documentation.
Before you begin
■
The Portal requires an RTserver to access a Management Profile. If you did not
specify an RTserver and security level during installation of the Portal, you must
configure these Portal settings before proceeding.
See “Specifying RTservers for the BMC Performance Manager Portal” on page 256.
■
The KMs must be loaded on the PATROL Agent.
■
Consider creating or updating Management Profiles so that you can quickly select
the agents that you want.
■
Ensure that at least one RSM has been installed and is available to the Portal. See
“Using the installation wizard to install the RSM program” on page 84.
To discover PATROL Agents in a PATROL Central environment
1 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
2 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 3 on page 42.
3 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM to collect data from the discovered agents, and click Next.
4 On the Elements–Add Infrastructure Element–Identification page, select PATROL
Integration, and click Next.
5 On the Elements–Add Infrastructure Element–Select Group page, specify the
object groups for the new elements, and click Next.
6 On the Elements–Add Infrastructure Element–Select PATROL Agent for
Configuration page, select PATROL Management Profile(s), and click Next.
30
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
7 On the Elements–Add Infrastructure Element–Console Server Credentials page,
specify the credentials to access the selected console server, and click Next:
A From the list, select the console server.
If your Portal administrator has not specified an RTserver, the Console Server list
is empty and you cannot continue.
B Type the user credentials for the Portal to use to access the console server.
8 On the Elements–Add Infrastructure Element–Integrate Managed Systems page,
select the Management Profiles to use, and click Next.
9 If necessary, on the Elements–Add Infrastructure Element–PATROL Agent
Credentials page, specify the credentials for the selected agents, and click Commit.
If the Management Profile had the PATROL Agent credentials saved in the console
server’s profile impersonation table, Agent credentials might already be displayed
on this page.
■
To monitor the discovered agents, select Monitor discovered PATROL Agents with
PATROL Agent Availability and Health Monitor.
■
To change the default element name, agent name, or port from that which was
discovered on the agent, type the new properties in the corresponding boxes for
each applicable agent.
■
To apply the same credentials to all agents, type the credentials in Agent User
Name and Agent Password, and click Apply to All.
■
To apply shared credentials to all agents, select a saved credential from the
Shared Credentials list, and click Apply to All.
■
To provide the credentials for individual agents, type the credentials in
corresponding Agent User Name and Agent Password boxes, or select a saved
credential from the list.
The data discovery process begins. In addition to matching application classes and
parameters between PATROL integration Performance Managers and KMs, the
Portal obtains the parameter thresholds from the discovered agents.
NOTE
The data discovery process can take a long time. During discovery, you can navigate away
from this page by clicking on the Status, Events, or Configure tab. If you navigate away
from this page, you will not be able to view the Results Summary page.
Chapter 2
Getting started with the BMC Performance Manager Portal
31
Methods for discovering PATROL Agent data
10 When the Elements–Add Infrastructure Element–Collect Application and
Threshold Data screen shows that it has finished collecting data, click Summary to
display the Elements–Add Infrastructure Element–Results Summary page.
This page shows the KMs on the agents that matched the available PATROL
integration Performance Managers for your Portal.
11 Click Done to return to the Elements page.
After you finish adding the element to the Portal, the RSM accesses the PATROL
Agent to collect parameter values. You might need to wait a minute or two for the
Portal to receive the initial parameter values and update the Status tab.
Where to go from here
■
If you navigated to other tasks or object views during the discovery process, you
can
— access the Status tab to view the new parameters and their values
— access the log files to check for errors encountered during discovery
■
Begin viewing measurements collected by the RSM program by selecting the Status
and Reports tabs.
■
View or edit parameter thresholds on the new elements. To access element
thresholds, take the following actions:
1. On the Configure tab, select the element in the navigation pane to open the
element Properties page.
2. Under Application Classes, click Edit.
Using a PATROL desktop file to discover PATROL Agents
If your business uses PATROL 3.x consoles, you can use a desktop file to discover
PATROL Agents. The discovery process also matches the PATROL integration
Performance Managers with the KMs and obtains parameter thresholds from the
agent.
Before you begin
32
■
You must have at least one RSM installed and available to the Portal. See “Using
the installation wizard to install the RSM program” on page 84.
■
You must have already saved a desktop file (*.dt) from the console. For information
about creating a desktop file, see your console documentation.
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
To use a PATROL desktop file to discover PATROL Agents
1 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
2 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 3.
3 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM to collect data from the discovered agents, and click Next.
4 On the Elements–Add Infrastructure Element–Identification page, select PATROL
Integration, and click Next.
5 On the Elements–Add Infrastructure Element–Select Group page, specify the
object groups for the new elements, and click Next.
6 On the Elements–Add Infrastructure Element–Select PATROL Agent for
Configuration page, select Console Desktop File(s), and click Next.
7 On the Elements–Add Infrastructure Element–Console Desktop File page, use one
of the following options to specify the desktop file, and click Next:
■
■
Click Browse to select a desktop file.
In File Name, type the full path and file name for the desktop file.
8 On the Elements–Add Infrastructure Element–PATROL Agent Credentials page,
specify the credentials for the selected agents, and click Commit.
■
To monitor the discovered agents, select Monitor discovered PATROL Agents with
PATROL Agent Availability and Health Monitor.
■
To change the default element name, agent name, or port from that which was
discovered on the agent, type the new properties in the corresponding boxes for
each applicable agent.
■
To apply the same credentials to all agents, type the credentials in Agent User
Name and Agent Password, and click Apply to All.
■
To apply shared credentials to all agents, select a saved credential from the
Shared Credentials list, and click Apply to All.
■
To provide the credentials for individual agents, type the credentials in
corresponding Agent User Name and Agent Password boxes, or select a saved
credential from the list.
Chapter 2
Getting started with the BMC Performance Manager Portal
33
Methods for discovering PATROL Agent data
The data discovery process begins. In addition to matching application classes and
parameters between PATROL integration Performance Managers and KMs, the
Portal obtains the parameter thresholds from the discovered agents.
NOTE
The data discovery process can take a long time. During discovery, you can navigate away
from this page by clicking on the Status, Events, or Configure tab. If you navigate away
from this page, you will not be able to view the Results Summary page.
9 When the Elements–Add Infrastructure Element–Collect Application and
Threshold Data screen shows that the Portal has finished collecting data, click
Summary to display the Elements–Add Infrastructure Element–Results Summary
page.
This page shows the KMs on the agents that matched the available Performance
Managers on your Portal.
10 Click Done to return to the Elements page.
After you finish adding the element to the Portal, the RSM accesses the PATROL
Agent to collect parameter values. You might need to wait a minute or two for the
Portal to receive the initial parameter values and update the Status tab.
Where to go from here
■
If you navigated to other tasks or object views during the discovery process, you
can
— access the Status tab to view the new parameters and their values
— access the log files to check for errors encountered during discovery
■
Begin viewing measurements collected by the RSM program by selecting the Status
and Reports tabs.
■
View or edit parameter thresholds on the new elements. To access element
thresholds, take the following actions:
1. On the Configure tab, select the element in the navigation pane to open the
element Properties page.
2. Under Application Classes, click Edit.
34
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
Using a PET file to discover PATROL Agents
If your business has a PATROL 3.x environment without a console, you can use a PET
file to discover PATROL Agents. The discovery process also matches the PATROL
integration Performance Managers with the KMs and obtains parameter thresholds
from the agent.
Before you begin
■
You must have at least one RSM installed and available to the Portal. See “Using
the installation wizard to install the RSM program” on page 84.
■
You must have used the PATROL Event Translation Configuration utility to create
a PET file.
To use a PET file to discover PATROL Agents
1 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
2 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 3.
3 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM to collect data from the discovered agents, and click Next.
4 On the Elements–Add Infrastructure Element–Identification page, select PATROL
Integration, and click Next.
5 On the Elements–Add Infrastructure Element–Select Group page, specify the
object groups for the new elements, and click Next.
6 On the Elements–Add Infrastructure Element–Select PATROL Agent for
Configuration page, select PET Configuration File(s), and click Next.
7 On the Elements–Add Infrastructure Element–PET File page, use one of the
following options to specify the desktop file, and click Next:
■
■
Click Browse to select a PET file.
In File Name, type the full path and file name for the PET file.
Chapter 2
Getting started with the BMC Performance Manager Portal
35
Methods for discovering PATROL Agent data
8 On the Elements–Add Infrastructure Element–PATROL Agent Credentials page,
specify the credentials for the selected agents, and click Commit:
■
To monitor the discovered agents, select Monitor discovered PATROL Agents with
PATROL Agent Availability and Health Monitor.
■
To change the default element name, agent name, or port from that which was
discovered on the agent, type the new properties in the corresponding boxes for
each applicable agent.
■
To apply the same credentials to all agents, type the credentials in Agent User
Name and Agent Password, and click Apply to All.
■
To apply shared credentials to all agents, select a saved credential from the
Shared Credentials list, and click Apply to All.
■
To provide the credentials for individual agents, type the credentials in
corresponding Agent User Name and Agent Password boxes, or select a saved
credential from the list.
The data discovery process begins. In addition to matching application classes and
parameters between PATROL integration Performance Managers and KMs, the
Portal obtains the parameter thresholds from the discovered agents.
NOTE
The data discovery process can take a long time. During discovery, you can navigate away
from this page by clicking on the Status, Events, or Configure tab. If you navigate away
from this page, you will not be able to view the Results Summary page.
9 When the Elements–Add Infrastructure Element–Collect Application and
Threshold Data screen shows that is has finished collecting data, click Summary to
display the Elements–Add Infrastructure Element–Results Summary page.
This page shows the KMs on the agents that matched the available Performance
Managers for your Remote Service Monitor.
10 Click Done to return to the Elements page.
After you finish adding the element to the Portal, the RSM accesses the PATROL
Agent to collect parameter values. You might need to wait a minute or two for the
Portal to receive the initial parameter values and update the Status tab.
36
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
Where to go from here
■
If you navigated to other tasks or object views during the discovery process, you
can
— access the Status tab to view the new parameters and their values
— access the log files to check for errors encountered during discovery
■
Begin viewing measurements collected by the RSM program by selecting the Status
and Reports tabs.
■
View or edit parameter thresholds on the new elements. To access element
thresholds, take the following actions:
1. On the Configure tab, select the element in the navigation pane to open the
element Properties page.
2. Under Application Classes, click Edit.
Using a CSV file to discover PATROL Agents
If you have the PATROL Agents listed in a comma-separated value (CSV) file, you
can identify the agents by uploading the file to the Portal.
Before you begin
■
You must have at least one RSM installed and available to the Portal. See “Using
the installation wizard to install the RSM program” on page 84.
■
You must have a CSV file that contains the following properties (in the order
specified) for each new element:
Table 2
PATROL Agent data required in CSV file
Value
element name
Notes
■
■
host name
■
■
port number
user name
cannot exceed 256 characters
if empty, the row is ignored
if empty, the row is ignored
■
■
password
value cannot exceed 256 characters
if empty, the row is ignored
■
■
■
cannot exceed 256 characters
value is not required
cannot exceed 256 characters
value is not required
if value is present, it must be PEM encrypted
Chapter 2
Getting started with the BMC Performance Manager Portal
37
Methods for discovering PATROL Agent data
To use a CSV file to discover PATROL Agents
1 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
2 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 3.
3 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM to collect data from the discovered agents, and click Next.
4 On the Elements–Add Infrastructure Element–Identification page, select PATROL
Integration, and click Next.
5 On the Elements–Add Infrastructure Element–Select Group page, specify the
object groups for the new elements, and click Next.
6 On the Elements–Add Infrastructure Element–Select PATROL Agent for
Configuration page, select Comma Separated Values (CSV file(s), and click Next.
7 On the Elements–Add Infrastructure Element–CSV File page, use one of the
following options to specify the file, and click Next:
■
■
Click Browse to select the file.
In File Name, type the full path and file name for the file.
8 On the Elements–Add Infrastructure Element–PATROL Agent Credentials page,
specify the credentials for the agents listed in the CSV file, and click Commit:
38
■
To monitor the discovered agents, select Monitor discovered PATROL Agents with
PATROL Agent Availability and Health Monitor.
■
To change the default element name, agent name, or port from that which was
discovered on the agent, type the new properties in the corresponding boxes for
each applicable agent.
■
To apply the same credentials to all agents, type the credentials in Agent User
Name and Agent Password, and click Apply to All.
■
To apply shared credentials to all agents, select a saved credential from the
Shared Credentials list, and click Apply to All.
■
To provide the credentials for individual agents, type the credentials in
corresponding Agent User Name and Agent Password boxes, or select a saved
credential from the list.
BMC Performance Manager Portal Monitoring and Management Guide
Methods for discovering PATROL Agent data
The data discovery process begins. In addition to matching application classes and
parameters between PATROL integration Performance Managers and KMs, the
Portal obtains the parameter thresholds from the discovered agents.
NOTE
The data discovery process can take a long time. During discovery, you can navigate away
from this page by clicking on the Status, Events, or Configure tab. If you navigate away
from this page, you will not be able to view the Results Summary page.
9 When the Elements–Add Infrastructure Element–Collect Application and
Threshold Data screen shows that is has finished collecting data, click Summary to
display the Elements–Add Infrastructure Element–Results Summary page.
This page shows the KMs on the agents that matched the available Performance
Managers on your Portal.
10 Click Done to return to the Elements page.
After you finish adding the element to the Portal, the RSM accesses the PATROL
Agent to collect parameter values. You might need to wait a minute or two for the
Portal to receive the initial parameter values and update the Status tab.
Where to go from here
■
If you navigated to other tasks or object views during the discovery process, you
can
— access the Status tab to view the new parameters and their values
— access the log files to check for errors encountered during discovery
■
Begin viewing measurements collected by the RSM program by selecting the Status
and Reports tabs.
■
View or edit parameter thresholds on the new elements. To access element
thresholds, take the following actions:
1. On the Configure tab, select the element in the navigation pane to open the
element Properties page.
2. Under Application Classes, click Edit.
Chapter 2
Getting started with the BMC Performance Manager Portal
39
Synchronization of thresholds and application classes
Synchronization of thresholds and application classes
Not only can you manually change parameter thresholds, but you can synchronize
the parameter thresholds and application classes in the PATROL integration
Performance Managers with those on the PATROL Agent through the Portal. When
synchronizing thresholds, you can also choose to monitor the health and availability
of the selected PATROL Agents. See “PATROL Agent health monitoring” on page 271
for more information.
The following conditions can cause discrepancies between the parameter thresholds
and application classes in the PATROL integration Performance Managers and the
PATROL Agent:
■
■
■
changing the parameter thresholds on the PATROL Agent
removing application classes on the PATROL Agent
adding application classes on the PATROL Agent
When you synchronize parameter values, the following limitations apply:
■
Updating PATROL integration parameters for more than 100 elements can take a
long time. Like with discovery, you can navigate to other tabs and options on the
Portal during the synchronization process, but if you do, you will not be able to
view or save the Results Summary report.
■
The Portal does not synchronize PATROL integration parameters for elements to
which an element profile has been applied. For more information about element
profiles, see “Element Profiles task” on page 51.
By default, the Portal synchronizes the thresholds for all parameters that it discovers
for the specified elements. You can provide a list of parameters to exclude from the
synchronization process by updating the padm.properties file. See the
padm.migrate.threshold.update.exclude.list property on page 292 for more
information.
40
BMC Performance Manager Portal Monitoring and Management Guide
Synchronization of thresholds and application classes
To manually synchronize PATROL integration parameters with those on the
PATROL Agent
1 Select the Configure tab, and in the navigation pane, select the Elements task.
2 On the Elements page, click Refresh PATROL Integration to synchronize the
parameter values in the Portal and the PATROL Agent.
3 On the Elements page, optionally select elements in the object tree, and click
Refresh PATROL Integration:
■
If you select elements from the object tree, the Portal searches the selected
elements for PATROL integration application classes.
■
If you do not select elements from the object tree, the Portal searches all
elements in the account for PATROL integration application classes.
The Elements–Refresh PATROL Integration–Select Elements page lists the
elements that use PATROL Integration application classes.
4 If necessary, modify the selections, and click Commit to open the Elements–Refresh
PATROL Integration–Collect Application, Threshold Data page and start the
synchronization process.
The synchronization process can take a long time. During this process, you can
navigate away from this page by clicking on any of the Portal tabs or by selecting
another task from the Configure tab. However, if you navigate away from this
page, you cannot view the Elements–Refresh PATROL Integration–Results
Summary page.
5 When the Elements–Refresh PATROL Integration–Collect Application, Threshold
Data page shows that it has finished collecting data, click Summary.
The Elements–Refresh PATROL Integration–Results Summary page shows the
status of the synchronization for the specified elements and PATROL Agents.
6 Click Done to return to the Elements page
See the Help for more information about synchronizing application classes and
threshold values. To initiate the synchronization from a command line, see Chapter 8,
“BMC Performance Manager Portal command-line interface.”
NOTE
The BMC Performance Manager Portal requires that an infrastructure element have at least
one application class assigned to it. If the synchronization process removes all of the
application classes from an element, the Portal deletes the element. This can occur if you
unload all the KMs on a PATROL Agent and then synchronize the application classes.
Chapter 2
Getting started with the BMC Performance Manager Portal
41
Integrating infrastructure elements and the BMC Atrium CMDB
Integrating infrastructure elements and the
BMC Atrium CMDB
See “BMC Atrium CMDB integration” on page 189 for more information about how
the BMC Performance Manager Portal can provide data to and consume data from
the BMC Atrium Configuration Management Database (BMC Atrium CMDB).
Searching for objects in the BMC Atrium CMDB
You can add BMC Atrium CMDB infrastructure objects to the Portal by using the
Elements task. When you identify the infrastructure element, you can use the Discover
from BMC Atrium CMDB option to access filters to restrict the objects that the Portal
finds in the BMC Atrium CMDB. The Portal search queries the BMC.ASSET dataset in
the BMC Atrium CMDB.
The search results are only as good as the data:
■
If you apply an IP address restriction, objects in the BMC Atrium CMDB that do
not have an IP address are not included in the search results.
■
If you apply a Platform restriction, objects in the BMC Atrium CMDB that have an
empty platform attribute are not included in any of the search results.
■
If you apply the Host Name restriction, objects in the BMC Atrium CMDB that do
not have a trusted host are not included in any of the search results.
The BMC Topology Discovery program is an example of a BMC Software product
that populates the trusted host attribute. The BMC Performance Manager Portal
also populates this attribute when you add an infrastructure element and assign an
operating system application class.
To add infrastructure objects in the BMC Atrium CMDB
1 Click the Configure tab, and under Tasks, select Elements to open the Elements
page, and then click Add.
2 If the Elements–Add–Type of Element page is displayed, select Infrastructure
Element, and click Next; otherwise, proceed to step 3.
3 On the Elements–Add Infrastructure Element–Select Remote Service Monitor
page, select an RSM to collect data about the discovered infrastructure objects, and
click Next.
42
BMC Performance Manager Portal Monitoring and Management Guide
Searching for objects in the BMC Atrium CMDB
4 On the Elements–Add Infrastructure Element–Identification page, select Discover
from BMC Atrium CMDB, and click Next.
5 On the Elements–Add Infrastructure Element–Discover from BMC Atrium CMDB
page, specify the search criteria for the Portal to use when retrieving objects from
the BMC Atrium CMDB, and click Next:
A Under Search for Configuration Items (CIs), provide the search criteria that the
Portal uses to retrieve CIs from the BMC Atrium CMDB, and click Search:
■
To filter CIs by host name, type a character string in Host Name. The string
that you type has an implied wild card appended to the end.
For example, typing acme would retrieve acme1, acme2, and acme3 from the
BMC Atrium CMDB.
■
To filter CIs by IP address, type the address in the IP Address text boxes.
■
To filter CIs by operating system, select an option from Platform.
B From the search results under CIs Found in the BMC Atrium CMDB, select the
objects to add as infrastructure elements.
All of your selections must have the same platform. If you select a CI that has a
platform specified and a CI that does not have a platform specified, the Portal
assumes that both CIs have the specified platform.
■
■
Select the check boxes to select individual CIs.
Click Select All to select all CIs in the list.
6 If necessary, on the Elements–Add Infrastructure Element–Select Group page,
specify the platform and an object group for the new elements:
■
If at least one of the CIs that you selected from the BMC Atrium CMDB had a
platform defined for it, then you cannot specify a platform.
■
If none of the CIs that you selected from the BMC Atrium CMDB had a platform
defined for it, then you can select a platform.
7 On the Elements–Add Infrastructure Element–Application Classes page, specify
the parameters to monitor.
8 On the Elements–Add Infrastructure Element–Properties and Credentials page,
specify the properties and authentication credentials that the RSM must have to
access the specified elements.
9 On the Elements–Add Infrastructure Element–Thresholds page, set the element
thresholds for each parameter.
Chapter 2
Getting started with the BMC Performance Manager Portal
43
Viewing object status
10 Click Finish.
The Elements–Add Infrastructure Element–Progress Page opens. When the Portal
has finished adding the elements to the database, the Done button becomes
available.
11 When the Portal has finished adding elements to the database, click Done to return
to the Elements page.
TIP
To view the reconciliation status of the new element, perform the following actions:
1. In the navigation pane, select the infrastructure object.
2. Select the Configure tab.
3. Under General Properties, locate BMC Atrium CMDB Status.
After you finish adding the element to the Portal, the RSM accesses the element to
collect parameter values. You might need to wait a minute or two for the Portal to
receive the initial parameter values and to update the Status tab.
Viewing object status
The Status tab provides a current snapshot of the objects in the account. You can view
the status of the entire account, its groups, individual elements, application classes,
and parameters. The status icons and color-coded status bars enable you to
proactively identify and resolve substandard performance problems before they
become severe.
You can use the icons at the top of the tab to print the status page or send the page to
email recipients.
The Status tab provides the tab controls shown in Table 3:
Table 3
Page controls on Status tab (part 1 of 2)
Page control
Description
Auto Refresh
enables or disables automatic update of the page
When selected, the Portal remains active and does not time
out due to inactivity.
opens the active Status page in a new window
44
BMC Performance Manager Portal Monitoring and Management Guide
Portal and infrastructure status views
Table 3
Page controls on Status tab (part 2 of 2)
Page control
Description
opens a printer-friendly view of the page in a new window
opens an email window that contains the active view of the
Status tab
Portal and infrastructure status views
The Status tab shows the most recent values received from the RSM. The object
statuses reflect the worst parameter status in the selected object. This means that if one
parameter for one of the elements in the account has a status of warning and all of the
remaining parameters for the other elements have a status of OK, the status of the
account is warning. In Figure 2, because one of the objects has a status of alarm, the
account also has a status of alarm.
Figure 2
Account view on the Status tab
The summary bar shows that one object has
a status of critical.
The solid red bar shows that the account
has a status of critical.
One of the objects in the Infrastructure
group has a status of critical alarm.
Individual parameter history charts
Parameter history charts show the parameter values for a selected parameter during a
user-specified time. Selecting
for a parameter on an element, application class, or
parameter on the Status page opens the history chart in a new window. By default, the
parameter history chart shows the raw data values collected during the most recent
six hours.
The time-interval controls enable you to change the reporting interval for the chart.
Chapter 2
Getting started with the BMC Performance Manager Portal
45
Parameter history tables
■
When you are viewing a time period within 12 hours of the time that you request
the chart, the chart shows raw data values. If the selected time period has no raw
data, the chart is blank.
■
When you are viewing a period greater than 12 hours from the collection time, the
chart shows summarized data values for each hour.
In Figure 3, the red and yellow lines show the alarm and warning thresholds relative
to the reported values.
Clicking
Figure 3
enables you to export the data to a file for use in other applications.
Parameter history chart
alarm threshold
warning
threshold
Parameter history tables
Selecting Table View from the list box on the parameter history chart opens the
parameter history table for the parameter. The parameter history table shows the
values for the raw data collected for the selected parameter, as shown in Figure 4 on
page 47. By default, the table shows the values for the last six hours, but you can
choose time intervals up to 10 days.
Clicking
46
enables you to export the raw data to a file for use in other applications.
BMC Performance Manager Portal Monitoring and Management Guide
Parameter filtering
Figure 4
Parameter history table
Parameter filtering
When viewing the status for the element, application class, and application instance
objects, the Status tab lists the parameters in the selected object and the status of each
parameter. The status buttons at the top of the Status tab, shown in Figure 5, enable
you to filter the parameters in the list to those that match or exceed the selected status.
Figure 5
Buttons to filter parameters on the Status tab
To list parameters in alarm, warning, and OK, click the OK button.
To list parameters in alarm and warning, click the warning button.
To list only parameters in alarm, click the alarm button.
The status buttons act as toggles.
■
■
To apply the filter, click the applicable status button.
To remove the filter and show all parameters for the selected object, click the status
button again.
Chapter 2
Getting started with the BMC Performance Manager Portal
47
Parameter filtering
48
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
3
3
Users and administrators
This chapter describes how users can configure the BMC Performance Manager
Portal for their accounts and how administrators can configure the accounts of their
users, their providers, and the BMC Performance Manager Portal. For general
configuration procedures that apply to all modules, see the BMC Portal Getting Started
guide.
This chapter presents the following topics:
User configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Account Information task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Blackout Periods task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Change Password task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dashboards task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Element Profiles task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Elements task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring On/Off task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Notifications task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Object Groups task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Personal Preferences task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Service Monitors task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Shared Credentials task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tags task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Groups task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Users task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tasks on the Accounts tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tasks on the Provider tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tasks on the Portal tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 3
Users and administrators
50
50
50
50
51
51
51
54
55
55
59
60
60
60
61
62
63
64
64
65
67
49
User configuration options
User configuration options
Each account can have one or more users who can access the Portal to view
information about the account and configure the account for their use. The BMC
Portal enables administrators to create and configure accounts that grant users Read
Only, Full Access, or a combination of rights and permissions for their accounts.
The user rights determine the user interface options that a user can see and select.
User permissions determine which infrastructure objects that you can view and
configure. The Configure tab provides a list of tasks from which you can choose. The
following sections describe the tasks available on the Configure tab for users who
have Full Access rights for all tasks.
NOTE
This book and the Help describe options and text boxes available to users with Full Access
rights for all tasks. If your account does not have full access, you might not see every option.
See the Help and the BMC Portal Getting Started guide for information about accounts,
user groups, users, and rights and permissions.
About task
The About task opens a page that contains information about the version of the
installed BMC Portal and modules.
Account Information task
The Account Information task opens a page that lists basic information about your
account, including account name, language preference for the account, information
about the primary account contact, and email format preference for receiving email
messages from the Portal.
Blackout Periods task
If your user ID has adequate permissions, you can use the Blackout Periods task to
schedule one-time or recurring blackout periods for all objects in the account, for all
objects in selected groups, and for individual objects.
50
BMC Performance Manager Portal Monitoring and Management Guide
Change Password task
NOTE
When you delete objects, the blackout periods for those objects are deleted.
You can use blackout periods to keep the Portal from notifying you about problems
during times when you know that your system will not be operating, such as during
scheduled routine maintenance.
Change Password task
The Change Password task enables users to change their logon credentials. Only users
with internal database authentication can use this task. See “Users task” on page 63
for more information about internal database authentication.
Dashboards task
The Dashboards task enables you to create a customizable view, or dashboard, that
displays your most important, but possibly disparate, objects in one window (for
example, parameters, reports, and HTML pages). Objects in a dashboard display the
same live data that the original object displays.
You can specify the number of objects to display in the dashboard. That number
determines the size of the underlying layout grid in the dashboard window. Each
section of the grid represents a place where you can position an object view. The size
of an individual displayed object view depends on the number of sections in the grid.
Element Profiles task
The Element Profiles task enables you to create platform-independent descriptions, or
profiles, to manage the infrastructure elements in your account. An element profile
acts as a template that enables you to quickly change the properties associated with
your infrastructure elements. Element profiles are especially useful when you need to
manage many elements that share common properties because you can apply a single
element profile to multiple objects.
When applying the template to elements, you can override thresholds and properties
on specified elements.
Chapter 3
Users and administrators
51
Element Profiles task
Using element profiles
You can use the following methods to create and apply element profiles:
■
Create an element profile by explicitly defining profile properties.
■
Create an element profile from an existing element and assign the profile to the
element.
■
Apply an existing element profile to a new or existing element.
■
Modify the element profile that is assigned to an element
If you have applied an element profile to an element, you can quickly change the
properties for that element and all elements associated with the profile by changing
the properties of its element profile or by applying a different element profile.
Properties controlled by element profiles
Element profiles enable you to apply and manage the following properties to many
elements at one time:
■
■
■
■
application classes assigned to the elements
collection interval for the application class
threshold values for parameters
credentials and properties required for the application classes, including properties
for child classes (when applicable for the application class)
If you remove an element profile from an infrastructure element, the profile
properties are copied to the infrastructure element, and any future changes applied to
the element profile have no effect on the element.
How the Portal applies element profiles
When you assign an element profile to an element, the following rules apply:
■
Any application classes previously assigned to the element that are not in the
element profile are removed from the element.
■
For any application classes previously assigned to the element that are also in the
element profile, the Portal retains the application class history data.
The thresholds in the element profile supersede any differing thresholds in the
application class on the element.
52
BMC Performance Manager Portal Monitoring and Management Guide
Element Profiles task
■
Modifications made to an element profile by adding or removing application
classes, or by modifying parameter thresholds, affect all assigned elements.
■
When you create an element profile that includes application classes that support
discovered instances, the Portal applies the profile properties to each discovered
instance.
■
When you assign an element profile, the Portal filters out any application classes in
the profile that do not apply to the platform of the element.
Overriding element profile settings
You can override properties and threshold settings defined by a profile without
disassociating the profile from the element.
■
■
When you override properties, you can also change authentication credentials.
When you override thresholds, you can change warning and alarm threshold
values (including the on or off flag) and Alert After properties.
When overriding a profile, the following rules apply:
■
When you override thresholds at the parent level of discovered instances or userdefined instances, then the override propagates to all discovered instances or user
defined instances (existing or newly discovered), unless they are already
overridden at the child level.
■
When you override thresholds at the parent level of discovered instances or userdefined instances, then at the child level, Global appears in the row for the
parameter in the Overridden column. At the parent level, if the same parameter
exists, Local appears in the row for the parameter in the Overridden column.
■
When you override thresholds at the instance level, Local appears in the row for the
parameter in the Overridden column.
■
When you make threshold changes at the Element-Profile level, and the parent and
instance levels are not overridden, then the Overridden column is blank.
■
When you disable an override at the instance level,
— if the parent of the instance is overridden, the parent thresholds are used and the
label in the row for the parameter is changed to Global in the Overridden
column.
— if the parent of the instance is not overridden, the Element-Profile thresholds are
used, and the Overridden column is blank
Chapter 3
Users and administrators
53
Elements task
■
When you disable an override at the parent level, the Element-Profile thresholds
are used and the Overridden column is blank
You can use the element Properties page to view thresholds and properties that are
overridden for the element.
Changing the report update interval for elements by using
element profile
You cannot override the report update interval at the element level. You can change
the report update interval by editing the general properties for the element. However,
editing the report update interval at the element profile level propagates that change
to all elements assigned to that element profile, regardless of any settings at the
element level.
For example, if the following are the settings for the report update interval:
■
■
At the element profile level, the report update interval is set to 10 minutes.
Elements that are assigned to this same element profile have report update
intervals set at 5 minutes and 15 minutes.
If you then change the report interval at the element profile level to 15 minutes, the
report update interval is set to 15 minutes for all of the elements assigned to this
element profile, regardless of the settings or changes made at the element level.
For more details, see the drmop.default.reporting.interval.minutes property in
Appendix C, “BMC Performance Manager Portal files.”
Elements task
The Elements task enables you to add infrastructure elements to the account. Each
infrastructure element corresponds to a system or device in your IT environment. You
can use the following methods to add infrastructure elements:
54
■
Add elements by explicitly typing the element names and specifying the
monitoring attributes for those elements. You can add many elements at a time by
pasting a list of host names into a text box.
■
If you use PATROL Knowledge Modules (KMs) to monitor infrastructure, you can
configure the Portal to discover PATROL Agents. The discovery process matches
the KMs in the agents with integration Performance Managers on the Portal and
then obtains parameter thresholds from the agents and applies the thresholds to
the parameters in the integration Performance Managers. The Elements task also
enables you to synchronize the parameter thresholds and application classes in the
PATROL integration Performance Managers with those on the PATROL Agent.
BMC Performance Manager Portal Monitoring and Management Guide
Monitoring On/Off task
■
If you use a product like BMC Topology Discovery to discover IT objects and
populate the BMC Atrium Configuration Management Database (BMC Atrium
CMDB), the Portal can discover the host names of those infrastructure objects.
Following discovery, you specify the monitoring attributes for those elements.
For more information about adding elements to an account, see “Adding
infrastructure elements for agentless monitoring” on page 25. The task also enables
you to change the properties associated with elements and to delete elements from
the BMC Performance Manager Portal.
Monitoring On/Off task
The Monitoring On/Off task enables you to temporarily stop and restart
■
■
remote data collection for selected objects
reporting of collected data from agents
Notifications task
When conditions cause an object to violate a threshold or change its state, the BMC
Portal can send a notification about the event. The Notifications task enables you to
create rules that specify when and how the Portal sends notifications in response to
system problems or state changes.
By default, the Portal does not send notifications for OK-Unknown or Unknown-OK
status changes. To enable these notifications, see “Enabling notifications for OKUnknown and Unknown-OK status changes” on page 58.
Users can create notification rules for the following types of conditions:
■
state changes, which occur when the status of an object changes to a state for which
you want the Portal to send a notification
■
general system problems, which occur when a system problem prevents the Portal
from receiving information about an object (for example, an RSM stops
communicating with the Portal)
Users can configure the following types of notifications:
■
email messages: The Portal can send long or concise email messages for state
change and general system problem events. Concise email messages are suitable
for pagers and other wireless devices.
Chapter 3
Users and administrators
55
Notifications task
■
SNMP traps: The Portal can send SNMP traps for state change and general system
problem events. In addition to creating an SNMP notification, you must also
specify the host names of the servers to receive the traps. See “SNMP traps” on
page 204.
■
AlarmPoint: If you have AlarmPoint installed, you can configure the Portal to send
state change and general system problem notifications to AlarmPoint. Before a user
or administrator can create a notification rule for AlarmPoint, a Portal
administrator must use the Global Properties page to configure the Portal for
AlarmPoint integration. For more information about configuring the Portal to send
notifications to an AlarmPoint server, see “Event integration using AlarmPoint” on
page 196 and the BMC Portal Getting Started guide.
■
BMC Impact Integration Web Services: You can use the BMC Impact Integration
Web Services (BMC II Web Services) component to send state change and general
system problem notifications to BMC Impact Manager. Before a user or
administrator can create a notification rule for this transport method, a provider
administrator must use the Notifications page on the Provider tab to configure a
target BMC II Web Services server for the Portal.
Notification rules specify the following properties:
■
type of event or system problem to trigger notification
■
length of time that the Portal waits after the change in event severity before
sending notification
■
transport method that the Portal uses to send notifications: email, SNMP, BMC II
Web Services, or AlarmPoint
■
the affected objects (groups or objects within groups)
■
notification recipients
You can apply the same notification rules to all objects in the account, or you can set
different notification rules for each object (or object groups). Also, you can set
multiple notifications for objects, enabling you to incorporate or establish an
escalation procedure.
TIP
To quickly configure notification rules for an escalation procedure, create one notification rule,
and then copy that rule and modify the wait time and notification recipients for the other
levels in the escalation order.
56
BMC Performance Manager Portal Monitoring and Management Guide
Notifications task
To customize the notifications, you can create notification templates that you can
apply to notification rules. The templates specify the subject and message for email
notifications and the detail message field for SNMP notifications. You can create
notification templates before you create notification rules and specify a template as
you create or edit notification rules, or you can create a template while creating or
editing a notification rule.
Unless you customize them, infrastructure email notifications provide the following
information:
■
Element email notifications contain the
— status of the element
— name of the infrastructure element
— date and time at which the event was detected
— parent objects of the element
— account name for the element
— ID for the account
Also, the notification contains the following information for each parameter of the
element that caused the element notification:
— name of the infrastructure element
— host name of the element
— date and time at which the event was detected
— application class for the parameter
— name of the parameter
— parameter status that triggered the event
— current parameter value
— warning or alarm threshold that was breached
— host name for the RSM that detected the event
■
Parameter email notifications contain the
— name of the element
— host name of the element
— date and time in which the event was detected
— application class for the parameter
— name of the parameter
— parameter status that triggered the event
— current parameter value
— warning or alarm threshold that was breached
— host name for the RSM that detected the event
Chapter 3
Users and administrators
57
Notifications task
Enabling notifications for OK-Unknown and Unknown-OK
status changes
By default, the BMC Portal does not send notifications for Unknown-OK and OKUnknown status changes. To enable notifications for Unknown-OK and OKUnknown status change, use the following procedure.
If the portal.events.prevent.unknown property in the drmop.properties file is set to true
it overrides the websdk.services.notification.ok.unknown.support properties. Therefore,
even when the websdk.services.notification.ok.unknown.support property is set to true,
the Portal does not send OK-Unknown notifications. However, the Unknown-Ok
notifications are still sent because the portal.events.prevent.unknown property
prevents only the generation of unknown events.
To enable notifications for Unknown-OK and OK-Unknown status changes
1 Open the internal.properties file in a text editor. The file is located in the following
directories:
■
On Windows:
%BMC_PORTAL_KIT_HOME%
\appserver\websdk\tools\jboss\server\all\conf\properties\
■
On Solaris:
$BMC_PORTAL_KIT_HOME
/appserver/websdk/tools/jboss/server/all/conf/properties/
2 Locate and uncomment the following property:
websdk.services.notification.ok.unknown.support=true
Figure 6
websdk.services.notification.ok.unknown.support property
############################################
# OK and UNKNOWN notification support flag #
############################################
# If the following property is set to true, the Portal sends OK to
# UNKNOWN and UNKNOWN to OK notifications;
# if set to false, it does not. By default, the property value is set
# to false. After changing the following property,
# you must restart the Portal application server for the changes to
# take effect.
# NOTE: THIS PROPERTY OVERRIDES ANY NOTIFICATION RULE SELECTED. For
# example, if you have selected the notification options
# "Only when the rules above are violated", or "When rules are
# violated and when the object is no longer in violation"
# and if you have set the below property to true, the Portal still
# sends notification when a state change from OK to UNKNOWN
# or UNKNOWN to OK occurs.
websdk.services.notification.ok.unknown.support=true
58
BMC Performance Manager Portal Monitoring and Management Guide
Object Groups task
3 Save and close the file.
4 For this change to take effect, you must restart the Portal.
Object Groups task
The Object Groups task enables you to create and modify object groups—containers—
to organize the objects in your account. You can create any number of object groups,
and you can create nested groups (groups that contain groups). After creating an
object group, you can manage the objects in the object group as a single entity and
view reports, status, and events for the group.
Each account must contain at least one object group under one of the top-level object
groups. By default, the BMC Portal has the following top-level object groups that
contain any object groups that you create:
■
Dashboards—populated by any module
■
Business—created and populated by the BMC Impact Portal module
■
Exceptions—created and populated by the BMC Performance Exception Detector
module
When you use the BMC Performance Exception Detector module, you must assign
each new detector to at least one object group.
■
Infrastructure—created and populated by the BMC Performance Manager Portal
module
When you use the BMC Performance Manager Portal module, you must assign
each new infrastructure element to at least one object group.
You choose how to create and organize the object groups in your account. Object
groups can assist you with the following activities:
■
creating user permissions—Create groups of objects whose members require the
same level of access. User groups provide permission to access specific objects.
Instead of selecting individual objects during user group creation, you can select
one or more object groups.
■
scheduling blackout periods—Create groups of objects that have the same
maintenance schedules.
Chapter 3
Users and administrators
59
Personal Preferences task
■
specifying objects to include in user notifications—Create groups of objects to
which you assign the same notification criteria. Instead of selecting individual
objects while you create a notification rule, you can select one or more object
groups.
Personal Preferences task
The Personal Preferences task enables you to control the language, time zone, refresh
rate, default view at logon, and provides the ability to view or suppress object status
icons in the object tree when you are logged on with your user name.
Remote Service Monitors task
The Remote Service Monitors task enables you to add and administer Remote Service
Monitors for your account. The BMC Performance Manager Portal module uses
Remote Service Monitors, or RSMs (computers in which you have installed the
Remote Service Monitor program), to provide agentless infrastructure monitoring
and to mine parameter data from PATROL Agents.
A user with the necessary permissions can add RSM computers to collect
measurement data about the elements in an account. The number of RSM computers
that you need depends on the number and types of elements in your account and
your high availability requirements. If you use PATROL integration Performance
Managers, the security level of the monitored PATROL agents can also affect the
number of RSMs required for your account. See “Security requirements for RSMs” on
page 21 for more information about how security levels can affect RSMs.
See “RSM program installation” on page 76 for more information about using and
configuring RSM computers.
Shared Credentials task
The Shared Credentials task enables you to define and save credentials that you can
apply to one or more elements. When you apply shared credential to elements, you
can simultaneously modify the credentials of those elements by updating the
properties for the shared credentials.
You can define shared credentials that the Portal can use across multiple application
classes on a single element, or across multiple elements.
60
BMC Performance Manager Portal Monitoring and Management Guide
Tags task
NOTE
The ability to apply shared credentials to an element is enabled in application classes. If you
do not see an option to apply a shared credential when specifying credentials and properties
for an application class, then the selected application class is not enabled for shared
credentials. For more information, see the applicable Performance Manager documentation
for the application class.
Guidelines for using shared credentials
Users with the necessary rights can create, edit, delete, and view lists of elements
using a shared credential.
■
You can apply a shared credential to individual elements or to an element profile.
■
When you modify the properties in a shared credential, the Portal immediately
updates the application class properties for the affected elements, including those
that obtain their properties from an element profile.
■
If you remove a shared credential from an infrastructure element, the properties in
the shared credential are copied to the infrastructure element.
■
You can delete a shared credential only if it is not applied to an element.
Preventing system lockouts on the monitored infrastructure elements
Before changing the credentials on the monitored infrastructure, use the Monitoring
Off or Blackout Periods task to stop the Portal from monitoring the systems that use
the credentials. If you do not temporarily stop monitoring before you change the
system credentials, the Portal might lock out your systems before you have an
opportunity to change the shared credential properties on the Portal.
Tags task
Tags are keywords that you can assign to objects in the account. Tagging objects with
keywords enables you to quickly retrieve a list of objects that have the same keyword
associations. Because the Portal does not restrict the number of keywords, individual
users can add keywords that are meaningful to them.
Chapter 3
Users and administrators
61
User Groups task
Types of tags
The Portal enables the following types of tagging:
■
system: dynamically and automatically assigned as you create or add objects to the
account
For example, when you create a new object group, the Portal assigns the object
group name as the system keyword for the object.
The Portal changes the system keyword if you change the name of its object. You
cannot explicitly change a system keyword.
■
user-defined: represent how you want to monitor and manage your infrastructure
For example, consider using department names, operating system names, and
application names as keywords.
You might also consider creating keywords that enable you to respond to
temporary conditions. For example, after implementing changes on critical
systems, you might want to assign a keyword like to_watch to the corresponding
infrastructure objects, enabling you to quickly access views of these objects. After
the initial implementation period has expired, you would remove the tag from
these objects.
Searching for tagged objects
The navigation pane provides a Search box that you can use to retrieve objects tagged
with specific system or user-defined keywords.
User Groups task
A user group is a collection of users that all have the same rights and permissions.
Users inherit the rights and permissions from the groups to which they belong. You
can create user groups to organize users according to rights and permissions. Each
user must belong to at least one user group.
The default user groups are Full Access and Read Only. Users in the Full Access user
group have access to all the features in the Portal and can add new users and user
groups. Users in the Read Only user group have read-only rights to all the Portal
features and read-only permissions for all objects.
The User Groups task enables you to create new user groups. You can create user
groups that use the BMC Portal database to authenticate users, or create user groups
that use external directory servers to authenticate users.
62
BMC Performance Manager Portal Monitoring and Management Guide
Users task
Users task
A user is a unique identifier in the Portal that you specify to access the product. As
users are added to the Portal, they are assigned to one or more user groups. Together,
users and user groups provide access rights and permissions on managed systems.
Rights and permissions are assigned to user groups, and users inherit the rights and
permissions from the groups to which they belong. Each user must belong to at least
one user group.
The Users task enables full-access users to add more users to the account, modify
users, and delete users from the account.
User authentication
The Portal requires that all user names exist in the Portal database, regardless of the
authentication type configured by the Portal administrator.
■
When you use the internal database for authentication (the default option), all user
information is saved in the internal database.
■
When you configure native operating-system authentication, you must create a
user in the internal database for each native operating-system user that logs on to
the Portal.
■
When you configure LDAP or Active Directory server authentication, the Portal
creates an internal user for each user specified in the directory server group.
Predefined user
The BMC Portal installation program creates a full-access user (with user/user
credentials) for the predefined account (My Account). You can use the User task to
change the predefined user credentials.
Characters allowed for user names
When adding users, you can use any combination of Unicode characters, but you
cannot use only a space for the user name. A user name can contain spaces, but not
consecutive spaces.
Chapter 3
Users and administrators
63
Administrator configuration options
Administrator configuration options
Administrators can have one, both, or neither of the following permissions:
■
■
Edit—enables the administrator to edit any accessible properties
See Other Providers and Their Accounts—enables the administrator to access all
accounts on the Portal
The combination of these permissions determines how you can access and configure
the Portal or any of the accounts on the Portal. When adding administrators to a
provider, assign account permissions that reflect the responsibilities of the
administrator.
■
An administrator with both Edit and See Other Providers and Their Accounts
permission (a Portal administrator) can edit the provider, administrators, and users
for every account on the Portal. An administrator with these permissions can also
configure the Portal. Each Portal needs at least one Portal administrator.
By default, each Portal has a Portal administrator that can log on by typing
superadmin and superadmin for the user name and password.
■
An administrator with Edit permission (a provider administrator) can configure
the provider, administrators for that provider, and accounts, and can approve or
reject accounts for that provider.
By default, each Portal has a provider administrator that can log on by typing
admin and admin for the user name and password.
■
An administrator with See Other Providers and Their Users permission has readonly rights to the provider and Portal configuration. An administrator with this
permission cannot edit account properties, but can impersonate all users on the
Portal. See “Tasks on the Accounts tab” on this page.
■
An administrator with neither permission has read-only rights to the provider
configuration for that provider and can access all accounts for that provider.
Tasks on the Accounts tab
The Accounts tab provides tasks that administrators can use to add, configure, and
approve accounts. Also, administrators who provide support activities can use the
tasks on the Accounts tab to proactively support their customers. From this tab,
administrators can help troubleshoot problems for their users by viewing activity
logs and by using the Log On option to impersonate their users.
64
BMC Performance Manager Portal Monitoring and Management Guide
Tasks on the Provider tab
Tasks on the Provider tab
Each organization that offers and supports the BMC Portal is a provider. Each
provider has corresponding properties that affect the overall appearance of the user
interface and the defaults that apply to the users and accounts for the provider.
■
Each provider has at least one administrator that can access all of the
administration tools to maintain the provider properties and settings.
■
Administrators with Edit or Edit and See Other Providers and Their Accounts
permissions can see the Provider tab and perform the tasks described in this
section.
The Help provides detailed information about each of the features on the Provider tab.
Account Types task
The Account Types task enables administrators to configure default properties for the
following categories of accounts:
■
■
■
trial—generally assigned to those trying the product
paying—assigned to most users of the product
internal—generally reserved for those who support the product and have accounts
that they use for testing
As accounts are added to the Portal, administrators assign an account type to the
account, and the account assumes the default properties for the account type.
Administrators can adjust account settings after assigning the account type.
Administrators task
The Administrators tasks enable administrators to add and modify administrators for
a provider. Administrators who have Edit and See Other Providers and Their Accounts
permissions can add administrators for the Portal.
Appearance task
The Appearance task enables administrators to customize the user interface for all
accounts associated with a provider. The page properties that you can change include
the
■
■
left and right banner images
product name displayed in the Portal user interface and in the Help
Chapter 3
Users and administrators
65
Tasks on the Provider tab
Licensing Information task
The Licensing Information task provides the following subtasks that administrators
can use to monitor and manage license usage:
■
The Performance Managers subtask enables administrators to generate CSV and text
files that list the extent to which the accounts in a provider are using the
Performance Managers to monitor their infrastructure. When generating the file,
you can select all the accounts in the provider or a subset of the accounts.
The Help provides detailed information about how to generate CSV files.
■
The Users subtask enables administrators to establish license thresholds for all
accounts on the Portal, maintain licenses, and monitor license usage.
Notifications task
The Notifications task on the Provider tab enables you to establish and maintain
notification rules that apply to all state change and general system problems events
associated with a provider. Because these notification rules apply to all events in a
provider, they enable you to integrate events from the BMC Performance Manager
Portal module with other modules and event management systems. See “Providerwide integration” on page 188 for more information about the transport methods that
you can use.
Properties task
The Properties task enables you to add providers and modify provider characteristics.
Administrators that have Edit permission can change the properties for their own
providers. Administrators who have both Edit and See Other Providers and Their
Accounts permissions can change the properties for all providers on the Portal.
Remote Service Monitors task
When you enter provider administrator credentials (administrator with only Edit
permission) during the installation of the RSM program, you configure a shared RSM
that multiple accounts can use to monitor infrastructure elements. The Remote Service
Monitors task enables you to administer shared RSMs for the provider.
66
BMC Performance Manager Portal Monitoring and Management Guide
Tasks on the Portal tab
Tasks on the Portal tab
The tasks associated with the Portal tab affect all accounts on the Portal.
Administrators with Portal permission (both Edit and See Other Providers and Their
Accounts permissions) can see the Portal tab and perform these tasks.
The Help provides detailed information about each of the features on the Portal tab.
Global Properties task
The Global Properties task enables administrators to set properties that can affect all
providers and accounts in the Portal.
Licensing Information task
The Licensing Information task enables Portal administrators monitor license usage
across all accounts on the Portal.
Mass Email task
The Mass Email task enables Portal administrators send email to all or a subset of
users and administrators on the Portal.
Performance Managers task
RSMs use the application classes contained in Performance Managers to monitor
groups of attributes on an infrastructure element. In addition to your ability to install
solution application classes on the Portal, administrators can use the Performance
Managers task to create and maintain custom application classes.
Administrators can use the Performance Manager Editor (PME) to modify the
application classes in solution Performance Managers and to create and modify
custom application classes for the accounts on the Portal. Administrators can also use
this task to import new solution Performance Managers into the Portal.
See Chapter 5, “Performance Managers and application classes,” on page 111 for
more information about importing solution Performance Managers and creating and
maintaining custom Performance Managers.
Chapter 3
Users and administrators
67
Tasks on the Portal tab
Remote Service Monitors task
When you enter Portal administrator credentials during the installation of the RSM
program, you configure a global RSM that all accounts on the Portal can use to
monitor infrastructure. The Remote Service Monitors task enables you to administer
global computers for the provider.
68
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
4
4
Remote Service Monitors
This chapter presents the following topics that describe how to configure the
monitoring component for the BMC Performance Manager Portal.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Types of RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Communication between the Portal and RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Communication between RSMs and elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Communication between RSMs and PATROL Agents . . . . . . . . . . . . . . . . . . . . . . 74
Notifications about RSM system problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
RSM program installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
RSM computer system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Data execution prevention (DEP) configuration for the RSM . . . . . . . . . . . . . . . . 76
Configure Distributed Component Object Model (DCOM) and Windows
Management Instrumentation (WMI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Using the installation wizard to install the RSM program . . . . . . . . . . . . . . . . . . . 84
Using a silent installation to install the RSM program . . . . . . . . . . . . . . . . . . . . . . 88
Data execution prevention (DEP) configuration for the RSM . . . . . . . . . . . . . . . . 76
Upgrading the RSM Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Clustered RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Cluster types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Clustered RSM operating status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Clustered RSM security considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
RSM load-balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
RSM failover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Clustering RSMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Clustered RSM upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
RSM configuration and maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Configuration and maintenance tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Changing the security level for an RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Configuring an RSM to use a proxy server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Configuring the RSM to use HTTP protocol to communicate with the
Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Changing the credentials for an RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Changing the maximum heap memory allocated for the Java VM on the
RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Viewing the log files for the RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Chapter 4
Remote Service Monitors
69
Overview
Collecting log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
RSM program uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Using the installation wizard to uninstall the RSM program . . . . . . . . . . . . . . . . 106
Manually uninstalling the RSM program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Using command-line options to uninstall the RSM program . . . . . . . . . . . . . . . . 109
Overview
The Remote Service Monitor (RSM) program runs as a Windows service (BMC
Remote Service Monitor service). Computers on which you have installed the RSM
program, also known as RSMs, are the components that provide the remote
monitoring for the BMC Performance Manager Portal.
The RSM, which acts as a single remote agent, monitors the elements in the accounts
and sends parameter data values to the Portal web server. The RSM must be able to
resolve network addresses to the elements that it monitors and to the BMC Portal.
The RSM uses the parameter thresholds that are saved in the Portal database to
monitor infrastructure. The RSM does not save thresholds to its local computers.
Each RSM has a utility program, the RSM Manager, that you can access from the
Windows system tray on the RSM computer. The RSM Manager utility enables you to
view current RSM status and settings, and to configure the RSM.
Types of RSMs
The BMC Performance Manager Portal module uses the following types of RSMs to
monitor accounts:
70
■
A dedicated RSM monitors only the elements in your account, and is installed with
user credentials. You configure a dedicated RSM by downloading the RSM
program from the Portal and installing it on a computer designated as an RSM.
Figure 7 on page 71 shows a Portal where account D has a single dedicated RSM to
monitor its elements, although an account can have more than one dedicated RSM.
Users in account D can also use the global RSM to monitor elements.
■
A shared RSM can monitor the elements in multiple accounts in a provider, and is
installed with administrator credentials for an administrator that has only Edit
permission. Figure 7 on page 71 shows that the accounts in provider ABC can use
the same shared RSM. Users in accounts A, B, and C can also use the global RSM.
The accounts that use a shared RSM must belong to the same provider.
BMC Performance Manager Portal Monitoring and Management Guide
Communication between the Portal and RSMs
■
A global RSM can monitor elements for all accounts on the Portal, and is installed
with administrator credentials for an administrator that has Edit and See Other
Providers and Their Accounts permissions.
■
A clustered RSM consists of two or more dedicated, shared, or global RSMs
configured to act as a single logical RSM. An RSM cluster must contain RSMs of the
same type. See “Clustered RSMs” on page 92 for more information about clustered
RSMs.
Your Portal administrator determines the types of RSMs available for your account.
Administrators and users with adequate permission can download and install the
RSM program.
Figure 7
Types of Remote Service Monitors
database
web browser
web server
application server
firewall
shared RSM
Account A
Account B
global RSM
dedicated RSM
Account C
Provider ABC
Account D
Provider DEF
Communication between the Portal and RSMs
Each RSM initiates all communication between itself and the Portal web server. When
placed inside the firewall, the RSM communicates with the Portal using HTTPS (port
443) and encrypts the data that it collects before sending it to the Portal web server.
After the web server receives data from the RSM, it sends it to the application server,
which sends the data to the Portal database.
Chapter 4
Remote Service Monitors
71
Communication between the Portal and RSMs
To configure the RSM to use HTTP to communicate with the Portal, see “Configuring
the RSM to use HTTP protocol to communicate with the Portal” on page 101.
Types of communication
RSM-to-Portal communication falls into one of the following categories:
■
heartbeat—The RSM attempts to connect to the Portal every 30 seconds to ensure
that the connection between the two components still exists. The heartbeat also
confirms that the Portal and RSM are running the same product version and that
they are both using the same user or administrator credentials.
If the user or administrator ID that installed an RSM becomes disabled or if its
credentials are not kept synchronized, the corresponding RSMs will fail to
authenticate with the Portal and will not send parameter data to the Portal. When a
disabled user or administrator is enabled or when the credentials are corrected, the
RSM resumes normal communication with the Portal after the next heartbeat.
■
threshold violations—When the RSM detects a threshold violation for a parameter,
it immediately sends the value for all parameters in the associated application
class to the Portal. You can set thresholds on the Properties page for elements.
■
parameter report data—The RSM sends current parameter data at the report
update interval defined for the element and whenever a parameter violates a
threshold, as described in the preceding paragraph. You can view this data on
parameter history charts.
■
program upgrade—The RSM downloads the latest version of the RSM program
after an upgrade of the Portal.
Communication interruptions
If an RSM cannot communicate with the Portal, it caches the data and attempts to
resend the cached data at the next heartbeat interval. If the RSM cannot successfully
send the data to the Portal after 15 minutes of repeated attempts, it deletes data older
than 15 minutes, and this process continues on every heartbeat interval until the
communication is reestablished. Any data that the RSM drops appears as a data gap
on reports.
NOTE
By default the RSM stores cached data for 15 minutes while waiting for a response from the
Portal. You can change the default time by resetting the MaxStoreAndForwardTime property
in the portal-PortalWebServer.properties file on the RSM computer. Lengthening the time
that the RSM caches data has a direct impact on system memory consumption. For
information about changing this property setting, see Table 55 on page 293.
72
BMC Performance Manager Portal Monitoring and Management Guide
Communication between the Portal and RSMs
When communication with the Portal resumes, the RSM sends any cached data that it
has not deleted. The Portal saves the cached data, but if the cached data includes
threshold violations, the Portal does not send notifications.
RSMs and their assigned elements
When you add elements to the account, you specify which RSM will monitor each
element. You can assign one RSM (or clustered RSM) to monitor an infrastructure
element. See “Clustered RSMs” on page 92 for information about using clustered
RSMs in place of non-clustered RSMs.
RSM program and BMC Performance Manager Portal
upgrades
During a Portal upgrade, communication stops between the Portal and its RSMs, and
data collection stops. Following the upgrade, the RSMs determine that they have an
earlier version of the RSM program and will request the current version of the RSM
program from the Portal. Upon receipt of the program, the RSMs will begin
upgrading to the new version and will drop their stored data. Immediately after
upgrading the RSM program, RSMs resume their communication with the Portal.
BMC Performance Managers on the RSM
The RSM program collects data from its monitored elements and sends that data to
the BMC Performance Manager Portal. The types of measurements that an RSM can
collect depend on the Performance Managers installed on the Portal. After
Performance Managers are installed, the Portal deploys the Performance Managers to
an RSM, upon request from the RSM.
EXAMPLE
You install the BMC Performance Manager Express for Databases solution Performance
Manager while installing the Portal. Following installation, a user selects the Oracle®
application class to monitor a database. When the assigned RSM computer discovers that it
does not have the specified application class, it requests the application class from the Portal
and the Portal deploys the Oracle application class to the RSM computer.
Chapter 4
Remote Service Monitors
73
Communication between RSMs and elements
Communication between RSMs and elements
RSMs use standard protocols to communicate with their assigned elements and can
monitor any IP-addressable computer or device. Ideally, you should locate an RSM
inside the firewall on the same network segment as the elements that it will monitor.
When a firewall sits between an RSM and the monitored element, configure the
firewall according to the information shown in Table 4 on page 74. This configuration
specifies the necessary ports for communication between the RSM and its elements.
Table 4
Application ports for firewalls
Application
Port number
DNS
53
FTP server
21
HTTP
80
a
Protocol
DNS name lookup
network socket connection
a
HTTPS
443
IMAP server
143
HTTP
a
Network Service Port
user
NNTP server
119
HTTPS
network socket connection
specified a
network socket connection
network socket connection
b
ICMP
Ping
ICMP
POP server
110
network socket connection
rstatd
111
RPC
SMTP
25
network socket connection
SNMP
161
SNMP
SSH server
22
network socket connection
Telnet server
23
network socket connection
Windows
TCP 135, 139, 445
UDP 137, 138, Dynamic
WinAPI (IPC$ share)
a
You can specify any port number, or use the default shown.
b
ICMP does not use a port.
Communication between RSMs and PATROL Agents
The RSM installation program requests a PATROL security level. The level that you
specify must match that of the PATROL Agents that the RSM will monitor.
74
■
If you will not use PATROL integration Performance Managers to monitor
PATROL Agents, you can use the default security level (level 0).
■
If you will use PATROL integration Performance Managers to monitor PATROL
Agents, specify the security level that matches that of the PATROL Agents. If you
will be monitoring PATROL Agents that have different security levels, configure a
BMC Performance Manager Portal Monitoring and Management Guide
Notifications about RSM system problems
separate RSM for each security level and assign to each RSM only the agents with a
security level that matches that RSM.
When you create RSM clusters that will integrate PATROL Agents, all member
RSMs in the cluster must have the same security level.
If the security level that you specify during RSM installation is not sufficient to
monitor the PATROL Agents in your environment, you can choose from the
following options:
— Change the security level of the RSM. See “Changing the security level for an
RSM” on page 99.
— Install the RSM program on another computer and specify the necessary
security level.
Notifications about RSM system problems
You can configure the Portal to send notifications when RSM system problems
interfere with the infrastructure monitoring.
■
To configure notifications for dedicated RSMs, log on with user credentials and on
the Configure tab, select Notifications.
■
To configure notifications for shared and global RSMs, log on with administrator
credentials and on the Provider tab, select Notifications.
When configuring the notification rules for RSMs, select General System Problems as
the rule type. The following conditions can cause general system problems:
■
■
■
The Portal does not receive data from the RSM.
The network is down.
The number of users exceeds the license threshold for the Portal.
See “Notifications task” on page 55 for more information about the different types of
notifications.
Chapter 4
Remote Service Monitors
75
RSM program installation
RSM program installation
This section provides the procedures necessary to install or upgrade the RSM
program on the computers designated as RSMs.
■
■
■
■
■
■
■
“RSM computer system requirements” on page 76
“Data execution prevention (DEP) configuration for the RSM” on page 76
“Configuring the access permissions for DCOM on the RSM computer and on the
target computer” on page 78
“Configuring the WMI control” on page 81
“Using the installation wizard to install the RSM program” on page 84
“Using a silent installation to install the RSM program” on page 88
“Upgrading the RSM Program” on page 91
RSM computer system requirements
You can install one instance of the RSM program on the BMC Portal computer (or the
application server computer in a multiple-computer Portal), or on computers
designated as RSMs. Computers designated as RSMs reside in the network with the
computers and devices that they monitor and inside the firewall, as shown in Figure 7
on page 71.
Ensure that the computers on which you want to install the RSM program meet the
minimum system requirements detailed in the BMC Portal Release Notes.
Data execution prevention (DEP) configuration for the RSM
When you install the RSM program on a Windows 2003 SP1 computer, the
installation program fails to successfully execute the RemoteServiceMonitor.exe file.
The installation program starts, but then does not allow you to continue with the
installation or an error message is displayed stating that DEP is blocking the
installation program. The problem is caused by an enhanced data execution
prevention (DEP) feature that Microsoft included in SP1. To resolve this issue, you
must configure DEP in your computer properties to recognize the RSM installation
program.
76
BMC Performance Manager Portal Monitoring and Management Guide
Data execution prevention (DEP) configuration for the RSM
To configure DEP to recognize the RSM installation program
1 On the Remote Service Monitors page in the Portal, download the RSM installation
program, and save the program to a temporary directory.
When installing the RSM program from the Windows DVD, CD 1, or installation
files, copy RemoteServiceMonitor.exe from one of the following locations to a
temporary directory:
■
RSM folder on Windows CD 1
■
BMCPortalKit\disk1\RSM on Windows DVD
■
folder to which you downloaded files from the EPD website
2 From the Windows Desktop, right-click My Computer.
3 Select Properties.
4 Select the Advanced tab.
5 Under the Performance heading, select Settings.
6 Select the Data Execution Prevention tab.
7 Select Turn on DEP for all programs except those I select.
8 Click Add.
9 Navigate to the folder where you saved the RSM installation program, and select
RemoteServiceMonitor.exe.
10 Click Open.
11 Click Apply.
12 Click OK.
13 Click OK to close the System Properties window.
14 Restart the RSM computer.
15 Run the RSM installation program.
Chapter 4
Remote Service Monitors
77
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
Configure Distributed Component Object Model (DCOM) and
Windows Management Instrumentation (WMI)
When monitoring Windows computers using the WMI collector, ensure that the
Remote Service Monitor (RSM) computer (the computer where the RSM is installed)
has the necessary DCOM and WMI configuration properties.
The RSM computer that monitors the event logs and services must have the following
default access permissions enabled in the DCOM properties:
■
■
■
■
Administrators
Interactive
Network
System
To successfully read performance data using WMI-based data collection, both the
RSM computer and the target computer (the computer that you want to monitor)
must have the appropriate permissions. The following are the permissions that must
be enabled on the RSM and on the target computer:
■
■
■
■
■
Execute Methods
Provider Write
Enable Account
Remote Enable
Read Security
Configuring the access permissions for DCOM on the RSM
computer and on the target computer
To configure the access permissions for DCOM on the RSM computer and on the
target computer, use one of the following procedures:
■
■
“To configure the access permissions for DCOM on Microsoft Windows 2000”
“To configure the access permissions for DCOM on Microsoft Windows XP and
Microsoft Windows 2003” on page 80
Before you begin
Stop the RSM, and do not restart it until you have configured the access permissions
for the DCOM on both the RSM computer and the target computer.
78
BMC Performance Manager Portal Monitoring and Management Guide
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
To configure the access permissions for DCOM on Microsoft Windows 2000
1 Using an account that has administrative permissions, log on to the RSM computer
that is monitoring the event log.
2 Click Start => Run.
3 Enter dcomcnfg.exe and click OK.
4 On the Distributed COM Configuration Properties window, click Default Security.
5 Under Default Access Permissions, click Edit Default.
6 In the Registry Value Permissions window, click Add.
The Add Users and Groups window opens.
7 From the List Names From drop-down list, select the local computer.
8 In the Type of Access field, select Allow Access (if not already selected).
9 In the Names field, perform the following steps:
A Select Administrators, and click Add.
B Select Interactive, and click Add.
C Select Network, and click Add.
D Select System, and click Add.
E Click OK.
10 In the Registry Value Permissions window, verify that the Administrators,
Interactive, System, and Network users are added, and that they have Allow
Access permission.
11 Click OK, twice.
12 Using an account that has administrative permissions, log on to the target
computer and repeat steps 2 through 11.
13 Start the RSM.
Chapter 4
Remote Service Monitors
79
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
To configure the access permissions for DCOM on Microsoft Windows XP and
Microsoft Windows 2003
Before you begin
Stop the RSM and do not restart it until you have configured the access permissions
for DCOM on both the RSM computer and the target computer.
1 Using an account that has administrative permissions, log on to the RSM computer
that is monitoring the event log.
2 On the Task Bar, click Start => Run.
3 Enter dcomcnfg.exe and click OK.
4 In the Component Services window, expand Component Services and Computers.
5 Right-click on My Computers and select Properties.
6 Select the COM Security or Default COM Security tab (depending upon your
operating system).
7 Under Access Permissions, select Edit Default.
8 In the Access Permissions window, click Add.
9 In the text box under Enter the object names to select (examples), enter Administrators;
Interactive; System; Network and click OK.
If a window opens with the message that more than one object matched the name
Administrators, Interactive, System, or Network, select the name that contains
only the one word (Administrators, Interactive, System, or Network).
10 In the Access Permissions window, verify that the Administrator, Interactive,
System, and Network users have been added and that Allow Access permission is
selected for each.
11 Click OK to return to the Component Services window.
12 Choose File => Exit.
13 Using an account that has administrative permissions, log on to the target
computer, and repeat steps 2 through 12.
14 Start the RSM.
80
BMC Performance Manager Portal Monitoring and Management Guide
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
Configuring the WMI control
Use the following procedures to configure and to test the WMI collector:
■
■
■
■
“To configure the WMI control” on page 81
“To set the inheritance on the name space” on page 82
“To test the WMI collector for CIMV2 name space.” on page 83
“To test the WMI collector for DEFAULT name space” on page 83
The permissions that are added are in addition to the permissions discussed under
Configuring DCOM configuration properties.
To configure the WMI control
1 On the Task bar, click Start => Settings => Control Panel.
2 Double-click Administrative Tools.
3 Double-click Computer Management.
4 Double-click Services and Applications.
5 Right-click WMI Control and select Properties.
6 Click Security.
7 Double-click Root and select CIMV2.
8 Click Security.
9 Click Add.
10 In Select Users, Computers or Groups, enter your user name or group name in Enter
the objects to select and click OK.
11 In Group or User Names, select your user name or group name.
12 In Allow Permissions for Administrators, select the following permissions:
■
■
■
■
■
Execute Methods
Provider Write
Enable Account
Remote Enable
Read Security
13 Click OK.
Chapter 4
Remote Service Monitors
81
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
14 Select DEFAULT.
15 Click Security.
16 Click Add.
17 In Select Users, Computers or Groups, enter your user name or group name in the
Enter the objects to select and click OK.
18 In Group or User Names, select your user name or group name.
19 In Allow Permissions for Administrators, select the following permissions:
■
Execute Methods
■
Provider Write
■
Enable Account
■
Remote Enable
■
Read Security
20 Click OK.
To set the inheritance on the name space
1 On the WMI Collector Properties snap-in, click Security.
2 Click Advanced.
3 In Permission entries, select the user or group whose permissions you want to
modify, and then click Edit.
4 To modify permissions for the user or group that you selected, in the Permissions
list, click Allow or Deny next to the permission that you want to allow or deny.
5 In Apply onto, click This name space and sub name space, and click OK.
6 Click OK.
7 Quit the WMI Control snap-in.
Determining whether the RSM can use the WMI collector to
access the remote computer
You can use wbemtest to determine whether the RSM computer can use WMI to
access the remote computer.
82
BMC Performance Manager Portal Monitoring and Management Guide
Configure Distributed Component Object Model (DCOM) and Windows Management Instrumentation (WMI)
To test the WMI collector for CIMV2 name space.
1 Open a command prompt window, and type wbemtest.
2 Click Connect.
3 Change name space to \\RemoteComputerToBeMonitored\root\CIMV2
4 Type user: domain\user
5 Type the password for the user.
6 Click Connect.
7 Click Query.
8 Type the following query: select * from Win32_NTEventLogFile and click Apply.
If this query is successful, Event Log file names, for example, AppEvent.Evt,
SecEvent.Evt and SysEvent.Evt (with paths), are generated. If these log files are not
generated, it indicates that the 'WMI collector for CIMV2 name space' test has
failed, and there is some problem with the WMI. See the error codes in the
wbemtest tool for information related to the problem.
9 Click Close and Exit.
To test the WMI collector for DEFAULT name space
1 Open a command prompt window, and type wbemtest.
2 Click Connect.
3 Change name space to \\RemoteComputerToBeMonitored\root\DEFAULT.
4 Type user: domain\user
5 Type the password for the user.
6 Click Connect.
7 Click Execute Method.
8 In Object Path, enter StdRegProv, and click OK.
9 In Method, select GetStringValue, and click Edit in Parameters.
Chapter 4
Remote Service Monitors
83
Using the installation wizard to install the RSM program
10 In Properties, double click sSubKeyName, select Not NULL, enter
"SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters", and click Save
Property.
11 Double click sValueName, select Not NULL, enter "Hostname", and click Save
Property… .
12 Click Save Object.
13 Click Execute.
14 Click Edit Out Parameter.
15 In Properties, check the value for sValue. It should be the name of the host to which
we have connected from RSM.
16 Click Close.
17 Click Exit.
NOTE
The StdRegProv class contains methods that manipulate system registry keys and
values. StdRegProv is available only in root\default name space.
Using the installation wizard to install the RSM program
This procedure describes how to install the RSM program on a Windows computer.
When you install the RSM program, the installation program requires that you enter
credentials that the RSM uses to authenticate itself with the Portal. These credentials
also determine the RSM type and how the users on the Portal can use the RSM to
monitor their accounts.
You can install the RSM program by downloading the installation program file from
the Portal or by copying it from the installation media.
84
BMC Performance Manager Portal Monitoring and Management Guide
Using the installation wizard to install the RSM program
To install the RSM program by downloading the program from the Portal
1 Log on to the Portal.
2 Perform one of the following actions:
■
■
■
When logged on with user credentials, click the Configure tab.
When logged on with provider administrator credentials, click the Provider tab.
When logged on with Portal administrator credentials, click the Portal tab.
3 From the Tasks list, select Remote Service Monitors.
4 On the Remote Service Monitors page, click Add to open the Remote Service
Monitors–Add page.
5 Click the Download the Remote Service Monitor program Now link to download the
RSM program installation file to a temporary directory on the computer
designated as the RSM.
6 When installing the RSM program on a Windows 2003 SP1 computer, perform
step 2 on page 77 through step 13 on page 77 to configure DEP to recognize the
RSM installation program.
7 Run RemoteServiceMonitor.exe to extract and start the installation program.
8 On the Introduction screen, click Next to display the software license agreement.
9 Select I accept the terms of the License Agreement, and click Next.
10 On the Select directory screen, specify a target directory or accept the default
location for the program files, and click Next.
Chapter 4
Remote Service Monitors
85
Using the installation wizard to install the RSM program
11 On the Enter Logon Information screen, enter the following authentication
information, and click Next:
Item
Description
User Name
the user name that determines the type of RSM:
■
To configure an RSM for a single account, type the
user name for the account.
■
To configure an RSM that can monitor all accounts
associated with a provider, type a user name for an
administrator that has only Edit permission (provider
administrator credentials).
■
To configure an RSM computer that can monitor all
accounts on the Portal, type a user name for an
administrator that has Edit and See Other Providers
and Their Accounts permissions (Portal administrator
credentials).
Portal Password
the password for the specified user name
Confirm Password
re-entry of the password for confirmation
Fully-Qualified Portal Host
Name
fully-qualified host name for the Portal web server
Portal Secure Port
port on which the Portal receives secure requests from the
RSM; 443 by default
RSM Name
host name or alias for the RSM
12 Indicate whether you will use this RSM to integrate data from PATROL Agents,
and click Next.
■
■
If you select Yes, the next screen requests the security level for the RSM.
If you select No, skip to step 13 on page 87.
If at a later time you decide to use this RSM to integrate PATROL Agent data, you
must perform the steps described in “Changing the security level for an RSM” on
page 99 to set the correct security for the RSM.
If this RSM will integrate parameter data from PATROL Agents, select the security
level that corresponds to those agents, and click Next.
The security level of the RSM must match that of the PATROL Agents that it
monitors. If you plan to monitor PATROL Agents with different security levels,
configure a separate RSM for each security level and assign to each RSM only the
agents with a security level that matches that RSM.
If you select level 3 or level 4, configure the security for unattended mode. For
more information about security, see the PATROL Security User Guide.
86
BMC Performance Manager Portal Monitoring and Management Guide
Using the installation wizard to install the RSM program
13 On the Pre-Installation Summary screen, review the entries and selections for the
monitor installation, and click Install.
At the completion of the installation, the Install Complete page is displayed.
To install the RSM program by copying it from the installation files
1 Copy RemoteServiceMonitor.exe from one of the following locations to a temporary
directory:
■
RSM folder on Windows DVD
■
BMCPortalKit\disk1\RSM on Windows DVD
■
folder to which you downloaded files from the EPD website
2 When installing the RSM program on a Windows 2003 SP1 computer, perform
step 2 on page 77 through step 13 on page 77.
3 Run RemoteServiceMonitor.exe to extract and start the installation program.
4 On the Introduction screen, click Next to display the software license agreement.
5 Select I accept the terms of the License Agreement, and click Next.
6 On the Select directory screen, specify a target directory or accept the default
location for the program files, and click Next.
7 On the Enter Logon Information screen, enter the following authentication
information, and click Next:
Table 5
Authentication information on Logon Information screen (part 1 of 2)
Item
Description
User Name
the user name that determines the type of RSM:
■
To configure an RSM for a single account, type the
user name for the account.
■
To configure an RSM that can monitor all accounts
associated with a provider, type a user name for an
administrator that has only Edit permission (provider
credentials).
■
To configure an RSM that can monitor all accounts on
the Portal, type a user name for an administrator that
has Edit and See Other Providers and Their Accounts
permissions (Portal credentials).
Portal Password
the password for the specified user name
Confirm Password
re-entry of the password for confirmation
Chapter 4
Remote Service Monitors
87
Using a silent installation to install the RSM program
Table 5
Authentication information on Logon Information screen (part 2 of 2)
Item
Description
Fully-Qualified Portal Host
Name
fully-qualified host name for the Portal web server
Portal Secure Port
port on which the Portal receives secure requests from the
RSM; 443 by default
RSM Name
host name or alias for the RSM
8 Indicate whether you will use this RSM to integrate data from PATROL Agents,
and click Next.
■
■
If you select Yes, the next screen requests the security level for the RSM.
If you select No, skip to step 9 on page 88.
If at a later time you decide to use this RSM to integrate PATROL Agent data, you
must perform the steps described in “Changing the security level for an RSM” on
page 99 to set the correct security for the RSM.
If this RSM will integrate parameter data from PATROL Agents, select the security
level that corresponds to those agents, and click Next.
The security level of the RSM must match that of the PATROL Agents that it monitors.
If you plan to monitor PATROL Agents with different security levels, configure a
separate RSM for each security level and assign to each RSM only the agents with a
security level that matches that RSM.
If you select level 3 or level 4, configure the security for unattended mode.
For more information about security, see the PATROL Security User Guide.
9 On the Pre-Installation Summary screen, review the entries and selections for the
monitor installation, and click Install.
At the completion of the installation, the Install Complete page is displayed.
Using a silent installation to install the RSM program
A silent installation enables you to launch the RSM installation program and specify
installation configuration options from a command line. Perform a silent installation
if any of the following scenarios exists in your environment:
88
■
You want to run the installation in the background instead of interactively.
■
You are installing to a remote computer that cannot display graphical user
interfaces.
BMC Performance Manager Portal Monitoring and Management Guide
Using a silent installation to install the RSM program
■
You want to maintain consistent installation configuration values across multiple
computers.
You specify the command-line options in a text file, and then specify that file when
you launch the installation program from the command line.
Before you begin
■
Copy RemoteServiceMonitor.exe from one of the following locations to a temporary
directory:
— RSM folder on the Windows BMC Portal DVD
— BMCPortalKit\disk1\RSM on Windows BMC Portal DVD
— folder to which you downloaded files from the EPD website
■
Configure DEP to recognize the RSM installation program.
■
In silent installations, passwords are displayed in plain text. If you want to encrypt
the passwords, run the encryption utility as described in “To encrypt RSM
passwords for use in a silent installation” on page 89.
To encrypt RSM passwords for use in a silent installation
1 Launch the RSM maintenance too.
See “To launch the Remote Service Monitor Maintenance Tool” on page 98.
2 Select the Encrypt tab.
3 In Password, type the password for the RSM.
4 In Confirm password, retype the password.
5 Click Encrypt.
The encrypted value is displayed in Encrypted password.
You will use the value in Encrypted password for the PORTAL_PASSWORD and
CONFIRM_PORTAL_PASSWORD values when you enter them in the options text
file or the command line. See “To install the RSM from a command line.”
Chapter 4
Remote Service Monitors
89
Using a silent installation to install the RSM program
To install the RSM from a command line
1 In a text editor, enter the options listed in Table 6 in a file called RSMOptions.txt,
and close and save the file.
NOTE
Include only those options for which you want to specify a value. If you want to use default
values, do not include the option in the options file.
Table 6
Options for an RSM silent installation
Option (case-sensitive)
Description
-P installLocation=installationDirectory
the installation directory where you want to install the
RSM
The default is C:\BMCSoftware\Remote Service
Monitor.
-J PORTAL_HOST_NAME=hostName
the host name where the Portal is installed
-J PORTAL_LOGIN=userName
the user name required to access the Portal
The default is admin.
-J PORTAL_PASSWORD=password
the password required to authenticate the user name
The default is admin.
-J CONFIRM_PORTAL_PASSWORD=password reentry of the password to ensure that you typed it
correctly in the previous field and to complete the
authentication of the user name
-J SECURITY_LEVEL=securityLevel
if you are integrating with PATROL, the security level that
matches the security for the PATROL Console Server
The default is 0.
Note: If several RT clouds operating at different security
levels are communicating through the same Console
Server, see the BMC Portal Installation Guide for
guidance about choosing the security level.
Figure 8 shows an example of the RSMOptions.txt file.
Figure 8
-P
-J
-J
-J
-J
-J
90
Example of RSMOptions.txt file for silent installation
installLocation=C:\BMCSoftware\Remote Service Monitor
PORTAL_HOST_NAME=host.bmc.com
PORTAL_LOGIN=admin
PORTAL_PASSWORD=admin
CONFIRM_PORTAL_PASSWORD=admin
SECURITY_LEVEL=0
BMC Performance Manager Portal Monitoring and Management Guide
Upgrading the RSM Program
2 Open a command prompt.
3 Change to the temporary directory in which you copied RemoteServiceMonitor.exe.
4 Enter the following command:
RemoteServiceMonitor.exe -i silent -DOPTIONS_FILE= drive:\path\RSMOptions.txt
The variable drive:\path is the location in which you saved the options file, if it is
different from the location of RemoteServiceMonitor.exe. If the path contains spaces,
enclose the path and options file name in double quotation marks (for example
“c:\Documents and Settings\RSMOptions.txt”).
To check the status of the installation, view the RSM installation log file.
If a problem occurs
Check the installation log rsm_install_log.txt for error messages. The installation log is
in the %temp% or %tmp% directory.
Where to go from here
After installing the RSM, log on to the Portal with the predefined administrator
credentials provided by the installation program to begin configuring the Portal and
the selected modules. For details about accessing and configuring the Portal, see the
BMC Portal Getting Started guide.
Upgrading the RSM Program
During a Portal upgrade, the RSMs cannot communicate with the Portal. Following
completion of the Portal upgrade, the RSM resumes its communication with the
Portal. When the RSM detects a mismatch between its program version and the
version on the Portal, the RSM obtains the correct version from the Portal. The receipt
of the new RSM program initiates the automatic upgrade of the program on the RSM.
If the RSMs fail to auto-upgrade, see “RSM upgrade fails on Windows 2003 SP1” on
page 255.
Chapter 4
Remote Service Monitors
91
Clustered RSMs
Clustered RSMs
A clustered RSM provides maximum availability and failover in the event of
computer downtime. A clustered RSM appears in the user interface on the Portal as a
single logical RSM. In Figure 9, users can choose from three RSMs when configuring
their elements. You can select a clustered RSM in place of a non-clustered RSM for all
application classes.
Figure 9
Clustered RSMs in the Portal
database
server
Portal
browser
web server
application server
In this scenario, users can
choose from RSMs C, D, and G.
RSM A
RSM B
RSM C
RSM E
RSM D
RSM F
RSM G
elements
NOTE
Selecting the SNMP Trap Listener application class requires additional setup. For all other
application classes, the RSM establishes communication with the monitored computer. In the
case of this application class, the monitored computer establishes communication with the
RSM. If you specify a clustered RSM, update the configuration of the device (router, switch, or
network) to include the IP address or host name of all RSM computers in the cluster as valid
monitoring hosts for the element. See the Help for additional information about this
application class.
The Help describes how to modify the members in a cluster, view the status history of
a cluster, and how to revert from a cluster to individual RSMs.
92
BMC Performance Manager Portal Monitoring and Management Guide
Cluster types
Cluster types
Table 7 shows how clustered RSMs mirror the usage of their individual RSM
counterparts.
Table 7
RSMs and clustered RSM counterparts
Individual RSM
Clustered RSM
Usage
dedicated RSM
dedicated RSM cluster
any user in an account
shared RSM
shared RSM cluster
all users in all accounts under a single
provider
global RSM
global RSM cluster
all users on the Portal
The RSMs that compose the cluster must meet the following requirements:
■
dedicated RSM cluster
— The individual RSMs are dedicated RSMs.
— The dedicated RSMs are installed with user credentials from the same account.
— The cluster is created from the Configure tab on the Remote Service Monitor
page.
■
shared RSM cluster
— The individual RSMs are shared RSMs.
— The shared RSMs are installed with administrator credentials from the same
provider.
— The cluster is created from the Provider tab on the Remote Service Monitors
page.
■
global RSM cluster
— The individual RSMs are global RSMs.
— The global RSMs are installed with Portal administrator credentials.
— The cluster is created from the Portal tab on the Remote Service Monitors page.
When clustering RSMs, you can create clusters of dedicated, shared, or global RSMs,
but you cannot mix RSM types in a cluster. For example, you cannot create a cluster
that contains one shared and one dedicated RSM.
Chapter 4
Remote Service Monitors
93
Clustered RSM operating status
Clustered RSM operating status
On pages where you select RSMs, the following icons represent the current operating
status of the available clustered RSMs:
Table 8
Icon
Icons for clustered RSM operating status
Current operating status
all members in the cluster are online and have an OK operating status
at least one member, but not all, in the cluster is not online
all members in the cluster are not online
Clustered RSM security considerations
When you create a cluster for integrating data from PATROL Agents, ensure that each
RSM in the cluster has a security level that matches those of the PATROL Agents.
RSM load-balancing
After you create the RSM cluster, the Portal attempts to evenly distribute the elements
monitored by the cluster members. The Portal also distributes elements as you assign
them to the cluster.
RSM failover
When a member of the RSM cluster goes offline, the Portal distributes the elements
assigned to that RSM among the remaining online members of the cluster. When the
RSM becomes available again, the Portal load-balances the assigned elements among
the cluster members.
94
BMC Performance Manager Portal Monitoring and Management Guide
Clustering RSMs
Clustering RSMs
You cluster RSMs to ensure maximum availability and provide a failover RSM in the
event of computer downtime.
When assigning elements to a cluster, ensure that you do not assign more elements to
the cluster than any one individual RSM can handle should the other RSMs in the
cluster fail.
Before you begin
Ensure that the RSM program is installed on each computer designated as an RSM for
the cluster, and that
■
■
each RSM is of the same type (dedicated, shared, or global)
for clustered RSMs that will integrate PATROL Agent data, each RSM has the
necessary security level
To configure RSMs for a cluster
1 Log on to the Portal:
■
To configure a cluster of dedicated RSMs, log on with user credentials for the
account.
■
To configure a cluster of shared RSMs, log on with provider administrator
credentials.
■
To configure a cluster of global RSMs, log on with Portal administrator
credentials.
2 Perform one of the following actions:
■
■
■
When logged on with user credentials, click the Configure tab.
When logged on with provider administrator credentials, click the Provider tab.
When logged on with Portal administrator credentials, click the Portal tab.
3 Under Tasks, click Remote Service Monitors.
4 On the Remote Service Monitors page, click Create RSM Cluster to open the Remote
Service Monitors–Add page.
5 In Cluster Name, type the name for the new cluster.
This name represents the cluster in RSM lists.
Chapter 4
Remote Service Monitors
95
Clustered RSM upgrades
6 In Description, type a character string that identifies the cluster.
This description appears with the cluster name in RSM lists.
7 In the list of RSMs, select the RSM to include in the cluster.
This list shows RSMs that are not in a cluster.
8 Click Save to finish creating the clustered RSM and return to the Remote Service
Monitors page.
The new clustered RSM appears in the list as a logical RSM and the RSMs that
compose the cluster are removed from the list.
See the Help for more information about managing RSM clusters.
Clustered RSM upgrades
When upgrading the Portal from version 2.1 or later, clustered RSMs retain their
cluster properties.
RSM configuration and maintenance
This section describes the RSM configuration and maintenance tools and how you can
use them to perform the following tasks:
■
■
■
■
■
■
■
Changing the security level for an RSM
Configuring an RSM to use a proxy server
Changing the credentials for an RSM
Configuring the RSM to use HTTP protocol to communicate with the Portal
Changing the maximum heap memory allocated for the Java VM on the RSM
Viewing the log files for the RSM
Collecting log files
Configuration and maintenance tools
The BMC Performance Manager Portal provides multiple tools that you can use to
configure and maintain the RSM.
96
BMC Performance Manager Portal Monitoring and Management Guide
Configuration and maintenance tools
Remote Service Monitor Manager utility
The Remote Service Monitor Manager is a program that enables you to configure,
stop, and start the RSM. The Remote Service Monitor Manager utility resides on the
RSM and is accessible from the system tray of the RSM computer.
The RSM Manager provides the following tabs:
■
Configure provides the Identification and Properties pages, which enable you to
change the credentials and properties for the RSM, including Portal (application
server) properties and proxy server setup.
■
Status provides the following monitoring information about the RSM:
— version number of the RSM program installed on the RSM computer
— number of application classes across all elements connected to the RSM
— most recent time and date that the RSM attempted to send data to the Portal
— number of report messages in the queue waiting to be sent to the Portal
— size of the latest report messages sent to the Portal
— number of milliseconds required by the RSM to complete the request that
transmitted the data to the Portal
To access the RSM Manager utility
In the system tray on the RSM computer, right-click
and select Launch RSM
Manager.
You can also access the RSM Manager by double-clicking
.
NOTE
You must directly access the RSM Manager on the RSM computer or you must use a
remote access program (such as Terminal Services) to access it.
Chapter 4
Remote Service Monitors
97
Configuration and maintenance tools
Remote Service Monitor Maintenance Tool
The RSM installation program installs a utility that you can use to perform the
following tasks:
■
View installation log files.
■
Collect log files into a ZIP file that you can send to a BMC Software Customer
Support representative for troubleshooting.
■
Change RSM installation configuration information, such as memory size and
credentials for connecting to the Portal.
To launch the Remote Service Monitor Maintenance Tool
1 On the RSM computer, open a command prompt, and enter the following
command:
cd %RSM_HOME%\RSM<versionNumber>
If you used the default location for the RSM program, you can find the utility in the
following location: %RSM_HOME%\RSM<versionNumber>
2 Enter the following command:
RSMMaintenanceTool.cmd
NOTE
If you had a failed or canceled installation, you might see a message indicating that you
need to set RSM_HOME. If you see this message, execute the following command and
repeat step 2:
set RSM_HOME=installationDirectory
You can access the Remote Service Monitor Maintenance Tool from the RSM
computer or the installation files.
98
BMC Performance Manager Portal Monitoring and Management Guide
Changing the security level for an RSM
Changing the security level for an RSM
The RSM supports security levels 0 through 4. During installation, if you do not
specify a security level, the installation program assigns security level 0. The types of
BMC Software products installed on the Portal computer and the order in which you
installed them determines the method that you use to change the security.
■
■
Changing the security level for an RSM that coexists with PATROL products
Changing the security level for an RSM-only computer
You can find a brief description of the security levels in Table 1 on page 20.
To determine the security level of an RSM, run the esstool utility. For information
about this utility, see “Policy and role information” in the PATROL Security Guide.
Changing the security level for an RSM that coexists with
PATROL products
When you install the RSM on a computer where PATROL products reside, the
installation program assigns their existing security setting to the RSM. All products
on the computer share the same security level. If you specify a security level that
differs from that which is already in place, the installation program overrides your
selection and uses the existing setting.
When an RSM coexists with any PATROL product, changing the security level for the
PATROL product also changes it for the RSM. If you need to change the security level
for all the BMC Software products installed on the same computer, see the PATROL
Security User Guide or documentation for the specific PATROL product.
Changing the security level for an RSM-only computer
To change the security level of an RSM computer, you must reinstall the RSM
program and specify the correct security level.
1 If the RSM is currently monitoring elements, move those elements to a different
RSM.
2 Uninstall the RSM program.
To uninstall the RSM program, use one of the procedures described under “RSM
program uninstallation” on page 106.
3 Reinstall the RSM program, entering the correct security when prompted.
Chapter 4
Remote Service Monitors
99
Configuring an RSM to use a proxy server
To install the RSM program, use one of the procedures described under “RSM
program installation” on page 76.
4 If necessary, reassign elements to the RSM.
Configuring an RSM to use a proxy server
The RSM monitors the elements in your account and sends the monitoring
information directly to the Portal. If you need to direct RSM communication through
a proxy server, you can adjust the default settings for the RSM to Portal
communication.
To configure an RSM to use a proxy server
1 Access the Remote Service Monitor Manager for the RSM to configure.
See “To access the RSM Manager utility” on page 97.
2 Select the Configure tab.
3 In the navigation pane under Properties, select the Portal host name.
4 On the Portal properties page, under Proxy Server, provide the following
properties:
A In Server Name, type the host name or IP address for the proxy server (for
example, myproxy.acme.com).
If your network uses proxy autoconfiguration files to direct requests to the
proxy server, specify the registered host name of the proxy server and not the
automatic configuration script address.
B If the proxy server uses domain authentication, type the domain name in User
Domain; otherwise, skip to 4C.
C If the proxy server uses a local account, type the local computer name in User
Domain; otherwise, skip to 4D.
D If the proxy server requires authentication credentials for access, type them in
User Name and Password.
E In Port Number, type the port number that receives requests.
100
BMC Performance Manager Portal Monitoring and Management Guide
Configuring the RSM to use HTTP protocol to communicate with the Portal
5 Click Save.
6 From the system tray on the RSM computer, restart the RSM:
A Right-click
and select Stop RSM.
B Right-click
and select Start RSM.
Configuring the RSM to use HTTP protocol to communicate
with the Portal
If your RSM is on a secure network and you can allow the RSM to communicate with
the Portal web server using an unsecured protocol, you can improve the overall
scalability of the RSM if you configure it to use HTTP instead of HTTPS. This
procedure changes the protocol and the port number on which the communication
occurs.
To configure the RSM to use HTTP protocol to communicate with the Portal
1 Access the Remote Service Monitor Manager for the RSM to configure.
See “To access the RSM Manager utility” on page 97.
2 On the Properties tab, select the Portal host name in the navigation pane.
3 To change the protocol to HTTP and port number to 80, clear the Use Secure Socket
Layer (SSL) check box.
4 From the system tray on the RSM computer, restart the RSM:
A Right-click
and select Stop RSM.
B Right-click
and select Start RSM.
Chapter 4 Remote Service Monitors
101
Changing the credentials for an RSM
Changing the credentials for an RSM
The credentials for the RSM must match its corresponding user or administrator
credentials on the Portal. If the credentials change for the user or administrator that
installed the RSM program, the RSM credentials must also be changed.
When you change the RSM credentials, ensure that you do not provide credentials
that change the RSM type. For example, if you installed the RSM with user
credentials, do not provide administrator credentials when you change the
credentials. Changing the type of an RSM can disable monitoring of its assigned
elements.
You can use the RSM Manager or Remote Service Monitor Maintenance Tool to
change RSM credentials.
Before you begin
Ensure that the RSM is connected to the Portal.
To use the RSM Manager to change the credentials for an RSM
1 Access the RSM Manager for the RSM.
See “To access the RSM Manager utility” on page 97.
2 Select the Configure tab.
3 In the navigation pane under Properties, select the Portal host name.
4 On the Portal properties page, under Portal Server, type the new Portal credentials
in User Name and Password, as necessary.
5 Click Save.
6 From the system tray on the RSM computer, restart the RSM:
102
A Right-click
and select Stop RSM.
B Right-click
and select Start RSM.
BMC Performance Manager Portal Monitoring and Management Guide
Changing the credentials for an RSM
To use the Remote Service Monitor Maintenance Tool to change the credentials
on the RSM
1 Launch the RSM installation tool.
See “To launch the Remote Service Monitor Maintenance Tool” on page 98.
2 Change any of the RSM credentials, and click Next:
A In User Name, enter the user name that determines the type of RSM:
■
To configure an RSM for a single account, enter the user name for the
account.
■
To configure an RSM that can monitor all accounts associated with a
provider, enter a user name for an administrator that has only Edit
permission (provider credentials).
■
To configure an RSM that can monitor all accounts on the Portal, enter a user
name for an administrator that has Edit and See Other Providers and Their
Accounts permissions (Portal credentials).
B In Portal Password, enter the password for the specified user name.
C In Confirm Password, retype the password.
3 Using one of the following methods, restart the RSM:
■
■
Restart the BMC Remote Service Monitor service.
In the system tray of the RSM computer, right-click
select Start RSM.
and Stop RSM and then
Chapter 4 Remote Service Monitors
103
Changing the maximum heap memory allocated for the Java VM on the RSM
Changing the maximum heap memory allocated for the
Java VM on the RSM
If you experience performance problems with the RSM, you might be advised by
BMC Customer Support to change the maximum heap memory allocated for the
RSM.
To change the maximum heap memory allocated for the Java VM on the RSM
1 Launch the Remote Service Monitor Maintenance Tool.
See “To launch the Remote Service Monitor Maintenance Tool” on page 98.
2 On the Configuration tab, specify the maximum amount of heap memory that you
want to allocate for the RSM, and click Next.
3 Click Next twice, and then click Finish.
4 Using one of the following methods, restart the RSM:
■
■
Restart the BMC Remote Service Monitor service.
In the system tray of the RSM computer, right-click
select Start RSM.
and Stop RSM and then
Viewing the log files for the RSM
This procedure describes how to view the log files that the installation program
creates when it installs the RSM program. The log files, created during the BMC
Portal installation, are displayed in a table showing the following information:
■
■
■
■
date and time that each message was recorded in the log file
the message severity
the message text
description of any failures that occurred
Messages highlighted in red indicate errors. Messages highlighted in yellow indicate
warnings.
104
BMC Performance Manager Portal Monitoring and Management Guide
Collecting log files
To view installation log files
1 Launch the Remote Service Monitor Maintenance Tool.
See “To launch the Remote Service Monitor Maintenance Tool” on page 98.
2 On the Logs tab, click the button that corresponds to the log file that you want to
view:
■
■
■
■
■
Install Log
Uninstall Log
Autoupgrade Log
Configuration Log
Application Log
The log viewer displays each installation in a separate tab, with the most recent
installation displayed first. Tab titles show the date and time of the installation.
Alternatively, in the Logs tab, click Browse to Log to locate and display the log file.
Collecting log files
This procedure creates a ZIP file that contains RSM log files. If you need to contact
BMC Customer Support, you can use this procedure to gather RSM log files.
To collect log files for the RSM
1 Launch the RSM installation tool.
See “To launch the Remote Service Monitor Maintenance Tool” on page 98.
2 On the Logs tab, click Zip Logs.
In %temp%, the program creates RSMLogs.zip, which contains the necessary log
files.
Chapter 4 Remote Service Monitors
105
RSM program uninstallation
RSM program uninstallation
The method that you should use to uninstall the RSM program depends on whether
the RSM program is sharing security with other BMC Software products on the RSM
computer:
■
If the RSM program is not installed on a computer with other BMC Software
products that use security, see “Using the installation wizard to uninstall the RSM
program” on page 106
■
If the RSM program is installed on a computer with other BMC Software products
that use security, see “Manually uninstalling the RSM program” on page 107.
Alternatively, you can perform a silent uninstallation of the RSM program from a
command line. See “Using command-line options to uninstall the RSM program” on
page 109.
If the RSM program was upgraded from an earlier version, perform one of the
following actions before uninstalling, regardless of the method that you choose to
uninstall the RSM program:
■
■
In the system tray on the RSM computer, right-click
Restart the RSM computer.
and select Exit.
Using the installation wizard to uninstall the RSM program
1 On the RSM computer, open the Control Panel.
2 In the Control Panel, double-click Add/Remove Programs to open the Add/Remove
Programs window.
3 Select BMC Remote Service Monitor <versionNumber>, and click Change/Remove.
4 On the first page of the uninstallation wizard, click Next.
5 Select BMC Remote Service Monitor, and click Next.
6 On the Summary page, review the messages for any errors, and click Next.
106
BMC Performance Manager Portal Monitoring and Management Guide
Manually uninstalling the RSM program
7 Using the credentials for the deleted RSM, log on to the Portal and delete the RSM:
A Perform one of the following actions:
■
When logged on with user credentials, click the Configure tab.
■
When logged on with provider administrator credentials, click the Provider
tab.
■
When logged on with Portal administrator credentials, click the Portal tab.
B From the Tasks list, select Remote Service Monitors.
C In the list of RSMs, select the RSM that corresponds to the uninstalled RSM
program, and click Delete.
Manually uninstalling the RSM program
1 Stop the BMC Remote Service Monitor service:
A On the RSM computer, open the Control Panel, open Administrative Tools, and
then open Services.
B Select the BMC Remote Service Monitor service, and stop it.
2 Save the following text in a file called DeleteRSM.reg, right-click on that file, and
select Merge to clean up the registry:
REGEDIT4
[-HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\aecf247c9581b1d626129c65a6
c804dd]
[-HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\BMC Remote Service Monitor]
[-HKEY_LOCAL_MACHINE\SYSTEM\ControlSet002\Services\BMC Remote Service Monitor]
[-HKEY_LOCAL_MACHINE\SYSTEM\ControlSet003\Services\BMC Remote Service Monitor]
[-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\BMC Remote Service Monitor]
[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment]
"RSM_HOME"=[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet002\Control\Session Manager\Environment]
"RSM_HOME"=[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet003\Control\Session Manager\Environment]
"RSM_HOME"=[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment]
"RSM_HOME"=-
Chapter 4 Remote Service Monitors
107
Manually uninstalling the RSM program
3 If security is no longer being used by any other programs on this computer,
perform the following actions; otherwise, skip to step 4:
A Delete the following directory: %BMC_ROOT%.\..\CI.
B Save the following text in a file called DeleteRSMSecurity.reg, right-click that file,
and select Merge to clean up the registry:
REGEDIT4
[-HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\Patrol\SecurityPolicy_v3.0]
[-HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\PATROL Agent]
[-HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\PATROL Security]
[-HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\BMC Software]
[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment]
"BMC_ROOT"=[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet002\Control\Session Manager\Environment]
"BMC_ROOT"=[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet003\Control\Session Manager\Environment]
"BMC_ROOT"=[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment]
"BMC_ROOT"=-
4 Perform the following actions to delete unnecessary files and directories:
A Delete the following directories:
■
installationDirectory\RSM<versionNumber>
■
installationDirectory\BMCRemoteServiceMonitorInstallJVM
■
installationDirectory\UninstallBMCRemoteServiceMonitor
■
installationDirectory\InstallationTaskConfiguration.xsd
■
installationDirectory\RSMInstalledConfiguration.xml
If the installation directory is now empty, you can delete it too.
B Delete the following file: %windir%\vpd.properties.
5 Using the process described in step 7 on page 107, delete the RSM from the Portal.
108
BMC Performance Manager Portal Monitoring and Management Guide
Using command-line options to uninstall the RSM program
Using command-line options to uninstall the RSM program
You can specify the command-line options for uninstallation in the following ways:
■
Enter the options in a text file, and then specify that file when you launch the
uninstallation program from the command line.
■
Enter the options directly on the command line when you launch the uninstallation
program.
To uninstall the RSM from a command line
1 Using a text editor, create a file called RSMUninstallOptions.txt, insert the
-U productRSM option, and save the file.
■
■
This option specifies the RSM as the product to uninstall.
Options are case-sensitive.
The RSMUninstallOptions.txt file should look as follows:
-U productRSM
2 Open a command prompt.
3 Change to the following directory:
%RSM_HOME%\UninstallBMCRemoteServiceMonitor\
4 Enter the following command:
uninstall.exe -i silent -DOPTIONS_FILE=drive:\path\RSMUninstallOptions.txt
The variable drive:\path is the location in which you saved the options file, if it is
different from the location of the uninstall.exe. If the path contains spaces, enclose
the path and options file name in double quotation marks (for example,
“c:\Documents and Settings\RSMUninstallOptions.txt”).
When the uninstallation is complete, the command prompt is displayed.
To check the status of the uninstallation, view the RSM uninstallation log file.
Chapter 4 Remote Service Monitors
109
Using command-line options to uninstall the RSM program
110
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
5
Performance Managers and
application classes
5
The BMC Performance Manager Portal provides Performance Managers that contain
application classes that you can use to monitor your infrastructure. You can also
obtain new Performance Managers that contain the application classes that you need
by purchasing or creating them.
This chapter describes how the BMC Performance Manager Portal uses Performance
Managers, and the application classes that they contain, to monitor the infrastructure
in your account. In addition, this chapter provides an overview of creating custom
Performance Managers.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameters and thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter thresholds and event severity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Thresholds and parameter status changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods of remote monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Agentless monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATROL Agent integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing new Performance Managers on the Portal . . . . . . . . . . . . . . . . . . . . . . . . . .
Removing Performance Managers from the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . .
Types of Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Core Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Custom Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Performance Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing unpublished custom Performance Managers . . . . . . . . . . . . . . . . . . . . . .
Editing published custom Performance Managers . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 5
Performance Managers and application classes
112
112
113
113
114
114
115
118
122
123
123
124
124
131
132
132
111
Overview
Overview
The application classes contained in Performance Managers monitor groups of
similar attributes on infrastructure elements. Immediately following the installation
and initial configuration of the Portal, you can log on with user credentials and begin
adding infrastructure elements and assigning application classes to gather
application and system metrics about the computers and devices in your account.
You can assign one or more application classes to any infrastructure element.
EXAMPLE
A Windows computer is running Microsoft Exchange. When adding the computer as an
infrastructure element, you can select an application class to monitor the operating system
and another to monitor Microsoft Exchange.
In addition to Performance Managers from BMC Software, you can create and modify
custom Performance Managers by using the following tools:
■
BMC Performance Manager Portal SDK—Included with the Portal, the SDK
provides developer tools necessary to create robust custom Performance
Managers. For detailed procedures that describe how to use the SDK, see the BMC
Performance Manager Development and Certification Guide on the Documentation CD.
The SDK enables Performance Manager developers to create Performance
Managers that use all protocols and collectors supported by the Portal.
■
Performance Manager Editor—Available when you log on with Portal
administrator credentials (Edit and See Other Providers and Their Accounts
permissions), the wizard-like series of pages enables you to create and modify
custom Performance Managers that use the PerfMon, SNMP, Telnet, and SSH
protocols and collectors to gather parameter metrics.
Parameters and thresholds
Each application class contains a set of related parameters. By setting performance
thresholds for the parameters and configuring notification rules, you can have the
Portal notify you when deteriorating system performance or application problems
become severe. You can configure parameter thresholds when adding infrastructure
elements to the account or at a later time.
If you do not set thresholds for a parameter, you can still view statistical information
gathered for the parameter, but you do not receive notification. To realize the greatest
benefit from the reports and notifications, configure thresholds that reflect realistic
metrics for your environment.
112
BMC Performance Manager Portal Monitoring and Management Guide
Parameter thresholds and event severity
Parameter thresholds and event severity
You can configure thresholds for each parameter by specifying parameter threshold
values that trigger the following event severities:
■
Warnings represent the first indication of a problem. Set a warning threshold to
notify you before a situation becomes severe. When the RSM measures a value on
the monitored element that can trigger a warning and you have selected the
Warning On option, a warning event is triggered for the parameter.
■
Alarms indicate that a problem has escalated to a severe level. Set an alarm
threshold to notify you when a situation first becomes severe. When the RSM
measures a value on the monitored element that can trigger an alarm and you have
selected the Alarm On option, an alarm event is triggered for the parameter.
Thresholds and parameter status changes
In addition to setting warning and alarm thresholds, you also control when the RSM
changes the parameter status by configuring the Alert After options on the Threshold
pages, as shown in Figure 10. By default, the RSM changes the status of a parameter
as soon as the RSM detects that a warning or alarm threshold has been breached.
Figure 10
■
Alert After threshold options
# Times sets the successive number of times that the RSM must measure parameter
values outside of the normal range before changing the status. By requiring
successive measurements outside the normal range, you eliminate status changes
and notifications for intermittent, momentary performance spikes.
For example, if the collection interval is 1 minute and you specify 5 for # Times, the
RSM does not notify the Portal of a status change unless the RSM collects five
successive measurements that breach the specified threshold value for the
specified type.
Chapter 5
Performance Managers and application classes
113
Methods of remote monitoring
■
Type determines the threshold type (alarm or warning) that the parameter must
breach.
— If you select Alarm
■
The RSM changes the parameter status to warning when the warning
threshold is breached.
■
The RSM changes the parameter status to alarm when the alarm threshold is
breached the specified number of times.
— If you select Alarm or Warning
■
The RSM changes the parameter status to the last threshold type breached
after any combination of successive alarms or warnings.
For example, suppose that you specify 3 and Alarm or Warning, and the RSM
measures warning value, alarm value, and warning value in three successive
collection intervals. The RSM changes the parameter status to warning after
the third collection interval.
■
After satisfying the parameter status change, the RSM changes the status after
the next collection interval if the RSM measures a value that breaches a more
severe threshold.
For example, suppose that you specify 3 and Alarm or Warning and the RSM
measures warning value, warning value, warning value, and alarm value.
The RSM changes the parameter status to warning after the third collection
interval. Because the RSM measures a more severe status during the next
collection interval, the status immediately changes to alarm.
Methods of remote monitoring
The types of Performance Managers installed on your Portal determine the methods
of remote monitoring that you can configure for the elements in your account.
Agentless monitoring
The agentless Performance Managers use industry-standard protocols, such as
PerfMon and SNMP, to obtain metrics from the target infrastructure elements. If you
do not have PATROL Agents installed in your IT environment, this is the only type of
Performance Manager that you need to install on your Portal.
114
BMC Performance Manager Portal Monitoring and Management Guide
PATROL Agent integration
As you specify application classes for infrastructure elements, you can accept or
modify parameter thresholds. In addition, you must provide authentication
credentials and properties that the application class can use to access the element and
obtain performance data. The type of collector used to obtain data and the type of
application class determine the type of information that you need to provide.
PATROL Agent integration
If your organization uses PATROL Agents to monitor and manage your IT
infrastructure, you can use PATROL integration Performance Managers, which
enable the RSM to mine parameter values from the PATROL Agents and integrate
agent-based data into the Portal.
You can explicitly add PATROL Agents as elements and specify the corresponding
PATROL integration Performance Managers, or you can have the Portal discover the
PATROL Agents and the parameter thresholds. If you choose the discovery method,
the Portal obtains local thresholds for each instance from its PATROL Agent. If
thresholds do not exist for an instance, the Portal applies the global thresholds to the
instance.
After configuring the PATROL integration Performance Managers, you can use the
Elements task or the bpmcli to synchronize the application classes and thresholds on
Performance Manager with those on PATROL Agents. See “Integrating PATROL
Agent data into the BMC Performance Manager Portal” on page 27 for more
information.
Parameter mapping between Performance Managers and
Knowledge Modules
To illustrate the parameter mapping between a Performance Manager and a
Knowledge Module (KM), consider the example shown in Figure 11 on page 116. The
PATROL Integration Performance Manager for Coffee Pots has parameters that map
to seven out of the 10 parameters in the Coffee Pot KM.
Chapter 5
Performance Managers and application classes
115
PATROL Agent integration
Figure 11
Performance Manager parameter mapping to Knowledge Module parameters
Integration Performance Manager for Coffee Pots
Pot Capacity
Pot Location
Pot Monitor
Pot Operating Status
Pot Level
Pot Metric
Pot Temperature
Coffee Pot Knowledge Module
potCapacity
potType
potLocation
potMonitor
potOperStatus
potLevel
potMetric
potStartTime
lastStartTime
potTemperature
You can use the BMC Performance Manager Portal SDK to create PATROL integration
Performance Managers that mine data from a PATROL Agent. See the BMC
Performance Manager Development and Certification Guide on the Documentation CD for
detailed information about creating Performance Managers.
Threshold mapping between Performance Managers and
Knowledge Modules
The parameter properties in Performance Managers differ somewhat from those in
KMs. Generally, the conventions shown in Table 9 show how the minimum and
maximum parameter thresholds in KMs map to the parameter threshold ranges in
PATROL integration Performance Managers.
Table 9
Minimum and maximum values for mapped thresholds
PATROL Agent parameter thresholds
Performance Manager parameter thresholds
border range is active for the agent parameter minimum and maximum border values
match the agent parameter thresholds
116
border range is inactive for the agent
parameter and the Y-autoscale=No
minimum and maximum border values
match the minimum and maximum Y-axis
values
border range is inactive for the agent
parameter and the Y-autoscale=Yes
minimum and maximum border values are
unbounded
BMC Performance Manager Portal Monitoring and Management Guide
PATROL Agent integration
Table 10 lists the types of parameters that do not have a one-to-one correlation and
shows how the thresholds appear in the mapped parameters.
Table 10
Differences between Performance Manager and Knowledge Module thresholds
(part 1 of 2)
PATROL KM threshold condition
border thresholds (numeric)
■
■
Alarm1 and Alarm2 thresholds
are inactive.
PATROL Integration Performance
Manager adaptation
■
The alarm direction is set to
ascending.
■
The minimum is set to the
PATROL Border minimum
value.
■
If the PATROL Border
threshold triggers a warning,
the warning threshold is set to
the PATROL Border maximum
value.
■
If the PATROL Border
threshold triggers an alarm, the
alarm threshold is set to the
PATROL Border maximum
value.
■
If the PATROL Border range is
0–0 and it triggers a warning,
the warning threshold is set to
True.
■
If the PATROL Border range is
greater-than-zero to greaterthan-zero and it triggers an
alarm, the alarm threshold is
set to True.
■
If the PATROL Border range is
greater-than-zero to greaterthan-zero and it triggers a
warning, the corresponding
warning threshold is set to
False.
■
If the PATROL Border range is
nonzero–to-nonzero and it
triggers an alarm, the
corresponding alarm threshold
is set to False.
Border threshold is active.
border thresholds (Boolean)
■
Alarm1 and Alarm2 thresholds
are inactive.
■
Border threshold is active and
is configured for warning and
alarms.
Notes
These threshold conditions are the
only instances where a PATROL
Border alarm sets a warning or
alarm threshold for a Performance
Manager parameter.
parameter configured to trigger
An event is triggered instantly.
event instantly, after n occurrences,
or after recovery
Chapter 5
Performance Managers and application classes
117
Installing new Performance Managers on the Portal
Table 10
Differences between Performance Manager and Knowledge Module thresholds
(part 2 of 2)
PATROL KM threshold condition
PATROL Integration Performance
Manager adaptation
Notes
Alarm1 and Alarm2 ranges are
Warning and alarm thresholds
both active or both ranges are set to match and alarm direction is set to
trigger the same state
ascending.
numeric threshold is inactive
The numeric threshold is set to 0
and is disabled.
Boolean threshold is set to false
and inactive
The Boolean threshold is set to
false.
boundary values between Alarm1
and Alarm2 are not contiguous
The warning range is extended so
that it is contiguous with the start
of the alarm range.
The BMC Performance Manager
Portal does not support
noncontiguous threshold ranges.
Installing new Performance Managers on the
Portal
Before you can use a Performance Manager, it must be installed in the Portal database
and have a status of Published. When you installed the Portal, the installation
program prompted you to insert the BMC Performance Manager Solutions CD or CD
image. When you selected the Performance Managers from the CD or CD image, the
installation program copied the corresponding PAR files (including the application
classes that they contain) to a staging directory on the Portal application server.
During Portal startup, the BMC Performance Manager Portal scanned the staging
directory for those files and installed them in the Portal database.
If you upgraded from BMC Performance Manager Portal 1.2 or installed the BMC
Performance Manager Portal for the first time, the Performance Managers have a
status of Published. As soon as RSMs are installed or upgraded, you can log on as a
user and begin using the application classes contained in the Performance Managers
to begin monitoring elements.
If you upgraded from BMC Performance Manager Portal 2.1 or later, the new
Performance Managers have a status of Unpublished. See “To upgrade a Performance
Manager during a Portal upgrade” on page 120 for more information about
publishing upgraded Performance Managers.
118
BMC Performance Manager Portal Monitoring and Management Guide
Installing new Performance Managers on the Portal
The following conditions require that you manually install new Performance
Managers on the Portal:
■
You use the BMC Performance Manager Portal SDK to create Performance
Managers.
■
You download a Performance Manager from the BMC Software Electronic Product
Distribution (EPD) website.
■
You install a Performance Manager from a CD or CD image that is not part of the
BMC Portal installation program.
To manually install a Performance Manager
1 Place the Performance Manager’s (PAR) file in a known location on your file
system or have the Performance Manager CD available.
2 Log on to the BMC Portal with Portal administrator credentials, and select the
Portal tab.
3 Under Tasks in the navigation pane, select Performance Managers to open the
Performance Managers page.
4 Click Upload to open the Performance Managers–Upload page.
5 Click Browse to open a file selection dialog box, and navigate to the PAR file from
one of the following sources:
■
■
the location of the PAR file that you used in step 1
PerformanceManagerName.par on the Performance Manager CD
6 Select the PAR and click Upload.
The Portal installs the PAR file in the database. The Performance Manager appears
in the list of Performance Managers and has a status of Published.
NOTE
To have the Performance Managers page reflect status changes, you might need to click the
Performance Managers task in the navigation pane.
To begin using the new application classes, log on as a user, add an infrastructure
element and select the new application classes, or add the new application classes to
existing elements.
Chapter 5
Performance Managers and application classes
119
Upgrading Performance Managers on the Portal
Upgrading Performance Managers on the
Portal
If you install or import a PAR file that replaces an earlier version of its Performance
Manager on your Portal, the new Performance Manager appears on the page for the
Performance Manager, but with a status of Unpublished. The procedures in this
section
■
■
■
remove the earlier version of the Performance Manager
change the status of the newer version to Publishing and then Published
update any affected infrastructure elements with the new version of the
application classes in the Performance Manager
When an upgrade occurs on an existing application class, the following information is
migrated to the new version of the application class:
■
■
■
application class properties and user configurations
parameter threshold settings
parameter history data
To upgrade a Performance Manager during a Portal upgrade
Use this procedure to upgrade each performance manager, individually.
WARNING
You must verify that all of the RSMs are updated to the latest version and that they are all
running before you can publish the Performance Manager solutions. Then you must publish
the Performance Manager solutions one by one, individually.
If a solution is in the process of publishing, do not start publishing another solution until the
first shows the upgraded version.
1 When you use the BMC Portal installation program to upgrade the Portal, select
any or all Performance Managers from the BMC Performance Manager Solutions
CD or CD image on your hard drive.
2 After the Portal installation, log on to the BMC Portal with Portal administrator
credentials, and select the Portal tab.
3 Under Tasks in the navigation pane, select Performance Managers to open the
Performance Managers page.
120
BMC Performance Manager Portal Monitoring and Management Guide
Upgrading Performance Managers on the Portal
The Performance Managers that you selected from the BMC Performance Manager
Solutions CD appear in the list of Performance Managers and have a status of
Unpublished, and the earlier versions of those Performance Managers have a status
of Published or In Use.
4 On the Performance Managers page, select a Performance Manager and click
Publish.
The status for the current version of the new Performance Manager changes to
Publishing and then Published.
The status for the earlier version of each new Performance Manager changes to
Upgrading and then is removed from the page.
5 After the first Performance Manager has completed the publishing process, repeat
step 4 for each remaining Performance Manager in the list, one-by-one,
individually, until all of the Performance Managers show a status of Published.
WARNING
Do not start publishing a Performance Manager when another Performance Manager is in the
process of publishing. Wait until the process is complete, and the previous Performance
Manager shows a status of Published before starting to publish another Performance
Manager.
To upgrade a Performance Manager by importing the new version’s PAR file
1 Place the PAR file for the Performance Manager in a location that you can access
through your file system:
■
Download the Performance Manager file from the EPD website to your chosen
location.
■
Insert the BMC Performance Manager Solutions CD in a disk drive that you can
access from your file system.
2 Log on to the BMC Portal with Portal administrator credentials, and select the
Portal tab.
3 Under Tasks in the navigation pane, select Performance Managers to open the
Performance Managers page.
4 Import the PAR file:
A Click Upload to open the Performance Managers–Upload page.
B Click Browse to open a file selection dialog box, and select a file.
Chapter 5
Performance Managers and application classes
121
Removing Performance Managers from the Portal
C Click Upload.
The new version of the Performance Manager appears in the list and has a status of
Unpublished, and the earlier version has a status of Published or In Use.
5 Select the Performance Manager and click Publish.
The status for the current version of the Performance Manager changes to
Publishing and then Published. The status for the earlier version of the Performance
Manager changes to Upgrading and then is removed from the page.
NOTE
To have the Performance Managers page reflect status changes, you might need to click the
Performance Managers task in the navigation pane to refresh the page.
The affected infrastructure elements begin using the updated application classes.
Removing Performance Managers from the
Portal
The following procedure permanently deletes selected custom or solution
Performance Managers from the Portal database. You cannot delete a Performance
Manager if any of its application classes are currently monitoring infrastructure
elements.
To remove a Performance Manager from the Portal
1 Ensure that the Portal is not using the Performance Manager to monitor
infrastructure elements, and if necessary, remove its corresponding application
classes from any elements that use them.
2 Log on with Portal administrator credentials and select the Portal tab.
3 Under Tasks in the navigation pane, select Performance Managers to open the
Performance Managers page.
4 In the Elements column, verify that the Performance Manager that you want to
delete does not have any assigned elements.
5 Select the Performance Manager to delete, and click Delete.
If necessary, you can delete multiple Performance Managers.
122
BMC Performance Manager Portal Monitoring and Management Guide
Types of Performance Managers
6 On the Performance Managers–Delete page, click Delete to confirm the deletion.
Types of Performance Managers
The Performance Managers page lists the Performance Managers available to the
users on the Portal. For each Performance Manager, the list includes its type. The
Portal supports the following types of Performance Managers:
■
■
■
core
solution
custom
Core Performance Managers
Core Performance Managers are those that are included with the BMC Performance
Manager Portal. The core Performance Managers include application collectors,
which typically have names that begin with BMC PM Collector for, and the
Performance Managers listed in Table 11.
Table 11
Core Performance Managers and their application classes
Performance Manager
Application classes
BMC PM for Lightweight Protocols–DNS
Domain Name Server
BMC PM for Lightweight Protocols–Ping
Ping
BMC PM for Lightweight Protocols–Port Monitor Network Service Port
BMC PM for SNMP Traps
SNMP Trap Listener
BMC PM Monitor
■
■
■
■
■
■
PATROL Agent Availability and Health Monitor
BMC PM Portal App Server Monitor
BMC PM Portal Datafeed Monitor
BMC PM RSM Monitor
BMC PM Web Server Monitor
BMC PM Portal App Server Monitor
BMC PM PATROL Integration
Monitor
PATROL Agent Availability and Health
Monitor
If you did not select any Performance Managers from the Solutions CD during
installation of the Portal, you can still use the application classes in the core
Performance Managers to monitor infrastructure elements.
You cannot edit or delete a core Performance Manager.
Chapter 5
Performance Managers and application classes
123
Solution Performance Managers
Solution Performance Managers
Solution Performance Managers are those that you can obtain from BMC Software or
BMC Software partners, or those created with the BMC Performance Manager Portal
SDK. You can install BMC Software solution Performance Managers from a Solutions
CD, by downloading them from the BMC Software EPD website, or from developers
who use the Performance Manager SDK.
You cannot edit a solution Performance Manager from BMC Software. If a solution
Performance Manager is not in use, you can use the Performance Manager Editor to
delete it from the Portal database.
Custom Performance Managers
If you cannot obtain a solution Performance Manager to monitor the infrastructure or
applications in your environment, you can create custom Performance Managers.
NOTE
This section provides some information about custom Performance Managers. The BMC
Portal Help provides detailed procedures for creating, editing, and administering
Performance Managers and the application classes that they contain.
A series of Portal pages, known collectively as the Performance Manager Editor
(PME), enables Portal administrators to create custom application classes for the
Portal and its users. The Performance Managers page, described in Table 12, acts as
the main page for the PME, and provides the starting point for accessing all of the
features required to administer Performance Managers on your Portal.
When you edit a published custom Performance Manager, the PME creates and opens
a copy of the selected Performance Manager in the editor. In this copy, you can edit
any custom or solution application class that uses PerfMon, SNMP, or command shell
protocols to collect data.
■
On the Performance Managers page, solution Performance Managers and those
created with the Performance Manager SDK have a Type of Solution.
■
On the Performance Managers page, Performance Managers created with the PME
have a Type of Custom.
You can access the Performance Managers task and PME when you log on with Portal
administrator credentials and select the Portal tab.
124
BMC Performance Manager Portal Monitoring and Management Guide
Custom Performance Managers
Table 12
Item
Features of the Performance Managers page
Description
Buttons
Upload
opens the Performance Managers–Upload page, enabling you to add solution
Performance Managers or those created with the Performance Manager SDK
to the Portal
Export
opens a File Save or File Download box, enabling you to save the PAR file to
your local file system
Publish
publishes the selected Performance Managers
Create
opens the Performance Managers–Create page, the first step in creating a
custom Performance Manager
Edit
opens the Performance Managers–Edit page, enabling you to edit the selected
solution or custom Performance Manager
Delete
opens the Performance Managers–Confirm Delete page, enabling you to
confirm the deletion of the selected Performance Managers
Performance Managers list
Select All
selects the check boxes of all Performance Managers
Note: You can edit only one Performance Manager at a time.
Unselect All clears the check boxes of all Performance Managers
Name
name of the Performance Manager
Version
version number of the Performance Manager
Type
identifies the type of Performance Manager: Solution, Custom, or Core
Status
shows one or more of the following states for the Performance Manager:
■ Publishing
■ Published
■ Unpublished
■ Upgrading
■ Publish Failed - failureReason
■ In Use
Elements
shows the number of elements on the Portal currently being monitored with
application classes in the Performance Manager
Profiles
shows the number of element profiles that contain one or more of the
application classes in the Performance Manager
With the PME, you can use the following methods to create custom Performance
Managers:
■
read a definition file that contains attributes that you can use to build a custom
application class
■
edit a custom Performance Manager and edit its application class, and add
application classes in the copy that is automatically created by the PME
Chapter 5
Performance Managers and application classes
125
Custom Performance Managers
The PME cannot create Performance Managers that integrate data from PATROL
Agents. To create PATROL integration Performance Managers, you must use the BMC
Performance Manager Portal SDK. See the BMC Performance Manager Development and
Certification Guide on the Documentation CD.
Application class properties
Each Performance Manager is composed of at least one application class, and an
application class is composed of organized groups of subapplications. Each
application class can have only one collector, but a Performance Manager can contain
application classes that each use a different collector.
EXAMPLE
You can create an operating system Performance Manager that contains the following
application classes:
■
■
■
Solaris Using SNMP
Windows Using PerfMon
Linux® Using Command Shell
The PME enables you to customize the properties that compose an application class
described in Table 13:
Table 13
Application class properties (part 1 of 2)
Property
Description
instance type
either of the following types:
■
Single-instance application classes can exist only once on a monitored element;
for example, a computer can have only one system uptime.
■
Multiple-instance application classes can exist many times on a monitored
element; for example, a computer has many running processes.
— For all multiple-instance application classes, you can specify the instances
to monitor.
— For some multiple-instance application classes, the Performance Manager
enables you to discover instances on the monitored element.
parent class
an application that contains parameters that monitor similar attributes
A parent class also has a root application instance that contains the Application
Collector Status parameter.
126
BMC Performance Manager Portal Monitoring and Management Guide
Custom Performance Managers
Table 13
Application class properties (part 2 of 2)
Property
Description
child class
groupings of similar parameters within the parent class
Example: In BMC Performance Manager Express for Oracle, Availability,
Capacity, and Performance are child classes of the Oracle parent class.
Child classes can require unique properties and credentials.
parameter
a data point or measurement; for example, available disk space
parameter type
one of the following types, which also determines other parameter characteristics:
■
■
■
■
■
alarm direction
string
float
integer
Boolean
long
specifies whether a lesser or greater value indicates deterioration of the monitored
parameter
Example:
■ for CPU load, the higher the load, the slower the computer (greater value
triggers alarm)
■ for available disk space, the lower the amount of free space, the less available
space for the user (lesser value triggers alarm)
alarm and warning
thresholds
■
■
■
parameter value
range
minimum and maximum values for the parameter that
■
■
data modifications
for string parameters, use regular expressions to specify thresholds
for numeric parameters, set default minimum warning and alarm thresholds
for Boolean parameters, specify warning and alarm conditions that the
notification recipient receives about the warning or alarm
set the ranges on charts
prohibit entry of invalid warning and alarm ranges by users
operations that display the numeric parameter value (on the Reports and Status
tabs) in a format that differs from the raw measurement format; not available for
Boolean and string parameters
Types of application classes
When you use the PME, you can create the following types of application classes,
which correspond to the type of information that the application class will monitor:
■
Single-instance application classes can monitor one instance of an application on
any computer. An operating system application class is an example of this type
because you can monitor only one instance of an operating system on any
computer.
Chapter 5
Performance Managers and application classes
127
Custom Performance Managers
■
Multiple-instance application classes can monitor more than one instance of an
application on any computer. Application classes that monitor log files or
processes are examples of this type because you can monitor more than one log file
or process on any computer.
Many multiple-instance application classes enable you to discover instances on the
target elements as you add elements to the Portal or as you add an application
class to existing elements. When the discovery process is finished, you can select
the discovered instances to monitor, and then provide the required credentials and
properties for those instances. Should the discovered instance no longer exist on
the element, the Portal enables you to remove that instance from the element.
Performance Manager publishing
Before you and your users can use the application classes in a new or edited
Performance Manager, you must publish the Performance Manager. After it is
published, users with adequate permission can select an application class and assign
it to an infrastructure element.
Data collection requirements
With the PME, you can create new application classes by specifying a definition file.
Definition files contain attributes and other information that you can use to build the
application class. For some collection protocols, you create an application class by
specifying a command.
Table 14 shows the collection protocols that you can use to create custom application
classes with the PME. This table also shows the input files or commands that you
might need to create application classes with the supported protocols.
Table 14
Supported collection protocols for custom application classes
Collection protocol
Definition files and input properties
Command Shell (SSH/Telnet) command that returns parameter values
PerfMon
HTML files saved from PerfMon Performance graphs
SNMP
MIB files
In addition to the parameters that you customize, each application class also includes
the Application Collector Status (ACS) parameter, which shows the status of the
collector. You cannot view or edit collector parameters in the PME, but users of your
custom Performance Manager can see them when setting thresholds and when
accessing element views on the Status tab.
128
BMC Performance Manager Portal Monitoring and Management Guide
Custom Performance Managers
Command Shell collector
You can use the Command Shell collector to create application classes from command
shell output issued by one or more commands. Application classes that use the
Command Shell collector can use either the SSH or Telnet protocol to obtain
parameter data.
Command shell application classes can define parameters that return a single value
(single instance) or more than one value (multiple instances).
EXAMPLE
■
■
The uptime command returns values for a single instance.
The ps command returns values for multiple instances, one instance for each process.
When creating application classes that use this collector, you must provide a
command that the RSM program runs to obtain the initial data from the target
element.
TIP
Run commands on a representative computer until the command produces the required
output. You can then use the command and the output in the PME to create the application
class.
Also, the application class must provide the following items:
■
for each instance, a valid regular expression (regex) that identifies the instance and
the identifier for the instance
■
for each parameter in an instance, a valid regex that identifies the parameter value
The PME has instance and regex testers to validate your regular expressions.
Users who select custom application classes that use the Command Shell collector can
provide shared credentials to authenticate the RSM.
The BMC Portal Help provides procedures that describe how to create application
classes that use the Command Shell collector.
Chapter 5
Performance Managers and application classes
129
Custom Performance Managers
PerfMon collector
When creating application classes that use the PerfMon collector, you can have the
PME upload PerfMon definition files that have an HTML file type. You can create a
PerfMon definition file in the Performance Monitor (PerfMon) on the Windows 2000,
Windows XP, or Windows 2003 operating system. A definition file can specify
parameters that report on multiple instances (for example, disk space). An
application class that uses the PerfMon collector must have the following
characteristics:
■
unique application class name (specified in the PME)
■
unique parameter names that have the same PerfMon Performance Object
■
unique PerfMon Performance Object and Counter pairs for each parameter in the
application class
■
PerfMon Performance Object and Counter pairs that do not identify a parameter
previously deleted from the application class
Users who select custom application classes that use the PerfMon collector can
provide shared credentials to authenticate the RSM.
The BMC Portal Help provides procedures that describe how to create application
classes that use the PerfMon collector and the definition files required to create them.
SNMP collector
The SNMP collector is used to create application classes that use Object Identifiers
(OIDs) to provide unique identifiers for the parameters in the application class. To
create application classes that use the SNMP collector, you must upload SNMP MIB
files that the PME can use as the definition files to create parameters. The PME can
parse and use the parameter name and data type from the MIB, if that information is
contained in the specified MIB. An application class that uses the SNMP collector
must have the following characteristics:
■
■
■
■
unique application class name (specified in the PME)
unique parameter names in the application class
unique Object Identifier (OID) for each parameter in the application class
OIDs that do not identify a parameter previously deleted from the application class
NOTE
Many MIBs that you can download from the Internet have dependencies on other MIBs. By
default, the BMC Performance Manager Portal populates an internal MIB library with many
commonly referenced MIBs. If necessary, you can upload the primary and dependent MIBs
when creating an SNMP application class.
130
BMC Performance Manager Portal Monitoring and Management Guide
Editing Performance Managers
Frequently, at least one instance name in the source MIB file is cryptic and does not
represent the parameters that it contains. If a parameter name in the instance more
closely represents the instance content, you can choose to have the parameter name
represent the instance name. When users select the application class to monitor
infrastructure, the selected parameter name represents the instance name on the
Status tab.
When using SMNP application classes to monitor infrastructure, ensure that the MIBs
used to create the application class are also loaded on the snmpd daemon on the target
element.
When creating the application class, ensure that you do not place more than 20
application classes in the top (or root) application instance. The PME will let you
specify more top-level parameters, but the RSM cannot obtain more than 20 top-level
parameter values. Should you require more than 20 of the top-level parameters in the
top-level instance, split the parameters between two application classes.
The BMC Portal Help provides procedures that describe how to create application
classes that use the SNMP collector.
Editing Performance Managers
The manner in which the PME interacts with the Performance Manager depends on
the state or type of Performance Manager being edited.
■
■
Editing unpublished custom Performance Managers
Editing published custom Performance Managers
You can make minor changes to the properties of a Performance Manager by
changing the Performance Manager display name and its internal short name. The
PME uses the short name as the PAR file name for the Performance Manager. In
addition, you can
■
■
■
add application classes to a Performance Manager
modify existing application classes in a Performance Manager
remove application classes from a Performance Manager
When editing an application class, you can
■
■
■
■
change the properties of an application class (but you cannot change collectors)
add and remove instances (subapplications)
add and remove parameters
modify parameter properties
Chapter 5
Performance Managers and application classes
131
Editing unpublished custom Performance Managers
Editing unpublished custom Performance Managers
When you create a new Performance Manager, the PME assigns a version number of
1.0.00. Until you publish the Performance Manager, the version number remains the
same, regardless of how often you edit the application classes in the unpublished
Performance Manager.
The PME enables you to modify any of the properties for the Performance Manager
and the properties in an application class.
Editing published custom Performance Managers
The PME enables you to select and edit published custom Performance Managers.
When you select a published Performance Manager to edit, the PME creates a copy
that you can edit. The PME increments the last two digits of the version number only
for a published custom Performance Manager. The new version number is displayed
on the Performance Managers–Edit page.
EXAMPLE
If you select My PM for Coffee Pots (version 2.0.00), the PME creates a new Performance
Manager with My PM for Coffee Pots (version 2.0.01) as the display name and version, and
opens the new Performance Manager in the editor.
When you edit custom Performance Managers, the following restrictions apply:
■
If you had assigned application classes from the earlier version of the Performance
Manager to infrastructure elements, publishing the edited copy updates the
elements so that they use the edited version of the application classes.
■
If the selected Performance Manager contains application classes that use the JMX
collector, the JMX application classes are not copied to the editable version of the
Performance Manager.
After you publish the edited Performance Manager, the JMX application classes
are removed from the elements and the data associated with the deleted
application classes will be deleted from the database.
NOTE
This situation would occur only if you had created a JMX application class with the
Application Class Editor in an earlier version of the Portal or in PATROL Express.
132
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
6
6
Reports
This chapter describes the available reporting options and presents the following
topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter update intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Standard parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accumulated parameter values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data summarization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data retention policies that affect object view content . . . . . . . . . . . . . . . . . . . . . . . . .
Retention policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties that control the raw data retention policies . . . . . . . . . . . . . . . . . . . . .
Properties that control event history retention . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purging inactive data from the Portal history tables . . . . . . . . . . . . . . . . . . . . . . .
Purging unknown and unused events from the event table. . . . . . . . . . . . . . . . .
Reports tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Time interval controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Top N report for object groups or the account . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Health At A Glance report for elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple parameter history charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dashboard parameter charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enterprise reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Downloading and installing the Crystal Reports components. . . . . . . . . . . . . . .
Installing the reporting integration components . . . . . . . . . . . . . . . . . . . . . . . . . .
Generating reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report types and details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstalling reporting integration components . . . . . . . . . . . . . . . . . . . . . . . . . . .
Continuous data export configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Continuous data export requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the datafeed utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing the retention policy for the CDE database. . . . . . . . . . . . . . . . . . . . . . .
Maintaining the continuous export to the CDE database . . . . . . . . . . . . . . . . . . .
Additional configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 6
Reports
134
134
135
136
136
137
137
137
138
139
141
143
144
144
147
152
153
153
154
155
163
167
170
172
173
174
182
182
183
133
Overview
Overview
The Portal provides embedded reports that you can access from the Reports tab. In
addition to these reports, you can configure the Continuous Data Export (CDE) utility
to send raw parameter data to an external database. You can then use Crystal Reports
to generate on-demand reports, or schedule periodic reports from the data in the CDE
database.
In addition to these reporting options, this chapter also describes the way in which
the Portal receives report data from the RSM and how the Portal summarizes and
saves data in the Portal database instance.
Parameter update intervals
The frequency at which the RSM sends parameter data to the Portal is determined by
an element’s report update interval and the status of the parameters in the application
class.
■
The report update interval determines the minimum frequency at which the RSM
sends parameter values to the Portal. Regardless of parameter status, the RSM
sends parameter values to the Portal at this frequency, which is less often than or
equal to the frequency of data collection (collection interval).
Unlike the collection interval, which you set for each application class, you set the
report update interval for each element. For more information, see the
drmop.default.reporting.interval.minutes property in Appendix C, “BMC
Performance Manager Portal files.”
■
134
When any parameter in an application class changes its status, the RSM sends the
values for all parameters in the application class to the Portal. Therefore,
depending on the statuses for the parameters in an application class, a parameter
might have additional raw data values between report update intervals, as
illustrated in Figure 12 on page 135.
BMC Performance Manager Portal Monitoring and Management Guide
Standard parameter values
Figure 12
Affect of status changes on reported parameter values
These charts show the raw
parameter values for
parameters in the same
application class. Although the
parameters in the top two
charts never changed status,
their values were reported
each time that the other
parameter changed status.
You can view the values for parameter data on the Status and Reports tabs.
Standard parameter values
For most parameters, unless a parameter status change occurs, the RSM sends the last
data value that it collected during the report update interval, as shown in Figure 13.
The Portal saves this value in the database as raw data for the parameter.
Figure 13
Standard parameter values
1-minute collection
interval
5-minute report
update interval
1
2
3
4
5
5
4
3
2
1
1
1
2
3
4
5
4
4
3
data values collected from
the parameter
data values sent to the
Portal
On parameter history charts, the Portal shows raw data values (or averaged values,
depending on the time period of the chart) at each chart interval.
Chapter 6
Reports
135
Accumulated parameter values
Accumulated parameter values
Some application classes contain parameters that require the RSM to total the
collected data values and send the totaled value to the Portal. The Portal saves this
accumulated parameter value in the database as raw data for the parameter, as shown
in Figure 14.
Figure 14
Accumulated parameter values
1-minute collection
interval
1
2
3
5-minute report
update interval
4
5
4
3
15
2
1
1
2
3
4
5
11
4
18
3
data values collected from
the parameter
data values sent to the
Portal
On parameter history charts, the Portal shows totaled values at each chart interval.
See the documentation or Help for application classes for more information.
Data summarization
The data summarization process creates a data point that is the average of the raw
data from the previous half hour. For example, suppose that you set the report update
interval to 15 minutes. Immediately after the end of each half hour, the Portal
database computes the average value for the two data points and creates a single halfhour data point.
Summarizing raw data into half-hour and daily data points reduces the data retrieval
effort required to generate reports that span large time intervals.
EXAMPLE
The RSM collects a data point every minute and sends report data to the Portal once every five
minutes. Using this scenario, the Portal receives data at least once every five minutes—more
often if infrastructure parameters go in and out of warning and alarm states. At 10 minutes
after the end of each half hour, the Portal database bundles the six data points (or more if there
were warnings or alarms) into a single half-hour summarized data point.
The Portal uses raw and summarized, half-hour data to produce the charts. Because
the Portal computes a daily data point after the end of the day, some charts might not
show data for the most recent day, depending on the end time specified for the chart.
136
BMC Performance Manager Portal Monitoring and Management Guide
Data retention policies that affect object view content
Data retention policies that affect object view
content
The Portal stores parameter data in partitions in the database and then the database
purges data by dropping an entire partition. The rollover period for a data type sets
the frequency at which the Portal stops writing data to one partition and starts
writing it to a new partition. This rollover period also determines the amount of data
that is deleted when a partition is dropped.
Data summarization and data retention policies of parameter data determine the data
that is used by the Portal to generate the various object views.
Retention policies
The amount and types of data stored in the Portal database are controlled by data
retention policies. Because the Portal collects and stores raw data faster than it
summarizes hourly and daily data, the raw data tables grow faster than the
summarized tables. To control the amount of data retained in the Portal database, the
retention policy purges data from raw data tables sooner than it does from the hourly
or daily tables. Controlling the amount of historical data that is stored in the Portal
database enables the Portal to quickly return the requested charts.
Properties that control the raw data retention policies
The Portal is optimized to run with the default retention policies. Should you need to
change them, you can access the drmop.properties file on the Portal application server
and modify the following properties:
■
portal.history.parameter.value.retention sets the number of days that the database
retains raw parameter data values. Database performance is optimized for a 14-day
retention of raw data if the report update interval is higher than 5 minutes.
However, BMC recommends that you set history retention for 7 days.
— Increasing the retention period can adversely impact database performance and
requires more disk space.
— Significantly decreasing the retention period, to 1 or 2 days, can cause the Portal
to lose data that was not summarized (in the event of a Portal downtime caused
by maintenance, upgrades, or hardware failure).
Chapter 6
Reports
137
Properties that control event history retention
■
portal.history.element.statusHistory.retention sets the number of days that the
database keeps element status changes, such as blackout and monitoring off.
Although the default value of this property is 428 days, BMC recommends that
you set the value at 92 days.
— The value of this property must match the value for the
portal.history.element.summarizationDataPoint.retention property.
— Increasing the retention period requires more disk space.
■
portal.history.parameter.summarizationDataPoint.retention sets the number of
days that the database keeps summarized parameter values.Although this property
has a default value of 428 days, BMC recommends a setting of 92 days.
— Increasing the retention period requires more disk space.
— Reducing this retention period reduces the time period in which you can chart
data points.
■
portal.history.parameter.summarization.disabled enables you to disable the
summarization of raw data. However, some of the reports include summarized
data points, so disabled summarization would cause those reports to display with
missing data. See “Top N report for object groups or the account” on page 144.
For more information about the properties file and its attributes, see “Configuration
files” on page 273 and Table 51 on page 276.
Properties that control event history retention
The event history partition size and the frequency at which the partition is purged are
controlled by the following properties:
■
portal.history.event.rollover.period sets frequency at which event data rolls over to
a new partition. Specifying a longer rollover period means that more data is
deleted when the Portal database drops a partition. When changing the rollover
period, you must specify one of the valid time values in the property file. See
page 281 for valid time values.
■
portal.history.event.retention sets the number of days of event data to save in the
database. The data retention policy uses the specified number of days to determine
when the database purges event partitions. By default, the Portal saves each event
for at least 100 days, but BMC recommends setting this at 14 days.
Longer retention periods can affect the response time of the Events tab and the
Health At A Glance report (which also contains event history data).
138
BMC Performance Manager Portal Monitoring and Management Guide
Purging inactive data from the Portal history tables
The data retention policy uses the number of days specified in the
portal.history.event.retention property to determine the number of partitions to
retain. The policy takes the number of days specified, multiplies that by the number
of days in the rollover period, and then rounds up the value.
EXAMPLE
■
If you use the following default values, the Portal saves seven day’s worth of data in a
partition. To retain 100 days of data, the Portal must keep 15 weeks (105 days) worth of
data.
— portal.history.event.rollover.period = WEEK
— portal.history.event.retention = 100
■
If you use the following recommended values, the Portal saves one days worth of events
in a partition and drops a partition when it has finished saving 14 partition’s worth of data
(14 days). When the database drops a partition, 1 day’s worth of events are purged
— portal.history.event.rollover.period = DAY
— portal.history.event.retention = 14
Purging inactive data from the Portal history tables
The Portal history tables are not deleted, even after deleting an instance or node from
the Portal. This inactive data is not displayed in the Portal, but uses extra disk space,
which can cause performance issues in the Portal.
If you use the Continuous Data Export (CDE) database to store BMC portal data for
reporting, then run the exportParameterHistory command to collect the inactive data
for reporting purposes. (For details, see “Data-extraction commands” on page 238).
You do not need to run exportParameterHistory if data has already been exported by
using exportParameterHistory, or if you do not need the historical data. Otherwise, you
must use the exportParameterHistory to collect historical data before purging inactive
data. Use the following procedure to purge inactive data:
“To purge inactive data” on page 140.
NOTE
When this feature is enabled, during the purging process, the Oracle UNDO table space usage
can reach 100 percent. However, the UNDO tables space usage returns to normal
automatically once the purge is complete. The first time the purge script runs, depending on
how much inactive data there is to purge, it could take from 2 to 8 hours for the UNDO table
space usage to return to normal. If you set the purge script to run on a weekly basis, the
UNDO table space usage should return to normal within 2 to 4 hours after each subsequent
purge, depending on the amount of inactive data accumulated between the weekly purges.
Chapter 6
Reports
139
Purging inactive data from the Portal history tables
To purge inactive data
The properties used to purge inactive data are in the drmop.properties configuration
files. For details, see Appendix C, “BMC Performance Manager Portal files.”
1 To enable purging of inactive data, change the following property to true:
portal.history.parameter.summarizationDataPoint.cleaninactiveparameter.enabled
=false
2 To set the day or days when you want the purge to occur, set the
portal.history.parameter.purgepsdp.scheduledays property by using the following
valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
If you want the job to run the purge on more than one day, you can enter multiple
valid values and separate them by a comma (no spaces). For example, a value of
1,2,6 sets the job to run on Sunday, Monday, and Friday.
3 To set the scheduled hours when you want the purge to occur, set the
portal.history.parameter.purgepsdp.schedulehours property by using the following
valid values:
10 through 19 (the default value)
Setting the property to 10 schedules the purge for 10:00 a.m., 11 schedules the
purge for 11:00 a.m; and so on, up to 19, which schedules the purge for 7:00 p.m.
This property only allows you to schedule the purge on the hour. You cannot add
minutes. The time set for this property is the time on the database server.
For example: portal.history.parameter.purgepsdp.schedulehours=19
140
BMC Performance Manager Portal Monitoring and Management Guide
Purging unknown and unused events from the event table
Purging unknown and unused events from the event table
The retention policy for the event table does not clean up the events that occurred that
are unused, for example, when an instance or element or application is deleted. Some
times Ok-Unknown and Unknown-OK events are generated and fill the table. If you
do not want to save those events, you can set a purging job schedule that cleans up
those events.
The jobs used to remove unknown and unused events execute with partitions in
mind, reducing the load on the Portal and the database while preventing any locking
issues.
Use the following procedures to purge unknown and unused events:
■
■
“To purge unknown events” on page 141
“To purge unused events” on page 142
To purge unknown events
The properties used to purge events are in the drmop.properties configuration files.
For more information, see Appendix C, “BMC Performance Manager Portal files.”
1 To purge unknown events, change the value of the following property to true:
portal.history.events.purgeunknown.cleanunknownevents.enabled=false
2 To schedule the day or days when you want the unknown events purged, change
the portal.history.events.purgeunknown.scheduledays property to one or more of the
following valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
To use these values in combination, separate them by a comma. For example, the
following value sets the purge to occur on Sunday and Friday:
portal.history.events.purgeunknown.scheduledays=1,6
Chapter 6
Reports
141
Purging unknown and unused events from the event table
3 To schedule the time on the day or days when you want the unknown events
purged, change the portal.history.events.purgeunknown.schedulehours property by
using the following valid values:
Valid values for this property are 0 (the default value that sets the value to
midnight or 12:00 a.m.) through 23 (which sets the value to 11:00 p.m.). The default
setting is 19, or 7:00 p.m. The time set for this property is the time on the database
server.
For example: portal.history.events.purgeunknown.schedulehours=19
To purge unused events
The properties used to purge events are in the drmop.properties configuration files.
For more information, see Appendix C, “BMC Performance Manager Portal files.”
1 To purge unused events, change the value of the following property to true:
portal.history.events.purgeunused.cleanunusedevents.enabled =false
2 To schedule the day or days when you want to purge unused events, change the
portal.history.events.purgeunused.scheduledays property by using the following
valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
To use these values in combination, separate them by a comma. For example, the
following value sets the purge to occur on Sunday and Friday:
portal.history.events.purgeunused.scheduledays=1,6
3 To schedule the time on the day or days when you want the unused events purged,
change the portal.history.events.purgeunused.schedulehours property by using the
following valid values:
Valid values for this property are 0 (the default value that sets the value to
midnight or 12:00 a.m.) through 23 (which sets the value to 11:00 p.m.). The default
setting is 19, or 7:00 p.m. The time set for this property is the time on the database
server.
Example: portal.history.events.purgeunused.schedulehours=19
142
BMC Performance Manager Portal Monitoring and Management Guide
Reports tab
Reports tab
The Reports tab provides charts that show performance metrics for selected
parameters. You can view data collected during a different period by adjusting the
report time range. The charts on the Reports tab vary, depending on the active view of
the Reports tab. Table 15 shows the charts available for each view.
Parameter history chart (single chart)
+
Parameter history chart (multiple charts)
+
+
Parameter history table
Top N
Health At A Glance
Parameter
view
Instance
view
Application
class view
Infrastructure
element view
Report
Object
Group view
Charts available from the Reports tab
Account view
Table 15
+
+
+
+
On all charts, when you roll the mouse pointer over a data point, a tooltip shows the
value of the data point.
TIP
Where available, you can use
to export the chart data to a file.
See the BMC Portal Help for information about accessing and customizing the object
views on the Reports tab.
Chapter 6
Reports
143
Time interval controls
Time interval controls
For many object views, you can control page content by using the time controls to
adjust the time interval of interest. You can choose to view chart data in daily and
hourly intervals.
■
Hourly intervals—When selecting Hours, you can choose to show from 1 to 168
hours’ worth of data on the chart.
— When you view 1 to 10 hours of data, the data points represent raw data.
— When showing 12 to 168 hours of data, the data points represent summarized
values of hourly data.
— Hourly reports end with the current hour of data. For example, if at 7:30 A.M.
you request a report for the last 24 hours, the report ends with 8:00 A.M.
■
Daily intervals—When selecting Days, you can choose to show from 1 to 184 days
worth of data on the chart. All charts show the data summarized in data points
that represent one day.
Daily charts end with the current day of data. For example, if on January 20 you
select Now and a 14-day interval, the x-axis shows January 20, and the chart
contains data points through January 20.
The ending date and time selection represents the right-most data point on the x-axis
on a chart. If you select 12 hours ending on January 6 at 6:00 P.M., the chart shows 12
hourly data points on the x-axis that start with January 6 at 7:00 A.M. and end with
January 6 at 6:00 P.M.
Top N report for object groups or the account
When you select the account or an object group from the navigation pane, the Top N
report is displayed, as shown in Figure 15 on page 145. This report compares the
history of a selected parameter across a specified number of elements. The parameter
performance and the number of available elements that use the parameter determine
which elements appear in the report. When viewing this report, you can choose to
view as many as 50 elements at a time. For example, you can quickly view the five
elements that have the least amount of remaining memory. You might not see the
summarized parameter values for a new element for 30–40 minutes after adding the
element.
144
BMC Performance Manager Portal Monitoring and Management Guide
Top N report for object groups or the account
Figure 15
Top N: report settings and content
Report settings
The following settings determine which element charts appear in the report.
■
predefined times from which you can choose to view the report
■
Top or Bottom selection from the performance drop-down list
■
selection from a drop-down list for the maximum number of elements in the report
■
Performance Manager name selected from a drop-down list
When you select an object group in the navigation pane, this list contains only
those Performance Managers found in the selected group.
■
application classes from which to select a parameter
This list contains all application classes in the selected Performance Manager.
■
names of parameters that return numeric values
For parameters in subapplications, the list shows the subapplication name
followed by the parameter name (SubapplicationName|ParameterName).
Chapter 6
Reports
145
Top N report for object groups or the account
Time settings
The Top N time controls provide predefined time periods for this report, as shown in
Figure 16.
Figure 16
Top N: time controls
Report content
After you click Show Report to adjust the report content settings, the report shows the
following information about each element:
■
name of the element
Clicking the element name opens the Status tab for the element.
■
icon that represents the current status of the element and the most recent (raw)
value for the parameter
■
minimum summarized value reported for the parameter during the specified
period
■
maximum summarized value reported for the parameter during the specified
period
■
average summarized value of the parameter reported during the specified period
The bar represents the average value of the parameter during the selected period.
The top bar spans the entire available space. The length of the other bars is
determined by their average value, relative to that of the top bar.
■
146
, which opens the Parameter History Chart for the parameter
BMC Performance Manager Portal Monitoring and Management Guide
Health At A Glance report for elements
TIP
If your account contains a very large number of elements, this report might time out before the
data is displayed. To change the time that you wait for the report to appear before a timeout
occurs, modify the value of the drmop.reports.topn.batch.job.timeout.minutes property. For
more information about this property, see page 278.
Output options
You can use the output controls described in Table 16 to print or export parameter
data from a Top N report.
Table 16
Item
Output controls for Reports tab
Description
exports parameter data points from the report to an external
data file
You can specify the column and row delimiters.
writes the selected report to a PDF file
Health At A Glance report for elements
When you select an infrastructure element from the navigation pane, you can view
the Health At A Glance report. This report contains charts that provide an overview
of the status of the element. You can click
to view the report in a PDF file. From
Adobe Acrobat, you can save the report to your file system or send it to a printer.
Time controls
The time controls set the time range for all charts and graphs in this report, and most
of the data in this report is not available until you select a time range. From the time
controls, you can select one of the predefined time ranges, as shown in Figure 16.
Figure 16
Health At A Glance: time controls
Chapter 6
Reports
147
Health At A Glance report for elements
Element Status Summary
This section of the report, shown in Figure 17, contains the charts that show the
history of the element’s status and the parameters that caused events during the
specified time.
Figure 17
Health At A Glance: Element Status Summary
Status by Time
The pie chart in this section shows the statuses for the selected element during the
specified time. Each section represents the percentage of time during the specified
time range that the element spent in that status.
NOTE
The Offline status represents all times when the Portal has no data for the element. For
example, suppose that you added the element to the Portal during the previous 18 hours and
you specified 24 hours for the report period. In this case, the Offline status would represent six
hours of the (24-hour) pie.
Top Parameters Causing Alerts
This section shows all of the parameters in the element that triggered an alarm or
warning notification during the specified period. The bar color represents the alert
status of the parameter. Clicking
opens the Parameter History Chart for the
corresponding parameter.
148
BMC Performance Manager Portal Monitoring and Management Guide
Health At A Glance report for elements
Element Attributes
This section shows the following information about the selected element:
■
fully-qualified host name of the element
■
operating system of the element
■
list of application classes monitoring the element
■
icon that represents the current status of the element and the hours and minutes
that the element has been in its current state
■
element availability (hours and minutes and the percentage of time that the
element was in OK) during the specified period
The Portal uses the following formula to compute availability:
up_time/(total_time - exclude_time) × 100%
By default, the Portal uses the following statuses for up_time and exclude_time:
— up_time: OK and Warning
— exclude_time: None, Blackout, Offline, and Unknown
■
When computing availability, the Unknown status is an aggregation of the
Unknown, Offline, and None statuses.
■
If an element is in a blackout period during the reporting time and the
availability formula excludes blackout periods from the formula, the element
availability is NA.
To change the statuses included with these values, you can modify the availability
properties described on page 278.
■
actual time (hours and minutes) and the percentage of time that the element had a
status of OK during the specified period
■
actual time (hours and minutes) and the percentage of time that the element was in
Critical during the specified period
■
actual time (hours and minutes) and the percentage of time that the element was in
Warning during the specified period
Chapter 6
Reports
149
Health At A Glance report for elements
Key Parameters
This section shows the top four key parameters for the selected Performance Manager
on the element. For each parameter, a history chart, similar to the one shown in
Figure 18, shows the parameter values for the time range specified in the time
controls at the top of the page.
Figure 18
Health At A Glance: Key Parameters
NOTE
If key parameters are not defined for the application class, the Key Parameters list shows No
key parameters to display.
Click select key parameters to view to change the key parameters shown in the charts.
When an application class contains more than four key parameters, the sort order of
the key parameters determines the top parameters for the specified time range. The
following parameter conditions or attributes determine the sort order for the key
parameters, and which parameters appear in the report:
■
■
■
150
severity level
parameter priority
alphabetization
BMC Performance Manager Portal Monitoring and Management Guide
Health At A Glance report for elements
Element Events
This section lists the events that occurred on the element during the specified time.
Figure 19
Health At A Glance: Element Events
Table 17 lists the attributes shown for each event.
Table 17
Element event attributes in Health At A Glance report
Item
Description
Event severity icon
represents the severity of the event
Object type icon
, which represents an infrastructure element
Element
name of the element
Group
object groups to which the element belongs
Time
date and time when the state change occurred
Description
name of the parameter and the value that triggered the event
Details
for events that triggered notification, the Notified link provides a
list of notification recipients
Chapter 6
Reports
151
Multiple parameter history charts
Multiple parameter history charts
When you select an instance or an application class from the navigation pane, you can
view multiple parameter history charts. By default, this report shows the first two
parameters in the application class, or the number of parameters in the application,
whichever is fewer. Figure 20 shows the report options that affect all parameter charts
in the report. You can show up to 10 parameters on the page by selecting an option
from Number of Charts to Display.
Figure 20
Options for multiple parameter history charts
Number of charts on page
time-interval options
You can use this report in the following ways:
■
to view many parameters from the same element, instance, or application class
Figure 21 is an example of the default view of this report, where each chart uses the
same element name.
■
to compare the same parameter on multiple infrastructure elements
Figure 22 on page 153 is an example of charts that display the same parameter
name for different elements.
Figure 21
Comparative parameter history charts for one element
The element name is
the same in all charts,
and each chart displays
the values for a
different parameter.
152
BMC Performance Manager Portal Monitoring and Management Guide
Dashboard parameter charts
Figure 22
Comparative parameter history report for one parameter
The parameter name is
the same in all charts,
and each chart
displays the parameter
values for a different
element.
Use the option lists and
application class, and parameter.
Click
above each chart to adjust the element name,
to export the data values for the applicable chart.
Dashboard parameter charts
Infrastructure dashboards enable you to create and save views of important element
metrics. For example, if you are responsible for a specific set of computers that
provide a critical business service, you can create a dashboard that enables you to
quickly view and compare the performance of key parameters on these computers.
When creating dashboards that contain parameter values, you can add dashboard
sections that contain parameter history for one parameter or sections that contain
data values for as many as six parameters. For charts that contain multiple
parameters, the chart legend and chart line styles and colors differentiate the
parameters.
Enterprise reports
In addition to the embedded reports that you can access from the Reports tab, you can
also generate reports by running Crystal Reports against parameter data in the CDE
database. The BMC Performance Manager Portal product includes a set of report
templates that you can use with the CDE database to provide a variety of operational
reports based on Portal data.
Chapter 6
Reports
153
Downloading and installing the Crystal Reports components
Downloading and installing the Crystal Reports components
NOTE
Not all BMC product licenses entitle you to the Crystal Report components. If the Crystal
Report components are not available from the BMC Portal EPD download page, see the BMC
Service Assurance Reporting Release Notes for inforamtion about how to obtain access to these
components. The BMC Service Assurance Reporting Release Notes document is available on the
BMC Software Customer Support web page at http://www.bmc.com/support_home.
This section describes how to download and install Crystal Reports Server and the
BMC Performance Manager Portal integration component from the BMC Portal EPD
download page. Some optional configuration tasks are also described.
Before you begin
You need a user name and password for the BMC Software Electronic Product
Download site. You can register and obtain credentials at
http://www.bmc.com/support_home.
To download Crystal Reports Server and integration components
1 Using a web browser, go to http://webapps.bmc.com/epd and log on.
2 Follow the instructions for completing the Export Validation & License Terms
page.
You must select I agree in the Export Compliance Disclaimer and TRIAL
AGREEMENT panes.
3 Follow the instructions to select BMC Performance Manager Portal <latestVersion>.
4 Select the appropriate component:
■
■
If this is a first-time installation, select Crystal Reports Server SP2 (Full Install).
If you have Crystal Reports Server XI release 2 without SP2, select Crystal
Reports Server SP2 (Incremental Patch-SP1 Customers Only).
5 Select BMC Performance Manager Operational Crystal Reports.
6 Follow the instructions to complete the download process.
7 Access the following website to obtain the installation documents for Crystal
Reports:
154
BMC Performance Manager Portal Monitoring and Management Guide
Installing the reporting integration components
http://support.businessobjects.com/documentation/product_guides/default.asp
■
■
product: Crystal Reports Server
release: BusinessObjects XI Release 2
To obtain a license key for Crystal Reports Server, contact BMC Customer Support.
8 Install the Crystal Reporting Designer product.
9 Use a ZIP file utility to open the downloaded file BMC_PM_Reports.zip, and extract
the BMC_PM_Reports.biar and BMC_PM-BusinessView.xml files.
Installing the reporting integration components
Installing the reporting integration components is a manual operation that is
performed on the Report Server host computer.
Before you begin
The following prerequisites must be met:
Table 18
Reporting integration prerequisites (part 1 of 2)
Product or component
Prerequisite
Crystal Reports Server
Crystal Reports XI release 2 SP2 must be installed
The Oracle client must be installed on the Crystal Reports server and it must be
in the executable path.
You need a Windows Administrator user name and password for the Crystal
Reports server host computer.
You need a user name and password with Crystal Reports Administrator rights
to log on to the Crystal Reports server (Business View Manager and Java
InfoView).
Chapter 6
Reports
155
Installing the reporting integration components
Table 18
Reporting integration prerequisites (part 2 of 2)
Product or component
Prerequisite
BMC Performance
Manager Portal and BMC
Datastore
The BMC Performance Manager Portal and database must be configured for
continuous data export (CDE). For information about configuring the CDE
database instance, see “Continuous data export configuration” on page 172.
For the reports that you want to generate, the appropriate Performance
Managers listed in Table 19 on page 156 must be installed and collecting data.
After Performance Managers have been collecting data for several hours, run the
following command on the Portal host computer:
bpmcli -portal portalWebServerHostName -login superadmin -pass superadmin -c
refreshDatafeedMetadata
where portalWebServerHostName is the Portal Web Server host computer, and
the correct superadmin user name and password are inserted.
You need a user name and password for the continuous data export (CDE)
database.
Table 19
BMC Performance Manager components required for various reports (part 1 of 3)
Report
Performance Managera
Application class or Knowledge Module
BMC Performance
Manager Availability
Report
BMC Performance Manager
Express for Unix/Linux
appropriate application classes for the operating
systems in your environment:
■
■
■
■
■
■
BMC Performance Manager
Express for Windows
appropriate application classes for operating
systems in your environment:
■
■
■
■
BMC Performance
Manager Logical
Domain Report
BMC Performance Manager
Express for Unix/Linux
■
■
■
■
■
156
Windows 2000
Windows 2003
Windows XP
Windows
appropriate application classes for the operating
systems in your environment:
■
BMC Performance
Manager Zone and
Pool Report
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
BMC Performance Manager Portal Monitoring and Management Guide
Installing the reporting integration components
Table 19
BMC Performance Manager components required for various reports (part 2 of 3)
Report
Performance Managera
Application class or Knowledge Module
BMC Performance
Manager Top N CPU
Usage
BMC Performance Manager
Express for Unix/Linux
appropriate application classes for operating
systems in your environment:
■
■
■
■
■
■
BMC Performance Manager
Express for Windows
appropriate application classes for the operating
systems in your environment:
■
■
■
■
BMC Performance
Manager Top N File
System Usage Report
PATROL KM for Microsoft Windows Operating
System
BMC Performance Manager
Integration with PATROL for
UNIX and Linux 9.5.01
PATROL KM for Unix
BMC Performance Manager
Express for Unix/Linux
appropriate application classes for operating
systems in your environment:
■
■
■
■
■
BMC Performance Manager
Express for Unix/Linux
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
appropriate application classes for operating
systems in your environment:
■
■
■
■
■
■
BMC Performance
Manager Top N
Process CPU Usage
Windows 2000
Windows 2003
Windows XP
Windows
BMC Performance Manager
Integration with PATROL for
Microsoft Windows
Servers 3.3.01
■
BMC Performance
Manager Top N File
System Space Usage
Report
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
BMC Performance Manager
Express for Unix/Linux
Unix Process
BMC Performance Manager
Express for Windows
Windows Process
Chapter 6
Reports
157
Installing the reporting integration components
Table 19
BMC Performance Manager components required for various reports (part 3 of 3)
Report
Performance Managera
Application class or Knowledge Module
BMC Performance
Manager UNIX®
Health Report
BMC Performance Manager
Express for Unix/Linux
appropriate application classes for the operating
systems in your environment:
■
■
■
■
■
■
BMC Performance
Manager Windows
Health Report
BMC Performance Manager
Express for Windows
AIX
HP-UX
Linux
Red Hat Linux 3.0 ES, AS
Red Hat Linux 4.0 ES, AS
Solaris
appropriate application classes for operating
systems in your environment:
Windows 2000
Windows 2003
■ Windows XP
■ Windows
You can use Performance Managers or PATROL KMs with PATROL Integration, or both.
■
■
a
To import the BMC_PM_Reports.biar file
1 Choose Start => Programs => Business Objects => Crystal Reports Server => Import
Wizard.
2 In the Import Wizard, click Next to begin the import process.
3 In the Source environment page, choose Business Intelligence Archive (BIAR) File in
the Source drop-down menu.
4 Click the Browse button to the left of the BIAR file field.
5 Browse to and select the BMC_PM_Reports.biar file.
6 Click Next.
7 In the Destination environment page, enter or confirm the following information:
CMS Name
host name of the destination Central Management Server (CMS), if it is not
present
User Name
user name that has the Crystal Reports Administrator privilege, if it is not
present
Password
password the corresponds to the user name
8 Click Next.
9 In the Select Objects to import page, click Next.
158
BMC Performance Manager Portal Monitoring and Management Guide
Installing the reporting integration components
10 In the Incremental import page, click Next.
11 In the A note on importing server groups page, click Next.
12 In the User and groups page, click Next.
13 In the Categories page, click Next.
14 In the Folders and objects page, select BMC_PM, and then click Next.
15 In the Select application folders and objects page, click Next.
16 In the Import objects for universes and connections page, click Next.
The Preparing for import page opens, displaying the following selections:
■
■
1 Folders selected
7 Objects selected
This page might remain open for several minutes. The title then changes to Ready
to Import.
17 Click Finish
The Import Progress dialog box opens.
18 When importing is complete, click Done.
To import the BMC_PM-BusinessView.xml file
Existing customers do not need to import the BMC_PM-BusinessView.xml file again.
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Business
View Manager.
2 In the Log On to BusinessObjects Enterprise dialog box, enter or confirm the
following information:
System
host name of the Central Management Server (CMS), if it is not present
User Name
user name that has the Crystal Reports Administrator privilege, if it is
not present
Password
password the corresponds to the user name
Authentication
Enterprise, unless your Crystal Reports environment was configured to
use a different authentication method
3 Click OK.
Chapter 6
Reports
159
Installing the reporting integration components
4 In the Welcome to Business View Manager window, click Cancel.
5 In the Business View Manager menu, choose Tools => Import.
6 In the Import dialog box, click Choose XML, and then browse to and select
BMC_PM-BusinessView.xml.
7 Highlight the root level of the hierarchy.
The root level of the hierarchy has the form CMS_server_name [user_name].
8 Confirm that Overwrite if CUID exists and Preserve CUID when importing objects are
selected.
9 Click OK.
10 In the confirmation dialog box, click Yes.
The BMC_PM-BusinessView.xml file is imported and the following message is
displayed:
Business views have been imported successfully.
11 Click OK to close the dialog box.
The BMC_PM folder is created in the Repository Explorer pane of the Business View
Manager.
12 (optional) Confirm that the following components are displayed under the
BMC_PM folder:
■
DROCR_BPMAccountElements
■
DROCR_BPMAccountElements - Prompt Group
DROCR_BPMConnection
DROCR_BPMElements
DROCR_BPMFoundation
DROCR_BPMPromptElements
DROCR_BPMView
■
■
■
■
■
To change the reports definition
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Business
View Manager.
2 In the Log On to Business Objects Enterprise dialog box, enter or confirm the
following information, and click OK:
160
BMC Performance Manager Portal Monitoring and Management Guide
Installing the reporting integration components
System
host name of the Central Management Server (CMS), if it is not present
User Name
user name that has the Crystal Reports Administrator privilege, if it is
not present
Password
password the corresponds to the user name
Authentication
Enterprise, unless your Crystal Reports environment was configured to
use a different authentication method
3 In the Welcome to Business View Manager window, click Cancel.
The BMC_PM folder appears in the Repository Explorer pane of the Business View
Manager.
4 Double-click the DROCR_BPMFoundation report.
5 In the Object Explorer, expand Tables.
6 Update the value of the Qualified Table Name property on the ACCOUNT table:
A Select the table and navigate to the Property Browser under Object Explorer.
B Edit the Qualified Table Name property.
Example: If you are using the default BMC Datastore, change the value to
CDE.ACCOUNT.
C Save this change and accept all subsequent prompts.
7 Update the value of the Qualified Table Name property on the ELEMENT table:
A Select the table and navigate to the Property Browser under Object Explorer.
B Edit the Qualified Table Name property.
Example: If you are using the default BMC Datastore, change the value to
CDE.ELEMENT.
C Save this change and accept all subsequent prompts.
8 Restart the Report Application Server.
To modify the business view to point to the CDE database
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Business
View Manager.
2 Log on to the Crystal Reports computer where you installed the .biar and .xml files.
Chapter 6
Reports
161
Installing the reporting integration components
3 In the Business View Manager, in the Repository Explorer pane, expand the
BMC_PM folder.
4 Double-click DROCR_BPMConnection.
5 In the Object Explorer pane, right-click DROCR_BMCConnection, and then choose
Edit Connection.
6 In the Choose a Data Source dialog box, expand Oracle Server (click the plus sign to
the left of Oracle Server).
7 In the Oracle Server dialog box, enter the following information:
Service
a string in the form serverName:port/cdeDatastoreInstance (for
example, mercury:1521/bmccde)
User ID
the user name for the CDE database instance
Password
the password corresponding to the user name
OS authentication
leave the box unchecked
8 Click Finish.
9 In the Choose a Data Source dialog box, click OK.
10 In the Set Data Connection Password dialog box, enter the CDE database
credentials, and click OK.
Unless you changed them, you can use the following default credentials:
■
■
user name: CDE
password: CDE
11 In the Business View Manager, choose Tools => Test Connectivity.
12 Choose File => Save.
At this point, you can continue with step 4 in the following procedure.
To refresh the list of values for Account/Elements selection lists
1 Choose Start => Programs => Business Objects => Crystal Reports Server => Business
View Manager.
2 Log on to the Crystal Reports computer where you installed the .biar and .xml files.
3 In the Business View Manager, in the Repository Explorer pane, expand the
BMC_PM folder.
162
BMC Performance Manager Portal Monitoring and Management Guide
Generating reports
4 Double-click DROCR_BPMAccountElements.
5 Click Refresh Status.
6 Click OK to close the dialog box.
Generating reports
After installation and configuration are completed, use this task to generate reports.
You can generate a report that runs once, immediately; or you can schedule a report
to run periodically.
You can use the Java InfoView component of Crystal Reports or a web browser.
Before you begin
■
You must have the Crystal Reports components installed and configured.
■
To use the Business Objects InfoView report portal, you must have the Java
InfoView component of Crystal Reports installed.
■
You need a user name and password to log on to the Crystal Reports server.
To generate a report by using Java InfoView
1 Choose Start => Programs => Business Objects => Crystal Reports Server => Java
InfoView.
NOTE
Some versions of Windows use All Programs in place of Programs.
2 Enter the following information:
■
■
■
■
name of the Crystal Reports server where you installed the .biar and .xml files
user name for the Crystal Reports server
password corresponding to the user name
authentication method
3 Click Log On.
Chapter 6
Reports
163
Generating reports
4 Continue with step 2 on page 171 in the following procedure.
To generate a report by using the Business Objects InfoView report portal
1 Use a web browser to log on to the Business Objects InfoView report portal of the
Crystal Reports system where the integration components are installed.
The URL is typically of the form
http://hostname:port/businessobjects/enterprise115/desktoplaunch/InfoView/logon/
logon.do.
Unless you changed them, you can use the following default credentials:
■
■
user name: Administrator
no password
2 Navigate to Public Folders => BMC_PM.
3 Click Schedule below the report that you want to generate. For a list of reports
installed with BMC Portal and their input properties, see Table 21 on page 168.
4 Under When, choose when to run the report:
■
Now—run the report immediately, from a time in the past until the present.
■
Once—run the report once, at a scheduled date and time.
■
Hourly, Daily, and so on—run the report periodically at a scheduled date and
time.
5 For all selections except Now, enter the schedule properties.
WARNING
To use a standard report template, do not change the Filters settings.
Modifying these settings requires expert knowledge of Crystal Reports, the BMC Portal
CDE database schema, and SQL.
6 (optional) Configure the following report settings:
Destination
Specify the recipients of the report (inbox, file, and so forth).
Format
Choose the report format: default Crystal Reports format (.rpt), or other
formats such as Adobe Portable Document Format (.pdf).
Print Settings
Specify settings for printing the report.
Server Settings Specify which Crystal Reports server to use.
Events
164
Specify events to wait for and events to trigger upon completion.
BMC Performance Manager Portal Monitoring and Management Guide
Generating reports
If you do not choose an option, the default will be used. For information about
these options, see the Crystal Reports online Help.
7 (optional) Under Parameters, specify values for the parameters that are required to
generate the report. Click the parameter value hyperlink or Empty to change the
value. After entering a selection, click OK.
Select Show Unused Parameters to display all parameters.
Some parameters have default values. In some cases, you can choose from
database information.
Table 20 provides information about the parameters:
Table 20
Report schedule parameters (part 1 of 2)
Parameter Name
Parameter value
Comments
Date Range Type
a range such as
number of days,
number of weeks,
and so forth
If you choose the Custom Date Range
option, values are required for Date Range.
If you choose an option other than Custom
Date Range, the value for Date Range is
ignored.
Time Range Type
Starting time for
start day, ending
time for end day
The report is for a continuous period from
the starting date and time to the ending
date and time.
Starting/Ending
time for everyday
The report is for a defined portion of each
day in the reporting period (for example,
8 A.M. to 5 P.M.).
the starting and
ending dates of the
report
No starting date means that the report will
contain all available data before the end
date.
Date Range
No ending date means that the report will
contain all available data from the starting
date to the present.
The Include this value option has no effect
on the data that is reported.
Time Range
the starting and
ending times of the
report
These times are interpreted in conjunction
with the Time Range Type parameter.
Chapter 6
Reports
165
Generating reports
Table 20
Report schedule parameters (part 2 of 2)
Parameter Name
Parameter value
Comments
Day of Week
a set of days of the
week
You can select any set of days, contiguous
or non-contiguous (for example, Monday
and Friday).
Normally this parameter is used to set the
work week.
AccountElements ELEMENT_NAME,
AccountElements ACCOUNT_NAME
the elements that
will be included in
the report
Changing this parameter will change the
information that is displayed in the report.
Multiple accounts may be available, and
each account may have access to different
elements.
WARNING
This step fails if no data is in the database, or if the connection to the database fails.
8 Click Schedule.
The page displays the schedule instance and indicates whether the status is
Running or Pending.
The report generates at the specified time. Figure 23 on page 167 shows a typical
example of a report.
This figure shows a PDF report, which is suitable for printing.
The native Crystal Reports format (.rpt) allows you to navigate to details by
clicking elements in the report.
166
BMC Performance Manager Portal Monitoring and Management Guide
Report types and details
Figure 23
Example of a typical report
Report types and details
Several types of reports are provided, to show overall health, best, and worst
transaction response times, and so on.
Chapter 6
Reports
167
Report types and details
Table 21 contains details of the BMC Performance Manager reports that you can
select:
Table 21
BMC Performance Manager report details (part 1 of 3)
Report name
Chart title
Chart description
BMC Performance
Manager
Availability Report
Elements
Availability
a bar chart that shows the number for each monitored element:
of parameter threshold breaches in
the following parameters, for each ■ element name
monitored element:
■ host name
■ number of alarms during the
report period
■ CPU Utilization
■ Memory Utilization
■ Paging
■ Swap
■ Disk I/O
BMC Performance
Top ‘N’ %
Manager Top N CPU Avg CPU
Usage Report
Usage
a bar chart that shows the percent
average CPU usage for each
monitored element
Table description
for each monitored element:
■
■
■
■
Top ‘N’ %
BMC Performance
Manager Top N File Used File
System
System Usage
Report
a bar chart that shows the percent
average file system in use for each
monitored element
element name
percent average CPU usage
percent maximum CPU usage
percent minimum CPU usage
for each monitored element
■
■
■
■
■
element name
file system (for example, /usr)
average value
maximum value
minimum value
BMC Performance
Manager Top N File
System Space Usage
Report
Top ‘N’ File
System Available
Space
a bar chart that shows the amount for each monitored element
of free space in megabytes for each
monitored element
■ element name
■ file system (for example, /usr)
■ average value
■ maximum value
■ minimum value
BMC Performance
Manager Top N
Process CPU Usage
Report
Top ‘N’
Process CPU
Utilization
a bar chart that shows the percent
average process CPU usage for
each monitored element
for each monitored element
■
■
■
■
■
168
BMC Performance Manager Portal Monitoring and Management Guide
element name
process name
average value
maximum value
minimum value
Report types and details
Table 21
BMC Performance Manager report details (part 2 of 3)
Report name
Chart title
Chart description
Table description
BMC Performance
Manager UNIX
Health Report
Health
Summary
pie charts that show whether
monitored elements in the OK,
Warning, or Alarm state for the
following parameters:
for each monitored parameter and
element:
■
■
■
■
■
■
■
■
■
BMC Performance
Manager Windows
Health Report
Health
Summary
CPU Usage
Disk I/O Requests in Queue
Memory Free
Network Errors
Page Fault Rate
Swap Space Percent Available
Transfer Request Workload
pie charts that show whether
monitored elements in the OK,
Warning, or Alarm state for the
following parameters:
■
■
for each monitored parameter and
element:
■
■
■
■
■
■
■
■
Available Memory
Current Queue Length
Disk Time
Pagefile Fault Rate
Paging File Usage
Total CPU Usage
element name
average value
maximum value
minimum value
■
■
element name
average value
maximum value
minimum value
BMC Performance
Manager Zone and
Pool Report
Solaris
Container
Report:
Pools and
Zones
graph that shows the average value for each parameter:
of following parameters in 'Stacked
Bar Chart' format:
■ element name
■ host name
■ Zone CPU Utilization (%)
■ average value
■ Zone Memory Utilization (%)
■ Zone CPU Shares (Count)
■ Zone Swap Space Used (MB)
■ Pool CPU Utilization (%)
■ Pool CPU Idle Time (%)
■ Pool CPU IO Wait (%)
■ Pool Used (%)
BMC Performance
Manager Logical
Domain Report
Logical
Domain
Report
graph that shows the average value for each parameter:
of following parameters in 'Stacked
Bar Chart’ format:
■ element name
■ host name
■ Logical Domain CPU
■ average value
Utilization (%)
■ Logical Domain Memory
Allocated (GB)
■ Logical Domain Status (Status)
■ Logical Domain Virtual CPU
Count (Count)
Chapter 6
Reports
169
Uninstalling reporting integration components
Table 21
BMC Performance Manager report details (part 3 of 3)
Report name
Chart title
Chart description
Table description
BMC Performance
Manager System
Availability Report
System
Availability
Report
table that provides the percentage
of system availability for each
selected element
for each monitored element:
■
■
■
element name
date
system availability status
The following rules apply to health reports:
■
The following table describes how pie chart color is determined. A plus sign (+) in
a cell indicates that one or more parameters are in the state listed in the column
heading. A blank cell indicates that no parameters are in the state listed in the
column heading.
Parameter states
OK
Warning
+
+
+
+
+
Alarm
Pie chart color
all yellow
+
all red
+
half yellow, half red
+
all green
■
If no data is available for a parameter, no pie chart appears for that parameter.
■
If a parameter has never had a state change, no data appears in the table in the
report.
Uninstalling reporting integration components
Uninstalling the Crystal Reports integration components is a manual operation that is
performed on the Report Server host computer.
The task comprises the following procedures:
■
■
170
“To remove folders”
“To remove the business view”
BMC Performance Manager Portal Monitoring and Management Guide
Uninstalling reporting integration components
To remove folders
1 Use a web browser to log on to the Business Objects InfoView report portal of the
Crystal Reports system where the integration components are installed.
The URL is typically of the form
http://hostname:port/businessobjects/enterprise115/desktoplaunch/InfoView/logon/logo
n.do.
2 Navigate to Public Folders => BMC_PM.
3 Select the BMC_PM folder.
4 Click Delete.
5 In the confirmation dialog box, click OK.
The folder is removed.
To remove the business view
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Business
View Manager.
2 Log on as an administrator to the Crystal Reports computer where the business
view is installed.
3 In the Welcome window, click Cancel.
4 In the Repository Explorer, select the BMC_PM folder, and then click Delete.
5 In the confirmation dialog box, click Yes.
The business view is removed.
Chapter 6
Reports
171
Continuous data export configuration
Continuous data export configuration
The RSM sends parameter data to the Portal at regularly scheduled intervals, known
as the report update interval, and whenever a parameter threshold is breached. You
can optionally configure the Portal datafeed utility to save this raw parameter data to
external Oracle databases (CDE databases), CSV (test) files, or a combination of test
files and CDE databases. After you customize the configuration files, the Portal
datafeed utility exports raw parameter data at the frequency at which it receives data
from the RSM, as illustrated in Figure 24. You can use the exported data to create
reports in a reporting program like Crystal Reports.
You can also backfill the CDE database with historical (summarized) parameter data.
To start a process that exports summarized data to the target database, see
“exportParameterHistory” on page 240.
NOTE
■
The datafeed utility supports CDE databases on Oracle Database 10g Enterprise Edition
with the Partitioning option.
■
You can configure multiple targets, but each target CDE database or file impacts the
performance of the Portal.
Figure 24
Continuous data export process
external CDE database
web server
browser
Portal database
RSM
application server
monitored elements
172
BMC Performance Manager Portal Monitoring and Management Guide
Continuous data export requirements
Continuous data export requirements
Configuring the datafeed utility to export data to a test file or Oracle CDE database
requires that you use the following files:
■
datafeed.properties: This file contains settings for the test CSV file and the directory
name that contains the property files that describe the target CDE database.
■
createDatafeedSchema.sql: When exporting data to a CDE database, you must first
create the necessary database structures in the target database. To properly
configure the target CDE database, run this SQL script to add the required data
structures to the target database. The data structures include tables, indexes, and
views to facilitate querying, and procedures used to create and purge partitions.
■
sampleDatafeedTarget.properties: This template property file is used to create a
property file for each target database. The property file contains the tablename for
the continuous data export, the summary data tablename needed for the historical
data export, and metadata tablenames that are used for querying the two export
utilities. The property file also contains some configuration properties for the
target database.
■
datafeedJob.sql: This script creates a job in the target CDE database that provides a
data-retention policy for the continuous data export data. Parameter data is saved
in 30-minute partitions, which are purged according to the retention time provided
by the user when prompted by this script.
To ensure that you can successfully query all of the parameter data stored in your
CDE database, run the refreshDatafeedMetadata command. For more information
about this bpmcli command, see page 232.
NOTE
When upgrading from an earlier version of BMC Portal, if you were using
Continuous Data Export (CDE), the old data in the CDE database might not appear in
Crystal Reports, unless you do the following:
■
While running the createDatafeedSchema.sql, use the same username and password for
the CDE database that was used in the earlier BMC Portal version.
■
Inside sampleDatafeedTarget.properties, the value for DB.TABLEOWNER,
DB.USERNAME and DB.PASSWORD should be the same as the value used while
running createDatafeedSchema.sql. For example, DB.TABLEOWNER= datafeed_user,
DB.USERNAME= datafeed_user, DB.PASSWORD= datafeed_password.
You can ignore the ORA-00955 and ORA-02275 error messages if they appear while running
the createDatafeedSchema.sql.
Chapter 6
Reports
173
Configuring the datafeed utility
Configuring the datafeed utility
To configure the datafeed utility and target clients, perform the following procedures
in the order shown. For environments with clustered application servers, repeat these
procedures for each application server in the cluster.
1. To update the attributes in the datafeed.properties file to scan a directory for export
property files and enable the datafeed utility, use the procedure in “Configuring
the target datafeed clients” on page 174.
2. To add the necessary tables to a CDE database, use the procedure in “Configuring
a target CDE database” on page 177 to configure the target database and execute
the createDatafeedSchema.sql script.
3. To specify the target CDE databases and to control which parameters are exported
by the datafeed utility, use the procedure in “Specifying the target CDE databases”
on page 180 to configure the property files based on the
sampleDatafeedTarget.properties template file.
4. To establish a data retention policy for the CDE database, use the procedure in
“Changing the retention policy for the CDE database” on page 182.
Configuring the target datafeed clients
You configure the datafeed utility to export parameter data to a CDE database, CSV
file, or both by modifying the properties in the datafeed.properties file, as described in
the following procedure. You should specify a CSV file for testing purposes only.
Also, Table 22 on page 183 contains optional configuration properties that you can
set.
To configure the target datafeed clients
1 Locate the datafeed.properties file at one of the following locations on the Portal
application server:
— On Windows:
%BMC_PORTAL_KIT_HOME%\appserver\websdk\tools\jboss\server\all\conf\
properties\drmop
— On Solaris:
$BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/
properties/drmop
174
BMC Performance Manager Portal Monitoring and Management Guide
Configuring the datafeed utility
2 Using Figure 25 as a guide, enable the data clients for the parameter data by
uncommenting the lines that correspond to your client preference:
■
■
■
Figure 25
To export data to an Oracle database only, uncomment the first highlighted line.
To export data to a test CSV file only, uncomment the second highlighted line.
To export data to a test CSV file and an Oracle database, uncomment the third
and fourth highlighted lines.
Data target lines in the datafeed.properties file
# JDBC
# Uncomment the following line to feed data to JDBC target(s) and be sure
# to set the portal.JdbcDataFeedClient.configDir property below.
#portal.datafeed.clients=com.bmc.patrol.portal.rsmcommunication.impl.datafeed.JdbcDataFeedClient
# CSV -- Client to use for testing purposes only.
# Uncomment the following line to feed data to a CSV file
#portal.datafeed.clients=com.bmc.patrol.portal.rsmcommunication.impl.datafeed.CsvDataFeedClient
#
# BOTH
# Uncomment the following two lines to feed data to both a CSV file and JDBC target(s)
# and be sure to set the portal.JdbcDataFeedClient.configDir property below.
#portal.datafeed.clients=com.bmc.patrol.portal.rsmcommunication.impl.datafeed.JdbcDataFeedClient,\
#com.bmc.patrol.portal.rsmcommunication.impl.datafeed.CsvDataFeedClient
3 To modify the cache properties for the datafeed utility, uncomment the property
setting that corresponds to your Portal size, as shown in Figure 26.
The following properties control the size of the cache and when items are removed
from the cache:
■
portal.datafeed.apppathcache.size=15000 indicates that the cache can hold the
ApplicationPath for 15,000 unique applications.
■
portal.datafeed.apppathcache.timetolive.seconds=86400 indicates that the cache
will hold items that are actively reused from the cache up to a day before
flushing them and causing the system to recalculate the ApplicationPath.
■
portal.datafeed.apppathcache.timetoidle.seconds=3600 indicates that the cache can
hold unused items for up to an hour.
Figure 26
Datafeed cache properties in the datafeed.properties file
# Datafeed cache properties
# Below values are the defaults if not set
#portal.datafeed.apppathcache.size=15000
#portal.datafeed.apppathcache.timetolive.seconds=86400
#portal.datafeed.apppathcache.timetoidle.seconds=3600
To determine whether you need to modify the cache properties, you can monitor
the MemoryStoreHitCount and MissCountNotFound properties on the JMX console
at http://PortalHostName/jmx-console/HtmlAdaptor?action=inspectMBean&name=
com.bmc.patrol.portal%3Aname%3DDataFeedAppPathCache.
Chapter 6
Reports
175
Configuring the datafeed utility
4 When exporting parameter data to an Oracle database, use the
portal.JdbcDataFeedClient.configDir setting to specify the directory where you will
place the properties file for the target database, as shown in Figure 27.
■
■
■
Figure 27
To create the properties file for the target database, see “Configuring a target
CDE database” on page 177.
The directory that you specify must exist and contain the CDE properties file
before you restart the Portal application server.
The directory that you specify cannot contain any property files other than the
CDE properties file.
Oracle properties in the datafeed.properties file
#------------------------------------------------------------------------------#JDBC PROPERTY -- Must be set to enable JdbcDataFeedClient.
#------------------------------------------------------------------------------#The datafeed utility will scan the following directory for property files.
#Each property file found configures a separate JDBC target db with its own
#column mapping.
#Please note while specifying configDir use forward (/) slash as directory
#separator for both Unix and Windows.
#portal.JdbcDataFeedClient.configDir=c:/datafeed
5 To specify the properties for the test CSV file client, under CSV PROPERTIES,
specify the path and file name, new header line, and timestamp format properties,
as shown in Figure 28.
A Under PATH AND FILENAME, uncomment the
portal.CsvDataFeedClient.filenameRoot property and substitute
/directoryPath/csvDatafeedFileName for the path and prefix to use for the file
names for your CSV files.
NOTE
Use the forward slash (/) as the directory separator on both Windows and UNIX.
B To insert a header line in the CSV files, use the default setting (true) for the
portal.CsvDataFeedClient.printHeader property.
By default, all CSV files contain a header line.
176
BMC Performance Manager Portal Monitoring and Management Guide
Configuring the datafeed utility
C To change the timestamp format, uncomment the
portal.CsvDataFeedClient.dateFormat property and change the default value
(EEE MMM dd HH : mm : ss : SSS z yyyy).
The default timestamp format produces a timestamp similar to
Wed Jul 12 20:45:44 GMT 2006.
To view valid values for the timestamp format, see the following website:
http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html.
D Save the datafeed.properties file.
Figure 28
CSV properties in the datafeed.properties file
#------------------------------------------------------------------------------# CSV PROPERTIES
#------------------------------------------------------------------------------# PATH AND FILENAME
# The default location for the csv output file
# is <portalinstalldir>/appserver/websdk/bin/csvdatafeed_20060704.csv.
#
# To specify a custom location for the file, uncomment the line below and
# specify the destination.Please use forward slash (/) as directory separator for
# both Windows and UNIX.
# portal.CsvDataFeedClient.filenameRoot=c:/dir/csvdatafeedfilename
# HEADER LINE
# This property determines whether a header line is placed in the output files.
# Example header line: Timestamp,Element,Hostname,Platform,Solution Name...
portal.CsvDataFeedClient.printHeader=true
#
#
#
#
#
#
#
TIMESTAMP FORMAT
Uncomment the following line to specify a timestamp format
in the CSV file. See the below URL for valid values:
http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html
The default of EEE MMM dd HH:mm:ss:SSS z yyyy produces,
e.g.: "Fri Aug 25 14:35:01:703 GMT 2006"
portal.CsvDataFeedClient.dateFormat=EEE MMM dd HH:mm:ss:SSS z yyyy
6 If you are exporting data to a test CSV client only, restart the Portal application
server; otherwise, proceed to “Specifying the target CDE databases” on page 180
Configuring a target CDE database
This section describes how to update and run the createDatafeedSchema.sql script to
create the required database structures in the target CDE database. Figure 29 contains
a view of the database structure. Also, Table 22 on page 183 contains optional
configuration properties that you can set.
Chapter 6
Reports
177
Configuring the datafeed utility
Figure 29
CDE database structures
metadata tables
summarized parameter data (Historical Data Export
utility)
raw parameter data (Continuous Data Export utility)
178
BMC Performance Manager Portal Monitoring and Management Guide
Configuring the datafeed utility
Before you begin
You must have an existing target Oracle CDE instance. You can use one of the
following methods to define the target instance:
■
If you use the BMC Datastore for the Portal, you can rerun the BMC Datastore
installation program to create an instance for the target CDE database. See the BMC
Portal Installation Guide for information about creating the continuous database
export (CDE) database instance.
■
If you have a licensed copy of Oracle Database 10g Enterprise Edition, use it to
create an instance for the target database.
To configure a target database
1 If you installed the CDE database instance and Portal application server on
separate computers, copy the .sql files from one of the following locations on the
application server to any location on the target database computer:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%\util\BPM_Datafeed
On Solaris: $BMC_PORTAL_KIT_HOME/util/BPM_Datafeed
2 On the database server, navigate to the location of the .sql files and set the value of
ORACLE_SID to the name of the CDE database instance name (if you did not use
the default CDE database name, BMCCDE, use the correct name):
Example:
On Windows: set ORACLE_SID=BMCCDE
On Solaris: export ORACLE_SID=BMCCDE
3 Connect to the CDE database and run the createDatafeedSchema.sql script.
sqlplus /nolog @createDatafeedSchema.sql
4 At the CDE Username prompt, type the user name for the CDE database.
5 At the CDE Password prompt, type the password for the CDE user.
6 At the next prompt, type the host name, including the @ prefix, and press Enter.
Example:
@//HOST:1521/BMCCDE)
Chapter 6
Reports
179
Configuring the datafeed utility
Specifying the target CDE databases
The following procedure describes how to modify the properties in the
sampleDatafeedTarget.properties file. This template file contains the Oracle properties
for the target CDE database, including data filters and the failover file location (in the
event of a write failure to the database, you can find the file at this location). It also
lists the properties that control which parameters that the datafeed utility will export
to the CDE database. To specify multiple CDE databases, you create and configure a
copy of this file for each database.
If you create multiple properties files from the sampleDatafeedTarget.properties file,
ensure that the files do not specify the same target Oracle database.
To specify the target CDE database
1 Copy the sampleDatafeedTarget.properties file to the directory that you specified in
step 4 on page 176.
You can assign any name to the new file, but the file must have .properties as the
file extension.
This template is on the Portal application server at one of the following locations:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%\util\BPM_Datafeed
On Solaris: $BMC_PORTAL_KIT_HOME/util/BPM_Datafeed
2 To specify a valid URL for the CDE database, modify the DB.URL property,
updating the highlighted line with the target CDE database information.
# Provide valid JDBC URL to database data is to be written to.
# jdbc:oracle:thin:@hostname:port:ORACLE_SID
DB.URL=jdbc:oracle:thin:@datafeedhost:1521:FEEDDB
3 Modify the values for DB.USERNAME and DB.PASSWORD so that they match the
values set in step 4 on page 179 and step 5 on page 179.
#Provide information for the credentials to be used to connect to the
database.
DB.USERNAME=cde
DB.PASSWORD=cde
Every time the datafeed utility reads this file, it verifies whether the password is
encrypted. If it appears as plain text, the utility encrypts the password and saves
the file. If you need to change the password, open the file, delete the encrypted
value, and type the new password.
180
BMC Performance Manager Portal Monitoring and Management Guide
Configuring the datafeed utility
4 To filter the data exported by the datafeed utility to a CDE database, provide a
regular expression for the INCLUSIVE_REGEX.ProviderName,
INCLUSIVE_REGEX.AccountName, INCLUSIVE_REGEX.ParameterDefinitionName,
and INCLUSIVE_REGEX.ApplicationPath properties.
The filtering does not apply to the CSV test files. The filtering affects target CDE
databases and failover files, which are created when the utility cannot connect to
the target CDE database.
■
ProviderName, AccountName, ApplicationPath, and ParameterDefinitionName are
the only data attributes with which you can filter data.
The ParameterDefinitionName is the internal name for the parameter and is not
accessible from the user interface. To obtain internal names, configure the
datafeed.properties to export data to a test CSV file. Use the exported data in the
file to identify the internal ParameterDefinitionName values on which to filter
data for the target database. After you obtain the ParameterDefinitionName
values that you need, reconfigure the datafeed.properties to export data to the
target database. See “To specify the target CDE database” on page 180.
■
The datafeed utility interprets regular expression patterns as filters.
■
When you specify filters for all four attributes, a parameter record must match
all four filters to be exported; otherwise, the parameter record is ignored.
■
If any one of the data attributes is not defined, then the parameter record passes
that particular filter.
■
If you do not apply a filter to any of the parameter attributes, the datafeed utility
exports all parameter records.
The sampleDatafeedTarget.properties file contains sample regex patterns that you
can use to filter data.
5 Save this file.
6 Repeat step 1 on page 180 through step 5 for each target database.
7 Restart the application server.
The datafeed utility begins sending parameter data at the next report update
interval time.
Chapter 6
Reports
181
Changing the retention policy for the CDE database
Changing the retention policy for the CDE database
When you run the datafeedJob.sql script, it prompts you for the number of days to
retain data, which sets the retention policy for the applicable CDE database. The
target CDE database stores the exported parameter data in 30-minute partitions and
deletes partitions when their age exceeds the number of days specified in the
retention policy. To change the retention period for the CDE database, perform the
steps in the following procedure.
To change a retention policy for the target database
1 If you installed the CDE database instance and Portal application server on
separate computers, copy the .sql files from one of the following locations on the
application server to any location on the target database computer:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%\util\BPM_Datafeed
On Solaris: $BMC_PORTAL_KIT_HOME/util/BPM_Datafeed
You can also find these scripts on the installation DVD or CD1 for the application
server.
2 Connect to the database as the database user specified step 4 on page 179, and run
the datafeedJob.sql script.
Example:
set ORACLE_SID=BMCCDE
sqlplus DATAFEED_USER/DATAFEED_PASSWORD @datafeedJob.sql
3 At the prompt, type the number of days of data to retain, and press Enter.
Maintaining the continuous export to the CDE database
The metadata tables in the CDE database do not automatically update as you add
elements to the account or change element configuration. The frequency at which you
need to update these tables depends on how often
■
■
■
■
■
■
182
you add new accounts
you add new elements to an account
you update application definitions by upgrading solution Performance Managers
you update application definitions by modifying custom Performance Managers
you add application classes to or remove application classes from an element
the Portal discovers new application instances on an element
BMC Performance Manager Portal Monitoring and Management Guide
Additional configuration options
To ensure that the metadata tables accurately reflect the objects in your account, run
the refreshDatafeedMetadata command, described on page 232.
TIP
To ensure that you capture all changes, run a nightly script that executes the
refreshDatafeedMetadata command.
Additional configuration options
If necessary, you can use the properties listed in Table 22 to configure the target
database.
Table 22
Additional configuration options for the datafeed utility (part 1 of 3)
Property
Description
datafeed.properties file
portal.datafeed.csvfile.maximumsize
defines the maximum file size for the CSV file in megabytes (MB)
Valid values:
■
■
0 (default value) defines the file size as unlimited
a positive whole number that defines the maximum file size in
megabytes (MB) (you cannot use a fraction)
By default this property is commented. By default, the csv file
name includes the name of the csv file, and the date the file was
created, in the following format: csvfilename_yyyyMMdd.csv
When you uncomment this property, the creation date is updated,
and the time is appended to the default file name in the following
format: csvfilename_yyyyMMdd_HHmmss.csv
Example:
portal.datafeed.csvfile.maximumsize=200
Chapter 6
Reports
183
Additional configuration options
Table 22
Additional configuration options for the datafeed utility (part 2 of 3)
Property
Description
portal.datafeed.queued.parameter.limit
overrides the default number of parameters in the queue to send
from the Portal to the CDE database or test file
When the total number of queued parameters exceeds the value
set by this attribute, the queue discards all additional parameter
values for as long as the value is exceeded.
This attribute enables you to prevent the Portal from running out
of memory, which can happen if the datafeed client cannot keep
up with the volume of data being sent by the Portal.
The default and recommended value is 3 million (3000000).
Example:
portal.datafeed.queued.parameter.limit=3000000
portal.datafeed.threadpool.size
modifies the thread pool size
The time required for the datafeed utility to process the data for a
single data point can exceed the time required for the Portal to
write a single data point to the Portal database. To enable the
datafeed utility to keep up with the Portal’s database, the datafeed
utility is multi-threaded. Datafeed thread pool size controls how
many threads are available to the datafeed utility to save data to
the datafeed database. On large Portals where the datafeed utility
must process data from a large number of RSMs, consider
increasing this setting.
To determine whether you need to modify the thread count
property, you can monitor the QueuedTaskCount property on the
JMX console at http://PortalHostName:9378/jmxconsole/HtmlAdaptor?action=inspectMBean&name=
com.bmc.patrol.portal%3Aname%3DDataFeed.
Example:
portal.datafeed.threadpool.size=10
sampleDatafeedTarget.properties
DB.BATCHSIZE
changes the size of the batched inserts to be sent to the database
■
Providing values significantly larger than 1,000 causes the
process to consume more memory on the Portal.
■
Providing values significantly smaller than 1,000 causes more
communication between the Portal and the CDE database,
causing the Portal to become less efficient in communicating
the data to the CDE database.
Sample value: DB.BATCHSIZE=1000
184
BMC Performance Manager Portal Monitoring and Management Guide
Additional configuration options
Table 22
Additional configuration options for the datafeed utility (part 3 of 3)
Property
Description
DB.POOLSIZE
controls the size of each connection pool created for each CDE
database
This property controls the number of threads available to process
the datafeed data and save it to the CDE database. For large
Portals that process data from several RSMs, you might want to
increase the value for this property.
To help determine how well the datafeed utility is keeping up with
the Portal, you can monitor the QueuedTaskCount property on
the JMX console, which you can find at
http://PortalHostName:9378/jmx-console/
HtmlAdaptor?action=inspectMBean&name=
com.bmc.patrol.portal%3Aname%3DDataFeed.
Sample value: DB.POOLSIZE=10
FAILURE.CSVFILE.ROOT
specifies a failover file location
Sample value:
c:/datafeed/errordump/feeddb_datafeed_table
The failover file name contains a unique identifier that includes
the date and a .csv extension (for example,
feeddb_datafeed_table_20060710.csv).
LOCALE
changes the locale
If this property is not set, set it to match the locale of the Portal
application server. If necessary, see the following website for valid
locale values:
http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html.
Sample value: LOCALE-en,US
Chapter 6
Reports
185
Additional configuration options
186
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
7
7
Portal events and data integration
When infrastructure elements exceed thresholds and trigger events, the Portal can
send those events to other products that can use or manage events.
This chapter presents the following topics:
Levels of integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Portal-wide integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provider-wide integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Account integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal as a CMDB Consumer. . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal as a CMDB Provider . . . . . . . . . . . . . . . . . . .
Reconciliation rules for infrastructure elements and the BMC
Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Model integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event integration using email notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event integration using SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event integration using AlarmPoint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event integration using BMC II Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Combining BMC Performance Manager and PATROL Agent events . . . . . . . .
SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MIB files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Object identifiers (OIDs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parsing SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC-Performance-Manager-Portal-MIB description . . . . . . . . . . . . . . . . . . . . . .
Trap properties customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample trap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trap error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Events tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Page controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 7
Portal events and data integration
188
188
188
189
189
190
191
191
192
194
194
195
196
196
201
204
204
205
206
207
211
213
214
215
216
217
187
Levels of integration
Levels of integration
The Portal enables you to configure different levels of integration with other Portal
modules and BMC products. The extent to which you can configure the Portal
depends on the credentials that you use to log on to the Portal.
Portal-wide integration
Administrators with Edit and See Other Providers and Their Users permissions can
establish Portal-wide integration, which affects all users and accounts on the Portal,
by using the Global Properties page on the Portal tab. For more information about
configuring Portal-wide integration, see the following topics:
■
■
“BMC Atrium CMDB integration” on page 189
“Service Model integration” on page 192
To configure AlarmPoint notifications, Portal administrators also must access the
Global Properties page to specify an AlarmPoint server to receive notifications from
the Portal.
Provider-wide integration
Administrators with Edit permission can establish provider-wide (or enterprise level)
integration, which affects all accounts in a provider. After you log on, you can access
and modify the options in the Notifications task on the Provider tab to integrate event
data with other modules or products. When configured, these notification rules
trigger notifications for all events (of the specified type) for all accounts in a provider.
■
“Event integration using email notifications” on page 194
■
“Event integration using SNMP traps” on page 195
Before you can configure SNMP notifications, you must specify a SNMP server to
receive notifications from the Portal.
■
“Event integration using AlarmPoint” on page 196
Before you can configure AlarmPoint notifications, a Portal administrator must
access the Global Properties page to specify an AlarmPoint server to receive
notifications from the Portal.
188
BMC Performance Manager Portal Monitoring and Management Guide
Account integration
■
“Event integration using BMC II Web Services” on page 196
Before you can configure BMC II Web Services notifications, you must specify a
BMC II Web Services server to receive notifications from the Portal.
Account integration
Users with full access rights for notifications can access and modify the options in the
Notifications task on the Configure tab to integrate event data with other modules or
products. For more information about configuring account integration, see the
following topics:
■
“Event integration using email notifications” on page 194
■
“Event integration using SNMP traps” on page 195
Before you can configure SNMP notifications, you must specify a SNMP server to
receive notifications from the Portal.
■
“Event integration using AlarmPoint” on page 196
Before users can configure AlarmPoint notifications, a Portal administrator must
access the Global Properties page to specify an AlarmPoint server to receive
notifications from the Portal.
■
“Event integration using BMC II Web Services” on page 196
Before users can configure BMC II Web Services notifications, a provider
administrator must specify a BMC II Web Services server to receive notifications
from the Portal.
BMC Atrium CMDB integration
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) is a
repository of configuration items (CIs), such as software, hardware, network and
related databases, documentation, and people. The BMC Atrium CMDB stores the
attributes for CIs and the relationships between them.
When you specify the BMC Remedy Action Request System (BMC Remedy AR
System) properties and credentials, the Portal sends objects to the BMC Atrium
CMDB whenever you add an infrastructure element to the Portal. When you add
application classes to an infrastructure element or remove them from an element, the
CI is updated in the BMC Atrium CMDB.
Chapter 7
Portal events and data integration
189
BMC Performance Manager Portal as a CMDB Consumer
NOTE
During installation of the Portal (or Portal application server), the installation program
prompted you for a BMC Remedy AR System server name and credentials. If you did not
have a BMC Atrium CMDB at the time of installation, you can log on with Portal
administrator credentials and provide the server name and credentials on the Global
Properties page.
Programs known as CMDB Providers feed CIs to the BMC Atrium CMDB. Programs
known as CMDB Consumers use the CIs.
■
CMDB Providers gather information about CIs and store this information in the
BMC Atrium CMDB. Provider programs provide the base content used by the
consumer programs. BMC Topology Discovery is an example of a BMC Software
product that acts as a CMDB Provider.
■
CMDB Consumers use information from the BMC Atrium CMDB, eliminating the
need to enter this information multiple times. Consumer programs can use this
information in many ways, such as to associate trouble tickets with computers or
programs, to create relationships among the CIs, or to build a service model in a
cell.
■
Some products, like BMC Performance Manager Portal, act as a consumer and a
provider.
BMC Performance Manager Portal as a CMDB Consumer
If you use a product like BMC Topology Discovery to discover IT objects and
populate the BMC Atrium CMDB, you can use the Portal to enable infrastructure
monitoring for those objects.
NOTE
Before searching for infrastructure objects in the BMC Atrium CMDB, ensure that the
credentials and properties for the BMC Atrium CMDB have been configured on the Global
Properties page. You can access this page when you log on to the Portal with Portal
administrator credentials.
“Integrating infrastructure elements and the BMC Atrium CMDB” on page 42
describes how to add an infrastructure element to the Portal by selecting (or
consuming) information from the BMC Atrium CMDB.
190
BMC Performance Manager Portal Monitoring and Management Guide
BMC Performance Manager Portal as a CMDB Provider
BMC Performance Manager Portal as a CMDB Provider
When you add an element to the Portal, the application classes that you select
determine what information is placed into the BMC Atrium CMDB. If the selected
application classes contain information to generate the required details, including the
reconciliation tokens, the Portal adds the CI and its relationships to other CIs to the
BMC.BPM dataset in the BMC Atrium CMDB. The CI also includes impact
relationships, which you can see if you have added the BMC SIM CMDB extensions
to the BMC Atrium CMDB. For information about configuring SIM extensions, see
the BMC Impact Solutions Planning and Installation guide.
After you add infrastructure elements to the account, a reconciliation program enters
the element properties into the BMC.ASSET dataset in the BMC Atrium CMDB. The
reconciliation is a scheduled task that runs on the BMC Atrium CMDB, generally
once a day. Any events triggered for an application class are not populated with a
reconciliation ID until after reconciliation occurs. If you do not want to wait for the
scheduled reconciliation task, you can use the BMC Remedy User program to
manually reconcile the element properties.
The Properties page for an infrastructure element shows the reconciliation status for
the element under BMC Atrium CMDB Status.
Reconciliation rules for infrastructure elements and the BMC
Atrium CMDB
To reconcile data from the BMC Performance Manager Portal, the reconciliation
program uses reconciliation rules. In addition to configuring the BMC Remedy AR
System Server properties in the Portal, you must also import the reconciliation rules.
Without reconciliation rules, the Portal does not add any information to the BMC
Atrium CMDB, and it writes an error to the log file.
To import reconciliation rules into the BMC Atrium CMDB
1 On the BMC Remedy AR System, in ARBASE\AR System\Admin, open a command
window or shell.
ARBASE represents the root installation directory for the Remedy components.
2 Enter the following command for each of the required files (Table 23 on page 192
describes the options’ variables):
arimportcmd -x server -u userName -p password -o fileName -l logFile -D 0
Chapter 7
Portal events and data integration
191
Service Model integration
Table 23
Variables for arimportcmd command
Variable
Description
server
host name for the BMC Atrium CMDB server
userName
user name to log on to the BMC Atrium CMDB
password
password that authenticates the user name
fileName
full path and file name of the file being imported
You must execute the arimportcmd command on the following files (in
the following order):
1. dataset.arx, which imports the dataset definition
2. reconrules.arx, which imports the reconciliation rules
You can find these files at the following location on the Portal application
server:
logFile
■
On Windows:
%BMC_PORTAL_KIT_HOME%\appserver\util\BPM_CMDB
■
On Solaris:
$BMC_PORTAL_KIT_HOME/appserver/util/BPM_CMDB
full path and file name of the optional log file
Service Model integration
How you provide infrastructure object data for service models depends on whether
you have BMC Atrium CMDB installed.
■
When you have BMC Atrium CMDB installed, you can configure the Portal to add
infrastructure CIs into the BMC Atrium CMDB. When the CIs are reconciled, you
can create service models. To implement this method, you need the BMC Atrium
CMDB and the BMC Impact Solutions kit.
■
If you do not have the BMC Atrium CMDB in place, you can configure the Portal to
send impact relationships for infrastructure object data directly to the cell. The
impact relationships define the infrastructure relationships in the service model.
To implement this method, you need the BMC Impact Solutions kit.
To configure the Portal to provide infrastructure data for service models
1 Log on to the Portal with Portal administrator credentials, and select the Portal tab.
2 In the navigation pane, select Global Properties.
192
BMC Performance Manager Portal Monitoring and Management Guide
Service Model integration
3 On the Global Properties page, perform one of the following actions:
■
To configure the Portal to send CIs to the BMC Atrium CMDB, specify the
settings under BMC Atrium Configuration Management Database Settings.
■
To configure the Portal to send impact relationships for the service model,
specify the settings under Direct Service Model Integration.
The settings under Direct Service Model Integration take effect if you clear the text
boxes in the BMC Atrium Configuration Management Database Settings section.
Figure 30 provides a high-level view of the methods you can use to provide
infrastructure object data for service models.
Figure 30
Portal
Simplified view of service model integration methods from the Portal
CIs
CMDB
Portal
object models
Impact Manager
(cell)
Following direct service model integration configuration, whenever you add an
element to the Portal and apply application classes that are enabled for BMC Atrium
CMDB integration, the Portal sends the infrastructure object data required for the
service model to the cell.
For information about adding service components to a service model or monitoring
service components, see the BMC Impact Solutions: Service Model Administrators Guide.
Chapter 7
Portal events and data integration
193
Event integration
Event integration
The BMC Performance Manager Portal sends events when
■
■
an agentless parameter changes state (state change events)
the RSM changes state (general system problems events)
When configuring notifications for provider-wide notifications, you can specify the
transports shown in Figure 31 to integrate state changes or general system problems
events with other products.
Figure 31
BMC Performance Manager Portal event integration
BMC Performance
Manager Portal
(Portal)
PATROL Enterprise
Manager (PEM)
SNMP event
third-party SNMP manager
(Tivoli, for example)
connectSNMP
provides enterprise-wide event
consolidation and management for
PATROL environments
email
Remote Service
Monitor
detects condition on
monitored system and
sends event to the Portal
- email
- page
- voice mail
- SNMP event
AlarmPoint by AlarmPoint
Systems
Impact Integration for PEM
Impact Integration Web
Services
BMC Service Impact
Manager
BMC Event Manager
BMC Performance Managers
shows real-time impact of IT
problems on IT and business
services
filters and correlates events and
automates corrective action
BMC Impact Explorer
Legend
event flow
viewable event data
(Java-based console) manages
events and event policies
Event integration using email notifications
You can configure notification rules that send event email messages to named
recipients. Email messages provide a subset of the information passed in the event.
They are not structured, which limits their use to simple integrations.
194
BMC Performance Manager Portal Monitoring and Management Guide
Event integration using SNMP traps
Event integration using SNMP traps
When logged on as a user or provider administrator, you can configure the Portal to
send SNMP traps to one or more computers. SNMP traps can be used to integrate
with BMC Software event managers and third-party event managers.
This transport method supports status change and general system problems events.
When configuring status change notification rules, you can select Element and
Parameter as the object type.
The Portal sends traps when the following events occur for any infrastructure object
in the account:
■
■
■
a parameter changes state
an infrastructure element changes state
an RSM changes state
When configuring user notification rules for SNMP traps, you can specify the type of
threshold violations, the circumstances under which the Portal should send the trap,
and the time to wait after the event occurs before sending the trap.
The MIB extensions used by the Portal enable you to translate the information
contained in the Portal traps for use with other products. MIB files map numeric
object identifiers (OIDs) (such as 1.3.6.1.4.11) used by most SNMP queries into more
meaningful names (and vice versa). MIB files are extensible, and most hardware and
software companies define their MIBs as extensions of some universal industrystandard MIB file. The Portal MIB files support SNMP traps, versions 1 and 2. See
page 211 for more information.
■
When a parameter or element value violates a rule that triggers a user notification
trap, that trap has a bmcPMPortalNotificationType of 2.
■
When an element value or RSM state triggers the Portal to send an enterprise-wide
SNMP trap, that trap has a bmcPMPortalNotificationType of 1.
If you configure provider-level notification rules that use the SNMP transport, you
might not want to have user-level notification rules that also use the SNMP transport
(and send notifications to the same target computers). When you have both types
configured, the Portal sends two notifications for each event.
For information about configuring the Portal to send SNMP traps, see “SNMP traps”
on page 204.
Chapter 7
Portal events and data integration
195
Event integration using AlarmPoint
Event integration using AlarmPoint
If you have AlarmPoint installed, you can configure the Portal to send notifications to
AlarmPoint. When administrators create AlarmPoint notifications from the Provider
tab or when users create AlarmPoint notifications from the Configure tab, the Portal
can send parameter, element, and general system problem events to the designated
AlarmPoint server.
Before users or provider administrators can create notification rules for AlarmPoint, a
Portal administrator must use the Global Properties page to configure the Portal for
AlarmPoint integration. By using scripts provided on the installation DVD and CD1
for your Portal operating system, you can use the Notifications task to configure the
Portal to send events to an AlarmPoint server. See the BMC Portal Getting Started
guide for detailed procedures about how to configure AlarmPoint integration.
If you configure provider-level notification rules that use the AlarmPoint transport,
you might not want to have user-level notification rules that also use the AlarmPoint
transport. When you have both types configured, the Portal sends two notifications
for each event.
Event integration using BMC II Web Services
When logged on as a user or provider administrator, you can configure notification
rules for the Portal to send notifications to BMC Impact Manager (BMC IM) through
the BMC Impact Integration Web Services server (BMC II Web Services). BMC II Web
Services maps parameter-level notifications from the Portal in the event format for
BMC Impact Manager solutions.
The Portal can use an insecure or secure web-based connection to send events to the
BMC II Web Services server.
Configuring the Portal to send data to a BMC II Web
Services server
When logged on as an administrator for a provider, you can configure the Portal to
send notifications to the primary BMC II Web Services server. If the BMC II Web
Services server was configured for high availability (HA), you can also specify a
secondary BMC II Web Services server. The Portal always tries to send events to the
computer identified as the primary BMC II Web Services server. When the Portal
cannot connect to the primary server, it tries the secondary BMC II Web Services
server, if one is specified. For more information about configuring a BMC II Web
Services server for HA, see the BMC Impact Integration Web Services Server Installation
and Configuration Guide.
196
BMC Performance Manager Portal Monitoring and Management Guide
Event integration using BMC II Web Services
Configuring secure event integration with BMC Impact
Solutions
These guidelines summarize the main tasks of sending events securely between the
BMC Portal and BMC II Web Services.
■
For secure communications between the BMC Portal and the BMC II Web Services
Server in a development or testing environment, generate a self-signed public key
and self-signed private key. The BMC Impact Integration Web Services Installation and
Configuration Guide describes how to generate these keys.
■
For secure communications in a production environment, obtain a signed
certificate from a certificate authority. See the BMC Impact Integration Web Services
Server Installation and Configuration Guide for information about obtaining a
certificate from a certificate authority.
To enable and configure secure communications using a self-signed certificate
between the Portal application server and the BMC II Web Services Server, perform
the following actions:
5. Import a secure certificate from the BMC II Web Services Server into the Portal
application server.
For information about importing the certificate, see “Importing the certificate for
the BMC II Web Services Server.”
6. Log on to the Portal with administrator credentials and configure the BMC II Web
Services Server to which the Portal will send events.
To specify secure communications, select Use HTTPS. See the BMC Portal Help for
detailed instructions.
7. While logged on as an administrator, select the Provider tab and add a notification
rule that uses the BMC II Web Services transport.
See the BMC Portal Help for detailed instructions.
Importing the certificate for the BMC II Web Services
Server
To configure secure communications between the Portal and the BMC II Web
Services Server, you must select Use HTTPS when specifying the BMC II Web Services
Server and BMC IM. See the BMC Portal Help for detailed information about
specifying the BMC II Web Services Server.
Chapter 7
Portal events and data integration
197
Event integration using BMC II Web Services
In addition to using the Portal interface to specify the BMC II Web Services Server,
you also must import the SSL certificate for the BMC II Web Services Server to the
Portal application server.
To import the BMC II Web Services secure certificate to the Portal application
server
1 Copy the secure certificate file from the BMC II Web Services Server to the Portal
application server.
2 Locate the Keytool utility in one of the following directories:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%/appserver/websdk/tools/jdk/jre/bin
On Solaris: $BMC_PORTAL_KIT_HOME\appserver\websdk\tools\jdk\jre\bin
3 Type the following command:
Keytool -import -file directory\iiwscertificate.cer -keystore directory\cacerts
You can find cacerts in one of the following directories:
■
On Windows:
%BMC_PORTAL_KIT_HOME%/appserver/websdk/tools/jdk/jre/lib/security
■
On Solaris:
$BMC_PORTAL_KIT_HOME\appserver\websdk\tools\jdk\jre\lib\security
4 At the Enter keystore password prompt, type changeit.
5 At the Trust this certificate password prompt, select yes.
6 Restart the Portal application server.
198
BMC Performance Manager Portal Monitoring and Management Guide
Event integration using BMC II Web Services
Using default insecure event integration with BMC Impact
Solutions
To enable and configure insecure communications between the Portal application
server and the BMC II Web Services Server, perform the following actions:
1. Log on to the Portal with administrator credentials and configure the BMC II Web
Services Server to which the Portal will send events.
Ensure that you do not select Use HTTPS. See the BMC Portal Help for detailed
instructions.
2. While logged on as an administrator, select the Provider tab and add a notification
rule that uses the BMC II Web Services transport.
See the BMC Portal Help for detailed instructions.
BMC Impact solutions base event class
BMC Impact Solutions have a base event class that defines the content of the events
(called slots) that the BMC Impact Manager cell can process. The base event class slots
listed in Table 24 represent the content of the event as it progresses from the BMC
Performance Manager Portal to the BMC Impact Manager cell. The BMC II Web
Services Server and the BMC Impact Solutions also populate additional slots, such as
mc_arrival_time (the time stamp of the event arrival at the BMC Impact Solutions
network).
Table 24
Slot names in the base event class populated for the Portal (part 1 of 2)a
Slot
Description
adapter_host
the server name for the BMC Portal server
CLASS
the type of event being generated
(PORTAL_PARAMETER_STATE_CHANGE,
PORTAL_RSM_STATE_CHANGE for RSM state changes)
mc_host
the host name of the managed element
mc_host_address
the IP address associated with the managed element
mc_host_class
the type of element (for example, Solaris)
mc_incident_time
the time of the event
mc_object
the instance or application class (if no instance exists)
mc_object_class
the qualified hierarchy for the object (including parent
instance and application classes separated by | as a
delimiter; for example: Windows 2003-Using
Perfmon|Disk)
mc_origin
the assigned name for the RSM that reported the event
mc_origin_class
the literal value: BPMPV2
Chapter 7
Portal events and data integration
199
Event integration using BMC II Web Services
Table 24
Slot names in the base event class populated for the Portal (part 2 of 2)a
Slot
Description
mc_origin_key
an internal identifier for the event (GUID)
mc_origin_sev
severity (same as the severity slot)
mc_parameter
the parameter name
mc_parameter_value
the value that caused the event
mc_smc_alias
the internal identifier (GUID) of the nearest parent
application instance that has a mapping to a CMDB CI
(always the same object referenced by mc_smc_id)
mc_smc_id
the CMDB reconciliation ID of the nearest parent
application instance which has a mapping to a CMDB CI
mc_tool
the server name for the BMC Portal server
mc_tool_class
the literal value: BMC Portal Server
msg
a text description of the event
severity
the severity of the event (Info, Warning, Critical)
a
For more information about the slots in the base event class, see the BMC Impact Manager
Knowledge Base Reference Guide.
In addition to the common slots in the base event class, the Portal uses the
PATROL_Portal event class to provide extended slots for event content from the
Portal. Because the slots in the PATROL_Portal event class extension, shown in
Table 25, are subject to change with emerging event-integration technology,
automated processes such as event filtering by BMC Service Impact Manager or BMC
Event Manager could also change in the future.
Table 25
PATROL_Portal event class extensions
PATROL_Portal slots
Description
patrolAccountName
the account associated with the event
patrolGroupName
the parent groups that contain the element associated with
the event
patrolElementName
the display name of the managed element
patrolParameterErrorCode error code
patrolParameterThreshold the threshold value breached
200
BMC Performance Manager Portal Monitoring and Management Guide
Combining BMC Performance Manager and PATROL Agent events
Combining BMC Performance Manager and PATROL Agent
events
This section describes situations in which duplicate events are sent to BMC PATROL
Enterprise Manager (BMC PATROL EM) when you use multiple event management
technologies to monitor the same systems. You can encounter this situation when you
introduce agentless monitoring in an environment that uses PATROL Agents to
monitor and manage infrastructure.
■
“Using PATROL integration Performance Managers with PATROL Agent-based
monitoring” describes how you can trigger two comparable events from a single
threshold breach.
Not all events that the PATROL Agent generates are available in the Portal.
Custom events generated by PATROL KMs or PATROL integration Performance
Managers using event triggers are available in the Portal, but to be usable by an
event manager, they must be sent from the PATROL Agent to BMC PATROL EM.
Also, only a subset of the parameters from PATROL KMs are available in the
Portal because of fundamental technical differences between the product
architectures.
■
“Overlapping agentless and agent-based monitoring” on page 202 describes how
you can trigger two distinct events for one threshold breach.
Using PATROL integration Performance Managers with
PATROL Agent-based monitoring
Duplicate events can occur when you use PATROL Agent-based management on a
computer and also use PATROL integration Performance Managers to remotely
monitor the same applications on the same computer. PATROL integration
Performance Managers contain many of the parameters found in their corresponding
KMs and obtain their parameter values from the PATROL Agent. When one of these
common parameters breaches one of its thresholds, an event is triggered by the Portal
and another one is triggered by the PATROL Agent.
Figure 32 on page 202 shows how a "disk full" event detected independently by each
management system creates duplicate events for a single parameter.
Chapter 7
Portal events and data integration
201
Combining BMC Performance Manager and PATROL Agent events
Figure 32
Two comparable events from one threshold breach
BMC PATROL EM
disk full
disk full
Portal
existing
integration
PATROL Agent-based
Management
PATROL integration
Performance Managers
(remote management)
managed server
Overlapping agentless and agent-based monitoring
Similar events can occur when you use PATROL Agent-based management to
manage a computer and also use the agentless Performance Managers in the Portal to
remotely monitor the same computer. In the scenario shown in Figure 33 on page 203,
the agentless Performance Managers contain parameters that the PATROL KMs,
running on the agent, also monitor. This situation results in events that, while very
similar, are not the same.
Figure 33 on page 203 illustrates the event flow that results from overlapping
monitoring. In the example, the disk events are sent by both management
components and have similar, but not identical, information about the computer,
based on a single threshold breach.
202
BMC Performance Manager Portal Monitoring and Management Guide
Combining BMC Performance Manager and PATROL Agent events
Figure 33
Sample agentless and agent-based events sent from the Portal
BMC PATROL EM
disk event
disk event
existing
integration
Portal
PATROL Agent-based
management
agentless Performance
Managers
managed server
A solution Performance Manager that is monitoring the same parameters as an agentmanaged server might have a threshold exception at the same time as a PATROL KM.
As the example in Figure 33 shows, this causes duplicate events to be sent to the BMC
PATROL EM event manager for a single parameter’s threshold breach—one from the
agent side and another from the Portal side. Unlike the example in Figure 32 on
page 202, the application class, parameters, and instances are different from those in
the PATROL KM.
How to avoid duplicate events
To eliminate duplicate state change events, you can use the following options:
■
Use the Notifications task to exclude notifications sent from systems in which you
have configured PATROL integration Performance Managers.
■
Correlate the duplicate events in an event manager such as BMC PATROL EM,
BMC EM, or a third-party product.
■
Deactivate one of the parameter thresholds in either the BMC Performance
Manager Portal or the PATROL Agent. This action results in losing the ability to
monitor the deactivated threshold.
Chapter 7
Portal events and data integration
203
SNMP traps
SNMP traps
The BMC-Performance-Manager-Portal-MIB provides the following traps:
■
■
■
Parameter State Change
RSM State Change
Element State Change
Although related, these traps have different meanings. The Portal triggers Parameter
State Change traps when the status of a parameter changes. Not all Parameter State
Changes result in a state change for the element. When a Parameter State Change also
affects the state of the element, the Portal also triggers an Element State Change trap.
If you choose to receive notification when a general system problem occurs, the Portal
will trigger an RSM State Change event if it fails to receive a heartbeat message from
the RSM.
When configuring enterprise integration and user notification integration, you can
choose to use SNMP version 1 or SNMP version 2 traps.
TIP
To change the maximum number of parameters that the Portal can send in a trap, modify the
value of the snmp.max.parameter.events.to.process property. For more information about
this property, see page 291.
MIB files
The BMC Performance Manager Portal module provides MIBs that you can use to
translate SNMP traps sent from the product.
■
WEBSDKV10-MIB— For more information about this MIB, see the BMC Portal
Getting Started guide.
■
BMC-Performance-Manager-Portal-MIB—If you install the BMC Performance
Manager Portal module, this MIB defines all SNMP events from this module.
On the BMC Portal installation DVD, you can find the MIB files under the
util\BPM_MIB (Windows) or util/BPM_MIB (Solaris) directory.
204
BMC Performance Manager Portal Monitoring and Management Guide
Object identifiers (OIDs)
Following installation, you can find the MIB files at the following locations on the
Portal application server:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%\appserver\util\BPM_MIB
On Solaris: $BMC_PORTAL_KIT_HOME/appserver/util/BPM_MIB
Object identifiers (OIDs)
OIDs are used by SNMP queries to identify individual pieces of data and are
identified in the MIB file. Figure 34 provides an overview of the general structure of a
BMC Performance Manager Portal OID.
Figure 34
OID structure in BMC-Performance-Manager-Portal-MIB
. 1 . 3 . 6 . 1 . 4 . 1 . 1031 . 5 . { 0 | 1 } . { 1–3 | 1–n } . [0...n]
indicates that the trap originated
from a BMC Software product
A value of 5 in this position indicates that the OID is from
the BMC-Performance-Manager-Portal-MIB.
A value of 7 indicates that the OID is from the
WEBSDK10-MIB. See BMC Portal Getting Started.
If the previous digit is 0, the possible
values for this digit are 1, 2, or 3.
If the previous digit is 1, the possible
values for this digit are 1–n.
indicates the type of value that this OID represents:
0 represents notification
1 represents object
Chapter 7
This number increments for
nodes that contain multiple
instances for an OID.
Portal events and data integration
205
Parsing SNMP traps
Parsing SNMP traps
Although the property OIDs in SNMP version 1 and version 2 are the same, the
version of SNMP version that you use has an effect on the following OIDs:
■
.1.3.6.1.2.1.1.3.0: This OID is identified as time ticks, and represents the Portal up
time.
■
.1.3.6.1.6.3.1.1.4.1.0: The value of this OID is another OID that identifies the type of
trap. This trap identifier OID looks like .1.3.6.1.4.1.1031.X.0.Y.0, where
— X identifies the source of the trap. The valid value for the BMC Performance
Manager Portal is 5.
— Y identifies the type of notification. Valid values are 1, 2, and 3.
■
■
■
1: Parameter State Change
2: RSM State Change
3: Element State Change
Version 1 traps include some additional header information that is not included in
version 2 traps. The version 1 header information includes a generic type, a sender
OID, and a specific type field. For traps generated from the BMC Performance
Manager Portal, the generic type is always 6 (enterprise-specific event). The specific
type identifies the type of notification. Valid values are 1, 2, and 3:
■
■
■
1: Parameter State Change
2: RSM State Change
3: Element State Change
The specific type field in the header of version 1 traps and the value corresponding to
OID .1.3.6.1.6.3.1.1.4.1.0 in version 2 traps enable you to determine the trap type, and
then filter or process the trap content as needed.
206
BMC Performance Manager Portal Monitoring and Management Guide
BMC-Performance-Manager-Portal-MIB description
BMC-Performance-Manager-Portal-MIB description
This MIB defines the event traps sent from the BMC Performance Manager Portal.
Table 26 describes each OID in an event trap.
Table 26
BMC-Performance-Manager-Portal-MIB (part 1 of 5)
OID
Type
.1.3.6.1.2.1.1.3.0
time ticks
Index
Node name and description
represents the up time for the Portal
bmcPMPortalNotifications (.1.3.6.1.4.1.1031.5.0)
.1.3.6.1.4.1.1031.5.0.1
bmcPMPortalParameterStateChange
parameter state change notification
Each state change contains the following nodes:
■ bmcPMPortalAccountName
■ bmcPMPortalGroupName
■ bmcPMPortalHostName
■ bmcPMPortalApplicationName
■ bmcPMPortalApplicationInstanceName
■ bmcPMPortalParameterName
■ bmcPMPortalParameterValue
■ bmcPMPortalParameterState
■ bmcPMPortalDetectedTimeUtcStr
■ bmcPMPortalRsmName
■ bmcPMPortalElementName
■ bmcPMPortalParameterErrorCode
■ bmcPMPortalParameterThresholdValue
■ bmcPMPortalDetectedTime
■ bmcPMPortalRsmClusterName
■ bmcPMPortalNotificationType
■ bmcPMPortalApplicationHierarchy
.1.3.6.1.4.1.1031.5.0.2
bmcPMPortalRsmStateChange
RSM state change notification (from up to down or from down
to up)
Each state change contains the following nodes:
■ bmcPMPortalAccountName
■ bmcPMPortalHostName
■ bmcPMPortalDetectedTimeUtcStr
■ bmcPMPortalRsmName
■ bmcPMPortalRsmState
■ bmcPMPortalDetectedTime
■ bmcPMPortalRsmClusterName
■ bmcPMPortalRsmClusterState
■ bmcPMPortalNotificationType
Chapter 7
Portal events and data integration
207
BMC-Performance-Manager-Portal-MIB description
Table 26
BMC-Performance-Manager-Portal-MIB (part 2 of 5)
OID
Type
Index
.1.3.6.1.4.1.1031.5.0.3
Node name and description
bmcPMPortalElementStateChange
element state change notification
Each state change trap contains the following nodes:
■ bmcPMPortalAccountName
■ bmcPMPortalGroupName
■ bmcPMPortalHostName
■ bmcPMPortalApplicationName
■ bmcPMPortalApplicationInstanceName
■ bmcPMPortalParameterName
■ bmcPMPortalParameterValue
■ bmcPMPortalParameterState
■ bmcPMPortalDetectedTimeUtcStr
■ bmcPMPortalRsmName
■ bmcPMPortalElementName
■ bmcPMPortalElementState
■ bmcPMPortalParameterErrorCode
■ bmcPMPortalParameterThresholdValue
■ bmcPMPortalDetectedTime
■ bmcPMPortalRsmClusterName
■ bmcPMPortalNotificationType
■ bmcPMPortalApplicationHierarchy
bmcPMPortalObjects (.1.3.6.1.4.1.1031.5.1)
.1.3.6.1.4.1.1031.5.1.1
string (300
characters)
bmcPMPortalAccountName
name of the account that contains the element that triggered
the notification
A trap can contain only one account name, and the account
name is unique in the provider.
For general system problems traps, this string contains
■
■
■
.1.3.6.1.4.1.1031.5.1.2.x
string (300 yes
characters)
Shared when a problem occurs on a shared RSM
Global when a problem occurs on a global RSM
the account name when a problem occurs on a dedicated
RSM
bmcPMPortalGroupName
name of the group or groups that contains the element that
triggered the notification
Elements can be members of more than one group, and all
affected groups are included in the notification.
208
BMC Performance Manager Portal Monitoring and Management Guide
BMC-Performance-Manager-Portal-MIB description
Table 26
BMC-Performance-Manager-Portal-MIB (part 3 of 5)
OID
Type
.1.3.6.1.4.1.1031.5.1.3
string (255
characters)
Index
Node name and description
bmcPMPortalHostName
host name or IP address of the object that triggered the
notification
This value might be the host name or IP address of the element
or of the RSM.
.1.3.6.1.4.1.1031.5.1.4.x
string (64 yes
characters)
bmcPMPortalApplicationName
application class responsible for triggering the notification
The application name is not necessarily unique on an element,
and the trap can contain multiple application names.
.1.3.6.1.4.1.1031.5.1.5.x
string (810 yes
characters)
bmcPMPortalApplicationInstanceName
instance in the application class that is responsible for
triggering the notification
Application instances are unique in an application class but
are not required to be unique among application classes.
This OID is populated for instances in multiple-instance
application classes and discovered instances.
.1.3.6.1.4.1.1031.5.1.6.x
string (255 yes
characters)
bmcPMPortalParameterName
parameter that triggered the notification
Parameter names are unique in an application instance but
might not be unique among application classes. The trap can
contain multiple parameter names.
.1.3.6.1.4.1.1031.5.1.7.x
string (128 yes
characters)
bmcPMPortalParameterValue
parameter value that triggered the notification
The trap contains a parameter value for each parameter that
triggered a notification.
.1.3.6.1.4.1.1031.5.1.8.x
integer
yes
bmcPMPortalParameterState
parameter state that triggered the notification:
■ 0: OK
■ 1: warning
■ 2: noncriticalalarm
■ 3 criticalalarm
Multiple parameter states are possible.
Chapter 7
Portal events and data integration
209
BMC-Performance-Manager-Portal-MIB description
Table 26
BMC-Performance-Manager-Portal-MIB (part 4 of 5)
OID
Type
.1.3.6.1.4.1.1031.5.1.9
string (255
characters)
Index
Node name and description
bmcPMPortalDetectedTimeUtcStr
time (formatted) at which the event that triggered the
notification occurred
.1.3.6.1.4.1.1031.5.1.10
string (255
characters)
bmcPMPortalRsmName
name of the RSM that detected the state change
.1.3.6.1.4.1.1031.5.1.11
integer
bmcPMPortalRsmState
current state of the RSM:
■ 0: up
■ 3: down
.1.3.6.1.4.1.1031.5.1.13
string (300
characters)
bmcPMPortalElementName
name of the monitored element that triggered the notification
.1.3.6.1.4.1.1031.5.1.14.x
string (255 yes
characters)
bmcPMPortalParameterErrorCode
Performance Manager-specific code that describes the
condition that triggered the notification
See “Trap error codes” on page 214.
This OID is not populated if the error does not have an error
code.
.1.3.6.1.4.1.1031.5.1.15
integer
bmcPMPortalElementState
state of the element after the State Change Event:
■ 0: OK
■ 1: warning
■ 2: noncriticalalarm
■ 3: criticalalarm
■ 4: nodata
.1.3.6.1.4.1.1031.5.1.17.x
string (256 yes
characters)
bmcPMPortalParameterThresholdValue
parameter threshold value that was breached
.1.3.6.1.4.1.1031.5.1.18
.1.3.6.1.4.1.1031.5.1.19
number of
milliseconds
(64
characters)
bmcPMPortalDetectedTime
string (225
characters)
bmcPMPortalRsmClusterName
number of milliseconds since January 1, 1970, that the
Parameter or Element State Change occurred
name of the clustered RSM
If the RSM is not clustered, this value is blank.
210
BMC Performance Manager Portal Monitoring and Management Guide
Trap properties customization
Table 26
BMC-Performance-Manager-Portal-MIB (part 5 of 5)
OID
Type
.1.3.6.1.4.1.1031.5.1.20
integer
Index
Node name and description
bmcPMPortalRsmClusterState
current state of the clustered RSM:
■
■
■
0: up
1: warn
3: down
If the RSM is not clustered, this value is blank.
.1.3.6.1.4.1.1031.5.1.21
integer
bmcPMPortalNotificationType
feature origin of the event:
■ 1: enterpriseIntegration
■ 2: userNotification
If you configure both enterprise integration and user
notification, in many instances the Portal will send duplicate
traps for a single event. Use the
bmcPMPortalNotificationType object to parse the origin of
the event.
.1.3.6.1.4.1.1031.5.1.22
string
(8192
characters)
bmcPMPortalApplicationHierarchy
specifies the full hierarchy of the application instance
responsible for the parameter that caused the state change
Application instances are separated by delimiters so that you
can easily determine multiple levels of application instances
and the exact parameter that caused the state change.
.1.3.6.1.4.1.1031.5.1.23
string (255
characters)
bmcPMPortalEventReason
provides a detailed description about the problem that caused
the event
Trap properties customization
This section describes some of the properties that you can change to affect the trap
header or trap content. You customize trap properties by modifying the
internal.properties file, which is located in the following directories:
■
On Windows: %BMC_PORTAL_KIT_HOME%\
appserver\websdk\tools\jboss\server\all\conf\properties\
■
On Solaris:
$BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/properties/
Chapter 7
Portal events and data integration
211
Trap properties customization
#################################################
# SNMP Trap Version, possible values are 1 or 2 #
#################################################
# default is snmp v1.
snmp.trap.version=1
snmp.trap.max.recv.size=13000
For changes to take effect, you must restart the Portal after modifying the
internal.properties file.
Changing the SNMP trap version sent by the Portal
By default, the Portal sends SNMP traps in SNMP version 1 format. To change to
version 2, modify the value of the snmp.trap.version property.
Changing the SNMP trap size for the Portal
By default, the Portal can transmit traps as large as 1,300 bytes. To increase the trap
size that the Portal can send, modify the value of the snmp.trap.max.recv.size property.
212
BMC Performance Manager Portal Monitoring and Management Guide
Sample trap
Sample trap
Figure 35 provides an example of an enterprise integration trap (identified by the
bmcPMPortalNotificationType node) for an Element State Change event. The
highlighted regions show the OIDs and their corresponding values. The annotations
describe the OIDs.
Figure 35
Sample trap for an Element State Change event (part 1 of 2)
Trap(v1) received from host snmp_server.acme.com(172.18.52.17) at Apr 6, 2006 12:21 PM.
Enterprise Oid : .1.3.6.1.4.1.1031.5 (.iso.org.dod.internet.private.enterprises.1031.5) , Specific
Type : 3,
account name: The trap can contain only one account.
Object ID: .1.3.6.1.4.1.1031.5.1.1.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.1.0)
STRING: Acme
Object ID: .1.3.6.1.4.1.1031.5.1.2.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.2.0)
object group name: The element that triggered the event
STRING: mygroup1
was a member of two object groups.
Object ID: .1.3.6.1.4.1.1031.5.1.2.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.2.1)
STRING: mygroup2
host name: An Element State Change event can contain
Object ID: .1.3.6.1.4.1.1031.5.1.3.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.3.0)
only host names, not IP addresses.
STRING: computer1.acme.com
application name: The applications in the trap correspond to
Object ID: .1.3.6.1.4.1.1031.5.1.4.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.4.0)
the parameters that triggered the notification.
STRING: SSHD
Object ID: .1.3.6.1.4.1.1031.5.1.4.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.4.1)
STRING: SSHD
Object ID: .1.3.6.1.4.1.1031.5.1.4.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.4.2)
STRING: SSHD
application instance name: The instances in the trap
Object ID: .1.3.6.1.4.1.1031.5.1.5.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.5.0)
correspond to the parameters that triggered notification.
STRING: com_acme-DRPM3-performance
Object ID: .1.3.6.1.4.1.1031.5.1.5.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.5.0)
STRING: com_acme-DRPM3-performance
Object ID: .1.3.6.1.4.1.1031.5.1.5.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.5.0)
STRING: com_acme-DRPM3-performance
names of parameters whose values triggered notification:
Object ID: .1.3.6.1.4.1.1031.5.1.6.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.6.0)
In this example, three parameters in the element breached
STRING: Application Collection Status
parameter thresholds.
Object ID: .1.3.6.1.4.1.1031.5.1.6.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.6.1)
STRING: Banner display
Object ID: .1.3.6.1.4.1.1031.5.1.6.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.6.2)
STRING: Port Responding
Object ID: .1.3.6.1.4.1.1031.5.1.7.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.7.0)
parameter values that triggered notification
STRING: true
Object ID: .1.3.6.1.4.1.1031.5.1.7.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.7.1)
STRING: SSH-1.99-OpenSSH_4.1
Object ID: .1.3.6.1.4.1.1031.5.1.7.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.7.2)
STRING: true
Object ID: .1.3.6.1.4.1.1031.5.1.8.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.8.0)
parameter state that triggered notification: In this trap, the
INTEGER: 0
parameter states changed to 0 (OK).
Object ID: .1.3.6.1.4.1.1031.5.1.8.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.8.1)
INTEGER: 0
Object ID: .1.3.6.1.4.1.1031.5.1.8.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.8.2)
INTEGER: 0
time indicating when the state change occurred
Object ID: .1.3.6.1.4.1.1031.5.1.9.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.9.0)
STRING: Thu, 6 Apr 2006 17:22:12 +0000
name of the RSM that detected the state change
Object ID: .1.3.6.1.4.1.1031.5.1.10.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.10.0)
STRING: Main Office RSM
Object ID: .1.3.6.1.4.1.1031.5.1.13.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.13.0)
name of the element in the Portal
STRING: computer1
Chapter 7
Portal events and data integration
213
Trap error codes
Figure 35
Sample trap for an Element State Change event (part 2 of 2)
Object ID: .1.3.6.1.4.1.1031.5.1.14.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.14.0)
Performance Manager-specific codes that describe the
STRING: 98
problem that triggered the event
Object ID: .1.3.6.1.4.1.1031.5.1.14.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.14.1)
STRING: 98
Object ID: .1.3.6.1.4.1.1031.5.1.14.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.14.2)
STRING: 98
Object ID: .1.3.6.1.4.1.1031.5.1.15.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.15.0)
state of the element after the state change
INTEGER: 0
Object ID: .1.3.6.1.4.1.1031.5.1.17.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.17.0)
parameter threshold that was breached
STRING: 0.0
Object ID: .1.3.6.1.4.1.1031.5.1.17.1 (.iso.org.dod.internet.private.enterprises.1031.5.1.17.1)
STRING: 0.0
Object ID: .1.3.6.1.4.1.1031.5.1.17.2 (.iso.org.dod.internet.private.enterprises.1031.5.1.17.2)
STRING: 0.0
timestamp indicating when the state change occurred
Object ID: .1.3.6.1.4.1.1031.5.1.18.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.18.0)
STRING: 1144344132703
if the RSM is a clustered RSM, the name of the cluster
Object ID: .1.3.6.1.4.1.1031.5.1.19.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.19.0)
STRING:
type of notification; in this case, enterprise integration
Object ID: .1.3.6.1.4.1.1031.5.1.21.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.21.0)
INTEGER: 1
application hierarchy: In this example, the event occurred
Object ID: .1.3.6.1.4.1.1031.5.1.22.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.22.0)
in the Performance instance in the Oracle application.
STRING: Oracle | Performance
Object ID: .1.3.6.1.4.1.1031.5.1.23.0 (.iso.org.dod.internet.private.enterprises.1031.5.1.23.0)
detailed description of the problem that caused of the
STRING: New Violation: The status of computer1 is OK
event
Trap error codes
Table 27 lists the generic parameter error codes that might appear in the
bmcPMPortalParameterErrorCode node. For error codes that are specific to the
Performance Managers in use on your Portal, see the Help or Getting Started guide
for the applicable Performance Managers.
Table 27
Parameter error codes (part 1 of 2)
Error code Description
0 success
4 unknown host name
8 database SQL problem—error with the SQL command being run against a
database
10 prohibited host—the host used was in the prohibited host list
11 network unavailable—the network was not available at the time of execution
12 network path unavailable—a network path to the named host is not available at
this time
98 invalid credentials—authentication credentials were not correct or otherwise
could not be used to authenticate execution
99 no data—collection could be performed, but no data was available
101 process down—the process being monitored was unavailable
214
BMC Performance Manager Portal Monitoring and Management Guide
Events tab
Table 27
Parameter error codes (part 2 of 2)
Error code Description
102 credentials conflict—the credentials being used conflict with another set of
credentials already accessing the same resource
103 account locked out—the account being used for authentication is locked out
200 configuration unavailable—configuration needed to execute was not available
210 configuration corrupt—the configuration was available but was corrupt and
unusable
Events tab
When the RSM detects that a parameter has changed to or from an alert (warning or
alarm) status, the RSM sends the parameter value to the Portal (along with the values
for other parameters in the application class). These parameter values are saved as
event history data in the Portal database and appear on the Events tab, and they are
also saved as raw data.
The Events tab provides history logs that show, for a specific time range, when
elements and parameters changed to an alert status (warning or alarm) and when
they changed to a different alert status.
■
A parameter appears on the Events tab when its status changes.
■
An element appears on the Events tab when at least one of its parameters changes
to an alert status. Because multiple status changes can occur on an element, an
element can appear on this tab more than once.
You can view events for the entire account, for object groups, for elements, and for
parameters. By default, this tab shows events from the previous 24 hours. You can
use the time controls at the top of the tab to change the time period for viewing alert
history.
Table 28 lists the event object views and the types of events available on each view.
Table 28
Types of events available for object views
Object view
Element events
account
+
object group
+
element
+
Parameter events
+
application class
+
parameter
+
Chapter 7
Portal events and data integration
215
List content
List content
When viewing alerts for infrastructure elements, you can use a variety of page
controls to adjust the number of alerts on the Events tab.
Objects to show
The Objects to Show list is available from the element view of events and enables you
to view element or parameter events, or both. When you are viewing events for both,
the
icon for element events and the
icon for parameter events enable you to
differentiate between the two event types. Figure 36 provides an example of an events
list that contains both element and parameter events.
■
When you select Elements, the description shows the parameter that caused the
status to change for the element. If the values of other parameters also violates
threshold settings during the time that the element is in that status, the description
does not update to show those parameters. Similarly, if you had configured
notifications so that the Portal would send SNMP traps, the Portal would send a
single trap for the element status change.
When listing element events, the list can contain a maximum of 300 events. To
change this default value, see the portal.events.element.limit property on page 279.
■
When you select Parameters or Elements + Parameters, the list includes every
parameter that violated its threshold value and the parameter value.
— When listing parameter events, the list can contain a maximum of 300 events. To
change this default value, see the portal.events.param.limit property on
page 280.
— When listing parameter events and element events, the list can contain a
maximum of 600 events (300 of each event type). To change this default value,
see the portal.events.element.param.limit property on page 279.
Figure 36
216
Infrastructure element view of Events tab
BMC Performance Manager Portal Monitoring and Management Guide
Page controls
Alerts to show
The Alerts to Show list, shown in Figure 37, is available for the account and object
group views and enables you to filter the list of events by the type of event. By
default, the list shows the events that caused the status to change for the element.
For each event, the description shows the parameter that caused the status to change
for the element. If the values of other parameters also violated threshold settings
during the time that the element is in that status, the description does not update to
show those parameters.
■
To view active and resolved alerts, select All. You can filter the list by time by
adjusting the time control options. When you use this option, the list can contain a
maximum of 300 alerts. To change this default value, see the
portal.events.element.limit property on page 279.
■
To view only active alerts, select Active Alarms, Active Warnings, or Active Alarms
and Warnings. These options displays all active alerts for the specified alert type.
Figure 37
Alerts to Show list on Events tab
Page controls
The Events tab also has the page controls listed in Table 29.
Table 29
Page controls for Events tab (part 1 of 2)
Page control
Description
updates the page at the refresh rate or stops the Portal from
updating the page
Select the On option when you select one of the Active
options from the Alerts to Show list.
Chapter 7
Portal events and data integration
217
Page controls
Table 29
Page controls for Events tab (part 2 of 2)
Page control
Description
opens the active Events tab in a new window
time controls
settings that you can change to view events from a different
time period
Click Update after changing the time-interval controls.
See page 144 for a complete description of the time controls.
totals
218
icons and totals for each state during the specified time
period; for example,
BMC Performance Manager Portal Monitoring and Management Guide
Chapter
8
BMC Performance Manager Portal
command-line interface
8
The BMC Performance Manager Portal command-line interface (bpmcli) enables
Portal users and administrators to add and delete infrastructure elements without
interacting with the user interface. The bpmcli can also query the Portal database for
infrastructure objects, enabling you to integrate the Portal data with other systems.
This chapter presents the following topics:
Preparing the client computer for the bpmcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bpmcli syntax and arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data-manipulation commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
addElements: adding a single element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
addElements: adding multiple elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
addPATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
deleteElements: deleting a single element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
deleteElements: deleting multiple elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refreshDatafeedMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refreshPATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
savePassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data-extraction commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
exportParameterHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getApplicationsForElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getParameterHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getParameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getPortalVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getSubApplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 8 BMC Performance Manager Portal command-line interface
220
221
222
223
225
228
230
231
232
234
237
238
240
244
245
246
249
250
251
219
Preparing the client computer for the bpmcli
Preparing the client computer for the bpmcli
Before you can use the bpmcli to manage infrastructure objects, you must prepare the
client computer so that it meets the necessary requirements for the utility. You can
install the bpmcli on any Microsoft Windows or Sun® Solaris computer that has
network access to the Portal. You do not need to use the Portal or RSM computer.
NOTE
If you try running the bpmcli against earlier versions of BMC Performance Manager Portal,
the commands return the following message: (404) Not Found.
Before you begin
■
If necessary, install JRE 1.5.0_06 or later on the client computer and verify that Java
is in the path.
■
Locate the necessary files for the bpmcli. You can find the files in the following
locations:
— product media for your operating system:
■
■
Windows DVD: util\BPM_CLI
Solaris DVD: util/BPM_CLI
— Portal application server:
■
■
On Windows: %BMC_PORTAL_KIT_HOME%\appserver\util\BPM_CLI
On Solaris: $BMC_PORTAL_KIT_HOME/appserver/util/BPM_CLI
— RSM computer (Windows only):
c:\Program Files\BMC Software\Remote Service Monitor\RSM<versionNumber>
\util\BPM_CLI
To prepare the client computer to run the bpmcli
1 Navigate to the bpmcli files on the application server, RSM computer, or
installation media.
2 Copy the following files to the client computer:
220
■
bpmcli.jar
■
bpmcli.bat (Windows) or bpmcli.sh (Solaris)
BMC Performance Manager Portal Monitoring and Management Guide
bpmcli syntax and arguments
You can copy the files to any location, but you must run bpmcli from that location.
bpmcli syntax and arguments
Each complete command line contains arguments that specify the Portal host name,
user credentials, and port number necessary to communicate with the Portal, and the
command that you want to execute. The command might also have additional
arguments.
The basic command-line syntax for the bpmcli is as follows:
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass
UserPassword
-c command -q
Table 30 lists the basic arguments that you can use with any bpmcli command. Other
arguments are included with their corresponding commands. See “Datamanipulation commands” on page 222 and “Data-extraction commands” on
page 238.
Table 30
Basic arguments for bpmcli commands (part 1 of 2)
Argument
Definition
-portal PortalWebServerName
specifies the fully-qualified host name of the Portal (for multiplecomputer installations, the Portal web server)
When you run the bpmcli from a Windows Portal web server, you can
omit the Portal host name; bpmcli assumes localhost. When run from a
computer other than the Portal web server or from any Solaris
computer, you must specify this argument.
-p PortNumber
specifies the port number on which the bpmcli receives data from the
Portal web server
The port number is required only if the web server does not use the
default port, 443.
-login UserName
specifies the user who is executing the command
■
Only users who are members of the Full Access user group can
execute data manipulation bpmcli commands. See page 222.
■
Users who are members of the Full Access or Read Only user group
can access the data extraction commands. See page 238.
■
The specified user can execute bpmcli commands against objects in
the user’s account.
Chapter 8 BMC Performance Manager Portal command-line interface
221
Data-manipulation commands
Table 30
Basic arguments for bpmcli commands (part 2 of 2)
Argument
Definition
-pass UserPassword
specifies the password for the user
Enclose the password in single quotes (' ') when a password contains a
special character (for example, ‘-ep’) or when the password contains
only one character (for example, 'g').
For example:
bpmcli -portal myportal.acme.com -login user -pass '-ep' -c
addElements -h databaseserver.acme.com -e DatabaseServer -ep
Databases -platform "Windows 2000" -r "Portal RSM" -g Databases
-c command
specifies the command
-q
(optional) suppresses return messages
Do not use this argument with data extraction commands.
(optional; not recommended) uses HTTP to communicate with the Portal
-unsecure
By default, the bpmcli uses HTTPS to communicate with the Portal.
When you specify -unsecure, the bpmcli transmits passwords as plain
text.
To execute bpmcli commands in a batch file, you must add a call to the individual
commands.
Data-manipulation commands
The commands in this section enable you to add data to and delete it from the Portal.
All commands are case sensitive. Table 31 shows the syntax for each complete bpmcli
command that falls into this category (the specific command is shown in bold text).
Only users who are members of the Full Access user group can execute the bpmcli
commands in this section. Users who are only members of user-defined user groups
cannot run the bpmcli commands.
Table 31
Data-manipulation bpmcli commands (part 1 of 2)
Command
Syntax
addElements: adding a
single element
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
223
-pass UserPassword -c addElements -h ElementHostName -e ElementName
-ep ProfileName -r RSMName -platform PlatformName -g ObjectGroupName
addElements: adding
multiple elements
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c addElements -platform PlatformName -f FileName
222
BMC Performance Manager Portal Monitoring and Management Guide
Page
225
addElements: adding a single element
Table 31
Data-manipulation bpmcli commands (part 2 of 2)
Command
Syntax
Page
addPATROL
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c addPATROL -email “EmailAddresses”
-f AgentFileName -r RSMName -g ObjectGroupName
228
deleteElements: deleting a bpmcli -portal PortalWebServerName -p PortNumber -login UserName
single element
-pass UserPassword -c deleteElements -e ElementName
230
deleteElements: deleting
multiple elements
231
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c deleteElements -f FileName
refreshDatafeedMetadata bpmcli -portal PortalWebServerName -p PortNumber -login adminName
-pass adminPassword -c refreshDatafeedMetadata
232
refreshPATROL
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c refreshPATROL -email “EmailAddresses”
-f ElementFileName
234
savePassword
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c savePassword
237
addElements: adding a single element
When adding a single element, you must provide the following properties:
■
■
■
■
■
host name or IP address of the element
existing profile name to apply to the element
existing RSM or RSM cluster to monitor the element
operating system of the element
existing object group that you will assign to the element
You can also provide the element name. If you do not provide the element name,
bpmcli uses the host name or IP address for the element name.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c addElements -h ElementHostName -e ElementName -ep ProfileName -r RSMName
-platform platformName -g ObjectGroupName
Chapter 8 BMC Performance Manager Portal command-line interface
223
addElements: adding a single element
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 32 with the addElements command.
Table 32
addElements arguments for adding a single element
Argument
Definition
-h ElementHostName
fully-qualified host name or IP address of the element
If you do not include this optional argument, you must
include the -e argument. You must specify this argument if
you do not include the -e argument.
-e ElementName
display name for the element
If you do not include this optional argument, you must
include the -h argument. Enclose multiple-word element
names in quotation marks.
-ep ProfileName
name of an existing element profile
Enclose multiple-word profile names in quotation marks.
-r RsmName
name of an existing RSM or RSM cluster to monitor the
elements
Enclose multiple-word RSM names in quotation marks.
-platform PlatformName
name of the platform as it appears in the following list:
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
AIX
HP-UX
Linux
Network Firewall
Network Load Balancer
Network Router
Network Switch
Open VMS
Other
Solaris
Storage
Tru64 UNIX
Windows
Windows 2000
Windows 2003
Windows XP
Enclose multiple-word platform names in quotation marks.
-g ObjectGroup
name of the existing object group to which the elements will
belong
Enclose multiple-word object group names in quotation
marks.
224
BMC Performance Manager Portal Monitoring and Management Guide
addElements: adding multiple elements
Sample command
The following command adds a single element that has the following properties:
■
■
■
■
■
■
■
■
■
web server name of the Portal: myportal.acme.com
user name: user
password for user: user
host name of the element: databaseserver.acme.com
element name: DatabaseServer
element profile name: Databases
RSM: Portal RSM
platform: Windows 2000
object group name: Databases
bpmcli -portal myportal.acme.com -login user -pass user -c addElements
-h databaseserver.acme.com -e DatabaseServer -ep Databases -platform “Windows 2000”
-r “Portal RSM” -g Databases
The port is not specified, so the bpmcli assumes that the port is the default, 443.
Return messages
After execution of the command, one of the following messages is displayed,
depending on whether the addition was successful:
■
SUCCESS, msg [added element], user [UserName], element
[ElementName], group [GroupName], platform [PlatformName],
rsm [RsmName], host [HostName], profile [ProfileName]
■
FAILURE, msg [ReasonForFailure], user [UserName], element
[ElementName], group [GroupName], platform [PlatformName],
rsm [RsmName], host [HostName], profile [ProfileName]
addElements: adding multiple elements
To add multiple elements, you must first list each element’s properties in a commaseparated value (CSV) file, using the following format, and then specify that file name
in the command:
HostName or IPAddress, [ElementDisplayName], ObjectGroupName, RsmName,
ElementProfileName, PlatformName
Figure 38 on page 226 contains an example of valid content for the CSV file.
Chapter 8 BMC Performance Manager Portal command-line interface
225
addElements: adding multiple elements
Figure 38
Sample CSV file for adding elements with bpmcli
computer1.acme.com,”My Computer”,”Windows Servers”,”Acme RSM”,”Windows Settings”,””
computer2.acme.com,Acme1,”UNIX Servers”,”Acme RSM”,”UNIX Settings”,”AIX”
computer3.acme.com,,”Windows Servers”,”Acme RSM”,”Windows Settings”,”Linux”
The following rules apply to the CSV file:
■
The file must contain the host name or IP address of each element.
■
If the file does not contain the element name, the bpmcli uses the host name or IP
address for the element name.
■
If the file does not contain the following properties, you must specify the missing
properties on the command line:
— group name
— RSM or RSM cluster name
— element profile name
— platform name
When you specify the property from the command line, that property applies to all
elements in the file.
■
Any value that you specify on the command line is superseded by an existing
value for the property in the CSV file.
■
If a property is specified in the command line and not in the file, the command-line
value is used.
■
If a required property is not specified at the command prompt or in the file, an
error message is displayed.
■
If you omit a property from the file, you must still include the comma delimiter for
that property, and the file must contain five commas. See Figure 38.
■
The bpmcli supports the following end-of-line terminators: \r, \n, and \n\r.
■
Files that contain multi-byte characters must be saved in UTF-8 format.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c addElements -platform PlatformName -f FileName
226
BMC Performance Manager Portal Monitoring and Management Guide
addElements: adding multiple elements
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 33 with the addElements command.
Table 33
addElements arguments for adding multiple elements
name of the CSV file that contains the element properties
-f CsvFileName
Files that contain multi-byte characters must be saved in
UTF-8 format.
-h ElementHostName
fully-qualified host name or IP address of the element
-ep ProfileName
name of an existing element profile
Enclose multiple-word profile names in quotation marks.
name of an existing RSM or RSM cluster to monitor the
elements (if not specified in the file)
-r RsmName
Enclose multiple-word RSM names in quotation marks.
-platform PlatformName
name of the platform as it appears in Table 32 on page 224
Enclose multiple-word platform names in quotation marks.
name of the existing object group to which the elements will
belong (if not specified in the file)
-g ObjectGroup
Enclose multiple-word object group names in quotation
marks.
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c addElements -platform AIX
-f NewElements.txt
Return messages
After execution of the command, the bpmcli returns one of the following messages
for each element specified in the CSV file, depending on whether the addition was
successful:
■
SUCCESS, msg [added element], user [UserName], element
[ElementName], group [GroupName], platform [PlatformName],
rsm [RsmName], host [HostName], profile [ProfileName]
■
FAILURE, msg [ReasonForFailure], user [UserName], element
[ElementName], group [GroupName], platform [PlatformName],
rsm [RsmName], host [HostName], profile [ProfileName]
Chapter 8 BMC Performance Manager Portal command-line interface
227
addPATROL
addPATROL
The addPATROL command initiates the process that adds elements to the Portal
based on a list of PATROL Agents that you specify in a CSV file. The PATROL
integration Performance Managers assigned to the elements are based on the KM
application classes found on the corresponding PATROL Agents. The Portal
synchronizes the thresholds for the newly added PATROL integration Performance
Managers with their corresponding values on the PATROL Agents.
Successful completion of this command means that the add operation was started on
the Portal. Successful completion of the command does not imply that the add
operation was completed on the Portal. When the add operation is complete on the
Portal, the Portal sends a summary report to each recipient identified by the -email
argument.
The CSV file is similar to that described in “Using a CSV file to discover PATROL
Agents” on page 37, but the addPATROL command requires slightly different
information, as follows:
■
The file must contain the host name, port number, and authentication (user name
and password or shared credential) for each PATROL Agent.
■
If the file does not contain the element name, the bpmcli uses the host name or IP
address for the element name.
■
The bpmcli supports the following end-of-line terminators: \r, \n, and \n\r.
■
Each row in the file must contain the comma-separated values in Table 34, in the
order listed.
Table 34
Values required for CSV input file for the addPATROL CLI command
Value
Description
element name (optional)
the element used in the Portal
This value cannot exceed 256 characters.
host name
the PATROL Agent host name or IP address
This value cannot exceed 256 characters.
port number
the PATROL Agent port number
user name or shared
credential
the user name used to log on to the PATROL Agent or the
name of a shared credential
This value cannot exceed 256 characters.
password
PATROL API Encrypted (PEM API) password
If you specify a shared credential instead of a user name, leave
this value blank. This value cannot exceed 256 characters.
228
BMC Performance Manager Portal Monitoring and Management Guide
addPATROL
By default, the Portal synchronizes the thresholds for all parameters that it discovers
for the specified elements. You can provide a list of parameters to exclude from the
synchronization process by updating the padm.properties file. See the
padm.migrate.threshold.update.exclude.list property on page 292 for more
information.
The following circumstances can cause an error:
■
insufficient rights: The specified user does not have Full Access rights to element
properties.
■
multiple synchronization processes: Another synchronization operation is already
in progress. By default, you can run only one synchronization operation
(addPATROL or refreshPATROL) at a time. To configure the Portal to enable
multiple synchronization operations, see the padm.migrate.locking property on
page 292.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c addPATROL -email “EmailAddresses” -f AgentFileName -r RSMName
-g ObjectGroupName
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 35 with the addPATROL command.
Table 35
addPATROL arguments (part 1 of 2)
Argument
Description
-f CsvFileName
name of the CSV file that contains the PATROL Agent
properties
Files that contain multibyte characters must be saved in UTF8 format.
-email
ListOfEmailAddresses
(optional) comma-separated list of email addresses enclosed
in quotation marks
If you include this argument, each user in the list receives an
email message, formatted in HTML, that contains the
Summary report that the Portal displays following PATROL
Agent discovery.
Chapter 8 BMC Performance Manager Portal command-line interface
229
deleteElements: deleting a single element
Table 35
addPATROL arguments (part 2 of 2)
Argument
Description
-r RsmName
name of an existing RSM or RSM cluster to monitor the
elements
Enclose multiple-word RSM names in quotation marks.
-g ObjectGroup
name of the existing object group to which the elements will
belong (if not specified in the file)
Enclose multiple-word object group names in quotation
marks.
Sample command
bpmcli -portal myportal.acme.com -login user -pass myPassword -c addPATROL
-f myElements.txt -g myGroup -r myRsm -email “[email protected],[email protected]”
Return message
After execution of the command, the bpmcli returns the following message:
PATROL add element process started
If an error occurs when attempting to start the add process, an error or warning
message is displayed.
When the add process is finished, a summary report is emailed to each recipient
identified in the -email argument. If problems were encountered with a particular
element, the email report contains an error description for each affected element.
deleteElements: deleting a single element
When deleting a single element, you must provide the element name for the element.
You cannot delete an element by specifying its host name or IP address.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c deleteElements -e ElementName
230
BMC Performance Manager Portal Monitoring and Management Guide
deleteElements: deleting multiple elements
Argument
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the argument in Table 35 on page 229 with the deleteElements command.
Table 36
deleteElements argument for deleting a single element
Argument
Description
-e ElementName
element to delete
Enclose multiple-word element names in quotation marks.
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c deleteElements -e MyElement
Return messages
After execution of the command, one of the following messages is displayed,
depending on whether the addition was successful:
■
SUCCESS, msg [deleted element], user [UserName], element
[ElementName]
■
FAILURE, msg [ReasonForFailure], user [UserName], element
[ElementName]
deleteElements: deleting multiple elements
To delete multiple elements, you must provide a CSV file that contains the element
name for each element to delete. The CSV file cannot contain host names or IP
addresses.
Figure 39
Sample CSV file for deleting elements with bpmcli
”My Computer”
Acme1
computer3.acme.com
The bpmcli supports the following end-of-line terminators: \r, \n, \n\r.
Chapter 8 BMC Performance Manager Portal command-line interface
231
refreshDatafeedMetadata
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c deleteElements -f FileName
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the argument in Table 37 with the deleteElements command.
Table 37
deleteElements argument for deleting multiple elements
Argument
Description
-f FileName
file that contains names of element to delete
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c deleteElements -f Elements.txt
Return messages
After execution of the command, the bpmcli returns one of the following messages
for each element in the CSV file, depending on whether the deletion was successful:
■
SUCCESS, msg [deleted element], user [UserName], element
[ElementName]
■
FAILURE, msg [ReasonForFailure], user [UserName], element
[ElementName]
refreshDatafeedMetadata
This command initiates the process that updates the Continuous Data Export (CDE)
metadata tables with new element and parameter data. The metadata tables include
the account name, element names, application classes, and parameters that
correspond to the data exported by the Continuous Data Export utility, described on
page 172. Run this command as often as necessary to keep the metadata tables current
with the Portal.
TIP
To ensure that you capture all changes, run a nightly script that executes this command.
232
BMC Performance Manager Portal Monitoring and Management Guide
refreshDatafeedMetadata
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login adminName -pass
adminPassword
-c refreshDatafeedMetadata
To execute the refreshDatafeedMetadata command, you must provide credentials for a
Portal administrator.
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the argument in Table 38 with the refreshDatafeedMetadata command.
Table 38
deleteElements argument for deleting multiple elements
Argument
Description
-abort
stops the active refresh operation
-status
returns information about the progress of the current refresh
operation
Sample commands
■
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin
-c refreshDatafeedMetadata
■
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin c refreshDatafeedMetadata -abort
■
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin
-c refreshDatafeedMetadata -status
Return messages
After execution of the command, the bpmcli returns the following message:
Request submitted. Run "-c refreshDatafeedMetadata -status" to get
updates on the progress.
Chapter 8 BMC Performance Manager Portal command-line interface
233
refreshPATROL
After execution of the command with a -abort argument, the bpmcli returns the
following message:
====================================================================
Datafeed Target: DB: jdbc:oracle:thin:@south-a2f.bmc.com:1521:BMCPDS
USER: DATAFEED_USER TABLE: DATAFEED_USER.PARAMETER_DETAIL
====================================================================
Status:
Aborted
Process start:
4/12/07 5:28:33 PM CDT
Process end:
4/12/07 5:28:33 PM CDT
Number of accounts processed: created: 0 updated: 2
Number of elements processed: created: 0 updated: 4
Number of applications processed: created: 0 updated: 12
Number of parameters processed: created: 0 updated: 35
====================================================================
After execution of the command with a -status argument, the bpmcli returns the
following message:
====================================================================
Datafeed Target: DB: jdbc:oracle:thin:@south-a2f.bmc.com:1521:BMCPDS
USER: DATAFEED_USER TABLE: DATAFEED_USER.PARAMETER_DETAIL
====================================================================
Status:
Completed
Process start:
4/12/07 5:28:33 PM CDT
Process end:
4/12/07 5:28:33 PM CDT
Number of accounts processed: created: 0 updated: 2
Number of elements processed: created: 0 updated: 4
Number of applications processed: created: 0 updated: 12
Number of parameters processed: created: 0 updated: 35
====================================================================
Depending on the status of the utility, the return message could contain one of the
following status values:
■
■
■
Completed
In progress
Failed
refreshPATROL
The refreshPATROL command initiates the process that synchronizes application
classes and threshold values between PATROL integration Performance Managers
and their corresponding PATROL Agents.
Successful completion of this command means that the refresh operation was started
on the Portal. Successful completion does not imply that the synchronization
operation was completed successfully.
234
BMC Performance Manager Portal Monitoring and Management Guide
refreshPATROL
When issuing the refreshPATROL command, you can specify a text file that contains
a list of the element names to process. If you do not specify a file, the command
attempts to synchronize every element to which a PATROL integration Performance
Manager has been assigned. If you specify an email address, you can also request a
Summary report, which contains the detailed status about the threshold
synchronization.
The following rules apply to data synchronization:
■
You cannot run this command if the Portal is in the process of a synchronization
process that was initiated from the UI (Refresh PATROL Integration).
■
During synchronization that was initiated from the refreshPATROL command,
you cannot use the UI to initiate another synchronization process.
■
If two users initiate concurrent refreshPATROL processes, both processes will run.
By default, the Portal refreshes the thresholds for all parameters that it discovers for
the specified elements. You can provide a list of parameters to exclude from the
refresh process by updating the padm.properties file. See the
padm.migrate.threshold.update.exclude.list property on page 292 for more
information.
The following rules apply to the file:
■
The file must contain the host name or IP address of each element.
■
If the file does not contain the element name, the bpmcli uses the host name or IP
address for the element name.
■
The bpmcli supports the following end-of-line terminators: \r, \n, and \n\r.
The following circumstances can cause an error:
■
insufficient rights: The specified user does not have full-access rights to element
properties.
■
multiple synchronization processes: This error occurs only if you disable multiple
synchronization operations. By default, you can run multiple synchronization
operations at a time (addPATROL or refreshPATROL). To configure the Portal to
enable only one synchronization operation at a time, see “padm.migrate.locking”
on page 292.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c refreshPATROL -email “EmailAddresses” -f ElementFileName
Chapter 8 BMC Performance Manager Portal command-line interface
235
refreshPATROL
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 39 with the refreshPATROL command.
Table 39
refreshPATROL arguments
Argument
Description
-email ListOfEmailAddresses (optional) comma-separated list of email addresses, enclosed
in quotation marks
If you include this argument, each user in the list receives an
email message, formatted in HTML, that contains the
Summary report that the Portal displays following threshold
synchronization.
-f FileName
(optional) UTF-8 file that contains a list of the element names
to synchronize, one element per line
Use this option to limit the elements synchronized to those
listed in the file. Otherwise, the command synchronizes all
elements on which PATROL integration Performance
Managers are collecting parameter values.
For any invalid element names, an error is included in the
Summary report.
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c refreshPATROL -email
“[email protected],youremail.acme.com” -f elements.txt
Return message
After execution of the command, the bpmcli returns the following message:
PATROL threshold refresh started
If an error occurs when the command attempts to start the refresh process, an error or
warning message is displayed.
When the synchronization process is finished, a summary report is emailed to each
recipient identified in the -email argument. If problems were encountered with a
particular element, the email report contains an error description for each affected
element.
236
BMC Performance Manager Portal Monitoring and Management Guide
savePassword
savePassword
The savePassword command saves the user password in an encrypted file
(bpmcli.pw) on the client computer, in the directory where you placed the bpmcli.jar
file. The bpmcli.pw file can store a single password for different users, and subsequent
use of the savePassword command for the same user overwrites the existing saved
password.
After using this command to save the bpmcli.pw file, you can omit the -pass password
argument when you use the corresponding user name to execute other bpmcli
commands. The savePassword command has no additional arguments.
Observe the following rules for using the bpmcli.pw file:
■
■
■
You can use a saved bpmcli.pw file on the computer on which it was created.
You can move the bpmcli.pw file to a different directory on the same computer.
If you copy the bpmcli.pw file to another computer, you cannot use the passwords
that you saved from the original computer.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c savePassword
Arguments
This command uses only the basic bpmcli arguments shown in Table 30 on page 221.
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c savePassword
Return messages
After execution of the command, the bpmcli returns one of the following messages,
depending on whether the command was successful:
■
■
saved password for userName
ERROR: failed to save password for userName
command: -c savePassword -login UserName -pass password
Chapter 8 BMC Performance Manager Portal command-line interface
237
Data-extraction commands
Data-extraction commands
The commands in this section enable you to retrieve data from the database. Many of
these commands depend on the return values of another command for their
arguments.
EXAMPLE
To retrieve parameter history values, you must first execute the getElements,
getApplicationsForElement, and getSubApplications commands to retrieve the GUIDs
necessary to run the subsequent commands, as illustrated in Figure 40. The first line in each
group is the command; the second line contains the returned values, and the arrows show
where the returned value is used in the subsequent command.
Figure 40
Using data-extraction commands to retrieve input arguments for subsequent commands
Users that are members of the Full Access or Read Only user group can access the
data-extraction commands. Users who are members of only user-defined user groups
cannot run the bpmcli commands.
238
BMC Performance Manager Portal Monitoring and Management Guide
Data-extraction commands
EXAMPLE
To retrieve the value for the CPU Usage parameter, issue commands similar to the following
scenario:
1. Type the following command to retrieve the GUID for the elements on the Portal:
bpmcli -login user -pass user -portal myportal.acme.com -c getElements
The following result is returned:
"mickey","x0et6qwx2u612","mickey.acme.com","Solaris","null","null"
2. Using a GUID that was returned from the previous command, type the following
command to retrieve the GUIDs for the top-level applications on the element:
bpmcli -login user -pass user -portal myportal.acme.com -c getApplicationsForElement
-guid x0et6qwx2u612
The following result is returned:
"dr2al_solaris_cmdshell_base","1aaaaZZZZml4","null","1aaaaZZZZml4","null"
3. Using a GUID that was returned from the previous command, type the following
command to retrieve the GUIDs for the child applications in the application class:
bpmcli -login user -pass user -portal myportal.acme.com
-c getSubApplications -guid 1aaaaZZZZml4
The following result is returned:
"1aa9wr8228bq","Processors","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228b0","CPU","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228c2","Data Storage","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228bi","Memory","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228c1","Paging","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228cv","Swap","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228bn","Network","1aa9wr8228ax","1aa9wr8228ax","null"
"1aa9wr8228dc","System Performance","1aa9wr8228ax","1aa9wr8228ax","null"
4. Using a GUID that was returned from the previous command, type the following
command to retrieve the parameters for the application class:
bpmcli -login user -pass user -portal myportal.acme.com -c getParameters -guid
1aa9wr8228b0
The following result is returned:
"1aaaaZZZZml41Og8On640f49wr8228ay","CPU usage",
"1aaaaZZZZml41Og8On640f49wr8228b0","0.0","OK"
Chapter 8 BMC Performance Manager Portal command-line interface
239
exportParameterHistory
In addition to the syntax for each bpmcli command, Table 40 lists the data-extraction
commands and the order in which they must be executed. Some of the commands
have no dependencies on other commands and no other commands have any
dependencies on them for extracting data from the database.
Table 40
Data-extraction bpmcli commands
Order of
Execution Syntax
Command
Page
NA
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c exportParameterHistory -startDate
"yyyy/mm/dd hh:mm:ss"
240
getApplicationsForElement
2
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c getApplicationsForElement -guid
ElementGuid
244
getElements
1
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c getElements
245
getParameterHistory
5
bpmcli -portal PortalWebServerName -p PortNumber
-login adminName -pass adminPassword
-c getParameterHistory -guid ParameterGuids -minutes
MinutesOfHistory -summarize
246
getParameters
4
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c getParameters -guid
ApplicationClassGuid
249
NA
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c getPortalVersion
250
3
bpmcli -portal PortalWebServerName -p PortNumber -login
UserName
-pass UserPassword -c getSubapplications -guid
ApplicationClassGuid
251
exportParameterHistory
getPortalVersion
getSubApplications
exportParameterHistory
This data extraction command runs the Historical Data Export utility, which
complements the Continuous Data Export utility (CDE, which is described on
page 172). The Continuous Data Export utility continuously writes specified raw
parameter values to an external database. For each parameter in the external
database, the exportParameterHistory command exports historical summarized data
to the same external database.
240
BMC Performance Manager Portal Monitoring and Management Guide
exportParameterHistory
NOTE
You can also configure the Historical Data Export utility to run in the absence of a CDE
database instance. To configure the exportParameterHistory and refreshDatafeedMetadata
commands to run without a CDE database instance, see “Alternate configuration settings for
Historical Data Export commands” on page 243.
EXAMPLE
You might run the exportParameterHistory command in the following scenarios:
■
On February 1, you begin using the Portal to monitor your infrastructure. On June 1, you
configure the Portal to continuously export raw data values to an external database. To
populate the external database with the historical data values between February 1 and
June 1, you run the exportParameterHistory command.
■
On February 1, you begin using the Portal to monitor your infrastructure. You also
configure the Portal to continuously export raw data values for selected parameters to an
external database. On June 1, you modify the Continuous Data Export utility to export
additional parameters to the external database. To capture parameter data values for the
newly specified parameters, you run the exportParameterHistory command.
You cannot use the exportParameterHistory command to fill in data gaps. The
exportParameterHistory command looks for the oldest data point in the external
database and compares it with the start date. The utility adds summarized data
values to the external database until it finds parameter data. If the Historical Data
Export finds data at the start date, it will end. As illustrated in Figure 41, if you
specify January 1 as the start date and the utility finds data values for January 10, the
utility adds summarized values for January 1 to January 10, and then ends.
Figure 41
How the Historical Data Export utility uses the startData argument
January 1
June
The utility does not add data for these gaps.
If you specify January 1 to fill in the data gaps, the utility will stop when it finds data.
Period with data
Period without data
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c exportParameterHistory -startDate "yyyy/mm/dd hh:mm:ss"
To execute the exportParameterHistory command, you must provide credentials for a
Portal administrator.
Chapter 8 BMC Performance Manager Portal command-line interface
241
exportParameterHistory
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 41 with the exportParameterHistory command.
Table 41
exportParameterHistory arguments
Arguments
Description
-startDate dataStartDate
start date on which to synchronize historical data for all
parameters in the external database
Use the following format to specify the date and enclose the
date in quotation marks:
“yyyy/mm/dd hh:mm:ss”
The argument uses the time zone of the Portal administrator
who is executing the command.
-abort
stops the active export operation
-status
returns information about the progress of the current export
operation
Sample commands
■
The following command exports historical data, beginning at February 1, 2007:
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin
-c exportParameterHistory -startDate "2007/02/01 00:00:00"
■
The following command aborts the current export operation:
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin
-c exportParameterHistory -abort
■
The following command returns information about the current data export
operation:
bpmcli -portal myportal.acme.com -login superadmin -pass superadmin
-c exportParameterHistory -status
Return messages
If you did not configure the datafeed.properties file, the following message is returned:
No external datasource configuration files found!
242
BMC Performance Manager Portal Monitoring and Management Guide
exportParameterHistory
After execution of the command with a -status argument, the bpmcli returns a
message similar to the following example:
===============================================================
Status:
In progress
Process start:
2/20/07 5:02:12 PM CST
Process end:
2/20/07 5:02:27 PM CST
Number of parameters processed:
1 of 3
Number of data points processed:
0 of 43
===============================================================
Depending on the status of the utility, the return message could contain one of the
following status values:
■
■
■
■
Aborted
Completed
In progress
Failed
Alternate configuration settings for Historical Data Export
commands
The exportParameterHistory and refreshDatafeedMetadata commands update the
CDE database instance with historical parameter data. These commands process the
parameters that are defined by the ParameterDefinitionName property. For more
information about this property, see “To configure a target database” on page 179.
Use the following procedure to configure the utility scripts to run these commands to
run in the absence of a CDE database instance.
To configure the utility scripts to run Historical Data Export commands without
a CDE database instance
1 In your JDBC target property file, comment out the
DB.TABLE.NAME=PARAMETER_DETAIL property, as shown in the following
example:
# Table used for Continuous Data Extract
#DB.TABLE.NAME=PARAMETER_DETAIL
2 Ensure that the SUMMARYTABLE property is configured with default values, as
shown in the following example:
# Table used for Historical Data Extract
DB.SUMMARYTABLE.NAME=PARAMETER_SUMMARY
Chapter 8 BMC Performance Manager Portal command-line interface
243
getApplicationsForElement
3 If you changed the values for the thread and connection pool sizes, change them to
the following default values:
■
■
portal.datafeed.threadpool.size=10
DB.BATCHSIZE=1000
4 Restart the Portal application server.
getApplicationsForElement
This data extraction command returns the application classes and corresponding
GUIDs for each top-level application class on an element. The command does not
return the entire hierarchy for the application classes.
NOTE
Do not use the -q (quiet) argument when executing a data extraction command; otherwise, the
command returns nothing.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName
-pass UserPassword -c getApplicationsForElement -guid ElementGuid
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the argument in Table 42 with the getApplicationsForElement command.
Table 42
getApplicationsForElement argument
Argument
Description
-guid guid
GUID for the infrastructure element
Sample command
bpmcli-portal myportal.acme.com -login user -pass user -c getApplicationsForElement
-guid E4smxqZZZE0FxkA8o2z60erunkhzz0wy
244
BMC Performance Manager Portal Monitoring and Management Guide
getElements
Return messages
After successful execution of the command, the bpmcli returns the following message
for each top-level application class on the element:
"InternalApplicationClassName","ApplicationClassGuid",
"ParentApplicationClassGuid","RootApplicationClassGuid",
"ReconciliationId"
■
The value RootApplicationClassGuid will equal that of ApplicationClassGuid.
■
Because this command returns the top-level application class, the value for
ParentApplicationClassGuid will be null.
■
Ping, Microsoft SQL Server, and Unix Process–Using Command Shell are
examples of InternalApplicationClassName.
If an error occurs, one of the following messages is returned:
========================================================
ERROR:
Element: 'Guid' does not exist or does not belong to this account.
==============================================================
========================================================
ERROR:
BMC-MOP10001E:Authentication failed for user <user name>.
==============================================================
getElements
This data extraction command returns the names for all elements in the account of the
user executing the command.
You can limit the results of the command by using standard operating system
commands to filter the results. For example, in Figure 40 on page 238, grep is piped
through the getElement command to limit the results to a specific element.
NOTE
Do not use the -q (quiet) argument when executing a data extraction command; otherwise, the
command returns nothing.
Chapter 8 BMC Performance Manager Portal command-line interface
245
getParameterHistory
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass UserPassword
-c getElements
Arguments
This command uses only the basic bpmcli arguments shown in Table 30 on page 221.
Sample command
bpmcli -c getElements -portal myportal.acme.com -login user -pass user
Return messages
After successful execution of the command, the bpmcli returns the following message
for each element in the account:
"ElementName","ElementGuid","ElementHostName",
"ElementOperatingSystem","ElementProfileName","ReconciliationId"
If an error occurs, the following message is returned:
===================================================================
ERROR:
BMC-MOP10001E:Authentication failed for user <user name>.
===================================================================
getParameterHistory
This data extraction command returns parameter history for the specified parameters.
■
If you specify the -summarize argument, the command returns available
summarized data values for the specified number of minutes.
— Raw data is summarized at 30-minute intervals on the hour and half hour.
Should you request summarized data at 11:42 A.M., the return message contains
data points for the summarized points and a point that summarizes the last 12
minutes of raw data.
— If you want to compare the summarized return data with the parameter history
table, specify at least 24 hours in the parameter history table.
246
BMC Performance Manager Portal Monitoring and Management Guide
getParameterHistory
■
If you do not specify the -summarize argument, the command returns raw data
values for the specified number of minutes.
NOTE
Do not use the -q (quiet) argument when executing a data extraction command; otherwise, the
command returns nothing.
If the value specified in the -minutes argument spans more data than the amount
actually stored in the Portal database for the parameter, the command returns all the
available data and does not return an error message. This condition can occur for new
parameters or when you request data for a period that exceeds the retention period.
Depending on when you run this command, the amount of summarized data
returned by the command might be less than you expected.
See “Retention policies” on page 137 and “Data summarization” on page 136 for
more information about how the Portal summarizes and retains data.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass
UserPassword
-c getParameterHistory -guid ParameterGuids -minutes MinutesOfHistory -summarize
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 43 with the getParameterHistory command.
Table 43
getParameterHistory arguments
Argument
Description
-minutes MinutesOfHistory
number of minutes of parameter history data to return
-guid ParameterGuids
list of parameter GUIDs
To specify more than one parameter, separate the GUIDs
with commas and enclose the entire argument in "".
-summarize
returns summarized data
If you do not specify this argument, the command returns
raw data values.
Chapter 8 BMC Performance Manager Portal command-line interface
247
getParameterHistory
Sample commands
The following command retrieves summarized parameter history for the previous 48
hours for three parameters:
bpmcli -portal myportal.acme.com -login user -pass user -c getParameterHistory -guid
"D5c4o05ZZKa89m12sin50esmep9qr0pn, D5c4o05ZZKa89m12sin50esmep9qr0pp,
D5c4o05ZZKa89m12sin50esmep9qr0pl" -minutes 2880 -summarize
The following command retrieves raw parameter history data for the previous 48
hours for three parameters:
bpmcli -portal myportal.acme.com -login user -pass user -c getParameterHistory -guid
"E4smxqZZZE0FxkA8o2z60erunkhzz0wy, E4smxqZZZE0FxkA8o2z60erimlhzz0yd,
E4smxqZZZE0FxkA8o2z60erybjhzz0zz" -minutes 2880
Return messages
Commands that specify the -summarize argument return fewer data points than
commands that do not specify the -summarize argument. If you specify a GUID that
does not have any history data, the bpmcli does not provide a return message for the
corresponding parameter.
After successful execution of the command, the bpmcli returns the following message
for each parameter:
“ParameterGuid”,”NumberOfDataPoints”,”TimestampForDataPoint1”,”ValueF
orDataPoint1”,”TimestampForDataPoint2”,”ValueForDataPoint2”,…
The TimestampForDataPoint2 is the UNIX Epoch (the number of milliseconds
since January 1, 1970 00:00:00 GMT) for the value that was measured by the RSM or
summarized by the Portal.
EXAMPLE
"D5c4o05ZZKa89m12sin50esmep9qr0pp","6","1159405200000","1.0","1159408800000"
,"1.0","1159412400000", \
"1.0","1159416000000","1.0","1159419600000","1.0","1159452000000","1.0"
"D5c4o05ZZKa89m12sin50esmep9qr0pn","6","1159405200000","0.0","1159408800000"
,"0.0","1159412400000", \
"0.0","1159416000000","0.0","1159419600000","0.0","1159452000000","0.0"
"D5c4o05ZZKa89m12sin50esmep9qr0pl","6","1159405200000","1.0","1159408800000"
,"1.0","1159412400000", \
"1.0","1159416000000","1.0","1159419600000","1.0","1159452000000","1.0"
248
BMC Performance Manager Portal Monitoring and Management Guide
getParameters
When the command specifies an invalid GUID, an error message is returned for the
parameter:
"InvalidGuid","0","Unknown parameter
getParameters
This data extraction command returns the parameters for the specified application
class or subapplication class.
NOTE
Do not use the -q (quiet) argument when executing a data extraction command; otherwise, the
command returns nothing.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass
UserPassword
-c getParameters -guid ApplicationClassGuid
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the argument in Table 44 with the getParameters command.
Table 44
getParameters argument
Argument
Description
-guid guid
GUID for the application or subapplication class
Sample command
bpmcli -portal myportal.acme.com -c getParameters -login user -pass user
-guid C4smw5cZZB1naz8D 6nC80er5bzbij05z
Chapter 8 BMC Performance Manager Portal command-line interface
249
getPortalVersion
Return messages
After successful execution of the command, the bpmcli returns the following message
for each parameter in the specified application class:
"ParameterGuid","ParameterDisplayName","ParentAppGuid",
"ParameterValue","ParameterStatus"
Table 45 shows the returned value for the ParameterStatus and its corresponding
status.
Table 45
Parameter status values
Returned value
Status
websdk.status.ok
OK
websdk.status.off
Monitoring Off
websdk.status.blackout
Blackout
websdk.status.unknown
Unknown
websdk.status.warning
Warning
websdk.status.critical
Critical (alarm)
If an error occurs, the following message is returned:
====================================================================
ERROR:
Application: 'Guid' does not exist or does not belong to this account.
====================================================================
getPortalVersion
The getPortalVersion command returns the version number of the BMC Performance
Manager Portal module on the specified BMC Portal.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass
UserPassword
-c getPortalVersion
250
BMC Performance Manager Portal Monitoring and Management Guide
getSubApplications
Arguments
This command uses only the basic bpmcli arguments shown in Table 30 on page 221.
Sample command
bpmcli -portal myportal.acme.com -login user -pass user -c getPortalVersion
getSubApplications
This data extraction command returns the child classes (subapplications) in the
specified application class or subapplication.
Syntax
bpmcli -portal PortalWebServerName -p PortNumber -login UserName -pass
UserPassword
-c getSubApplications -guid ApplicationClassGuid
Arguments
In addition to the basic bpmcli arguments shown in Table 30 on page 221, you can use
the arguments in Table 46 with the getSubApplications command.
Table 46
getSubApplications argument
Argument
Description
-guid guid
GUID for the application or subapplication class
Sample command
bpmcli -portal myportal.acme.com -c getSubApplications -login user -pass user -guid
C4smw5cZZB1naz8D 6nC80er5bzbij05z
Return messages
After successful execution of the command, the bpmcli returns the following message
for each subapplication in the specified application class or subapplication:
"SubApplicationGuid","SubApplicationDisplayName",
"ParentApplicationClassGuid","RootApplicationClassGuid",
"ReconciliationId"
Chapter 8 BMC Performance Manager Portal command-line interface
251
getSubApplications
NOTE
If the parent application class on the element has not been reconciled in the BMC Atrium
CMDB at the time that the command is executed, the value for ReconciliationId is null.
If an error occurs, the following message is returned:
====================================================================
ERROR:
Application: 'Guid' does not exist or does not belong to this account.
====================================================================
252
BMC Performance Manager Portal Monitoring and Management Guide
Appendix
A
BMC Performance Manager Portal
troubleshooting and FAQs
A
This appendix describes how to diagnose and fix monitoring problems, presenting
the following topics:
Monitoring problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSM computers running Windows require permission changes . . . . . . . . . . . . . . . .
RSM upgrade fails on Windows 2003 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When you use Management Profiles to integrate data, Console Server list is
empty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reinstalling the application server component of the Portal . . . . . . . . . . . . . . . .
Specifying RTservers for the BMC Performance Manager Portal . . . . . . . . . . . .
Changing the security for the BMC Performance Manager Portal . . . . . . . . . . .
Cannot find errors when data discovery runs as a background process. . . . . . . . . .
PATROL integration error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Crystal Reports Server troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error message in Crystal Reports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report does not contain expected data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Checking log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Frequently asked questions (FAQs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
253
254
255
256
256
256
257
258
258
259
259
260
261
262
Monitoring problems
Monitoring problems can occur because
■
configuration prerequisites on the monitored elements have not been met for a
particular application class
■
configuration prerequisites have not been met on the RSM for a particular
application class
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
253
RSM computers running Windows require permission changes
■
the RSM cannot communicate with the Portal
■
the RSM has stopped monitoring its assigned elements
The Help provides information about the prerequisites for the target elements and the
RSM computers. Also, the Help provides troubleshooting assistance for all collectors.
For information about monitoring the health and availability of the Portal, see
Appendix B, “Monitoring the health of the Portal” on page 253.
The Portal Monitoring application or other JMX based collectors i.e. JBoss Solution,
they get this error in the application collection status: patsdk-bpm-monsolution.dr1we_prm.timeoutException:bpm-mon-prod-wmi-process Problems
connecting to host ciz-adam-rsm2:9779: (JMX Paramlet)
RSM computers running Windows require
permission changes
If you installed the RSM program on a computer running Windows 2003 SP1 and that
RSM will use the PerfMon collector to monitor its elements, use regedit32 to add a
permission to those target computers, as described in the following procedures.
To update the registry key on a target Windows 2000 computer
1 Highlight the following Perflib key, and from the main menu, choose
Security => Permissions:
\HKEY_LOCAL_MACHINE\Software\Microsoft\Windows
NT\CurrentVersion\Perflib
2 Verify that the NETWORK service is present and has Read access.
By default, the permission applies to this key and all its subkeys.
The PerfMon collectors begin collecting data during the next collection cycle.
254
BMC Performance Manager Portal Monitoring and Management Guide
RSM upgrade fails on Windows 2003 SP1
To update the registry key on a target Windows 2003 or Windows XP computer
1 Highlight the following Perflib key, right-click the key, and select Permissions:
\HKEY_LOCAL_MACHINE\Software\Microsoft\Windows
NT\CurrentVersion\Perflib
2 Verify that NETWORK SERVICE is present and that it has Read access to this key.
By default, the permission applies to this key and all its subkeys.
The PerfMon collectors begin collecting data during the next collection cycle.
RSM upgrade fails on Windows 2003 SP1
If you installed the RSM program on Windows 2003 SP1 computers without
preparing them as described in “Data execution prevention (DEP) configuration for
the RSM” on page 76 and in the BMC Portal Installation Guide, the installation
failed. However, you can configure DEP and rerun the RSM installation program after
the Portal upgrade if you perform following procedure.
To add the Remote Service Monitor program to DEP
1 On the RSM computer, select Start => Settings => Control Panel.
2 On the Control Panel, select System.
3 On System Properties, click the Advanced tab, and under Performance, click
Settings.
4 On Settings, click Advanced.
5 On the Data Execute Prevention tab, click Add, and select
C:\Windows\temp\rsminstall.exe, and click Open.
6 Click OK until you exit the Control Panel.
7 Restart the RSM computer.
After the computer restarts, the auto upgrade begins for the RSM program.
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
255
When you use Management Profiles to integrate data, Console Server list is empty
When you use Management Profiles to
integrate data, Console Server list is empty
If you are integrating PATROL data by specifying a Management Profile, the Portal
must be configured to access an RTserver. If you did not configure RTserver access
during installation, the Console Server list is empty. Use one of the following methods
to configure RTservers and PATROL security.
Reinstalling the application server component of the Portal
You can configure the RTserver for the Portal by reinstalling the application server
component of the Portal.
To reinstall the application server component of the Portal
1 Using the upgrade procedures described in the BMC Portal Installation Guide,
run the installation program on the Portal computer (or Portal application server),
and select the BMC Performance Manager Portal.
The installation program displays the values that it saved in the installation log
file.
2 When prompted for whether you want the Portal to discover PATROL Agents,
change the selection to Yes, and select Next.
3 Follow the remaining instructions, and provide the name of the RTserver and the
security level for the PATROL Agents.
4 Unless you need to make any other changes, click Next until you reach the end of
the installation program, and then click Finish to start upgrading the changes for
the RTserver.
Specifying RTservers for the BMC Performance Manager
Portal
If you want to discover PATROL Agents and parameter thresholds from a PATROL
Central environment but you did not specify an RTserver during Portal installation,
use one of the following procedures to configure an RTserver for the BMC
Performance Manager Portal.
256
BMC Performance Manager Portal Monitoring and Management Guide
Changing the security for the BMC Performance Manager Portal
To specify RTservers in Windows
1 Locate the system environment variables.
2 Add the RTSERVERS variable and set it to the locator string (for example,
tcp:MyHost:2059,tcp:YourHost:2059).
The Portal can access only one RTserver at a time, but the order in which you list
RTservers establishes a failover priority.
3 Restart the BMC Portal Windows service.
To specify RTservers in Solaris
1 In the following directory, open run.sh:
InstallationDirectory/appserver/websdk/bin/
2 On any line after the first line in the file, add the following lines:
RTSERVERS=tcp:RtServer.domain.com:2059
export RTSERVERS
3 Save the file and restart the BMCPortalAppserver process.
Changing the security for the BMC Performance Manager
Portal
If you did not specify a security level during installation, the installation program
assigned security level 0 (the default level) to the BMC Portal (and BMC Performance
Manager Portal). If you want the Portal to discover agents of a different security level,
you must change the default security assigned for the Portal. In the BMC Portal
Getting Started guide, see the information about changing the security level after
installation.
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
257
Cannot find errors when data discovery runs as a background process
Cannot find errors when data discovery runs
as a background process
When you are using the PATROL Integration option to discover PATROL Agents and
their thresholds, the Summary page lists any errors that occurred during discovery.
Because of the lengthy discovery process, you can access other tabs in the Portal while
the Portal continues discovering the data in a background process; however, when
you navigate to other pages in the Portal, you cannot access the Summary page to see
if the Portal encountered any errors, but you can access the portal.log file, located in
the following directory:
■
■
(Windows) %BMC_PORTAL_KIT%\appserver\websdk\tools\jboss\server\all\log
(Solaris) $BMC_PORTAL_KIT/appserver/websdk/tools/jboss/server/all/log
PATROL integration error messages
You might encounter problems when using the PATROL Integration option to discover
PATROL Agents and their thresholds. Table 47 lists the error messages that you might
see on the user interface or in the log files and provides some instructions for
handling the error or problem.
Table 47
258
Error messages for PATROL integration
Message
Action to take
Cannot connect to agent name,
invalid user name or password,
or denied by agent ACL
Verify that you provided the correct credentials
and that the agent ACL allows the specified user to
connect with PEM authorization.
Cannot connect to agent name,
check the hostname and port
number is right and agent is
running. And the security
level of agent is the same as
RSM.
Verify that you provided the correct credentials
and that the agent ACL allows the specified user to
connect with PEM authorization.
Cannot connect to agent name,
cannot encrypt password
Contact BMC Software Customer Support.
Cannot connect to agent name,
invalid host name
The Portal cannot find the specified host. Ensure
that the host is listed in the hosts file or in DNS.
Ping the host and the PATROL Agent and port.
The rempadm process is down
Verify that the padmr-mbean.par file is included in
the RSM deployment.
Timeout when trying to talk
with remote padm
Using the JMX console, increase the timeout or
reduce the workload on the PATROL Agent. If
these actions do not resolve the problem, contact
BMC Software Customer Support.
BMC Performance Manager Portal Monitoring and Management Guide
Crystal Reports Server troubleshooting
Crystal Reports Server troubleshooting
This section provides troubleshooting information for enterprise reporting.
Error message in Crystal Reports Server
When you try to view a report, you may receive the following error message:
Maximum processing time or maximum records limit reached.
This problem occurs when the Crystal Reports Page Server and Report Application
Server (RAS) return the default maximum of 20,000 records.
Use the following procedures to increase the maximum number of records:
To configure the page server
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Java
Administration Launchpad.
2 Click the Central Management Console link.
3 Log on to the Central Management Console as an administrator.
4 Click Servers, and then click Crystal Reports Page Server.
5 On the Properties tab, change the Database Records To Read When Previewing Or
Refreshing a Report option to Unlimited.
6 Click Update.
7 Restart the Crystal Reports Page Server service.
To configure the RAS server
1 Choose Start =>Programs => Business Objects =>Crystal Reports Server => Central
Configuration Manager.
2 Click Report Application Server, and then click Stop.
3 Right-click Report Application Server, and then choose Properties.
The Report Application Server Properties dialog box opens.
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
259
Report does not contain expected data
4 On the Parameters tab, in the Option Type list, click Database.
5 Under Max Number Of Records, click Unlimited.
6 Click OK to close the dialog box.
7 Restart the Crystal Report Application Server service.
Report does not contain expected data
If the report contains no data or does not contain data from the latest reporting
period, perform the following troubleshooting steps:
■
Confirm that BMC Performance Manager components listed in Table 21 on
page 168 are collecting data in the Portal.
■
Confirm that the report date and time that you selected are within the CDE
database retention period. For more information, see Chapter 7 of the BMC
Performance Manager Portal Monitoring and Management Guide.
■
If the elements that you selected for the report were added to the Portal recently,
confirm that the RefreshDatafeedMetadata command is successfully executed. For
more information, see Chapter 7 of the BMC Performance Manager Portal
Monitoring and Management Guide.
■
Perform the procedure in “To refresh the list of values for Account/Elements
selection lists” on page 162.
■
Confirm that the Central Management Server service is running
(Start => Programs => Administrative Tools => Services).
■
Use the Central Configuration Manager to confirm that other Crystal Reports
services are running (Start => Programs => Business Objects => Crystal Report
Server => Central Configuration Manager).
■
Check the connectivity between Crystal Reports Server and the CDE database, as
described in “To confirm connectivity between Crystal Reports Server and the
CDE database.”
■
Check the DROCR_BPMAccountElements list of values, as described in “To check
the DROCR_BPMAccountElements list of values” on page 261.
To confirm connectivity between Crystal Reports Server and the CDE database
1 Log on to Crystal Reports.
2 In the Business View Manager, expand the BMC_PM folder, and then double-click
DROCR_BPMConnection.
260
BMC Performance Manager Portal Monitoring and Management Guide
Checking log files
3 Confirm that the following information is correct:
■
■
■
connection string, as described in step 9 on page 162
user name
password
NOTE
The password is not visible. You must re-enter the password to confirm that it is correct.
4 Click the Test Connectivity button.
To check the DROCR_BPMAccountElements list of values
1 Start the Crystal Reports Business View Manager.
2 In the Business View Manager, expand the BMC_PM folder, and then double-click
DROCR_BPMAccountElements.
3 Click Clear Instance.
The Clear Instance button becomes unavailable.
4 Confirm that the Schedule Status field contains the following message:
There is no scheduled List of Values instance. This list of values
executes on demand.
If this message does not appear, contact BMC Software Customer Support.
Checking log files
Some problems can be diagnosed by checking log files.
■
Check the Windows Event Logs for events with a source that begins with
“BusinessObjects_” (for example, BusinessObjects_CMS).
■
Create a log file to troubleshoot the Crystal Reports Import Wizard. Search the
Crystal Reports Support site for Knowledge Base article 6492639.
■
Check the Crystal Reports Server logging directory: C:\Program Files\Business
Objects\BusinessObjects Enterprise vv.r\Logging.
The directory path may have been changed during installation.
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
261
Frequently asked questions (FAQs)
Frequently asked questions (FAQs)
The following are questions frequently posed by customers with regard to
performance and scaling, and how the estimates provided by the BMC Performance
Manager Portal Performance and Scalability Guidelines Installation Notes.
What is the impact on the scale estimates if Continuous
Data Export (CDE) is used?
CDE is designed to put minimum impact on the Portal. The CDE database should
have a configuration equivalent to the Portal database.
Can I deploy fewer RSM computers than recommended?
The actual number of RSMs necessary for your environment might vary based on the
actual hardware configuration, number of elements and parameters, and activity in
your environment.
For a new installation, as you add managed servers, compare the actual parameter
counts observed in your environment to the original estimates to adjust the RSM
counts as necessary.
Does having remote offices affect the number of RSM
computers required?
Yes. Remote monitoring across a WAN is generally not recommended (though it is
possible in limited situations). Therefore, you will likely need at least one RSM for
each remote location. Keep the RSM estimating guidelines in mind so that the RSMs
in each remote location can accommodate the Performance Managers you plan to run
at those sites.
We do not recommend clustering of RSMs (in a single cluster) located at different
WAN locations as it might put extra network load, as we distribute the elements to
available RSMs of a cluster in round robin fashion.
Is the minimum RSM configuration required even if I am
managing only a few systems in these locations?
No. If only a few systems are being monitored, the size of the system required is
reduced.
262
BMC Performance Manager Portal Monitoring and Management Guide
Frequently asked questions (FAQs)
How will clustering of the web server, application server, or
RSM impact performance and scale estimates?
Clustering addresses continued operation in the event of a failure, and not
performance. The scale estimates represent the minimum number of computers
required to support a given workload. If you implement clustering, you will need
additional computers. The estimates should be used to ensure that, in the case of a
failure, the remaining components continue to operate.
Appendix A BMC Performance Manager Portal troubleshooting and FAQs
263
Frequently asked questions (FAQs)
264
BMC Performance Manager Portal Monitoring and Management Guide
Appendix
B
B
Monitoring the health of the Portal
This appendix presents the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Self-monitoring Performance Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Service Monitor setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure RSM to monitor JMX behind a firewall . . . . . . . . . . . . . . . . . . . . . . . . .
BMC PM Monitor application classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Performance Manager configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATROL Agent health monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring PATROL Agent monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing the threshold settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
265
266
266
267
268
270
270
271
272
272
Overview
The BMC Performance Manager Portal module provides the following tools that you
can use to monitor the health and performance of the Portal:
■
a self-monitoring Performance Manager that monitors the status of the Portal
components
■
an application class that monitors the status of a PATROL Agent
Appendix B
Monitoring the health of the Portal
265
Self-monitoring Performance Manager
Self-monitoring Performance Manager
The BMC Performance Manager Portal module includes BMC PM Monitor, a core
Performance Manager that enables you to monitor the health and performance of the
following Portal components:
■
■
■
■
■
Portal application server
Portal web server
RSM
Continuous Data Export (Datafeed) utility
PATROL integration
This Performance Manager is installed by default during installation of the BMC
Performance Manager Portal module. Immediately following installation, you can log
on as a Portal administrator and see this Performance Manager on the Performance
Managers page.
You cannot use the Performance Manager Editor (PME) to modify this Performance
Manager, and you should not use the SDK to change its properties.
Permissions
When you install the BMC Portal, the installation program creates predefined settings
for the predefined provider and account. In addition to these settings, when you
install the BMC Performance Manager Portal module, the installation program
creates the predefined settings described in Table 48. To access the self-monitoring
application classes in BMC PM Monitor, you must log on with these credentials.
Table 48
Predefined settings for monitoring the BMC Performance Manager Portal module
Portal hierarchy level
Description
Predefined credentials
provider
default provider, named Portal Monitoring, that you can
use for self-monitoring accounts
superadmin /
superadmin
To manage this provider, log on with Portal credentials.
account
266
default account named Portal Monitoring, that you can
use to monitor the Portal
BMC Performance Manager Portal Monitoring and Management Guide
portalmon/portalmon
Remote Service Monitor setup
Remote Service Monitor setup
When setting up an RSM to monitor the Portal components, consider the following
issues:
■
When configured as a shared or dedicated RSM, an RSM cannot monitor itself. If
you do not use global RSMs in your environment, you must set up at least one
RSM to monitor your production RSMs.
■
The portalmon user belongs to a different account and provider than other users
on your Portal. The RSM that you specify to monitor the Portal component must
belong to the portalmon user, the Portal Monitoring provider, or the Portal.
— Dedicated RSMs can monitor elements for all users in an account. To specify a
dedicated RSM to monitor the Portal components, set up a separate RSM and
enter the credentials for the Portal Monitoring user account
(portalmon/portalmon).
— Shared RSMs can monitor elements for all users in a provider. To specify a
shared RSM with the BMC PM Monitor application classes, set up a separate
RSM and enter the credentials for the Portal Monitoring administrator.
By default, the Portal Monitoring provider does not have an administrator. You
must create an administrator for this provider before you can install a shared
RSM.
— Global RSMs can monitor elements for all users on the Portal, including users
under the Portal Monitoring provider.
Based on these issues, you might consider the scenario illustrated in Figure 42 on
page 268. This figure shows typical user accounts under the DEFAULT provider and
the Portal Monitoring account under the Portal Monitoring provider. By installing the
RSM using the credentials for the portalmon user, you can configure a dedicated RSM
that monitors the Portal components.
Appendix B
Monitoring the health of the Portal
267
Configure RSM to monitor JMX behind a firewall
Figure 42
RSM setup for monitoring the Portal components
database
web browser
web server
application server
firewall
shared RSM
Account A
Account B
global RSM
dedicated RSM
Account C
DEFAULT
Portal
Monitoring
account
Portal Monitoring
TIP
You can install one instance of the RSM on the Portal computer. Consider installing this RSM
with the self monitoring (portalmon/portalmon) credentials.
Configure RSM to monitor JMX behind a firewall
The Portal Monitoring application or other JMX-based collectors (JBoss Solution)
generate the following error in the application collection status:
patsdk-bpm-mon-solution.dr1we_prm.timeoutException:bpm-monprod-wmi-process Problems connecting to host ciz-adamrsm2:9779: (JMX Paramlet)
This JMX time out occurs because of the environmental constraints of the Jboss server
when it is behind a firewall. Use the following steps to configure the RSM so that you
can monitor JMX behind a firewall.
268
BMC Performance Manager Portal Monitoring and Management Guide
Configure RSM to monitor JMX behind a firewall
To monitor JMX behind a firewall
1 Open following ports in the firewall:
■
■
■
RmiPort–9785
RMIObjectPort–9786
Naming Service–9779
2 Add the following two entries in the
%RSM_HOME%\RSM<versionNumber>\conf\rsmwrapper.conf file on each RSM
that you want to monitor for JMX metrics:
■
wrapper.java.additional.10=-Djava.rmi.server.hostname=<NAT'ed IP
address or External IP address of this RSM>
■
wrapper.java.additional.11=Djava.rmi.server.useLocalHostname=true
EXAMPLE
wrapper.java.additional.10=-Djava.rmi.server.hostname=123.45.67.89
wrapper.java.additional.11=-Djava.rmi.server.useLocalHostname=true
NOTE
Use the next available number for additional parameters in the rsmwrapper.conf file. For
example:, if wrapper.java.additional.9 is the last java additional parameter in the
file, add the other two parameters as wrapper.java.additional.10 and
wrapper.java.additional.11.
3 Save the file and restart the RSM.
4 Verify that JBoss JMX metrics collection starts. If the problem is still unresolved,
A Capture screens that show the details of the grayed out JMX parameters.
B Turn on debugging for the JMX collector in the RSM.
C On the RSM machine, please add the following two lines to
%RSM_HOME%\RSM<versionNumber>\tools\jdk\jre\lib\logging.properties:
■
■
com.bmc.patrol.patsdk.solutions.jmx.JmxParamlet.level=FINEST
com.bmc.patrol.patsdk.solutions.jmx.JmxDiscoveryParamlet.level=
FINEST
D After modifying the logging.properties file, restart the RSM.
Appendix B
Monitoring the health of the Portal
269
BMC PM Monitor application classes
BMC PM Monitor application classes
BMC PM Monitor contains the application classes listed in Table 49. For more
information about the parameters in each application class, see the Help.
Table 49
BMC PM Monitor application classes
Application class name
Description
BMC PM Portal App Server Monitor
monitors the JBoss program, communication metrics from the
RSM, operating system performance, and the following Portal
application server processes, and displays information about the
monitoring activity on the application server:
■
■
BMC PM Portal Datafeed Monitor
BMCPortal.exe (Windows)
BMCPortal (Solaris)
monitors the performance of the Continuous Data Export
(Datafeed) utility
For more information about the Datafeed utility, see “Continuous
data export configuration” on page 172.
BMC PM RSM Monitor
monitors the JBoss program, the BMCRSM.exe process, Windows
operating system performance, and monitoring activity on the
RSM
BMC PM PATROL Integration Monitor
monitors the rempadm.exe process on the RSM
The rempadm.exe process mines parameter data from the
PATROL Agent.
BMC PM Web Server Monitor
monitors the following Portal web server processes and the
operating system on the web server:
■
■
Solaris: BMCPortalWebserver
Windows:
— BMCPortalWebserver.exe (non Windows 2000 computers)
— BMCPortalWebser (Windows 2000 computers)
Performance Manager configuration
To use the application classes in BMC PM Monitor, you must log on with the user
credentials described in Table 48 on page 266. After logging on, add the Portal
components as elements and select the applicable BMC PM Monitor application
classes.
270
BMC Performance Manager Portal Monitoring and Management Guide
PATROL Agent health monitoring
EXAMPLE
To monitor the application server:
1. Log on to the Portal as the portalmon user.
2. On the Configure tab, select the Elements task, and specify the host name on which you
installed the Portal application server.
3. On the Application Classes page, select Self Monitoring from the Select Category list,
and select BMC PM App Server Monitor for the appropriate operating system.
4. Finish adding the application server by specifying the required credentials and by
modifying the thresholds, if necessary.
PATROL Agent health monitoring
PATROL Agent Availability and Health Monitor is a core application class that
monitors the health and status of the PATROL Agents from which the Portal is
mining parameter data. The parameters in this application class provide the
following information about the monitored PATROL Agents:
■
whether the PATROL Agent was restarted after the most recent collection interval
by the RSM
■
description of any errors that occurred when the RSM tried to connect to the
PATROL Agent
■
whether the RSM can establish a connection to the PATROL Agent on the specified
host name and port
■
number of milliseconds required for the PATROL Agent to execute the remote PSL
command that was initiated from the RSM
Appendix B
Monitoring the health of the Portal
271
Configuring PATROL Agent monitoring
Configuring PATROL Agent monitoring
You can apply this application class when you add elements to the Portal or when
you refresh thresholds.
■
When you use the PATROL Integration option to add elements, you can choose to
have the Portal apply the application class to all discovered PATROL Agents. The
Portal applies the properties that you specify for the PATROL Agents on the Add
Elements pages.
■
When you use the Refresh PATROL Integration option to update thresholds, you can
choose to have the Portal apply the application class to any PATROL integration
element that does not have the application class.
You cannot use the element Properties page to explicitly add this application class to
an element.
Changing the threshold settings
When you choose to apply the PATROL Agent Availability and Health Monitor
application class to PATROL integration elements, the Portal sets two parameter
thresholds and does not enable alert notifications. You can modify threshold settings
from the element Properties page for the applicable elements.
272
BMC Performance Manager Portal Monitoring and Management Guide
Appendix
C
BMC Performance Manager Portal
files
C
This appendix describes the configuration files used by the BMC Performance
Manager Portal and log files that you can use to diagnose problems. Generally, you
should use the configuration options on the BMC Performance Manager Portal user
interface to change the properties for this module, instead of editing the configuration
files.
This appendix presents the following topics:
Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal property files . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Service Monitor property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration file properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Performance Manager Portal log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSM log files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
273
274
274
275
295
295
295
Configuration files
The BMC Performance Manager Portal saves most of its configuration settings in
property files. Generally, the user interface provides screens that you can use to
change properties for the BMC Performance Manager module. However, you might
encounter a situation that requires you to locate and edit one of these files.
Appendix C
BMC Performance Manager Portal files
273
BMC Performance Manager Portal property files
BMC Performance Manager Portal property files
Table 50 shows the location for the BMC Performance Manager Portal module’s
property files on the Portal application server. This module saves properties in the
following files:
■
drmop.properties—defines many default and customizable properties for the BMC
Performance Manager Portal
■
padm.properties—contains timeout and scheduling information for integrating data
from PATROL Agents
■
datafeed.properties—contains the path to the directory that contains the properties
files that configure target files and databases for continuous data export parameter
data
You must restart the Portal after modifying any of the properties in these files.
Table 50
Operating
system
Location of BMC Performance Manager Portal property files
Location
Windows
%BMC_PORTAL_KIT_HOME%\appserver\websdk\tools\jboss\server\all
\conf\properties\drmop
UNIX
$BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/
conf/properties/drmop
Remote Service Monitor property files
The Remote Service Monitor program saves properties in the following files on the
RSM computer:
■
rsm-RsmHostName.properties—available in the following location, contains the
display name and description attributes for the RSM
(for example, rsm-server1.acme.com.properties). You can find this file in the
following location:
%RSM_HOME%\RSM<version Number>\server\rsm\conf\properties\rsm\
■
rsm.properties—contains timeout values that you can customize for application
classes that use the SNMP or command shell collectors. You can find this file in the
following location:
%RSM_HOME%\RSM<versionNumber>\server\rsm\conf\properties\rsm\
274
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
■
portal-PortalWebServer.properties—defines how the RSM communicates to the
Portal (for example, portal-server1.acme.com.properties). You can find this file in the
following location:
%RSM_HOME%\RSM<versionNumber>\server\rsm\conf\properties\rsm\
■
jboss-service.xml—contains default settings for creating the RSM log files. You can
find this file in the following location:
%RSM_HOME%\RSM<versionNumber>\server\rsm\deploy\patsdk.sar\META-INF
Do not edit this file unless instructed by BMC Software Customer Support.
Configuration file properties
Table 51 on page 276 through Table 56 on page 294 list properties that configure the
BMC Performance Manager Portal. You must restart the Portal after modifying any of
the properties in these files.
Appendix C
BMC Performance Manager Portal files
275
Configuration file properties
Table 51
Properties in drmop.properties file (part 1 of 16)
Property
Description
drmop.default.reporting.interval.minutes
determines the default value for Report Update Interval
Valid values (in minutes):
■
■
■
■
■
5 (default for versions earlier than 2.7)
10 (default for version 2.7 and later)
15
30
60
For the change to take effect, you must restart the Portal
after applying the new value.
Setting drmop.default.reporting.interval.minutes=5
causes all elements and element profiles created after this
value is set to have 5 mintutes as their default report
update interval. However, element and element profile
settings that existed prior to the change continue to use
the settings they used prior to the change.
The report update interval default is 10 minutes for fresh
installations of BMC Portal version 2.7.00 or later.
Previous versions and previous installations that are
updated to version 2.7.00 or later retain the 5-minute
default.
Example:
drmop.default.reporting.interval.minutes=5
drmop.applicationinstance.
enabledeleteinactiveinstance property
enables and disables the inactive application instance
deletion feature
Valid values:
■
true (default) = inactive application instance deletion
is enabled
■
false = inactive application instance deletion is
disabled
Example:
drmop.applicationinstance.
enabledeleteinactiveinstance=true
276
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 2 of 16)
Property
Description
drmop.applicationinstance.maxinactiveminutes
sets the discovered inactive instance retention time in
minutes
Valid values are positive whole numbers. The default
value is 4320 minutes (or 3 days).
Example:
drmop.applicationinstance.
maxinactiveminutes=4320
Warnings:
■ When an element is in monitor off mode, or when an
element comes out of blackout, if the monitor off
mode or blackout duration exceeds the value of the
this property, the instances underneath the element
are considered inactive. If the
drmop.applicationinstance.enabledeleteinactiveinst
ance property is enabled, these instances will be
deleted.
■
Whenever you restart the Portal service, the
drmop.applicationinstance. maxinactiveminutes
time is reset, and the tallying of time to determine
when an instance is considered inactive begins from
that point forward.
For example, by default drmop.applicationinstance.
maxinactiveminutes is set to 4320 minutes (or 3
days). If you restart the Portal after 3 days, all inactive
instances are not deleted, even those that were
inactive for 3 days. However, the inactive instances
are deleted 3 days after the Portal is restarted (if they
remain inactive).
If you restart the Portal on a schedule or at a rate that
occurs more frequently than the value of the
drmop.applicationinstance. maxinactiveminutes
property, the inactive instances will never be deleted.
For example, if you regularly restart the Portal every
night, and you set the max inactive minutes to 1440
minutes (one day) or less, the inactive instances will
never be deleted.
Appendix C
BMC Performance Manager Portal files
277
Configuration file properties
Table 51
Properties in drmop.properties file (part 3 of 16)
Property
Description
drmop.element.properties.allow.hostname.
change
indicates whether a user can change the host name of an
element
Any value except true is considered false.
By default, users can change the host name of an existing
element.
Example:
drmop.element.properties.allow.hostname.
change=true
drmop.reports.availability.formula.up_time
sets the statuses to include in and exclude from the
drmop.reports.availability.formula.exclude_time formula used to calculate element availability
By default the following formula includes warning and
OK times in up_time and includes none, blackout period,
offline, and unknown times in exclude_time:
availability =up_time/(total_time - exclude_time) * 100%
Valid values:
■
■
■
■
■
■
blackout
none
offline
OK
unknown
warning
To change the statuses in up_time and exclude_time,
change the following properties:
drmop.reports.availability.formula.up_
time= Ok, warning
drmop.reports.availability.formula.
exclude_time=None, Blackout, Offline,
Unknown
drmop.reports.topn.batch.job.timeout.minutes
specifies the maximum number of minutes for data to
appear on the Top N report (account and element views
on the Reports tab), after which a timeout occurs
Example:
drmop.reports.topn.batch.job.timeout.
minutes=30
278
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 4 of 16)
Property
Description
enable.ula.alternate.ldap.search
when uncommented and set to true, adds security so that
users cannot delete all of the users in the DEFAULT FULL
ACCESS user group
This property is commented out in the drmop.properties
file. To activate this property, you must open the
drmop.properties file, and uncomment the
enable.ula.alternate.ldap.search property.
Valid values:
■
false = the DEFAULT FULL ACCESS user group can
be deleted
■
true = the DEFAULT FULL ACCESS user group
cannot be deleted
Example:
enable.ula.alternate.ldap.search=true
portal.cmdb.search.max.hosts.to.return
sets the maximum number of CIs to return for BMC
Atrium CMDB discovery searches
Valid values are positive whole numbers.
Example:
portal.cmdb.search.max.hosts.to.return=100
portal.events.element.limit
sets the maximum number of element alerts to show on
the Events tab when you select Elements from Objects to
Show or All from Alerts to Show
Valid values are positive whole numbers. By default, the
Events tab shows a maximum of 300 element alerts.
Example:
portal.events.element.limit=300
portal.events.element.param.limit
sets the maximum number of element and parameter
alerts to show on the Events tab when you select
Elements + Parameters from Objects to Show
Valid values are positive whole numbers. By default, the
Events tab shows a maximum of 600 element and
parameter alerts.
Example:
portal.events.element.param.limit=600
Appendix C
BMC Performance Manager Portal files
279
Configuration file properties
Table 51
Properties in drmop.properties file (part 5 of 16)
Property
Description
portal.events.param.limit
sets the maximum number of parameter alerts to show on
the Events tab when you select Parameters from Objects
to Show
Valid values are positive whole numbers. By default, the
Events tab shows a maximum of 300 parameter alerts.
Example:
portal.events.param.limit=300
portal.events.prevent.unknown
specifies whether the unknown events appear in the
event table
Valid values:
■
false (default) = unknown events appear in the event
table
■
true = unknown events do not appear in the event
table
Example:
portal.events.prevent.unknown=false
portal.history.element.statusHistory.retention
sets the number of days that the database keeps element
status changes, such as blackout and monitoring off
■
The value of this property must match the value for
the portal.history.element.summarizationData
Point.retention property.
■
Increasing the retention period requires more disk
space.
■
The default value is 428 days; however, BMC
recommends that you set the value at 92 days.
Example:
portal.history.element.statusHistory.
retention=428
280
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 6 of 16)
Property
Description
portal.history.event.retention
specifies the number of days’ worth of event data to
retain; this value is used to calculate the number of
partitions to keep in the database
Valid values are positive whole numbers or positive
numbers with a single-digit decimal (for example, 1.5).
To calculate the number of partitions to drop, the
database multiplies the number of days specified in the
portal.history.event.rollover.period property and rounds
up.
Although the default setting is 100, BMC recommends a
setting of 14.
Example:
portal.history.event.retention=14
See page 138 for more information about event retention.
portal.history.event.rollover.period
sets the period for saving data in an event partition in the
database; works with the portal.history.event.retention
property to determine when to purge a partition from the
database
Valid values:
■
■
■
■
■
■
■
HALF_HOUR
HOUR
HALF_DAY
DAY (default)
WEEK
MONTH
YEAR
BMC recommends that you set this property value to
DAY, which saves one day’s worth of data in event
partitions.
Example:
portal.history.event.rollover.period=DAY
See page 138 for more information about event retention.
Appendix C
BMC Performance Manager Portal files
281
Configuration file properties
Table 51
Properties in drmop.properties file (part 7 of 16)
Property
Description
portal.history.events.purgeunknown.
cleanunknownevents.enabled
determines whether purging is enabled or disabled for all
unknown events that were generated when an element,
application class, or parameter went into unknown states
Valid values:
■
false (default, recommended value) = purging of
unknown events is disabled
■
true = purging of unknown events is enabled
Example:
portal.history.events.purgeunknown.
cleanunknownevents.enabled=false
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
portal.history.events.purgeunknown.
scheduledays
sets the days on which the retention job to purge
unknown events runs
Valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
If you want the job to run on more than one day, you can
enter multiple values and separate them by a comma (no
spaces). For example, a value of 1,2,6 sets the job to run on
Sunday, Monday, and Friday.
Example:
portal.history.events.purgeunknown.
scheduledays=1
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
282
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 8 of 16)
Property
Description
portal.history.events.purgeunknown.
schedulehours
determines the hour when the Retention Job to purge
unknown events begins to run
Valid values are 0 (12:00 a.m. or midnight) through 23
(11:00 p.m.). No minutes are recongized. The value must
represent an hour between 12:00 a.m. and 11:00 p.m. The
default and recommended value is 19 (7:00 p.m.).
The time set for this property is the time on the database
server.
Example:
portal.history.events.purgeunknown.
schedulehours=19
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
portal.history.events.purgeunused.
cleanunusedevents.enabled
determines whether purging is enabled or disabled for all
unused events that were generated by elements, appclass,
or parameters that were deleted or that do not exist
Valid values:
■
■
false (default) = purging is disabled
true = purging is enabled
Example:
portal.history.events.purgeunused.cleanunusedevents.
enabled=false
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
Appendix C
BMC Performance Manager Portal files
283
Configuration file properties
Table 51
Properties in drmop.properties file (part 9 of 16)
Property
Description
portal.history.events.purgeunused.scheduledays determines the days on which the retention job to purge
unused events runs
Valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
If you want the job to run on more than one day, you can
enter multiple values and separate them by a comma (no
spaces). For example, a value of 1,2, 6 sets the job to run
on Sunday, Monday, and Friday.
Example:
portal.history.events.purgeunused.
scheduledays=1
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
portal.history.events.purgeunused.schedulehours determines the time (the hour on the hour) when the
retention job to purge unused Events runs
Valid values are 0 (12:00 a.m. or midnight) through 23
(11:00 p.m.). No minutes are recongized. The value must
represent an hour between 12:00 a.m. and 11:00 p.m. The
default and recommended value is 19 (7:00 p.m.).
The time set for this property is the time on the database
server.
Example:
portal.history.events.purgeunused.schedule
hours=19
For details, see “Purging unknolwn and unused events in
the event table,” in the BMC Portal Installation Guide.
284
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 10 of 16)
Property
Description
portal.history.websdk.activitylog.retention
determines the number of days that the database retains
the websdk activity log
Valid values are positive whole numbers. The default and
recommended value is 100, which retains the websdk
activity log for 100 days.
Example:
portal.history.websdk.activitylog.
retention=100
portal.history.websdk.agentstatushistory.
retention
determines the number of days that the database retains
the history for remote server monitor (RSM) status
Valid values are positive whole numbers. The default and
recommended value is 30, which retains the RSM status
history for 30 days.
Example:
portal.history.websdk.agentstatushistory.
retention=30
portal.history.websdk.rsmmessage.retention
determines the number of days that the database retains
the history for RSM message
Valid values are positive whole numbers or positive
numbers with a single-digit decimal (for example, 1.5).
The default and recommended value is 0.5, which retains
the history for one-half of a day.
Example:
portal.history.websdk.rsmmessage.retention
=0.5
portal.history.websdk.parameterstatushistory.
retention
determines the number of days that the database keeps
parameter statuas history
Valid values are positive whole numbers. The default and
recommended value is 12.
Example:
portal.history.websdk.
parameterstatushistory.retention= 12
Appendix C
BMC Performance Manager Portal files
285
Configuration file properties
Table 51
Properties in drmop.properties file (part 11 of 16)
Property
Description
portal.history.websdk.websdkalertjob.retention
determines the number of days that the database keeps
history for websdk alert job
Valid values are positive whole numbers. The default and
recommended value is 2.
Example:
portal.history.websdk.websdkalertjob.
retention= 2
portal.history.websdk.eventnotification.retention determines the number of days that the database retains
the history for event notification
Valid values are positive whole numbers or positive
numbers with a single-digit decimal (for example, 1.5).
The default and recommended value is 14 (which is the
same as the portal.history.event.retention default)
Example:
portal.history.websdk.eventnotification.
retention=14
portal.history.jmsmessages.delete.enable
determines whether unwanted JMS messages are purged
at startup
Valid values:
■
true (default and recommended) = unwanted JMS
messages are purged at startup
■
false = JMS messages are not purged at startup
Example:
portal.history.jmsmessages.delete.enable
=true
286
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 12 of 16)
Property
Description
portal.history.alertjob.truncate.enable
determines whether purging is enabled at startup for all
existing alert jobs
Valid values:
■
true (default and recommended) = enables purging of
all existing alert jobs at startup
■
false = purging is not enabled at start up
Example:
portal.history.alertjob.truncate.enable=
true
portal.history.parameter.summarization.disabled determines whether the Portal summarizes raw data
Many of the reports use only summarized data. Changing
this value to false prevents you from creating those
reports.
Example:
portal.history.parameter.summarization.
disabled=true
portal.history.parameter.summarization
DataPoint.cleaninactiveparameter.enabled
determines whether purging is enabled or disabled for
inactive data that was generated for elements, application
classes, or parameters that were deleted or that do not
exist
Valid values:
■
■
false (default) = purging is disabled
true = purging is enabled
Example:
portal.history.parameter.summarizationDataPoint.
cleaninactiveparameter.enabled=false
For more details, see “Purging inactive data from the
Portal history tables” on page 139.
Appendix C
BMC Performance Manager Portal files
287
Configuration file properties
Table 51
Properties in drmop.properties file (part 13 of 16)
Property
Description
portal.history.parameter.purgepsdp.
scheduledays
determines the days on which the retention job to purge
unused events runs
Valid values:
■
■
■
■
■
■
■
1 = Sunday (default and recommended value)
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
If you want the job to run on more than one day, you
canenter multiple values and separate them by a comma
(no spaces). For example, a value of 1,2, 6 sets the job to
run on Sunday, Monday, and Friday.
Example:
portal.history.parameter.purgepsdp.
scheduledays=1
For more details, see “Purging unknown and unused
events from the event table” on page 141.
portal.history.parameter.purgepsdp.
schedulehours
determines the time (the hour on the hour) when the
retention job to purge unused events runs
Valid values are 10 (10:00 a.m.) through 19 (7:00 p.m.). No
minutes are recognized. The value must represent an
hour between 10:00 a.m. and 7:00 p.m. The default and
recommended value is 19 (7:00 p.m.).
The time set for this property is the time on the database
server.
Example:
portal.history.parameter.purgepsdp.
schedulehours=19
For more details, see “Purging unknown and unused
events from the event table” on page 141.
288
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 14 of 16)
Property
Description
portal.history.parameter.summarizationDataPoin determines the number of days that the database keeps
t.retention
summarized parameter values
■
Increasing the retention period requires more disk
space.
■
Reducing this retention period reduces the time
period in which you can chart data points.
■
BMC recommends a setting of 92 days; however, the
default value is 428 days.
Example:
portal.history.element.summarizationData
Point.retention=92
portal.history.parameter.value.retention
sets the number of days that the database retains raw
parameter data values
Database performance is optimized for a 14-day retention
of raw data if the report update interval is higher than 5
minutes. However, BMC recommends that you set history
retention at 7 days.
■
Increasing the retention period can adversely impact
database performance and requires more disk space.
■
Significantly decreasing the retention period, to 1 or 2
days, can cause the Portal to lose data that was not
summarized (in the event of a Portal downtime
caused by maintenance, upgrades, or hardware
failure).
Default value:
portal.history.parameter.value.
retention=14
portal.rsmcommunication.queueWatcher.
workerThreads
sets the number of worker threads created to watch
queues and process incoming data
Do not modify this property unless instructed to do so by
Customer Support.
Example:
portal.rsmcommunication.queueWatcher.
workerThreads=10
Appendix C
BMC Performance Manager Portal files
289
Configuration file properties
Table 51
Properties in drmop.properties file (part 15 of 16)
Property
Description
portal.ssh.private.key.file.max.size
sets the number of bytes for the maximum size of the SSH
private key file
Most private key files are small. Setting a maximum size
value keeps users from accidentally specifying a file of an
incorrect type.
Example:
portal.ssh.private.key.file.max.size=
2097152
portal.upgrade.transaction.timeout
specifies the time out in seconds for the process of
solution upgrade.
The default time out is 108000 seconds (30 hours). Please
do not decrease the timeout below the default values. It
can cause the solution upgrade to fail on large size portal.
Example:
portal.upgrade.transaction.timeout=108000
portal.utd.timeout.sec
specifies the number of seconds that the Portal waits for
the RSM to return the instance discovery results, after
which a timeout occurs
Valid values are positive whole numbers. The default
discovery time is 300 seconds, or 5 minutes.
Example:
portal.utd.timeout.sec=300
rsm.download.protocol
protocol used to download RSM from the Portal
Valid values:
■
■
http (default)
https
Example:
rsm.download.protocol=http
290
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 51
Properties in drmop.properties file (part 16 of 16)
Property
Description
snmp.max.parameter.events.to.process
specifies the maximum number of parameters included in
an SMNP trap
Valid values are positive whole numbers. The default
maximum number of parameters in a trap is 5.
Example:
snmp.max.parameter.events.to.process=5
snmp.trap.showappinstsingleton
determines whether the application instance name is sent
in the SNMP trap for singleton application instances
Valid values:
■
■
false (default)-- application instance name is not sent
true-- application instance name is sent
For change to take effect, you must restart the Portal after
applying the new properties.
Example:
snmp.trap.showappinstsingleton=false
snmp.trap.showlastapp
determines whether the last application in the application
hierarchy is displayed in the SNMP trap
Valid values:
■
false (default)-- last application in the hierarchy is not
displayed
■
true-- last application in the hierarchy is displayed
For example, if Windows Event Log Monitor | Portal
Log | Log Count is the hierarchy sent in the SNMP trap,
you see the following results:
■
false (default)--Windows Event Log Monitor | Portal
Log
■
true--Windows Event Log Monitor | Portal Log |
Log Count
This applies for both Element- and Parameter-level
notifications. For change to take effect, you must restart
the Portal after applying the new properties.
Example:
snmp.trap.showlastapp=false
Appendix C
BMC Performance Manager Portal files
291
Configuration file properties
Table 52
Properties in the padm.properties file
Property
Description
padm.migrate.locking
restricts the PATROL Agent refresh (synchronization) process
to one user when set to true
If a user attempts to synchronize the thresholds of integration
Performance Managers while another user is running this
operation, the second user gets an error message.
Example:
padm.migrate.locking=true
padm.migrate.schedule.limit
sets a limit on the number of migration jobs that can be
scheduled without pause
Example:
padm.migrate.schedule.limit=25
padm.migrate.schedule.max
sets the maximum number of PATROL Agents that can be
migrated at one time
Example:
padm.migrate.schedule.max=100
padm.migrate.schedule.wait
sets the number of seconds that the migration collector pauses
when the schedule limit is reached
Example:
padm.migrate.schedule.wait=10
padm.migrate.threshold.update.exclude.list provides a list of comma separated application
class/parameter name pairs to exclude during threshold
synchronization
For each parameter, use the following format and specify the
PATROL names for the application class and parameter:
/InternalApplicationClassName/InternalParameterName
Example:
padm.migrate.threshold.update.exclude.list=/LOGMON/
LOGStatus,/DB2_DIAGLOG/DiagLogOK,/DB2EEE_DIAGLOG/
DiagLogO
padm.migrate.wait.timeout
sets the number of seconds that the migration collector waits
for a response from the PATROL Agent before a timeout occurs
Example:
padm.migrate.wait.timeout=1000
292
BMC Performance Manager Portal Monitoring and Management Guide
Configuration file properties
Table 53
Properties in rsm-RsmHostName.propertiesa file on the RSM computer
Property
Description
DisplayName
name of the RSM that displays in the user interface
Description
description for the RSM computer
Version
version number of the RSM program
Do not edit this value.
a
This file is reinitialized from the rsm-RsmHostName-xmbean.xml file, which you should never edit. To
update the properties in rsm-RsmHostName-xmbean.xml, edit rsm-RsmHostName.properties.
Table 54
Properties in the rsm.properties file on the RSM computer
Property
Description
patsdk-commandshell-solution.patsdkcommandshell.timeout
number of seconds that the Command Shell collector waits
for a value before timing out
patsdk-snmp-solution.patsdk-snmp.timeout
number of seconds that the SNMP collector waits for a value
before timing out
patsdk-snmp-solution.patsdk-snmp-trap
.MatchedTrapContents.showWholeTrap
determines whether the Portal displays the whole value of the
the trapped process parameter
Valid values:
■
■
true=Portal displays the whole trap
false (default)=Portal displays part of trap
Example:
patsdk-snmp-solution.patsdk-snmp-trap.
MatchedTrapContents.showWholeTrap
=false
Table 55
Properties in portal-PortalWebServer.propertiesa file on the RSM computer (part 1 of 2)b
Property
Description
AuthenticationHostUrl
URL that the RSM uses to authenticate itself with the Portal whenever it
initiates communication with the Portal
AuthenticationInfo
defines the authentication credentials used to connect to the Portal
Credentials are encrypted by the installation program.
HeartbeatInterval
frequency with which the RSM contacts the Portal once it has authenticated
and established a session
On each heartbeat, the RSM requests jobs to perform and uploads data if
necessary; the Portal will respond with new or updated configuration for
jobs if any remain to be assigned.
Appendix C
BMC Performance Manager Portal files
293
Configuration file properties
Properties in portal-PortalWebServer.propertiesa file on the RSM computer (part 2 of 2)b
Table 55
Property
Description
Master
flags this Portal as the master Portal to which this RSM communicates (out
of possibly many Portals)
This information is used primarily for determining when the RSM needs to
upgrade itself; the RSM follows a command to upgrade when the command
comes from the master Portal.
MaxStoreAndForwardTime
sets the time in milliseconds that the RSM holds unsent messages in memory
before discarding them
The default time is 900000 milliseconds (15 minutes).
Specify a value of 60000 or higher. If you specify less than 60000, the RSM
ignores the value and uses 60000 milliseconds.
Name
name of the Portal
UseSsl
determines whether the RSM uses SSL to communicate with the Portal
UseCompression
not supported in this release
Timeout
number of milliseconds the RSM waits to receive a response to a connection
to the Portal
ConnectionTimeout
number of milliseconds that the RSM waits to connect to the Portal
After the connection is established, the Timeout attribute defines how long
the connection remains open waiting for a response.
a
This file is initialized from the portal-PortalWebServer-xmbean.xml file, which you should never edit. To
update the properties in portal-PortalWebServer-xmbean.xml, modify portal-PortalWebServer.properties.
b
You must restart the RSM after changing any of the properties in this file.
Table 56
JMX credentials on RSMs
File name
Property
rsm/server/rsm/conf/props/jmx-console-roles.properties
userName=JBossAdmin,HttpInvoker
By default, the user name is set to admin:
admin=JBossAdmin,HttpInvoker
rsm/server/rsm/conf/props/jmx-console-users.properties
userName=password
By default, the password is set to admin:
admin=admin
If you change the user name in jmx-consoleroles.properties, you must also change the
user name value in this file.
294
BMC Performance Manager Portal Monitoring and Management Guide
Log files
Log files
Log files can help you diagnose problems encountered by the BMC Performance
Manager Portal components.
BMC Performance Manager Portal log file
To help diagnose monitoring errors that occurred on the Portal, you can access the
portal.log file, located in the following directory:
■
■
(Windows) %BMC_PORTAL_KIT%\appserver\websdk\tools\jboss\server\all\log
(Solaris) $BMC_PORTAL_KIT/appserver/websdk/tools/jboss/server/all/log
RSM log files
The RSM provides the following files that you can use to diagnose problems with the
RSM:
■
rsm*.log helps diagnose problems that the RSM has when monitoring
infrastructure elements.
■
wrapper.log is used to diagnose problems in cases where the RSM is not getting any
CPU time or when it appears to be hung. The RSM runs as a Java Service Wrapper.
You can find both log files in the following location on the RSM computer:
%RSM_HOME%\RSM<versionNumber>\server\rsm\log\
To help diagnose problems that might occur when mining data from the PATROL
Agents, you can access the padm-err.nn log file. You can find this file in the following
location:
%RSM_HOME%\RSM<versionNumber>\server\rsm\deploy\padmr-mbean.sar\padmbase\log
Appendix C
BMC Performance Manager Portal files
295
RSM log files
296
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Glossary
A
application class
The object class to which an application instance belongs; also, the representation of the class as
a container (UNIX) or folder (Windows) on the PATROL console.
application severity
The condition of an application class or an application instance. The most common application
severities are OK, warning, and alarm. An application class or instance icon can also show
additional conditions.
B
backbone
On the Internet or other wide area network, a set of paths that local or regional networks
connect to for long-distance interconnection. In BMC Performance Manager Portal, the
backbone represents the physical location (company name) of the computer in the network.
C
clustered RSM
Two or more physical Remote Service Monitors (RSMs) clustered to run as a single entity. Users
can view and select a clustered RSM to collect parameter data from an element as if it was a
dedicated, shared, or global RSM. See also dedicated RSM, global RSM, and shared RSM.
collection interval
The interval at which the RSM collects parameter values for the parameters in an application
class. You can set the collection interval for an application class when you add an element to the
account or at a later time. The collection interval is sometimes referred to as the monitoring
interval. Compare with report update interval.
collector
A module of the RSM program that measures and gathers parameter values on the monitored
elements. For example, the collector modules can gather SNMP, PerfMon, and PATROL data
from the monitored elements.
Glossary
297
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
core Performance Manager
A Performance Manager provided with BMC Performance Manager Portal and available for use
whether or not you install Performance Managers from a Solutions CD or another source.
Compare with custom Performance Manager and solution Performance Manager.
custom application class
An application class created from the Portal pages that compose the Performance Manager
Editor (PME). Custom application classes are contained in custom Performance Managers. You
can access the PME when you log on to the Portal with Portal administrator credentials.
custom Performance Manager
A Performance Manager created with the PME. A custom Performance Manager is composed of
custom application classes.
cryptographic hash
An algorithm that takes an entire message and, through a process of shuffling, manipulating,
and processing the bytes using logical operations, generates a small fingerprint or message
digest of the data.
D
dedicated RSM
An RSM that is located with your monitored systems, measures only the elements in an account,
and is installed by a user in the account. Compare with global RSM and shared RSM.
desktop file
See PATROL desktop file.
E
element profile
An element profile acts as a template that you can apply to multiple elements and enables you
to quickly change the properties associated with your infrastructure elements. Element profiles
are especially useful when you need to manage many elements that share common properties.
encoding system
A method of assigning binary codes to represent characters of data. The Portal enables you to
specify an encoding system when you save data to a file.
escalation procedure
The process of referring a problem up the chain of command. For example, operations
personnel might be notified within five minutes of a problem occurrence, a manager would
learn of it after 15 minutes, and a director after one hour (if the problem still exists).
298
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
F
Full Access
A permission or right that enables you to fully configure the account, within the limits specified
by the administrator, by adding and deleting elements and groups, and by setting up the goals
and thresholds that correspond to the service level agreement.
G
global RSM
An RSM that is located in a centralized data center (possibly outside your company). It can
monitor the elements for many accounts, and is installed and maintained by a Portal
administrator. Compare with dedicated RSM and shared RSM.
H
HTTP response code
A three-digit integer that indicates the result of the attempt to understand and satisfy an HTTP
request. The first digit of the status code defines the class of response. The last two digits do not
have any categorization role.
I
impersonation
Posing as another user to gain access to an account. Administrators can impersonate a user to
assist with account configuration and troubleshooting. During user impersonation, the Portal
attributes the user activity to the administrator.
infrastructure element
An addressable object that can be monitored, such as a managed system in PATROL.
instance
A monitored device, process, log, or application on an infrastructure element. Instances can be
specified (processes and logs) or automatically discovered by the RSM (disk drives and network
interfaces) or PATROL Agent.
K
Knowledge Module (KM)
A set of files that define how a PATROL Agent gathers, processes, and presents data about
resources running on a monitored computer. A KM file can contain the actual instructions for
monitoring objects or simply contain a list of KMs to load. KMs are loaded by a PATROL Agent
and a PATROL console. The BMC Performance Manager Portal can mine parameter data from
PATROL Agents when you install PATROL integration Performance Managers on the Portal.
Glossary
299
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
L
latency
The time between the initial request for data and the beginning of the actual data transfer.
logical RSM
See clustered RSM.
M
Management Information Base (MIB)
Management Information Base (MIB). A formal description of a set of network objects that can
be managed using the Simple Network Management Protocol (SNMP). The format of the MIB is
defined as part of the SNMP. SNMP uses standardized MIB formats that allow any SNMP tool
to monitor any device defined by a MIB.
Management Profile
A user profile for PATROL Central Operator – Windows Edition and PATROL Central
Operator – Web Edition that is stored by the console server. A Management Profile is similar to
a session file and contains information about custom views, your current view of the PATROL
environment, information about systems that you are currently managing, Knowledge Module
information, and console layout information for PATROL Central. Management Profiles replace
the desktop files and session files that were used in PATROL 3.x and earlier.
monitoring interval
See collection interval.
P
PAR file
An archive file that contains the components for a Performance Manager. PAR files can contain
one or more application classes. See also Performance Manager.
parameter
The monitoring element of the BMC Performance Manager Portal. Parameters are run by a
PATROL Agent or an RSM computer. Parameters can display data in various formats, such as
numeric, text, and Boolean. Parameters have thresholds and can trigger warnings and alarms. If
the value returned by the parameter triggers a warning or an alarm, the RSM sends an event to
the Portal web server.
parameter severity
The condition of a parameter. The most common parameter severities are OK, warning, and
alarm.
300
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
PATROL Agent
The core component of PATROL architecture. The agent is used to monitor and manage host
computers and can communicate with the PATROL console, a stand-alone event manager
(PEM), PATROL Integration products, and SNMP consoles.
PATROL desktop file
A file created by PATROL Console for Microsoft Windows and PATROL Console for UNIX.
Desktop files usually have a .dt extension.
Performance Manager
A collection of one or more logically-related application classes that have been packaged
together to provide infrastructure monitoring for business-critical computers or applications.
Performance Managers are contained in PAR files that you can install from Solution CDs or by
loading from the Portal tab in the BMC Performance Manager Portal. See also PAR file.
Portal administrator
An administrator that has both Edit and See Other Providers and Their Accounts permissions.
Portal administrators can view the Accounts, Provider, and Portal tabs and configure global
defaults that affect the Portal and all providers on the Portal. Additionally, Portal
administrators can add new providers and can send email to all administrators and users on the
Portal. Unless changed by the administrator, Portal administrators use superadmin/superadmin
to log on as a Portal administrator.
provider administrator
An administrator with only Edit permission can view the Accounts and Provider tabs and can
configure provider properties, administrators, and accounts, and approve or reject account
requests for that provider.
R
Reconciliation Identity
An attribute that uniquely identifies a BMC Atrium CMDB object for a given dataset. The
combination of the dataset and the Reconciliation Identity is unique.
regular expression
Sometimes referred to as regex, regular expressions are used in pattern matching and
substitution operators. A simple regular expression is a sequence or a pattern of characters that
is matched against a string of text during searches and replace operations. Regular expressions
are used for configuring text thresholds.
Remote Service Monitor (RSM)
The BMC Performance Manager Portal component that provides remote monitoring of the
elements in your account. The RSM polls the elements in your account at regular collection
intervals and sends parameter data to the Portal upon detection of parameter status changes.
Glossary
301
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Regardless of parameter status, the RSM also sends parameter data to the Portal at the report
update interval for each element.
Depending on the setup of your account, your administrator might control the location and
maintenance of the RSMs that monitor your account. See also dedicated RSM, global RSM, and
shared RSM.
Remote Service Monitor Manager
A utility for the RSM program that you access from the system tray of the RSM computer. This
utility enables you to configure, start and stop the RSM. It also provides monitoring statistics
about your account. See also Remote Service Monitor (RSM).
report update interval
Regardless of parameter status, the frequency at which the RSM sends the most recentlycollected parameter data to the Portal. You can view these parameter values on the Status and
Reports tabs. The RSM also sends parameter values when it detects that a parameter has
changed to or from an alert status. You can view parameter values that triggered an alert status
on the Events tab. Compare with collection interval.
RSA algorithm
A public-key encryption system based on the factoring problem. RSA stands for Rivest, Shamir,
and Adleman, the developers of the RSA public-key encryption system and the founders of RSA
Data Security (now RSA Security).
RTserver
Real Time server. The PATROL Central component that delivers application data among the
PATROL Central components.
S
shared credential
Authentication credentials that you can save and apply to many elements in the account. When
you apply shared credentials to an element, you can quickly change the credentials for the
element when the credentials change on the monitored elements by updating the properties for
a set of shared credentials.
shared RSM
An RSM that is located in a centralized data center, can monitor the systems and devices of
more than one account, and is installed and maintained by a provider administrator who has
Edit permission. Compare with dedicated RSM and global RSM.
Simple Network Management Protocol (SNMP)
Simple Network Management Protocol. The protocol governing network management and the
monitoring of network devices and their functions.
302
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
SNMP community string
A user name or password that allows access to the statistics of a router or other device when
sending SNMP traps. If the community string is correct, the device responds with the requested
information. If the community string is incorrect, the device simply ignores the request.
SNMP trap
A condition which, when satisfied, results in an SNMP agent issuing a trap message to other
SNMP agents and clients. Within the PATROL Agent, all events can be translated to SNMP
traps and forwarded to SNMP managers.
solution Performance Manager
A Performance Manager installed from a Solutions CD, downloaded from the BMC Software
EPD website, or created using the BMC Performance Manager SDK. Compare with core
Performance Manager and custom Performance Manager.
SSH
Secure Shell. Sometimes known as Secure Socket Shell, SSH is a UNIX-based command interface
and protocol for securely accessing a remote computer. Network administrators use SSH to
remotely control web and other kinds of servers. SSH commands are encrypted.
SSH fingerprint
Each SSH server has a unique host fingerprint. When an SSH client connects to an SSH server, it
gets the server’s fingerprint. The client can then optionally verify the server’s fingerprint in an
internal database, or prompt the user for the fingerprint.
store and forward
A mechanism that ensures that if an event cannot reach its destination, it is saved in a file and
sent when a viable connection to the destination becomes available.
Glossary
303
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
304
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Index
A
About task, described 50
Account Information task, described 50
account reports 144
account types settings for providers 65
Account Types task, described 65
accounts
predefined name for new Portal 63
predefined name for self monitoring 266
Accounts tab tasks for administrators 64
ACE. See PME
ACS. See Application Collector Status parameter
activity logs to view user activity, viewing user activity
logs 64
adapter_host slot name 199
addElements command in bpmcli 223, 225
adding a clustered RSM for the account 95
adding infrastructure elements to account
adding objects in the BMC Atrium CMDB 42
agent-based monitoring 30–36
agentless monitoring 25
using the command-line interface (bpmcli) 223
adding Performance Managers to the Portal. See
importing Performance Managers or creating
Performance Managers
addPATROL command in bpmcli 228
administrator for Portal-wide configuration 64
administrator for provider-wide configuration 64
administrator permissions 64
administrator tabs
Accounts tab 64
Portal tab 67
Provider tab 65
Administrators task, described 65
agent integration Performance Managers. See PATROL
integration Performance Managers
agent-based monitoring
adding infrastructure elements to account 30–36
described 18
minimum and maximum values for mapped
thresholds 116
monitoring the PATROL Agent 271
parameter mappings between KMs and Performance
Managers 115
security requirements 75
threshold mappings between KMs and Performance
Managers 116
agentless monitoring
adding infrastructure elements to account 25
described 18, 114
security requirements 74
alarm and warning thresholds in a parameter, described
127
alarm direction in a parameter, described 127
AlarmPoint, event integration with the Portal
account level integration 56
enterprise level integration 196
Alerts to Show list on Events tab 217
allocating Java heap memory for the RSM Java VM 104
allowed characters, user names 63
Appearance task, described 65
application class editor. See PME
application class reports 152
application classes
characteristics 126
collection interval 20, 134
collectors 129, 130
custom 128–131
definition files 128
described 112
instance types, described 126
multiple instances 128
parameters and thresholds 112
publishing 128
requirements 128
single instance 127
types 127
application classes, custom
command shell collector 129
data collection requirements 128
PerfMon collector 130
publishing application classes 128
SNMP collector 130
Application Collector Status parameter 128
application server component on the Portal 19
arimportcmd command for importing reconciliation rules
191
authentication credentials for monitoring 22
AuthenticationHostUrl property in portalPortalWebServer.properties 293
Index
305
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
AuthenticationInfo property in portalPortalWebServer.properties 293
auto refresh for object views 44
availability report, formula 149, 278
avoiding duplicate events 201
B
base event class for event integration 199
base event class slot names 199
Blackout Periods task, described 50
BMC Atrium CMDB
as a source for infrastructure elements 55
BMC Performance Manager Portal as a consumer 190
BMC Performance Manager Portal as a provider
program 191
changing the number of hosts to return when adding
elements 279
configuring for the Portal 191
filtering infrastructure objects 43
importing reconciliation rules 191
integration with Portal, described 42
searching for infrastructure objects 42
searching the BMC.ASSET dataset 42
BMC Atrium CMDB Consumers 190
BMC Atrium CMDB Status for an element 44
BMC Atrium CMDB, receiving data from Portal 189
BMC II Web Services
configuring event integration, overview 196
configuring non-secure event integration 199
configuring secure event integration 197
high availability configuration 196
importing SSL certificate 197
user account notifications 56
BMC Impact Integration Web Services. See BMC II Web
Services
BMC Impact Manager solutions, event integration with
Portal 199
BMC Performance Manager Availability Report 156
BMC Performance Manager Logical Domain Report 156,
169
BMC Performance Manager Portal
rsm-RsmHostName.properties configuration file 293
BMC Performance Manager Portal CLI. See CLI for BMC
Performance Manager Portal
BMC Performance Manager Portal SDK 112
BMC Performance Manager Portal, described 17
BMC Performance Manager System Availability Report
170
BMC Performance Manager Zone and Pool Report 156,
169
BMC PM for Lightweight Protocols–DNS (core
Performance Manager) 123
BMC PM for Lightweight Protocols–Ping (core
Performance Manager) 123
306
BMC PM for Lightweight Protocols–Port Monitor (core
Performance Manager) 123
BMC PM for SNMP Traps (core Performance Manager) 92,
123
BMC PM Monitor (core Performance Manager) 123, 266
BMC Remote Service Monitor service 70
BMC Software, contacting 2
BMC.ASSET dataset in the BMC Atrium CMDB 42
BMC_PM_Reports.biar file, importing 158
BMC_PM-BusinessView.xml file, importing 159
BMC-Performance-Manager-Portal-MIB
described 207
location after installation 205
location on CD 204
OID described 205
bmcPMPortalAccountName OID 208
bmcPMPortalApplicationHierarchy OID 211
bmcPMPortalApplicationInstanceName OID 209
bmcPMPortalApplicationName OID 209
bmcPMPortalDetectedTime OID 210
bmcPMPortalDetectedTimeUtcStr OID 210
bmcPMPortalElementName OID 210
bmcPMPortalElementState OID 210
bmcPMPortalElementStateChange OID 208
bmcPMPortalEventReason OID 211
bmcPMPortalGroupName OID 208
bmcPMPortalHostName OID 209
bmcPMPortalParameterErrorCode OID 210
bmcPMPortalParameterName OID 209
bmcPMPortalParameterState OID 209
bmcPMPortalParameterStateChange OID 207
bmcPMPortalParameterThresholdValue OID 210
bmcPMPortalParameterValue OID 209
bmcPMPortalRsmClusterName OID 210
bmcPMPortalRsmClusterState OID 211
bmcPMPortalRsmName OID 210
bmcPMPortalRsmState OID 210
bmcPMPortalRsmStateChange OID 207
bpmcli commands
See also CLI for BMC Performance Manager Portal
addElements 223
addPATROL 228
deleteElements 230, 231
exportParameterHistory 240
getApplicationsForElement 244
getElements 245
getParameterHistory 246
getParameters 249
getPortalVersion 237, 250
getSubApplications 251
refreshDatafeedMetadata 232
refreshPATROL 234
savePassword 237
user restrictions 221
Business, top-level object group 59
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
C
calculating element availability 149
cell, receiving data from Portal 192
Change Password task, described 51
changing RSM credentials 102, 103
changing SNMP trap version 212
changing the maximum number of hosts to return from
the BMC Atrium CMDB 279
characters allowed
user names 63
charts
dashboard 153
list of all charts available on Reports tab 143
parameter history, multiple parameters 152
parameter history, single parameter 45
child classes
described 127
element profiles 52
CI. See configuration items in BMC Atrium CMDB
CLASS slot name 199
CLI for BMC Performance Manager Portal
See also bpmcli commands
adding a single element to the Portal 223
adding multiple elements to the Portal 225
deleting a single element from the Portal 230
deleting multiple elements from the Portal 231
exporting parameter history data to external database
240
getting all the elements in an account 245
getting child classes from specified application classes
251
getting parameter history for specified parameters 246
getting parameters from specified elements 249
getting the Portal version number 250
getting top-level applications in an element 244
hiding the user password 237
preparing client computer 220
refreshing metadata for CDE database 232
refreshing PATROL integration parameters 234
saving the user password in an encrypted file 237
synchronizing PATROL parameter thresholds in the
Portal 234
user restrictions 221
clustered RSMs
configuring 95
described 71
security considerations 94
upgrades 96
CMDB. See BMC Atrium CMDB
collection interval for application classes 20, 134
collection methods. See data collection methods for
Performance Managers
collectors for custom application classes
Command Shell 129
PerfMon 130
SNMP 130
Command Shell collector
guidelines for custom application classes 129
timeout value for application classes 293
command-line interface for Performance Manager
data. See CLI for BMC Performance Manager Portal
common slots in the base event class 199
communication between Portal and RSM 71, 73
communication interruptions between RSM and Portal 72
components of BMC Performance Manager Portal 18
configuration files
datafeed.properties 173, 274
drmop.properties 274, 276
jboss-service.xml 275
jmx-console-roles.properties 294
jmx-console-users.properties 294
padm.properties 274
portal-PortalHostName.properties 293
portal-PortalHostName-xmbean.xml 275, 294
rsm.properties 274
rsm-RsmHostName.properties 274, 293
configuration items in BMC Atrium CMDB 189
configuration tasks
About 50
Account Information 50
Administrators 65
Appearance 65
Blackout Periods 50
Change Password 51
Dashboards 51
Element Profiles 51
Elements 54
Global Properties 67
Licensing Information 66, 67
Mass Email 67
Monitoring On/Off 55
Notifications 55, 66
Object Groups 59
Performance Managers 67
Personal Preferences 60
Properties 66
Remote Service Monitors 60, 66, 68
Shared Credentials 60
Tags 61
User Groups 62
Users 63
Configure tab 50–63
ConnectionTimeout property in portalPortalHostName.properties 294
Console Server
list is empty when integrating PATROL data 256
methods for PATROL integration 29
security considerations 21
consumer program for the BMC Atrium CMDB 190
contacting Support, gathering RSM log files 105
continuously exporting data from the Portal 172–185
Index
307
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
core Performance Managers
BMC PM Monitor 266
delivered with the Portal 123
described 123
createDatafeedSchema.sql file 173, 174
credentials for monitoring
avoiding system lockouts on the monitored computer
61
changing for an RSM 102, 103
changing for the JMX console on the RSM 294
for monitoring infrastructure 22
for RSM program 86, 87
overriding in an element profile 53
Crystal Reports
generating enterprise reports 163
importing BMC_PM_Reports.biar file 158
importing BMC_PM-BusinessView.xml file 159
installing reporting components 155
integration prerequisites 155
modifying business view to point to CDE database
161
preparing data for integration 172
CSV file, defining maximum size 183
CSV input files
using to add elements with bpmcli 225, 227, 229
using to delete elements with bpmcli 231, 232
using to integrate PATROL parameter data 29, 37
using to refresh PATROL and Portal parameters 234
CSV output files
datafeed output file 175, 176–181
Performance Manager license information 66
custom application classes
collectors 128–131
described 128–131
custom Performance Managers
described 124
editing 132
customer support 3
customizing instance names for SNMP application classes
131
D
Dashboards task, described 51
dashboards with parameter history charts 153
Dashboards, top-level object group 59
data collection methods for Performance Managers
agentless 18, 42, 114
PATROL Agent integration 18, 115
data collection requirements for application classes 128
Data Execution Prevention. See DEP configuration for
RSM program
data extraction commands in bpmcli 238
data gaps 73
data modifications in custom application classes 127
data retention properties for object views
308
drmop.history.events.lag.periods 138
drmop.history.events.rollover.period 138
overview 137
portal.history.element.statusHistory.retention 138, 280
portal.history.parameter.summarization.disabled 138,
287
portal.history.parameter.summarizationDataPoint.rete
ntion 138, 289
portal.history.parameter.value.retention 137, 289
data summarization for report data 136, 287
datafeed utility 172–185
datafeed.properties file 173, 174, 183, 274
datafeedJob.sql 173
dataset.arx file 192
DB.BATCHSIZE property in
sampleDatafeedTarget.properties file 184, 244
DB.PASSWORD property in
sampleDatafeedTarget.properties file 180
DB.POOLSIZE property in
sampleDatafeedTarget.properties file 185
DB.USERNAME property in
sampleDatafeedTarget.properties file 180
dedicated RSMs, described 70
default (predefined) user account for the Portal 63, 266
default user for the predefined account 63, 266
definition files for custom application classes 128
Delete option in PME 125
deleteElements command for bpmcli 230, 231
deleting
discovered instances 128
elements from the Portal 54, 230, 231
Performance Managers from Portal 122, 123
RSMs from the Portal 106
DEP configuration for RSM program 76
Description property in rsm-RsmHostName.properties 293
desktop files, using to integrate PATROL parameter data
32
direct service model integration 192
discovering instances on elements 128
discovering PATROL Agents
using CSV files 37
using Management Profiles 30
using PATROL desktop files 32
using PET files 35
DisplayName property in rsm-RsmHostName.properties
293
DNS port configuration for firewall 74
drmop.applicationinstance.enabledeleteinactiveinstance
property 276
drmop.applicationinstance.maxinactiveminutes 277
drmop.default.reporting.interval.minutes 134
drmop.default.reporting.interval.minutes property 276
drmop.element.properties.allow.hostname.change
property 278
drmop.history.events.lag.periods property 138
drmop.history.events.rollover.period property 138
drmop.properties configuration file 274, 276
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
drmop.reports.availability.formula.exclude_time property
278
drmop.reports.availability.formula.up_time property 278
drmop.reports.topn.batch.job.timeout.minutes property
147, 278
E
Edit option in PME 125
Edit permission for administrators 64
editing Performance Managers
core Performance Managers 123, 266
overview 131
published custom Performance Managers 132
solution Performance Managers 124
unpublished Performance Managers 132
element attributes in Health At A Glance report 149
element availability 149
element events
in Events tab 216, 217
in Health At A Glance report 151
element host name, prohibiting users from changing 278
element profile, report update interval 54
Element Profiles task
described 51
effect on PATROL Agent integration 40
overriding properties and thresholds 53
element report data, sending from RSM to Portal 72
element reports 147
element status by time in Health At A Glance report 148
element status summary in Health At A Glance report 148
elements
adding to the account 25, 29, 223, 225
described 54
multiple element management 51, 60
prohibiting users from changing host names 278
report update interval 134
elements and their RSMs 73
Elements task, described 54
email messages as notifications
account level 55
enterprise level 194
enable.ula.alternate.ldap.search 279
encrypting the user password (bpmcli) 237
enterprise integration
AlarmPoint 196
BMC Impact Solutions 196
described 66, 188
email messages 194
events from PATROL Agents 201
SNMP traps 195
enterprise reports
generating enterprise reports 163
importing BMC_PM_Reports.biar file 158
importing BMC_PM-BusinessView.xml file 159
installing reporting components 155
integration prerequisites 155
modifying business view to point to CDE database
161
preparing the CDE database instance 172
error codes in SNMP traps 214
error messages for PATROL integration 258
event class extensions for PATROL_Portal 200
event history data retention 138
event integration
BMC Impact Solutions 196–200
email messages 194
SNMP traps 195
event severity for parameters, configuring thresholds 113
event table
purging 141
retention policy 141
Events tab
Alerts to Show list 217
described 215
Objects to Show list 216
page controls 217
time interval controls 144
Exceptions, top-level object group 59
exclude_time property for availability 278
excluding PATROL integration parameters to refresh 235
Export option in PME 125
exporting parameter data values
comparative parameter history reports 153
from a parameter history chart 46
from a parameter history table 46
Top N report 147
exportParameterHistory 139
exportParameterHistory command for bpmcli 240
F
failover for RSMs 94
FAILURE.CSVFILE.ROOT property in
sampleDatafeedTarget.properties file 185
file locations
BMC Performance Manager Portal module
configuration files 274
portal.log 295
RSM installation log file 91
rsm*.log 295
wrapper.log 295
filtering
infrastructure objects in BMC Atrium CMDB 43
parameter data on the Status tab 47
firewall configuration for application ports 74
formula for availability report 278
FTP port, firewall configuration 74
full access rights and permissions 50
Index
309
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
G
gaps in parameter data 73
general system problems
described 75, 204
notifications for all accounts in a provider 66
notifications for user accounts 55
RSMs 75
traps 208
getApplicationsForElement command for bpmcli 244
getElements command for bpmcli 245
getParameterHistory command for bpmcli 246
getParameters command for bpmcli 249
getPortalVersion command 237, 250
getPortalVersion command for bpmcli 250
getSubApplications command for bpmcli 251
Global Properties task, described 67
global RSMs, described 68, 71
H
HA. See high availability
HDE. See Historical Data Export utility
Health At A Glance report
adjusting availability formula 149, 278
described 147
printing 147
health monitoring for Portal 266
heap memory, changing on the RSM 104
heartbeat, communication from RSM to Portal 72
HeartbeatInterval property in portalPortalHostName.properties 293
hierarchy of an application class 126
high availability
BMC II Web Services server 196
clustered RSMs 92
Historical Data Export utility
configuring for use with no CDE database instance
243
exportParameterHistory command 240
refreshDatafeedMetadata 232
host names, ability to change for an element 278
hourly charts, data points on 144
HTTP port, firewall configuration 74
HTTPS port, firewall configuration 74
I
IIWS. See BMC II Web Services
IMAP server port, firewall configuration 74
impact relationships in the BMC Atrium CMDB 191
impersonating users 64
importing
BMC_PM_Reports.biar file 158
BMC_PM-BusinessView.xml file 159
310
certificate for BMC II Web Services Server 197
PAR files 118
Performance Managers 118
reconciliation rules for the BMC Atrium CMDB 191
inactive data, purge from history tables 140
INCLUSIVE_REGEX.AccountName property in
sampleDatafeedTarget.properties file 181
INCLUSIVE_REGEX.ApplicationPath property in
sampleDatafeedTarget.properties file 181
INCLUSIVE_REGEX.ProviderName property in
sampleDatafeedTarget.properties file 181
infrastructure status view for status 45
Infrastructure, top-level object group 59
installation
Crystal Reports 155
Performance Managers on Portal 118
RSM program 76
verifying, BMC Performance Manager Portal 24
installation directory for RSM program 108
installing the RSM program
copying from installation media 87
downloading program from the Portal 85
executing from a command line 90
locating installation log 91
instance name in SNMP application class 131
instance type in an application class, described 126
instances, discovering on elements 128
integrating Portal with other products
account integration 189
AlarmPoint 188, 189
BMC Atrium CMDB 189
BMC Impact Solutions, enterprise integration 196
enterprise management systems 205
Portal-wide integration 188
provider-wide integration 188
Service Impact Manager 192
SNMP traps, enterprise integration 195
interaction among BMC Performance Manager Portal
components 19
internal account types 65
interval at which RSM sends report data to Portal 134
interval at which the RSM collects data 20, 134
J
jboss-service.xml configuration file 275
jmx-console-roles.properties file on RSM 294
jmx-console-users.properties file on RSM 294
K
key parameters in Health At A Glance report 150
KMs, synchronizing thresholds and application classes 234
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
L
Licensing Information tasks, described 66, 67
Licensing tasks, described 66
load balancing RSMs 94
loading PAR files 118, 119
LOCALE property in sampleDatafeedTarget.properties file
185
lockouts on systems, preventing 61
log files
collecting Portal log files for Support 105
collecting RSM log files for Support 105
padm-err.nn 295
portal.log 258, 295
RSM installation 91
rsm.log file 295
viewing RSM log files 105
wrapper.log file 295
logical RSMs. See clustered RSMs
logs that show user activity 64
M
Management Profiles, using to integrate PATROL
parameter data
configuring 30
described 29
specifying RTserver for discovering agent thresholds
256
manually uninstalling the RSM program 107
Mass Email task, described 67
Master property in portal-PortalHostName.properties 294
maximum number of hosts to return from BMC Atrium
CMDB, changing 279
MaxStoreAndForwardTime property in portalPortalHostName.properties 294
MaxStoreAndForwardTime property in the portalPortalHostName.properties 72
mc_host slot name 199
mc_host_address slot name 199
mc_host_class slot name 199
mc_incident_time slot name 199
mc_object slot name 199
mc_object_class slot name 199
mc_origin slot name 199
mc_origin_class slot name 199
mc_origin_key slot name 200
mc_origin_sev slot name 200
mc_parameter slot name 200
mc_parameter_value slot name 200
mc_smc_alias slot name 200
mc_smc_id slot name 200
mc_tool slot name 200
mc_tool_class slot name 200
memory for the RSM, allocating heap memory for Java
VM 104
metadata, refreshing for CDE database 232
methods of data collection
agentless 114
PATROL Agent integration 115
MIB for Performance Manager Portal 205
module configuration files
BMC Performance Manager Portal 273
jboss-service.xml 275
module properties
datafeed.properties 274
drmop.properties 274, 276
jmx-console-roles.properties 294
jmx-console-users.properties 294
padm.properties 274, 292
portal-PortalHostName-xmbean.xml 275
rsm.properties 274
rsm-RsmHostName.properties 274
monitoring interval. See collection interval
Monitoring On/Off task, described 55
monitoring the Portal components 266
monitors. See RSMs
msg slot name 200
multiple parameter history charts 152
multiple-instance application classes 128
N
Name property in portal-PortalHostName.properties 294
Network Service Port firewall configuration 74
NNTP Server port, firewall configuration 74
notification rules, described 56
notification templates for notification rules 57
notification transports
BMC II Web Services 196–200
described 55
email messages 57
SNMP traps 195
notifications
enable for unknown and OK status changes 58
OK-unknown status 58
unknown-OK status 58
notifications for RSM general system problems 75
Notifications task
described 55, 66
using to avoid duplicate events 201
O
object group reports 144
Object Groups task, described 59
object identifier. See OID
object views
data policies 137
Events tab 215
Reports tab 143–153
Index
311
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
object views (continued)
Status tab 44
time interval controls 144, 146
Objects to Show list on Events tab 216
OID
individual descriptions 207
structure description for MIB 205
Ok-Unknown events
purging 141
OK-unknown status
notifications 58
overriding element profile settings 53
overview of Portal 15
P
padm.migrate.locking property 292
padm.migrate.schedule.limit property 292
padm.migrate.schedule.max property 292
padm.migrate.schedule.wait property 292
padm.migrate.threshold.update.exclude.list property 292
padm.migrate.wait.timeout property 292
padm.properties file 274, 292
padm-err.nn log file 295
page controls
Events tab 216, 217
Reports tab 144, 146, 152
Status tab 44
page description for Performance Managers page 125
PAR files
deleting 122
described 118
importing 119
installing 118, 119
uninstalling 122
upgrading by importing individual PAR files 121
upgrading during a Portal upgrade 120
parameter collection interval 20, 134
parameter data
filtering by status 47
gaps 73
RSM communication type 72
parameter events in Events tab 216, 217
parameter history charts
dashboard views 153
Health At A Glance report 148
multiple parameters 152
single parameter 45
Top N report 146
parameter history tables 46
parameter mapping for PATROL integration Performance
Managers 115
parameter sets. See application classes
parameter thresholds
configuring event severity 113
312
configuring for PATROL integration application
classes 28
configuring status changes 113
overview 112
parameter type in an application class, described 127
parameter value range in custom application classes 127
parsing SNMP traps for product integration 206
password administration. See Shared Credentials task
PATROL Agent Availability and Health Monitor (core
Performance Manager) 123
PATROL Agent Availability and Health Monitor
application class 271
PATROL Agent integration
additional security requirements 21
avoiding duplicate events 201
communication between RSM and PATROL Agents 74
effect of element profiles 40
error messages 258
parameter mapping 115
Performance Managers described 115
properties file 292
RSM security requirements 75
setting the maximum number of Agents to refresh at a
time 292
synchronizing more than 100 elements 40
synchronizing thresholds and application classes 234,
292
PATROL desktop files, using to integrate PATROL
parameter data 32
PATROL Event Translation. See PET files
PATROL Integration option for adding elements 29
PATROL integration Performance Managers
See also PATROL Agent integration
described 18, 27
threshold configuration 28
threshold discovery 28
threshold mapping 116
PATROL_Portal event class extensions 200
patsdk-commandshell-solution.patsdkcommandshell.timeout property 293
patsdk-snmp-solution.patsdk-snmp.timeout property 293
patsdk-snmp-solution.patsdk-snmp-trap
.MatchedTrapContents.showWholeTrap property 293
paying account types 65
PerfMon collector 130
Performance Manager Editor. See PME, described
Performance Managers
agentless 18, 114
automatic installation 118
core 123
custom 124
deleting 122
deployed to RSMs 73
described 17
editing custom published Performance Managers 132
editing unpublished Performance Managers 132
importing 119
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Performance Managers (continued)
installed on the Portal 73
installing manually 119
location in the Portal 17
methods of data collection 18
overview 73
PATROL integration 18, 115
publishing 128
removing from the Portal 122
solution 124
upgrading 120
verifying upgrades 27
Performance Managers license reports for accounts in a
provider 66
Performance Managers page, described 125
Performance Managers task, described 67
permissions and rights for users 17, 50
permissions for monitoring Portal components 266
Personal Preferences task, described 60
PET files, using to integrate PATROL parameter data 35
Ping application, firewall configuration 74
PME, described 124
POP server port, firewall configuration 74
Portal administrator 64
Portal administrator credentials 86
Portal and RSM communication 71
Portal application server component of the Portal 19
Portal components, monitoring 266
Portal credentials 64
Portal history tables, purging inactive data 139
Portal integration
AlarmPoint 196
service model 189, 192
SNMP traps 195
Portal overview 15
Portal status view 45
Portal tab tasks for administrators 67
portal.cmdb.search.max.hosts.to.return property 279
portal.CsvDataFeedClient.dateFormat property 177
portal.CsvDataFeedClient.filenameRoot property 176
portal.CsvDataFeedClient.printHeader property 176
portal.datafeed.apppathcache.size property in
datafeed.properties file 175
portal.datafeed.apppathcache.timetoidle.seconds property
in datafeed.properties file 175
portal.datafeed.apppathcache.timetolive.seconds property
in datafeed.properties file 175
portal.datafeed.csvfile.maximumsize 183
portal.datafeed.queued.parameter.limit property in
datafeed.properties file 184
portal.datafeed.threadpool.size property 244
portal.datafeed.threadpool.size property in
datafeed.properties file 184
portal.events.element.limit property 279
portal.events.element.param.limit property 216, 279
portal.events.param.limit property 216, 280
portal.events.prevent.unknown property 58, 280
portal.history.alertjob.truncate.enable 287
portal.history.element.statusHistory.retention property 280
portal.history.event.retention property 281
portal.history.event.rollover.period property 281
portal.history.events.purgeunknown.cleanunknownevents
.enabled 141
portal.history.events.purgeunknown.cleanunknownevents
.enabled property 282
portal.history.events.purgeunknown.scheduledays 141
portal.history.events.purgeunknown.scheduledays
property 282
portal.history.events.purgeunknown.schedulehours 142
portal.history.events.purgeunknown.schedulehours
property 283
portal.history.events.purgeunused.cleanunusedevents.ena
bled property 283
portal.history.events.purgeunused.scheduledays property
284
portal.history.events.purgeunused.schedulehours property
284
portal.history.jmsmessages.delete.enable property 286
portal.history.parameter.purgepsdp.scheduledays 140
portal.history.parameter.purgepsdp.scheduledays
property 288
portal.history.parameter.purgepsdp.schedulehours 140
portal.history.parameter.purgepsdp.schedulehours
property 288
portal.history.parameter.summarization.disabled property
287
portal.history.parameter.summarizationDataPoint.cleanina
ctiveparameter.enabled 140
portal.history.parameter.summarizationDataPoint.cleanina
ctiveparameter.enabled property 287
portal.history.parameter.summarizationDataPoint.retentio
n property 289
portal.history.parameter.value.retention property 289
portal.history.websdk.activitylog.retention property 285
portal.history.websdk.agentstatushistory.retention
property 285
portal.history.websdk.eventnotification.retention property
286
portal.history.websdk.parameterstatushistory.retention
property 285
portal.history.websdk.rsmmessage.retention property 285
portal.history.websdk.websdkalertjob.retention property
286
portal.JdbcDataFeedClient.configDir property in
datafeed.properties file 176
portal.log file 258, 295
portal.rsmcommunication.queueWatcher.workerThreads
property 289
portal.ssh.private.key.file.max.size property 290
portal.upgrade.transaction.timeout property 290
portal.utd.timeout.sec property 290
portal-PortalHostName.properties configuration file 293
portal-PortalHostName-xmbean.xml configuration file 294
ports, firewall configuration 74
Index
313
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
predefined settings
account 63, 266
Portal administrator 64
provider administrator 64
user 63, 266
prerequisites for monitoring, RSM computer 76
primary user, described 50
printing object views
Health At A Glance report 147
Status tab 45
Top N report 147
product support 3
profiles for elements See element profiles.
program upgrade for RSMs 72
prohibited characters
user names 63
Properties task, described 66
provider administrator 64
provider administrator credentials 86
provider credentials 64
provider program for the BMC Atrium CMDB 190, 191
provider reports 66
Provider tab tasks for administrators 65
proxy server configuration for an RSM 100
Publish option in PME 125
publishing Performance Managers 128
purge event table 141
R
read-only permission for administrators 64
read-only rights and permissions for users 50
reconrules.arx file 192
refreshDatafeedMetadata command for bpmcli 232, 243
refreshing object views 44
refreshPATROL command for bpmcli 234
remote monitoring
agent-based 18, 115
agentless 18, 42, 114
Remote Service Monitors task, described 60, 66, 68
Remote Service Monitors. See RSMs
RemoteServiceMonitor.exe file for a command line
installation 89
removing Performance Managers 122
report data
See also enterprise reports
account view 144
application class view 152
infrastructure element view 147
object group view 144
printing 147
retention policies for data 137
standard parameter values 135
summarization of data 136
time interval controls 144, 146
report for provider 66
314
report update interval
affect of state change on interval 134
described 20, 72
report update interval, element profile change 54
reports
availability 156, 170
logical domain 156, 169
zone and pool 156, 169
Reports tab 143–153
restrictions for editing Performance Managers
core 123, 266
custom 132
solution 124
retention policies
CDE data 182
changing retention time 280, 287, 289
report data, described 137
retention policies for report data 289
rights and permissions for users 17, 50
RSM configuration files
jboss-service.xml 275
portal-PortalHostName-xmbean.xml 275
rsm.properties 274
rsm-RsmHostName.properties 274
RSM log file 295
RSM Maintenance Tool
changing heap memory allocated for Java VM 104
changing RSM credentials 103
collecting RSM log files 105
launching the utility 98
silent installation 90
silent uninstallation 109
viewing RSM log files 105
RSM Manager utility
changing RSM credentials 102
configuring HTTP communication with Portal 101
configuring RSM to use a proxy server 100
described 97
launching 97
RSM program
See also RSMs
allocating heap memory for the Java VM on RSM 104
collecting log files for Support 105
configuring for Portal monitoring 267
installation credentials 86, 87
installation directory, default 108
installing from a command line 90
installing from installation media 87
installing from Portal 85
log file location 295
preparing to install the program 76
RSM Manager utility 97
rsm*.log file, location 295
service name 70
system requirements 76
uninstalling 106, 107, 109
wrapper.log file, location 295
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
RSM security
changing the security level 99
requirements 21
rsm*.log file 105, 295
rsm.download.protocol property 290
rsm.properties file 293
rsm_install_log.txt file 91
RSMOptions.txt file for a silent installation from a
command line 90
rsm-RsmHostName.properties configuration file 293
RSMs
See also RSM program
assigned to elements 73
changing credentials 102, 103
changing maximum heap memory 104
changing the credentials for the JMX console 294
changing the security level 99
clustering 95
communication interruptions with Portal, cached data
on the RSM 72
communication with elements 74
communication with PATROL Agents 74
communication with Portal 71, 72
data gaps 73
dedicated 70
deleting from Portal 106
described 19, 60
failover 94
global 68, 71
HTTP communication to Portal, setting 101
installation log file, locating 91
load balancing 94
log files 295
notifications about system problems 75
overview 17
problems with Windows 2003 254
program upgrade 72
proxy server, configuring 100
security level, determining 99
security requirements 21
shared 66, 70
store and forward, overview 73
types 70
rstatd firewall configuration 74
RTservers
specifying for Solaris Portal 257
specifying for Windows Portal 257
S
sample SNMP trap 213
sampleDatafeedTarget.properties file 173, 174, 180
SDK for creating Performance Managers 112
searching for objects in the BMC Atrium CMDB 42
Secure Hash Algorithm (SHA) 22
security
additional security for Portal 21
changing for an RSM that co-exists with PATROL
products 99
changing for an RSM that does not coexist with
PATROL products 99
changing for the BMC Performance Manager Portal
257
clustered RSMs 94
how the installation program assigns security to an
RSM 99
requirements for RSM 21
RSM security for agentless monitoring 74
RSM security for PATROL Agent integration
monitoring 75
security level
changing 99
described 20
determining for the RSM 99
See Other Providers and Their Accounts permission for
administrators 64
self monitoring for the Portal components 266
service model integration
BMC Atrium CMDB 189
direct to cell 192
service name for Remote Service Monitor 70
severity slot name 200
SHA. See Secure Hash Algorithm (SHA)
shared credentials
custom PerfMon application classes 130
custom Telnet and SSH application classes 129
described 60
Shared Credentials task, described 60
shared RSMs, described 66, 70
silent mode
installing RSM program 88
uninstalling RSM program 109
single-instance application classes 127
size of SNMP traps sent by Portal 212
slot names in the base event class populated for the Portal
199
SMTP server, firewall configuration 74
SNMP collector
described 130
MIB dependencies 130
problems with more than 20 top-level parameters 131
SNMP collector timeout value 293
SNMP firewall configuration 74
SNMP Trap Listener application class and clustered RSMs
92
SNMP traps
account-level notifications 56
BMC-Performance-Manager-Portal-MIB 204
changing maximum trap size 212
changing SNMP trap version 212
changing the maximum number of parameters in a
trap 204
customizing trap properties 211
Index
315
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
SNMP traps (continued)
error codes 214
MIB description 207
OID description 205
parsing SNMP traps 206
provider level notifications 195
sample trap 213
user notifications 189
snmp.max.parameter.events.to.process property 204, 291
snmp.trap.max.recv.size property 212
snmp.trap.showappinstsingleton property 291
snmp.trap.showlastapp property 291
snmp.trap.version property 212
solution Performance Managers, described 124
solutions. See Performance Managers
SSH collection protocol 129
SSH Server port, firewall configuration 74
state changes
notification for the enterprise 66, 188
notifications for user accounts 55
status
filtered by parameter status 47
infrastructure status view 45
portal status view 45
return values from bpmcli 250
Status tab 44
store and forward for RSM, overview 73
summarization of report data 136
support, customer 3
synchronizing thresholds and KM application classes 234,
292
system lockouts, preventing 61
system requirements for RSM program 76
T
table, parameter history 46
tabs
Accounts 64
configure 50
Events 215
Portal 67
Provider 65
Reports 143–153
Status 44
Tags task, described 61
tasks for configuration
About 50
Account Information 50
Administrators 65
Appearance 65
Blackout Periods 50
Change Password 51
Dashboards 51
Element Profiles 51
Elements 54
316
Global Properties 67
Licensing Information 67
Mass Email 67
Monitoring On/Off 55
Notifications 55, 66
Object Groups 59
Performance Managers 67
Personal Preferences 60
Properties 66
Remote Service Monitors 60, 66, 68
Shared Credentials 60
Tags 61
User Groups 62
Users 63
technical support 3
Telnet collection protocol 129
Telnet server port, firewall configuration 74
templates for configuring elements See element profiles.
templates for notification rules 57
thresholds
configuring for parameters 26, 113
mapping for PATROL integration 116
overriding in an element profile 53
PATROL integration, discovering in background
process 258
refreshing PATROL integration 41, 234
synchronizing with KM application classes 234
violations, communication from RSM to Portal 72
time interval controls for object views 144, 146
Timeout property in portal-PortalHostName.properties
294
timeout values for application classes 293
Top N report
changing the timeout wait period for the report 147,
278
described 144
exporting parameter data 147
printing 147
top parameters causing alerts in Health At A Glance
report 148
top-level object groups 59
traps, SNMP
changing maximum trap size 212
changing SNMP version 212
changing the maximum number of parameters in a
trap 204
error codes 214
parsing 206
sample trap 213
trial account types 65
troubleshooting
cannot find errors when data discovery runs in the
background 258
Console Server list is empty 256
monitoring problems 253
PATROL integration requires security change on
Portal 257
BMC Performance Manager Portal Monitoring and Management Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
RSM requires permission changes for PerfMon 254
RSM upgrade fails on Windows 2003 SP1 255
U
uninstalling Performance Managers 122
uninstalling the RSM program 106, 107, 109
Unknown-OK events
purging 141
unknown-OK status
notifications 58
up_time property for availability 278
updating registry key on Windows operating system 254,
255
upgrades
clustered RSMs 96
effect on communication between Portal and RSMs 73
Performance Managers 120
RSM 91
verifying, Performance Manager 27
UseCompression property in portalPortalHostName.properties 294
user
configuration options 50
impersonating 64
predefined in Portal 63, 266
restrictions for using bpmcli 221
user credentials 86
User Groups task, described 62
user name
allowed characters 63
user notification. See notifications
Users task, described 63
UseSsl property in portal-PortalHostName.properties on
RSM 294
V
verifying BMC Performance Manager Portal installation 24
verifying Performance Manager upgrades 27
version of SNMP trap, changing 212
Version property in rsm-RsmHostName.properties 293
W
warning and alarm thresholds in a parameter, described
127
websdk.services.notification.ok.unknown.support
property 58
WEBSDKV10-MIB, described 204
Windows operating systems application classes, firewall
configuration 74
Windows operating systems, problems for RSM
computers 254
wrapper.log file 295
Index
317
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
318
BMC Performance Manager Portal Monitoring and Management Guide
Notes
*94168*
*94168*
*94168*
*94168*
*94168*
">