Welcome to the OpenNMS Documentation

OpenNMS is an open source solution that helps you visualize and monitor everything on your local and remote networks. It offers comprehensive fault, performance, traffic monitoring, and alarm generation in one place. Highly customizable and scalable, OpenNMS easily integrates with your core business applications and workflows.


  • OpenNMS Horizon

    • Core (server that drives Horizon)

    • Minion (distritubed monitoring)

    • Sentinel (scale flow processing)

  • Plugin for Grafana, formerly HELM (customized dashboards)

  • Architecture for Learning Enabled Correlation (ALEC) (alarm correlation)

  • Provisioning Integration Server (PRIS) (advanced node provisioning)

  • OpenNMS.js (JavaScript library for interacting over REST)

  • Helm Charts (deploy on Kubernetes)

  • Velocloud Plugin (plugin to provision nodes from a Velocloud Orchestrator)

About this documentation

This documentation includes information on the OpenNMS components listed above, including deployment, configuration, use, and maintenance.


Suitable for administrative users and those who will use OpenNMS to monitor their network.

Typographical conventions

Convention Meaning


Indicates UI elements to click or select in a procedure, and the names of UI elements like dialogs or icons.


Introduces a defined or special word. Also used for the titles of publications.


Anything you must type or enter, and the names for code- or config-related elements (classes, methods, commands).

Need help?

OpenNMS is the creation of numerous people and organizations, operating under the umbrella of the OpenNMS project. The source code is published under the GNU Affero GPL, version 3 or later, and is Copyright © 2015-2023 The OpenNMS Group, Inc.

The current corporate sponsor of OpenNMS is The OpenNMS Group, which also owns the OpenNMS trademark.

Please report any omissions or corrections to this document by creating an issue at http://issues.opennms.org.

Permission is granted to copy, distribute, and/or modify this document under the terms of the GNU Free Documentation License, version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is available at http://www.gnu.org/copyleft/fdl.html

Copyright © 2015-2023 The OpenNMS Group, Inc.