Developers Guide

Total Page：16

File Type：pdf, Size：1020Kb

Developers Guide Copyright (c) 2015-2019 The OpenNMS Group, Inc. OpenNMS Meridian 2017.1.26, Last updated 2020-09-01 19:13:44 UTC Table of Contents 1. Setup a development system . 1 1.1. Operating System / Environment . 1 1.2. Installation . 1 1.3. Tooling . 3 1.4. Useful links . 3 1.4.1. General . 3 1.4.2. Installation / Setup . 3 2. Topology . 4 2.1. Info Panel Items . 4 2.1.1. Programmatic . 4 2.1.2. Scriptable . 5 2.2. GraphML . 9 2.2.1. Create/Update/Delete GraphML Topology . 10 2.2.2. Supported Attributes . 11 2.2.3. Focus Strategies . 12 2.2.4. Icons. 12 2.2.5. Vertex Status Provider . 13 2.2.6. Edge Status Provider . 13 2.2.7. Layers . 14 2.2.8. Breadcrumbs . 16 3. CORS Support . 20 3.1. Why do I need CORS support? . 20 3.2. How can I enable CORS support? . 20 3.3. How can I configure CORS support? . 20 4. ReST API . 21 4.1. ReST URL . 21 4.2. Authentication . 21 4.3. Data format . 21 4.4. Standard Parameters . 21 4.5. Standard filter examples . 22 4.6. HTTP Return Codes . 23 4.7. Identifying Resources . 23 4.8. Currently Implemented Interfaces . 24 4.8.1. Acknowledgements . 24 4.8.2. Alarm Statistics . 25 4.8.3. Alarms . 25 4.8.4. Events . 26 4.8.5. Categories . 27 4.8.6. Foreign Sources . 28 4.8.7. Groups . 29 4.8.8. Heatmap . 30 4.8.9. Categories . 31 4.8.10. KSC Reports . 32 4.8.11. Maps . 32 4.8.12. Measurements API . 33 4.8.13. Nodes. 37 4.8.14. Notifications . 39 4.8.15. Outage Timelines . 39 4.8.16. Outages . 39 4.8.17. Requisitions . 40 4.8.18. Resources API . ..

Copy Link

Recommended publications

