Configure the HP OMi Plugin LAM

The HP OMi Plugin LAM is an endpoint for HTTP notifications from HP OMi. The LAM parses the alerts from HP OMi into Moogsoft Enterprise events.

You can install a basic HP OMi Plugin integration in the UI. See HP OMi Plugin for integration steps.

The HP OMi Plugin LAM does not require authentication. It listens without requiring password information.

Configure the HP OMi Plugin LAM if you want to configure custom properties, set up high availability or configure advanced options that are not available in the UI integration.

See the HP OMi documentation for details on HP OMi components.

Before You Begin

The HP OMi Plugin integration has been validated with HP OMi v10.1. Before you start to set up the LAM, ensure you have met the following requirements:

You have the URL for your HP OMi workspace.
You have credentials to connect to HP OMi with permissions to configure External Event Processing.
HP OMi can make requests to external endpoints over port 443. This is the default.

If you are configuring a distributed deployment refer to High Availability Overview first. You will need the details of the server configuration you are going to use for HA.

Configure the LAM

Edit the configuration file to control the behavior of the HP OMi LAM. You can find the file at $MOOGSOFT_HOME/config/hp_omi_plugin_lam.conf

The HP OMi Plugin LAM is a REST-based LAM as it provides an HTTP endpoint for data ingestion. See the LAM and Integration Reference for a full description of all properties.

Some properties in the file are commented out by default. Uncomment properties to enable them.

Configure the properties for the REST connection:
- address: Address on the Moogsoft Enterprise server that listens for REST messages. Defaults to all interfaces.
- port: Port on the Moogsoft Enterprise server that listens for HP OMi messages. Defaults to 48015.
Configure the SSL properties if you want to encrypt communications between the LAM and the REST connection:
- use_ssl: Whether to use SSL certification.
- path_to_ssl_files: Path to the directory that contains the SSL certificates.
- ssl_key_filename: The SSL server key file.
- ssl_cert_filename: The SSL root CA file.
- ssl_protocols: Sets the allowed SSL protocols.
Configure the LAM behavior:
- num_threads: Number of worker threads to use when processing events.
- rest_response_mode: When to send a REST response. See the LAM and Integration Reference for the options.
- rpc_response_timeout: Number of seconds to wait for a REST response.
- event_ack_mode: When Moogfarmd acknowledges events from the REST LAM during the event processing pipeline.
- accept_all_json: Allows the LAM to read and process all forms of JSON.
- lists_contain_multiple_events: Whether Moogsoft Enterprise interprets a JSON list as multiple events.
Optionally configure the LAM identification and capture logging details:
- name: Maps to $Laminstancename, so that the agent field indicates events Moogsoft Enterprise ingests from this LAM.
- capture_log: Name and location of the LAM's capture log file, which it writes to for debugging purposes.
Optionally configure severity conversions. See Severity Reference for further information and "Conversion Rules" in Tokenize Source Event Data for details on conversions in general.
Optionally configure the process logging details:
- configuration_file: Name and location of the LAM's process log configuration file. See Configure Logging for more information.Configure Logging

Unsupported Properties

HP OMi Plugin alerts do not support client authentication. Do not uncomment or change the following properties:

use_client_certificates
client_ca_filename
auth_token or encrypted_auth_token
header_auth_token or encrypted_header_auth_token
authentication_type
authentication_cache

Example

The following example demonstrates a HP OMi Plugin LAM configuration.

monitor:
{
    name                          : "HpOmiPlugin Monitor",
    class                         : "CRestMonitor",
    port                          : 48015,
    address                       : "0.0.0.0",
    use_ssl                       : false,
    path_to_ssl_files             : "config",
    ssl_key_filename              : "server.key",
    #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",
    authentication_type           : "none",
    authentication_cache          : false,
    accept_all_json               : true,
    lists_contain_multiple_events : true,
    num_threads                   : 5,
    rest_response_mode            : "on_receipt",
    rpc_response_timeout          : 20,
    event_ack_mode                : "queued_for_processing"
},
agent:
{
    name                          : "HP OMi",
    capture_log                   : "$MOOGSOFT_HOME/log/data-capture/hp_omi_plugin_lam.log"
},
log_config:
{
    configuration_file            : "$MOOGSOFT_HOME/config/logging/hp_omi_plugin_lam_log.json"
},

Configure for High Availability

Configure the HP OMi Plugin LAM for high availability if required. See High Availability Overview for details.

Configure LAMbot Processing

The HP OMi Plugin LAMbot processes and filters events before sending them to the Message Bus. You can customize or bypass this processing if required. You can also load JavaScript files into the LAMbot and execute them.

See LAMbot Configuration for more information. An example HP OMi Plugin LAM filter configuration is shown below.

filter:
{
    presend: "HpOmiPluginLam.js",
    modules: [ "CommonUtils.js" ]
}

Configure Mapping

By default the following HP OMi properties map to the following Moogsoft Enterprise HP OMi Plugin LAM properties. You can configure custom mappings in the HP OMi Plugin LAMbot.

HP OMi Event Property	HP OMi Plugin LAM Property
`$LamInstanceName`	agent
`$event.category`	agent_location
`$event.time_changed", conversion:"timeConverter`	agent_time
`$event.title`	class
`$event.title`	description
`$event.originating_server.dns_name`	external_id
`HP OMi`	manager
`$event.severity", conversion:"sevConverter`	severity
`$event.originating_server.ip_address::$event.id`	signature
`$event.originating_server.ip_address`	source
`$event.originating_server.ip_address`	source_id
`$event.priority`	type

Start and Stop the LAM

Restart the HP OMi Plugin LAM to activate any changes you make to the configuration file or LAMbot.

The LAM service name is hpomipluginlamd.

See Control Moogsoft Enterprise Processes for the commands to start, stop and restart the LAM.

You can use a GET request to check the status of the HP OMi Plugin LAM. See "Check the LAM Status" in Configure the REST LAM for further information and examples.

Configure HP OMi

After you have the HP OMi Plugin LAM running and listening for incoming requests, you can configure HP OMi. See "Configure HP OMi" in HP OMi Plugin.

In this section: