Beruflich Dokumente
Kultur Dokumente
Entuity 12.5
Entuity Integration Module for BMC ProactiveNet Performance Management
The Entuity integration module for BMC ProactiveNet Performance Management forwards events from Entuity to the designated BMC ProactiveNet Performance Management server. A sample integration allows for easy configuration of both the Entuity and BMC ProactiveNet Performance Management servers.
EMEA Headquarters
9a Devonshire Square London, EC2M 4YN Tel: +44 (0)20 7444 4800 Fax: +44 (0)20 7444 4808
www.entuity.com
0000-0125-PD054 entuity_integ_bppm.rev1.fm
Entuity The Entuity product and its related documentation are protected by copyright and distributed under licenses restricting use, copying, distribution, and decompilation. Unless you have negotiated with Entuity specific terms and conditions for using its product and associated documentation, such use shall be governed by Entuity's standard licence terms, a copy of which is distributed with the product. Entuity may make improvements and/or changes to the product(s) and/or program(s) described in this publication at any time. These changes will be incorporated into new editions of the relevant publication.
Entuity , Eye of the Storm , InSight Center , Green IT Perspective, Network Delivery Perspective and Service Delivery Perspective are registered trademarks of Entuity. All other trademarks are the property of their respective owners.
License terms and conditions of use for Entuity and included third party software can be found on the Entuity server at entuity_home/licenseTerms/. A listing of these third party trademarks, references and software included with Entuity is available through its web UI.
Entuity
Contents
1 Integrating BMC ProactiveNet Performance Management
BMC ProactiveNet Performance Management .....................................................1-1 Entuity integration module for BMC ProactiveNet Performance Management ....1-1 Module Availability.............................................................................................1-1 Module Security.................................................................................................1-2 Overview of Forwarding Events ........................................................................1-2 Mapping Severity Levels ........................................................................................1-3
iii
Entuity
Glossary Index
iv
Entuity
Figures
Figure 1-1 Figure 2-1 Figure 2-2 Figure 2-3 Figure 4-1 Figure 4-2 Figure 4-3 Figure 4-4 Figure 4-5 Figure 4-6 Figure 4-7 BMC ProactiveNet Performance Management Architecture ......................1-3 Integration Configuration Process Overview ..............................................2-4 Configuring Event Forwarding ....................................................................2-5 Configure the Integration ............................................................................2-6 Entuity Forwarded Events ...........................................................................4-1 Entuity Event Summary ..............................................................................4-2 Entuity Event Object Details .......................................................................4-3 Entuity Event Logs and Notes ....................................................................4-4 Entuity Event Source Details ......................................................................4-5 Entuity Event Other Details .........................................................................4-5 Launching Entuity in Context ......................................................................4-6
Module Availability
Entuity integration module for BMC ProactiveNet Performance Management is available with Entuity (for details on Entuitys technical specification see the Entuity Getting Started Guide). It is approved for use with:
BMC ProactiveNet Performance Management 8.0.10/BEIM 2.0 using the web services
API of the BMC Impact Integration Developers Kit 7.3.02.
Entuity
h
The screen captures, terminology and instructions used for this guide are taken from BMC ProactiveNet Performance Management 8.0.10.
Module Security
Entuity access permissions are granted based on that view membership according to the standard Entuity security model. With automatic event forwarding the user account defined in the bem section of entuity.cfg must have access to the Entuity view used with the integration.
1) proffer forwards the event to forkevent (when forkevent starts it registers itself as a client
of proffer, using the details in the connect section of its configuration file).
2) forkevent structures the information and by default passes event information to the
EventActionApplication, BEMForkEvent.
3) BEMForkEvent converts the Entuity information to the format required by the target BMC
ProactiveNet Performance Management server.
1-2
Entuity
Entuity Server
proffer raising events
forkevent
Pipe
EventActionApplication (BEMForkEvent)
Fork
bemForkEvent
Server Configuration
Internal Value
10 8 6 4 2 -
Description
Critical Minor Warning Info OK Unknown
Value
CRITICAL MAJOR MINOR WARNING INFO OK UNKNOWN Red
Color
Orange Amber Yellow Blue Green Grey
Orange Major
Table 1-1 Mapping Entuity and BMC ProactiveNet Performance Management Event Severity Levels
h
The event severity values visible from Event Viewer run from 1 to 5, the internal values which you should use for mapping run from 2 to 10.
1-3
Entuity
Entuity recommend that you create a view for use by the integration. For the BMC ProactiveNet Performance Management view set appropriate event and object filters, as by default every event raised in this view triggers the automatic forwarding of event details. You can set an additional event filter, through sw_bem_menu_def.cfg, to allow only certain events in a view to automatically trigger BMC ProactiveNet Performance Management generation.
1-4
a different Entuity user account a different Entuity view multiple Entuity views, which requires configuration of multiple forkevents multiple Entuity servers to forward events to one or more BMC ProactiveNet Performance Management servers.
Entuity recommend you configure the Entuity integration module for BMC ProactiveNet Performance Management in this sequence:
1) BMC ProactiveNet Performance Management server, creating the required cell for the
Entuity event data
3) amending, if required, the sample Entuity integration module for BMC ProactiveNet
Performance Management.
Entuity recommend you always consult the BMC ProactiveNet Performance Management documentation when configuring BMC ProactiveNet Performance Management.
entuity_home/integ/BEM/server/etc/CELL/kb/rules/ eye_integration.mrl to
MCELL_HOME/etc/<CELL_NAME>/kb/rules.
Entuity Integration Module for BMC ProactiveNet Performance Management Guide 2-1
Entuity
entuity_home/integ/BEM/server/etc/CELL/kb/collectors/eye_collector.mrl to
MCELL_HOME/etc/<CELL_NAME>/kb/collectors. where:
MCELL_HOME is the root of the BMC Server Impact Manager <CELL_NAME> is the name of the cell that you are forwarding events to. 2) Amend MCELL_HOME/etc/<CELL_NAME>/kb/classes/.load to include:
#Integration for EYE EYE_EVENT
6) Restart <CELL_NAME>. 7) Add the new slots to your cell view in BMC IX.
h
mccomp manifest.kb only has to be run once after all the files have been copied to their correct locations and the appropriate .load files have been updated. Once compilation is complete, the cell can be restarted.
Description
configure automatically generates the file. It holds BMC ProactiveNet Performance Management details. Defines BEM slot and BEM types.
Table 2-1 Entuity integration module for BMC ProactiveNet Performance Management Integration Files
2-2
Entuity
Configuration Overview
Filename
Description
BEMSeverityMapping.properties Maps Entuity event severity levels to BMC ProactiveNet Performance Management severity levels. eye_event.baroc bemforkevent.cfg Event class definition file. This file must be added to the target BMC ProactiveNet Performance Management server. Event Action Configuration, specifies automatic forwarding of events through the forkevent process and EventActionApplication. Default name of the BMC ProactiveNet Performance Management forkevent log file. Sets the parameters for the BMC ProactiveNet Performance Management forkevent log file, including name, maximum number of backups, maximum file size, warning level. The bem section details parameters required to connect to the BMC ProactiveNet Performance Management server. A standard Entuity file that defines Entuity processes that should run when the Entuity server is running, The site specific startup file for Entuity. For automatic event forwardingn copy the bemclient section from startup_O/S.cfg and set the state to normal. Advanced Actions Configuration, details the type of information gathered for automatic event forwarding. This is applied to the Entuity server.
bemForkEvent.log BEMForkEventLoggerConf.xml
sw_bem_menu_def.cfg
Table 2-1 Entuity integration module for BMC ProactiveNet Performance Management Integration Files
h
When you edit the configuration files you may want to consider backing them up, or renaming them, to preserve the changes during any subsequent Entuity re-install or upgrade (see Appendix A - Integration Installation Files).
Configuration Overview
Activation of Entuity integration module for BMC ProactiveNet Performance Management requires an appropriate license, inclusion of its configuration and the running of Entuity configure.
2-3
Entuity
Configuration Overview
Start Entuity
Amend bemforkevent.cfg
Amend
startup_o/s_site_specific.cfg
The Entuity integration module for BMC ProactiveNet Performance Management is supplied with a default implementation. Before activating Entuity integration module for BMC ProactiveNet Performance Management you should:
add to the Entuity server a license that includes Entuity integration module for BMC
ProactiveNet Performance Management. By default license.dat is installed to entuity_home\etc.
consider renaming, or backing up, configuration files when you have amended the
default settings (see Appendix A - Integration Installation Files)
decide which managed object - event type combinations you want to allow Entuity
integration module for BMC ProactiveNet Performance Management to forward. Create a view that meets these requirements, using the object and event view filters.
Entuity
login to the BMC ProactiveNet Performance Management server for an extended period
to monitor the type of events raised, and judge whether the configuration meets your requirements.
h
By default Entuity integration module for BMC ProactiveNet Performance Management uses the Regional view and the admin user account. You could use this combination, if you still have an account called admin, however it will forward all Entuity events to the BMC ProactiveNet Performance Management.
Is Entuity Running ?
No
Run Configure
Yes
Select BCM ProactiveNet Performance Management from Module screen Stop Entuity
Complete Configure
Entuity
1) Acquire a valid license from your Entuity representative. The new license file should be
added to entuity_home/etc.
2) Stop the Entuity server. 3) Run Entuity configure, and when it is run: as a wizard, from the Module Select page check the BMC ProactiveNet Performance
Management integration
from the command line, when prompted enter yes to modify the activated modules
and again when prompted to activate the appropriate version of BMC ProactiveNet Performance Management integration.
4) configure prompts for you to make a connection and forward events to BMC
ProactiveNet Performance Management:
BMC Cell Name, the BMC ProactiveNet Performance Management instance to which
Entuity forwards events.
Web Server Host Name, hostname of the server where the BMC II Web Services
Server is located.
Web Server Port Number, the port number used by the BMC II Web Services Server,
by default 9080.
Web Service Name, the name of the web service, by default ImpactManager.
Entuity
change the default view and user account create configuration that allows forwarding of events from multiple Entuity views. Each
view requires its own forkevent. Before amending the default configuration backup the Entuity integration module for BMC ProactiveNet Performance Management configuration files. After amending the default configuration take a second backup of these files. If you are amending the content of the default files, but not renaming them, the next time you upgrade Entuity their content is overwritten. You can use the second backup to restore your customisations.
1) Open an Entuity client and create the view, e.g. coreRouters, for use with the integration.
Take care to include to the view only those object - event type combinations against which you want to forward events. By default all events that are raised in this view are forwarded to the BMC ProactiveNet Performance Management. You can open this view in Event Manager, the events raised here are the events Entuity would forward to the BMC ProactiveNet Performance Management.
2) From the view use Access Control to associate the user groups allowed to access the
view. This user group should include the user account, e.g. JJones, you are going to use with BEMForkEvent.
2-7
Entuity
This example forwarded all events in the coreRouters view, with access being permitted to forkevent through the defined Entuity user account, JJones.
h
By default Entuity integration module for BMC ProactiveNet Performance Management forwards all events in the defined view. You can apply an additional filter, through sw_bem_menu_def.cfg, which would only forward explicitly detailed events.
1) Stop the Entuity server. 2) From the [bemclient] section set the state to: normal, for the Entuity integration fpr Entuity integration module for BMC
ProactiveNet Performance Management to run
2-8
in the specified view, e.g. Regional does the specified user account allow access to the view, e.g. admin of the specified type, e.g. in the sample configuration all events are passed.
Only when all conditions are met is event information passed to the BMC ProactiveNet Performance Management.
h
In the sample configuration the Regional view and all event types are specified, which would result in all events received by the Entuity server being forwarded to BMC ProactiveNet Performance Management server. Entuity recommend changing the view to a more restricted view, through bemforkevent.cfg.
bemforkevent.cfg you define the connection to this view; the connection used by
forkevent to forward event information to the BMC ProactiveNet Performance Management.
sw_bem_menu_def.cfg you can configure an additional event filter, so not all events
raised in the view are forwarded.
an object filter that only permits those objects against which you would want to forward
events.
Entuity Integration Module for BMC ProactiveNet Performance Management Guide 3-1
Entuity
a view filter, through which you select which type of events are displayed against the
managed objects in the view. When you have setup a view you must still configure forkevent to use that view, through the connection section of bemforkevent.cfg. Entuity recommend you tightly control the number of managed object - event combinations that can Entuity integration module for BMC ProactiveNet Performance Management forwards. For details on view creation and management see the Entuity System Administrator Guide.
You can adjust the event filter to only forward explicitly specified events, for example:
supportedEventTypes=8:7
uniquely identifies AvailMonitor Node Down as 8 is its event group identifier and 7 is its event identifier. (See the Entuity Event Guide for details on Entuity event groups and identifiers.) You can identify more than one event type, using commas to separate each event:
supportedEventTypes=1024:800,1024:802
respectively identifies AP Host Count High and AP Host count Low events.
h
Entuity recommend you consult your Entuity Support representative before amending Advanced Action configuration files.
BEMForkEvent.log BEMForkEventFailedSend.log.
Entuity Integration Module for BMC ProactiveNet Performance Management Guide 3-2
Entuity
BEMForkEvent.log
This log file records the reasons for event forwarding failure:
when the target BEM cell does not exist on the target BMC ProactiveNet Performance
Management, the log file includes this message:
Check BMC II Web Server is running on [serverName] and that cell[eye_integration] exists Error -110 connecting to cell eye_integrations.File eye_integrations, Line impl.cpp.
when the forwarding of an event fails, the log file includes this message:
Check BMC II Web Server is running on [serverName] and that cell[eye_integration] exists
BEMForkEventFailedSend.log
This log file records the events Entuity fails to forward.
3-3
Entuity
Status, indicates current status of the event, e.g. Open. Severity, BMC ProactiveNet Performance Management event severity. Message, Entuity event name and source Entuity server. Detailed Message, Entuity event name, source Entuity server and event details. Class, Entuity event class, EYE_EVENT. Repeated, number of times the event is repeated. Metric, Entuity event name.
Object, identifier of the managed object, e.g. the interface on the device. Object Class, type of Entuity object, e.g. StormWorks, Device, Application. Object URI, opens the event in Entuity. Host, identifier of the managed device. Parameter, name of the Entuity event. Location, physical location of the managed object.
4-2
Entuity
Occurred, time the event was raised in Entuity. Origin Time, time the event was raised in Entuity. Arrived, time the event arrived at the BMC ProactiveNet Performance Management. Received, time the event received at the BMC ProactiveNet Performance Management. Modified, time the event was last modified, indicating the event has been repeatedly raised.
4-3
Entuity
Tool, name of the event provider software, i.e. Entuity. Tool ID, Entuity server name. Client Address, Entuity client address. Tool Class, environment Entuity is installed to. Tool Severity, Entuity severity level. Tool Address, Entuity server IP address.
4-4
Entuity
eye_comp_id, internal Entuity component identifier. eye_event_group Entuity event group identifier. eye_event_id, Entuity event identifier which is unique within the event group. eye_impact_descr, indicates the impact of the network event on performance. eye_stormworks_id, internal Entuity unique object identifier. eye_userID, Entuity user account name used for forwarding events.
4-5
Entuity
4-6
Appendix A
sample configuration files in entuity_home/etc/: bem.cfg bemforkevent.cfg BEMForkEventLoggerConf.xml. sw_bem_menu_def.cfg startup_O/S.cfg startup_O/S_site_specific.cfg file generated after configure in entuity_home/install/template/etc: bem.cfg files in entuity_home/integ/BEM/etc: BEMEventTypes.properties BEMSeverityMapping.properties files in entuity_home/integ/BEM/server/etc/CELL/kb/: classes/eye_event.baroc collectors/eye_collector.mrl rules/eye_integration.mrl files in entuity_home/integ/BEM/console/etc/event_op/: eye_actions.xml eye_cross_launch eye_cross_launch.cmd LocalActions.xml files in entuity_home/integ/BEM/lib/: BMCEventManager.jar iiws-client-stub.jar sendEvents.jar
A-1
Entuity
Configuration Files
sw_bem_menu_def_NEWNAME.cfg. bemforkevent_NEWNAME.cfg.
You must also rename any references to these files within the configuration files. For example, in:
Configuration Files
Entuity integration module for BMC ProactiveNet Performance Management configuration files:
identify the connection between Entuity and the BMC ProactiveNet Performance
Management server(bem.cfg)
map Entuity event fields to BMC ProactiveNet Performance Management slots, using
existing slots or ones created for Entuity (sw_bem_menu_def.cfg)
bem.cfg
bem.cfg is automatically generated by configure. It defines the connection between Entuity and the BMC ProactiveNet Performance Management cell.
[connection] cellname=entuity webServerHostName=decade webServerPortNumber=9080 webServiceName=ImpactManager refreshCache=3600
where:
A-2
Entuity
Configuration Files
webServerHostName, hostname of the server where the BMC II Web Services Server is
located.
webServerPortNumber, the port number used by the BMC II Web Services Server, by
default 9080.
webServiceName, the name of the web service, by default ImpactManager. refreshCache is the time in seconds that the integration slots are maintained in memory
by Entuity, after which Entuity automatically initiates a refresh of the list. The default value is 3600.
BEMEventTypes.properties
BEMEventTypes.properties defines BMC ProactiveNet Performance Management slots and their types. These are the slots and their formats supplied in the sample integration:
mc_ueid=STRING msg=STRING mc_long_msg=STRING severity=STRING mc_tool_sev=STRING mc_tool=STRING mc_tool_id=STRING mc_tool_address=STRING mc_tool_class=STRING mc_parameter=STRING mc_parameter_value=STRING mc_parameter_unit=STRING mc_incident_time=STRING mc_object=STRING mc_object_class=STRING mc_tool_key=STRING mc_tool_uri=STRING eye_userId=STRING eye_impact_descr=STRING eye_stormworks_id=STRING eye_comp_id=STRING eye_event_group=STRING eye_event_id=STRING
A-3
Entuity
Configuration Files
BEMSeverityMapping.properties
BEMSeverityMapping.properties maps Entuity event severity levels to BMC ProactiveNet Performance Management event severity levels:
EYE_SEVERITY_CRITICAL=BEM_SEVERITY_CRITICAL EYE_SEVERITY_SEVERE=BEM_SEVERITY_MAJOR EYE_SEVERITY_MAJOR=BEM_SEVERITY_MINOR EYE_SEVERITY_MINOR=BEM_SEVERITY_WARNING EYE_SEVERITY_INFO=BEM_SEVERITY_OK
A-4
Appendix B
For automatic event forwarding you must configure and run forkevent. The default instance of forkevent is called BEMForkEvent. forkevent is configured through its own event action configuration file (bemforkevent.cfg), to forward event information to the EventActionApplication. Specifically forkevent uses details in the [pipe_bem7_4] section when calling EventActionApplication. forkevent structures the event details, and sends the data to EventActionApplication using the stdin of the pipe process.
h
You can also run more than one forkevent process at one time, although they must use different configuration files. For details contact your Entuity Support representative. EventActionApplication uses the default configuration, specifically:
2) EventActionApplication builds a string that contains the returned parameters and then
passes it to the BMC ProactiveNet Performance Management. forkevent connection uses details in the [bem] section of entuity.cfg to register with proffer. forkevent becomes a client of proffer, proffer only forwards to forkevent those events in the registered view.
Configuring forkevent
Pipe Process
forkevent communicates with the database using Pipe, each time forkevent recognizes an event it sends the event data to the stdin of the Pipe process. The format and structure of the event data is taken from the [data] section in the configuration file. The Pipe continues to run until it is explicitly stopped or the Entuity server is stopped. Each time a new event occurs the same forkevent process is used. In Pipe mode forkevent sends event data in the format:
VariableLabel VariableValue <CR> BlankLine <CR>
Where:
VariableLabel is the label assigned to the event data in the [data] section, e.g. Descr in
Descr=${event.PAPIDescr}.
VariableValue is the event data value, extracted from the [data] section, e.g.
${event.PAPIDescr} in Descr=${event.PAPIDescr}.
B-1
Entuity
<CR> is the end of line marker. Each value is passed on its own line. BlankLine is automatically sent at the end of the event data to signal the end of that event. Integration forkevent Configuration
The Entuity integration module for BMC ProactiveNet Performance Management configuration file, e.g. bemforkevent.cfg, contains details used to determine the format and order event data is passed to the BMC ProactiveNet Performance Management server. There are a number of sections, each starts with its section name, enclosed within square brackets, e.g. [connection] and [data]. All variable definitions are held within sections. These sections can be divided into three types:
Connection section contains details required to access the Entuity database (see
Connection Section).
Process section determines which parameters are passed. You can specify one or more
process sections, which one is used is passed as an argument when running forkevent (see Process Sections).
Data section details the event data passed to the Pipe process (see the Data Section).
h
Entuity supply a sample file, bemforkevent.cfg. You should read this section and then take a backup of the file before attempting to amend it. Connection Section In bemforkevent.cfg configure the connection, for example:
[connection] username=${bem.connection_username} view=${bem.connection_view} extendedEvents=${bem.connection_extendedEvents}
Process Sections The process sections define the pipe process and its arguments. A configuration file can have more than one process definition, although only one is used at any one time. This is passed as an argument when forkevent is run. This is the sample process section:
[pipe_bem7_4] start=${install.JAVA} -Dlog4j.configuration=file:${ENTUITY_HOME} ${FPS}etc${FPS}BEMForkEventLoggerConf.xml =-Dhostname="" =-Djava.library.path=${ENTUITY_HOME}${FPS}lib =-Dbem.properties=${ENTUITY_HOME}${FPS}etc${FPS}bem.cfg =-Dseverity.mapping=${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}etc${FPS} BEMSeverityMapping.properties
B-2
Entuity
=-Dbem.eventTypes=${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}etc${FPS} BEMEventTypes.properties =-cp ${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}classes$ {EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}webapps${FPS}webUI${FPS}WEB -INF${FPS}lib${FPS}EYEAuthModel.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}webapps${FPS}webUI${FPS}WEB -INF${FPS}lib${FPS}EyeAuthClientWS.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}webapps${FPS}webUI${FPS}WEB -INF${FPS}lib${FPS}XMLStream.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}lib${FPS}activa tion.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}lib${FPS}jaxbapi.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}lib${FPS}jaxbimpl.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}lib${FPS}jsr173 _1.0_api.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}common${FPS}lib${FPS}webrpc .jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}TomCat${FPS}webapps${FPS}webUI${FPS}WEB -INF${FPS}lib${FPS}mysql-connector-java-3.1.13-bin.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}ImpactManager-testclient.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}BMCEventManager.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axis2-kernel1.5.1.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axis2-adb1.5.1.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axiom-api1.2.8.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axiom-impl1.2.8.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}XmlSchema1.4.3.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}neethi2.0.4.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axis2-transportlocal-1.5.1.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}axis2-transporthttp-1.5.1.jar${EPS}
B-3
Entuity
=${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}commons-httpclient3.1.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}mail-1.4.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}httpcore4.0.jar${EPS} =${ENTUITY_HOME}${FPS}integ${FPS}BEM${FPS}lib${FPS}commons-codec1.3.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}axis.jar${ EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}jaxrpc.jar ${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}commonsdiscovery-0.2.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}commonslogging-1.0.4.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}saaj.jar${ EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}map${FPS}wsdl4j1.5.1.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}EOSServer.jar${EPS} =${ENTUITY_HOME}${FPS}lib${FPS}httpd${FPS}EOS${FPS}log4j.jar =com.entuity.eos.menu.EventActionApplication =period=0 appname=BEMForkEvent userid=${bem.connection_username} webport=${webportnum} args= type=pipe directory=${LOGDIR}
[pipe_bem7_4] is the section name. This is passed as a parameter with the forkevent
command.
start runs the specified application with the set arguments: maxactions, the maximum number of concurrently executing menu actions, by default
15. Once exceeded Entuity queues remaining actions. It is optional, but when set must be 1 or greater.
timeout, the time after which an executing action can be removed from the pool and
queued actions run. A timeout action can be terminated, or left for execution based on the value of terminate. 0 indicates no timeout, the default is 900000 ms, 15 minutes, and the minimum value is 100 ms.
terminate, when set to true, the default, terminates a timed-out action, false allows the
action to complete.
period, specifies the minimum amount of time in milliseconds that must elapse
Entuity Integration Module for BMC ProactiveNet Performance Management Guide B-4
Entuity
between action executions, and is used to control throughput of action executions and system load. The default is 1000.
dsport, Entuity StormWorks port, the default is 5467. dstimeout, timeout for the Entuity StormWorks database connection. The default is 60
seconds.
appname, name of the application forkevent runs to gather the BMC ProactiveNet
Performance Management data.
userid, the account name used to access Entuity events. When customising the
installation you could change this user account.
clienthost, application's IP address, by default localhost. eyeserver, IP address or hostname, and port of the Entuity web server, by default
localhost:80. This attribute is used in place of webport but can also make use of it, for example where keli is the Entuity server hostname:
eyeserver=keli:${webportnum}
webport, the port on which the Entuity web server is accessible, by default 80. args allow you to pass commandline arguments with the Pipe and Fork processes. They
are not used with the Entuity integration module for BMC ProactiveNet Performance Management.
When type is pipe, start runs as soon as forkevent runs, creating the Pipe process. EmptyVariable is used to enter a value in an event variable passed from Entuity that does
not contain any data, i.e. to make it easier to identify in the integrated package. By default EMPTY_VARIABLE is entered, using EmptyVariable you can replace that with one of your choice, e.g. MISSING_VALUE.
directory is the directory from which the process is run and log files are written to. loglevel is the level of logging information recorded, i.e. errors, warning, info, debug
and all. Data Section This section holds the associations between labels and Entuity event variables. These labels can be used by the Pipe process to identify and manipulate event data. There must only be one data section in an Event Forward configuration file.
h
The data section is only used with the Pipe process. The Pipe process runs continually and it is only through the data section that arguments can be passed for each event. The Fork process is started for each event, and so arguments are passed each time an event occurs. This is an example section:
[data] event.PAPIId=${event.PAPIId} event.PAPIEventGroup=${event.PAPIEventGroup}
B-5
Entuity
event.PAPIEventId=${event.PAPIEventId} event.PAPIEventStr=${event.PAPIEventStr} event.PAPItimeStamp=${event.PAPItimeStamp} event.PAPIObjectID_1=${event.PAPIObjectID_1} event.PAPIObjectID_2=${event.PAPIObjectID_2} event.PAPIObjectID_3=${event.PAPIObjectID_3} event.PAPIObjectID_4=${event.PAPIObjectID_4} event.PAPIpriority=${event.PAPIpriority} event.PAPIAttr=${event.PAPIAttr} event.PAPIDescr=${event.PAPIDescr} event.PAPIImpact=${event.PAPIImpact} event.PAPIImpactDescr=${event.PAPIImpactDescr} event.PAPIDetails=${event.PAPIDetails}
Where:
[data] is the mandatory name of the data section. ${event.PAPIID} is a numeric value specifying the current instance of the event. ${event.PAPIEventGroup} is a numeric value specifying the event's group. ${event.PAPIEventID} is the event identifier within the context of the event group.
The combination of event group and event ID uniquely identify all Entuity event types (see the Entuity Event Guide).
${event.PAPIEventStr} is the description of the event associated with the event identifier. ${event.PAPItimestamp} is the time the event occurred, represented as UTC
(Coordinated Universal Time, i.e. the number of seconds since 1970-01-01 00:00:00 GMT).
${event.PAPIpriority} is an obsolete attribute retained for Entuity backward compatibility. ${event.PAPIAttr} is an internal numeric attribute, not used for the integration. ${event.PAPIImpactDescr} lists entities likely to be affected by the event, e.g. hosts,
VLANs and monitored applications.
B-6
Entuity
Where:
[bem] is the name of the section that contains the details required to access Entuity event
data.
connection_view is the Entuity view from which events are collected, by default Regional.
Only when an event occurs on a managed object within the defined view is it forwarded by forkevent. Regional includes all managed objects, Entuity advise changing view to a more restricted view to only include events from required objects.
0, forwards event descriptions to a maximum of 127 characters 1, forwards event descriptions to a maximum of 4095 characters.
h
You should create the view and user account to use with Entuity integration module for BMC ProactiveNet Performance Management before configuring the integration. After configuring the integration and restarting Entuity, Entuity immediately starts forwarding events using these connection details. If the view and user account combination do not exist the integration fails.
version, sets the version of IIWS used with the integration to 7.4. This is the default setting
and supports the recommended BMC products:
B-7
Appendix C
Configuring cross context launch of Entuity is only required for versions of BMC ProactiveNet Performance Management earlier than 8.0.
C-1
Glossary
BMC Cell
BMC Impact Manager instance. A cell receives events from Entuity and displays them in the BMC IX.
BMC IIDK
BMC Impact Integration Developer's Kit, used with the Entuity BEM System.
BMC IX
BMC IX (BMC Impact Explorer) displays events received from Entuity.
Drop Box
Drop box acts as a temporary repository for objects, for example gauges, charts, links, device metrics, that you want to include to new reports, dashboards.
Entuity
Entuity is both the name of the network management software and the company producing it. Entuity software is designed for networks of any size and complexity, from the smallest, simplest corporate infrastructure to the largest multinational. Every customer can access the full functionality of our cornerstone solution, incorporating fault, performance and inventory management.
Entuity Integration Module for BMC ProactiveNet Performance Management Guide Glossary-1
Entuity
Essential Reports
Entuity provide a number of Essential Report templates that determine the basic report type, e.g. PVC Data Loss report. An Entuity administrator can use these templates to create new Essential Report definitions, setting when the report runs, which view it reports on, the page layout and the reports Prime Time. Entuity users that have access to the associated views, can then access the generated reports through Reports in the web UI or Component Viewer. These reports are currently available as pdf documents.
Polling Engine
The Polling Engine (or Core Management Engine) is the set of processes within an Entuityserver responsible for all general network management tasks excluding flow collection (e.g.network discovery, inventory, monitoring, event management). Administrators can enable/disable an Entuity servers Polling Engine through configure, a decision which should be made according to the role the administrator wants the server to perform in the management of the network.
Reachability
Availability Monitor sends an ICMP ping to the management IP address of managed devices, by default every two minutes. Devices that respond are considered reachable, those that do not respond, after the set number of retries, are considered unreachable. When Availability Monitor is not running, then the reachability of the device is Unknown for that period, although Entuity maintains the last known state of the device. Entuity maintains a record of device reachability, which is available through Entuity reports, e.g. Routing Summary, Switching Summary, Device Uptime and Reachability reports.
Reboot
Entuity uses the device sysuptime to calculate when the device was last rebooted, or more accurately when the device last came up after being rebooted.
Uptime
By default Entuity polls devices every five minutes, retrieving device sysuptime. Entuity checks as to whether the device has been continually up since the last poll, and modifies the devices uptime value accordingly. When sysuptime indicates the device has been down during the polling interval but is now up, from sysuptime alone Entuity cannot identify for how long the device was down. Entuity
Glossary-2
Entuity
takes this unknown time, and adds fifty percent of it to the known uptime value, with the remaining fifty percent considered UNKNOWN. For example where sysuptime has a value of two minutes. Entuity cannot determine the state of the device over the first three minutes of the polling interval. Entuity adds ninety seconds to the sysuptime value, giving an uptime value of two hundred and ten seconds and records the device state as UNKNOWN for ninety seconds. Device uptime is visible through Component Viewer, and is used in many reports, e.g. Routing Summary, Switching Summary, KPI Device Availability / Uptime.
Glossary-3
Entuity
Index
A
Advanced Actions configuration 2-3 event filters 3-2 Event Forwarding event attributes B-5 EventActionApplication 1-2 configuration 2-3 EventActionApplication.log 2-8
B
baroc file Entuity event class 2-1 bem.cfg A-2 BEMEventTypes.properties A-3 BEMForkEvent B-1 bemforkevent.cfg 2-7, 2-8 bemForkEventLoggerConf.xml 2-8 BEMSeverityMapping.properties A-4 BMC Event Manager 7.X B-7 BMC ProactiveNet Performance Management versions 1-1, B-7 amending B-7 BMC ProactiveNet Performance Management 8.0 B-7
Events filtering 3-2 groups B-6 identifiers B-6 restricting B-7 Extensible Menus 1-4, 2-3 eye_collector.mrl A-1 eye_event.baroc 2-1, A-4 location A-1 eye_integration.mrl A-1
F
forkevent application name B-5 automatic startup 2-8 connection B-7 data B-5 process B-2 workflow B-1
C
cacheRefresh A-3 cacheUser A-3 Configuration Files Entuity upgrades A-2 renaming A-1
L
Log Files 2-8 troubleshooting 3-2
D
DMK Glossary-1
P
Pipe mode B-1 Process Health forkevent 2-8 proffer raising events 3-1
E
Entuity integration module for BMC ProactiveNet Performance Management files A-1 installing A-1 entuity.cfg bem section 2-3, B-7
R
Renaming Configuration Files A-1
Index-1
Entuity
S
Security 1-2 startup_O/S_site_specific.cfg A-1 backups A-2 definition 2-3 startup_O/S.cfg A-1 definition 2-3 sw_bem_menu_def.cfg 1-4, 2-3, A-4 backups A-2
U
User Account bemforkevent.cfg 2-7, B-5
V
Views restricting events B-7
Index-2