The World's First Enterprise-Grade Open Source Network Management
The World’s First Enterprise-grade Open Source Network Management Platform OpenNMS is the world’s first enterprise-grade Event Management and Notifications network management application developed under the open-source model. It is a free OpenNMS is event driven, and the system has software alternative to commercial products such the ability to generate internal events, such as a as Hewlett-Packard’s OpenView, IBM’s Netcool loss of a service, as well as to receive external and Tivoli, and CA Unicenter. events, such as SNMP Traps. Each event can be fed into a robust notification system that can Because OpenNMS is open source software, there send e-mails, pages, text messages, pop-ups are no software license costs. Since the software and even instant messages via XMPP (Jabber). code can be freely modified, OpenNMS can also Notices can be acknowledged, automatically be changed to fit the way the organization works, resolved and escalated. instead of having to change processes and procedures to fit the software. OpenNMS was designed from Day One to be able to monitor tens of thousands of interfaces. The ultimate goal for the software is to become the de facto network management platform. OpenNMS is focused on four main areas: • Automated Discovery • Event Management and Notifications • Service Level Monitoring • Performance Data Collection In addition, OpenNMS includes an event translator that can take an event and turn it Automated Discovery into another event. Fields in the original event It would be very difcult to configure by hand can then be parsed and used to access external thousands of devices, thus OpenNMS was databases (such as a customer or inventory designed to automate the process of network system) and a new enriched event created.
[Show full text]
Mysql Enterprise Monitor 2.0 Mysql Enterprise Monitor 2.0 Manual
MySQL Enterprise Monitor 2.0 MySQL Enterprise Monitor 2.0 Manual Copyright © 2005, 2011, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
[Show full text]
Whats New Opennms 2019
www.opennms.co.uk Whats New OpenNMS 2019 Dr Craig Gallen, Director Entimoss Ltd (OpenNMS UK) Associate Lecturer Solent University Craig Gallen Email : [email protected] : [email protected] : [email protected] Mobile: +44 (0) 7789 938012 Craig © OpenNMS / Entimoss 2014 entimOSS limited Company registered in England and Wales No. 06402040 Contents www.opennms.co.uk OpenNMS Project Overview OpenNMS Functional Overview Future directions © OpenNMS / Entimoss 2012 slide - 1 Converged Virtualised Services www.opennms.co.uk End user Services (Apps) are a mash-up of web services accessed through standard and Application proprietary protocols; Access Network Cloud • HTTP, REST, SOAP, Space JSON, RSS, • Open Data / RDF etc. • ‘Internet of things’ URI URI URI Service 1 Services hosted in Virtualised Service 3 Service 2 VM ‘Cloud’ designed to VM scale through addition Infrastructure VM of VM resources And applications VM VM VM VM VM VM ‘cloud bursting’ VM VM VM ‘cloud brokering’ Underlying physical infrastructure Physical •Commodity hardware •Geographical Diversity Infrastructure •Rapid Churn •Network Connectivity Core Network Cloud © OpenNMS / Entimoss 2012 slide - 2 Moving to Virtualised Networks www.opennms.co.uk You May Have Heard Of • Software defined Networking • Research / Data Centre • Open Flow • Network Functions Virtualisation • Service providers – ETSI • TM Forum ZOOM • Zero-touch Orchestration, Operations and Management (ZOOM) • ETSI’s vision for Network Functions Virtualisation — http://www.telco2research.com/articles/WP_telco2-network-functions-virtualisation-NFV-vs-software-defined-networking- SDN_Summary © OpenNMS / Entimoss 2012 slide - 3 OSGi – facilitates integration into Open Daylight SDN/SFV controller www.opennms.co.uk © OpenNMS / Entimoss 2012 slide - 4 OpenNMS futures www.opennms.co.uk © OpenNMS / Entimoss 2012 slide - 5 The OpenNMS Project www.opennms.co.uk • OpenNMS — Open Network Management System — OpenNMS is the world's first Enterprise and Carrier grade network management platform developed under the open source model.
[Show full text]
Opennms Provisioning
OpenNMS Provisioning OpenNMS version 1.8.0 The OpenNMS Group, Inc. 220 Chatham Business Drive, Suite 220 Pittsboro, NC 27312 T +1 919 533-0160 F Work Fax Phone [email protected] http://www.opennms.com The OpenNMS Group, Inc. Provisioning 5 Summary 5 Concepts 5 OpenNMS Provisioning Terminology 5 Entity 6 Foreign Source and Foreign ID 6 Foreign Source Definition 6 Import Requisition 6 Auto Discovery 6 Directed Discovery 6 Enhanced Directed Discovery 7 Policy Based Discovery 7 Addressing Scalability 7 Parallelization and Non-Blocking I/O 7 Provisioning Policies 7 The Default Foreign Source Definition 8 Getting Started 8 Provisioning the SNMP Configuration 8 Automatic Discovery 9 Separation of Concerns 9 Enhanced Directed Discovery 10 Understanding the Process 10 Import Handlers 12 File Handler 12 HTTP Handler 12 DNS Handler 12 DNS Import Examples: 12 Simple 12 Using a Regular Expression Filter 12 DNS Setup 13 Configuration 13 OpenNMS Provisioning 1 The OpenNMS Group, Inc. Configuration Reload 13 Provisioning Examples 14 Basic Provisioning 14 Defining the Nodes via the Web-UI 14 Import the Nodes 16 Adding a Node 16 Changing a Node 17 Deleting a Node 17 Deleting all the Nodes 18 Advanced Provisioning Example 19 Service Detection 20 Applying a New Foreign Source Definition 20 Provisioning with Policies 21 New Import Capabilities 23 Provisiond Configuration 23 Provisioning Asset Data 24 External Requisition Sources 25 Provisioning Nodes from DNS 25 Adapters 27 DDNS Adapter 27 RANCID Adapter 27 Maps (soon to be moved to Mapd) 27 WiMax-Link (soon to be moved to Linkd) 27 Integrating with Provisiond 28 Provisioning Groups of Nodes 28 Example 28 Step 1 (Create a Foreign Source) 28 Step 2 (Update the SNMP configuration) 29 Step 3 (Create/Update the Requisition) 29 Adding a Node to a Current Requisition 29 Provisioning Single Nodes (Quick Add Node) 30 Fine Grained Provisioning Using “provision.pl” 31 First, Create a new Provisioning Group 31 OpenNMS Provisioning 2 The OpenNMS Group, Inc.
[Show full text]
Opennms Release Notes
OpenNMS Release Notes Cumulative Release History Copyright © 2004-2012 Tarus Balog, Matt Brozowski, David Hustace, Benjamin Reed 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 Preface ................................................................................................................................... vi 1. Introduction ......................................................................................................................... 1 1.1. Release 1.12.9 ........................................................................................................... 1 1.2. Release 1.12.8 ........................................................................................................... 1 1.3. Release 1.12.7 ........................................................................................................... 1 1.4. Release 1.12.6 ........................................................................................................... 1 1.5. Release 1.12.5 ........................................................................................................... 1 1.6. Release 1.12.4 ........................................................................................................... 1 1.7. Release
[Show full text]
W.Chinthaka Prasanna Senanayaka 15/1A, Perera Mw
GSoC 2011 – OpenNMS project proposal Create a maven archetype for creating GWT based XML configuration management and implement three of them W.Chinthaka Prasanna Senanayaka 15/1A, Perera Mw, Meethotamulla, Wellampitiya, Colombo, Sri Lanka. Tel. No. +94718443972 E-mail: [email protected] / [email protected] Personal Details Name: Wahalatantrige Chinthaka Prasanna Senanayaka (W.C.P. Senanayaka) University: University of Kelaniya, Sri Lanka. Course: B.Sc. in Management and Information Technology (3rd year, Special) Email address: [email protected] Physical address: 15/1 A, Perera Mw, Meethotamulla, Wellampitiya, Colombo, Sri Lanka. Phone numbers: +94718443972 Web page: http://chinthakarobotikka.blogspot.com/ IM contacts: Skype: chinthakas87 IRC nick: chinthakas Availability: 1. I can spend on GSoC OpenNMS project, 5–7 hours per day practically. 2. As GSoC time plan I can start and end the project, and I will continue the contact with OpenNMS projects. 3. Other factors affects my availability are university examinations (I have examinations on 2011/04/23, 2011/04/30, 2011/05/02. And before the next semester exams come, GSoC will be finished). 1 GSoC 2011 – OpenNMS project proposal Starting date delays: no delays. Background Information Education background: Did Mathematics, Physics for Advance Level examination. Then I entered to University and now I am in 3rd year special batch. Software development background: I have worked at H’Senid Software International Pvt Ltd (mobile software development, as an undergraduate trainee software engineer). Computer languages: C, JAVA, VB (VB.NET and VB script), PHP (HTML, Javascript), ASP.NET (average), and Scala (average) Other Java compliant tools: Spring, Hibernate, Vaardin Software: Linux – Ubuntu, MySQL, Flash, SQL SERVER Software design using UML (just started learning BPMN) Other: Maven, special interest in open source Why I am interested in OpenNMS: 1.
[Show full text]
Opennms Meridian Release Notes
OpenNMS Meridian Release Notes Copyright (c) 2016-2019 The OpenNMS Group, Inc. OpenNMS Meridian v2017.1.26, Last updated 2020-09-01 19:13:44 UTC Table of Contents OpenNMS Meridian Development Team . 1 OpenNMS Meridian 2017 . 1 System Requirements. 1 What’s New in Meridian 2017 . 1 Release Meridian-2017.1.26 . 6 Release Meridian-2017.1.25 . 7 Release Meridian-2017.1.24 . 7 Release Meridian-2017.1.23 . 7 Release Meridian-2017.1.22 . 8 Release Meridian-2017.1.21 . 8 Release Meridian-2017.1.20 . 8 Release Meridian-2017.1.19 . 8 Release Meridian-2017.1.18 . 9 Release Meridian-2017.1.17 . 9 Release Meridian-2017.1.16 . 9 Release Meridian-2017.1.15 . 10 Release Meridian-2017.1.14 . 10 Release Meridian-2017.1.13 . 10 Release Meridian-2017.1.12 . 11 Release Meridian-2017.1.11 . 11 Release Meridian-2017.1.10 . 11 Release Meridian-2017.1.9 . 14 Release Meridian-2017.1.8 . 14 Release Meridian-2017.1.7 . 15 Release Meridian-2017.1.6 . 16 Release Meridian-2017.1.5 . 16 Release Meridian-2017.1.4 . 16 Release Meridian-2017.1.3 . 17 Release Meridian-2017.1.2 . 17 Release Meridian-2017.1.1 . 18 Release Meridian-2017.1.0 . 19 OpenNMS Meridian Development Team Tarus Balog <[email protected]> David Hustace <[email protected]> Benjamin Reed <[email protected]> Copyright © 2004-2020 The OpenNMS Group, Inc. 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.
[Show full text]
Developers Guide
Developers Guide Copyright (c) 2015-2019 The OpenNMS Group, Inc. OpenNMS Meridian 2019.1.23, Last updated 2021-09-07 21:58:30 UTC Table of Contents 1. Setup a development system . 1 1.1. Operating System / Environment . 1 1.2. Installation . 1 1.3. Tooling. 3 1.4. Useful links. 3 1.4.1. General . 3 1.4.2. Installation / Setup . 3 2. Topology . 4 2.1. Info Panel Items . 4 2.1.1. Programmatic . 4 2.1.2. Scriptable . 5 2.2. GraphML . 9 2.2.1. Create/Update/Delete GraphML Topology. 10 2.2.2. Supported Attributes . 11 2.2.3. Focus Strategies . 12 2.2.4. Icons . 12 2.2.5. Vertex Status Provider . 13 2.2.6. Edge Status Provider . 13 2.2.7. Layers . 14 2.2.8. Breadcrumbs . 16 2.3. Topologies Updates. 20 2.3.1. OnmsTopologyUpdater . 20 2.3.2. OnmsTopologyRef. 20 2.3.3. OnmsTopologyMessage . 21 2.3.4. OnmsTopologyProtocol . 21 2.3.5. TopologyMessageStatus. 21 2.3.6. OnmsTopology. 21 2.3.7. OnmsTopologyVertex. 21 2.3.8. OnmsTopologyEdge . 21 2.3.9. OnmsTopologyPort . 22 2.3.10. OnmsTopologyConsumer . 22 3. CORS Support . 23 3.1. Why do I need CORS support?. 23 3.2. How can I enable CORS support? . 23 3.3. How can I configure CORS support? . 23 4. ReST API . 24 4.1. ReST URL. 24 4.2. Authentication. 24 4.3. Data format . 24 4.4. Standard Parameters . 24 4.5. Standard filter examples . 25 4.6. HTTP Return Codes . 26 4.7. Identifying Resources .
[Show full text]
Systems Monitoring Shootout Finding Your Way in the Maze of Monitoring Tools
Systems Monitoring Shootout Finding your way in the Maze of Monitoring tools Kris Buytaert Tom De Cooman Inuits Inuits [email protected] [email protected] Frederic Descamps Bart Verwilst Inuits Inuits [email protected] [email protected] Abstract serving, do you want to know about the internal state of your JBoss, or be triggered if the OOM killer will start The open source market is getting overcrowded with working soon? . As you see, there are several ways of different Network Monitoring solutions, and not with- monitoring depending on the level of detail. out reason: monitoring your infrastructure is becoming more important each day. You have to know what’s go- In our monitoring tool, we add hosts. This host can be ing on for your boss, your customers, and for yourself. any device we would like to monitor. Next we need to deﬁne what parameter on the host we would like to Nagios started the evolution, but today OpenNMS, check, how we are going to get the data, and at which Zabix, Zenoss, GroundWorks, Hyperic, and different point we’d consider the values not within normal lim- others are showing up in the market. its anymore. The result is called a check. There are several ways to ‘get’ the required data. Most monitor- Do you want light-weight, or feature-full? How far do ing tools can use SNMP as a way to gather the required you want to go with your monitoring, just on an OS data. Either the tool itself performs an SNMP-get, or it level, or do you want to dig into your applications, do receives data via an SNMP-trap.
[Show full text]
SNMP and Opennms
This watermark does not appear in the registered version - http://www.clicktoconvert.com SNMP and OpenNMS Part –2 OpenNMS Parts of this presentation were shamelessly copied from a presentation by the project's maintainer, Tarus Balog with the author's permission. Zeev Halevi This watermark does not appear in the registered version - http://www.clicktoconvert.com NMS - ISO Definition: FCAPS • Fault Management • Configuration Management • Accounting • Performance • Security This watermark does not appear in the registered version - http://www.clicktoconvert.com FCAPS and OpenNMS • Fault Management • Configuration Management • Accounting • Performance • Security This watermark does not appear in the registered version - http://www.clicktoconvert.com He-Who-Must-Not-Be-Named of the NMS world This watermark does not appear in the registered version - http://www.clicktoconvert.com The Three "Halves" of OpenNMS • Service Scanning: Is a given network service available? • SNMP Data Collection: Traditional network performance measurement via SNMP • Event Management and Notification This watermark does not appear in the registered version - http://www.clicktoconvert.com Services Available by Default - MSExchange This watermark does not appear in the registered version - http://www.clicktoconvert.com On-line demo • http://www.opennms.org/onmsdemo/onms_ ex0_main_view.htm • http://nms.nws.orst.edu:8080/publicnms/ind ex.jsp • (look at /performance/index.jsp for reports) This watermark does not appear in the registered version - http://www.clicktoconvert.com Concurrent management tasks Concurrent Task Name of Description daemon Action daemon actiond Auto-action execution facility, for automated action (workflow) based on incoming events. Collection daemon collectd Collects data from managed nodes. Capability daemon capsd Performs capability check on discovered nodes.
[Show full text]
SNMP (Polling and Traps, Mibs, DELL Openmanage)
OpenNMS Daniel Traynor, GRIDPP, QMUL HEPSYSMAN June 2014, RAL OpenNMS Monitoring Overview SNMP (polling and traps, mibs, DELL openmanage) (r)syslog OpenNMS Basics, Installation, automated and directed discovery. Examples Monitoring Choice Do a search for network monitoring and you can find lots.. http://en.wikipedia.org/wiki/Comparison_of_network_monitoring_systems e.g. cacti, ganglia, nagios, but lots of others …. Have setup and used Zenoss in the past, needed to upgrade hardware, found that new version of Zenoss required lots of extra packages not in SL6. Chose OpenNMS after recommendation from FOSSUK2013. Also used in Physics at QMUL. Requirements Open source. Network service checks (e.g. ssh, DNS, ntp, snmp, https:1311). SNMP polling and SNMP trap receiver (does not use agents on clients). syslog monitoring. Automated [directed] discovery. Performance measurements. SNMP On SL install net-snmp also snmpv3 for secure monitoring useful to install net-snmp-utils for (used by QMUL physics), gridpp testing with snmpwalk / snmpget. use v2 on private network. community name set to random string ro for reading not writing set IP address to limit access monitor disk space in usefull units set values for standard variables override default values setup dell openmanage to send snmp traps to our monitoring box make extra information available (fans, tempt,…) SNMP MIB Management information bases (MIBs) define the structure of the data of a system via object identifiers (OID). An OID identifies a variable that can be read or set via SNMP. MIBs exits for e.g. linux, switches (HP, Force10,…) also enterprise versions, e.g. DELL MIB provides fans speeds, server temperatures etc… OpenNMS already knows about a lot of these MIBS.
[Show full text]
COVER STORIES Opennms
COVER STORIES OpenNMS Monitoring large systems and networks Big Time If you need to monitor very large networks, you need powerful software. OpenNMS offers serious monitor- ing capabilities in a truly open source package. By Kurt Seifried espite administrators’ best efforts, networks, servers, and services are destined to fail at some point. Sometimes the failure is obvious (a fan Dgoes out or a backhoe meets your network cable), and sometimes the failure is subtle (a DNS change that breaks email to a server). Troubleshooting these problems can be easy if you know the root cause, but that’s not typically the case, and the task is orders of magnitude more difficult when you have 1,000, 10,000, or 100,000 machines to manage. In such cases, OpenNMS [1] can help. When you need to monitor very large networks, especially geographically distributed and non-homogeneous (Windows, Linux, Solaris, AIX, etc.) networks, you need some pretty serious monitoring software. The big commer- cial products, such as IBM Tivoli or HP Systems Manager will do the trick, but they aren’t open source or cheap. Thus, you might have issues if you need to customize them signifi- cantly, and tracking down the appropriate support can be difficult. What Is OpenNMS? At first, I thought OpenNMS was a typical network monitoring tool like Nagios. I thought you could just fire it up, tell it what to watch, and wait for your cell phone to ring when something failed. OpenNMS will do that, and more. OpenNMS is designed to address the monitoring of extremely large (e.g., 100,000 machines) networks with many different types of devices.
[Show full text]