Geographical maps

:information_source: This article has been migrated from our wiki site. I have not personally tested this against current versions of OpenNMS.

As of version 1.12, OpenNMS includes a set of geographical maps which can show nodes with address asset information on a world map, including dynamic alarm status.

You can reach the geographical map UI by going to http://<your-opennms-ip>/opennms/node-maps or by going to the page of a node that has an address and/or longitude/latitude defined in its asset fields, and following the “View in Geographical Map” link.

Note that this is not the same as the remote poller geographical maps feature that has existed in previous OpenNMS versions. The plan is to merge the two codebases in a future release.

Markers and Clusters

The geographical maps display each node that has an address, or longitude and latitude in the database. When you first load the geographical map, it will look at each node. If the node has coordinates, it will display it on the map. If the node has an address, it will use a geolocation service to convert the address to coordinates, and then display it on the map.

The geographical maps will automatically cluster nodes into groups if they are close together. If you hover over a cluster (the circle marker with a number in it), it will show the boundaries of the nodes it contains. If you click a marker, it will show a summary of the nodes it contains.

Status

A node’s marker will display as the color associated with the most severe alarm for that node. A cluster’s marker will display as the color of the highest severity of the nodes the marker contains.

Normal: image

Warning: image

Minor: image

Major: image

Critical: image

Searching

The search bar has the ability to do a simple text search, as well as searching particular fields associated with the node.

Search Fields

The following fields can be searched:

nodeId : The ID of the node.
nodeLabel : A text description.
foreignSource : The provisioned foreign source, if any.
foreignId : The provisioned foreign ID, if any.
ipAddress : The primary IP address.
severityLabel : The severity. (“Normal”, “Warning”, etc.)
description : The description field from the node’s assets.
maintContract : The maintenance contract from the node’s assets.
category : Match a category, if any.

Note that all searches are done in a case-insensitive manner.

Substring Matching

To search for text in one of the fields, use the following syntax:

<fieldname>: <searchtext>

For example, if you have a node with the node label “mymachine.opennms.com”, searching for “nodelabel:machine” will match.

Exact Matching

To search for an exact match of a field, use the following syntax:

<fieldname>=<searchtext>

So, to match the same node label as the previous example, you would have to search for “nodelabel=mymachine.opennms.com”.

Linking To A Search

It is possible to make a link to the node-maps page that already has a pre-filled search. To do so, just add a “#” character, and then search/<your-search>.

For example, to link to the node label search from the substring match example above, you would link to:

http://&lt;your-opennms-ip&gt;/opennms/node-maps#search/nodelabel:machine

…or to search for the exact node label match, it would be:

http://&lt;your-opennms-ip&gt;/opennms/node-maps#search/nodelabel=mymachine.opennms.com


:woman_facepalming: You can fix me, I’m a wiki post.