1. Data Choices

When a user with the Admin role logs into the system for the first time, they will be prompted as to whether or not they want to opt-in to publish these statistics.
Statistics will only be published once an Administrator has opted-in.

Usage statistics can later be disabled by accessing the 'Data Choices' link in the 'Admin' menu.

When enabled, the following anonymous statistics will be collected and publish on system startup and every 24 hours after:

System ID (a randomly generated UUID)

OpenNMS Horizon Release

OpenNMS Horizon Version

OS Architecture

OS Name

OS Version

Number of Alarms in the alarms table

Number of Events in the events table

Number of IP Interfaces in the ipinterface table

Number of Nodes in the node table

Number of Nodes, grouped by System OID

2. User Management

Users are entities with login accounts in the OpenNMS Horizon system.
Ideally each user corresponds to a person.
An OpenNMS HorizonUser represents an actor which may be granted permissions in the system by associating Security Roles.
OpenNMS Horizon stores by default User information and credentials in a local embedded file based storage.
Credentials and user details, e.g. contact information, descriptions or Security Roles can be managed through the Admin Section in the Web User Interface.

Beside local Users, external LDAP service and SSO can be configured, but are not scope in this section.
The following paragraphs describe how to manage the embedded User and Security Roles in OpenNMS Horizon.

2.1. Users

Managing Users is done through the Web User Interface and requires to login as a User with administrative permissions.
By default the admin user is used to initially create and modify Users.
The User, Password and other detail descriptions are persisted in users.xml file.
It is not required to restart OpenNMS Horizon when User attributes are changed.

In case administrative tasks should be delegated to an User the Security Role named ROLE_ADMIN can be assigned.

Don’t delete the admin and rtc user.
The RTC user is used for the communication of the Real-Time Console on the start page to calculate the node and service availability.

Change the default admin password to a secure password.

How to set a new password for any user

Login as a User with administrative permissions

Choose Configure OpenNMS from the user specific main navigation which is named as your login user name

Use Add new user and type in a login name as User ID and a Password with confirmation or click Modify next to an existing User

Optional: Fill in detailed User Information to provide more context information around the new user in the system

Optional: Assign Security Roles to give or remove permissions in the system

Optional: Provide Notification Information which are used in Notification targets to send messages to the User

Optional: Set a schedule when a User should receive Notifications

Click Finish to persist and apply the changes

By default a new User has the Security Role similar to ROLE_USER assigned.
Acknowledgment and working with Alarms and Notifications is possible.
The Configure OpenNMS administration menu is not available.

How to delete existing user

Login as a User with administrative permissions

Choose Configure OpenNMS from the user specific main navigation which is named as your login user name

2.2. Security Roles

A Security Roles is a set of permissions and can be assigned to an User.
They regulate access to the Web User Interface and the ReST API to exchange monitoring and inventory information.
In case of a distributed installation, the Minion or Remote Poller instances interact with OpenNMS Horizon and require specific permissions which are defined in the Security RolesROLE_MINION and ROLE_REMOTING.
The following Security Roles are available:

Use Add and Remove to assign or remove the Security Role from the User

Click Finish to persist and apply the Changes

Logout and Login to apply the new Security Role settings

How to add custom roles

Create a file called $OPENNMS_HOME/etc/security-roles.properties.

Add a property called roles, and for its value, a comma separated list of the custom roles, for example:

roles=operator,stage

After following the procedure to associate the security roles with users, the new custom roles will be available as shown on the following image:

:imagesdir: ../../images

2.3. Web UI Pre-Authentication

It is possible to configure OpenNMS Horizon to run behind a proxy that provides authentication, and then pass the pre-authenticated user to the OpenNMS Horizon webapp using a header.

The pre-authentication configuration is defined in $OPENNMS_HOME/jetty-webapps/opennms/WEB-INF/spring-security.d/header-preauth.xml. This file is automatically included in the Spring Security context, but is not enabled by default.

DO NOT configure OpenNMS Horizon in this manner unless you are certain the web UI is only accessible to the proxy and not to end-users.
Otherwise, malicious attackers can craft queries that include the pre-authentication header and get full control of the web UI and ReST APIs.

2.3.1. Enabling Pre-Authentication

Edit the header-preauth.xml file, and set the enabled property:

<beans:property name="enabled" value="true" />

2.3.2. Configuring Pre-Authentication

There are a number of other properties that can be set to change the behavior of the pre-authentication plugin.

Property

Description

Default

enabled

Whether the pre-authentication plugin is active.

false

failOnError

If true, disallow login if the header is not set or the user does not exist. If false, fall through to other mechanisms (basic auth, form login, etc.)

false

userHeader

The HTTP header that will specify the user to authenticate as.

X-Remote-User

credentialsHeader

A comma-separated list of additional credentials (roles) the user should have.

3. Administrative Webinterface

3.1. Grafana Dashboard Box

Grafana provides an API key which gives access for 3rd party application like OpenNMS Horizon.
The Grafana Dashboard Box on the start page shows dashboards related to OpenNMS Horizon.
To filter relevant dashboards, you can use a tag for dashboards and make them accessible.
If no tag is provided all dashboards from Grafana will be shown.

The feature is by default deactivated and is configured through opennms.properties. Please note that this feature
works with the Grafana API v2.5.0.

This setting controls whether a grafana box showing the
available dashboards is placed on the landing page. The two
valid options for this are true or false.

false

org.opennms.grafanaBox.hostname

String

If the box is enabled you also need to specify hostname of
the Grafana server

localhost

org.opennms.grafanaBox.port

Integer

The port of the Grafana server ReST API

3000

org.opennms.grafanaBox.basePath

String

The Grafana base path to be used

org.opennms.grafanaBox.apiKey

String

The API key is needed for the ReST calls to work

org.opennms.grafanaBox.tag

String

When a tag is specified only dashboards with this given tag
will be displayed. When no tag is given all dashboards will
be displayed

org.opennms.grafanaBox.protocol

String

The protocol for the ReST call can also be specified

http

org.opennms.grafanaBox.connectionTimeout

Integer

Timeout in milliseconds for getting information from the
Grafana server

500

org.opennms.grafanaBox.soTimeout

Integer

Socket timeout

500

org.opennms.grafanaBox.dashboardLimit

Integer

Maximum number of entries to be displayed (0 for unlimited)

0

If you have Grafana behind a proxy it is important the org.opennms.grafanaBox.hostname is reachable.
This host name is used to generate links to the Grafana dashboards.

The process to generate an Grafana API Key can be found in the HTTP API documentation.
Copy the API Key to opennms.properties as org.opennms.grafanaBox.apiKey.

3.2. Operator Board

In a network operation center (NOC) the Ops Board can be used to visualize monitoring information.
The monitoring information for various use-cases are arranged in configurable Dashlets.
To address different user groups it is possible to create multiple Ops Boards.

Surveillance

Topology

This Dashlet shows a Topology Map.
The Topology Map can be configured with the following parameter.

Boost support

false

focusNodes

Which node(s) is in focus for the topology

provider

Which topology should be displayed, e.g. Linkd, VMware

szl

Set the zoom level for the topology

URL

This Dashlet shows the content of a web page or other web application, e.g. other monitoring systems by a given URL.

Boost support

false

password

Optional password if a basic authentication is required

url

URL to the web application or web page

username

Optional username if a basic authentication is required

3.2.3. Boosting Dashlet

The behavior to boost a Dashlet describes the behavior of a Dashlet showing critical monitoring information.
It can raise the priority in the Ops Board rotation to indicate a problem.
This behavior can be configured with the configuration parameter Boost Priority and Boost Duration.
These to configuration parameter effect the behavior on the Ops Board in rotation.

Boost Duration: Absolute duration in seconds of the Dashlet with critical monitoring information.

3.2.4. Criteria Builder

The Criteria Builder is a generic component to filter information of a Dashlet.
Some Dashlets use this component to filter the shown information on a Dashlet for certain use case.
It is possible to combine multiple Criteria to display just a subset of information in a given Dashlet.

Table 5. Generic Criteria Builder configuration possibilities

Restriction

Property

Value 1

Value 2

Description

Asc

-

-

-

ascending order

Desc

-

-

-

descending order

Between

database attribute

String

String

Subset of data between value 1 and value 2

Contains

database attribute

String

-

Select all data which contains a given text string in a given database attribute

Distinct

database attribute

-

-

Select a single instance

Eq

database attribute

String

-

Select data where attribute equals (==) a given text string

Ge

database attribute

String

-

Select data where attribute is greater equals than (>=) a given text value

Gt

database attribute

String

-

Select data where attribute is greater than (>) a given text value

Ilike

database attribute

String

-

unknown

In

database attribute

String

-

unknown

Iplike

database attribute

String

-

Select data where attribute matches an given IPLIKE expression

IsNull

database attribute

-

-

Select data where attribute is null

IsNotNull

database attribute

-

-

Select data where attribute is not null

IsNotNull

database attribute

-

-

Select data where attribute is not null

Le

database attribute

String

-

Select data where attribute is less equals than (⇐) a given text value

Lt

database attribute

String

-

Select data where attribute is less than (<) a given text value

Le

database attribute

String

-

Select data where attribute is less equals than (⇐) a given text value

Like

database attribute

String

-

Select data where attribute is like a given text value similar to SQL like

Limit

-

Integer

-

Limit the result set by a given number

Ne

database attribute

String

-

Select data where attribute is not equals (!=) a given text value

Not

database attribute

String

-

unknown difference between Ne

OrderBy

database attribute

-

-

Order the result set by a given attribute

3.3. JMX Configuration Generator

OpenNMS Horizon implements the JMX protocol to collect long term performance data for Java applications.
There are a huge variety of metrics available and administrators have to select which information should be collected.
The JMX Configuration Generator Tools is build to help generating valid complex JMX data collection configuration and RRD graph definitions for OpenNMS Horizon.

This tool is available as CLI and a web based version.

3.3.1. Web based utility

Complex JMX data collection configurations can be generated from a web based tool.
It collects all available MBean Attributes or Composite Data Attributes from a JMX enabled Java application.

The workflow of the tool is:

Connect with JMX or JMXMP against a MBean Server provided of a Java application

Retrieve all MBean and Composite Data from the application

Select specific MBeans and Composite Data objects which should be collected by OpenNMS Horizon

By clicking the arrow ( > ) the MBeans and Composite Data will be retrieved with the given connection settings.
The data is loaded into the MBeans Configuration screen which allows to select metrics for the data collection configuration.

Select MBeans and Composite

The MBeans Configuration section is used to assign the MBean and Composite Data attributes to RRD domain specific data types and data source names.

The MBean Name, Composite Alias and Name are validated against special characters.
For the Alias inputs are validated to be not longer then 19 characters and have to be unique in the data collection configuration.

Download and include configuration

The last step is generating the following configuration files for OpenNMS Horizon:

collectd-configuration.xml: Generated sample configuration assigned to a service with a matching data collection group

The content of the configuration files can be copy & pasted or can be downloaded as ZIP archive.

If the content of the configuration file exceeds 2,500 lines, the files can only be downloaded as ZIP archive.

3.3.2. CLI based utility

The command line (CLI) based tool is not installed by default.
It is available as Debian and RPM package in the official repositories.

Installation

RHEL based installation with Yum

yum install opennms-jmx-config-generator

Debian based installation with apt

apt-get install opennms-jmx-config-generator

Installation from source

It is required to have the Java 8 Development Kit with Apache Maven installed.
The mvn binary has to be in the path environment.
After cloning the repository you have to enter the source folder and compile an executable JAR.

cd opennms/features/jmx-config-generator
mvn package

Inside the newly created target folder a file named jmxconfiggenerator-<VERSION>-onejar.jar is present.
This file can be invoked by:

java -jar target/jmxconfiggenerator-21.1.0-SNAPSHOT-onejar.jar

Usage

After installing the the JMX Config Generator the tool’s wrapper script is located in the ${OPENNMS_HOME}/bin directory.

$ cd /path/to/opennms/bin
$ ./jmx-config-generator

When invoked without parameters the usage and help information is printed.

The JMX Config Generator uses sub-commands for the different configuration generation tasks.
Each of these sub-commands provide different options and parameters.
The command line tool accepts the following sub-commands.

Sub-command

Description

query

Queries a MBean Server for certain MBeans and attributes.

generate-conf

Generates a valid jmx-datacollection-config.xml file.

generate-graph

Generates a RRD graph definition file with matching graph definitions for a given jmx-datacollection-config.xml.

The following global options are available in each of the sub-commands of the tool:

Option/Argument

Description

Default

-h (--help)

Show help and usage information.

false

-v (--verbose)

Enables verbose mode for debugging purposes.

false

Sub-command: query

This sub-command is used to query a MBean Server for it’s available MBean objects.
The following example queries the server myserver with the credentials myusername/mypassword on port 7199 for MBean objects in the java.lang domain.

The following command line options are available for the query sub-command.

Option/Argument

Description

Default

<filter criteria>

A filter criteria to query the MBean Server for.
The format is <objectname>[:attribute name].
The <objectname> accepts the default JMX object name pattern to identify the MBeans to be retrieved.
If null all domains are shown.
If no key properties are specified, the domain’s MBeans are retrieved.
To execute for certain attributes, you have to add :<attribute name>.
The <attribute name> accepts regular expressions.
When multiple <filter criteria> are provided they are OR concatenated.

-

--host <host>

Hostname or IP address of the remote JMX host.

-

--ids-only

Only show the ids of the attributes.

false

--ignore <filter criteria>

Set <filter criteria> to ignore while running.

-

--include-values

Include attribute values.

false

--jmxmp

Use JMXMP and not JMX over RMI.

false

--password <password>

Password for JMX authentication.

-

--port <port>

Port of JMX service.

-

--show-domains

Only lists the available domains.

true

--show-empty

Includes MBeans, even if they do not have attributes.
Either due to the <filter criteria> or while there are none.

Sub-command: generate-conf

This sub-command can be used to generate a valid jmx-datacollection-config.xml for a given set of MBean objects queried from a MBean Server.

The following example generate a configuration file myconfig.xml for MBean objects in the java.lang domain of the server myserver on port 7199 with the credentials myusername/mypassword.
You have to define either an URL or a hostname and port to connect to a JMX server.

The option --skipDefaultVM offers the ability to ignore the MBeans provided as standard by the JVM and just create configurations for the MBeans provided by the Java Application itself.
This is particularly useful if an optimized configuration for the JVM already exists.
If the --skipDefaultVM option is not set the generated configuration will include the MBeans of the JVM and the MBeans of the Java Application.

Check the file and see if there are alias names with more than 19 characters.
This errors are marked with NAME_CRASH_AS_19_CHAR_VALUE

Sub-command: generate-graph

This sub-command generates a RRD graph definition file for a given configuration file.
The following example generates a graph definition file mygraph.properties using the configuration in file myconfig.xml.

Configuration file to use as input to generate the graph properties file

-

--output <file>

Output filename for the generated graph properties file.

-

--print-template

Prints the default template.

false

--template <file>

Template file using Apache Velocity template engine to be used to generate the graph properties.

-

-h (--help)

Show help and usage information.

false

-v (--verbose)

Enables verbose mode for debugging purposes.

false

Graph Templates

The JMX Config Generator uses a template file to generate the graphs.
It is possible to use a user-defined template.
The option --template followed by a file lets the JMX Config Generator use the external template file as base for the graph generation.
The following example illustrates how a custom template mytemplate.vm is used to generate the graph definition file mygraph.properties using the configuration in file myconfig.xml.

The JMX Config Generator generates different types of graphs from the jmx-datacollection-config.xml.
The different types are listed below:

Type

Description

AttributeReport

For each attribute of any MBean a graph will be generated.
Composite attributes will be ignored.

MbeanReport

For each MBean a combined graph with all attributes of the MBeans is generated.
Composite attributes will be ignored.

CompositeReport

For each composite attribute of every MBean a graph is generated.

CompositeAttributeReport

For each composite member of every MBean a combined graph with all composite attributes is generated.

3.4. Heatmap

The Heatmap can be either be used to display unacknowledged alarms or to display ongoing outages of nodes.
Each of this visualizations can be applied on categories, foreign sources or services of nodes.
The sizing of an entity is calculated by counting the services inside the entity.
Thus, a node with fewer services will appear in a smaller box than a node with more services.

The feature is by default deactivated and is configured through opennms.properties.

Heatmap visualizations of alarms

Table 6. Heatmap dashboard configuration properties

Name

Type

Description

Default

org.opennms.heatmap.defaultMode

String

There exist two options for using the heatmap: alarms and
outages. This option configures which are displayed per
default.

alarms

org.opennms.heatmap.defaultHeatmap

String

This option defines which Heatmap is displayed by default.
Valid options are categories, foreignSources and
monitoredServices.

categories

org.opennms.heatmap.categoryFilter

String

The following option is used to filter for categories to be
displayed in the Heatmap. This option uses the Java regular
expression syntax. The default is .* so all categories will
be displayed.

.*

org.opennms.heatmap.foreignSourceFilter

String

The following option is used to filter for foreign sources
to be displayed in the Heatmap. This option uses the Java
regular expression syntax. The default is .* so all foreign
sources will be displayed.

.*

org.opennms.heatmap.serviceFilter

String

The following option is used to filter for services to be
displayed in the Heatmap. This option uses the Java regular
expression syntax. The default is .* so all services will
be displayed.

.*

org.opennms.heatmap.onlyUnacknowledged

Boolean

This option configures whether only unacknowledged alarms
will be taken into account when generating the alarm-based
version of the Heatmap.

false

org.opennms.web.console.centerUrl

String

You can also place the Heatmap on the landing page by
setting this option to /heatmap/heatmap-box.jsp.

/surveillance-box.jsp

You can use negative lookahead expressions for excluding categories you wish not to be displayed in the heatmap,
e.g. by using an expression like ^(?!XY).* you can filter out entities with names starting with XY.

3.5. Trend

The Trend feature allows to display small inline charts of database-based statistics.
These chart are accessible in the Status menu of the OpenNMS' web application.
Furthermore it is also possible to configure these charts to be displayed on the OpenNMS' landing page.
To achieve this alter the org.opennms.web.console.centerUrl property to also include the entry /trend/trend-box.htm.

Trend chart structure

These charts can be configured and defined in the trend-configuration.xml file in your OpenNMS'etc directory.
The following sample defines a Trend chart for displaying nodes with ongoing outages.

4. Service Assurance

In OpenNMS Horizon the daemon to measures service availability and latency is done by Pollerd.
To run these tests Service Monitors are scheduled and run in parallel in a Thread Pool.
The behavior of Pollerd uses the following files for configuration and logging.
Functionalities and general concepts are described in the User Documentation of OpenNMS.
This section describes how to configure Pollerd for service assurance with all available Service Monitors coming with OpenNMS.

Enable or Disable Path Outage functionality based on a Critical Node in a network path

3

In case of unresponsive service services a serviceUnresponsive event is generated and not an outage.
It prevents to apply the Downtime Model to retest the service after 30 seconds and prevents false alarms.

Configuration changes are applied by restarting OpenNMS and Pollerd.
It is also possible to send an Event to Pollerd reloading the configuration.
An Event can be sent on the CLI or the Web User Interface.

If you define new services in poller-configuration.xml a service restart of OpenNMS is necessary.

4.2. Critical Service

The Critical Service is used to correlate outages from Services to a nodeDown or interfaceDown event.
It is a global configuration of Pollerd defined in poller-configuration.xml.
The OpenNMS default configuration enables this behavior.

Optional: In case of nodes without a Critical Service this option controls the behavior.
If set to true then all services will be polled.
If set to false then the first service in the package that exists on the node will be polled until service is restored, and then polling will resume for all services.

3

Define Critical Service for Node Outage correlation

4.3. Downtime Model

By default the monitoring interval for a service is 5 minutes.
To detect also short services outages, caused for example by automatic network rerouting, the downtime model can be used.
On a detected service outage, the interval is reduced to 30 seconds for 5 minutes.
If the service comes back within 5 minutes, a shorter outage is documented and the impact on service availability can be less than 5 minutes.
This behavior is called Downtime Model and is configurable.

Figure 11. Downtime model with resolved and ongoing outage

In figure Outages and Downtime Model there are two outages.
The first outage shows a short outage which was detected as up after 90 seconds.
The second outage is not resolved now and the monitor has not detected an available service and was not available in the first 5 minutes (10 times 30 second polling).
The scheduler changed the polling interval back to 5 minutes.

from 0 seconds after an outage is detected until 5 minutes the polling interval will be set to 30 seconds

2

after 5 minutes of an ongoing outage until 12 hours the polling interval will be set to 5 minutes

3

after 12 hours of an ongoing outage until 5 days the polling interval will be set to 10 minutes

4

after 5 days of an ongoing outage the service will be deleted from the monitoring system

4.4. Path Outages

To reduce the amount of alarms and notifications a Path Outage can be configured.
This functionality is used to suppress Notifications based on the node depending on each other in the network path.
The dependency is modeled in the Node Provisioning in Path Outage.

By default the Path Outage feature is disabled and has to be enabled in the pollerd-configuration.xml.

It requires the following information:

Parent Foreign Source: The Foreign Source where the parent node is defined.

Parent Foreign ID: The Foreign ID of the parent Node where this node depends on.

The IP Interface selected as Primary is used as Critical IP

Additionally it is possible to define generic rules for Path Outages.
For example there is a whole IP Subnet behind a Router and this Router is the Critical Path to this IP Subnet.

The configuration can be made in Admin → Configure Notifications → Configure Path Outages.
It requires to specify a Critical IP of the Router and allows to specify the IP Subnet by defining a Rule/Filter.
They are specified in Rules/Filters in the OpenNMS Wiki.
In this case, the Router with all Nodes on the IP Subnet are down, but only one Notification is sent.
All other Node Down notifications are suppressed matching the Rule/Filter defined in the Path Outage.

Figure 12. Topology for Path Outage

To configure a Path Outage based on the example in figure Topology for Path Outage, the configuration has to be defined as the following.

This example expects all Nodes are defined in the same Foreign Source named Network-ACME and the Foreign ID is the same as the Node Label.

Table 9. Provisioning for Topology Example

Parent Foreign Source

Parent Foreign ID

Provisioned Node

not defined

not defined

default-gw-01

Network-ACME

default-gw-01

node-01

Network-ACME

default-gw-01

node-02

Network-ACME

default-gw-01

default-gw02

Network-ACME

default-gw-02

node-03

Network-ACME

default-gw-02

node-04

The IP Interface which is set to Primary is selected as the Critical IP.
In this example it is important the IP interface on default-gw-01 in the network 192.168.1.0/24 is set as Primary interface.
The IP interface in the network 172.23.42.0/24 on default-gw-02 is set as Primary interface.

4.5. Poller Packages

To define more complex monitoring configuration it is possible to group Service configurations into Polling Packages.
They allow to assign to Nodes different Service Configurations.
To assign a Polling Package to nodes the Rules/Filters syntax can be used.
Each Polling Package can have its own Downtime Model configuration.

Multiple packages can be configured, and an interface can exist in more than one package.
This gives great flexibility to how the service levels will be determined for a given device.

Filter can be based on IP address, categories or asset attributes of Nodes based on Rules/Filters.
The filter is evaluated first and is required.
This package is used for all IP Interfaces which don’t have 0.0.0.0 as an assigned IP address and is required.

3

Allow to specify if the configuration of Services is applied on a range of IP Interfaces (IPv4 or IPv6).

Instead of the include-range it is possible to add one or more specific IP-Interfaces with:

Defining a specific IP Interfaces

<specific>192.168.1.59</specific>

It is also possible to exclude IP Interfaces with:

Exclude IP Interfaces

<exclude-range begin="192.168.0.100" end="192.168.0.104"/>

4.5.1. Response Time Configuration

The definition of Polling Packages allows to configure similar services with different polling intervals.
All the response time measurements are persisted in RRD Files and require a definition.
Each Polling Package contains a RRD definition

Polling interval for all services in this Polling Package is reflected in the step of size 300 seconds.
All services in this package have to polled in 5 min interval, otherwise response time measurements are not correct persisted.

The RRD configuration and the service polling interval has to be aligned.
In other cases the persisted response time data is not correct displayed in the response time graph.

If the polling interval is changed afterwards, existing RRD files needs to be recreated with the new definitions.

4.5.2. Overlapping Services

With the possibility of specifying multiple Polling Packages it is possible to use the same Service like ICMP multiple times.
The order how Polling Packages in the poller-configuration.xml are defined is important when IP Interfaces match multiple Polling Packages with the same Service configuration.

The following example shows which configuration is applied for a specific service:

The last Polling Package on the service will be applied.
This can be used to define a less specific catch all filter for a default configuration.
A more specific Polling Package can be used to overwrite the default setting.
In the example above all IP Interfaces in 192.168.1/24 or 2600:/64 will be monitored with ICMP with different polling, retry and timeout settings.

Which Polling Packages are applied to the IP Interface and Service can be found in the Web User Interface.
The IP Interface and Service page show which Polling Package and Service configuration is applied for this specific service.

Node info displayed will have nodeId, nodeLabel, location and optional fileds like foreignId, foreignSource, categories when they exist.

4.6. Service monitors

To support several specific applications and management agents, Pollerd executes Service Monitors.
This section describes all available built-in Service Monitors which are available and can be configured to allow complex monitoring.
For information how these can be extended, see Development Guide of the OpenNMS documentation.

4.6.1. Common Configuration Parameters

Application or Device specific Monitors are based on a generic API which provide common configuration parameters.
These minimal configuration parameters are available in all Monitors and describe the behavior for timeouts, retries, etc.

Table 10. Common implemented configuration parameters

Parameter

Description

Required

Default value

retry

Number of attempts to test a Service to be up or down.

optional

3

timeout

Timeout for the isReachable method, in milliseconds.

optional

3000

invert-status

Invert the up/down behavior of the monitor

optional

false

In case the Monitor is using the SNMP Protocol the default configuration for timeout and retry are used from the SNMP Configuration (snmp-config.xml).

Minion Configuration Parameters

When nodes are configured with a non-default location, the associated Service Monitors are executed on a Minion configured with that same location.
If there are many Minions at a given location, the Service Monitor may be executed on any of the Minions that are currently available.
Users can choose to execute a Service Monitor on a specific Minion, by specifying the System ID of the Minion.
This mechanism is used for monitoring the Minions individually.

The following parameters can be used to override this behavior and control where the Service Monitors are executed.

Table 11. Minion configuration parameters

Parameter

Description

Required

Default value

location

Specify the location at which the Service Monitor should be executed.

optional

(The location of the associated node)

system-id

Specify the System ID on which the Service Monitor should be executed

optional

(None)

use-foreign-id-as-system-id

Use the foreign id of the associated node as the System ID

optional

false

When specifying a System ID the location should also be set to the corresponding location for that system.

4.6.2. AvailabilityMonitor

This monitor tests reachability of a node by using the isReachable method of the InetAddress java class.
The service is considered available if isReachable returns true.
See Oracle’s documentation for more details.

This monitor is deprecated in favour of the IcmpMonitor monitor. You should only use this monitor on remote pollers
running on unusual configurations (See below for more details).

IcmpMonitor vs AvailabilityMonitor

