E-mail
HQ and OpenNMS
HQ integration with OpenNMS v1.3.10, introduced in HQ 3.2.2, is implemented using the HQU Framework, extending the early integration efforts of the OpenNMS Group. For information about the OpenNMS Group effort, and about preparing OpenNMS for integration see the OpenNMS white paper.
Integrating HQ and OpenNMS enables you to:
- Import HQ platforms into OpenNMS as OpenNMS nodes on a scheduled basis. (In HQ, a physical or virtual hardware and operating system combination is referred to as a platform, which corresponds to an OpenNMS node.)
- Configure an "OpenNMS" alert notification action in an alert definition for a resource or (in HQ Enterprise only) a resource type.
 | HQ Open Source Issue A known problem in the open source version of HQ causes a problem with the OpenNMS tab in alert action dialogs in the HQ user interface. To avoid the issue, replace hq-engine/server/default/deploy/hq.ear/hq.war/WEB-INF/lib/hq_jsp.jar with download. |
| HQ 4.3 Issue A known problem in HQ 4.3 causes an error when the import process runs: HypericHQ outage identified on interface 10.0.0.120 with reason code: response code out of range for uri:http://10.0.0.120:7080/j_security_check.do. Expected 100-399 but received 405. To avoid this problem, make the following changes to /opt/opennms/etc/poller-configuration.xml, under HypericHQ service:
(The syntax above applies to Linux environments.) |
Implementing HQ-OpenNMS Integration
HQ-OpenNMS leverages an OpenNMS API for importing monitored elements from external systems.
Importing HQ Platforms to OpenNMS Nodes
The OpenNMS HQU plugin exposes a web service that exports Hyperic's platforms as OpenNMS nodes. To run the web service with curl, enter this command with the correct HQ username and password, and the HQ Server address and port.
The command above returns a list of HQ platforms in XML format.
 | If you use HQ Enterprise, you can enable the Guest user account to avoid using the username and password in plain text and allow OpenNMS to access the export data without passing in authentication information. |
On the OpenNMS side, configure model-importer.properties. Adjust the cron schedule for imports to your liking and add the appropriate URL. For example, this schedules a daily import of HQ platforms into OpenNMS, to occur at one second after midnight:
The full plugin can be found here.
Using an OpenNMS Action in Alert Definitions
You configure an OpenNMS alert notification action on OpenNMS action tab for the alert definition.
Configure the OpenNMS host and port. When the alert fires, HQ will send an alert notification to OpenNMS.
| In HQ Enterprise, you can use OpenNMS actions in resource type alerts, and well a resource alerts. A resource type alert definition applies to all resoures of a particular resource type. |
To customize the OpenNMS notifcation, modify hq-engine/server/default/deploy/hq.ear/alertTemplates/opennms_notify.gsp. HQ Server restart is not required.