Professional Documents
Culture Documents
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
Copyright 20062009 BMC Software, Inc. BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. AIX is a registered trademark of International Business Machines Corporation in the United States, other countries, or both. ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office, and is used here by BMC Software, Inc., under license from and with the permission of OGC. Linux is the registered trademark of Linus Torvalds. Oracle is a registered trademark of Oracle Corporation. Sun, Java, and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc., in the U.S. and several other countries. UNIX is the registered trademark of The Open Group in the US and other countries. BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.
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
I I I I I I I I
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)
operating system and environment information machine type operating system type, version, and service pack or other maintenance level such as PUT or PTF system hardware configuration serial numbers related software (database, application, and communication) including type, version, and service pack or maintenance level
I I I
sequence of events leading to the issue commands and options that you used messages received (and the time and date that you received them) product error messages messages from the operating system, such as file system full messages from related software
Contents
Chapter 1 Managing BMC Impact Manager cells 23 General configuration overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Production cells and test cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Cell configuration tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Configuring mcell.conf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Creating cell-specific configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Configuring event slot propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 About mcell.dir, the cell directory file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Configuring passive connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Configuring slots for time stamping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Configuring encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Reloading cell configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Managing high availability cell servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Automatic failover process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Automatic switchback process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Manually failing over to the secondary server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Manually switching back to the secondary server . . . . . . . . . . . . . . . . . . . . . . . . . . 46 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 2 Managing a Knowledge Base 65
Contents
About the unified Event Management and Service Impact Management Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Knowledge Base directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Knowledge Base index files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Managing a Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Integrating a unified KB with pre-7.2 cell definitions . . . . . . . . . . . . . . . . . . . . . . . 70 Creating a new production or test Knowledge Basemcrtcell . . . . . . . . . . . . . . . 71 Importing Knowledge Base information into a cellmkb . . . . . . . . . . . . . . . . . . . 71 Compiling a Knowledge Basemccomp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Loading a Knowledge Base into a running cellmcontrol . . . . . . . . . . . . . . . . . . . 72 Implementing changes to a Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Versioning a Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Retrieving KB version information in rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Retrieving KB version information by using a commandmgetinfo . . . . . . . . . . 74 Chapter 3 Managing the BMC Impact Administration server 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 139 140 142 142 142 144 145 146 148 149 150 152 156 157 158 159 160 163 164 165 165 165 169 172 172
Accessing the BMC Impact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting and stopping the BMC Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting and stopping the BMC Portal on Windows . . . . . . . . . . . . . . . . . . . . . . . Starting and stopping the BMC Portal on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration tasks for BMC Impact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registering production and test cells in the BMC Impact Portal . . . . . . . . . . . . . Customizing BMC Impact Portal configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Dashboard Table View columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Events Table columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Status Table columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring object link synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the number of events displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the maximum number of recent items displayed . . . . . . . . . . . . . . . . Configuring the general properties displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up Image Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration file and parameter definitions for BMC Impact Portal. . . . . . . . . . . . smsIwc/application.properties file and parameters . . . . . . . . . . . . . . . . . . . . . . . smsConsoleServer/application.properties file and parameters. . . . . . . . . . . . . . internal.properties file and parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 5 Working with Infrastructure Management
Default Infrastructure Management service model . . . . . . . . . . . . . . . . . . . . . . . . . . . Roles and permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Walkthrough. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying the out-of-the-box real-time service model . . . . . . . . . . . . . . . . . . . . . Sampling context-sensitive information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing files on remote systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Packaging support files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Launching remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Infrastructure Management tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigating the interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying and understanding the Details and Administer tab data . . . . . . . . . Editing infrastructure relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating logical components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Usage reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Executing remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reloading cell configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Forcing event propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Collecting metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Executing other actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the audit log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating the support package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Background to Infrastructure Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How a product component registers and communicates with the IAC . . . . . . .
Contents
Registering a cell with the Admin cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Recreating an Admin cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Unregistering with the IAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Chapter 6 Managing the BMC Impact Explorer (BMC IX) console 177
Defining property files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Selecting a single BMC IX instance for cross- and web-launching . . . . . . . . . . . . . . . 179 Defining console-wide policy files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Configuring display and connection settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Defining global event severity and priority color values . . . . . . . . . . . . . . . . . . . . . . . 184 Event group configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 XML files that define user interface elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Chapter 7 Defining presentation names 187
Presentation names overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Presentation name resource file locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Default presentation name definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Creating a new presentation name resource file . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Presentation name resource files search order . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Defining presentation names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Creating or modifying presentation name keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Digitally signing a .jar file with a digital test certificate. . . . . . . . . . . . . . . . . . . . . 194 Enabling or disabling presentation names in BMC Impact Explorer tool tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Chapter 8 Configuring StateBuilder and gateways 197
Understanding the StateBuilder and gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 StateBuilder configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 statbld return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Gateway configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Exporting events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Modifying a statbld.conf file to export events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Modifying a gateway.export file to export events . . . . . . . . . . . . . . . . . . . . . . . . . 206 Configuring tracing for StateBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Trouble-shooting the StateBuilder process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Appendix A BMC SIM and EM CLI Reference 209
BMC Impact Manager CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 BMC Impact Manager CLI common command options . . . . . . . . . . . . . . . . . . . . 211 Configuring CLI authentication through BMC Impact Administration Server . 212 BMC Impact Manager CLI common return codes . . . . . . . . . . . . . . . . . . . . . . . . . 213 mccompCompiling rules in the Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . 214 mcellStarting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 mcfgtraceConfiguring tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 mclassinfoRequesting class information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 mcollinfoGetting information about a specific collector . . . . . . . . . . . . . . . . . . 225
8 BMC Impact Solutions Infrastructure Administration Guide
mcontrolPerforming cell control operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . mcrtcellCreating a new cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mcstatReturning cell status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mdelcellDeleting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetinfoRetrieving information about a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetrecObtaining a global record value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkbUpdating the Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkillStopping a cell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mlogchkPerforming consistency checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mposter and msendManaging data and events . . . . . . . . . . . . . . . . . . . . . . . . . mqueryRetrieving objects from a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrecoverRecovering from a catastrophic data loss . . . . . . . . . . . . . . . . . . . . . . mrextractExtracting cell state files to create new state files . . . . . . . . . . . . . . . mrmergeMerging event objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetmsgModifying an event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetrecSetting the value of a global record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC Impact Manager CLI configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring tracing for BMC Impact Manager CLI commands . . . . . . . . . . . . . BMC Impact Manager CLI trace configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . Appendix B mcell.conf file parameters
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 297
Action result event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell failover configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client communication parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encryption parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event repository cleanup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event cleanup process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Heartbeat parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Internal cell monitor parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KB parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Propagation parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deprecated MessageBuffer propagation parameters. . . . . . . . . . . . . . . . . . . . . . . Reporting client connection parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service model parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State Builder parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Trace parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index
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
Raw output format for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Class tree for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Example of mclassinfo command for a list of classes . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Example output of mclassinfo command for a list of classes . . . . . . . . . . . . . . . . . . . 223 Example of mclassinfo command for list of classes . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Example of mclassinfo command output for list of classes . . . . . . . . . . . . . . . . . . . . . 223 Example of mclassinfo command for adding slot names . . . . . . . . . . . . . . . . . . . . . . 224 Example of mclassinfo command output for adding slot names . . . . . . . . . . . . . . . . 224 Example of mclassinfo command for adding slot flags . . . . . . . . . . . . . . . . . . . . . . . . 224 Example of mclassinfo command output for adding slot flags . . . . . . . . . . . . . . . . . 224 mcollinfo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Raw output format for mcollinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 mcollinfo example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 mcollinfo command for verbose mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 mcollinfo command for number of events for severity/status . . . . . . . . . . . . . . . . . . 227 mcontrol syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Retrying Pending propagations with mcontrol command . . . . . . . . . . . . . . . . . . . . . 230 Example of mcontrol command output for retrying pending propagations . . . . . . 230 Terminating a cell using the mcontrol command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Example of mcontrol command output for terminating a cell . . . . . . . . . . . . . . . . . . 231 Reconfiguring a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Example of mcontrol command output for reconfiguring a cell . . . . . . . . . . . . . . . . 231 mcrtcell syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Example of mcrtcell command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Example of output of mcrtcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Example of mcrtcell command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Example output of mcrtcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Example mcrtcell for recreating an Admin cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 mcstat syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 mcstat example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Message for cell not running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Message for cell running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 mdelcell syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Deleting a cell using mdelcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Output for mdelcell if cell is not running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Output for mdelcell if cell is running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 mgetinfo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 Example of mgetinfo param . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 mgetinfo param command output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Example of mgetinfo services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 mgetinfo services command output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Example of mgetinfo services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Output of mgetinfo connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 mgetrec syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Example of mgetrec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Output of mgetrec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 mkb syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 mkb command on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 mkb output on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
12
mkb command on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkb command output on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkill syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output of mkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mlogchk syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mlogchk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output of mlogchk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mlogchk message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mposter syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msend syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mposter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Definition changes using mposter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling persistent buffering using mposter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error message if buffers files are not writable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mquery syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of raw output specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verbose mode options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . End of form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Special BAROC format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mquerySelect events with severity status . . . . . . . . . . . . . . . . . . . . . . Example of mquerySelect events from collector . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting events using mquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrecover syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Fixing a broken cell using mrecover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrextract syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mrextract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrmerge syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of mrmerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetmsg syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetrec syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of msetrec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . command to send tracing output to text file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of Heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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
Figures
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
Edit Relationship dialog: field descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Edit This Relationship subdialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Audit log parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Audit log IAS properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Slots for specifying support files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 run_state values for components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Component state and menu options for a normal or primary cell in a high availability configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 Component state and menu options for a secondary cell in a high availability configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 Components and actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 default.console_policy.prop parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Property descriptions from ix.properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Event severity levels and colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Event priority levels and colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Event group configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 xml files that define user interface elements in BMC IX . . . . . . . . . . . . . . . . . . . . . . . 186 Presentation names for BMC Impact Solution interfaces . . . . . . . . . . . . . . . . . . . . . . 188 Presentation name key formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 StateBuilder file name conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 statbld.conf Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 statbld return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Gateway configuration parameter predefined variables . . . . . . . . . . . . . . . . . . . . . . . 201 Gateway Configuration Parameter Text Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 gateway.export file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 BMC Impact Manager CLI command descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Common options for CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Common return codes for CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 mccomp options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 mcell options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 mcell return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 mcfgtrace option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 mcfgtrace parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 mclassinfo options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Type of slot value for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Reported facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Class flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Information amount limitation options for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . 222 mclassinfo return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 mcollinfo options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Information amount limitation options for mcollinfo . . . . . . . . . . . . . . . . . . . . . . . . . 227 mcollinfo return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 mcontrol option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 mcontrol controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Files for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 mcrtcell options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 mcrtcell return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 mcstat option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 mdelcell options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16
mdelcell return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetinfo option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetinfo information options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information from connect request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetinfo return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mgetrec option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkb options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkb new file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mkill option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mlogchk return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mposter and msend options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mposter and msend return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mquery options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mquery query options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mquery return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrecover option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrecover return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrextract options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrextract return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrmerge options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mrmerge return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetmsg options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetmsg return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetrec options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . msetrec return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC Impact Manager CLI configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . Action result event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell failover configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client communication parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Date and time format parameters for Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encryption parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event Repository cleanup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Heartbeat parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Heartbeat slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Internal cell monitors parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KB parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Propagation parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deprecated MessageBuffer propagation parameters . . . . . . . . . . . . . . . . . . . . . . . . . Reporting client connection parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service model parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State Builder parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell tracing parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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
Tables
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
BMC Impact Manager cell BMC Impact Explorer BMC Impact Portal
Task Description
2 3
Chapter 1, Managing BMC Impact Manager cells Chapter 3, Managing the BMC Impact Administration server BMC Portal Getting Started BMC Impact Solutions Installation Guide
Define user groups for access to the console BMC Impact functions and objects. Administration Server Distribute the BMC Portal URL address so users can install consoles. BMC Impact Explorer can be deployed as a Java Web Start application from BMC Impact Portal or installed standalone.
I I I
BMC Impact Portal BMC Impact Explorer BMC Impact Service Model Editor
5 6
Chapter 4, Managing the BMC Impact Portal Chapter 6, Managing the BMC Impact Explorer (BMC IX) console Chapter 8, Configuring StateBuilder and gateways Chapter 7, Defining presentation names
7 8
(optional) Configure the StateBuilder, which BMC Impact Manager manages the persistent storage of events. (optional) Customize the labels used in the console interfaces.
I I I
BMC Impact Portal BMC Impact Manager BMC Impact Service Model Editor
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.
Service impact management For information about monitoring service impact management, see BMC Impact Solutions Service Impact Management Guide. For information about defining service models, see the BMC Impact Solutions Service Modeling and Publishing 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 test event data, collectors, and actions, select a test cell in the Events view. To view and create test event management policies, select a test cell in the Administration view. To view test service model components, use the Find tool in the Services view and select a test cell.
26
Description Create additional cells. When you install BMC Impact Manager on a system, one cell is installed. You can create additional cells by running the mcrtcell command.
2 3
If you created multiple cells for an environment, you can create separate configuration files for each cell. If you created multiple cells for an environment, configure the cells so that they can communicate with other cells in the network.
Creating cell-specific configuration files on page 30 BMC Impact Solutions Getting Started Guide
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. If inbound connections to the cell are disallowed in a protected environment, the connection has to be established within the protected zone to allow a connection between an external client and a cell in the protected zone. Configuring passive connections on page 36
7 8 9
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 If desired, you can encrypt communication among the various BMC Impact Solutions components. Set the default client parameters executing CLI commands. Configuring encryption on page 38 BMC Impact Manager CLI configuration on page 269
27
To configure the mcell.conf file using a text editor 1 Open the mcell.conf file in a text editor.
The default location is MCELL_HOME\etc.
2 Create line entries using the format Parameter=Value based on the syntax rules
described in Rules for cell configuration parameter syntax.
3 Save the changes. 4 Either reload the cell configuration or restart the cell for the changes to go into
effect. For more information, see Reloading cell configuration on page 43.
One parameter per line, in the form: Parameter=Value where the Value extends to the end of the line 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. Times are stated in seconds unless otherwise specified. 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.
For more information on cell configuration parameters, see Appendix B, mcell.conf file parameters.
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 %H %C %B %L %T %P %N
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
A range is a number of sequences, each of which is a consecutive range of ports. The cell attempts to access all ports in the specified order. The default is to use any of the ephemeral ports. For example,
I I
18281840 specifies a range of ports 1828 through 1840 1828, 1829, 1840 specifies the sequence of ports 1828, 1829, and 1840
To create cell-specific configuration files 1 Copy the configuration file that you want to be unique to the
MCELL_HOME\etc\cellName directory. cellName represents the name of the cell.
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 BMC Impact Solutions Infrastructure Management Guide
When a cell starts, it searches for configuration files in the MCELL_HOME\etc\cellName directory. If no configuration file is found, the cell uses the configuration file in the MCELL_HOME\etc directory. For example, if you copy the mcell.conf file into the MCELL_HOME\etc\cellName directory and modify it, the cell reads that mcell.conf file and all other files in the MCELL_HOME\etc directory. All cells use the following cell-specific directories:
I
Knowledge Base)
I
of the cell
I
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:
I I I I
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
CLASS mc_modhist
administrator propagates administrator value changes up (forward) within the cell hierarchy
propagates changes to notes attached to an event up (forward) within the cell hierarchy propagates changes to repeat_count up (forward) within the cell hierarchy propagates severity value changes up (forward) within the cell hierarchy
f f f
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
event sources
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:
I I I I
enable cell-to-cell communication in mcell.dir configure propagation parameters in mcell.conf specify the slots whose modification has to propagate in mcell.propagate either write a Propagate rule or define an Event Propagation policy
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
Name
# ## 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
Cells may be grouped into separate cell files readable only by certain users or groups (domains).
35
A cell must be configured to communicate with, at a minimum, the cells to which it propagates events. A cell does not need to be configured to communicate with the cell from which it receives events, even for backward propagation. 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.
To configure the client for passive connections 1 Open the mcell.dir file in a text editor.
The default location is MCELL_HOME\etc.
3 Save the changes. 4 Either reload the cell configuration or stop and start the cell.
36
When a cell or gateway client needs to connect to an isolated destination cell, it cannot establish a connection because it does not have the IP address and port number of the cell. Instead, the cell or gateway client registers the destination and waits for a connection from it.
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
To configure slots for time stamping 1 Open the mcell.modify file in a text editor.
The default location is MCELL_HOME\etc.
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
# Configuration of slots affecting mc_modification_date when modified # Format : # SlotName # Special name : CLASS : specifies all class-specific slots status severity mc_priority repeat_count CLASS
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.
3 Save the changes. 4 Either reload the cell configuration or stop and start the cell.
Configuring encryption
You can encrypt communication among the various BMC Impact Solutions components. To enable encryption, make the appropriate settings in the following locations:
I I I I
the cells configuration file mcell.conf the CLI configuration file mclient.conf the BMC Impact Administration server used by BMC Impact Explorer the cell directory file, which is MCELL_HOME\etc\mcell.dir by default
38
Configuring encryption
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
A character in the hexadecimal range (0-9, A-F, a-f) is converted to the corresponding hexadecimal value (for example, 8 gives the value 8, B gives the value 11). Any other character is converted to its ASCII code modulo 16.
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:
I
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.
you execute the CLI command on a host without an mcell.dir file the cell has an encryption key other than 0 (zero)
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.
AddrMaskList = AddrMask {':' AddrMask} AddrMask = Addr ['/' Mask] Addr = Nr '.' [Nr '.' [Nr '.' [Nr]]] Mask = Addr | Nr Nr = 0..255
41
Configuring encryption
An abbreviated Addr or Mask is expanded with zeros. A numeric Mask (number without trailing dot) gives the number of 1 bit. An omitted Mask defaults to all bits set to 1. A connection is allowed if the source address ANDed with the Mask matches Addr ANDed with the Mask.
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
Parameter AllowConnectionFrom=0./0
IP Address parameters
Description all systems allowed (same as 0.0.0.0/0)
AllowConnectionFrom=0./32
AllowConnectionFrom=198.12./255.255.
AllowConnectionFrom=127.0.0.1/1
allows any host with an IP address lower than 128.0.0.0, because it indicates there is only 1 bit in the mask Only the highest-order bit is considered and must be the same as 127, which is a 0 bit.
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:
I I I
42
When you specify more than one address per mask pair, a system that matches at least one of the pairs can accept a connection.
Send a hang-up signal on UNIX. 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 cell directory
KB collector
43
Table 6
Type
KB program
KB data
a
kb\data \kb\records
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
To manually fail over from a primary server to a secondary server 1 Terminate the primary server (if it is still running) by entering: mkill -n
CellName#1
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.
To manually switch back from a secondary server to a primary server 1 Clear the primary server log directory by entering the appropriate command for
your operating system:
I I
3 Transfer the state file from the secondary to the primary server:
I
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
number of events received, including erroneous ones number of events containing errors number of events dropped by rules (Filter, Regulate) number of events removed from the event repository during cleanup number of events propagated, including sendto number of events added to the event repository, that is, entering the permanent context
Calculation is performed on a 60-second basis, so every minute the counters are restarted. Counts from the last five minutes are retained. Running counters are reset only on demand.
47
short termtotal count of the last complete one-minute interval medium termsum of the five last, completed one-minute intervals long termrunning total
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
Slot description long_average long_interval long_total medium_average medium_interval medium_total short_average short_interval short_total subject
MC_CELL_METRIC slots
Description metric description long-term average, per second long-term interval lengths, in seconds long-term total count medium-term average, per second medium-term interval lengths, in seconds medium-term total count short-term average, per second short-term interval lengths, in seconds short-term total count metric subject name
48
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
Slot client_location client_name client_type
MC_CELL_CLIENT slots
Data the location of the client as IPAddress:Port the client's name, as announced by the client, or noname type of client, such as adapter, CLI, console, cell
An attempt to connect using an invalid encryption key generates an internal event, MC_CELL_UNALLOWED_CONNECT, that contains the slot reason, which details why the connection is refused.
I
Another class, MC_CELL_MODIFIED_EVENT, represents the operation of modification of an event. Table 10 lists the slots. Table 10
Slot event requestor
MC_CELL_MODIFIED_EVENT slots
Data universal event ID of the event being modified identification of the user that performed the modification
the trace configuration file, mcell.trace tracing parameters in the mcell.conf configuration file
You can also configure cell tracing using the mcfgtrace command. For further information, see mcfgtraceConfiguring tracing on page 218.
50 BMC Impact Solutions Infrastructure Management Guide
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
Table 11 lists the parameters that must be defined in a configuration line. Table 11
Parameter Destination
Levela
I I
INFORM VERBOSE
51
Table 11
Parameter Modulea
ACTION COLLECT COLLMAP CONFIG CONTROL DATAPROC DBDATAID DBEVTID DBEVTTM EVTLOG EVTPROC EXPORT FILTER
I I I I I I I I I I I I
HEARTBEAT INTEVT MC2TEC MCBAROC MESSAGES METRIC PROPAGATE QUERY RECOVERY RECTRL REGEX REGULATE
I I I I I I I I I I I I
RESULT ROLES RULES SERVICE SRVMGT STATBLD SVCMGT SVRCOMM SVRDIR SYNCH SYSPROC TRACE
SWITCH Switch
a
keyword that enables access to a sublevel or category of messages for a module 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
configure which module/level combinations of trace messages will be produced as events 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.
The log_time date and time slot is an integer in timestamp format. The textual representation of the log message log_text uses the originating cell's local message catalog.
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
Slot
MC_CELL_PROCESS_ERROR slots
Data the error number the part of the processing command that has the error an error description message the position in the rule source where the error occurred the mc_ueid of the event that was being processed
If the modification applies to all modules, then log_module=ALL. If the modification applies to all message levels, then log_level=ALL. The log_destination slot contains the full path to the destination file, in normalized (UNIX) form. Other possible values are:
I I I
noindicates disabling stderrindicates redirection to the standard error stream consoleindicates redirection to the console terminal
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 1 2 3 4 5 16 17 19 27 29 37 39 47 49 57 59 67 69 77 79 97
57
connect and disconnect a cell view cell information register for state change events
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.
To connect or disconnect a cell 1 Right-click the cell icon or name. 2 Select Connect or Disconnect from the pop-up menu.
This menu item toggles between Connect and Disconnect, depending on the state of the cell when you right-click it. The result of your action in the Administration view is reflected in the Events and Services views.
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.
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.
The SIM_COMPONENT_DELETE and SIM_RELATIONSHIP_DELETE events are generated when you remove a configuration item or an impact relationship from the published service model. The SIM_COMPONENT_CHANGE and SIM_RELATIONSHIP_CHANGE events are generated when a configuration item or an impact relationship is altered by the cell because of a change in status or priority. BMC Impact Manager generates these notification events upon request by a client. For example, the BMC Impact Portal can register to receive notification events just as a gateway client can. Another BMC Impact Manager or even the BMC Impact Manager containing the SIM model can register to receive the notification events.
59
Slots for configuration item: status manual_status computed_status self_status impact_status manual_status_comment manual_status_requestor consolidate_function root_causes schedule_status cost self_priority impact_priority computed_priority maintenance_mode
To register for notification events, you create a SIM_NOTIFICATION_REGISTRY instance in the cell, telling it which notification events to look for and which clients to forward the events to. You perform this procedure through the BMC IX interface or through the mposter CLI.
NOTE
Refer to the BMC Impact Solutions: Knowledge Base Development Reference for mposter examples that show how to register for notification events.
To register for notification events in the BMC IX 1 In the Adminstration tab, expand the cell for which you want to create a
SIM_NOTIFICATION_REGISTRY data instance.
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 mc_udid 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 comma-separated list of SIM notification events for which notification is requested
I I I I I
notification_mode
specifies how slot values that have not changed are reported in the SIM notification event
I
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
notifications_at_registration instructs the cell whether or not to send the current component states at the moment of registration
I
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
asset_filter
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.
7 Click OK.
In the Administration tab, the new SIM_NOTIFICATION_REGISTRY instance is displayed under SIM_NOTIFICATION_REGISTRY.
To delete a SIM_NOTIFICATION_REGISTRY data instance 1 Right-click the SIM_NOTIFICATION_REGISTRY data instance. 2 Select Delete. To modify a SIM_NOTIFICATION_REGISTRY data instance 1 Right-click the SIM_NOTIFICATION_REGISTRY data instance. 2 Select Edit. 3 Make the necessary changes to the fields in the SIM_NOTIFICATION_REGISTRY
dialog box.
62
mcdb.0 mcdb.lock
2 If either or both of these files are present, delete them. 3 Restart the cell.
Problem: The primary and secondary servers for my high availability cell are in active mode simultaneously or are unsynchronized.
This problem can occur when the primary and secondary servers are running on a network that does not have a reliable connection, if you have started a high availability cell using any of the mcell -i initialization options (for example, -ia, -id or other variants), or if the primary server was started first and terminates before the secondary server is started.
63
Problem: The primary and secondary servers for my high availability cell are in active mode simultaneously or are
Possible solution: Synchronize the mcdb and xact files of the primary and secondary servers
Follow these steps to correct the incompatible states between the primary and secondary servers:
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.)
4 Start the secondary cell server. 5 Start the primary cell server.
64
Chapter
2
66 66 66 70 70 70 71 71 71 72 72 72
Chapter 2
65
About the unified Event Management and Service Impact Management Knowledge Base
For an overview of the unified template structure of the KB, see the BMC Impact Solutions Concepts Guide.
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.
The Knowledge Base used by the cell during runtime is located in %MCELL_HOME%\etc\CellName\kb on Windows platforms and in $MCELL_HOME/etc/CellName/kb on UNIX platforms.
66
The template Knowledge Base resides in the MCELL_HOME\etc\default\SIM or MCELL_HOME\etc\default\EM directory. The Knowledge Base available (EM only or both EM and SIM) will depend on the type specified when the cell was created.
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.
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 bin stores the external scripts that can execute during rule processing and actions that can be run from BMC Impact Explorer The bin directory organizes the scripts and programs in subdirectories specific to the appropriate operating system, as follows:
I I I I I I
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. classes stores event class, data class, and interface definitions 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 stores collector rule definitions Collector definitions are used to organize the event lists that are viewed in the BMC Impact Explorer console. Collector rules are defined in .mrl files. Collectors and their syntax are described in BMC Impact Solutions Event Management Guide. 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 stores primitives and functions used in the Knowledge Base For example, the SIM Knowledge Base contains the following files that cannot be modified:
I I
sim.wiccontains the compiled implementation of primitives and functions that are loaded by the cell at startup sim_decl.wiccontains the compiled definitions for primitives and functions; it is loaded by the compiler to compile rules that reference SIM primitives
For more information about functions and primitives, see the BMC Impact Solutions Knowledge Base Development Reference Guide. 68 BMC Impact Solutions Infrastructure Management Guide
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 stores the rule definitions for the Knowledge Base The source for rule definitions are the files with an .mrl extension. The compiled versions of rules are contained in files with the .wic or .pkg extension. The .load file indicates the order in which the rules are loaded into the cell. Rules and their syntax are described in the BMC Impact Solutions Knowledge Base Development Reference Guide and in the BMC Impact Solutions Event Management Guide.
Table 16 lists the file extensions and directory location for the each of the components contained in a KB. Table 16
Component event classes data classes data instances global records rules collectors action executables service model class definitions interface classes scripts and programs
Chapter 2
69
manifest.kbserves as an index file for the listed directories that compose the
Knowledge Base during compilation. This file is located in %MCELL_HOME%\etc\CellName\kb on Windows platforms and in $MCELL_HOME/etc/CellName/kb on UNIX platforms.
I
corresponding subdirectory of the Knowledge Base directory structure. Load files are included in each subdirectory to determine load order for that particular directory. Files types within the .load file do not have extensions.
I
.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.
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.
72
A logical KB module is a collection of class definitions and rules that perform a specific task within the KB. For instance, all class definitions and rules that are related to Help Desk events could be called the HelpDesk KB module. A single KB can contain multiple such logical modules. The class definitions and rules that are not associated to a specific KB module are considered to be part of the global, unnamed KB module. If desired, you can make rules behave differently depending on the version of specific KB modules. This can be useful in patches, for example.
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 ModuleName
Description 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:
I I I I I I
release number of the compiler used to compile the file build number of the compiler used to compile the file build date of the compiler used to compile the file source file name source file size in bytes source file checksum
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.
Returned results list of KB modules with version information list of KB source files with compiler version information
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
BMC Impact InfoRetrieval 7.3.00 (Build 1332814 - 27-Jan-2009) Copyright 1998-2009 BMC Software, Inc. as an unpublished work. All rights reserved. 7.3.00 1332814 27-Jan-2009 collectors/self_collector.mrl 329 215528602 7.3.00 1332814 27-Jan-2009 collectors/mc_bystatus_collectors.mrl 8682876756519 7.3.00 1332814 27-Jan-2009 collectors/mc_bylocation_collectors.mrl 2673155257002 7.3.00 1332814 27-Jan-2009 collectors/mc_evr_collectors.mrl 17193192677488 7.3.00 1332814 27-Jan-2009 collectors/bii4p_collectors.mrl 1861 72069569 7.3.00 1332814 27-Jan-2009 collectors/mc_sm_collectors.mrl 1351 3438665385 7.3.00 1332814 27-Jan-2009 collectors/catchall_collector.mrl 3813425794528 7.3.00 1332814 27-Jan-2009 rules/mc_startup.mrl 578 2337723164 7.3.00 1332814 27-Jan-2009 rules/im_internal.mrl 36351 4174289538 7.3.00 1332814 27-Jan-2009 rules/mc_intevt.mrl 3115 1930567566 7.3.00 1332814 27-Jan-2009 rules/mc_mccs.mrl 2296 2571308892 7.3.00 1332814 27-Jan-2009 rules/ips.mrl 2333 2499185120 7.3.00 1332814 27-Jan-2009 rules/mc_sm_start.mrl 1196 92543871 7.3.00 1332814 27-Jan-2009 rules/mc_sm_associate.mrl 3389 3376465454 7.3.00 1332814 27-Jan-2009 rules/mc_sm_maintenance.mrl 1885 797195742 7.3.00 1332814 27-Jan-2009 rules/mc_sm_elect.mrl 1055 4013285370 7.3.00 1332814 27-Jan-2009 rules/mc_sm_attach.mrl 1943 1558282738 7.3.00 1332814 27-Jan-2009 rules/mc_sm_shadow.mrl 3781 4283488066 7.3.00 1332814 27-Jan-2009 rules/mc_sm_slm.mrl 4512 1631402620 7.3.00 1332814 27-Jan-2009 rules/bii4p.mrl 10473 1881293223 7.3.00 1332814 27-Jan-2009 0 1073706332 7.3.00 1332814 27-Jan-2009 bin/mc_actions.mrl 1304 3908443203 7.3.00 1332814 27-Jan-2009 bin/im_operations.mrl 16424 2639831549 7.3.00 1332814 27-Jan-2009 bin/sim_operations.mrl 3992 3834546431
Chapter 2
75
76
Chapter
This chapter presents the following topics: 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 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 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
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 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 color.properties credential_repository.xml ldap_configuration_query.xml default_role_permissions.xml
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:
I I I I I
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 -ac -mc -dc -lc -aru -mru -dru -lru -ar -dr -lr -mr -ag -dg -lg -mg -acr -mcr -dcr -lcr -cp
79
Table 18
Option -rp
-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.
enclose values within quotation marks if they contain spaces omit spaces in lists enclose password values within double quotation marks For example, if the password string is $able_baker, then enclose it within double quotation marks in the iadmin command string, as in the following excerpt:
password=$able_baker
I I
On Windows, execute the iadmin command from any path On Unix, set $MCELL_HOME environment using the command ./etc/mcell/setup_env.sh, then run the iadmin command from any path
80
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
Defining group roles and permissions Adding Impact Manager cells to the cell_info list Defining standalone, primary, and secondary BMC Impact Administration servers Defining HA configuration for Impact Administration cells Synchronizing cell information with BMC Atrium CMDB Receiving synchronized data from the BMC Portal Defining server-side logging levels Defining client-side logging levels Customizing the GUI color scheme for status, priority, and severity levels Setting LDAP authentication Configuring IAS to support remote actions Checking the time required to execute an LDAP query
Depending on the goal of the task, you may need to edit multiple files.
81
1 Open the file in a text editor. 2 Make the changes in the proper format. 3 Save the file without changing its extension or file path. 4 Restart IAS. NOTE
When manually editing files to enable a high availability configuration, you must follow the special guidelines outlined in the topicDefining a failover configuration for the Impact Administration cell on page 105.
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 BMC Impact Solutions Infrastructure Management Guide
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. Table 19
Permission (P) or Right (R)
Service Administrator
Service Operator
Service Manager
Function Dashboards-Create, update, and delete all profiles Dashboards-Create and delete own profiles only Dashboards (SIEM) Edit
Edit
View
Supervisors 83
Full Access
Read Only
Operators
Choices
Admins
Defining permissions
Table 19
Permission (P) or Right (R)
Service Administrator
Service Operator
Service Manager
Function Dashboards (CIEM) Events tab ConfigurationEdit Relationship View ConfigurationEdit Personal Filters ConfigurationEdit Personal Attribute (Slot) Orders ConfigurationEdit Personal MetaCollectors ConfigurationEdit Global Event Filters ConfigurationEdit Global Attribute (Slot) Orders ConfigurationEdit Impact Manager Group on Impact Manager Configuration window Events tab-Show Impact Administration cell Events tabJump from an Event to Its Services Impacted View Events tabReopen Events
R R R R R
X X X X X
X X X X X
X X X X X
X X X X X
X X X X X
X X X X X
X X
X X X X X
X X X X X
X X X X X
Edit
R R
Edit Edit
X X
X X
X X
X X
X X
X X
Edit
Edit
Edit
Edit
84
Supervisors
Full Access
Read Only
Operators
Choices
Admins
Defining permissions
Table 19
Permission (P) or Right (R)
Service Administrator
Service Operator
Service Manager
Function Events tabEvent Operation Supervisor Privileges (for example, close events owned by someone else) Events tabAssign Events Events tabAdd Image View Events tabDelete Image View Services tab Services tabSearch for Service Components Services tab-Create and delete components Services tabEvent List View of a Service Component Edit
R R R R R
X X X X X
X X X X X X X X X X X X X
X X X X X X
Edit
View
Services tabEdit My Edit Services Navigation Tree Services tab-Create, Edit, Delete Relationship between components Services tabSet or Remove Manual Status (of a component) Action Edit
Edit
Supervisors 85
Full Access
Read Only
Operators
Choices
Admins
Table 19
Permission (P) or Right (R)
Service Administrator
Service Operator
Service Manager
Function Services tabSet or Clear Maintenance Mode (of a Component) Action Administration tab Timeframes Administration tab: all actions Edit
R R R R R
X X X X X
X X X X X
X X
X X
X X X X X
Infrastructure Edit Management subtab Infrastructure Edit Management subtab: all actions Alias Formula Editor Edit Remote Actions: Create remote actions Send Events to Cell Edit
R R
X X
X X
X X
R R
Edit
X X
X X
X X
86
Supervisors
Full Access
Read Only
Operators
Choices
Admins
If you create a separate .xml file to contain your customized role/permission mappings, you must specify its name in the com.bmc.sms.ixs.role.permission.mapping property of the ias.properties file. Then you must restart IAS to initialize the change. The user-defined .xml file does not override the default file. Its individual entries override matching ones in the default file. Any entries in the default file that are not overridden by matching ones in the user-defined file remain valid. When you use the iadmin script to add, modify, or delete a role/permission mapping, the change is saved to the role/permissions file specified by the com.bmc.sms.ixs.role.permission.mapping property.
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.
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin command using the -dr option, as in the following example:
iadmin -dr role=Test
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 Full Access Read Only
Service Administrators Service Managers Service Managers - Senior Service Operators Service Operators - Senior 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
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin command using the -ag option, as in the following example:
iadmin -ag group=NewGroup:roles=Role
Any roles that you add to a group must have already been defined in the
group_roles.xml file.
90
To update user groups and roles (file editor) 1 Open the group_roles.xml file in an editor. 2 Update or delete the existing entries, or add a new entry where
I I
3 Save and close the group_roles.xml file. 4 Restart the IAS to initialize the changes.
To enable file-based authentication 1 In the ias.properties file, ensure that the com.bmc.sms.ixs.enable.file.login
parameter is set equal to true.
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
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin command using the -rp option, as in the following example:
iadmin -rp loginId=JoeUser:newPassword=bsm
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
To synchronize with the BMC Atrium CMDB 1 Change the com.bmc.sms.ixs.cmdb.enable.sync property to true. 2 Enter the fully qualified domain name or the IP address of the host system where
the AR Server resides.
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
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
This information defined in the server_logging.properties file describes the properties that you would typically modify: Table 22
Property .level
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 java.util.logging.FileHandler.count the maximum size of each log file in bytes. The default is 5 million bytes (about 5 MB). 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.
I I I I
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
This information helps in gathering factual information about the customer environment for IAS and fine tuning IAS. You can define the configuration settings for status monitoring in the ias.properties file.
99
Table 23
Property
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
com.bmc.sms.ixs.iasclient.threadManager.cor Specifies the Core ThreadPool Size. It indicates the number of e_Pool_Size threads to keep in the pool even if they are idle (Minimum Thread Pool size). com.bmc.sms.ixs.iasclient.threadManager.ma Specifies the Maximum ThreadPool Size. It indicates the x_Pool_Size maximum number of threads to allow in the thread pool.
100
Table 24
Property
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
By default the IAS is configured to work in standalone mode. However, after installation, you can choose to implement a failover configuration, in which you define a pair of primary and secondary servers to handle failover situations after which you need to restart both the servers.
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:
I I I I I
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.
com.bmc.sms.configService.keepBackupFile
com.bmc.sms.ixs.sync.interval
Chapter 3
103
Table 25
Property
com.bmc.sms.ixs.primary.server
com.bmc.sms.ixs.backup.server
for failover definitions. The IP address of the secondary server along with its default port number in the following format: ipaddressOfSecondaryServer:portNumber. You define the secondary server in the ias.properties file of the primary IAS server.
com.bmc.sms.ixs.server.mode
the server role. Options are standalone (default), primary, and backup.
If you specify primary or backup, then of course you must complete the primary and backup server entries in the respective ias.properties files of the two servers.
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.
execute the iadmin -sync command on the secondary server to start the synchronization process immediately instead of waiting until the next synchronization interval
104
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.
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
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 BMC Impact Solutions Infrastructure Management Guide
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
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
Use Lightweight Directory Access Protocol (LDAP) authentication in a production environment. In this way, you can link your BMC Impact Administration server (IAS) authentication with your corporate infrastructure for user authentication and authorization management. Using LDAP authentication allows you to use the same user definitions across multiple BMC product lines. After you define your LDAP user and user groups, you can map your LDAP user groups to the IAS user groups. Any users you add to an LDAP user group share the permissions of the IAS user group to which you have mapped. The IAS supports Active Directory LDAP nested groups. You can use a single sign-on to access multiple products. You do not have to create a separate user definition and sign-on information for each product. To enable LDAP authentication for the IAS on a Windows system, your login account must have administrator privileges on the target system. On a UNIX system, you must be logged in as root or under a user account with write and execute permission on the IMPACT_SOLUTIONS_HOME/server directory. Set up your LDAP server according to your LDAP server procedures. Next, enable the LDAP login entry in the ias.properties file. Then you can enter your LDAP configuration information for each LDAP server that you are enabling.
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.
To enable the LDAP login entry in the ias.properties file 1 In an editor, open the IMPACT_SOLUTIONS_HOME/server/conf/ias.properties
file, where IMPACT_SOLUTIONS_HOME/server is the installation directory of your server. Locate the com.bmc.sms.ixs.enable.ldap.login parameter, and set it equal to true:
#----------------------------------------------------------------# Enable/disable LDAP login module. # When it is enabled, "ldap_definition.xml" file has to be filled. #----------------------------------------------------------------com.bmc.sms.ixs.enable.ldap.login=true
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.
3 Save and close the ias.properties file. 4 Restart IAS. 5 In an editor, open the IMPACT_SOLUTIONS_HOME/server/conf/jaas.conf file. Do
not modify this file. Verify that it contains an entry such as the following:
com.bmc.sms.ixscomm.authentication.ldap.LdapLoginModule Sufficient;
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
<?xml version="1.0" encoding="UTF-8"?><ldapList xmlns="urn:bmc:schemas:impact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:bmc:schemas:impact ldap_definitions.xsd"> <ldap alias="test"> <host>majestix.bmc.com</host> <port>389</port> <version>3</version> <baseDN>DC=pinfrastruct,DC=rd,DC=bmc,DC=com</baseDN> <connectionUserName>glin@pinfrastruct.rd.bmc.com</connectionUserName> <useridAttribute>sAMAccountName</useridAttribute> <useSSL>false</useSSL> <memberOfAttribute>memberOf</memberOfAttribute> <userSearchFilter>(objectClass=organizationalPerson)</userSearchFilter> <groupSearchFilter/> <connectionPassword encrypted="true">fisSCap4ZhOLOUENWPLe== </connectionPassword> </ldap> ...... </ldapList>
2 Follow these guidelines for your <ldap></ldap> entries: A Specify a unique alias for each LDAP configuration. B Ensure that the LDAP group is defined in the group_roles.xml file on the IAS. 3 Using Table 28 on page 111 as a guide, complete the LDAP configuration
parameters. Table 28
host port version
LDAP parameter
Chapter 3
111
Configuring Lightweight Directory Access Protocol for BMC Impact Administration server
Table 28
baseDN
LDAP parameter
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
authentication password (encrypted) that is used to connect to the LDAP server. Note: Set the encrypted attribute equal to false and then enter the password in plain text. When IAS restarts, it encrypts the password and changes the encrypted attribute value from false to true.
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
From the/bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin command using the -ag option, as in the following example:
iadmin -ag group=NewGroup:roles=Role
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:
I I I I I I I I
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
Group names Service Administrators, Service Operators - Senior, Service Operators Service Administrators, Service Operators - Senior, Service Operators Service Administrators, Service Operators - Senior, Service Operators Service Administrators, Service Operators - Senior, Service Operators Service Administrators, Service Operators - Senior Service Administrators, Service Operators - Senior Service Administrators, Service Operators - Senior
Event operation Acknowledge Take Ownership Decline Ownership Close Assign to Operation Set Priority Reopen
An example of a group name assignment to a specific event management action is shown below:
action im_operations.Acknowledge: { ['Service Administrators','Service Operators Senior','Service Operators',nameofUserGroup] }
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
5 Restart the cell using the mcell command. To retrieve LDAP groups or to authenticate an LDAP user
From the /bin subdirectory of your IMPACT_SOLUTIONS_HOME/server directory, execute the iadmin command using the -tlq option, as in the following example that retrieves a list of LDAP groups:
iadmin -tlq group
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 com.bmc.sms.ixs.search.time.limit com.bmc.sms.ixs.search.ldap.group Description the maximum time for an LDAP query to retrieve data from the LDAP server. The default is 5000 milliseconds. 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
I
I I I
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
118
To manually synchronize the cell_info.list 1 Execute the iadmin -lc command against the Impact Administration server system
that you will later configure as the secondary server. An example command with sample output is shown below:
bash-3.00# iadmin -lc BMC Impact Administration Server 7.3.00 [Build 1647631 - 29-Dec-2008] Copyright 1998-2009 BMC Software, Inc. as an unpublished work. rights reserved. List BMC Impact Managers: pun-sms-sun31 mc pun-sms-sun31.bmc.com:1828 Production * All
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.
5 Restart the primary and secondary servers. 6 Execute the iadmin -reinit fullsync command on the secondary server to copy the
primary servers configuration to it and to restart it with the new configuration
Chapter 3
119
120
Chapter
4
122 122 123 123 124 124 124 124 125 126 127 127 129 130 130 131 132 132 133 134 136
Chapter 4
121
To access the BMC Portal 1 In the browsers address box, type the BMC Portal URL address using the
following syntax:
https://computerName:portNumber
I
computerNamerepresents the host name of the BMC Portal server portNumberrepresents the port number assigned to the BMC Portal; the default port number is 443
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
using the Services window using the net start and net stop commands
To start or stop the BMC Portal from the Services window 1 Open the Services window. 2 From the scroll list, select BMC Portal. 3 To start the service, click Start Service. 4 To stop the service, click Stop Service. To start or stop the BMC Portal from the command line
From a command prompt, use the following methods to start and stop the BMC Portal:
I
Chapter 4
123
To configure Dashboard Table View columns 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
2 Edit the file to add or remove columns using the following format:
table_name=comma separated attribute (slot) names
124
To configure Events Table columns 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
2 Edit the appropriate events table column as shown in Table 30 on page 125.
Table 30
status mc_priority severity date_reception owner_name msg
To configure Status Table columns 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
To configure object link synchronization 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
Configuring reports
You can configure the following items for reports by editing the ..\smsConsoleServer\application.properties file:
I I I I
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 Managing the BMC Impact Portal 127
Configuring reports
Table 32
Retention Age
com.bmc.sms.consoleserver.retention.policy. The number of days Status tab data will be age.SMS_CS_STATUS_EVENT retained. Default value is 395. com.bmc.sms.consoleserver.retention.policy. The number of days Availability data will age.SMS_CS_RT_AVAIL be retained. Default value is 395. com.bmc.sms.consoleserver.retention.policy. The number of days Mean Time to Repair age.SMS_CS_RT_MTTR data will be retained. Default value is 395. com.bmc.sms.consoleserver.retention.policy. The number of days Mean Time Between age.SMS_CS_RT_MTBF Failure data will be retained. Default value is 395. com.bmc.sms.consoleserver.retention.policy. The number of days Mean Time Between age.SMS_CS_RT_MTBSI Service Incidents data will be retained. Default value is 395. com.bmc.sms.consoleserver.retention.policy. The number of days event data will be age.EG_EVENT retained in the BMC Datastore. Default value is 395.
128
Table 33
Parameter type
com.bmc.sms.reportSummarizer.scheduler.is Determines whether or not the setting of StartingNextHour startingHour will be ignored. If set to true, startingHour will be ignored. Default value is true. com.bmc.sms.reportSummarizer.scheduler. startingHour Determines the desired starting hour. No summarization is made until this value is reached. If the startingHour has passed on that day, the summarization will start at that hour the next day. Default value is 0.
To configure the number of events displayed 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
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 Managing the BMC Impact Portal 129
To change the maximum number of recent items displayed 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
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 configure the general properties displayed 1 Open the application.properties file in a text editor. This file is located at
installationDirectory\tools\jboss\server\all\conf\properties\smsIwc\.
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:
I I I
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
To modify BMC Impact Portal connection settings 1 In a text editor, open the
%BMC_PORTAL_KIT_HOME%\appserver\websdk\tools\jboss\server\all\conf\ properties\smsConsoleServer\application.properties file.
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
3 Modify the connection properties. 4 Save the application.properties file. 5 Restart the BMC Portal service (or daemon) to initialize the file.
The BMC Impact Portal settings are reset.
BMC Impact Portal BMC Impact Service Model Editor BMC Impact Publishing Server
132
contains the general BMC Impact Portal configurations for component properties and user Description interface presentation Parameter name
com.bmc.sms.iwc.ui. recentitems.maxsize
Description
Default value
sets the maximum number of objects that can display 5 in the Recent Items group folder in the navigation tree of the BMC Impact Portal Refer to Changing the maximum number of recent items displayed on page 130 for more information.
com.bmc.sms.iwc.status. table
sets the columns that will display in the status and dashboard table views Refer to Configuring Dashboard Table View columns on page 124 for more information.
determines which general properties are displayed in See the application. the Configure tab for selected components properties file for more information. Refer to Configuring the general properties displayed on page 130 for more information. determines which columns in the events table are visible in the BMC Impact Portal module Refer to Configuring Events Table columns on page 125 for more information. See the application. properties file.
com.bmc.sms.iwc.event.table
com.bmc.sms.iwc.domain. notification.impact.type
sets the impact definitions included in a component notification e-mail You can designate multiple types of impact definitions, separating each by a comma. If no impact type is set explicitly, the default is BMC_BaseElement.
BMC_BaseElement
com.bmc.sms.iwc.domain. recentitem.RecentItemsFolderIcon
ServiceComponent .gif
Chapter 4
133
Table 34
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 sets the maximum and minimum number of events retrieved per component instance; this information is displayed on the Events tab minimum: 5 maximum: 50
Parameter name
com.bmc.sms.configService. dataLocation
com.bmc.sms.configService. keepBackupFile
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
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 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 cellName.timeout
sets the timeout value for data queries by the BMC 30 seconds Impact Portal to the specified cell. The timeout value is measured in seconds sets the number of times for the BMC Impact Portal to try to reconnect to the specified cell when it is unavailable cell (such as the cell or host is down) 60 tries
cellName.reconnect_attempts
sets the polling cycle, measured in seconds, for the BMC 30 seconds Impact Portal reconnection attempt to the specified cell sets the polling cycle, measured in seconds, for the BMC 1800 seconds Impact Portal data query attempt to the specified cell sets whether is encryption is enabled (off or on) for the connection with the specified cell defines the path in which the icon images for service model components are maintained on /smsConsoleSer ver/images/obje cts/
com.bmc.sms.event. maxDelayedHours com.bmc.sms.consoleserver. retention.policy.age. SMS_CS_STATUS_EVENT 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
defines the maximum number of hours an event can be 24 hours delayed and will still be processed sets the length of time, in days, that report data is retained for each report and that event data is retained in the BMC Datastore 395 days
sets whether the Object Store communication service should run in unrestricted mode when connecting to the Remedy server
true
Chapter 4
135
Table 35
identifies the host computer on which the BMC Remedy Action Remedy Action Request System host resides server host name lists the port number on which BMC Remedy Action Request System runs default
aggregator.properties file
aggregator.properties BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties/sms ConsoleServer contains the configurations for BMC Impact Portal communications with cells, including port number used for cell communications, encryption key, and encryption enablement Description sets the port number through which the BMC Impact Portal communicates with the BMC IM cell sets the encryption key used to communicate with the BMC IM cell communication encryption indicator (true or false) Default value 3783
Parameter name
com.bmc.sms. eventaggregator. jserverPortNumber com.bmc.sms.eventaggregator. jserverEncryptionKey com.bmc.sms.eventaggregator. jserverEncryptionEnabled
mc true
internal.properties file
internal.properties BMC_PORTAL_KIT_HOME/appserver/webskd/tools/jboss/server/all/conf/properties /smsConsoleServer 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 Description Default value
136
Table 37
internal.properties file
sets the port number through which the BMC Impact Portal communicates with the Administration Server 3084
com.bmc.sms.ixs.port.number
com.bmc.sms.ixs.enable.bind.ip com.bmc.sms.ixs.bind.ip.address
sets whether the BMC Impact Portal can bind an IP false address on a multi-homed (multi NIC card) system specifies the IP address on a multi-homed system to 0.0.0.0 which the BMC Impact Portal is bound
Chapter 4
137
138
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
This chapter presents the following topics: Default Infrastructure Management service model . . . . . . . . . . . . . . . . . . . . . . . . . . . Roles and permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Walkthrough. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying the out-of-the-box real-time service model . . . . . . . . . . . . . . . . . . . . . Sampling context-sensitive information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing files on remote systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Packaging support files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Launching remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Infrastructure Management tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigating the interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying and understanding the Details and Administer tab data . . . . . . . . . Editing infrastructure relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating logical components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Usage reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Executing remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reloading cell configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Forcing event propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Collecting metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Executing other actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the audit log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating the support package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Background to Infrastructure Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How a product component registers and communicates with the IAC . . . . . . . Registering a cell with the Admin cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recreating an Admin cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unregistering with the IAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 5
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 101 102 103
140
Table 38
Group Id 104 105 106 110 111 112 120 121 122 123 124 125 126 127 130 131 132 133 134 140 141 142 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
LOG_FILE_ADAPTER SNMP_ADAPTER WINDOWS_EVENT_ADAPTER SYSLOG_ADAPTER TCP_ADAPTER TELNET_ADAPTER UDP_ADAPTER IIP7 IIP3 IIOVO IINNM IITIVOLI DBGW IIARS
IBRSD
BPM ARS ARS_SD CMDB BiiZ BIM SLM TM_ART TM_RCA TM_REM
EM_Server_Standby SIM_Server_Standby
Chapter 5
141
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.
To display the service model 1 In BMC Impact Explorer, click the Administration tab. 2 In the icon bar at the top of the navigation area on the left, click the Infrastructure
Management icon (the wrench or spanner icon).
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 Infrastructure Management navigation pane
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 leaf component under SIM Cells to select it. 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. Click Edit Component in the Details=>General tab and change a property of the component.
144
To edit and save configuration files 1 Click the leaf component under a service or an application, such as SIM Cells, to
select it.
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
5 Edit the file. 6 When youre done, you can click either of the following:
I I
File=>Save a Copy to save a copy of the file to your local system File=>Update Original to update the file on the remote system
To edit and save log files 1 Click the leaf component under a service or an application, such as SIM Cells, to
select it.
3 To modify a file, select it from the list, and click View. 4 In the dialog box, enter the credentials of the remote system, and click OK.
The log file is displayed in the editor.
5 Edit the file. 6 When youre done, click File=>Save a Copy to save a copy of the file to your local
system. You cannot update a log file on a remote system. You can save it only to the local system.
146
To package support files 1 Click on the leaf component under SIM Cells, for example, to select it. 2 From the Notebook tabs, choose Administer=>Support Package.
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.
4 Optional. Enter a tracking number in the Issue Number field. 5 Optional. Enter a description of the issue in the Description field. 6 Click Create Package. 7 Enter the credentials of the remote system from which you are retrieving the files.
Chapter 5
147
A pop-up progress indicator shows the status of the retrieval. If it completes successfully, go to the specified directory and review the contents of the zipped package. The file contents vary based on the type of component. Here are typical files for a SIM server component.
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:
I I I I I I I
Start Cell Server Process (Start) Stop Cell Server Process (Stop) Restart Cell Server Process (Restart) Pause Events Admittance (Pause) Resume Events Admittance (Resume) Set to Active Set to Standby
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.
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
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
You can create customized subgroups under the Infrastructure Management heading. After selecting the heading, right-click to open the Add a sub group menu item.
After you define your group, you can drag and drop component objects into it.
152
Table 40
Slot
Editable Here
Master Repository
specifies the data source of the component object. For example, component objects that originate from a direct feed source, such as BMC IX, mposter, or an MRL, are designated in this format: CellcellName. The default name for Infrastructure Management is Cell_Admin. 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. indicates whether a component, such as a cell server or IAS, is standalone or, in an HA pair, either primary or secondary. identifies a selected cell component as Service Impact Management, Event Management, Impact Administration, or Integration. for a selected cell component, the IP address of the standalone cell server or of the primary cell server in an HA pair. for a selected cell component, the port number of the standalone cell server or of the primary cell server in an HA pair. for a selected cell component, the IP address of the secondary cell server in an HA pair. for a selected cell component, the port number of the secondary cell server in an HA pair.
Run State
Role Cell Type Cell Server 1 Cell Server 1 Port Cell Server 2 Cell Server 2 Port
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:
I I I I I I I
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
I I
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 Edit Relationships dialog with Edit This Relationship subdialog
The Edit Relationships dialog box contains the following fields: Table 41
Field Component Name Related Component Type Relationships
156
Table 41
Field
Component Direction
You can search on component types by selecting an Impact Administration subtype from the drop-down list. When you click Search, it retrieves the relationships associated with the selected subtype. Select an item in the Edit Relationships dialog, and right-click to open the pop-up menu. You can perform actions common to all object relationships: View Service Impact Graph, View Events, Edit Component, Add Navigation Link, and Add Relationship. You can edit any of the components relationships by selecting it and then choosing the Edit Relationship button at the bottom of the dialog. The Edit This Relationship subdialog contains the following fields: Table 42
Field Consumer/Provider indicator Type of Relationship Relationship Status Status Weight Description
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:
I I I I
SIM and BEM management servers SIM and BEM standalone cells SIM and BEM high availability cells integrations I BMC Impact Integration for HP Openview Network Node Manager I BMC Impact Integration for HP Openview Operations I BMC Impact Integration for BMC Remedy Action Request System I Integration for BMC Remedy Service Desk I BMC Impact Integration fro PATROL 3.x I BMC Impact Integration for PATROL 7.x
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:
I I
plain text file comma-separated values (CSV) for tabular data presentation
1 In the Administration view, choose File=>Usage Report. 2 You can choose to save the list in .csv or .txt format or to print the display screen.
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.
When the Impact Administration cell (IAC) is in an HA configuration, do not launch a remote action against any components in the Infrastructure Management view when the IAC primary server is down and its secondary server is in a passive state. In this case, the IAC rejects the actions.
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 High availability (HA) view: two cell servers
Chapter 5
161
162
All: Fetch all the nodes in the Node Group Bank, Node Hierarchy Bank, and Node Bank from the OVO.
To reload all of the cell configuration 1 Right-click a cell. 2 Select Reload => All.
All configuration files and the KB are reloaded.
To reload the directory 1 Right-click a cell. 2 Select Reload => Directory (mcell.dir).
The mcell.dir file is reloaded.
Chapter 5
163
To reload cell configuration 1 Right-click a cell. 2 Select Reload => Cell Configuration.
The configuration files mcell.conf, mcell.propagate, and mcell.modify are reloaded.
To reload trace configuration 1 Right-click a cell. 2 Select Reload => Trace Configuration.
The mcell.trace file is reloaded.
To force propagation to all target cells 1 Right-click a cell. 2 Select Propagate Events => All Destinations to force propagation of the buffer
contents to all target cells.
To force propagation to a selected target cell 1 Right-click a cell. 2 Select Propagate Events => Select Destinations. 3 In the Propagate dialog box, specify the target cell to which you want to propagate
the buffer contents.
4 Click OK.
164
Collecting metrics
Collecting metrics
Use the Metrics Collection menu command to access the commands for working with metrics.
To turn metrics collection off 1 Right-click a cell. 2 Select Metrics Collection=> Disable. To reset collection counters 1 Right-click a cell. 2 Select Metrics Collection => Clear Values.
The collection counts are reset to 0.
viewing the graph of a selected component and its relationships viewing events associated with the selected component setting manual status and maintenance mode adding links to components from container folders refreshing the graph view after making an edit to a component or relationship
Chapter 5
165
Table 43
A typical SEVERE message documents the error exceptions that occur during the execution of a remote action, such as Unable to save file on remote machine IAS_USER OS_USER SUB_TYPE current BMC IX user name that has logged on and connected with the Impact Administration server 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 the component or application type on the BMC IX administrator is performing the remote action. In version 7.2, Infrastructure Management supports the subtypes listed under Supported component or application types on page 166 user-specified value in the Object slot of the component or application on the which remote action is being executed unique Id associated with the remote action. This unique Id is defined in the corresponding actions.xml file stored on the computer where the BMC Impact Administration Server resides. For example, the ImpactManager.xml file is an actions file that applies to BEM and SIM cells. It is stored under the IMPACT_SOLUTIONS_HOME/server/data/admin/actions folder on the IAS computer short text description of the logged action
OBJECT ACTION_ID
EXPLANATION
I I I I I
I I I I I
166
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
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
I
default support files These are internal files of the infrastructure application. They are not included in the other categories. They vary among the applications, but they include .baroc, .mrl, .wic, and .cmd files. Generally, for a cell server, this package contains the files of its KB directory and its log directory. You can choose which files to include. They also include a sysinfo.text file that captures active port connections, OS and hardware configurations, and network card details. The absolute file path to each file is included.
additional support files This is a customizable list of files that the user can edit by adding or deleting files to or from the support package. It is designed to enable the user to add other files to the support package.
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 Additional Support Files Configuration files Dir files Filter files Map files Selector files Trace conf files Trace files
To compile your support package, choose the Administer=>Support Package tab. Browse to the destination folder where you want to save the list of configuration and log files, and select it. You can enter the issue number (maximum of 16 characters) if one has been assigned.
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 Working with Infrastructure Management 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
To manually register a cell with the Admin cell 1 Add the cell using the mcrtcell CLI, as in the following example:
mcrtcell -p 2008 -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=*
The cell is added automatically to the IMPACT_SOLUTIONS_HOME/server/conf cell_info.list of the Impact Administration Server. It is also automatically added to the IMPACT_SOLUTIONS_HOME/server/data/admin admin.dir file of the Admin cell, as in the following example:
cell cell cell 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
The current run_state of the component determines which context-sensitive actions are disabled or enabled from the Actions option on the right-click menu. Table 47 on page 175 indicates which menu options are enabled (Yes) or disabled (blank) for each run_state of a normal cell or a primary cell in an HA configuration.
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 Yes Yes Yes Yes Yes Yes Yes Yes None Yes Yes Yes Yes Stop Cell Server Process Restart Cell Server Pause Events Resume Events Process Admittance Admittance
Set to Standby
Set to Active
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 Start Cell Server Process Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Stop Cell Server Process Restart Cell Server Pause Events Resume Events Process Admittance Admittance
Set to Standby
Set to Active
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:
I I I
Start Cell Server Process Stop Cell Server Process Restart Cell Server Process
For other objects apart from cell servers, the Start, Stop, and Restart menu options in the Actions submenu are described as:
I I I
For OVO adapter cells, the menu options in the Actions submenu are described as:
I I I
Different actions are available for different types of components. Table 49 lists the main exceptions: Table 49
Component HA cell
Impact Administration server receives the Restart action only (IAS) Publishing Server IBRSD normal cell receives the Start, Stop, and Restart actions receives the Stop, Start, and Restart options receives the Stop, Start, Restart, Pause Events Admittance, and Resume Events Admittance options
Logical components that you add to the Infrastructure Management service model receive no actions.
176
Chapter
6
178 179 179 183 184 185 186
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
177
Figure 22 illustrates a file Operator.econ.config created for a user named Operator. Figure 22 Operator.econ.config file contents
#Wed Feb 05 11:52:22 CST 2003 user.region=US toolbar_orientation=0 config_dialog_position_y=191 config_dialog_height=520 toolbar_layout=North config_dialog_position_x=288 config_dialog_width=394 framework_bounds=229,259,512,384
178
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
Parameter
default.console_policy.prop parameters
Description controls the tracking of local actions performed against events specifies the default filter used to display the event list when no view is selected specifies the default slot order used for the event list when no view is selected controls the slots shown as icons in the event list (values of hidden slots can be viewed only as icons) 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 administration_editor_acls
controls the classes (with their subclasses) that are available to the Dynamic Data Editor specifies the ACLs that control access to the Dynamic Data Editor controls exclusion of slots when exporting controls the time interval between saves of configuration information (such as window sizes and locations) controls the time interval between saves of Services View navigation tree information
no_import_slots
config.save.freq ix.servicetree.save.timer
parameters used to manage data-handling actions such as copying, pasting, exporting, and printing Boolean switch for the AssignTo users filter Boolean switch that indicates whether the import is done using the previous method or the new method, where false = previous method (deprecated)a controls creation of notes for events that have local actions performed against them; replaced with local_action_event_operations (deprecated)a controls creation of notes for events that have remote actions performed against them (deprecated)a controls creation of notes for events that change status by means of user-initiated action
remote_action_event_notes status_mod_event_note
a
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
framework_debug help_url java_plaf macro_connect_timeout remote_server_port remote_server_enabled all_connection_allowed
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.
specifies the background color for the navigation tab on the Events tab of the console sets the maximum number of status bar history messages that are stored in the console specifies the default name assigned to newly created subgroups on the Services tab on the console length of time, in milliseconds, the console waits to display tooltips in the Services View
183
Table 51
Console property
svc_view_link_thickness_normal svc_view_link_thickness_true_impact
Severity level
184
WARNING
I I
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_1 Priority_2 Priority_3 Priority_4 Priority_5
Priority level
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.
185
Table 54
Folder
\Map\Map_xxx
186
Chapter
7
188 188 189 190 191 192 192 194 195
Chapter 7
187
event class names slot names enumeration class names and values collector names action names service model class names (component types) and slot names service model management class and slot names service model enumeration class names and values policy type names event class names slot names - In the Event Selection Criteria column, the internal slot names are shown because this is the actual text of the ECF. event class names slot names enumeration class names and values service model class names (component types) and slot names service model management class and slot names service model enumeration class names and values service model class names (component types) and slot names service model management class and slot names service model enumeration class names and values
BMC Impact Explorer Services View BMC Impact Explorer Administration View
I I I I I I
I I I I I I
I I I
For BMC Impact Explorer, the default presentation names are defined in the following two files:
I
188
InstallDir\BMC Software\MasterCell\console\lib\lang\kbinfo\ kb_deprecated_resource.properties (contains names for slots that appear on the
For BMC Impact Service Model Editor, the kb_core_resource.properties file is located in the BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all /conf/resources/en_US/smsConsoleServer directory.
Extracting the presentation name resource files for BMC Impact Explorer (Java Web Start)
The presentation name resource file for BMC Impact Explorer (Java Web Start) is provided in a .jar file and is digitally signed by BMC Software, Inc. with its digital certificate. To edit the presentation name resource file for BMC Impact Explorer (Java Web Start), you must uncompress the BMC_Portal_Kit_Home/appserver/websdk/tools /jboss/server/all/modules/smsIX.sar /smsIX.war/kbresource.jar into a temporary directory using the following command:
jar xvf kbresource.jar
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
Presentation name resource file search order for BMC Impact Explorer
BMC Impact Explorer searches a list of local resource files for presentation name keys. You specify the order in which resource files are searched by defining the search order in the kb_info_resource parameter located in the InstallDir\BMC Software\MasterCell\console\etc\ix.properties file. Because BMC Impact Explorer searches a set of files in the order you specify, you can override the presentation names in the default file by creating a new .properties file, defining presentation names in this file and listing the new .properties file before the default file in the kb_info_resource parameter. (For instructions on creating a new .properties file, see Creating a new presentation name resource file on page 190.) For example, if you created a new .properties file called my_ix_names.properties and you wanted BMC Impact Explorer to search this file first, you would modify the kb_info_resource parameter to look like this:
# Specifies the set of files to load for kb specific resources (base names only, comma separated list) kb_info_resources=my_ix_names, kb_core_resource, kb_deprecated_resource
Presentation name resource file search order for BMC Impact Portal
The BMC Impact Portal searches for presentation name keys in the files located in the
BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/resources /en_US/smsConsoleServer and BMC_PORTAL_KIT_HOME/appserver/websdk/tools /jboss/server/all/conf/resources/en_US/smsIwc directories.
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
Presentation name resource file search order for BMC Impact Service Model Editor
The BMC Impact Service Model Editor looks for presentation name keys in the
BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/resources/ en_US/smsConsoleServer/kb_core_resource.properties file.
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 Class Slot
ENUM.InternalEnumerationName ENUMVAL.InternalEnumerationName.InternalValueName
192
To create or modify presentation name keys 1 In a text editor, open either the kb_core_resource.properties file or the new
.properties file that you have created. For instructions on creating a new .properties file, see Creating a new presentation name resource file on page 190.
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.
2 Create a self-signed test certificate by following these steps: A Enter the following command.
keytool -selfcert -alias <my_alias> -keystore <keystore_filename>
3 Verify that the key and certificate creation were successful by following these
steps:
194
The resulting listing should appear as follows: Figure 24 Listing of the contents of a keystore file
Keystore type: jks Keystore provider: SUN Your keystore contains 1 entry: myself, Tue Jan 23 19:29:32 PST 2001, keyEntry, Certificate fingerprint (MD5): C2:E9:BF:F9:D3:DF:4C:8F:3C:5F:22:9E:AF:0B:42:9D
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.
a presentation name in a column header a presentation name that labels a slot value (for example, in an Event Details tab) the label of a drop-down list or field that shows a presentation name, a slot presentation name in a list box (as in the Edit Slot Order window) a class presentation name in the Class Chooser window a class presentation name in either of the Administration tab navigation trees
Chapter 7
195
classes in the Services tab Of type list classes or enumeration values in lists such as event and data lists or event selection criteria lists
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
8
198 199 199 200 205 205 206 207 207
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
197
lock file indicating StateBuilder activity transaction file generated by the cell terminated transaction file, where n=1 is the oldest transaction file terminated transaction history file corresponding to mcdb.t Timestamp t in the xact.t file refers to the mcdb.t file to which the transactions lead.
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
Description sets path to the gateway.export file Default value
%H/etc/%N/gateway. export
indicates whether discarded events are included in the No export file Discarded events are those that were dropped in the first four rule phases: Refine, Filter, Regulate, and New (Update).
ExportTriggerArguments
sets the arguments to be passed to the executable serving as the export trigger program Value is interpreted as a sequence of space-separated arguments, so spaces within each argument are not allowed.
blank; no arguments
ExportTriggerProgram
sets the program to execute after exporting data The value is interpreted as a path. See the mcell.conf file for special syntax for a path.
blank
StateHistoryCount
sets the number of state files to retain in the history Each time a new saved state is produced, the oldest state is removed.
Return code
Chapter 8
199
Gateway configuration
Table 60
57 67 77 87 97
Return code
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:
I
A gateway configuration file contains parameter settings in the form of parameter=setting. Parameters can be specified differently for new events and for event modifications. The parameter name must be suffixed with
I I
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 $CLASS $CONTEXT
$DATE $TIME $MODNMS $GHANDLE $CNAME $CHANDLE $VALUE slot $NAME $VALUE $MODS $ALL $ALL cls $MAP.map val
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 gateway.export file parameters (part 1 of 2)
Parameter Communication protocol parameters Contents parameters cond 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. 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. 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. lists additional new slot definitions. List of comma separated settings in the format slotname=slotvalue. slotname represents the name for the new defined slot and slotvalue defines the value of the new slot. The default value is [], so no slot is added. 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 lists slots whose modifications result in a message. Modifications of slots that are not included in this list are ignored. The default value is [], which means that every slot modification is included. Defines the map table with the name name List of comma separated settings in the format original_value=converted_value original_value represents a value that has to be replaced and converted_value is the replacement value. Both values must be literal values.
drop
add
slots
map.name
202
Gateway configuration
Table 63
Format parameters
body
term
separator quotable
openquote closequote
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]
All other values of SEVERITY are passed unchanged. To actually replace the values of slot severity, the slot has to be dropped and a new slot, with the same name, has to be added, mapping the value:
EXAMPLE
drop=[severity] add=[severity=$MAP.GW1severity($VALUE(severity))]
The BAROC format produces output similar to the example shown in Figure 26. Figure 26 Example of printed events
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 Command to configure the export file
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.
# Export Gateway Configuration # cond=always slots.new=[$ALL] slots.mod=[$MODS] body=$VALUE term=\n separator=, quotable=," openquote=" closequote=" escapequote="
Using the default values in the gateway.export file for new events produces output in the format shown in Figure 29. Figure 29 gateway.explore file output for new events
206
Using the default values in the gateway.export file for modified events produces output in the format shown in Figure 30. Figure 30 gateway.explore file output for modified events
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
Check the MCELL_HOME/log/cell_name directory for the number of xact.n files, where n is 1, 2, 3. More than three xact.n files is an indication that the StateBuilder process is failing. If more than three xact.n files are present, follow these steps:
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. Determine whether or not the MCELL_HOME/bin/statbld program exists and can be executed by the current user who is running the mcell process. 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
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
Appendix A
209
210
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 -c ConfigFile -h or -? -i UserID[/Password] [@Host[/Port]] -l HomeLocation -n cellName or -n @Host[/Port[#Key]] -p Var=Value -q -v -z
[optional] specifies that user authentication is required to execute the CLI specifies home directory (HomeLocation) for the command if it is not specified with MCELL_HOME starts the cell named cellName (as defined in mcell.dir). For more information, see Using the -n option. assigns the specified value (Value) to the option Var invokes quiet execution (no banner appears) activates verbose mode to display more information displays version information
Appendix A
211
This format maps the cellName to the host, port, and encryption key in the mcell.dir file.
I
Designate the host, port, and encryption key by using -n @Host[/Port[#Key]], where Host is either a host name or an IP address Port is the port number Key is the encryption key
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.
authenticated through the OS has read permission on mcell.dir has execute permission on the CLI
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 0 1 10 11 12 13 14 15 16 17 20 25 26 27 28
mccomp syntax
Figure 31 shows the syntax for mccomp. Figure 31 mccomp syntax
mccomp [-e ErrorLogFile] [-h|?] [-n CellName | ManifestKBFilePath] {-p Var=Value} [-l HomeLocation] [-t] [-v [VERBOSE|INFORM|WARNING|ERROR|FATAL]] [-z]
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
Option
mccomp options
Description redirects error messages to a user-specified file; used primarily in scripts
-t - v [VERBOSE|INFORM|WARNING |ERROR|FATAL]
generates tracing calls in the resulting compiled files for debugging purposes 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 Example output for mccomp
Parsing BAROC file classes/root.baroc Parsing BAROC file classes/intevt.baroc Compilation ended successfully
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
Option -c
mcell options
Description 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. runs in foreground instead of as a service or daemon initializes the cell repository; can combine with suboptions:
I I I I I
-d -i
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 runs in cell recovery mode
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:
I
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. Starting a cell
Figure 35
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. Starting a cell as a service on windows
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.
I
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. Starting the BMC Impact Manager service on Microsoft Windows
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
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
Option Module Level Destination
mcfgtrace option
Description See mcfgtrace parameters on page 219.
mcfgtrace parameters
Table 71 lists the parameters for mcfgtrace. Table 71
Parameter Module Level SWITCH Destination
mcfgtrace parameters
Available values ALL | Module ALL | VERBOSE | INFORM | WARNING | ERROR | FATAL SwitchName no | stderr | console | DestinationFileName
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
Option -a Amount -d -e -o OutputFile -r -u -x Class
mclassinfo options
Description specifies the amount of information: 0, 1, 2, 3 (See Information amount on page 222); default is 2 reports data class definitions instead of event class reports enumeration definitions used in the classes produces the output in a file called OutputFile, instead of using standard output produces raw output for programs reports unique slots only, excluding redefined slots in subclasses reports enumeration definitions only (exclude classes) names of selected classes
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 BMC Impact Solutions Infrastructure Management Guide
EnumInfo EnumTypeInfo
The class tree is reported depth-first, left-to-right, as ClassInfo, as shown in Figure 42. Figure 42 Class tree for mclassinfo
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 i r p s e;EnumerationTypeName c:BaseClass q:BaseClass
A slot representation type (ClassSlotRepType) corresponds to the representation facet of the slot. If that facet is not specified, it is reported as an asterisk (*).
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
Facet r|R k|K p|P d|D h|H
Reported facets
Function read_only key parse dup_detect hidden
Table 75
Flag p|P
Class flags
Function publishable class
Information amount
The amount of reported information is limited as shown in Table 76. Table 76
Option -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
mcollinfo syntax
Figure 51 shows the syntax for mcollinfo. Figure 51 mcollinfo syntax
mcollinfo [-a Amount] [-c ConfigFile] [-i UserID[/Password][@Host[/Port]]] [-h|-?] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation] [-r] [-o OutputFile] [-v] [-q] [-z] (-d | [-g] [-s] (Collector | -f InputFile))
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 -a Amount -d -f {InputFile}
Appendix A
225
Table 78
Option -g
-o OutputFile -r -s Collector
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.
CollInfo = CollCompCount (CollCompInfo)*CollCompCount CollCompInfo = CollName CollPerm CollClassCount (CollClass)*CollClassCount CollInfo CollPerm : CollPermR CollPermW CollPermX CollPerm_ : CollRoleCnt (CollRole)*CollRoleCnt
226
Information amount
The amount of reported information is limited as shown in Table 79. Table 79
Option -a 0 -a 1 -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 mcollinfo command for verbose mode
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 mcollinfo command for number of events for severity/status
Appendix A
227
mcontrol syntax
Figure 56 on page 228 shows the syntax for mcontrol. Figure 56 mcontrol syntax
mcontrol [-h|-?] [-z] [-q] [-c ConfigFile] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation] [-v] Control [ -i UserID[/Password][@Host[/Port]] ]
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
Option Control
mcontrol option
Description specifies the control command to use. See Table 82 for the available control commands.
228
suspends reception of adapter messages; events are no longer accepted if one or more Destinations are mentioned, only propagations to these destinations are retried; if no Destinations are specified, all pending propagation destinations are retried reload cell configuration, for one or more categories; if you do not choose an argument, all categories reload
I I I I I I I
dirmcell.dir tracemcell.trace confmcell.conf, propagate, modify collectcollector definitions kbKnowledge Base, classes, rules datadata instances allall the categories
stops and restarts the cell terminates the cell in fast shutdown mode; same as mkill -s switches cell to standby mode resumes reception of adapter messages; cell operates normally again forces the cell to perform a StateBuild immediately instead of waiting for the next scheduled StateBuild; mcontrol waits until termination of the forced StateBuild and, if successful, returns the path to the resulting saved state file terminates the cell in normal mode; same as mkill turns rule tracing on or off
Appendix A
229
Table 82
Control
modifies the configuration of which rules are enabled for tracing. The Names value has the same format as the TraceRuleNames parameter. For example, mcontrol -n CellName tracerule names problem_rule
This command enables tracing of the rule named problem_rule (assuming that problem_rule is of a phase that has rule tracing enabled).
mcontrol examples
mcontrol can be used as shown in the following examples.
Figure 58 shows an example of the output. Figure 58 Example of mcontrol command output for retrying pending propagations
Terminating a cell
To terminate a cell named grace, type the command shown in Figure 59. Figure 59 Terminating a cell using the mcontrol command
230
Figure 60 shows an example of the output. Figure 60 Example of mcontrol command output for terminating a cell
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
Figure 62 shows an example of the output. Figure 62 Example of mcontrol command output for 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:
I I I
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:
I
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 adds an entry to the local mcell.dir file creates an entry in the startup scripts on UNIX platforms, unless you specify the -m option recreates an Admin cell using the -aa 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
Linux platforms
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
mcrtcell [-ae|-as|-aa] NewcellName [-f] [-h|-?] [-l HomeLocation] [-m] -p PortNumber [-s SourceCell] [-z]
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 -aa -ae
Appendix A
233
Table 84
Option -as -f
-m -p PortNumber
prevents automatic restart on reboot specifies the cell port number (PortNumber) Note: The -p option for mcrtcell overrides the common CLI -p option listed in Table 65 Common options for CLI commands on page 211.
-s SourceCell NewcellName
specifies the cell (SourceCell) from which to copy a Knowledge Base 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 Example of mcrtcell command
Figure 66 shows an example of how to create another service using mcrtcell. Figure 66 Example of mcrtcell command
NOTE
This command does not use the -ae or -as option. It makes a copy of the KB from the previous cell.
234
Figure 68 shows an example of how to create an Impact Administration cell using mcrtcell. Figure 68 Example mcrtcell for recreating an Admin cell
In this example, an Impact Administration cell with the name Admin is created and assigned to port number 10011.
Code Description uname command failed MCELL_HOME environment variable not set or duplicate cell name or port definition in mcell.dir no MCELL_HOME environment variable is defined duplicate cell definition in mcell.dir existing cell with same name on a different host existing cell with same name on a different port existing cell with same name on a different host/port failed to create new directory cannot get OS failed to remove a cell
Appendix A
235
mcstat Syntax
Figure 69 shows the syntax for mcstat. Figure 69 mcstat syntax
mcstat [-h|?] [-z] [-q] [-c ConfigFile] [-i UserID[/Password][@Host[/Port]]] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] [-v] [-t TimeOut ]
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
Option -t TimeOut
mcstat option
Description 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 Message for cell not 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:
I I I
removes the entry in the mcell.dir file deletes the etc\cellName removes the entry from the services on Microsoft Windows or the startup scripts on UNIX
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
Option -k -w TimeOut
mdelcell options
Description keeps tmp and log directories of the cell 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 Deleting a cell using mdelcell
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 Output for mdelcell if cell is not running
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 Output for mdelcell if cell is running
Warning! Cell grace was running and mdelcell tries to terminate it. Service successfully removed.
mgetinfo syntax
Figure 77 shows the syntax for mgetinfo. Figure 77 mgetinfo syntax
mgetinfo [-c ConfigFile] [-i UserID[/Password][@Host[/Port]]] [-h|?] [-l HomeLocation] [-n cellName | -n @Host[/Port[#Key]]] {-p Var=Value} [-q] [-v] [-z] Information
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
kbsources
metrics
Appendix A
239
Table 90
param
Information
services version
reports service metrics counting the components and relationships displays the version number of the cell
A connect request displays the information shown in Table 91. Table 91 Information from connect request
Description IN for incoming and OUT for outgoing This information refers to the initiator of the connection. An incoming connection means a client contacted the cell, while an outgoing connection means the cell itself contacted another cell. In both cases, data can flow in both directions. type of client name of connected program source address destination address Incoming Connections name of user time delta sequence sequence Outgoing Connections time stamp sequence message message timestamp of last connection setup or trial sequence number of last outgoing message number of messages waiting for connection opening number of messages waiting for answer the name of the user; example: Admin between both sender and receiver in seconds, to be added to time stamps coming in to convert to the cell time sequence number of last incoming message sequence number of last answer the client type, such as unknown, cell, browser, adapter, CLI, and EIF, which are reported as literal values the name of the connected program (for example: Impact Explorer, mposter, cellName) IP address/port of source side of the connection for inbound connections, this is the client; for outbound, it is the cell IP address/port of destination side of the connection for inbound connections, this is the cell; for outbound, it is the destination
240
mgetinfo examples
This section contains examples of mgetinfo.
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
I I I
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)
Appendix A
241
the description for ReceivedEvents is Number of received event messages 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 mgetinfo param command output
mgetinfo services
This command produces output similar to the example shown in Figure 81. Figure 81 mgetinfo services command output (part 1 of 2)
Number of MC SM Component Number of Connectivity 87 11
Figure 81
mgetinfo connect
This command produces output similar to the example shown in Figure 83. Figure 83 Output of mgetinfo connect
10.0.10.28:1828 Admin 0 2028 2071
Appendix A
243
mgetrec syntax
Figure 84 shows the syntax for mgetrec. Figure 84 mgetrec syntax
mgetrec [-c ConfigFile] [-i UserID[/Password][@Host[/Port]]] [-h|?] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] -r Record[.Slot] [-q] [-z]
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
Option -r Record[.Slot]
mgetrec option
Description specifies the global record to be obtained, optionally limited to one of its slots
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 Output of mgetrec (part 1 of 2)
244
Figure 86
mkb syntax
Figure 87 shows the syntax for mkb. Figure 87
mkb [-f [-j [-r
mkb syntax
[-h|-?] [-z] [-q] [-v] [-n CellName | -n @Host[/Port[#Key]] ] ManifestFile] [-b BinFile] [-c ClassFile] [-d DataFile] [-a Arch] RecordFile] [-l LibFile] [-m Directory] [-o CollectorFile] [-p] RuleFile] [ -i UserID[/Password][@Host[/Port]] ]
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 -a Arch -b BinFile -c ClassFile
Appendix A
245
Table 94
Option
-m Directory -o CollectorFile -p
creates a new Knowledge Base directory hierarchy based on the contents of the designated manifest.kb file imports the specified CollectorFile.mrl that defines that collector definitions
prints the contents of the designated manifest.kb file, along with the names of the .load files in the various directories comprising the Knowledge Base
Note: The -p option for mkb overrides the common CLI -p option listed in Table 65 Common options for CLI commands on page 211.
-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
-a Arch
mkb Option
h1 - HP-UX l2 - Linux p4 - AIX (Power PC) s5 - Solaris (Sparc) w4 - Microsoft Windows (Intel)
-b BinFile -c ClassFile
adds the binary file (BinFile) for the architecture adds the class file (ClassFile) to the designated Knowledge Base
-o CollectorFile adds the collector file (CollectorFile) to the designated Knowledge Base -d DataFile -l LibFile adds the data file (DataFile) to the designated Knowledge Base adds the library file (LibFile) to the designated Knowledge Base Note: The -l option for the mkb command overrides the -l option in Table 65 Common options for CLI commands on page 211. -r RuleFile adds the rule file (RuleFile) to the designated Knowledge Base
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 command on UNIX
mkb -f ./manifest.kb -p
This command produces output similar to the example shown in Figure 89 on a UNIX computer named spud. Figure 89 mkb output on UNIX
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 BMC SIM and EM CLI Reference 247
mkillStopping a cell
This command produces output similar to the example shown in Figure 91 on Microsoft Windows. Figure 91 mkb command output on Microsoft Windows
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
mkill [-h|?] [-z] [-q] [-c ConfigFile] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation][-v] [-s] [-i UserID[/Password][@Host[/Port]]]
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
Option -s
mkill option
Description performs rapid shutdown termination; bypasses StateBuilder
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 mcdb.lock file exists and, if so checks for a running statbld and waits for termination reports trailing lock file and removes it (after confirmation)
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 [-h|?] [-z] [-q] [-c ConfigFile] {-p Var=Value} [-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation] [-v] [-i UserID[/Password][@Host[/Port]]]
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.
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 [-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]]
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 -a Class -b SlotSetValue
- d -e -f DirFile -i -I -j BufDira
(Used with mposter only.) sends as data instead of as event specifies to use EIF instead of MCELL format specifies the directory file path; the default value is MCELL_HOME\etc\mcell.dir sets to interactive mode reinitializes persistent buffers sets the directory to be used for persisting events that are buffered until they are sent
252
Table 98
Option
-l EventID
sets event message to the specified Message text sets event source to the specified Source this common CLI option can be used to specify the directory path to the source file using the following syntax: -p ServerDirectoryName=ServerDirectoryPath The default value is $MCELL_HOME\etc\mcell.dir
-r Severity
sets the event severity value to the Severity specified For example, -r WARNING or -r CRITICAL
-t MSecTerminationWait -u -w MSecAnswerWait
sets the length of time in milliseconds to wait for trailing answers before terminating; default is 5000 leave messages unanswered sets the length of time in milliseconds to wait for message answer; default is 0. If set to 0, the mposter/msend command waits for the answer until the connection times out. examines timings immediately terminate upon connection failure
-x -y
a
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:
I I I
specifying that the instance to add is an instance of AppByHost defining the host as aspen specifying that it defines applications as word or excel
You can use the mposter command to change any one of definitions without changing any of the others.
254 BMC Impact Solutions Infrastructure Management Guide
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.
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
The purpose of the mposterbuf.lck file is to provide a file-locking mechanism when multiple mposter-like servers are started at the same time. To change the maximum size of persist.dat edit the $MCELL_HOME/etc/mclient.conf file and add or edit the line MessageBufferSize=. The default size is 2,000 events.
msend.exe (Windows) or msend (UNIX) located in the MCELL_HOME\server\bin directory [Windows only] the redistributable MSVC runtime DLLs, MSVCR71.dll and MSVCP71.dll, which are located in the MCELL_HOME\server\libnative directory
256
Table 99
Code 2 3 4
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 -a Class -d -f Format -g Collector -o OrderSlot Description performs queries as read from standard input stream select from a specified Class (default is either CORE_EVENT or CORE_DATA). select data objects instead of event objects format using: quoted, BAROC, CSV, or XML selects only in a collector (optional + suffix for closure) sorts on the specified slot order (OrderSlot). Set the sort order by appending a suffix to the OrderSlot value that you specify. Append a plus sign (+) for ascending sort or a minus sign (-) for a descending sort. -Q Query -r perform the specified query sets output to be raw output. For more information, see Raw output format on page 226.
Appendix A
257
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
I I
N is the number of the solution (starting from 1) M is the total number of solutions.
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 -d -a Class Description retrieves data instances instead of events selects instances of class Class or its subclasses If omitted, a default value of CORE_EVENT or CORE_DATA is assumed (depending on whether the -d option is specified) -w Where imposes one or more conditions on the instance slot values The Where value is a general MRL expression as used in a Where clause. Several subexpressions can be combined with a comma (,) or AND. Quotes may be needed to escape from shell interpretation. -s SlotList selects the slots listed in SlotList, a comma-separated sequence of slot names Special values are
I I I
ALLgets all slots COUNTgets no slots, only a count of matching objects is returned DELETEall matching objects are deleted, returning a count of these
The default is ALL. -x SlotList excludes the slots listed in SlotList, a comma-separated sequence of slot names All slots are reported except for these. -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.
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 -g "'By Host'.host1+,'By Host'.host2+" -s "mc_ueid,CLASS,severity,hostname,msg" -o "status,severity-"
NOTE
The current implementation of the mquery command has the following limitations:
I
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
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 TargetCell Description 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
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 -o OutputFile -s InputStateFile TargetCell Description sends output to the specified OutputFile file; the default is to send output to standard output specifies to use input from InputStateFile; the default is the cells mcdb specifies the name of the cell to which events have been propagated; separate multiple cell names with a space
mrextract example
Figure 116 shows an example of mrextract. Figure 116 Example of mrextract
mrextract -n CellTwo -o \tmp\mcdb.CellOne
264
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 -o OutputFile Description specifies the file (OutputFile) to which to send command output; the default output target is terminal; the path name of the recovery cells database file (mcdb) to be created by this command specifies the input file for the mrextract command
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
266
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 -u EventId -C -O -A -G -B Description specifies the event handle of the event to be modified sets the status value of the specified event to CLOSED sets the status value of the specified event to OPEN sets the status value of the specified event to ACK sets the status value of the specified event to ASSIGNED sets the status value of the specified event to BLACKOUT
-S "Slot=Value[{;Slot=Value}]" specified the slot to be modified and the changes to be made to the slots value
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
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
Option -b -r Record -S Slot -V Value
msetrec options
Description specifies slot value assignment specifies the global record containing the Slot to be modified specifies the Slot to be modified specifies the Value to set for the specified Slot
268
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]
Appendix A
269
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. specifies the name of the cell; an alternative for the Host -n cellName option the host name or IP address of the cell specifies the name of the cell directory file Host mcell.dir
specifies the TCP/IP port number where the cell 1828 listens for all in-bound requests from sources, such as the BMC Impact Explorer, CLIs, and adapters enables or disables encryption to and from the cell Yes used by encryption process as part of the encoding no default key the maximum time, in seconds, that a CLI command attempts to establish a connection to a cell If the connection with the cell cannot be completely established within this timeframe, the command aborts. Note: If the cell is busy with a database cleanup, it may be impossible to connect the CLI with the default values. A database cleanup has a duration limit defined by the EventDBCleanupDurationLimit option, with a default value of 30 seconds. With a default ConnectionSetupTimeOut of 10 seconds, the connection cannot be established within the first 20 seconds of a cleanup. 10 (seconds)
270
Table 113
Option
ConnectionPortRange
ConnectionPortReuse
indicates whether or not the ports specified in ConnectionPortRange should be reused as much as possible By default the cell tries to reuse ports from the specified range, in the given order. When ConnectionPortReuse=No, for every new connection within the same session, the next free port from the specified range is used. Only when it reaches the end of the range will it restart at the beginning of the range.
Yes
MessageBufferSize
the number of messages, or events, retained in the buffer when the cell is unable to send, or when waiting for an answer; a message that is not sent because the destination is down, for example, or a message that was sent but not yet answered, remains in the buffer the time interval, in seconds, in which the cell attempts reconnection to a destination if the original connection failed The amount of time, in seconds, that messages are retained in the buffer until they can be sent. Once the specified time elapses, the retained messages are removed from the buffer. Appendix A
2000
MessageBufferCleanupPercentage MessageBufferReconnectInterval
10 600
MessageBufferKeepWait
3600
271
Table 113
Option
MessageBufferKeepSent MessageBufferResendCount
272
Appendix
B
274 274 276 278 280 281 283 284 287 287 288 291 292 292 293
Appendix B
273
ActionResultKeepPeriod
the period, in seconds, that an action result is kept on behalf of a (Browser) client The client should retrieve the result within that period. After the period has expired, the result is dropped. This is independent of the action result event. A generated action result event is not influenced by this parameter. It exists as long as other events.
CellOperationRelax
indicates whether the operation level should be lowered in case there is no license available for the desired level, as set by CellOperationLevel Typically, more license tokens are available for lower operation levels.
Boolean
No
274
Table 115
Parameter
ConnectionPortRangea
ConnectionPortReusea indicates whether or not the ports specified in ConnectionPortRange should be reused as much as possible By default, the cell or command line interface (CLI) tries to reuse ports from the specified range, in the given order. When ConnectionPortReuse=No, for every new connection within the same session, the next free port from the specified range is used. Only when it reaches the end of the range will it restart at the beginning of the range. ProcessingLimit Percentage specifies limitation of event processing speed At 100% the cell accepts events as fast as it can. At x% it does not accept events during (100-x)% of the time. This limits the cells CPU utilization. ServerAllInterfaces determines whether the cell listens on one specific interface or on all available interfaces When ServerAllInterfaces=Yes, the cell communicates on all network interfaces on the host. When ServerAllInterfaces=No, the cell only communicates with the network interface that has the IP address specified in the mcell.dir file of that cell. ServerDirectoryNamea specifies the name of the cell directory file ServerPorta
Boolean
Yes
number
100
Boolean
Yes
path
mcell.dir 1828
specifies the TCP/IP port number at which the cell number listens for all in-bound requests from sources, such as the BMC Impact Explorer console, CLIs, and adapters
Appendix B
275
Table 115
Parameter
ServiceModelEnabled
SystemLogDirName SystemTmpDirName
a
specifies the path to the default system-defined log directory specifies the path to the default system-defined tmp directory
path path
%H/log %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.
CellDuplicateAutoSwitchBack
determines whether the secondary server automatically switches back to the primary server when the primary server restarts after failover. For automatic switchback to occur, this parameter must be set to YES on both the primary and secondary servers.
Boolean
Yes
276
Table 116
Parameter
CellDuplicateFailOverStart TimeOut
CellDuplicateFailOverTimeOut
specifies the length of time (in seconds) that the secondary server waits to become active after the secondary server loses connection to the primary server.
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 specifies the operation mode of the server. 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. number
Yes
CellDuplicateMode
Appendix B
277
ClientPollTimeOut
the maximum time, in milliseconds, the cell waits for a client request before it continues processing the time interval, in milliseconds, that the cell has to send a packet to a client on the lowest communication level the format used to display timestamps in the date slot A default value of CIM indicates use of the Common Information Model (CIM) format from the Desktop Management Force Group. DateFormat parameters use the syntax of %[letter]. Table 118 on page 279 lists the DateFormat parameters for Solaris; for other operating systems, see their documentation.
number
200 milliseconds
ClientSendTimeOut
number
1000 milliseconds
DateFormat
string
CIM
SynchronizeTimeOut
the maximum time, in milliseconds, the cell waits for synchronization before dropping a connection
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 %% %a %A %b %B %c %C %d %D %e %h %H %I %j %k %l %m %M %n %p %r %R %S %t %T %u %U %V
%w %W %x
weekday as a decimal number [0,6], where 0 represents Sunday week number of year as a decimal number [00,53], where Monday is the first day of week 1 locales appropriate date representation
Appendix B
279
Encryption parameters
Table 118
Parameter %X %y %Y %Z
Encryption parameters
Table 119 lists the encryption parameters. Table 119
Parameter AllowAdapterFrom
Encryption parameters
Description Type Default value 0./0 specifies the adapters within the range of IP addresses string These are adapters that use the BMC Impact Solutions communications protocol.
AllowBrowserFrom
specifies the BMC Impact Explorer and the BMC Impact Portal connections within the range of IP addresses specifies the cells within the range of IP addresses specifies the command line interfaces (for example, mkill or mcstat) within the range of IP addresses
string
0./0
string string
specifies the client within the range of IP addresses that string is allowed to connect to a cell specifies the EIF event sources (for example, a postemsg) within the range of IP addresses specifies to use encryption specifies the encryption key specifies if encryption is to be forced string
280
EventDBCleanupPercentage
the percentage of free space required at number termination of an EventDB cleanup With a default EventDBSize of 100000, this means that at least 10000 places must be available at termination of a completed cleanup.
EventDBCleanupOnDateReception indicates the preference for deleting events from the repository based on when they were received instead of when they were last modified
Boolean
No
Appendix B
281
282
Appendix B
283
Heartbeat parameters
The mc_date_modification slot is considered to determine the time of an event. However, if parameter EventDBCleanupOnDateReception=Yes, the date_reception slot is considered instead. Cleanup is interrupted if it takes longer than the value of the
EventDBCleanupDurationLimit parameter. By default, this value is 30 seconds. If
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 HeartbeatEnabled HeartbeatInterval Description indicates whether the heartbeat monitoring mechanism is enabled or not the default interval between two beats, if not specified in the data object Type Boolean number number Default value Yes 60 3
HeartbeatMissedCritical the default number of consecutive missed beats that are needed to generate a critical event, if not specified in the data object HeartbeatMissedMinor the default number of consecutive missed beats that are needed to generate a minor event, if not specified in the data object
number
HeartbeatMissedWarning
the default number of consecutive missed beats number that are needed to generate a warning event, if not specified in the data object
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:
I I I
1 missed heartbeat generate a warning event 2 missed heartbeats generate a minor event 3 missed heartbeats generate a critical event
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 1 cell 2
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 cell enable last_time interval Description target monitored cell name 0 = disabled, 1 = enabled time last heartbeat was received length of interval between heartbeats Specify zero (0) to use the default, as determined by the HeartbeatInterval configuration parameter. missed_warning number of missed heartbeats before a WARNING event is generated Specify zero (0) to use the default, as determined by the corresponding HeartbeatMissedWarning configuration parameter. Specify -1 to disable generation of the corresponding event. missed_minor number of missed heartbeats before a MINOR event is generated Specify zero (0) to use the default, as determined by the corresponding HeartbeatMissedMinor configuration parameter. Specify -1 to disable generation of the corresponding event. missed_critical number of missed heartbeats before a CRITICAL event is generated Specify zero (0) to use the default, as determined by the corresponding HeartbeatMissedCritical configuration parameter. Specify -1 to disable generation of the corresponding event. missed number of consecutive missed heartbeats
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
CellErrorEvents
CellMetricsEnabled determines whether metrics for cell performance are collected or not CellTickInterval the time interval, in seconds, between generation of cell heartbeat events (ticks) The purpose of such heartbeats is to send a sign of life from the cell. A zero (0) value disables cell ticks without disabling other internal events. This parameter operates only if the CellEventEnable is set to Yes. RuleLoopDetect
a flag that requires the cell to check for certain conditions Boolean that can induce infinite looping of events Setting this parameter to Yes can cause mild cell performance degradation.
No
KB parameters
Table 124 KB parameters
Parameter KBDirName Description the path to the active KB directory Type path Default value the KB directory in the cells cell-specific configuration directory kbrecovery
KBRecoveryDirName
the path to an alternate KB directory to be used path for recovery from catastrophic damage For more information, see mrecover Recovering from a catastrophic data loss on page 262.
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)
Parameter DestinationBufferBaseSize Description the initial number of messages, or events, retained in the buffer Type Default value
number 5000
DestinationBufferExpandPercentage percentage of the actual buffer size that number 10 the buffer expands when events continue to be propagated after the buffer is full
288
Propagation parameters
number 0
the number of requests for propagation number 20000 to retain in the propagation buffer Such a request corresponds to firing a Propagate rule. There is one propagate buffer per cell with as many places for requests as set by the parameter.
PropagateBufferExpandPercentage
percentage of the actual buffer size that number 10 the buffer expands when events continue to be propagated after the buffer is full
Appendix B
289
Type
Default value
number 0
minimum percentage of free buffer size number 50 required to perform a reduction the name of the propagation configuration file 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.
Description the initial number of messages, or events, retained in the buffer the time, in seconds, to keep sent messages buffered while waiting for an answer
Type
Default value
The amount of time, in seconds, that messages number 3600, or 1 hour are retained in the buffer until they can be sent. Once the specified time elapses, the retained messages are removed from the buffer.
290
Description the time interval, in seconds, in which the cell attempts reconnection to a destination if the original connection failed The cell continues to reestablish a connection as long as there are messages in the buffer.
Type
Default value
number 600
MessageBufferResendCount MessageBufferSize
number 1
the number of messages, or events, retained in number 20000 the buffer when the cell is unable to send, or when waiting for an answer; a message that is not sent because the destination is down, for example, or a message that was sent but not yet answered, remains in the buffer A cell maintains one buffer for each destination. Such buffers have the same size, as set by the parameter.
PropagateBufferSize
the number of requests for propagation to retain in the propagation buffer Such a request corresponds to firing a Propagate rule. There is one propagate buffer per cell with as many places for requests as set by the parameter.
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.
ReportModifyClients
Appendix B
291
ServiceModelDirectFeed
Boolean when ServiceModelPublish is enabled, ServiceModelDirectFeed controls whether or not Service Model Data is accepted through direct feed
YES
the maximum size, in kilobytes, of a transaction number file before it is transformed into a new saved state when the StateBuilder runs again. If BMC Impact Manager seems to be consuming too much CPU, verify that State Builder is not running too frequently. Compare the time stamps of the mcdb.* files in the log directory of the cell. If the time between two state builds is less than 10 minutes, increase the StateBuildSize parameter.
path
indication to run the StateBuilder when the cell Boolean terminates the timeout, in seconds, to consider when waiting for the StateBuilder to terminate number
292
Trace parameters
Trace parameters
Table 130 Cell tracing parameters (part 1 of 3)
Parameter Tracea TraceSrc TraceConfigFileName Description allows the generation of trace messages location of the file containing the configuration of the trace messages Type Boolean path Default value Yes No mcell.trace %T/trace
includes the file and line number in the trace messages Boolean
path TraceDefaultFileName destination file to redirect trace messages from stderr to, in case the cell runs as a daemon or service Note: If you direct trace files to the temporary directory of the cell (for example, TraceDefaultFileName=%T/trace - %T=cell_tmp), the trace file will be removed each time the cell starts because the cell always cleans up its tmp directory at startup. To keep trace files across cell sessions, do not use the tmp directory as the default destination file location. TraceRuleLevel sets the level of rule execution tracing:
I I I
number
0no rule tracing and no cell error catch (not recommended) 1no rule tracing; cell errors are caught in the standard cell trace (default) 2rule tracing enabled ALL
TraceRulePhases
When rule tracing is enabled, lists the rule phases to be string traced. The value ALL can be used to specify that all phases are to be traced. Each phase can be prefixed with a + or a - sign to indicate addition or removal from the list. The list is interpreted in sequential order. For example, the following parameter setting: TraceRulePhases=ALL,-refine,-regulate indicates that all rule phases will be traced except for the refine and regulate phases. NOTE: TraceRulePhases and TraceRuleName work together to determine which rules are traced. A rule is only traced if both the phase to which it belongs and the rule itself are configured for tracing.
Appendix B
293
Trace parameters
%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
indicates whether to include rule tracing in the Boolean transaction file, as well as in the standard cell trace, in module RULES
No
294
Trace parameters
number
indicates whether to append to existing trace files or empty existing trace files at startup
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 BIX tool tips enabling and disabling for presentation names 195 BMC Impact Administration server command line interface 78 configuration files 78, 119 customizing BMC IX colors 99 default mapping of roles and permissions 83 defining client logging 98 defining group roles 88 defining high availability for Impact Administration cell 105 defining permissions 83 defining primary and secondary servers 101 defining standalone servers 101 editing logging properties 98 high availability 101 iadmin command 78 iadmin command format 80 iadmin command options 79 iadmin reinit options 104 LDAP configuration 109 manual editing guidelines 82 Master server 102 relation to BMC Impact Portal 93 Standard server 102 supporting remote actions for infrastructure management 107 synchronization properties 103 synchronizing with BMC Atrium CMDB 95 synchronizing with BMC Impact Portal 93 transaction and trace logs 106 updating cell information 96 updating user information (file-based authentication) 91 BMC Impact Explorer configuration files, event group 185 defining presentation name search order using ix.properties file 191 remote cell administration 58 BMC Impact Manager CLI common options 211 configuration of 269 BMC Impact Portal communication and encryption parameters 135 configuration parameters 124 configuring the ixs.properties file 124
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 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
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
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
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
300
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 infrastructure management (continued) permissions 142 registered components 140, 166, 172 related components 154 remote actions 148, 149, 160, 174 remote systems 145 roles 142 run states 174 specifying support files 169 support files 146, 169, 171 usage reporting 159 interface classes directory 69 ix.properties file defining presentation name search order for BIX 191 entry format 190 property descriptions 183 ixs.properties file parameters 136 using to customize BMC Impact Portal 124
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
J
jar files digitally signing 194 Java Web Start application extracting presentation name resource files 189
H
HeartbeatEnabled parameter 284 HeartbeatInterval parameter 284 HeartbeatMissedCritical parameter 284 HeartbeatMissedMinor parameter 284 HeartbeatMissedWarning parameter 284 heartbeats, cell 287
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
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
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 mcfgtrace command (continued) parameters 219 syntax 218 mclassinfo command 220 adding slot flags and default values 224 adding slot names and representation types 224 examples 222 obtaining a list of classes 223 obtaining a list of slot names 223 options 220 output 220 return codes 225 syntax 220 mcollinfo command 225 example 227 options 225 output 226 return codes 228 syntax 225 mcontrol command 72, 228 commands mcontrol 229 examples 230 options 228 reconfiguring a cell 231 retrying pending propagations 230 syntax 228 terminating a cell 230 mcrtcell command 71, 231 actions 232 creating a service 234 creating another service 234 examples 234 options 233 return codes 235 syntax 233 mcstat command 235 example 236 options 236 return codes 236 mdelcell command 237 deleting a cell 237 example 237 options 237 return codes 238 syntax 237 menu, Reload 163 merging event objects 265 message buffer parameters MessageBufferKeepSent 289, 290 MessageBufferKeepWait 289, 290 MessageBufferReconnectIntervalparameters MessageBufferReconnectInterval 289, 291 MessageBufferResendCount 289, 291 MessageBufferSize 288, 290, 291 MessageBufferKeepSent 289, 290 MessageBufferKeepWait 289, 290
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 mrextract command (continued) return codes 265 syntax 264 mrmerge command 265 command options 265 example 266 options 266 return codes 266 syntax 265 msend command 251, 267 msetmsg command 267 closing an event 267 examples 267 options 267 return codes 268 syntax 267 msetrec command 268 example 269 options 268 return codes 269 syntax 268
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 PropagateBufferSize 289, 291 PropagateConfigFileName 290 propagating events using a gateway 31 propagation configuration file, mcell propagate 31 propagation parameters PropagateBufferSize 289, 291 PropagateConfigFileName 290 protected environments client configuration for passive connections 36 monitoring passive connections 37 protected zone, connecting cells in 36
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
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
304
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