Docs
Videos
OpenNMS 101 Training OpenNMS 102 Training OpenNMS on YouTube
Community Tools
Project Website JIRA Discourse Mattermost Chat Toolbox
OpenNMS Group
Training Commercial Support Sponsored Development
Archived Docs
GitHub

Horizon

  • Release Notes
    • What’s New in OpenNMS Horizon 32
    • Changelog
  • Deployment
    • OpenNMS Horizon
      • Minimum System Requirements
      • Installation and Configuration
      • Containerized Deployment
      • Set up Message Broker
      • Reset the Web UI Admin Password
    • Minion
      • Minimum System Requirements
      • Install Minion
      • Install JDBC Driver on Minion
      • Off-heap storage
    • Sentinel
      • Install Sentinel Runtime
    • Time Series Database
      • RRDtool
      • Newts
        • Configure Horizon to Use Newts
        • Configuration Reference
        • Cassandra Monitoring
        • Newts Monitoring
        • RRD/JRB to Newts Migration Utility
        • Newts Karaf Commands
      • Time Series Integration Layer
        • Enable Time Series Integration Layer
      • Cortex Time Series Plugin
    • Set up Jaeger Tracing
    • Upgrade Horizon
      • Identify Changed Configuration Files
      • Manage Configuration Changes with Git
      • Basic Upgrade Steps
      • Upgrade Horizon with Git
    • Back up OpenNMS Horizon
    • Restore OpenNMS Horizon
  • Operation
    • Overview
    • Quick Start
      • Step 1: First-Time Sign In
      • Step 2: Turn on Default Notifications
      • Step 3: Provision Inventory
      • Step 4: Set Up Performance Data Collection
      • Step 5: Set up a Threshold
      • Step 6: Establish a Baseline
      • Step 7: Determine Service Availability
      • Step 8: Configure Notifications
      • Step 9: Visualize Data
      • Beyond the Quick Start Guide
    • Deep Dive
      • User Management
        • User Creation and Configuration
        • Assign User Permissions
        • Groups
        • On-Call Roles
        • User Maintenance
        • Web UI Pre-Authentication
      • Provisioning
        • Configuration Options
          • Foreign Source Definition
          • Adapters
          • Detectors
          • Policies
          • Import Handlers
        • Directed Discovery
        • Auto Discovery
        • Integrating with Provisiond
        • Addressing Scalability
        • Fine-Grained provisioning using provision.pl
        • SNMP Profiles
      • Thresholding
        • Thresholding Tasks
        • Create a Threshold Group
          • Thresholding Service
          • Troubleshoot and Manage Thresholds
      • Service Assurance
        • Configure Pollerd
        • Improve Monitoring Efficiency
        • Detect Short Service Outages
        • Use Path Outages to Suppress Notifications
        • Poller Packages
        • Service Monitors
        • Scheduled Outages
        • Application Perspective Monitoring
        • Shell Commands
          • Pollerd Schedule
      • Device Configuration Backup
        • Configure Backup Script
        • Poller Configuration
        • Create Requisition for Device Configuration Backup
        • Manage Device Configuration Backups
      • Performance Management
        • Configure Collector Packages
        • Configuring Collectd
        • Data Types
        • Resource Types
          • Create a Custom Resource Type
        • Collectors
        • Graphing Metrics
        • SNMP Property Extenders
          • Cisco CBQoS property extender
          • Enum Lookup property extender
          • Index Split Property Extender
          • Pointer-Like Index Property Extender
          • Regex Property Extender
          • SNMP Interface Property Extender
          • Value Mapping Property Extender
        • Collectd Administration
          • Shell Commands
            • Ad hoc collection
            • Measurements & Resources
            • Stress Testing
            • Collectd Schedule
      • Events
        • Event Daemon Configuration
          • Event Definition
          • Replacement Tokens
          • Event Troubleshooting
        • Event Translator
        • Sources of Events
          • IBM Tivoli Event Integration Facility
          • Kafka Consumer (Events)
          • REST
          • Sink
          • SNMP Traps
          • Syslog Messages
          • TL1 Autonomous Messages
          • XML-TCP
        • SNMP Trap Performance Data
        • Advanced Event Search
      • Alarms
        • Configure Alarms
        • Alarm Lifecycle
        • Alarm Handling
        • Alarm Sounds
        • Alarm History
        • Advanced Alarm Search
        • IFTTT Integration
      • Notifications
        • Concepts
        • Notification Configuration
        • Notification Commands
        • Bonus Notification Methods
          • Mattermost Notifications
          • Slack Notifications
        • Notification Shell Commands
      • Business Service Monitoring
        • Business Service Definition
          • Edges
        • Business Service Topology
        • Operational Status
          • Map Functions
          • Reduce Functions
        • Root Cause and Impact Analysis
      • Topology
        • Topology Map
        • Asset Topology Provider
        • Enhanced Link Daemon
          • Shell Commands
          • Layer 2 Link Discovery
            • Link Layer Discovery
            • Cisco Discovery Protocol
            • Transparent Bridge Discovery
          • Layer 3 Link Discovery
            • OSPF Discovery
            • IS-IS Discovery
      • Database Reports
        • Report Templates
          • Availability by Node
          • Availability Summary
          • Default Classic
          • Default Calendar
          • Event Analysis
          • Grafana Dashboard
          • Interface Availability
          • Maintenance Contracts Expiring
          • Maintenance Contracts Strategy
          • Early Morning
          • Response Time Summary
          • Response Time by Node
          • Serial Interface Utilization
          • SNMP Interface Availability
          • Total Bytes Transferred by Interface
          • Traffic Rates for Nodes by Interface
      • Ticketing
      • Overriding SNMP Client Behavior
      • DNS Resolver
      • Telemetry Daemon
      • Elasticsearch Integration
        • Feature Matrix
        • Event Forwarder
          • Mapping Events to Elasticsearch
          • Table of Index Mapping
        • Flow Support
        • Situation Feedback
        • Alarm History
      • Flows
        • Basic Flows Setup
        • Using Minions as a Flow Collector
        • Scale Flow Processing with Sentinel
        • Flows Classification
        • Aggregate Flows with REST API
        • Data Collection of Flow Applications
        • Thresholding Flow Applications
        • Flows Troubleshooting
      • Geographical Maps
        • Map Search
      • Kafka Producer
        • Enable the Kafka Producer
        • Configure the Kafka Producer
        • Shell Commands
      • Alarm Correlation
      • Metadata
      • Search
      • SNMP Interface Poller
      • Visualizations
        • Horizon Dashboard
        • Grafana Dashboard Box
        • Heatmap
        • Operator Board
          • Boost Configuration
          • Criteria Builder
          • Dashlets
            • Alarm Details
            • Alarms
            • Charts
            • Grafana
            • Image
            • KSC Reports
            • Map
            • RRD
            • RTC
            • Summary
            • Surveillance
            • Topology
            • URL
        • Surveillance View
        • Trend
      • Horizon Administration
        • Horizon Configuration
          • Startup Configuration
          • Configure System Proxies
          • Configuration Tester
          • Daemon Configuration Files
          • Usage Statistics
          • Enable RMI
          • External Authentication
          • Geocoder Service
          • HTTPS/SSL
            • Secure Jetty with HTTPS
            • Enable Request Logs
            • SSL Client Connections
          • News Feed Configuration
          • SameSite Cookie Attribute
          • Secure Credentials Vault
          • Configure System Properties
        • Housekeeping Tasks
        • JMX Configuration Generator
          • CLI-Based Utility
          • Web-Based Utility
        • Logging
          • Instrumentation Log Reader
          • Log File Viewer
        • Shutdown and Restart Horizon
        • SNMP MIB Compiler
  • Development
    • Build from Source
      • Copyright Conventions and Guidelines
    • OSGi Integration
    • Minion
      • Container
      • Guidelines
      • Testing
    • Topology
      • Info Panel Items
      • GraphML
      • Topologies Updates
    • Graph Service API
    • CORS Support
    • REST API
      • Expose ReST services via OSGi
      • Interfaces
        • Acknowledgements
        • Alarm Statistics
        • Alarms
        • Alarm History
        • Events
        • Categories
        • Config Management
        • Device Config REST API
        • Discovery
        • Flow API
        • Flow Classification API
        • Foreign Sources
        • Graph API
        • Groups
        • Heatmap
        • Health Rest Service
        • Monitored Services
        • IP Interfaces
        • KSC Reports
        • Maps
        • Measurements API
        • Metadata
        • News Feed
        • Nodes
        • Node Links
        • Notifications
        • Outage Timelines
        • Outages
        • Perspective Poller
        • Requisitions
        • Resources API
        • Realtime Console Data
        • Scheduled Outages
        • SNMP Configuration
        • SNMP Interfaces
        • SNMP Metadata
        • Users
        • User-Defined Links
        • SNMP Trap Northbounder Interface Configuration
        • Email Northbounder Interface Configuration
        • JavaMail Configuration
        • Syslog Northbounder Interface Configuration
        • Business Service Monitoring
        • Situation Feedback
    • Plugin Development with the OpenNMS Plugin API
    • AMQP Integration
      • Event Forwarder
      • Event Receiver
      • Alarm Northbounder
      • Custom Processors
    • InMemory Ticketer
    • Jasper Report Guideline Design and Style Guidelines
  • Reference
    • Configuration
      • File Editor
      • Filters
        • OpenNMS components that use filters
        • Parameters
        • Rule formats
      • Core Docker
      • Minion Docker
        • Configuring Minion via confd
          • Prometheus JMX exporter
          • Test confd Templates
      • Sentinel Features
      • Tuning ActiveMQ
      • Tuning Apache Kafka
      • Time to Live (TTL) for RPCs
      • SELinux and ICMP permissions
      • Receive SNMP traps/informs
      • Install JDBC Driver on Horizon Core
    • Collectors
      • HttpCollector
      • JDBC Collector
      • JmxCollector
      • NSClientCollector
      • PrometheusCollector
      • SnmpCollector
      • TcaCollector
      • VmwareCollector
      • VmwareCimCollector
      • WmiCollector
      • WsManCollector
      • XmlCollector
    • Service Monitors
      • ActiveMQMonitor
      • BgpSessionMonitor
      • BSFMonitor
      • CiscoIpSlaMonitor
      • CiscoPingMibMonitor
      • CitrixMonitor
      • DeviceConfigMonitor
      • DhcpMonitor
      • DiskUsageMonitor
      • DnsMonitor
      • DskTableMonitor
      • DNSResolutionMonitor
      • FtpMonitor
      • HostResourceSwRunMonitor
      • HttpMonitor
      • HttpPostMonitor
      • HttpsMonitor
      • IcmpMonitor
      • ImapMonitor
      • ImapsMonitor
      • JCifsMonitor
      • JDBCMonitor
      • JDBCQueryMonitor
      • JDBCStoredProcedureMonitor
      • JmxMonitor
      • JolokiaBeanMonitor
      • LdapMonitor
      • LdapsMonitor
      • MailTransportMonitor
      • MemcachedMonitor
      • MinaSshMonitor
      • NetScalerGroupHealthMonitor
      • NrpeMonitor
      • NtpMonitor
      • OmsaStorageMonitor
      • OpenManageChassisMonitor
      • PageSequenceMonitor
      • PassiveStatusMonitor
      • PercMonitor
      • Pop3Monitor
      • PrTableMonitor
      • RadiusAuthMonitor
      • SmbMonitor
      • SmtpMonitor
      • SnmpMonitor
      • SshMonitor
      • SSLCertMonitor
      • StrafePingMonitor
      • SystemExecuteMonitor
      • TcpMonitor
      • TrivialTimeMonitor
      • VmwareCimMonitor
      • VmwareMonitor
      • WebMonitor
      • Win32ServiceMonitor
      • WmiMonitor
      • WsManMonitor
    • Telemetryd
      • Listener Reference
        • TCP Listener
        • UDP Listener
      • Protocol Reference
        • BGP Monitoring Protocol
          • BMP Setup
          • BMP TCP Parser
          • BMP Telemetry Adapter
          • BMP Peer Status Adapter
          • OpenBMP Integration Adapter
          • BMP Persisting Adapter
        • Cisco NX-OS Telemetry
        • Graphite Telemetry
        • IPFIX
        • Junos Telemetry Interface
        • NetFlow v5
        • NetFlow v9
        • OpenConfig Telemetry
        • sFlow
    • Ticketer
      • Jira Ticketing Plugin
      • TSRM Ticketing Plugin
    • Provisioning
      • Adapters
        • Dynamic DNS
        • GeoIP
        • Hardware Inventory
        • Reverse DNS
        • SNMP Asset
        • SNMP Metadata
        • WS-Man Asset
      • Import Handlers
        • DNS
        • File
        • HTTP(S)
        • VMware
        • Requisition Plugins
      • Policies
        • IP Interface Policy
        • Metadata Policies
        • Node Categorization Policy
        • Script Policy
        • SNMP Interface Policy
      • Detectors
        • ActiveMQ
        • BGP Session
        • Bean Script
        • DNS
        • FTP
        • HostResourceSWRun
        • HTTP
        • HTTPS
        • JDBC
        • JDBC Query
        • JDBC Stored Procedure
        • Loop
        • Reverse DNS
        • SNMP
        • TCP
        • TrivialTimeDetector
        • Web
        • Win32 Service
        • WMI
        • WS-MAN
        • WS-MAN WQL
    • Daemons
      • Ackd
      • Alarmd
      • Bsmd
      • Collectd
      • Discovery
      • Enlinkd
      • Eventd
      • JettyServer
      • Karaf
      • KarafStartupMonitor
      • Notifd
      • PerspectivePoller
      • Pollerd
      • Provisiond
      • Queued
      • Reportd
      • Rtcd
      • SnmpPoller
      • Statsd
      • Syslogd
      • Telemetryd
      • Ticketer
      • TL1d
      • Trapd
      • Vacuumd
    • Glossary
  • Troubleshooting
    • Horizon Startup
    • Horizon Log Files
    • Other Errors
  • Write the Docs
    • Develop Documentation
    • Write the Documentation
    • Build the Documentation
    • Glossary