This monitor has been developped in a time when the IcmpMonitor monitor wasn’t remote enabled, to circumvent this limitation.
Now, with the JNA ICMP implementation, the IcmpMonitor monitor is remote enabled under most configurations and this monitor shouldn’t be needed -unless you’re running your remote poller on such an unusual configuration (See also issue NMS-6735 for more information)-.

4.6.3. BgpSessionMonitor

This monitor checks if a BGP-Session to a peering partner (peer-ip) is functional.
To monitor the BGP-Session the RFC1269 SNMP MIB is used and test the status of the session using the following OIDs is used:

Replace 99.99.99.99 with your BGP-Peer IP.
The result should be an Integer between 1 and 6.

4.6.4. BSFMonitor

This monitor runs a Bean Scripting FrameworkBSF compatible script to determine the status of a service.
Users can write scripts to perform highly custom service checks.
This monitor is not optimised for scale.
It’s intended for a small number of custom checks or prototyping of monitors.

BSFMonitor vs SystemExecuteMonitor

The BSFMonitor avoids the overhead of fork(2) that is used by the SystemExecuteMonitor.
BSFMonitor also grants access to a selection of OpenNMS Horizon internal methods and classes that can be used in the script.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.BSFMonitor

Remote Enabled

false

Configuration and Usage

Table 12. Monitor specific parameters for the BSFMonitor

Parameter

Description

Required

Default value

file-name

Path to the script file.

required

-

bsf-engine

The BSF Engine to run the script in different languages likeBean Shell: bsh.util.BeanShellBSFEngineGroovy: org.codehaus.groovy.bsf.GroovyEngineJython: org.apache.bsf.engines.jython.JythonEngine

The script is expected to put its results into this object.
The status indication should be set into the entry with key status.
If the status is not OK, a key reason should contain a description of the problem.

times

LinkedHashMap<String, Number>

The script is expected to put one or more response times into this object.

Additionally every parameter added to the service definition in poller-configuration.xml is available as a String object in the script.
The key attribute of the parameter represents the name of the String object and the value attribute represents the value of the String object.

Please keep in mind, that these parameters are also accessible via the map bean.

Avoid non-character names for parameters to avoid problems in the script languages.

Response Codes

The script has to provide a status code that represents the status of the associated service.
The following status codes are defined:

Table 14. Status codes

Code

Description

OK

Service is available

UNK

Service status unknown

UNR

Service is unresponsive

NOK

Service is unavailable

Response time tracking

By default the BSFMonitor tracks the whole time the script file consumes as the response time.
If the response time should be persisted the response time add the following parameters:

RRD response time tracking for this service in poller-configuration.xml

<!-- where in the filesystem response times are stored -->
<parameter key="rrd-repository" value="/opt/opennms/share/rrd/response" />
<!-- name of the rrd file -->
<parameter key="rrd-base-name" value="minimalbshbase" />
<!-- name of the data source in the rrd file -->
<!-- by default "response-time" is used as ds-name -->
<parameter key="ds-name" value="myResponseTime" />

It is also possible to return one or many response times directly from the script.
To add custom response times or override the default one, add entries to the times object.
The entries are keyed with a String that names the datasource and have as values a number that represents the response time.
To override the default response time datasource add an entry into times named response-time.

Timeout and Retry

The BSFMonitor does not perform any timeout or retry processing on its own.
If retry and or timeout behaviour is required, it has to be implemented in the script itself.

Requirements for the script (run-types)

Depending on the run-type the script has to provide its results in different ways.
For minimal scripts with very simple logic run-typeeval is the simple option.
Scripts running in eval mode have to return a String matching one of the status codes.

If your script is more than a one-liner, run-typeexec is essentially required.
Scripts running in exec mode need not return anything, but they have to add a status entry with a status code to the results object.
Additionally, the results object can also carry a "reason":"message" entry that is used in non OK states.

Commonly used language settings

The BSF supports many languages, the following table provides the required setup for commonly used languages.

Example Jython

To use the Jython (Java implementation of Python) language an additional library is required.
Copy a compatible jython-x.y.z.jar into the opennms/lib folder and restart OpenNMS Horizon.
That makes Jython available for the BSFMonitor.

The monitor can be run in two scenarios.
The first one tests the RTT_LATEST_OPERSENSE which is a sense code for the completion status of the latest RTT operation.
If the RTT_LATEST_OPERSENSE returns ok(1) the service is marked as up.

The second scenario is to monitor the configured threshold in the IP SLA config.
If the RTT_LATEST_OPERSENSE returns with overThreshold(3) the service is marked down.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.CiscoIpSlaMonitor

Remote Enabled

false

Configuration and Usage

Table 16. Monitor-specific parameters for the CiscoIpSlaMonitor

Parameter

Description

Required

Default value

admin-tag

The tag attribute from your IP SLA configuration you want to monitor.

required

-

ignore-thresh

Boolean indicates if just the status or configured threshold should be monitored.

Example for HTTP and ICMP echo reply

In this example we configure an IP SLA entry to monitor Google’s website with HTTP GET from the Cisco device.
We use 8.8.8.8 as our DNS resolver.
In our example our SLA says we should reach Google’s website within 200ms.
To advise co-workers that this monitor entry is used for monitoring, I set the owner to OpenNMS.
The tag is used to identify the entry later in the SNMP table for monitoring.

In the second example we configure a IP SLA to test if the IP address from www.opennms.org is reachable with ICMP from the perspective of the Cisco device.
Like the example above we have a threshold and a timeout.

It´s not possible to reconfigure an IP SLA entry.
If you want to change parameters, you have to delete the whole configuration and reconfigure it with your new parameters.
Backup your Cisco configuration manually or take a look at RANCID.

To monitor both of the entries the configuration in poller-configuration.xml requires two service definition entries:

4.6.6. CiscoPingMibMonitor

This poller monitor’s purpose is to create conceptual rows (entries) in the ciscoPingTable on Cisco IOS devices that support the CISCO-PING-MIB.
These entries direct the remote IOS device to ping an IPv4 or IPv6 address with a configurable set of parameters.
After the IOS device has completed the requested ping operations, the poller monitor queries the IOS device to determine the results.
If the results indicate success according to the configured parameters in the service configuration, then the monitored service is reported as available and the results are available for optional time-series (RRD) storage.
If the results indicate failure, the monitored service is reported unavailable with a descriptive reason code.
If something goes wrong during the setup of the entry or the subsequent querying of its status, the monitored service is reported to be in an unknown state.

Unlike most poller monitors, the CiscoPingMibMonitor does not interpret the timeout and retries parameters to determine when a poll attempt has timed out or whether it should be attempted again.
The packet-count and packet-timeout parameters instead service this purpose from the perspective of the remote IOS device.

Prerequisites

One or more Cisco devices running an IOS image of recent vintage; any 12.2 or later image is probably fine.
Even very low-end devices appear to support the CISCO-PING-MIB.

The IOS devices that will perform the remote pings must be configured with an SNMP write community string whose source address access-list includes the address of the OpenNMS Horizon server and whose MIB view (if any) includes the OID of the ciscoPingTable.

The corresponding SNMP write community string must be specified in the write-community attribute of either the top-level <snmp-config> element of snmp-config.xml or a <definition> child element that applies to the SNMP-primary interface of the IOS device(s) that will perform the remote pings.

Scalability concerns

This monitor spends a fair amount of time sleeping while it waits for the remote IOS device to complete the requested ping operations.
The monitor is pessimistic in calculating the delay between creation of the ciscoPingTable entry and its first attempt to retrieve the results of that entry’s ping operations — it will always wait at least (packet-count * (packet-timeout + packet-delay)) milliseconds before even checking whether the remote pings have completed.
It’s therefore prone to hogging poller threads if used with large values for the packet-count, packet-timeout, and/or packet-delay parameters.
Keep these values as small as practical to avoid tying up poller threads unnecessarily.

This monitor always uses the current time in whole seconds since the UNIX epoch as the instance identifier of the ciscoPingTable entries that it creates.
The object that holds this identifier is a signed 32-bit integer type, precluding a finer resolution.
It’s probably a good idea to mix in the least-significant byte of the millisecond-accurate time as a substitute for that of the whole-second-accurate value to avoid collisions.
IOS seems to clean up entries in this table within a manner of minutes after their ping operations have completed.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.CiscoPingMibMonitor

Remote Enabled

false

Configuration and Usage

Table 17. Monitor specific parameters for the CiscoPingMibMonitor

Parameter

Description

Required

Default value

version

SNMP protocol version (1, 2c, or 3) to use for operations performed by this service
monitor. Do not use with out a very good reason to do so.

optional

from snmp-config.xml

packet-count

Number of ping packets that the remote IOS device should send.

optional

5

packet-size

Size, in bytes, of each ping packet that the remote IOS device should send.

optional

100

packet-timeout

Timeout, in milliseconds, of each ping packet sent by the remote IOS device.

optional

2000

packet-delay

Delay, in milliseconds, between ping packets sent by the remote IOS device.

optional

0

entry-owner

String value to set as the value of ciscoPingEntryOwner of entries created for this
service.

optional

OpenNMS CiscoPingMibMonitor

vrf-name

String value to set as the VRF (VLAN) name in whose context the remote IOS device
should perform the pings for this service.

optional

empty String

proxy-node-id

Numeric database identifier of the node whose primary SNMP interface should be used
as the proxy for this service. If specified along with the related
proxy-node-foreign-source, proxy-node-foreign-id, and/or proxy-ip-addr, this
parameter will be the effective one.

optional

-

proxy-node-foreign-sourceproxy-node-foreign-id

foreign-source name and foreign-ID of the node whose primary SNMP interface
should be used as the "proxy" for this service. These two parameters are corequisites.
If they appear along with the related proxy-ip-addr, these parameters will be the
effective ones.

optional

-

proxy-ip-addr

IP address of the interface that should be used as the proxy for this service.
Effective only if none of proxy-node-id, proxy-node-foreign-source, nor
proxy-node-foreign-id appears alongside this parameter. A value of ${ipaddr} will
be substituted with the IP address of the interface on which the monitored service
appears.

optional

-

target-ip-addr

IP address that the remote IOS device should ping. A value of ${ipaddr} will be
substituted with the IP address of the interface on which the monitored service
appears.

optional

-

success-percent

A whole-number percentage of pings that must succeed (from the perspective of the
remote IOS device) in order for this service to be considered available. As an
example, if packet-count is left at its default value of 5 but you wish the
service to be considered available even if only one of those five pings is successful,
then set this parameter’s value to 20.

optional

100

rrd-repository

Base directory of an RRD repository in which to store this service monitor’s
response-time samples

optional

-

ds-name

Name of the RRD datasource (DS) name in which to store this service monitor’s
response-time samples; rrd-base-name Base name of the RRD file (minus the .rrd or
.jrb file extension) within the specified rrd-repository path in which this service
monitor’s response-time samples will be persisted

This value will be substituted with the IP address of the interface on which the monitored service
appears.

Example: Ping the same non-routable address from all routers of customer Foo

A service provider’s client, Foo Corporation, has network service at multiple locations.
At each Foo location, a point-of-sale system is statically configured at IPv4 address 192.168.255.1.
Foo wants to be notified any time a point-of-sale system becomes unreachable.
Using an OpenNMS Horizon remote location monitor is not feasible.
All of Foo Corporation’s CPE routers must be Cisco IOS devices in order to achieve full coverage in this scenario.

One approach to this requirement is to configure all of Foo Corporation’s premise routers to be in the surveillance categories Customer_Foo, CPE, and Routers, and to use a filter to create a poller package that applies only to those routers.
We will use the special value ${ipaddr} for the proxy-ip-addr parameter so that the remote pings will be provisioned on each Foo CPE router.
Since we want each Foo CPE router to ping the same IP address 192.168.255.1, we statically list that value for the target-ip-addr address.

Example: Ping from a single IOS device routable address of each router of customer Bar

A service provider’s client, Bar Limited, has network service at multiple locations.
While OpenNMS Horizon' world-class service assurance is generally sufficient, Bar also wants to be notified any time a premise router at one of their locations unreachable from the perspective of an IOS device in Bar’s main data center.
Some or all of the Bar Limited CPE routers may be non-Cisco devices in this scenario.

To meet this requirement, our approach is to configure Bar Limited’s premise routers to be in the surveillance categories Customer_Bar, CPE, and Routers, and to use a filter to create a poller package that applies only to those routers.
This time, though, we will use the special value ${ipaddr} not in the proxy-ip-addr parameter but in the target-ip-addr parameter so that the remote pings will be performed for each Bar CPE router.
Since we want the same IOS device 20.11.5.11 to ping the CPE routers, we statically list that value for the proxy-ip-addr address.
Example poller-configuration.xml additions

4.6.7. CitrixMonitor

This monitor is used to test if a Citrix® Server or XenApp Server® is providing the Independent Computing Architecture (ICA) protocol on TCP 1494.
The monitor opens a TCP socket and tests the greeting banner returns with ICA, otherwise the service is unavailable.

If you have configure the Metaframe Presentation Server Client using Session Reliability, the TCP port is 2598 instead of 1494.
You can find additional information on CTX104147.
It is not verified if the monitor works in this case.

Examples

The following example configures OpenNMS Horizon to monitor the ICA protocol on TCP 1494 with 2 retries and waiting 5 seconds for each retry.

4.6.8. DhcpMonitor

This monitor is used to monitor the availability and functionality of DHCP servers.
This monitor has two parts, the first one is the monitor class DhcpMonitor executed by Pollerd and the second part is a background daemon Dhcpd running inside the OpenNMS Horizon JVM and listening for DHCP responses.
A DHCP server is tested by sending a DISCOVER message.
If the DHCP server responds with an OFFER the service is marked as up.
The Dhcpd background daemon is disabled by default and has to be activated in service-configuration.xml in OpenNMS Horizon by setting service enabled="true".
The behavior for testing the DHCP server can be modified in the dhcp-configuration.xml configuration file.

It is required to install the opennms-plugin-protocol-dhcp before you can use this feature.

If you try to start OpenNMS Horizon without the opennms-plugin-protocol-dhcp you will see the following error message in output.log:

An error occurred while attempting to start the "OpenNMS:Name=Dhcpd" service (class org.opennms.netmgt.dhcpd.jmx.Dhcpd). Shutting down and exiting.
java.lang.ClassNotFoundException: org.opennms.netmgt.dhcpd.jmx.Dhcpd

Make sure no DHCP client is running on the OpenNMS Horizon server and using port UDP/68.
If UDP/68 is already in use, you will find an error message in the manager.log.
You can test if a process is listening on udp/68 with sudo ss -lnpu sport = :68.

This parameter will usually be set to the IP address of the OpenNMS Horizon server,
which puts the DHCP poller in relay mode as opposed to broadcast mode.
In relay mode, the DHCP server being polled will unicast its responses directly
back to the IP address specified by myIpAddress rather than broadcasting its
responses. This allows DHCP servers to be polled even though they are not on the
same subnet as the OpenNMS Horizon server, and without the aid of an external relay.
Usage:myIpAddress="10.11.12.13" or myIpAddress="broadcast"

required

broadcast

extendedMode

When extendedMode is false, the DHCP poller will send a DISCOVER and expect an
OFFER in return. When extendedMode is true, the DHCP poller will first send a
DISCOVER. If no valid response is received it will send an INFORM. If no valid
response is received it will then send a REQUEST. OFFER, ACK, and NAK are all
considered valid responses in extendedMode.
Usage:extendedMode="true" or extendedMode="false"

required

false

requestIpAddress

This parameter only applies to REQUEST queries sent to the DHCP server when
extendedMode is true. If an IP address is specified, that IP address will be
requested in the query. If targetHost is specified, the DHCP server’s own IP
address will be requested. Since a well-managed server will probably not respond
to a request for its own IP, this parameter can also be set to targetSubnet.
This is similar to targetHost except the DHCP server’s IP address is
incremented or decremented by 1 to obtain an ip address that is on the same
subnet.
(The resulting address will not be on the same subnet if the DHCP server’s
subnet is a /32 or /31. Otherwise, the algorithm used should be reliable.)
Usage:requestIpAddress="10.77.88.99" or requestIpAddress="targetHost"
or requestIpAddress="targetSubnet"

required

false

Figure 14. Visualization of DHCP message flow in broadcast mode

Figure 15. Visualization of DHCP message flow in relay mode

Example testing DHCP server in the same subnet

Example configuration how to configure the monitor in the poller-configuration.xml.
The monitor will try to send in maximum 3 DISCOVER messages and waits 3 seconds for the DHCP server OFFER message.

If in extendedMode, the time required to complete the poll for an unresponsive node is increased by a factor of 3.
Thus it is a good idea to limit the number of retries to a small number.

4.6.9. DiskUsageMonitor

The DiskUsageMonitor monitor can be used to test the amount of free space available on certain storages of a node.
The monitor gets information about the available free storage spaces available by inspecting the hrStorageTable of the HOST-RESOURCES-MIB.
A storage’s description (as found in the corresponding hrStorageDescr object) must match the criteria specified by the disk and match-type parameters to be monitored.
A storage’s available free space is calculated using the corresponding hrStorageSize and hrStorageUsed objects.

The hrStorageUsed doesn’t account for filesystem reserved blocks (i.e. for the super-user), so DiskUsageMonitor will report the service as
unavailable only when the amount of free disk space is actually lower than free minus the percentage of reserved filesystem blocks.

This monitor uses SNMP to accomplish its work.
Therefore systems against which it is to be used must have an SNMP agent supporting the HOST-RESOURCES-MIB installed and configured.
Most modern SNMP agents, including most distributions of the Net-SNMP agent and the SNMP service that ships with Microsoft Windows, support this MIB.
Out-of-box support for HOST-RESOURCES-MIB among commercial Unix operating systems may be somewhat spotty.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.DiskUsageMonitor

Remote Enabled

false, relies on SNMP configuration.

Configuration and Usage

Table 22. Monitor specific parameters for the DiskUsageMonitor

Parameter

Description

Required

Default value

disk

A pattern that a storage’s description (hrStorageDescr) must match to be taken into account.

required

-

free

The minimum amount of free space that storages matching the criteria must have available.
This parameter is evaluated as a percent of the storage’s reported maximum capacity.

optional

15

match-type

The way how the pattern specified by the disk parameter must be compared to storages description
Must be one of the following symbolic operators:endswith : The disk parameter’s value is evaluated as a string that storages' description
must end with;exact : The disk parameter’s value is evaluated as a string that storages" description
must exactly match;regex : The disk parameter’s value is evaluated as a regular expression that storages'
description must match;startswith : The disk parameter’s value is evaluated as a string that storages' description
must start with.
Note: Comparisons are case-sensitive

optional

exact

port

Destination port where the SNMP requests shall be sent.

optional

from snmp-config.xml

retries

Deprecated.
Same as retry.
Parameter retry takes precedence when both are set.

DiskUsageMonitor vs thresholds

Storages' available free space can also be monitored using thresholds if you are already collecting these data.

4.6.10. DnsMonitor

This monitor is build to test the availability of the DNS service on remote IP interfaces.
The monitor tests the service availability by sending a DNS query for A resource record types against the DNS server to test.

The monitor is marked as up if the DNS Server is able to send a valid response to the monitor.
For multiple records it is possible to test if the number of responses are within a given boundary.

TIP:
This monitor is intended for testing the availability of a DNS service.
If you want to monitor the DNS resolution of some of your nodes from a client’s perspective, please use the DNSResolutionMonitor.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.DnsMonitor

Remote Enabled

true

Configuration and Usage

Table 23. Monitor specific parameters for the DnsMonitor

Parameter

Description

Required

Default value

retry

Number of retries before the service is marked as down

optional

0

timeout

Time in milliseconds to wait for the A Record response from the server

optional

5000

port

UDP Port for the DNS server

optional

53

lookup

DNS A Record for lookup test

optional

localhost

fatal-response-codes

A comma-separated list of numeric DNS response codes that will be considered fatal if
present in the server’s response. Default value is 2 corresponds to Server Failed. A
list of codes and their meanings is found in RFC 2929

optional

2

min-answers

Minmal number of records in the DNS server respone for the given lookup

optional

-

max-answers

Maximal number of records in the DNS server respone for the given lookup

Examples

The given examples shows how to monitor if the IP interface from a given DNS server resolves a DNS request.
This service should be bound to a DNS server which should be able to give a valid DNS respone for DNS request www.google.com.
The service is up if the DNS server gives between 1 and 10A record responses.

Example configuration monitoring DNS request for a given server for www.google.com

4.6.11. DNSResolutionMonitor

The DNS resolution monitor, tests if the node label of an OpenNMS Horizon node can be resolved.
This monitor uses the name resolver configuration from the poller configuration or from the operating system where OpenNMS Horizon is running on.
It can be used to test a client behavior for a given host name.
For example: Create a node with the node label www.google.com and an IP interface.
Assigning the DNS resolution monitor on the IP interface will test if www.google.com can be resolved using the DNS configuration defined by the poller.
The response from the A record lookup can be any address, it is not verified with the IP address on the OpenNMS Horizon IP interface where the monitor is assigned to.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.DNSResolutionMonitor

Remote Enabled

true

Configuration and Usage

Table 24. Monitor specific parameters for the DNSResolutionMonitor

Parameter

Description

Required

Default value

resolution-type

Type of record for the node label test.
Allowed valuesv4 for A records,v6 for AAAA record,bothA and AAAA record must be available,eitherA or AAAA record must be available.

To have response time graphs for the name resolution you have to configure RRD graphs for the given ds-names (dns-res-v4, dns-res-v6, dns-res-both, dns-res-either, dns-res-cname-mx) in '$OPENNMS_HOME/etc/response-graph.properties'.

DNSResolutionMonitor vs DnsMonitor

The DNSResolutionMonitor is used to measure the availability and record outages of a name resolution from client perspective.
The service is mainly used for websites or similar public available resources.
It can be used in combination with the Page Sequence Monitor to give a hint if a website isn’t available for DNS reasons.

The DnsMonitor on the other hand is a test against a specific DNS server.
In OpenNMS Horizon the DNS server is the node and the DnsMonitor will send a lookup request for a given A record to the DNS server IP address.
The service goes down if the DNS server doesn’t have a valid A record in his zone database or as some other issues resolving A records.

4.6.12. FtpMonitor

The FtpMonitor is able to validate ftp connection dial-up processes.
The monitor can test ftp server on multiple ports and specific login data.

The service using the FtpMonitor is up if the FTP server responds with return codes between 200 and 299.
For special cases the service is also marked as up for 425 and 530.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.FtpMonitor

Remote Enabled

true

Configuration and Usage

Table 25. Monitor specific parameters for the FtpMonitor.

Parameter

Description

Required

Default value

retry

Number of attempts to get a valid FTP response/response-text

optional

0

port

A list of TCP ports to which connection shall be tried.

optional

20,21

password

This parameter is meant to be used together with the user parameter to perform basic
authentication. This parameter specify to password to be used. The user and password
parameters are ignored when the basic-authentication parameter is defined.

optional

empty string

userid

This parameter is meant to be used together with the password parameter to perform
basic authentication. This parameter specify to user ID to be used. The userid and
password parameters are ignored when the basic-authentication parameter is defined.

Hint

Comment from FtpMonitor source

Also want to accept the following ERROR message generated by some FTP servers following a QUIT command without a previous successful login:
"530 QUIT : User not logged in. Please login with USER and PASS first."

Also want to accept the following ERROR message generated by some FTP servers following a QUIT command without a previously successful login:
"425 Session is disconnected."

4.6.13. HostResourceSwRunMonitor

This monitor test the running state of one or more processes.
It does this via SNMP by inspecting the hrSwRunTable of the HOST-RESOURCES-MIB.
The test is done by matching a given process as hrSwRunName against the numeric value of the hrSwRunState.

This monitor uses SNMP to accomplish its work.
Therefore systems against which it is to be used must have an SNMP agent installed and configured.
Furthermore, the SNMP agent on the system must support the HOST-RESOURCES-MIB.
Most modern SNMP agents, including most distributions of the Net-SNMP agent and the SNMP service that ships with Microsoft Windows, support this MIB.
Out-of-box support for HOST-RESOURCES-MIB among commercial Unix operating systems may be somewhat spotty.

The name of the process to be monitored. This parameter’s value is case-sensitive and is
evaluated as an exact match.

required

-

match-all

If the process name appears multiple times in the hrSwRunTable, and this parameter is set to
true, then all instances of the named process must match the value specified for
run-level.

optional

false

run-level

The maximum allowable value of hrSWRunStatus amongrunning(1),runnable(2) = waiting for resourcenotRunnable(3) = loaded but waiting for eventinvalid(4) = not loaded

optional

2

service-name-oid

The numeric object identifier (OID) from which process names are queried. Defaults to
hrSwRunName and should never be changed under normal
circumstances. That said, changing it to hrSwRunParameters (.1.3.6.1.2.1.25.4.2.1.5) is
often helpful when dealing with processes running under Java Virtual Machines which all have
the same process name java.

optional

.1.3.6.1.2.1.25.4.2.1.2

service-status-oid

The numeric object identifier (OID) from which run status is queried. Defaults to
hrSwRunStatus and should never be changed under normal circumstances.

Test the state if the process is in a valid state, i.e. have a run-level no higher than notRunnable(3)

3

If the httpd process runs multiple times the test is done for each instance of the process.

4.6.14. HttpMonitor

The HTTP monitor tests the response of an HTTP server on a specific HTTP 'GET' command.
During the poll, an attempt is made to connect on the specified port(s).
The monitor can test web server on multiple ports.
By default the a test is made against port 80, 8080 and 8888.
If the connection request is successful, an HTTP 'GET' command is sent to the interface.
The response is parsed and a return code extracted and verified.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.HttpMonitor

Remote Enabled

true

Configuration and Usage

Table 27. Monitor specific parameters for the HttpMonitor

Parameter

Description

Required

Default value

basic-authentication

Authentication credentials to perform basic authentication.
Credentials should comply to RFC1945 section
11.1, without the Base64 encoding part. That’s: be a string made of the concatenation of:
1- the user ID;
2- a colon;
3- the password.basic-authentication takes precedence over the user and password parameters.

optional

-

header[0-9]+

Additional headers to be sent along with the request.
Example of valid parameter’s names areheader0, header1 and header180. header is not a valid parameter name.

optional

-

host-name

Specify the Host header’s value.

optional

-

nodelabel-host-name

If the host-name parameter isn’t set and the resolve-ip parameter is set to false,
then OpenNMS Horizon will use the node’s label to set the Host header’s value if
this parameter is set to true. Otherwise, OpenNMS Horizon will fall back using
the node interface’s IP address as Host header value.

optional

false

password

This parameter is meant to be used together with the user parameter to perform basic
authentication. This parameter specify to password to be used. The user and password
parameters are ignored when the basic-authentication parameter is defined.

optional

empty string

port

A list of TCP ports to which connection shall be tried.

optional

80,8080,8888

retry

Number of attempts to get a valid HTTP response/response-text

optional

0

resolve-ip

If the host-name parameter isn’t set and this parameter is set to true,
OpenNMS Horizon will use DNS to resolve the node interface’s IP address, and use
the result to set the Host header’s value. When set to false and the host-name
parameter isn’t set, OpenNMS Horizon will try to use the nodelabel-host-name
parameter to set the Host header’s value.

