Page tree
Skip to end of metadata
Go to start of metadata

Overview

HP OMi server is used for application management, security, and compliance, as well as business and web analytics. It captures, indexes and correlates real-time data in a searchable repository from which it can generate graphs, reports, alerts, dashboards, and visualizations. The HP OMi Plugin pushes the events generated in the HP OMi server to the HP OMi Plugin LAM. The HP OMi Plugin LAM then sends the events to Moogsoft AIOps

Process Workflow

  1. The HP OMi Plugin LAM reads the configuration from the hp_omi_plugin_lam.conf file.
  2. The HP OMi Plugin push the events via the configured mechanism (http/https etc.) to the LAM in XML format.
  3. The HP OMi Plugin LAM parses the events and submits it to Extractor.
  4. The Extractor is responsible for handling JSON strings and extracting events from it.
  5. The events are parsed and converted into normalized Moogsoft AIOps alerts.
  6. The normalized alerts are then published to MooMS bus.

Installing the HP OMi Plugin

Installing HP OMi Plugin involves creation of a Connected Server and an event forwarding rule. When an alarm is generated or its status changes then, HP OMi checks if the rule defined in the Event Forwarding rule is met or not, if it does, then the alarm details are forwarded to the configured Connected Server in the Event forwarding rule. The Connected server has a script and connection details of the HP OMi Plugin LAM. The triggered alarm then via the Connected Server is forwarded to the LAM. 

Creating a Connected Server

To create a Connected Server with connection details of the HP OMi Pugin LAM:

  1. Open the HP OMi Login page and enter the Login user name and password in it. The HP OMi Workspace opens
  2. Click on Administration, then in the Setup and Maintenance section, click on Connected Servers
  3. Click on the asterisk icon, i.e. the New Item button. icon in the Connected Servers section and select External Event Processing. The Create New Server Connection dialog opens.
  4. In the General tab, enter the Display Name and the Name of the Connected Server and click on Next
  5. In the Server Properties tab, enter the FQDN or the IP Address of the HP OMi Plugin LAM, and select any one of the CI Type form the CI Type dropdown, then click on Next.
  6. In the Integration Type tab, click on Manage Scripts. The Event Forwarding Script Configuration dialog opens
  7. Click on the asterisk icon, i.e. the New Item button. icon in the Scripts section. The Create New Script dialog opens.
  8. Enter the Display Name and the description, then click on Next

  9. In the Scripts Section, delete the existing text, and copy and paste the text from the CHpomiPushAdapter file, then click on Next

    The CHpomiPushAdapter file is available for download here CHpomiPushAdapter


  10. Click on Finish, and close the Create New Script dialog.

  11. The newly created script is displayed in the Scripts section.
  12. In the Integration Type section, select the script you created e.g. Moogsoft_Push_Adapter, then click on Next

    The Maximum Transaction Time can also be changed here. It is the maximum time the Adapter will wait before trying again to push the event in case of a connection failure

  13. Enter the Port of the HP OMi Plugin LAM in the Port field of the Outgoing Connection section. The default port of the HP OMi Plugin LAM is 48015
  14. If SSL Connection is to be established, then select the check box Use Secure HTTP, and click on Retrieve from Server to extract the certificate from the HP OMi Plugin LAM. Alternatively, the certificate can also be imported in HP OMi by clicking on Import from File

    For using Retrieve from Server, ensure that the certificate is placed in the HP OMi Plugin LAM

    For using Import from File, please ensure that the certificate is copied to the HP OMi server

  15. Click on Next.

  16. Click on Finish

The Connected Server is created which will forward the events to HP OMi Plugin LAM. Now configure an Event Forwarding Rule which will trigger the events that will be forwarded.

