Moogsoft Docs

HP OMi Integration Reference

HP Operations Manager (OMi) is an automated IT operations management software application. HP OMi provides automated monitoring, root cause identification and prioritization with automated remedial action.

See HP OMi for UI configuration instructions.

The HP OMi LAM fetches events from the HP OMi and forwards it to Moogsoft AIOps.

  1. LAM reads the configuration from the hp_omi_lam.conf file.
  2. LAM connects to HP OMi REST API with given host name.
  3. The response is received with event data in JSON format.
  4. Events are parsed and converted into normalized Moogsoft AIOps events.
  5. The normalized events are then published to MooMS bus.

HP OMi LAM Configuration

The events received from HP OMi are processed according to the configurations in the hp_omi_lam.conf file. The processed events are published to Moogsoft AIOps.

The configuration file contains a JSON object. At the first layer of the object, the LAM has a parameter called config, and the object that follows config has all the necessary information to control the LAM.

The following sections are available for configuration in the hp_omi_lam.conf file:

Monitor

Agent

HA Configuration

Mapping

Constants and Conversions

Monitor

The HP OMi LAM takes the alerts from the HP OMi Server. You can configure the parameters here to establish a connection with HP OMi:

General

Field
Type
Description
Example
name and class String Reserved fields: do not change. Default values are HpOMi Lam Monitor and CHpOMiMonitor.
url String

Enter the IP address or the host name or the FQDN of the HP OMi server along with the port on which it will communicate.

In case of SSL communication, https will be used instead of http.

http://myhpomi:80

https://myhpomi:443

user_name and Password String

Enter the username and password of the HP OMi console

Note

The username and password of the user who has the permissions for handling all the events should be given here. If a user does not have permissions for handling all the events, then the LAM will not fetch all the events present in HP OMi.


encrypted_password String

If you are using an encrypted password, enter the encrypted password in this field and comment the password field. Either password or the encrypted_password field is used. If both the fields are specified, then only the encrypted_password value will be used by the HP Omi LAM.


events_date_format String The format of the date/time in event response. The possible value would be like "yyyy-MM-dd'T'HH:mm:ss" or "yyyy-MM-dd'T'HH:mm:ss.SSSXXX".  If this value is set to blank, then event date/time will be epoch time.
event_uri String This is the uri of the REST Server from which the events will be fetched. The version given here is 9.10 i.e. the current version of the OMi Event Web Service (not the current OMi version). If the version number is omitted, versions lower than 9.10 of the Event Web Service are addressed. You can change the version in case there is an upgrade of the API of HP OMi. /opr-web/rest/9.10/event_list

polling_interval

Integer

The polling time interval, in seconds, between the requests after which the event data is fetched from HP OMi.
Default = 10 seconds. If 0 is entered the time interval is set to 10 seconds.


max_retries
Integer

The maximum number of retry attempts to reconnect with HP OMi in case of a connection failure.

Default = -1, if no value is specified, then there will be infinite retry attempts.

If the specified value is greater than 0, then the LAM will try that many times to reconnect; in case of any other value less than 0, max retries will set to default.


retry_interval Integer

The time interval between two successive retry attempts.

Default = 60 seconds, if 0 is entered the time interval will set to 60 seconds.


timeout Integer

The value in seconds to wait for a request to complete before timing out. If a timeout occurs, the LAM will wait for the next poll before trying again. Default value is 120 seconds.


Secure Sockets Layer

Field
Type
Description
ssl Boolean

Set to true, to enable SSL Communication:

  • ssl_keystore_file_path : Enter the path of the keystore file. This is the path where the generated keystore file is copied in Moogsoft AIOps, e.g. "/usr/local/hpomi_ssl/keystore.jks".

  • ssl_keystore_password : Enter the password of keystore. It is the same password that was entered when the keystore was generated.


Note

The HP OMi has a functionality of duplicating events within its event browser. The LAM does not fetch all the duplicated events, instead it will fetch only single event which is duplicated into multiple events.

Example