If the url parameter is set to /, the default
value for this parameter is 100-499, otherwise it’s 100-399.

response-text

Text to look for in the response body. This will be matched against every line, and it will
be considered a success at the first match. If there is a ~ at the beginning of the
parameter, the rest of the string will be used as a regular expression pattern match,
otherwise the match will be a substring match. The regular expression match is anchored at
the beginning and end of the line, so you will likely need to put a .* on both sides of
your pattern unless you are going to be matching on the entire line.

optional

-

url

URL to be retrieved via the HTTP 'GET' command

optional

/

user

This parameter is meant to be used together with the password parameter to perform
basic authentication. This parameter specify to user ID to be used. The user and
password parameters are ignored when the basic-authentication parameter is defined.

optional

-

user-agent

Allows you to set the User-Agent HTTP header (see also
RFC2616 section 14.43).

optional

OpenNMS HttpMonitor

verbose

When set to true, full communication between client and the webserver will be logged
(with a log level of DEBUG).

4.6.16. HttpsMonitor

The HTTPS monitor tests the response of an SSL-enabled HTTP server.
The HTTPS monitor is an SSL-enabled extension of the HTTP monitor with a default TCP port value of 443.
All HttpMonitor parameters apply, so please refer to HttpMonitor’s documentation for more information.

4.6.17. IcmpMonitor

The ICMP monitor tests for ICMP service availability by sending echo request ICMP messages.
The service is considered available when the node sends back an echo reply ICMP message within the specified amount of time.

Note on Remote Poller

The IcmpMonitor needs the JNA ICMP implementation to function on remote poller.
Though, corner cases exist where the IcmpMonitor monitor won’t work on remote poller.
Examples of such corner cases are: Windows when the remote poller isn’t running has administrator, and Linux on ARM / Rasperry Pi.
JNA is the default ICMP implementation used in the remote poller.

4.6.18. ImapMonitor

This monitor checks if an IMAP server is functional.
The test is done by initializing a very simple IMAP conversation.
The ImapMonitor establishes a TCP connection, sends a logout command and test the IMAP server responses.

4.6.19. ImapsMonitor

The IMAPS monitor tests the response of an SSL-enabledIMAP server.
The IMAPS monitor is an SSL-enabled extension of the IMAP monitor with a default TCP port value of 993.
All ImapMonitor parameters apply, so please refer to ImapMonitor’s documentation for more information.

4.6.20. JCifsMonitor

This monitor allows to test a file sharing service based on the CIFS/SMB protocol.

This monitor is not installed by default.
You have to install opennmms-plugin-protocol-cifs from your OpenNMS Horizon installation repository.

With the JCIFS monitor you have different possibilities to test the availability of the JCIFS service:

With the JCifsMonitor it is possible to run tests for the following use cases:

share is available in the network

a given file exists in the share

a given folder exists in the share

a given folder should contain at least one (1) file

a given folder folder should contain no (0) files

by testing on files and folders, you can use a regular expression to ignore specific file and folder names from the test

A network resource in SMB like a file or folder is addressed as a UNC Path.

\\server\share\folder\file.txt

The Java implementation jCIFS, which implements the CIFS/SMB network protocol, uses SMB URLs to access the network resource.
The same resource as in our example would look like this as an SMB URL:

smb://workgroup;user:password@server/share/folder/file.txt

The JCifsMonitor can not test:

file contains specific content

a specific number of files in a folder, for example folder should contain exactly / more or less than x files

Age or modification time stamps of files or folders

Permissions or other attributes of files or folders

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.JCifsMonitor

Remote Enabled

false

Configuration and Usage

Table 33. Monitor specific parameters for the JCifsMonitor

Parameter

Description

Required

Default value

retry

Number of retries before the service is marked as down.

optional

0

domain

Windows domain where the user is located. You don’t have to use the domain parameter if you use
local user accounts.

optional

empty String

username

Username to access the resource over a network

optional

empty String

password

Password for the user

optional

empty String

path

Path to the resource you want to test

required

empty String

mode

The test mode which has the following optionspath_exist: Service is up if the resource is accessiblepath_not_exist: Service is up if the resource is not accessiblefolder_empty: Service is up if the folder is empty (0 files)folder_not_empty: Service is up if the folder has at least one file

optional

path_exist

smbHost

Override the IP address of the SMB url to check shares on different file servers.

optional

empty String

folderIgnoreFiles

Ignore specific files in folder with regular expression. This parameter will just be applied on
folder_empty and folder_not_empty, otherwise it will be ignored.

It makes little sense to have retries higher than 1.
It is a waste of resources during the monitoring.

Please consider, if you are accessing shares with Mac OSX you have some side effects with the hidden file '.DS_Store.'
It could give you false positives in monitoring, you can use then the folderIgnoreFiles parameter.

Example test existence of a file

This example shows how to configure the JCifsMonitor to test if a file share is available over a network.
For this example we have access to a share for error logs and we want to get an outage if we have any error log files in our folder.
The share is named log.
The service should go back to normal if the error log file is deleted and the folder is empty.

4.6.21. JDBCMonitor

The JDBCMonitor checks that it is able to connect to a database and checks if it is able to get the database catalog from that database management system (DBMS).
It is based on the JDBC technology to connect and communicate with the database.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.JDBCMonitor

Remote Enabled

true

Configuration and Usage

Table 34. Monitor specific parameters for the JDBCMonitor

Parameter

Description

Required

Default value

driver

JDBC driver class to use

required

com.sybase.jdbc2.jdbc.SybDriver

url

JDBC Url to connect to.

required

jdbc:sybase:Tds:OPENNMS_JDBC_HOSTNAME/tempdb

user

Database user

required

sa

password

Database password

required

empty string

retries

How many retries should be performed before failing the test

optional

0

The OPENNMS_JDBC_HOSTNAME is replaced in the url parameter with the IP or resolved hostname of the interface the monitored service is assigned to.

Provide the database driver

The JDBCMonitor is based on JDBC and requires a JDBC driver to communicate with any database.
Due to the fact that OpenNMS Horizon itself uses a PostgreSQL database, the PostgreSQL JDBC driver is available out of the box.
For all other database systems a compatible JDBC driver has to be provided to OpenNMS Horizon as a jar-file.
To provide a JDBC driver place the driver-jar in the opennms/lib folder of your OpenNMS Horizon.
To use the JDBCMonitor from a remote poller, the driver-jar has to be provided to the Remote Poller too.
This may be tricky or impossible when using the Java Webstart Remote Poller, because of code signing requirements.

Examples

The following example checks if the PostgreSQL database used by OpenNMS Horizon is available.

4.6.22. JDBCStoredProcedureMonitor

The JDBCStoredProcedureMonitor checks the result of a stored procedure in a remote database.
The result of the stored procedure has to be a boolean value (representing true or false).
The service associated with this monitor is marked as up if the stored procedure returns true and it is marked as down in all other cases.
It is based on the JDBC technology to connect and communicate with the database.

Provide the database driver

The JDBCStoredProcedureMonitor is based on JDBC and requires a JDBC driver to communicate with any database.
Due to the fact that OpenNMS Horizon itself uses a PostgreSQL database, the PostgreSQL JDBC driver is available out of the box.
For all other database systems a compatible JDBC driver has to be provided to OpenNMS Horizon as a jar-file.
To provide a JDBC driver place the driver-jar in the opennms/lib folder of your OpenNMS Horizon.
To use the JDBCStoredProcedureMonitor from a remote poller, the driver-jar has to be provided to the Remote Poller too.
This may be tricky or impossible when using the Java Webstart Remote Poller, because of code signing requirements.

Examples

The following example checks a stored procedure added to the PostgreSQL database used by OpenNMS Horizon.
The stored procedure returns true as long as less than 250000 events are in the events table of OpenNMS Horizon.

4.6.23. JDBCQueryMonitor

The JDBCQueryMonitor runs an SQL query against a database and is able to verify the result of the query.
A read-only connection is used to run the SQL query, so the data in the database is not altered.
It is based on the JDBC technology to connect and communicate with the database.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.JDBCQueryMonitor

Remote Enabled

false

Configuration and Usage

Table 36. Monitor specific parameters for the JDBCQueryMonitor

Parameter

Description

Required

Default value

driver

JDBC driver class to use

required

com.sybase.jdbc2.jdbc.SybDriver

url

JDBC URL to connect to.

required

jdbc:sybase:Tds:OPENNMS_JDBC_HOSTNAME/tempdb

user

Database user

required

sa

password

Database password

required

empty string

query

The SQL query to run

required

-

action

What evaluation action to perform

required

row_count

column

The result column to evaluate against

required

-

operator

Operator to use for the evaluation

required

>=

operand

The operand to compare against the SQL query result

required

depends on the action

message

The message to use if the service is down.
Both operands and the operator are added to the message too.

optional

generic message depending on the action

retries

How many retries should be performed before failing the test

optional

0

The OPENNMS_JDBC_HOSTNAME is replaced in the url parameter with the IP or resolved hostname of the interface the monitored service is assigned to.

The number of returned rows is compared, not a value of the resulting rows

1

compare_string

Strings are always checked for equality with the operand

-

compare_int

An integer from a column of the first result row is compared

1

Table 38. Available operand parameters

Parameter

XML entity to use in XML configs

=

=

<

&lt;

>

&gt;

!=

!=

⇐

&lt;=

>=

&gt;=

Evaluating the action - operator - operand

Only the first result row returned by the SQL query is evaluated.
The evaluation can be against the value of one column or the number of rows returned by the SQL query.

Provide the database driver

The JDBCQueryMonitor is based on JDBC and requires a JDBC driver to communicate with any database.
Due to the fact that OpenNMS Horizon itself uses a PostgreSQL database, the PostgreSQL JDBC driver is available out of the box.
For all other database systems a compatible JDBC driver has to be provided to OpenNMS Horizon as a jar-file.
To provide a JDBC driver place the driver-jar in the opennms/lib folder of your OpenNMS Horizon.
To use the JDBCQueryMonitor from a remote poller, the driver-jar has to be provided to the Remote Poller too.
This may be tricky or impossible when using the Java Webstart Remote Poller, because of code signing requirements.

Examples

The following example checks if the number of events in the OpenNMS Horizon database is fewer than 250000.

4.6.25. JolokiaBeanMonitor

The JolokiaBeanMonitor is a JMX monitor specialized for the use with the Jolokia framework.
If it is required to execute a method via JMX or poll an attribute via JMX, the JolokiaBeanMonitor can be used.
It requires a fully installed and configured Jolokia agent to be deployed in the JVM container.
If required it allows attribute names, paths, and method parameters to be provided additional arguments to the call.
To determine the status of the service the JolokiaBeanMonitor relies on the output to be matched against a banner.
If the banner is part of the output the status is interpreted as up.
If the banner is not available in the output the status is determined as down.
Banner matching supports regular expression and substring match.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.JolokiaBeanMonitor

Remote Enabled

false

Configuration and Usage

Table 40. Monitor specific parameters for the JolokiaBeanMonitor

Parameter

Description

Required

Default value

beanname

The bean name to query against.

required

-

attrname

The name of the JMX attribute to scrape.

optional (attrname or methodname must be set)

-

attrpath

The attribute path.

optional

-

auth-username

The username to use for HTTP BASIC auth.

optional

-

auth-password

The password to use for HTTP BASIC auth.

optional

-

banner

A string that is match against the output of the system-call. If the output contains the banner,
the service is determined as up. Specify a regex by starting with ~.

optional

-

input1

Method input

optional

-

input2

Method input

optional

-

methodname

The name of the bean method to execute, output will be compared to banner.

AttrName vs MethodName

The JolokiaBeanMonitor has two modes of operation. It can either scrape an attribute from a bean, or execute a method and compare output to a banner. The method execute is useful when your application has it’s own test methods that you would like to trigger via OpenNMS Horizon.

The args to execute a test method called "superTest" that take in a string as input would look like this:

4.6.26. LdapMonitor

The LDAP monitor tests for LDAP service availability.
The LDAP monitor first tries to establish a TCP connection on the specified port.
Then, if it succeeds, it will attempt to establish an LDAP connection and do a simple search.
If the search returns a result within the specified timeout and attempts, the service will be considered available.
The scope of the LDAP search is limited to the immediate subordinates of the base object.
The LDAP search is anonymous by default.
The LDAP monitor makes use of the com.novell.ldap.LDAPConnection class.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.LdapMonitor

Remote Enabled

true

Configuration and Usage

Table 42. Monitor specific parameters for the LdapMonitor

Parameter

Description

Required

Default value

dn

The distinguished name to use if authenticated search is needed.

optional

-

password

The password to use if authenticated search is needed.

optional

-

port

The destination port where connection shall be attempted.

optional

389

retry

Number of attempts to get a search result.

optional

1

searchbase

The base distinguished name to search from.

optional

base

searchfilter

The LDAP search’s filter.

optional

(objectclass=*)

version

The version of the LDAP protocol to use, specified as an integer.
Note: Only LDAPv3 is supported at the moment.

4.6.27. LdapsMonitor

The LDAPS monitor tests the response of an SSL-enabled LDAP server.
The LDAPS monitor is an SSL-enabled extension of the LDAP monitor with a default TCP port value of 636.
All LdapMonitor parameters apply, so please refer to LdapMonitor’s documentation for more information.

4.6.28. MemcachedMonitor

This monitor allows to monitor Memcached, a distributed memory object caching system.
To monitor the service availability the monitor tests if the Memcached statistics can be requested.
The statistics are processed and stored in RRD files.
The following metrics are collected:

4.6.29. NetScalerGroupHealthMonitor

This monitor is designed for Citrix® NetScaler® loadbalancing checks.
It checks if more than x percent of the servers assigned to a specific group on a loadbalanced service are active.
The required data is gathered via SNMP from the NetScaler®.
The status of the servers is determined by the NetScaler®.
The provided service it self is not part of the check.
The basis of this monitor is the SnmpMonitorStrategy.
A valid SNMP configuration in OpenNMS Horizon for the NetScaler® is required.

A NetScaler® can manage several groups of servers per application.
This monitor just covers one group at a time.
If there are multiple groups to check, define one monitor per group.

Examples

The following example checks a server group called central_webfront_http.
If at least 70% of the servers are active, the service is up.
If less then 70% of the servers are active the service is down.
A configuration like the following can be used for the example in the poller-configuration.xml.

Details about the used SNMP checks

The monitor checks the status of the server group based on the NS-ROOT-MIB using the svcGrpMemberState.
svcGrpMemberState is part of the serviceGroupMemberTable.
The serviceGroupMemberTable is indexed by svcGrpMemberGroupName and svcGrpMemberName.
A initial lookup for the group-name is performed.
Based on the lookup the serviceGroupMemberTable is walked with the numeric representation of the server group.
The monitor interprets just the server status code 7-up as active server.
Other status codes like 2-unknown or 3-busy are counted for total amount of servers.

4.6.30. NrpeMonitor

This monitor allows to test plugins and checks running on the Nagios Remote Plugin Executor (NRPE) framework.
The monitor allows to test the status output of any available check command executed by NRPE.
Between OpenNMS Horizon and Nagios are some conceptional differences.
In OpenNMS Horizon a service can only be available or not available and the response time for the service is measured.
Nagios on the other hand combines service availability, performance data collection and thresholding in one check command.
For this reason a Nagios check command can have more states then OK and CRITICAL.
Using the NrpeMonitor marks all check command results other than OK as down.
The full output of the check command output message is passed into the service down event in OpenNMS Horizon.

NRPE configuration on the server is required and the check command has to be configured, e.g. command[check_apt]=/usr/lib/nagios/plugins/check_apt

OpenNMS Horizon executes every NRPE check in a Java thread without fork() a process and it is more resource friendly.
Nevertheless it is possible to run NRPE plugins which combine a lot of external programs like sed, awk or cut.
Be aware, each command end up in forking additional processes.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.NrpeMonitor

Remote Enabled

false

Configuration and Usage

Table 47. Monitor specific parameters for the NrpeMonitor

Parameter

Description

Required

Default value

retry

Number of retries before the service is marked as down.

optional

0

command