Creating an Event Forwarding Rule

  1. Navigate to Administration > Event Processing Event Forwarding


  2. Click on the asterisk icon i.e. the New Item button in the Event Forwarding Rules section. The Create New Event Forwarding Rule dialog opens
  3. Enter the following information in the Create New Event Forwarding Rule dialog:
    1. Enter a Display Name and Description
    2. Click on the three dots in the Event Filter field and create a custom filter as shown in the screenshot below and click on OK

    3. Select the newly created filter e.g. test1 in the Event Filter dropdown. The filter decides if rule will be triggered or not depending on the state of the events selected.

      In the above example, if any of the state of the event is triggered then it will be forwarded to the HP OMi Push Plugin

    4. Select the Connected Server, created in the above procedure in the Target Servers field e.g. Moogsoft Server, then click on the Add icon (plus sign).
    5. Select Notify and Update in the Forwarding Type field.

      Notify and Update should be selected in the Forwarding Type field. If not selected, then the Adapter will not work properly

  4. Click on OK


The event forwarding rule is displayed in the Event Forwarding Rules section.

The HP OMi Plugin is now ready to forward events to HP OMi Plugin LAM

Managing Plugin Logs 

The Logs of the Plugin is created in the file opr-event-sync-adapter.log located at /opt/HP/BSM/log/opr-scripting-host. The events that are pushed by the plugin and the errors are logged in the file. The log levels and the size of the log file can also be changed. These parameters can be changed in the file opr-event-sync-adapter.properties located at  /opt/HP/BSM/conf/core/Tools/log4j/wde. The following configurations can be done here:

  • Log file size: The maximum file size and the number of archived log files are defined in the log properties files located at <OMi_HOME>/conf/core/Tools/log4j. An example is: 

    def.file.max.size=2000KB
    def.files.backup.count=10

    The size limit is set in the field def.file.max.size. When a file reaches this limit, it is renamed and becomes an archived log. A new active log file is then created.

    For many logs, you can configure the number of archived log files that are saved in the field def.files.backup.count. When a file reaches its size limit, it is renamed with the numbered extension 1 (log.1). If there is currently an archived log with the extension 1 (log.1), it is renamed to log.2, log.2 becomes log.3, and so on, until the oldest archived log file (with the number corresponding to the maximum number of files to be saved) is permanently deleted.

  • Log file level: The log level can be changed according to the requirement, it is defined in the log properties files located at <OMi_HOME>/conf/core/Tools/log4j an example is:

    loglevel=ERROR

    Change the loglevel to the required level. The following levels are available:

    • Error: The log records only events that adversely affect the immediate functioning of OMi. When a malfunction occurs, you can check if Error messages were logged and inspect their content to trace the source of the failure.

    • Warning: The log's scope includes, in addition to Error-level events, problems for which OMi is currently able to compensate and incidents that should be noted to prevent possible future malfunctions.

    • Info: The log records all activity. Most of the information is routine and the log file quickly fills up.

    • Debug: This level is used by HP Software Support when troubleshooting problems.

HP OMi Plugin LAM

The HP OMi Plugin LAM is used to communicate with the HP OMi Plugin. It is a copy of the REST LAM and configurations available here is same as that of a REST LAM. Refer the REST LAM document on the available configurations. The configuration for the HP OMi Plugin LAM is done in the hp_omi_plugin_lam.conf file. The default configurations in the HP OMi Plugin LAM is as follows:

Monitor section

The following section is the monitor section of the HP OMi Plugin LAM