Config File
config :
    {

        monitor:
        {

            name                     : "HpOmi Lam Monitor",

            class                    : "CHpOmiMonitor",

            url		                 : "http://<ip-address:80>",

            user_name                : "user_name",

            password                 : "password",

            # encrypted_password     : "ieytOFRUdLpZx53nijEw0rOh07VEr8w9lBxdCc7229o=",

            events_date_format       : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",

            event_uri				 : "/opr-web/rest/9.10/event_list",

            ssl 				     : false,

            ssl_keystore_file_path   : "usr/local/hpomi_ssl/keystore.jks",

            ssl_keystore_password    : "",

            polling_interval         : 10,

            max_retries              : -1, 

            retry_interval           : 60,
			
			timeout					 : 120

		},

Agent

Agent allows you to define two parameters:

Field

name This is the agent name, the events sent to MooMS by the HP OMi LAM are identified by the agent name in the log. In this example the agent name is HP OMi.
log

HP OMi LAM will write its ingress content in the file hp_omi_lam.log located at the location /var/log/moogsoft/.

Example


Agent
agent:
        {
                name    : "HP OMi"
                #log    : "/var/log/moogsoft/hp_omi_lam.log"
        },

HA Configuration

Refer the document HA Configuration of LAM

Mapping

For alerts received from HP OMi, you can directly map the alert fields of HP OMi with Moogsoft fields. The parameters of the received alert are displayed in the Moogsoft AIOps according to the mapping done here:

mapping :
        {
            catchAll: "overflow",
            rules:
            [
                { name: "signature", rule:      "$originating_server.ip_address::$related_ci.configuration_item.root_class" },   
                { name: "source_id", rule:      "$originating_server.ip_address" },
                { name: "external_id", rule:    "$originating_server.dns_name" },
                { name: "manager", rule:        "HP OMi" },
                { name: "source", rule:         "$originating_server.ip_address" },
                { name: "class", rule:          "$state" },
                { name: "agent", rule:          "$LamInstanceName" },
                { name: "agent_location", rule: "$category" }, 
                { name: "type", rule:           "$priority" },
                { name: "severity", rule:       "$severity", conversion:"sevConverter" },
                { name: "description", rule:    "$title" },
                { name: "agent_time", rule:     "$time_changed", conversion:"timeConverter"} 
            ]
        },
        filter:
        {
            presend:"HpOmiLam.js"
        }       

Data not mapped to Moogsoft AIOps Fields goes into "Custom Info".

Constants and Conversions

Constants and Conversions allows you to convert formats of the received data.

Field
Description
Example
Severity and sevConverter

has a conversion defined as sevConverter in the Conversions section, this looks up the value of severity defined in the severity section of constants and returns back the mapped integer corresponding to the severity.

severity:
{
    "unknown"   : 0,
    "normal"    : 1,
    "warning"   : 2,
    "minor"     : 3,
    "major"     : 4,
    "critical"  : 5
          
}, 
sevConverter:
{
    lookup : "severity",
    input  : "STRING",
    output : "INTEGER"
},
stringToInt

used in a conversion, which forces the system to turn a string token into an integer value.

stringToInt:
{
    input  : "STRING",
    output : "INTEGER"
},
timeConverter used in conversion which forces the system to convert time. If epoc time is to be used, then timeFormat mentioned in timeConverter should be commented. Otherwise, the user should provide the timeFormat.
timeConverter:
{
    timeFormat : "yyyy-MM-dd'T'HH:mm:ss.SSS",
    input      : "STRING",
    output     : "INTEGER"
}

Example

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



Severity Reference

Severity Levels
Moogsoft Severity Levels
severity:
        {
            "CLEAR" : 0,
            "INDETERMINATE" : 1,
            "WARNING" : 2,
            "MINOR" : 3,
            "MAJOR" : 4,
            "CRITICAL" : 5,
            moog_lookup_default: 3
        }
Level Description
0 Clear
1 Indeterminate
2 Warning
3 Minor
4 Major
5 Critical

Service Operation Reference

Process Name Service Name
hp_omi_lam hpomilamd

Start the LAM Service:

service hpomilamd start

Stop the LAM Service:

service hpomilamd stop

Check the LAM Service status:

service hpomilamd status

Command Line Reference

To see the available optional attributes of the hp_omi_lam, run the following command:

hp_omi_lam --help

The hp_omi_lam is a command line executable, and has the following optional attributes:

Option Description

--config

Points to a pathname to find the configuration file for the LAM. This is where the entire configuration for the LAM is specified.
--help Displays all the command line options.
--version

Displays the component’s version number.

--log level

Specifies the level of debugging. By default, user gets everything. In common with all executables in MOOG, having it set at that level can result in a lot of output (many messages per event message processed).

In all production implementations, it is recommended that log level is set to WARN, which only informs user of matters of importance.


Performance Information

Minimum requirement
Component Value
CPU 2 core
RAM 4 GB
Operating System CentOS Linux release 6.7

Version Information

LAM Version

Tool Version

Tested?

Expected to Work

1.0

HP OMi 10.6

Yes

Yes

1.1

HP OMi 10.6

Yes

Yes

1.2

HP OMi 10.6

Yes

Yes

1.3

HP OMi 10.6

Yes

Yes