The {check_name} of the command configured as `command[{check_name}]="/path/to/plugin/check-script"

4.6.31. NtpMonitor

The NTP monitor tests for NTP service availability.
During the poll an NTP request query packet is generated.
If a response is received, it is parsed and validated.
If the response is a valid NTP response, the service is considered available.

To test the status of the disk array the virtualDiskRollUpStatus is used.
If the result of the virtualDiskRollUpStatus is not 3 the monitors is marked as down.

Table 49. Possible result of virtual disk rollup status

Result

State description

Monitor state in OpenNMS Horizon

1

other

DOWN

2

unknown

DOWN

3

ok

UP

4

non-critical

DOWN

5

critical

DOWN

6

non-recoverable

DOWN

You’ll need to know the maximum number of possible logical disks you have in your environment.
For example: If you have 3 RAID arrays, you need for each logical disk array a service poller.

To give more detailed information in case of an disk array error, the monitor tries to identify the problem using the other OIDs.
This values are used to enrich the error reason in the service down event.
The disk array state is resolved to a human readable value by the following status table.

4.6.33. OpenManageChassisMonitor

The OpenManageChassis monitor tests the status of a Dell chassis by querying its SNMP agent.
The monitor polls the value of the node’s SNMP OID .1.3.6.1.4.1.674.10892.1.300.10.1.4.1 (MIB-Dell-10892::chassisStatus).
If the value is OK (3), the service is considered available.

As this monitor uses SNMP, the queried nodes must have proper SNMP configuration in snmp-config.xml.

Dell MIBs

Dell MIBs can be found here.
Download the DCMIB<version>.zip or DCMIB<version>.exe file corresponding to the version of your OpenManage agents.
The latest one should be good enough for all previous version though.

4.6.34. PageSequenceMonitor

The PageSequenceMonitor (PSM) allows OpenNMS to monitor web applications.
This monitor has several configuration options regarding IPv4, IPv6 and how to deal with name resolution.
To add flexibility, the node label and IP address can be passed as variable into the monitor.
This allows running the monitor with node dependent configuration.
Beyond testing a web application with a single URL it can also test a path through a web application.
A test path through an web application can look like this:

login to a certain web application

Execute an action while being logged in

Log off

The service is considered as up if all this is working ok.
If there’s an error somewhere, your application will need attention and the service changes the state to down.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.PageSequenceMonitor

Remote Enabled

true

Configuration and Usage

The configuration for this monitor consists of several parts.
First is the overall configuration for retries and timeouts.
These parameters are global for the whole path through the web application.

Figure 16. Configuration overview of the PSM

The overall layout of the monitor configuration is more complex.
Additionally, it is possible to configure a page sequence containing a path through a web application.

Table 53. Monitor parameters for the PageSequenceMonitor

Parameter

Description

Required

Default value

retry

The number of retries per page.

optional

0

strict-timeout

Defines a timer to wait before a retry attempt is made.
It is only used if at least one (1) retry is configured.
If retry >= 1 and strict-timeout is true the next attempt is delayed and the Poller Daemon
waits NOW - InitialAttempt ms + Timeout ms.
With strict-timout = false the next attempt is started right after a failure.

optional

false

page-sequence

Definition of the page-sequence to execute, see table with Page Sequence Parameter

Set the user agent field in HTTP header to identify the OpenNMS monitor

optional

OpenNMS PageSequenceMonitor (Service name: "${SERVICE NAME}")

virtual-host

Set the virtual host field in HTTP header.
In case of an HTTPS request, this is also the virtual domain to send as part of the TLS
negotiation, known as server name indication (SNI)
(See: RFC3546 section 3.1)

-

-

path

The relative URL to call in the request.

required

-

scheme

Define the URL scheme as http or https

optional

http

user-info

Set user info field in the HTTP header

-

-

host

Set host field in HTTP header

optional

IP interface address of the service

requireIPv6

Communication requires a connection to an IPv6 address. (true or false)

-

-

requireIPv4

Communication requires a connection to an IPv4 address. (true or false)

-

-

disable-ssl-verification

Enable or disable SSL certificate verification for HTTPS tests.
Please use this option carefully, for self-signed certificates import the CA certificate
in the JVM and don’t just disable it.

optional

false

port

Port of the web server connecting to

optional

80

query

??

-

-

failureMatch

Text to look for in the response body.
This is a Regular Expression matched against every line, and it will be considered a
failure at the first match and sets the service with this monitor Down.

-

-

failureMessage

The failure message is used to construct the reason code.
${n} values may be used to pull information from matching groups in the failureMatch
regular expression.

-

-

successMatch

Text to look for in the response body.
This is a Regular Expression matched against every line, and it will be considered a
success at the first match and sets the service with this monitor Up.

optional

-

locationMatch

The relative URL which must be loaded for the request to be considered successful.

optional

-

response-range

Range for allowed HTTP error codes from the response.

-

-

session-variable

Assign the value of a regex match group to a session variable with a user-defined name.
The match group is identified by number and must be zero or greater.

If you set requireIPv4andrequireIPv6 false, the host IP for connection will be resolved from system name resolver and the associated IP address from the IP interface is ignored.

Table 55. Variables which can be passed in the configuration

Variable

Description

${nodelabel}

Nodelabel of the node the monitor is associated to.

Session variables

It is possible to assign strings from a retrieved page to variables that can be used in page parameters later in the same sequence.
First, specify one or more capturing groups in the successMatch expression (see Java Class Pattern for more information on regular expressions in Java).
The captured values can then be assigned to variable names by using the session-variable parameter, and used in a later page load.

Per-page response times

It is possible to collect response times for individual pages in a sequence.
To use this functionality, a ds-name attribute must be added to each page whose load time should be tracked.
The response time for each page will be stored in the same RRD file specified for the service via the rrd-base-name parameter under the specified datasource name.

You will need to delete existing RRD files and let them be recreated with the new list of datasources when you add a ds-name attribute to a page in a sequence that is already storing response time data.

Examples

The following example shows how to monitor the OpenNMS web application using several mechanisms.
It first does an HTTP GET of ${ipaddr}/opennms (following redirects as a browser would) and then checks to ensure that the resulting page has the phrase Password on it.
Next, a login is attempted using HTTP POST to the relative URL for submitting form data (usually, the URL which the form action points to).
The parameters (j_username and j_password) indicate the form’s data and values to be submitted.
After getting the resulting page, first the expression specified in the page’s failureMatch attribute is verified, which when found anywhere on the page indicates that the page has failed.
If the failureMatch expression is not found in the resulting page, then the expression specified in the page’s successMatch attribute is checked to ensure it matches the resulting page.
If the successMatch expression is not found on the page, then the page fails.
If the monitor was able to successfully login, then the next page is processed.
In the example, the monitor navigates to the Event page, to ensure that the text Event Queries is found on the page.
Finally, the monitor calls the URL of the logout page to close the session.
By using the locationMatch parameter, it is verified that the logout was successful and a redirect was triggered.

Each page is checked to ensure its HTTP response code fits into the response-range, before the failureMatch, successMatch, and locationMatch expressions are evaluated.

4.6.35. PercMonitor

This monitor tests the status of a PERC RAID array.

The monitor first polls the RAID-Adapter-MIB::logicaldriveTable (1.3.6.1.4.1.3582.1.1.2) to retrieve the status of the RAID array you want to monitor.
If the value of the status object of the corresponding logicaldriveEntry is not 2, the array is degraded and the monitor further polls the RAID-Adapter-MIB::physicaldriveTable (1.3.6.1.4.1.3582.1.1.3) to detect the failed drive(s).

This monitor requires the outdated persnmpd software to be installed on the polled nodes.
Please prefer using OmsaStorageMonitor monitor where possible.

4.6.36. Pop3Monitor

The POP3 monitor tests for POP3 service availability on a node.
The monitor first tries to establish a TCP connection on the specified port.
If a connection is established, a service banner should have been received.
The monitor makes sure the service banner is a valid POP3 banner (ie: starts with +OK).
If the banner is valid, the monitor sends a QUITPOP3 command and makes sure the service answers with a valid response (ie: a response that starts with +OK).
The service is considered available if the service’s answer to the QUIT command is valid.

4.6.37. PrTableMonitor

A table containing information on running programs/daemons configured for monitoring in the snmpd.conf file of the agent.
Processes violating the number of running processes required by the agent’s configuration file are flagged with numerical and textual errors.

— UCD-SNMP-MIB

The monitor looks up the prErrorFlag entries of this table.
If the value of a prErrorFlag entry in this table is set to "1" the service is considered unavailable.

prErrorFlag definition

An Error flag to indicate trouble with a process.
It goes to 1 if there is an error, 0 if no error.

— UCD-SNMP-MIB

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.PrTableMonitor

Remote Enabled

false

Configuration and Usage

Table 58. Monitor specific parameters for the PrTableMonitor

Parameter

Description

Required

Default value

port

The port to which connection shall be tried.

optional

from snmp-config.xml

retries

Deprecated.
Same as retry.
Parameter retry takes precedence if both are set.

UCD-SNMP-MIB

4.6.38. RadiusAuthMonitor

This monitor allows to test the functionality of the RADIUS authentication system.
The availability is tested by sending an AUTH packet to the RADIUS server.
If a valid ACCEPT response is received, the RADIUS service is up and considered as available.

To use this monitor it is required to install the RADIUS protocol for OpenNMS Horizon.

4.6.39. SmbMonitor

This monitor is used to test the NetBIOS over TCP/IP name resolution in Microsoft Windows environments.
The monitor tries to retrieve a NetBIOS name for the IP address of the interface.
Name services for NetBIOS in Microsoft Windows are provided on port 137/UDP or 137/TCP.

The service uses the IP address of the interface, where the monitor is assigned to.
The service is up if for the given IP address a NetBIOS name is registered and can be resolved.

For troubleshooting see the usage of the Microsoft Windows command line tool nbtstat or on Linux nmblookup.

Microsoft deprecated the usage of NetBIOS.
Since Windows Server 2000 DNS is used as the default name resolution.

To decide which mode should be used, the walk and match-all parameters are used.

See the Operating mode selection'' and Monitor specific parameters for the SnmpMonitor'' tables below for more information about these operation modes.

Table 61. Operating mode selection

walk

match-all

Operating mode

true

true

tabular, all values must match

false

tabular, any value must match

count

specifies that the value of at least minimum and at most
maximum objects encountered in

false

true

scalar

false

scalar

count

tabular, between minimum and maximum values must match

This monitor can’t be used on the OpenNMS Horizon Remote Poller.
It is currently not possible for the Remote Poller to have access to the SNMP configuration of a central OpenNMS Horizon.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.SnmpMonitor

Remote Enabled

false

When the monitor is configured to persist the response time, it will count the total amount of time spent until a successful response is obtained, including the retries.
It won’t store the time spent during the last successful attempt.

Configuration and Usage

Table 62. Monitor specific parameters for the SnmpMonitor

Parameter

Description

Required

Default value

hex

Specifies that the value monitored should be compared against its hexadecimal representation.
Useful when the monitored value is a string containing non-printable characters.

optional

false

match-all

Can be set to:count: specifies that the value of at least minimum and at most maximum objects encountered in
the walk must match the criteria specified by operand and operator.true and walk is set to true: specifies that the value of every object encountered in
the walk must match the criteria specified by the operand and operator parameters.false and walk is set to true: specifies that the value of any object encountered in
the walk must match the criteria specified by the operand and operator parameters.

optional

true

maximum

Valid only when match-all is set to count, otherwise ignored. Should be used in conjunction
with the minimum parameter. Specifies that the value of at mostmaximum objects
encountered in the walk must meet the criteria specified by the operand and operator
parameters.

optional

0

minimum

Valid only when match-all is set to count, otherwise ignored. Should be used in conjunction
with the maximum parameter. Specifies that the value of at leastminimum objects
encountered in the walk must meet the criteria specified by the operand and operator
parameters.

optional

0

oid

The object identifier of the MIB object to monitor.
If no other parameters are present, the monitor asserts that the agent’s response for this
object must include a valid value (as opposed to an error, no-such-name, or end-of-view
condition) that is non-null.

optional

.1.3.6.1.2.1.1.2.0 (SNMPv2-MIB::SysObjectID)

operand

The value to be compared against the observed value of the monitored object.
Note: Comparison will always succeed if either the operand or operator parameter isn’t set
and the monitored value is non-null.

optional

-

operator

The operator to be used for comparing the monitored object against the operand parameter.
Must be one of the following symbolic operators:&lt; (<): Less than. Both operand and observed object value must be numeric.&gt; (>): Greater than. Both operand and observed object value must be numeric.&lt;= (⇐): Less than or equal to. Both operand and observed object value must be numeric.&gt;= (>=): Greater than or equal to. Both operand and observed object value must be numeric.=: Equal to. Applied in numeric context if both operand and observed object value are numeric,
otherwise in string context as a case-sensitive exact match.!=: Not equal to. Applied in numeric context if both operand and observed object value are
numeric, otherwise in string context as a case-sensitive exact match.~: Regular expression match. Always applied in string context.
Note: Comparison will always succeed if either the operand or operator parameter isn’t set
and the monitored value is non-null.
Keep in mind that you need to escape all < and > characters as XML entities (&lt; and &gt;
respectively)

optional

-

port

Destination port where the SNMP requests shall be sent.

optional

from snmp-config.xml

reason-template

A user-provided template used for the monitor’s reason code if the service is unvailable.
Defaults to a reasonable value if unset.
See below for an explanation of the possible template parameters.

optional

depends on operation mode

retries

Deprecated Same as retry. Parameter retry takes precedence if both are set.

optional

from snmp-config.xml

walk

false: Sets the monitor to poll for a scalar object unless if the match-all parameter is set
to count, in which case the match-all parameter takes precedence.true: Sets the monitor to poll for a tabular object where the match-all parameter defines how
the tabular object’s values must match the criteria defined by the operator and operand
parameters. See also the match-all, minimum, and maximum parameters.

SYNTAX INTEGER {
other (1),
ok (2),
degraded (3),
failed (4)
}
ACCESS read-only
DESCRIPTION
"The status of the fan(s) in the system.
This value will be one of the following:
other(1)
Fan status detection is not supported by this system or driver.
ok(2)
All fans are operating properly.
degraded(3)
A non-required fan is not operating properly.
failed(4)
A required fan is not operating properly.
If the cpqHeThermalDegradedAction is set to shutdown(3) the
system will be shutdown if the failed(4) condition occurs."

The SnmpMonitor is configured to test if the fan status returns ok(2). If so, the service is marked as up.
Any other value indicates a problem with the thermal fan status and marks the service down.

Encode MIB status in the reason code to give more detailed information if the service goes down

Example test SNMP table with all matching values

The second mode shows how to monitor values of a whole SNMP table.
As a practical use case the status of a set of physical drives is monitored.
This example configuration shows the status monitoring from the CPQIDA-MIB.

We use as a scalar object id the physical drive status given by the following tabular OID:

cpqDaPhyDrvStatus .1.3.6.1.4.1.232.3.2.5.1.1.6

Description of the cpqDaPhyDrvStatus object id from CPQIDA-MIB

SYNTAX INTEGER {
other (1),
ok (2),
failed (3),
predictiveFailure (4)
}
ACCESS read-only
DESCRIPTION
Physical Drive Status.
This shows the status of the physical drive.
The following values are valid for the physical drive status:
other (1)
Indicates that the instrument agent does not recognize
the drive. You may need to upgrade your instrument agent
and/or driver software.
ok (2)
Indicates the drive is functioning properly.
failed (3)
Indicates that the drive is no longer operating and
should be replaced.
predictiveFailure(4)
Indicates that the drive has a predictive failure error and
should be replaced.

The configuration in our monitor will test all physical drives for status ok(2).

Enable walk mode to test every entry in the table against the test criteria

3

Test operator for integer

4

Integer 2 as operand for the test

5

Test in walk mode has to be passed for every entry in the table

6

Encode MIB status in the reason code to give more detailed information if the service goes down

Example test SNMP table with all matching values

This example shows how to use the SnmpMonitor to test if the number of static routes are within a given boundary.
The service is marked as up if at least 3 and at maxium 10 static routes are set on a network device.
This status can be monitored by polling the table ipRouteProto from the RFC1213-MIB2.

To monitor only local routes, the test should be applied only on entries in the ipRouteProto table with value 2.
The number of entries in the whole ipRouteProto table has to be counted and the boundaries on the number has to be applied.

Example SnmpMonitor used to test if the number of local static route entries are between 3 or 10.

Enable walk mode to test every entry in the table against the test criteria

3

Test operator for integer

4

Integer 2 as operand for testing local route entries

5

Test in walk mode has is set to count to get the number of entries in the table regarding operator and operand

6

Lower count boundary set to 3

7

High count boundary is set to 10

4.6.41. SshMonitor

The SshMonitor tests the availability of a SSH service.
During the poll an attempt is made to connect on the specified port.
If the connection request is successful, then the service is considered up.
Optionaly, the banner line generated by the service may be parsed and compared against a pattern before the service is considered up.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.SshMonitor

Remote Enabled

true

Configuration and Usage

Table 64. Monitor specific parameters for the SshMonitor

Parameter

Description

Required

Default value

banner

Regular expression to be matched against the service’s banner.

optional

-

client-banner

The client banner that OpenNMS Horizon will use to identify itself on the service.

optional

SSH-1.99-OpenNMS_1.5

match

Regular expression to be matched against the service’s banner.
Deprecated, please use the banner parameter instead.
Note that this parameter takes precedence over the banner parameter, though.

4.6.42. SSLCertMonitor

This monitor is used to test if a SSL certificate presented by a remote network server are
valid. A certificate is invalid if its initial time is prior to the current time, or if the current time
is prior to 7 days (configurable) before the expiration time. The monitor only supports SSL on
the socket and does not support a higher level protocol above it.

Table 66. Variables which can be passed in the configuration for server-name

Variable

Description

${ipaddr}

The node’s IP-Address

${nodeid}

The node ID

${nodelabel}

Label of the node the monitor is associated to.

${svcname}

The service name

The monitor has no support for communicating on other protocol layers above the SSL session layer. It
is not able to send a Host header for HTTPS, or issue a STARTTLS command for IMAP, POP3, SMTP, FTP, XMPP, LDAP,
or NNTP.

Examples

The following example shows how to monitor SSL certificates on services like IMAPS, SMTPS and HTTPS.
If the certificates expire within 30 days the service goes down and indicates this issue in the reason of the monitor.
In this example the monitoring interval is reduced to test the certificate every 2 hours (7,200,000 ms).
Configuration in poller-configuration.xml is as the following:

4.6.43. StrafePingMonitor

This monitor is used to monitor packet delay variation to a specific endpoint using ICMP.
The main use case is to monitor a WAN end point and visualize packet loss and ICMP packet round trip time deviation.
The StrafePingMonitor performs multiple ICMP echo requests (ping) and stores the response-time of each as well as the packet loss, in a RRD file.
Credit is due to Tobias Oetiker, as this graphing feature is an adaptation of the SmokePing tool that he developed.

Figure 17. Visualization of a graph from the StrafePingMonitor

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.StrafePingMonitor

Remote Enabled

false

Configuration and Usage

Monitor specific parameters for the StrafePingMonitor

Parameter

Description

Required

Default value

timeout

Time in milliseconds to wait before assuming that a packet has not responded

optional

800

retry

The number of retries to attempt when a packet fails to respond in the given timeout

optional

2

ping-count

The number of pings to attempt each interval

required

20

failure-ping-count

The number of pings that need to fail for the service to be considered down

required

20

allow-fragmentation

Whether to set the "Don’t Fragment" bit on outgoing packets

optional

true

dscp

DSCP traffic-control value.

optional

0

packet-size

Number of bytes of the ICMP packet to send.

optional

64

wait-interval

Time in milliseconds to wait between each ICMPecho-request packet

required

50

rrd-repository

The location to write RRD data. Generally, you will not want to change this from default

Examples

The StrafePingMonitor is typically used on WAN connections and not activated for every ICMP enabled device in your network.
Further this monitor is much I/O heavier than just a simple RRD graph with a single ICMP response time measurement.
By default you can find a separate poller package in the 'poller-configuration.xml' called strafer.
Configure the include-range or a filter to enable monitoring for devices with the service StrafePing.

Don’t forget to assign the service StrafePing on the IP interface to be activated.

The following example enables the monitoring for the service StrafePing on IP interfaces in the range 10.0.0.1 until 10.0.0.20.
Additionally the Nodes have to be in a surveillance category named Latency.

4.6.44. TcpMonitor

This monitor is used to test IP Layer 4 connectivity using TCP.
The monitor establishes an TCP connection to a specific port.
To test the availability of the service, the greetings banner of the application is evaluated.
The behavior is similar to a simple test using the telnet command as shown in the example.

4.6.45. SystemExecuteMonitor

If it is required to execute a system call or run a script to determine a service status, the SystemExecuteMonitor can be used.
It is calling a script or system command, if required it provides additional arguments to the call.
To determine the status of the service the SystemExecuteMonitor can rely on 0 or a non-0 exit code of system call.
As an alternative, the output of the system call can be matched against a banner.
If the banner is part of the output the status is interpreted as up.
If the banner is not available in the output the status is determined as down.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.SystemExecuteMonitor

Remote Enabled

true

Configuration and Usage

Table 68. Monitor specific parameters for the SystemExecuteMonitor

Parameter

Description

Required

Default value

script

The system-call to execute.

required

-

args

The arguments to hand over to the system-call. It supports variable replacement, see below.

optional

-

banner

A string that is match against the output of the system-call. If the output contains the banner, the
service is determined as UP.

optional

-

The parameter args supports variable replacement for the following set of variables.

Examples

SystemExecuteMonitor vs GpMonitor

The SystemExecuteMonitor is the successor of the GpMonitor. The main differences are:

Variable replacement for the parameter args

There are no fixed arguments handed to the system-call

The SystemExecuteMonitor supports RemotePoller deployment

To migrate services from the GpMonitor to the SystemExecuteMonitor it is required to alter the parameter args.
To match the arguments called hoption for the hostAddress and toption for the timeoutInSeconds.
The args string that matches the GpMonitor call looks like this:

To migrate the GpMonitor parameters hoption and toption just replace the --hostname and --timeout directly in the args key.

4.6.46. VmwareCimMonitor

This monitor is part of the VMware integration provided in Provisiond.
The monitor is specialized to test the health status provided from all Host System (host) sensor data.

This monitor is only executed if the host is in power state on.

This monitor requires to import hosts with Provisiond and the VMware import.
OpenNMS Horizon requires network access to VMware vCenter and the hosts.
To get the sensor data the credentials from vmware-config.xml for the responsible vCenter is used.
The following asset fields are filled from Provisiond and is provided by VMware import feature:
VMware Management Server, VMware Managed Entity Type and the foreignId which contains an internal VMware vCenter Identifier.

The global health status is evaluated by testing all available host sensors and evaluating the state of each sensor.
A sensor state could be represented as the following:

Unknown(0)

OK(5)

Degraded/Warning(10)

Minor failure(15)

Major failure(20)

Critical failure(25)

Non-recoverable error(30)

The service is up if all sensors have the status OK(5).
If any sensor gives another status then OK(5) the service is marked as down.
The monitor error reason contains a list of all sensors which not returned status OK(5).

In case of using Distributed Power Management the standBy state forces a service down.
The health status is gathrered with a direct connection to the host and in stand by this connection is unavailable and the service is down.
To deal with stand by states, the configuration ignoreStandBy can be used.
In case of a stand by state, the service is considered as up.

4.6.47. VmwareMonitor

This monitor is part of the VMware integration provided in Provisiond and test the power state of a virtual machine (VM) or a host system (host).
If the power state of a VM or host is poweredOn the service is up.
The state off the service on the VM or Host is marked as down.
By default standBy is also considered as down.
In case of using Distributed Power Management the standBy state can be changed see the ignoreStandBy configuration parameter.

The information for the status of a virtual machine is collected from the responsible VMware vCenter using the credentials from the vmware-config.xml.
It is also required to get specific asset fields assigned to an imported virtual machine and host system.
The following asset fields are required, which are populated by the VMware integration in Provisiond: VMware Management Server, VMware Managed Entity Type and the foreignId which contains an internal VMware vCenter Identifier.

4.6.48. Win32ServiceMonitor

The Win32ServiceMonitor enables OpenNMS Horizon to monitor the running state of any Windows service.
The service status is monitored using the Microsoft Windows® provided SNMP agent providing the LAN Manager MIB-II.
For this reason it is required the SNMP agent and OpenNMS Horizon is correctly configured to allow queries against part of the MIB tree.
The status of the service is monitored by polling the

svSvcOperatingState = 1.3.6.1.4.1.77.1.2.3.1.3

of a given service by the display name.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.Win32ServiceMonitor

Remote Enabled

false

Configuration and Usage

Table 72. Monitor specific parameters for the Win32ServiceMonitor

Parameter

Description

Required

Default value

service-name

The name of the service, this should be the exact name of the Windows service to monitor as it
appears in the Services MSC snap-in. Short names such as you might use with net start will not
work here.

Troubleshooting

If you’ve created a Win32ServiceMonitor poller and are having difficulties with it not being monitored properly on your hosts, chances are there is a difference in the name of the service you’ve created, and the actual name in the registry.

For example, I need to monitor a process called Example Service on one of our production servers.
I retrieve the Display name from looking at the service in service manager, and create an entry in the poller-configuration.xml files using the exact name in the Display name field.

However, what I don’t see is the errant space at the end of the service display name that is revealed when doing the following:

The extra space at the end of the name was difficult to notice in the service manager GUI, but is easily visible in the snmpwalk output.
The right way to fix this would be to correct the service Display name field on the server, however, the intent of this procedure is to recommend verifying the true name using snmpwalk as opposed to relying on the service manager GUI.

Examples

Monitoring the service running state of the Task Scheduler on an English local Microsoft Windows® Server requires at minimum the following entry in the poller-configuration.xml.

4.6.50. XmpMonitor

The XMP monitor tests for XMP service/agent availability by establishing an XMP session and querying the target agent’s sysObjectID variable contained in the Core MIB.
The service is considered available when the session attempt succeeds and the agent returns its sysObjectID without error.

Monitor facts

Class Name

org.opennms.netmgt.poller.monitors.XmpMonitor

Remote Enabled

false

Configuration and Usage

These parameters can be set in the XMP service entry in collectd-configuration.xml and will override settings from xmp-config.xml.
Also, don’t forget to add an entry in response-graph.properties so that response values will be graphed.

5. Performance Management

In OpenNMS Horizon collection of performance data is done by the Collectd daemon.
Management Agents and protocols to access performance data is implemented in Collectors.
These Collectors are scheduled and run in parallel in a global defined Thread Pool in Collectd.

This section describes how to configure Collectd for performance data collection with all available Collectors coming with OpenNMS Horizon.

To change the behavior for performance data collection, the collectd-configuration.xml file can be modified.
The configuration file is structured in the following parts:

Global daemon config: Define the size of the used Thread Pool to run Collectors in parallel.

Collection packages: Packages to allow the grouping of configuration parameters for Collectors.

Collection service association: Based on the name of the collection service, the implementation for application or network management protocols are assigned.

Figure 18. Collectd overview for associated files and configuration

The global behavior, especially the size of the Thread Pool for Collectd, is configured in the collectd-configuration.xml.

Global configuration parameters for Collectd

<collectd-configuration
threads="50"> (1)

1

Size of the Thread Pool to run Collectors in parallel

5.1.1. Resource Types

Resource Types

Resource Types are used to group sets of performance data measurements for persisting, indexing, and display in the Web UI.
Each resource type has a unique name, label definitions for display in the Web UI, and strategy definitions for archiving the measurements for long term analysis.

There are two labels for a resource type.
The first, label, defines a string to display in the Web UI.
The second, resourceLabel, defines the template used when displaying each unique group of measurements name for the resource type.

There are two types of strategy definitions for resource types, persistence selector and storage strategies.
The persistence selector strategy filters the group indexes down to a subset for storage on disk.
The storage strategy is used to convert an index into a resource path label for persistence.
There are two special resource types that do not have a resource-type definition.
They are node and ifIndex.

Resource Types can be defined inside files in either $OPENNMS_HOME/etc/resource-types.d or $OPENNMS_HOME/etc/datacollection, with the latter being specific for SNMP.

Here is the diskIOIndex resource type definition from $OPENNMS_HOME/etc/datacollection/netsnmp.xml:

PersistRegexSelectorStrategy

The PersistRegexSelectorStrategy class takes a single parameter, match-expression, which defines a JEXL expressions.
On evaulation, this expression should return either true, persist index to storage, or false, discard data.

Storage Strategies

Table 77. Storage Strategies

Class

Storage Path Value

org.opennms.netmgt.collection.support.IndexStorageStrategy

Index

org.opennms.netmgt.collection.support.JexlIndexStorageStrategy

Value after JexlExpression evaluation

org.opennms.netmgt.collection.support.ObjectNameStorageStrategy

Value after JexlExpression evaluation

org.opennms.netmgt.dao.support.FrameRelayStorageStrategy

interface label + '.' + dlci

org.opennms.netmgt.dao.support.HostFileSystemStorageStrategy

Uses the value from the hrStorageDescr column in the hrStorageTable, cleaned up for unix filesystems.

org.opennms.netmgt.dao.support.SiblingColumnStorageStrategy

Uses the value from an SNMP lookup of OID in sibling-column-name parameter, cleaned up for unix filesystems.

org.opennms.protocols.xml.collector.XmlStorageStrategy

Index, but cleaned up for unix filesystems.

IndexStorageStrategy

The IndexStorageStrategy takes no parameters.

JexlIndexStorageStrategy

The JexlIndexStorageStrategy takes two parameters, index-format which is required, and clean-output which is optional.

Parameter

Description

index-format

The JexlExpression to evaluate

clean-output

Boolean to indicate whether the index value is cleaned up.

If the index value will be cleaned up, then it will have all whitespace, colons, forward and back slashes, and vertical bars replaced with underscores. All equal signs are removed.

This class can be extended to create custom storage strategies by overriding the updateContext method to set additional key/value pairs to use in your index-format template.

ObjectNameStorageStrategy

The ObjectNameStorageStrategy extends the JexlIndexStorageStrategy, so its requirements are the same. Extra key/values pairs are added to the JexlContext which can then be used in the index-format template.
The original index string is converted to an ObjectName and can be referenced as ${ObjectName}. The domain from the ObjectName can be referenced as ${domain}. All key properties
from the ObjectName can also be referenced by ${key}.

This storage strategy is meant to be used with JMX MBean datacollections where multiple MBeans can return the same set of attributes. As of OpenNMS Horizon 20, this is only supported using a HTTP to JMX proxy and using the XmlCollector as the JmxCollector does not yet support indexed groups.

Given an MBean like java.lang:type=MemoryPool,name=Survivor Space, and a storage strategy like this:

SiblingColumnStorageStrategy

Values for replace-first, and replace-all must match the pattern s/regex/replacement/ or an error will be thrown.

XmlStorageStrategy

This XmlStorageStrategy takes no parameters.
The index value will have all whitespace, colons, forward and back slashes, and vertical bars replaced with underscores.
All equal signs are removed.

5.2. Collection Packages

To define more complex collection configuration it is possible to group Service configurations which provide performance metrics into Collection Packages.
They allow to assign to Nodes different Service Configurations to differentiate collection of performance metrics and connection settings.
To assign a Collection Package to nodes the Rules/Filters syntax can be used.

Multiple packages can be configured, and an interface can exist in more than one package.
This gives great flexibility how the service levels will be determined for a given device.
The order how Collection Packages are defined is important when IP Interfaces match multiple Collection Packages with the same Service configuration.
The last Collection Package on the service will be applied.
This can be used to define a less specific catch all filter for a default configuration.
A more specific Collection Package can be used to overwrite the default setting.

Apply this package to all IP interfaces with a configured IPv4 address (not equal 0.0.0.0)

3

Evaluate IPv4 rule to collect for all IPv4 interfaces in the given range

4

Evaluate IPv6 rule to collect for all IPv6 interfaces in the given range

5.2.1. Service Configurations

Service Configurations define what Collector to use and which performance metrics needs to be collected.
Service Configurations contains common Service Attributes as well as Collector specific parameters.

The connection url, e.g. service:jmx:rmi:localhost:18980.
The ip address can be substituted. Use ${ipaddr} in that case, e.g.:
service:jmx:rmi:${ipaddr}:18980

optional

(none)

username

The username if authentication is required.

optional

(none)

password

The password if authentication is required.

optional

(none)

port

Deprecated. JMX port.

optional

1099

protocol

Deprecated. Protocol used in the JMX connection string.

optional

rmi

urlPath

Deprecated. Path used in JMX connection string.

optional

/jmxrmi

rmiServerPort

Deprecated. RMI port.

optional

45444

remoteJMX

Deprecated. Use an alternative JMX URL scheme.

optional

false

The parameters port, protocol, urlPath, rmiServerPort and remoteJMX are deprecated and should be replaced with the url parameter.
If url is not defined the collector falls back to Legacy Mode and the deprecated parameters are used instead to build the connection url.

If a service requires different configuration it can be overwritten with an entry in $OPENNMS_HOME/etc/jmx-config.xml.

JMX Collection Configuration

JMX Collections are defined in the etc/jmx-datacollection-config.xml and etc/jmx-datacollection-config.d/.

Here is a snippet providing a collection definition named opennms-poller:

3rd Party JMX Services

Some java applications provide their own JMX implementation and require certain libraries to be present on the classpath, e.g. the java application server Wildfly.
In order to successfully collect data the following steps may be required:

Place the jmx client lib to the $OPENNMS_HOME/lib folder (e.g. jboss-cli-client.jar)

The connection url, e.g. service:jmx:rmi:localhost:18980.
The ip address can be substituted. Use ${ipaddr} in that case, e.g.:
service:jmx:rmi:${ipaddr}:18980

optional

(none)

username

The username if authentication is required.

optional

(none)

password

The password if authentication is required.

optional

(none)

port

Deprecated. JMX port.

optional

1099

protocol

Deprecated. Protocol used in the JMX connection string.

optional

rmi

urlPath

Deprecated. Path used in JMX connection string.

optional

/jmxrmi

rmiServerPort

Deprecated. RMI port.

optional

45444

remoteJMX

Deprecated. Use an alternative JMX URL scheme.

optional

false

The parameters port, protocol, urlPath, rmiServerPort and remoteJMX are deprecated and should be replaced with the url parameter.
If url is not defined the collector falls back to Legacy Mode and the deprecated parameters are used instead to build the connection url.

If a service requires different configuration it can be overwritten with an entry in $OPENNMS_HOME/etc/jmx-config.xml.

JMX Collection Configuration

JMX Collections are defined in the etc/jmx-datacollection-config.xml and etc/jmx-datacollection-config.d/.

Here is a snippet providing a collection definition named opennms-poller:

3rd Party JMX Services

Some java applications provide their own JMX implementation and require certain libraries to be present on the classpath, e.g. the java application server Wildfly.
In order to successfully collect data the following steps may be required:

Place the jmx client lib to the $OPENNMS_HOME/lib folder (e.g. jboss-cli-client.jar)

5.3.11. WsManCollector

Web Services-Management (WS-Management) is a DMTF open standard defining a SOAP-based protocol for the management of servers, devices, applications and various Web services.
Windows Remote Management (WinRM) is the Microsoft implementation of WS-Management Protocol.

Collector Facts

Class Name

org.opennms.netmgt.collectd.WsManCollector

Package

core

Supported on Minion

Yes

Collector Parameters

Table 88. Collector specific parameters for the WsManCollector

Parameter

Description

Required

Default value

collection

The name of the WS-Man Collection to use

required

WS-Management Setup

Before setting up OpenNMS Horizon to communicate with a WS-Management agent, you should confirm that it is properly configured and reachable from the OpenNMS Horizon system.
If you need help enabling the WS-Management agent, consult the documentation from the manufacturer.
Here are some link resources that could help:

WS-Management Agent Configuration

The agent specific configuration details are maintained in etc/wsman-config.xml.
This file has a similar structure as etc/snmp-config.xml, which the reader may already be familiar with.

This file is consulted when a connection to a WS-Man Agent is made.
If the IP address of the agent is matched by the range, specific or ip-match elements of a definition, then the attributes on that definition are used to connect to the agent.
Otherwise, the attributes on the outer wsman-config definition are used.

This etc/wsman-config.xml files is automatically reloaded when modified.

Enables GSS authentication.
When enabled a reverse lookup is performed on the target IP address in order to determine the
canonical host name.

False

If you try to connect against Microsoft Windows Server make sure to set specific ports for WinRM connections.
By default Microsoft Windows Server uses port TCP/5985 for plain text and port TCP/5986 for SSL connections.

WS-Management Collection Configuration

Configuration for the WS-Management collector is stored in etc/wsman-datacollection-config.xml and etc/wsman-datacollection.d/*.xml.

The contents of these files are automatically merged and reloaded when changed.
The default WS-Management collection looks as follows:

The magic happens with the <include-all-system-definitions/> element which automatically includes all of the system definitions into the collection group.

If required, you can include a specific system-definition with <include-system-definition>sys-def-name</include-system-definition>.

System definitions and related groups can be defined in the root etc/wsman-datacollection-config.xml file, but it is preferred that be added to a device specific configuration files in etc/wsman-datacollection-config.d/*.xml.

Avoid modifying any of the distribution configuration files and create new ones to store you specific details instead.

System Definitions

The expression has access to the following variables in it`s evaluation context:

Name

Type

(root)

org.opennms.netmgt.model.OnmsNode

agent

org.opennms.netmgt.collection.api.CollectionAgent

productVendor

java.lang.String

productVersion

java.lang.String

If a particular agent is matched by any of the rules, then the collector will attempt to collect the referenced groups from the agent.

Group Definitions

Groups are retrieved by issuing an Enumerate command against a particular Resource URI and parsing the results.
The Enumerate commands can include an optional filter in order to filter the records and attributes that are returned.

When configuring a filter, you must also specify the dialect.

The resource type used by the group must of be of type node or a generic resource type.
Interface level resources are not supported.

When using a generic resource type, the IndexStorageStrategy cannot be used since records have no implicit index.
Instead, you must use an alternative such as the SiblingColumnStorageStrategy.