Horizon 32
  • ALEC
    • 3.0.2-SNAPSHOT
    • 3.0.1
    • 3.0.0
  • HELM
    • 8
  • Horizon
    • 33
    • 32
    • 31
    • 30
  • Lōkahi/Cloud
    • 1.0
  • Meridian
    • 2024
    • 2023
    • 2022
    • 2021
  • OpenNMS.js
    • develop
    • v2.5.8
    • v2.5.7
    • 2.5.6-SNAPSHOT
    • 2.5.5
    • 2.5.0
    • 2.4.1
    • 2.4.0
    • 2.3.0
    • 2.2.0
    • 2.1.1
    • 2.1.0
  • Plugin for Grafana
    • 9
  • PRIS
    • 2.1.0
    • 2.0.0
    • 1.3.2
    • 1.3.1
    • 1.3.0
    • 1.2.0
  • ServiceNow Plugin
    • 2.0.0-SNAPSHOT
    • 1.0.1
  • Start Page
    • 1.0.0
  • Velocloud Plugin
    • 2.0.0-SNAPSHOT
    • 1.0.4
    • 1.0.3
    • 1.0.2
    • 1.0.1
  • Horizon
  • Development
  • REST API
  • Interfaces
33 32 31 30
Edit this Page

Currently Implemented Interfaces

This section describes currently implemented interfaces.

Expose ReST services via OSGi Acknowledgements

Copyright (c) 2002–2022 The OpenNMS Group, Inc.

Licensed under the terms of the AGPL-3.0.

Legal Notice