Professional Documents
Culture Documents
BMC Impact Solutions 7.3 - Infrastructure Management Guide PDF
BMC Impact Solutions 7.3 - Infrastructure Management Guide PDF
Infrastructure Management
Guide
Supporting
BMC Impact Manager version 7.3
BMC Impact Administration Server 7.3
BMC Impact Explorer version 7.3
BMC Impact Portal version 7.3
February 2009
www.bmc.com
Telephone
Fax
Fax
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
s
s
s
s
s
s
s
s
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
product information
product name
product version (release number)
license number and password (trial or permanent)
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
messages received (and the time and date that you received them)
Contents
Chapter 1
23
65
Contents
77
Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Command line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Impact Administration cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
How to configure BMC Impact Administration server files . . . . . . . . . . . . . . . . . . . . . 81
Guidelines for manual edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Users, groups, roles, and permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Defining permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Full Access role permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Adding customized role/permission mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Defining group roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
File-based authentication: updating user information . . . . . . . . . . . . . . . . . . . . . . . 91
Adding role names to the cells KB definition files. . . . . . . . . . . . . . . . . . . . . . . . . . 93
Receiving synchronized data from the BMC Portal . . . . . . . . . . . . . . . . . . . . . . . . . 93
Synchronizing cell information with BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . 95
Updating cell information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Editing logging properties for IAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Defining client logging for the iadmin script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Customizing colors for severities, statuses, and priorities. . . . . . . . . . . . . . . . . . . . 99
IAS Status Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Customizing the IAS thread pool handling IAS Clients . . . . . . . . . . . . . . . . . . . . 100
Defining standalone, primary, and secondary BMC Impact Administration
servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Defining a failover configuration for the Impact Administration cell . . . . . . . . . 105
Transaction and trace logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Example trace output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Advanced tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Configuring BMC Impact Administration server to support remote actions. . . 107
Configuring Lightweight Directory Access Protocol for BMC Impact
Administration server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Problem: Cell_info.list synchronization error during manual configuration of an
IAS failover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Chapter 4
121
122
122
123
123
124
124
124
124
125
126
127
127
129
130
130
131
132
132
133
134
136
Chapter 5
139
Contents
140
142
142
142
144
145
146
148
149
150
152
156
157
158
159
160
163
164
165
165
165
169
172
172
177
187
197
209
228
231
235
237
238
243
245
248
249
251
257
262
264
265
267
268
269
272
272
273
274
274
276
278
280
281
283
284
287
287
288
290
291
292
292
293
Index
297
Contents
10
Figures
ConnectionPortRange syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Distributed event management using event propagation . . . . . . . . . . . . . . . . . . . . . . 33
Format of an entry in the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Example of the mcell.dir file and its entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Passive connection format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Data object specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
mcell.modify file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Masking syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Format of configuration line in mcell.trace file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Knowledge Base directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Output from mgetinfo kbsources argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Relation among users, groups, roles, and permissions . . . . . . . . . . . . . . . . . . . . . . . . . 82
Excerpt from ldap_configuration.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Default Infrastructure Management service model . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Infrastructure Management navigation pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Default service model BMC Impact Solutions (with active services) . . . . . . . . . . . . 144
Edit Relationships dialog with Edit This Relationship subdialog . . . . . . . . . . . . . . . 156
Actions right-click menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
High availability (HA) view: two cell servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Actions right-click menu for OVO adapter cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
default.econ.config file contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Operator.econ.config file contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Default policy file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Listing of the contents of a keystore file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Parameters used to print event in BAROC format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Example of printed events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Command to configure the export file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
gateway.export file format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
gateway.explore file output for new events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
gateway.explore file output for modified events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
mccomp syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
mccomp example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Example output for mccomp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
mcell syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Starting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Starting a cell as a service on windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Starting the BMC Impact Manager service on Microsoft Windows . . . . . . . . . . . . . 217
mcfgtrace syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
mcfgtrace example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
mclassinfo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Figures
11
12
Figures
248
248
248
249
249
250
250
250
251
252
252
254
255
255
256
257
258
258
259
259
261
261
261
263
263
264
264
265
266
267
268
269
272
285
13
14
Tables
BMC Impact Solutions configuration process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Cell configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Substitution parameters for %X in path value parameters . . . . . . . . . . . . . . . . . . . . . . 29
Default mcell.propagate options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
IP Address parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Files for cell reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
MC_CELL_METRIC slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Default values for client parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
MC_CELL_CLIENT slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
MC_CELL_MODIFIED_EVENT slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Trace configuration file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
MC_CELL_PROCESS_ERROR slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
BMC Impact Manager exit codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
SIM_NOTIFICATION_REGISTRY dialog box fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Knowledge Base subdirectories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Knowledge Base file extensions and directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Configurable IAS files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
iadmin options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
BMC Impact Explorer user group mapping to functionality . . . . . . . . . . . . . . . . . . . 83
Groups and roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Cell entry format in cell_info.list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Server logging properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
IAS status monitoring properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
IAS thread pool properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
IAS synchronization properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
mcell.dir entries for a failover pair of Impact Administration cells . . . . . . . . . . . . . 105
IAS log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
LDAP configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Event operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Event Table column default values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Status table column default values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Report parameters (application.properties file) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Report parameters (internal.properties) file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
application.properties file in smsIwc directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
application.properties file in smsConsoleServer directory . . . . . . . . . . . . . . . . . . . . . 134
aggregator.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
internal.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Supported application groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Icon listing for infrastructure management model . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Slot values: Details: General subtab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Tables
15
16
Tables
238
239
239
240
243
244
245
246
249
251
252
257
257
260
262
263
263
264
265
266
266
267
268
268
269
270
274
274
276
278
279
280
281
284
286
287
287
288
290
291
292
292
293
17
18
Chapter
This chapter describes how to manage and configure BMC Impact Manager cells.
General configuration overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Cell configuration tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring mcell.conf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Configuring event slot propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuring passive connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Configuring slots for time stamping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Reloading cell configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Managing high availability cell servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Manually failing over to the secondary server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Manually switching back to the secondary server . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Automatic failover process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Automatic switchback process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Explicitly connecting a CLI to a selected high availability cell server. . . . . . . . . . 47
Monitoring event performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Monitoring client to cell interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring cell tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configuring mcell.trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring a destination for cell trace output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Sending trace output to another cell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Event processing errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Automatic notification of trace configuration changes . . . . . . . . . . . . . . . . . . . . . . 56
Interpreting cell execution failure codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Using the BMC IX Administration view to manage cells . . . . . . . . . . . . . . . . . . . . . . . 58
Connecting or disconnecting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Viewing cell information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Registering for SIM notification events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Trouble-shooting BMC Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Problem: The cell will not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Problem: The primary and secondary servers for my high availability cell are in
active mode simultaneously or are unsynchronized. . . . . . . . . . . . . . . . . . . . . . 63
Chapter 1 Managing BMC Impact Manager cells
23
Task Description
1
Component
s
s
s
Chapter 8, Configuring
StateBuilder and gateways
Chapter 7, Defining
presentation names
s
s
s
After you configure BMC Impact Manager, BMC Impact Portal, and BMC Impact
Explorer, you are ready to implement event management and service impact
management. For information, consult the following resources:
24
Event management
For information about setting up adapters to collect events, see the BMC Impact
Event Adapters User Guide.
For information about setting up dynamic data, policies, event groups, and
image views, see the BMC Impact Solutions Event Management Guide.
For information about defining event data, writing event management rules,
defining collectors, or creating actions, see the BMC Impact Solutions Event
Management Guide.
SIM cell
Enables publishing of service models from a development sandbox to a test
environment before promoting them to a production environment. Each BMC
Impact Service Model Editor user has one dedicated test environment, which
consists of a pair of test CMDB data sets and an alias to a test cell. Promoted service
model components include those in a users sandbox and in production. For details
about test environments and promotion, see the BMC Impact Solutions Service
Modeling and Publishing Guide.
EM cell
For event management, a test cell provides KB developers with a test environment
for defining event classes, event management rules, policies, actions, and collectors
and testing their behavior with test event data.
BMC Impact Portal does not collect events from test cells for reporting.
25
To view and create test event management policies, select a test cell in the
Administration view.
26
To view test event data, collectors, and actions, select a test cell in the Events view.
To view test service model components, use the Find tool in the Services view and
select a test cell.
Task
Description
Creating cell-specific
configuration files on page 30
If you created multiple cells for an environment, configure a high BMC Impact Solutions Getting Started
availability cell or cells.
Guide
Managing high availability cell
servers on page 44
Events can be processed locally or selectively propagated to other Configuring event slot
cells. To configure the event slots that must be propagated when propagation on page 31
they are changed configure the propagation configuration file.
To add a time stamp to a slot so that the date and time is recorded Configuring slots for time
when the slot is changed, configure the mcell.modify file.
stamping on page 37
Configuring encryption on
page 38
27
2 Create line entries using the format Parameter=Value based on the syntax rules
described in Rules for cell configuration parameter syntax.
Typically, the value for a parameter is a Boolean value, a string, or a path. The
supported Boolean values are Yes/No and On/Off.
The Boolean values are not case sensitive, so, for example, On, ON, on, and even
oN are equally valid.
Do not enclose the value in quotation marks unless you want the quotation marks
to be part of the value.
By default, all parameter settings are disabled, that is, commented out with a #
sign at the beginning of the line of code. Enable a parameter setting by removing
the # sign that precedes it.
28
absolute pathstarts with slash (/) or backslash (\), or on Windows, with a drive
designator (for example, D:)
runtime relative pathstarts with ./ or ../. The path is relative from the cells
working directory. The working directory is the root directory (/) when it runs as a
daemon or a service. When running in foreground, it is the directory where mcell
is started.
configuration relative pathall other path values are relative from the cells
configuration directory, or, for program paths, from the kb\bin directory.
Path values can contain the substitution parameters $VAR or %X. Any $VAR parameter
is substituted by the value of the environment variable VAR. Table 3 lists the possible
%X substitution parameters.
Table 3
Parameter
Description
%H
%C
%B
%L
%T
%P
program name
%N
cell name
29
If you change the default value for the SystemLogDirName parameter or the
KBDirName parameter in the mcell.conf file, you must also change the value in the
statbld.conf file. If you fail to do this, the cell loses persistency and the mcdb file is not
created, because the StateBuilder is configured from statbld.conf file and has no input
from the mcell.conf file. As a result, StateBuilder does not know where to find the log
files or the KB directory it requires.
ConnectionPortRange syntax
Figure 1 shows the syntax of ConnectionPortRange.
Figure 1
ConnectionPortRange syntax
1828, 1829, 1840 specifies the sequence of ports 1828, 1829, and 1840
2 Using a text editor, edit the configuration file and customize it for that cell and
save it.
You can copy and edit any configuration file located in the MCELL_HOME\etc
directory.
3 Either reload the cell configuration or stop and start the cell so that the changes
take affect.
30
Knowledge Base)
s
of the cell
s
High availability cells use the cell-specific directories, but the names of the log and
tmp directories are suffixed with # followed by the server number, 1 for the primary
server and 2 for the secondary server. The names become:
s
s
s
s
$MCELL_HOME/log/CellName# 1
$MCELL_HOME/log/CellName# 2
$MCELL_HOME/tmp/CellName# 1
$MCELL_HOME/tmp/CellName# 2
31
For the mcell.propagate file to be effective, one or more Propagate rules must be
running. For information about Propagate rules, see the BMC Impact Solutions
Knowledge Base Development Reference Guide.
The format is Slotname = Value, where:
Slotname = slot name or CLASS for class-specific slots
Value = sequence of { b = backward f = forward }
You can specify a slot in the base CORE_EVENT class. However, if you want to specify
a slot outside those in the base CORE_EVENT class you must use the CLASS specifier,
which means that all class-specific slots are propagated in the direction given.
Table 4 on page 32 lists the parameters in the mcell.propagate file and the defaults.
Table 4
Parameter
Action Performed
Default
Values
administrator propagates administrator value changes up (forward) within the cell hierarchy
CLASS
mc_modhist
repeat_count
severity
status
propagates status value changes in both directions, backward and forward, in the bf
cell hierarchy
If you have multiple instances of BMC Impact Manager installed, you might want to
use event propagation to distribute the event processing load among the cells or to
back up events on another cell for failover.
Figure 2 on page 33 illustrates a cell network that is collecting and processing
numerous events in a distributed environment.
32
Figure 2
cell
cell
cell
cell
cell
event
sources
cell
event
sources
event
sources
event
sources
In this illustration, the lower-level cells process the source events and then propagate
(or forward) the events on to higher-level cells according to a Propagate rule or an
Event Propagation policy. As events pass through a series of cells, the cells discard
unneeded events, identify and leave behind unimportant events, and resolve some of
the problems reported by other events.
To enable event propagation, perform the following tasks:
s
s
s
s
33
If the cell cannot propagate events, the cell stores the events to be propagated in the
destination buffers and the requests for propagation of those events in the
propagation buffer. When the buffers become full, the cell automatically expands the
buffer size by a specified percentage (10 percent, by default), unless the buffer has
exceeded a maximum size. By default, the maximum buffer size is unlimited,
although the practical limit of the buffer size is the amount of available memory.
Once the maximum defined buffer size is reached, additional requests will fail.
When automatic expansion occurs, an MC_CELL_RESOURCE_EXPANSION event is
generated.
An expanded buffer will contain free space after propagation has resumed. To free
memory resources, the buffer will be reduced when it contains more than the
specified amount of free space. Reduction will leave enough free space to avoid the
need for an immediate expansion. The buffer will never be reduced below the
specified minimum size. When the buffer is reduced, an MC_CELL_RESOURCE_
REDUCTION event is generated.
Parameters controlling the buffer size are located in the mcell.conf file. For
information on configuring these parameters, see Propagation parameters on
page 288.
#
## One line per component :
# <Type> <Name> <EncryptionKey> <IpAddress/Port>
# <Type> = cell | gateway.type
#
# cell
ComponentName
# gateway.portal
bip.fullyqualifiedHostName
# admin
ImpactAdministrationServerName
34
EncryptionKey
EncryptionKey
UserID/Password
Host/1828
Host/3783
Host/3084
Description
Type
Name
Name is an abstract name for the component. Component names are not case-sensitive and
may be any alphanumeric string, including underscores (_).
A Portal name is, by convention, the fully qualified host name of the Portal host, prefixed
with bip.
String to be used as part of the key for the encryption of the communication between a cell
and the component. Default value is 0 (zero).
EncryptionKey
Note: If the string has an odd number of characters, the last character is ignored.
For an IAS component, the string must have the form UserID/Password, or be 0. If the
value is non-zero, the indicated UserId and Password are used as IAS login credentials.
IPAddress/Port
Host name or IP address and port number on which the component is listening. Default
port number for a cell is 1828 and for a Portal is 3783.
#
## One line per component :
# <Type> <Name> <EncryptionKey> <IpAddress/Port>
# <Type> = cell | gateway.type
#
cell
bos-71
mc
cell
local
mc
gateway.portal
bip.bos-71.amc.com
mc
admin
ias1
Mac/FreeAI1
cell
sim1
mc
bos-71/1828
127.0.0.1/1828
bos-71/3783
bos-71/3084
pprod001:1828 bprod001:1828
Cells may be grouped into separate cell files readable only by certain users or
groups (domains).
35
The mcell.dir file may define any number of entries, but each entry must be on a
separate line.
You can place mcell.dir files on remote mountable partitions or distribute them
using rdist, tftp, or any other distribution mechanism.
NOTE
A passive connection is only possible with the server type clients, such as the cell and
gateway clients.
36
The cell slot, as defined in the MC_CELL_HEARTBEAT superclass, gives the name of the
passive client. The enable slot in the superclass specifies whether or not monitoring
and reconnection is enabled. The cell attempts to connect to passive client targets as
configured with the standard connection parameters. As soon as a connection is
established, the connection is reversed. At that moment, the client takes up the
connection and behaves as an ordinary client.
37
Configuring encryption
2 Create a line entry containing the name of the slot whose modification is to be time
stamped. Figure 7 shows an example of the mcell.modify file.
Figure 7
mcell.modify file
When CLASS is used as a slot name, all class-specific slots or slots not defined in the
base class CORE_EVENT update the mc_modification_date slot with a time stamp.
Configuring encryption
You can encrypt communication among the various BMC Impact Solutions
components. To enable encryption, make the appropriate settings in the following
locations:
s
s
s
s
38
Configuring encryption
Encryption
ForceEncryption
EncryptionKey
If Encryption is set to Yes, encrypted communication to and from the cell is enabled,
but not required. For example, if a BMC Impact Explorer does not have encryption
enabled, then the communication with that particular BMC Impact Explorer console
is not encrypted.
ForceEncryption requires encryption for all communications. If the BMC Impact
Explorer attempts an unencrypted connection to the cell, the connection is rejected.
The encryption process uses the EncryptionKey value as part of the encoding key. If
there is no encryption, the EncryptionKey value has no effect.
Encryption
EncryptionKey
For more information about the CLI configuration parameters, see BMC Impact
Manager CLI configuration on page 269.
Characters of the encryption key are grouped in pairs. If the string has an odd
number of characters, the last character is ignored.
Each pair is converted to an 8-bit value. The first character of the pair determines
the four most significant bits, the second character determines the four least
significant bits.
39
Configuring encryption
Information retrieval
A component must have the address and port of a cell to establish communications
with it. To establish encrypted communications, the component must also have the
encryption key of the cell. BMC Impact Explorer and the CLI commands determine
the information in different ways:
s
BMC Impact Explorer acquires the information from the BMC Impact
Administration server (cell_info.list).
BMC Impact CLI commands obtain the information by determining the server
location using one of the following methods:
directly from the CLI command
from CLI configuration parameters in mclient.conf
from mcell.dir if you use the -n cellName option
40
Configuring encryption
Default values
The default value for cellName is the name of the host (hostName). The default value
for the port is 1828.
When the mcell.dir file is present, the default value is EncryptionKey=mc at
installation. BMC Software recommends that you modify this value for security.
If the mcell.dir file is absent on the host and you do not specify an encryption key, the
CLI command uses 0 (zero) as the default value for EncryptionKey. This value
enables encrypted communications.
NOTE
You can disable encryption by setting the configuration parameter to Encryption=No. You
might want to use this setting to disable encryption while tracing.
These conditions apply with the default installation. However, if the mcell.dir file is
present on the host, and the file specifies the encryption key, you are only required to
specify the cellName.
Masking syntax
41
Configuring encryption
When the Mask is all zeros, any address matches regardless of the value of Addr. For
all Mask bits whose value is one (1), the equivalent bits in Addr must match the
equivalent bits in the source address.
Table 5 lists the IP address parameters.
Table 5
IP Address parameters
Parameter
Description
AllowConnectionFrom=0./0
AllowConnectionFrom=0./32
no system allowed
(00.00.00.00 is not a valid IP address)
AllowConnectionFrom=198.12./255.255.
AllowConnectionFrom=127.0.0.1/1
AllowConnectionFrom=198.12.33./
255.255.255.:198.12.92./255.255.255.
The default is 0./0, indicating that the server should accept connections from any
source. Usually this is useful only for testing or debugging, or for use with a system
that is isolated from the network.
To specify one single address, specify the address without a mask, or use a 32-bit
mask. The following examples are equivalent ways of specifying a single address:
s
s
s
42
127.0.0.1
127.0.0.1/32
127.0.0.1/255.255.255.255
When you specify more than one address per mask pair, a system that matches at
least one of the pairs can accept a connection.
Run the mcontrol command on UNIX or Windows. For information about the
mcontrol command, see mcontrolPerforming cell control operations on
page 228.
Table 6 lists the specific instances in which the reconfigure feature can be used and
the effect that results from its use.
Table 6
Type
Name/Directory
Result of reconfiguration
cell directory
mcell.dira
cell tracing
mcell.tracea
Tracing is adapted and has the same effect as through the mcfgtrace
CLI.
cell
configuration
mcell.conf
mcell.propagate
mcell.modify
KB collector
kb\collectors
43
Table 6
Type
Name/Directory
Result of reconfiguration
KB program
kb\classes
\kb\rules
\kb\lib
\kb\bin
KB data
kb\data
\kb\records
a
For mcell.dir and mcell.trace, a hang-up signal on a UNIX platform performs maximum reconfiguration
without a cell restart. For information about restarting a cell, see Interpreting cell execution failure codes
on page 56.
WARNING
The primary and secondary servers of a high availability pair must run on two different
logical OS images of the same type. Primary and secondary servers of a high availability pair
running on the same system or running on different operating systems is not supported.
The highest possible availability for a cell occurs when two server machines are close
to each other with a highly reliable network connection. When the two server
machines are on remote sites, the high availability cell functions more like a Disaster
Recovery system.
Only one of the two servers should be active at any time.
WARNING
It is highly recommended that you disable automatic failover and enable manual failover
when the connection between the primary and secondary server is unreliable. Otherwise,
there is a risk that both primary and secondary servers would be active at the same time when
they cannot communicate with each other, due to network problems.
Although it is technically possible to activate both servers, this is not supported. If both
servers are activated, incompatible server states can occur. If the server states are
incompatible, manual intervention is required to re-synchronize the primary and secondary
servers. If this situation occurs, see Problem: The primary and secondary servers for my high
availability cell are in active mode simultaneously or are unsynchronized. on page 63.
44
WARNING
It is highly recommended that you disable automatic failover and enable manual failover
when the connection between the primary and secondary server is unreliable. Otherwise,
there is a risk that both primary and secondary servers would be active at the same time when
they cannot communicate with each other. This situation is not supported. If this situation
occurs, see Problem: The primary and secondary servers for my high availability cell are in
active mode simultaneously or are unsynchronized. on page 63.
45
WARNING
You must explicitly include the #1 suffix after the cell name or the mkill command will
terminate the secondary cell if the command cannot connect to the primary cell.
3 Transfer the state file from the secondary to the primary server:
s
This example retrieves the activity level of the secondary cell server.
Another method is to enter the cell name, followed by # and the server number (1 for
primary and 2 for secondary). For example:
mgetinfo -n CellName#2 -v activity
47
Metrics are stored in MC_CELL_METRIC data objects, one object instance for each
metric. Each metric mentions the subject. For each of the short-, medium-, and longterm results, it contains the length of the interval, in seconds, and the total count. An
average per second is also provided, rounded to an integer. Other averages per
second, minute, or hour can be calculated by the application from this information, if
needed.
A configuration parameter, CellMetricsEnabled, determines whether metrics are
collected or not.
The mcontrol CLI is used to switch metric collection on and off, and to reset the
counters. Short- and medium-term metrics are reset whenever metrics are disabled.
Metrics can be retrieved through rules by data object access, or through a command.
The BMC Impact Explorer console and the mgetinfo CLI can use that command.
The received event counter does not include incoming messages that cannot be
parsed as events. It does include events of nonexistent classes or events with
erroneous slots. These are added to the erroneous event counter. Internally generated
events are counted as received events. Dropped events include those that are
dropped when an event with the same universal ID exists.
Table 7 lists the metrics data objects MC_CELL_METRIC slots.
Table 7
MC_CELL_METRIC slots
Slot
Description
description
metric description
long_average
long_interval
long_total
medium_average
medium_interval
medium_total
short_average
short_interval
short_total
subject
48
ReceivedEvents
ErrorEvents
DroppedEvents
StoredEvents
RemovedEvents
PropagatedEvents
Parameter
Value
ReportConnectClients
ReportModifyClients
Every parameter corresponds to a reporting clients set. Such a set has a positive and a
negative list. Clients that belong to the positive list will have their operation reported
while operations performed by clients on the negative list will not be reported.
Clients that are not named in the parameter are considered to be on the default list.
The default list initially is the negative list. The default list can be modified through a
special setting of the parameter.
A value for a reporting configuration parameter consists of a comma separated
sequence of client names. Every client name can be prefixed with a minus sign (-) or
a plus sign (+). The client name prefixed with the minus sign (-) is added to the
negative list. When not prefixed, or prefixed with a plus sign (+), it is added to the
positive list.
49
The special value ALL in place of a client name refers to the default. Including ALL or
+ALL modifies the default list so it becomes the positive list. With -ALL, the default list
is the negative list. Both parameters could include -ALL, as this is the default setting
for clients that are not explicitly mentioned.
The superclass for client operation related events is MC_CELL_CLIENT. Table 9 lists the
slots.
Table 9
MC_CELL_CLIENT slots
Slot
Data
client_location
client_name
client_type
MC_CELL_MODIFIED_EVENT slots
Slot
Data
event
requestor
You can also configure cell tracing using the mcfgtrace command. For further
information, see mcfgtraceConfiguring tracing on page 218.
50
Configuring mcell.trace
Configuring mcell.trace
The trace configuration file, mcell.trace, configures the tracing of the cells operation.
Tracing messages are divided in several levels. Every module of the cell can be
configured differently. An output destination can be determined per message level
and per module. Messages also can be disabled at the same granularity.
The default location is MCELL_HOME\etc.
The configuration commands in mcell.trace are incremental. Every new command
adds to the configuration, possibly overriding previous commands either completely
or partly.
Figure 9 shows the format of a configuration line in the mcell.trace file.
.
Figure 9
<Module>
SWITCH
<Destination>
<Destination>
Parameter
Description
Destination
destination file name or predefined value for the selected trace messages or
switch
predefined values:
nodisables these tracing messages
consolesends to the console device
stderrsends to standard error stream
Levela
FATAL
ERROR
WARNING
s
s
INFORM
VERBOSE
51
Table 11
Parameter
Description
Modulea
ACTION
COLLECT
COLLMAP
CONFIG
CONTROL
DATAPROC
DBDATAID
DBEVTID
DBEVTTM
EVTLOG
EVTPROC
EXPORT
FILTER
s
s
s
s
s
s
s
s
s
s
s
s
HEARTBEAT
INTEVT
MC2TEC
MCBAROC
MESSAGES
METRIC
PROPAGATE
QUERY
RECOVERY
RECTRL
REGEX
REGULATE
s
s
s
s
s
s
s
s
s
s
s
s
RESULT
ROLES
RULES
SERVICE
SRVMGT
STATBLD
SVCMGT
SVRCOMM
SVRDIR
SYNCH
SYSPROC
TRACE
SWITCH
Switch
switch name
the console
the standard error stream
an external file or files
no trace output
In addition to sending trace output to one of these destinations, you also can send
trace output to another cell. For information, see Sending trace output to another
cell on page 53.
52
WARNING
The MCELL_HOME\tmp\cellName directory is for temporary files only. A trace file placed
in that directory will be deleted by the cell when it restarts. To maintain your trace file across
cell sessions, place it in a different directory.
53
add a propagate rule to the Knowledge Base to specify which trace log events have
to be propagated to which destination(s)
Once configured, the cell trace module will generate an internal event for each trace
log message.
54
This setting specifies that events must be generated for messages from all modules, of
all but the VERBOSE level.
WARNING
Event tracing should be configured with care, as it may produce an excessive number of
events. In particular, VERBOSE level messages should not be configured as events.
For more information about the trace configuration parameters in mcell.conf, see
Trace parameters on page 293.
Adding a propagate rule to the Knowledge Base to specify which trace log
events have to be propagated to which destination(s)
The propagate rule syntax is described in the BMC Impact Solutions Knowledge Base
Development Reference Guide.
The following is an example of a propagate rule for trace log events:
propagate PropTraceEvents: MC_CELL_LOG_MSG
to CentralAdminCell
END
55
Table 12
MC_CELL_PROCESS_ERROR slots
Slot
Data
error_code
error_goal
error_message
error_source
event
noindicates disabling
56
If the cell service setup fails, an error file, mcell.err, is generated. Additional service
setup failures can be appended to the original file, resulting in a file content of
multiple lines. Normally, each line corresponds to one failed service setup. This error
file contains exit codes specific to BMC Impact Manager.
Table 13 lists the exit codes for BMC Impact Manager.
Table 13
Code
Description
16
17
19
27
29
37
39
47
49
57
59
67
69
77
79
97
57
For more information on using BMC Impact Explorer, see Chapter 6, Managing the
BMC Impact Explorer (BMC IX) console and the BMC Impact Solutions Event Management
Guide.
58
The Impact Manager Info dialog box appears with cell property information
presented on the Info tab.
3 To refresh the information in the Workload tab of this dialog box, click Refresh in
the top right corner of the tab.
SIM_COMPONENT_CHANGE
SIM_COMPONENT_DELETE
SIM_COMPONENT_OVERWRITE
SIM_RELATIONSHIP_CHANGE
SIM_RELATIONSHIP_DELETE
NOTE
In the mc_sm_notify.baroc file under mcell_home/etc/cellName/kb/classes, you can view the
definitions of the SIM_NOTIFICATION_EVENT base class and the event classes
SIM_COMPONENT_CHANGE, SIM_COMPONENT_DELETE, SIM_COMPONENT_OVERWRITE,
SIM_RELATIONSHIP_CHANGE, and SIM_RELATIONSHIP_DELETE.
59
NOTE
Refer to the BMC Impact Solutions: Knowledge Base Development Reference for mposter examples
that show how to register for notification events.
4 Right-click SIM_NOTIFICATION_REGISTRY.
5 Select New.
6 Fill in the editable fields in the SIM_NOTIFICATION_REGISTRY dialog box.
Table 14
Field
Description
mc_udid
populated automatically
client_data
allows you to define a rule set for the SIM notification events that your
client has registered for. For example, the rule could look for the text
john in the client_data to determine if it is a state change requested by
john.
The content of this slot is copied to the client_data slot of the corresponding
SIM notification event. Each SIM_NOTIFICATION_REGISTRY data instance
must have a different value for this slot. This slot is available only in BMC
Impact Manager versions 7.0.x and later.
clients
comma-separated list of clients where the notification must be sent. The clients
in the list must be defined in mcell.dir.
By default, the cell name is listed as the client in mcell.dir, so you do not
need to change mcell.dir if you are sending events internally.
requested_notifications
notification_mode
SIM_COMPONENT_CHANGE
SIM_COMPONENT_DELETE
SIM_COMPONENT_OVERWRITE
SIM_RELATIONSHIP_CHANGE
SIM_RELATIONSHIP_DELETE
specifies how slot values that have not changed are reported in the SIM
notification event
s
DELTA the slots whose values do not change are reported with their
default values, not their current values. The default value is an empty
string for symbolic values and -1 for numer ic values. See the .baroc class
definition of the SIM notification event for the default slot values.
FULL the current values of all slots are reported, including those that
have not changed
61
Table 14
Field
Description
notifications_at_registration instructs the cell whether or not to send the current component states at the
moment of registration
s
YES instructs the cell to send the current component state at the
moment of registration
NO instructs the cell not to send the current component state at the
moment of registration
filter contains one class name. When you specify a class name, only state
change notifications for configuration items of this class or a sub-class are
generated.
asset_filter
7 Click OK.
In the Administration tab, the new SIM_NOTIFICATION_REGISTRY instance is
displayed under SIM_NOTIFICATION_REGISTRY.
62
mcdb.0
mcdb.lock
63
Problem: The primary and secondary servers for my high availability cell are in active mode simultaneously or are
1 If the problem was caused by an unreliable network, resolve the network issue.
2 Shut down both cell servers
3 Copy the mcdb and xact files of the preferred server to the other server. (The
preferred server can be either primary or secondary.)
64
Chapter
Chapter 2
66
66
66
70
70
70
71
71
71
72
72
72
65
NOTE
The SIM code of the unified KB is active only if the cell is configured as a SIM cell and the
ServiceModelEnabled parameter of the MCELL_HOME/etc/mcell.conf file is set to Yes.
For additional information about the mcell.conf parameters, see Appendix B, mcell.conf file
parameters.
The Event Management-only KB, stored under MCELL_HOME/etc/default/EM/kb,
remains for backward compatibility with versions of the mcrtcell CLI older than version
7.2.00. It contains the KB elements used by Event Management to process events.
When you create or install a new cell using the mcrtcell command, you always create
or install a unified SIM KB in the newly-created cells KB directory path:
MCELL_HOME/etc/CellName/kb. Modifications to the KB in the CellName/kb directory
apply to the CellName cell only.
If you modify the template KB in either MCELL_HOME\etc\default\SIM or
MCELL_HOME\etc\default\EM any cell that you install or create will include those
modifications.
66
Cells are created during installation of a BMC Impact Manager instance or by using
the mcrtcell command. For information about this command, see mcrtcell
Creating a new cell on page 231.
NOTE
The environment variables created during installation that define paths to BMC Impact
Manager configuration files and executables are listed in the BMC Impact Solutions Installation
Guide.
kb
\bin
\A
\h1
\l2
\p4
\s5
\w4
\classes
\collectors
\data
\lib
\records
\rules
In the Knowledge Base, each subdirectory is labeled to indicate the type of files or
programs it stores, as listed in Table 15 on page 68.
Chapter 2
67
Table 15
Knowledge
Base
subdirectory Description
stores the external scripts that can execute during rule processing and actions that can be run
from BMC Impact Explorer
bin
The bin directory organizes the scripts and programs in subdirectories specific to the
appropriate operating system, as follows:
s
s
s
s
s
s
The .load file in the bin directory specifies the order in which external scripts or programs are
presented to clients. Actions are defined in .mrl files. There is one default file, .load, in the bin
directory. Actions and their syntax are described in the BMC Impact Solutions Event Management
Guide.
stores event class, data class, and interface definitions
classes
Classes are stored in .baroc files. The .load file in the classes directory specifies the order in
which classes are loaded. Parent classes must be loaded prior to child classes.
Event and data classes are described in the BMC Impact Solutions Knowledge Base Development
Reference Guide.
collectors
data
instances of dynamic data stored in files that are loaded when the cell is initialized
Dynamic data instances are stored in .baroc files. The .load file indicates the order in which the
files are loaded into the cell. After the values are loaded into the cell any changes are
maintained in the mcell.db. Dynamic data objects and their syntax are described in the BMC
Impact Solutions Knowledge Base Development Reference Guide and in the BMC Impact Solutions
Event Management Guide.
lib
For more information about functions and primitives, see the BMC Impact Solutions Knowledge
Base Development Reference Guide.
68
Table 15
Knowledge
Base
subdirectory Description
records
stores global record definitions, which store dynamic information across all rule phases
A global record stores persistent dynamic information in a .baroc file. Many rule processing
phases use global records for retrieving dynamic information. The .load file indicates the order
in which the files are loaded into the cell. The default copy of record definitions is stored in
baroc files in the records directory. After the values are loaded they are maintained in the
mcell.db. Dynamic data objects and their syntax are described in the BMC Impact Solutions
Knowledge Base Development Reference Guide and in the BMC Impact Solutions Event Management
Guide.
rules
Table 16 lists the file extensions and directory location for the each of the components
contained in a KB.
Table 16
Component
File extension
Directory
event classes
.baroc
kb\classes
data classes
.baroc
kb\classes
data instances
.baroc
kb\data
global records
.baroc
kb\records
rules
.mrl
kb\rules
collectors
.mrl
kb\collector
action executables
.mrl
kb\bin
.baroc
kb\classes
interface classes
.baroc
kb\classes
not applicable
kb\bin\platform
Chapter 2
69
manifest.kbserves as an index file for the listed directories that compose the
.loadwicBefore the compilation of the Knowledge Base, rules and collectors are
created in .mrl files and are included in the .load files. After compilation, rule and
collector files are stored in .wic files and a .loadwic file is created for the KB to use.
The .wic files are machine-readable only.
NOTE
To protect the format of the default Knowledge Base, back it up prior to making any
modifications. An adequate backup includes all directories and files in the kb directory or the
directory where the changes occur.
You can also use source-control programs such as CVS or Subversion to keep track of changes
to the KB. Source control allows you to revert to older versions of the KB and to examine
changes.
70
1 Create a new cell using the mcrtcell CLI with either the -ae or -as option.
2 Copy the modifications or extensions youve made in old cells KB to the new cells
KB.
To do so, you can manually edit the files or use your specific utilities.
NOTE
To use the mkb command to manipulate an existing KB, you must use the -f parameter to
define the path to the manifest.kb file and specify the action that the mkb command should
execute.
Chapter 2
71
NOTE
The TraceRuleLevel parameter in the mcell.conf file must be set to 2 for rules tracing to
occur.
72
KB source files For each KB source file that you specify, information about the
source file is provided and the version of the compiler that was used to compile it.
Logical KB modulesVersion information is provided for each logical module that
you identify in the KB.
Enabling KB versioning
To enable versioning, you must create logical modules in the KB. To identify the files
for a particular module, add the @kbversion annotation to the KB source files, using
the following syntax:
@kbversion( [ ModuleName , ] VersionID )
Variable
Description
ModuleName
specifies the name of the module to which the current file belongs
To indicate version information for the global module, either use the empty
string as ModuleName or omit ModuleName.
VersionID
WARNING
Multiple @kbversion annotations for the same module will result in a compilation error.
This also applies to a global version; only one annotation without a module name is allowed
in a KB.
The mccomp command compiles the @kbversion annotations into the KB object files
and includes the following information about each source file in the KB:
s
s
s
s
s
s
Chapter 2
73
KB versioning example
@kbversion( HelpDesk , '1.2.01' )
This example specifies that the KB contains a logical module called HelpDesk, and
that its version is 1.2.01.
Argument
Returned results
kbmodules
kbsources
The information is displayed in raw format. You can use the -v switch to obtain the
information in a more readable format. Figure 11 on page 75 shows a portion of the
information returned from the kbsources argument.
74
Figure 11
Chapter 2
75
76
Chapter
77
Configuration files
Configuration files
End users can configure the following IAS file listed in Table 17. These files are
located under the IMPACT_SOLUTIONS_HOME/server/conf directory.
Table 17
IAS file
Description
ias.properties
user_definitions.xml
ldap_configuration.xml
role_permissions.xml
group_roles.xml
cell_info.list
cmdb.properties
server_logging.properties
client_logging.properties
defines the logging properties for the client when you use
the iadmin command
color.properties
credential_repository.xml
ldap_configuration_query.xml
default_role_permissions.xml
defines the view and edit permissions for each tab view
and menu option in BMC IX
NOTE
The full path to the server directory under IMPACT_SOLUTIONS_HOME is
/opt/bmc/Impact/server on UNIX and drive letter:\Program Files\BMC
Software\Impact\server on MS Windows.
78
You can use the iadmin command to manage the following configuration files:
s
s
s
s
s
user_definitions.xml
group_roles.xml
cell_info.list
role_permissions.xml
credential_repository.xml
Remember that you do not have to restart IAS to initialize your changes if you use the
iadmin command.
You can execute the iadmin command against an IAS on the local system. You cannot
execute the iadmin command against an IAS on a remote system.
The iadmin options are summarized below in Table 18 on page 79. You can display
these options from the command line by entering iadmin -h.
Table 18
Option
Description
-ac
add a cell to the cell_info.list file and register the cell with the BMC
Impact Administration Server
-mc
modify a cell
-dc
delete a cell
-lc
-aru
-mru
-dru
-lru
-ar
-dr
-lr
-mr
-ag
-dg
-lg
-mg
-acr
-mcr
-dcr
-lcr
-cp
change the current password of an existing user. Requires that you enter
the current password
79
Table 18
Option
Description
-rp
reset the password of an existing user. In this option, you enter the new
password only. You do not enter the current password
-reinit [fullsync
| actions]
-sync
-tlq
NOTE
Refer to the BMC Impact Solutions Event Management Guide for a description of the -acr, -mcr, dcr, -lcr, and [actions] options in its discussion of remote execution.
password=$able_baker
s
s
80
Admin
IAC
mc
mc
hostName:1827
hostName:1827
Admin is the default name of the Impact Administration cell. The default name is
provided at installation. It is the same name as the IAS instance name. Its default port
number is 1827.
You can change the default name of the IAC and the IAS instance name
simultaneously during installation as an installation option. After installation, you
can change the name of the IAC independent of the IAS instance name. You can
change the default port number as long as the port number that you assign does not
conflict with any other.
IAC is the alias name that other cells use to propagate events to the Impact
Administration cell.
Each SIM or BEM cell that registers with an Impact Administration cell and a Master
IAS should have an IAC entry in its mcell.dir file along with its own cell name, as in
the following example:
cell
cell
cellName
IAC
mc
mc
hostName:1828
hostName:1827
Depending on the goal of the task, you may need to edit multiple files.
81
You can create new users, groups, and roles. You cannot, however, create new
permissions. You can only select from a predefined list of existing permissions.
82
Defining permissions
Defining permissions
The default_role_permissions.xml file defines the view and edit permissions for each
tab view and menu option in BMC IX. For each role, it lists the permissions in a
comma-separated string as shown in the following extract for the Full Access role:
....
<properties>
<entry key="Full Access">administration_tab_view_and_access,
events_tab_view_and_access,services_tab_view_and_access,
services_tab_access_component_event_list,
events_tab_edit_drill_down,events_tab_edit_user_event_filter,
events_tab_edit_user_slot_order, .....
</entry>
....
</properties>
WARNING
Do not modify the default_role_permissions.xml file. Use the role_permissions.xml file
instead.
Any permission that you add or modify must be taken from the predefined
default_role_permissions.xml file.
Table 19 on page 83 matches the default mapping of roles/permissions to BMC IX
functionality.
Supervisors
Operators
Admins
Read Only
Service Operator
Service Manager
Service Administrator
Full Access
Function
Choices
Table 19
Dashboards-Create,
update, and delete
all profiles
Edit
Dashboards-Create
and delete own
profiles only
Edit
Dashboards (SIEM)
View
83
Defining permissions
Operators
Supervisors
Dashboards (CIEM)
View
Events tab
View
ConfigurationEdit
Relationship View
Edit
ConfigurationEdit
Personal Filters
Edit
ConfigurationEdit
Personal Attribute
(Slot) Orders
Edit
ConfigurationEdit
Personal
MetaCollectors
Edit
ConfigurationEdit
Global Event Filters
Edit
ConfigurationEdit
Global Attribute
(Slot) Orders
Edit
ConfigurationEdit
Impact Manager
Group on Impact
Manager
Configuration
window
Edit
Events tab-Show
Impact
Administration cell
Edit
Events tabJump
from an Event to Its
Services Impacted
View
Edit
Events tabReopen
Events
Edit
84
Read Only
Service Operator
Service Manager
Service Administrator
Full Access
Choices
Function
Admins
Table 19
Defining permissions
Events tabEvent
Operation
Supervisor
Privileges (for
example, close
events owned by
someone else)
Edit
Events tabAssign
Events
Edit
Events tabAdd
Image View
Edit
Events tabDelete
Image View
Edit
Services tab
View
Services tabSearch
for Service
Components
Edit
Services tab-Create
and delete
components
Edit
Services tabEvent
List View of a
Service Component
View
Services tab-Create,
Edit, Delete
Relationship
between
components
Edit
Services tabSet or
Remove Manual
Status (of a
component) Action
Edit
Supervisors
Operators
Admins
Read Only
Service Operator
Service Manager
Service Administrator
Full Access
Function
Choices
Table 19
X
X
85
Services tabSet or
Clear Maintenance
Mode (of a
Component) Action
Edit
Administration tab
View
Timeframes
Edit
Administration tab:
all actions
Edit
Infrastructure
Edit
Management subtab
Infrastructure
Edit
Management subtab:
all actions
Remote Actions:
Create remote
actions
Edit
Edit
Supervisors
Operators
Admins
Read Only
Service Operator
Service Manager
Service Administrator
Full Access
Function
Choices
Table 19
86
87
NOTE
If the role to be deleted only exists in the default file, then an entry is added to the userdefined file. The entry contains the role name only, without any permissions associated with
it. Because the user-defined entry overrides the default one, the role is effectively deleted.
The entry role=Test is written to the user-defined file and effectively overrides any
identical role in the default file.
88
Table 20
Group
Role
Full Access
Read Only
Service Administrators
Service Managers
Service Managers
Service Operators
Service Operators
Admins
Operators
Supervisors
NOTE
If you are using Lightweight Directory Access Protocol (LDAP) authentication, you
must map your LDAP user groups to the IAS roles defined in the group_roles.xml file.
See Configuring Lightweight Directory Access Protocol for BMC Impact Administration
server on page 109 for more information.
You can update user groups and roles and create new ones by editing the
group_roles.xml file, shown below:
<!DOCTYPE properties SYSTEM
"http://java.sun.com/dtd/properties.dtd">
<!--Each entry's key is the Group name and the value is the list of
Roles assigned to that group-->
<properties>
<entry key="Full Access">Full Access</entry>
<entry key="Read Only">Read Only</entry>
<entry key="Service Administrators">Service Administrators</entry>
<entry key="Service Managers">Service Managers</entry>
<entry key="Service Managers - Senior">Service Managers Senior</entry>
<entry key="Service Operators">Service Operators</entry>
<entry key="Service Operators - Senior">Service Operators Senior</entry>
<entry key="Admins">Full Access,Service Administrators</entry>
<entry key="Operators">Service Operators,Service Operators Senior</entry>
<entry key="Supervisors">Service Managers - Senior,Service
Operators - Senior</entry>
</properties>
89
Any roles that you add to a group must have already been defined in the
group_roles.xml file.
90
2 In the user_definitions.xml file, define the users attributes. These include user id,
password, group names and their descriptions, and so forth.
You can use the iadmin command to update user information in the
user_definitions.xml if you have enabled file-based authentication. You can add,
modify, or delete users, and you can modify the password of an existing user.
The user_definitions.xml file defines a user ID, password, and group of a specified
user, as in the default example below:
<?xml version="1.0" encoding="UTF-8"?>
<userList xmlns="urn:bmc:schemas:impact"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:bmc:schemas:impact user_definitions.xsd ">
<user userid="user">
<password encrypted="false">user</password>
<groupList>Full Access</groupList>
<description>This is optional</description>
</user>
</userList>
91
NOTE
On UNIX platforms, execute the iadmin command that contains a password value without the
bash shell.
92
93
The BMC Portal connects with IAS through IASs administrative account. The default
password is IAS$Admin$. (There is no user name associated with administrative
access.) During synchronization, only BMC Portal user groups that have defined
permissions in BMC IX are exported. You can check for the permissions in the User
Groups task off of the Configure tab in the BMC Portal. Look for permissions that
begin Impact Explorer.
BMC Portal groups are mapped to IAS roles with the same name. When a BMC Portal
group is exported to IAS, a new role is created in IAS with the same name. To
illustrate, if the BMC Portal group abc is exported to IAS, a role/permission mapping
is created in IAS for abc and all the permissions that abc maps to in the BMC Portal.
Then IAS creates a group/role mapping abc/abc.
User passwords are not exported, but are set to the default value user.
Any cells that are added to the BMC Portal are registered with IAS.
For the Atrium installation scenario, BMC Atrium CMDB parameters are not
synchronized with either the BMC Portal or IAS. They need to be added manually.
In LDAP authentication, the IAS and BMC Portal connect separately to an LDAP
server. The mappings of BMC Portal groups to LDAP group mappings are sent to IAS
as group to role mappings. The BMC Portal uses the fully qualified distinguished
name for an LDAP group (for example, ldapG1.bmc.com) while the IAS uses the
common name (ldapG1). For example, if the BMC Portal group abc maps to several
LDAP groupsfor example, ldapG1.bmc.com and ldapG2.bmc.comthen IAS
creates the following group/role mappings: abc/abc, ldapG1/abc, and ldapG2/abc.
To set up LDAP authentication in IAS, see Configuring Lightweight Directory
Access Protocol for BMC Impact Administration server on page 109.
94
3 Enter the port number of the AR Server. If the AR Server is using portmapper, then
enter 0.
4 Enter the AR Server user Id that you use for accessing the BMC Atrium CMDB.
5 Enter the password in plain text. When IAS restarts, it encrypts the password and
displays the encryption in the file.
95
Entry
Description
cell
required. Each entry must begin with cell. The cell type is
appended after cell, with a period separating cell and the
type. The available cell types are SIM, BEM, and Admin. IAS
retrieves the type from the cell and appends to the entry.
name
key
primaryHost
primaryPort
failoverHost
failoverPort
environment
Production or Test.
usergroups
user group or groups who can access this cell. If all groups
can access the cell, enter an asterisk. Otherwise enter the user
group name, separating multiple groups with commas. If the
group name contains a space, use double quotation marks to
enclose the entire name.
To add/register a cell
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory,
execute the iadmin command using the -ac option, as in the following example:
iadmin -ac name=testCell:key=mc:primaryHost=moondog:primaryPort=1828:
failoverHost=suncat:failoverPort=1828:environment=Production:usergroups=*
96
The cell information is added to the cell_info.list. It is also added to the BMC Atrium
CMDB if the cell is synchronized with BMC Atrium CMDB as defined in the
cmdb.properties.
To ensure that the cell is registered with the IAS, be sure that its mcell.dir file contains
the IAC entry, as in the following example:
cell
IAC
mc
myComputer.adprod.bmc.com:1827
The IAC entry enables event propagation between the cell and the Admin cell that is
part of the IAS.
To modify a cell
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory,
execute the iadmin command using the -mc option. After you specify the cell name,
you only to need to include the options that you are changing, as in the following
example:
iadmin -mc name=testCell:failoverHost=null:environment=Test
In this example, the secondary cell is removed and thus failoverHost is defined by
null. The environment is changed from Production to Test. If you were to change the
primaryHost or primaryPort value, then IAS connects to the cell to retrieve its type.
All updates are saved into the cell_info.list and to the BMC Atrium CMDB, if the cell
is synchronized with the BMC Atrium CMDB.
To delete a cell
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory,
execute the iadmin command using the -dc option to delete a cell from the
cell_info.list, as in the following example:
iadmin -dc name=testCell
If the cell is synchronized with the BMC Atrium CMDB, it is removed from the
CMDB.
To list cells
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory,
execute the iadmin command using the -lc option, as in the following example:
iadmin -lc
97
logging level
file name and path
maximum size of each file
number of log files in a cycle
Property
Description
.level
message levels that the log captures. The default is INFO. The log
ignores all levels lower than the specified one. The values range
from SEVERE to FINEST.
java.util.logging.FileHandler.pattern specifies the file name, file path, and the generated numeral that
distinguishes the log file cycle. The default pattern
/tmp/ias/ias%g.log.
java.util.logging.FileHandler.limit
the maximum size of each log file in bytes. The default is 5 million
bytes (about 5 MB).
java.util.logging.FileHandler.count
maximum number of log files in each cycle. The default is 10. After
the maximum number of files is reached, a new cycle starts and the
new log files override the existing ones in sequence.
After you make changes, save the server_logging.properties file, and restart IAS.
98
NOTE
These changes to the color properties do not affect the icon colors.
You should be consistent when changing the color values of the same parameter. For
example, if you change the color for DOWN to indicate event severity, you should
make the same change to the DOWN parameter for service component status.
Otherwise, if you specify different colors, one color change overrides the other.
After you make changes, save the color.properties file, and restart IAS.
s
s
s
s
List of clients connected to IAS and the corresponding threads IDs of threads in
IAS serving it
Threads count (user, daemon) in the IAS application at that instant
Peak thread count of the IAS application
Memory consumption of the IAS application
Other services information (like memory consumed and thread count) running on
the machine hosting the IAS application
Operating System information
99
Table 23
Property
Description
com.bmc.sms.ixs.appAuditLogEnable
com.bmc.sms.ixs.appAuditLogFilename
Specifies the log file name and its format. "%g" the generation
number to distinguish rotated logs.
com.bmc.sms.ixs.appAuditLogLimit
com.bmc.sms.ixs.appAuditLogFileCount
Specifies how many output files to cycle through, that is, the
number of files to use.
com.bmc.sms.ixs.applicationAuditInterval
Code examples follow that show sample IAS Status Monitoring configuration
parameters.
# IAS Status Monitoring Enable
com.bmc.sms.ixs.appAuditLogEnable=true
# Status Monitoring Audit File Name
com.bmc.sms.ixs.appAuditLogFilename=log/ias/IAS_App_Audit_File#%g.log
# Status Monitoring Audit Log Limit
com.bmc.sms.ixs.appAuditLogLimit=50000
# Status Monitoring Audit Log File Count
com.bmc.sms.ixs.appAuditLogFileCount=10
# Status Monitoring Audit Log Interval
com.bmc.sms.ixs.applicationAuditInterval=60
Property
Description
100
Table 24
Property
Description
com.bmc.sms.ixs.iasclient.threadManager.ke Specifies the maximum time that excess idle threads will wait
ep_Alive_Time
for new tasks before terminating. Excess idle threads occur
when the number of idle threads in the thread pool is more
than the core pool size.
com.bmc.sms.ixs.iasclient.threadManager.ke Specifies the time unit for the keepAliveTime argument. The
ep_Alive_Time_Unit
possible values are DAYS, HOURS, MINUTES, or SECONDS.
NOTE
The property com.bmc.sms.ixs.thread.pool.size is not applicable in 7.3.00 and 7.2.x,
if the patch for thread pool changes is applied.
Do not modify the properties
com.bmc.sms.ixs.iasclient.threadManager.keep_Alive_Time and
com.bmc.sms.ixs.iasclient.threadManager.keep_Alive_Time_Unit as these are
sensitive.
Code examples follow that show sample IAS ThreadPool configuration parameters.
# Core ThreadPool Size
com.bmc.sms.ixs.iasclient.threadManager.core_Pool_Size=10
# Max ThreadPool Size
com.bmc.sms.ixs.iasclient.threadManager.max_Pool_Size=50
# Keep Alive Time
com.bmc.sms.ixs.iasclient.threadManager.keep_Alive_Time=1000
# Keep Alive Time Unit
com.bmc.sms.ixs.iasclient.threadManager.keep_Alive_Time_Unit=SECONDS
Chapter 3
101
You must first install another BMC IAS on a second system. Rerun the installation,
and make the appropriate Standard or Master IAS selection for the second system.
The primary and secondary Impact Administration servers must have the same
name.
NOTE
If you define a standalone Master IAS as an HA pair, you must also define its accompanying
administration cell as an HA pair.
102
When you define primary and secondary servers, you also define the synchronization
properties for both. The synchronization process updates IAS records and files, such
as the following files:
s
s
s
s
s
user_definitions.xml
group_roles.xml
role_permissions.xml
cmdb.properties
cell_info.list
During synchronization of failover pairs, data is carried from the primary to the
secondary IAS and from the secondary to the primary. Each server of a failover pair
has its own ias.properties and logging configuration files. These files are not
synchronized.
NOTE
To enable synchronization between servers, they must be installed on the same type of
platform: either all on MS Windows or all on the same UNIX operating system (for example,
Solaris to Solaris, Linux to Linux).
When you execute the iadmin command on a primary or secondary IAS, the change is
reflected on the corresponding secondary or primary IAS after the synchronization
process is complete. To synchronize the servers immediately, use the iadmin -reinit
fullsync | -sync command. See iadmin reinit/sync options on page 104 for more
information.
Property
Description
com.bmc.sms.ixs.transaction.history
com.bmc.sms.configService.keepBackupFile
com.bmc.sms.ixs.sync.interval
Chapter 3
103
Table 25
Property
Description
com.bmc.sms.ixs.primary.server
com.bmc.sms.ixs.backup.server
com.bmc.sms.ixs.server.mode
execute the iadmin -reinit command on the primary or secondary server to restart
the server with the latest configuration data
You usually execute the iadmin -reinit command on the primary server after you
have manually edited any of its files.
execute the iadmin -reinit fullsync command on the secondary server only to copy
the primary servers configuration to it and to restart it with the new configuration
You should execute the iadmin -reinit fullsync command on the secondary server
the first time you start it after installation.
104
execute the iadmin -sync command on the secondary server to start the
synchronization process immediately instead of waiting until the next
synchronization interval
Use the iadmin -reinit and iadmin -reinit fullsync commands to restart the respective
server anytime you have manually edited one or more of the primary servers
configuration files.
Your typical use case would look as follows:
1. Manually edit the configuration files on the primary server.
2. Execute the iadmin -reinit command on the primary server.
3. Execute the iadmin -reinit fullsync command on the secondary server.
BMC recommends that you use the iadmin CLI to edit files whenever possible,
thereby eliminating the need to restart the server.
cell
Admin
mc
host1:1827 host2:1827
cell
Admin
mc
host1:1827 host2:1827
cell
IAC
mc
host1:1827 host2:1827
cell
IAC
mc
host1:1827 host2:1827
Remember that the primary IAC resides on the same host as the primary Master IAS
and the secondary IAC resides on the same host as the secondary Master IAS.
After you define the entries in the mcell.dir files, you must modify the respective
mcell.conf files as you would any normal cell that you are configuring for failover.
Chapter 3
105
File name
Description
transaction.log
record_transaction.log
ias0.log
You can edit the properties of the diagnostic trace log ias0.log in the
server_logging.properties file.
Advanced tasks
This section describes two tasks that require background knowledge of third-party
products and utilities. The task Configuring BMC Impact Administration server to
support remote actions on page 107 requires knowledge of secure protocols, and the
task Configuring Lightweight Directory Access Protocol for BMC Impact
Administration server on page 109 requires knowledge of Lightweight Directory
Access Protocol (LDAP).
106
Default protocols
IAS uses the default communication protocols that are specified in the
IMPACT_SOLUTIONS_HOME/server/conf/resources/centraladmin-strings.properties file.
For the UNIX-based operating systems, the following defaults are used:
unix.execute.command=com.bmc.sms.marimba_cas_tools.SSHTask
unix.putfile=com.bmc.sms.marimba_cas_tools.SCPTask
unix.getfile=com.bmc.sms.marimba_cas_tools.SCPTask
Chapter 3
107
You can specify multiple protocol values for each of these properties, as shown:
windows.execute.command=com.bmc.sms.marimba_cas_tools.PsExecTask,com.bmc.sms.
marimba_cas_tools.SSHTask,com.bmc.sms.marimba_cas_tools.TelnetTask
windows.putfile=com.bmc.sms.marimba_cas_tools.PsExecTask,com.bmc.sms.
marimba_cas_tools.SCPTask,com.bmc.sms.marimba_cas_tools.FTPTask
windows.getfile=com.bmc.sms.marimba_cas_tools.PsExecTask,com.bmc.sms.
marimba_cas_tools.SCPTask,com.bmc.sms.marimba_cas_tools.FTPTask
In this instance, the IAS tries to execute the remote action using each of the specified
protocols in sequence until the command succeeds. For example, for the
windows.execute.command, the IAS first tries PsExec. If it fails, then it tries SSH. If it
fails, then it uses Telnet. It repeats the pattern for each command.
NOTE
Make sure that youre familiar with security protocols before modifying these settings.
If the BMC Impact Explorer console, cell, or the task definition in the
UserDefinedActions.xml file does not specify an operating system, then IAS uses the
SSH protocol for all OS commands, as shown below:
all.execute.command=com.bmc.sms.marimba_cas_tools.SSHTask
all.putfile=com.bmc.sms.marimba_cas_tools.SCPTask
all.getfile=com.bmc.sms.marimba_cas_tools.SCPTask
See the BMC Impact Solutions Event Management Guide for more information on task
definitions.
You can also specify multiple protocol values for these commands, as shown in the
preceding example.
To initialize any changes, restart the BMC Impact Administration server.
Enabling Telnet
By default, the Telnet protocol is turned off. Telnet is not a secure protocol. User name
and password credentials that you enter are sent in plain text to the remote system.
Also, the Telnet session times out during the creation of support packages.
However, you can enable Telnet and ftp. You will need to start the Telnet service on
the Windows system. You also need to modify the centraladmin-strings.properties file
located under the IMPACT_SOLUTIONS_HOME/server/conf/resources path.
108
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
Chapter 3
109
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
NOTE
If you are using a solution that requires the BMC Portal and/or BMC Atrium CMDB, you may
need to set up LDAP authentication on the BMC Portal server and on the AR System server.
Refer to the BMC Portal Getting Started guide for information on setting up LDAP
authentication on the BMC Portal server. Refer to the BMC Remedy Action Request System 7.1
Integration with Plug-ins and Third-Party Products for information on setting up LDAP
authentication on the AR System server.
The user groups defined in the user_definitions.xml file are mapped to roles for the
initial log-in and for user authorization.
NOTE
If you leave the default value false, then only roles that are mapped to the users LDAP
groups are used for user authorization.
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
LDAP parameter
Description
host
the fully qualified host name where LDAP is installed. You should be able to verify
the connection between the LDAP server and the IAS using the ping command.
port
port number by which to connect to the LDAP server. Normally the nonsecure port
number is 389. The secure (SSL) port number is 636.
version
Chapter 3
111
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
Table 28
LDAP parameter
Description
baseDN
directory of the LDAP structure from which the search routine starts in LDAP. This is
the base Fully Qualified Distinguished Name (FQDN) from which all user and group
queries occur. The Distinguished Name represents an object and the path to the
object in the directory hierarchical namespace. Objects are ordered from most to least
specific.
connectionUserName
userIdAttribute
useSSL
memberOfAttribute
attribute in the user entry that specifies whether the user belongs to certain user
groups.
userSearchFilter
search filter that the LDAP server uses to look up a user entry. If left blank, this
parameter defaults to the following filter:
(|(objectClass=person)(objectClass=user)
(objectClass=inetOrgPerson)(objectClass=
organizationalPerson))
groupSearchFilter
search filter that the LDAP server uses to look up a user group entry. If left blank, this
parameter defaults to the following filter:
(|(objectClass=group)(objectClass=
groupOfUniqueNames)(objectClass=groupOfNames)(objectClass=grou
pOfUrls))
connectionPassword
On Microsoft Windows, restart the IAS service through the Services window.
On UNIX, execute the ias_service script from the appropriate path. (The default
path is /opt/bmc/Impact/server/bin.) You must be logged on as a root user to
start and stop the script.
The IAS connects to the LDAP servers one at a time in succession. When it finds a
users matching login credentials, the IAS returns the match. It does not attempt to
connect to other LDAP servers that might be defined in the ldap_configuration.xml
file.
Next, after you add your LDAP server or servers, you can add a user group and
assign it a user role.
112
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
The new entry would look similar to the following in the group_roles.xml file:
<entry key="nameofUserGroup">IAS_defaultRoleName</entry>
NOTE
If the ACL is empty, then every group has access.
1 Add the user group name to each of the following collector definition files that you
want the user group to access. Where indicated, associate the read, write, and
execute permissions (r, w, x) with the group name entry:
s
s
s
s
s
s
s
s
biip4p_collectors.mrl
catchall_collector.mrl
mc_bylocation_collectors.mrl
mc_bystatus_collectors.mrl
mc_evr_collectors.mrl
mc_sm_collectors.mrl
mcxpcoll.mrl
self_collector.mrl
You may need to change the file permissions on these files before editing them.
Chapter 3
113
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
biip4p_collectors.mrl
collector PATROL :
{
r['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
w['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
x['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
}
END
catchall_collector.mrl
collector 'All
{
r['Service
w['Service
x['Service
}
Events' :
Administrators',nameofUserGroup]
Administrators',nameofUserGroup]
Administrators',nameofUserGroup]
mc_bylocation_collectors.mrl
collector 'By Location':
{
r['Service Administrators',nameofUserGroup]
w['Service Administrators',nameofUserGroup]
x['Service Administrators',nameofUserGroup]
}
END
...............
collector 'By Location'.*:
{
r['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
w['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
x['Service Administrators','Service Operators Senior','Service Operators','Service Managers - Senior','Service
Managers',nameofUserGroup]
}:
114
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
mc_bystatus_collectors.mrl
collector 'By Status':
{
r['Service Administrators','Service Operators Senior',nameofUserGroup]
w['Service Administrators','Service Operators Senior',nameofUserGroup]
x['Service Administrators','Service Operators Senior',nameofUserGroup]
}
END
mc_evr_collectors.mrl
collector MC_Related_Events:
{
r['Service Administrators',nameofUserGroup]
w['Service Administrators',nameofUserGroup]
x['Service Administrators',nameofUserGroup]
}
END
collector MC_Related_Events.*:
{
r['Service Administrators',nameofUserGroup]
w['Service Administrators',nameofUserGroup]
x['Service Administrators',nameofUserGroup]
}:
EVENT
where [mc_relation_source: != '']
create $THIS.CLASS
END
You can add a user group to this .mrl file, but be sure not to edit any other parameter
or value.
Chapter 3
115
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
mc_sm_collectors.mrl
collector
{
r['Full
w['Full
x['Full
}
END
MC_SMC_Events:
Access', 'Service Administrators'nameofUserGroup]
Access', 'Service Administrators'nameofUserGroup]
Access', 'Service Administrators'nameofUserGroup]
collector MC_SMC_Events.*:
EVENT
where [$THIS.mc_smc_id != ""]
create cond($THIS.mc_smc_type == '', "Unknown", $THIS.mc_smc_type)
END
collector MC_SMC_Events.*.Impacts:
EVENT
where [$THIS.mc_smc_impact == 1]
END
collector MC_SMC_Events.*.History:
SMC_STATE_CHANGE
END
You can add a user group to this .mrl file, but be sure not to edit any other parameter
or value.
mcxpcoll.mrl
collector 'By Location'.*.*.*.*.*:
PATROL_EV where [p_application: not_equals '']
create $THIS.p_application
END
{
r[nameofUserGroup]
w[nameofUserGroup]
x[nameofUserGroup]
}
self_collector.mrl
collector self :
{
r['Full Access', 'Read Only',nameofUserGroup]
w['Full Access', nameofUserGroup]
x['Full Access', nameofUserGroup]
}
END
116
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
2 Next, assign the group name to the appropriate event management operations in
the im_operations.mrl file. Each event operation can be performed by a predefined
set of groups, as shown in Table 29.
Table 29
Event operations
Event operation
Group names
Acknowledge
Take Ownership
Decline Ownership
Close
Assign to Operation
Set Priority
Reopen
3 Make the appropriate group name assignments to the mc_actions.mrl file and the
sim_operations.mrl file, following the syntax examples in the files.
4 Recompile the cells KB using the mccomp command, as in the following example:
mccomp -n cellName | manifestKBFilePath
Chapter 3
117
Troubleshooting
NOTE
When you execute the iadmin command using the -tlq option, you must have the
correct LDAP server information in the ldap_configuration_query.xml file.
To authenticate a specific LDAP user, enter the user name and password, as in the
following example:
iadmin -tlq username=<string>:password=<string>
The -tlq option also checks the time required to execute an LDAP query.
To facilitate the iadmin -tlq option, you can modify the following properties in the
IMPACT_SOLUTIONS_HOME/server/conf/ias.properties file.
LDAP property
Description
com.bmc.sms.ixs.search.time.limit
the maximum time for an LDAP query to retrieve data from the LDAP
server. The default is 5000 milliseconds.
com.bmc.sms.ixs.search.ldap.group
groups to be searched in the LDAP server when, for example, you are
assigning events to groups. Only groups that are also defined in the
group_roles.xml file are searched in LDAP.
Troubleshooting
Problem: Cell_info.list synchronization error during manual
configuration of an IAS failover
When manually configuring an IAS high availability pair, you will find that the
cell_info.list does not synchronize properly between the primary and secondary
Impact Administration servers. You can work around this issue by
s
s
s
s
118
manually copying the cell entries of the Impact Administration server that you will
convert to the secondary server
saving them to an editor
adding them to the newly created primary server using the iadmin command
starting both the primary and secondary servers and executing the iadmin -reinit
fullsync command on the secondary server
All
mc pun-sms-sun31.bmc.com:1828
Production
2 Copy the cell entry to a text editor, such as Notepad. In this example, the copy
would look as follows:
pun-sms-sun31
mc pun-sms-sun31.bmc.com:1828
Production
3 Manually add the host cell entry from the secondary server to the primary servers
cell_info.list file using the iadmin -ac command, as in the following example:
iadmin -ac name= pun-sms-sun31:key=mc:primaryHost=pun-sms-sun31:Port=1828:
environment=Production:usergroups=*
4 Configure IAS failover (primary and secondary servers). See To configure IAS
failover manually on page 102 for the steps.
Chapter 3
119
120
Chapter
Chapter 4
122
122
123
123
124
124
124
124
125
126
127
127
129
130
130
131
132
132
133
134
136
121
NOTE
The Transport Layer Security (TLS) protocol is used to secure communication between the
BMC Portal Application Server and the Web browser.
2 In the security alert window, click Yes to accept the security certificate.
3 In the logon screen, type your logon user name and password, and then click Log
On.
If you receive the message user name and password invalid after entering a
valid user name and password, the BMC Portal server might not be running. Start
the BMC Portal and log on to it again.
WARNING
If you leave your BMC Portal session by selecting a different URL and then return to the
session before the expiration of the timeout period, the BMC Portal fails to prompt you for
your user name and password. To ensure the integrity of the session, log out of the session
every time you leave your BMC Portal session.
122
./BMCPortalAppserver stop
./BMCPortalAppserver start
Chapter 4
123
2 Edit the file to add or remove columns using the following format:
table_name=comma separated attribute (slot) names
124
2 Edit the appropriate events table column as shown in Table 30 on page 125.
Table 30
mc_priority
severity
value of the possible severities of the event (unknown, ok, info, warning,
minor, major, or critical)
date_reception
owner_name
msg
125
Table
Default columns
Providers
com.bmc.sms.iwc.status.table.providers
last_status_modification
description
owner_name
owner_contact
Providers
(dashboard view)
com.bmc.sms.iwc.status.table.providers. small
none
Consumers
com.bmc.sms.iwc.status.table.consumers
last_status_modification
description
owner_name
owner_contact
Consumers
(dashboard view)
Causes
com.bmc.sms.iwc.status.table.causes
last_status_modification
description
owner_name
owner_contact
Configuring reports
You can configure the following items for reports by editing the
..\smsConsoleServer\application.properties file:
s
s
s
s
scheduling
value of report goal lines
length of time report data is retained
length of time event data is retained
To configure reports
1 Open the application.properties or internal.properties files in a text editor. These file
are located at
installationDirectory\tools\jboss\server\all\conf\properties\smsConsoleServer\.
2 Edit the appropriate status table column as shown in Table 32 on page 128 and
Table 33 on page 129.
Chapter 4
127
Configuring reports
Table 32
Parameter type
Parameter
Description
Report Goals
Retention Age
128
Table 33
Parameter type
Parameter
Description
com.bmc.sms.reportSummarizer.scheduler.
delaySeconds
2 To change the minimum number of events shown on the Events table, edit the
value for com.bmc.sms.iwc.event.table.minimumevents. The default value is 5.
3 To change the maximum number of events shown on the Events table, edit the
value for com.bmc.sms.iwc.event.table.maximumevents. The default value is 50.
Chapter 4
129
2 To change the maximum number of recent items displayed in the navigation tree,
edit the value for com.bmc.sms.iwc.ui.recentitems.maxsize.
130
To add a background image, place a copy of the graphic file in this directory. You can
use the following types of graphic files for background images:
s
s
s
GIF
JPEG
PNG
Use the Configure tab in the BMC Impact Portal to create, edit, and delete Image
Views. For more information on setting up Image Views, see the BMC Impact Portal
online Help.
Chapter 4
131
2 Search for the Cell connection configuration stanza, and review the connection
properties. The following figure depicts the default values for the connection
properties.
CellName.timeout = 30
CellName.reconnect_attempts = 5
CellName.reconnect_frequency = 30
CellName.polling_frequence = 3600
CellName.encryption = on
132
Filename
File path
BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties/smsIwc
contains the general BMC Impact Portal configurations for component properties and user
Description interface presentation
Parameter name
Description
Default value
com.bmc.sms.iwc.ui.
recentitems.maxsize
com.bmc.sms.iwc.status.
table
See the
application.
properties file.
com.bmc.sms.iwc.event.table
See the
application.
properties file.
BMC_BaseElement
Chapter 4
ServiceComponent
.gif
133
Table 34
com.bmc.sms.iwc.status.
table.providers
com.bmc.sms.iwc.status.
table.consumers
com.bmc.sms.iwc.status.
table.causes
com.bmc.sms.iwc.status.
table.existinggroup
See the
application.
properties file.
com.bmc.sms.iwc.status.
table.causal.components
com.bmc.sms.iwc.status.
table.components.small
com.bmc.sms.iwc.event.
table.minimumevents
com.bmc.sms.iwc.event.
table.maximumevents
minimum: 5
maximum: 50
Filename
File path
BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties/sms
ConsoleServer
Description
contains the configurations for report scheduling, report goals, and report data retention
Parameter name
Description
Default value
com.bmc.sms.configService.
dataLocation
no value; the
location
BOSS_HOME/s
erver/all/data/s
msConsoleServ
er is used
com.bmc.sms.configService.
keepBackupFile
false; no backup
file is saved
com.bmc.sms.reportSummarizer.goa sets the value of the goal line for the Availability report 90.000%
l.default.
as a percentage
SMS_CS_RT_AVAIL
com.bmc.sms.reportSummarizer.goa sets the value of the goal line for the Mean Time to
l.default.
Repair (MTTR) report
SMS_CS_RT_MTTR
134
300000
milliseconds
(5 minutes)
Table 35
com.bmc.sms.reportSummarizer.goa sets the value of the goal line for the Mean Time Before
l.default.
Failure (MTBF) report
SMS_CS_RT_MTBF
172800000
milliseconds
(2 days)
com.bmc.sms.reportSummarizer.goa sets the value of the goal line for the Mean Time Before
l.default.
Service Impact (MTBSI) report. Goal line value is
SMS_CS_RT_MTBSI=172800000
expressed in milliseconds
172800000
milliseconds
(2 days)
cellName.timeout
cellName.reconnect_attempts
cellName.reconnect_frequency
sets the polling cycle, measured in seconds, for the BMC 30 seconds
Impact Portal reconnection attempt to the specified cell
cellName.polling_frequency
sets the polling cycle, measured in seconds, for the BMC 1800 seconds
Impact Portal data query attempt to the specified cell
<cellname>.encryption
on
com.bmc.sms.icon.webdir
/smsConsoleSer
ver/images/obje
cts/
com.bmc.sms.event.
maxDelayedHours
com.bmc.sms.consoleserver.
retention.policy.age.
SMS_CS_STATUS_EVENT
395 days
true
60 tries
com.bmc.sms.consoleserver.
retention.policy.age.
SMS_CS_RT_AVAIL
com.bmc.sms.consoleserver.
retention.policy.age.
SMS_CS_RT_MTTR
com.bmc.sms.consoleserver.
retention.policy.age.
SMS_CS_RT_MTBF
com.bmc.sms.consoleserver.
retention.policy.age.
SMS_CS_RT_MTBSI
com.bmc.sms.consoleserver.
retention.policy.age.
EG_EVENT
com.bmc.sms.service.os.
unrestricted
Chapter 4
135
Table 35
com.bmc.sms.service.os.
restrict.read.access
true
com.bmc.sms.service.os.
filtersim
true
com.bmc.sms.remedy.
serverHostName
identifies the host computer on which the BMC Remedy Action Remedy
Action Request System host resides
server host name
com.bmc.sms.remedy.
serverPortNumber
default
aggregator.properties file
Filename
aggregator.properties
File path
BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties/sms
ConsoleServer
Description
contains the configurations for BMC Impact Portal communications with cells, including port
number used for cell communications, encryption key, and encryption enablement
Parameter name
Description
Default value
com.bmc.sms.
eventaggregator.
jserverPortNumber
3783
com.bmc.sms.eventaggregator.
jserverEncryptionKey
mc
com.bmc.sms.eventaggregator.
jserverEncryptionEnabled
true
internal.properties file
Filename
internal.properties
File path
BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties
/smsConsoleServer
Description
contains the configurations for BMC Impact Portal communications with the BMC Impact
Administration Server, including the port number used for BMC Impact Administration
Server communications and parameters for building an IP address in a multi-homed
environment
Parameter name
136
Description
Default value
Table 37
internal.properties file
com.bmc.sms.ixs.port.number
com.bmc.sms.ixs.enable.bind.ip
com.bmc.sms.ixs.bind.ip.address
Chapter 4
3084
137
138
Chapter
Chapter 5
140
142
142
142
144
145
146
148
149
150
152
156
157
158
159
160
163
164
165
165
165
169
172
172
172
173
174
174
139
In the color scheme, green indicates that the object has registered with the Impact
Administration cell. Grey indicates that the object is a logical grouping, components
whose status is unknown to the Impact Administration cell. Only registered
components are viewable in the Find window and services graph. The bold lines that
connect the components represent the active impact relationships. The bold lines that
connect the components represent the active impact relationships. The arrows
indicate the direction (provider to consumer) of the event feed. A dotted line
indicates that the relationship is inactive.
The following versions of BMC components register with this service model. They
can be added as components instances to the respective logical group.
Table 38
Group Id
100
EM_CELL
101
EM_SERVER_1
102
EM_SERVER_2
103
140
Name
SIM_CELL
Table 38
Group Id
Name
104
SIM_SERVER_1
105
SIM_SERVER_2
106
110
111
112
120
Adapter
121
141
LOG_FILE_ADAPTER
SNMP_ADAPTER
WINDOWS_EVENT_ADAPTER
SYSLOG_ADAPTER
TCP_ADAPTER
TELNET_ADAPTER
UDP_ADAPTER
IIP7
IIP3
IIOVO
IINNM
IITIVOLI
DBGW
IIARS
142
IBRSD
150
159
BPM
ARS
ARS_SD
CMDB
BiiZ
BIM
SLM
TM_ART
TM_RCA
TM_REM
160
EM_Server_Standby
161
SIM_Server_Standby
162
ADAP_SERVER_1
ADAP_SERVER_2
ADAP_CELL
122
123
124
125
126
127
130
131
132
133
134
140
151
152
153
154
155
156
157
158
163
164
Chapter 5
141
Service Administrators
Full Access
Only members of either group can view the Infrastructure Management subtab.
Refer to Defining permissions on page 83 for information on assigning roles.
Walkthrough
This section provides a walkthrough of Infrastructure Management, highlighting its
main features. You can use this walkthrough to learn about and become familiar with
Infrastructure Management.
3 Under Find Infrastructure Components in the bottom pane of the navigation area,
choose Find to list the services and applications.
The logical groupings of components and applications are displayed, along with
registered components.
142
Alternatively, you can open the BEM Infrastructure Management group to display
the navigation tree, as shown in Figure 15 on page 143.
Figure 15
4 Locate the BMC Impact Solutions object in the Find list, and then, using the mouse,
click and drag it into the graph viewing area in the top right pane to reveal the
service model.
You can also choose to select BMC Impact Solutions in the navigation tree under
BEM Infrastructure Management to display it in the graph viewing area.
You may need to click the Orientation icon at the top of the graph viewing area to
reposition it vertically.
The default service model should look similar to the example in Figure 16 on
page 144.
Chapter 5
143
Figure 16
The services and applications are color-coded to reflect their real-time status. You can
check the multi-colored Status legend to see the status associated with each color. The
grey-colored icons represent logical groupings, components whose status is
unknown to the Impact Administration cell.
Click the Details tab. Click the subtabs such as General, Status, Priority and Cost,
Advanced, Related Components, SLM, and Schedule. These tabs provide component
specific information.
Click the Administer tab. Click the subtabs such as Configuration, Logs, and Support
Package. You can access the Workload and Components tabs if you have selected
either a SIM or an EM cell server.
144
Click Edit Component in the Details=>General tab and change a property of the
component.
3 To modify a file, select it from the list, and click Edit. The Credentials dialog box
displays.
The Additional command credentials check box applies mainly to UNIX systems,
where you may need to log into the system under one user account, but then
switch to another user account (for example, root) to execute the action.
4 In the dialog box, enter the credentials of the remote system, and click OK.
The configuration file is displayed in the editor.
Chapter 5
145
146
3 In the Destination field, enter the file path where the package should be saved on
the local system. You can use the Browse button to navigate to the directory.
The file name of the support package is created automatically.
Chapter 5
147
1 Right-click the leaf component under SIM Cells or EM Cells to select a cell residing
on a remote system.
2 Choose Actions to display a list of all possible actions for that component.
3 Choose Stop Cell Server Process, click Stop, and enter the logon credentials for the
remote system.
If the selected component resides on an MS Windows system, your login
credentials should have administrative rights to the system. The Additional
Command Credentials are needed check box is disabled.
148
When the component on the remote system has stopped, its status changes to
Unavailable.
5 Verify that the cell has startedfor example, you can execute an mcstat command
to check the cells status. Then you can verify that the status of the selected
component is changed to OK.
You can also launch remote actions for selected components by clicking one of the
Action toolbar icons of the Infrastructure Management view.
Depending on the type and state of the selected component, you can choose from
among the following actions:
s
s
s
s
s
s
s
Different actions are enabled based on the status and type of component. For
example, if a component in an unknown state is already started and you choose
Actions=>Start, you receive a status message notifying you that the component is
started already. Refer to Remote actions on page 174 for more information.
149
In the Of type drop-down list, click All if its not already displayed.
Click Find to open the list of logical groupings and registered components in your
infrastructure.
Logical groupings and registered components are depicted by different icons:
Table 39
Icon
150
Table 39
Icon
Definition
BMC Publishing Server
Integration for BMC Remedy Service Desk
Select the BMC Impact Solutions grouping, which contains the default infrastructure
model, and drag-and-drop it on the graph viewing area. You may need to select the
Orientation icon to display it along a vertical axis.
Multiple graphs
You can display multiple graph views. For example, you can select registered
components from the Results list in the navigation pane, and drag-and-drop them on
the graph viewing area, creating new graph views. You can switch from one view to
the other by selecting the tabs at the top of the graph viewing area.
Navigation tree
To help organize your model, you can display and manipulate the grouping and
component hierarchy in the navigation tree view under the Infrastructure
Management heading.
You can select objects in the navigation tree and display them in the graph viewing
area.
You can drag objects from the graph viewing area and drop into the navigation tree,
creating a navigation link between the two.
TIP
You can press the CTRL or SHIFT key and then click an object in the navigation tree to display
the object in the graph viewing area without closing any displayed objects.
Chapter 5
151
After you define your group, you can drag and drop component objects into it.
152
Table 40
Slot
Description
Editable Here
Master Repository
Run State
the current state of the object, which helps to determine its status, its
icon shape, the icons color, as well as which actions can be performed
against the object. This slot value is updated whenever the component
changes its state, from start to stop, from start to paused, from stop to
start, and so forth.
Role
Cell Type
Cell Server 1
for a selected cell component, the port number of the standalone cell
server or of the primary cell server in an HA pair.
Cell Server 2
for a selected cell component, the port number of the secondary cell
server in an HA pair.
From the General subtab, you can click Edit Component to open the Edit Service
Component dialog in which you can modify the components properties.
Status
In the Status subtab, you can view the applicable status levels of the component:
Service Level Agreement, manual status, maintenance mode, and computation
statuses.
Chapter 5
153
Advanced
In the Advanced subtab, you can view information on identification, creation and
modification time, and read/write permissions for groups for the selected object.
Related Components
In the Related Components subtab, you can retrieve status causes, possible problems,
providers, and consumers of the selected component type. You can modify the
relationship by selecting Edit Relationship..., which opens the Edit Relationships
dialog where you can add, modify, or remove relationships. Using the right-click
menu options, you can highlight a retrieved component in the list, and add a link to
the navigation tree by choosing the Add Navigation Link option. You can view the
events associated with the component.
This subtab also lets you view other components that have relationships with the
selected component.
SLM
In the SLM subtab, you can list and view the details of Service Level Management
agreements assigned to the component. This subtab view is not available for the
Admin cell (IAC).
Schedule
In the Schedule subtab, you can view the times when the component is in service
together with its priority costs when it is in service and when it is out of service. This
subtab view is not available for the Admin cell (IAC).
154
You can edit any supported configuration file of an infrastructure component. The
type of file varies with the component, but the files include:
s
s
s
s
s
s
s
mcell.dir
.conf files
filter files
selector files
mapping files
trace.conf files
cell_info.list
You should know the parameters of the file before trying to edit it. Refer to the
components respective documentation.
You can save the edited configuration file to a local or remote system. If saving to a
local system, you can specify a different file path. If saving to a remote system, you
update the configuration file in its current directory path. You cannot save it to a
different file path.
Logs
Similar to configuration files, you can open and annotate log files of components on
local systems in the Log subtab. You cannot save an edited or update a viewed log file
to a remote system, however. You must save it to the local system.
Support Package
In the Support Package subtab, you can prepare a zipped package of predefined
support files for troubleshooting purposes. See Creating the support package on
page 169 for more information.
Workload
The Workload subtab dynamically tracks the event activity of the cell server
component. It presents counts, averages, and percentages of different event actions,
such as sent, received, dropped, and removed. You can refresh the table by clicking
the Refresh button. This subtab view is available for SIM cell servers, but not for BEM
cell servers.
Components
The Components subtab dynamically tracks the component instances that send events
to the selected object. You refresh the table by clicking the Refresh button. This subtab
view is available for SIM and BEM cell servers.
Chapter 5
155
s
s
Select the Related Components subtab from the Details notebook tab. Click the Edit
Relationship... button.
Click Edit => Edit Relationship.
Click the Edit Relationship toolbar icon.
The Edit Relationships dialog box is opened. Figure 17 on page 156 shows an open
Edit Relationships dialog box with a selected SIM cell opened for editing in the Edit
This Relationship subdialog.
Figure 17
Field
Component Name
Related Component
Type
Relationships
156
Description
Table 41
Field
Description
Component
Direction
State
Type
Propagation Model
Editable
Field
Description
Consumer/Provider
indicator
Type of Relationship
Relationship Status
Active or Inactive
Status Weight
Description
157
Deleting components
Although logical components are not registered with the IAC and therefore do not
provide real-time status information, they can help to complement the BMC
infrastructure model. For example, you can add logical integrations and server
processes to the model to represent an idealized infrastructure environment.
NOTE
The names of logically created components do not display in Korean in the graph viewing
area while its component object does.
Deleting components
You can delete both logical service groupings/objects and live, registered objects
from the Infrastructure Management service model.
To organize your service model around its real-time components, you can delete
logical groupings that do not have registered components associated with them.
Generally, you should delete the leaf objects, not objects that lie between other
objects. If you delete objects that lie between other objects, some objects that should
be deleted because of relationship associations with the other objects will nonetheless
remain.
BMC recommends that you do not delete components that have been registered
automatically with the Infrastructure Management service model. However, if you
delete a live, registered object, it is removed from the Infrastructure Management
service model, and an event of the class Service Model Component Delete is sent to
the IAC.
TIP
You can recover a deleted registered object by modifying the DATA/ADMIN_DATA/
ADMIN_REGISTRATIONS table of the IAC in the Administration tab view.
You change the enable parameter for the specific component from NO to YES in the Edit tab.
Then you restart the component to reregister it.
158
Usage reporting
Usage reporting
NOTE
The File=>Usage Report menu option is only available in the Administration view. It does
not display in the Events or Services view.
In the Administration view, you can choose the File=>Usage Report menu option to
display and print a report that lists the BMC components which are registered with
the BMC Impact Administration cell. These components include:
s
s
s
s
NOTE
By default, users belonging to the user group Full Access, Service Administrators, Service
Managers, or Service Managers - Senior can access these reports.
You can save and print the report in any of the following formats:
s
s
Chapter 5
159
Depending on the current state of the component, not all actions are available.
You can also launch remote actions from the toolbar icons.
Depending on the type of component and its current state, a range of actions are
available to you. See Remote actions on page 174 for an explanation.
NOTE
You can connect to remote systems from the Configuration and Support Package
subtabs of the Administer notebook tab.
NOTE
An IAC cell that is in standby mode is shown in yellow.
160
When BEM or SIM cell servers are in standby mode, you can perform only the
permitted actions on them.
When the secondary cell server is in an active state while the primary cell server is
down, which is the situation depicted by SIM Cell Server 1 and SIM Cell Server 2 in
Figure 19 on page 161, the range of permitted actions increases.
Figure 19
Chapter 5
161
162
All: Fetch all the nodes in the Node Group Bank, Node Hierarchy Bank, and Node
Bank from the OVO.
1 Right-click a cell.
2 Select Reload => Knowledge Base.
The KB is reloaded.
Chapter 5
163
4 Click OK.
164
Collecting metrics
Collecting metrics
Use the Metrics Collection menu command to access the commands for working with
metrics.
IAS_USER OS_USER
SUB_TYPE:OBJECT
ACTION_ID
Chapter 5
165
Table 43
month, day, year, hour, minute, and second that the log entry was
created. Uses the format mm/dd/yyyy hh:mm:ss
LOG_LEVEL
current BMC IX user name that has logged on and connected with the
Impact Administration server
OS_USER
user name that logs into the remote hosts operating system. This is the
user name under which the action is executed on the remote host
SUB_TYPE
OBJECT
ACTION_ID
EXPLANATION
SIM_SERVER_1
IBRSD
EM_SERVER_1
SIM_SERVER_2
BEM_SERVER_STANDBY
EM_SERVER_2
IAC
SIM_SERVER_STANDBY
SIM_CELL
IAS
PS
166
EM_CELL
PORTAL SERVER
ADAPTERS
INTEGRATIONS
Sample logs
A sample audit log for a remote startup action on a SIM cell might look as follows:
Mon 07/23/2007 16:50:15 INFO iasuser superuser SIM_CELL:PUNE_CELL
start_im_windows Executing action
Similarly an audit log for a remote startup action on an IAS server might look like
this:
Mon 07/23/2007 16:52:10 INFO iasuser superuser IAS_Server:PUNE_IAS_Server
start_IASserver_window Executing action
Sample audit logs for the remote actions of restarting and stopping a SIM server cell
follow:
Tue Aug 14 20:14:06 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun01 restart_im_WINDOWS Executing action.
Tue Aug 14 20:14:40 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun01 stop_im_WINDOWS Executing action.
Configuration parameters
These audit logs are stored by default under the
IMPACT_SOLUTIONS_HOME/server/log/ias directory on the Impact Administration
server.
You can configure the audit log by modifying the properties in the ias.properties file
shown in Table 44 on page 168.
Chapter 5
167
Table 44
Property
Description
com.bmc.sms.ixscomm.util.auditLogEnable
com.bmc.sms.ixscomm.util.auditLogFilename specifies the file path and name of the audit log file, using
the %g indicator to show that the audit log files are cycled
through a numerical sequence. For example, if
auditLogFilename=AuditLog%g.log
auditLogFilecount=10
auditLogLimit=5000
then the initial audit log is assigned the name
AuditLog1.file. When its file size reaches 5000 bytes, a new
audit log is generated with the same name but incremented
by one: AuditLog2.file. As each log reaches the maximum
size, a new audit log is created and incremented by one.
When the maximum log file count (10 in this example) is
reached, then the process repeats itself because only one
cycle of logs is maintained. The first audit log of the new
cycle starts at 1 (AuditLog1), overwriting the existing file. As
new logs are generated in the new cycle, they overwrite the
existing ones in sequence.
By default the audit logs are stored in the
IMPACT_SOLUTIONS_HOME/server/log/ias directory.
You can specify another directory path in this parameter
value: for example,
auditLogFilename=log/AuditLog%g.log, provided that the
specified directory exists under
IMPACT_SOLUTIONS_HOME/server.
com.bmc.sms.ixscomm.util.auditLogLimit
size in bytes of the audit log file. The default is 5000 bytes
(approximately 4.88 kilobytes). While there is no predefined
maximum size, BMC recommends that each log file not
exceed 5 MB.
com.bmc.sms.ixscomm.util.auditLogFileCount indicates the number of audit log files that are cycled
through during a rotation. After the specified number is
reached, the cycle repeats itself, overwriting in sequence the
log files of the previous cycle. The default is 1.
After you modify any of the properties in the ias.properties file, you must restart the
Impact Administration server.
168
.dir files
.conf files
filter files
selector files
mapping files
trace files
trace.conf files
In addition, it contains
s
Chapter 5
169
Your support files should be on the system on which the component is running. Enter
the full path to the file you want to include. If you are adding multiple files, separate
the complete file paths with commas. There is no limit to the number of files that you
can add.
Table 45
Slot
Description
Configuration files
Dir files
Filter files
Map files
Selector files
Trace files
WARNING
MS Windows does not support the creation of files that have any of the following special
characters in their file names: , \, /, ?, *, ", |, <, >. If the BMC Impact Explorer is installed on
MS Windows, do not enter any of the special characters in the Issue Number slot. Otherwise,
the support package creation fails.
If you do enter the issue number, assign it as a prefix to the support package name.
You can type a short, but informative, description of the package (maximum of 256
characters). Then click Create Package.
The file name of the support package file follows this format:
OBJECT_NAME_support_package_TIMESTAMP.zip
The OBJECT_NAME value is taken from the object slot of the selected component.
The time stamp is in the format: MMDDYY_HHMMSS.
170
whether the component for which you are creating the support package resides in
a different domain from the system on which you are running BMC IX. If it does lie
in a different domain, expect a delay.
the size of the zipped or tarred file. The greater the size, the longer the delay,
especially as the file approaches 500 kb or larger.
In a successful support package creation, the audit log does return an error message:
Fri Aug 17 12:49:31 IST 2007 SEVERE user ADPROD\slondhe SIM_SERVER_1
:slondhe-pun-01 remove_zip_WINDOWS Stderr returned with some error.
You can ignore this error because users can still retrieve the zipped support package
automatically from the remote system without any manual intervention.
Chapter 5
171
If you receive a SEVERE error message on any of the other support package actions,
such as saveRemoteFile, create_support_package, get_file, and getBinaryFile, it
indicates that the support package creation failed. Discard it, and try again.
NOTE
All event information should be compliant with the event format strictures of version 1.1.00 of
the Common Event Model (CEM). See the Common Event Model appendix in the BMC Impact
Solutions Knowledge Base Development Guide for more information.
172
-as
sparkles_cell
2 Next, use the iadmin -ac command to register the cell with the Impact
Administration Server. From the /bin subdirectory of your
IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin -ac
command as in the next example:
iadmin -ac
name=sparkles_cell:key=mc:primaryHost=moondog:primaryPort=2008:
failoverHost=suncat:failoverPort=2008:environment=Production:
usergroups=*
moondog_10
mc
Admin
mc
sparkles_cell mc
moondog.bmc.com:1828
moondog.bmc.com:1827
moondog.bmc.com:2008 suncat.bmc.com:2008
In the Event view, you see that the cell you have registered sends a registration event
to the Admin cell.
In this example, you create an Admin cell with the name Admin and assign it to
port number 10011.
Chapter 5
173
Remote actions
While events flow only from the components to the Infrastructure Management
interface, administrators can initiate actions on the components from the interface.
Depending on the type of component and its status, you can initiate several actions
on the local or remote component.
run_state value
Description
unknown
active
unavailable
started
stopped
paused
passive
174
Remote actions
Table 47
Component state and menu options for a normal or primary cell in a high availability
configuration
Menu options
Start
Cell
Server
Process
run_state
state_unknown
Stop
Cell
Server
Process
Restart
Cell
Server Pause Events Resume Events
Process Admittance
Admittance
Set to
Standby
Set to
Active
Yes
state_active
Yes
Yes
Yes
Yes
Yes
Yes
state_started
state_stopped
Yes
Yes
state_unavailable
Yes
Yes
state_paused
Yes
state_passive
None
NOTE
If a component in an unknown state is already started and you choose Actions=>Start, you
receive a status message notifying you that the component is started already.
Table 48 on page 175 indicates which menu options are enabled (Yes) or disabled
(blank) for each run_state of a secondary cell in an HA configuration.
Table 48
Component state and menu options for a secondary cell in a high availability
configuration
Menu options
run_state
state_unknown
Start
Cell
Server
Process
Stop
Cell
Server
Process
Restart
Cell
Server Pause Events Resume Events
Process Admittance
Admittance
Set to
Standby
Set to
Active
Yes
state_active
Yes
Yes
Yes
Yes
Yes
Yes
state_paused
Yes
Yes
state_passive
Yes
Yes
state_unavailable
Yes
state_started
state_stopped
Yes
Yes
Yes
Yes
Chapter 5
175
Remote actions
Exceptions
Generally, most component objects receive the actions Start, Stop, Restart, Pause, and
Resume.
For cell servers, the Start, Stop, and Restart menu options in the Actions submenu are
described as:
s
s
s
For other objects apart from cell servers, the Start, Stop, and Restart menu options in
the Actions submenu are described as:
s
s
s
Start Process
Stop Process
Restart Process
For OVO adapter cells, the menu options in the Actions submenu are described as:
s
s
s
Different actions are available for different types of components. Table 49 lists the
main exceptions:
Table 49
Component
Exception
HA cell
all actions. The HA cell is the only component that allows the
Set to Standby and Set to Active menu options
IBRSD
normal cell
Logical components that you add to the Infrastructure Management service model
receive no actions.
176
Chapter
This chapter describes some aspects on how to configure the BMC Impact Explorer
(BMC IX) console and contains the following topics:
Defining property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting a single BMC IX instance for cross- and web-launching . . . . . . . . . . . . . . .
Defining console-wide policy files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring display and connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Defining global event severity and priority color values. . . . . . . . . . . . . . . . . . . . . . .
Event group configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XML files that define user interface elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
178
179
179
183
184
185
186
177
178
value =true/>
To launch a single BMC IX instance through the web, add the ix_single_instance
property to the resource section of the PortalInstall
Dir\appserver\websdk\tools\jboss\server\all\modules\smsIX.sar\
smsIX.war\ix.jnlp file. Set its value to true.
After modifying either the ix-xl.jnlp or ix.jnlp file, restart the Portal Application
server to initialize the changes.
179
Table 50
default.console_policy.prop parameters
Parameter
Description
local_action_event_operations
default_filter_name
specifies the default filter used to display the event list when no view
is selected
default_slotorder_name
specifies the default slot order used for the event list when no view is
selected
eventlist_icon_slots
controls the slots shown as icons in the event list (values of hidden
slots can be viewed only as icons)
filter_hidden_slots
controls the hidden slots that are available for creating filters
Note: Filters that rely on hidden slots may be broken in future releases
because they rely on undocumented contents.
administration_editor_classes
controls the classes (with their subclasses) that are available to the
Dynamic Data Editor
administration_editor_acls
specifies the ACLs that control access to the Dynamic Data Editor
no_import_slots
config.save.freq
ix.servicetree.save.timer
data_handle_chunk_size
data_handle_sleep_interval
data_paste_chunk_size
data_paste_sleep_interval
users_filter
import_method_new
Boolean switch that indicates whether the import is done using the
previous method or the new method, where false = previous method
local_action_event_notes
(deprecated)a controls creation of notes for events that have local actions
performed against them; replaced with
local_action_event_operations
remote_action_event_notes
status_mod_event_note
Deprecated parameters remain in version 4.1 and earlier cells. However, the parameters do not exist in newer
releases.
Figure 23 lists its contents, including the default values for each parameter.
180
Figure 23
# This document keeps default Policies for different BMC Impact Explorer wide functions.
# Format:
# <policy_name>=<polcy specific value>
# Policy which controls the creation of an event operation track for events which
# have local actions performed against them.
# value: on=operation track created when local action performed, off=operation track not
created.
local_action_event_operations=on
# Policy which controls the creation of an event note for events which
# have local actions performed against them.
# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,
mc_operations is dedicated to this purpose.
# replaced with local_action_event_operations
# value: on=note created when local action performed, off=note not created.
local_action_event_notes=on
# Policy which controls the creation of an event note for events which
# have remote actions performed against them.
# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,
mc_operations is dedicated to this purpose.
# The registering of history in mc_operations is configured at the im.
# value: on=note created when remote action performed, off=note not created.
remote_action_event_notes=on
# Policy which controls the creation of an event note for events which
# change status via user initiated action (e.g.: OPEN -> CLOSED).
# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,
mc_operations is dedicated to this purpose.
# The registering of history in mc_operations is configured at the im.
# value: on=note created when event status changes, off=note not created.
status_mod_event_note=on
# default filter and slot order when no view is ever selected.
# value: the name of a defined filter and slotorder.
default_filter_name=All Events
default_slotorder_name=Basic Information
# controls if ClassDetailProvider detail tabs show hidden slots
#ClassDetailProvider_shows_hidden_slots=false
# Policy which controls the slots shown as icons in the event lists.
# Values of hidden slots can only be viewed as icons.
# value: <className> "." <slotName> { "," <className> "." <slotName> }
# default value: CORE_EVENT.mc_abstracted, CORE_EVENT.mc_abstraction,
CORE_EVENT.mc_action_count, CORE_EVENT.mc_cause, CORE_EVENT.mc_effects,
CORE_EVENT.mc_history, CORE_EVENT.mc_notes, CORE_EVENT.mc_smc_cause,
CORE_EVENT.mc_smc_effects, CORE_EVENT.mc_smc_impact
#eventlist_icon_slots=CORE_EVENT.mc_abstracted, CORE_EVENT.mc_abstraction,
CORE_EVENT.mc_action_count, CORE_EVENT.mc_cause, CORE_EVENT.mc_effects,
CORE_EVENT.mc_history, CORE_EVENT.mc_notes, CORE_EVENT.mc_smc_cause,
CORE_EVENT.mc_smc_effects, CORE_EVENT.mc_smc_impact
181
Figure 23
# Policy which controls the hidden slots that will be available for filter building.
# Impartant remark: Filters that rely on hidden slots may be broken in future release
without notice, because they rely on undocumented contents.
# value: <className> "." <slotName> { "," <className> "." <slotName> }
# default value: <empty list>
#filter_hidden_slots=
# Policy which controls what classes (with their subclasses) are visible in
Administration's editor
# value: <className> { "," <className> }
# default value: DATA
#administration_editor_classes=DATA
#Policy which controls what acls control the classes (with their subclasses) in
Administration's editor
# value: <aclName> { "," <aclName> }
# default value: MC_DATA_EDITOR
#administration_editor_acls=MC_DATA_EDITOR
# Slots that, though parsable, should be excluded from import (thus paste and export for
import), because of specific semantics
# value: <className> "." <slotName> { "," <className> "." <slotName> }
no_import_slots=CORE_DATA.mc_udid, MC_SM_OBJECT.creation_mode, MC_SM_COMPONENT.ext_id,
MC_SM_COMPONENT.home_cell, MC_SM_RELATIONSHIP.provider_id, MC_SM_RELATIONSHIP.consumer_id
# Configuration information (such as window sizes and locations) will be saved on a
periodic basis.
# Policy which controls the time window (in seconds) for this operation.
# default value: 5 minutes (300 seconds).
config.save.freq=300
# Service Views navigation tree information stored as XML will be saved to the IXS on a
periodic basis.
# Policy which controls the time window (in seconds) for this operation.
# default value: 5 seconds (5000 milliseconds).
# Based on section 4.1.1.2.1 in Impact Explorer 4.1 Functional Specification
ix.servicetree.save.timer=5
When you execute a local action, a remote action, or modify the status of an event, a
note is written to the event as a value to the mc_notes slot and appears in the Notes
tab of the details pane of BMC Impact Explorer Events View. The initial filter is set to
display all events and the initial slot order is to display as basic information, as
indicated on the event source tab in the event list display. The last entry in the policy
file identifies those slots that should not be imported because of their specific
semantics.
The policy files console-wide application can be used to protect the individual users
cell groupings from being accessed and modified by other users on a multi-user BMC
Impact Explorer console. This enables a business to assign multiple users with
limited use requirements to one BMC Impact Explorer console, fully utilizing one
resource, rather than investing in several BMC Impact Explorer consoles that will be
under utilized.
182
Another beneficial aspect of the global nature of the policy file is that you can use it to
create a customized default event filter and slot order for a BMC Impact Explorer
console for new users and as the default filter and slot order when a user selects an
improper filter.
Console property
Description
framework_debug
help_url
sets the directory location and URL address for the BMC Impact
Explorer Help file
java_plaf
specifies the look and feel for BMC Impact Explorer according to the
Java interface settings
macro_connect_timeout
remote_server_port
sets the port number used by the Remote Method Invocation (RMI)
service in BMC Impact Explorer
remote_server_enabled
enables the RMI service for BMC Impact Explorer for remote access to
event data
all_connection_allowed
enables any connection to the RMI service for a BMC Impact Explorer
If set to false, the RMI service can only accept connections from the
local computer where the console is running.
mc_console_remote_object_name
specifies the name of the remote object used by the RMI client
This value must be matched in the -Dremote_object_name option in
the run_client.bat or run_client.sh scripts.
user.region
specifies the region used for the console to provide II8N support
By default, this information is retrieved from the environment setup of
the computer.
collector_tree_color
specifies the background color for the navigation tab on the Events tab
of the console
max_msg_history
sets the maximum number of status bar history messages that are
stored in the console
new_groups_name
svc_view_tooltip
183
Table 51
Console property
Description
svc_view_link_thickness_normal
sets the width for line indicators that connect service model
components in the relationships pane of the console
svc_view_link_thickness_true_impact
sets the width of the line indicators that indicate impact relationships
between service model components in the relationships pane of the
console
Severity level
Down
Black
000000,FFFFFF
Critical
Red
FF0000,FFFFFF
Major
orange
FF9900,000000
Minor
light orange
FFCC33,000000
Warning
yellow
FFFF00,000000
Information
blue
3366CC,FFFFFF
OK
green
33CC00,000000
Unknown
184
Color
gray
CCCCCC,000000
WARNING
s
The entries are the default color properties. Do not delete these properties.
If you customize the severities by increasing the number of levels to be greater than the
number of default severity levels, the severity list on the Event and Services Views
becomes truncated and partially illegible. Restrict your customizations to the same
number or fewer severity levels.
Table 53 lists the default priority level colors and their values, as defined in
color.properties.
Table 53
Priority level
Color
Priority_1
red
FF0000,FFFFFF
Priority_2
orange
FF9900,FFFFFF
Priority_3
light orange
FFCC33,000000
Priority_4
yellow
FFFF00,000000
Priority_5
green
33CC00,000000
To globally change the default severity or priority colors, modify the color.properties
file and stop and start the BMC Impact Administration Server.
NOTE
Modifications made to the color.properties file do not immediately appear in the BMC Impact
Portal. By default, the BMC Impact Portal configuration.update.interval parameter
checks for changes every 300 seconds.
Folder
Contains
\Images
\Images\Backgrounds
\Images\Icons
\Map
\Map
\Map
185
Table 54
Folder
Contains
\Map\Map_xxx
File name
Description
default.DataEditor.extdetails.xml
global.DataEditor.extdetails.xml
global.extdetails.xml
global.PolicyEditor.extdetails.xml
186
Chapter
Chapter 7
188
188
189
190
191
192
192
194
195
187
Interface
BMC Impact Explorer Events View
s
s
s
s
s
s
s
s
s
s
s
s
s
s
s
For BMC Impact Explorer, the default presentation names are defined in the
following two files:
s
188
InstallDir\BMC Software\MasterCell\console\lib\lang\kbinfo\
kb_core_resource.properties
InstallDir\BMC Software\MasterCell\console\lib\lang\kbinfo\
kb_deprecated_resource.properties (contains names for slots that appear on the
On UNIX: $MCELL_HOME/etc/default/SIM/kb/classes/.load or
$MCELL_HOME/etc/default/EM/kb/classes/.load
On Windows: %MCELL_HOME%\etc\default\SIM\kb\classes\.load or
%MCELL_HOME%\etc\default\EM\kb\classes\.load
NOTE
The event slot names shown on the Deprecated tab in the BMC Impact Explorer Events View
do not have presentation names by default. This tab shows in parenthesis the recommended
internal slot to use in place of the deprecated internal slot.
Chapter 7
189
If you load a supplied BAROC file that is not loaded by default, you should define
presentation names for the internal names. For instructions, see Defining
presentation names on page 192.
Collector names and action presentation names are also defined in
kb_core_resource.properties by default. However, these entries are used by BMC
Impact Explorer only and are used primarily for localization.
If you want to modify the exiting presentation names or create new ones, you can
create a new presentation name resource file for any BMC Impact Solutions
application by following these steps:
4 (BMC Impact Explorer only.) Add the base name of the resource file to the value of
kb_info_resources parameter in the
InstallDir\BMC Software\MasterCell\console\etc\ix.properties file using the
following format:
kb_info_resources=ResourceFileName,kb_core_resource, kb_deprecated_resource
190
If you want to add custom classes or extend existing classes to add new attributes,
you can add them to the kb_core_resource.properties file located in the
BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/resources
/en_US/smsConsoleServer directory. For more information about modifying
Chapter 7
191
If you want to add custom classes or extend existing classes to add new attributes,
you can add them to the kb_core_resource.properties file. For more information about
modifying presentation name keys, see Defining presentation names on page 192.
NOTE
If you customize presentation names in the default kb_core_resource.properties file, you will
need to merge your customizations into a newer file when you upgrade.
where value is the presentation name. The value can contain space characters.
Table 56 lists the formats for the presentation name key.
Table 57
Object
Key format
Class
CLASS.InternalClassName
Slot
SLOT.InternalClassName.InternalSlotName
Note: Use the class name where the slot is originally defined (the superclass).
Enumeration
ENUM.InternalEnumerationName
Enumeration Value
ENUMVAL.InternalEnumerationName.InternalValueName
192
2 To define the presentation name for an event class, add a line with the following
format to the resource file:
CLASS.eventClassName=eventPresentationName Event
3 To define the presentation name for an event slot, add a line with the following
format to the resource file:
SLOT.eventClassName.slotName=slotPresentationName
4 To define the presentation name for a new policy type, add a line with the
following format to the resource file:
CLASS.policyTypeName=policyTypePresentationName Policy
5 To define the presentation name for a policy slot, add a line with the following
format to the resource file:
SLOT.policyTypeName.slotName=slotPresentationName
6 To define the presentation name for a service model component type, add a line
with the following format to the resource file:
CLASS.BMC_ClassName=ComponentTypeName
7 To define the presentation name for a service model component slot (attribute),
add a line with the following format to the resource file:
SLOT.BMC_ClassName.slotName=slotPresentationName
8 When you have finished adding or modifying the presentation names in the
.properties file, save and close the file.
WARNING
To preserve the .properties suffix, save as type All Files. Do not save the .properties file as
a .txt file. The configuration changes may not be recognized.
Chapter 7
193
9 (BMC Impact Explorer only.) Deploy the revised files to all machines on which BMC
Impact Explorer is installed.
10 (BMC Impact Explorer only.) If you are using BMC Impact Explorer (Java Web Start
application), digitally sign the .jar file using the instructions in Digitally signing a .jar file
with a digital test certificate on page 194.
3 Verify that the key and certificate creation were successful by following these
steps:
194
4 Sign the .jar file with the test certificate by following these steps:
A Enter the following command.
jarsigner -keystore keystore_filename jar_filename alias
B Repeat this step for all the .jar files that you have created or changed.
NOTE
A self-signed test certificate should only be used for internal testing, because it does not
provide any guarantees about the identity of the user and, therefore, cannot be trusted. You
can obtain a trust-worthy certificate from a certificate authority, such as VeriSign, use it to sign
the .jar file when the application is put into production.
After you have defined presentation names, they are available for automatic
download by users who are using the BMC Impact Explorer consoles that are Java
Web Start applications.
Chapter 7
195
To enable the display of internal names in tool tips, select the Show Internal Names in
Tool Tips on the Global tab of the Edit Configuration dialog.
To always display internal names instead of the presentation names in BMC Impact
Explorer, set the value of the kb_disable_resources parameter in
InstallDir\BMC Software\MasterCell\console\etc\ix.properties to true. There is no way
to display presentation names in some BMC Impact Explorer views and internal
names in others.
196
Chapter
This chapter describes how to configure the StateBuilder and gateways for exporting
events and contains the following topics:
Understanding the StateBuilder and gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StateBuilder configuration file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
statbld return codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Gateway configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exporting events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying a statbld.conf file to export events. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying a gateway.export file to export events . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring tracing for StateBuilder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trouble-shooting the StateBuilder process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 8
198
199
199
200
205
205
206
207
207
197
File
Description
mcdb
mcdb.0
mcdb.t
mcdb.lock
xact
xact.n
xact.t.n
There is also a statbld.trace file for the configuration of StateBuilder tracing. For
further information, see Configuring tracing for StateBuilder on page 207.
The StateBuilder uses the gateway.export file in conjunction with its statbld.conf file to
export event data. For more information, see the StateBuilder configuration fileand
Exporting events on page 205.
198
statbld.conf Parameters
Parameter
Description
Default value
Export
ExportConfigFileName
ExportDiscarded
%H/etc/%N/gateway.
export
ExportTriggerArguments
blank; no arguments
ExportTriggerProgram
blank
StateHistoryCount
Return code
Description
10
37
47
Chapter 8
199
Gateway configuration
Table 60
Return code
Description
57
67
77
87
97
Gateway configuration
This section discusses general message formatting that applies both to StateBuilder
export and to gateways.
Gateway specific message formats are described in a gateway configuration file. The
location of this file for gateway of a particular type is determined from the
GwTypeConfigFileName parameter of the cell. Its default value is
%H/etc/gateway.Type where Type represents the type of gateway.
Example default parameter values for TEC and jServer gateways:
s
GwTECConfigFileName=%H/etc/gateway.TEC
which means: $MCELL_HOME/etc/gateway.TEC
GwjServerConfigFileName=%H/etc/gateway.jServer
which means: $MCELL_HOME/etc/gateway.jServer
Without a suffix, the setting is assumed to be on both categories. Both the contents of
a message and its format are specified using parameters.
200
Gateway configuration
Table 61
Variable
Description
$CLASS
class name
$CONTEXT
context name:
s Permanentevent permanently in DB (until out of date)
s Processeddiscarded by rule processing
s Regulateddiscarded by regulation
s Filtereddiscarded by filter
s Refineddiscarded by refine
s Receiveddiscarded immediately
$DATE
date stamp
$TIME
time stamp
$MODNMS
$GHANDLE
event ID in gateway
$CNAME
$CHANDLE
event ID in cell
$VALUE slot
$NAME
$VALUE
$MODS
$ALL
$ALL cls
$MAP.map val
Character
Name
\\
backslash
\s
space
\n
new line
\r
carriage return
\t
tab
\0ddd
Chapter 8
201
Gateway configuration
References to variables that are not followed by punctuation or space characters must
be enclosed in curly brackets ( { } ). For example, $NAMEabc is invalid;
${NAME}abc is correct. Non-printable characters and hard spaces must be expressed
with an escape sequence. String values for parameters are considered from the first
non-white space character up to the first (non-escaped) white space character.
Table 63 on page 202 lists the gateway.export file parameters.
Table 63
Communication protocol
parameters
Description
sets the communication protocol. Both categories, new event and
modification, use the same protocol. The last one specified is used. The
default value is MCELL.
cond
sets the condition for a slot to be included in the $ALL variable. Use
always to always include the slot. Use propagate to include the slot if its
value is different from the default value for the slot and it is able to be
parsed. The default value is propagate for new, and always for mod.
drop
lists slots that must be dropped from the $ALL and $MODS variable. List of
comma separated slot names. Only real slot names can be used. The
default value is [], so no slot is dropped.
add
slots
Contents
parameters
sets and orders the slot names to be included. Non-base class slots must be
prefixed with ClassName: . The list can also contain variable references to
include those values among regular slots.
The default value is [], so no slots are exported.
modify
map.name
202
Gateway configuration
Table 63
Format
parameters
Description
init
body
text or value to be printed for every slot to be included; can use the
variable, $NAME (name of the slot) and $VALUE (value of the slot). The
default value is blank. At least one of the init, body, or term parameters
must be specified to populate the export file.
term
text or value to be printed at the end of each event. The default value is
blank. At least one of the init, body, or term parameters must be
specified to populate the export file.
separator
sets the separator character or string to use between slot values. The
default value is nothing.
quotable
openquote
sets the opening quotation character to use for values that must be quoted.
The default value is a single quote ().
closequote
sets the closing quotation character to use for values that must be quoted.
The default value is a single quote ().
escapequote determines how to escape a quotation mark inside a quoted value. The
default value is a single quote ().
You convert a value applying a map table, by using the variable $MAP.
$MAP.name(value)
If the specified value cannot be found in the map table, it is not replaced.
Chapter 8
203
Gateway configuration
For example: You want to modify the value of the enumeration SEVERITY when it is
sent to a certain gateway. Value WARNING will be replaced with LOW, and value
CRITICAL with URGENT.
To do this, create a map table to define the required mapping:
EXAMPLE
map.GW1severity=[WARNING=LOW,CRITICAL=URGENT]
EXAMPLE
drop=[severity]
add=[severity=$MAP.GW1severity($VALUE(severity))]
init=$CLASS;\n
body=\t$NAME=$VALUE;\n
term=END\n
The BAROC format produces output similar to the example shown in Figure 26.
Figure 26
MC_CELL_TICK;
server_handle=0;
date_reception=1010183001;
event_handle=2;
source=;
sub_source=;
...
END
The slots are displayed, one per line, indented by a tab (\t). For every slot, the slot
name and value are printed, separated by an equals sign (=) and terminated with
semicolon and a new line (\n). To terminate, END is printed on a line at the end of the
data.
204
Exporting events
In the example shown in Figure 27, the first two lines configure the export file so that
it exports new events and modified events differently. Specifically,
slots.new=[$ALL] exports all slots of new events to the database and
slots.mod=[event_handle,$NAME,$VALUE] exports event_handle, slot name, and
value of events that are modified to the export file.
Figure 27
slots.new=[$ALL]
slots.mod=[event_handle, $NAME, $VALUE]
Exporting events
Events received in the cell can be exported to a flat file that resides on the same
computer as the cell. The exported events then can be used in third-party products for
archiving and data mining. Also, they can be exported to a program on another
computer by using the BMC Impact Solutions Gateway.
To export events, you configure the statbld.conf and gateway.export files.
Chapter 8
205
The export process produces two separate files that are located in the
MCELL_HOME\log\cellName directory. These two files are exp.TimeStamp.new,
which contains all new events since the previous export, and exp.TimeStamp.mod,
which contains all modifications of events after they have first passed through all rule
phases. The TimeStamp part of the file name corresponds to the timestamp part used
in the mcdb and xact file names and enables archiving of multiple export files.
Because the primary goal of exporting events is to import the data into another
format for other use, BMC Software recommends that you remove the export files as
soon as their contents have been archived. The easiest way to do this is to have them
removed by the program that is triggered at the end of the export.
Using the default values in the gateway.export file for new events produces output in
the format shown in Figure 29.
Figure 29
0,1010183001,1,,,,,,,,OPEN,,[admin],1,OK,,,0,0,0,0,
mc.exp.000000001,0,['exp:1'],[],[],[],[],[],0,[],exp,
10.0.9.10:1981,28698
0,1010183001,2,,,,,,,,OPEN,,[admin],1,OK,,,0,0,0,0,
mc.exp.000000002,0,['exp:2'],[],[],[],[],[],0,[],exp,
10.0.9.10:1981,600
206
Using the default values in the gateway.export file for modified events produces
output in the format shown in Figure 30.
Figure 30
mc.exp.000000001
exp
10.0.9.10:1981
28698
mc.exp.000000002
exp
10.0.9.10:1981
600
ACK
1010183062
mc.exp.000000003
exp
10.0.9.10:1981
28698
mcdb.0
mcdb.lock
Chapter 8
207
Check the MCELL_HOME/log/cell_name directory to ensure that your xact.n files are
named xact.1, xact.2, and so forth. If the file does not have the numeric extension (.n)
(the file is only named xact), then rename the file to xact.1.
Verify your systems available memory and compare it with the actual memory
usage of the mcell process.
On some UNIX platforms, available unused virtual memory must equal or exceed
the virtual memory used by the mcell process.
208
Appendix
Appendix A
210
211
213
214
216
218
220
225
228
231
235
237
238
243
245
248
249
251
257
262
264
265
267
268
269
272
272
209
Command
Page
mccomp
214
mcell
starts a cell
216
mcfgtrace
218
mclassinfo
220
mcollinfo
225
mcontrol
228
mcrtcell
231
mcstat
235
mdelcell
deletes a cell
237
mgetinfo
238
mgetrec
243
mkb
245
mkill
stops a cell
248
mlogchk
249
mposter
251
mrecover
262
mrextract
264
mrmerge
265
mquery
267
msend
267
msetmsg
267
msetrec
210
Description
268
NOTE
A few commands have command-specific options that override the common CLI command
options listed in Table 65. For example, the -p option for the mkb command prints the
contents of the designated manifest.kb file, rather than assigning the specified value (Value)
to the option Var. If a command has an option that overrides the common option, the
command-specific option is noted in the section of this appendix dedicated to that command.
Table 65 describes the common command options that apply to all commands.
Table 65
Option
Description
-c ConfigFile
-h
or
-?
-i UserID[/Password]
[@Host[/Port]]
-l HomeLocation
-n cellName
or
-n @Host[/Port[#Key]]
starts the cell named cellName (as defined in mcell.dir). For more
information, see Using the -n option.
-p Var=Value
-q
-v
-z
Appendix A
211
This format maps the cellName to the host, port, and encryption key in the
mcell.dir file.
s
The importance of setting a valid encryption key when using the -n option
If you do not specify Key or Key and Port, the default values are applied. The default
value for Key is 0, and the default value for Port is 1828.
Accepting the default value for Port means that your cell has to listen on port 1828,
which is normally the case with the default installation procedure.
When BMC Impact Manager is installed, the default installation procedure sets Key to
mc, instead of 0. Unless you change the encryption key to 0 during installation or
afterwards by manually editing the $MCELL_HOME/etc/mcell.dir file, you need to
specify the Key explicitly. Otherwise, if you do not specify the Key, the CLI will not be
able to connect to the cell.
For security purposes, you should set Key to a valid value other than the default.
If you want users to use the -i CLI option to authenticate through the BMC Impact
Administration Server (IAS) before they execute a CLI, you must prevent them from
having read permission to mcell.dir. Otherwise, the CLI connects to the cell without
any cell-specific authentication by retrieving the cell location and encryption key
from the cell directory.
212
When the -i option is specified, the Impact Manager user identification name must
be given as an argument. The corresponding password can be included in the
argument, following the user name, separated by a forward slash (/). If the password
is not included in the argument, the CLI requests the password on the standard input
stream, and suspends execution until the password is entered.
To authenticate the user through the BMC Impact Administration server (IAS), use
the -i option and specify the host (either by name or IP address) and port of an
authenticating IAS, as shown:
[-i UserID[/Password][@Host[/Port]]]
If Host and Port are not specified, the values entered in the
AuthenticationServerAddress parameter in mclient.conf are used. If the
AuthenticationServerAddress parameter is not present in the mclient.conf file and
no host and port number are specified when -i is entered, default Impact
Administration Server port number on the local host is used. Any arguments entered
with the -i option override the AuthenticationServerAddress parameter in
mclient.conf.
NOTE
If the AuthenticationServerAddress parameter is present in the mclient.conf file with
no value specified and the host and port are not specified with -i on the command line, CLI
execution will display a Failed to connect to IAS authentication server error
message.
To enforce user authentication through IAS, the mcell.dir file must be unreadable for
CLI users. However, the cell still needs this file to be able to connect to other cells, so
the mcell.dir file has to remain readable for the user running the cell.
To make the mcell.dir file unreadable for CLI users, but readable to the user running
the cell, install and run the cell (using the mcell command) as one user. That user
should be the only user to own and have read permission for the mcell.dir file. The
CLI should be run as another user.
Appendix A
213
Table 66
Code
Description
success
10
initialization failure
11
12
13
14
15
16
17
20
25
memory fault
26
command failed
27
syntax error
28
mccomp syntax
Figure 31 shows the syntax for mccomp.
Figure 31
mccomp syntax
Table 67 lists the command-specific options for mccomp. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
214
Table 67
mccomp options
Option
Description
-e ErrorLogFile
-n CellName |
ManifestKBFilePath
-t
- v
[VERBOSE|INFORM|WARNING
|ERROR|FATAL]
sets the verbosity level of messages. Only messages of the specified level or
higher are printed. If -v is not used, the default level is INFORM. If -v is
used without specifying a level, the default level is VERBOSE.
The -t option enables extra cell runtime tracing by the rules engine if the cell
configuration parameter TraceRuleLevel=2. The trace output goes to the standard
cell trace in the RULES module. You can include the output in the transaction file by
setting TraceRuleToXact=Yes.
WARNING
A Knowledge Base compiled for runtime rule tracing using -t can experience considerable
runtime performance degradation.
mccomp example
Figure 32 shows an example of mccomp.
Figure 32
mccomp example
mccomp -n cell1
This command produces output similar to the example shown in Figure 33.
Figure 33
Appendix A
215
mcellStarting a cell
mcellStarting a cell
The mcell command starts a specified cell.
mcell syntax
Figure 34 shows the syntax for mcell.
Figure 34
mcell syntax
mcell [-h|-?] [-z] [-q] [-d] [-i [a][c][d][e]] [-r] [-n cellName]
[-l HomeLocation] [-c ConfigFile] {-p Var=Value}
Table 68 lists the command-specific options for mcell. For a list of common command
options that apply to all CLI commands, see BMC Impact Manager CLI common
command options on page 211.
Table 68
mcell options
Option
Description
-c
specifies a configuration file other than the default. If -c is used, all configuration
files are assumed to be in the directory in which the specified configuration file is
located.
-d
-i
-i-ied
-ieevents
-iddata--initializes all data
-icEventCounter
-ia-iedcinitializes all data
Warning: Although these options are available, BMC Software recommends that
you do not use an of the -i options except for -ia. Unexpected cell states can occur if
you initialize only events or only data, because events and data may be correlated.
If you need to restart a cell from an empty state, empty the cell's log directory
(MCELL_HOME/log/CellName) and then start the cell without using any of the -i
options.
Note: If you start a cell using the -ia or -id options, you must re-register the cell
with the BMC Impact Portal.
Note: The -i option for the mcell command overrides the -i option in Table 65
Common options for CLI commands on page 211.
-r
216
mcellStarting a cell
mcell example
On UNIX, mcell can be started from a command prompt as a daemon (running in
background) or as a terminal program (running in foreground).
On Microsoft Windows, mcell can be started from a command prompt as a service or
as a terminal program.
You can start the cell using any of the following methods:
s
To start the cell in the foreground rather than as a service or daemon on UNIX and
Microsoft Windows platforms, type the command shown in Figure 35.
Figure 35
Starting a cell
mcell -n cellName -d
NOTE
When starting BMC Impact Solutions software as a daemon process on UNIX platforms, use
the method described in the BMC Impact Solutions Getting Started Guide.
To start the cell as a service on a Microsoft Windows platform, type the command
shown in Figure 36.
Figure 36
When started from command prompt without the -d option, mcell contacts the
Service Control Manager to start itself as a service. It uses mcell_cellName as the
service name, with the cell name as specified with the -n option. Without the -n
option, the host name is taken as cellName.
s
To start the BMC Impact Solutions service on Microsoft Windows and initialize the
dynamic data in the cell, type the following command shown in Figure 37.
Figure 37
WARNING
If you start a cell with the mcell -ia or mcell -id commands, you must re-register the cell
with the BMC Impact Portal.
Appendix A
217
mcfgtraceConfiguring tracing
Code
Description
19
29
37
39
47
49
57
59
67
69
77
79
97
mcfgtraceConfiguring tracing
The mcfgtrace command modifies the tracing configuration of a running cell and
takes the same argument format as a line in the mcell.trace file.
See BMC Impact Manager CLI trace configuration on page 272 for instructions on
setting up CLI trace configuration files.
mcfgtrace syntax
Figure 38 shows the syntax for mcfgtrace.
218
mcfgtraceConfiguring tracing
Figure 38
mcfgtrace syntax
mcfgtrace [-h|-?] [-z] [-q] [-c ConfigFile] [-l HomeLocation] {-p Var=Value}
[-i UserID[/Password][@Host[/Port]]] [-n cellName|-n @Host[/Port[#Key]]]
[-v] (Module Level Destination | Module SWITCH Switch Destination)
The -n option is required if the cell is remote or if cellName differs from Host. See
Using the -n option on page 211 for more information.
Table 70 lists the command-specific option for mcfgtrace. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 70
mcfgtrace option
Option
Description
mcfgtrace parameters
Table 71 lists the parameters for mcfgtrace.
Table 71
mcfgtrace parameters
Parameter
Available values
Module
ALL | Module
Level
SWITCH
SwitchName
Destination
mcfgtrace example
To activate maximum tracing for all modules and send the output to the file all.trace
in the temporary directory for Cell1, which is by default MCELL_HOME\tmp\Cell1,
type the command shown in Figure 39.
Figure 39
mcfgtrace example
Appendix A
219
mclassinfo syntax
Figure 40 shows the syntax for mclassinfo.
Figure 40
mclassinfo syntax
mclassinfo [-a Amount] [-d] [-e] [-c ConfigFile] [-h|-?] [-l HomeLocation]
[-i UserID[/Password][@Host[/Port]]] [-n cellName | -n @Host[/Port[#Key]]]
[-o OutputFile] [{Class}] {-p Var=Value} [-r] [-q] [-u] [-v] [-x] [-z]
Table 72 lists the command-specific options for mclassinfo. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 72
mclassinfo options
Option
Description
-a Amount
-d
-e
-o OutputFile
-r
-u
-x
Class
mclassinfo output
You can request output in raw format for parsing by a program. You can also request
standard output formatted for users, including verbose output that provides
additional information. See Table 72 for the available options.
220
EnumInfo
EnumTypeInfo
=
=
EnumTypeCount (EnumTypeInfo)*EnumTypeCount
EnumTypeName EnumValCount (EnumValName)*EnumValCount
ClassInfo
ClassCompInfo
= ClassCompCount(ClassCompInfo)*ClassCompCount
= ClassName ClassFlags ClassSlotCount
(ClassSlotInfo)*ClassSlotCount ClassInfo
ClassSlotInfo
= ClassSlotName ClassSlotValType ClassSlotRepType
ClassSlotFlags ClassSlotDefaultValueLength
ClassSlotDefaultValueText
ClassSlotValType
= ClassSlotStructCode ClassSlotTypeCode
ClassSlotStructCode = S | L
ClassSlotTypeCode
= i | r | p | s | e:EnumerationTypeName
| c | c:BaseClass
| q | q:BaseClass
ClassSlotFlags
= (r|R) (k|K) (p|P) (d|D) (h|H)
Slot value types (ClassSlotValType) are encoded by two characters. The first one
indicates whether it is a simple slot (S) or a list (L). List slots are defined in BAROC as
LIST_OF. The second character determines the type of the slot value. It corresponds to
the BAROC definition as listed in Table 73.
Table 73
Slot Type
Definition
INTEGER
REAL
POINTER
STRING
e;EnumerationTypeName
Enumeration
c:BaseClass
ECF of BaseClass
q:BaseClass
QUERY of BaseClass
Appendix A
221
Flags contain Boolean facets of the slot. For every facet, one character is reported. An
uppercase character means the facet is TRUE; a lowercase character means it is FALSE.
Table 74 on page 222 lists the facets that are reported.
Table 74
Reported facets
Facet
Function
r|R
read_only
k|K
key
p|P
parse
d|D
dup_detect
h|H
hidden
Table 75
Class flags
Flag
Function
p|P
publishable class
Information amount
The amount of reported information is limited as shown in Table 76.
Table 76
Option
Description
-a 0
-a 1
-a 2
-a 3
mclassinfo examples
mclassinfo can be used as shown in the following examples.
222
mclassinfo -n grace -a 0
Figure 44
Class: CORE_EVENT
Class: MC_CELL_CONTROL
Class: MC_CELL_START
Class: MC_CELL_STOP
Class: MC_CELL_TICK
Class: MC_CELL_STATBLD_START
Class: MC_CELL_STATBLD_STOP
Class: MC_CELL_DB_CLEANUP
Class: MC_CELL_CONNECT
Class: MC_CELL_CONNECT_RESOURCES_EXPANDED
Class: MC_CELL_CONNECT_SUSPENDED
Class: MC_CELL_CONNECT_RESUMED
Class: MC_CELL_CLIENT
.
mclassinfo -n grace -a 1
Appendix A
223
mclassinfo -n grace -a 2
mclassinfo -n grace -a 3
224
Code
Description
31
mcollinfo syntax
Figure 51 shows the syntax for mcollinfo.
Figure 51
mcollinfo syntax
The -n option is required if the cell is remote or if cellName differs from Host. See
Using the -n option on page 211 for more information.
Table 78 lists the command-specific options for mcollinfo. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 78
Option
Description
-a Amount
specifies the amount of information (0, 1, 2); the default is 2. For more
information, see Information amount on page 222.
-d
-f {InputFile}
Appendix A
225
Table 78
Option
Description
-g
-o OutputFile
-r
-s
Collector
specifies the collector name or OID with optional + suffix for closure
mcollinfo output
You can request output in raw format for parsing by a program. You can also request
standard output formatted for users, including verbose output that provides
additional information. See the preceding table for the available options.
226
Information amount
The amount of reported information is limited as shown in Table 79.
Table 79
Option
Description
-a 0
-a 1
add permissions
-a 2
mcollinfo examples
Figure 53 shows an example of mcollinfo.
Figure 53
mcollinfo example
You can request user-formatted output in verbose mode as shown in Figure 54.
Figure 54
You can also request the number of events for each severity/status combination in
the collector as shown in Figure 55. You must specify the collector name.
Figure 55
Appendix A
227
Code
Description
31
mcontrol syntax
Figure 56 on page 228 shows the syntax for mcontrol.
Figure 56
mcontrol syntax
The -n option is required if the cell is remote or if cellName differs from Host. See
Using the -n option on page 211 for more information.
Table 81 lists the command-specific option for mcontrol. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 81
mcontrol option
Option
Control
228
Description
specifies the control command to use. See Table 82 for the available control
commands.
Control
Description
metrics [on|off|reset]
on = enables metrics
off = disables metrics
reset = resets running counters
If an argument is not specified, metrics are reported by default.
pause
prop [{Destination}]
reload [{dir|trace|conf|collect
|kb|data|all}]
dirmcell.dir
tracemcell.trace
confmcell.conf, propagate, modify
collectcollector definitions
kbKnowledge Base, classes, rules
datadata instances
allall the categories
restart
shutdown
standby
start
statbld
stop
tracerule on|off
Appendix A
229
Table 82
Control
Description
mcontrol examples
mcontrol can be used as shown in the following examples.
Terminating a cell
To terminate a cell named grace, type the command shown in Figure 59.
Figure 59
230
Reconfiguring a cell
To reconfigure cell grace after mcell.dir has been modified, type the command shown
in Figure 61.
Figure 61
Reconfiguring a cell
Cell names
Cell names must be unique throughout the enterprise.
WARNING
Cells with identical cell names on different computers within your enterprise will cause
unexpected results.
Appendix A
231
The cell name cannot contain spaces or special characters. You can use any
alphanumeric string and underscores (_) in a cell name, such as the following:
s
s
s
my_cell
spike12
oracle
Do not give a cell the same name as any item in the MCELL_HOME\etc directory, such
as the KB directory or the mcell.conf, mcell.dir, or mcell.trace files.
Using the mcrtcell command to add cells ensures that the cell names are unique.
TIP
When naming cells, adopt a naming convention for test and production cells that clearly
identifies its purpose. For example, you could assign test cells names that use test as a prefix
or suffix. A clear naming convention is important because in BMC Impact Explorer views
there is no way to distinguish test and production cells other than by the cell name.
mcrtcell actions
The mcrtcell command performs the following actions:
s
determines if an entry exists in the mcell.dir file that matches the cell being created
If a matching entry exists, the creation fails. You can use the -f option to force the
creation of the cell.
creates the etc\cellName directory, which contains a Knowledge Base copied from
the etc\default\SIM\kb directory
creates a services entry on Microsoft Windows, unless you specify the -m option
creates an entry in the startup scripts on UNIX platforms, unless you specify the -m
option
UNIX files
When you install the cell or run mcrtcell -ae|-as -p PortNumber cellName on a
UNIX system, you create the files listed in Table 83 on page 233 that enable the cell to
start on reboot and to stop on shut down. If you run mdelcell cellName, these files
are automatically removed.
232
Table 83
Platform
File
AIX platforms
etc/cellName.d
HP-UX platforms
sbin/init.d/mc_cellName
Solaris platforms
etc/init.d/cellName
etc/rc2.d/K99cellName
etc/rc2.d/S99cellName
Linux platforms
etc/rc.d/init.d/mc_cellName
etc/rc.d/rc3.d/K99mc_cellName
etc/rc.d/rc3.d/S99mc_cellName
After you configure the cell, you must stop and restart it for the changes to take effect.
For instructions, see the BMC Impact Solutions Getting Started Guide.
mcrtcell syntax
Figure 63 shows the syntax for mcrtcell.
Figure 63
mcrtcell syntax
Specifying either the -ae or -as option creates a unified Knowledge Base, which
contains the default BEM and SIM KBs (see the BMC Impact Solutions Knowledge Base
Development Reference Guide for information about the unified KB). If you do not
specify the -ae or -as option, you create a cell with an empty Knowledge Base, and the
cell does not respond to requests.
NOTE
By default, mcrtcell creates a BEM cell. If you want to create a SIM cell, you must create a cell
using mcrtcell and then set the ServiceModelEnabled configuration parameter to YES in the
mcell.conf file. For more information about the ServiceModelEnabled configuration
parameter, see Cell configuration parameters on page 274.
Table 84 lists the command-specific options for mcrtcell. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 84
Option
Description
-aa
-ae
Appendix A
233
Table 84
Option
Description
-as
-f
forces the creation of a cell when the mcell.dir file contains an entry of the same name;
reinstalls the Knowledge Base
If you do not use this option, mcrtcell exits without creating a new cell when it finds a
duplicate entry in the mcell.dir file.
-m
-p PortNumber
-s SourceCell
NewcellName
specifies the name for the cell being created. For information about cell naming
conventions, see Cell names on page 231.
mcrtcell example
Figure 64 shows an example of how to create a service using mcrtcell.
Figure 64
NOTE
This command does not use the -ae or -as option. It makes a copy of the KB from the previous
cell.
234
In this example, an Impact Administration cell with the name Admin is created and
assigned to port number 10011.
Code Description
-1
MCELL_HOME environment variable not set or duplicate cell name or port definition
in mcell.dir
31
32
33
34
35
36
37
cannot get OS
38
Appendix A
235
mcstat Syntax
Figure 69 shows the syntax for mcstat.
Figure 69
mcstat syntax
Table 86 lists the command-specific option for mcstat. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 86
mcstat option
Option
Description
-t TimeOut
specifies the length of time, in milliseconds, for the command to wait for
answer before terminating; default is 60000, or 1 minute
mcstat example
To obtain the status for a cell named examplecell, type the command shown in
Figure 70.
Figure 70
mcstat example
mcstat -n examplecell
If the cell is not running, a message similar to the example in Figure 71 appears.
Figure 71
Running
236
mdelcellDeleting a cell
mdelcellDeleting a cell
Use mdelcell to delete a specified cell on the local computer. Deleting a cell by using
the mdelcell command removes the cell and its entry in the mcell.dir file. You can use
this command only locally on the computer where the cell resides. Executing this
command results in the following actions:
s
s
s
mdelcell syntax
Figure 73 shows the syntax for mdelcell.
Figure 73
mdelcell syntax
Table 87 lists the command-specific options for mdelcell. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 87
mdelcell options
Option
Description
-k
-w TimeOut
specifies the length of time, in seconds, for the command to wait when
terminating the cell.
mdelcell example
To delete a cell named grace, type the command shown in Figure 74.
Figure 74
mdelcell grace
If grace is not currently running, this command produces output similar to the
example shown in Figure 75 on Microsoft Windows platforms:
Figure 75
Appendix A
237
On UNIX platforms, the command does not produce output when it runs
successfully.
If grace is currently running, this command produces output similar to the example
shown in Figure 76.
Figure 76
Warning! Cell grace was running and mdelcell tries to terminate it.
Service successfully removed.
Code
Description
-1
31
mgetinfo syntax
Figure 77 shows the syntax for mgetinfo.
Figure 77
mgetinfo syntax
The -n option is required if the cell is remote and defined in the mcell.dir file, or if the
cell is local and named something other than Host.
Table 89 on page 239 lists the command-specific option for mgetinfo. For a list of
common command options that apply to all CLI commands, see BMC Impact
Manager CLI common command options on page 211.
238
Table 89
Option
mgetinfo option
Description
Information specifies the Information option to use. See Table 90 for the available
Information options.
Information
Description
activity
config
retrieves configuration of a cell, including the cell name, home directory, Knowledge Base
directory, and the full paths of all configuration files the cell uses
connect
retrieves information about the current connections that are open from and to the cell; see
Table 91 for description of that information
kbmodules
lists KB modules with version information from the cells loaded KB; information is displayed
in raw format. When combined with the -v switch, it is returned in a more verbose and
readable format.
kbsources
lists KB source files with version information from the cells loaded KB; information is
displayed in raw format. When combined with the -v switch, it is returned in a more verbose
and readable format.
metrics
reports the metrics, collected by the cell, that are stored in MC_CELL_METRIC data objects
metrics output consists of
s metric name
s metric description
s short term, medium term and long term metric, each consisting of
period of time for which the metric is counted (in seconds)
total count of metric items during the period
average occurrence of the metric item over the time period (in items per second)
The following metrics are defined:
s ReceivedEventsnumber of received event messages
s ErrorEventsnumber of received event messages that are incorrect (for example,
causing a parse error)
s DroppedEventsnumber of events that are dropped during processing through the
rules
s StoredEventsnumber of events that have passed all the rules and are stored in the
Event database
s RemovedEventsnumber of events that have been removed from the Event database by
a database cleanup
s DeletedEventsnumber of events that have been deleted by clients, such as CLI or the
console
s PropagatedEventsnumber of events that have been propagated to another
destination
s ConnectedSourcesnumber of adapter clients that are connected to the cell
Appendix A
239
Table 90
Information
Description
param
services
version
Connect information
Description
All Connections
direction
type of client
the client type, such as unknown, cell, browser, adapter, CLI, and EIF, which are
reported as literal values
name of connected
program
the name of the connected program (for example: Impact Explorer, mposter,
cellName)
source address
destination address
Incoming Connections
name of user
time delta
between both sender and receiver in seconds, to be added to time stamps coming
in to convert to the cell time
sequence
sequence
Outgoing Connections
time stamp
sequence
message
message
240
mgetinfo examples
This section contains examples of mgetinfo.
All
0
0
0
0
0
0
0
0
rights reserved.
300 1
0
3616974
300 0
0
3616974
300 1
0
3616974
300 0
0
3616974
300 0
0
3616974
300 0
0
3616974
300 0
0
3616974
300 0
0
3616974
12534
94
5700
6834
27451
0
102
0
0
0
0
0
0
0
0
0
The output for mgetinfo metric consists of the metric name, a metric description and
short term, medium term and long term metrics, each consisting of
s
s
s
Appendix A
241
the short term metric is 60 seconds during which 0 events were received, resulting
in an average occurrence of 0 events received per second
the medium term metric ran for 300 seconds during which 1 event was received,
resulting in an average of 0 events received per second
the long term metric ran for 3616974 seconds, during which 12534 events were
received, resulting in an average of 0 events received per second
This command produces output similar to the example shown in Figure 79.
Figure 79
Trace=Yes
TraceSrc=No
TraceRuleLevel=1
TraceConfigFileName=mcell.trace
TraceDefaultFileName=%T/trace
LicenseServer=
CellOperationLevel=Consolidation
CellOperationRelax=No
.
.
.
mgetinfo services
This command produces output similar to the example shown in Figure 81.
Figure 81
MC_SM_COMPONENT
CONNECTIVITY
242
Number of MC SM Component
Number of Connectivity
87
11
Figure 81
IT_COMPONENT
LOGICAL_COMPONENT
SERVICE_LEVEL_AGREEMENT
MC_SM_RELATIONSHIP
IMPACT_RELATIONSHIP
NULL_RELATIONSHIP
Number
Number
Number
Number
Number
Number
of
of
of
of
of
of
IT Component
Logical Component
Service Level Agreement
MC SM Relationship
Impact Relationship
Null Relationship
22
47
7
126
126
0
mgetinfo connect
This command produces output similar to the example shown in Figure 83.
Figure 83
10.0.10.28:1828
Admin
2028 2071
Code
Description
31
Appendix A
243
mgetrec syntax
Figure 84 shows the syntax for mgetrec.
Figure 84
mgetrec syntax
The -n option is required if the cell is remote and defined in the mcell.dir file, or if the
cell is local and named something other than Host.
Table 93 lists the command-specific option for mgetrec. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 93
mgetrec option
Option
Description
-r Record[.Slot]
mgetrec example
Figure 85 shows an example of mgetrec.
Figure 85
Example of mgetrec
mgetrec -r EM_KB_OPTIONS
The preceding command produces output similar to the example shown in Figure 86.
Figure 86
startup_script_enabled
----NO
----dfilter_enabled
----NO
----dnotification_enabled
----NO
----dpropagation_enabled
244
Figure 86
----NO
----default_location
-----
mkb syntax
Figure 87 shows the syntax for mkb.
Figure 87
mkb
[-f
[-j
[-r
mkb syntax
Table 94 lists the command-specific options for mkb. For a list of common command
options that apply to all CLI commands, see BMC Impact Manager CLI common
command options on page 211.
Table 94
Option
Description
-a Arch
-b BinFile
-c ClassFile
Appendix A
245
Table 94
Option
Description
-d DataFile
-f manifest
-j RecordFile
-l LibFile
-m Directory
-o CollectorFile
-p
-r RuleFile
imports the specified RuleFile mrl that defines the rule definitions
Use the options described in Table 95 to add new files to the Knowledge Base that
you specified with the -f option. The new files are also described in Table 95.
Table 95
mkb Option
Description
-a Arch
h1 - HP-UX
l2 - Linux
p4 - AIX (Power PC)
s5 - Solaris (Sparc)
w4 - Microsoft Windows (Intel)
-b BinFile
-c ClassFile
-l LibFile
-r RuleFile
246
Each of the above options causes mkb to copy the designated files into the proper
Knowledge Base directory and adds information to the .load file of that directory.
mkb examples
This section contains UNIX and Microsoft Windows examples.
UNIX example
Figure 88 shows an example of mkb on UNIX.
Figure 88
mkb -f ./manifest.kb -p
classes = \mcell\server\etc\spud\kb\.\classes
load file: .load
root.baroc
intevt.baroc
.
.
.
patrol.baroc
collectors = \mcell\server\etc\spud\kb\.\collectors
load file: .load
collectors.mrl
internal.mrl
Adapters.mrl
catchall.mrl
data = \mcell\server\etc\spud\kb\.\data
load file: .load
lib = \mcell\server\etc\spud\kb\.\lib
load file: .load
can not open file: \mcell\server\etc\spud\kb\.\lib\.load
rules = \mcell\server\etc\spud\kb\.\rules
load file: .load
new.mrl
records = \mcell\server\etc\spud\kb\.\records
load file: .load
intrec.wic
Appendix A
247
mkillStopping a cell
mkillStopping a cell
Use the mkill command to stop a running cell or gateway.
mkill syntax
Figure 92 shows the syntax for mkill.
Figure 92
mkill syntax
If you do not specify a cell to stop, this command stops the default cell, Host.
You must use the -n cellName option on multiple cell hosts.
248
Table 96 lists the command-specific option for mkill. For a list of common command
options that apply to all CLI commands, see BMC Impact Manager CLI common
command options on page 211.
Table 96
mkill option
Option
Description
-s
mkill example
Figure 93 shows an example of mkill.
Figure 93
Example of mkill
mkill -n examplecell
The preceding command produces output similar to the example shown in Figure 94.
Figure 94
Output of mkill
NOTE
The mkill -s command terminates a cell and bypasses the StateBuilder. If a user has cells set
to run the StateBuilder before terminating, then mkill -s -n cellName overrides the
StateBuilder option.
Appendix A
249
determines whether an xact.1 file exists and, if so, reports and instructs the user to
run statbld
determines whether an mcdb.0 file exists and, if so, reports and proposes to rename
or remove it
mlogchk syntax
Figure 95 shows the syntax for mlogchk.
Figure 95
mlogchk syntax
mlogchk example
Figure 96 shows an example of mlogchk.
Figure 96
Example of mlogchk
mlogchk -n spud -v
For a cell named spud, the preceding command produces output similar to the
example shown in Figure 97.
Figure 97
Output of mlogchk
Warning: Cell spud is running - this may influence the consistency check.
To ensure correct results, you should shutdown the Cell now.
Do you want to continue (y/n) ?
The output continues with the message shown in Figure 98 on page 251 if you
respond with y.
250
Figure 98
mlogchk message
No inconsistency found.
Code
Description
21
Use the msend command to manage events in a cell. Use the mposter command to
manage data and events in a cell. You can create, modify, and delete data instances
and events using the mposter command.
BMC Software recommends that you use the msend command instead of the mposter
command when you do not need to access or modify dynamic data or global records.
The msend command is a more secure command because it is more restrictive than
mposter.
WARNING
BMC Impact Solutions does not support using the mposter command to create or to edit
service model component instances.Although it is possible to use the mposter command to
create and to edit the service model class instances on a cell, these changes are made to only
the BAROC service model running on the cell, not to the cells standard (reference) published
service model in the CMDB. This causes a loss of service model integrity and subsequent
service model publishings will fail.
You can use the mposter command to modify dynamic data objects in the cell even
when the cell is paused.
Appendix A
251
mposter syntax
Figure 99 shows the syntax for msend. The syntax for msend very similar to mposter
except that mposter supports the -d option.
Figure 100 msend syntax
msend [-h|?] [-z] [-q] [-c ConfigFile] {-p Var=Value}
[-n cellName | -n @Host[/Port[#Key]]] [-y] [-f DirFile] [-v] [-i]
[-I] [-x] [-u] [-w MSecAnswerWait] [-t MSecTerminationWait]
[-j BufDir] [-d] [-e] [ - | {SourceFile} | -a Class [-o Source]
[-m Message] [-r Severity] [-b SlotSetValue] | -l EventID
[-b SlotSetValue]]
Table 98 lists the command-specific options for mposter and msend. For a list of
common command options that apply to all CLI commands, see BMC Impact
Manager CLI common command options on page 211.
Table 98
Option
Description
-a Class
-b SlotSetValue
- d
-e
-f DirFile
-i
-I
-j
252
Table 98
Option
Description
-l EventID
-m Message
-o Source
-p Var=Value
-r Severity
-t MSecTerminationWait
-u
-w MSecAnswerWait
-x
examines timings
-y
It is possible for msend and mposter to use a different file other than /etc/itm/.reg/Buffers for
the persistent buffer location. In the $MCELL_HOME/etc directory, create msend.conf and
mposter.conf files that contain a MpServerRegisterFile parameter. The value for this
parameter is the name of the file that will contain the location of the persistent buffer
directory. For example:
MpServerRegisterFile=/opt/mcell/buffers
NOTE
To send a punctuation mark as part of a text field using msend or mposter, enclose the value
within a set of single quotation marks ( ) framed by a set of double quotation marks( ).
For example, if you were sending a semicolon (;) as part of a text field it would look like this:
msend -n CellName -m "'a;b'"
Appendix A
253
mposter examples
NOTE
All examples and information in this section also can apply to msend.
The information for the event is entered using BAROC-style input as shown:
HOST_DOWN;
origin='HOST_DOWN';
msg='host blue is down';
END
In the example shown in Figure 102, mposter adds an instance of the DATA class
AppByHost to the host aspen. The example uses dynamic data technology in the
following ways:
s
s
s
You can use the mposter command to change any one of definitions without
changing any of the others.
254
NOTE
On Microsoft Windows, the mposter and msend commands accept only double quotes with
the -b option. If you use single quotation marks with the -b option on Microsoft Windows, the
event is not sent, and no error message appears.
On UNIX, with the with the -b option, the command accepts both single and double quotation
marks.
The mposter.lck and persist.dat files are placed in BufDir after the mposter (or msend)
command is executed. Multiple instances of mposter (and/or msend) can use the same
BufDir directory if the destination cells are the same.
To successfully start the mposter or msend CLI commands in a persistent buffering
mode, you must ensure that you have write access to the buffers file. Using persistent
buffering causes mposter/msend to launch an mposter/msend server.
UNIX/etc/itm/.reg/Buffers
Microsoft WindowsHKEY_LOCAL_MACHINE/SOFTWARE/BMC
Software/BMCImpact/mposter/Buffers
The Microsoft Windows registry key for the Buffers file is not created by default; it is
created the first time the mposter (or msend) command is executed using the -j
option.
Appendix A
255
If the Buffers file is not writable, you will receive the error message shown in
Figure 104 Error message if buffers files are not writable
Launching mposter server... OK
Getting Server Port number... OK (33992)
Connecting mposter server... Fatal error! Cannot negotiate connection
with mposter server. Check if the cell(s) name, location, port and
encryption key are the same as those running server (protocol error:
4)
Fatal error! Client initialization failed. A current cause of this
problem is a wrong/unavailable cell destination (hostname, port,
encryption key).
persist.dat
mposterbuf.lck
256
Table 99
Code
Description
mquery syntax
Figure 105 shows the syntax for mquery.
Figure 105 mquery syntax
mquery [-h|-?] [-z] [-q] [-c ConfigFile] {-p Var=Value}
[ -i UserID[/Password][@Host[/Port]] ] [-n cellName |
-n @Host[/Port[#Key]]] [-l HomeLocation] [-v] [-r] [-f Format] ( [-d]
[-a Class] [-w Where] [-s SlotList | -x SlotList] [-g Collector] [-o OrderSlot] |
-Q Query | - | {File} )
Table 100 lists the command-specific options for mquery. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 100 mquery options (part 1 of 2)
Option
Description
-a Class
-d
-f Format
-g Collector
-o OrderSlot
-Q Query
-r
sets output to be raw output. For more information, see Raw output
format on page 226.
Appendix A
257
Description
-s SlotList
-w Where
-x SlotList
File
mquery output
Output of the mquery command is available in raw format for parsing by a program,
and in printed format for users, with several variations.
Verbose mode
In verbose mode, every solution is preceded by a line of the form as shown in
Figure 107 on page 258.
Figure 107 Verbose mode options
-----N/M-----
258
where
s
s
The last solution is followed by a line of the form as shown in Figure 108.
Figure 108 End of form
-----END-----
Values have quotes when needed. Nonexistent slots are not printed. The solution is
terminated with an END on a line.
Appendix A
259
Columns are separated with a comma (,). A value that contains a comma (,) or a quote
("), or a new line, is quoted with a quote ("). A quote (") within such a value is
doubled.
Query specification
You can specify a query either with command line options or with the -Q option
through standard input. Using -Q with standard input, you must specify the query in
MRL syntax. You can use the options described in Table 101 to specify the query with
CLI.
Table 101 mquery query options
Option
Description
-d
-a Class
-w Where
-s SlotList
-g Collector retrieves only matching object instances that belong to one of the collectors specified in
Collector
This is a comma-separated sequence of collector object identifiers (OIDs), names, or both.
Each one can be suffixed optionally with a + to include its subcollectors as well.
-o OrderSlot sorts the slots mentioned in OrderSlot
This is a comma-separated sequence of slot names. Each one can be suffixed optionally with
a + to indicate ascending order or a - to indicate descending order. Without suffix, a + is
assumed. Ordering is done first on the first slot, then on the next one, and so on.
260
mquery examples
This section contains examples of the mquery command.
-a MC_CELL_CONTROL
-w "severity: >= MINOR AND status: != CLOSED"
-s "mc_ueid,CLASS,severity,msg"
The command shown in Figure 111 on page 261 selects all events from the ByHost
collectors for hosts host1 and host2 including all of their subcollectors, if any. The
result is ordered on status in ascending order beginning with OPEN, and for each
equal status value, descending on severity beginning with DOWN.
Figure 111 Example of mquerySelect events from collector
mquery
NOTE
The current implementation of the mquery command has the following limitations:
s
The XML format is experimental and may change in future BMC Impact Solutions
product releases.
The list slot values in XML are printed as strings, not as XML lists.
Appendix A
261
Description
21
NOTE
The mrecover command recovers only propagated events.
The mrecover command contacts each of the cells that you list in the TargetCell
option and requests that each target cell produce an up-to-date saved state. The
events that were propagated from the local cell are extracted from each target cell and
stored locally. After all of the target cells have been prompted and the propagated
events are retrieved, they are merged into a new saved state for the local cell. Then,
the saved state is processed by the local cell during a recovery process.
If the local cell is running or contains an mcdb file, the recovery process aborts. If the
recovery process cannot connect to a target cell, you are prompted to choose to stop
or continue the recovery process. If you choose to continue, you are prompted to
choose to include events collected from the previous session. After the recovery
process completes, the saved state is used to restart the recovered cell.
NOTE
If the data loss includes the BMC Impact Solutions product executables or the Knowledge
Base definition of the cell, you must reinstall the cell software, the Knowledge Base, and a
dedicated recovery Knowledge Base (if applicable) before using the mrecover command.
262
mrecover syntax
Figure 113 shows the syntax for mrecover.
Figure 113 mrecover syntax
mrecover [-c ConfigFile] [-q] [-h|-?] [-l HomeLocation]
[-n cellName | -n @Host[/Port[#Key]]]{-p Var=Value} [-z]
{TargetCell} . . .
Table 103 lists the command-specific option for mrecover. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 103 mrecover option
Option
Description
TargetCell
specifies the name of the cell that propagated events or to which events
have been propagated
mrecover example
To fix a broken cell with input from cella, cellb, and cellc, type the command
shown in Figure 114.
Figure 114 Fixing a broken cell using mrecover
mrecover -n broken_cell cella cellb cellc
Description
failed to send the command that started the StateBuilder on a remote cell
Appendix A
263
WARNING
This command is used by mrecover and should be avoided by end users.
mrextract syntax
Figure 115 shows the syntax for mrextract.
Figure 115 mrextract syntax
mrextract [-c ConfigFile] [-h|-?] [-l HomeLocation]
[-n cellName | -n @Host[/Port[#Key]]] [-o OutputFile] {-p Var=Value}
[-q] [-s InputStateFile] [-z] {TargetCell} . . .
Table 105 lists the command-specific options for mrextract. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 105 mrextract options
Option
Description
-o OutputFile
-s InputStateFile
TargetCell
mrextract example
Figure 116 shows an example of mrextract.
Figure 116 Example of mrextract
mrextract -n CellTwo -o \tmp\mcdb.CellOne
264
Description
37
47
67
97
WARNING
This command is used by mrecover and should be avoided by end users.
mrmerge syntax
Figure 117 shows the syntax for mrmerge.
Figure 117 mrmerge syntax
mrmerge [-h|-?] [-c ConfigFile] [-l HomeLocation]
[-n cellName | -n @Host[/Port[#Key]]] {-p Var=Value}
[-o OutputFile] {InputFile} [-q] [-z]
Appendix A
265
Table 107 lists the command-specific options for mrmerge. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 107 mrmerge options
Option
Description
-o OutputFile
InputFile
mrmerge example
Figure 118 shows an example of mrmerge.
Figure 118 Example of mrmerge
mrmerge -n Cellone -o $MCELL_HOME\log\Cellone\mcdb\tmp\mcdb.X1 \tmp\mcdb.X2
47
67
97
266
Description
msetmsgModifying an event
msetmsgModifying an event
Use the msetmsg command to modify the status value of an event in a specified cell.
Use the -s option to modify the slot value.
msetmsg syntax
Figure 119 shows the syntax for msetmsg.
Figure 119 msetmsg syntax
msetmsg [-h|-?] [-z] [-q] [-c ConfigFile]
{-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]]
[ -i UserID[/Password][@Host[/Port]] ] -u EventId -C -O -B -A -G
-S "Slot=Value[{;Slot=Value}]"
Table 109 lists the command-specific options for msetmsg. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 109 msetmsg options
Option
Description
-u EventId
-C
-O
-A
-G
-B
msetmsg example
To close an event whose event ID (event_handle) is 12981, type the following
command:
msetmsg -n cellName -u 12981 -C
Appendix A
267
Code
Description
31
32
msetrec syntax
Figure 120 shows the syntax for msetrec.
Figure 120 msetrec syntax
msetrec [-h|?] [-z] [-q] [-c ConfigFile]
{-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]]
-r Record -S Slot -V Value [-i UserID[/Password][@Host[/Port]]]
Table 111 lists the command-specific options for msetrec. For a list of common
command options that apply to all CLI commands, see BMC Impact Manager CLI
common command options on page 211.
Table 111
msetrec options
Option
-b
-r Record
-S Slot
-V Value
268
Description
msetrec example
Figure 121 shows an example of msetrec.
Figure 121 Example of msetrec
msetrec -n <cellName> -r test_rec -S slot_list_int -V [4,5,6]
Code
Description
31
Appendix A
269
Option
Description
AuthenticationServerAddress
If no value
specifies the host name or IP address of an
authentication server, optionally followed by a port is entered,
the default
number, using the following syntax:
IAS port
number on
Host[/Port]
the local
host is
used.
ServerName
ServerLocation
Host
ServerDirectoryName
mcell.dir
ServerPort
Encryption
EncryptionKey
ConnectionSetupTimeOut
270
Yes
10
(seconds)
Table 113
Option
Description
ConnectionPortRange
empty
Yes
MessageBufferCleanupPercentage
2000
10
MessageBufferReconnectInterval
600
MessageBufferKeepWait
3600
271
Table 113
Option
Description
MessageBufferKeepSent
300
MessageBufferResendCount
272
Appendix
Appendix B
274
274
276
278
280
281
283
284
287
287
288
291
292
292
293
273
Parameter
Description
Type
Default value
ActionResultInlineLimit
the size limit, in bytes, for an action result to be number 4096 (4 KB)
included directly in the action result event slots
This applies to both the output stream (slot
"output_val") and the error stream (slot
"error_val"). If the respective result is larger
than the indicated size, it is stored in a file.
Instead of placing the value directly in the *_val
slot, the reference to the file is placed in the
corresponding *_ref slot.
ActionResultKeepPeriod
Parameter
Description
Type
Default value
CellDescription
string
BMC Impact
Manager
CellOperationLevel
string
Consolidation
Boolean
No
274
Table 115
Parameter
Description
Type
Default value
ConnectionPortRangea
string
empty
Boolean
Yes
number
100
Boolean
Yes
path
mcell.dir
ServerAllInterfaces
Appendix B
1828
275
Table 115
Parameter
Description
Type
Default value
ServiceModelEnabled
Yes
path
%H/log
SystemTmpDirName
path
%H/tmp
Can also be used in the mclient.conf configuration file, which affects the behavior of all of the BMC Impact
Solutions CLI commands. These parameters retain the same qualities and definitions in the mclient.conf file
as they have in the mcell.conf file.
Parameter
Description
Type
Default
value
CellDuplicateAutoFailOver
Boolean
Yes
Boolean
Yes
276
Table 116
Parameter
Description
Type
Default
value
CellDuplicateFailOverStart
TimeOut
number
120
number
40
CellDuplicateHeartbeatEnabled
Boolean
can be used to disable the heartbeat of a high
availability cell, to prevent the secondary cell
server from becoming active when the primary
cell server is active due to VMware clock
discrepancies
CellDuplicateMode
number
Yes
1 = primary server
2 = secondary server
0 = the server is operating as a non-high
availability cell.
This is the only parameter that needs a
different value between primary and
secondary.
Appendix B
277
Parameter
Description
Type
Default value
ClientCleanupInterval
number
300
number
200 milliseconds
ClientSendTimeOut
number
1000 milliseconds
DateFormat
string
CIM
number
5000 milliseconds
If the cell receives an event with an empty value for the date slot, it sets the date slot
to the textually formatted value of the date_reception slot. That value is
determined by the DateFormat parameter. This assignment is performed only once,
when the event first enters the cell. If the cell is shut down and restarted, the value of
date remains the same even if the DateFormat parameter has been modified in the
interval.
The CIM format is yyyymmddhhmmss.mmmmmmsutc, where:
yyyy = year
mm = month
dd = day
hh = hour, based on 24-hour clock
mm = minutes
ss = seconds
mmmmmm = microseconds
s = + or -
278
utc = offset in minutes from UTC; UTC is the Universal Time Coordinate system
Table 118 lists the parameters from the Solaris platform. Other platforms, including
UNIX and Microsoft Windows platforms, may have slight differences.
Table 118
Parameter
Description
%%
same as %
%a
%A
%b
%B
%c
%C
%d
%D
date as %m/%d/%y
%e
%h
%H
hour (24-hour clock) [0,23]; single digits are preceded by zero (0)
%I
hour (12-hour clock) [1,12]; single digits are preceded by zero (0)
%j
day number of year [1,366]; single digits are preceded by zero (0)
%k
%l
%m
%M
%n
%p
%r
%R
time as %H:%M
%S
seconds [00,61]
%t
insert a tab
%T
time as %H:%M:%S
%u
%U
week number of year as a decimal number [00,53], where Sunday is the first day of week 1
%V
week number of the year as a decimal number [01,53], where Monday is the first day of the week
If the week containing January 1st has four or more days in the new year, then it is considered
week 1. Otherwise, it is week 53 of the previous year, and the next week is considered week 1.
%w
%W
week number of year as a decimal number [00,53], where Monday is the first day of week 1
%x
Appendix B
279
Encryption parameters
Table 118
Parameter
Description
%X
%y
%Y
%Z
Encryption parameters
Table 119 lists the encryption parameters.
Table 119
Encryption parameters
Parameter
Description
Type
AllowAdapterFrom
Default value
0./0
string
0./0
AllowCellFrom
string
0./0
AllowCLIFrom
string
0./0
AllowConnectionFrom
0./0
AllowEIFFrom
string
0./0
Encryption
Boolean Yes
EncryptionKey
string
ForceEncryption
Boolean No
280
(empty)
Description
Type
EventAutoClose
Default value
Yes
30
EventDBCleanupPercentage
number
3600, or 1
hour
minimum = 60;
no maximum
10
minimum=5;
no maximum
Appendix B
Boolean
No
281
Description
Type
EventDBCleanupPreferClosed
Default value
No
number
604800, or 7
days;
no minimum;
no maximum
number
2592000, or
30 days
minimum
value=0;
maximum
value =
4294967295, or
136 years
282
the minimum age, in seconds, of nonclosed events before they are removed
from the repository
Description
Type
Default value
EventDBSize
number
100000
minimum
value=100;
no maximum
string
empty
EventDBNoCleanupNonClosed
Boolean
SMC_STATE_
CHANGE
Appendix B
283
Heartbeat parameters
the cleanup period was not long enough to remove all expired events, a new cleanup
is scheduled for a later time with the same amount of time as the duration limit. If all
expired events were removed, the next cleanup is scheduled after the normal interval
value of EventDBCleanupInterval.
Heartbeat parameters
Table 121 Heartbeat parameters
Parameter
Description
Type
Default value
HeartbeatEnabled
Boolean
Yes
HeartbeatInterval
number
60
number
HeartbeatMissedMinor
number
HeartbeatMissedWarning
The heartbeat feature allows a specific cell, called the monitoring cell, to monitor one
or more cells, called the monitored cell or cells, for enabled access by the monitoring
cell.
The parameter in the mcell.conf file of the monitored cell should be
HeartbeatEnabled=Yes. By default, the monitored cell sends a beat every 300
seconds.
Heartbeats are configured through MC_CELL_HEARTBEAT dynamic data objects in the
monitoring cell. An MC_CELL_HEARTBEAT dynamic data object contains information,
such as the name of the cell to be monitored, the length of the expected time intervals
between the heartbeats, and the number of heartbeats that must be missed to generate
corresponding internal events in the monitoring cell.
284
Heartbeat parameters
The cell receives the dynamic data object either by loading it from the data directory,
receiving it through an mposter call, or viewing it in the Administrative View of the
BMC Impact Explorer. The monitoring cell sends a request to the monitored cell. The
monitored cell sends a heartbeat back to the monitoring cell at the specified intervals.
If the monitoring cell does not receive a heartbeat in the expected timeframe, the
monitoring cell generates an alert that can be viewed in the BMC Impact Explorer
console.
The default settings for missing heartbeats are as follows:
s
s
s
For example, in Figure 123 on page 285, cell 1 is the monitoring cell, which sends a
request to cell 2, the monitored cell. If it does not receive a response at a specified
interval, then the monitoring cell sends an alert that can be seen in the BMC Impact
Explorer.
Figure 123 Example of Heartbeat
Request
cell 2
cell 1
Heartbeat
After a monitoring cell terminates and restarts, it is aware of prior requests for
heartbeats because it rereads the dynamic data objects that are stored in the cell
repository mcdb. After it rereads the data, the monitoring cell attempts to resend the
request to the monitored cell.
Appendix B
285
Heartbeat parameters
If the monitored cell terminates, the monitoring cell resends the request for heartbeats
at the specified intervals. Table 122 lists the MC_CELL_HEARTBEAT slots.
Table 122 Heartbeat slots
Slot
Description
cell
enable
0 = disabled, 1 = enabled
last_time
interval
missed_warning
missed_minor
NOTE
Deleting an instance of an MC_CELL_HEARTBEAT data object from a monitoring cell
terminates the monitoring of the corresponding cell or cells.
286
Description
Type
Default value
CellEventEnable
Boolean
Yes
CellErrorEvents
Boolean
Yes
Boolean
Yes
CellTickInterval
number
600
a flag that requires the cell to check for certain conditions Boolean
that can induce infinite looping of events
No
RuleLoopDetect
KB parameters
Table 124 KB parameters
Parameter
Description
Type
Default value
KBDirName
path
KBRecoveryDirName
kbrecovery
Appendix B
287
Propagation parameters
Propagation parameters
The propagation parameters allow you to configure propagation and destination
buffers.
You can configure these parameters for individual destinations and also configure a
default value for all other destinations. Use the asterisk (*) to specify all destinations.
The following parameter definition illustrates how to configure these parameters for
all destinations.
DestinationBufferReconnectInterval = *=600
This example specifies that the interval to try to reconnect is 600 seconds for all
destinations. If the * is not explicitly defined, the default value for the parameter will
be applied to all destinations.
To configure parameters for individual destinations, the value for these parameters is
formatted as a comma-separated sequence of destination-specific settings in the form
of DestinationName=Value. DestinationNames #1 and #2 are reserved to indicate
the primary and secondary nodes of a high availability cell.
For example,
DestinationBufferReconnectInterval = #1=10,#2=10,*=600,SlowCell=1200
This example specifies that the interval to try to reconnect is 10 seconds for the high
availability nodes, 1200 seconds for a cell called SlowCell and 600 seconds for all
other destinations. If the * is not explicitly defined, the default value for the parameter
will be applied to all unspecified destinations.
Table 125 Propagation parameters (part 1 of 3)
Default
value
Parameter
Description
Type
DestinationBufferBaseSize
number 5000
288
Propagation parameters
Parameter
Description
Type
DestinationBufferSizeLimit
number 0
DestinationBufferKeepWait
number 3600, or 1
hour
number 600
PropagateBufferBaseSize
number 1
Appendix B
289
Parameter
Description
Type
PropagateBufferSizeLimit
number 0
PropagateConfigFileName
path
mcell.
propagate
Can also be used in the mclient.conf configuration file, which affects the behavior of all of the BMC Impact Solutions CLI
commands. These parameters retain the same qualities and definitions in the mclient.conf file as they have in the
mcell.conf file.
Parameter
Description
Type
MessageBufferBaseSize
number 5000
MessageBufferKeepSenta
number 300
MessageBufferKeepWait
290
Parameter
Description
Type
MessageBufferReconnectInterval
number 600
MessageBufferSize
number 1
number 20000
Can also be used in the mclient.conf configuration file, which affects the behavior of all of the BMC Impact Solutions CLI
commands. These parameters retain the same qualities and definitions in the mclient.conf file as they have in the
mcell.conf file.
Description
Type
Default value
browser, Console,
ImpactExplorer, mcontrol,
mkill, mposter, msetmsg,
msetrec
ReportModifyClients
Appendix B
291
Parameter
Description
Type
Default value
ServiceModelPublish
Boolean
YES
Boolean
when ServiceModelPublish is enabled,
ServiceModelDirectFeed controls whether or
not Service Model Data is accepted through direct
feed
YES
Description
Type
Default value
StateBuildInterval
number
3600
StateBuildSize
1000
path
statbld.conf
StateBuildAtTerminate
No
StateBuildRunTimeOut
600 seconds
292
number
Trace parameters
Trace parameters
Table 130 Cell tracing parameters (part 1 of 3)
Parameter
Description
Type
Default value
Tracea
Boolean
Yes
TraceSrc
includes the file and line number in the trace messages Boolean
No
TraceConfigFileName
path
mcell.trace
path
TraceDefaultFileName destination file to redirect trace messages from
stderr to, in case the cell runs as a daemon or service
%T/trace
TraceRulePhases
number
ALL
Appendix B
293
Trace parameters
Description
Type
TraceRuleNames
string
When rule tracing is enabled, lists module:rule
combinations to be traced. The value ALL can be used
to specify that all modules and/or rules are to be
traced. Each module:rule combination can be prefixed
with a + or a - sign to indicate addition or removal
from the list. The list is interpreted in sequential order.
Default value
ALL:ALL
%F, %L: %P
%R: %C
# %H:
%I message id
%F source file name
%L source line number
%M KB module name
%R rule name
%P rule phase
%H handle of the main event being processed
(event_handle slot)
%C class name of the main event being
processed
TraceRuleToXact
294
No
Trace parameters
Description
Type
TraceFileSize
Default value
TraceFileHistory
number
Boolean
Yes
Can also be used in the mclient.conf configuration file, which affects the behavior of all of the BMC Impact
Solutions CLI commands. These parameters retain the same qualities and definitions in the mclient.conf file
as they have in the mcell.conf file.
Appendix B
295
Trace parameters
296
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
.baroc files 68, 69
.jar files
digitally signing 194
.load files 68, 70
.loadwic files 70
.mrl files 69
.pkg files 69
.wic files 69, 70
.xact files 72
@kbversion annotation 73
A
action result event parameters
ActionResultInlineLimit 274
ActionResultKeepPeriod 274
actions
directory 69
activating maximum tracing for all modules 219
adding
slot flags and default values 224
slot names and representation types 224
administering remote cells
Administration View (BIX) 58
Administration View
managing cells from 58
metrics collection 165
Reload menu 163
administrator activities
modifying cell connection settings 132
AllowAdapterFrom 280
AllowBrowserFrom 280
AllowCellFrom 280
AllowCLIFrom 280
AllowConnectionFrom 280
AllowEIFFrom 280
application.properties configuration file 125
B
bin directory 68
BIX
defining presentation name search order using
ix.properties file 191
extracting presentation name resource files 189
Index
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
BMC Impact Portal (continued)
policy file 179
report goal line configuration parameters 134
BMC Portal
starting from command line 123
starting from Services Window 123
starting on UNIX 123
stopping from command line 123
stopping on UNIX 123
URL address 124
URL address syntax 124
BMC Software, contacting 2
C
cell
defining high availability for Impact Administration
105
Impact Administration 105
cell configuration
creating files for specific cells 30
files 4344
modifying cell connection settings 132
Cell Info dialog box (BIX) 165
cell names
conventions for 231
cell objects, retrieving 251, 267
cell parameters
CellDescription 274
CellOperationLevel 274
CellOperationRelax 274
ConnectionPortRange 275
ConnectionPortReuse 275
ProcessingLimitPercentage 275
ServerAllInterfaces 275
ServerDirectoryName 275
ServerPort 275
SystemLogDirName 276
SystemTmpDirName 276
cell tracing parameters, list of 293
CellDescription 274
CellErrorEvents 287
CellEventEnable 287
CellMetricsEnabled 287
CellOperationLevel 274
CellOperationRelax 274
cells
creating new 231, 264
deleting 237
extracting state files from 264
heartbeats 287
naming, mcrtcell command 231
obtaining status using mcstat 236
posting events 251
production, described 25
reconfiguring 43, 231
298
cells (continued)
recovering data 262
remote administration 58
retrieving information 238
running in foreground 217
sending events to 251, 267
starting 217
starting a specified cell 216
starting and stopping 72
status 235
stopping with mkill 248
test, described 25
view information 58
CellTickInterval 287
class information request 220
classes
directory 68
CLI, BMC Impact Manager. See BMC Impact Manager CLI
client configuration for passive connections 36
client parameters 287
ClientCleanupInterval 278
ClientPollTimeOut 278
ClientSendTimeOut 278
DateFormat 278
SynchronizedTimeOut 278
ClientCleanupInterval 278
ClientPollTimeOut 278
ClientSendTimeOut 278
closing an event 267
collectors 225
directory 68, 69
com.bmc.sms.iwc.component.properties.
generalProperties.properties file property 133
com.bmc.sms.iwc.domain.notification.impact.type
property 133
com.bmc.sms.iwc.domain.recentitem.
RecentItemsFolderIcon property 133
com.bmc.sms.iwc.event.table property 133
com.bmc.sms.iwc.event.table.maximumevents property
134
com.bmc.sms.iwc.event.table.minimumevents property
134
com.bmc.sms.iwc.status. 134
com.bmc.sms.iwc.status.table property 133
com.bmc.sms.iwc.status.table. existinggroup property 134
com.bmc.sms.iwc.status.table.causes property 134
com.bmc.sms.iwc.status.table.consumers property 134
com.bmc.sms.iwc.status.table.providers property 134
com.bmc.sms.iwc.ui.recentitems.maxsize property 133
command options
mkill 248
mrmerge 265
commands
mccomp 71, 214
mcell 216
mcfgtrace 217, 218
mclassinfo 220
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
commands (continued)
mcollinfo 225
mcontrol 72, 228
mcrtcell 71, 231
mcstat 235
mdelcell 237
mgetinfo 74, 238
mgetrec 243
mkb 71, 245
mkill 248
mlogchk 249
mposter 251, 255
mquery 251, 267
mrecover 262
mrextract 264
mrmerge 265
msend 251, 267
msetmsg 267
msetrec 268
reference 210
communication and encryption
AllowAdapterFrom 280
AllowBrowserFrom 280
AllowCellFrom 280
AllowCLIFrom 280
AllowConnectionFrom 280
AllowEIFFrom 280
BMC Impact Portal configuration parameters 135
encryption behavior 40
ForceEncryption 39
mcell.conf settings 39
mcell.dir settings 39
mclient.conf settings 39
compiling
Knowledge Base 214
Knowledge Bases 71
Knowledge Bases with trace 72
version annotations 73
configuration activities for administrators
modifying cell connection settings 132
configuration files
cell 4344
cell-specific, creating 30
ix.properties 183
ixs.properties 124
mcell.conf 28, 31
mcell.modify 3738
mcell.propagate 31
mcell.trace 51
StateBuilder configuration 199
configuration parameters
BMC Impact Portal configuration and encryption 135
HeartbeatEnabled 284
HeartbeatInterval 284
HeartbeatMissedCritical 284
HeartbeatMissedMinor 284
HeartbeatMissedWarning 284
configuring
BIX using the ix.properties file 183
BMC Impact Portal using ixs.properties 124
clients for passive connections 36
error tracing for BMC Impact Manager 217, 218
reloading cell configuration 43
setting cell-specific configurations up 30
StateBuilder 199
connecting
cells in a protected zone 36
ConnectionPortRange 271, 275
ConnectionPortReuse 271, 275
consistency checks 249
console_policy.prop 179
control operations 228
conventions
for cell naming 231
creating
a new cell 231
a new service with mcrtcell 234
another service 234
configuration files
cell-specific 30
Knowledge Bases 71
customer support 3
D
data classes
directory 69
data directory 68
data instances
directory 69
DateFormat 278
deleting
a cell 237
events using mquery 261
digital test certificate 194
digitally signing .jar files 194
directories
bin 68
classes 68
collectors 68
data 68
for KB components 69
lib 68
record 69
rules 69
structure for Knowledge Bases 66
dynamic data
model 284
Index
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
E
EM cell
production 25
test 25
enabling
persistent buffering 255
encryption
behavior 40
mcell.conf settings 39
mcell.dir settings 39
mclient.conf settings 39
encryption key 39
error file
mcell.err 57
establishing inbound connection in protected environment
36
event classes
directory 69
event group
configuration files 185
event parameters
EventAutoClose 281
EventDBCleanupDurationLimit 281
EventDBCleanupInterval 281
EventDBCleanuponDateReception 281
EventDBCleanupPercentage 281
EventDBCleanupPreferClosed 282
EventDBKeepClosed 282
EventDBKeepNonClosed 282
EventDBNoCleanupClosed 283
EventDBNoCleanupNoCleanupNonClosed 283
EventDBSize 283
repository cleanup 281
event propagation
enabling 33
illustrated 33
event repository
cleanup parameters 281
EventAutoClose 281
EventDBCleanupDurationLimit 281
EventDBCleanupInterval 281
EventDBCleanupOnDateReception 281
EventDBCleanupPercentage 281
EventDBCleanupPreferClosed 282
EventDBKeepClosed 282
EventDBKeepNonClosed 282
EventDBNoCleanupClosed 283
EventDBNoCleanupNonClosed 283
EventDBSize 283
events
deleting using mquery 261
exporting to a flat file 205
merging objects 265
modifying 267
posting with mposter 251
propagating using a gateway 31
300
examples
mccomp 215
mcell 217
mcfgtrace 219
mclassinfo 222
mcollinfo 227
mcontrol 230
mcrtcell 234
mcstat 236
mdelcell 237
mgetinfo config 241
mgetinfo connect 243
mgetinfo param 242
mgetinfo services 242
mgetrec command 244
mkb 247
mkill 249
mlogchk 250
mquery 261
mrecover 263
mrextract 264
mrmerge 266
msetmsg 267
msetrec 269
ExportConfigFileName 199
ExportDiscarded 199
exporting
event data from mcdb by StateBuilder 199
events to a flat file 205
ExportTriggerArguments 199
ExportTriggerProgram 199
F
files
.baroc 68, 69
.load 68, 70
.loadwic 70
.mrl 69
.pkg 69
.wic 69, 70
.xact 72
application.properties 125
extensions for KB components 69
gateway.export 198, 205, 206
ixs.properties 124
kb_core_resource.properties 188
kb_deprecated_resource.properties 189
manifest.kb 70, 214
mcdb state 198
mcell.conf 31
mcell.dir 34??, 211
mcell.err error 57
mcell.modify 37, 124
mcell.propagate 31
mcell.trace 51
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
files (continued)
mcfgtrace 217, 218
propagation configuration 31
sim.wic 68
sim_decl.wic 68
statbld.conf 198, 205
statbld.exe 198
statbld.trace 198, 207
StateBuilder configuration 199
trace configuration 51
xact transaction 198
filters
using hidden slots 180
ForceEncryption 39
foreground, running cell in 217
G
gateway 31
gateway configuration 200
gateway.export file 198, 205, 206
global records
directory 69
obtain a value 243
setting a value 268
goal line (reports) configuration parameters 134
H
HeartbeatEnabled parameter 284
HeartbeatInterval parameter 284
HeartbeatMissedCritical parameter 284
HeartbeatMissedMinor parameter 284
HeartbeatMissedWarning parameter 284
heartbeats, cell 287
I
icons
BMC Impact Explorer configuration files for event
groups 185
image views
overview 124
importing Knowledge Bases 71
infrastructure management
Administer subtabs 154
audit log 165, 167, 171
default service model 140, 142
Details subtabs 152
editing infrastructure relationships 156
GUI view 144, 150
high availability cells 160
icons 150
manually deleting components 174
navigation tree 143, 151
J
jar files
digitally signing 194
Java Web Start application
extracting presentation name resource files 189
K
kb_core_resource.properties file
entry format 192
modifying 193
kb_deprecated_resource.properties file 189
KBDirName 287
KBDirName parameter 287
kbmodules argument 74
KBRecoveryDirName parameter 287
kbsources argument 74
kbversion primitive
described 74
keys
creating and modifying presentation names 192
formats for presentation names 192
Knowledge Bases
compiling 71, 214
compiling with trace 72
creating 71
directories 69
directory structure 66
file extensions 69
importing 71
index file 70
integrating with a unified KB 70
KBDirName 287
Index
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
Knowledge Bases (continued)
loading 72
managing 70
parameters
KBRecovery 287
retrieving version information with kbversion 74
retrieving version information with mgetinfo 74
subdirectories 68
updating 245
versioning 72
versioning mechanism 73
L
lib directory 68
loading
Knowledge Bases 72
M
managing
Knowledge Bases 70
manifest.kb file 70, 214
mccomp command 71, 214
example 215
options 214
return codes 215
syntax 214
mcdb state file 198
affects on recovery process 262
mcell command 216
example 217
options 216
return codes 218
syntax 216
mcell.conf file
parameter rules 28
path substitution parameters 29
specifying paths 29
mcell.dir file 211
configuring clients for passive connections 36
description and usage 34??
example file 35
format of entries 34
keywords for entries 35
rules applied to entries 35
mcell.err file 57
mcell.modify file 37, 3738, 124
mcell.propagate file 31
default options 32
usage 31
mcell.trace file 51, 217, 218
mcfgtrace command 217, 218
example 219
options 219
302
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
MessageBufferReconnectInterval 289, 291
MessageBufferResendCount 289, 291
MessageBufferSize 288, 290, 291
metrics collection, tab for 165
mgetinfo command 74, 238
config example 241
connect example 243
options 238
param example 242
return codes 243
services example 242
syntax 238
mgetrec command 243
example 244
options 244
return codes 245
syntax 244
mkb command 71, 245
examples 247
options 245
return codes 248
syntax 245
mkill command 248
command options 248
examples 249
options 249
return codes 249
syntax 248
mlogchk command 249
examples 250
return codes 251
syntax 250
modifying
cell connection settings 132
ModuleName parameter 73
monitoring passive connections 37
mposter command 251, 255
enabling persistent buffering 255
options 252
return codes 256
syntax 252
mquery command 251, 267
deleting events 261
examples 261
options 257
output 258
return codes 262
selecting events with a severity level 261
syntax 257
mrecover command 262
example 263
options 263
return codes 263
syntax 263
mrextract command 264
example 264
options 264
N
name keys
creating and modifying 192
naming conventions
for cells 231
O
objects
list of presentation names for 188
obtaining a global record value 243
obtaining a list of classes 223
obtaining a list of slot names 223
obtaining status of cell
using mcstat 236
options
mccomp 214
mcell 216
mcfgtrace 219
mclassinfo command 220
mcollinfo 225
mcontrol 228
mcrtcell 233
mcstat 236
mdelcell 237
mgetinfo 238
mgetrec 244
mkb 245
mkill 249
mposter 252
mquery 257
mrecover 263
Index
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
options (continued)
mrextract 264
mrmerge 266
msetmsg 267
msetrec 268
output
mclassinfo 220
mcollinfo 226
mquery command 258
P
parameters
ActionResultInlineLimit 274
ActionResultKeepPeriod 274
BMC Impact Portal configuration 124
client 287
HeartbeatEnabled 284
HeartbeatInveral 284
HeartbeatMissedCritical 284
HeartbeatMissedMinor 284
HeartbeatMissedWarning 284
KBRecovery 287
mcfgtrace 219
Server 287
state 287
trace, list of 293
tracing, configuring 55
passive connections 36
client configuration 36
monitoring 37
passwords
invalid, logging on to BMC Portal 122
pending progagations
retrying 230
policy file
BMC Impact Portal 179
console_policy.prop 179
posting events to a cell 251
presentation names
about 188
creating a new resource file 190
creating and modifying name keys 192
default definitions 189
defining 192
enabling and disabling BIX tool tips for 195
extracting resource files for BIX (Java Web Start) 189
files 191
key formats 192
list of objects with 188
resource file locations 188
resource file search order 191
ProcessingLimitPercentage 30, 275
product support 3
production cells
described 25
304
R
reconfiguring
cell files for 43
cells with mcontrol command 231
records directory 69
Reload menu (BIX)
Administration View (BIX) 163
reports
BMC Impact Portal goal line configuration parameters
134
resource files
creating 190
extracting for BIX (Java Web Start) 189
locations of 188
search order 191
retrieve objects from cell 251, 267
retrying pending progagations 230
return codes
mccomp 215
mcell 218
mclassinfo 225
mcollinfo 228
mcrtcell 235
mcstat 236
mdelcell 238
mgetinfo 243
mgetrec 245
mkb 248
mkill 249
mlogchk 251
mposter 256
mquery 262
mrecover 263
mrextract 265
mrmerge 266
msetmsg 268
msetrec 269
statbld 199
RuleLoopDetect 287
rules
directory 69
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
S
saved state 262
scripts and programs directory 69
selecting
events with a severity level 261
server parameters 287
CellErrorEvents 287
CellEventEnable 287
CellMetricstEnabled 287
CellTickInterval 287
ConnectionPortRange 271, 275
ConnectionPortReuse 271, 275
ProcessingLimitPercentage 30, 275
RuleLoopDetect 287
ServerDirectoryName 275
ServerPort 275
ServerAllInterfaces 275
ServerDirectoryName 275
ServerPort 275
service models
class definitions directory 69
setting
a value in a global record 268
cell-specific configuration up 30
SIM cell
production 25
test 25
sim.wic file 68
sim_decl.wic file 68
starting cells
specific cell 216
with mcell 72
statbld return codes 199
statbld.conf file 198, 205
statbld.exe file 198
statbld.trace file 198, 207
State 292
state configuration parameters 287
ExportConfigFileName 199
ExportDiscarded 199
ExportTriggerArguments 199
ExportTriggerProgram 199
StateHistoryCount 199
state files, extracting 264
state parameters 287
StateBuildAtTerminate 292
StateBuildConfigFileName 292
StateBuildInterval 292
StateBuildRunTimeOut 292
StateBuildSize 292
StateBuildAtTerminate 292
StateBuildConfigFileName 292
StateBuilder 198
configuration parameters for event data export 199
StateBuildInterval 292
StateBuildRunTimeOut 292
StateBuildSize 292
StateHistoryCount 199
stopping cells
with mkill 72, 248
support, customer 3
SynchronizedTimeOut 278
syntax
mccomp 214
mcell 216
mcfgtrace 218
mclassinfo 220
mcollinfo 225
mcontrol 228
mcrtcell 233
mdelcell 237
mgetinfo 238
mgetrec 244
mkb 245
mkill 248
mlogchk 250
mposter 252
mquery 257
mrecover 263
mrextract 264
mrmerge 265
msetmsg 267
msetrec 268
SystemLogDirName parameter
described 276
SystemTmpDirName parameter
described 276
T
technical support 3
terminating a cell 230
test cells
described 25
test certificate, digital 194
tool tips
BIX, enabling and disabling 195
trace configuration file 51
configuring 51
parameters 51
Trace parameter 293
trace parameters
list of 293
trace, disable encryption to 41
TraceConfigFileName parameter 293
TraceDefaultFileName parameter 293
TraceFileAppend parameter 295
TraceFileHistory parameter 295
TraceFileSize parameter 295
TraceRuleLevel parameter 293
TraceRuleToXact parameter 294
TraceSrc parameter 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
tracing parameters
configuring 55
Trace 293
TraceConfigFileName 293
TraceDefaultFileName 293
TraceFileAppend 295
TraceFileHistory 295
TraceFileSize 295
TraceRuleLevel 293
TraceRuleToXact 294
TraceSrc 293
U
updating the Knowledge Base 245
usage reporting 159
V
VersionID parameter 73
versioning
compiling 73
Knowledge Bases 72
mechanism 73
retrieving version information with kbversion 74
retrieving version information with mgetinfo 74
X
xact transaction file 198
306
Notes
*97717*
*71779*
*71779*
*71779*
*71779*