If a record includes a multi-valued key, you can collect the value at a specific index with an index-of expression.
This is best demonstrated with an example. Let`s assume we wanted to collect the ServiceTag from the following record:

Specifying, the attribute name OtherIdentifyingInfo would not be sufficient, since there are multiple values for that key.
Instead, we want to retrieve the value for the OtherIdentifyingInfo key at the same index where IdentifyingDescriptions is set to DCIM:ServiceTag.

Caveats

The org.opennms.protocols.json.collector.DefaultJsonCollectionHandler requires the fetched document to be single element of type object to make xpath query work.
If the root element is an array, it will be wrapped in an object whereas the original array is accessible as /elements.

5.4. Shell Commands

A number of Karaf Shell commands are made available to help administer and diagnose issues related to performance data collection.

To use the commands, log into the Karaf Shell on your system using:

ssh -p 8101 admin@localhost

The Karaf shell uses the same credential as the web interface.
Users must be associated with the ADMIN role to access the shell.

In order to keep the session open while executing long-running tasks without any user input add -o ServerAliveInterval=10 to your ssh command.

5.4.1. Ad-hoc collection

The collection:collectKaraf Shell command can be used to trigger and perform a collection on any of the available collectors.

The results of the collection (also referred to as the "collection set") will be displayed in the console after a successful collection.
The resulting collection set will not be persisted, nor will any thresholding be applied.

Setting the location on the command line will override the node’s location.

If you see errors caused by RequestTimedOutException`s when invoking a collector at a remote location, consider increasing the time to live.
By default, `collectd will use the service interval as the time to live.

Invoke the JdbcCollector against 127.0.0.1 while specifying some of the collector parameters.

5.4.2. Interpreting the output

The description of the resources, groups and attribute may differ between collectors.
This output is independent of the persistence strategy that is being used.

5.4.3. Stress Testing

The metrics:stressKaraf Shell command can be used to simulate load on the active persistence strategy, whether it be RRDtool, JRobin, or Newts.

The tool works by generating collection sets, similar to those built when performing data collection, and sending these to the active persistence layer.
By using the active persistence layer, we ensure that we use the same write path which is used by the actual data collection services.

Generate samples for 10 nodes every 15 seconds and printing the statistic report every 30 seconds:

metrics:stress -n 10 -i 15 -r 30

While active, the command will continue to generate and persist collection sets.
During this time you can monitor the system I/O and other relevant statistics.

When your done, use CTRL+C to stop the stress tool.

A complete list of options is available using:

metrics:stress --help

5.4.4. Interpreting the output

The statistics output by the tool can be be interpreted as follows:

numeric-attributes-generated

The number of numeric attributes that were sent to the persistence layer.
We have no guarantee as to whether or not these were actually persisted.

string-attributes-generated

The number of string attributes that were sent to the persistence layer.
We have no guarantee as to whether or not these were actually persisted.

batches

The count is used to indicate how many batches of collection sets (one at every interval) were sent to the persistence layer.
The timers show how much time was spent generating the batch, and sending the batch to the persistence layer.

6. Events

Events are central to the operation of the OpenNMS Horizon platform, so it’s critical to have a firm grasp of this topic.

Whenever something in OpenNMS Horizon appears to work by magic, it’s probably events working behind the curtain.

6.1. Anatomy of an Event

Events are structured historical records of things that happen in OpenNMS Horizon and the nodes, interfaces, and services it manages.
Every event has a number of fixed fields and zero or more parameters.

Mandatory Fields

UEI (Universal Event Identifier)

A string uniquely identifying the event’s type.
UEIs are typically formatted in the style of a URI, but the only requirement is that they start with the string uei..

Event Label

A short, static label summarizing the gist of all instances of this event.

Description

A long-form description describing all instances of this event.

Log Message

A long-form log message describing this event, optionally including expansions of fields and parameters so that the value is tailored to the event at hand.

Severity

A severity for this event type.
Possible values range from Cleared to Critical.

Event ID

A numeric identifier used to look up a specific event in the OpenNMS Horizon system.

Notable Optional Fields

Operator Instruction

A set of instructions for an operator to respond appropriately to an event of this type.

Alarm Data

If this field is provided for an event, OpenNMS Horizon will create, update, or clear alarms for events of that type according to the alarm-data specifics.

6.2. Sources of Events

Events may originate within OpenNMS Horizon itself or from outside.

Internally-generated events can be the result of the platform’s monitoring and management functions (e.g. a monitored node becoming totally unavailable results in an event with the UEI uei.opennms.org/nodes/nodeDown) or they may act as inputs or outputs of housekeeping processes.

The following subsections summarize the mechanisms by which externally-created events can arrive.

6.2.1. SNMP Traps

If SNMP-capable devices in the network are configured to send traps to OpenNMS Horizon, these traps are transformed into events according to pre-configured rules. The Trapd service daemon, which enables OpenNMS Horizon to receive SNMP traps, is enabled by default.

Event definitions are included with OpenNMS Horizon for traps from many vendors' equipment.

6.2.2. Syslog Messages

Syslog messages sent over the network to OpenNMS Horizon can be transformed into events according to pre-configured rules.

The Syslogd service daemon, which enables OpenNMS Horizon to receive syslog messages over the network, must be enabled for this functionality to work. This service daemon is disabled by default.

Parsers

Different parsers can be used to convert the syslog message fields into OpenNMS Horizon event fields.

Parser

Description

org.opennms.netmgt.syslogd.CustomSyslogParser

Default parser that uses a regex statement to parse the syslog header.

org.opennms.netmgt.syslogd.RadixTreeSyslogParser

Parser that uses an internal list of grok-style statements to parse the syslog header.

org.opennms.netmgt.syslogd.SyslogNGParser

Parser that strictly parses messages in the default pattern of syslog-ng.

org.opennms.netmgt.syslogd.Rfc5424SyslogParser

Parser that strictly parses the RFC 5424 format for syslog messages.

RadixTreeSyslogParser

The RadixTreeSyslogParser normally uses a set of internally-defined patterns to parse multiple syslog message formats.
If you wish to customize the set of patterns, you can put a new set of patterns into a syslog-grok-patterns.txt in the etc directory for OpenNMS Horizon.

The patterns are defined in grok-style statements where each token is defined by a %{PATTERN:semantic} clause.
Whitespace in the pattern will match 0…​n whitespace characters and character literals in the pattern will match the corresponding characters.
The '%' character literal must be escaped by using a backslash, ie. '\%'.

The RadixTreeSyslogParser’s grok implementation only supports a limited number of pattern types. However, these patterns should be sufficient to parse any syslog message format.

The patterns should be arranged in the file from most specific to least specific since the first pattern to successfully match the syslog message will be used to construct the OpenNMS Horizon event.

Pattern

Description

INT

Positive integer.

MONTH

3-character English month abbreviation.

NOSPACE

String that contains no whitespace.

STRING

String. Because this matches any character, it must be followed by a delimiter in the pattern string.

Semantic Token

Description

day

2-digit day of month (1-31).

facilityPriority

Facility-priority integer.

hostname

String hostname (unqualified or FQDN), IPv4 address, or IPv6 address.

hour

2-digit hour of day (0-23).

message

Remaining string message.

messageId

String message ID.

minute

2-digit minute (0-59).

month

2-digit month (1-12).

processId

String process ID.

processName

String process name.

second

2-digit second (0-59).

secondFraction

1- to 6-digit fractional second value as a string.

timezone

String timezone value.

version

Version.

year

4-digit year.

6.2.3. ReST

Posting an event in XML format to the appropriate endpoint in the OpenNMS Horizon ReST API will cause the creation of a corresponding event, just as with the XML-TCP interface.

6.2.4. XML-TCP

Any application or script can create custom events in OpenNMS Horizon by sending properly-formatted XML data over a TCP socket.

6.2.5. Receiving IBM Tivoli Event Integration Facility Events

OpenNMS can be configured to receive Events sent using the Tivoli Event Integration Facility.
These EIF events are translated into OpenNMS events using preconfigured rules. The resulting UEI are anchored in the uei.opennms.org/vendor/IBM/EIF/ namespace, with the name of the EIF event class appended.

A sample event configuration for the OMEGAMON_BASE class is included with OpenNMS.

Configuring the EIF Adapter

Once OpenNMS is started and the Karaf shell is accessible, you can install the EIF Adapter feature and configure it to listen on a specific interface and port.

By default the EIF Adapter is configured to listen on TCP port 1828 on all interfaces.

Features installed through the Karaf shell persist only as long as the ${OPENNMS_HOME}/data directory remains intact. To enable the feature more permanently, add it to the featuresBoot list in ${OPENNMS_HOME}/etc/org.apache.karaf.features.cfg.

You should now be able to configure your EIF forwarders to send to this destination, and their events will be translated into OpenNMS Events and written to the event bus.

Troubleshooting

If events are not reaching OpenNMS, check whether the event source (EIF Forwarder) is correctly configured.
Check your event destination configuration. In particular review the HOSTNAME and PORT parameters. Also check that your situations are configured to forward to that EIF destination.

If those appear to be correct verify that the EIF Forwarder can communicate with OpenNMS over the configured port (default 1828).

Review the OSGi log with log:tail or the camel:* commands.

6.2.6. TL1 Autonomous Messages

Autonomous messages can be retrieved from certain TL1-enabled equipment and transformed into events.

The Tl1d service daemon, which enables OpenNMS Horizon to receive TL1 autonomous messages, must be enabled for this functionality to work. This service daemon is disabled by default.

6.3. The Event Bus

At the heart of OpenNMS Horizon lies an event bus.
Any OpenNMS Horizon component can publish events to the bus, and any component can subscribe to receive events of interest that have been published on the bus.
This publish-subscribe model enables components to use events as a mechanism to send messages to each other.
For example, the provisioning subsystem of OpenNMS Horizon publishes a node-added event whenever a new node is added to the system.
Other subsystems with an interest in new nodes subscribe to the node-added event and automatically receive these events, so they know to start monitoring and managing the new node if their configuration dictates.
The publisher and subscriber components do not need to have any knowledge of each other, allowing for a clean division of labor and lessening the programming burden to add entirely new OpenNMS Horizon subsystems or modify the behavior of existing ones.

6.3.1. Associate an Event to a given node

There are 2 ways to associate an existing node to a given event prior sending it to the Event Bus:

Set the nodeId of the node in question to the event.

For requisitioned nodes, set the _foreignSource and _foreignId as parameters to the event. Then, any incoming event without a nodeId and these 2 parameters will trigger a lookup on the DB; if a node is found, the nodeId attribute will be dynamically set into the event, regardless which method has been used to send it to the Event Bus.
:imagesdir: ../../images

6.4. Event Configuration

The back-end configuration surrounding events is broken into two areas: the configuration of Eventd itself, and the configuration of all types of events known to OpenNMS Horizon.

6.4.1. The eventd-configuration.xml file

The overall behavior of Eventd is configured in the file OPENNMS_HOME/etc/eventd-configuration.xml.
This file does not need to be changed in most installations.
The configurable items include:

TCPAddress

The IP address to which the Eventd XML/TCP listener will bind. Defaults to 127.0.0.1.

TCPPort

The TCP port number on TCPAddress to which the Eventd XML/TCP listener will bind. Defaults to 5817.

UDPAddress

The IP address to which the Eventd XML/UDP listener will bind. Defaults to 127.0.0.1.

UDPPort

The UDP port number on TCPAddress to which the Eventd XML/UDP listener will bind. Defaults to 5817.

receivers

The number of threads allocated to service the event intake work done by Eventd.

queueLength

The maximum number of events that may be queued for processing. Additional events will be dropped. Defaults to unlimited.

getNextEventID

An SQL query statement used to retrieve the ID of the next new event. Changing this setting is not recommended.

socketSoTimeoutRequired

Whether to set a timeout value on the Eventd receiver socket.

socketSoTimeoutPeriod

The socket timeout, in milliseconds, to set if socketSoTimeoutRequired is set to yes.

logEventSummaries

Whether to log a simple (terse) summary of every event at level INFO. Useful when troubleshooting event processing on busy systems where DEBUG logging is not practical.

6.4.2. The eventconf.xml file and its tributaries

The set of known events is configured in OPENNMS_HOME/etc/eventconf.xml.
This file opens with a <global> element, whose <security> child element defines which event fields may not be overridden in the body of an event submitted via any Eventd listener.
This mechanism stops a mailicious actor from, for instance, sending an event whose operator-action field amounts to a phishing attack.

After the <global> element, this file consists of a series of <event-file> elements.
The content of each <event-file> element specifies the path of a tributary file whose contents will be read and incorporated into the event configuration.
These paths are resolved relative to the OPENNMS_HOME/etc directory; absolute paths are not allowed.

Each tributary file contains a top-level <events> element with one or more <event> child elements.
Consider the following event definition:

<event>
<uei>uei.opennms.org/nodes/nodeLostService</uei>
<event-label>OpenNMS-defined node event: nodeLostService</event-label>
<descr>&lt;p>A %service% outage was identified on interface
%interface% because of the following condition: %parm[eventReason]%.&lt;/p> &lt;p>
A new Outage record has been created and service level
availability calculations will be impacted until this outage is
resolved.&lt;/p></descr>
<logmsg dest="logndisplay">
%service% outage identified on interface %interface%.
</logmsg>
<severity>Minor</severity>
<alarm-data reduction-key="%uei%:%dpname%:%nodeid%:%interface%:%service%" alarm-type="1" auto-clean="false"/>
</event>

Every event definition has this same basic structure.
See Anatomy of an Event for a discussion of the structural elements.

A word about severities

When setting severities of events, it’s important to consider each event in the context of your infrastructure as a whole.
Events whose severity is critical at the zoomed-in level of a single device may not merit a Critical severity in the zoomed-out view of your entire enterprise.
Since an event with Critical severity can never have its alarms escalated, this severity level should usually be reserved for events that unequivocally indicate a truly critical impact to the business.
Rock legend Nigel Tufnel offered some wisdom on the subject.

Replacement tokens

Various tokens can be included in the description, log message, operator instruction and automatic actions for each event.
These tokens will be replaced by values from the current event when the text for the event is constructed.
Not all events will have values for all tokens, and some refer specifically to information available only in events derived from SNMP traps.

%eventid%

The event’s numeric database ID

%uei%

The Universal Event Identifier for the event.

%source%

The source of the event (which OpenNMS Horizon service daemon created it).

%time%

The time of the event.

%dpname%

The ID of the Minion (formerly distributed poller) that the event was received on.

%nodeid%

The numeric node ID of the device that caused the event, if any.

%nodelabel%

The node label for the node given in %nodeid% if available.

%host%

%interface%

The IP interface associated with the event, if any.

%interfaceresolv%

Does a reverse lookup on the %interface% and returns its name if available.

%service%

The service associated with the event, if any.

%severity%

The severity of the event.

%snmphost%

The host of the SNMP agent that generated the event.

%id%

The SNMP Enterprise OID for the event.

%idtext%

The decoded (human-readable) SNMP Enterprise OID for the event (?).

%ifalias%

The interface' SNMP ifAlias.

%generic%

The Generic trap-type number for the event.

%specific%

The Specific trap-type number for the event.

%community%

The community string for the trap.

%version%

The SNMP version of the trap.

%snmp%

The SNMP information associated with the event.

%operinstruct%

The operator instructions for the event.

%mouseovertext%

The mouse over text for the event.

Parameter tokens

Many events carry additional information in parameters (see Anatomy of an Event).
These parameters may start life as SNMP trap variable bindings, or varbinds for short.
You can access event parameters using the parm replacement token, which takes several forms:

%parm[all]%

Space-separated list of all parameter values in the form parmName1="parmValue1" parmName2="parmValue2" and so on.

%parm[values-all]%

Space-separated list of all parameter values (without their names) associated with the event.

%parm[names-all]%

Space-separated list of all parameter names (without their values) associated with the event.

%parm[<name>]%

Will return the value of the parameter named <name> if it exists.

%parm[##]%

Will return the total number of parameters as an integer.

%parm[#<num>]%

Will return the value of parameter number <num> (one-indexed).

%parm[name-#<num>]%

Will return the name of parameter number <num> (one-indexed).

The structure of the eventconf.xml tributary files

The ordering of event definitions is very important, as an incoming event is matched against them in order.
It is possible and often useful to have several event definitions which could match variant forms of a given event, for example based on the values of SNMP trap variable bindings.

The tributary files included via the <event-file> tag have been broken up by vendor. When OpenNMS Horizon starts, each tributary file is loaded in order.
The ordering of events inside each tributary file is also preserved.

The tributary files listed at the very end of eventconf.xml contain catch-all event definitions.
When slotting your own event definitions, take care not to place them below these catch-all files; otherwise your definitions will be effectively unreachable.

A few tips

To save memory and shorten startup times, you may wish to remove event definition files that you know you do not need.

If you need to customize some events in one of the default tributary files, you may wish to make a copy of the file containing only the customized events, and slot the copy above the original; this practice will make it easier to maintain your customizations in case the default file changes in a future release of OpenNMS Horizon.

6.4.3. Reloading the event configuration

After making manual changes to OPENNMS_HOME/etc/eventconf.xml or any of its tributary files, you can trigger a reload of the event configuration by issuing the following command on the OpenNMS Horizon server:

6.5. Debugging

When debugging events, it may be helpful to lower the minimum severity at which Eventd will log from the default level of WARN.
To change this setting, edit OPENNMS_HOME/etc/log4j2.xml and locate the following line:

<KeyValuePair key="eventd" value="WARN" />

Changes to log42.xml will be take effect within 60 seconds with no extra action needed.
At level DEBUG, Eventd will log a verbose description of every event it handles to OPENNMS_HOME/logs/eventd.log.
On busy systems, this setting may create so much noise as to be impractical.
In these cases, you can get terse event summaries by setting Eventd to log at level INFO and setting logEventSummaries="yes" in OPENNMS_HOME/etc/eventd-configuration.xml.
Note that changes to eventd-configuration.xml require a full restart of OpenNMS Horizon.

7. Alarms

7.1. Alarm Sounds

Often users want an audible indication of a change in alarm state.
The OpenNMS Horizon alarm list page has the optional ability to generate a sound either on each new alarm or (more annoyingly) on each change to an alarm event count on the page.

By default the alarm sound feature is disabled. System Administrators must activate the sound feature and also set the default sound setting for all users.
However users can modify the default sound setting for the duration of their logged-in session using a drop down menu with the following options:

Sound off: no sounds generated by the page.

Sound on new alarm: sounds generated for every new alarm on the page.

Sound on new alarm count: sounds generated for every increase in alarm event count for alarms on the page.

7.2. Flashing Unacknowledged Alarms

By default OpenNMS Horizon displays the alarm list page with acknowledged and unacknowledged alarms listed in separate search tabs.
In a number of operational environments it is useful to see all of the alarms on the same page with unacknowledged alarms flashing to indicate that they haven’t yet been noticed by one of the team.
This allows everyone to see at a glance the real time status of all alarms and which alarms still need attention.

The figure Alarm Sounds View also shows the alarm list page when flashing unacknowledged alarms are enabled.
Alarms which are unacknowledged flash steadily.
Alarms which have been acknowledged do not flash and also have a small tick beside the selection check box.
All alarms can be selected to be escalated, cleared, acknowledged and unacknowledged.

7.3. Configuring Alarm Sounds and Flashing

By default OpenNMS Horizon does not enable alarm sounds or flashing alarms.
The default settings are included in opennms.properties.
However rather than editing the default opennms.properties file, the system administrator should enable these features by creating a new file in opennms.properties.d and applying the following settings;

# ###### Alarm List Page Options ######
# Several options are available to change the default behaviour of the Alarm List Page.
# <opennms url>/opennms/alarm/list.htm
#
# The alarm list page has the ability to generate a sound either on each new alarm
# or (more annoyingly) on each change to an alarm event count on the page.
#
# Turn on the sound feature. Set true and Alarm List Pages can generate sounds in the web browser.
opennms.alarmlist.sound.enable=true
#
# Set the default setting for how the Alarm List Pages generates sounds. The default setting can be
# modified by users for the duration of their logged-in session using a drop down menu .
# off = no sounds generated by the page.
# newalarm = sounds generated for every new alarm in the page
# newalarmcount = sounds generated for every increase in alarm event count for alarms on the page
#
opennms.alarmlist.sound.status=off
# By default the alarm list page displays acknowledged and unacknowledged alarms in separate search tabs
# Some users have asked to be able to see both on the same page. This option allows the alarm list page
# to display acknowledged and unacknowledged alarms on the same list but unacknowledged alarms
# flash until they are acknowledged.
#
opennms.alarmlist.unackflash=true

The sound played is determined by the contents of the following file ${OPENNMS_HOME}/jetty-webapps/opennms/sounds/alert.wav

If you want to change the sound, create a new wav file with your desired sound, name it alert.wav and replace the default file in the same directory.

8. Notifications

8.1. Introduction

OpenNMS Horizon uses notifications to make users aware of an event.
Common notification methods are email and paging, but notification mechanisms also exist for:

Arbitrary HTTP GET and POST operations

Arbitrary external commands

Asterisk call origination

IRCcat Internet Relay Chat bot

SNMP Traps

Slack, Mattermost, and other API-compatible team chat platforms

Twitter, GNU Social, and other API-compatible microblog services

User-provided scripts in any JSR-223 compatible language

XMPP

The notification daemon Notifd creates and sends notifications according to configured rules when selected events occur in OpenNMS Horizon.

8.2. Getting Started

The status of notifications is indicated by an icon at the top right of the web UI’s navigation bar.
OpenNMS Horizon installs with notifications globally disabled by default.

8.2.1. Enabling Notifications

To enable notifications in OpenNMS Horizon, log in to the web UI as a user with administrator privileges. Hover over the user icon and click the Configure OpenNMS link.
The controls for global notification status appear in the top-level configuration menu as Notification Status.
Click the On radio button and then the Update button.
Notifications are now globally enabled.

The web workflow above is functionally equivalent to editing the notifd-configuration.xml file and setting status="on" in the top-level notifd-configuration element.
This configuration file change is picked up on the fly with no need to restart or send an event.

The event notification configuration is stored in the notifications.xml file.
Changes to this file are picked up on the fly with no need to restart or send an event.

8.3. Concepts

Notifications are how OpenNMS Horizon informs users about an event that happened in the network, without the users having to log in and look at the UI.
The core concepts required to understand notifications are:

Events and UEIs

Users, Groups, and On-Call Roles

Duty Schedules

Destination Paths

Notification Commands

These concepts fit together to form an Event Notification Definition.
Also related, but presently only loosely coupled to notifications, are Alarms and Acknowledgments.

8.3.1. Events and UEIs

As discussed in the chapter on Events, events are central to the operation of OpenNMS Horizon.
Almost everything that happens in the system is the result of, or the cause of, one or more events; Every notification is triggered by exactly one event.
A good understanding of events is therefore essential to a working knowledge of notifications.

Every event has a UEI (Uniform Event Identifier), a string uniquely identifying the event’s type.
UEIs are typically formatted in the style of a URI, but the only requirement is that they start with the string uei..
Most notifications are triggered by an exact UEI match (though they may also be triggered with partial UEI matches using regular expression syntax).

8.3.2. Users, Groups, and On-Call Roles

Users are entities with login accounts in the OpenNMS Horizon system.
Ideally each user corresponds to a person.
They are used to control access to the web UI, but also carry contact information (e-mail addresses, phone numbers, etc.) for the people they represent.
A user may receive a notification either individually or as part of a Group or On-Call Role.
Each user has several technology-specific contact fields, which must be filled if the user is to receive notifications by the associated method.

Groups are lists of users.
In large systems with many users it is helpful to organize them into Groups.
A group may receive a notification, which is often a more convenient way to operate than on individual user.
Groups allow to assign a set of users to On Call Roles to build more complex notification workflows.

How to create or modify membership of Users in a Group

Login as a User with administrative permissions

Choose Configure OpenNMS from the user specific main navigation which is named as your login user name

On-Call Roles are an overlay on top of groups, designed to enable OpenNMS Horizon to target the appropriate user or users according to a calendar configuration.
A common use case is to have System Engineers in On-Call rotations with a given schedule.
The On-Call Roles allow to assign a predefined Duty Schedule to an existing Group with Users.
For each On-Call Role a User is assigned as a Supervisor to be responsible for the group of people in this On-Call Role.

How to assign a Group to an On-Call Role

Login as a User with administrative permissions

Choose Configure OpenNMS from the user specific main navigation which is named as your login user name

Use Add New On-Call Role and set a Name for this On-Call Role, assign an existing Group and give a meaningful description

Click Save to persist

Define a Duty Schedule in the calendar for the given date by click on the Plus (+) icon of the day and provide a notification time for a specific User from the associated Group

Click Save to persist the Schedule

Click Done to apply the changes

8.3.3. Duty Schedules

Every User and Group may have a Duty Schedule, which specifies that user’s (or group’s) weekly schedule for receiving notifications.
If a notification should be delivered to an individual user, but that user is not on duty at the time, the notification will never be delivered to that user.
In the case of notifications targeting a user via a group, the logic differs slightly.
If the group is on duty at the time the notification is created, then all users who are also on duty will be notified.
If the group is on duty, but no member user is currently on duty, then the notification will be queued and sent to the next user who comes on duty.
If the group is off duty at the time the notification is created, then the notification will never be sent.

8.3.4. Destination Paths

A Destination Path is a named, reusable set of rules for sending notifications.
Every destination path has an initial step and zero or more escalation steps.

Each step in a destination path has an associated delay which defaults to zero seconds. The initial step’s delay is called the initial delay, while an escalation step’s delay is simply called its delay.

Each step has one or more targets.
A target may be a user, a group, an on-call role, or a one-off e-mail address.

While it may be tempting to use one-off e-mail addresses any time an individual user is to be targeted, it’s a good idea to reserve one-off e-mail addresses for special cases.
If a user changes her e-mail address, for instance, you’ll need to update in every destination path where it appears.
The use of one-off e-mail addresses is meant for situations where a vendor or other external entity is assisting with troubleshooting in the short term.

When a step targets one or more groups, a delay may also be specified for each group.
The default is zero seconds, in which case all group members are notified simultaneously.
If a longer delay is set, the group members will be notified in alphabetical order of their usernames.

Avoid using the same name for a group and a user.
The destination path configuration does not distinguish between users and groups at the step level, so the behavior is undefined if you have both a user and a group named admin.
It is for this reason that the default administrators group is called Admin (with a capital A) — case matters.

Within a step, each target is associated with one or more notification commands.
If multiple commands are selected, they will execute simultaneously.

Each step also has an auto-notify switch, which may be set to off, on, or auto.
This switch specifies the logic used when deciding whether or not to send a notice for an auto-acknowledged notification to a target that was not on duty at the time the notification was first created.
If off, notices will never be sent to such a target; if on, they will always be sent; if auto, the system employs heuristics aimed at "doing the right thing".

8.3.5. Notification Commands

A Notification Command is a named, reusable execution profile for a Java class or external program command used to convey notices to targets.
The following notification commands are included in the default configuration:

callHomePhone, callMobilePhone, and callWorkPhone

Ring one of the phone numbers configured in the user’s contact information.
All three are implemented using the in-process Asterisk notification strategy, and differ only in which contact field is used.

ircCat

Conveys a notice to an instance of the IRCcat Internet Relay Chat bot.
Implemented by the in-process IRCcat notification strategy.

javaEmail and javaPagerEmail

By far the most commonly used commands, these deliver a notice to a user’s email or pagerEmail contact field value.
By configuring a user’s pagerEmail contact field value to target an email-to-SMS gateway, SMS notifications are trivially easy to configure.
Both are implemented using the in-process JavaMail notification strategy.

microblogDM, microblogReply, and microblogUpdate

Sends a notice to a user as a direct message, at a user via an at-reply, or to everybody as an update via a microblog service with a Twitter v1-compatible API.
Each command is implemented with a separate, in-process notification strategy.

numericPage and textPage

Sends a notice to a user’s numeric or alphanumeric pager.
Implemented as an external command using the qpage utility.

xmppGroupMessage and xmppMessage

Sends a message to an XMPP group or user.
Implemented with the in-process XMPP notification strategy.

Notification commands are customizable and extensible by editing the notificationCommands.xml file.

Use external binary notification commands sparingly to avoid fork-bombing your OpenNMS Horizon system.
Originally, all notification commands were external.
Today only the numericPage and textPage commands use external programs to do their work.

8.4. Bonus Notification Methods

A handful of newer notification methods are included in OpenNMS Horizon but currently require manual steps to activate.

8.4.1. Mattermost

If your organization uses the Mattermost team communications platform, you can configure OpenNMS Horizon to send notices to any Mattermost channel via an incoming webhook.
You must configure an incoming webhook in your Mattermost team and do a bit of manual configuration to your OpenNMS Horizon instance.

First, add the following bit of XML to the notificationCommands.xml configuration file (no customization should be needed):

8.4.2. Slack Notifications

If your organization uses the Slack team communications platform, you can configure OpenNMS Horizon to send notices to any Slack channel via an incoming webhook.
You must configure an incoming webhook in your Slack team and do a bit of manual configuration to your OpenNMS Horizon instance.

First, add the following bit of XML to the notificationCommands.xml configuration file (no customization should be needed):

9. Provisioning

9.1. Introduction

The introduction of OpenNMS version 1.8 empowers enterprises and services providers like never before with a new service daemon for maintaining the managed entity inventory in OpenNMS.
This new daemon, Provisiond, unifies all previous entity control mechanisms available in 1.6 (Capsd and the Importer), into a new and improved, massively parallel, policy based provisioning system.
System integrators should note, Provisiond comes complete with a RESTFul Web Service API for easy integration with external systems such as CRM or external inventory systems as well as an adapter API for interfacing with other management systems such as configuration management.

OpenNMS 1.0, introduced almost a decade ago now, provided a capabilities scanning daemon, Capsd, as the mechanism for provisioning managed entities.
Capsd, deprecated with the release of 1.8.0, provided a rich automatic provisioning mechanism that simply required an IP address to seed its algorithm for creating and maintaining the managed entities (nodes, interfaces, and IP based services).
Version 1.2 added and XML-RPC API as a more controlled (directed) strategy for provisioning services that was mainly used by non telco based service providers (i.e. managed hosting companies).
Version 1.6 followed this up with yet another and more advanced mechanism called the Importer service daemon.
The Importer provided large service providers with the ability to strictly control the OpenNMS entity provisioning with an XML based API for completely defining and controlling the entities where no discovery and service scanning scanning was feasible.

The Importer service improved OpenNMS' scalability for maintaining managed entity databases by an order of magnitude.
This daemon, while very simple in concept and yet extremely powerful and flexible provisioning improvement, has blazed the trail for Provisiond.
The Importer service has been in production for 3 years in service provider networks maintaining entity counts of more than 50,000 node level entities on a single instances of OpenNMS.
It is a rock solid provisioning tool.

Provisiond begins a new era of managed entity provisioning in OpenNMS.

9.2. Concepts

Provisioning is a term that is familiar to service providers (a.k.a. operators, a.k.a. telephone companies) and OSS systems but not so much in the non OSS enterprises.

Provisiond receives "requests" for adding managed entities via 2 basic mechanisms, the OpenNMS Horizon traditional "New Suspect" event, typically via the Discovery daemon, and the import requisition (XML definition of node entities) typically via the Provisioning Groups UI.
If you are familiar with all previous releases of OpenNMS, you will recognize the New Suspect Event based Discovery to be what was previously the Capsd component of the auto discovery behavior.
You will also recognize the import requisition to be of the Model Importer component of OpenNMS.
Provisiond now unifies these two separate components into a massively parallel advanced policy based provisioning service.

9.2.1. Terminology

The following terms are used with respect to the OpenNMS Horizon provisioning system and are essential for understanding the material presented in this guide.

Entity

Entities are managed objects in OpenNMS Horizon such as Nodes, IP interfaces, SNMP Interfaces, and Services.

Foreign Source and Foreign ID

The Importer service from 1.6 introduced the idea of foreign sources and foreign IDs.
The Foreign Source uniquely identifies a provisioning source and is still a basic attribute of importing node entities into OpenNMS Horizon.
The concept is to provide an external (foreign) system with a way to uniquely identify itself and any node entities that it is requesting (via a requisition) to be provisioned into OpenNMS Horizon.

The Foreign ID is the unique node ID maintained in foreign system and the foreign source uniquely identifies the external system in OpenNMS Horizon.

OpenNMS Horizon uses the combination of the foreign source and foreign ID become the unique foreign key when synchronizing the set of nodes from each source with the nodes in the OpenNMS Horizon DB.
This way the foreign system doesn’t have to keep track of the OpenNMS Horizon node IDs that are assigned when a node is first created.
This is how Provisiond can decided if a node entity from an import requisition is new, has been changed, or needs to be deleted.

Foreign Source Definition

Additionally, the foreign source has been extended to also contain specifications for how entities should be discovered and managed on the nodes from each foreign source.
The name of the foreign source has become pervasive within the provisioning system and is used to simply some of the complexities by weaving this name into:

the name of the provisioning group in the Web-UI

the name of the file containing the persisted requisition (as well as the pending requisition if it is in this state)

the foreign-source attribute value inside the requisition (obviously, but, this is pointed out to indicate that the file name doesn’t necessarily have to equal the value of this attribute but is highly recommended as an OpenNMS Horizon best practice)

the building attribute of the node defined in the requisition (this value is called “site” in the Web-UI and is assigned to the building column of the node’s asset record by Provisiond and is the default value used in the Site Status View feature)

Import Requisition

Import requisition is the terminology OpenNMS Horizon uses to represent the set of nodes, specified in XML, to be provisioned from a foreign source into OpenNMS Horizon.
The requisition schema (XSD) can be found at the following location. http://xmlns.opennms.org/xsd/config/model-import

Auto Discovery

Auto discovery is the term used by OpenNMS Horizon to characterize the automatic provisioning of nodes entities.
Currently, OpenNMS Horizon uses an ICMP ping sweep to find IP address on the network.
For the IPs that respond and that are not currently in the DB, OpenNMS Horizon generates a new suspect event.
When this event is received by Provisiond, it creates a node and it begins a node scan based on the default foreign source definition.

Directed Discovery

Provisiond takes over for the Model Importer found in version 1.6 which implemented a unique, first of its kind, controlled mechanism for specifying managed entities directly into OpenNMS Horizon from one or more data sources.
These data sources often were in the form of an in-housed developed inventory or stand-alone provisioning system or even a set of element management systems.
Using this mechanism, OpenNMS Horizon is directed to add, update, or delete a node entity exactly as defined by the external source.
No discovery process is used for finding more interfaces or services.

Enhanced Directed Discovery

Directed discovery is enhanced with the capability to scan nodes that have been directed nodes for entities (interfaces.

Policy Based Discovery

The phrase, Policy based Directed Discovery, is a term that represents the latest step in OpenNMS Horizon provisioning evolution and best describes the new provisioning architecture now in OpenNMS Horizon for maintaining its inventory of managed entities.
This term describes the control that is given over the Provisioning system to OpenNMS Horizon users for managing the behavior of the NMS with respect to the new entities that are being discovered.
Current behaviors include persistence, data collection, service monitoring, and categorization policies.

9.2.2. Addressing Scalability

The explosive growth and density of the IT systems being deployed today to support not traditional IP services is impacting management systems like never before and is demanding from them tremendous amounts of scalability.
The scalability of a management system is defined by its capacity for maintaining large numbers of managing entities coupled with its efficiency of managing the entities.

Today, It is not uncommon for OpenNMS Horizon deployments to find node entities with tens of thousands of physical interfaces being reported by SNMP agents due to virtualization (virtual hosts, interfaces, as well as networks).
An NMS must be capable of using the full capacity every resource of its computing platform (hardware and OS) as effectively as possible in order to manage these environments.
The days of writing scripts or single threaded applications will just no longer be able to do the work required an NMS when dealing with the scalability challenges facing systems and systems administrators working in this domain.

Parallelization and Non-Blocking I/O

Squeezing out every ounce of power from a management system’s platform (hardware and OS) is absolutely required to complete all the work of a fully functional NMS such as OpenNMS Horizon.
Fortunately, the hardware and CPU architecture of a modern computing platform provides multiple CPUs with multiple cores having instruction sets that include support for atomic operations.
While these very powerful resources are being provided by commodity systems, it makes the complexity of developing applications to use them vs. not using them, orders of magnitude more complex.
However, because of scalability demands of our complex IT environments, multi-threaded NMS applications are now essential and this has fully exposed the complex issues of concurrency in software development.

OpenNMS Horizon has stepped up to this challenge with its new concurrency strategy.
This strategy is based on a technique that combines the efficiency of parallel (asynchronous) operations (traditionally used by most effectively by single threaded applications) with the power of a fully current, non-blocking, multi-threaded design.
The non-blocking component of this new concurrency strategy added greater complexity but OpenNMS Horizon gained orders of magnitude in increased scalability.

Java Runtimes, based on the Sun JVM, have provided implementations for processor based atomic operations and is the basis for OpenNMS Horizon’ non-blocking concurrency algorithms.

Provisioning Policies

Just because you can, doesn’t mean you should!
Because the massively parallel operations being created for Provisiond allows tremendous numbers of nodes, interfaces, and services to be very rapidly discovered and persisted, doesn’t mean it should.
A policy API was created for Provisiond that allows implementations to be developed that can be applied to control the behavior of Provisiond.
The 1.8 release includes a set of flexible provisioning policies that control the persistence of entities and their attributes constrain monitoring behavior.

When nodes are imported or re-scanned, there is, potentially, a set of zero or more provisioning policies that are applied.
The policies are defined in the foreign source’s definition.
The policies for an auto-discovered node or nodes from provisioning groups that don’t have a foreign source definition, are the policies defined in the default foreign source definition.

The Default Foreign Source Definition

Contained in the libraries of the Provisioning service is the "template" or default foreign source.
The template stored in the library is used until the OpenNMS Horizon admin user alters the default from the Provisioning Groups WebUI.
Upon edit, this template is exported to the OpenNMS Horizon etc/ directory with the file name: default-foreign-source.xml.

Automatic Rescanning

The default foreign source defines a scan-interval of 1d, which will cause all nodes in the requisition to be scanned daily. You may set the scan interval using any combination of the following signifiers:

w: Weeks

d: Days

h: Hours

m: Minutes

s: Seconds

ms: Milliseconds

For example, to rescan every 6 days and 53 minutes, you would set the scan-interval to 6d 53m.

Don’t forget, for the new scan interval to take effect, you will need to import the requisition one more time so that the foreign source becomes active.

Disabling Rescan

For a large number of devices, you may want to set the scan-interval to 0 to disable automatic rescan altogether. OpenNMS Horizon will not attempt to rescan the nodes in the requisition unless you trigger a manual (forced) rescan through the web UI or Provisioning ReST API.

9.3. Getting Started

An NMS is of no use until it is setup for monitoring and entities are added to the system.
OpenNMS Horizon installs with a base configuration with a configuration that is sufficient get service level monitoring and performance management quickly up and running.
As soon as managed entities are provisioned, the base configuration will automatically begin monitoring and reporting.

Generally speaking, there are two methods of provisioning in OpenNMS Horizon: Auto Discovery and Directed Discovery.
We’ll start with Auto Discovery, but first, we should quickly review the configuration of SNMP so that newly discovered devices can be immediately scanned for entities as well as have reporting and thresholding available.

9.3.1. Provisioning the SNMP Configuration

OpenNMS Horizon requires SNMP configuration to be properly setup for your network in order to properly understand Network and Node topology as well as to automatically enable performance data collection.
Network topology is updated as nodes (a.k.a. devices or hosts) are provisioned.
Navigate to the Admin/Configure SNMP Community Names by IP address as shown below.

Configuring SNMP community names

Provisiond includes an option to add community information in the Single Node provisioning interface.
This, is equivalent of entering a single IP address in the screen with the convenience of setting the community string at the same time a node is provisioned.
See the Quick Node Add feature below for more details about this capability.

This screen sets up SNMP within OpenNMS Horizon for agents listening on IP addresses 10.1.1.1 through 10.254.254.254.
These settings are optimized into the snmp-configuration.xml file.
Optimization means that the minimal configuration possible will be written.
Any IP addresses already configured that are eclipsed by this range will be removed.
Here is the resulting configuration.

However, If an IP address is then configured that is within the range,
the range will be split into two separate ranges and a specific entry will
be added. For example, if a configuration was added through the same UI for
the IP: 10.12.23.32 having the community name public, then the
resulting configuration will be:

the bold IP addresses show where the range was split and the specific with community name "public" was added.

Now, with SNMP configuration provisioned for our 10 networks, we are ready to begin adding nodes.
Our first example will be to automatically discover and add all managed entities (nodes, IP interfaces, SNMP Interfaces, and Monitored IP based Services).
We will then give an example of how to be more directed and deliberate about your discovery by using Provisioning Groups.

Automatically discovered entities are analyzed, persisted to the relational data store, and then managed based on the policies defined in the default foreign source definition.
This is very similar to the way that entities were previously handled by the (now obsolete) Capsd daemon but with finer grained sense of control.

9.3.2. Automatic Discovery

Currently in OpenNMS Horizon, the ICMP is used to automatically provision node entities into OpenNMS Horizon.
This functionality has been in OpenNMS since is 1.0 release, however, in 1.8, a few of the use cases have been updated with Provisiond’s replacement of Capsd.

Separation of Concerns

Version 1.8 Provisiond separates what was called Capsd scanning in to 3 distinct phases: entity scanning, service detection, and node merging.
These phases are now managed separately by Provisiond.
Immediately following the import of a node entity, tasks are created for scanning a node to discover the node entity’s interfaces (SNMP and IP).
As interfaces are found, they are persisted and tasks are scheduled for service detection of each IP interface.

For auto discovered nodes, a node merging phase is scheduled;
Nodes that have been directly provisioned will not be included in the node merging process.
Merging will only occur when 2 automatically discovered nodes appear to be the same node.

the use case and redesign of node merging is still an outstanding issue with the 1.8.0 release

9.3.3. Enhanced Directed Discovery

This new form of provisioning first appears in OpenNMS with version 1.8 and the new Provisiond service.
It combines the benefits of the Importer’s strictly controlled methodology of directed provisioning (from version 1.6) with OpenNMS’ robustly flexible auto discovery.
Enhanced Directed discovery begins with an enhanced version of the same import requisition used in directed provisioning and completes with a policy influenced persistence phase that sorts though the details of all the entities and services found during the entity and service scanning phase.

If you are planning to use this form of provisioning, it important to understand the conceptual details of how Provisiond manages entities it is directed to provision.
This knowledge will enable administrators and systems integrators to better plan, implement, and resolve any issues involved with this provisioning strategy.

Understanding the Process

There are 3 phases involved with directing entities to be discovered: import, node scan, and service scan.
The import phase also has sub phases: marshal, audit, limited SNMP scan, and re-parent.

Marshal and Audit Phases

It is important to understand that the nodes requisitioned from each foreign source are managed as a complete set.
Nodes defined in a requisition from the foreign source CRM and CMDB, for example, will be managed separately from each other even if they should contain exactly the same node definitions.
To OpenNMS Horizon, these are individual entities and they are managed as a set.

Requisitions are referenced via a URL.
Currently, the URL can be specified as one of the following protocols: FILE, HTTP, HTTPS, and DNS.
Each protocol has a protocol handler that is used to stream the XML from a foreign source, i.e. http://inv.corp.org/import.cgi?customer=acme or file:/opt/opennms/etc/imports/acme.xml.
The DNS protocol is a special handler developed for Provisioning sets of nodes as a foreign-source from a corporate DNS server.
See DNS Protocol Handler for details.

Upon the import request (either on schedule or on demand via an Event) the requisition is marshaled into Java objects for processing.
The nodes defined in the requisition represent what OpenNMS Horizon should have as the current set of managed entities from that foreign source.
The audit phase determines for each node defined (or not defined) in the requisition which are to be processed as an Add, Update, or Delete operation during the Import Phase.
This determination is made by comparing the set foreign IDs of each node in the requisition set with the set of foreign IDs of currently managed entities in OpenNMS Horizon.

The intersection of the IDs from each set will become the Update operations, the extra set of foreign IDs that are in the requisition become the Add operations, and the extra set of foreign IDs from the managed entities become the Delete operations.
This implies that the foreign IDs from each foreign source must be unique.

Naturally, the first time an import request is processed from a foreign source there will be zero (0) node entities from the set of nodes currently being managed and each node defined in the requisition will become an Add Operation.
If a requisition is processed with zero (0) node definitions, all the currently managed nodes from that foreign source will become Delete operations (all the nodes, interfaces, outages, alarms, etc. will be removed from OpenNMS Horizon).

When nodes are provisioned using the Provisioning Groups Web-UI, the requisitions are stored on the local file system and the file protocol handler is used to reference the requisition.
Each Provisioning Group is a separate foreign source and unique foreign IDs are generated by the Web-UI.
An MSP might use Provisioning Groups to define the set of nodes to be managed by customer name where each customer’s set of nodes are maintained in a separate Provisioning Group.

Import Phase

The import phase begins when Provisiond receives a request to import a requisition from a URL.
The first step in this phase is to load the requisition and marshal all the node entities defined in the requisition into Java objects.

If any syntactical or XML structural problems occur in the requisition, the entire import is abandoned and no import operations are completed.

Once the requisition is marshaled, the requisition nodes are audited against the persisted node entities.
The set of requisitioned nodes are compared with a subset of persisted nodes and this subset is generated from a database query using the foreign source defined in the requisition.
The audit generates one of three operations for each requisition node: insert, update, delete based on each requisitioned node’s foreign ID.
Delete operations are created for any nodes that are not in the requisition but are in the DB subset, update operations are created for requisition nodes that match a persisted node from the subset (the intersection), and insert operations are created from the remaining requisition nodes (nodes in the requisition that are not in the DB subset).

If a requisition node has an interface defined as the Primary SNMP interface, then during the update and insert operations the node will be scanned for minimal SNMP attribute information.
This scan find the required node and SNMP interface details required for complete SNMP support of the node and only the IP interfaces defined in the requisition.

this not the same as Provisiond SNMP discovery scan phases: node scan and interface scan.

Node Scan Phase

Where directed discovery leaves off and enhanced directed discovery begins is that after all the operations have completed, directed discovery is finished and enhanced directed discovery takes off.
The requisitioned nodes are scheduled for node scans where details about the node are discovered and interfaces that were not directly provisioned are also discovered.
All physical (SNMP) and logical (IP) interfaces are discovered and persisted based on any Provisioning Policies that may have been defined for the foreign source associated with the import requisition.

Service Scan (detection) Phase

Additionally, the new Provisiond enhanced directed discovery mechanism follows interface discovery with service detection on each IP interface entity.
This is very similar to the Capsd plugin scanning found in all former releases of OpenNMS except that the foreign source definition is used to define what services should be detected on these interfaces found for nodes in the import requisition.

9.4. Import Handlers

The new Provisioning service in OpenNMS Horizon is continuously improving and adapting to the needs of the community.

One of the most recent enhancements to the system is built upon the very flexible and extensible API of referencing an import requisition’s location via a URL.
Most commonly, these URLs are files on the file system (i.e. file:/opt/opennms/etc/imports/<my-provisioning-group.xml>) as requisitions created by the Provisioning Groups UI.
However, these same requisitions for adding, updating, and deleting nodes (based on the original model importer) can also come from URLs.
For example a requisition can be retrieving the using HTTP protocol: http://myinventory.server.org/nodes.cgi

In addition to the standard protocols supported by Java, we provide a series of custom URL handlers to help retrieve requisitions from external sources.

9.4.1. Generic Handler

The generic handler is made available using URLs of the form: requisition://type?param=1;param=2

Using these URLs various type handlers can be invoked, both locally and via a Minion.

In addition to the type specific parameters, the following parameters are supported:

Table 94. General parameters

Parameter

Description

Required

Default value

location

The name of location at which the handler should be run

optional

Default

ttl

The maximum number of miliseconds to wait for the handler when ran remotely

optional

20000

See the relevant sections bellow for additional details on the support types.

The provision:show-import command available via the Karaf Shell can be used to show the results of an import (without persisting or triggering the import):

9.4.4. DNS Handler

The DNS handler requests a Zone Transfer (AXFR) request from a DNS server.
The A records are recorded and used to build an import requisition.
This is handy for organizations that use DNS (possibly coupled with an IP management tool) as the data base of record for nodes in the network.
So, rather than ping sweeping the network or entering the nodes manually into OpenNMS Horizon Provisioning UI, nodes can be managed via 1 or more DNS servers.

The format of the URL for this new protocol handler is: dns://<host>[:port]/<zone>[/<foreign-source>/][?expression=<regex>]

DNS Import Examples:

Simple

dns://my-dns-server/myzone.com

This URL will import all A records from the host my-dns-server on port 53 (default port) from zone "myzone.com" and since the foreign source (a.k.a. the provisioning group) is not specified it will default to the specified zone.

Using a Regular Expression Filter

dns://my-dns-server/myzone.com/portland/?expression=^por-.*

This URL will import all nodes from the same server and zone but will only manage the nodes in the zone matching the regular expression ^port-.* and will and they will be assigned a unique foreign source (provisioning group) for managing these nodes as a subset of nodes from within the specified zone.

If your expression requires URL encoding (for example you need to use a ? in the expression) it must be properly encoded.

dns://my-dns-server/myzone.com/portland/?expression=^por[0-9]%3F

DNS Setup

Currently, the DNS server requires to be setup to allow a zone transfer from the OpenNMS Horizon server.
It is recommended that a secondary DNS server is running on OpenNMS Horizon and that the OpenNMS Horizon server be allowed to request a zone transfer.
A quick way to test if zone transfers are working is:

dig -t AXFR @<dnsServer> <zone>

Configuration

The configuration of the Provisoning system has moved from a properties file (model-importer.properties) to an XML based configuration container.
The configuration is now extensible to allow the definition of 0 or more import requisitions each with their own cron based schedule for automatic importing from various sources (intended for integration with external URL such as http and this new dns protocol handler.

A default configuration is provided in the OpenNMS Horizon etc/ directory and is called: provisiond-configuration.xml.
This default configuration has an example for scheduling an import from a DNS server running on the localhost requesting nodes from the zone, localhost and will be imported once per day at the stroke of midnight.
Not very practical but is a good example.

This means that you don’t have to restart OpenNMS Horizon every time you update the configuration.

9.5. Provisioning Examples

Here are a few practical examples of enhanced directed discovery to help with your understanding of this feature.

9.5.1. Basic Provisioning

This example adds three nodes and requires no OpenNMS Horizon configuration other than specifying the node entities to be provisioned and managed in OpenNMS Horizon.

Defining the Nodes via the Web-UI

Using the Provisioning Groups Web-UI, three nodes are created given a single IP address.
Navigate to the Admin Menu and click Provisioning Groups Menu from the list of Admin options and create the group Bronze.

Creating a new Provisioning Group

Clicking the Add New Group button will create the group and will redisplay the page including this new group among the list of any group(s) that have already been created.

At this point, the XML structure for holding the new provisioning group (a.k.a. an import requisition) has been persisted to the '$OPENNMS_ETC/imports/pending' directory.

Clicking the Edit link will bring you to the screen where you can begin the process of defining node entities that will be imported into OpenNMS Horizon.
Click the Add Node button will begin the node entity creation process fill in the node label and click the Save button.

Creating a new Node definition in the Provisioning Group

At this point, the provisioning group contains the basic structure of a node entity but it is not complete until the interface(s) and interface service(s) have been defined.
After having clicked the Save button, as we did above presents, in the Web-UI, the options Add Interface, Add Node Category, and Add Node Asset.
Click the Add Interface link to add an interface entity to the node.

Adding an Interface to the node definition

Enter the IP address for this interface entity, a description, and specify the Primary attribute as P (Primary), S (Secondary), N (Not collected), or C (Collected) and click the save button.
Now the node entity has an interface for which services can be defined for which the Web-UI now presents the Add Service link.
Add two services (ICMP, SNMP) via this link.

A complete node definition with all required elements defined.

Now the node entity definition contains all the required elements necessary for importing this requisition into OpenNMS Horizon.
At this point, all the interfaces that are required for the node should be added.
For example, NAT interfaces should be specified there are services that they provide because they will not be discovered during the Scan Phase.

Two more node definitions will be added for the benefit of this example.

The completed requisition for the example Bronze Provisioning Group

This set of nodes represents an import requisition for the Bronze provisioning group.
As this requisition is being edited via the WebUI, changes are being persisted into the OpenNMS Horizon configuration directory '$OPENNMS_etc/imports/' pending as an XML file having the name bronze.xml.

The name of the XML file containing the import requisition is the same as the provisioning group name.
Therefore naming your provisioning group without the use of spaces makes them easier to manage on the file system.

Click the Done button to return to the Provisioning Groups list screen.
The details of the “Bronze” group now indicates that there are 3 nodes in the requisition and that there are no nodes in the DB from this group (a.k.a. foreign source).
Additionally, you can see that time the requisition was last modified and the time it last imported are given (the time stamps are stored as attributes inside the requisition and are not the file system time stamps).
These details are indicative of how well the DB represents what is in the requisition.

You can tell that this is a pending requisition for 2 reasons: 1) there are 3 nodes defined and 0 nodes in the DB, 2) the requisition has been modified since the last import (in this case never).

Import the Nodes

In this example, you see that there are 3 nodes in the pending requisition and 0 in the DB.
Click the Import button to submit the requisition to the provisioning system (what actually happens is that the Web-UI sends an event to the Provisioner telling it to begin the Import Phase for this group).

Do not refresh this page to check the values of these details.
To refresh the details to verify the import, click the Provisioning Groups bread crumb item.

You should be able to immediately verify the importation of this provisioning group because the import happens very quickly.
Provisiond has several threads ready for processing the import operations of the nodes defined in this requisition.

A few SNMP packets are sent and received to get the SNMP details of the node and the interfaces defined in the requisition.
Upon receipt of these packets (or not) each node is inserted as a DB transaction.

The nodes are now added to OpenNMS Horizon and are under management.

Following the import of a node with thousands of interfaces, you will be able to refresh the Interface table browser on the Node page and see that interfaces and services are being discovered and added in the background.
This is the discovery component of directed discovery.

Adding a Node

To direct that another node be added from a foreign source (in this example the Bronze Provisioning Group) simply add a new node definition and re-import.
It is important to remember that all the node definitions will be re-imported and the existing managed nodes will be updated, if necessary.

Changing a Node

To direct changes to an existing node, simply add, change, or delete elements or attributes of the node definition and re- import.
This is a great feature of having directed specific elements of a node in the requisition because that attributes will simply be changed.
For example, to change the IP address of the Primary SNMP interface for the node, barbrady.opennms.org, just change the requisition and re-import.

Each element in the Web-UI has an associated Edit icon
Click this icon to change the IP address for barbrady.opennms.org, click save, and then Click the Done button.

Changing the IP address of barbrady.opennms.org from 10.1.1.2 to 192.168.1.1

The Web-UI will return you to the Provisioning Groups screen where you will see that there are the time stamp showing that the requisition’s last modification is more recent that the last import time.

The Provisioning Group must be re-imported

This provides an indication that the group must be re-imported for the changes made to the requisition to take effect.
The IP Interface will be simply updated and all the required events (messages) will be sent to communicate this change within OpenNMS Horizon.

The IP interface for barbrady.opennms.org is immediately updated

Deleting a Node

Barbrady has not been behaving, as one might expect, so it is time to remove him from the system.
Edit the provisioning group, click the delete button next to the node barbrady.opennms.org, click the Done button.

Bronze Provisioning Group definition indicates a node has been removed and requires an import to delete the node entity from the OpenNMS Horizon system

Click the Import button for the Bronze group and the Barbrady node and its interfaces, services, and any other related data will be immediately deleted from the OpenNMS Horizon system.
All the required Events (messages) will be sent by Provisiond to provide indication to the OpenNMS Horizon system that the node Barbrady has been deleted.

Barbrady has been deleted

Deleting all the Nodes

There is a convenient way to delete all the nodes that have been provided from a specific foreign source.
From the main Admin/Provisioning Groups screen in the Web-UI, click the Delete Nodes button.
This button deletes all the nodes defined in the Bronze requisition.
It is very important to note that once this is done, it cannot be undone!
Well it can’t be undone from the Web-UI and can only be undone if you’ve been good about keeping a backup copy of your '$OPENMS_ETC/' directory tree.
If you’ve made a mistake, before you re-import the requisition, restore the Bronze.xml requisition from your backup copy to the '$OPENNMS_ETC/imports' directory.

All node definitions have been removed from the Bronze requisition. The Web-UI indicates an import is now required to remove them from OpenNMS Horizon.

Clicking the Import button will cause the Audit Phase of Provisiond to determine that all the nodes from the Bronze group (foreign source) should be deleted from the DB and will create Delete operations.
At this point, if you are satisfied that the nodes have been deleted and that you will no longer require nodes to be defined in this Group, you will see that the Delete Nodes button has now changed to the Delete Group button.
The Delete Group button is displayed when there are no nodes entities from that group (foreign source) in OpenNMS Horizon.

When no node entities from the group exist in OpenNMS Horizon, then the Delete Group button is displayed.

9.5.2. Advanced Provisioning Example

In the previous example, we provisioned 3 nodes and let Provisiond complete all of its import phases using a default foreign source definition.
Each Provisioning Group can have a separate foreign source definition that controls:

The rescan interval

The services to be detected

The policies to be applied

This example will demonstrate how to create a foreign source definition and how it is used to control the behavior of Provisiond when importing a Provisioning Group/foreign source requisition.

Following the import, All the IP and SNMP interfaces, in addition to the interface specified in the requisition, have been discovered and added to the node entity.
The default foreign source definition has no polices for controlling which interfaces that are discovered either get persisted or managed by OpenNMS Horizon.

Logical and Physical interface and Service entities directed and discovered by Provisiond.

Service Detection

As IP interfaces are found during the node scan process, service detection tasks are scheduled for each IP interface.
The service detections defined in the foreign source determines which services are to be detected and how (i.e. the values of the parameters that parameters control how the service is detected, port, timeout, etc.).

Applying a New Foreign Source Definition

This example node has been provisioned using the Default foreign source definition.
By navigating to the Provisioning Groups screen in the OpenNMS Horizon Web-UI and clicking the Edit Foreign Source link of a group, you can create a new foreign source definition that defines service detection and policies.
The policies determine entity persistence and/or set attributes on the discovered entities that control OpenNMS Horizon management behaviors.

When creating a new foreign source definition, the default definition is used as a template.

In this UI, new Detectors can be added, changed, and removed.
For this example, we will remove detection of all services accept ICMP and DNS, change the timeout of ICMP detection, and a new Service detection for OpenNMS Horizon Web-UI.

Click the Done button and re-import the NMS Provisioning Group.
During this and any subsequent re-imports or re- scans, the OpenNMS Horizon detector will be active, and the detectors that have been removed will no longer test for the related services for the interfaces on nodes managed in the provisioning group (requisition), however, the currently detected services will not be removed.
There are 2 ways to delete the previously detected services:

Delete the node in the provisioning group, re-import, define it again, and finally re-import again

Use the ReST API to delete unwanted services. Use this command to remove each unwanted service from each interface, iteratively:

There is a sneaky way to do #1.
Edit the provisioning group and just change the foreign ID.
That will make Provisiond think that a node was deleted and a new node was added in the same requisition!
Use this hint with caution and an full understanding of the impact of deleting an existing node.

Provisioning with Policies

The Policy API in Provisiond allow you to control the persistence of discovered IP and SNMP Interface entities and Node Categories during the Scan phase.

Matching IP Interface Policy

The Matching IP Interface policy controls whether discovered interfaces are to be persisted and if they are to be persisted, whether or not they will be forced to be Managed or Unmanaged.

Continuing with this example Provisioning Group, we are going to define a few policies that:

Prevent discovered 10 network addresses from being persisted

Force 192.168 network addresses to be unmanaged

From the foreign source definition screen, click the Add Policy button and the definition of a new policy will begin with a field for naming the policy and a drop down list of the currently installed policies.
Name the policy no10s, make sure that the Match IP Interface policy is specified in the class list and click the Save button.
This action will automatically add all the parameters required for the policy.

The two required parameters for this policy are action and matchBehavior.

The action parameter can be set to DO_NOT_PERSIST, Manage, or UnManage.

Creating a policy to prevent persistence of 10 network IP interfaces.

The DO_NOT_PERSIST action does just what it indicates, it prevents discovered IP interface entities from being added to OpenNMS Horizon when the matchBehavior is satisfied.
The Manage and UnManage values for this action allow the IP interface entity to be persisted by control whether or not that interface should be managed by OpenNMS Horizon.

The matchBehavior action is a boolean control that determines how the optional parameters will be evaluated.
Setting this parameter’s value to ALL_PARAMETERS causes Provisiond to evaluate each optional parameter with boolean AND logic and the value ANY_PARAMETERS will cause OR logic to be applied.

Now we will add one of the optional parameters to filter the 10 network addresses.
The Matching IP Interface policy supports two additional parameters, hostName and ipAddress.
Click the Add Parameter link and choose ipAddress as the key.
The value for either of the optional parameters can be an exact or regular expression match.
As in most configurations in OpenNMS Horizon where regular expression matching can be optionally applied, prefix the value with the ~ character.

Any subsequent scan of the node or re-imports of NMS provisioning group will force this policy to be applied.
IP Interface entities that already exist that match this policy will not be deleted.
Existing interfaces can be deleted by recreating the node in the Provisioning Groups screen (simply change the foreign ID and re-import the group) or by using the ReST API:

The next step in this example is to define a policy that sets discovered 192.168 network addresses to be unmanaged (not managed) in OpenNMS Horizon.
Again, click the Add Policy button and let’s call this policy noMgt192168s.
Again, choose the Mach IP Interface policy and this time set the action to UNMANAGE.

Policy to not manage IP interfaces from 192.168 networks

The UNMANAGE behavior will be applied to existing interfaces.

Matching SNMP Interface Policy

Like the Matching IP Interface Policy, this policy controls the whether discovered SNMP interface entities are to be persisted and whether or not OpenNMS Horizon should collect performance metrics from the SNMP agent for Interface’s index (MIB2 IfIndex).

In this example, we are going to create a policy that doesn’t persist interfaces that are AAL5 over ATM or type 49 (ifType).
Following the same steps as when creating an IP Management Policy, edit the foreign source definition and create a new policy.
Let’s call it: noAAL5s.
We’ll use Match SNMP Interface class for each policy and add a parameter with ifType as the key and 49 as the value.

At the appropriate time during the scanning phase, Provisiond will
evaluate the policies in the foreign source definition and take
appropriate action. If during the policy evaluation process any policy
matches for a “DO_NOT_PERSIST” action, no further policy evaluations
will happen for that particular entity (IP Interface, SNMP Interface).

Node Categorization Policy

With this policy, nodes entities will automatically be assigned categories.
The policy is defined in the same manner as the IP and SNMP interface polices.
Click the Add Policy button and give the policy name, cisco and choose the Set Node Category class.
Edit the required category key and set the value to Cisco.
Add a policy parameter and choose the sysObjectId key with a value ~^\.1\.3\.6\.1\.4\.1\.9\..*.

Example: Node Category setting policy

New Import Capabilities

Several new XML entities have been added to the import requisition since the introduction of the OpenNMS Importer service in version 1.6.
So, in addition to provisioning the basic node, interface, service, and node categories, you can now also provision asset data.

Provisiond Configuration

The configuration of the Provisioning system has moved from a properties file (model-importer.properties) to an XML based configuration container.
The configuration is now extensible to allow the definition of 0 or more import requisitions each with their own Cron based schedule for automatic importing from various sources (intended for integration with external URL such as HTTP and this new DNS protocol handler.

A default configuration is provided in the OpenNMS Horizon etc/ directory and is called: provisiond-configuration.xml.
This default configuration has an example for scheduling an import from a DNS server running on the localhost requesting nodes from the zone, localhost and will be imported once per day at the stroke of midnight. Not very practical but is a good example.

This means that you don’t have to restart OpenNMS Horizon every time you update the configuration!

Provisioning Asset Data

The Provisioning Groups Web-UI had been updated to expose the ability to add Node Asset data in an import requisition.
Click the Add Node Asset link and you can select from a drop down list all the possible node asset attributes that can be defined.

After an import, you can navigate to the Node Page and click the Asset Info link and see the asset data that was just provided in the requisition.

External Requisition Sources

Because Provisiond takes a URL as the location service for import requisitions, OpenNMS Horizon can be easily extended to support sources in addition to the native URL handling provided by Java: file://, http://, and https://.
When you configure Provisiond to import requisitions on a schedule you specify using a URL Resource.
For requisitions created by the Provisioning Groups WebUI, you can specify a file based URL.

<need further documentation>

Provisioning Nodes from DNS

The new Provisioning service in OpenNMS Horizon is continuously improving and adapting to the needs of the community.
One of the most recent enhancements to the system is built upon the very flexible and extensible API of referencing an import requisition’s location via a URL.
Most commmonly, these URLs are files on the file system (i.e. file:/opt/opennms/etc/imports/<my-provisioning-group.xml>) as requisitions created by the Provisioning Groups UI. However, these same requistions for adding, updating, and deleting nodes (based on the original model importer) can also come from URLs specifying the HTTP protocol: http://myinventory.server.org/nodes.cgi)

Now, using Java’s extensible protocol handling specification, a new protocol handler was created so that a URL can be specified for requesting a Zone Transfer (AXFR) request from a DNS server.
The A records are recorded and used to build an import requisition.
This is handy for organizations that use DNS (possibly coupled with an IP management tool) as the data base of record for nodes in the network.
So, rather than ping sweeping the network or entering the nodes manually into OpenNMS Horizon Provisioning UI, nodes can be managed via 1 or more DNS servers.
The format of the URL for this new protocol handler is:

dns://<host>[:port]/<zone>[/<foreign-source>/][?expression=<regex>]

Simple Example

dns://my-dns-server/myzone.com

This will import all A records from the host my-dns-server on port 53 (default port) from zone myzone.com and since the foreign source (a.k.a. the provisioning group) is not specified it will default to the specified zone.

Using a Regular Expression Filter

You can also specify a subset of the A records from the zone transfer using a regular expression:

dns://my-dns-server/myzone.com/portland/?expression=^por-.*

This will import all nodes from the same server and zone but will only manage the nodes in the zone matching the regular expression ^port-.* and will and they will be assigned a unique foreign source (provisioning group) for managing these nodes as a subset of nodes from within the specified zone.

URL Encoding

If your expression requires URL encoding (for example you need to use a ? in the expression) it must be properly encoded.

dns://my-dns-server/myzone.com/portland/?expression=^por[0-9]%3F

DNS Setup

Currently, the DNS server requires to be setup to allow a zone transfer from the OpenNMS Horizon server.
It is recommended that a secondary DNS server is running on OpenNMS Horizon and that the OpenNMS Horizon server be allowed to request a zone transfer.
A quick way to test if zone transfers are working is:

dig -t AXFR @<dn5Server> <zone>

9.6. Adapters

The OpenNMS Horizon Provisiond API also supports Provisioning Adapters (plugins) for integration with external systems during the provisioning Import phase.
When node entities are added, updated, deleted, or receive a configuration management change event, OpenNMS Horizon will call the adapter for the provisioning activities with integrated systems.

Currently, OpenNMS Horizon supports the following adapters:

9.6.1. DDNS Adapter

The Opposite end of Provisiond integration from the DNS Requisition Import, is the DDNS adapter.
This adapter uses the dynamic DNS protocol to update a DNS system as nodes are provisioned into OpenNMS Horizon.
To configure this adapter, edit the opennms.properties file and set the importer.adapter.dns.server property:

importer.adapter.dns.server=192.168.1.1

9.6.2. RANCID Adapter

Integration has been integrated with RANCID though this new API.

<More documentation needed>

Maps (soon to be moved to Mapd) <documentation required>

WiMax-Link (soon to be moved to Linkd) <documentation required>

9.7. Integrating with Provisiond

The ReST API should be used for integration from other provisioning systems with OpenNMS Horizon.
The ReST API provides an interface for defining foreign sources and requisitions.

9.7.1. Provisioning Groups of Nodes

Just as with the WebUI, groups of nodes can be managed via the ReST API from an external system.
The steps are:

Create a Foreign Source (if not using the default) for the group

Update the SNMP configuration for each node in the group

Create/Update the group of nodes

9.7.2. Example

Step 1 - Create a Foreign Source

If policies for this group of nodes are going to be specified differently than the default policy, then a foreign source should be created for the group.
Using the ReST API, a foreign source can be provided.
Here is an example:

The XML can be imbedded in the curl command option -d or be referenced from a file if the @ prefix is used with the file name as in this case.

The current API doesn’t strictly follow the ReST design guidelines and will be updated in a later release.

Step 2 - Update the SNMP configuration

The implementation only supports a PUT request because it is an implied "Update" of the configuration since it requires an IP address and all IPs have a default configuration.
This request is is passed to the SNMP configuration factory in OpenNMS Horizon for optimization of the configuration store snmp-config.xml.
This example changes the community string for the IP address 10.1.1.1 to yRuSonoZ.

Step 3 - Create/Update the Requisition

This example adds 2 nodes to the Provisioning Group, customer-a.
Note that the foreign-source attribute typically has a 1 to 1 relationship to the name of the Provisioning Group requisition.
There is a direct relationship between the foreign- source attribute in the requisition and the foreign source policy specification.
Also, typically, the name of the provisioning group will also be the same.
In the following example, the ReST API will automatically create a provisioning group based on the value foreign-source attribute specified in the XML requisition.

A provisioning group file called etc/imports/customer-a.xml will be found on the OpenNMS Horizon system following the successful completion of this curl command and will also be visible via the WebUI.

Add, Update, Delete operations are handled via the ReST API in the same manner as described in detailed specification.

9.8. Provisioning Single Nodes (Quick Add Node)

Adding a Node to a Current Requisition

Often, it is requested that a single node add/update be completed for an already defined provisioning group.
There is a ReST API for the Add Node implementation found in the OpenNMS Horizon Web-UI.
For this to work, the provisioning group must already exist in the system even if there are no nodes defined in the group.

9.9.1. Create a new requisition

provision.pl provides easy access to the requisition REST service using the requisition option:

${OPENNMS_HOME}/bin/provision.pl requisition customer1

This command will create a new, empty (containing no nodes) requisition in OpenNMS Horizon.

The new requisition starts life in the pending state.
This allows you to iteratively build the requisition and then later actually import the nodes in the requisition into OpenNMS Horizon.
This handles all adds/changes/deletes at once.
So, you could be making changes all day and then at night either have a schedule in OpenNMS Horizon that imports the group automatically or you can send a command through the REST service from an outside system to have the pending requisition imported/reimported.

You can get a list of all existing requisitions with the list option of the provision.pl script:

${OPENNMS_HOME}/bin/provision.pl list

Create a new Node

${OPENNMS_HOME}/bin/provision.pl node add customer1 1 node-a

This command creates a node element in the requisition customer1 called node-a using the script’s node option. The node’s foreign-ID is 1 but it can be any alphanumeric value as long as it is unique within the requisition.
Note the node has no interfaces or services yet.

Add an Interface Element to that Node

${OPENNMS_HOME}/bin/provision.pl interface add customer1 1 127.0.0.1

This command adds an interface element to the node element using the interface option to the provision.pl command and it can now be seen in the pending requisition by running provision.pl requisition list customer1.

This will cause OpenNMS Horizon Provisiond to import the pending customer1 requisition.
The formerly pending requisition will move into the deployed state inside OpenNMS Horizon.

Deleting a Node from a Requisition

Very much the same as the add, except that a single delete command and a re-import is required.
What happens is that the audit phase is run by Provisiond and it will be determined that a node has been removed from the requisition and the node will be deleted from the DB and all services will stop activities related to it.

9.11. Service Detectors

9.11.1. SNMP Detector

This detector is used to find and assigns services based on SNMP.
The detector binds a service with a given Service Name when a particular SNMP OID as scalar or table matches a given criteria.

Detector facts

Implementation

org.opennms.netmgt.provision.detector.snmp.SnmpDetector

Configuration and Usage

Table 95. Parameters for the SNMP detector

Parameter

Description

Required

Default value

oid

SNMP OID for scalar or table to detect the service.

required

.1.3.6.1.2.1.1.2.0

retry

Number of retries to detect the service.

optional

agent config

timeout

Timeout in milliseconds to wait for a response from the SNMP agent.

optional

agent config

vbvalue

expected return value to detect the service; if not specified the service is detected if the SNMP OID
returned any kind of valid value.
The vbvalue is evaluated as
Java Regular Expression.

optional

-

hex

Set true if the data is from type HEX-String.

optional

false

isTable

Set true if detector should evaluate SNMP tables.

optional

false

matchType

Set match type to evaluate the expected value in the SNMP table.EXIST: the expected vbalue is ignored, service detected if the given table under OID existALL: all values in the table must match against expected vbalue to detect serviceANY: at least one value in the table must match against expected vbalue to detect serviceNONE: None of the values should match against expected value to detect service

optional

EXIST

Example for SNMP scalar value

We have Dell server farm and want to monitor the global server status provided by the OpenManage Server Administrator.
Global status is provided by a scalar OID.1.3.6.1.4.1.674.10892.1.200.10.1.2.1.
The service should be automatically detected if the server supports this OID.

For provisioning we have a requisition named Server which contains all server of our data center.
A Detector with the name Dell-OMSA-Global-State for this requisition is created with the following parameter:

Table 96. Parameters for the SNMP detector

Parameter

Value

Name

Dell-OMSA-Global-State

oid

.1.3.6.1.4.1.674.10892.1.200.10.1.2.1

When the requisition Server is synchronized the service Dell-OMSA-Global-State will be detected in case they support the given SNMP OID.

Example using SNMP tables

We have a HP server farm and want to monitor the status of logical drives over SNMP provided from HP Insight Manager.
The status for logical drives is provided in a SNMP Table under .1.3.6.1.4.1.232.3.2.3.1.1.4.
The service should be automatically assigned to all servers exposing the given SNMP OID.

For provisioning we have a requisition named Server which contains all server of our data center.
A Detector with the name HP-Insight-Drive-Logical for this requisition is created with the following parameter:

Table 97. Parameters for the SNMP detector

Parameter

Value

Name

HP-Insight-Drive-Logical

oid

.1.3.6.1.4.1.232.3.2.3.1.1.4

isTable

true

When the requisition Server is synchronized the service HP-Insight-Drive-Logical will be detected in case they support the given SNMP OID table.

9.11.2. WS-Man Detector

The WS-Management detector attempts to connect to the agent defined in wsman-config.xml and issues an Identify command.
If the Identify command is successful, the service is marked as detected and the product details returned by the command are optionally stored in the asset fields (see details bellow.)

Detector facts

Implementation

org.opennms.netmgt.provision.detector.wsman.WsManDetector

Configuration and Usage

Table 98. Parameters for the <DETECTOR-NAME-HERE>

Parameter

Description

Required

Default value

updateAssets

Stores the product vendor and product version in the vendor and modelNumber asset fields

false

true

Examples

If a valid response to the Identify command is received, the product vendor and product version are stored in the vendor and modelNumber fields of the associated node`s assets table.

