The core of ncpa is the api, which works the same across all platforms. Nagios xi also includes graphs and reports, customizable dashboards and views, an integrated db, a backend api, multitenancy, and many other advanced features that will make it much quicker and easier to use, and provide a complete monitoring, alerting, graphing, and reporting solution. The twilio sms component provides outbound sms notifications from nagios xi, thereby increasing the flexibility, reliability and dependability of receiving critical alerts and notifications. This document describes how to install and setup the nagios vshell, or visual shell, for nagios core and nagios xi installations.
This section covers how the api works with individual references for each module. Manual pages this part provides documentation for each individual plugin that is included in the official nagios plugins distribution. As your infrastructure grows, your monitoring environment can expand without increasing load or management requirements at the central node. Icinga certificate monitoring keeps track of certificates as they are deployed in a network environment. Nagios xi uses this api to send text notifications to recipients. Official manuals, documentation, video tutorials, and faqs for nagios solutions. All of the documentation is available inside of the nagios xi product via the help menu. Live stats using realtime graphing api the live stats tab is an example of the ncpa realtime graphing api via websockets and a way to view realtime cpu, memory, disk, and interface details. Generic means, it can be used with every core that understands the nagios configuration syntax for example nagios xi, nrdp2, etc. Expect some portions of the docs to be different than others for a while.
This is the updated online version of the nagios documentation package distributed with nagios core version 3. Nagiosplugins considers these items to be extremely important for proper code coverage and longevity. How to download files from the nagios exchange using wget. For any support related questions please visit the nagios support forums at. To view the rest api documentation in nagios xi navigate to help backend api docs.
The graphite module for displays data stored in graphite directly in the icinga web 2 interface. This document describes how to access the nagios xi backend api to query. This documentation provides information about developing plugins. Nagios xi was built to run natively on centosrhel, debian, and ubuntu linux. If youre looking at writing your own plugins for nagios core, please make sure. They can also be integrated with nagios xi or called via the api. Documentation on nagios can be found on the nagios support portal at support azeti sonarplex the azeti sonarplex monitoring appliances provide you a reliable, easytouse, nagiosbased monitoring solution. This api is desinged for nagios client unofficial nagios status monitoring app. Documentation backend api access backend rest api as of nagios xi 5, a new rest api was introduced. Centreons aiopsready it monitoring platform provides holistic visibility to complex it workflows from cloudtoedge. Download the core monitoring engine and a basic web interface. The api is constructed in a way that allows users to easily follow the hierarchy down, creating a url that will access specific requested data. Log management software nagios log server download.
Documentation is meant to complement the nagios network analyzer manuals and tutorials. This 4 kb output limit is fairly easy to change if you need. Configure nagios to monitor critical it infrastructure components, including system metrics, network protocols, applications, services, servers, and. Nagios xi is the most powerful it infrastructure monitoring solution on the market. Nagios core import functionality makes it easy to migrate from nagios core. Its easy just create an account, login, and add a new listing. Integrated performance graphs provide trending and capacity planning information. It provides a restful api for generating any standard nag. Nagira is rubysinatra lightweight web services api for accessing and operating data of nagios hosts and services, accessing nagios configuration.
Handles external api requests including those for active checks. Inquire today and let our quickstart team help you get started with nagios xi. Documentation is meant to complement the nagios xi manuals and tutorials. Nagios xi provides network, server, and application monitoring in one easy to configure package along with advanced alerting and reporting. Customizable dashboards allow for peruser customization.
Dec 07, 2016 documentation backend api access backend rest api. Nagios xi multitech mtr api integration nagios exchange. Faq the faq section offers additional information on the nagios plugins package as a whole. It can provide information on servers assigned to the kernelcare key, or for all the servers in partner account. This document is intended for use by nagios administrators experienced with installing and configuring network devices. We provide a software appliance complete with its linux operating system, databases or web server. Nagios is a hostservicenetwork monitoring program written in c and released under the gnu general public license, version 2. Help build nagios exchange for yourself and the entire the nagios community by your nagios project to the site. Nagios core serves as the basic event scheduler, event processor, and alert manager for elements that are monitored. This document is intended for use by nagios administrators who want to understand in detail. They have become the standard nagios core interface, and are often used as an api by many nagios extensions. Remote nagios servers distribute the load associated with monitoring and performance graphing. The api daemon needs to run on a machine where it has access to the files that nagios creates the status file, log file, and external commands pipe.
Download a free 60day trial of nagios xi or give the online demo a spin. Nagira is packaged as ruby gems which provides easy installation and configuration. Component installation the component comes installed in nagios xi by default. This program provides a simple restlike interface to nagios. The script can be downloaded from the following locations. Available manuals online manuals are available for the most recent versions of nagios core and key nagios addons. This project provides java libraries that can be used to receive nagios configuration and status information via the ndoutils tcp socket interface, and to transmit commands to nagios via the external command interface. This document describes how to access to backend api and query information. Run this on your nagios host and then sit back and enjoy a much easier, more straightforward way to accomplish things with nagios. Nagios xi documentation documentation on using nagios xi.
Nagios will only read the first 4 kb of data that a plugin returns. While it will not install natively on a windows server, you can use our prepackaged vm and install it on a virtual box with a program like vmware player, hyperv or vsphere. Monitoring wizards make it easy to monitor new devices, applications, and services. Webbased configuration provides advanced configuration features. This download is to manually install nagios xi on centos, redhat enterprise, oracle, debian, or ubuntu lts. Nagrestconf is a mature and well maintained rest interface and configuration gui for nagios. The main nagios plugins documentation is split into two parts. Nagios xi is the easytouse, enterprise version of nagios that features. It was designed to make it easy for administrators to setup checks, troubleshoot problems, test checks, while still being flexible.
Nagios network analyzer documentation nagios library. Nagios xi extends on proven, enterpriseclass open source components to deliver the best monitoring solution for todays demanding organizational requirements. This api allows you to read, write, delete, and update data in the nagios xi system through commands that are authenticated via nagios xi api keys. Nagios features an optional embedded perl interpreter which can speed up the execution of perl plugins. The official online documentation is available here nagios is a extremly powerful, versatile and open software system. Fusion is designed to scale with your organization. Icinga reporting is the central component for reporting related functionality in. This is done in order to prevent runaway plugins from dumping megs or gigs of data back to nagios. Oct 27, 2011 the api daemon needs to run on a machine where it has access to the files that nagios creates the status file, log file, and external commands pipe. Nagios can be used to check the health condition of a rips instance regularly using a script that acquires this information through the api, making it possible to evaluate if the system is running as expected or if some action is required. Nagios core documentation will be coming to the nagios library soon stay tuned. Icinga reporting is the central component for reporting related functionality in the icinga web frontend. Restlos german for completely, totally is a generic nagios api.
Cgi programs are included to allow you to view the current status, history, etc via a web interface if you so desire. I hope the changes im making will make things clearereasier for new and seasoned nagios users alike. This is a brief tutorial on how to change the host alive check and give a brief introduction on. These will provide you with the basic functionality that is required to view and manage the various elements monitored by nagios core.
Monitor your entire it infrastructure quickly with the most powerful monitoring solution on the market. If you are using nagios in distributed mode, you want to run the daemon on the central machine that receives all of the distributed check results. Communitycontributed and official documentation on nagios and various nagios addons. Vmware workstation proplayer, virtualbox, and anything that can use ovf.
I would recommend that you download the official nagios plugins and look through the code for various c, perl, and shell script plugins. It should be noted that a passed, does not mean that all coverity reported issues have been resolved, instead that the latest build submitted did not have any newly found issues, and may or may not have eliminated previously found issues. Nagios api purpose this site is used to process data related to version update checks and feedback for nagios and other products and services developed andor distributed by nagios enterprises. Accessing the nagios xi backend api nagios exchange. See a variety of open source frontends by the community. Provide you with notifications of updates and new releases of. Support plans certification implementation videos knowledge base documentation support forums. Download the latest nagios core plugins package 50 plugins. Documentation backend api access backend rest api as. Nagios xi has helped organizations around the world make better business decisions as a proven it infrastructure monitoring solution. This simple api makes it easy to integrate nagios information into thirdparty applications and external websites. Nagios vshell is a lightweight php interface for nagios core designed to be simple to install and use, and read more. See additional projects that extend nagios core functionality. Nagios xi includes a backend api that allows developers to pull current status information and more in xml format for use by external systems.
Backend api the original backend api for nagios xi was designed to query current status and historical information. Contribute to sulochango nagiosapi development by creating an account on github. Documentation on nagios can be found on the nagios support portal at support. This is going to take a while, as 1 theres a lot of documentation and 2 writing documentation is not my favorite thing in the world. If it is not present it can be downloaded from the following url. This documentation describes how to install nagios core from source on centos, ubuntu, and rhel. This document describes how to integrate twilio component with nagios xi for notification.
1022 1428 1041 309 792 763 665 373 187 86 1430 1489 733 1052 753 1587 893 1409 285 245 1311 113 1020 1205 410 1042 503 628 777 352 996 1343 1443 788 1345 693 1235 117 811 1448 767 744 112 1250 116 1143