Developers Guide

Total Page:16

File Type:pdf, Size:1020Kb

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 . 26 4.8. Expose ReST services via OSGi . 27 4.8.1. Define a ReST interface . 27 4.8.2. Implement a ReST interface . 28 4.8.3. Export the ReST service. 28 4.9. Currently Implemented Interfaces. 29 4.9.1. Acknowledgements . 29 4.9.2. Alarm Statistics . 30 4.9.3. Alarms . 30 4.9.4. Alarm History . ..
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]
  • Jaspersoft Platform Support Commercial Edition
    Jaspersoft Platform Support Commercial Edition Updated: May 15th, 2019 © Copyright 2019, TIBCO Software Inc. All Rights Reserved. Table of Contents OVERVIEW 1 SUPPORT POLICIES 1 COMMERCIAL AND COMMUNITY EDITIONS 1 APPLICATION SERVERS 2 WEB BROWSERS 2 PORTAL SERVERS 2 DATABASES 3 BIG DATA CERTIFIED SUPPORT 4 BIG DATA COMPATIBLE SUPPORT 5 JDBC/SQL SUPPORT NOTE 6 OPERATING SYSTEMS 7 JAVA VIRTUAL MACHINES (JVM) 8 JASPERSOFT ODBO CONNECT 8 JASPERSOFT OLAP SCHEMA WORKBENCH 8 JASPERSOFT ETL (VERSION 6.2.1) 8 LANGUAGE SUPPORT 9 © Copyright 2019, TIBCO Software Inc. All Rights Reserved. Overview This document contains a list of platforms that covers following Jaspersoft products: - ● JasperReports Server 7.2 ● Jaspersoft Studio 7.3 ● JasperReports IO 1.1 Support Policies 1. Certification Levels. Platforms denoted as “Certified” are fully tested and supported by Jaspersoft. Platforms denoted as “Compatible” may be either: partially tested, tested in past releases, or noted as upward compatible by the platform vendor. 2. Product issues must be reproduced on a Certified platform as listed in this document; otherwise Jaspersoft will offer “Guidance Level” support as defined below: a) Jaspersoft Customer Support will log a case, collect the information and review it (without necessarily setting up the customer environment) to make educated suggestions as to what is happening and how to resolve the issue, but without any commitment to resolve the issue. b) Support may choose to review customers’ configuration files or code snippets. c) Support will provide information on the technology such as FAQs, helpful websites, documentation references, etc. Support may also include research of other avenues including consultation with Jaspersoft Engineering, Sales Engineering and Professional Services.
    [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]
  • Jazz up Your Applications – Seamlessly Embed Jasperreports T Is Easy to See Why Bbj® That Embeds Java Code to Wrap and Data for the Report
    Utility Jazz up Your Applications – Seamlessly Embed JasperReports t is easy to see why BBj® that embeds Java code to wrap and data for the report. Specifying optional developers are jazzed about extend the Jasper API. This fully report parameters and a locale for report I the iReport Designer – now supported, fully documented, and fully creation provide further report criteria they can create and preview modifiable utility delivers a very easy, and localization. All of these inputs professional looking reports against yet very powerful mechanism to utilize come together during the fill operation, their live data with very little effort. The JasperReports in BBj. The BBJasper which takes the design (.jasper or iReport Designer Wizard steps the utility is comprised of three different .jrxml) file, obtains the data via a JDBC developer through the report creation modules or CustomObjects: connection as specified in the connect process to deliver useful and, in some • BBJasperReport string, and applies the report parameter cases, critical information. The next step, • BBJasperViewerWindow and localization. Voilà, a report is born! of course, is figuring out how to embed • BBJasperViewerControl Figure 1 is a code sample that displays the newly-created report into an existing a BBJasperReport in a BBj window. application. The BBJasperReport CustomObject allows for creating, displaying, printing, BBJasper extends much-needed So, how do you use JasperReports in and saving a report from within a GUI, flexibility in printing the reports. Some BBj? CUI, or background BBj application. common options and preferences To create a report, this API requires include printing to the server or client, The answer is simple and the focus of a .jrxml or .jasper file and a JDBC displaying an optional dialog to allow this article...use BBJasper – the new connect string.
    [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]
  • TIBCO Jasperreports Server Installation Guide
    JASPERREPORTS® SERVER INSTALLATION GUIDE RELEASE 7.1 http://www.jaspersoft.com Copyright ©2005-2018 TIBCO Software Inc. All Rights Reserved. TIBCO Software Inc. This is version 0518-JSP71-47 of the TIBCO JasperReports Server Installation Guide. TABLE OF CONTENTS Chapter 1 Introduction 9 1.1 Conventions 10 1.2 Supported Platforms 11 1.3 Using the IBM JDK 11 1.4 JasperReports Server Distributions 11 1.4.1 Installer Support 12 1.4.2 WAR File Binary Distribution Support 13 1.5 Release Notes 14 1.6 System Requirements 14 1.7 Support for Internationalization 15 Chapter 2 Installing JasperReports Server 17 2.1 Pre-installation Steps 17 2.2 Starting the Installer 18 2.3 Accepting the License Agreement 18 2.4 Choosing Installation Type 18 2.5 Choosing an Installation Directory 19 2.6 Selecting a Tomcat Configuration 19 2.7 Selecting a PostgreSQL Configuration 19 2.7.1 Choosing the Bundled PostgreSQL 20 2.7.2 Choosing an Existing PostgreSQL on a Local Host 20 2.7.3 Using an Existing PostgreSQL on a Remote Host 21 2.7.4 Enabling Connections to a Remote Host 21 2.8 Installing Sample Data 22 2.9 Completing the Installation 22 2.10 Post-installation Steps 23 2.10.1 Updates Made by the Installer During Installation 23 2.10.2 Installer Output Log File Location 23 2.10.3 Setting your Java JVM Options 23 2.10.4 Installing a New License File 24 2.10.5 License File for Existing Tomcat as Windows Service 24 2.11 Starting and Stopping the Server 25 2.11.1 Start/Stop Menu — Windows 25 TIBCO Software Inc.
    [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]
  • 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 define 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]
  • Jasperreports Server Community Project Install Guide
    TIBCO JASPERREPORTS® SERVER COMMUNITY PROJECT INSTALLATION GUIDE RELEASE 6.0 http://www.jaspersoft.com Copyright ©2005-2014, TIBCO Software Inc. All rights reserved. Printed in the U.S.A. TIBCO, the TIBCO logo, TIBCO Jaspersoft, the TIBCO Jaspersoft logo, TIBCO Jaspersoft iReport Designer, TIBCO JasperReports Library, TIBCO JasperReports Server, TIBCO Jaspersoft OLAP, TIBCO Jaspersoft Studio, and TIBCO Jaspersoft ETL are trademarks and/or registered trademarks of TIBCO Software Inc. in the United States and in jurisdictions throughout the world. All other company and product names are or may be trade names or trademarks of their respective owners. This is version 1214-JSO60-33 of the JasperReports Server Community Project Installation Guide. TABLE OF CONTENTS Chapter 1 Introduction 7 1.1 Conventions 8 1.2 Java Version Supported 9 1.3 JasperReports Server Distributions 9 1.3.1 Installer Support 9 1.3.2 WAR File Binary Distribution Support 11 1.4 Release Notes 12 1.5 System Requirements 12 1.6 Support for Internationalization 13 Chapter 2 Installing JasperReports Server 15 2.1 Pre-Installation Steps 15 2.2 Starting the Installer 15 2.3 Accepting the License Agreement 16 2.4 Choosing Installation Type 16 2.5 Choosing an Installation Directory 17 2.6 Selecting a Tomcat Configuration 17 2.7 Selecting a PostgreSQL Configuration 18 2.7.1 Choosing the Bundled PostgreSQL 18 2.7.2 Choosing an Existing PostgreSQL on a Local Host 18 2.7.3 Using an Existing PostgreSQL on a Remote Host 19 2.7.4 Enabling Connections to a Remote Host 20 2.8 Installing Sample Data 20 2.9 Completing the Installation 21 2.10 Post-Installation Steps 21 2.10.1 Updates Made by the Installer During Installation 21 2.10.2 Installer Output Log File Location 22 2.10.3 Checking your Java JVM Options 22 Chapter 3 Starting and Stopping JasperReports Server 25 3.1 Start/Stop Menu — Windows 25 3.1.1 Start/Stop Menus — Bundled Tomcat and PostgreSQL 25 3.1.2 Additional Information about the Bundled Tomcat and PostgreSQL 25 3.1.3 Start/Stop Scripts — No Bundled Applications 26 TIBCO Software Inc.
    [Show full text]