For example, a Windows Server 2008 machine returns:

Product Vendor

Microsoft Corporation

Product Version

OS: 6.1.7601 SP: 1.0 Stack: 2.0

If these assets field are being used for another purpose, this behavior can be disabled by settings the updateAssets parameters to false in the detector configuration of the appropriate foreign source.

Some agents may respond to the Identify command with generic identities such as Openwsman2.0.0.
These values can be overridden by specifying the product-vendor and product-version attributes in wsman-config.xml.

10. Business Service Monitoring

This section describes how to model and configure Business Services (BS) and orchestrate them in a hierarchy.
The concepts and usage of the section Business Service Monitoring from the User Guide is presumed.

Business Service Monitoring (BSM) includes the following components:

Business Service Monitoring Daemon (BSMD): Maintains and drives the state of all BS

Business Service Editor: Web application which allows you to create, update or delete BS

Topology View for Business Services: Visual representation of the Business Service Hierarchy as a component of the Topology User Interface.

BSM ReST API: ReST based API to create, read, update or delete BS

10.1. Business Service Definition

The status of Service Monitors and any kind of Alarm can be used to drive the Operational Status of a BS.
A BS is defined with the following components:

Business Service Name: A unique name used to identify the BS

Edges: A set of elements on which this BS relies which can include other BS, or Reduction Keys.