config :
    {
        monitor:
        {

            name                    		: "HPOMiPlugin Monitor",

            class                   		: "CHpOmiPluginMonitor",

            port                    		: 48015,

            address                			: "0.0.0.0",

            use_ssl                 		: false,
	
            path_to_ssl_files       		: "config",

            ssl_key_filename        		: "server.key",

            ssl_cert_filename       		: "server.pem",

            #use_client_certificates  		: false,

            #client_ca_filename      		: "ca.crt",

            #auth_token             	    : "my_secret",

            #encrypted_auth_token    		: "dfJtTQMGiFHfiq7sCmxguBt6Jv+eytkoiKCquSB/7iWxpgGsG2aez3z2j7SuBtKj",

            #header_auth_token           	: "my_secret",

            #encrypted_header_auth_token 	: "dfJtTQMGiFHfiq7sCmxguBt6Jv+eytkoiKCquSB/7iWxpgGsG2aez3z2j7SuBtKj",

            ssl_protocols					:"TLSv1.2", 
            								  #[
            								  #  "TLSv1.2"
            								  #]

            authentication_type				: "none",

            authentication_cache			: false,

            accept_all_json          		: false,

            lists_contain_multiple_events 	: true,

            num_threads              		: 5,

            rest_response_mode 				: "on_receipt",

            rpc_response_timeout			: 20,

            event_ack_mode 					: "queued_for_processing"
In the Monitor section, in the address field, enter the hostname of the machine where the HP OMi Plugin LAM is running
The port given in the port field is an optional value that defaults to 48015


For more information about the fields refer the REST LAM document.

Agent 

agent:
	    {
	            name    : "HP OMI Plugin"
	            #log    : "/var/log/moogsoft/hp_omi_pugin_lam.log"
	    },

The above example specifies: 

  • name: This is the agent name, the events sent to MooMS by HP OMi Plugin are identified by the agent name. In this example the agent name is HP OMi Plugin
  • log: In this instance, the HP OMi Plugin LAM will write its ingress contents to hp_omi_plugin_lam.log located at /var/log/moogsoft

Mapping

The following mapping section in the config file provides an example of mapping of the HP OMi alert fields with the Moogsoft AIOps fields.

mapping:
    
		{   
			catchAll:"overflow",
            rules:
            [
				{ name: "signature", rule:      "$event.originating_server.ip_address::$event.id" },
                { name: "source_id", rule:      "$event.originating_server.ip_address" },
                { name: "external_id", rule:    "$event.originating_server.dns_name" },
                { name: "manager", rule:        "HP OMi" },
                { name: "source", rule:         "$event.originating_server.ip_address" },
                { name: "class", rule:          "$event.title" },
                { name: "agent", rule:          "$LamInstanceName" },
                { name: "agent_location", rule: "$event.category" },
                { name: "type", rule:           "$event.priority" },
                { name: "severity", rule:       "$event.severity", conversion:"sevConverter" },
                { name: "description", rule:    "$event.title" },
                { name: "agent_time", rule:     "$event.time_changed", conversion:"timeConverter"}
            ]
        },
        filter:
        {
            presend: "HpOmiPluginLam.js"
        }
The signature field is used by the LAM to identify the correlated alerts. By default, here it is set to the combination of event.originating_server.ip_address and event.id field. However, user can change it as per the requirement
Variables section is not required in HP OMi Plugin LAM; a user can directly map the alert fields of HP OMi alerts with moogsoft fields
The Mapping section given here is an example, the user has to change the mapping according to the fields received in alerts/alarms from HP OMi

Custom Info

The alarms/events are displayed in the Moogsoft AIOps, the data in the fields of the alarm or event mapped in the mapping section are shown in the respective columns of Moogsoft AIOps columns. The fields of alarms and events which are not mapped in the mapping section are displayed in the Custom Info field of the alarm. An example of Custom Info:

Constants and Conversions

The following section is the constant and conversion of the HP OMi Plugin LAM

constants:
        {
	   severity:
            {
                "unknown"       : 0,
                "normal"        : 1,
                "warning"       : 2,
                "minor"         : 3,
                "major"         : 4,
                "critical"      : 5
            }
        },
        conversions:
        {
            sevConverter:
            {
                lookup: "severity",
                input:  "INTEGER",
                output: "INTEGER"
            },
			timeConverter:
            {
                timeFormat: "yyyy-MM-dd'T'HH:mm:ss.SSS",
                input:      "STRING",
                output:     "INTEGER"
            }

        },

Quotes

In some instances, the attribute strings are quoted. Our JSON parser ignores it, but the standard requires quoting for all strings, so Moogsoft recommends that user quote all strings.

Comments

A user can comment out lines by prefixing them with a hash. 

Starting the HP OMi Plugin LAM

To start the HP OMi Plugin LAM enter the following command:

service hpomipluginlamd start

To stop the HP OMi Plugin LAM enter the following command:

service hpomipluginlamd stop


To view the status of HP OMi Plugin LAM, enter the following command:

service hpomipluginlamd status

Version Information

LAM Version

Tool Version

Tested?

Expected to Work

1.0

HP OMi Enterprise version 6.5.1 

Yes

Yes

System Information

This LAM was tested on a system with the following configurations:

CPU2 core
RAM4 GB
Operating SystemCentOS Linux release 6.7

The system must at least have the above mentioned system requirements to run the LAM.

  • No labels