Reduce Function: Function used to aggregate the Operational Status from all the Edges.
Specific functions may take additional parameters.

Attributes: Optional key/value pairs that can be used to tag or enrich the Busines Service with additional information.

Each Business Service can contain a list of optional key/value attributes.
These can be used to identify or tag the BS, and may be reference in other workflows.
These attributes do not affect the dependencies or the status calculation of the BS.

Attributes can be used to filter BS in Ops Board dashlets.

The Business Service Editor is used to manage and model the Business Services and their hierarchy.
It is required to have administrative permissions and is available in "Login Name → Configure OpenNMS → Manage Business Services" in the Service Monitoring section.

Managing Business Services with the Business Service Editor

1

Create a new Business Service definition

2

Collapse tree view for all Business Services in the view

3

Expand tree view for all Business Services in the view

4

Reload all Business Services in the view with current Business Services from the system

5

Reload the Business Service Monitoring Daemon to use the Business Service definition as configured

6

Business Service dependency hierarchy as tree view

7

Show the current Business Service with dependencies in the Topology UI

10.2. Edges

Edges map the Alarm status monitoring with OpenNMS

The following types can be used:

Child Service: A reference to an existing Business Service on which to depend

IP Service: A convenient way to refer to the alarms that can be generated by a monitored IP Service. This will automatically provided edges for the nodeLostService, interfaceDown and nodeDown reductions keys of the specified service.

Reduction Key: A resolved Reduction Key used to refer to a specific Alarm, e.g. generated by a SNMP Trap or Threshold violation

If you need help determining the reduction key used by alarm, trigger the alarm in question and pull the reduction key from the Alarm details page.

All edge types have the following parameters:

Map Function: The associated Map Function for this Edge

Weight: The relative Weight of this edge. Used by certain Reduce Functions.

Both IP Service and Reduction Key type edges also support a Friendly Name parameter which gives the user control on how the edge is labeled in the Topology User Interface.
The editor changing the Edge attributes is shown in figure Editor to add Business Service Edges.

Editor to add Business Service Edges

10.2.1. Child Services

To create a hierarchy of Business Services they need to be created first.
The hierarchy is build by selecting the Business Service as_Child Service_ as dependency.

10.2.2. IP Services

The IP Service is a predefined set of Reduction Keys which allows easily to assign a specific Monitored Service to the given BS.
As an example you have multiple Servers with a Monitored ServiceSMTP and you want to model a BS named Mail Communication.
If just the Reduction Key for a nodeLostService is assgined, the BS would not be affected in case the IP Interface or the whole Node goes down.
OpenNMS generates Alarms with different UEI which needs to be assigned to the BS as well.
To make it easier to model this use case the IP Service generates the following Reduction Keys automatically:

uei.opennms.org/nodes/nodeLostService:%nodeId%:%ipAddress%:%serviceName%: Matches Alarms when the given Monitored Service goes down

uei.opennms.org/nodes/interfaceDown:%nodeId%:%ipAddress%: Matches Alarms when the given IP Interface of the Monitored Service goes down

uei.opennms.org/nodes/nodeDown:%nodeId%: Matches Alarms when the given Node of the Monitored Service goes down

10.2.3. Custom Reduction Key

The Reduction Key edge is used to refer to specific instance of alarms.
When an alarm with the given Reduction Key is present, the alarms' severity will be used to calculate the Operational Status of the BS.
To give a better explanation a Friendly Name can be set and is used in the Business Service View.
The format of the Reduction Key is build by a set of attributes as a key separated by : and enclosed in %, i.e (%attribute%:%attribute%).

10.3. Map Functions

The Map Functions define how the Severity of the edge will be used in the Reduce Function of the parent when calculating the Operational Status.

The available Map Functions are:

Table 99. Calculation of the Operational Status with Map Functions

Name

Description

Identity

Use the same Severity as Operational Status of the BS

Increase

Increase the Severity by one level and use it as Operational Status of the BS

Decrease

Decrease the Severity by one level and use it as Operational Status of the BS

SetTo

Set the Operational Status to a constant Severity value

Ignore

The input of the Edge is ignored for Operational Status calculation

10.4. Reduce Functions

A Reduce Function is used to aggregate the Operational Status for the BS.
The Alarm Severity from the Edges are used as input for the Reduce Function.
For this operation the following Reduce Functions are available:

Table 100. Status calculation Reduce Functions

Name

Description

Highest Severity

Uses the value of the highest severity, Weight is ignored.

Threshold

Uses the highest severity found more often than the given threshold, e.g. 0.26 can also be seen as 26%, which means at least 2 of 4 Alarms need to be raised to change the BS.

Highest Severity Above

Uses the highest severity greater than the given threshold severity.

Exponential Propagation

This reduce function computes the sum of the given child severities based on a base number. For this computation the severities are mapped to
numbers:

\$WARNING=0, MINOR=1, MAJOR=2, CRITICAL=3\$

All other severities are ignored.

For the aggregation the following formula will be used to compute the resulting Business Service severity from its n child entities based on the base number b:

\$severity = |__log_{b}( sum_(i=1)^n b^(ch\ildSeverity_{i}) )__|\$

In summary the base value defines how many items of a severity x will result in a severity x+1.
Results lower as 0 are treated as NORMAL and results higher than 3 are treated as CRITICAL.
If all input values are of severity INDETERMINATE, the result is INDETERMINATE.

For example if the Business Service depends on four child entities with the severities WARNING, WARNING, NORMAL and NORMAL and the base defined by the number 2 the following computation will be made:

The following table shows the status calculation with Edges assigned to an IP Service.
The IP-Service is driven by the monitoring of the ICMP service for three Web Server.
In the table below you find a configuration where Web Server 3 is weighted 3 times higher than the other and a threshold of 0.33 (33%) is configured.

Table 101. Example for status calculation using the Threshold function

Name

Weight

Weight Factor

Input Severity

Operational Status

Critical

Major

Minor

Warning

Normal

Web-ICMP-1

1

0.2

Critical

Critical

0.2

0.2

0.2

0.2

0.2

Web-ICMP-2

1

0.2

Normal

Normal

0

0

0

0

0.2

Web-ICMP-3

3

0.6

Warning

Warning

0

0

0

0.6

0.6

Total

1.0

0.2

0.2

0.2

0.8

1

Percentage

100%

20%

20%

20%

80%

100%

The Operational Status Severity is evaluated from left to right, the first value higher then the configured Threshold is used.
In this case the Operational Status is set to Warning because the first threshold which exceeds 33% is Warning with 80%.

10.5. Business Service Daemon

The calculation of the Operational Status of the BS is driven by the Business Service Monitoring Daemon (bsmd).
The daemon is responsible for tracking the operational status of all BS and for sending events in case of operational status changes.

In order to calculate the Operational Status the reduction key associated with a Business Service is used.
The reduction key is obtained from an alarm generated by OpenNMS Horizon.
This means that the alarm’s reduction key of a defined Business Service must not change afterwards.
Otherwise bsmd is not able to calculate the Operational Status correctly.
This also applies for removing the alarm data from events associated to Business Services
In addition the child type "IP Service" from the Business Service Configuration Page requires the following events with the default reduction keys being defined:
* uei.opennms.org/nodes/nodeLostService
* uei.opennms.org/nodes/nodeDown
* uei.opennms.org/nodes/interfaceDown

Every time the configuration of a Business Service is changed a reload of the daemon’s configuration is required.
This includes changes like the name of the Business Service or its attributes as well as changes regarding the Reduction Keys, contained Business Services or IP Services.
The bsmd configuration can be reloaded with the following mechanisms:

Click the Reload Daemon button in the Business Service Editor

Send the reloadDaemonConfig event using send-event.pl or use the WebUI in Manually Send an Event with parameter daemonName bsmd

Use the ReST API to perform a POST request to /opennms/api/v2/business-services/daemon/reload

If the reload of the configuration is done an event of type uei.opennms.org/internal/reloadDaemonConfigSuccessful is fired.

11. Topology Map

11.1. Properties

The Topology Map supports the following properties, which can be influenced by changing the file etc/org.opennms.features.topology.app.cfg:

Property

Type

Default

Description

showHeader

Boolean

true

Defines if the OpenNMS Horizon header is shown.

autoRefresh.enabled

Boolean

false

If enabled, auto refresh is enabled by default.

autoRefresh.interval

Integer

60

Defines the auto refresh interval in seconds.

hiddenCategoryPrefix

String

empty String

A String which allows hiding categories. For example a value of server will hide all categories starting with server.
Be aware, that this setting is case-sensistive, so Servers will be shown.
The resolution is only enabled if no longitude/latitude information is available.

11.2. Icons

Each Vertex on the Topology Map is represented by an icon.
The default icon is configured in the icon mapping file: ${OPENNMS_HOME}/etc/org.opennms.features.topology.app.icons.<topology-namespace>.cfg.
If an icon mapping file does not exist for a Topology Provider, the provider does not support customization.

A Topology Provider dependent string which maps to an icon id.
An icon key consists of one to multiple segments.
Each segment must contain only numbers or characters.
If multiple segments exist they must be separated by ., e.g. my.custom.key.
Any existing default icon keys are not configurable and should not be changed.

Icon id

The icon id is a unique icon identifier to reference an icon within one of the available SVG icons located in ${OPENNMS_HOME}/jetty-webapps/opennms/svg.
For more details see Add new icons.

If the Enterprise OID of a node is 1.3.6.1.4.1.9.1.485 the icon with id server1 is used.
If the Enterprise OID of a node is 1.3.6 the icon with id server2 is used.
However, if the Enterprise OID of a node is 1.3.6.1.4.1.9.1.13 the icon with id server2 is used.

Linkd Topology Provider

The Linkd Topology Provider uses the Enterprise OID from each node to determine the icon of a vertex.

11.2.2. Change existing icon mappings

The easiest way to change an icon representation of an existing Vertex is to use the Icon Selection Dialog from the Vertex' context menu in the Topology Map.
This will create a custom icon key to icon id mapping in the Topology Provider specific icon mapping file.
As icon key the Vertex id is used.
This allows each Vertex to have it’s own icon.

If a more generic approach is preferred the icon mapping file can be modified manually.

Do NOT remove the default mappings and do NOT change the icon keys in the default mappings.

11.2.3. Add new icons

All available icons are stored in SVG files located in ${OPENNMS_HOME}/jetty-webapps/opennms/svg.
To add new icons, either add definitions to an existing SVG file or create a new SVG file in that directory.

Whatever way new icons are added to OpenNMS it is important that each new icon id describes a set of icons, rather than a single icon.
The following example illustrates this.

Each icon must be in a SVG group with the id <icon id>_icon.
Each SVG <icon id>_icon group must contain three sub groups with the ids: <icon id>_active, <icon id>_rollover and <icon id>.

2

The icon to use when the Vertex is selected.

3

The icon to use when the Vertex is moused over.

4

The icon to use when the Vertex is not selected or not moused over (just visible).

It is important that each icon id is unique overall SVG files. This means there cannot be another my-custom icon id in any other SVG file.

If the new icons should be selectable from the Topology Map’s Icon Selection Dialog an entry with the new icon id must be added to the file ${OPENNMS_HOME}/etc/org.opennms.features.topology.app.icons.properties.

The order of the entries in org.opennms.features.topology.app.icons.list determine the order in the Icon Selection Dialog in the Topology Map.

12. Asset Topology Provider

12.1. Overview

OpenNMS Horizon has introduced the ability for users to define arbitrarily complex
layered topologies using GraphML (see http://graphml.graphdrawing.org/).
The details of how OpenNMS Horizon interprets GraphML are given in the
GraphML section of the OpenNMS Horizon developers guide. The ability to display
complex layered topologies is a great feature but creating a usable GraphML topology for a
large network can be a complex task for a user.

The Asset Topology Provider avoids the need for users to work directly with GraphML
by directly generating a layered GraphML topology based upon node parameters and the contents of the Node Asset table.
The Asset Topology Provider greatly simplifies the task for many use cases by allowing users
to define fields in the Node Asset table which will enable nodes to be positioned correctly
in a complex topology. This allows a physical and logical ordering of nodes which makes
it easier for users to represent and navigate their infrastructure.

The structure of the generated topology is determined by the assetLayers configuration
constant which can be set by a user. To illustrate how this works, we will consider the following configuration:

assetLayers=asset-region,asset-building

The OpenNMS Horizon Asset table is parsed to generate nested layers in
the order of the comma separated keys in the assetLayers property.
Each layer is a graph which is named after the key. Graph nodes in each layer reference
related Graph nodes in the underlying layer. The lowest layer contains Graph nodes which
are directly linked to monitored OpenNMS Horizon nodes which have entries in the Asset table.

The following diagram shows the structure of a topology generated by the above assetLayers property

In this example the region asset fields for node 1,2,3,4 are set to north.
All of these nodes are in the same north region. The building asset fields
for Node 1 and Node 2 are set to 21 (both nodes are in building 21) while the
building asset fields for Node 3 and Node 4 are set to 22 (both nodes are in building 22).

The Asset Topology Provider generates four linked graphs for this configuration.
The layer 0 graph is called asset-region, the layer 1 graph is called asset-building
and the layer 2 graph is called nodes.

Conceptually we can see that the topology is rendered as concentric sets.
The Asset Topology Provider first searches all of the nodes with regions
defined and creates a new level 0 graph node representing each region found.
The Asset Topology Provider then searches within each region to find the building entries and
creates a corresponding level 1 graph node for each building name found. Finally the Asset Topology Provider
creates layer 2 nodes corresponding to each OpenNMS Horizon monitored node and places each in the correct building.

If however OpenNMS Horizon monitored nodes are found which have either the region
or building asset fields empty they cannot be placed correctly in this topology.
These nodes as shown in the diagram as unallocated nodes.
Finally, only building and region nodes are generated which can be linked to OpenNMS Horizon nodes in the topology.
The Asset Topology Provider does not generate spurious graph nodes in upper
layers which are not directly and completely referenced by OpenNMS Horizon nodes in the lowest layer.

12.2. Asset layers

The entries for assetLayers can be any node or asset entry from the following list (defined in class NodeParamLabels).
Keys beginning with node- come from the node table.
Keys beginning with parent- come from the node table entry of the designated parent node (If defined).
Keys beginning with asset- come from the corresponding asset table entry for the given node (If defined).

node-nodelabel

node-nodeid

node-foreignsource

node-foreignid

node-nodesysname

node-nodesyslocation

node-operatingsystem

node-categories

parent-nodelabel

parent-nodeid

parent-foreignsource

parent-foreignid

asset-address1

asset-address2

asset-city

asset-zip

asset-state

asset-latitude

asset-longitude

asset-region

asset-division

asset-department

asset-building

asset-floor

asset-room

asset-rack

asset-slot

asset-port

asset-circuitid

asset-category

asset-displaycategory

asset-notifycategory

asset-pollercategory

asset-thresholdcategory

asset-managedobjecttype

asset-managedobjectinstance

asset-manufacturer

asset-vendor

asset-modelnumber

asset-description

asset-operatingsystem

asset-country

This allows arbitrary topologies to be generated including physical fields (room, rack etc.) and
logical fields such as asset node categories. Please note you should not put any spaces in the comma separated assetLayers list.
If the assetLayers property is defined as empty then a single graph layer will be generated containing all opennms nodes.

12.3. Node filtering

In many cases it is desirable to control which nodes are included or excluded from a topology. For instance it is
useful to be able to generate customised topologies for specific customers which include only regions/buildings etc
relevant to their filtered node set. To this end it is possible to define a node filter
which chooses which nodes are included in a generated topology.

Filters are defined using the same asset table keys which are available for the assetLayers field.

Operation

Definition

Example

OR

key1=value1,value2 alternatively key1=value1;key1=value2

asset-region=north,south

AND

key1=val1;key2=val2

asset-region=north;asset-building=23

NOT

key1=!val1

asset-building=!23

Thus the following configuration means include only nodes with region north or south but exclude all nodes with building 23.

filter=asset-region=north,south;asset-building=!23

The filters are designed to treat all selected text key entries as comma separated values (csv). This allows OpenNMS node-categories which are
many to many entries to be dealt with as a comma separated list of values; routers,servers,web etc.
Thus we can select based on multiple separate node categories. The following configuration means show routers and servers on all buildings except building 23.

filter=node-categories=routers,servers;asset-building=!23

The filters treat all asset table entries as comma separated variables (csv). This also means that,
for instance asset-displaycategory could also contain several values separated by commas. e.g. customer1,customer2,customer3 etc.

You should make sure asset addresses and other free format asset text fields do not contain commas if you want an exact match on the whole field

Regular expressions are also allowed. Regular expressions start with the ~ character.
You can also negate a regular expression by preceding it with !~.

The following example will match against regions 'Stuttgart' and 'Isengard' and any building name which ends in 4

filter=asset-region=~.*gar(t|d);asset-building=~.*4

12.4. Configuration

The Asset Topology Provider persists both the asset topology graph definitions and the generated GraphML graphs.
The persisted definitions mean that is is possible to regenerate graphs if the asset table is changed without reentering the configuration.

The Asset Topology Provider persists GraphML graphs along side any other GraphML graphs in the directory;

<opennms home>/etc/graphml

Please note that if you are using ReST or any other means to generate other GraphML graphs, you should ensure that
the providerIds and labels are distinct from those used by the Asset Topology Provider

The asset graph definitions for the Asset Topology Provider are persisted to the following xml configuration file:

12.7. Viewing the topology

If all goes well, having installed the topology, upon refreshing your screen,
you should see a new topology display option in the OpenNMS Horizon topology page.
The displayed name of this topology is given by the label field

The label field need not be the same as the providerId which is used by the ReST api for the installation
or removal of a topology. However the label field must be unique across all installed topologies.

It is possible to have several topologies installed which have been generated using different configurations.
You simply need to ensure that the providerId and label field used for each installation command is different.

12.8. additional notes

Please note you MUST first uninstall an OpenNMS Horizon graphml topology before installing a new one.
You will also have to log out and log back into the UI in order to see the new topology file.
If you uninstall a topology while viewing it, the UI will throw an error and
you will also have to log out and back in to see the remaining topologies.

13. Database Reports

Reporting on information from the OpenNMS Horizon monitoring system is important for strategical or operational decisions.
Database Reports give access to the embedded JasperReports engine and allows to create and customize report templates.
These reports can be executed on demand or on a pre-defined schedule within OpenNMS Horizon.

Originally Database Reports were introduced to create reports working on data stored in the OpenNMS Horizon database only.
This is no longer mandatory, also performance data can be used.
Theoretically the reports do not necessarily need to be OpenNMS Horizon related.

The OpenNMS Horizon Report Engine allows the creation of various kinds of reports and also supports distributed report repositories.
At the moment these features are not covered by this documentation.
Only reports using JasperReports are described here.

13.1. Overview

The OpenNMS Horizon Report Engine uses the JasperReport library to create reports in various output formats.
Each report template must be a *.jrxml file.
The OpenNMS Horizon Report Engine passes a JDBC Connection to the OpenNMS Horizon Database to each report on execution.

Table 102. feature overview

Supported Output Formats

PDF, CSV

JasperReport Version

6.3.0

For more details on how JasperReports works, please have a look at the official documentation of Jaspersoft Studio.

13.2. Modify existing reports

All default reports of OpenNMS Horizon are located in $OPENNMS_HOME/etc/report-templates.
Each .jrxml file located there can be modified and the changes are applied the next time a report is created by OpenNMS Horizon.

When a subreport has been modified OpenNMS Horizon will detect a change based on the report’s lastModified time and will recompile the report.
A compiled version of the report is represented by a .jasper file with the same name as the .jrxml file.
Subreports are located in $OPENNMS_HOME/etc/report-templates/subreports.

If unsure, simply delete all .jasper files and OpenNMS Horizon will automatically compile the subreports if needed.

13.3. Add a custom report

To add a new JasperReport report to the Local OpenNMS Horizon Report Repository, the following steps are required.

At first a new entry in the file $OPENNMS_HOME/etc/database-reports.xml must be created.

The identifier defined in the previous step. This identifier must exist in $OPENNMS_HOME/etc/database-reports.xml.

2

The name of the template. The template must be located in $OPENNMS_HOME/etc/report-templates.

3

The engine to use. It is either jdbc or null.

13.4. Usage of Jaspersoft Studio

When developing new reports it is recommended to use the Jaspersoft Studio application.
It can be downloaded here.

We recommend always to use the same Jaspersoft Studio version as the JasperReport library OpenNMS Horizon uses.
Currently OpenNMS Horizon uses version 6.3.0.

13.4.1. Connect to the OpenNMS Horizon Database

In order to actually create SQL statements against the OpenNMS Horizon database a database Data Adapter must be created.
The official Jaspersoft Studio documentation and wiki covers this aspect.

13.4.2. Use Measurements Datasource and Helpers

To use the Measurements API it is required to add the Measurements Datasource library to the build path of JasperStudio.
This is achieved with right click in the Project Explorer and select Configure Buildpath.

Switch to the Libraries tab.

Click Add External JARs and select the opennms-jasperstudio-extension-21.1.0-SNAPSHOT-jar-with-dependencies.jar file located in $OPENNMS_HOME/contrib/jasperstudio-extension.

Close the file selection dialog.

Close the dialog.

The Measurements Datasource and Helpers should now be available.

Go to the Dataset and Query Dialog in Jaspersoft Studio and select a language called measurement.

Even if there is no Read Fields functionality available, the Data preview can be used.
It is required the the access to the Measurements API is possible using the connection parameters MEASUREMENT_URL, MEASUREMENT_USERNAME and MEASUREMENT_PASSWORD.
The Supported Fields section gives more details. In addition you have

13.5. Accessing Performance Data

Before OpenNMS Horizon 17 and OpenNMS Meridian 2016 it was possible to access the performance data stored in .rrd or .jrobin files directly by using the jrobin language extension provided by the RrdDataSource.
This is no longer possible and the Measurements Datasource has to be used.

To access performance data within reports we created a custom Measurement Datasource which allows to query the Measurements API and process the returned data in your reports.
Please refer to the official Measurements API documentation on how to use the _Measurements API_.

When using the Measurements Datasource within a report a HTTP connection to the Measurements API is only established if the report is NOT running within OpenNMS Horizon, e.g. when used with Jaspersoft Studio.

To receive data from the Measurements API simply create a query as follows:

13.6. Helper methods

There are a couple of helper methods to help creating reports in OpenNMS Horizon.

These helpers come along with the Measurement Datasource.

Table 103. supported helper methods

Helper class

Helper Method

Description

org.opennms.netmgt.jasper.helper.MeasurementsHelper

getNodeOrNodeSourceDescriptor(nodeId, foreignSource, foreignId)

Generates a node source descriptor according to the input paramters. Either node[nodeId] or nodeSource[foreignSource:foreignId] is returned.
nodeSource[foreignSource:foreignId] is only returned if foreignSource and foreignId is not empty and not null.
Otherwise always node[nodeId] is returned.

nodeId : String, the id of the nodeforeignSource: String, the foreign source of the node, may be nullforeignId: String, the foreign id of the node, may be null.

Returns the interface descriptor of a given interface, e.g. en0-005e607e9e00.
The input paramaters are prioritized. If a snmpifdescr is specified, it is used instead of the snmpifname.
It a snmpifdescr is defined, it will be appended to snmpifname/snmpifdescr.

snmpifname: String, the interface name of the interface, e.g. en0. May be null.snmpifdescr: String, the description of the interface, e.g. en0. May be null.snmphyaddr: String, the mac address of the interface, e.g. 005e607e9e00. May be null.
As each input parameter may be null, not all of them can be null at the same time. At least one input parameter has to be defined.

To get the appropriate interface descriptor depends on the input parameter.

13.6.4. Use HTTPS

To establish a secure connection to the Measurements API the public certificate of the running OpenNMS Horizon must be imported to the Java Trust Store.
In Addition OpenNMS Horizon must be configured to use that Java Trust Store.
Please follow the instructions in this chapter to setup the Java Trust Store correctly.

In addition please also set the property org.opennms.netmgt.jasper.measurement.ssl.enable in $OPENNMS_HOME\etc\opennms.properties to true to ensure that only secure connections are established.

If org.opennms.netmgt.jasper.measurement.ssl.enable is set to false an accidentally insecure connection can be established to the Measurements API location.
A SSL secured connection can be established even if org.opennms.netmgt.jasper.measurement.ssl.enable is set to false.

13.7. Limitations

Only a JDBC Datasource to the OpenNMS Horizon Database connection can be passed to a report, or no datasource at all.
One does not have to use the datasource, though.

14. Enhanced Linkd

Enhanced Linkd (Enlinkd) has been designed to discover connections between nodes using data generated by various link discovery protocols and accessible via SNMP.
Enlinkd gathers this data on a regular interval and creates a snapshot of a device’s neighbors from its perspective.
The connections discovered by Enlinkd are called Links.
The term Link, within the context of Enlinkd, is not synonymous with the term "link" when used with respect to the network OSI Layer 2 domain, whereby a link only indicates a Layer 2 connection.
A Link in context of Enlinkd is a more abstract concept and is used to describe any connection between two OpenNMS Horizon Nodes.
These Links are discovered based on information provided by an agent’s understanding of connections at the OSI Layer 2, Layer 3, or other OSI layers.

The following sections describe the Enlinkd daemon and its configuration.
Additionally, the supported Link discovery implementations will be described as well as a list of the SNMP MIBs that the SNMP agents must expose in order for EnLinkd to gather Links between Nodes.
FYI: Detailed information about a node’s connections (discovered Links) and supporting link data can be seen on the Node detail page within the OpenNMS Horizon Web-UI.

14.1. Enlinkd Daemon

Essentially Enlinkd asks each device the following question: "What is the network topology from your point of view".
From this point of view this will only provide local topology discovery features.
It does not attempt to discover global topology or to do any correlation with the data coming from other nodes.

For large environments the behavior of Enlinkd can be configured.
During the Link discovery process informational and error output is logged to a global log file.

Time in milliseconds to wait for discovering the topology after OpenNMS Horizon is started.

rescan_interval

Integer

86400000

Interval to rediscover and update the topology in milliseconds.

use-cdp-discovery

Boolean

true

Enable or disable topology discovery based on CDP information.

use-bridge-discovery

Boolean

true

Enable or disable algorithm to discover the topology based on the Bridge MIB information.

use-lldp-discovery

Boolean

true

Enable or disable topology discovery based on LLDP information.

use-ospf-discovery

Boolean

true

Enable or disable topology discovery based on OSPF information.

use-isis-discovery

Boolean

true

Enable or disable topology discovery based on IS-IS information.

If multiple protocols are enabled, the links will be discovered for each enabled discovery protocol.
The topology WebUI will visualize Links for each discovery protocol.
For example if you start CDP and LLDP discovery, the WebUI will visualize a CDP Link and an LLDP Link.

14.2. Layer 2 Link Discovery

Enlinkd is able to discover Layer 2 network links based on the following protocols:

This information are provided by SNMP Agents with appropriate MIB support.
For this reason it is required to have a working SNMP configuration running.
The following section describes the required SNMP MIB provided by the SNMP agent to allow the Link Discovery.

14.2.1. LLDP Discovery

The Link Layer Discovery Protocol (LLDP) is a vendor-neutral link layer protocol.
It is used by network devices for advertising their identity, capabilities, and neighbors.
LLDP performs functions similar to several proprietary protocols, such as the Cisco Discovery Protocol (CDP), Extreme Discovery Protocol, Foundry Discovery Protocol (FDP), Nortel Discovery Protocol (also known as SONMP), and Microsoft’s Link Layer Topology Discovery (LLTD)[1].

Only nodes with a running LLDP process can be part of the link discovery.
The data is similar to running a show lldp neighbor command on the device.
Linux and Windows servers don’t have an LLDP process running by default and will not be part of the link discovery.

The following OIDs are supported to discover and build the LLDP network topology.

Table 106. Supported OIDs from LLDP-MIB

Name

OID

Description

lldpLocChassisIdSubtype

.1.0.8802.1.1.2.1.3.1.0

The type of encoding used to identify the chassis associated with the local system. Possible values can be:chassisComponent(1)interfaceAlias(2)portComponent(3)macAddress(4)networkAddress(5)interfaceName(6)local(7)

lldpLocChassisId

.1.0.8802.1.1.2.1.3.2.0

The string value used to identify the chassis component associated with the local system.

lldpLocSysName

.1.0.8802.1.1.2.1.3.3.0

The string value used to identify the system name of the local system.
If the local agent supports IETF RFC 3418, lldpLocSysName object should have the same value of sysName object.

lldpLocPortIdSubtype

.1.0.8802.1.1.2.1.3.7.1.2

The type of port identifier encoding used in the associated lldpLocPortId object.

lldpLocPortId

.1.0.8802.1.1.2.1.3.7.1.3

The string value used to identify the port component associated with a given port in the local system.

lldpLocPortDesc

.1.0.8802.1.1.2.1.3.7.1.4

The string value used to identify the 802 LAN station’s port description associated with the local system.
If the local agent supports IETF RFC 2863, lldpLocPortDesc object should have the same value of ifDescr object.

lldpRemChassisIdSubtype

.1.0.8802.1.1.2.1.4.1.1.4

The type of encoding used to identify the chassis associated with the local system. Possible values can be:chassisComponent(1)interfaceAlias(2)portComponent(3)macAddress(4)networkAddress(5)interfaceName(6)local(7)

lldpRemChassisId

.1.0.8802.1.1.2.1.4.1.1.5

The string value used to identify the chassis component associated with the remote system.

lldpRemPortIdSubtype

.1.0.8802.1.1.2.1.4.1.1.6

The type of port identifier encoding used in the associated lldpRemPortId object.

interfaceAlias(1)
the octet string identifies a particular instance of the ifAlias object (defined in IETF RFC 2863). If the particular ifAlias object does not contain any values, another port identifier type should be used.

portComponent(2)
the octet string identifies a particular instance of the entPhysicalAlias object (defined in IETF RFC 2737) for a port or backplane component.

networkAddress(4)
this string identifies a network address associated with the port.
The first octet contains the IANA AddressFamilyNumbers enumeration value for the specific address type, and octets 2 through N contain the networkAddress address value in network byte order.

interfaceName(5)
the octet string identifies a particular instance of the ifName object (defined in IETF RFC 2863).
If the particular ifName object does not contain any values, another port identifier type should be used.

agentCircuitId(6)
this string identifies a agent-local identifier of the circuit (defined in RFC 3046)

local(7)
this string identifies a locally assigned port ID.

lldpRemPortId

.1.0.8802.1.1.2.1.4.1.1.7

The string value used to identify the port component associated with the remote system.

lldpRemPortDesc

.1.0.8802.1.1.2.1.4.1.1.8

The string value used to identify the description of the given port associated with the remote system.

lldpRemSysName

.1.0.8802.1.1.2.1.4.1.1.9

The string value used to identify the system name of the remote system.

Generic information about the LLDP process can be found in the LLDP Information box on the Node Detail Page of the device.
Information gathered from these OIDs will be stored in the following database table:

Figure 21. Database tables related to LLDP discovery

14.2.2. CDP Discovery

The Cisco Discovery Protocol (CDP) is a proprietary link layer protocol from Cisco.
It is used by network devices to advertise identity, capabilities and neighbors.
CDP performs functions similar to several proprietary protocols, such as the Link Layer Discovery Protocol (LLDP), Extreme Discovery Protocol, Foundry Discovery Protocol (FDP), Nortel Discovery Protocol (also known as SONMP), and Microsoft’s Link Layer Topology Discovery (LLTD).
The CDP discovery uses information provided by the CISCO-CDP-MIB and CISCO-VTP-MIB.

Only nodes with a running CDP process can be part of the link discovery.
The data is similar to running a show cdp neighbor command on the IOS CLI of the device.
Linux and Windows servers don’t have a CDP process running by default and will not be part of the link discovery.